@objectstack/spec 0.1.0 → 0.1.2

package/dist/api/contract.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.zod.d.ts","sourceRoot":"","sources":["../../src/api/contract.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB,eAAO,MAAM,cAAc;;;;;;;;;;;;EAIzB,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAS7B,CAAC;AAMH,eAAO,MAAM,gBAAgB,oCAA6D,CAAC;AAE3F;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;EAE9B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;EAE9B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;EAG5B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE9B,CAAC;AAMH;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAErC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQnC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAInC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE7B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE/B,CAAC;AAMH;;;GAGG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqCxB,CAAC"}

package/dist/api/contract.zod.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiContracts = exports.DeleteResponseSchema = exports.BulkResponseSchema = exports.ModificationResultSchema = exports.ListRecordResponseSchema = exports.SingleRecordResponseSchema = exports.ExportRequestSchema = exports.BulkRequestSchema = exports.UpdateRequestSchema = exports.CreateRequestSchema = exports.RecordDataSchema = exports.BaseResponseSchema = exports.ApiErrorSchema = void 0;
+const zod_1 = require("zod");
+const query_zod_1 = require("../data/query.zod");
+// ==========================================
+// 1. Base Envelopes
+// ==========================================
+exports.ApiErrorSchema = zod_1.z.object({
+    code: zod_1.z.string().describe('Error code (e.g. validation_error)'),
+    message: zod_1.z.string().describe('Readable error message'),
+    details: zod_1.z.any().optional().describe('Additional error context (e.g. field validation errors)'),
+});
+exports.BaseResponseSchema = zod_1.z.object({
+    success: zod_1.z.boolean().describe('Operation success status'),
+    error: exports.ApiErrorSchema.optional().describe('Error details if success is false'),
+    meta: zod_1.z.object({
+        timestamp: zod_1.z.string(),
+        duration: zod_1.z.number().optional(),
+        requestId: zod_1.z.string().optional(),
+        traceId: zod_1.z.string().optional(),
+    }).optional().describe('Response metadata'),
+});
+// ==========================================
+// 2. Request Payloads (Inputs)
+// ==========================================
+exports.RecordDataSchema = zod_1.z.record(zod_1.z.any()).describe('Key-value map of record data');
+/**
+ * Standard Create Request
+ */
+exports.CreateRequestSchema = zod_1.z.object({
+    data: exports.RecordDataSchema.describe('Record data to insert'),
+});
+/**
+ * Standard Update Request
+ */
+exports.UpdateRequestSchema = zod_1.z.object({
+    data: exports.RecordDataSchema.describe('Partial record data to update'),
+});
+/**
+ * Standard Bulk Request
+ */
+exports.BulkRequestSchema = zod_1.z.object({
+    records: zod_1.z.array(exports.RecordDataSchema).describe('Array of records to process'),
+    allOrNone: zod_1.z.boolean().default(true).describe('If true, rollback entire transaction on any failure'),
+});
+/**
+ * Export Request
+ */
+exports.ExportRequestSchema = query_zod_1.QuerySchema.extend({
+    format: zod_1.z.enum(['csv', 'json', 'xlsx']).default('csv'),
+});
+// ==========================================
+// 3. Response Payloads (Outputs)
+// ==========================================
+/**
+ * Single Record Response (Get/Create/Update)
+ */
+exports.SingleRecordResponseSchema = exports.BaseResponseSchema.extend({
+    data: exports.RecordDataSchema.describe('The requested or modified record'),
+});
+/**
+ * List/Query Response
+ */
+exports.ListRecordResponseSchema = exports.BaseResponseSchema.extend({
+    data: zod_1.z.array(exports.RecordDataSchema).describe('Array of matching records'),
+    pagination: zod_1.z.object({
+        total: zod_1.z.number().describe('Total matching records count'),
+        limit: zod_1.z.number().describe('Page size'),
+        offset: zod_1.z.number().describe('Page offset'),
+        hasMore: zod_1.z.boolean().describe('Are there more pages?'),
+    }).describe('Pagination info'),
+});
+/**
+ * Modification Result (for Batch/Bulk operations)
+ */
+exports.ModificationResultSchema = zod_1.z.object({
+    id: zod_1.z.string().optional().describe('Record ID if processed'),
+    success: zod_1.z.boolean(),
+    errors: zod_1.z.array(exports.ApiErrorSchema).optional(),
+});
+/**
+ * Bulk Operation Response
+ */
+exports.BulkResponseSchema = exports.BaseResponseSchema.extend({
+    data: zod_1.z.array(exports.ModificationResultSchema).describe('Results for each item in the batch'),
+});
+/**
+ * Delete Response
+ */
+exports.DeleteResponseSchema = exports.BaseResponseSchema.extend({
+    id: zod_1.z.string().describe('ID of the deleted record'),
+});
+// ==========================================
+// 4. API Contract Registry
+// ==========================================
+/**
+ * Standard API Contracts map
+ * Used for generating SDKs and Documentation
+ */
+exports.ApiContracts = {
+    create: {
+        input: exports.CreateRequestSchema,
+        output: exports.SingleRecordResponseSchema
+    },
+    update: {
+        input: exports.UpdateRequestSchema,
+        output: exports.SingleRecordResponseSchema
+    },
+    delete: {
+        input: zod_1.z.object({}), // usually just ID in URL
+        output: exports.DeleteResponseSchema
+    },
+    get: {
+        input: zod_1.z.object({}), // usually just ID in URL
+        output: exports.SingleRecordResponseSchema
+    },
+    list: {
+        input: query_zod_1.QuerySchema,
+        output: exports.ListRecordResponseSchema
+    },
+    bulkCreate: {
+        input: exports.BulkRequestSchema,
+        output: exports.BulkResponseSchema
+    },
+    bulkUpdate: {
+        input: exports.BulkRequestSchema,
+        output: exports.BulkResponseSchema
+    },
+    bulkUpsert: {
+        input: exports.BulkRequestSchema,
+        output: exports.BulkResponseSchema
+    },
+    bulkDelete: {
+        input: zod_1.z.object({ ids: zod_1.z.array(zod_1.z.string()) }),
+        output: exports.BulkResponseSchema
+    }
+};

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

