@cxtms/cx-schema 1.7.17 → 1.8.1

package/schemas/workflows/tasks/authentication.json

@@ -34,39 +34,25 @@
     },
     "inputs": {
       "type": "object",
-      "description": "OAuth2 authentication inputs",
+      "description": "Authentication operation inputs",
       "properties": {
-        "credentials": {
-          "type": "object",
-          "description": "OAuth2 credentials object (e.g., grant_type, client_id, client_secret)",
-          "additionalProperties": true
-        },
-        "tokenUrl": {
+        "provider": {
           "type": "string",
-          "description": "Token endpoint URL"
+          "description": "OAuth2 provider name"
         },
-        "headers": {
-          "type": "array",
-          "description": "Optional HTTP headers for the token request",
-          "items": {
-            "type": "object",
-            "additionalProperties": {
-              "type": "string"
-            }
-          }
+        "clientId": {
+          "type": "string",
+          "description": "OAuth2 client ID"
         },
-        "retryOptions": {
-          "type": "object",
-          "description": "Optional retry configuration for the HTTP request",
-          "additionalProperties": true
+        "clientSecret": {
+          "type": "string",
+          "description": "OAuth2 client secret"
         },
-        "cache": {
-          "type": "boolean",
-          "description": "Enable token caching (default: true). Set to false to always fetch a new token.",
-          "default": true
+        "tokenUrl": {
+          "type": "string",
+          "description": "Token endpoint URL"
         }
       },
-      "required": ["credentials", "tokenUrl"],
       "additionalProperties": true
     },
     "outputs": {

package/schemas/workflows/tasks/edi.json

@@ -8,6 +8,8 @@
       "type": "string",
       "enum": [
         "EDI/Parse@1",
+        "EDIFACT/Parse@1",
+        "EDIFACT/Generate@1",
         "StructuredFile/Parse"
       ],
       "description": "Task type identifier"
@@ -39,11 +41,101 @@
       "properties": {
         "content": {
           "type": "string",
-          "description": "File content to parse"
+          "description": "File content to parse (EDI/Parse)"
         },
         "format": {
           "type": "string",
           "description": "EDI format (e.g., X12, EDIFACT)"
+        },
+        "edifactData": {
+          "type": "string",
+          "description": "Raw EDIFACT data string (EDIFACT/Parse, EDIFACT/Generate)"
+        },
+        "messageType": {
+          "type": "string",
+          "enum": ["IFTMIN", "CONTRL", "APERAK"],
+          "description": "EDIFACT message type for parse/generate tasks"
+        },
+        "sender": {
+          "type": "object",
+          "description": "Sender identification for EDIFACT/Generate",
+          "properties": {
+            "id": { "type": "string", "description": "Sender ID (Trading Partner ID)" },
+            "qualifier": { "type": "string", "description": "Partner ID code qualifier (e.g., ZZZ)" }
+          }
+        },
+        "recipient": {
+          "type": "object",
+          "description": "Recipient identification for EDIFACT/Generate",
+          "properties": {
+            "id": { "type": "string", "description": "Recipient ID (e.g., INTTRA)" },
+            "qualifier": { "type": "string", "description": "Partner ID code qualifier" }
+          }
+        },
+        "documentNumber": {
+          "type": "string",
+          "description": "Shipment Identification Number"
+        },
+        "messageFunctionCode": {
+          "type": "string",
+          "enum": ["5", "9"],
+          "description": "9 = Original, 5 = Replace"
+        },
+        "references": {
+          "type": "array",
+          "description": "Business references (BN=Booking, BM=B/L, etc.)",
+          "items": {
+            "type": "object",
+            "properties": {
+              "qualifier": { "type": "string" },
+              "identifier": { "type": "string" }
+            }
+          }
+        },
+        "parties": {
+          "type": "array",
+          "description": "Party details (HI=Requestor, CZ=Shipper, CA=Carrier, CN=Consignee)",
+          "items": {
+            "type": "object",
+            "properties": {
+              "functionCode": { "type": "string" },
+              "identification": { "type": "string" },
+              "name": { "type": "string" }
+            }
+          }
+        },
+        "goodsItems": {
+          "type": "array",
+          "description": "Goods item details (GID segment group). Numeric fields (itemNumber, numberOfPackages) are serialized as strings.",
+          "items": {
+            "type": "object",
+            "properties": {
+              "itemNumber": { "type": ["integer", "string"], "description": "Goods item number (GID/0). Auto-incremented." },
+              "numberOfPackages": { "type": ["integer", "string"], "description": "Number of outer packages (C213/7224)" },
+              "packageType": { "type": "string", "description": "Package type code, UN/ECE rec. 21 (C213/7065, e.g. CT, PK, PL)" },
+              "packageTypeDescription": { "type": "string", "description": "Package type description (C213/7065 text)" },
+              "packageTypeAgencyCode": { "type": "string", "description": "Code list responsible agency (C213/3055). Auto-set to '6' (UN/ECE) when packageType is provided." },
+              "packageTypeDescriptionText": { "type": "string", "description": "Package type description text for B/L printing (C213/7064)" },
+              "innerPackageCount": { "type": ["integer", "string"], "description": "Number of inner packages (second C213/7224)" },
+              "innerPackageType": { "type": "string", "description": "Inner package type code (second C213/7065)" },
+              "grossWeight": { "type": ["number", "string"], "description": "Gross weight value" },
+              "weightUnit": { "type": "string", "description": "Weight unit (KGM, LBR)" },
+              "description": { "type": "string", "description": "Goods description free text" }
+            }
+          }
+        },
+        "equipment": {
+          "type": "array",
+          "description": "Container/equipment details",
+          "items": {
+            "type": "object",
+            "properties": {
+              "equipmentQualifier": { "type": "string" },
+              "equipmentIdentification": { "type": "string" },
+              "sizeTypeCode": { "type": "string" },
+              "fullEmptyIndicator": { "type": "string" }
+            }
+          }
         }
       },
       "additionalProperties": true

package/schemas/workflows/tasks/httpRequest.json

@@ -105,6 +105,10 @@
             }
           }
         },
+        "saveToFile": {
+          "type": "boolean",
+          "description": "When true, saves response body to a temp file instead of returning it in memory. Response returns { StatusCode, Headers, FilePath } instead of body content."
+        },
         "cache": {
           "type": "object",
           "properties": {

package/schemas/workflows/tasks/order.json

@@ -69,6 +69,51 @@
         "validateOnly": {
           "type": "boolean",
           "description": "Only validate, don't persist"
+        },
+        "data": {
+          "description": "Structured import data (for Order/Import@1)",
+          "additionalProperties": true
+        },
+        "options": {
+          "type": "object",
+          "description": "Import options (for Order/Import@1)",
+          "properties": {
+            "orderMatchByFields": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Fields to match existing orders. If null, creates new orders."
+            },
+            "contactMatchByFields": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Fields to match existing contacts for order entities."
+            },
+            "contactAddressMatchByFields": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Fields to match existing contact addresses within order entities."
+            },
+            "inventoryItemMatchByFields": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Fields to match existing inventory items on commodities."
+            },
+            "tagMatchByFields": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Fields to match existing tags."
+            },
+            "commodityMatchByFields": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Fields to match existing commodities."
+            },
+            "linkTrackingEventsToCommodities": {
+              "type": "boolean",
+              "description": "When true, imported tracking events are linked to the order's first-level (non-container) commodities. Default: false."
+            }
+          },
+          "additionalProperties": true
         }
       },
       "additionalProperties": true

