@defra/forms-model 3.0.466 → 3.0.468

package/src/__stubs__/components.ts

@@ -3,10 +3,22 @@ import {
   type AutocompleteFieldComponent,
   type CheckboxesFieldComponent,
   type DatePartsFieldComponent,
+  type DetailsComponent,
+  type EmailAddressFieldComponent,
   type FileUploadFieldComponent,
+  type HtmlComponent,
+  type InsetTextComponent,
+  type ListComponent,
+  type MarkdownComponent,
+  type MonthYearFieldComponent,
+  type MultilineTextFieldComponent,
   type NumberFieldComponent,
   type RadiosFieldComponent,
-  type TextFieldComponent
+  type SelectFieldComponent,
+  type TelephoneNumberFieldComponent,
+  type TextFieldComponent,
+  type UkAddressFieldComponent,
+  type YesNoFieldComponent
 } from '~/src/components/types.js'
 import { type Item, type List } from '~/src/form/form-definition/types.js'
 
@@ -17,19 +29,169 @@ import { type Item, type List } from '~/src/form/form-definition/types.js'
 export function buildTextFieldComponent(
   partialTextField: Partial<TextFieldComponent> = {}
 ): TextFieldComponent {
-  const textFieldComponent: TextFieldComponent = {
+  return {
     id: '407dd0d7-cce9-4f43-8e1f-7d89cb698875',
     name: 'TextField',
     title: 'Text field',
-    type: ComponentType.TextField,
     hint: '',
     options: {},
-    schema: {}
+    schema: {},
+    ...partialTextField,
+    type: ComponentType.TextField
+  }
+}
+
+export function buildMultilineTextFieldComponent(
+  partialMultilineTextField: Partial<MultilineTextFieldComponent> = {}
+): MultilineTextFieldComponent {
+  return {
+    id: '72671f23-552e-4504-a06a-693e240880d5',
+    name: 'MuTeCo',
+    options: {},
+    schema: {},
+    title: 'Multiline TextField Component',
+    ...partialMultilineTextField,
+    type: ComponentType.MultilineTextField
+  }
+}
+
+export function buildYesNoFieldComponent(
+  partialYesNoField: Partial<YesNoFieldComponent> = {}
+): YesNoFieldComponent {
+  return {
+    title: 'YesNo Field Component',
+    id: 'be7f849c-47d8-4f1f-ba15-ab939dc70914',
+    name: 'YesNoFieldComponent',
+    options: {},
+    ...partialYesNoField,
+    type: ComponentType.YesNoField
+  }
+}
+export function buildMonthYearFieldComponent(
+  partialMonthYearField: Partial<MonthYearFieldComponent> = {}
+): MonthYearFieldComponent {
+  return {
+    id: 'd4e99aca-6d13-4c1a-a623-9e9e5b27d46d',
+    title: 'MonthYearFieldComponent',
+    name: 'MonthYearFieldComponent',
+    options: {},
+    ...partialMonthYearField,
+    type: ComponentType.MonthYearField
+  }
+}
+export function buildSelectFieldComponent(
+  partialSelectField: Partial<SelectFieldComponent> = {}
+): SelectFieldComponent {
+  return {
+    id: '7f219cf6-3e16-4549-b8df-789506682147',
+    list: '',
+    name: '',
+    options: {},
+    title: '',
+    ...partialSelectField,
+    type: ComponentType.SelectField
+  }
+}
+export function buildUkAddressFieldComponent(
+  partialUkAddressField: Partial<UkAddressFieldComponent> = {}
+): UkAddressFieldComponent {
+  return {
+    id: 'a7cb7440-9095-44cd-9136-2914232722c8',
+    title: 'UkAddressFieldComponent',
+    name: 'UkAddressFieldComponent',
+    options: {},
+    ...partialUkAddressField,
+    type: ComponentType.UkAddressField
+  }
+}
+export function buildTelephoneNumberFieldComponent(
+  partialTelephoneNumberField: Partial<TelephoneNumberFieldComponent> = {}
+): TelephoneNumberFieldComponent {
+  return {
+    id: '69907916-beac-4faa-b469-656dad5edced',
+    title: 'TelephoneNumberFieldComponent',
+    name: 'TelephoneNumberFieldComponent',
+    options: {},
+    ...partialTelephoneNumberField,
+    type: ComponentType.TelephoneNumberField
   }
+}
+export function buildEmailAddressFieldComponent(
+  partialEmailAddressField: Partial<EmailAddressFieldComponent> = {}
+): EmailAddressFieldComponent {
+  return {
+    id: '9dcf0781-bf34-48c8-b13b-d13050dc34d9',
+    title: 'EmailAddressFieldComponent',
+    name: 'EmailAddressFieldComponent',
+    options: {},
+    ...partialEmailAddressField,
+    type: ComponentType.EmailAddressField
+  }
+}
 
+export function buildHtmlComponent(
+  partialHtml: Partial<HtmlComponent> = {}
+): HtmlComponent {
+  return {
+    id: 'bac683ce-149e-4740-95aa-8289b35bc327',
+    title: 'HtmlComponent',
+    name: 'HtmlComponent',
+    options: {},
+    content: '',
+    ...partialHtml,
+    type: ComponentType.Html
+  }
+}
+export function buildInsetTextComponent(
+  partialInsetText: Partial<InsetTextComponent> = {}
+): InsetTextComponent {
+  return {
+    id: '6b717151-1e86-42b2-97a9-2201b0676e47',
+    title: 'InsetText Component',
+    name: 'InsetTextComponent',
+    content: '',
+    options: {},
+    ...partialInsetText,
+    type: ComponentType.InsetText
+  }
+}
+export function buildDetailsComponent(
+  partialDetails: Partial<DetailsComponent> = {}
+): DetailsComponent {
+  return {
+    id: '245d54df-bb1e-488e-82f6-8f1e42c197e6',
+    title: 'Details Component',
+    name: 'DetailsComponent',
+    content: '',
+    options: {},
+    ...partialDetails,
+    type: ComponentType.Details
+  }
+}
+export function buildListComponent(
+  partialList: Partial<ListComponent> = {}
+): ListComponent {
   return {
-    ...textFieldComponent,
-    ...partialTextField
+    id: '62f17168-c2ef-4978-bd42-bdaa5704e25f',
+    title: 'List Component',
+    name: 'ListComponent',
+    list: '',
+    options: {},
+    ...partialList,
+    type: ComponentType.List
+  }
+}
+export function buildMarkdownComponent(
+  partialMarkdown: Partial<MarkdownComponent> = {}
+): MarkdownComponent {
+  return {
+    id: '4a2dc88c-be1a-4277-aff8-04220de2e778',
+    title: 'Markdown Component',
+    name: 'MarkdownComponent',
+    options: {},
+    content: '',
+    ...partialMarkdown,
+    type: ComponentType.Markdown
   }
 }
 
@@ -38,19 +200,15 @@ export function buildTextFieldComponent(
  * @returns {FileUploadFieldComponent}
  */
 export function buildFileUploadComponent(
-  partialFileUploadField: Partial<FileUploadFieldComponent>
+  partialFileUploadField: Partial<FileUploadFieldComponent> = {}
 ): FileUploadFieldComponent {
-  const fileUploadFieldComponent: FileUploadFieldComponent = {
+  return {
     name: 'FileUploadField',
-    type: ComponentType.FileUploadField,
     title: 'File Upload Field',
     options: {},
-    schema: {}
-  }
-
-  return {
-    ...fileUploadFieldComponent,
-    ...partialFileUploadField
+    schema: {},
+    ...partialFileUploadField,
+    type: ComponentType.FileUploadField
   }
 }
 
@@ -60,19 +218,15 @@ export function buildFileUploadComponent(
  * @returns {AutocompleteFieldComponent}
  */
 export function buildAutoCompleteComponent(
-  partialAutoCompleteField: Partial<AutocompleteFieldComponent>
+  partialAutoCompleteField: Partial<AutocompleteFieldComponent> = {}
 ): AutocompleteFieldComponent {
-  const autocompleteComponent: AutocompleteFieldComponent = {
+  return {
     name: 'AutoCompleteField',
     title: 'What languages do you speak?',
-    type: ComponentType.AutocompleteField,
     list: 'AutoCompleteList',
-    options: {}
-  }
-
-  return {
-    ...autocompleteComponent,
-    ...partialAutoCompleteField
+    options: {},
+    ...partialAutoCompleteField,
+    type: ComponentType.AutocompleteField
   }
 }
 
@@ -83,17 +237,13 @@ export function buildAutoCompleteComponent(
 export function buildRadioComponent(
   partialListComponent: Partial<RadiosFieldComponent> = {}
 ): RadiosFieldComponent {
-  const radioFieldComponent: RadiosFieldComponent = {
+  return {
     name: 'RadioField',
     title: 'Which country do you live in?',
-    type: ComponentType.RadiosField,
     list: 'RadioList',
-    options: {}
-  }
-
-  return {
-    ...radioFieldComponent,
-    ...partialListComponent
+    options: {},
+    ...partialListComponent,
+    type: ComponentType.RadiosField
   }
 }
 
@@ -102,19 +252,15 @@ export function buildRadioComponent(
  * @returns {CheckboxesFieldComponent}
  */
 export function buildCheckboxComponent(
-  partialListComponent: Partial<CheckboxesFieldComponent>
+  partialListComponent: Partial<CheckboxesFieldComponent> = {}
 ): CheckboxesFieldComponent {
-  const checkboxesFieldComponent: CheckboxesFieldComponent = {
+  return {
     name: 'FellowshipOfTheRing',
     title: 'Which are your favourite characters from the fellowship?',
-    type: ComponentType.CheckboxesField,
     list: 'CheckboxList',
-    options: {}
-  }
-
-  return {
-    ...checkboxesFieldComponent,
-    ...partialListComponent
+    options: {},
+    ...partialListComponent,
+    type: ComponentType.CheckboxesField
   }
 }
 
@@ -171,7 +317,7 @@ export function buildList(partialList: Partial<List> = {}): List {
 }
 
 export function buildNumberFieldComponent(
-  partialComponent: Partial<NumberFieldComponent>
+  partialComponent: Partial<NumberFieldComponent> = {}
 ): NumberFieldComponent {
   return {
     name: 'year',
@@ -184,7 +330,7 @@ export function buildNumberFieldComponent(
 }
 
 export function buildDateComponent(
-  partialComponent: Partial<DatePartsFieldComponent>
+  partialComponent: Partial<DatePartsFieldComponent> = {}
 ): DatePartsFieldComponent {
   return {
     name: 'bcdefg',
@@ -196,7 +342,7 @@ export function buildDateComponent(
 }
 
 export function buildRadiosComponent(
-  partialComponent: Partial<RadiosFieldComponent>
+  partialComponent: Partial<RadiosFieldComponent> = {}
 ): RadiosFieldComponent {
   return {
     name: 'cdefgh',

package/src/__stubs__/pages.ts

@@ -33,13 +33,13 @@ export function buildQuestionPage(
 export function buildSummaryPage(
   partialSummaryPage: Partial<PageSummary> = {}
 ): PageSummary {
-  const pageSummary: PageSummary = {
+  return {
     id: '449a45f6-4541-4a46-91bd-8b8931b07b50',
     title: 'Summary page',
+    ...partialSummaryPage,
     path: ControllerPath.Summary,
     controller: ControllerType.Summary
   }
-  return { ...pageSummary, ...partialSummaryPage }
 }
 
 /**
@@ -50,7 +50,7 @@ export function buildSummaryPage(
 export function buildFileUploadPage(
   partialFileUploadPage: Partial<PageFileUpload> = {}
 ): PageFileUpload {
-  const fileUploadPage: PageFileUpload = {
+  return {
     id: '85e5c8da-88f5-4009-a821-7d7de1364318',
     title: '',
     path: '/supporting-evidence',
@@ -69,13 +69,9 @@ export function buildFileUploadPage(
         id: '4189b8a1-1a04-4f74-a7a0-dd23012a0ee0'
       })
     ],
-    controller: ControllerType.FileUpload,
-    next: []
-  }
-
-  return {
-    ...fileUploadPage,
-    ...partialFileUploadPage
+    next: [],
+    ...partialFileUploadPage,
+    controller: ControllerType.FileUpload
   }
 }
 
@@ -87,7 +83,7 @@ export function buildFileUploadPage(
 export function buildRepeaterPage(
   partialRepeaterPage: Partial<PageRepeat> = {}
 ): PageRepeat {
-  const repeaterPage: PageRepeat = {
+  return {
     title: 'Repeater Page',
     path: '/repeater-page',
     components: [
@@ -104,15 +100,11 @@ export function buildRepeaterPage(
     ],
     next: [],
     id: '32888028-61db-40fc-b255-80bc67829d31',
-    controller: ControllerType.Repeat,
     repeat: {
       options: { name: 'fawfed', title: 'Simple question responses' },
       schema: { min: 1, max: 3 }
-    }
-  }
-
-  return {
-    ...repeaterPage,
-    ...partialRepeaterPage
+    },
+    ...partialRepeaterPage,
+    controller: ControllerType.Repeat
   }
 }

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

@@ -2,7 +2,11 @@ import Joi, { type LanguageMessages } from 'joi'
 import { v4 as uuidV4 } from 'uuid'
 
 import { ComponentType } from '~/src/components/enums.js'
-import { type ComponentDef } from '~/src/components/types.js'
+import {
+  type ComponentDef,
+  type ContentComponentsDef,
+  type FileUploadFieldComponent
+} from '~/src/components/types.js'
 import {
   type ConditionData,
   type ConditionDataV2,
@@ -18,6 +22,7 @@ import {
   type RelativeDateValueData
 } from '~/src/conditions/types.js'
 import {
+  SchemaVersion,
   type ConditionWrapper,
   type ConditionWrapperV2,
   type Event,
@@ -34,6 +39,7 @@ import {
   type RepeatSchema,
   type Section
 } from '~/src/form/form-definition/types.js'
+import { ControllerType } from '~/src/pages/enums.js'
 import { hasComponents } from '~/src/pages/helpers.js'
 
 const idSchemaOptional = Joi.string().uuid()
@@ -449,6 +455,26 @@ export const componentSchemaV2 = componentSchema
   })
   .description('Component schema for V2 forms')
 
+export const fileUploadComponentSchema = componentSchemaV2.keys({
+  type: Joi.string<ComponentType.FileUploadField>()
+    .trim()
+    .valid(ComponentType.FileUploadField)
+    .required()
+    .description('Component that can only be a FileUploadField')
+})
+
+export const contentComponentSchema = componentSchemaV2.keys({
+  type: Joi.string<ComponentType>()
+    .trim()
+    .valid(ComponentType.Details)
+    .valid(ComponentType.Html)
+    .valid(ComponentType.Markdown)
+    .valid(ComponentType.InsetText)
+    .valid(ComponentType.List)
+    .required()
+    .description('Content only component type (Details, Html, Markdown, etc.)')
+})
+
 const nextSchema = Joi.object<Link>()
   .description('Navigation link defining where to go after completing a page')
   .keys({
@@ -549,6 +575,19 @@ const eventsSchema = Joi.object<Events>()
       .description('Event handler triggered when the page data is saved')
   })
 
+export const pageUploadComponentsSchema = Joi.array<
+  FileUploadFieldComponent | ContentComponentsDef
+>()
+  .items(
+    fileUploadComponentSchema.required(),
+    contentComponentSchema.optional()
+  )
+  .unique('name')
+  .unique('id')
+  .min(1)
+  .max(2)
+  .description('Components allowed on Page Upload schema')
+
 /**
  * `/status` is a special route for providing a user's application status.
  *  It should not be configured via the designer.
@@ -619,11 +658,19 @@ export const pageSchemaV2 = pageSchema
       .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')
-      .description('Components schema for V2 forms'),
+    components: Joi.when('controller', {
+      switch: [
+        {
+          is: Joi.string().trim().valid(ControllerType.FileUpload).required(),
+          then: pageUploadComponentsSchema
+        }
+      ],
+      otherwise: Joi.array<ComponentDef>()
+        .items(componentSchemaV2)
+        .unique('name')
+        .unique('id')
+        .description('Components schema for V2 forms')
+    }),
     condition: Joi.string()
       .trim()
       .valid(conditionIdRef)
@@ -796,6 +843,11 @@ export const formDefinitionSchema = Joi.object<FormDefinition>()
       .allow('V1', 'V2')
       .default('V1')
       .description('Form engine version to use (V1 or V2)'),
+    schema: Joi.number()
+      .integer()
+      .valid(SchemaVersion.V1)
+      .default(SchemaVersion.V1)
+      .description('Form schema version to use (1 or 2)'),
     name: Joi.string()
       .trim()
       .allow('')
@@ -856,6 +908,10 @@ export const formDefinitionSchema = Joi.object<FormDefinition>()
 
 export const formDefinitionV2Schema = formDefinitionSchema
   .keys({
+    schema: Joi.number()
+      .integer()
+      .valid(SchemaVersion.V2)
+      .description('Form schema version to use (2)'),
     pages: Joi.array<Page>()
       .items(pageSchemaV2)
       .required()

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

@@ -11,6 +11,11 @@ export enum Engine {
   V2 = 'V2'
 }
 
+export enum SchemaVersion {
+  V1 = 1,
+  V2 = 2
+}
+
 export interface Link {
   path: string
   condition?: string
@@ -174,6 +179,7 @@ export interface ConditionWrapperV2 {
  */
 export interface FormDefinition {
   engine?: Engine
+  schema?: SchemaVersion
   pages: Page[]
   conditions: (ConditionWrapper | ConditionWrapperV2)[]
   lists: List[]