npm - @cxtms/cx-schema - Versions diffs - 1.0.0 → 1.1.1 - Mend

@cxtms/cx-schema 1.0.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (66) hide show

package/.claude/skills/cx-core/SKILL.md +93 -0
package/.claude/skills/cx-core/ref-entity-accounting.md +173 -0
package/.claude/skills/cx-core/ref-entity-commodity.md +205 -0
package/.claude/skills/cx-core/ref-entity-contact.md +153 -0
package/.claude/skills/cx-core/ref-entity-geography.md +119 -0
package/.claude/skills/cx-core/ref-entity-job.md +77 -0
package/.claude/skills/cx-core/ref-entity-order-sub.md +140 -0
package/.claude/skills/cx-core/ref-entity-order.md +168 -0
package/.claude/skills/cx-core/ref-entity-rate.md +174 -0
package/.claude/skills/cx-core/ref-entity-shared.md +147 -0
package/.claude/skills/cx-core/ref-entity-warehouse.md +110 -0
package/.claude/skills/cx-module/SKILL.md +402 -0
package/.claude/skills/cx-module/ref-components-data.md +286 -0
package/.claude/skills/cx-module/ref-components-display.md +394 -0
package/.claude/skills/cx-module/ref-components-forms.md +362 -0
package/.claude/skills/cx-module/ref-components-interactive.md +306 -0
package/.claude/skills/cx-module/ref-components-layout.md +295 -0
package/.claude/skills/cx-module/ref-components-specialized.md +427 -0
package/.claude/skills/cx-workflow/SKILL.md +330 -0
package/.claude/skills/cx-workflow/ref-accounting.md +66 -0
package/.claude/skills/cx-workflow/ref-communication.md +161 -0
package/.claude/skills/cx-workflow/ref-entity.md +162 -0
package/.claude/skills/cx-workflow/ref-expressions.md +239 -0
package/.claude/skills/cx-workflow/ref-filetransfer.md +80 -0
package/.claude/skills/cx-workflow/ref-flow.md +180 -0
package/.claude/skills/cx-workflow/ref-other.md +120 -0
package/.claude/skills/cx-workflow/ref-query.md +85 -0
package/.claude/skills/cx-workflow/ref-utilities.md +171 -0
package/README.md +34 -34
package/dist/cli.js +545 -35
package/dist/cli.js.map +1 -1
package/dist/types.d.ts +17 -1
package/dist/types.d.ts.map +1 -1
package/dist/workflowValidator.d.ts +31 -0
package/dist/workflowValidator.d.ts.map +1 -1
package/dist/workflowValidator.js +299 -9
package/dist/workflowValidator.js.map +1 -1
package/package.json +4 -3
package/schemas/schema.graphql +2077 -321
package/schemas/workflows/flow/aggregation.json +44 -0
package/schemas/workflows/flow/entity.json +110 -0
package/schemas/workflows/flow/state.json +105 -0
package/schemas/workflows/flow/transition.json +143 -0
package/schemas/workflows/input.json +53 -7
package/schemas/workflows/output.json +20 -0
package/schemas/workflows/trigger.json +4 -0
package/schemas/workflows/variable.json +2 -6
package/schemas/workflows/workflow.json +179 -21
package/scripts/postinstall.js +30 -1
package/templates/module-configuration.yaml +110 -0
package/templates/module-form.yaml +152 -0
package/templates/module-grid.yaml +229 -0
package/templates/module-select.yaml +139 -0
package/templates/module.yaml +3 -3
package/templates/workflow-api-tracking.yaml +189 -0
package/templates/workflow-basic.yaml +76 -0
package/templates/workflow-document.yaml +155 -0
package/templates/workflow-entity-trigger.yaml +90 -0
package/templates/workflow-ftp-edi.yaml +158 -0
package/templates/workflow-ftp-tracking.yaml +161 -0
package/templates/workflow-mcp-tool.yaml +112 -0
package/templates/workflow-public-api.yaml +135 -0
package/templates/workflow-scheduled.yaml +125 -0
package/templates/workflow-utility.yaml +96 -0
package/templates/workflow-webhook.yaml +128 -0
package/templates/workflow.yaml +52 -12

