@cxtms/cx-schema 1.0.0

package/dist/workflowValidator.js

@@ -0,0 +1,410 @@
+"use strict";
+/**
+ * Workflow validator for CargoXplorer YAML workflow files
+ */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowValidator = void 0;
+const ajv_1 = __importDefault(require("ajv"));
+const ajv_formats_1 = __importDefault(require("ajv-formats"));
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const yaml = __importStar(require("js-yaml"));
+class WorkflowValidator {
+    constructor(options = {}) {
+        this.schemasDir = options.schemasPath || path.join(__dirname, '../schemas/workflows');
+        this.options = {
+            schemasPath: this.schemasDir,
+            strictMode: options.strictMode ?? true,
+            includeWarnings: options.includeWarnings ?? true,
+            validateTasks: options.validateTasks ?? true,
+            validateExpressions: options.validateExpressions ?? false
+        };
+        // Initialize Ajv with Draft 7 support
+        this.ajv = new ajv_1.default({
+            strict: false,
+            allErrors: true,
+            verbose: true,
+            validateFormats: true,
+            allowUnionTypes: true
+        });
+        // Add format validators
+        (0, ajv_formats_1.default)(this.ajv);
+        // Load all workflow schemas
+        this.schemas = this.loadWorkflowSchemas(this.schemasDir);
+        // Register schemas with Ajv
+        this.registerSchemas();
+    }
+    /**
+     * Load all workflow schemas from the schemas/workflows directory
+     */
+    loadWorkflowSchemas(schemasDir) {
+        const schemas = new Map();
+        // Load main workflow.json
+        const mainSchemaPath = path.join(schemasDir, 'workflow.json');
+        if (fs.existsSync(mainSchemaPath)) {
+            const schema = JSON.parse(fs.readFileSync(mainSchemaPath, 'utf-8'));
+            schemas.set('workflow.json', {
+                schema,
+                uri: `file:///${mainSchemaPath.replace(/\\/g, '/')}`
+            });
+        }
+        // Load workflow sub-schemas
+        const subSchemas = ['input.json', 'output.json', 'variable.json', 'trigger.json', 'schedule.json', 'activity.json'];
+        for (const schemaFile of subSchemas) {
+            const schemaPath = path.join(schemasDir, schemaFile);
+            if (fs.existsSync(schemaPath)) {
+                const schema = JSON.parse(fs.readFileSync(schemaPath, 'utf-8'));
+                schemas.set(schemaFile, {
+                    schema,
+                    uri: `file:///${schemaPath.replace(/\\/g, '/')}`
+                });
+            }
+        }
+        // Load task schemas from tasks/ subdirectory
+        const tasksDir = path.join(schemasDir, 'tasks');
+        if (fs.existsSync(tasksDir)) {
+            this.loadSchemasFromDir(tasksDir, 'tasks', schemas);
+        }
+        // Load common schemas from common/ subdirectory
+        const commonDir = path.join(schemasDir, 'common');
+        if (fs.existsSync(commonDir)) {
+            this.loadSchemasFromDir(commonDir, 'common', schemas);
+        }
+        return schemas;
+    }
+    /**
+     * Recursively load schemas from a directory
+     */
+    loadSchemasFromDir(dir, relativePath, schemas) {
+        const files = fs.readdirSync(dir);
+        for (const file of files) {
+            const filePath = path.join(dir, file);
+            const stat = fs.statSync(filePath);
+            if (stat.isDirectory()) {
+                this.loadSchemasFromDir(filePath, `${relativePath}/${file}`, schemas);
+            }
+            else if (file.endsWith('.json')) {
+                try {
+                    const schema = JSON.parse(fs.readFileSync(filePath, 'utf-8'));
+                    const key = `${relativePath}/${file}`;
+                    schemas.set(key, {
+                        schema,
+                        uri: `file:///${filePath.replace(/\\/g, '/')}`
+                    });
+                }
+                catch (error) {
+                    console.error(`Error loading schema ${filePath}:`, error);
+                }
+            }
+        }
+    }
+    /**
+     * Register all loaded schemas with Ajv
+     */
+    registerSchemas() {
+        for (const [key, entry] of this.schemas.entries()) {
+            try {
+                this.ajv.addSchema(entry.schema, key);
+            }
+            catch (error) {
+                console.error(`Error adding schema ${key}:`, error);
+            }
+        }
+    }
+    /**
+     * Validate a YAML workflow file
+     */
+    async validateWorkflow(filePath) {
+        const errors = [];
+        const warnings = [];
+        try {
+            // Check if file exists
+            if (!fs.existsSync(filePath)) {
+                errors.push({
+                    type: 'file_not_found',
+                    path: filePath,
+                    message: `File not found: ${filePath}`
+                });
+                return this.createResult(filePath, errors, warnings);
+            }
+            // Read and parse YAML
+            const content = fs.readFileSync(filePath, 'utf-8');
+            let workflowData;
+            try {
+                workflowData = yaml.load(content);
+            }
+            catch (yamlError) {
+                errors.push({
+                    type: 'yaml_syntax_error',
+                    path: filePath,
+                    message: `YAML syntax error: ${yamlError.message}`
+                });
+                return this.createResult(filePath, errors, warnings);
+            }
+            // Validate workflow structure
+            this.validateWorkflowStructure(workflowData, errors, warnings);
+            // Validate against main workflow schema
+            const validate = this.ajv.getSchema('workflow.json');
+            if (validate && !validate(workflowData)) {
+                this.addAjvErrors(validate.errors, '', errors);
+            }
+            // Validate activities recursively
+            if (workflowData.activities && Array.isArray(workflowData.activities)) {
+                this.validateActivities(workflowData.activities, 'activities', errors, warnings);
+            }
+            return this.createResult(filePath, errors, warnings);
+        }
+        catch (error) {
+            errors.push({
+                type: 'unexpected_error',
+                path: filePath,
+                message: `Unexpected error: ${error.message}`
+            });
+            return this.createResult(filePath, errors, warnings);
+        }
+    }
+    /**
+     * Validate top-level workflow structure
+     */
+    validateWorkflowStructure(workflowData, errors, warnings) {
+        // Check required top-level properties
+        if (!workflowData.workflow) {
+            errors.push({
+                type: 'missing_property',
+                path: 'workflow',
+                message: 'Missing required property: workflow'
+            });
+            return;
+        }
+        if (!workflowData.activities) {
+            errors.push({
+                type: 'missing_property',
+                path: 'activities',
+                message: 'Missing required property: activities'
+            });
+        }
+        // Validate workflow metadata
+        const workflow = workflowData.workflow;
+        if (!workflow.workflowId) {
+            errors.push({
+                type: 'missing_property',
+                path: 'workflow.workflowId',
+                message: 'Missing required property: workflow.workflowId'
+            });
+        }
+        if (!workflow.name) {
+            errors.push({
+                type: 'missing_property',
+                path: 'workflow.name',
+                message: 'Missing required property: workflow.name'
+            });
+        }
+        // Check for deprecated properties
+        this.checkDeprecatedProperties(workflow, 'workflow', warnings);
+    }
+    /**
+     * Validate activities array recursively
+     */
+    validateActivities(activities, basePath, errors, warnings) {
+        activities.forEach((activity, index) => {
+            const activityPath = `${basePath}[${index}]`;
+            this.validateActivity(activity, activityPath, errors, warnings);
+        });
+    }
+    /**
+     * Validate a single activity
+     */
+    validateActivity(activity, activityPath, errors, warnings) {
+        if (!activity || typeof activity !== 'object') {
+            errors.push({
+                type: 'invalid_activity',
+                path: activityPath,
+                message: 'Activity must be an object'
+            });
+            return;
+        }
+        // Check for required properties
+        if (!activity.name) {
+            errors.push({
+                type: 'missing_property',
+                path: `${activityPath}.name`,
+                message: 'Activity must have a name property'
+            });
+        }
+        if (!activity.steps || !Array.isArray(activity.steps)) {
+            errors.push({
+                type: 'missing_property',
+                path: `${activityPath}.steps`,
+                message: 'Activity must have a steps array'
+            });
+            return;
+        }
+        // Validate each step
+        activity.steps.forEach((step, stepIndex) => {
+            const stepPath = `${activityPath}.steps[${stepIndex}]`;
+            this.validateStep(step, stepPath, errors, warnings);
+        });
+    }
+    /**
+     * Validate a single step (task)
+     */
+    validateStep(step, stepPath, errors, warnings) {
+        if (!step || typeof step !== 'object') {
+            errors.push({
+                type: 'schema_violation',
+                path: stepPath,
+                message: 'Step must be an object'
+            });
+            return;
+        }
+        // Check for task type
+        if (!step.task) {
+            errors.push({
+                type: 'missing_property',
+                path: `${stepPath}.task`,
+                message: 'Step must have a task property'
+            });
+            return;
+        }
+        // Validate nested structures (foreach, switch, while)
+        this.validateNestedSteps(step, stepPath, errors, warnings);
+    }
+    /**
+     * Validate nested structures within control flow tasks
+     */
+    validateNestedSteps(step, stepPath, errors, warnings) {
+        const taskType = step.task;
+        // Handle foreach
+        if (taskType === 'foreach') {
+            if (step.steps && Array.isArray(step.steps)) {
+                step.steps.forEach((nestedStep, index) => {
+                    this.validateStep(nestedStep, `${stepPath}.steps[${index}]`, errors, warnings);
+                });
+            }
+        }
+        // Handle switch
+        if (taskType === 'switch') {
+            if (step.cases && Array.isArray(step.cases)) {
+                step.cases.forEach((caseItem, caseIndex) => {
+                    if (caseItem.steps && Array.isArray(caseItem.steps)) {
+                        caseItem.steps.forEach((nestedStep, stepIndex) => {
+                            this.validateStep(nestedStep, `${stepPath}.cases[${caseIndex}].steps[${stepIndex}]`, errors, warnings);
+                        });
+                    }
+                });
+            }
+            if (step.default && step.default.steps && Array.isArray(step.default.steps)) {
+                step.default.steps.forEach((nestedStep, index) => {
+                    this.validateStep(nestedStep, `${stepPath}.default.steps[${index}]`, errors, warnings);
+                });
+            }
+        }
+        // Handle while
+        if (taskType === 'while') {
+            if (step.steps && Array.isArray(step.steps)) {
+                step.steps.forEach((nestedStep, index) => {
+                    this.validateStep(nestedStep, `${stepPath}.steps[${index}]`, errors, warnings);
+                });
+            }
+        }
+    }
+    /**
+     * Convert Ajv errors to our error format
+     */
+    addAjvErrors(ajvErrors, basePath, errors) {
+        if (!ajvErrors)
+            return;
+        for (const error of ajvErrors) {
+            const errorPath = basePath ? `${basePath}${error.instancePath}` : error.instancePath.slice(1);
+            errors.push({
+                type: 'schema_violation',
+                path: errorPath || '/',
+                message: error.message || 'Schema validation failed',
+                schemaPath: error.schemaPath
+            });
+        }
+    }
+    /**
+     * Check for deprecated properties
+     */
+    checkDeprecatedProperties(obj, path, warnings) {
+        const deprecations = {
+        // Add deprecated workflow properties here as needed
+        };
+        for (const [oldProp, message] of Object.entries(deprecations)) {
+            if (oldProp in obj) {
+                warnings.push({
+                    type: 'deprecated_property',
+                    path: `${path}.${oldProp}`,
+                    message
+                });
+            }
+        }
+    }
+    /**
+     * Create validation result
+     */
+    createResult(filePath, errors, warnings) {
+        const errorsByType = {};
+        errors.forEach(error => {
+            errorsByType[error.type] = (errorsByType[error.type] || 0) + 1;
+        });
+        return {
+            isValid: errors.length === 0,
+            errors,
+            warnings: this.options.includeWarnings ? warnings : [],
+            summary: {
+                file: filePath,
+                timestamp: new Date().toISOString(),
+                status: errors.length === 0 ? 'PASSED' : 'FAILED',
+                errorCount: errors.length,
+                warningCount: warnings.length,
+                errorsByType
+            }
+        };
+    }
+    /**
+     * Get all loaded schema keys
+     */
+    getLoadedSchemas() {
+        return Array.from(this.schemas.keys());
+    }
+}
+exports.WorkflowValidator = WorkflowValidator;
+//# sourceMappingURL=workflowValidator.js.map

