@cxtms/cx-schema 1.9.67 → 1.9.241

package/schemas/components/dataGrid.json

@@ -68,6 +68,21 @@
                   },
                   "onClick": {
                     "$ref": "../schemas.json#/definitions/actionsList"
+                  },
+                  "permission": {
+                    "type": "string",
+                    "description": "Permission required to show/enable the menu item"
+                  },
+                  "isHidden": {
+                    "$ref": "../schemas.json#/definitions/templateExpression",
+                    "description": "Template expression evaluated with component props and row data"
+                  },
+                  "disabled": {
+                    "oneOf": [
+                      { "type": "boolean" },
+                      { "$ref": "../schemas.json#/definitions/templateExpression" }
+                    ],
+                    "description": "Boolean or template expression evaluated with component props and row data"
                   }
                 }
               }

package/schemas/components/field-collection.json

@@ -18,13 +18,19 @@
     },
     "props": {
       "type": "object",
-      "required": ["fieldName", "itemTemplate"],
+      "required": ["fieldName"],
       "properties": {
         "fieldName": {
           "type": "string",
           "description": "The form field name this collection binds to",
           "x-example": "businessHours"
         },
+        "itemType": {
+          "type": "string",
+          "enum": ["object", "string", "number", "boolean", "auto"],
+          "default": "object",
+          "description": "Array item type. Primitive collections can omit itemTemplate; auto detects from existing data."
+        },
         "itemTemplate": {
           "oneOf": [
             {
@@ -105,12 +111,20 @@
               "default": null,
               "description": "Maximum number of items allowed",
               "x-example": 10
+            },
+            "removeType": {
+              "type": "string",
+              "enum": ["soft", "hard"],
+              "default": "soft",
+              "description": "Delete mode for removed items: 'soft' marks object rows with isDeleted=true, while 'hard' physically removes the item from the array",
+              "x-example": "hard"
             }
           },
           "x-example": {
             "allowAdd": true,
             "allowRemove": true,
             "allowReorder": true,
+            "removeType": "soft",
             "minItems": 0,
             "maxItems": 7
           }
@@ -281,6 +295,30 @@
           "description": "Number of columns for grid layout",
           "x-example": 2
         },
+        "groupCols": {
+          "oneOf": [
+            {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 12
+            },
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "xs": { "type": "integer", "minimum": 1, "maximum": 12 },
+                "sm": { "type": "integer", "minimum": 1, "maximum": 12 },
+                "md": { "type": "integer", "minimum": 1, "maximum": 12 },
+                "lg": { "type": "integer", "minimum": 1, "maximum": 12 },
+                "xl": { "type": "integer", "minimum": 1, "maximum": 12 }
+              },
+              "minProperties": 1
+            }
+          ],
+          "default": 1,
+          "description": "Number of group columns when groupMode is enabled. Accepts a fixed count or responsive breakpoint counts; each count is converted to Material UI grid width (12 / count).",
+          "x-example": { "xs": 1, "md": 2, "lg": 4 }
+        },
         "spacing": {
           "type": "integer",
           "minimum": 0,
@@ -289,6 +327,14 @@
           "description": "Spacing between items (Material-UI spacing units)",
           "x-example": 3
         },
+        "groupSpacing": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 10,
+          "default": 0,
+          "description": "Spacing between group columns when groupMode is enabled (Material-UI spacing units)",
+          "x-example": 2
+        },
         "showIndex": {
           "type": "boolean",
           "default": false,
@@ -301,6 +347,12 @@
           "description": "Show drag handle for reordering",
           "x-example": true
         },
+        "showMoveButtons": {
+          "type": "boolean",
+          "default": false,
+          "description": "Show up/down move buttons for reordering. Requires options.allowReorder to be true. Reorder UI backfills stable internal _uuid keys on object rows so moves follow the row instead of the array index.",
+          "x-example": true
+        },
         "containerClass": {
           "type": "string",
           "description": "CSS class for the container",
@@ -310,7 +362,35 @@
           "type": "string",
           "description": "CSS class for each item",
           "x-example": "collection-item"
-        }
+        },
+        "label": {
+          "type": ["string", "object"],
+          "description": "Section label. Enables a full collection header at top level and a compact section header when nested."
+        },
+        "itemTitle": { "type": "string", "description": "Field path or template used as the accordion row title" },
+        "defaultExpanded": { "type": "boolean", "default": false },
+        "itemIcon": { "type": "string", "description": "Icon name or per-item template rendered before the accordion row title" },
+        "itemSubtitle": { "type": "string", "description": "Per-item template for muted row metadata" },
+        "itemBadges": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["label"],
+            "properties": {
+              "label": { "type": "string" },
+              "color": { "type": "string", "enum": ["danger", "warning", "info", "success", "primary", "neutral"], "default": "neutral" },
+              "when": { "type": "string", "description": "Template guarding badge visibility" }
+            }
+          }
+        },
+        "itemNestedCount": { "type": "string", "description": "Template resolving to a nested-record count" },
+        "nestedCountLabel": { "type": ["string", "object"], "default": "nested items" },
+        "summaryTemplate": { "type": "string", "description": "Header summary template receiving count and items" },
+        "showCount": { "type": "boolean", "default": true },
+        "showExpandAll": { "type": "boolean", "default": true },
+        "collapseNested": { "type": "boolean", "default": true },
+        "autoItemTitle": { "type": "boolean", "default": true },
+        "density": { "type": "string", "enum": ["compact", "comfortable"], "default": "compact" }
       }
     }
   },
