@cxtms/cx-schema 1.9.67 → 1.9.241

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cxtms/cx-schema",
-  "version": "1.9.67",
+  "version": "1.9.241",
   "description": "Schema validation package for CXTMS YAML modules",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/schemas/actions/all.json

@@ -7,12 +7,14 @@
     { "$ref": "navigateBack.json" },
     { "$ref": "navigateBackOrClose.json" },
     { "$ref": "refresh.json" },
+    { "$ref": "reload.json" },
     { "$ref": "notification.json" },
     { "$ref": "confirm.json" },
     { "$ref": "mutation.json" },
     { "$ref": "query.json" },
     { "$ref": "setFields.json" },
     { "$ref": "setStore.json" },
+    { "$ref": "setSessionStorage.json" },
     { "$ref": "validateForm.json" },
     { "$ref": "dialog.json" },
     { "$ref": "workflow.json" },
@@ -22,6 +24,8 @@
     { "$ref": "consoleLog.json" },
     { "$ref": "openBarcodeScanner.json" },
     { "$ref": "resetDirtyState.json" },
-    { "$ref": "clipboard.json" }
+    { "$ref": "clipboard.json" },
+    { "$ref": "sound.json" },
+    { "$ref": "vibrate.json" }
   ]
 }

package/schemas/actions/reload.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "reload Action",
+  "type": "object",
+  "properties": {
+    "reload": {
+      "description": "Refetches and replaces one or more forms from their initialValues source",
+      "oneOf": [
+        { "type": "string" },
+        { "type": "array", "items": { "type": "string" }, "minItems": 1 }
+      ],
+      "x-examples": ["orderForm", ["orderForm", "orderLinesForm"]]
+    }
+  },
+  "required": ["reload"],
+  "additionalProperties": false
+}

package/schemas/actions/setSessionStorage.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "setSessionStorage Action",
+  "type": "object",
+  "properties": {
+    "setSessionStorage": {
+      "type": "object",
+      "description": "Browser sessionStorage value to set for the current tab",
+      "required": ["key", "value"],
+      "properties": {
+        "key": {
+          "type": "string",
+          "description": "Unscoped sessionStorage key"
+        },
+        "value": {
+          "description": "Value to store. Template expressions are resolved before writing."
+        }
+      },
+      "additionalProperties": false,
+      "x-examples": [
+        { "key": "isDevMode", "value": "true" },
+        { "key": "activeWorkspace", "value": "{{ workspaceId }}" }
+      ]
+    },
+    "onSuccess": {
+      "type": "array",
+      "description": "Actions to execute after sessionStorage is updated",
+      "items": { "$ref": "all.json" }
+    },
+    "onError": {
+      "type": "array",
+      "description": "Actions to execute if sessionStorage update fails",
+      "items": { "$ref": "all.json" }
+    }
+  },
+  "required": ["setSessionStorage"],
+  "additionalProperties": false
+}

package/schemas/actions/sound.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "sound Action",
+  "type": "object",
+  "properties": {
+    "sound": {
+      "oneOf": [
+        {
+          "type": "string",
+          "enum": ["success", "error", "warning", "scan"]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": ["success", "error", "warning", "scan"],
+              "description": "Feedback tone preset. Defaults to success."
+            },
+            "volume": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 1,
+              "description": "Tone volume from 0 to 1. Defaults to 1."
+            }
+          },
+          "additionalProperties": false
+        }
+      ],
+      "description": "Play a short browser-generated feedback tone. Unsupported browsers resolve without failing the action chain.",
+      "x-examples": [
+        "success",
+        { "type": "scan", "volume": 0.5 }
+      ]
+    }
+  },
+  "required": ["sound"],
+  "additionalProperties": false
+}

