@cxtms/cx-schema 1.0.0

package/schemas/components/card.json

@@ -0,0 +1,176 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Card Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "card"
+    },
+    "name": {
+      "type": "string",
+      "description": "Unique name identifier for the card"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "title": {
+          "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }]
+        },
+        "icon": {
+          "type": "string",
+          "description": "Icon class name"
+        },
+        "permission": {
+          "$ref": "../schemas.json#/definitions/permissions"
+        },
+        "className": {
+          "type": "string",
+          "description": "CSS classes for styling"
+        },
+        "toolbar": {
+          "type": "array",
+          "description": "Toolbar components",
+          "items": { "$ref": "../schemas.json#/definitions/component" }
+        },
+        "contextMenu": {
+          "type": "object",
+          "description": "Context menu (3-dots menu) configuration",
+          "properties": {
+            "icon": {
+              "type": "string",
+              "description": "Icon for the menu trigger (default: 'ellipsis-v' or 'more-vert')",
+              "default": "ellipsis-v"
+            },
+            "position": {
+              "type": "string",
+              "enum": ["top-right", "top-left", "bottom-right", "bottom-left"],
+              "description": "Position of the menu icon",
+              "default": "top-right"
+            },
+            "items": {
+              "type": "array",
+              "description": "Menu items to display",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "label": {
+                    "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }],
+                    "description": "Display text for the menu item"
+                  },
+                  "icon": {
+                    "type": "string",
+                    "description": "Optional icon for the menu item"
+                  },
+                  "divider": {
+                    "type": "boolean",
+                    "description": "Show as a divider instead of menu item"
+                  },
+                  "onClick": {
+                    "$ref": "../schemas.json#/definitions/actionsList",
+                    "description": "Actions to execute when item is clicked"
+                  },
+                  "permission": {
+                    "$ref": "../schemas.json#/definitions/permissions",
+                    "description": "Permission required to view this item"
+                  },
+                  "isHidden": {
+                    "$ref": "../schemas.json#/definitions/templateExpression",
+                    "description": "Conditionally hide this menu item"
+                  },
+                  "disabled": {
+                    "$ref": "../schemas.json#/definitions/templateExpression",
+                    "description": "Conditionally disable this menu item"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "onClick": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions to execute when the card is clicked"
+        }
+      }
+    },
+    "children": {
+      "$ref": "../schemas.json#/definitions/componentChildren"
+    }
+  },
+  "required": ["component"],
+  "x-examples": [
+    {
+      "component": "card",
+      "props": {
+        "title": { "en-US": "Primary Contact Information" },
+        "toolbar": [
+          {
+            "component": "button",
+            "props": {
+              "icon": "pen",
+              "onClick": [
+                { "dialog": { "name": "updateContactDialog", "component": { "component": "Contacts/UpdateContact" } } }
+              ]
+            }
+          }
+        ],
+        "contextMenu": {
+          "icon": "ellipsis-v",
+          "position": "top-right",
+          "items": [
+            {
+              "label": { "en-US": "Edit" },
+              "icon": "edit",
+              "onClick": [
+                { "dialog": { "name": "editDialog", "component": { "component": "Contacts/Edit" } } }
+              ]
+            },
+            {
+              "label": { "en-US": "Duplicate" },
+              "icon": "copy",
+              "onClick": [
+                { "action": "duplicate", "params": { "id": "{{ contactId }}" } }
+              ]
+            },
+            {
+              "divider": true
+            },
+            {
+              "label": { "en-US": "Delete" },
+              "icon": "trash",
+              "onClick": [
+                { "confirm": { "message": "Are you sure you want to delete this contact?" } },
+                { "action": "delete", "params": { "id": "{{ contactId }}" } }
+              ],
+              "permission": "contacts.delete"
+            }
+          ]
+        }
+      },
+      "children": [
+        {
+          "component": "layout",
+          "props": { "cols": 2 },
+          "children": [{ "component": "text", "props": { "value": "..." } }]
+        }
+      ]
+    },
+    {
+      "component": "card",
+      "props": {
+        "className": "p-2",
+        "onClick": [{ "navigate": "orders" }]
+      },
+      "children": [
+        {
+          "component": "layout",
+          "props": { "className": "d-flex justify-content-between cursor-pointer p-3", "cols": 0 },
+          "children": [
+            { "component": "icon", "props": { "icon": "briefcase" } },
+            { "component": "text", "props": { "value": { "en-US": "Orders" } } }
+          ]
+        }
+      ]
+    }
+  ]
+}