package/templates/workflow-document.yaml ADDED Viewed

@@ -0,0 +1,155 @@
+# {{displayName}} Workflow
+# Generated by cx-cli create workflow --template document
+workflow:
+  workflowId: "{{uuid}}"
+  name: "{{displayName}}"
+  description: "{{displayName}} document generation workflow"
+  version: "1.0"
+  workflowType: "Document"
+  executionMode: Sync
+  logLevel: Information
+  isActive: true
+  enableAudit: true
+  filePath: "{{fileName}}"
+  tags:
+    - "generated"
+    - "document"
+inputs:
+  - name: orderId
+    type: text
+    props:
+      displayName: "Order ID"
+      description: "The ID of the order to generate document for"
+      required: true
+      visible: true
+      mapping: "order.orderId"
+outputs:
+  - name: file
+    mapping: "GenerateDocument.Render.document"
+  - name: fileName
+    mapping: "fileName"
+  - name: fileDisposition
+    mapping: "attachment"
+variables:
+  - name: fileName
+    value: "{{displayNameNoSpaces}}.pdf"
+triggers:
+  - type: Manual
+    name: ManualTrigger
+    displayName: "Generate {{displayName}}"
+activities:
+  - name: FetchData
+    events:
+      onActivityStarted:
+        - task: "Utilities/Log@1"
+          name: LogActivityStarted
+          inputs:
+            message: "Activity FetchData started"
+            level: Information
+      onActivityCompleted:
+        - task: "Utilities/Log@1"
+          name: LogActivityCompleted
+          inputs:
+            message: "Activity FetchData completed"
+            level: Information
+      onActivityFailed:
+        - task: "Utilities/Log@1"
+          name: LogActivityFailed
+          inputs:
+            message: "Activity FetchData failed: {{exception.message}}"
+            level: Error
+    steps:
+      - task: "Query/GraphQL"
+        name: GetOrder
+        inputs:
+          query: |
+            query($organizationId: Int!, $orderId: Int!) {
+              order(organizationId: $organizationId, orderId: $orderId) {
+                orderId
+                orderNumber
+                status
+              }
+            }
+          variables:
+            organizationId: "\{{organizationId}}"
+            orderId: "\{{inputs.orderId}}"
+        outputs:
+          - name: order
+            mapping: "order?"
+  - name: GenerateDocument
+    events:
+      onActivityStarted:
+        - task: "Utilities/Log@1"
+          name: LogActivityStarted
+          inputs:
+            message: "Activity GenerateDocument started"
+            level: Information
+      onActivityCompleted:
+        - task: "Utilities/Log@1"
+          name: LogActivityCompleted
+          inputs:
+            message: "Activity GenerateDocument completed"
+            level: Information
+      onActivityFailed:
+        - task: "Utilities/Log@1"
+          name: LogActivityFailed
+          inputs:
+            message: "Activity GenerateDocument failed: {{exception.message}}"
+            level: Error
+    steps:
+      - task: "Document/Render@1"
+        name: Render
+        inputs:
+          template:
+            engine: "handlebars"
+            recipe: "chrome-pdf"
+            content: |
+              <html>
+              <head>
+                <style>
+                  body { font-family: Arial, sans-serif; margin: 40px; }
+                  h1 { color: #333; }
+                  table { width: 100%; border-collapse: collapse; margin-top: 20px; }
+                  th, td { border: 1px solid #ddd; padding: 8px; text-align: left; }
+                  th { background-color: #f5f5f5; }
+                </style>
+              </head>
+              <body>
+                <h1>{{displayName}}</h1>
+                <p>Order: \{{orderNumber}}</p>
+                <p>Status: \{{status}}</p>
+              </body>
+              </html>
+          data:
+            orderNumber: "\{{FetchData?.GetOrder?.order?.orderNumber?}}"
+            status: "\{{FetchData?.GetOrder?.order?.status?}}"
+        outputs:
+          - name: document
+            mapping: "document?"
+events:
+  onWorkflowStarted:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowStarted
+      inputs:
+        message: "{{displayName}} workflow started"
+        level: Information
+  onWorkflowExecuted:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowExecuted
+      inputs:
+        message: "{{displayName}} workflow completed successfully"
+        level: Information
+  onWorkflowFailed:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowFailed
+      inputs:
+        message: "{{displayName}} workflow failed: {{exception.message}}"
+        level: Error

package/templates/workflow-entity-trigger.yaml ADDED Viewed

@@ -0,0 +1,90 @@
+# {{displayName}} Workflow
+# Generated by cx-cli create workflow --template entity-trigger
+workflow:
+  workflowId: "{{uuid}}"
+  name: "{{displayName}}"
+  description: "{{displayName}} entity trigger workflow"
+  version: "1.0"
+  executionMode: Sync
+  logLevel: Information
+  isActive: true
+  enableAudit: true
+  filePath: "{{fileName}}"
+  tags:
+    - "generated"
+    - "trigger"
+triggers:
+  - type: "Entity"
+    entityName: "Order"
+    eventType: "Modified"
+    conditions:
+      - expression: "any([changes], [each.key] = 'Status') = true"
+    position: "After"
+activities:
+  - name: Data
+    events:
+      onActivityStarted:
+        - task: "Utilities/Log@1"
+          name: LogActivityStarted
+          inputs:
+            message: "Activity Data started"
+            level: Information
+      onActivityCompleted:
+        - task: "Utilities/Log@1"
+          name: LogActivityCompleted
+          inputs:
+            message: "Activity Data completed"
+            level: Information
+      onActivityFailed:
+        - task: "Utilities/Log@1"
+          name: LogActivityFailed
+          inputs:
+            message: "Activity Data failed: {{exception.message}}"
+            level: Error
+    steps:
+      - task: "Query/GraphQL"
+        name: GetOrder
+        inputs:
+          query: |
+            query($organizationId: Int!, $orderId: Int!) {
+              order(organizationId: $organizationId, orderId: $orderId) {
+                orderId
+                orderNumber
+                status
+              }
+            }
+          variables:
+            organizationId: "\{{organizationId}}"
+            orderId: "\{{entity.orderId}}"
+        outputs:
+          - name: order
+            mapping: "order?"
+      - task: "Utilities/Log@1"
+        name: LogChange
+        inputs:
+          message: "{{displayName}}: Order \{{Data?.GetOrder?.order?.orderNumber?}} status changed"
+          level: Information
+events:
+  onWorkflowStarted:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowStarted
+      inputs:
+        message: "{{displayName}} workflow started"
+        level: Information
+  onWorkflowExecuted:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowExecuted
+      inputs:
+        message: "{{displayName}} workflow completed successfully"
+        level: Information
+  onWorkflowFailed:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowFailed
+      inputs:
+        message: "{{displayName}} workflow failed: {{exception.message}}"
+        level: Error

package/templates/workflow-ftp-edi.yaml ADDED Viewed

@@ -0,0 +1,158 @@
+# {{displayName}} Workflow
+# Generated by cx-cli create workflow --template ftp-edi
+workflow:
+  workflowId: "{{uuid}}"
+  name: "{{displayName}}"
+  description: "{{displayName}} - Import orders from FTP via EDI"
+  version: "1.0"
+  executionMode: Async
+  logLevel: Information
+  isActive: true
+  enableAudit: true
+  filePath: "{{fileName}}"
+  runAs: workflowAgent
+  concurrency:
+    waitTime: 0
+  tags:
+    - "generated"
+    - "ftp"
+    - "edi"
+variables:
+  - name: ftpConfig
+    fromConfig:
+      configName: "apps.myApp.ftpConfig"
+schedules:
+  - cron: "0/10 * * * *"
+    displayName: "{{displayName}} - Every 10 minutes"
+activities:
+  - name: FtpImport
+    conditions: "[ftpConfig?.schedulingEnabled?] = true"
+    events:
+      onActivityStarted:
+        - task: "Utilities/Log@1"
+          name: LogActivityStarted
+          inputs:
+            message: "Activity FtpImport started"
+            level: Information
+      onActivityCompleted:
+        - task: "Utilities/Log@1"
+          name: LogActivityCompleted
+          inputs:
+            message: "Activity FtpImport completed"
+            level: Information
+      onActivityFailed:
+        - task: "Utilities/Log@1"
+          name: LogActivityFailed
+          inputs:
+            message: "Activity FtpImport failed: {{exception.message}}"
+            level: Error
+    steps:
+      - task: "FileTransfer/Connect@1"
+        name: SftpConnect
+        inputs:
+          host: "{{ ftpConfig?.host? }}"
+          protocol: "{{ ftpConfig?.protocol? }}"
+          username: "{{ ftpConfig?.username? }}"
+          authentication:
+            type: "password"
+            password: "{{ ftpConfig?.password? }}"
+          options:
+            timeout: 30
+        outputs:
+          - name: connection
+            mapping: "connection?"
+          - name: connectionId
+            mapping: "connectionId?"
+      - task: "FileTransfer/ListFiles@1"
+        name: SftpListFiles
+        inputs:
+          connection: "{{ FtpImport?.SftpConnect?.connection? }}"
+          directory: "inbound"
+          recursive: false
+          includeDirectories: false
+          sortBy: "name"
+          sortOrder: "asc"
+        outputs:
+          - name: files
+            mapping: "files?"
+          - name: fileCount
+            mapping: "fileCount?"
+      - task: "foreach"
+        name: ProcessFiles
+        collection: "FtpImport?.SftpListFiles?.files?"
+        steps:
+          - task: "FileTransfer/DownloadFile@1"
+            name: SftpDownloadFile
+            inputs:
+              connection: "{{ FtpImport?.SftpConnect?.connection? }}"
+              remotePath: "{{ item.path }}"
+            outputs:
+              - name: fileInfo
+                mapping: "fileInfo?"
+              - name: content
+                mapping: "content?"
+          - task: "Workflow/Execute@1"
+            name: ProcessEdi
+            inputs:
+              workflowName: "EDI Parse"
+              workflowInputs:
+                fileContent:
+                  expression: "fromBase64([FtpImport?.SftpDownloadFile?.content?])"
+            outputs:
+              - name: parsedData
+                mapping: "parsedObject?"
+          # TODO: Map parsed EDI data to orders and import
+          - task: "Order/Import@1"
+            name: ImportOrders
+            inputs:
+              orders: "{{ orderData }}"
+              options:
+                orderMatchByFields:
+                  - "orderNumber"
+                commodityMatchByFields:
+                  - "description"
+          - task: "FileTransfer/MoveFile@1"
+            name: SftpMoveFile
+            inputs:
+              connection: "{{ FtpImport?.SftpConnect?.connection? }}"
+              sourcePath: "{{ item.path }}"
+              destinationPath:
+                expression: "format('processed/{0}-{1}', formatDate(now(), 'yyyyMMdd_HHmmss', 'en-US'), [item.name])"
+              options:
+                createDirectories: true
+                overwrite: true
+      - task: "FileTransfer/Disconnect@1"
+        name: SftpDisconnect
+        conditions: "isNullOrEmpty([FtpImport?.SftpConnect?.connection?]) = false"
+        inputs:
+          connection: "{{ FtpImport?.SftpConnect?.connection? }}"
+events:
+  onWorkflowStarted:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowStarted
+      inputs:
+        message: "{{displayName}} workflow started"
+        level: Information
+  onWorkflowExecuted:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowExecuted
+      inputs:
+        message: "{{displayName}} workflow completed successfully"
+        level: Information
+  onWorkflowFailed:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowFailed
+      inputs:
+        message: "{{displayName}} workflow failed: {{exception.message}}"
+        level: Error

package/templates/workflow-ftp-tracking.yaml ADDED Viewed

@@ -0,0 +1,161 @@
+# {{displayName}} Workflow
+# Generated by cx-cli create workflow --template ftp-tracking
+workflow:
+  workflowId: "{{uuid}}"
+  name: "{{displayName}}"
+  description: "{{displayName}} - Import tracking events from FTP"
+  version: "1.0"
+  executionMode: Async
+  logLevel: Information
+  isActive: true
+  enableAudit: true
+  filePath: "{{fileName}}"
+  runAs: workflowAgent
+  concurrency:
+    waitTime: 0
+  tags:
+    - "generated"
+    - "ftp"
+    - "tracking"
+variables:
+  - name: ftpConfig
+    fromConfig:
+      configName: "apps.myApp.ftpConfig"
+schedules:
+  - cron: "*/30 * * * *"
+    displayName: "{{displayName}} - Every 30 minutes"
+activities:
+  - name: FtpImport
+    conditions: "[ftpConfig?.schedulingEnabled?] = true"
+    events:
+      onActivityStarted:
+        - task: "Utilities/Log@1"
+          name: LogActivityStarted
+          inputs:
+            message: "Activity FtpImport started"
+            level: Information
+      onActivityCompleted:
+        - task: "Utilities/Log@1"
+          name: LogActivityCompleted
+          inputs:
+            message: "Activity FtpImport completed"
+            level: Information
+      onActivityFailed:
+        - task: "Utilities/Log@1"
+          name: LogActivityFailed
+          inputs:
+            message: "Activity FtpImport failed: {{exception.message}}"
+            level: Error
+    steps:
+      - task: "FileTransfer/Connect@1"
+        name: SftpConnect
+        inputs:
+          host: "{{ ftpConfig?.host? }}"
+          protocol: "{{ ftpConfig?.protocol? }}"
+          username: "{{ ftpConfig?.username? }}"
+          authentication:
+            type: "password"
+            password: "{{ ftpConfig?.password? }}"
+          options:
+            timeout: 30
+        outputs:
+          - name: connection
+            mapping: "connection?"
+          - name: connectionId
+            mapping: "connectionId?"
+      - task: "FileTransfer/ListFiles@1"
+        name: SftpListFiles
+        inputs:
+          connection: "{{ FtpImport?.SftpConnect?.connection? }}"
+          directory: "tracking/inbound"
+          pattern: "*.json"
+          recursive: false
+          includeDirectories: false
+          sortBy: "name"
+          sortOrder: "asc"
+        outputs:
+          - name: files
+            mapping: "files?"
+          - name: fileCount
+            mapping: "fileCount?"
+      - task: "foreach"
+        name: ProcessFiles
+        collection: "FtpImport?.SftpListFiles?.files?"
+        steps:
+          - task: "FileTransfer/DownloadFile@1"
+            name: SftpDownloadFile
+            inputs:
+              connection: "{{ FtpImport?.SftpConnect?.connection? }}"
+              remotePath: "{{ item.path }}"
+            outputs:
+              - name: fileInfo
+                mapping: "fileInfo?"
+              - name: content
+                mapping: "content?"
+          # TODO: Parse downloaded content and map to tracking events
+          - task: "Utilities/SetVariable@1"
+            name: ParseContent
+            inputs:
+              variables:
+                - name: trackingEvents
+                  value: []
+          - task: "Order/Import@1"
+            name: ImportTrackingEvents
+            inputs:
+              orders:
+                - trackingNumber: "{{ varTrackingNumber }}"
+                  orderType: "ParcelShipment"
+                  trackingEvents: "{{ trackingEvents }}"
+              options:
+                orderMatchByFields:
+                  - "trackingNumber"
+                trackingEventMatchByFields:
+                  - "eventDate"
+                  - "customValues.eventType"
+                skipIfExists: true
+                createEventDefinitions: true
+          - task: "FileTransfer/MoveFile@1"
+            name: SftpMoveFile
+            inputs:
+              connection: "{{ FtpImport?.SftpConnect?.connection? }}"
+              sourcePath: "{{ item.path }}"
+              destinationPath:
+                expression: "format('tracking/processed/{0}-{1}', formatDate(now(), 'yyyyMMdd_HHmmss', 'en-US'), [item.name])"
+              options:
+                createDirectories: true
+                overwrite: true
+      - task: "FileTransfer/Disconnect@1"
+        name: SftpDisconnect
+        conditions: "isNullOrEmpty([FtpImport?.SftpConnect?.connection?]) = false"
+        inputs:
+          connection: "{{ FtpImport?.SftpConnect?.connection? }}"
+events:
+  onWorkflowStarted:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowStarted
+      inputs:
+        message: "{{displayName}} workflow started"
+        level: Information
+  onWorkflowExecuted:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowExecuted
+      inputs:
+        message: "{{displayName}} workflow completed successfully"
+        level: Information
+  onWorkflowFailed:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowFailed
+      inputs:
+        message: "{{displayName}} workflow failed: {{exception.message}}"
+        level: Error

package/templates/workflow-mcp-tool.yaml ADDED Viewed

@@ -0,0 +1,112 @@
+# {{displayName}} Workflow
+# Generated by cx-cli create workflow --template mcp-tool
+workflow:
+  workflowId: "{{uuid}}"
+  name: "{{displayName}}"
+  description: "{{displayName}} - MCP tool workflow"
+  version: "1.0"
+  executionMode: Sync
+  logLevel: Information
+  isActive: true
+  enableAudit: true
+  filePath: "{{fileName}}"
+  agentInstruction: |
+    Use this tool to {{displayName}}.
+    Inputs:
+      - orderId (required): The order ID to process
+    Returns:
+      - result: Processing outcome with success status
+  tags:
+    - "mcp-tool"
+inputs:
+  - name: orderId
+    type: number
+    props:
+      displayName: "Order ID"
+      description: "The ID of the order to process"
+      required: true
+outputs:
+  - name: result
+    mapping: "Main.SetResult.result"
+activities:
+  - name: Main
+    events:
+      onActivityStarted:
+        - task: "Utilities/Log@1"
+          name: LogActivityStarted
+          inputs:
+            message: "Activity Main started"
+            level: Information
+      onActivityCompleted:
+        - task: "Utilities/Log@1"
+          name: LogActivityCompleted
+          inputs:
+            message: "Activity Main completed"
+            level: Information
+      onActivityFailed:
+        - task: "Utilities/Log@1"
+          name: LogActivityFailed
+          inputs:
+            message: "Activity Main failed: {{exception.message}}"
+            level: Error
+    steps:
+      - task: "Query/GraphQL"
+        name: GetOrder
+        inputs:
+          query: |
+            query($organizationId: Int!, $orderId: Int!) {
+              order(organizationId: $organizationId, orderId: $orderId) {
+                orderId
+                orderNumber
+                status
+              }
+            }
+          variables:
+            organizationId: "\{{int organizationId}}"
+            orderId: "\{{inputs.orderId}}"
+        outputs:
+          - name: order
+            mapping: "order?"
+      - task: "Utilities/Error@1"
+        name: ValidateOrder
+        conditions:
+          - expression: "isNullOrEmpty([Main?.GetOrder?.order?]) = true"
+        inputs:
+          message: "Order not found: \{{inputs.orderId}}"
+      # TODO: Add processing logic here
+      - task: "Utilities/SetVariable@1"
+        name: SetResult
+        inputs:
+          variables:
+            - name: result
+              value:
+                success: true
+                orderId: "\{{inputs.orderId}}"
+                orderNumber: "\{{Main?.GetOrder?.order?.orderNumber?}}"
+events:
+  onWorkflowStarted:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowStarted
+      inputs:
+        message: "{{displayName}} workflow started"
+        level: Information
+  onWorkflowExecuted:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowExecuted
+      inputs:
+        message: "{{displayName}} workflow completed successfully"
+        level: Information
+  onWorkflowFailed:
+    - task: "Utilities/Log@1"
+      name: LogWorkflowFailed
+      inputs:
+        message: "{{displayName}} workflow failed: {{exception.message}}"
+        level: Error