@objectql/types 1.8.3 → 1.9.0

package/dist/api.d.ts

@@ -315,6 +315,8 @@ export interface DataApiClientConfig {
     headers?: Record<string, string>;
     /** Request timeout in milliseconds */
     timeout?: number;
+    /** Custom data API path (defaults to /api/data) */
+    dataPath?: string;
 }
 /**
  * Configuration for Metadata API client
@@ -328,6 +330,8 @@ export interface MetadataApiClientConfig {
     headers?: Record<string, string>;
     /** Request timeout in milliseconds */
     timeout?: number;
+    /** Custom metadata API path (defaults to /api/metadata) */
+    metadataPath?: string;
 }
 /**
  * Interface for Data API client operations
@@ -425,3 +429,51 @@ export interface IMetadataApiClient {
      */
     getMetadata<T = unknown>(metadataType: string, id: string): Promise<MetadataApiResponse<T>>;
 }
+/**
+ * Configuration for API route paths
+ * Allows customization of all API endpoints during initialization
+ */
+export interface ApiRouteConfig {
+    /**
+     * Base path for JSON-RPC endpoint
+     * @default '/api/objectql'
+     */
+    rpc?: string;
+    /**
+     * Base path for REST data API
+     * @default '/api/data'
+     */
+    data?: string;
+    /**
+     * Base path for metadata API
+     * @default '/api/metadata'
+     */
+    metadata?: string;
+    /**
+     * Base path for file operations
+     * @default '/api/files'
+     */
+    files?: string;
+}
+/**
+ * Complete API route configuration with defaults applied
+ */
+export interface ResolvedApiRouteConfig {
+    /** JSON-RPC endpoint path */
+    rpc: string;
+    /** REST data API base path */
+    data: string;
+    /** Metadata API base path */
+    metadata: string;
+    /** File operations base path */
+    files: string;
+}
+/**
+ * Default API route configuration
+ */
+export declare const DEFAULT_API_ROUTES: ResolvedApiRouteConfig;
+/**
+ * Resolve API route configuration by merging user config with defaults
+ * All paths are normalized to start with '/'
+ */
+export declare function resolveApiRoutes(config?: ApiRouteConfig): ResolvedApiRouteConfig;

package/dist/api.js

@@ -6,7 +6,8 @@
  * These types enable frontend applications to make type-safe API calls.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectQLError = exports.ApiErrorCode = void 0;
+exports.DEFAULT_API_ROUTES = exports.ObjectQLError = exports.ApiErrorCode = void 0;
+exports.resolveApiRoutes = resolveApiRoutes;
 // ============================================================================
 // Error Handling Types
 // ============================================================================
@@ -42,4 +43,27 @@ class ObjectQLError extends Error {
     }
 }
 exports.ObjectQLError = ObjectQLError;
+/**
+ * Default API route configuration
+ */
+exports.DEFAULT_API_ROUTES = {
+    rpc: '/api/objectql',
+    data: '/api/data',
+    metadata: '/api/metadata',
+    files: '/api/files'
+};
+/**
+ * Resolve API route configuration by merging user config with defaults
+ * All paths are normalized to start with '/'
+ */
+function resolveApiRoutes(config) {
+    var _a, _b, _c, _d;
+    const normalizePath = (path) => path.startsWith('/') ? path : `/${path}`;
+    return {
+        rpc: normalizePath((_a = config === null || config === void 0 ? void 0 : config.rpc) !== null && _a !== void 0 ? _a : exports.DEFAULT_API_ROUTES.rpc),
+        data: normalizePath((_b = config === null || config === void 0 ? void 0 : config.data) !== null && _b !== void 0 ? _b : exports.DEFAULT_API_ROUTES.data),
+        metadata: normalizePath((_c = config === null || config === void 0 ? void 0 : config.metadata) !== null && _c !== void 0 ? _c : exports.DEFAULT_API_ROUTES.metadata),
+        files: normalizePath((_d = config === null || config === void 0 ? void 0 : config.files) !== null && _d !== void 0 ? _d : exports.DEFAULT_API_ROUTES.files)
+    };
+}
 //# sourceMappingURL=api.js.map