package/schemas/actions/vibrate.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "vibrate Action",
+  "type": "object",
+  "properties": {
+    "vibrate": {
+      "oneOf": [
+        {
+          "type": "string",
+          "enum": ["success", "error", "warning", "light", "medium", "heavy"]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": ["success", "error", "warning", "light", "medium", "heavy"],
+              "description": "Haptic preset. Defaults to success."
+            },
+            "pattern": {
+              "type": "array",
+              "items": {
+                "type": "number",
+                "minimum": 0
+              },
+              "minItems": 1,
+              "description": "Vibration API pattern in milliseconds: even indexes vibrate, odd indexes pause."
+            },
+            "duration": {
+              "type": "number",
+              "minimum": 0,
+              "description": "Single vibration duration in milliseconds."
+            }
+          },
+          "additionalProperties": false
+        }
+      ],
+      "description": "Trigger device haptic feedback through navigator.vibrate when supported. Unsupported devices resolve without failing the action chain.",
+      "x-examples": [
+        "success",
+        { "type": "light" },
+        { "pattern": [50, 60, 50] }
+      ]
+    }
+  },
+  "required": ["vibrate"],
+  "additionalProperties": false
+}

package/schemas/components/avatar.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","title":"Avatar Component","type":"object","required":["component"],"properties":{"component":{"const":"avatar"},"name":{"type":"string"},"props":{"type":"object","properties":{"src":{},"firstName":{},"lastName":{},"name":{},"email":{},"colorSeed":{},"color":{"type":"string"},"bgcolor":{"type":"string"},"textColor":{"type":"string"},"size":{"type":["number","string"]},"skin":{"type":"string"},"variant":{"type":"string"},"tooltip":{},"onClick":{"$ref":"../schemas.json#/definitions/actionsList"}},"additionalProperties":true}},"additionalProperties":true}

package/schemas/components/badge.json

