@cxtms/cx-schema 1.0.0

package/schemas/fields/rangedatetime.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "DateTime Range Field Type",
+  "description": "Schema for rangedatetime input field type",
+  "type": "object",
+  "properties": {
+    "type": { "type": "string", "const": "rangedatetime" },
+    "label": {
+      "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }],
+      "description": "Field label",
+      "x-example": { "en-US": "Delivery Window" }
+    },
+    "placeholder": { "type": "string", "description": "Field placeholder text", "x-example": "Select date range" },
+    "required": { "type": "boolean", "description": "Whether field is required", "x-example": false },
+    "disabled": { "type": "boolean", "description": "Whether field is disabled", "x-example": false },
+    "options": {
+      "type": "object",
+      "description": "DateTime range configuration options",
+      "properties": {
+        "dateFormat": { "type": "string", "description": "Display format", "x-example": "MM/dd/yyyy h:mm aa" },
+        "showTimeSelect": { "type": "boolean", "description": "Show time selection", "x-example": true },
+        "showTimeSelectOnly": { "type": "boolean", "description": "Time only (no date)", "x-example": false },
+        "timeIntervals": { "type": "number", "description": "Time intervals in minutes", "x-example": 60 },
+        "timeCaption": { "type": "string", "description": "Time caption label", "x-example": "Time" },
+        "useTimezone": { "type": "boolean", "description": "Enable timezone-aware handling", "x-example": false },
+        "storeAsUTC": { "type": "boolean", "description": "When useTimezone is true, store in UTC", "x-example": true },
+        "timezone": { "type": "string", "description": "Fixed timezone for display", "x-example": "America/New_York" },
+        "format": { "type": "string", "description": "Custom storage format" },
+        "isClearable": { "type": "boolean", "description": "Show clear button", "x-example": true }
+      },
+      "additionalProperties": true
+    },
+    "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",
+      "description": "Actions to execute when field value changes"
+    },
+    "onBlur": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field loses focus"
+    },
+    "onFocus": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field gains focus"
+    }
+  },
+  "required": ["type"]
+}

package/schemas/fields/select-async.json

