@objectstack/spec 0.1.0 → 0.1.2

package/dist/data/mapping.zod.d.ts

@@ -0,0 +1,470 @@
+import { z } from 'zod';
+/**
+ * Transformation Logic
+ * Built-in helpers for converting data during import.
+ */
+export declare const TransformType: z.ZodEnum<["none", "constant", "lookup", "split", "join", "javascript", "map"]>;
+/**
+ * Field Mapping Item
+ */
+export declare const FieldMappingSchema: z.ZodObject<{
+    /** Source Column */
+    source: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+    /** Target Field */
+    target: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+    /** Transformation */
+    transform: z.ZodDefault<z.ZodEnum<["none", "constant", "lookup", "split", "join", "javascript", "map"]>>;
+    /** Configuration for transform */
+    params: z.ZodOptional<z.ZodObject<{
+        value: z.ZodOptional<z.ZodAny>;
+        object: z.ZodOptional<z.ZodString>;
+        fromField: z.ZodOptional<z.ZodString>;
+        toField: z.ZodOptional<z.ZodString>;
+        autoCreate: z.ZodOptional<z.ZodBoolean>;
+        valueMap: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        separator: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        object?: string | undefined;
+        value?: any;
+        fromField?: string | undefined;
+        toField?: string | undefined;
+        autoCreate?: boolean | undefined;
+        valueMap?: Record<string, any> | undefined;
+        separator?: string | undefined;
+    }, {
+        object?: string | undefined;
+        value?: any;
+        fromField?: string | undefined;
+        toField?: string | undefined;
+        autoCreate?: boolean | undefined;
+        valueMap?: Record<string, any> | undefined;
+        separator?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    source: string | string[];
+    target: string | string[];
+    transform: "lookup" | "join" | "map" | "none" | "constant" | "split" | "javascript";
+    params?: {
+        object?: string | undefined;
+        value?: any;
+        fromField?: string | undefined;
+        toField?: string | undefined;
+        autoCreate?: boolean | undefined;
+        valueMap?: Record<string, any> | undefined;
+        separator?: string | undefined;
+    } | undefined;
+}, {
+    source: string | string[];
+    target: string | string[];
+    params?: {
+        object?: string | undefined;
+        value?: any;
+        fromField?: string | undefined;
+        toField?: string | undefined;
+        autoCreate?: boolean | undefined;
+        valueMap?: Record<string, any> | undefined;
+        separator?: string | undefined;
+    } | undefined;
+    transform?: "lookup" | "join" | "map" | "none" | "constant" | "split" | "javascript" | undefined;
+}>;
+/**
+ * ETL Mapping Schema
+ * Definition for importing/exporting data defined in `integration-etl.mdx`.
+ */
+export declare const MappingSchema: z.ZodObject<{
+    /** Identity */
+    name: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    /** Scope */
+    sourceFormat: z.ZodDefault<z.ZodEnum<["csv", "json", "xml", "sql"]>>;
+    targetObject: z.ZodString;
+    /** Column Mappings */
+    fieldMapping: z.ZodArray<z.ZodObject<{
+        /** Source Column */
+        source: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+        /** Target Field */
+        target: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+        /** Transformation */
+        transform: z.ZodDefault<z.ZodEnum<["none", "constant", "lookup", "split", "join", "javascript", "map"]>>;
+        /** Configuration for transform */
+        params: z.ZodOptional<z.ZodObject<{
+            value: z.ZodOptional<z.ZodAny>;
+            object: z.ZodOptional<z.ZodString>;
+            fromField: z.ZodOptional<z.ZodString>;
+            toField: z.ZodOptional<z.ZodString>;
+            autoCreate: z.ZodOptional<z.ZodBoolean>;
+            valueMap: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+            separator: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            object?: string | undefined;
+            value?: any;
+            fromField?: string | undefined;
+            toField?: string | undefined;
+            autoCreate?: boolean | undefined;
+            valueMap?: Record<string, any> | undefined;
+            separator?: string | undefined;
+        }, {
+            object?: string | undefined;
+            value?: any;
+            fromField?: string | undefined;
+            toField?: string | undefined;
+            autoCreate?: boolean | undefined;
+            valueMap?: Record<string, any> | undefined;
+            separator?: string | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        source: string | string[];
+        target: string | string[];
+        transform: "lookup" | "join" | "map" | "none" | "constant" | "split" | "javascript";
+        params?: {
+            object?: string | undefined;
+            value?: any;
+            fromField?: string | undefined;
+            toField?: string | undefined;
+            autoCreate?: boolean | undefined;
+            valueMap?: Record<string, any> | undefined;
+            separator?: string | undefined;
+        } | undefined;
+    }, {
+        source: string | string[];
+        target: string | string[];
+        params?: {
+            object?: string | undefined;
+            value?: any;
+            fromField?: string | undefined;
+            toField?: string | undefined;
+            autoCreate?: boolean | undefined;
+            valueMap?: Record<string, any> | undefined;
+            separator?: string | undefined;
+        } | undefined;
+        transform?: "lookup" | "join" | "map" | "none" | "constant" | "split" | "javascript" | undefined;
+    }>, "many">;
+    /** Upsert Logic */
+    mode: z.ZodDefault<z.ZodEnum<["insert", "update", "upsert"]>>;
+    upsertKey: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    /** Extract Logic (For Export) */
+    extractQuery: z.ZodOptional<z.ZodObject<{
+        object: z.ZodString;
+        fields: z.ZodOptional<z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">>;
+        aggregations: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            function: z.ZodEnum<["count", "sum", "avg", "min", "max", "count_distinct", "array_agg", "string_agg"]>;
+            field: z.ZodOptional<z.ZodString>;
+            alias: z.ZodString;
+            distinct: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            function: "min" | "max" | "count" | "sum" | "avg" | "count_distinct" | "array_agg" | "string_agg";
+            alias: string;
+            field?: string | undefined;
+            distinct?: boolean | undefined;
+        }, {
+            function: "min" | "max" | "count" | "sum" | "avg" | "count_distinct" | "array_agg" | "string_agg";
+            alias: string;
+            field?: string | undefined;
+            distinct?: boolean | undefined;
+        }>, "many">>;
+        windowFunctions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            function: z.ZodEnum<["row_number", "rank", "dense_rank", "percent_rank", "lag", "lead", "first_value", "last_value", "sum", "avg", "count", "min", "max"]>;
+            field: z.ZodOptional<z.ZodString>;
+            alias: z.ZodString;
+            over: z.ZodObject<{
+                partitionBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                orderBy: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    field: z.ZodString;
+                    order: z.ZodDefault<z.ZodEnum<["asc", "desc"]>>;
+                }, "strip", z.ZodTypeAny, {
+                    field: string;
+                    order: "asc" | "desc";
+                }, {
+                    field: string;
+                    order?: "asc" | "desc" | undefined;
+                }>, "many">>;
+                frame: z.ZodOptional<z.ZodObject<{
+                    type: z.ZodOptional<z.ZodEnum<["rows", "range"]>>;
+                    start: z.ZodOptional<z.ZodString>;
+                    end: z.ZodOptional<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    type?: "rows" | "range" | undefined;
+                    start?: string | undefined;
+                    end?: string | undefined;
+                }, {
+                    type?: "rows" | "range" | undefined;
+                    start?: string | undefined;
+                    end?: string | undefined;
+                }>>;
+            }, "strip", z.ZodTypeAny, {
+                partitionBy?: string[] | undefined;
+                orderBy?: {
+                    field: string;
+                    order: "asc" | "desc";
+                }[] | undefined;
+                frame?: {
+                    type?: "rows" | "range" | undefined;
+                    start?: string | undefined;
+                    end?: string | undefined;
+                } | undefined;
+            }, {
+                partitionBy?: string[] | undefined;
+                orderBy?: {
+                    field: string;
+                    order?: "asc" | "desc" | undefined;
+                }[] | undefined;
+                frame?: {
+                    type?: "rows" | "range" | undefined;
+                    start?: string | undefined;
+                    end?: string | undefined;
+                } | undefined;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            function: "min" | "max" | "count" | "sum" | "avg" | "row_number" | "rank" | "dense_rank" | "percent_rank" | "lag" | "lead" | "first_value" | "last_value";
+            alias: string;
+            over: {
+                partitionBy?: string[] | undefined;
+                orderBy?: {
+                    field: string;
+                    order: "asc" | "desc";
+                }[] | undefined;
+                frame?: {
+                    type?: "rows" | "range" | undefined;
+                    start?: string | undefined;
+                    end?: string | undefined;
+                } | undefined;
+            };
+            field?: string | undefined;
+        }, {
+            function: "min" | "max" | "count" | "sum" | "avg" | "row_number" | "rank" | "dense_rank" | "percent_rank" | "lag" | "lead" | "first_value" | "last_value";
+            alias: string;
+            over: {
+                partitionBy?: string[] | undefined;
+                orderBy?: {
+                    field: string;
+                    order?: "asc" | "desc" | undefined;
+                }[] | undefined;
+                frame?: {
+                    type?: "rows" | "range" | undefined;
+                    start?: string | undefined;
+                    end?: string | undefined;
+                } | undefined;
+            };
+            field?: string | undefined;
+        }>, "many">>;
+        filters: z.ZodOptional<z.ZodType<any, z.ZodTypeDef, any>>;
+        joins: z.ZodOptional<z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">>;
+        groupBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        having: z.ZodOptional<z.ZodType<any, z.ZodTypeDef, any>>;
+        sort: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            field: z.ZodString;
+            order: z.ZodDefault<z.ZodEnum<["asc", "desc"]>>;
+        }, "strip", z.ZodTypeAny, {
+            field: string;
+            order: "asc" | "desc";
+        }, {
+            field: string;
+            order?: "asc" | "desc" | undefined;
+        }>, "many">>;
+        top: z.ZodOptional<z.ZodNumber>;
+        skip: z.ZodOptional<z.ZodNumber>;
+        distinct: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        object: string;
+        sort?: {
+            field: string;
+            order: "asc" | "desc";
+        }[] | undefined;
+        fields?: any[] | undefined;
+        distinct?: boolean | undefined;
+        aggregations?: {
+            function: "min" | "max" | "count" | "sum" | "avg" | "count_distinct" | "array_agg" | "string_agg";
+            alias: string;
+            field?: string | undefined;
+            distinct?: boolean | undefined;
+        }[] | undefined;
+        windowFunctions?: {
+            function: "min" | "max" | "count" | "sum" | "avg" | "row_number" | "rank" | "dense_rank" | "percent_rank" | "lag" | "lead" | "first_value" | "last_value";
+            alias: string;
+            over: {
+                partitionBy?: string[] | undefined;
+                orderBy?: {
+                    field: string;
+                    order: "asc" | "desc";
+                }[] | undefined;
+                frame?: {
+                    type?: "rows" | "range" | undefined;
+                    start?: string | undefined;
+                    end?: string | undefined;
+                } | undefined;
+            };
+            field?: string | undefined;
+        }[] | undefined;
+        filters?: any;
+        joins?: any[] | undefined;
+        groupBy?: string[] | undefined;
+        having?: any;
+        top?: number | undefined;
+        skip?: number | undefined;
+    }, {
+        object: string;
+        sort?: {
+            field: string;
+            order?: "asc" | "desc" | undefined;
+        }[] | undefined;
+        fields?: any[] | undefined;
+        distinct?: boolean | undefined;
+        aggregations?: {
+            function: "min" | "max" | "count" | "sum" | "avg" | "count_distinct" | "array_agg" | "string_agg";
+            alias: string;
+            field?: string | undefined;
+            distinct?: boolean | undefined;
+        }[] | undefined;
+        windowFunctions?: {
+            function: "min" | "max" | "count" | "sum" | "avg" | "row_number" | "rank" | "dense_rank" | "percent_rank" | "lag" | "lead" | "first_value" | "last_value";
+            alias: string;
+            over: {
+                partitionBy?: string[] | undefined;
+                orderBy?: {
+                    field: string;
+                    order?: "asc" | "desc" | undefined;
+                }[] | undefined;
+                frame?: {
+                    type?: "rows" | "range" | undefined;
+                    start?: string | undefined;
+                    end?: string | undefined;
+                } | undefined;
+            };
+            field?: string | undefined;
+        }[] | undefined;
+        filters?: any;
+        joins?: any[] | undefined;
+        groupBy?: string[] | undefined;
+        having?: any;
+        top?: number | undefined;
+        skip?: number | undefined;
+    }>>;
+    /** Error Handling */
+    errorPolicy: z.ZodDefault<z.ZodEnum<["skip", "abort", "retry"]>>;
+    batchSize: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    mode: "update" | "upsert" | "insert";
+    sourceFormat: "json" | "csv" | "xml" | "sql";
+    targetObject: string;
+    fieldMapping: {
+        source: string | string[];
+        target: string | string[];
+        transform: "lookup" | "join" | "map" | "none" | "constant" | "split" | "javascript";
+        params?: {
+            object?: string | undefined;
+            value?: any;
+            fromField?: string | undefined;
+            toField?: string | undefined;
+            autoCreate?: boolean | undefined;
+            valueMap?: Record<string, any> | undefined;
+            separator?: string | undefined;
+        } | undefined;
+    }[];
+    errorPolicy: "skip" | "abort" | "retry";
+    batchSize: number;
+    label?: string | undefined;
+    upsertKey?: string[] | undefined;
+    extractQuery?: {
+        object: string;
+        sort?: {
+            field: string;
+            order: "asc" | "desc";
+        }[] | undefined;
+        fields?: any[] | undefined;
+        distinct?: boolean | undefined;
+        aggregations?: {
+            function: "min" | "max" | "count" | "sum" | "avg" | "count_distinct" | "array_agg" | "string_agg";
+            alias: string;
+            field?: string | undefined;
+            distinct?: boolean | undefined;
+        }[] | undefined;
+        windowFunctions?: {
+            function: "min" | "max" | "count" | "sum" | "avg" | "row_number" | "rank" | "dense_rank" | "percent_rank" | "lag" | "lead" | "first_value" | "last_value";
+            alias: string;
+            over: {
+                partitionBy?: string[] | undefined;
+                orderBy?: {
+                    field: string;
+                    order: "asc" | "desc";
+                }[] | undefined;
+                frame?: {
+                    type?: "rows" | "range" | undefined;
+                    start?: string | undefined;
+                    end?: string | undefined;
+                } | undefined;
+            };
+            field?: string | undefined;
+        }[] | undefined;
+        filters?: any;
+        joins?: any[] | undefined;
+        groupBy?: string[] | undefined;
+        having?: any;
+        top?: number | undefined;
+        skip?: number | undefined;
+    } | undefined;
+}, {
+    name: string;
+    targetObject: string;
+    fieldMapping: {
+        source: string | string[];
+        target: string | string[];
+        params?: {
+            object?: string | undefined;
+            value?: any;
+            fromField?: string | undefined;
+            toField?: string | undefined;
+            autoCreate?: boolean | undefined;
+            valueMap?: Record<string, any> | undefined;
+            separator?: string | undefined;
+        } | undefined;
+        transform?: "lookup" | "join" | "map" | "none" | "constant" | "split" | "javascript" | undefined;
+    }[];
+    label?: string | undefined;
+    mode?: "update" | "upsert" | "insert" | undefined;
+    sourceFormat?: "json" | "csv" | "xml" | "sql" | undefined;
+    upsertKey?: string[] | undefined;
+    extractQuery?: {
+        object: string;
+        sort?: {
+            field: string;
+            order?: "asc" | "desc" | undefined;
+        }[] | undefined;
+        fields?: any[] | undefined;
+        distinct?: boolean | undefined;
+        aggregations?: {
+            function: "min" | "max" | "count" | "sum" | "avg" | "count_distinct" | "array_agg" | "string_agg";
+            alias: string;
+            field?: string | undefined;
+            distinct?: boolean | undefined;
+        }[] | undefined;
+        windowFunctions?: {
+            function: "min" | "max" | "count" | "sum" | "avg" | "row_number" | "rank" | "dense_rank" | "percent_rank" | "lag" | "lead" | "first_value" | "last_value";
+            alias: string;
+            over: {
+                partitionBy?: string[] | undefined;
+                orderBy?: {
+                    field: string;
+                    order?: "asc" | "desc" | undefined;
+                }[] | undefined;
+                frame?: {
+                    type?: "rows" | "range" | undefined;
+                    start?: string | undefined;
+                    end?: string | undefined;
+                } | undefined;
+            };
+            field?: string | undefined;
+        }[] | undefined;
+        filters?: any;
+        joins?: any[] | undefined;
+        groupBy?: string[] | undefined;
+        having?: any;
+        top?: number | undefined;
+        skip?: number | undefined;
+    } | undefined;
+    errorPolicy?: "skip" | "abort" | "retry" | undefined;
+    batchSize?: number | undefined;
+}>;
+export type Mapping = z.infer<typeof MappingSchema>;
+export type FieldMapping = z.infer<typeof FieldMappingSchema>;
+//# sourceMappingURL=mapping.zod.d.ts.map

