@cxtms/cx-schema 1.0.0

package/schemas/components/field.json

@@ -0,0 +1,265 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Field Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "field"
+    },
+    "name": {
+      "type": "string",
+      "description": "Field name (form field path)",
+      "x-example": "countryCode"
+    },
+    "props": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }],
+          "x-example": {
+            "en-US": "Country Code"
+          }
+        },
+        "placeholder": {
+          "type": "string",
+          "description": "Field placeholder text",
+          "x-example": "Enter Country Code"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "text",
+            "number",
+            "email",
+            "password",
+            "tel",
+            "url",
+            "date",
+            "datetime",
+            "rangedatetime",
+            "time",
+            "select",
+            "select-async",
+            "autocomplete-googleplaces",
+            "checkbox",
+            "radio",
+            "textarea",
+            "attachment"
+          ],
+          "description": "Field input type",
+          "x-example": "select-async"
+        },
+        "required": {
+          "type": "boolean",
+          "description": "Whether field is required",
+          "x-example": true
+        },
+        "disabled": {
+          "type": "boolean",
+          "description": "Whether field is disabled",
+          "x-example": false
+        },
+        "options": {
+          "type": "object",
+          "description": "Field options for select types",
+          "properties": {
+            "variant": { "type": "string" },
+            "size": { "type": "string" },
+            "allowInlineCreate": { "type": "boolean" },
+            "allowCreate": { "type": "boolean", "description": "Alias for allowInlineCreate" },
+            "allowMultiple": { "type": "boolean" },
+            "allowClear": { "type": "boolean" },
+            "allowSearch": { "type": "boolean" },
+            "placeholder": { "type": "string" },
+            "minWidth": { "type": "string" },
+            "valueFieldName": {
+              "type": "string",
+              "description": "Field name to use as the value for select options",
+              "x-example": "countryCode"
+            },
+            "itemLabelTemplate": {
+              "type": "string",
+              "description": "Template expression for option labels",
+              "x-example": "{{countryName}}"
+            },
+            "itemValueTemplate": {
+              "type": "string",
+              "description": "Template expression for option values",
+              "x-example": "{{countryCode}}"
+            },
+            "navigateActionPermission": {
+              "type": "string",
+              "description": "Permission required for navigation actions",
+              "x-example": "System/Countries/Update"
+            },
+            "searchQuery": {
+              "type": "object",
+              "description": "Query configuration for async search",
+              "properties": {
+                "name": { "type": "string", "x-example": "getCountries" },
+                "path": {
+                  "type": "string",
+                  "description": "Path to data in query result",
+                  "x-example": "countries.items"
+                },
+                "params": {
+                  "type": "object",
+                  "description": "Query parameters",
+                  "additionalProperties": true,
+                  "x-example": {
+                    "search": "{{ string search }}",
+                    "take": "{{ number pageSize }}",
+                    "skip": "{{ number skip }}",
+                    "filter": "{{ string filter }}"
+                  }
+                }
+              }
+            },
+            "valueQuery": {
+              "type": "object",
+              "description": "Query configuration for fetching selected value",
+              "properties": {
+                "name": { "type": "string" },
+                "path": { "type": "string", "description": "Path to data in query result" },
+                "params": { "type": "object", "description": "Query parameters", "additionalProperties": true }
+              }
+            },
+            "defaultValues": {
+              "type": "object",
+              "description": "Default values for the field",
+              "additionalProperties": true
+            }
+          },
+          "additionalProperties": true
+        },
+        "dropDownToolbar": {
+          "type": "array",
+          "description": "Toolbar components for dropdown",
+          "items": { "$ref": "../schemas.json#/definitions/component" }
+        },
+        "queries": {
+          "type": "array",
+          "description": "Field-specific queries for select-async fields",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": { "type": "string" },
+              "query": {
+                "type": "object",
+                "properties": {
+                  "command": { "type": "string" },
+                  "variables": { "type": "object", "additionalProperties": true }
+                }
+              }
+            }
+          }
+        },
+        "onEditClick": { "$ref": "../schemas.json#/definitions/actionsList" },
+        "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",
+          "items": {
+            "type": "object",
+            "properties": {
+              "label": { "type": "string" },
+              "value": { "oneOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }] }
+            },
+            "required": ["label", "value"]
+          }
+        },
+        "transformValue": {
+          "type": "object",
+          "description": "Value transformation configuration",
+          "properties": {
+            "onLoad": { "type": "string", "description": "Template expression to transform value on load" },
+            "onChange": { "type": "string", "description": "Template expression to transform value on change" },
+            "onBlur": { "type": "string", "description": "Template expression to transform value on blur" }
+          }
+        },
+        "onChange": { "$ref": "../schemas.json#/definitions/actionsList" },
+        "onBlur": { "$ref": "../schemas.json#/definitions/actionsList" },
+        "onFocus": { "$ref": "../schemas.json#/definitions/actionsList" },
+        "onSelectValue": {
+          "$ref": "../schemas.json#/definitions/actionsList",
+          "description": "Actions to execute when a value is selected in select-async fields"
+        }
+      }
+    }
+  },
+  "allOf": [
+    {
+      "if": { "properties": { "props": { "properties": { "type": { "const": "select" } } } } },
+      "then": { "properties": { "props": { "required": ["items"] } } }
+    }
+  ],
+  "required": ["component", "name"],
+  "x-examples": [
+    {
+      "component": "field",
+      "name": "calendarType",
+      "props": {
+        "label": { "en-US": "Calendar Type" },
+        "type": "select",
+        "options": { "placeholder": "Select Calendar Type" },
+        "items": [
+          { "label": "Standard", "value": "Standard" },
+          { "label": "Resource", "value": "Resource" },
+          { "label": "Personal", "value": "Personal" }
+        ]
+      }
+    },
+    {
+      "component": "field",
+      "name": "countryId",
+      "props": {
+        "label": { "en-US": "Country" },
+        "type": "select-async",
+        "options": {
+          "allowSearch": true,
+          "allowClear": true,
+          "searchQuery": {
+            "name": "getCountries",
+            "path": "countries.items",
+            "params": {
+              "search": "{{ string search }}",
+              "take": "{{ number pageSize }}",
+              "skip": "{{ number skip }}",
+              "filter": "{{ string filter }}"
+            }
+          }
+        }
+      }
+    },
+    {
+      "component": "field",
+      "name": "tags",
+      "props": {
+        "label": { "en-US": "Tags" },
+        "type": "select-async",
+        "onOptionTagClick": [
+          {
+            "dialog": {
+              "name": "editTagDialog",
+              "props": { "title": { "en-US": "Edit Tag" } },
+              "component": { "component": "layout", "children": [{ "component": "Tags/EditTag" }] }
+            }
+          }
+        ]
+      }
+    },
+    {
+      "component": "field",
+      "name": "description",
+      "props": {
+        "label": { "en-US": "Description" },
+        "type": "text",
+        "placeholder": "Enter description"
+      }
+    }
+  ]
+}