@@ -332,6 +412,8 @@
           { "key": 0, "label": "Sunday" }
         ],
         "layout": "accordion",
+        "groupCols": { "xs": 1, "md": 2, "lg": 4 },
+        "groupSpacing": 2,
         "defaultItem": {
           "startTime": "09:00:00",
           "endTime": "17:00:00"
@@ -404,6 +486,8 @@
           { "key": "in_progress", "label": { "en-US": "In Progress" }, "icon": "spinner" },
           { "key": "done", "label": { "en-US": "Done" }, "icon": "check-circle" }
         ],
+        "groupCols": { "xs": 1, "md": 3 },
+        "groupSpacing": 2,
         "groupTemplate": {
           "component": "layout",
           "props": { "className": "group-header bg-gray-100 p-2 rounded" },

package/schemas/components/field.json

@@ -33,6 +33,7 @@
           "enum": [
             "text",
             "number",
+            "number-select",
             "email",
             "password",
             "tel",
@@ -46,8 +47,15 @@
             "autocomplete-googleplaces",
             "checkbox",
             "radio",
+            "toggle",
             "textarea",
-            "attachment"
+            "attachment",
+            "secret",
+            "file",
+            "hidden",
+            "quill",
+            "object",
+            "yaml"
           ],
           "description": "Field input type",
           "x-example": "select-async"
@@ -62,6 +70,13 @@
           "description": "Whether field is disabled",
           "x-example": false
         },
+        "min": { "type": "number", "description": "Minimum value for numeric field types" },
+        "max": { "type": "number", "description": "Maximum value for numeric field types" },
+        "step": { "type": "number", "description": "Step increment for number-select arrow controls" },
+        "secretPath": {
+          "type": "string",
+          "description": "Template expression for the secret name used by secret fields, e.g. integrations/{{ id }}/apiKey"
+        },
         "options": {
           "type": "object",
           "description": "Field options for select types",
@@ -134,7 +149,9 @@
               "type": "object",
               "description": "Default values for the field",
               "additionalProperties": true
-            }
+            },
+            "color": { "type": "string" },
+            "orientation": { "type": "string" }
           },
           "additionalProperties": true
         },
@@ -160,14 +177,17 @@
             }
           }
         },
-        "onEditClick": { "$ref": "../schemas.json#/definitions/actionsList" },
+        "onEditClick": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions to execute when the edit icon is clicked. Rendered for text, select-async, and autocomplete-async fields when a single value is set."
+        },
         "onOptionTagClick": {
           "$ref": "../schemas.json#/definitions/actionsList",
           "description": "Actions to execute when clicking on an option tag/chip in the dropdown"
         },
         "items": {
           "type": "array",
-          "description": "Static options for select fields",
+          "description": "Static options for select, radio, and toggle fields",
           "items": {
             "type": "object",
             "properties": {
@@ -192,6 +212,21 @@
         "onSelectValue": {
           "$ref": "../schemas.json#/definitions/actionsList",
           "description": "Actions to execute when a value is selected in select-async fields"
+        },
+        "allowMultiple": {
+          "type": "boolean",
+          "description": "Toggle field multi-select mode (array value when true)."
+        },
+        "exclusive": {
+          "type": "boolean",
+          "description": "Legacy toggle single-select flag; prefer allowMultiple."
+        },
+        "enforceValue": {
+          "type": "boolean",
+          "description": "Toggle single-select mode: prevent deselecting the current value."
+        },
+        "defaultValue": {
+          "description": "Initial field value."
         }
       }
     }

package/schemas/components/form.json

@@ -159,6 +159,10 @@
           "type": "boolean",
           "description": "Reset form values after successful submission"
         },
