@cxtms/cx-schema 1.0.0

package/schemas/fields/checkbox.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Checkbox Field Type",
+  "description": "Schema for checkbox input field type",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "checkbox"
+    },
+    "label": {
+      "oneOf": [
+        { "type": "string" },
+        { "$ref": "../schemas.json#/definitions/localized" }
+      ],
+      "description": "Field label",
+      "x-example": {
+        "en-US": "I agree to the terms"
+      }
+    },
+    "required": {
+      "type": "boolean",
+      "description": "Whether field is required",
+      "x-example": false
+    },
+    "disabled": {
+      "type": "boolean",
+      "description": "Whether field is disabled",
+      "x-example": false
+    },
+    "defaultChecked": {
+      "type": "boolean",
+      "description": "Default checked state",
+      "x-example": false
+    },
+    "value": {
+      "oneOf": [
+        { "type": "string" },
+        { "type": "number" },
+        { "type": "boolean" }
+      ],
+      "description": "Value when checked",
+      "x-example": true
+    },
+    "uncheckedValue": {
+      "oneOf": [
+        { "type": "string" },
+        { "type": "number" },
+        { "type": "boolean" }
+      ],
+      "description": "Value when unchecked",
+      "x-example": false
+    },
+    "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"
+        }
+      }
+    },
+    "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/date.json

@@ -0,0 +1,88 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Date Field Type",
+  "description": "Schema for date input field type",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "date"
+    },
+    "timezone": {
+      "type": "string",
+      "description": "Timezone identifier (e.g., America/New_York)",
+      "x-example": "America/New_York"
+    },
+    "label": {
+      "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }],
+      "description": "Field label",
+      "x-example": {
+        "en-US": "Order Date"
+      }
+    },
+    "placeholder": {
+      "type": "string",
+      "description": "Field placeholder text",
+      "x-example": "Select date"
+    },
+    "required": {
+      "type": "boolean",
+      "description": "Whether field is required",
+      "x-example": true
+    },
+    "disabled": {
+      "type": "boolean",
+      "description": "Whether field is disabled",
+      "x-example": false
+    },
+    "min": {
+      "type": "string",
+      "format": "date",
+      "description": "Minimum date (YYYY-MM-DD)",
+      "x-example": "2024-01-01"
+    },
+    "max": {
+      "type": "string",
+      "format": "date",
+      "description": "Maximum date (YYYY-MM-DD)",
+      "x-example": "2025-12-31"
+    },
+    "format": {
+      "type": "string",
+      "description": "Date display format",
+      "x-example": "MM/DD/YYYY"
+    },
+    "transformValue": {
+      "type": "object",
+      "description": "Value transformation configuration",
+      "properties": {
+        "onLoad": {
+          "type": "string",
+          "description": "Template expression to transform value on load",
+          "x-example": "{{ format value 'YYYY-MM-DD' }}"
+        },
+        "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/datetime.json

@@ -0,0 +1,75 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "DateTime Field Type",
+  "description": "Schema for datetime input field type",
+  "type": "object",
+  "properties": {
+    "type": { "type": "string", "const": "datetime" },
+    "label": {
+      "oneOf": [{ "type": "string" }, { "$ref": "../schemas.json#/definitions/localized" }],
+      "description": "Field label",
+      "x-example": { "en-US": "Appointment Time" }
+    },
+    "placeholder": { "type": "string", "description": "Field placeholder text", "x-example": "Select date/time" },
+    "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 configuration options",
+      "properties": {
+        "dateFormat": {
+          "type": "string",
+          "description": "Display format for the date/time",
+          "x-example": "MM/dd/yyyy h:mm aa"
+        },
+        "showTimeSelect": {
+          "type": "boolean",
+          "description": "Show time selection in addition to date",
+          "x-example": true
+        },
+        "showTimeSelectOnly": {
+          "type": "boolean",
+          "description": "Show only a time picker without date",
+          "x-example": false
+        },
+        "timeIntervals": { "type": "number", "description": "Time selection intervals in minutes", "x-example": 30 },
+        "timeCaption": { "type": "string", "description": "Label displayed for the time section", "x-example": "Time" },
+        "useTimezone": { "type": "boolean", "description": "Enable timezone-aware date handling", "x-example": false },
+        "storeAsUTC": {
+          "type": "boolean",
+          "description": "When useTimezone is true, store date/time in UTC",
+          "x-example": true
+        },
+        "timezone": {
+          "type": "string",
+          "description": "Fixed timezone for display (e.g., America/New_York)",
+          "x-example": "America/New_York"
+        },
+        "format": { "type": "string", "description": "Custom storage format; if omitted, inferred by options" }
+      },
+      "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/email.json

@@ -0,0 +1,75 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Email Field Type",
+  "description": "Schema for email input field type",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "email"
+    },
+    "label": {
+      "oneOf": [
+        { "type": "string" },
+        { "$ref": "../schemas.json#/definitions/localized" }
+      ],
+      "description": "Field label",
+      "x-example": {
+        "en-US": "Email Address"
+      }
+    },
+    "placeholder": {
+      "type": "string",
+      "description": "Field placeholder text",
+      "x-example": "Enter email address"
+    },
+    "required": {
+      "type": "boolean",
+      "description": "Whether field is required",
+      "x-example": true
+    },
+    "disabled": {
+      "type": "boolean",
+      "description": "Whether field is disabled",
+      "x-example": false
+    },
+    "pattern": {
+      "type": "string",
+      "description": "Custom email validation pattern",
+      "x-example": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
+    },
+    "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.toLowerCase().trim() }}"
+        },
+        "onBlur": {
+          "type": "string",
+          "description": "Template expression to transform value on blur",
+          "x-example": "{{ eval value.toLowerCase().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"]
+}

