cxtms 1.9.13

package/schemas/actions/workflow.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "workflow Action",
+  "type": "object",
+  "properties": {
+    "workflow": {
+      "type": "object",
+      "properties": {
+        "workflowId": { "type": "string", "description": "Workflow identifier" },
+        "inputs": { "type": "object", "description": "Workflow inputs" },
+        "onSuccess": { "$ref": "../schemas.json#/definitions/actionsList" },
+        "onError": { "$ref": "../schemas.json#/definitions/actionsList" }
+      },
+      "x-examples": [
+        {
+          "workflowId": "b7c4ffa9-bf7e-4e2c-8e57-8f24f4a2b8a8",
+          "inputs": { "request": { "message": "Hello, World!" } },
+          "onSuccess": [{ "notification": { "message": "Echo executed successfully. {{ response.echo.message }}" } }]
+        }
+      ]
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/components/README.md

@@ -0,0 +1,147 @@
+# Component Schemas
+
+This directory contains individual JSON schema files for each CargoXplorer component type. Breaking down component schemas into separate files improves maintainability, organization, and reusability.
+
+## Directory Structure
+
+```
+schema/
+├── components/
+│   ├── appComponent.json     # Base app component schema
+│   ├── navbar.json          # Navigation bar component
+│   ├── navbarItem.json      # Navigation item component
+│   ├── navDropdown.json     # Navigation dropdown component
+│   ├── navbarLink.json      # Navigation link component
+│   ├── collection.json      # Collection/iteration component
+│   ├── row.json             # Row layout component
+│   ├── dataGrid.json        # Data grid component
+│   ├── button.json          # Button component
+│   ├── form.json            # Form component
+│   ├── layout.json          # Layout container component
+│   ├── tabs.json            # Tabs container component
+│   ├── tab.json             # Individual tab component
+│   ├── field.json           # Form field component
+│   ├── dropdown.json        # Dropdown menu component
+│   ├── datasource.json      # Data source component
+│   ├── calendar.json        # Calendar component
+│   ├── module.json          # Module component
+│   ├── index.json           # Component schema index
+│   └── README.md            # This documentation file
+├── fields/                  # Field type schemas
+│   ├── text.json
+│   ├── select-async.json
+│   └── ...
+└── schemas.json             # Main schema file with references
+```
+
+## Benefits of Separate Component Schemas
+
+### 1. **Maintainability**
+
+- Each component schema is in its own file
+- Easier to find and update specific component definitions
+- Reduces the size of the main schemas.json file
+
+### 2. **Reusability**
+
+- Component schemas can be referenced from multiple locations
+- Enables better modular schema design
+- Facilitates schema composition and inheritance
+
+### 3. **Organization**
+
+- Clear separation between different component types
+- Logical file structure mirrors component hierarchy
+- Better developer experience when working with schemas
+
+### 4. **Collaboration**
+
+- Multiple developers can work on different component schemas simultaneously
+- Reduces merge conflicts in the main schema file
+- Easier code reviews for component-specific changes
+
+## Usage
+
+The main `schemas.json` file now references these separate component files:
+
+```json
+{
+  "components": {
+    "schemas": {
+      "button": {
+        "$ref": "components/button.json"
+      },
+      "dataGrid": {
+        "$ref": "components/dataGrid.json"
+      },
+      "form": {
+        "$ref": "components/form.json"
+      }
+      // ... other components
+    }
+  }
+}
+```
+
+## Schema References
+
+Each component schema file uses relative references to the main schemas.json file for shared definitions:
+
+```json
+{
+  "properties": {
+    "onClick": {
+      "$ref": "../schemas.json#/definitions/actionsList"
+    },
+    "isHidden": {
+      "$ref": "../schemas.json#/definitions/templateExpression"
+    }
+  }
+}
+```
+
+## Adding New Components
+
+To add a new component schema:
+
+1. Create a new JSON file in this directory (e.g., `myComponent.json`)
+2. Define the component schema following the existing patterns
+3. Add a reference to the component in the main `schemas.json` file
+4. Update the `index.json` file if needed
+5. Update this README.md file
+
+## Component Schema Structure
+
+Each component schema should follow this general structure:
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Component Name",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "componentName"
+    },
+    "name": {
+      "type": "string",
+      "description": "Component name identifier"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        // Component-specific properties
+      }
+    },
+    "children": {
+      "$ref": "../schemas.json#/definitions/componentChildren"
+    }
+  },
+  "required": ["component"]
+}
+```
+
+## Validation
+
+All component schemas are validated against JSON Schema Draft 07 specification. Ensure your schemas are valid JSON and follow the established patterns for consistency.

package/schemas/components/appComponent.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Generic CargoXplorer App Component",
+  "type": "object",
+  "description": "Base schema for any CargoXplorer component that can be used within the application",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Component name in format 'ModuleName/ComponentName'",
+      "pattern": "^[A-Za-z0-9]+/[A-Za-z0-9]+$"
+    },
+    "permissions": {
+      "$ref": "../schemas.json#/definitions/permissions"
+    },
+    "priority": {
+      "type": "integer",
+      "default": 0,
+      "description": "Component priority (higher number = higher priority)"
+    },
+    "displayName": {
+      "$ref": "../schemas.json#/definitions/localized"
+    },
+    "props": {
+      "oneOf": [
+        {
+          "type": "object",
+          "description": "Properties passed to the component when targeting a slot",
+          "properties": {
+            "targetSlot": {
+              "type": "string",
+              "description": "Name of the slot this component targets"
+            },
+            "order": {
+              "type": "integer",
+              "description": "Order of the component in the target slot"
+            }
+          },
+          "additionalProperties": true
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "platforms": {
+      "type": "array",
+      "description": "Target platforms for this component",
+      "items": {
+        "type": "string",
+        "enum": ["web", "mobile"]
+      }
+    },
+    "layout": {
+      "$ref": "../schemas.json#/definitions/component"
+    }
+  },
+  "required": ["name", "layout"]
+}

package/schemas/components/barcodeScanner.json

@@ -0,0 +1,69 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Barcode Scanner Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "barcodeScanner"
+    },
+    "name": {
+      "type": "string",
+      "description": "Component name identifier"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "minBarcodeLength": {
+          "type": "integer",
+          "description": "Minimum length for recognized barcodes"
+        },
+        "onScan": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions to execute when a barcode is successfully scanned"
+        },
+        "isHidden": {
+          "$ref": "../schemas.json#/definitions/templateExpression",
+          "description": "Boolean expression for conditional rendering"
+        }
+      }
+    }
+  },
+  "required": ["component"],
+  "x-examples": [
+    {
+      "component": "barcodeScanner",
+      "props": {
+        "minBarcodeLength": 8,
+        "onScan": [
+          { "setStore": { "scannedBarcode": "{{ result.data }}" } },
+          { "notification": { "message": "Barcode scanned: {{ result.data }}" } }
+        ]
+      }
+    },
+    {
+      "component": "barcodeScanner",
+      "props": {
+        "minBarcodeLength": 10,
+        "onScan": [
+          {
+            "if": "{{ eval result.format === 'QR_CODE' }}",
+            "then": [{ "setStore": { "qrCodeData": "{{ result.data }}" } }, { "navigate": "/qr-details" }],
+            "else": [
+              {
+                "mutation": {
+                  "command": "logBarcodeScan",
+                  "variables": {
+                    "barcodeData": "{{ result.data }}",
+                    "format": "{{ result.format }}"
+                  }
+                }
+              },
+              { "notification": { "message": "Barcode logged: {{ result.data }}" } }
+            ]
+          }
+        ]
+      }
+    }
+  ]
+}

package/schemas/components/button.json

@@ -0,0 +1,123 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Button Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "button"
+    },
+    "name": {
+      "type": "string",
+      "description": "Button name identifier"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }]
+        },
+        "icon": {
+          "type": "string",
+          "description": "Icon class name"
+        },
+        "size": {
+          "type": "object",
+          "description": "Responsive size configuration",
+          "additionalProperties": true
+        },
+        "options": {
+          "type": "object",
+          "description": "Button options. these are the same as the button component attributes ",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": ["submit", "reset", "button"]
+            },
+            "variant": {
+              "type": "string",
+              "enum": [
+                "primary",
+                "secondary",
+                "outline-primary",
+                "outline-secondary",
+                "danger",
+                "success",
+                "warning",
+                "info"
+              ],
+              "description": "Button variant style"
+            },
+            "disabled": {
+              "type": "boolean",
+              "description": "Disable the button"
+            }
+          },
+          "additionalProperties": true
+        },
+        "onClick": {
+          "$ref": "../schemas.json#/definitions/actionsList"
+        },
+        "isHidden": {
+          "$ref": "../schemas.json#/definitions/templateExpression"
+        }
+      }
+    }
+  },
+  "required": ["component"],
+  "x-examples": [
+    {
+      "component": "button",
+      "name": "openDialog",
+      "props": {
+        "label": { "en-US": "New Order" },
+        "icon": "plus",
+        "options": { "variant": "primary", "type": "button" },
+        "onClick": [
+          {
+            "dialog": {
+              "name": "createOrder",
+              "props": { "title": { "en-US": "Create Order" } },
+              "component": { "component": "layout", "children": [{ "component": "Orders/CreateOrder" }] }
+            }
+          }
+        ]
+      }
+    },
+    {
+      "component": "button",
+      "name": "submitFormBtn",
+      "props": {
+        "label": "Save",
+        "options": { "type": "submit", "variant": "success", "disabled": false }
+      }
+    },
+    {
+      "component": "button",
+      "name": "export",
+      "props": {
+        "label": { "en-US": "Export" },
+        "icon": "download",
+        "options": { "variant": "outline-primary" },
+        "onClick": [
+          {
+            "workflow": {
+              "workflowId": "24f504ad-2ca3-4432-b2a4-c540c48fee31",
+              "inputs": { "exportName": "orders" }
+            }
+          }
+        ]
+      }
+    },
+    {
+      "component": "button",
+      "name": "back",
+      "props": {
+        "label": "Back",
+        "options": { "type": "button", "variant": "secondary" },
+        "onClick": [{ "navigateBack": { "fallback": "/home" } }],
+        "isHidden": "{{ eval !canGoBack }}"
+      }
+    }
+  ]
+}