@cxtms/cx-schema 1.0.0

package/schemas/components/module.json

@@ -0,0 +1,138 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "StoreVista Module",
+  "type": "object",
+  "properties": {
+    "module": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Module name"
+        },
+        "description": {
+          "$ref": "../schemas.json#/definitions/localized"
+        },
+        "appModuleId": {
+          "type": "string",
+          "description": "Unique module identifier (UUID)"
+        },
+        "displayName": {
+          "$ref": "../schemas.json#/definitions/localized"
+        },
+        "application": {
+          "type": "string",
+          "description": "Application name"
+        },
+        "priority": {
+          "type": "integer",
+          "description": "Module priority for override resolution"
+        },
+        "fileName": {
+          "type": "string",
+          "description": "File name/path for the module YAML file in the repository. Creates a direct link to the module definition file location. Default is modules/{name}-module.yaml"
+        }
+      },
+      "required": ["name", "appModuleId", "displayName", "application"]
+    },
+    "components": {
+      "type": "array",
+      "description": "Module components",
+      "items": {
+        "$ref": "../schemas.json#/components/schemas/appComponent"
+      }
+    },
+    "routes": {
+      "type": "array",
+      "description": "Module routes",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Route name"
+          },
+          "path": {
+            "type": "string",
+            "description": "Route path pattern"
+          },
+          "platforms": {
+            "type": "array",
+            "description": "Target platforms for this route",
+            "items": {
+              "type": "string",
+              "enum": ["web", "mobile"]
+            },
+            "default": ["web", "mobile"]
+          },
+          "component": {
+            "type": "string",
+            "description": "Component name to render"
+          },
+          "props": {
+            "type": "object",
+            "description": "Route-specific properties",
+            "properties": {
+              "title": {
+                "$ref": "../schemas.json#/definitions/localized"
+              },
+              "icon": {
+                "type": "string",
+                "description": "Icon class name"
+              },
+              "permission": {
+                "type": "string",
+                "description": "Required permission to access this route"
+              }
+            },
+            "required": ["title"],
+            "additionalProperties": true
+          },
+          "children": {
+            "type": "array",
+            "description": "Child routes",
+            "items": {
+              "$ref": "../schemas.json#"
+            }
+          }
+        },
+        "required": ["name", "path", "component"]
+      }
+    },
+    "entities": {
+      "type": "array",
+      "description": "Module entities",
+      "items": {
+        "$ref": "../schemas.json#/definitions/entity"
+      }
+    },
+    "permissions": {
+      "type": "array",
+      "description": "Module permissions",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Permission name"
+          },
+          "displayName": {
+            "$ref": "../schemas.json#/definitions/localized"
+          },
+          "description": {
+            "$ref": "../schemas.json#/definitions/localized"
+          },
+          "roles": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Roles that have this permission"
+          }
+        },
+        "required": ["name", "roles"]
+      }
+    }
+  },
+  "required": ["module"]
+}

package/schemas/components/navDropdown.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Nav Dropdown Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "navDropdown"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "permission": {
+          "$ref": "../schemas.json#/definitions/permissions"
+        },
+        "label": {
+          "type": "string",
+          "description": "Dropdown label text"
+        },
+        "icon": {
+          "type": "string",
+          "description": "Icon class name"
+        },
+        "isHidden": {
+          "$ref": "../schemas.json#/definitions/templateExpression",
+          "description": "Boolean expression for conditional rendering"
+        }
+      },
+      "required": ["label"]
+    },
+    "children": {
+      "$ref": "../schemas.json#/definitions/componentChildren"
+    }
+  },
+  "required": ["component", "props"]
+}

package/schemas/components/navbar.json