package/schemas/components/form.json

@@ -0,0 +1,234 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "form"
+    },
+    "name": {
+      "type": "string",
+      "description": "Form name identifier",
+      "x-example": "countryForm"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "Input parameters for the form",
+      "additionalProperties": true,
+      "x-example": {}
+    },
+    "props": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "title": {
+          "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }],
+          "x-example": {
+            "en-US": "Country"
+          }
+        },
+        "cols": {
+          "type": "integer",
+          "description": "Number of columns for form layout",
+          "x-example": 2
+        },
+        "orientation": {
+          "type": "string",
+          "enum": ["horizontal", "vertical"],
+          "description": "Form layout orientation",
+          "x-example": "vertical"
+        },
+        "initialValues": {
+          "type": "object",
+          "description": "Initial form values",
+          "properties": {
+            "fromQuery": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "description": "Query name to fetch initial values",
+                  "x-example": "getCountry"
+                },
+                "path": {
+                  "type": "string",
+                  "description": "Path to data in query result",
+                  "x-example": "country"
+                }
+              },
+              "required": ["name", "path"],
+              "x-example": {
+                "name": "getCountry",
+                "path": "country"
+              }
+            },
+            "append": {
+              "type": "object",
+              "description": "Additional values to append",
+              "additionalProperties": true,
+              "x-example": {
+                "customValues": {},
+                "isActive": true
+              }
+            }
+          },
+          "additionalProperties": true
+        },
+        "queries": {
+          "type": "array",
+          "description": "Form-associated queries",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Unique name for the query",
+                "x-example": "getCountry"
+              },
+              "query": {
+                "type": "object",
+                "properties": {
+                  "command": {
+                    "type": "string",
+                    "description": "GraphQL query string"
+                  },
+                  "variables": {
+                    "type": "object",
+                    "description": "Query variables with template expressions",
+                    "additionalProperties": true
+                  }
+                },
+                "required": ["command"]
+              }
+            },
+            "required": ["name", "query"]
+          }
+        },
+        "validationSchema": {
+          "type": "object",
+          "description": "Form-level validation schema",
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": ["string", "number", "boolean", "array", "object"]
+              },
+              "required": {
+                "oneOf": [
+                  { "type": "boolean" },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "message": { "type": "string" }
+                    }
+                  }
+                ]
+              },
+              "min": {
+                "type": "object",
+                "properties": {
+                  "length": { "type": "number" },
+                  "message": { "type": "string" }
+                }
+              },
+              "max": {
+                "type": "object",
+                "properties": {
+                  "length": { "type": "number" },
+                  "message": { "type": "string" }
+                }
+              },
+              "nullable": {
+                "type": "boolean"
+              },
+              "schema": {
+                "type": "object",
+                "description": "Nested schema for object types",
+                "additionalProperties": true
+              }
+            }
+          }
+        },
+        "autoSave": {
+          "type": "boolean",
+          "description": "Enable automatic form saving"
+        },
+        "resetOnSubmit": {
+          "type": "boolean",
+          "description": "Reset form values after successful submission"
+        },
+        "dirtyGuard": {
+          "type": "object",
+          "description": "Configuration for unsaved changes warning dialog",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "description": "Enables or disables the dirty guard feature"
+            },
+            "title": {
+              "$ref": "../schemas.json#/definitions/localized",
+              "description": "Localized dialog title"
+            },
+            "message": {
+              "$ref": "../schemas.json#/definitions/localized",
+              "description": "Localized dialog message explaining the warning"
+            },
+            "confirmLabel": {
+              "$ref": "../schemas.json#/definitions/localized",
+              "description": "Localized confirm button text"
+            },
+            "cancelLabel": {
+              "$ref": "../schemas.json#/definitions/localized",
+              "description": "Localized cancel button text"
+            },
+            "onConfirm": {
+              "$ref": "../schemas.json#/definitions/actionsList",
+              "description": "Actions to execute when user confirms leaving (discards changes)"
+            },
+            "onCancel": {
+              "$ref": "../schemas.json#/definitions/actionsList",
+              "description": "Actions to execute when user cancels and stays on the page"
+            }
+          },
+          "x-example": {
+            "enabled": true,
+            "title": { "en-US": "Unsaved Changes" },
+            "message": { "en-US": "You have unsaved changes. Are you sure you want to leave?" },
+            "confirmLabel": { "en-US": "Leave" },
+            "cancelLabel": { "en-US": "Stay" }
+          }
+        },
+        "preventDefault": {
+          "type": "boolean",
+          "description": "Prevent default form submission behavior"
+        },
+        "isHidden": {
+          "$ref": "../schemas.json#/definitions/templateExpression",
+          "description": "Boolean expression for conditional rendering"
+        },
+        "onSubmit": {
+          "$ref": "../schemas.json#/definitions/actionsList"
+        },
+        "onLoad": {
+          "$ref": "../schemas.json#/definitions/actionsList"
+        },
+        "onReset": {
+          "$ref": "../schemas.json#/definitions/actionsList"
+        },
+        "onValidate": {
+          "$ref": "../schemas.json#/definitions/actionsList"
+        },
+        "onError": {
+          "$ref": "../schemas.json#/definitions/actionsList"
+        }
+      },
+      "required": ["validationSchema"]
+    },
+    "children": {
+      "$ref": "../schemas.json#/definitions/componentChildren"
+    }
+  },
+  "required": ["component", "name"]
+}

