@objectstack/spec 0.2.0 → 0.3.1

package/dist/ai/workflow-automation.zod.js

@@ -0,0 +1,197 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AIWorkflowExecutionResultSchema = exports.BatchAIWorkflowExecutionSchema = exports.AIWorkflowAutomationSchema = exports.PostProcessingActionSchema = exports.WorkflowScheduleSchema = exports.WorkflowFieldConditionSchema = exports.AITaskSchema = exports.AITaskTypeSchema = exports.AIWorkflowTriggerSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * AI Workflow Automation Protocol
+ *
+ * Defines intelligent automation workflows that leverage AI/ML capabilities
+ * to automate business processes with cognitive tasks like classification,
+ * extraction, summarization, content generation, and prediction.
+ *
+ * Use Cases:
+ * - Automatically classify support tickets by urgency and route to teams
+ * - Extract key information from documents and populate fields
+ * - Generate summaries of long text content
+ * - Predict lead scores or customer churn risk
+ * - Auto-fill forms based on natural language input
+ */
+/**
+ * Workflow Trigger Types
+ * Defines when an AI workflow should be initiated
+ */
+exports.AIWorkflowTriggerSchema = zod_1.z.enum([
+    'record_created', // When a new record is created
+    'record_updated', // When a record is updated
+    'field_changed', // When specific field(s) change
+    'scheduled', // Time-based trigger (cron)
+    'manual', // User-initiated trigger
+    'webhook', // External system trigger
+    'batch', // Batch processing trigger
+]);
+/**
+ * AI Task Types
+ * Cognitive operations that can be performed by AI
+ */
+exports.AITaskTypeSchema = zod_1.z.enum([
+    'classify', // Categorize content into predefined classes
+    'extract', // Extract structured data from unstructured content
+    'summarize', // Generate concise summaries of text
+    'generate', // Generate new content (text, code, etc.)
+    'predict', // Make predictions based on historical data
+    'translate', // Translate text between languages
+    'sentiment', // Analyze sentiment (positive, negative, neutral)
+    'entity_recognition', // Identify named entities (people, places, etc.)
+    'anomaly_detection', // Detect outliers or unusual patterns
+    'recommendation', // Recommend items or actions
+]);
+/**
+ * AI Task Configuration
+ * Individual AI task within a workflow
+ */
+exports.AITaskSchema = zod_1.z.object({
+    /** Task Identity */
+    id: zod_1.z.string().optional().describe('Optional task ID for referencing'),
+    name: zod_1.z.string().describe('Human-readable task name'),
+    type: exports.AITaskTypeSchema,
+    /** Model Configuration */
+    model: zod_1.z.string().optional().describe('Model ID from registry (uses default if not specified)'),
+    promptTemplate: zod_1.z.string().optional().describe('Prompt template ID for this task'),
+    /** Input Configuration */
+    inputFields: zod_1.z.array(zod_1.z.string()).describe('Source fields to process (e.g., ["description", "comments"])'),
+    inputContext: zod_1.z.record(zod_1.z.any()).optional().describe('Additional context for the AI model'),
+    /** Output Configuration */
+    outputField: zod_1.z.string().describe('Target field to store the result'),
+    outputFormat: zod_1.z.enum(['text', 'json', 'number', 'boolean', 'array']).optional().default('text'),
+    /** Classification-specific options */
+    classes: zod_1.z.array(zod_1.z.string()).optional().describe('Valid classes for classification tasks'),
+    multiClass: zod_1.z.boolean().optional().default(false).describe('Allow multiple classes to be selected'),
+    /** Extraction-specific options */
+    extractionSchema: zod_1.z.record(zod_1.z.any()).optional().describe('JSON schema for structured extraction'),
+    /** Generation-specific options */
+    maxLength: zod_1.z.number().optional().describe('Maximum length for generated content'),
+    temperature: zod_1.z.number().min(0).max(2).optional().describe('Model temperature override'),
+    /** Error Handling */
+    fallbackValue: zod_1.z.any().optional().describe('Fallback value if AI task fails'),
+    retryAttempts: zod_1.z.number().int().min(0).max(5).optional().default(1),
+    /** Conditional Execution */
+    condition: zod_1.z.string().optional().describe('Formula condition - task only runs if TRUE'),
+    /** Task Metadata */
+    description: zod_1.z.string().optional(),
+    active: zod_1.z.boolean().optional().default(true),
+});
+/**
+ * Workflow Field Condition
+ * Specifies which field changes trigger the workflow
+ */
+exports.WorkflowFieldConditionSchema = zod_1.z.object({
+    field: zod_1.z.string().describe('Field name to monitor'),
+    operator: zod_1.z.enum(['changed', 'changed_to', 'changed_from', 'is', 'is_not']).optional().default('changed'),
+    value: zod_1.z.any().optional().describe('Value to compare against (for changed_to/changed_from/is/is_not)'),
+});
+/**
+ * Workflow Schedule Configuration
+ * For time-based workflow execution
+ */
+exports.WorkflowScheduleSchema = zod_1.z.object({
+    type: zod_1.z.enum(['cron', 'interval', 'daily', 'weekly', 'monthly']).default('cron'),
+    cron: zod_1.z.string().optional().describe('Cron expression (required if type is "cron")'),
+    interval: zod_1.z.number().optional().describe('Interval in minutes (required if type is "interval")'),
+    time: zod_1.z.string().optional().describe('Time of day for daily schedules (HH:MM format)'),
+    dayOfWeek: zod_1.z.number().int().min(0).max(6).optional().describe('Day of week for weekly (0=Sunday)'),
+    dayOfMonth: zod_1.z.number().int().min(1).max(31).optional().describe('Day of month for monthly'),
+    timezone: zod_1.z.string().optional().default('UTC'),
+});
+/**
+ * Post-Processing Action
+ * Actions to execute after AI tasks complete
+ */
+exports.PostProcessingActionSchema = zod_1.z.object({
+    type: zod_1.z.enum(['field_update', 'send_email', 'create_record', 'update_related', 'trigger_flow', 'webhook']),
+    name: zod_1.z.string().describe('Action name'),
+    config: zod_1.z.record(zod_1.z.any()).describe('Action-specific configuration'),
+    condition: zod_1.z.string().optional().describe('Execute only if condition is TRUE'),
+});
+/**
+ * AI Workflow Automation Schema
+ * Complete workflow definition with AI-powered tasks
+ */
+exports.AIWorkflowAutomationSchema = zod_1.z.object({
+    /** Identity */
+    name: zod_1.z.string().regex(/^[a-z_][a-z0-9_]*$/).describe('Workflow unique identifier (snake_case)'),
+    label: zod_1.z.string().describe('Workflow display name'),
+    description: zod_1.z.string().optional(),
+    /** Target Object */
+    objectName: zod_1.z.string().describe('Target object for this workflow'),
+    /** Trigger Configuration */
+    trigger: exports.AIWorkflowTriggerSchema,
+    /** Trigger-specific configuration */
+    fieldConditions: zod_1.z.array(exports.WorkflowFieldConditionSchema).optional().describe('Fields to monitor (for field_changed trigger)'),
+    schedule: exports.WorkflowScheduleSchema.optional().describe('Schedule configuration (for scheduled trigger)'),
+    webhookConfig: zod_1.z.object({
+        secret: zod_1.z.string().optional().describe('Webhook verification secret'),
+        headers: zod_1.z.record(zod_1.z.string()).optional().describe('Expected headers'),
+    }).optional().describe('Webhook configuration (for webhook trigger)'),
+    /** Entry Criteria */
+    entryCriteria: zod_1.z.string().optional().describe('Formula condition - workflow only runs if TRUE'),
+    /** AI Tasks */
+    aiTasks: zod_1.z.array(exports.AITaskSchema).describe('AI tasks to execute in sequence'),
+    /** Post-Processing */
+    postActions: zod_1.z.array(exports.PostProcessingActionSchema).optional().describe('Actions after AI tasks complete'),
+    /** Execution Options */
+    executionMode: zod_1.z.enum(['sequential', 'parallel']).optional().default('sequential').describe('How to execute multiple AI tasks'),
+    stopOnError: zod_1.z.boolean().optional().default(false).describe('Stop workflow if any task fails'),
+    /** Performance & Limits */
+    timeout: zod_1.z.number().optional().describe('Maximum execution time in seconds'),
+    priority: zod_1.z.enum(['low', 'normal', 'high', 'critical']).optional().default('normal'),
+    /** Monitoring & Logging */
+    enableLogging: zod_1.z.boolean().optional().default(true),
+    enableMetrics: zod_1.z.boolean().optional().default(true),
+    notifyOnFailure: zod_1.z.array(zod_1.z.string()).optional().describe('User IDs to notify on failure'),
+    /** Status */
+    active: zod_1.z.boolean().optional().default(true),
+    version: zod_1.z.string().optional().default('1.0.0'),
+    /** Metadata */
+    tags: zod_1.z.array(zod_1.z.string()).optional(),
+    category: zod_1.z.string().optional().describe('Workflow category (e.g., "support", "sales", "hr")'),
+    owner: zod_1.z.string().optional().describe('User ID of workflow owner'),
+    createdAt: zod_1.z.string().optional().describe('ISO timestamp'),
+    updatedAt: zod_1.z.string().optional().describe('ISO timestamp'),
+});
+/**
+ * Batch AI Workflow Execution Request
+ * For processing multiple records at once
+ */
+exports.BatchAIWorkflowExecutionSchema = zod_1.z.object({
+    workflowName: zod_1.z.string().describe('Workflow to execute'),
+    recordIds: zod_1.z.array(zod_1.z.string()).describe('Records to process'),
+    batchSize: zod_1.z.number().int().min(1).max(1000).optional().default(10),
+    parallelism: zod_1.z.number().int().min(1).max(10).optional().default(3),
+    priority: zod_1.z.enum(['low', 'normal', 'high']).optional().default('normal'),
+});
+/**
+ * AI Workflow Execution Result
+ * Result of a single workflow execution
+ */
+exports.AIWorkflowExecutionResultSchema = zod_1.z.object({
+    workflowName: zod_1.z.string(),
+    recordId: zod_1.z.string(),
+    status: zod_1.z.enum(['success', 'partial_success', 'failed', 'skipped']),
+    executionTime: zod_1.z.number().describe('Execution time in milliseconds'),
+    tasksExecuted: zod_1.z.number().int().describe('Number of tasks executed'),
+    tasksSucceeded: zod_1.z.number().int().describe('Number of tasks succeeded'),
+    tasksFailed: zod_1.z.number().int().describe('Number of tasks failed'),
+    taskResults: zod_1.z.array(zod_1.z.object({
+        taskId: zod_1.z.string().optional(),
+        taskName: zod_1.z.string(),
+        status: zod_1.z.enum(['success', 'failed', 'skipped']),
+        output: zod_1.z.any().optional(),
+        error: zod_1.z.string().optional(),
+        executionTime: zod_1.z.number().optional().describe('Task execution time in milliseconds'),
+        modelUsed: zod_1.z.string().optional(),
+        tokensUsed: zod_1.z.number().optional(),
+    })).optional(),
+    error: zod_1.z.string().optional(),
+    startedAt: zod_1.z.string().describe('ISO timestamp'),
+    completedAt: zod_1.z.string().optional().describe('ISO timestamp'),
+});

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

