cxtms 1.9.13

package/schemas/workflows/tasks/workflow-execute.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Workflow Execute Task",
+  "description": "Execute another workflow",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["Workflow/Execute@1"],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": ["expression"]
+      }
+    },
+    "continueOnError": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "Workflow execution inputs",
+      "properties": {
+        "workflowId": {
+          "type": "string",
+          "format": "uuid",
+          "description": "ID of workflow to execute"
+        },
+        "workflowName": {
+          "type": "string",
+          "description": "Name of workflow to execute (alternative to workflowId)"
+        },
+        "workflowInputs": {
+          "type": "object",
+          "description": "Inputs to pass to the child workflow",
+          "additionalProperties": true
+        },
+        "async": {
+          "type": "boolean",
+          "description": "Execute asynchronously"
+        },
+        "timeout": {
+          "type": "integer",
+          "description": "Execution timeout in milliseconds"
+        }
+      },
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "mapping": {
+            "type": "string"
+          }
+        },
+        "required": ["name", "mapping"]
+      }
+    }
+  },
+  "required": ["task"],
+  "additionalProperties": true
+}

package/schemas/workflows/trigger.json

@@ -0,0 +1,90 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Workflow Trigger",
+  "description": "Definition of a workflow trigger",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Trigger name identifier"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["Manual", "Entity"],
+      "description": "Trigger type"
+    },
+    "displayName": {
+      "type": "string",
+      "description": "Display name for manual triggers (button text)"
+    },
+    "entityName": {
+      "type": "string",
+      "description": "Entity name for the trigger context"
+    },
+    "eventType": {
+      "type": "string",
+      "enum": ["Added", "Modified", "Deleted"],
+      "description": "Entity event type (for Entity triggers)"
+    },
+    "position": {
+      "type": "string",
+      "enum": ["Before", "After"],
+      "description": "When to execute relative to entity operation"
+    },
+    "conditions": {
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "Single condition expression"
+        },
+        {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "expression": {
+                    "type": "string"
+                  }
+                },
+                "required": ["expression"]
+              }
+            ]
+          },
+          "description": "Array of condition expressions"
+        }
+      ],
+      "description": "Conditions for trigger activation"
+    },
+    "additionalProperties": {
+      "type": "object",
+      "description": "Additional trigger properties",
+      "properties": {
+        "silent": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "Entity"
+          }
+        },
+        "required": ["type"]
+      },
+      "then": {
+        "required": ["entityName", "eventType"]
+      }
+    }
+  ],
+  "additionalProperties": true
+}

package/schemas/workflows/variable.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Workflow Variable",
+  "description": "Definition of a workflow variable. Valid properties: name, value, fromConfig, expression.",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$",
+      "description": "Variable name"
+    },
+    "value": {
+      "description": "Static variable value or template expression"
+    },
+    "expression": {
+      "type": "string",
+      "description": "NCalc expression to evaluate at runtime. Has access to all previously resolved variables. Mutually exclusive with value and fromConfig."
+    },
+    "fromConfig": {
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "Configuration key to load value from"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "configName": {
+              "type": "string",
+              "description": "Configuration name (e.g., 'apps.novaposhta')"
+            },
+            "key": {
+              "type": "string",
+              "description": "Optional key within configuration"
+            }
+          },
+          "required": ["configName"],
+          "additionalProperties": true
+        }
+      ],
+      "description": "Load value from configuration"
+    }
+  },
+  "required": ["name"],
+  "additionalProperties": false
+}

package/schemas/workflows/workflow.json

