cxtms 1.9.13

package/schemas/workflows/flow/transition.json

@@ -0,0 +1,143 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Flow Transition",
+  "description": "Transition definition for Flow workflows. Defines how entities move between states.",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Unique transition name within the workflow."
+    },
+    "displayName": {
+      "type": "string",
+      "description": "Display name for UI presentation."
+    },
+    "from": {
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "Single source state name, or '*' for wildcard (any non-final state)."
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Array of source state names. Transition is valid from any of them."
+        }
+      ],
+      "description": "Source state(s). Can be a single state, array of states, or '*' wildcard."
+    },
+    "to": {
+      "type": "string",
+      "description": "Target state name. Must be a leaf state (no children)."
+    },
+    "trigger": {
+      "type": "string",
+      "enum": ["auto", "manual", "event"],
+      "description": "Trigger type: 'auto' (condition-based), 'manual' (user-initiated), or 'event' (external event)."
+    },
+    "eventName": {
+      "type": "string",
+      "description": "Event name for 'event' trigger type. Required when trigger is 'event'."
+    },
+    "priority": {
+      "type": "integer",
+      "description": "Priority for ordering when multiple transitions are valid. Higher numbers = higher priority. Default is 50."
+    },
+    "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 conditions that must all evaluate to true."
+        }
+      ],
+      "description": "Conditions for the transition to occur."
+    },
+    "steps": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "task": { "type": "string" },
+          "name": { "type": "string" },
+          "inputs": { "type": "object", "additionalProperties": true },
+          "outputs": { "type": "array" },
+          "conditions": { "oneOf": [{ "type": "string" }, { "type": "array" }] },
+          "continueOnError": { "type": "boolean" }
+        },
+        "required": ["task"],
+        "additionalProperties": true
+      },
+      "description": "Steps to execute during the transition. Executed after onExit and before onEnter steps."
+    }
+  },
+  "required": ["name", "trigger"],
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "trigger": { "const": "event" }
+        },
+        "required": ["trigger"]
+      },
+      "then": {
+        "required": ["eventName"]
+      }
+    }
+  ],
+  "additionalProperties": false,
+  "x-examples": [
+    {
+      "name": "submit",
+      "from": "Draft",
+      "to": "Submitted",
+      "trigger": "manual"
+    },
+    {
+      "name": "auto_approve",
+      "displayName": "Auto Approve Order",
+      "from": "Submitted",
+      "to": "Approved",
+      "trigger": "auto",
+      "priority": 10,
+      "conditions": ["Order.TotalAmount < 1000"]
+    },
+    {
+      "name": "cancel",
+      "from": ["Draft", "Submitted", "Approved"],
+      "to": "Cancelled",
+      "trigger": "manual"
+    },
+    {
+      "name": "deliver",
+      "from": "Shipped",
+      "to": "Delivered",
+      "trigger": "event",
+      "eventName": "DeliveryConfirmed"
+    },
+    {
+      "name": "force_cancel",
+      "from": "*",
+      "to": "Cancelled",
+      "trigger": "manual"
+    }
+  ]
+}

package/schemas/workflows/input.json