package/dist/data/mapping.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapping.zod.d.ts","sourceRoot":"","sources":["../../src/data/mapping.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;GAGG;AACH,eAAO,MAAM,aAAa,iFAQxB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,kBAAkB;IAC7B,oBAAoB;;IAGpB,mBAAmB;;IAGnB,qBAAqB;;IAGrB,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiBlC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,aAAa;IACxB,eAAe;;;IAIf,YAAY;;;IAIZ,sBAAsB;;QAzCtB,oBAAoB;;QAGpB,mBAAmB;;QAGnB,qBAAqB;;QAGrB,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAmClC,mBAAmB;;;IAInB,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAGjC,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGrB,CAAC;AAEH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACpD,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC"}

package/dist/data/mapping.zod.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MappingSchema = exports.FieldMappingSchema = exports.TransformType = void 0;
+const zod_1 = require("zod");
+const query_zod_1 = require("./query.zod");
+/**
+ * Transformation Logic
+ * Built-in helpers for converting data during import.
+ */
+exports.TransformType = zod_1.z.enum([
+    'none', // Direct copy
+    'constant', // Use a hardcoded value
+    'lookup', // Resolve FK (Name -> ID)
+    'split', // "John Doe" -> ["John", "Doe"]
+    'join', // ["John", "Doe"] -> "John Doe"
+    'javascript', // Custom script (Review security!)
+    'map' // Value mapping (e.g. "Active" -> "active")
+]);
+/**
+ * Field Mapping Item
+ */
+exports.FieldMappingSchema = zod_1.z.object({
+    /** Source Column */
+    source: zod_1.z.union([zod_1.z.string(), zod_1.z.array(zod_1.z.string())]).describe('Source column header(s)'),
+    /** Target Field */
+    target: zod_1.z.union([zod_1.z.string(), zod_1.z.array(zod_1.z.string())]).describe('Target object field(s)'),
+    /** Transformation */
+    transform: exports.TransformType.default('none'),
+    /** Configuration for transform */
+    params: zod_1.z.object({
+        // Constant
+        value: zod_1.z.any().optional(),
+        // Lookup
+        object: zod_1.z.string().optional(), // Lookup Object
+        fromField: zod_1.z.string().optional(), // Match on (e.g. "name")
+        toField: zod_1.z.string().optional(), // Value to take (e.g. "_id")
+        autoCreate: zod_1.z.boolean().optional(), // Create if missing
+        // Map
+        valueMap: zod_1.z.record(zod_1.z.any()).optional(), // { "Open": "draft" }
+        // Split/Join
+        separator: zod_1.z.string().optional()
+    }).optional()
+});
+/**
+ * ETL Mapping Schema
+ * Definition for importing/exporting data defined in `integration-etl.mdx`.
+ */
+exports.MappingSchema = zod_1.z.object({
+    /** Identity */
+    name: zod_1.z.string().regex(/^[a-z_][a-z0-9_]*$/),
+    label: zod_1.z.string().optional(),
+    /** Scope */
+    sourceFormat: zod_1.z.enum(['csv', 'json', 'xml', 'sql']).default('csv'),
+    targetObject: zod_1.z.string().describe('Target Object Name'),
+    /** Column Mappings */
+    fieldMapping: zod_1.z.array(exports.FieldMappingSchema),
+    /** Upsert Logic */
+    mode: zod_1.z.enum(['insert', 'update', 'upsert']).default('insert'),
+    upsertKey: zod_1.z.array(zod_1.z.string()).optional().describe('Fields to match for upsert (e.g. email)'),
+    /** Extract Logic (For Export) */
+    extractQuery: query_zod_1.QuerySchema.optional().describe('Query to run for export only'),
+    /** Error Handling */
+    errorPolicy: zod_1.z.enum(['skip', 'abort', 'retry']).default('skip'),
+    batchSize: zod_1.z.number().default(1000)
+});