package/dist/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAOH,+EAA+E;AAC/E,uBAAuB;AACvB,+EAA+E;AAE/E;;GAEG;AACH,IAAY,YAUX;AAVD,WAAY,YAAY;IACpB,mDAAmC,CAAA;IACnC,qDAAqC,CAAA;IACrC,6CAA6B,CAAA;IAC7B,uCAAuB,CAAA;IACvB,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;IACrB,iDAAiC,CAAA;IACjC,iDAAiC,CAAA;IACjC,2DAA2C,CAAA;AAC/C,CAAC,EAVW,YAAY,4BAAZ,YAAY,QAUvB;AAwBD;;GAEG;AACH,MAAa,aAAc,SAAQ,KAAK;IAIpC,YAAY,KAAkF;QAC1F,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAE7B,uDAAuD;QACvD,MAAM,gBAAgB,GAAG,KAA2F,CAAC;QACrH,IAAI,OAAO,gBAAgB,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;YAC3D,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAC5D,CAAC;IACL,CAAC;CACJ;AAhBD,sCAgBC"}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAgjBH,4CASC;AAljBD,+EAA+E;AAC/E,uBAAuB;AACvB,+EAA+E;AAE/E;;GAEG;AACH,IAAY,YAUX;AAVD,WAAY,YAAY;IACpB,mDAAmC,CAAA;IACnC,qDAAqC,CAAA;IACrC,6CAA6B,CAAA;IAC7B,uCAAuB,CAAA;IACvB,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;IACrB,iDAAiC,CAAA;IACjC,iDAAiC,CAAA;IACjC,2DAA2C,CAAA;AAC/C,CAAC,EAVW,YAAY,4BAAZ,YAAY,QAUvB;AAwBD;;GAEG;AACH,MAAa,aAAc,SAAQ,KAAK;IAIpC,YAAY,KAAkF;QAC1F,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAE7B,uDAAuD;QACvD,MAAM,gBAAgB,GAAG,KAA2F,CAAC;QACrH,IAAI,OAAO,gBAAgB,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;YAC3D,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAC5D,CAAC;IACL,CAAC;CACJ;AAhBD,sCAgBC;AA+dD;;GAEG;AACU,QAAA,kBAAkB,GAA2B;IACtD,GAAG,EAAE,eAAe;IACpB,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,eAAe;IACzB,KAAK,EAAE,YAAY;CACtB,CAAC;AAEF;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,MAAuB;;IACpD,MAAM,aAAa,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;IAEzF,OAAO;QACH,GAAG,EAAE,aAAa,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,mCAAI,0BAAkB,CAAC,GAAG,CAAC;QACzD,IAAI,EAAE,aAAa,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,mCAAI,0BAAkB,CAAC,IAAI,CAAC;QAC5D,QAAQ,EAAE,aAAa,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,mCAAI,0BAAkB,CAAC,QAAQ,CAAC;QACxE,KAAK,EAAE,aAAa,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,mCAAI,0BAAkB,CAAC,KAAK,CAAC;KAClE,CAAC;AACN,CAAC"}

package/dist/config.d.ts

@@ -20,9 +20,14 @@ export interface ObjectQLConfig {
      */
     packages?: string[];
     /**
-     * List of npm packages or presets to load.
+     * @deprecated Use 'modules' instead.
      */
     presets?: string[];
+    /**
+     * List of modules to load.
+     * Can be npm packages or local directories.
+     */
+    modules?: string[];
     /**
      * List of plugins to load.
      * Can be an instance of ObjectQLPlugin or a package name string.

package/dist/field.d.ts

@@ -157,13 +157,23 @@ export interface FieldConfig {
     ai_context?: ValidationAiContext;
     /** Dimension of the vector for 'vector' type fields. */
     dimension?: number;
-    /** Formula expression. */
+    /** Formula expression (for 'formula' type fields). */
     formula?: string;
+    /** Expected return data type for formula fields. */
+    data_type?: 'number' | 'text' | 'date' | 'datetime' | 'boolean' | 'currency' | 'percent';
+    /** Display format for formula results (e.g., "0.00", "YYYY-MM-DD"). */
+    format?: string;
+    /** Decimal precision for numeric formula results. */
+    precision?: number;
+    /** Treat blank/null as zero in formula calculations. */
+    blank_as_zero?: boolean;
+    /** Default value for null/undefined referenced fields in formulas. */
+    treat_blank_as?: string | number | boolean | Date | null;
     /** Object to summarize. */
     summary_object?: string;
     /** Field on the summary object. */
     summary_field?: string;
     /** Type of summary (count, sum, min, max, avg). */
     summary_type?: string;
-    filters?: any[];
+    filters?: unknown[];
 }

package/dist/form.d.ts