@@ -0,0 +1,78 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Navbar Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "navbar"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "options": {
+          "type": "object",
+          "description": "Additional options for the navbar"
+        },
+        "brand": {
+          "type": "object",
+          "description": "Brand/logo configuration",
+          "properties": {
+            "component": {
+              "type": "string",
+              "description": "Component type for brand"
+            },
+            "name": {
+              "type": "string",
+              "description": "Component name identifier"
+            },
+            "props": {
+              "type": "object",
+              "properties": {
+                "value": {
+                  "type": "string",
+                  "description": "Text value for brand"
+                },
+                "options": {
+                  "type": "object",
+                  "properties": {
+                    "className": {
+                      "type": "string",
+                      "description": "CSS classes for styling"
+                    }
+                  }
+                },
+                "onClick": {
+                  "$ref": "../schemas.json#/definitions/actionsList"
+                },
+                "label": {
+                  "type": "string",
+                  "description": "Label text"
+                },
+                "to": {
+                  "type": "string",
+                  "description": "Navigation URL"
+                }
+              }
+            }
+          }
+        },
+        "items": {
+          "type": "array",
+          "description": "Main navigation items",
+          "items": {
+            "$ref": "../schemas.json#/definitions/component"
+          }
+        },
+        "contextItems": {
+          "type": "array",
+          "description": "Context menu items (e.g., user menu)",
+          "items": {
+            "$ref": "../schemas.json#/definitions/component"
+          }
+        }
+      }
+    }
+  },
+  "required": ["component", "props"]
+}

package/schemas/components/navbarItem.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Navbar Item Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "navbarItem"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "type": "string",
+          "description": "Item label text"
+        },
+        "isHidden": {
+          "$ref": "../schemas.json#/definitions/templateExpression",
+          "description": "Boolean expression for conditional rendering"
+        }
+      }
+    },
+    "children": {
+      "$ref": "../schemas.json#/definitions/componentChildren"
+    }
+  },
+  "required": ["component"]
+}

package/schemas/components/navbarLink.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Navbar Link Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "navbarLink"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "permission": {
+          "$ref": "../schemas.json#/definitions/permissions"
+        },
+        "label": {
+          "type": "string",
+          "description": "Link label text"
+        },
+        "to": {
+          "type": "string",
+          "description": "Navigation URL (supports template variables)"
+        },
+        "isHidden": {
+          "$ref": "../schemas.json#/definitions/templateExpression",
+          "description": "Boolean expression for conditional rendering"
+        },
+        "onClick": {
+          "$ref": "../schemas.json#/definitions/actionsList"
+        }
+      },
+      "required": ["label"]
+    }
+  },
+  "required": ["component", "props"]
+}

package/schemas/components/row.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Row Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "row"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "className": {
+          "type": "string",
+          "description": "CSS classes for styling"
+        },
+        "cols": {
+          "type": "integer",
+          "description": "Number of columns"
+        }
+      }
+    },
+    "children": {
+      "$ref": "../schemas.json#/definitions/componentChildren"
+    },
+    "onClick": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when the row is clicked"
+    }
+  }
+}

package/schemas/components/tab.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Tab Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "tab"
+    },
+    "name": {
+      "type": "string",
+      "description": "Tab name identifier"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }]
+        },
+        "icon": {
+          "type": "string",
+          "description": "Icon class name"
+        },
+        "isHidden": {
+          "$ref": "../schemas.json#/definitions/templateExpression"
+        }
+      }
+    },
+    "children": {
+      "$ref": "../schemas.json#/definitions/componentChildren"
+    }
+  },
+  "required": ["component"]
+}

package/schemas/components/tabs.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Tabs Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "tabs"
+    },
+    "name": {
+      "type": "string",
+      "description": "Tabs name identifier"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "toolbar": {
+          "type": "array",
+          "description": "Toolbar components",
+          "items": {
+            "$ref": "../schemas.json#/definitions/component"
+          }
+        },
+        "defaultTab": {
+          "type": "string",
+          "description": "Default active tab name"
+        }
+      }
+    },
+    "children": {
+      "$ref": "../schemas.json#/definitions/componentChildren"
+    }
+  },
+  "required": ["component"]
+}

package/schemas/components/timeline.json