@@ -0,0 +1,334 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Select Async Field Type",
+  "description": "Schema for select-async field type with GraphQL query support",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "select-async"
+    },
+    "label": {
+      "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }],
+      "description": "Field label",
+      "x-example": {
+        "en-US": "Select Order"
+      }
+    },
+    "placeholder": {
+      "type": "string",
+      "description": "Field placeholder text",
+      "x-example": "Search and select an order"
+    },
+    "required": {
+      "type": "boolean",
+      "description": "Whether field is required",
+      "x-example": false
+    },
+    "disabled": {
+      "type": "boolean",
+      "description": "Whether field is disabled",
+      "x-example": false
+    },
+    "options": {
+      "type": "object",
+      "description": "Select-async specific options",
+      "properties": {
+        "valueFieldName": {
+          "type": "string",
+          "description": "Field name to use as the value for select options",
+          "x-example": "orderId"
+        },
+        "itemLabelTemplate": {
+          "type": "string",
+          "description": "Template expression for option labels",
+          "x-example": "{{eval `Id ${orderId} - ${trackingNumber ? `Tracking Number ${trackingNumber}` : `Order Number ${orderNumber}`} - ${orderType}` }}"
+        },
+        "itemValueTemplate": {
+          "type": "string",
+          "description": "Template expression for option values",
+          "x-example": "{{orderId}}"
+        },
+        "navigateActionPermission": {
+          "type": "string",
+          "description": "Permission required for navigation actions",
+          "x-example": "System/Orders/Update"
+        },
+        "searchQuery": {
+          "type": "object",
+          "description": "Query configuration for async search",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Query name",
+              "x-example": "getOrders"
+            },
+            "path": {
+              "type": "string",
+              "description": "Path to data in query result",
+              "x-example": "orders.items"
+            },
+            "params": {
+              "type": "object",
+              "description": "Query parameters with template expressions",
+              "additionalProperties": true,
+              "x-example": {
+                "search": "{{ string search }}",
+                "take": "{{ number pageSize }}",
+                "skip": "{{ number skip }}",
+                "filter": "{{ string filter }}"
+              }
+            }
+          },
+          "required": ["name", "path"]
+        },
+        "valueQuery": {
+          "type": "object",
+          "description": "Query configuration for fetching selected value details",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Query name"
+            },
+            "path": {
+              "type": "string",
+              "description": "Path to data in query result"
+            },
+            "params": {
+              "type": "object",
+              "description": "Query parameters",
+              "additionalProperties": true
+            }
+          },
+          "required": ["name", "path"],
+          "x-example": {
+            "name": "getOrder",
+            "path": "order",
+            "params": {
+              "orderId": "{{ orderId }}"
+            }
+          }
+        },
+        "allowMultiple": {
+          "type": "boolean",
+          "description": "Allow multiple selection",
+          "x-example": false
+        },
+        "allowClear": {
+          "type": "boolean",
+          "description": "Allow clearing selection",
+          "x-example": true
+        },
+        "allowSearch": {
+          "type": "boolean",
+          "description": "Enable search functionality",
+          "x-example": true
+        },
+        "minWidth": {
+          "type": "string",
+          "description": "Minimum width for the dropdown",
+          "x-example": "300px"
+        },
+        "prefix": {
+          "type": "string",
+          "description": "Prefix for form field names, used in dynamic forms",
+          "x-example": "orderEntityCarriers[{{carrierIndex}}]."
+        },
+        "filter": {
+          "type": "string",
+          "description": "Filter expression for search queries",
+          "x-example": "contactType: Carrier"
+        },
+        "allowCreate": {
+          "type": "boolean",
+          "description": "Allow creating new items inline",
+          "x-example": true
+        },
+        "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"
+            }
+          }
+        }
+      },
+      "required": ["searchQuery"]
+    },
+    "dropDownToolbar": {
+      "type": "array",
+      "description": "Toolbar components for dropdown (create buttons, etc)",
+      "items": {
+        "$ref": "../schemas.json#/definitions/component"
+      },
+      "x-example": [
+        {
+          "component": "button",
+          "name": "createBtn",
+          "props": {
+            "permission": "System/Orders/Create",
+            "label": {
+              "en-US": "Create New Order"
+            },
+            "icon": "plus",
+            "options": {
+              "className": "create-entity-select-btn btn btn-sm btn-primary w-100",
+              "variant": "primary"
+            },
+            "onClick": [
+              {
+                "dialog": {
+                  "component": "Orders/CreateOrder",
+                  "props": {
+                    "title": "Create New Order"
+                  },
+                  "onClose": [{ "selectValue": "{{ result }}" }]
+                }
+              }
+            ]
+          }
+        }
+      ]
+    },
+    "queries": {
+      "type": "array",
+      "description": "GraphQL queries for the field",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Query name"
+          },
+          "query": {
+            "type": "object",
+            "properties": {
+              "command": {
+                "type": "string",
+                "description": "GraphQL query string"
+              },
+              "variables": {
+                "type": "object",
+                "description": "Query variables",
+                "additionalProperties": true
+              }
+            },
+            "required": ["command"]
+          }
+        },
+        "required": ["name", "query"]
+      },
+      "x-example": [
+        {
+          "name": "getOrders",
+          "query": {
+            "command": "query($organizationId: Int!, $filter: String!, $search: String!, $take: Int!, $skip: Int!) { orders(organizationId: $organizationId, filter: $filter, search: $search, take: $take, skip: $skip) { items { orderId orderNumber trackingNumber orderType } totalCount } }",
+            "variables": {
+              "organizationId": "{{number organizationId}}",
+              "search": "{{string search}}",
+              "take": "{{number pageSize}}",
+              "skip": "{{number skip}}",
+              "filter": "{{ string filter }}"
+            }
+          }
+        }
+      ]
+    },
+    "onSelectValue": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when a value is selected",
+      "x-example": [
+        {
+          "setStore": {
+            "orderForm.selectedOrder": "{{eval {...selectedItem} }}"
+          }
+        },
+        {
+          "setFields": {
+            "orderNumber": "{{ selectedItem.orderNumber }}",
+            "trackingNumber": "{{ selectedItem.trackingNumber }}"
+          }
+        }
+      ]
+    },
+    "onChange": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field value changes"
+    },
+    "onBlur": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field loses focus"
+    },
+    "onFocus": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field gains focus"
+    },
+    "onOptionTagClick": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when clicking on an option tag/chip in the dropdown",
+      "x-example": [
+        {
+          "dialog": {
+            "props": {
+              "organizationId": "{{ organizationId }}",
+              "jobId": "{{ item.jobId }}",
+              "title": {
+                "en-US": "Update Job"
+              }
+            },
+            "component": {
+              "layout": {
+                "component": "layout",
+                "children": [{ "component": "Jobs/UpdateJob" }]
+              }
+            }
+          }
+        }
+      ]
+    },
+    "onEditClick": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when edit action is clicked",
+      "x-example": [
+        {
+          "dialog": {
+            "props": {
+              "organizationId": "{{ organizationId }}",
+              "countryCode": "{{ countryCode }}",
+              "title": {
+                "en-US": "Update Country"
+              }
+            },
+            "component": {
+              "layout": {
+                "component": "layout",
+                "children": [{ "component": "Countries/UpdateCountry" }]
+              }
+            }
+          }
+        }
+      ]
+    },
+    "filter": {
+      "type": "string",
+      "description": "Filter expression applied to queries",
+      "x-example": "contactType: Contact"
+    },
+    "className": {
+      "type": "string",
+      "description": "CSS class names for the field",
+      "x-example": "col-3"
+    }
+  },
+  "required": ["type", "options"]
+}