@@ -0,0 +1,315 @@
+/**
+ * Form Metadata Definition
+ *
+ * Defines the structure for forms, layouts, and field arrangements in ObjectQL.
+ * Forms control how data is entered, edited, and displayed to users with
+ * sections, tabs, columns, and conditional visibility.
+ *
+ * Based on patterns from Salesforce Page Layouts, Dynamics Forms, and similar platforms.
+ */
+import { ValidationCondition } from './validation';
+/**
+ * Form types supported by ObjectQL
+ */
+export type FormType = 'create' | 'edit' | 'view' | 'wizard' | 'quick_create' | 'inline' | 'custom';
+/**
+ * Layout types for form arrangement
+ */
+export type FormLayoutType = 'single_column' | 'two_column' | 'three_column' | 'tabs' | 'accordion' | 'custom';
+/**
+ * Field display configuration in form
+ */
+export interface FormField {
+    /** Field name */
+    name: string;
+    /** Display label (overrides field config) */
+    label?: string;
+    /** Help text (overrides field config) */
+    help_text?: string;
+    /** Placeholder text */
+    placeholder?: string;
+    /** Whether field is required in this form */
+    required?: boolean;
+    /** Whether field is readonly in this form */
+    readonly?: boolean;
+    /** Whether field is hidden in this form */
+    hidden?: boolean;
+    /** Field width in columns (for multi-column layouts) */
+    width?: number;
+    /** Span across columns */
+    span?: number;
+    /** Visibility condition */
+    visible_when?: ValidationCondition | string;
+    /** Enabled condition */
+    enabled_when?: ValidationCondition | string;
+    /** Default value override */
+    default_value?: any;
+    /** Field-specific validation override */
+    validation?: any;
+    /** Custom CSS class */
+    class_name?: string;
+    /** Field-specific configuration */
+    config?: Record<string, any>;
+}
+/**
+ * Form section configuration
+ */
+export interface FormSection {
+    /** Section identifier */
+    id?: string;
+    /** Section label */
+    label?: string;
+    /** Section description */
+    description?: string;
+    /** Number of columns in this section */
+    columns?: number;
+    /** Fields in this section */
+    fields: (string | FormField)[];
+    /** Whether section is collapsible */
+    collapsible?: boolean;
+    /** Default collapsed state */
+    collapsed?: boolean;
+    /** Visibility condition */
+    visible_when?: ValidationCondition | string;
+    /** Section border style */
+    border?: boolean;
+    /** Section background color */
+    background?: string;
+    /** Custom CSS class */
+    class_name?: string;
+}
+/**
+ * Form tab configuration
+ */
+export interface FormTab {
+    /** Tab identifier */
+    id: string;
+    /** Tab label */
+    label: string;
+    /** Tab icon */
+    icon?: string;
+    /** Sections within this tab */
+    sections: FormSection[];
+    /** Visibility condition */
+    visible_when?: ValidationCondition | string;
+    /** Badge/count to display on tab */
+    badge?: string | number;
+    /** Whether this tab is disabled */
+    disabled?: boolean;
+}
+/**
+ * Wizard step configuration
+ */
+export interface WizardStep {
+    /** Step identifier */
+    id: string;
+    /** Step label */
+    label: string;
+    /** Step description */
+    description?: string;
+    /** Icon for step */
+    icon?: string;
+    /** Sections in this step */
+    sections: FormSection[];
+    /** Validation to pass before proceeding */
+    validation?: ValidationCondition;
+    /** Whether user can skip this step */
+    skippable?: boolean;
+    /** Visibility condition */
+    visible_when?: ValidationCondition | string;
+    /** Action to execute when step is completed */
+    on_complete?: string;
+}
+/**
+ * Form action/button configuration
+ */
+export interface FormAction {
+    /** Action identifier */
+    name: string;
+    /** Display label */
+    label: string;
+    /** Button type */
+    type?: 'submit' | 'cancel' | 'custom' | 'save' | 'save_new' | 'save_close';
+    /** Icon */
+    icon?: string;
+    /** Button style variant */
+    variant?: 'primary' | 'secondary' | 'danger' | 'success' | 'ghost';
+    /** Position */
+    position?: 'header' | 'footer' | 'both';
+    /** Confirmation message before executing */
+    confirm?: string;
+    /** Visibility condition */
+    visible_when?: ValidationCondition | string;
+    /** Enabled condition */
+    enabled_when?: ValidationCondition | string;
+    /** Custom action handler */
+    handler?: string;
+    /** Navigate to path after action */
+    redirect?: string;
+}
+/**
+ * Form validation configuration
+ */
+export interface FormValidationConfig {
+    /** Enable real-time validation */
+    realtime?: boolean;
+    /** Validate on blur */
+    validate_on_blur?: boolean;
+    /** Validate on change */
+    validate_on_change?: boolean;
+    /** Show validation summary */
+    show_summary?: boolean;
+    /** Custom validation rules */
+    rules?: any[];
+}
+/**
+ * Form header configuration
+ */
+export interface FormHeader {
+    /** Show header */
+    show?: boolean;
+    /** Header title */
+    title?: string;
+    /** Header subtitle */
+    subtitle?: string;
+    /** Show record info (created, updated dates) */
+    show_record_info?: boolean;
+    /** Custom header component */
+    component?: string;
+}
+/**
+ * Form footer configuration
+ */
+export interface FormFooter {
+    /** Show footer */
+    show?: boolean;
+    /** Footer actions */
+    actions?: FormAction[];
+    /** Footer position */
+    position?: 'sticky' | 'static';
+    /** Custom footer component */
+    component?: string;
+}
+/**
+ * Form autosave configuration
+ */
+export interface FormAutosaveConfig {
+    /** Enable autosave */
+    enabled: boolean;
+    /** Autosave interval in milliseconds */
+    interval?: number;
+    /** Show autosave indicator */
+    show_indicator?: boolean;
+    /** Autosave on field blur */
+    on_blur?: boolean;
+}
+/**
+ * Complete form configuration
+ */
+export interface FormConfig {
+    /** Unique form identifier */
+    name: string;
+    /** Display label */
+    label: string;
+    /** Form type */
+    type?: FormType;
+    /** Object this form is for */
+    object: string;
+    /** Form description */
+    description?: string;
+    /** Layout type */
+    layout: FormLayoutType;
+    /** Number of columns (for column layouts) */
+    columns?: number;
+    /** Sections (for non-tab layouts) */
+    sections?: FormSection[];
+    /** Tabs (for tab layout) */
+    tabs?: FormTab[];
+    /** Wizard steps (for wizard layout) */
+    steps?: WizardStep[];
+    /** Form header */
+    header?: FormHeader;
+    /** Form footer */
+    footer?: FormFooter;
+    /** Form actions/buttons */
+    actions?: FormAction[];
+    /** Validation configuration */
+    validation?: FormValidationConfig;
+    /** Autosave configuration */
+    autosave?: FormAutosaveConfig;
+    /** Show required field indicator */
+    show_required_indicator?: boolean;
+    /** Show field help text */
+    show_help_text?: boolean;
+    /** Compact mode (reduced spacing) */
+    compact?: boolean;
+    /** Read-only mode */
+    readonly?: boolean;
+    /** Disable all fields */
+    disabled?: boolean;
+    /** Show success message after save */
+    success_message?: string;
+    /** Redirect after successful save */
+    redirect_on_success?: string;
+    /** Access control */
+    permissions?: {
+        /** Roles that can view this form */
+        view?: string[];
+        /** Roles that can edit using this form */
+        edit?: string[];
+    };
+    /** Custom form handler */
+    handler?: string;
+    /** Custom CSS class */
+    class_name?: string;
+    /** Form width (for modal forms) */
+    width?: string;
+    /** Maximum width */
+    max_width?: string;
+    /** Custom form configuration */
+    config?: Record<string, any>;
+    /** AI context for form generation */
+    ai_context?: {
+        /** Purpose of this form */
+        intent?: string;
+        /** User experience goals */
+        ux_goals?: string[];
+        /** Field organization strategy */
+        organization_strategy?: string;
+    };
+}
+/**
+ * Lightweight form reference
+ * Used in navigation, dropdowns, and form selectors
+ */
+export interface FormReference {
+    /** Form name/identifier */
+    name: string;
+    /** Display label */
+    label?: string;
+    /** Form type */
+    type?: FormType;
+    /** Whether this is the default form */
+    is_default?: boolean;
+}
+/**
+ * Dynamic form state (runtime)
+ */
+export interface FormState {
+    /** Current form values */
+    values: Record<string, any>;
+    /** Field errors */
+    errors: Record<string, string>;
+    /** Touched fields */
+    touched: Record<string, boolean>;
+    /** Whether form is submitting */
+    submitting: boolean;
+    /** Whether form is valid */
+    valid: boolean;
+    /** Whether form is dirty (has changes) */
+    dirty: boolean;
+    /** Current wizard step (for wizard forms) */
+    current_step?: number;
+    /** Custom state */
+    custom?: Record<string, any>;
+}

package/dist/form.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * Form Metadata Definition
+ *
+ * Defines the structure for forms, layouts, and field arrangements in ObjectQL.
+ * Forms control how data is entered, edited, and displayed to users with
+ * sections, tabs, columns, and conditional visibility.
+ *
+ * Based on patterns from Salesforce Page Layouts, Dynamics Forms, and similar platforms.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=form.js.map

package/dist/form.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"form.js","sourceRoot":"","sources":["../src/form.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG"}