@@ -0,0 +1,172 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Timeline Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "timeline"
+    },
+    "name": {
+      "type": "string",
+      "description": "Instance name for referencing in actions/variables"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "Input parameters for the timeline"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "orientation": {
+          "type": "string",
+          "enum": ["horizontal", "vertical"],
+          "default": "horizontal",
+          "description": "Timeline axis direction"
+        },
+        "view": {
+          "type": "string",
+          "enum": ["day", "week", "month", "year"],
+          "default": "day",
+          "description": "Zoom level controlling granularity and visible window"
+        },
+        "startDate": {
+          "$ref": "../schemas.json#/definitions/templateExpression",
+          "description": "Initial lower bound for the visible date range (ISO or expression)",
+          "x-example": "{{ today() }}"
+        },
+        "endDate": {
+          "$ref": "../schemas.json#/definitions/templateExpression",
+          "description": "Initial upper bound for the visible date range",
+          "x-example": "{{ addDays today 7 }}"
+        },
+        "defaultDate": {
+          "$ref": "../schemas.json#/definitions/templateExpression",
+          "description": "Initial focal date when no specific range is set",
+          "x-example": "{{ today() }}"
+        },
+        "options": {
+          "type": "object",
+          "description": "Visual/behavioral options for the timeline",
+          "properties": {
+            "height": {
+              "oneOf": [
+                { "type": "number", "description": "Height in pixels" },
+                { "type": "string", "description": "CSS size (e.g., '400px', '50vh')" }
+              ],
+              "default": "400px",
+              "description": "Timeline container height"
+            }
+          }
+        },
+        "eventTemplate": {
+          "$ref": "../schemas.json#/definitions/component",
+          "description": "Component used to render each event; receives 'item' bound to mapped fields"
+        },
+        "eventSources": {
+          "type": "array",
+          "description": "Data providers executed for the current visible range",
+          "items": {
+            "type": "object",
+            "properties": {
+              "query": {
+                "type": "object",
+                "description": "GraphQL source executed when the visible range changes",
+                "properties": {
+                  "command": {
+                    "type": "string",
+                    "description": "GraphQL document string"
+                  },
+                  "variables": {
+                    "type": "object",
+                    "description": "Variables for the GraphQL command (template expressions supported)",
+                    "additionalProperties": true
+                  }
+                },
+                "required": ["command"]
+              },
+              "path": {
+                "type": "string",
+                "description": "Dot path to the array of items in the result (e.g., 'orders.items')"
+              },
+              "mapping": {
+                "type": "object",
+                "description": "Maps source fields to timeline event fields",
+                "properties": {
+                  "date": { "type": "string", "description": "ISO date/time for the event" },
+                  "title": { "type": "string", "description": "Display title" },
+                  "id": {
+                    "oneOf": [{ "type": "string" }, { "type": "number" }],
+                    "description": "Stable identifier"
+                  },
+                  "endDate": { "type": "string", "description": "ISO end date/time for ranged spans" },
+                  "description": { "type": "string" },
+                  "backgroundColor": { "type": "string" },
+                  "textColor": { "type": "string" },
+                  "icon": { "type": "string" },
+                  "iconColor": { "type": "string" },
+                  "iconSize": { "oneOf": [{ "type": "string" }, { "type": "number" }] }
+                },
+                "required": ["date", "title"],
+                "additionalProperties": true,
+                "x-example": {
+                  "id": "{{ item.orderId }}",
+                  "date": "{{ item.orderDate }}",
+                  "endDate": "{{ item.orderEnd }}",
+                  "title": "{{ item.orderNumber }}",
+                  "description": "Order created on {{ item.orderDate }}",
+                  "icon": "package"
+                }
+              }
+            },
+            "required": ["query", "path", "mapping"]
+          }
+        },
+        "isHidden": {
+          "$ref": "../schemas.json#/definitions/templateExpression",
+          "description": "Boolean expression for conditional rendering"
+        }
+      }
+    },
+    "children": {
+      "$ref": "../schemas.json#/definitions/componentChildren"
+    }
+  },
+  "required": ["component", "props"],
+  "x-examples": [
+    {
+      "component": "timeline",
+      "name": "shipmentTimeline",
+      "props": {
+        "orientation": "horizontal",
+        "view": "day",
+        "options": { "height": "360px" },
+        "eventTemplate": {
+          "component": "card",
+          "props": {
+            "title": "{{ item.title }}",
+            "description": "{{ item.description }}"
+          }
+        },
+        "eventSources": [
+          {
+            "query": {
+              "command": "query GetOrders($organizationId: Int!, $filter: String) { orders(organizationId: $organizationId, take: 500, filter: $filter) { items { orderId orderDate orderNumber } } }",
+              "variables": {
+                "organizationId": "{{ number organizationId }}",
+                "filter": "orderDate:[{{startDate}} TO {{endDate}}]"
+              }
+            },
+            "path": "orders.items",
+            "mapping": {
+              "id": "{{ item.orderId }}",
+              "date": "{{ item.orderDate }}",
+              "title": "{{ item.orderNumber }}",
+              "description": "Order created on {{ item.orderDate }}"
+            }
+          }
+        ]
+      }
+    }
+  ]
+}