@@ -0,0 +1,122 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Workflow Input Parameter",
+  "description": "Definition of a workflow input parameter. Only 'name', 'type', and 'props' are valid top-level properties. All other settings (required, displayName, description, etc.) belong inside 'props'.",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$",
+      "description": "Input parameter name (must be valid identifier)"
+    },
+    "type": {
+      "type": "string",
+      "description": "Input parameter type (e.g., text, number, integer, boolean, date, datetime, options, object, array, or custom entity types)"
+    },
+    "props": {
+      "type": "object",
+      "description": "Input properties and configuration",
+      "properties": {
+        "displayName": {
+          "type": "string",
+          "description": "Human-readable display name"
+        },
+        "description": {
+          "type": "string",
+          "description": "Description of the input parameter"
+        },
+        "in": {
+          "type": "string",
+          "enum": ["path", "query", "header", "body"],
+          "description": "Parameter location for PublicApi workflows: path, query, header, or body"
+        },
+        "format": {
+          "type": "string",
+          "description": "Parameter format hint for OpenAPI documentation (e.g., 'uuid', 'date-time', 'email', 'int32', 'int64')"
+        },
+        "required": {
+          "type": "boolean",
+          "description": "Whether input is required"
+        },
+        "multiple": {
+          "type": "boolean",
+          "description": "Whether multiple values are allowed"
+        },
+        "visible": {
+          "type": "boolean",
+          "description": "Whether input is visible in UI"
+        },
+        "defaultValue": {
+          "description": "Default value for the input"
+        },
+        "mapping": {
+          "type": "string",
+          "description": "Maps to entity property (e.g., 'order.orderId')"
+        },
+        "filter": {
+          "type": "string",
+          "description": "Filter expression for entity inputs"
+        },
+        "default": {
+          "description": "Default value for the input (alternative to defaultValue)"
+        },
+        "itemType": {
+          "type": "string",
+          "description": "Item type for array inputs (e.g., 'number', 'text')"
+        },
+        "schema": {
+          "description": "Input validation schema. Can be a type assertion (e.g., {type: 'string'}), an object field list (multiline string), or an array field list with types/conditions.",
+          "oneOf": [
+            {
+              "type": "string",
+              "description": "Multiline field list describing expected object/array shape"
+            },
+            {
+              "type": "object",
+              "description": "Type assertion or structured schema",
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "description": "Expected type (e.g., 'string', 'number', 'uuid')"
+                }
+              },
+              "additionalProperties": true
+            }
+          ]
+        },
+        "additionalProperties": {
+          "type": "object",
+          "description": "DEPRECATED: Use 'visible' and 'mapping' directly on props instead. Legacy nested UI/mapping metadata.",
+          "properties": {
+            "visible": {
+              "type": "boolean",
+              "description": "Whether input is visible in UI (deprecated, use props.visible)"
+            },
+            "mapping": {
+              "type": "string",
+              "description": "Maps to entity property path (deprecated, use props.mapping)"
+            }
+          },
+          "additionalProperties": true
+        },
+        "options": {
+          "type": "array",
+          "description": "Available options for 'options' type",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "value": {}
+            },
+            "required": ["name", "value"]
+          }
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "required": ["name"],
+  "additionalProperties": false
+}

package/schemas/workflows/output.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Workflow Output",
+  "description": "Definition of a workflow output",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Output name identifier"
+    },
+    "mapping": {
+      "type": "string",
+      "description": "Path to variable value (e.g., 'activityName.stepName.outputVar')"
+    },
+    "props": {
+      "type": "object",
+      "description": "Output metadata for PublicApi workflows (OpenAPI response schema)",
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "Response type (e.g., 'object', 'array', 'string', 'integer')"
+        },
+        "description": {
+          "type": "string",
+          "description": "Description of the output for OpenAPI documentation"
+        },
+        "schema": {
+          "type": "object",
+          "description": "JSON Schema describing the response structure",
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": true
+    },
+    "additionalProperties": {
+      "type": "object",
+      "description": "Additional output configuration",
+      "properties": {
+        "displayName": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "visible": {
+          "type": "boolean"
+        },
+        "type": {
+          "type": "string",
+          "enum": ["json", "text"]
+        },
+        "multiple": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "required": ["name", "mapping"],
+  "additionalProperties": true
+}

package/schemas/workflows/schedule.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Workflow Schedule",
+  "description": "Definition of a scheduled workflow execution",
+  "type": "object",
+  "properties": {
+    "cron": {
+      "type": "string",
+      "description": "Cron expression for scheduled execution (e.g., '30 0 1-7 * 6')"
+    },
+    "displayName": {
+      "type": "string",
+      "description": "Human-readable description of the schedule"
+    },
+    "enabled": {
+      "type": "boolean",
+      "description": "Whether the schedule is enabled"
+    },
+    "timezone": {
+      "type": "string",
+      "description": "Timezone for the schedule"
+    }
+  },
+  "required": ["cron"],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/accounting-transaction.json

@@ -0,0 +1,95 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Accounting Transaction Tasks",
+  "description": "Accounting transaction operations (invoices, bills, payments)",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "AccountingTransaction/Generate@1",
+        "AccountingTransaction/Update@1",
+        "AccountingTransaction/Delete@1",
+        "AccountingTransaction/ApplyCreditToInvoices@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": "Accounting transaction inputs",
+      "properties": {
+        "accountingTransactionId": {
+          "type": "string",
+          "description": "Transaction ID"
+        },
+        "type": {
+          "type": "string",
+          "enum": ["Invoice", "Bill", "CreditMemo", "Payment"],
+          "description": "Transaction type"
+        },
+        "orderId": {
+          "type": "string",
+          "description": "Associated order ID"
+        },
+        "jobId": {
+          "type": "string",
+          "description": "Associated job ID"
+        },
+        "customerId": {
+          "type": "string",
+          "description": "Customer contact ID"
+        },
+        "appendToExistingInvoice": {
+          "type": "boolean",
+          "description": "Append charges to existing unpaid invoice"
+        },
+        "entity": {
+          "type": "object",
+          "description": "Transaction entity data",
+          "additionalProperties": true
+        }
+      },
+      "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/tasks/action-event.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Action Event Tasks",
+  "description": "Action event operations (triggers UI notifications or webhooks)",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "ActionEvent/Create"
+      ],
+      "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": "Action event inputs",
+      "properties": {
+        "eventName": {
+          "type": "string",
+          "description": "Event name identifier"
+        },
+        "data": {
+          "type": "object",
+          "description": "Event data payload",
+          "additionalProperties": true
+        }
+      },
+      "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/tasks/all.json