package/schemas/components/index.json

@@ -0,0 +1,68 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Component Schemas Index",
+  "description": "Index of all available CargoXplorer component schemas",
+  "type": "object",
+  "definitions": {
+    "appComponent": {
+      "$ref": "appComponent.json"
+    },
+    "navbar": {
+      "$ref": "navbar.json"
+    },
+    "navbarItem": {
+      "$ref": "navbarItem.json"
+    },
+    "navDropdown": {
+      "$ref": "navDropdown.json"
+    },
+    "navbarLink": {
+      "$ref": "navbarLink.json"
+    },
+    "collection": {
+      "$ref": "collection.json"
+    },
+    "row": {
+      "$ref": "row.json"
+    },
+    "dataGrid": {
+      "$ref": "dataGrid.json"
+    },
+    "card": {
+      "$ref": "card.json"
+    },
+    "barcodeScanner": {
+      "$ref": "barcodeScanner.json"
+    },
+    "button": {
+      "$ref": "button.json"
+    },
+    "form": {
+      "$ref": "form.json"
+    },
+    "layout": {
+      "$ref": "layout.json"
+    },
+    "tabs": {
+      "$ref": "tabs.json"
+    },
+    "tab": {
+      "$ref": "tab.json"
+    },
+    "field": {
+      "$ref": "field.json"
+    },
+    "dropdown": {
+      "$ref": "dropdown.json"
+    },
+    "datasource": {
+      "$ref": "datasource.json"
+    },
+    "calendar": {
+      "$ref": "calendar.json"
+    },
+    "module": {
+      "$ref": "module.json"
+    }
+  }
+}

package/schemas/components/layout.json

@@ -0,0 +1,69 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Layout Component",
+  "type": "object",
+  "properties": {
+    "component": {
+      "type": "string",
+      "const": "layout"
+    },
+    "name": {
+      "type": "string",
+      "description": "Layout name identifier"
+    },
+    "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"
+        },
+        "cols": {
+          "type": "integer",
+          "description": "Number of columns"
+        },
+        "orientation": {
+          "type": "string",
+          "enum": ["horizontal", "vertical"],
+          "description": "Layout orientation"
+        },
+        "toolbar": {
+          "type": "array",
+          "description": "Toolbar components",
+          "items": {
+            "$ref": "../schemas.json#/definitions/component"
+          }
+        }
+      }
+    },
+    "inputs": {
+      "type": "array",
+      "description": "Layout input parameters",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "type": {
+            "type": "string"
+          },
+          "props": {
+            "type": "object",
+            "additionalProperties": true
+          }
+        }
+      }
+    },
+    "children": {
+      "$ref": "../schemas.json#/definitions/componentChildren"
+    }
+  },
+  "required": ["component"]
+}