@defra/forms-model 3.0.431 → 3.0.433

package/schemas/page-schema-payload-v2.json

@@ -0,0 +1,400 @@
+{
+  "type": "object",
+  "description": "Page schema for payload data with auto-generated IDs for pages and components",
+  "properties": {
+    "path": {
+      "type": "string",
+      "description": "URL path for this page, must not be the reserved \"/status\" path",
+      "not": {
+        "type": "string",
+        "enum": [
+          "/status"
+        ]
+      },
+      "title": "Path"
+    },
+    "section": {
+      "type": "string",
+      "description": "Section this page belongs to",
+      "title": "Section"
+    },
+    "controller": {
+      "type": "string",
+      "description": "Custom controller class name for special page behavior",
+      "title": "Controller"
+    },
+    "repeat": {
+      "type": "object",
+      "title": "Repeat Configuration",
+      "description": "Configuration for repeatable pages, used with RepeatPageController. Defines how repeatable sections behave including min/max repetitions and display options.\n\nNOTE: This configuration is only used when the 'controller' property is set to 'RepeatPageController'. Otherwise, this property should not be specified.",
+      "oneOfTitles": [
+        "Repeat Configuration",
+        "Alternative Validation"
+      ],
+      "properties": {
+        "options": {
+          "type": "object",
+          "description": "Display and identification options for the repetition",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Identifier for the repeatable section, used in data structure",
+              "title": "Name"
+            },
+            "title": {
+              "type": "string",
+              "description": "Title displayed for each repeatable item",
+              "title": "Title"
+            }
+          },
+          "required": [
+            "name",
+            "title"
+          ],
+          "additionalProperties": false,
+          "title": "Options"
+        },
+        "schema": {
+          "type": "object",
+          "description": "Validation constraints for the number of repetitions",
+          "properties": {
+            "min": {
+              "type": "number",
+              "description": "Minimum number of repetitions required",
+              "title": "Min"
+            },
+            "max": {
+              "type": "number",
+              "description": "Maximum number of repetitions allowed",
+              "title": "Max"
+            }
+          },
+          "required": [
+            "min",
+            "max"
+          ],
+          "additionalProperties": false,
+          "title": "Schema"
+        }
+      },
+      "required": [
+        "options",
+        "schema"
+      ],
+      "additionalProperties": false
+    },
+    "condition": {
+      "type": "string",
+      "description": "Optional condition that determines if this page is shown",
+      "title": "Condition"
+    },
+    "next": {
+      "type": "array",
+      "description": "Possible navigation paths after this page",
+      "default": [],
+      "items": {
+        "type": "object",
+        "description": "Navigation link defining where to go after completing a page",
+        "properties": {
+          "path": {
+            "type": "string",
+            "description": "The target page path to navigate to",
+            "title": "Path"
+          },
+          "condition": {
+            "type": "string",
+            "description": "Optional condition that determines if this path should be taken",
+            "title": "Condition"
+          },
+          "redirect": {
+            "type": "string",
+            "description": "Optional external URL to redirect to instead of an internal page",
+            "title": "Redirect"
+          }
+        },
+        "required": [
+          "path"
+        ],
+        "additionalProperties": false,
+        "title": "Next Item"
+      },
+      "title": "Next"
+    },
+    "events": {
+      "type": "object",
+      "description": "Event handlers for page lifecycle events",
+      "properties": {
+        "onLoad": {
+          "type": "object",
+          "description": "Event handler triggered when the page is loaded",
+          "properties": {
+            "type": {
+              "type": "string",
+              "description": "Type of the event handler (currently only \"http\" supported)",
+              "title": "Type"
+            },
+            "options": {
+              "type": "object",
+              "description": "Options specific to the event handler type",
+              "properties": {
+                "method": {
+                  "type": "string",
+                  "description": "HTTP method to use for the request",
+                  "title": "Method"
+                },
+                "url": {
+                  "type": "string",
+                  "description": "URL endpoint to call when the event fires",
+                  "format": "uri",
+                  "title": "Url"
+                }
+              },
+              "required": [
+                "method",
+                "url"
+              ],
+              "additionalProperties": false,
+              "title": "Options"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false,
+          "title": "On Load"
+        },
+        "onSave": {
+          "type": "object",
+          "description": "Event handler triggered when the page data is saved",
+          "properties": {
+            "type": {
+              "type": "string",
+              "description": "Type of the event handler (currently only \"http\" supported)",
+              "title": "Type"
+            },
+            "options": {
+              "type": "object",
+              "description": "Options specific to the event handler type",
+              "properties": {
+                "method": {
+                  "type": "string",
+                  "description": "HTTP method to use for the request",
+                  "title": "Method"
+                },
+                "url": {
+                  "type": "string",
+                  "description": "URL endpoint to call when the event fires",
+                  "format": "uri",
+                  "title": "Url"
+                }
+              },
+              "required": [
+                "method",
+                "url"
+              ],
+              "additionalProperties": false,
+              "title": "Options"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false,
+          "title": "On Save"
+        }
+      },
+      "additionalProperties": false,
+      "title": "Events"
+    },
+    "view": {
+      "type": "string",
+      "description": "Optional custom view template to use for rendering this page",
+      "title": "View"
+    },
+    "title": {
+      "type": "string",
+      "description": "Page title with enhanced support for empty titles in V2",
+      "title": "Title"
+    },
+    "id": {
+      "type": "string",
+      "description": "Auto-generated unique identifier for the page",
+      "format": "uuid",
+      "title": "Id"
+    },
+    "components": {
+      "type": "array",
+      "description": "Components with auto-generated IDs",
+      "uniqueItems": true,
+      "items": {
+        "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,
+        "title": "Components Item"
+      },
+      "title": "Components"
+    }
+  },
+  "required": [
+    "path",
+    "title"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Page Schema Payload V2",
+  "$id": "@defra/forms-model/schemas/page-schema-payload-v2.json"
+}