package/schemas/fields/index.json

@@ -0,0 +1,53 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Field Types Index",
+  "description": "Index of all available field types for CargoXplorer TMS",
+  "definitions": {
+    "fieldType": {
+      "oneOf": [
+        { "$ref": "./text.json" },
+        { "$ref": "./number.json" },
+        { "$ref": "./email.json" },
+        { "$ref": "./password.json" },
+        { "$ref": "./tel.json" },
+        { "$ref": "./url.json" },
+        { "$ref": "./date.json" },
+        { "$ref": "./datetime.json" },
+        { "$ref": "./rangedatetime.json" },
+        { "$ref": "./time.json" },
+        { "$ref": "./select.json" },
+        { "$ref": "./select-async.json" },
+        { "$ref": "./autocomplete-googleplaces.json" },
+        { "$ref": "./checkbox.json" },
+        { "$ref": "./radio.json" },
+        { "$ref": "./textarea.json" },
+        { "$ref": "./attachment.json" }
+      ]
+    }
+  },
+  "fieldTypes": {
+    "text": { "description": "Basic text input field", "schema": "./text.json" },
+    "number": { "description": "Numeric input field with validation", "schema": "./number.json" },
+    "email": { "description": "Email input field with validation", "schema": "./email.json" },
+    "password": { "description": "Password input field with security features", "schema": "./password.json" },
+    "tel": { "description": "Telephone number input field", "schema": "./tel.json" },
+    "url": { "description": "URL input field with validation", "schema": "./url.json" },
+    "date": { "description": "Date picker field", "schema": "./date.json" },
+    "datetime": { "description": "Date/time picker field with timezone options", "schema": "./datetime.json" },
+    "rangedatetime": { "description": "Date/time range picker field", "schema": "./rangedatetime.json" },
+    "time": { "description": "Time picker field", "schema": "./time.json" },
+    "select": { "description": "Dropdown select field with static options", "schema": "./select.json" },
+    "select-async": {
+      "description": "Async dropdown select field with GraphQL queries",
+      "schema": "./select-async.json"
+    },
+    "autocomplete-googleplaces": {
+      "description": "Google Places autocomplete field for addresses",
+      "schema": "./autocomplete-googleplaces.json"
+    },
+    "checkbox": { "description": "Checkbox input field", "schema": "./checkbox.json" },
+    "radio": { "description": "Radio button group field", "schema": "./radio.json" },
+    "textarea": { "description": "Multi-line text input field", "schema": "./textarea.json" },
+    "attachment": { "description": "Attachment picker/uploader field (images or files)", "schema": "./attachment.json" }
+  }
+}

package/schemas/fields/number.json