@@ -0,0 +1,79 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "badge-component",
+  "title": "Badge Component",
+  "description": "Colored chip/badge with template-parsed label, optional color lookup key, dot indicator, and optional click actions.",
+  "type": "object",
+  "required": ["component", "props"],
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "badge",
+      "description": "Component type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Unique identifier for the badge component"
+    },
+    "props": {
+      "type": "object",
+      "required": ["label"],
+      "properties": {
+        "label": {
+          "type": ["string", "object"],
+          "description": "Badge text. Template-parsed with store values, component variables, and form values.",
+          "x-example": "{{ status }}"
+        },
+        "colorKey": {
+          "type": ["string", "object"],
+          "description": "Optional color lookup key. Template-parsed with store values, component variables, and form values. Defaults to the normalized label.",
+          "x-example": "{{ statusCode }}"
+        },
+        "color": { "type": ["string", "object"], "description": "Template-parsed seed color, normally an organization-defined hex." },
+        "variant": { "type": ["string", "object"], "description": "Semantic badge variant." },
+        "size": { "type": "string", "enum": ["xs", "sm", "md"], "default": "sm" },
+        "appearance": { "type": "string", "enum": ["soft", "outline", "solid", "ghost"], "default": "soft" },
+        "uppercase": { "type": "boolean", "default": false },
+        "dot": { "type": "boolean", "default": false },
+        "icon": { "type": "string" },
+        "maxWidth": { "type": ["number", "string"] },
+        "options": {
+          "type": "object",
+          "properties": {
+            "colors": {
+              "type": "object",
+              "description": "Map of color keys to text/background/dot colors. Include a default entry for fallback rendering.",
+              "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "object", "additionalProperties": true }] }
+            }
+          },
+          "additionalProperties": true
+        },
+        "onClick": {
+          "type": "array",
+          "description": "Actions to dispatch when clicked. Makes the badge interactive and stops event propagation.",
+          "items": {
+            "type": "object"
+          }
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "additionalProperties": true,
+  "x-examples": {
+    "statusBadge": {
+      "component": "badge",
+      "name": "statusBadge",
+      "props": {
+        "label": "{{ status }}",
+        "colorKey": "{{ status }}",
+        "options": {
+          "colors": {
+            "Delivered": { "label": "#1b5e20", "bgcolor": "#e8f5e9", "dot": "#4caf50" },
+            "default": { "label": "#5f370e", "bgcolor": "#fff8e1", "dot": "#ff9800" }
+          }
+        }
+      }
+    }
+  }
+}

package/schemas/components/barcodeScanner.json

@@ -16,8 +16,36 @@
       "properties": {
         "minBarcodeLength": {
           "type": "integer",
+          "minimum": 1,
           "description": "Minimum length for recognized barcodes"
         },
+        "deduplicate": {
+          "type": "boolean",
+          "default": true,
+          "description": "Suppress repeated reads of the same barcode"
+        },
+        "scanDelayMs": {
+          "type": "number",
+          "minimum": 0,
+          "default": 1000,
+          "description": "Per-code deduplication window in milliseconds"
+        },
+        "minScanIntervalMs": {
+          "type": "number",
+          "minimum": 0,
+          "default": 0,
+          "description": "Minimum interval in milliseconds between accepted scans"
+        },
+        "continuous": {
+          "type": "boolean",
+          "default": true,
+          "description": "Allow more than one accepted scan"
+        },
+        "maxBarcodes": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Maximum number of accepted scans in continuous mode"
+        },
         "onScan": {
           "$ref": "../schemas.json#/definitions/actionsList",
           "description": "Actions to execute when a barcode is successfully scanned"

package/schemas/components/camera.json

@@ -0,0 +1,177 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Camera Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "camera"
+    },
+    "name": {
+      "type": "string",
+      "description": "Unique name identifier for the camera instance"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "width": {
+          "type": "number",
+          "description": "Viewport width in pixels"
+        },
+        "height": {
+          "type": "number",
+          "description": "Viewport height in pixels"
+        },
+        "facing": {
+          "type": "string",
+          "enum": ["front", "back"],
+          "default": "back",
+          "description": "Which camera to use"
+        },
+        "mode": {
+          "type": "string",
+          "enum": ["picture", "scanner", "hybrid"],
+          "description": "Camera mode. Scanner and hybrid modes are supported by the mobile renderer.",
+          "default": "picture"
+        },
+        "scanner": {
+          "type": "object",
+          "description": "Scanner settings used by scanner and hybrid modes.",
+          "properties": {
+            "recognize": {
+              "type": "array",
+              "items": { "type": "string", "enum": ["barcode", "vin", "container"] },
+              "uniqueItems": true,
+              "default": ["barcode"],
+              "description": "Mobile recognition modes. VIN and container use native OCR with checksum validation."
+            },
+            "autoCapture": {
+              "type": "boolean",
+              "default": false,
+              "description": "Mobile: capture a proof photo immediately after accepting a scan."
+            },
+            "barcodeTypes": { "type": "array", "items": { "type": "string" } },
+            "minBarcodeLength": { "type": "integer", "minimum": 1 },
+            "continuous": { "type": "boolean" },
+            "deduplicate": { "type": "boolean" },
+            "scanDelayMs": { "type": "number", "minimum": 0 },
+            "minScanIntervalMs": { "type": "number", "minimum": 0 },
+            "maxBarcodes": { "type": "integer", "minimum": 1 }
+          },
+          "additionalProperties": true
+        },
+        "enableTorch": {
+          "type": "boolean",
+          "description": "Enable the device flashlight/torch during streaming"
+        },
+        "zoom": {
+          "type": "number",
+          "description": "Initial zoom factor (device capabilities determine actual range)"
+        },
+        "autofocus": {
+          "type": "string",
+          "enum": ["on", "off"],
+          "description": "Controls autofocus. Omit to let the browser decide."
+        },
+        "mirror": {
+          "type": "boolean",
+          "description": "Horizontally flip the video preview. Defaults to true for front camera, false for back."
+        },
+        "picture": {
+          "type": "object",
+          "description": "Capture format and quality settings",
+          "properties": {
+            "quality": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 1,
+              "description": "JPEG/WebP quality from 0 to 1"
+            },
+            "format": {
+              "type": "string",
+              "enum": ["jpeg", "png", "webp"],
+              "default": "jpeg",
+              "description": "Output image format"
+            },
+            "base64": {
+              "type": "boolean",
+              "description": "If true, onCapture receives a base64 string; otherwise a Blob"
+            }
+          }
+        },
+        "onCapture": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions fired after a successful capture. Receives { data: string|Blob, width: number, height: number }"
+        },
+        "onScan": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions fired after an accepted scan. Receives { data, format, type } and optional proof-photo fields when scanner.autoCapture is enabled."
+        },
+        "onClose": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions fired when the camera stream stops"
+        },
+        "onReady": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions fired once the camera is initialized and streaming. Receives { facing, mode: 'picture' }"
+        },
+        "onPermissionDenied": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions fired when camera permission is denied. Receives { permission: 'camera' }"
+        },
+        "onError": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions fired on camera errors. Receives { message: string, code: string }"
+        }
+      }
+    }
+  },
+  "required": ["component"],
+  "x-examples": [
+    {
+      "component": "camera",
+      "props": {
+        "width": 1024,
+        "height": 768,
+        "facing": "back",
+        "onCapture": [
+          {
+            "fileUpload": {
+              "file": "{{ result.data }}",
+              "name": "capture",
+              "onSuccess": [
+                { "setStore": { "imageUrl": "{{ result.url }}" } }
+              ]
+            }
+          }
+        ],
+        "onClose": [
+          { "navigateBackOrClose": { "result": "camera_closed" } }
+        ]
+      }
+    },
+    {
+      "component": "camera",
+      "props": {
+        "facing": "front",
+        "mirror": true,
+        "picture": {
+          "format": "jpeg",
+          "quality": 0.85,
+          "base64": true
+        },
+        "onCapture": [
+          { "setStore": { "selfieData": "{{ result.data }}" } }
+        ],
+        "onPermissionDenied": [
+          {
+            "notification": {
+              "message": "Camera access is required to take photos.",
+              "variant": "warning"
+            }
+          }
+        ]
+      }
+    }
+  ]
+}