@@ -344,8 +344,8 @@ export declare const SingleRecordResponseSchema: z.ZodObject<{
 } & {
     data: z.ZodRecord<z.ZodString, z.ZodAny>;
 }, "strip", z.ZodTypeAny, {
-    success: boolean;
     data: Record<string, any>;
+    success: boolean;
     error?: {
         code: string;
         message: string;
@@ -358,8 +358,8 @@ export declare const SingleRecordResponseSchema: z.ZodObject<{
         traceId?: string | undefined;
     } | undefined;
 }, {
-    success: boolean;
     data: Record<string, any>;
+    success: boolean;
     error?: {
         code: string;
         message: string;
@@ -425,8 +425,8 @@ export declare const ListRecordResponseSchema: z.ZodObject<{
         hasMore: boolean;
     }>;
 }, "strip", z.ZodTypeAny, {
-    success: boolean;
     data: Record<string, any>[];
+    success: boolean;
     pagination: {
         total: number;
         limit: number;
@@ -445,8 +445,8 @@ export declare const ListRecordResponseSchema: z.ZodObject<{
         traceId?: string | undefined;
     } | undefined;
 }, {
-    success: boolean;
     data: Record<string, any>[];
+    success: boolean;
     pagination: {
         total: number;
         limit: number;
@@ -570,7 +570,6 @@ export declare const BulkResponseSchema: z.ZodObject<{
         }[] | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    success: boolean;
     data: {
         success: boolean;
         id?: string | undefined;
@@ -580,6 +579,7 @@ export declare const BulkResponseSchema: z.ZodObject<{
             details?: any;
         }[] | undefined;
     }[];
+    success: boolean;
     error?: {
         code: string;
         message: string;
@@ -592,7 +592,6 @@ export declare const BulkResponseSchema: z.ZodObject<{
         traceId?: string | undefined;
     } | undefined;
 }, {
-    success: boolean;
     data: {
         success: boolean;
         id?: string | undefined;
@@ -602,6 +601,7 @@ export declare const BulkResponseSchema: z.ZodObject<{
             details?: any;
         }[] | undefined;
     }[];
+    success: boolean;
     error?: {
         code: string;
         message: string;
@@ -726,8 +726,8 @@ export declare const ApiContracts: {
         } & {
             data: z.ZodRecord<z.ZodString, z.ZodAny>;
         }, "strip", z.ZodTypeAny, {
-            success: boolean;
             data: Record<string, any>;
+            success: boolean;
             error?: {
                 code: string;
                 message: string;
@@ -740,8 +740,8 @@ export declare const ApiContracts: {
                 traceId?: string | undefined;
             } | undefined;
         }, {
-            success: boolean;
             data: Record<string, any>;
+            success: boolean;
             error?: {
                 code: string;
                 message: string;
@@ -797,8 +797,8 @@ export declare const ApiContracts: {
         } & {
             data: z.ZodRecord<z.ZodString, z.ZodAny>;
         }, "strip", z.ZodTypeAny, {
-            success: boolean;
             data: Record<string, any>;
+            success: boolean;
             error?: {
                 code: string;
                 message: string;
@@ -811,8 +811,8 @@ export declare const ApiContracts: {
                 traceId?: string | undefined;
             } | undefined;
         }, {
-            success: boolean;
             data: Record<string, any>;
+            success: boolean;
             error?: {
                 code: string;
                 message: string;
@@ -927,8 +927,8 @@ export declare const ApiContracts: {
         } & {
             data: z.ZodRecord<z.ZodString, z.ZodAny>;
         }, "strip", z.ZodTypeAny, {
-            success: boolean;
             data: Record<string, any>;
+            success: boolean;
             error?: {
                 code: string;
                 message: string;
@@ -941,8 +941,8 @@ export declare const ApiContracts: {
                 traceId?: string | undefined;
             } | undefined;
         }, {
-            success: boolean;
             data: Record<string, any>;
+            success: boolean;
             error?: {
                 code: string;
                 message: string;
@@ -1203,8 +1203,8 @@ export declare const ApiContracts: {
                 hasMore: boolean;
             }>;
         }, "strip", z.ZodTypeAny, {
-            success: boolean;
             data: Record<string, any>[];
+            success: boolean;
             pagination: {
                 total: number;
                 limit: number;
@@ -1223,8 +1223,8 @@ export declare const ApiContracts: {
                 traceId?: string | undefined;
             } | undefined;
         }, {
-            success: boolean;
             data: Record<string, any>[];
+            success: boolean;
             pagination: {
                 total: number;
                 limit: number;
@@ -1321,7 +1321,6 @@ export declare const ApiContracts: {
                 }[] | undefined;
             }>, "many">;
         }, "strip", z.ZodTypeAny, {
-            success: boolean;
             data: {
                 success: boolean;
                 id?: string | undefined;
@@ -1331,6 +1330,7 @@ export declare const ApiContracts: {
                     details?: any;
                 }[] | undefined;
             }[];
+            success: boolean;
             error?: {
                 code: string;
                 message: string;
@@ -1343,7 +1343,6 @@ export declare const ApiContracts: {
                 traceId?: string | undefined;
             } | undefined;
         }, {
-            success: boolean;
             data: {
                 success: boolean;
                 id?: string | undefined;
@@ -1353,6 +1352,7 @@ export declare const ApiContracts: {
                     details?: any;
                 }[] | undefined;
             }[];
+            success: boolean;
             error?: {
                 code: string;
                 message: string;
@@ -1443,7 +1443,6 @@ export declare const ApiContracts: {
                 }[] | undefined;
             }>, "many">;
         }, "strip", z.ZodTypeAny, {
-            success: boolean;
             data: {
                 success: boolean;
                 id?: string | undefined;
@@ -1453,6 +1452,7 @@ export declare const ApiContracts: {
                     details?: any;
                 }[] | undefined;
             }[];
+            success: boolean;
             error?: {
                 code: string;
                 message: string;
@@ -1465,7 +1465,6 @@ export declare const ApiContracts: {
                 traceId?: string | undefined;
             } | undefined;
         }, {
-            success: boolean;
             data: {
                 success: boolean;
                 id?: string | undefined;
@@ -1475,6 +1474,7 @@ export declare const ApiContracts: {
                     details?: any;
                 }[] | undefined;
             }[];
+            success: boolean;
             error?: {
                 code: string;
                 message: string;
@@ -1565,7 +1565,6 @@ export declare const ApiContracts: {
                 }[] | undefined;
             }>, "many">;
         }, "strip", z.ZodTypeAny, {
-            success: boolean;
             data: {
                 success: boolean;
                 id?: string | undefined;
@@ -1575,6 +1574,7 @@ export declare const ApiContracts: {
                     details?: any;
                 }[] | undefined;
             }[];
+            success: boolean;
             error?: {
                 code: string;
                 message: string;
@@ -1587,7 +1587,6 @@ export declare const ApiContracts: {
                 traceId?: string | undefined;
             } | undefined;
         }, {
-            success: boolean;
             data: {
                 success: boolean;
                 id?: string | undefined;
@@ -1597,6 +1596,7 @@ export declare const ApiContracts: {
                     details?: any;
                 }[] | undefined;
             }[];
+            success: boolean;
             error?: {
                 code: string;
                 message: string;
@@ -1684,7 +1684,6 @@ export declare const ApiContracts: {
                 }[] | undefined;
             }>, "many">;
         }, "strip", z.ZodTypeAny, {
-            success: boolean;
             data: {
                 success: boolean;
                 id?: string | undefined;
@@ -1694,6 +1693,7 @@ export declare const ApiContracts: {
                     details?: any;
                 }[] | undefined;
             }[];
+            success: boolean;
             error?: {
                 code: string;
                 message: string;
@@ -1706,7 +1706,6 @@ export declare const ApiContracts: {
                 traceId?: string | undefined;
             } | undefined;
         }, {
-            success: boolean;
             data: {
                 success: boolean;
                 id?: string | undefined;
@@ -1716,6 +1715,7 @@ export declare const ApiContracts: {
                     details?: any;
                 }[] | undefined;
             }[];
+            success: boolean;
             error?: {
                 code: string;
                 message: string;

package/dist/api/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * API Protocol Exports
+ *
+ * API Contracts & Envelopes
+ * - Request/Response schemas
+ * - Error handling
+ */
+export * from './contract.zod';
+//# sourceMappingURL=index.d.ts.map

package/dist/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,cAAc,gBAAgB,CAAC"}

package/dist/api/index.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * API Protocol Exports
+ *
+ * API Contracts & Envelopes
+ * - Request/Response schemas
+ * - Error handling
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./contract.zod"), exports);