package/schemas/components/collection.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Collection Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "collection"
+    },
+    "name": {
+      "type": "string",
+      "description": "Collection name identifier"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "items": {
+          "type": "string",
+          "description": "Template expression for items array"
+        },
+        "itemName": {
+          "type": "string",
+          "description": "Variable name for current item in iteration"
+        },
+        "cols": {
+          "type": "integer",
+          "description": "Number of columns for layout"
+        },
+        "orientation": {
+          "type": "string",
+          "enum": ["horizontal", "vertical"],
+          "description": "Layout orientation"
+        },
+        "containerTag": {
+          "type": "string",
+          "description": "HTML container tag"
+        },
+        "className": {
+          "type": "string",
+          "description": "CSS classes for styling"
+        },
+        "childClassName": {
+          "type": "string",
+          "description": "CSS classes for child elements"
+        }
+      },
+      "required": ["items", "itemName"]
+    },
+    "children": {
+      "$ref": "../schemas.json#/definitions/componentChildren"
+    }
+  },
+  "required": ["component", "props"]
+}

package/schemas/components/dataGrid.json

@@ -0,0 +1,119 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "DataGrid Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "dataGrid"
+    },
+    "name": {
+      "type": "string",
+      "description": "Unique name identifier for the dataGrid"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "Input parameters for the dataGrid"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "refreshHandler": {
+          "type": "string",
+          "description": "Name of the refresh handler",
+          "x-example": "states"
+        },
+        "enableStore": {
+          "type": "boolean",
+          "description": "Enable store for the datagrid, row data will be placed in the store"
+        },
+        "views": {
+          "type": "array",
+          "description": "Array of view configurations",
+          "items": {
+            "$ref": "../schemas.json#/definitions/dataGridView"
+          },
+          "x-example": [
+            {
+              "name": "allStates",
+              "displayName": { "en-US": "All States" },
+              "columns": [
+                { "name": "stateCode", "label": { "en-US": "State code" } },
+                { "name": "name", "label": { "en-US": "State Name" } },
+                { "name": "countryCode", "label": { "en-US": "Country code" } },
+                {
+                  "name": "created",
+                  "label": { "en-US": "Created" },
+                  "showAs": { "component": "text", "props": { "value": "{{ format created L }}" } }
+                }
+              ]
+            }
+          ]
+        },
+        "dotsMenu": {
+          "type": "object",
+          "description": "Dots menu configuration for row-level actions",
+          "properties": {
+            "items": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "label": {
+                    "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }]
+                  },
+                  "icon": {
+                    "type": "string",
+                    "description": "Icon name for the menu item"
+                  },
+                  "onClick": {
+                    "$ref": "../schemas.json#/definitions/actionsList"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "options": {
+          "$ref": "../schemas.json#/definitions/dataGridOptions",
+          "x-examples": [
+            {
+              "query": "states",
+              "rootEntityName": "State",
+              "entityKeys": ["countryCode", "stateCode"],
+              "enableDynamicGrid": true,
+              "defaultView": "allStates"
+            },
+            {
+              "query": "allOrderCommodities",
+              "rootEntityName": "OrderCommodity",
+              "entityKeys": ["commodityId"],
+              "navigationType": "store",
+              "enableDynamicGrid": true,
+              "enableViews": false,
+              "enableSearch": true,
+              "enablePagination": true,
+              "defaultView": "commodities"
+            }
+          ]
+        },
+        "toolbar": {
+          "type": "array",
+          "description": "Toolbar components",
+          "items": {
+            "$ref": "../schemas.json#/definitions/component"
+          }
+        },
+        "isHidden": {
+          "$ref": "../schemas.json#/definitions/templateExpression",
+          "description": "Boolean expression for conditional rendering"
+        }
+      },
+      "required": ["options"]
+    },
+    "children": {
+      "$ref": "../schemas.json#/definitions/componentChildren"
+    }
+  },
+  "required": ["component", "name", "props"]
+}

package/schemas/components/datasource.json

