@defra/forms-model 3.0.430 → 3.0.432

package/dist/types/form/form-metadata/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-metadata/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAErB,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACvB,MAAM,mCAAmC,CAAA;AAE1C,eAAO,MAAM,aAAa,UAUzB,CAAA;AAED,eAAO,MAAM,QAAQ,0BAA2C,CAAA;AAChE,eAAO,MAAM,WAAW,0BAA0C,CAAA;AAClE,eAAO,MAAM,UAAU,0BAEV,CAAA;AAEb,eAAO,MAAM,kBAAkB,0BAElB,CAAA;AAEb,eAAO,MAAM,cAAc,0BAA0C,CAAA;AACrE,eAAO,MAAM,eAAe,0BAGf,CAAA;AAEb,eAAO,MAAM,WAAW,0BAAsB,CAAA;AAE9C,eAAO,MAAM,kBAAkB,0BAAyC,CAAA;AACxE,eAAO,MAAM,uBAAuB,0BAAiC,CAAA;AACrE,eAAO,MAAM,WAAW,4CAGtB,CAAA;AAEF,eAAO,MAAM,eAAe,0BAKf,CAAA;AACb,eAAO,MAAM,gBAAgB,0BAAiC,CAAA;AAC9D,eAAO,MAAM,YAAY,6CAGvB,CAAA;AAEF,eAAO,MAAM,aAAa,uCAIxB,CAAA;AAEF,eAAO,MAAM,wBAAwB,0BAAsB,CAAA;AAE3D,eAAO,MAAM,sBAAsB,0BAI1B,CAAA;AAET,eAAO,MAAM,8BAA8B,0BAGR,CAAA;AAEnC,eAAO,MAAM,gBAAgB,sBAA8B,CAAA;AAC3D,eAAO,MAAM,cAAc,0BAAiC,CAAA;AAC5D,eAAO,MAAM,uBAAuB,0BAAiC,CAAA;AAErE,eAAO,MAAM,qBAAqB;;;;;;;;;CASjC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,uBAAuB,qCAEvB,CAAA;AAEb;;;GAGG;AACH,eAAO,MAAM,wBAAwB,sCAKxB,CAAA;AAEb;;;GAGG;AACH,eAAO,MAAM,uBAAuB,qCAKlC,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,gCAS7B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-metadata/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAErB,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACvB,MAAM,mCAAmC,CAAA;AAE1C,eAAO,MAAM,aAAa,UAUzB,CAAA;AAED,eAAO,MAAM,QAAQ,0BAMlB,CAAA;AAEH,eAAO,MAAM,WAAW,0BAI+B,CAAA;AAEvD,eAAO,MAAM,UAAU,0BAGqC,CAAA;AAE5D,eAAO,MAAM,kBAAkB,0BAG8B,CAAA;AAE7D,eAAO,MAAM,cAAc,0BAIgC,CAAA;AAE3D,eAAO,MAAM,eAAe,0BAIyC,CAAA;AAErE,eAAO,MAAM,WAAW,0BAEiC,CAAA;AAEzD,eAAO,MAAM,kBAAkB,0BAI2B,CAAA;AAE1D,eAAO,MAAM,uBAAuB,0BAGwB,CAAA;AAE5D,eAAO,MAAM,WAAW,4CAK+C,CAAA;AAEvE,eAAO,MAAM,eAAe,0BAMmB,CAAA;AAE/C,eAAO,MAAM,gBAAgB,0BAGiC,CAAA;AAE9D,eAAO,MAAM,YAAY,6CAK6C,CAAA;AAEtE,eAAO,MAAM,aAAa,uCAM+C,CAAA;AAEzE,eAAO,MAAM,wBAAwB,0BAEkC,CAAA;AAEvE,eAAO,MAAM,sBAAsB,0BAKsB,CAAA;AAEzD,eAAO,MAAM,8BAA8B,0BAMxC,CAAA;AAEH,eAAO,MAAM,gBAAgB,sBAGoC,CAAA;AAEjE,eAAO,MAAM,cAAc,0BAGuB,CAAA;AAElD,eAAO,MAAM,uBAAuB,0BAGe,CAAA;AAEnD,eAAO,MAAM,qBAAqB;;;;;;;;;CASjC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,uBAAuB,qCAG+B,CAAA;AAEnE;;;GAGG;AACH,eAAO,MAAM,wBAAwB,sCAMkC,CAAA;AAEvE;;;GAGG;AACH,eAAO,MAAM,uBAAuB,qCAaqC,CAAA;AAEzE;;;GAGG;AACH,eAAO,MAAM,kBAAkB,gCAiB5B,CAAA"}