package/schemas/components/card.json

@@ -28,6 +28,84 @@
           "type": "string",
           "description": "CSS classes for styling"
         },
+        "options": {
+          "type": "object",
+          "description": "Card visual and layout options",
+          "properties": {
+            "variant": {
+              "type": "string",
+              "enum": ["elevation", "outlined"],
+              "description": "MUI Card variant"
+            },
+            "elevation": {
+              "type": "number",
+              "description": "Shadow depth when variant is elevation"
+            },
+            "sx": {
+              "type": "object",
+              "description": "MUI sx styles applied to the card root",
+              "additionalProperties": true
+            },
+            "style": {
+              "type": "object",
+              "description": "Theme-aware CSSProperties applied after sx",
+              "properties": {
+                "light": {
+                  "type": "object",
+                  "description": "Card root styles for light mode",
+                  "additionalProperties": true
+                },
+                "dark": {
+                  "type": "object",
+                  "description": "Card root styles for dark mode",
+                  "additionalProperties": true
+                }
+              },
+              "additionalProperties": false
+            },
+            "bgcolor": {
+              "type": "string",
+              "description": "Background color"
+            },
+            "color": {
+              "type": "string",
+              "description": "Text color"
+            },
+            "className": {
+              "type": "string",
+              "description": "CSS classes for the card root"
+            },
+            "header": {
+              "type": "object",
+              "description": "Card header configuration",
+              "additionalProperties": true
+            },
+            "actions": {
+              "type": "object",
+              "description": "Card actions configuration",
+              "additionalProperties": true
+            },
+            "disableContentWrapper": {
+              "type": "boolean",
+              "description": "Render children directly without CardContent"
+            },
+            "contentSx": {
+              "type": "object",
+              "description": "MUI sx styles applied to CardContent",
+              "additionalProperties": true
+            },
+            "contentClassName": {
+              "type": "string",
+              "description": "CSS class applied to CardContent"
+            },
+            "contentProps": {
+              "type": "object",
+              "description": "Additional CardContent props",
+              "additionalProperties": true
+            }
+          },
+          "additionalProperties": true
+        },
         "toolbar": {
           "type": "array",
           "description": "Toolbar components",

package/schemas/components/dashboard-widget.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Dashboard Widget Component",
+  "type": "object",
+  "properties": {
+    "component": { "type": "string", "const": "dashboard-widget" },
+    "name": { "type": "string", "description": "Unique widget name within the parent dashboard" },
+    "inputs": { "type": "object" },
+    "props": {
+      "type": "object",
+      "properties": {
+        "options": {
+          "type": "object",
+          "properties": {
+            "row": { "type": "number", "default": 1 },
+            "col": { "type": "number", "default": 1 },
+            "rowSpan": { "type": "number", "default": 1 },
+            "colSpan": { "type": "number", "default": 1 },
+            "title": { "type": "string" },
+            "showHeader": { "type": "boolean", "default": true },
+            "className": { "type": "string" },
+            "minRowSpan": { "type": "number", "default": 1 },
+            "maxRowSpan": { "type": "number" },
+            "minColSpan": { "type": "number", "default": 1 },
+            "maxColSpan": { "type": "number" },
+            "isEditMode": { "type": "boolean" },
+            "allowScroll": { "type": "boolean", "default": false }
+          },
+          "additionalProperties": true
+        },
+        "isHidden": { "$ref": "../schemas.json#/definitions/templateExpression" }
+      },
+      "additionalProperties": true
+    },
+    "children": { "$ref": "../schemas.json#/definitions/componentChildren" }
+  },
+  "required": ["component", "name"],
+  "additionalProperties": false
+}