@@ -0,0 +1,151 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Datasource Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "datasource"
+    },
+    "name": {
+      "type": "string",
+      "description": "Datasource name identifier",
+      "x-example": "dataSourceCommodities"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Internal name for the datasource",
+          "x-example": "dataSourceCommodities"
+        },
+        "refreshHandler": {
+          "type": "string",
+          "description": "Name of the refresh handler for this datasource",
+          "x-example": "datasourcePickupOptions"
+        },
+        "isHidden": {
+          "$ref": "../schemas.json#/definitions/templateExpression",
+          "description": "Boolean expression for conditional rendering",
+          "x-example": "{{ eval !pickupForm.contactAddressId || !pickupForm.pickupDate }}"
+        },
+        "queries": {
+          "type": "array",
+          "description": "Array of queries or workflows to execute",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Unique name for the query or workflow",
+                "x-example": "commodities"
+              },
+              "query": {
+                "type": "object",
+                "description": "GraphQL query configuration",
+                "properties": {
+                  "command": {
+                    "type": "string",
+                    "description": "GraphQL query string",
+                    "x-example": "query($organizationId: Int!, $filter: String!) { commodities(organizationId: $organizationId, filter: $filter) { items { commodityId description } } }"
+                  },
+                  "path": {
+                    "type": "string",
+                    "description": "Path to extract data from query result",
+                    "x-example": "country"
+                  },
+                  "variables": {
+                    "type": "object",
+                    "description": "Query variables with template expressions",
+                    "additionalProperties": true,
+                    "x-example": {
+                      "organizationId": "{{number organizationId }}",
+                      "filter": "{{string filter }}"
+                    }
+                  },
+                  "mapping": {
+                    "type": "object",
+                    "description": "Optional mapping transformation applied to each item at the resolved path",
+                    "additionalProperties": true,
+                    "x-example": {
+                      "id": "{{ item.commodityId }}",
+                      "text": "{{ item.description }}"
+                    }
+                  }
+                },
+                "required": ["command"],
+                "x-example": {
+                  "command": "query($organizationId: Int!, $filter: String!) { commodities(organizationId: $organizationId, filter: $filter) { items { commodityId description } } }",
+                  "path": "commodities.items",
+                  "variables": {
+                    "organizationId": "{{ number organizationId }}",
+                    "filter": "{{ string filter }}"
+                  },
+                  "mapping": {
+                    "id": "{{ item.commodityId }}",
+                    "text": "{{ item.description }}"
+                  }
+                }
+              },
+              "workflow": {
+                "type": "object",
+                "description": "Workflow execution configuration",
+                "properties": {
+                  "workflowId": {
+                    "type": "string",
+                    "description": "Unique identifier of the workflow to execute",
+                    "x-example": "6563ba2f-1883-4b4e-9fd8-bb431e40c159"
+                  },
+                  "inputs": {
+                    "type": "object",
+                    "description": "Input values for the workflow",
+                    "additionalProperties": true,
+                    "x-example": {
+                      "contactAddressId": "{{ number pickupForm.contactAddressId }}",
+                      "dispatchDate": "{{ format pickupForm.pickupDate YYYY-MM-DD }}"
+                    }
+                  }
+                },
+                "required": ["workflowId"]
+              }
+            },
+            "oneOf": [
+              {
+                "required": ["name", "query"]
+              },
+              {
+                "required": ["name", "workflow"]
+              }
+            ]
+          }
+        },
+        "onSuccess": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions to execute when datasource loads successfully"
+        },
+        "onError": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions to execute when datasource fails to load"
+        },
+        "onLoad": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions to execute when datasource starts loading"
+        },
+        "autoLoad": {
+          "type": "boolean",
+          "description": "Whether to automatically load data when component mounts",
+          "default": true,
+          "x-example": true
+        },
+        "enableStore": {
+          "type": "boolean",
+          "description": "Whether to store loaded data in the application store",
+          "x-example": false
+        }
+      },
+      "required": ["queries"]
+    }
+  },
+  "required": ["component", "name"]
+}

package/schemas/components/dropdown.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Dropdown Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "dropdown"
+    },
+    "name": {
+      "type": "string",
+      "description": "Dropdown name identifier"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }]
+        },
+        "icon": {
+          "type": "string",
+          "description": "Icon class name"
+        },
+        "options": {
+          "type": "object",
+          "properties": {
+            "variant": {
+              "type": "string",
+              "enum": ["primary", "secondary", "outline-primary", "outline-secondary"],
+              "description": "Dropdown variant style"
+            }
+          },
+          "additionalProperties": true
+        },
+        "items": {
+          "type": "array",
+          "description": "Dropdown menu items",
+          "items": {
+            "type": "object",
+            "properties": {
+              "label": {
+                "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }]
+              },
+              "onClick": {
+                "$ref": "../schemas.json#/definitions/actionsList"
+              },
+              "isHidden": {
+                "$ref": "../schemas.json#/definitions/templateExpression"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "required": ["component"]
+}