package/dist/types/form/form-submission/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAErB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,eAAe,EACrB,MAAM,qCAAqC,CAAA;AAE5C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,gCAIjC,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,yBAAyB,mCAMpC,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,iCASvB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAErB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,eAAe,EACrB,MAAM,qCAAqC,CAAA;AAE5C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,gCAW0B,CAAA;AAE7D;;;GAGG;AACH,eAAO,MAAM,yBAAyB,mCAayC,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,uBAAuB,iCAkB2C,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.430",
+  "version": "3.0.432",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "repository": {
@@ -14,21 +14,23 @@
   "main": "dist/module/index.js",
   "types": "dist/types/index.d.ts",
   "scripts": {
-    "build": "npm run build:types && npm run build:node",
+    "build": "npm run build:types && npm run build:node && npm run build:schemas",
     "build:node": "babel --delete-dir-on-start --extensions \".ts\" --ignore \"**/*.test.*\" --copy-files --no-copy-ignored --source-maps --out-dir ./dist/module ./src",
     "build:types": "tsc --build --force tsconfig.build.json && tsc-alias --project tsconfig.build.json",
+    "build:schemas": "node scripts/generate-schemas.js",
     "test": "jest --color --coverage --verbose",
     "test:watch": "jest --color --watch"
   },
   "dependencies": {
     "marked": "^15.0.7",
+    "nanoid": "^5.0.7",
     "slug": "^10.0.0",
-    "uuid": "^11.1.0",
-    "nanoid": "^5.0.7"
+    "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@types/slug": "^5.0.9",
     "joi": "^17.13.3",
+    "joi-to-json": "^4.3.1",
     "tsc-alias": "^1.8.11"
   },
   "peerDependencies": {

package/schemas/component-schema-v2.json

@@ -0,0 +1,162 @@
+{
+  "type": "object",
+  "description": "Enhanced component schema for V2 forms with auto-generated IDs",
+  "properties": {
+    "type": {
+      "type": "string",
+      "description": "Component type (TextField, RadioButtons, DateField, etc.)",
+      "title": "Type"
+    },
+    "shortDescription": {
+      "type": "string",
+      "description": "Brief description of the component purpose",
+      "title": "Short Description"
+    },
+    "name": {
+      "type": [
+        "array",
+        "boolean",
+        "number",
+        "object",
+        "string",
+        "null"
+      ],
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "Name format for display-only components like HTML, Markdown, etc.",
+          "pattern": "^[a-zA-Z]+$",
+          "title": "Display Component Name"
+        },
+        {
+          "type": "string",
+          "description": "Name format for input components that collect user data.",
+          "pattern": "^[a-zA-Z]+$",
+          "title": "Input Component Name"
+        }
+      ],
+      "title": "Name",
+      "description": "The name value.",
+      "oneOfTitles": [
+        "Display Component Name",
+        "Input Component Name"
+      ]
+    },
+    "title": {
+      "type": [
+        "array",
+        "boolean",
+        "number",
+        "object",
+        "string",
+        "null"
+      ],
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "Title format for display-only components.",
+          "title": "Display Component Title"
+        },
+        {
+          "type": "string",
+          "description": "Title displayed above input components.",
+          "title": "Input Component Title"
+        }
+      ],
+      "title": "Title",
+      "description": "The title value.",
+      "oneOfTitles": [
+        "Display Component Title",
+        "Input Component Title"
+      ]
+    },
+    "hint": {
+      "type": "string",
+      "description": "Additional guidance text displayed below the component title",
+      "title": "Hint"
+    },
+    "options": {
+      "type": "object",
+      "description": "Component-specific configuration options",
+      "default": {},
+      "properties": {
+        "rows": {
+          "type": "number",
+          "description": "Number of rows for textarea components",
+          "title": "Rows"
+        },
+        "maxWords": {
+          "type": "number",
+          "description": "Maximum number of words allowed in text inputs",
+          "title": "Max Words"
+        },
+        "maxDaysInPast": {
+          "type": "number",
+          "description": "Maximum days in the past allowed for date inputs",
+          "title": "Max Days In Past"
+        },
+        "maxDaysInFuture": {
+          "type": "number",
+          "description": "Maximum days in the future allowed for date inputs",
+          "title": "Max Days In Future"
+        },
+        "customValidationMessage": {
+          "type": "string",
+          "description": "Custom error message for validation failures",
+          "title": "Custom Validation Message"
+        },
+        "customValidationMessages": {
+          "type": "object",
+          "description": "Custom error messages keyed by validation rule name",
+          "properties": {},
+          "additionalProperties": true,
+          "title": "Custom Validation Messages"
+        }
+      },
+      "additionalProperties": true,
+      "title": "Options"
+    },
+    "schema": {
+      "type": "object",
+      "description": "Validation rules for the component",
+      "default": {},
+      "properties": {
+        "min": {
+          "type": "number",
+          "description": "Minimum value or length for validation",
+          "title": "Min"
+        },
+        "max": {
+          "type": "number",
+          "description": "Maximum value or length for validation",
+          "title": "Max"
+        },
+        "length": {
+          "type": "number",
+          "description": "Exact length required for validation",
+          "title": "Length"
+        }
+      },
+      "additionalProperties": true,
+      "title": "Schema"
+    },
+    "list": {
+      "type": "string",
+      "description": "Reference to a predefined list of options for select components",
+      "title": "List"
+    },
+    "id": {
+      "type": "string",
+      "description": "Auto-generated unique identifier for the component",
+      "format": "uuid",
+      "title": "Id"
+    }
+  },
+  "required": [
+    "type"
+  ],
+  "additionalProperties": true,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Component Schema V2",
+  "$id": "@defra/forms-model/schemas/component-schema-v2.json"
+}