@@ -0,0 +1,60 @@
+import { z } from 'zod';
+/**
+ * Data Import Strategy
+ * Defines how the engine handles existing records.
+ */
+export declare const DatasetMode: z.ZodEnum<["insert", "update", "upsert", "replace", "ignore"]>;
+/**
+ * Dataset Schema (Seed Data / Fixtures)
+ *
+ * Standardized format for transporting data.
+ * Used for:
+ * 1. System Bootstrapping (Admin accounts, Standard Roles)
+ * 2. Reference Data (Countries, Currencies)
+ * 3. Demo/Test Data
+ */
+export declare const DatasetSchema: z.ZodObject<{
+    /**
+     * Target Object
+     * The machine name of the object to populate.
+     */
+    object: z.ZodString;
+    /**
+     * Idempotency Key (The "Upsert" Key)
+     * The field used to check if a record already exists.
+     * Best Practice: Use a natural key like 'code', 'slug', 'username' or 'external_id'.
+     * Standard: '_id' (internal ID) is rarely used for portable seed data.
+     */
+    externalId: z.ZodDefault<z.ZodString>;
+    /**
+     * Import Strategy
+     */
+    mode: z.ZodDefault<z.ZodEnum<["insert", "update", "upsert", "replace", "ignore"]>>;
+    /**
+     * Environment Scope
+     * - 'all': Always load
+     * - 'dev': Only for development/demo
+     * - 'test': Only for CI/CD tests
+     */
+    env: z.ZodDefault<z.ZodArray<z.ZodEnum<["prod", "dev", "test"]>, "many">>;
+    /**
+     * The Payload
+     * Array of raw JSON objects matching the Object Schema.
+     */
+    records: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">;
+}, "strip", z.ZodTypeAny, {
+    object: string;
+    externalId: string;
+    mode: "update" | "upsert" | "insert" | "replace" | "ignore";
+    env: ("prod" | "dev" | "test")[];
+    records: Record<string, any>[];
+}, {
+    object: string;
+    records: Record<string, any>[];
+    externalId?: string | undefined;
+    mode?: "update" | "upsert" | "insert" | "replace" | "ignore" | undefined;
+    env?: ("prod" | "dev" | "test")[] | undefined;
+}>;
+export type Dataset = z.infer<typeof DatasetSchema>;
+export type DatasetImportMode = z.infer<typeof DatasetMode>;
+//# sourceMappingURL=dataset.zod.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dataset.zod.d.ts","sourceRoot":"","sources":["../../src/data/dataset.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,WAAW,gEAMtB,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa;IACxB;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;OAGG;;;;;;;;;;;;;;EAEH,CAAC;AAEH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACpD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC"}

package/dist/data/dataset.zod.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DatasetSchema = exports.DatasetMode = void 0;
+const zod_1 = require("zod");
+/**
+ * Data Import Strategy
+ * Defines how the engine handles existing records.
+ */
+exports.DatasetMode = zod_1.z.enum([
+    'insert', // Try to insert, fail on duplicate
+    'update', // Only update found records, ignore new
+    'upsert', // Create new or Update existing (Standard)
+    'replace', // Delete ALL records in object then insert (Dangerous - use for cache tables)
+    'ignore' // Try to insert, silently skip duplicates
+]);
+/**
+ * Dataset Schema (Seed Data / Fixtures)
+ *
+ * Standardized format for transporting data.
+ * Used for:
+ * 1. System Bootstrapping (Admin accounts, Standard Roles)
+ * 2. Reference Data (Countries, Currencies)
+ * 3. Demo/Test Data
+ */
+exports.DatasetSchema = zod_1.z.object({
+    /**
+     * Target Object
+     * The machine name of the object to populate.
+     */
+    object: zod_1.z.string().regex(/^[a-z_][a-z0-9_]*$/).describe('Target Object Name'),
+    /**
+     * Idempotency Key (The "Upsert" Key)
+     * The field used to check if a record already exists.
+     * Best Practice: Use a natural key like 'code', 'slug', 'username' or 'external_id'.
+     * Standard: '_id' (internal ID) is rarely used for portable seed data.
+     */
+    externalId: zod_1.z.string().default('name').describe('Field match for uniqueness check'),
+    /**
+     * Import Strategy
+     */
+    mode: exports.DatasetMode.default('upsert').describe('Conflict resolution strategy'),
+    /**
+     * Environment Scope
+     * - 'all': Always load
+     * - 'dev': Only for development/demo
+     * - 'test': Only for CI/CD tests
+     */
+    env: zod_1.z.array(zod_1.z.enum(['prod', 'dev', 'test'])).default(['prod', 'dev', 'test']).describe('Applicable environments'),
+    /**
+     * The Payload
+     * Array of raw JSON objects matching the Object Schema.
+     */
+    records: zod_1.z.array(zod_1.z.record(zod_1.z.any())).describe('Data records'),
+});