package/schemas/components/dashboard.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Dashboard Component",
+  "type": "object",
+  "properties": {
+    "component": { "type": "string", "const": "dashboard" },
+    "name": { "type": "string", "description": "Unique dashboard name; used in saved layout setting keys" },
+    "inputs": { "type": "object" },
+    "props": {
+      "type": "object",
+      "properties": {
+        "toolbar": {
+          "type": "array",
+          "description": "Header controls whose values are shared with dashboard widgets",
+          "items": { "$ref": "../schemas.json#/definitions/component" }
+        },
+        "options": {
+          "type": "object",
+          "properties": {
+            "rows": { "type": "number", "default": 12 },
+            "columns": { "type": "number", "default": 12 },
+            "gridGap": { "type": "number", "default": 8 },
+            "responsive": { "type": "boolean", "default": false },
+            "allowEdit": { "type": "boolean", "default": false },
+            "showGridLines": { "type": "boolean", "default": true },
+            "autoSave": { "type": "boolean", "default": false, "description": "Persist layout changes to UserSettings automatically" },
+            "title": { "type": "string" },
+            "minHeight": { "oneOf": [{ "type": "string" }, { "type": "number" }] },
+            "maxHeight": { "oneOf": [{ "type": "string" }, { "type": "number" }] },
+            "height": { "oneOf": [{ "type": "string" }, { "type": "number" }] }
+          },
+          "additionalProperties": true
+        },
+        "isHidden": { "$ref": "../schemas.json#/definitions/templateExpression" }
+      },
+      "additionalProperties": true
+    },
+    "children": {
+      "type": "array",
+      "description": "Dashboard widgets",
+      "items": { "$ref": "../schemas.json#/definitions/component" }
+    }
+  },
+  "required": ["component", "name"],
+  "additionalProperties": false
+}