+        "reloadHandler": {
+          "type": "string",
+          "description": "Handler targeted by reload actions; falls back to refreshHandler, then the form name"
+        },
         "dirtyGuard": {
           "type": "object",
           "description": "Configuration for unsaved changes warning dialog",

package/schemas/components/index.json

@@ -31,6 +31,9 @@
     "card": {
       "$ref": "card.json"
     },
+    "badge": {
+      "$ref": "badge.json"
+    },
     "barcodeScanner": {
       "$ref": "barcodeScanner.json"
     },
@@ -58,14 +61,27 @@
     "datasource": {
       "$ref": "datasource.json"
     },
+    "dashboard": {
+      "$ref": "dashboard.json"
+    },
+    "dashboard-widget": {
+      "$ref": "dashboard-widget.json"
+    },
     "calendar": {
       "$ref": "calendar.json"
     },
+    "map": {
+      "$ref": "map.json"
+    },
     "module": {
       "$ref": "module.json"
     },
     "slot": {
       "$ref": "slot.json"
-    }
+    },
+    "avatar": { "$ref": "avatar.json" },
+    "infoLine": { "$ref": "infoLine.json" },
+    "progressBar": { "$ref": "progressBar.json" },
+    "planner": { "$ref": "planner.json" }
   }
 }

package/schemas/components/infoLine.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","title":"InfoLine Component","type":"object","required":["component"],"properties":{"component":{"const":"infoLine"},"name":{"type":"string"},"props":{"type":"object","properties":{"icon":{},"iconColor":{},"value":{},"href":{},"truncate":{"type":"boolean"},"variant":{"enum":["default","chip"]},"tooltip":{},"onClick":{"$ref":"../schemas.json#/definitions/actionsList"}},"additionalProperties":true}},"additionalProperties":true}

package/schemas/components/map.json

@@ -0,0 +1,167 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Map Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "map"
+    },
+    "name": {
+      "type": "string",
+      "description": "Unique name identifier for the map instance"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["google"],
+          "default": "google",
+          "description": "Map provider. Only Google Maps is currently supported."
+        },
+        "height": {
+          "oneOf": [
+            { "type": "number" },
+            {
+              "type": "string",
+              "pattern": "\\{\\{.*\\}\\}",
+              "description": "Template expression that resolves to a numeric height"
+            }
+          ],
+          "default": 520,
+          "description": "Map viewport height in pixels"
+        },
+        "center": {
+          "type": "object",
+          "description": "Optional map center. Values can be numbers or numeric strings.",
+          "properties": {
+            "lat": {
+              "oneOf": [{ "type": "number" }, { "type": "string" }]
+            },
+            "lng": {
+              "oneOf": [{ "type": "number" }, { "type": "string" }]
+            }
+          },
+          "required": ["lat", "lng"]
+        },
+        "zoom": {
+          "oneOf": [
+            { "type": "number" },
+            {
+              "type": "string",
+              "pattern": "\\{\\{.*\\}\\}",
+              "description": "Template expression that resolves to a numeric zoom"
+            }
+          ],
+          "description": "Initial zoom level"
+        },
+        "stops": {
+          "description": "Dispatch route/template stops array or template expression. Used when markers is not supplied.",
+          "oneOf": [
+            { "type": "array", "items": { "type": "object", "additionalProperties": true } },
+            { "type": "string", "pattern": "\\{\\{.*\\}\\}" }
+          ]
+        },
+        "markers": {
+          "description": "Explicit marker array or template expression. Takes precedence over stops.",
+          "oneOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "oneOf": [{ "type": "string" }, { "type": "number" }]
+                  },
+                  "number": {
+                    "oneOf": [{ "type": "string" }, { "type": "number" }]
+                  },
+                  "label": {
+                    "type": "string"
+                  },
+                  "lat": {
+                    "oneOf": [{ "type": "number" }, { "type": "string" }, { "type": "null" }]
+                  },
+                  "lng": {
+                    "oneOf": [{ "type": "number" }, { "type": "string" }, { "type": "null" }]
+                  },
+                  "address": {
+                    "type": ["string", "null"]
+                  },
+                  "stopType": {
+                    "type": ["string", "null"]
+                  }
+                },
+                "additionalProperties": true
+              }
+            },
+            { "type": "string", "pattern": "\\{\\{.*\\}\\}" }
+          ]
+        },
+        "fitBounds": {
+          "oneOf": [
+            { "type": "boolean" },
+            { "type": "string", "pattern": "\\{\\{.*\\}\\}" }
+          ],
+          "default": true,
+          "description": "Automatically fit the map bounds to valid markers when no explicit center is supplied"
+        },
+        "showUnmappedNote": {
+          "oneOf": [
+            { "type": "boolean" },
+            { "type": "string", "pattern": "\\{\\{.*\\}\\}" }
+          ],
+          "default": true,
+          "description": "Show a caption listing markers/stops that could not be plotted"
+        },
+        "showInfoWindow": {
+          "oneOf": [
+            { "type": "boolean" },
+            { "type": "string", "pattern": "\\{\\{.*\\}\\}" }
+          ],
+          "default": true,
+          "description": "Open an info window when a marker is clicked"
+        },
+        "onMarkerClick": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions fired when a marker is clicked. Receives the marker as result."
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "required": ["component"],
+  "x-examples": [
+    {
+      "component": "map",
+      "name": "dispatchRouteMap",
+      "props": {
+        "height": 560,
+        "stops": "{{ dispatchRoute.stops }}",
+        "fitBounds": true,
+        "onMarkerClick": [
+          { "setStore": { "selectedStopId": "{{ result.id }}" } }
+        ]
+      }
+    },
+    {
+      "component": "map",
+      "name": "terminalMap",
+      "props": {
+        "height": 420,
+        "center": { "lat": 33.749, "lng": -84.388 },
+        "zoom": 8,
+        "markers": [
+          {
+            "id": "atl",
+            "label": "Atlanta Terminal",
+            "lat": 33.749,
+            "lng": -84.388,
+            "address": "Atlanta, GA"
+          }
+        ]
+      }
+    }
+  ]
+}