package/schemas/workflows/tasks/resolve-timezone.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "ResolveTimezone Task",
+  "description": "Resolve IANA timezone ID and UTC offset from geographic coordinates",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["Utilities/ResolveTimezone@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": "ResolveTimezone inputs",
+      "properties": {
+        "latitude": {
+          "type": ["string", "number"],
+          "description": "Latitude coordinate (decimal degrees)"
+        },
+        "longitude": {
+          "type": ["string", "number"],
+          "description": "Longitude coordinate (decimal degrees)"
+        }
+      },
+      "required": ["latitude", "longitude"],
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": { "type": "string" },
+          "mapping": { "type": "string" }
+        },
+        "required": ["name", "mapping"]
+      },
+      "description": "Outputs: timezoneId (IANA timezone string, e.g. 'America/Chicago'), utcOffset (number, hours from UTC, e.g. -5)"
+    }
+  },
+  "required": ["task", "name", "inputs"]
+}

package/schemas/workflows/tasks/transmission.json

@@ -0,0 +1,185 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Transmission Tasks",
+  "description": "Create, update, and delete transmission records linked to orders",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "Transmission/Create@1",
+        "Transmission/Update@1",
+        "Transmission/Delete@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": "Task inputs — shape depends on task type",
+      "properties": {
+        "organizationId": {
+          "type": ["string", "integer"],
+          "description": "Organization ID (required for all task types)"
+        },
+        "transmissionId": {
+          "type": ["string", "integer"],
+          "description": "Transmission ID (required for Update and Delete)"
+        },
+        "transmission": {
+          "type": "object",
+          "description": "Transmission field values (Create: full object; Update: partial/dynamic)",
+          "properties": {
+            "orderIds": {
+              "type": ["array", "string"],
+              "items": { "type": ["integer", "string"] },
+              "description": "Order IDs to link (required for Create, at least one)"
+            },
+            "channel": {
+              "type": "string",
+              "maxLength": 20,
+              "description": "Communication channel (e.g. EDI, API, EMAIL, WEBHOOK)"
+            },
+            "direction": {
+              "type": ["string", "integer"],
+              "enum": ["Inbound", "Outbound", 0, 1],
+              "description": "Inbound (0) or Outbound (1)"
+            },
+            "messageType": {
+              "type": "string",
+              "maxLength": 50,
+              "description": "Message type identifier (e.g. 204, 990, 214)"
+            },
+            "sender": {
+              "type": "string",
+              "maxLength": 100,
+              "description": "Sender identifier"
+            },
+            "receiver": {
+              "type": "string",
+              "maxLength": 100,
+              "description": "Receiver identifier"
+            },
+            "correlationId": {
+              "type": "string",
+              "format": "uuid",
+              "description": "Correlation ID (auto-generated if omitted on Create)"
+            },
+            "parentId": {
+              "type": ["integer", "string", "null"],
+              "description": "Parent transmission ID for chaining"
+            },
+            "status": {
+              "type": ["string", "integer"],
+              "enum": ["Pending", "InProgress", "Sent", "Received", "Delivered", "Acknowledged", "Rejected", "Error", "RetryScheduled", "Cancelled", "Expired", "Accepted", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11],
+              "description": "Transmission status"
+            },
+            "endpoint": {
+              "type": "string",
+              "maxLength": 500,
+              "description": "Target endpoint URL"
+            },
+            "protocol": {
+              "type": "string",
+              "maxLength": 20,
+              "description": "Protocol (e.g. HTTPS, SFTP, AS2)"
+            },
+            "httpStatus": {
+              "type": ["integer", "string", "null"],
+              "description": "HTTP response status code"
+            },
+            "byteSize": {
+              "type": ["integer", "string", "null"],
+              "description": "Payload size in bytes"
+            },
+            "retryCount": {
+              "type": ["integer", "string"],
+              "description": "Current retry count (default: 0)"
+            },
+            "maxRetries": {
+              "type": ["integer", "string"],
+              "description": "Maximum retry attempts (default: 3)"
+            },
+            "nextRetryAt": {
+              "type": ["string", "null"],
+              "description": "Scheduled next retry time (ISO 8601)"
+            },
+            "errorCode": {
+              "type": ["string", "null"],
+              "maxLength": 50,
+              "description": "Error code"
+            },
+            "errorMessage": {
+              "type": ["string", "null"],
+              "description": "Error description"
+            },
+            "customValues": {
+              "type": ["object", "string", "null"],
+              "description": "Arbitrary key-value metadata (JSONB)"
+            },
+            "headers": {
+              "type": ["object", "string", "null"],
+              "description": "Message headers (JSONB)"
+            },
+            "payloadRef": {
+              "type": ["string", "null"],
+              "description": "Reference to stored payload (e.g. blob URI)"
+            },
+            "scheduledAt": {
+              "type": ["string", "null"],
+              "description": "Scheduled send time (ISO 8601)"
+            },
+            "startedAt": {
+              "type": ["string", "null"],
+              "description": "Processing start time (ISO 8601)"
+            },
+            "completedAt": {
+              "type": ["string", "null"],
+              "description": "Processing end time (ISO 8601)"
+            },
+            "durationMs": {
+              "type": ["integer", "string", "null"],
+              "description": "Processing duration in milliseconds"
+            }
+          }
+        }
+      },
+      "required": ["organizationId"]
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": { "type": "string" },
+          "mapping": { "type": "string" }
+        },
+        "required": ["name", "mapping"]
+      },
+      "description": "Create outputs: transmission (TransmissionDto). Delete outputs: success (boolean)."
+    }
+  },
+  "required": ["task", "name", "inputs"]
+}