@@ -0,0 +1,91 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Number Field Type",
+  "description": "Schema for number input field type",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "number"
+    },
+    "label": {
+      "oneOf": [
+        { "type": "string" },
+        { "$ref": "../schemas.json#/definitions/localized" }
+      ],
+      "description": "Field label",
+      "x-example": {
+        "en-US": "Quantity"
+      }
+    },
+    "placeholder": {
+      "type": "string",
+      "description": "Field placeholder text",
+      "x-example": "Enter quantity"
+    },
+    "required": {
+      "type": "boolean",
+      "description": "Whether field is required",
+      "x-example": true
+    },
+    "disabled": {
+      "type": "boolean",
+      "description": "Whether field is disabled",
+      "x-example": false
+    },
+    "min": {
+      "type": "number",
+      "description": "Minimum value",
+      "x-example": 0
+    },
+    "max": {
+      "type": "number",
+      "description": "Maximum value",
+      "x-example": 9999
+    },
+    "step": {
+      "type": "number",
+      "description": "Step increment",
+      "x-example": 1
+    },
+    "decimals": {
+      "type": "number",
+      "description": "Number of decimal places",
+      "x-example": 2
+    },
+    "transformValue": {
+      "type": "object",
+      "description": "Value transformation configuration",
+      "properties": {
+        "onLoad": {
+          "type": "string",
+          "description": "Template expression to transform value on load",
+          "x-example": "{{ eval Number(value) }}"
+        },
+        "onChange": {
+          "type": "string", 
+          "description": "Template expression to transform value on change",
+          "x-example": "{{ eval Number((pieces * quantity * unitaryValue).toFixed(2)) }}"
+        },
+        "onBlur": {
+          "type": "string",
+          "description": "Template expression to transform value on blur",
+          "x-example": "{{ eval Number(value).toFixed(2) }}"
+        }
+      }
+    },
+    "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/password.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Password Field Type",
+  "description": "Schema for password input field type",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "password"
+    },
+    "label": {
+      "oneOf": [
+        { "type": "string" },
+        { "$ref": "../schemas.json#/definitions/localized" }
+      ],
+      "description": "Field label",
+      "x-example": {
+        "en-US": "Password"
+      }
+    },
+    "placeholder": {
+      "type": "string",
+      "description": "Field placeholder text",
+      "x-example": "Enter password"
+    },
+    "required": {
+      "type": "boolean",
+      "description": "Whether field is required",
+      "x-example": true
+    },
+    "disabled": {
+      "type": "boolean",
+      "description": "Whether field is disabled",
+      "x-example": false
+    },
+    "minLength": {
+      "type": "number",
+      "description": "Minimum character length",
+      "x-example": 8
+    },
+    "maxLength": {
+      "type": "number",
+      "description": "Maximum character length",
+      "x-example": 128
+    },
+    "pattern": {
+      "type": "string",
+      "description": "Regex pattern for validation",
+      "x-example": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[@$!%*?&])[A-Za-z\\d@$!%*?&]{8,}$"
+    },
+    "showToggle": {
+      "type": "boolean",
+      "description": "Show password visibility toggle",
+      "x-example": true
+    },
+    "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/radio.json

@@ -0,0 +1,94 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Radio Field Type",
+  "description": "Schema for radio button field type",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "radio"
+    },
+    "label": {
+      "oneOf": [
+        { "type": "string" },
+        { "$ref": "../schemas.json#/definitions/localized" }
+      ],
+      "description": "Field label",
+      "x-example": {
+        "en-US": "Payment Method"
+      }
+    },
+    "required": {
+      "type": "boolean",
+      "description": "Whether field is required",
+      "x-example": true
+    },
+    "disabled": {
+      "type": "boolean",
+      "description": "Whether field is disabled",
+      "x-example": false
+    },
+    "orientation": {
+      "type": "string",
+      "enum": ["horizontal", "vertical"],
+      "description": "Layout orientation of radio options",
+      "x-example": "vertical"
+    },
+    "items": {
+      "type": "array",
+      "description": "Radio button options",
+      "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"
+          },
+          "disabled": {
+            "type": "boolean",
+            "description": "Whether this option is disabled"
+          }
+        },
+        "required": ["label", "value"]
+      },
+      "x-example": [
+        {
+          "label": { "en-US": "Credit Card" },
+          "value": "credit_card"
+        },
+        {
+          "label": { "en-US": "Bank Transfer" },
+          "value": "bank_transfer"
+        },
+        {
+          "label": { "en-US": "Cash" },
+          "value": "cash"
+        }
+      ]
+    },
+    "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", "items"]
+}