package/schemas/components/module.json

@@ -133,6 +133,38 @@
         "required": ["name", "roles"]
       }
     },
+    "defaultData": {
+      "type": "array",
+      "description": "Default data imports loaded with the module. Supported entities include reference/master data such as Terminal; Terminal rows match by Name unless keys are provided.",
+      "items": {
+        "type": "object",
+        "properties": {
+          "entity": {
+            "type": "string",
+            "description": "Entity type to import, e.g. Currency, PaymentTerm, Terminal"
+          },
+          "keys": {
+            "type": "array",
+            "items": { "type": "string" },
+            "description": "Field names used to match existing records"
+          },
+          "overwrite": {
+            "type": "boolean",
+            "description": "Update existing matching records instead of skipping them"
+          },
+          "data": {
+            "type": "array",
+            "description": "Rows to import",
+            "items": {
+              "type": "object",
+              "additionalProperties": true
+            }
+          }
+        },
+        "required": ["entity", "data"],
+        "additionalProperties": true
+      }
+    },
     "configurations": {
       "type": "array",
       "description": "Organization configuration definitions",

package/schemas/components/planner.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","title":"Planner Component","type":"object","required":["component","props"],"properties":{"component":{"const":"planner"},"name":{"type":"string"},"props":{"type":"object","required":["queries","rows","columns","itemTemplate"],"properties":{"height":{},"refreshHandler":{"type":"string"},"debug":{"type":"boolean"},"options":{"type":"object","properties":{"enableVirtualization":{"type":"boolean"},"virtualizeThreshold":{"type":"number"},"estimatedRowHeight":{"type":"number"}},"additionalProperties":true},"queries":{"type":"array","minItems":1,"items":{"type":"object","required":["name","query"],"properties":{"name":{"type":"string"},"query":{"type":"object"},"itemsPath":{"type":"string"},"parentAs":{"type":"string"},"mapping":{"type":"object"}},"additionalProperties":true}},"rows":{"type":"object","required":["groupBy","headerWidth"],"properties":{"groupBy":{"type":"string"},"fromQuery":{"type":"string"},"key":{"type":"string"},"label":{},"orderBy":{"type":"array"},"unassigned":{"type":"object"},"headerWidth":{"type":"number"}},"additionalProperties":true},"columns":{"type":"object","required":["width"],"properties":{"orderBy":{"type":"array"},"appendEmpty":{"type":"boolean","description":"Keep one trailing empty slot beyond the largest group."},"label":{},"width":{"type":"number"}},"additionalProperties":true},"rowHeaderTemplate":{"$ref":"../schemas.json#/definitions/component"},"itemTemplate":{"$ref":"../schemas.json#/definitions/component"},"emptyCellTemplate":{"$ref":"../schemas.json#/definitions/component"},"summaryComponent":{"$ref":"../schemas.json#/definitions/component"},"emptyStateTemplate":{"$ref":"../schemas.json#/definitions/component"},"itemAccent":{},"events":{"type":"object","additionalProperties":{"$ref":"../schemas.json#/definitions/actionsList"}}},"additionalProperties":true}},"additionalProperties":true}

package/schemas/components/progressBar.json

@@ -0,0 +1 @@
+{"$schema":"http://json-schema.org/draft-07/schema#","title":"ProgressBar Component","type":"object","required":["component"],"properties":{"component":{"const":"progressBar"},"name":{"type":"string"},"props":{"type":"object","properties":{"value":{},"max":{},"items":{},"completedPath":{"type":"string"},"completedValue":{},"label":{},"showValue":{"type":"boolean"},"valueFormat":{"enum":["count","percent"]},"variant":{"enum":["linear","circular","segmented"]},"height":{},"size":{},"color":{},"activeColor":{"type":"string","description":"Mobile segmented variant color for completed segments"},"trackColor":{"type":"string","description":"Track or incomplete-segment color"},"tooltip":{},"testID":{"type":"string"}},"additionalProperties":true}},"additionalProperties":true}