@objectstack/spec 0.6.1 → 0.7.2

package/dist/data/external-lookup.zod.d.ts

@@ -0,0 +1,662 @@
+import { z } from 'zod';
+/**
+ * External Data Source Schema
+ *
+ * Configuration for connecting to external data systems.
+ * Similar to Salesforce External Objects for real-time data integration.
+ *
+ * @example
+ * ```json
+ * {
+ *   "id": "salesforce-accounts",
+ *   "name": "Salesforce Account Data",
+ *   "type": "rest-api",
+ *   "endpoint": "https://api.salesforce.com/services/data/v58.0",
+ *   "authentication": {
+ *     "type": "oauth2",
+ *     "config": {
+ *       "clientId": "...",
+ *       "clientSecret": "...",
+ *       "tokenUrl": "https://login.salesforce.com/services/oauth2/token"
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export declare const ExternalDataSourceSchema: z.ZodObject<{
+    /**
+     * Unique identifier for the external data source
+     */
+    id: z.ZodString;
+    /**
+     * Human-readable name of the data source
+     */
+    name: z.ZodString;
+    /**
+     * Protocol type for connecting to the data source
+     */
+    type: z.ZodEnum<["odata", "rest-api", "graphql", "custom"]>;
+    /**
+     * Base URL endpoint for the external system
+     */
+    endpoint: z.ZodString;
+    /**
+     * Authentication configuration
+     */
+    authentication: z.ZodObject<{
+        /**
+         * Authentication method
+         */
+        type: z.ZodEnum<["oauth2", "api-key", "basic", "none"]>;
+        /**
+         * Authentication-specific configuration
+         * Structure varies based on auth type
+         */
+        config: z.ZodRecord<z.ZodString, z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        type: "none" | "oauth2" | "api-key" | "basic";
+        config: Record<string, any>;
+    }, {
+        type: "none" | "oauth2" | "api-key" | "basic";
+        config: Record<string, any>;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "custom" | "odata" | "rest-api" | "graphql";
+    name: string;
+    id: string;
+    endpoint: string;
+    authentication: {
+        type: "none" | "oauth2" | "api-key" | "basic";
+        config: Record<string, any>;
+    };
+}, {
+    type: "custom" | "odata" | "rest-api" | "graphql";
+    name: string;
+    id: string;
+    endpoint: string;
+    authentication: {
+        type: "none" | "oauth2" | "api-key" | "basic";
+        config: Record<string, any>;
+    };
+}>;
+/**
+ * Field Mapping Schema for External Lookups
+ *
+ * Extends the base field mapping with external lookup specific features.
+ * Uses the canonical field mapping protocol from shared/mapping.zod.ts.
+ *
+ * @see {@link BaseFieldMappingSchema} for the base field mapping schema
+ *
+ * @example
+ * ```json
+ * {
+ *   "source": "AccountName",
+ *   "target": "name",
+ *   "readonly": true
+ * }
+ * ```
+ */
+export declare const ExternalFieldMappingSchema: z.ZodObject<{
+    source: z.ZodString;
+    target: z.ZodString;
+    transform: z.ZodOptional<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+        type: z.ZodLiteral<"constant">;
+        value: z.ZodAny;
+    }, "strip", z.ZodTypeAny, {
+        type: "constant";
+        value?: any;
+    }, {
+        type: "constant";
+        value?: any;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"cast">;
+        targetType: z.ZodEnum<["string", "number", "boolean", "date"]>;
+    }, "strip", z.ZodTypeAny, {
+        type: "cast";
+        targetType: "string" | "number" | "boolean" | "date";
+    }, {
+        type: "cast";
+        targetType: "string" | "number" | "boolean" | "date";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"lookup">;
+        table: z.ZodString;
+        keyField: z.ZodString;
+        valueField: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "lookup";
+        table: string;
+        keyField: string;
+        valueField: string;
+    }, {
+        type: "lookup";
+        table: string;
+        keyField: string;
+        valueField: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"javascript">;
+        expression: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "javascript";
+        expression: string;
+    }, {
+        type: "javascript";
+        expression: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"map">;
+        mappings: z.ZodRecord<z.ZodString, z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        type: "map";
+        mappings: Record<string, any>;
+    }, {
+        type: "map";
+        mappings: Record<string, any>;
+    }>]>>;
+    defaultValue: z.ZodOptional<z.ZodAny>;
+} & {
+    /**
+     * Field data type
+     */
+    type: z.ZodOptional<z.ZodString>;
+    /**
+     * Whether the field is read-only
+     * @default true
+     */
+    readonly: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    source: string;
+    target: string;
+    readonly: boolean;
+    type?: string | undefined;
+    transform?: {
+        type: "constant";
+        value?: any;
+    } | {
+        type: "cast";
+        targetType: "string" | "number" | "boolean" | "date";
+    } | {
+        type: "lookup";
+        table: string;
+        keyField: string;
+        valueField: string;
+    } | {
+        type: "javascript";
+        expression: string;
+    } | {
+        type: "map";
+        mappings: Record<string, any>;
+    } | undefined;
+    defaultValue?: any;
+}, {
+    source: string;
+    target: string;
+    type?: string | undefined;
+    transform?: {
+        type: "constant";
+        value?: any;
+    } | {
+        type: "cast";
+        targetType: "string" | "number" | "boolean" | "date";
+    } | {
+        type: "lookup";
+        table: string;
+        keyField: string;
+        valueField: string;
+    } | {
+        type: "javascript";
+        expression: string;
+    } | {
+        type: "map";
+        mappings: Record<string, any>;
+    } | undefined;
+    defaultValue?: any;
+    readonly?: boolean | undefined;
+}>;
+/**
+ * External Lookup Schema
+ *
+ * Real-time data lookup protocol for external systems.
+ * Enables querying external data sources without replication.
+ * Inspired by Salesforce External Objects and OData protocols.
+ *
+ * @example
+ * ```json
+ * {
+ *   "fieldName": "external_account",
+ *   "dataSource": {
+ *     "id": "salesforce-api",
+ *     "name": "Salesforce",
+ *     "type": "rest-api",
+ *     "endpoint": "https://api.salesforce.com/services/data/v58.0",
+ *     "authentication": {
+ *       "type": "oauth2",
+ *       "config": {"clientId": "..."}
+ *     }
+ *   },
+ *   "query": {
+ *     "endpoint": "/sobjects/Account",
+ *     "method": "GET",
+ *     "parameters": {"limit": 100}
+ *   },
+ *   "fieldMappings": [
+ *     {
+ *       "externalField": "Name",
+ *       "localField": "account_name",
+ *       "type": "text",
+ *       "readonly": true
+ *     }
+ *   ],
+ *   "caching": {
+ *     "enabled": true,
+ *     "ttl": 300,
+ *     "strategy": "ttl"
+ *   },
+ *   "fallback": {
+ *     "enabled": true,
+ *     "showError": true
+ *   },
+ *   "rateLimit": {
+ *     "requestsPerSecond": 10,
+ *     "burstSize": 20
+ *   }
+ * }
+ * ```
+ */
+export declare const ExternalLookupSchema: z.ZodObject<{
+    /**
+     * Name of the field that uses external lookup
+     */
+    fieldName: z.ZodString;
+    /**
+     * External data source configuration
+     */
+    dataSource: z.ZodObject<{
+        /**
+         * Unique identifier for the external data source
+         */
+        id: z.ZodString;
+        /**
+         * Human-readable name of the data source
+         */
+        name: z.ZodString;
+        /**
+         * Protocol type for connecting to the data source
+         */
+        type: z.ZodEnum<["odata", "rest-api", "graphql", "custom"]>;
+        /**
+         * Base URL endpoint for the external system
+         */
+        endpoint: z.ZodString;
+        /**
+         * Authentication configuration
+         */
+        authentication: z.ZodObject<{
+            /**
+             * Authentication method
+             */
+            type: z.ZodEnum<["oauth2", "api-key", "basic", "none"]>;
+            /**
+             * Authentication-specific configuration
+             * Structure varies based on auth type
+             */
+            config: z.ZodRecord<z.ZodString, z.ZodAny>;
+        }, "strip", z.ZodTypeAny, {
+            type: "none" | "oauth2" | "api-key" | "basic";
+            config: Record<string, any>;
+        }, {
+            type: "none" | "oauth2" | "api-key" | "basic";
+            config: Record<string, any>;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        type: "custom" | "odata" | "rest-api" | "graphql";
+        name: string;
+        id: string;
+        endpoint: string;
+        authentication: {
+            type: "none" | "oauth2" | "api-key" | "basic";
+            config: Record<string, any>;
+        };
+    }, {
+        type: "custom" | "odata" | "rest-api" | "graphql";
+        name: string;
+        id: string;
+        endpoint: string;
+        authentication: {
+            type: "none" | "oauth2" | "api-key" | "basic";
+            config: Record<string, any>;
+        };
+    }>;
+    /**
+     * Query configuration for fetching external data
+     */
+    query: z.ZodObject<{
+        /**
+         * API endpoint path (relative to base endpoint)
+         */
+        endpoint: z.ZodString;
+        /**
+         * HTTP method for the query
+         * @default 'GET'
+         */
+        method: z.ZodDefault<z.ZodOptional<z.ZodEnum<["GET", "POST"]>>>;
+        /**
+         * Query parameters or request body
+         */
+        parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        method: "GET" | "POST";
+        endpoint: string;
+        parameters?: Record<string, any> | undefined;
+    }, {
+        endpoint: string;
+        method?: "GET" | "POST" | undefined;
+        parameters?: Record<string, any> | undefined;
+    }>;
+    /**
+     * Mapping between external and local fields
+     */
+    fieldMappings: z.ZodArray<z.ZodObject<{
+        source: z.ZodString;
+        target: z.ZodString;
+        transform: z.ZodOptional<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+            type: z.ZodLiteral<"constant">;
+            value: z.ZodAny;
+        }, "strip", z.ZodTypeAny, {
+            type: "constant";
+            value?: any;
+        }, {
+            type: "constant";
+            value?: any;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"cast">;
+            targetType: z.ZodEnum<["string", "number", "boolean", "date"]>;
+        }, "strip", z.ZodTypeAny, {
+            type: "cast";
+            targetType: "string" | "number" | "boolean" | "date";
+        }, {
+            type: "cast";
+            targetType: "string" | "number" | "boolean" | "date";
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"lookup">;
+            table: z.ZodString;
+            keyField: z.ZodString;
+            valueField: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "lookup";
+            table: string;
+            keyField: string;
+            valueField: string;
+        }, {
+            type: "lookup";
+            table: string;
+            keyField: string;
+            valueField: string;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"javascript">;
+            expression: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "javascript";
+            expression: string;
+        }, {
+            type: "javascript";
+            expression: string;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"map">;
+            mappings: z.ZodRecord<z.ZodString, z.ZodAny>;
+        }, "strip", z.ZodTypeAny, {
+            type: "map";
+            mappings: Record<string, any>;
+        }, {
+            type: "map";
+            mappings: Record<string, any>;
+        }>]>>;
+        defaultValue: z.ZodOptional<z.ZodAny>;
+    } & {
+        /**
+         * Field data type
+         */
+        type: z.ZodOptional<z.ZodString>;
+        /**
+         * Whether the field is read-only
+         * @default true
+         */
+        readonly: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        source: string;
+        target: string;
+        readonly: boolean;
+        type?: string | undefined;
+        transform?: {
+            type: "constant";
+            value?: any;
+        } | {
+            type: "cast";
+            targetType: "string" | "number" | "boolean" | "date";
+        } | {
+            type: "lookup";
+            table: string;
+            keyField: string;
+            valueField: string;
+        } | {
+            type: "javascript";
+            expression: string;
+        } | {
+            type: "map";
+            mappings: Record<string, any>;
+        } | undefined;
+        defaultValue?: any;
+    }, {
+        source: string;
+        target: string;
+        type?: string | undefined;
+        transform?: {
+            type: "constant";
+            value?: any;
+        } | {
+            type: "cast";
+            targetType: "string" | "number" | "boolean" | "date";
+        } | {
+            type: "lookup";
+            table: string;
+            keyField: string;
+            valueField: string;
+        } | {
+            type: "javascript";
+            expression: string;
+        } | {
+            type: "map";
+            mappings: Record<string, any>;
+        } | undefined;
+        defaultValue?: any;
+        readonly?: boolean | undefined;
+    }>, "many">;
+    /**
+     * Cache configuration for external data
+     */
+    caching: z.ZodOptional<z.ZodObject<{
+        /**
+         * Whether caching is enabled
+         * @default true
+         */
+        enabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        /**
+         * Time-to-live in seconds
+         * @default 300
+         */
+        ttl: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+        /**
+         * Cache eviction strategy
+         * @default 'ttl'
+         */
+        strategy: z.ZodDefault<z.ZodOptional<z.ZodEnum<["lru", "lfu", "ttl"]>>>;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        strategy: "ttl" | "lru" | "lfu";
+        ttl: number;
+    }, {
+        enabled?: boolean | undefined;
+        strategy?: "ttl" | "lru" | "lfu" | undefined;
+        ttl?: number | undefined;
+    }>>;
+    /**
+     * Fallback behavior when external system is unavailable
+     */
+    fallback: z.ZodOptional<z.ZodObject<{
+        /**
+         * Whether fallback is enabled
+         * @default true
+         */
+        enabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        /**
+         * Default value to use when external system fails
+         */
+        defaultValue: z.ZodOptional<z.ZodAny>;
+        /**
+         * Whether to show error message to user
+         * @default true
+         */
+        showError: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        showError: boolean;
+        defaultValue?: any;
+    }, {
+        defaultValue?: any;
+        enabled?: boolean | undefined;
+        showError?: boolean | undefined;
+    }>>;
+    /**
+     * Rate limiting to prevent overwhelming external system
+     */
+    rateLimit: z.ZodOptional<z.ZodObject<{
+        /**
+         * Maximum requests per second
+         */
+        requestsPerSecond: z.ZodNumber;
+        /**
+         * Burst size for handling spikes
+         */
+        burstSize: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        requestsPerSecond: number;
+        burstSize?: number | undefined;
+    }, {
+        requestsPerSecond: number;
+        burstSize?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    query: {
+        method: "GET" | "POST";
+        endpoint: string;
+        parameters?: Record<string, any> | undefined;
+    };
+    fieldName: string;
+    dataSource: {
+        type: "custom" | "odata" | "rest-api" | "graphql";
+        name: string;
+        id: string;
+        endpoint: string;
+        authentication: {
+            type: "none" | "oauth2" | "api-key" | "basic";
+            config: Record<string, any>;
+        };
+    };
+    fieldMappings: {
+        source: string;
+        target: string;
+        readonly: boolean;
+        type?: string | undefined;
+        transform?: {
+            type: "constant";
+            value?: any;
+        } | {
+            type: "cast";
+            targetType: "string" | "number" | "boolean" | "date";
+        } | {
+            type: "lookup";
+            table: string;
+            keyField: string;
+            valueField: string;
+        } | {
+            type: "javascript";
+            expression: string;
+        } | {
+            type: "map";
+            mappings: Record<string, any>;
+        } | undefined;
+        defaultValue?: any;
+    }[];
+    caching?: {
+        enabled: boolean;
+        strategy: "ttl" | "lru" | "lfu";
+        ttl: number;
+    } | undefined;
+    fallback?: {
+        enabled: boolean;
+        showError: boolean;
+        defaultValue?: any;
+    } | undefined;
+    rateLimit?: {
+        requestsPerSecond: number;
+        burstSize?: number | undefined;
+    } | undefined;
+}, {
+    query: {
+        endpoint: string;
+        method?: "GET" | "POST" | undefined;
+        parameters?: Record<string, any> | undefined;
+    };
+    fieldName: string;
+    dataSource: {
+        type: "custom" | "odata" | "rest-api" | "graphql";
+        name: string;
+        id: string;
+        endpoint: string;
+        authentication: {
+            type: "none" | "oauth2" | "api-key" | "basic";
+            config: Record<string, any>;
+        };
+    };
+    fieldMappings: {
+        source: string;
+        target: string;
+        type?: string | undefined;
+        transform?: {
+            type: "constant";
+            value?: any;
+        } | {
+            type: "cast";
+            targetType: "string" | "number" | "boolean" | "date";
+        } | {
+            type: "lookup";
+            table: string;
+            keyField: string;
+            valueField: string;
+        } | {
+            type: "javascript";
+            expression: string;
+        } | {
+            type: "map";
+            mappings: Record<string, any>;
+        } | undefined;
+        defaultValue?: any;
+        readonly?: boolean | undefined;
+    }[];
+    caching?: {
+        enabled?: boolean | undefined;
+        strategy?: "ttl" | "lru" | "lfu" | undefined;
+        ttl?: number | undefined;
+    } | undefined;
+    fallback?: {
+        defaultValue?: any;
+        enabled?: boolean | undefined;
+        showError?: boolean | undefined;
+    } | undefined;
+    rateLimit?: {
+        requestsPerSecond: number;
+        burstSize?: number | undefined;
+    } | undefined;
+}>;
+export type ExternalLookup = z.infer<typeof ExternalLookupSchema>;
+export type ExternalDataSource = z.infer<typeof ExternalDataSourceSchema>;
+export type ExternalFieldMapping = z.infer<typeof ExternalFieldMappingSchema>;
+//# sourceMappingURL=external-lookup.zod.d.ts.map

package/dist/data/external-lookup.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"external-lookup.zod.d.ts","sourceRoot":"","sources":["../../src/data/external-lookup.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,wBAAwB;IACnC;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;QAED;;WAEG;;QAGH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGL,CAAC;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACrC;;OAEG;;IAGH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;OAEG;;IAGH;;OAEG;;QA7HH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;YAED;;eAEG;;YAGH;;;eAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAgGL;;OAEG;;QAED;;WAEG;;QAGH;;;WAGG;;QAGH;;WAEG;;;;;;;;;;;IAIL;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAhGH;;WAEG;;QAGH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA2FH;;OAEG;;QAED;;;WAGG;;QAGH;;;WAGG;;QAGH;;;WAGG;;;;;;;;;;;IAIL;;OAEG;;QAED;;;WAGG;;QAGH;;WAEG;;QAGH;;;WAGG;;;;;;;;;;;IAIL;;OAEG;;QAED;;WAEG;;QAGH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGL,CAAC;AAGH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC"}