package/dist/workflowValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflowValidator.js","sourceRoot":"","sources":["../src/workflowValidator.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,8CAAyD;AACzD,8DAAqC;AACrC,uCAAyB;AACzB,2CAA6B;AAC7B,8CAAgC;AAUhC,MAAa,iBAAiB;IAM5B,YAAY,UAAoC,EAAE;QAChD,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,WAAW,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC;QACtF,IAAI,CAAC,OAAO,GAAG;YACb,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,IAAI;YACtC,eAAe,EAAE,OAAO,CAAC,eAAe,IAAI,IAAI;YAChD,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,IAAI;YAC5C,mBAAmB,EAAE,OAAO,CAAC,mBAAmB,IAAI,KAAK;SAC1D,CAAC;QAEF,sCAAsC;QACtC,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC;YACjB,MAAM,EAAE,KAAK;YACb,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,IAAI;YACb,eAAe,EAAE,IAAI;YACrB,eAAe,EAAE,IAAI;SACtB,CAAC,CAAC;QAEH,wBAAwB;QACxB,IAAA,qBAAU,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAErB,4BAA4B;QAC5B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEzD,4BAA4B;QAC5B,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACK,mBAAmB,CAAC,UAAkB;QAC5C,MAAM,OAAO,GAAG,IAAI,GAAG,EAAuB,CAAC;QAE/C,0BAA0B;QAC1B,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QAC9D,IAAI,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;YAClC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;YACpE,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE;gBAC3B,MAAM;gBACN,GAAG,EAAE,WAAW,cAAc,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE;aACrD,CAAC,CAAC;QACL,CAAC;QAED,4BAA4B;QAC5B,MAAM,UAAU,GAAG,CAAC,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,cAAc,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC;QACpH,KAAK,MAAM,UAAU,IAAI,UAAU,EAAE,CAAC;YACpC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YACrD,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;gBAChE,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;oBACtB,MAAM;oBACN,GAAG,EAAE,WAAW,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE;iBACjD,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,6CAA6C;QAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAChD,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACtD,CAAC;QAED,gDAAgD;QAChD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAClD,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACK,kBAAkB,CACxB,GAAW,EACX,YAAoB,EACpB,OAAiC;QAEjC,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAElC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAEnC,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;gBACvB,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,GAAG,YAAY,IAAI,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;YACxE,CAAC;iBAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;oBAC9D,MAAM,GAAG,GAAG,GAAG,YAAY,IAAI,IAAI,EAAE,CAAC;oBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE;wBACf,MAAM;wBACN,GAAG,EAAE,WAAW,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE;qBAC/C,CAAC,CAAC;gBACL,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,KAAK,CAAC,wBAAwB,QAAQ,GAAG,EAAE,KAAK,CAAC,CAAC;gBAC5D,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACK,eAAe;QACrB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YAClD,IAAI,CAAC;gBACH,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YACxC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,uBAAuB,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CAAC,QAAgB;QACrC,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,MAAM,QAAQ,GAAwB,EAAE,CAAC;QAEzC,IAAI,CAAC;YACH,uBAAuB;YACvB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC7B,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,gBAAgB;oBACtB,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,mBAAmB,QAAQ,EAAE;iBACvC,CAAC,CAAC;gBACH,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;YACvD,CAAC;YAED,sBAAsB;YACtB,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACnD,IAAI,YAA0B,CAAC;YAE/B,IAAI,CAAC;gBACH,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAiB,CAAC;YACpD,CAAC;YAAC,OAAO,SAAc,EAAE,CAAC;gBACxB,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,mBAAmB;oBACzB,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,sBAAsB,SAAS,CAAC,OAAO,EAAE;iBACnD,CAAC,CAAC;gBACH,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;YACvD,CAAC;YAED,8BAA8B;YAC9B,IAAI,CAAC,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;YAE/D,wCAAwC;YACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;YACrD,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;gBACxC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;YACjD,CAAC;YAED,kCAAkC;YAClC,IAAI,YAAY,CAAC,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC;gBACtE,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;YACnF,CAAC;YAED,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;QACvD,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,qBAAqB,KAAK,CAAC,OAAO,EAAE;aAC9C,CAAC,CAAC;YACH,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED;;OAEG;IACK,yBAAyB,CAC/B,YAA0B,EAC1B,MAAyB,EACzB,QAA6B;QAE7B,sCAAsC;QACtC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,qCAAqC;aAC/C,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,YAAY;gBAClB,OAAO,EAAE,uCAAuC;aACjD,CAAC,CAAC;QACL,CAAC;QAED,6BAA6B;QAC7B,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;YACzB,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,qBAAqB;gBAC3B,OAAO,EAAE,gDAAgD;aAC1D,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,0CAA0C;aACpD,CAAC,CAAC;QACL,CAAC;QAED,kCAAkC;QAClC,IAAI,CAAC,yBAAyB,CAAC,QAAQ,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACK,kBAAkB,CACxB,UAAiB,EACjB,QAAgB,EAChB,MAAyB,EACzB,QAA6B;QAE7B,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;YACrC,MAAM,YAAY,GAAG,GAAG,QAAQ,IAAI,KAAK,GAAG,CAAC;YAC7C,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,gBAAgB,CACtB,QAAa,EACb,YAAoB,EACpB,MAAyB,EACzB,QAA6B;QAE7B,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC9C,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,YAAY;gBAClB,OAAO,EAAE,4BAA4B;aACtC,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,gCAAgC;QAChC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,GAAG,YAAY,OAAO;gBAC5B,OAAO,EAAE,oCAAoC;aAC9C,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACtD,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,GAAG,YAAY,QAAQ;gBAC7B,OAAO,EAAE,kCAAkC;aAC5C,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,qBAAqB;QACrB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAS,EAAE,SAAiB,EAAE,EAAE;YACtD,MAAM,QAAQ,GAAG,GAAG,YAAY,UAAU,SAAS,GAAG,CAAC;YACvD,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,YAAY,CAClB,IAAS,EACT,QAAgB,EAChB,MAAyB,EACzB,QAA6B;QAE7B,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,wBAAwB;aAClC,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,sBAAsB;QACtB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,GAAG,QAAQ,OAAO;gBACxB,OAAO,EAAE,gCAAgC;aAC1C,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,sDAAsD;QACtD,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACK,mBAAmB,CACzB,IAAS,EACT,QAAgB,EAChB,MAAyB,EACzB,QAA6B;QAE7B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;QAE3B,iBAAiB;QACjB,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,IAAI,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,UAAe,EAAE,KAAa,EAAE,EAAE;oBACpD,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,QAAQ,UAAU,KAAK,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;gBACjF,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,gBAAgB;QAChB,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAa,EAAE,SAAiB,EAAE,EAAE;oBACtD,IAAI,QAAQ,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;wBACpD,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,UAAe,EAAE,SAAiB,EAAE,EAAE;4BAC5D,IAAI,CAAC,YAAY,CACf,UAAU,EACV,GAAG,QAAQ,UAAU,SAAS,WAAW,SAAS,GAAG,EACrD,MAAM,EACN,QAAQ,CACT,CAAC;wBACJ,CAAC,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5E,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,UAAe,EAAE,KAAa,EAAE,EAAE;oBAC5D,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,QAAQ,kBAAkB,KAAK,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;gBACzF,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,eAAe;QACf,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,UAAe,EAAE,KAAa,EAAE,EAAE;oBACpD,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,QAAQ,UAAU,KAAK,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;gBACjF,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACK,YAAY,CAClB,SAA2C,EAC3C,QAAgB,EAChB,MAAyB;QAEzB,IAAI,CAAC,SAAS;YAAE,OAAO;QAEvB,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE,CAAC;YAC9B,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9F,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,SAAS,IAAI,GAAG;gBACtB,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,0BAA0B;gBACpD,UAAU,EAAE,KAAK,CAAC,UAAU;aAC7B,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;OAEG;IACK,yBAAyB,CAC/B,GAAQ,EACR,IAAY,EACZ,QAA6B;QAE7B,MAAM,YAAY,GAA2B;QAC3C,oDAAoD;SACrD,CAAC;QAEF,KAAK,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YAC9D,IAAI,OAAO,IAAI,GAAG,EAAE,CAAC;gBACnB,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,qBAAqB;oBAC3B,IAAI,EAAE,GAAG,IAAI,IAAI,OAAO,EAAE;oBAC1B,OAAO;iBACR,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACK,YAAY,CAClB,QAAgB,EAChB,MAAyB,EACzB,QAA6B;QAE7B,MAAM,YAAY,GAA2B,EAAE,CAAC;QAChD,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACrB,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;YAC5B,MAAM;YACN,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YACtD,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,MAAM,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ;gBACjD,UAAU,EAAE,MAAM,CAAC,MAAM;gBACzB,YAAY,EAAE,QAAQ,CAAC,MAAM;gBAC7B,YAAY;aACb;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;CACF;AAlcD,8CAkcC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@cxtms/cx-schema",
+  "version": "1.0.0",
+  "description": "Schema validation package for CargoXplorer YAML modules",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "cx-validate": "dist/cli.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "postinstall": "node scripts/postinstall.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "schema",
+    "validation",
+    "yaml",
+    "tms",
+    "cargoxplorer",
+    "module"
+  ],
+  "author": "CargoXplorer",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cargoxplorer/cx-schema.git"
+  },
+  "files": [
+    "dist",
+    "schemas",
+    "scripts",
+    "templates"
+  ],
+  "dependencies": {
+    "ajv": "^8.12.0",
+    "ajv-formats": "^2.1.1",
+    "chalk": "^4.1.2",
+    "js-yaml": "^4.1.0"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^20.10.0",
+    "typescript": "^5.3.3"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}

