@anri1214/dynamic-forms-mui-mcp 0.1.5

package/dist/schema/0.1/formSchema.json

@@ -0,0 +1,806 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "FormSchema",
+  "description": "Schema for @ai-hub/dynamic-forms-mui — describes a declarative, JSON-driven dynamic form with sections, fields, validation, conditions, and dynamic options.",
+  "type": "object",
+  "required": [
+    "sections",
+    "fields"
+  ],
+  "properties": {
+    "sections": {
+      "type": "array",
+      "description": "Ordered list of form sections. Each section groups related fields.",
+      "items": {
+        "$ref": "#/definitions/Section"
+      }
+    },
+    "fields": {
+      "type": "object",
+      "description": "Map of field key → field configuration. Keys are referenced by sections.fields[].",
+      "additionalProperties": {
+        "$ref": "#/definitions/FieldConfig"
+      }
+    }
+  },
+  "definitions": {
+    "Section": {
+      "type": "object",
+      "required": [
+        "id",
+        "fields"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique section identifier"
+        },
+        "title": {
+          "type": "string",
+          "description": "Section heading displayed to the user"
+        },
+        "description": {
+          "type": "string",
+          "description": "Optional section description"
+        },
+        "fields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Ordered list of field keys that belong to this section"
+        }
+      }
+    },
+    "FieldConfig": {
+      "description": "Configuration for a single form field. Discriminated by the \"type\" property.",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/TextFieldConfig"
+        },
+        {
+          "$ref": "#/definitions/NumberFieldConfig"
+        },
+        {
+          "$ref": "#/definitions/SelectFieldConfig"
+        },
+        {
+          "$ref": "#/definitions/AutocompleteFieldConfig"
+        },
+        {
+          "$ref": "#/definitions/CheckboxFieldConfig"
+        },
+        {
+          "$ref": "#/definitions/RadioFieldConfig"
+        },
+        {
+          "$ref": "#/definitions/DateFieldConfig"
+        },
+        {
+          "$ref": "#/definitions/FileFieldConfig"
+        }
+      ]
+    },
+    "BaseFieldConfig": {
+      "type": "object",
+      "required": [
+        "type",
+        "label"
+      ],
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": [
+            "text",
+            "password",
+            "email",
+            "number",
+            "textarea",
+            "select",
+            "multiselect",
+            "autocomplete",
+            "checkbox",
+            "radio",
+            "switch",
+            "date",
+            "dateRange",
+            "file"
+          ],
+          "description": "Field type discriminator"
+        },
+        "label": {
+          "type": "string",
+          "description": "Label displayed above the field"
+        },
+        "placeholder": {
+          "type": "string",
+          "description": "Placeholder text inside the field"
+        },
+        "helperText": {
+          "type": "string",
+          "description": "Helper text displayed below the field"
+        },
+        "defaultValue": {
+          "description": "Default value for the field"
+        },
+        "disabled": {
+          "type": "boolean",
+          "description": "Whether the field is disabled"
+        },
+        "showIf": {
+          "$ref": "#/definitions/Condition",
+          "description": "Condition to show this field"
+        },
+        "validation": {
+          "$ref": "#/definitions/ValidationRules"
+        }
+      }
+    },
+    "TextFieldConfig": {
+      "description": "Text-based field: text, password, email, or textarea",
+      "allOf": [
+        {
+          "$ref": "#/definitions/BaseFieldConfig"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "text",
+                "password",
+                "email",
+                "textarea"
+              ]
+            },
+            "autoComplete": {
+              "type": "string",
+              "description": "HTML autocomplete attribute value"
+            },
+            "rows": {
+              "type": "number",
+              "description": "Number of visible rows (textarea only)"
+            }
+          },
+          "required": [
+            "type",
+            "label"
+          ]
+        }
+      ]
+    },
+    "NumberFieldConfig": {
+      "description": "Numeric input field",
+      "allOf": [
+        {
+          "$ref": "#/definitions/BaseFieldConfig"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "number"
+              ]
+            },
+            "min": {
+              "type": "number",
+              "description": "Minimum allowed value"
+            },
+            "max": {
+              "type": "number",
+              "description": "Maximum allowed value"
+            },
+            "step": {
+              "type": "number",
+              "description": "Step increment"
+            }
+          },
+          "required": [
+            "type",
+            "label"
+          ]
+        }
+      ]
+    },
+    "SelectFieldConfig": {
+      "description": "Dropdown select or multi-select field",
+      "allOf": [
+        {
+          "$ref": "#/definitions/BaseFieldConfig"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "select",
+                "multiselect"
+              ]
+            },
+            "options": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/Option"
+              },
+              "description": "Static options list"
+            },
+            "optionsSource": {
+              "$ref": "#/definitions/OptionsSource",
+              "description": "Dynamic options from an API"
+            },
+            "initialOptions": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/Option"
+              },
+              "description": "Pre-selected options to display before API response arrives (used with optionsSource)"
+            }
+          },
+          "required": [
+            "type",
+            "label"
+          ]
+        }
+      ]
+    },
+    "AutocompleteFieldConfig": {
+      "description": "Autocomplete field with async search support. Single-value selection with typeahead.",
+      "allOf": [
+        {
+          "$ref": "#/definitions/BaseFieldConfig"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "autocomplete"
+              ]
+            },
+            "options": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/Option"
+              },
+              "description": "Static options list"
+            },
+            "optionsSource": {
+              "$ref": "#/definitions/OptionsSource",
+              "description": "Dynamic options from an API (supports async search via dependsOnInput)"
+            },
+            "initialOptions": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/Option"
+              },
+              "description": "Pre-selected options to display before API response arrives"
+            }
+          },
+          "required": [
+            "type",
+            "label"
+          ]
+        }
+      ]
+    },
+    "CheckboxFieldConfig": {
+      "description": "Checkbox or switch toggle field",
+      "allOf": [
+        {
+          "$ref": "#/definitions/BaseFieldConfig"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "checkbox",
+                "switch"
+              ]
+            },
+            "defaultValue": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "type",
+            "label"
+          ]
+        }
+      ]
+    },
+    "RadioFieldConfig": {
+      "description": "Radio button group field",
+      "allOf": [
+        {
+          "$ref": "#/definitions/BaseFieldConfig"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "radio"
+              ]
+            },
+            "options": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/Option"
+              }
+            },
+            "optionsSource": {
+              "$ref": "#/definitions/OptionsSource"
+            },
+            "direction": {
+              "type": "string",
+              "enum": [
+                "row",
+                "column"
+              ],
+              "description": "Layout direction for radio buttons"
+            }
+          },
+          "required": [
+            "type",
+            "label"
+          ]
+        }
+      ]
+    },
+    "DateFieldConfig": {
+      "description": "Date or date range picker field",
+      "allOf": [
+        {
+          "$ref": "#/definitions/BaseFieldConfig"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "date",
+                "dateRange"
+              ]
+            },
+            "includeTime": {
+              "type": "boolean",
+              "description": "Include time picker"
+            },
+            "minDate": {
+              "type": "string",
+              "description": "Minimum date (ISO 8601 string)"
+            },
+            "maxDate": {
+              "type": "string",
+              "description": "Maximum date (ISO 8601 string)"
+            },
+            "format": {
+              "type": "string",
+              "description": "Display format (e.g. \"dd/MM/yyyy\")"
+            }
+          },
+          "required": [
+            "type",
+            "label"
+          ]
+        }
+      ]
+    },
+    "FileFieldConfig": {
+      "description": "File upload field",
+      "allOf": [
+        {
+          "$ref": "#/definitions/BaseFieldConfig"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "file"
+              ]
+            },
+            "accept": {
+              "type": "string",
+              "description": "Accepted file types (e.g. \"image/*,.pdf\")"
+            },
+            "maxSize": {
+              "type": "number",
+              "description": "Max file size in bytes"
+            },
+            "multiple": {
+              "type": "boolean",
+              "description": "Allow multiple files"
+            }
+          },
+          "required": [
+            "type",
+            "label"
+          ]
+        }
+      ]
+    },
+    "Option": {
+      "type": "object",
+      "required": [
+        "value",
+        "label"
+      ],
+      "properties": {
+        "value": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            }
+          ],
+          "description": "Option value submitted with the form"
+        },
+        "label": {
+          "type": "string",
+          "description": "Display text for this option"
+        },
+        "disabled": {
+          "type": "boolean"
+        }
+      }
+    },
+    "OptionsSource": {
+      "type": "object",
+      "required": [
+        "apiUrl"
+      ],
+      "description": "Configuration for loading options dynamically from an API endpoint",
+      "properties": {
+        "apiUrl": {
+          "type": "string",
+          "description": "API endpoint URL"
+        },
+        "queryParams": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/QueryParam"
+          },
+          "description": "Query parameters to append; can depend on other field values"
+        },
+        "valueKey": {
+          "type": "string",
+          "default": "value",
+          "description": "Key in API response object to use as option value"
+        },
+        "labelKey": {
+          "type": "string",
+          "default": "label",
+          "description": "Key in API response object to use as option label"
+        }
+      }
+    },
+    "QueryParam": {
+      "type": "object",
+      "required": [
+        "key"
+      ],
+      "properties": {
+        "key": {
+          "type": "string",
+          "description": "Query parameter name"
+        },
+        "dependsOn": {
+          "type": "string",
+          "description": "Field key whose value is used as this parameter"
+        },
+        "value": {
+          "type": "string",
+          "description": "Static value (used when dependsOn is not set)"
+        },
+        "dependsOnInput": {
+          "type": "boolean",
+          "description": "When true, the query param value comes from the autocomplete text input (for async search)"
+        }
+      }
+    },
+    "ValidationRules": {
+      "type": "object",
+      "description": "Validation rules for a field",
+      "properties": {
+        "required": {
+          "type": "boolean"
+        },
+        "requiredIf": {
+          "$ref": "#/definitions/Condition"
+        },
+        "minLength": {
+          "type": "number"
+        },
+        "maxLength": {
+          "type": "number"
+        },
+        "pattern": {
+          "type": "string",
+          "description": "Regex pattern string"
+        },
+        "email": {
+          "type": "boolean"
+        },
+        "url": {
+          "type": "boolean"
+        },
+        "hasUppercase": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "number"
+            }
+          ],
+          "description": "Require uppercase letters (true or minimum count)"
+        },
+        "hasLowercase": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "number"
+            }
+          ],
+          "description": "Require lowercase letters (true or minimum count)"
+        },
+        "hasNumber": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "number"
+            }
+          ],
+          "description": "Require digits (true or minimum count)"
+        },
+        "hasSpecialChar": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "number"
+            }
+          ],
+          "description": "Require special characters (true or minimum count)"
+        },
+        "includes": {
+          "type": "string",
+          "description": "String that must be included"
+        },
+        "min": {
+          "type": "number",
+          "description": "Minimum numeric value"
+        },
+        "max": {
+          "type": "number",
+          "description": "Maximum numeric value"
+        },
+        "minDate": {
+          "type": "string",
+          "description": "Minimum date (ISO 8601)"
+        },
+        "maxDate": {
+          "type": "string",
+          "description": "Maximum date (ISO 8601)"
+        },
+        "maxSize": {
+          "type": "number",
+          "description": "Max file size in bytes"
+        },
+        "minFiles": {
+          "type": "number"
+        },
+        "maxFiles": {
+          "type": "number"
+        },
+        "matchField": {
+          "type": "string",
+          "description": "Key of another field whose value must match"
+        },
+        "asyncValidation": {
+          "$ref": "#/definitions/AsyncValidationConfig"
+        },
+        "messages": {
+          "$ref": "#/definitions/ValidationMessages"
+        }
+      }
+    },
+    "AsyncValidationConfig": {
+      "type": "object",
+      "required": [
+        "apiUrl",
+        "message"
+      ],
+      "properties": {
+        "apiUrl": {
+          "type": "string",
+          "description": "API endpoint for async validation"
+        },
+        "queryParams": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/QueryParam"
+          }
+        },
+        "debounce": {
+          "type": "number",
+          "default": 500,
+          "description": "Debounce in ms before sending request"
+        },
+        "message": {
+          "type": "string",
+          "description": "Error message when validation fails"
+        }
+      }
+    },
+    "ValidationMessages": {
+      "type": "object",
+      "description": "Custom error messages that override defaults",
+      "properties": {
+        "required": {
+          "type": "string"
+        },
+        "minLength": {
+          "type": "string"
+        },
+        "maxLength": {
+          "type": "string"
+        },
+        "pattern": {
+          "type": "string"
+        },
+        "email": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        },
+        "hasUppercase": {
+          "type": "string"
+        },
+        "hasLowercase": {
+          "type": "string"
+        },
+        "hasNumber": {
+          "type": "string"
+        },
+        "hasSpecialChar": {
+          "type": "string"
+        },
+        "includes": {
+          "type": "string"
+        },
+        "min": {
+          "type": "string"
+        },
+        "max": {
+          "type": "string"
+        },
+        "invalidDate": {
+          "type": "string"
+        },
+        "minDate": {
+          "type": "string"
+        },
+        "maxDate": {
+          "type": "string"
+        },
+        "invalidRange": {
+          "type": "string"
+        },
+        "maxSize": {
+          "type": "string"
+        },
+        "fileType": {
+          "type": "string"
+        },
+        "minFiles": {
+          "type": "string"
+        },
+        "maxFiles": {
+          "type": "string"
+        },
+        "matchField": {
+          "type": "string"
+        },
+        "asyncValidation": {
+          "type": "string"
+        }
+      }
+    },
+    "Condition": {
+      "description": "A condition expression. Can be a simple comparison, or a composite (and/or) condition.",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/SimpleCondition"
+        },
+        {
+          "$ref": "#/definitions/AndCondition"
+        },
+        {
+          "$ref": "#/definitions/OrCondition"
+        }
+      ]
+    },
+    "SimpleCondition": {
+      "type": "object",
+      "required": [
+        "field",
+        "operator"
+      ],
+      "properties": {
+        "field": {
+          "type": "string",
+          "description": "Field key to evaluate"
+        },
+        "operator": {
+          "type": "string",
+          "enum": [
+            "equals",
+            "notEquals",
+            "in",
+            "notIn",
+            "isEmpty",
+            "isNotEmpty",
+            "gt",
+            "gte",
+            "lt",
+            "lte"
+          ],
+          "description": "Comparison operator"
+        },
+        "value": {
+          "description": "Value to compare against (not needed for isEmpty/isNotEmpty)"
+        }
+      }
+    },
+    "AndCondition": {
+      "type": "object",
+      "required": [
+        "and"
+      ],
+      "properties": {
+        "and": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Condition"
+          },
+          "description": "All conditions must be true"
+        }
+      }
+    },
+    "OrCondition": {
+      "type": "object",
+      "required": [
+        "or"
+      ],
+      "properties": {
+        "or": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Condition"
+          },
+          "description": "At least one condition must be true"
+        }
+      }
+    }
+  }
+}