@@ -0,0 +1,335 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "CargoXplorer Workflow",
+  "description": "Schema for CargoXplorer workflow YAML files. Supports standard task-based workflows and Flow (state machine) workflows.",
+  "type": "object",
+  "properties": {
+    "workflow": {
+      "type": "object",
+      "description": "Workflow metadata and configuration",
+      "properties": {
+        "workflowId": {
+          "type": "string",
+          "format": "uuid",
+          "description": "Unique workflow identifier (UUID)"
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Workflow name"
+        },
+        "description": {
+          "type": "string",
+          "description": "Workflow description"
+        },
+        "version": {
+          "type": "string",
+          "description": "Workflow version (e.g., '1.0')"
+        },
+        "executionMode": {
+          "type": "string",
+          "enum": ["Sync", "Async"],
+          "description": "Execution mode - synchronous or asynchronous"
+        },
+        "logLevel": {
+          "type": "string",
+          "enum": ["None", "Trace", "Debug", "Information", "Warning", "Error"],
+          "description": "Logging level for workflow execution"
+        },
+        "isActive": {
+          "type": "boolean",
+          "description": "Whether the workflow is active"
+        },
+        "enableAudit": {
+          "type": "boolean",
+          "description": "Enable audit logging"
+        },
+        "enableTransaction": {
+          "type": "boolean",
+          "description": "Enable transaction support"
+        },
+        "enableActionEvents": {
+          "type": "boolean",
+          "description": "Enable action events (deprecated)"
+        },
+        "priority": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 100,
+          "description": "Workflow priority (0-100, higher = higher priority, default: 50)"
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Tags for categorization and filtering"
+        },
+        "workflowType": {
+          "type": "string",
+          "enum": ["Document", "Quote", "Flow", "Webhook", "PublicApi"],
+          "description": "Workflow type: Document (PDF/Excel generation), Quote, Flow (declarative state machine), Webhook (HTTP endpoint), or PublicApi (REST API endpoint). Omit for standard process workflows."
+        },
+        "runAs": {
+          "type": "string",
+          "description": "Username or user ID for workflow execution context"
+        },
+        "concurrency": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": true,
+              "description": "Whether concurrency control is active"
+            },
+            "group": {
+              "type": "string",
+              "description": "Concurrency group identifier"
+            },
+            "waitTime": {
+              "type": "number",
+              "default": 15,
+              "description": "Seconds to wait for lock (default: 15)"
+            }
+          },
+          "additionalProperties": true
+        },
+        "filePath": {
+          "type": "string",
+          "description": "Repository file path under workflows/ or features/{name}/workflows/"
+        },
+        "agentInstruction": {
+          "type": "string",
+          "description": "AI agent instruction describing how to use this workflow, expected inputs, and returned outputs"
+        },
+        "actionEvent": {
+          "type": "object",
+          "description": "Workflow action event configuration",
+          "additionalProperties": true
+        },
+        "additionalProperties": {
+          "type": "object",
+          "description": "Custom additional properties",
+          "additionalProperties": true
+        }
+      },
+      "required": ["workflowId", "name"],
+      "additionalProperties": true
+    },
+    "inputs": {
+      "type": ["array", "null"],
+      "description": "Workflow input parameters",
+      "items": {
+        "$ref": "input.json"
+      }
+    },
+    "outputs": {
+      "type": ["array", "null"],
+      "description": "Workflow output definitions",
+      "items": {
+        "$ref": "output.json"
+      }
+    },
+    "variables": {
+      "type": ["array", "null"],
+      "description": "Workflow variables",
+      "items": {
+        "$ref": "variable.json"
+      }
+    },
+    "activities": {
+      "type": "array",
+      "description": "Workflow activities containing steps (required for standard workflows, not used in Flow workflows)",
+      "items": {
+        "$ref": "activity.json"
+      },
+      "minItems": 1
+    },
+    "triggers": {
+      "type": "array",
+      "description": "Workflow triggers",
+      "items": {
+        "$ref": "trigger.json"
+      }
+    },
+    "schedules": {
+      "type": "array",
+      "description": "Scheduled execution configurations",
+      "items": {
+        "$ref": "schedule.json"
+      }
+    },
+    "events": {
+      "oneOf": [
+        {
+          "type": "object",
+          "description": "Workflow-level event handlers as object",
+          "properties": {
+            "onWorkflowStarted": {
+              "type": "array",
+              "description": "Steps to execute when workflow starts",
+              "items": { "$ref": "common/step.json" }
+            },
+            "onWorkflowCompleted": {
+              "type": "array",
+              "description": "Steps to execute when workflow completes",
+              "items": { "$ref": "common/step.json" }
+            },
+            "onWorkflowExecuted": {
+              "type": "array",
+              "description": "Alias for onWorkflowCompleted (deprecated, use onWorkflowCompleted)",
+              "items": { "$ref": "common/step.json" }
+            },
+            "onWorkflowFailed": {
+              "type": "array",
+              "description": "Steps to execute when workflow fails",
+              "items": { "$ref": "common/step.json" }
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "array",
+          "description": "Workflow-level event handlers as array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "description": "Event type"
+              },
+              "steps": {
+                "type": "array",
+                "description": "Steps to execute for this event",
+                "items": { "$ref": "common/step.json" }
+              }
+            },
+            "additionalProperties": true
+          }
+        }
+      ]
+    },
+    "api": {
+      "type": "object",
+      "description": "Public API endpoint configuration (required for PublicApi workflows)",
+      "properties": {
+        "path": {
+          "type": "string",
+          "description": "API route path with parameter placeholders (e.g., '/orders/{orderId}')"
+        },
+        "method": {
+          "type": "string",
+          "enum": ["GET", "POST", "PUT", "PATCH", "DELETE"],
+          "description": "HTTP method"
+        },
+        "summary": {
+          "type": "string",
+          "description": "Short summary for Swagger/OpenAPI documentation"
+        },
+        "description": {
+          "type": "string",
+          "description": "Detailed description for Swagger/OpenAPI documentation"
+        },
+        "operationId": {
+          "type": "string",
+          "description": "Unique operation ID for OpenAPI (auto-generated if omitted)"
+        },
+        "document": {
+          "type": "string",
+          "description": "Swagger document name (default: 'public')"
+        },
+        "category": {
+          "type": "string",
+          "description": "Swagger tag/group for organizing endpoints"
+        },
+        "authentication": {
+          "type": "string",
+          "enum": ["none", "bearer", "apiKey"],
+          "description": "Authentication method: none (anonymous), bearer (JWT token), or apiKey"
+        },
+        "rateLimit": {
+          "type": "object",
+          "description": "Rate limiting configuration",
+          "properties": {
+            "perSecond": {
+              "type": "integer",
+              "description": "Maximum requests per second"
+            },
+            "perMinute": {
+              "type": "integer",
+              "description": "Maximum requests per minute"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": ["path", "method"],
+      "additionalProperties": true
+    },
+    "entity": {
+      "$ref": "flow/entity.json",
+      "description": "Entity configuration for Flow workflows"
+    },
+    "states": {
+      "type": "array",
+      "description": "State definitions for Flow workflows",
+      "items": {
+        "$ref": "flow/state.json"
+      }
+    },
+    "transitions": {
+      "type": "array",
+      "description": "Transition definitions for Flow workflows",
+      "items": {
+        "$ref": "flow/transition.json"
+      }
+    },
+    "aggregations": {
+      "type": "array",
+      "description": "Aggregation definitions for Flow workflows",
+      "items": {
+        "$ref": "flow/aggregation.json"
+      }
+    }
+  },
+  "required": ["workflow"],
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "workflow": {
+            "properties": {
+              "workflowType": { "const": "Flow" }
+            },
+            "required": ["workflowType"]
+          }
+        }
+      },
+      "then": {
+        "required": ["workflow", "entity"],
+        "properties": {
+          "activities": false
+        }
+      },
+      "else": {
+        "required": ["workflow", "activities"]
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "workflow": {
+            "properties": {
+              "workflowType": { "const": "PublicApi" }
+            },
+            "required": ["workflowType"]
+          }
+        }
+      },
+      "then": {
+        "required": ["workflow", "activities", "api"]
+      }
+    }
+  ],
+  "additionalProperties": true
+}