@objectstack/spec 0.3.3 → 0.4.1

package/dist/automation/approval.zod.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApprovalProcess = exports.ApprovalProcessSchema = exports.ApprovalStepSchema = exports.ApprovalActionSchema = exports.ApprovalActionType = exports.ApproverType = void 0;
+const zod_1 = require("zod");
+const identifiers_zod_1 = require("../shared/identifiers.zod");
+/**
+ * Approval Step Approver Type
+ */
+exports.ApproverType = zod_1.z.enum([
+    'user', // Specific user(s)
+    'role', // Users with specific role
+    'manager', // Submitter's manager
+    'field', // User ID defined in a record field
+    'queue' // Data ownership queue
+]);
+/**
+ * Approval Action Type
+ * Actions to execute on transition
+ */
+exports.ApprovalActionType = zod_1.z.enum([
+    'field_update',
+    'email_alert',
+    'webhook',
+    'script'
+]);
+/**
+ * definition of an action to perform
+ */
+exports.ApprovalActionSchema = zod_1.z.object({
+    type: exports.ApprovalActionType,
+    name: zod_1.z.string().describe('Action name'),
+    config: zod_1.z.record(zod_1.z.any()).describe('Action configuration')
+});
+/**
+ * Approval Process Step
+ */
+exports.ApprovalStepSchema = zod_1.z.object({
+    name: identifiers_zod_1.SnakeCaseIdentifierSchema.describe('Step machine name'),
+    label: zod_1.z.string().describe('Step display label'),
+    description: zod_1.z.string().optional(),
+    /** Entry criteria for this step */
+    entryCriteria: zod_1.z.string().optional().describe('Formula expression to enter this step'),
+    /** Who can approve */
+    approvers: zod_1.z.array(zod_1.z.object({
+        type: exports.ApproverType,
+        value: zod_1.z.string().describe('User ID, Role Name, or Field Name')
+    })).min(1).describe('List of allowed approvers'),
+    /** Approval Logic */
+    behavior: zod_1.z.enum(['first_response', 'unanimous']).default('first_response')
+        .describe('How to handle multiple approvers'),
+    /** Rejection behavior */
+    rejectionBehavior: zod_1.z.enum(['reject_process', 'back_to_previous'])
+        .default('reject_process').describe('What happens if rejected'),
+    /** Actions */
+    onApprove: zod_1.z.array(exports.ApprovalActionSchema).optional().describe('Actions on step approval'),
+    onReject: zod_1.z.array(exports.ApprovalActionSchema).optional().describe('Actions on step rejection'),
+});
+/**
+ * Approval Process Protocol
+ *
+ * Defines a complex review and approval cycle for a record.
+ * Manages state locking, notifications, and transition logic.
+ */
+exports.ApprovalProcessSchema = zod_1.z.object({
+    name: identifiers_zod_1.SnakeCaseIdentifierSchema.describe('Unique process name'),
+    label: zod_1.z.string().describe('Human readable label'),
+    object: zod_1.z.string().describe('Target Object Name'),
+    active: zod_1.z.boolean().default(false),
+    description: zod_1.z.string().optional(),
+    /** Entry Criteria for the entire process */
+    entryCriteria: zod_1.z.string().optional().describe('Formula to allow submission'),
+    /** Record Locking */
+    lockRecord: zod_1.z.boolean().default(true).describe('Lock record from editing during approval'),
+    /** Steps */
+    steps: zod_1.z.array(exports.ApprovalStepSchema).min(1).describe('Sequence of approval steps'),
+    /** Global Actions */
+    onSubmit: zod_1.z.array(exports.ApprovalActionSchema).optional().describe('Actions on initial submission'),
+    onFinalApprove: zod_1.z.array(exports.ApprovalActionSchema).optional().describe('Actions on final approval'),
+    onFinalReject: zod_1.z.array(exports.ApprovalActionSchema).optional().describe('Actions on final rejection'),
+    onRecall: zod_1.z.array(exports.ApprovalActionSchema).optional().describe('Actions on recall'),
+});
+exports.ApprovalProcess = Object.assign(exports.ApprovalProcessSchema, {
+    create: (config) => config,
+});