@defra/forms-model 3.0.456 → 3.0.457

package/schemas/{form-definition-v2-payload-schema.json → form-definition-v2-schema.json}

@@ -1,6 +1,6 @@
 {
   "type": "object",
-  "description": "Enhanced form definition schema for V2 payloads with auto-generated IDs",
+  "description": "Form definition schema for V2",
   "properties": {
     "engine": {
       "type": "string",
@@ -377,11 +377,11 @@
     },
     "pages": {
       "type": "array",
-      "description": "Pages with auto-generated IDs for V2 forms",
+      "description": "Pages schema for V2 forms",
       "uniqueItems": true,
       "items": {
         "type": "object",
-        "description": "Page schema for payload data with auto-generated IDs for pages and components",
+        "description": "Page schema for V2 forms",
         "properties": {
           "path": {
             "type": "string",
@@ -592,24 +592,24 @@
             "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",
+            "description": "Unique identifier for the page",
             "format": "uuid",
             "title": "Id"
           },
+          "title": {
+            "type": "string",
+            "description": "Page title displayed at the top of the page (with support for empty titles in V2)",
+            "title": "Title"
+          },
           "components": {
             "type": "array",
-            "description": "Components with auto-generated IDs",
+            "description": "Components schema for V2 forms",
             "uniqueItems": true,
             "items": {
               "type": "object",
-              "description": "Enhanced component schema for V2 forms with auto-generated IDs",
+              "description": "Component schema for V2 forms",
               "properties": {
                 "type": {
                   "type": "string",
@@ -756,7 +756,7 @@
                 },
                 "id": {
                   "type": "string",
-                  "description": "Auto-generated unique identifier for the component",
+                  "description": "Unique identifier for the component",
                   "format": "uuid",
                   "title": "Id"
                 }
@@ -781,11 +781,11 @@
     },
     "lists": {
       "type": "array",
-      "description": "Lists with auto-generated IDs for V2 forms",
+      "description": "Lists schema for V2 forms",
       "uniqueItems": true,
       "items": {
         "type": "object",
-        "description": "Enhanced list schema for V2 forms with auto-generated IDs",
+        "description": "List schema for V2 forms",
         "properties": {
           "name": {
             "type": "string",
@@ -1304,7 +1304,7 @@
           },
           "id": {
             "type": "string",
-            "description": "Auto-generated unique identifier for the list",
+            "description": "Unique identifier for the list",
             "format": "uuid",
             "title": "Id"
           }
@@ -1504,6 +1504,6 @@
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Form Definition V2 Payload Schema",
-  "$id": "@defra/forms-model/schemas/form-definition-v2-payload-schema.json"
+  "title": "Form Definition V2 Schema",
+  "$id": "@defra/forms-model/schemas/form-definition-v2-schema.json"
 }

package/schemas/list-schema-v2.json

@@ -1,6 +1,6 @@
 {
   "type": "object",
-  "description": "Enhanced list schema for V2 forms with auto-generated IDs",
+  "description": "List schema for V2 forms",
   "properties": {
     "name": {
       "type": "string",
@@ -519,7 +519,7 @@
     },
     "id": {
       "type": "string",
-      "description": "Auto-generated unique identifier for the list",
+      "description": "Unique identifier for the list",
       "format": "uuid",
       "title": "Id"
     }

package/schemas/page-schema-v2.json

@@ -1,13 +1,7 @@
 {
   "type": "object",
-  "description": "Enhanced page schema for V2 forms with support for empty titles",
+  "description": "Page schema for V2 forms",
   "properties": {
-    "id": {
-      "type": "string",
-      "description": "Unique identifier for the page",
-      "format": "uuid",
-      "title": "Id"
-    },
     "path": {
       "type": "string",
       "description": "URL path for this page, must not be the reserved \"/status\" path",
@@ -29,172 +23,6 @@
       "description": "Custom controller class name for special page behavior",
       "title": "Controller"
     },
-    "components": {
-      "type": "array",
-      "description": "UI components displayed on this page",
-      "uniqueItems": true,
-      "items": {
-        "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,
-        "title": "Components Item"
-      },
-      "title": "Components"
-    },
     "repeat": {
       "type": "object",
       "title": "Repeat Configuration",
@@ -383,10 +211,182 @@
       "description": "Optional custom view template to use for rendering this page",
       "title": "View"
     },
+    "id": {
+      "type": "string",
+      "description": "Unique identifier for the page",
+      "format": "uuid",
+      "title": "Id"
+    },
     "title": {
       "type": "string",
-      "description": "Page title with enhanced support for empty titles in V2",
+      "description": "Page title displayed at the top of the page (with support for empty titles in V2)",
       "title": "Title"
+    },
+    "components": {
+      "type": "array",
+      "description": "Components schema for V2 forms",
+      "uniqueItems": true,
+      "items": {
+        "type": "object",
+        "description": "Component schema for V2 forms",
+        "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": "Unique identifier for the component",
+            "format": "uuid",
+            "title": "Id"
+          }
+        },
+        "required": [
+          "type"
+        ],
+        "additionalProperties": true,
+        "title": "Components Item"
+      },
+      "title": "Components"
     }
   },
   "required": [

package/src/form/form-definition/index.ts

@@ -307,9 +307,9 @@ export const componentSchemaV2 = componentSchema
       .trim()
       .uuid()
       .default(() => uuidV4())
-      .description('Auto-generated unique identifier for the component')
+      .description('Unique identifier for the component')
   })
-  .description('Enhanced component schema for V2 forms with auto-generated IDs')
+  .description('Component schema for V2 forms')
 
 const nextSchema = Joi.object<Link>()
   .description('Navigation link defining where to go after completing a page')
@@ -477,32 +477,25 @@ export const pageSchema = Joi.object<Page>()
  */
 export const pageSchemaV2 = pageSchema
   .append({
-    title: Joi.string()
-      .trim()
-      .allow('')
-      .required()
-      .description('Page title with enhanced support for empty titles in V2')
-  })
-  .description(
-    'Enhanced page schema for V2 forms with support for empty titles'
-  )
-
-export const pageSchemaPayloadV2 = pageSchemaV2
-  .keys({
     id: Joi.string()
       .trim()
       .uuid()
       .default(() => uuidV4())
-      .description('Auto-generated unique identifier for the page'),
+      .description('Unique identifier for the page'),
+    title: Joi.string()
+      .trim()
+      .allow('')
+      .required()
+      .description(
+        'Page title displayed at the top of the page (with support for empty titles in V2)'
+      ),
     components: Joi.array<ComponentDef>()
       .items(componentSchemaV2)
       .unique('name')
-      .unique('id', { ignoreUndefined: true })
-      .description('Components with auto-generated IDs')
+      .unique('id')
+      .description('Components schema for V2 forms')
   })
-  .description(
-    'Page schema for payload data with auto-generated IDs for pages and components'
-  )
+  .description('Page schema for V2 forms')
 
 const baseListItemSchema = Joi.object<Item>()
   .description('Base schema for list items with common properties')
@@ -605,7 +598,7 @@ export const listSchema = Joi.object<List>()
   })
 
 /**
- * v2 Joi schema for Lists
+ * V2 Joi schema for Lists
  */
 export const listSchemaV2 = listSchema
   .keys({
@@ -613,9 +606,9 @@ export const listSchemaV2 = listSchema
       .trim()
       .uuid()
       .default(() => uuidV4())
-      .description('Auto-generated unique identifier for the list')
+      .description('Unique identifier for the list')
   })
-  .description('Enhanced list schema for V2 forms with auto-generated IDs')
+  .description('List schema for V2 forms')
 
 const feedbackSchema = Joi.object<FormDefinition['feedback']>()
   .description('Feedback configuration for the form')
@@ -696,18 +689,9 @@ export const formDefinitionSchema = Joi.object<FormDefinition>()
       .description('Path of the first page to show when starting the form'),
     pages: Joi.array<Page>()
       .required()
-      .when('engine', {
-        is: 'V2',
-        then: Joi.array<Page>()
-          .items(pageSchemaV2)
-          .description('Pages using V2 schema with enhanced features'),
-        otherwise: Joi.array<Page>()
-          .items(pageSchema)
-          .description('Pages using standard V1 schema')
-      })
-      .unique('path')
-      .unique('id', { ignoreUndefined: true })
-      .description('All pages within the form'),
+      .items(pageSchema)
+      .description('Pages schema for V1 forms')
+      .unique('path'),
     sections: Joi.array<Section>()
       .items(sectionsSchema)
       .unique('name')
@@ -749,24 +733,22 @@ export const formDefinitionSchema = Joi.object<FormDefinition>()
       .description('Configuration for submission output format')
   })
 
-export const formDefinitionV2PayloadSchema = formDefinitionSchema
+export const formDefinitionV2Schema = formDefinitionSchema
   .keys({
     pages: Joi.array<Page>()
-      .items(pageSchemaPayloadV2)
+      .items(pageSchemaV2)
       .required()
       .unique('path')
-      .unique('id', { ignoreUndefined: true })
-      .description('Pages with auto-generated IDs for V2 forms'),
+      .unique('id')
+      .description('Pages schema for V2 forms'),
     lists: Joi.array<List>()
       .items(listSchemaV2)
       .unique('name')
       .unique('title')
-      .unique('id', { ignoreUndefined: true })
-      .description('Lists with auto-generated IDs for V2 forms')
+      .unique('id')
+      .description('Lists schema for V2 forms')
   })
-  .description(
-    'Enhanced form definition schema for V2 payloads with auto-generated IDs'
-  )
+  .description('Form definition schema for V2')
 
 // Maintain compatibility with legacy named export
 // E.g. `import { Schema } from '@defra/forms-model'`

package/src/form/form-manager/types.ts

@@ -1,8 +1,11 @@
-import { type PageRepeat } from '~/src/index.js'
+import { type ControllerType, type Repeat } from '~/src/index.js'
 
-export type PatchPageFields = Partial<
-  Pick<PageRepeat, 'title' | 'path' | 'controller' | 'repeat'>
->
+export interface PatchPageFields {
+  title?: string
+  path?: string
+  controller?: ControllerType | null
+  repeat?: Repeat
+}
 
 export interface AddComponentQueryOptions {
   prepend?: boolean