@cxtms/cx-schema 1.0.0

package/schemas/workflows/common/condition.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Workflow Condition",
+  "description": "Condition evaluation patterns for workflow execution control",
+  "definitions": {
+    "condition": {
+      "type": "object",
+      "properties": {
+        "expression": {
+          "type": "string",
+          "description": "NCalc expression that evaluates to boolean"
+        }
+      },
+      "required": ["expression"],
+      "additionalProperties": false
+    },
+    "conditionArray": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/condition"
+      },
+      "description": "Array of conditions (all must be true)"
+    },
+    "simpleCondition": {
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "Simple condition expression string"
+        },
+        {
+          "$ref": "#/definitions/condition"
+        }
+      ]
+    }
+  },
+  "x-examples": {
+    "singleCondition": {
+      "expression": "[status] = 'Active'"
+    },
+    "multipleConditions": [
+      { "expression": "[isValid] = true" },
+      { "expression": "[amount] > 0" }
+    ],
+    "complexExpression": {
+      "expression": "([status] = 'Completed' || [status] = 'Failed') && [notifyUser] = true"
+    }
+  }
+}

package/schemas/workflows/common/expression.json

@@ -0,0 +1,76 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "NCalc Expression",
+  "description": "NCalc expression patterns for workflow conditions and calculations",
+  "definitions": {
+    "expression": {
+      "type": "string",
+      "description": "NCalc expression string",
+      "x-examples": [
+        "[orderTotal] > 1000",
+        "[status] = 'Approved'",
+        "isNullOrEmpty([value?]) = false",
+        "[status] = 'Completed' || [status] = 'Failed'",
+        "format('{0:F2}', [weight])",
+        "convertWeight([value], [fromUnit], [toUnit])",
+        "formatDate([date], 'MM.dd.yyyy hh:mm', 'en-US')",
+        "sum([collection], [each.property])",
+        "distinct([collection])",
+        "length([array])",
+        "All([items], [item.isValid])",
+        "Any([items], [item.status] = 'Complete')",
+        "contains([text], 'search')",
+        "base64(format('{0}:{1}', [user], [password]))",
+        "replace([value], 'pattern', 'replacement')",
+        "lower([value])",
+        "upper([value])",
+        "trim(first(split([string], '(')))",
+        "join([array], [item.name], ', ')"
+      ]
+    },
+    "templateExpression": {
+      "type": "string",
+      "description": "Template expression with variable substitution",
+      "x-examples": [
+        "{{ orderId }}",
+        "{{ customer.name }}",
+        "{{ order?.customValues?.isConsolidated? }}",
+        "Order-{{ orderNumber }}-{{ Date.Now.ToString('yyyyMMdd') }}"
+      ]
+    },
+    "safeNavigation": {
+      "type": "string",
+      "description": "Path with optional chaining using ?",
+      "x-examples": [
+        "order?.customer?.email?",
+        "items?[0]?.name?",
+        "activity?.step?.output?"
+      ]
+    },
+    "variableConverters": {
+      "type": "string",
+      "description": "Variable type converters",
+      "enum": [
+        "string",
+        "int",
+        "decimal",
+        "bool",
+        "datetime",
+        "luceneString",
+        "emptyIfNull",
+        "nullIfEmpty",
+        "transliterate",
+        "parseJson",
+        "toJson"
+      ],
+      "x-examples": [
+        "[int orderId]",
+        "[decimal amount]",
+        "[string value]",
+        "[bool isActive]",
+        "[datetime createdDate]",
+        "[luceneString searchTerm]"
+      ]
+    }
+  }
+}

package/schemas/workflows/common/mapping.json