package/schemas/actions/all.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "All Actions",
+  "type": "object",
+  "oneOf": [
+    { "$ref": "navigate.json" },
+    { "$ref": "navigateBack.json" },
+    { "$ref": "navigateBackOrClose.json" },
+    { "$ref": "refresh.json" },
+    { "$ref": "notification.json" },
+    { "$ref": "confirm.json" },
+    { "$ref": "mutation.json" },
+    { "$ref": "query.json" },
+    { "$ref": "setFields.json" },
+    { "$ref": "setStore.json" },
+    { "$ref": "validateForm.json" },
+    { "$ref": "dialog.json" },
+    { "$ref": "workflow.json" },
+    { "$ref": "fileDownload.json" },
+    { "$ref": "forEach.json" },
+    { "$ref": "if.json" },
+    { "$ref": "consoleLog.json" },
+    { "$ref": "openBarcodeScanner.json" },
+    { "$ref": "resetDirtyState.json" }
+  ]
+}

package/schemas/actions/confirm.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "confirm Action",
+  "type": "object",
+  "properties": {
+    "confirm": {
+      "type": "object",
+      "properties": {
+        "title": { "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }] },
+        "message": { "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }] }
+      },
+      "x-examples": [
+        {
+          "title": { "en-US": "Delete Calendar" },
+          "message": { "en-US": "Are you sure you want to delete this calendar?" }
+        }
+      ]
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/actions/consoleLog.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "consoleLog Action",
+  "type": "object",
+  "properties": {
+    "consoleLog": {
+      "type": "object",
+      "properties": {
+        "message": { "type": "string", "description": "Message to log" },
+        "level": { "type": "string", "enum": ["log", "info", "warn", "error"], "default": "log" }
+      },
+      "x-examples": [{ "message": "Scanned: {{ result.data }}", "level": "info" }]
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/actions/dialog.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "dialog Action",
+  "type": "object",
+  "properties": {
+    "dialog": {
+      "type": "object",
+      "properties": {
+        "name": { "type": "string", "description": "Dialog identifier" },
+        "props": { "type": "object", "description": "Props to pass to dialog" },
+        "component": { "$ref": "../schemas.json#/definitions/component" },
+        "onClose": { "$ref": "../schemas.json#/definitions/actionsList" }
+      },
+      "x-examples": [
+        { "name": "addCommoditiesDialog", "props": { "title": { "en-US": "Add Commodities" } } },
+        {
+          "component": "States/CreateState",
+          "props": { "title": "Create New State" },
+          "onClose": [{ "selectValue": "{{ result }}" }]
+        }
+      ]
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/actions/fileDownload.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "fileDownload Action",
+  "type": "object",
+  "properties": {
+    "fileDownload": {
+      "type": "object",
+      "properties": {
+        "url": { "type": "string", "description": "File download URL" },
+        "filename": { "type": "string", "description": "Suggested filename" }
+      },
+      "x-examples": [{ "url": "{{ outputs.labelUrl }}", "filename": "label.pdf" }]
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/actions/forEach.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "forEach Action",
+  "type": "object",
+  "properties": {
+    "forEach": {
+      "type": "object",
+      "properties": {
+        "items": { "type": "string", "description": "Template expression for items array" },
+        "item": { "type": "string", "description": "Variable name for current item" },
+        "actions": { "$ref": "../schemas.json#/definitions/actionsList" }
+      },
+      "x-examples": [
+        {
+          "items": "{{ existingRouteLegs.selectedItems }}",
+          "item": "routeLeg",
+          "actions": [
+            {
+              "mutation": {
+                "command": "mutation CreateRouteRouteLegMutation($input: CreateRouteRouteLegInput!) { createRouteRouteLeg(input: $input) { routeRouteLeg { routeLegId } } }",
+                "variables": { "input": { "routeLegId": "{{ number routeLeg.routeLegId }}" } }
+              }
+            },
+            { "refresh": "routeLegsGrid" }
+          ]
+        }
+      ]
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/actions/if.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "if Action",
+  "type": "object",
+  "properties": {
+    "if": { "type": "string", "description": "Template expression condition" },
+    "then": { "$ref": "../schemas.json#/definitions/actionsList" },
+    "else": { "$ref": "../schemas.json#/definitions/actionsList" }
+  },
+  "x-examples": [{ "if": "{{ result }}", "then": [{ "refresh": "warehouseReceiptsCommodities" }] }],
+  "additionalProperties": false
+}

package/schemas/actions/mutation.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "mutation Action",
+  "type": "object",
+  "properties": {
+    "mutation": {
+      "type": "object",
+      "properties": {
+        "command": { "type": "string", "description": "GraphQL mutation string" },
+        "variables": { "type": "object", "description": "Mutation variables" },
+        "onSuccess": { "$ref": "../schemas.json#/definitions/actionsList" },
+        "onError": { "$ref": "../schemas.json#/definitions/actionsList" }
+      },
+      "x-examples": [
+        {
+          "command": "mutation DeleteCalendarMutation($input: DeleteCalendarInput!) { deleteCalendar(input: $input) { deleteResult { rowsAffected } } }",
+          "variables": {
+            "input": { "organizationId": "{{number organizationId }}", "calendarId": "{{number calendarId }}" }
+          }
+        }
+      ]
+    }
+  },
+  "additionalProperties": false
+}