@cxtms/cx-schema 1.1.1 → 1.3.0

package/schemas/workflows/tasks/filetransfer.json

@@ -0,0 +1,102 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "File Transfer Tasks",
+  "description": "SFTP/FTP file transfer operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "FileTransfer/Connect@1",
+        "FileTransfer/Disconnect@1",
+        "FileTransfer/ListFiles@1",
+        "FileTransfer/DownloadFile@1",
+        "FileTransfer/UploadFile@1",
+        "FileTransfer/MoveFile@1",
+        "FileTransfer/DeleteFile@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": "File transfer operation inputs",
+      "properties": {
+        "connection": {
+          "type": "string",
+          "description": "Connection reference from Connect step"
+        },
+        "host": {
+          "type": "string",
+          "description": "Remote host (for Connect)"
+        },
+        "port": {
+          "type": ["string", "integer"],
+          "description": "Remote port (for Connect)"
+        },
+        "username": {
+          "type": "string",
+          "description": "Username (for Connect)"
+        },
+        "password": {
+          "type": "string",
+          "description": "Password (for Connect)"
+        },
+        "protocol": {
+          "type": "string",
+          "description": "Protocol: sftp, ftp, ftps"
+        },
+        "path": {
+          "type": "string",
+          "description": "Remote file/directory path"
+        },
+        "sourcePath": {
+          "type": "string",
+          "description": "Source path (for MoveFile)"
+        },
+        "destinationPath": {
+          "type": "string",
+          "description": "Destination path (for MoveFile)"
+        },
+        "content": {
+          "type": "string",
+          "description": "File content (for UploadFile)"
+        }
+      },
+      "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/flow-transition.json

@@ -0,0 +1,68 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Flow Transition Task",
+  "description": "Trigger a Flow state transition programmatically",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "Flow/Transition@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": "Flow transition inputs",
+      "properties": {
+        "entityName": {
+          "type": "string",
+          "description": "Entity type name"
+        },
+        "entityId": {
+          "type": "string",
+          "description": "Entity ID"
+        },
+        "transition": {
+          "type": "string",
+          "description": "Transition name to trigger"
+        }
+      },
+      "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/httpRequest.json

@@ -82,6 +82,29 @@
           },
           "description": "Retry configuration"
         },
+        "responseContentType": {
+          "type": "string",
+          "description": "Expected response content type (e.g., application/pdf, application/json)"
+        },
+        "actionEvents": {
+          "type": "object",
+          "description": "Enable action events when the request operates on a specific entity",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "description": "Enable action event tracking"
+            },
+            "eventName": {
+              "type": "string",
+              "description": "Event name identifier (e.g., carrier.sendParcelInfo)"
+            },
+            "eventDataExt": {
+              "type": "object",
+              "description": "Extended event data linking to entity (e.g., orderId)",
+              "additionalProperties": true
+            }
+          }
+        },
         "cache": {
           "type": "object",
           "properties": {

package/schemas/workflows/tasks/import.json

@@ -0,0 +1,64 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Import Tasks",
+  "description": "Data import operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "Utilities/Import@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": "Import operation inputs",
+      "properties": {
+        "content": {
+          "type": "string",
+          "description": "File content to import"
+        },
+        "format": {
+          "type": "string",
+          "description": "Import format (e.g., csv)"
+        }
+      },
+      "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/inventory.json

@@ -0,0 +1,67 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Inventory Tasks",
+  "description": "Inventory item CRUD operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "InventoryItem/Create",
+        "InventoryItem/Update",
+        "InventoryItem/Delete"
+      ],
+      "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": "Inventory item operation inputs",
+      "properties": {
+        "inventoryItemId": {
+          "type": "string",
+          "description": "Inventory item ID"
+        },
+        "entity": {
+          "type": "object",
+          "description": "Inventory item 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/movement.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Movement Tasks",
+  "description": "Cargo movement operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "Movement/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": "Movement operation inputs",
+      "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/note.json

@@ -0,0 +1,59 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Note Tasks",
+  "description": "Note and note thread operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "Note/Create",
+        "Note/Update",
+        "Note/Delete",
+        "NoteThread/Rename",
+        "Notes/Import",
+        "Notes/Export"
+      ],
+      "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": "Note operation inputs",
+      "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/number.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Number Generation Tasks",
+  "description": "Sequential number generation operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "Number/Generate@1",
+        "SequenceNumber/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": "Number generation inputs",
+      "properties": {
+        "format": {
+          "type": "string",
+          "description": "Number format string (e.g., INV-{0:D6})"
+        },
+        "sequenceName": {
+          "type": "string",
+          "description": "Sequence name identifier"
+        }
+      },
+      "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/order.json

@@ -11,7 +11,14 @@
         "Order/Update@1",
         "Order/Update@2",
         "Order/Delete@1",
-        "Order/Get@1"
+        "Order/Get@1",
+        "Order/Copy@1",
+        "Order/Split@1",
+        "Order/Import@1",
+        "Order/RecalculateCharges@1",
+        "Order/GenerateTrackingNumber@1",
+        "Order/Purge@1",
+        "Order/GetCargoMovementByPalletQuery"
       ],
       "description": "Task type identifier"
     },

package/schemas/workflows/tasks/pdf-document.json

@@ -0,0 +1,60 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "PDF Document Tasks",
+  "description": "PDF document operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "PdfDocument/Merge@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": "PDF document operation inputs",
+      "properties": {
+        "documents": {
+          "type": "array",
+          "description": "Array of PDF documents to merge"
+        }
+      },
+      "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/user.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "User Tasks",
+  "description": "User account management operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "User/Create",
+        "User/Update",
+        "User/Delete",
+        "User/GetVerificationCode",
+        "User/GetEmailVerificationCode",
+        "User/GetResetPasswordToken"
+      ],
+      "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": "User operation inputs",
+      "properties": {
+        "userId": {
+          "type": "string",
+          "description": "User ID"
+        },
+        "entity": {
+          "type": "object",
+          "description": "User 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/scripts/postinstall.js

@@ -17,7 +17,7 @@ function findProjectRoot() {
       // Check if this is not the cx-schema-validator package itself
       try {
         const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
-        if (packageJson.name !== 'cx-schema-validator') {
+        if (packageJson.name !== '@cxtms/cx-schema') {
           return currentDir;
         }
       } catch (error) {
@@ -59,7 +59,7 @@ function createValidationScript(projectRoot) {
  * This script uses the schemas in .cx-schema to validate modules
  */
 
-const { ModuleValidator } = require('cx-schema-validator');
+const { ModuleValidator } = require('@cxtms/cx-schema');
 const path = require('path');
 
 async function main() {
@@ -185,6 +185,6 @@ function main() {
 }
 
 // Only run if this is not being installed as a dependency of cx-schema-validator itself
-if (!process.env.npm_package_name || process.env.npm_package_name !== 'cx-schema-validator') {
+if (!process.env.npm_package_name || process.env.npm_package_name !== '@cxtms/cx-schema') {
   main();
 }