@elqnt/types

Core TypeScript type definitions for the Eloquent platform.

Installation

npm install @elqnt/types

Quick Start

import type { ResponseMetadata, JSONSchema, APIResponse } from "@elqnt/types";

// Standard API response metadata
interface MyResponse {
  data: unknown;
  metadata: ResponseMetadata;
}

// JSON Schema for dynamic forms
const schema: JSONSchema = {
  type: "object",
  properties: {
    name: { type: "string", minLength: 1 },
    email: { type: "string", format: "email" },
  },
  required: ["name", "email"],
};

Entry Points

| Import | Description | |--------|-------------| | @elqnt/types | Core types (ResponseMetadata, JSONSchema, etc.) | | @elqnt/types/models | Model types (UserStatus, Widget, Product) |

Core Types

• ResponseMetadata - Standard API response metadata
• APIResponse<T> - Unified response wrapper
• APIError - Structured error information
• JSONSchema - JSON Schema definition type
• Variable - Workflow/agent variable type
• DataType - Data type enum

Migration Notice

Admin and billing types have moved to @elqnt/admin:

// NEW location for User, Org, Plan, etc.
import type { User, Org, Plan } from "@elqnt/admin/models";

Documentation

Full reference: https://docs.eloquent.ai/packages/types

Changelog

See CHANGELOG.md

License

Private - Eloquent Platform