package/schemas/fields/select.json

@@ -0,0 +1,115 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Select Field Type",
+  "description": "Schema for select field type with static options",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "select"
+    },
+    "label": {
+      "oneOf": [
+        { "type": "string" },
+        { "$ref": "../schemas.json#/definitions/localized" }
+      ],
+      "description": "Field label",
+      "x-example": {
+        "en-US": "Country"
+      }
+    },
+    "placeholder": {
+      "type": "string",
+      "description": "Field placeholder text",
+      "x-example": "Select a country"
+    },
+    "required": {
+      "type": "boolean",
+      "description": "Whether field is required",
+      "x-example": false
+    },
+    "disabled": {
+      "type": "boolean",
+      "description": "Whether field is disabled",
+      "x-example": false
+    },
+    "options": {
+      "type": "object",
+      "description": "Select field options",
+      "properties": {
+        "allowMultiple": {
+          "type": "boolean",
+          "description": "Allow multiple selection",
+          "x-example": false
+        },
+        "allowClear": {
+          "type": "boolean",
+          "description": "Allow clearing selection",
+          "x-example": true
+        },
+        "variant": {
+          "type": "string",
+          "description": "Visual variant of the select",
+          "x-example": "outlined"
+        },
+        "size": {
+          "type": "string",
+          "description": "Size of the select component",
+          "x-example": "medium"
+        }
+      }
+    },
+    "items": {
+      "type": "array",
+      "description": "Static options for select field",
+      "items": {
+        "type": "object",
+        "properties": {
+          "label": {
+            "oneOf": [
+              { "type": "string" },
+              { "$ref": "../schemas.json#/definitions/localized" }
+            ],
+            "description": "Option label"
+          },
+          "value": {
+            "oneOf": [
+              { "type": "string" },
+              { "type": "number" },
+              { "type": "boolean" }
+            ],
+            "description": "Option value"
+          }
+        },
+        "required": ["label", "value"]
+      },
+      "x-example": [
+        {
+          "label": { "en-US": "United States" },
+          "value": "US"
+        },
+        {
+          "label": { "en-US": "Canada" },
+          "value": "CA"
+        },
+        {
+          "label": { "en-US": "Mexico" },
+          "value": "MX"
+        }
+      ]
+    },
+    "onChange": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field value changes"
+    },
+    "onBlur": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field loses focus"
+    },
+    "onFocus": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field gains focus"
+    }
+  },
+  "required": ["type"]
+}