@@ -0,0 +1,134 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Workflow Mapping",
+  "description": "Input/output mapping patterns for workflow data flow",
+  "definitions": {
+    "outputMapping": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Output variable name"
+        },
+        "mapping": {
+          "type": "string",
+          "description": "Path to extract value from result"
+        }
+      },
+      "required": ["name", "mapping"],
+      "additionalProperties": false
+    },
+    "variableMapping": {
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "Simple template expression"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "expression": {
+              "type": "string",
+              "description": "NCalc expression"
+            }
+          },
+          "additionalProperties": true
+        },
+        {
+          "type": "object",
+          "properties": {
+            "switch": {
+              "type": "object",
+              "properties": {
+                "expression": {
+                  "type": "string"
+                }
+              }
+            },
+            "cases": {
+              "type": "object",
+              "additionalProperties": true
+            },
+            "default": {}
+          }
+        },
+        {
+          "type": "object",
+          "properties": {
+            "extends": {
+              "type": "string",
+              "description": "Extend an existing object"
+            },
+            "defaultIfNull": {},
+            "mapping": {}
+          }
+        },
+        {
+          "type": "object",
+          "properties": {
+            "foreach": {
+              "type": "string",
+              "description": "Collection to iterate"
+            },
+            "mapping": {
+              "type": "object",
+              "additionalProperties": true
+            }
+          }
+        },
+        {
+          "type": "object",
+          "properties": {
+            "coalesce": {
+              "type": "array",
+              "items": {},
+              "description": "Return first non-null value"
+            }
+          }
+        }
+      ]
+    },
+    "pathExpression": {
+      "type": "string",
+      "description": "Dot-notation path to access nested values",
+      "x-examples": [
+        "activityName.stepName.outputVariable",
+        "orders.items?[0]?.jobs[0]?.jobId",
+        "order?.customValues?.isConsolidated?",
+        "orders?[orderType=\"ParcelShipment\"]?[0]?",
+        "carriers[contactId=(carrierId)]",
+        "charges[applyToContactId=(carrierId)]",
+        "commodities[**]",
+        "commodities[**][-1]"
+      ]
+    }
+  },
+  "x-examples": {
+    "simpleMapping": {
+      "name": "orderId",
+      "mapping": "getOrder.order.orderId"
+    },
+    "safeNavMapping": {
+      "name": "customValue",
+      "mapping": "order?.customValues?.value?"
+    },
+    "templateMapping": "Order_{{ order.orderNumber }}.pdf",
+    "switchMapping": {
+      "switch": {
+        "expression": "[orderType]"
+      },
+      "cases": {
+        "Air": "air-template",
+        "Ocean": "ocean-template"
+      },
+      "default": "default-template"
+    },
+    "foreachMapping": {
+      "foreach": "items?",
+      "mapping": {
+        "id": "{{ item.id }}",
+        "name": "{{ item.name }}"
+      }
+    }
+  }
+}

package/schemas/workflows/input.json

@@ -0,0 +1,76 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Workflow Input Parameter",
+  "description": "Definition of a workflow input parameter",
+  "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"
+        },
+        "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"
+        },
+        "options": {
+          "type": "array",
+          "description": "Available options for 'options' type",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "value": {}
+            },
+            "required": ["name", "value"]
+          }
+        },
+        "additionalProperties": {
+          "type": "object",
+          "description": "Additional input properties",
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "required": ["name"],
+  "additionalProperties": true
+}

package/schemas/workflows/output.json

@@ -0,0 +1,41 @@
+{
+  "$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')"
+    },
+    "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/all.json

@@ -0,0 +1,34 @@
+{
+  "$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": "foreach.json" },
+    { "$ref": "switch.json" },
+    { "$ref": "while.json" },
+    { "$ref": "validation.json" },
+    { "$ref": "map.json" },
+    { "$ref": "setVariable.json" },
+    { "$ref": "httpRequest.json" },
+    { "$ref": "log.json" },
+    { "$ref": "error.json" },
+    { "$ref": "csv.json" },
+    { "$ref": "export.json" },
+    { "$ref": "template.json" },
+    { "$ref": "graphql.json" },
+    { "$ref": "order.json" },
+    { "$ref": "contact.json" },
+    { "$ref": "commodity.json" },
+    { "$ref": "job.json" },
+    { "$ref": "attachment.json" },
+    { "$ref": "email-send.json" },
+    { "$ref": "document-render.json" },
+    { "$ref": "document-send.json" },
+    { "$ref": "charge.json" },
+    { "$ref": "accounting-transaction.json" },
+    { "$ref": "payment.json" },
+    { "$ref": "workflow-execute.json" },
+    { "$ref": "generic.json" }
+  ]
+}

package/schemas/workflows/tasks/attachment.json

@@ -0,0 +1,94 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Attachment Tasks",
+  "description": "Attachment entity CRUD operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "Attachment/Create@1",
+        "Attachment/Update@1",
+        "Attachment/Delete@1",
+        "Attachment/Get@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": "Attachment operation inputs",
+      "properties": {
+        "attachmentId": {
+          "type": "string",
+          "description": "Attachment ID"
+        },
+        "entityName": {
+          "type": "string",
+          "description": "Parent entity name"
+        },
+        "entityId": {
+          "type": "string",
+          "description": "Parent entity ID"
+        },
+        "fileName": {
+          "type": "string",
+          "description": "Attachment file name"
+        },
+        "content": {
+          "type": "string",
+          "description": "File content (base64)"
+        },
+        "contentType": {
+          "type": "string",
+          "description": "MIME content type"
+        },
+        "entity": {
+          "type": "object",
+          "description": "Attachment 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
+}