package/schemas/component-schema.json

@@ -0,0 +1,162 @@
+{
+  "type": "object",
+  "description": "Form component definition specifying UI element behavior",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Unique identifier for the component",
+      "format": "uuid",
+      "title": "Id"
+    },
+    "type": {
+      "type": "string",
+      "description": "Component type (TextField, RadioButtons, DateField, etc.)",
+      "title": "Type"
+    },
+    "shortDescription": {
+      "type": "string",
+      "description": "Brief description of the component purpose",
+      "title": "Short Description"
+    },
+    "name": {
+      "type": [
+        "array",
+        "boolean",
+        "number",
+        "object",
+        "string",
+        "null"
+      ],
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "Name format for display-only components like HTML, Markdown, etc.",
+          "pattern": "^[a-zA-Z]+$",
+          "title": "Display Component Name"
+        },
+        {
+          "type": "string",
+          "description": "Name format for input components that collect user data.",
+          "pattern": "^[a-zA-Z]+$",
+          "title": "Input Component Name"
+        }
+      ],
+      "title": "Name",
+      "description": "The name value.",
+      "oneOfTitles": [
+        "Display Component Name",
+        "Input Component Name"
+      ]
+    },
+    "title": {
+      "type": [
+        "array",
+        "boolean",
+        "number",
+        "object",
+        "string",
+        "null"
+      ],
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "Title format for display-only components.",
+          "title": "Display Component Title"
+        },
+        {
+          "type": "string",
+          "description": "Title displayed above input components.",
+          "title": "Input Component Title"
+        }
+      ],
+      "title": "Title",
+      "description": "The title value.",
+      "oneOfTitles": [
+        "Display Component Title",
+        "Input Component Title"
+      ]
+    },
+    "hint": {
+      "type": "string",
+      "description": "Additional guidance text displayed below the component title",
+      "title": "Hint"
+    },
+    "options": {
+      "type": "object",
+      "description": "Component-specific configuration options",
+      "default": {},
+      "properties": {
+        "rows": {
+          "type": "number",
+          "description": "Number of rows for textarea components",
+          "title": "Rows"
+        },
+        "maxWords": {
+          "type": "number",
+          "description": "Maximum number of words allowed in text inputs",
+          "title": "Max Words"
+        },
+        "maxDaysInPast": {
+          "type": "number",
+          "description": "Maximum days in the past allowed for date inputs",
+          "title": "Max Days In Past"
+        },
+        "maxDaysInFuture": {
+          "type": "number",
+          "description": "Maximum days in the future allowed for date inputs",
+          "title": "Max Days In Future"
+        },
+        "customValidationMessage": {
+          "type": "string",
+          "description": "Custom error message for validation failures",
+          "title": "Custom Validation Message"
+        },
+        "customValidationMessages": {
+          "type": "object",
+          "description": "Custom error messages keyed by validation rule name",
+          "properties": {},
+          "additionalProperties": true,
+          "title": "Custom Validation Messages"
+        }
+      },
+      "additionalProperties": true,
+      "title": "Options"
+    },
+    "schema": {
+      "type": "object",
+      "description": "Validation rules for the component",
+      "default": {},
+      "properties": {
+        "min": {
+          "type": "number",
+          "description": "Minimum value or length for validation",
+          "title": "Min"
+        },
+        "max": {
+          "type": "number",
+          "description": "Maximum value or length for validation",
+          "title": "Max"
+        },
+        "length": {
+          "type": "number",
+          "description": "Exact length required for validation",
+          "title": "Length"
+        }
+      },
+      "additionalProperties": true,
+      "title": "Schema"
+    },
+    "list": {
+      "type": "string",
+      "description": "Reference to a predefined list of options for select components",
+      "title": "List"
+    }
+  },
+  "required": [
+    "type"
+  ],
+  "additionalProperties": true,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Component Schema",
+  "$id": "@defra/forms-model/schemas/component-schema.json"
+}

package/schemas/date-sub-schema.json

@@ -0,0 +1,11 @@
+{
+  "type": "string",
+  "enum": [
+    "DatePartsField",
+    "MonthYearField"
+  ],
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Date Sub Schema",
+  "description": "JSON Schema for validating Date Sub Schema in Defra forms",
+  "$id": "@defra/forms-model/schemas/date-sub-schema.json"
+}