package/schemas/fields/tel.json

@@ -0,0 +1,79 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Tel Field Type",
+  "description": "Schema for telephone input field type",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "tel"
+    },
+    "label": {
+      "oneOf": [
+        { "type": "string" },
+        { "$ref": "../schemas.json#/definitions/localized" }
+      ],
+      "description": "Field label",
+      "x-example": {
+        "en-US": "Phone Number"
+      }
+    },
+    "placeholder": {
+      "type": "string",
+      "description": "Field placeholder text",
+      "x-example": "(555) 123-4567"
+    },
+    "required": {
+      "type": "boolean",
+      "description": "Whether field is required",
+      "x-example": false
+    },
+    "disabled": {
+      "type": "boolean",
+      "description": "Whether field is disabled",
+      "x-example": false
+    },
+    "pattern": {
+      "type": "string",
+      "description": "Regex pattern for phone number validation",
+      "x-example": "^\\+?[1-9]\\d{1,14}$"
+    },
+    "format": {
+      "type": "string",
+      "description": "Phone number format mask",
+      "x-example": "(999) 999-9999"
+    },
+    "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",
+          "x-example": "{{ eval value.replace(/\\D/g, '') }}"
+        },
+        "onBlur": {
+          "type": "string",
+          "description": "Template expression to transform value on blur"
+        }
+      }
+    },
+    "onChange": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field value changes"
+    },
+    "onBlur": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field loses focus"
+    },
+    "onFocus": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field gains focus"
+    }
+  },
+  "required": ["type"]
+}

package/schemas/fields/text.json

@@ -0,0 +1,86 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Text Field Type",
+  "description": "Schema for text input field type",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "text"
+    },
+    "label": {
+      "oneOf": [
+        { "type": "string" },
+        { "$ref": "../schemas.json#/definitions/localized" }
+      ],
+      "description": "Field label",
+      "x-example": {
+        "en-US": "Full Name"
+      }
+    },
+    "placeholder": {
+      "type": "string",
+      "description": "Field placeholder text",
+      "x-example": "Enter your full name"
+    },
+    "required": {
+      "type": "boolean",
+      "description": "Whether field is required",
+      "x-example": true
+    },
+    "disabled": {
+      "type": "boolean",
+      "description": "Whether field is disabled",
+      "x-example": false
+    },
+    "maxLength": {
+      "type": "number",
+      "description": "Maximum character length",
+      "x-example": 255
+    },
+    "minLength": {
+      "type": "number",
+      "description": "Minimum character length",
+      "x-example": 2
+    },
+    "pattern": {
+      "type": "string",
+      "description": "Regex pattern for validation",
+      "x-example": "^[a-zA-Z\\s]+$"
+    },
+    "transformValue": {
+      "type": "object",
+      "description": "Value transformation configuration",
+      "properties": {
+        "onLoad": {
+          "type": "string",
+          "description": "Template expression to transform value on load",
+          "x-example": "{{ format orderForm.orderSummary.totalIncome currency USD }}"
+        },
+        "onChange": {
+          "type": "string", 
+          "description": "Template expression to transform value on change",
+          "x-example": "{{ eval value.toUpperCase() }}"
+        },
+        "onBlur": {
+          "type": "string",
+          "description": "Template expression to transform value on blur",
+          "x-example": "{{ eval value.trim() }}"
+        }
+      }
+    },
+    "onChange": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field value changes"
+    },
+    "onBlur": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field loses focus"
+    },
+    "onFocus": {
+      "$ref": "../schemas.json#/definitions/actionsList",
+      "description": "Actions to execute when field gains focus"
+    }
+  },
+  "required": ["type"]
+}