@@ -0,0 +1,152 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "All Workflow Tasks",
+  "description": "Aggregator schema for all workflow task types. Uses anyOf to allow matching any known task type or falling back to generic task structure.",
+  "type": "object",
+  "anyOf": [
+    {
+      "$ref": "accounting-transaction.json"
+    },
+    {
+      "$ref": "action-event.json"
+    },
+    {
+      "$ref": "appmodule.json"
+    },
+    {
+      "$ref": "attachment.json"
+    },
+    {
+      "$ref": "authentication.json"
+    },
+    {
+      "$ref": "caching.json"
+    },
+    {
+      "$ref": "charge.json"
+    },
+    {
+      "$ref": "commodity.json"
+    },
+    {
+      "$ref": "contact-address.json"
+    },
+    {
+      "$ref": "contact-payment-method.json"
+    },
+    {
+      "$ref": "contact.json"
+    },
+    {
+      "$ref": "csv.json"
+    },
+    {
+      "$ref": "document-render.json"
+    },
+    {
+      "$ref": "document-send.json"
+    },
+    {
+      "$ref": "edi.json"
+    },
+    {
+      "$ref": "email-send.json"
+    },
+    {
+      "$ref": "error.json"
+    },
+    {
+      "$ref": "export.json"
+    },
+    {
+      "$ref": "filetransfer.json"
+    },
+    {
+      "$ref": "flow-transition.json"
+    },
+    {
+      "$ref": "foreach.json"
+    },
+    {
+      "$ref": "graphql.json"
+    },
+    {
+      "$ref": "httpRequest.json"
+    },
+    {
+      "$ref": "import.json"
+    },
+    {
+      "$ref": "inventory.json"
+    },
+    {
+      "$ref": "job.json"
+    },
+    {
+      "$ref": "log.json"
+    },
+    {
+      "$ref": "map.json"
+    },
+    {
+      "$ref": "movement.json"
+    },
+    {
+      "$ref": "note.json"
+    },
+    {
+      "$ref": "number.json"
+    },
+    {
+      "$ref": "order-tracking-event.json"
+    },
+    {
+      "$ref": "order.json"
+    },
+    {
+      "$ref": "payment.json"
+    },
+    {
+      "$ref": "pdf-document.json"
+    },
+    {
+      "$ref": "postal-codes.json"
+    },
+    {
+      "$ref": "resolve-timezone.json"
+    },
+    {
+      "$ref": "setVariable.json"
+    },
+    {
+      "$ref": "switch.json"
+    },
+    {
+      "$ref": "template.json"
+    },
+    {
+      "$ref": "tracking-event.json"
+    },
+    {
+      "$ref": "transmission.json"
+    },
+    {
+      "$ref": "unzip-file.json"
+    },
+    {
+      "$ref": "user.json"
+    },
+    {
+      "$ref": "validation.json"
+    },
+    {
+      "$ref": "while.json"
+    },
+    {
+      "$ref": "workflow-execute.json"
+    },
+    {
+      "$ref": "generic.json"
+    }
+  ]
+}