@cxtms/cx-schema 1.0.0

package/schemas/workflows/tasks/order.json

@@ -0,0 +1,87 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Order Tasks",
+  "description": "Order entity CRUD operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "Order/Create@1",
+        "Order/Update@1",
+        "Order/Update@2",
+        "Order/Delete@1",
+        "Order/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": "Order operation inputs",
+      "properties": {
+        "orderId": {
+          "type": "string",
+          "description": "Order ID (for update/delete/get operations)"
+        },
+        "orderType": {
+          "type": "string",
+          "description": "Order type (for create operations)"
+        },
+        "entity": {
+          "type": "object",
+          "description": "Order entity data",
+          "additionalProperties": true
+        },
+        "partial": {
+          "type": "boolean",
+          "description": "Partial update (patch)"
+        },
+        "validateOnly": {
+          "type": "boolean",
+          "description": "Only validate, don't persist"
+        }
+      },
+      "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/payment.json

@@ -0,0 +1,85 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Payment Tasks",
+  "description": "Payment processing operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["Payment/Create", "Payment/Create@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": "Payment inputs",
+      "properties": {
+        "paymentId": {
+          "type": "string",
+          "description": "Payment ID"
+        },
+        "amount": {
+          "type": "number",
+          "description": "Payment amount"
+        },
+        "customerId": {
+          "type": "string",
+          "description": "Customer contact ID"
+        },
+        "invoiceId": {
+          "type": "string",
+          "description": "Invoice to apply payment to"
+        },
+        "paymentMethod": {
+          "type": "string",
+          "description": "Payment method"
+        },
+        "entity": {
+          "type": "object",
+          "description": "Payment 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/setVariable.json

@@ -0,0 +1,76 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "SetVariable Task",
+  "description": "Set or update workflow variables",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["Utilities/SetVariable", "Utilities/SetVariable@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": "SetVariable inputs",
+      "properties": {
+        "variables": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Variable name to set"
+              },
+              "value": {
+                "description": "Value to assign (can be expression, template, or complex object)"
+              }
+            },
+            "required": ["name", "value"]
+          }
+        }
+      },
+      "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/switch.json

@@ -0,0 +1,75 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Switch Task",
+  "description": "Conditional branching with multiple cases",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "const": "switch",
+      "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"]
+      },
+      "description": "Conditions for execution"
+    },
+    "continueOnError": {
+      "type": "boolean",
+      "description": "Continue on error"
+    },
+    "cases": {
+      "type": "array",
+      "description": "Switch cases",
+      "items": {
+        "type": "object",
+        "properties": {
+          "when": {
+            "type": "string",
+            "description": "Condition expression for this case"
+          },
+          "steps": {
+            "type": "array",
+            "items": {
+              "$ref": "generic.json"
+            },
+            "minItems": 1
+          }
+        },
+        "required": ["when", "steps"],
+        "additionalProperties": true
+      },
+      "minItems": 1
+    },
+    "default": {
+      "type": "object",
+      "description": "Default case if no conditions match",
+      "properties": {
+        "steps": {
+          "type": "array",
+          "items": {
+            "$ref": "generic.json"
+          }
+        }
+      }
+    }
+  },
+  "required": ["task", "cases"],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/template.json

@@ -0,0 +1,73 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Template Task",
+  "description": "Render templates using Handlebars",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["Utilities/Template@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": "Template inputs",
+      "properties": {
+        "template": {
+          "type": "string",
+          "description": "Handlebars template string"
+        },
+        "data": {
+          "description": "Data to pass to template"
+        },
+        "helpers": {
+          "type": "object",
+          "description": "Custom Handlebars helpers",
+          "additionalProperties": true
+        }
+      },
+      "required": ["template"],
+      "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/validation.json

@@ -0,0 +1,90 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Validation Task",
+  "description": "Validate data with rules",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["Validation/Validate@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"]
+      },
+      "description": "Conditions for execution"
+    },
+    "continueOnError": {
+      "type": "boolean",
+      "description": "Continue on error"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "Validation inputs",
+      "properties": {
+        "rules": {
+          "type": "array",
+          "description": "Validation rules",
+          "items": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": ["required", "expression"],
+                "description": "Validation rule type"
+              },
+              "expression": {
+                "type": "string",
+                "description": "Expression to validate (for expression type)"
+              },
+              "value": {
+                "type": "string",
+                "description": "Value to validate (for required type)"
+              },
+              "message": {
+                "type": "string",
+                "description": "Error message if validation fails"
+              }
+            },
+            "required": ["type"]
+          }
+        }
+      },
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "mapping": {
+            "type": "string"
+          }
+        },
+        "required": ["name", "mapping"]
+      },
+      "description": "Output mappings"
+    }
+  },
+  "required": ["task"],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/while.json

@@ -0,0 +1,53 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "While Task",
+  "description": "Loop while conditions are true",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "const": "while",
+      "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"]
+      },
+      "description": "Conditions to continue looping"
+    },
+    "continueOnError": {
+      "type": "boolean",
+      "description": "Continue on error"
+    },
+    "maxIterations": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Maximum number of iterations to prevent infinite loops"
+    },
+    "steps": {
+      "type": "array",
+      "description": "Steps to execute each iteration",
+      "items": {
+        "$ref": "generic.json"
+      },
+      "minItems": 1
+    }
+  },
+  "required": ["task", "conditions", "steps"],
+  "additionalProperties": true
+}

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
+}