package/schemas/workflows/tasks/unzip-file.json

@@ -0,0 +1,68 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "UnzipFile Task",
+  "description": "Extract files from a ZIP archive (local path or URL)",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["Utilities/UnzipFile@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": "UnzipFile inputs — provide either filePath or fileUrl",
+      "properties": {
+        "filePath": {
+          "type": "string",
+          "description": "Local file path to ZIP archive (from saveToFile or previous step)"
+        },
+        "fileUrl": {
+          "type": "string",
+          "description": "URL to ZIP archive (file://, http://, https://)"
+        },
+        "filePattern": {
+          "type": "string",
+          "description": "Glob-style pattern to filter extracted files (e.g. '*.csv', 'data_*.json'). If omitted, all files returned."
+        }
+      },
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": { "type": "string" },
+          "mapping": { "type": "string" }
+        },
+        "required": ["name", "mapping"]
+      },
+      "description": "Outputs: Files (string[] — full paths to extracted files), Count (int — number of matched files)"
+    }
+  },
+  "required": ["task", "name", "inputs"]
+}

package/schemas/workflows/variable.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Workflow Variable",
-  "description": "Definition of a workflow variable. Valid properties: name, value, fromConfig.",
+  "description": "Definition of a workflow variable. Valid properties: name, value, fromConfig, expression.",
   "type": "object",
   "properties": {
     "name": {
@@ -12,6 +12,10 @@
     "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": [
         {

package/schemas/workflows/workflow.json

@@ -102,6 +102,10 @@
           "type": "string",
           "description": "AI agent instruction describing how to use this workflow, expected inputs, and returned outputs"
         },
+        "fileName": {
+          "type": "string",
+          "description": "Path to the workflow YAML file (deprecated, use filePath)"
+        },
         "actionEvent": {
           "type": "object",
           "description": "Workflow action event configuration",

package/scripts/postinstall.js

@@ -182,7 +182,7 @@ function main() {
 
   console.log('✓ CX Schema Validator installed successfully!');
   console.log('\nUsage:');
-  console.log('  npx cxtms modules/your-module.yaml');
+  console.log('  npx cx-cli modules/your-module.yaml');
   console.log('  node .cx-schema/validate.js modules/your-module.yaml');
   console.log('  /cx-module <description>   (Claude Code skill - UI modules)');
   console.log('  /cx-workflow <description>  (Claude Code skill - workflows)');