@defra/forms-engine-plugin 4.23.0 → 5.0.0-alpha

package/.server/server/forms/register-as-a-unicorn-breeder.yaml

@@ -242,20 +242,6 @@ pages:
         content: 'Fill in this field'
         options:
           required: false
-    next:
-      - path: '/pay-for-your-licence'
-  - title: Pay for your licence
-    path: '/pay-for-your-licence'
-    section: section
-    components:
-      - name: licencePayment
-        title: Unicorn breeder licence fee
-        type: PaymentField
-        hint: You'll be redirected to GOV.UK Pay to complete your payment
-        options:
-          required: true
-          amount: 50
-          description: Unicorn breeder annual licence fee
     next:
       - path: '/summary'
 conditions:

package/.server/server/forms/simple-form.yaml

@@ -3,6 +3,57 @@ name: Page events
 engine: V2
 schema: 2
 startPage: '/summary'
+metadata:
+  language: en-GB
+  translations:
+    cy:
+      components:
+        1fb8e182-c709-4792-8f83-e01d8b1fee1a:
+          title: Beth yw eich enw cyntaf?
+          shortDescription: Eich enw cyntaf
+        b68df7f1-d4f4-4c17-83c8-402f584906c9:
+          title: Beth yw eich enw olaf?
+          shortDescription: Eich enw olaf
+        987c1234-56d7-89e0-1234-56789abcdef0:
+          title: Llwytho copi o'ch pasbort
+          shortDescription: Llwytho pasbort
+        987c1234-56d7-89e0-1234-56789abcdef1:
+          title: Llwytho copi o'ch trwydded yrru
+          shortDescription: Llwytho trwydded yrru
+        00738799-3489-4ab2-a57b-542eecb31bfa:
+          title: Pryd yw pen-blwydd {{ applicantFirstName }} {{ applicantLastName }}?
+          shortDescription: Eich pen-blwydd
+        123e4567-e89b-12d3-a456-426614174000:
+          title: Beth yw eich cyfeiriad?
+          shortDescription: Eich cyfeiriad
+        aabbccdd-1122-3344-5566-778899001123:
+          title: Oes gennych chi drwydded yrru?
+          shortDescription: Trwydded yrru
+        aabbccdd-1122-3344-5566-778899001124:
+          title: Sut rydych chi fel arfer yn teithio?
+          shortDescription: Eich ffordd o deithio
+      listItems:
+        aabbccdd-1122-3344-5566-778899001126:
+          text: Car
+        aabbccdd-1122-3344-5566-778899001127:
+          text: Bws
+        aabbccdd-1122-3344-5566-778899001128:
+          text: Trên
+      pages:
+        622a35ec-3795-418a-81f3-a45746959045:
+          title: Eich enw
+        23456789-0abc-def1-2345-67890abcdef1:
+          title: Llwytho copi o'ch pasbort
+        23456789-0abc-def1-2345-67890abcdef2:
+          title: Llwytho copi o'ch trwydded yrru
+        da0fbdb4-a2de-4650-be16-9ba552af135f:
+          title: Dyddiad geni
+        449a45f6-4541-4a46-91bd-8b8931b07b50:
+          title: Crynodeb
+        123e4567-e89b-12d3-a456-426614174001:
+          title: Ble rydych chi'n byw?
+        aabbccdd-1122-3344-5566-778899001122:
+          title: Amdanoch chi
 pages:
   - title: Your name
     path: '/your-name'
@@ -36,6 +87,21 @@ pages:
         id: e18116e0-7c3e-416a-af42-6f229017c5b1
     next: []
     id: 622a35ec-3795-418a-81f3-a45746959045
+  - title: Where do you live?
+    path: '/where-you-live'
+    components:
+      - type: UkAddressField
+        title: What is your address?
+        name: applicantAddress
+        shortDescription: Your address
+        hint: ''
+        options:
+          required: true
+          usePostcodeLookup: true
+        schema: {}
+        id: 123e4567-e89b-12d3-a456-426614174000
+    next: []
+    id: 123e4567-e89b-12d3-a456-426614174001
   - title: Upload a copy of your passport
     controller: FileUploadPageController
     path: '/upload-passport'
@@ -46,7 +112,7 @@ pages:
         shortDescription: Upload passport
         hint: ''
         options:
-          required: true
+          required: false
         schema: {}
         id: 987c1234-56d7-89e0-1234-56789abcdef0
     id: 23456789-0abc-def1-2345-67890abcdef1
@@ -60,7 +126,7 @@ pages:
         shortDescription: Upload drivers licence
         hint: ''
         options:
-          required: true
+          required: false
         schema: {}
         id: 987c1234-56d7-89e0-1234-56789abcdef1
     id: 23456789-0abc-def1-2345-67890abcdef2
@@ -78,6 +144,29 @@ pages:
         id: '00738799-3489-4ab2-a57b-542eecb31bfa'
     next: []
     id: da0fbdb4-a2de-4650-be16-9ba552af135f
+  - title: About you
+    path: '/about-you'
+    components:
+      - type: YesNoField
+        title: Do you have a driving licence?
+        name: hasDrivingLicence
+        shortDescription: Driving licence
+        hint: ''
+        options: {}
+        schema: {}
+        id: aabbccdd-1122-3344-5566-778899001123
+      - type: RadiosField
+        title: How do you usually travel?
+        name: travelMethod
+        shortDescription: Your travel method
+        hint: ''
+        options:
+          required: true
+        schema: {}
+        list: aabbccdd-1122-3344-5566-778899001125
+        id: aabbccdd-1122-3344-5566-778899001124
+    next: []
+    id: aabbccdd-1122-3344-5566-778899001122
   - title: ''
     path: '/notification-demo'
     components:
@@ -103,4 +192,18 @@ pages:
     controller: SummaryPageController
 conditions: []
 sections: []
-lists: []
+lists:
+  - id: aabbccdd-1122-3344-5566-778899001125
+    name: travelMethods
+    title: Travel methods
+    type: string
+    items:
+      - id: aabbccdd-1122-3344-5566-778899001126
+        text: Car
+        value: car
+      - id: aabbccdd-1122-3344-5566-778899001127
+        text: Bus
+        value: bus
+      - id: aabbccdd-1122-3344-5566-778899001128
+        text: Train
+        value: train

package/.server/server/plugins/engine/components/AutocompleteField.d.ts

@@ -1,31 +1,31 @@
 import { type AutocompleteFieldComponent } from '@defra/forms-model';
 import { SelectField } from '../../../../server/plugins/engine/components/SelectField.js';
-import { type FormPayload, type FormSubmissionError } from '../../../../server/plugins/engine/types.js';
+import { type RenderContext } from '../../../../server/plugins/engine/components/types.js';
 export declare class AutocompleteField extends SelectField {
     options: AutocompleteFieldComponent['options'];
     constructor(def: AutocompleteFieldComponent, props: ConstructorParameters<typeof SelectField>[1]);
-    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+    getViewModel(context: RenderContext): {
         formGroup: {
             classes?: string;
             attributes?: string | Record<string, string>;
         };
-        items: import("./types.js").ListItem[];
+        items: import("../../../../server/plugins/engine/components/types.js").ListItem[];
         label: {
             text: string;
         };
         id: string;
         name: string;
-        value: import("../../../../server/plugins/engine/types.js").FormValue;
+        value: import("../types.js").FormValue;
         type?: string;
         hint?: {
             id?: string;
             text: string;
         };
-        prefix?: import("./types.js").ComponentText;
-        suffix?: import("./types.js").ComponentText;
+        prefix?: import("../../../../server/plugins/engine/components/types.js").ComponentText;
+        suffix?: import("../../../../server/plugins/engine/components/types.js").ComponentText;
         classes?: string;
         condition?: string;
-        errors?: FormSubmissionError[];
+        errors?: import("../types.js").FormSubmissionError[];
         errorMessage?: {
             text: string;
         };
@@ -38,19 +38,19 @@ export declare class AutocompleteField extends SelectField {
             accept?: string;
             inputmode?: string;
         };
-        content?: import("./types.js").Content | import("./types.js").Content[] | string;
+        content?: import("../../../../server/plugins/engine/components/types.js").Content | import("../../../../server/plugins/engine/components/types.js").Content[] | string;
         maxlength?: number;
         maxwords?: number;
         rows?: number;
         fieldset?: {
             attributes?: string | Record<string, string>;
-            legend?: import("./types.js").Label;
+            legend?: import("../../../../server/plugins/engine/components/types.js").Label;
         };
         showFieldsetError?: boolean;
-        components?: import("./types.js").ComponentViewModel[];
+        components?: import("../../../../server/plugins/engine/components/types.js").ComponentViewModel[];
         upload?: {
             count: number;
-            summaryList: import("../../../../server/plugins/engine/types.js").SummaryList;
+            summaryList: import("../types.js").SummaryList;
         };
     };
 }

package/.server/server/plugins/engine/components/AutocompleteField.js

@@ -19,8 +19,8 @@ export class AutocompleteField extends SelectField {
     this.options = options;
     this.formSchema = formSchema;
   }
-  getViewModel(payload, errors) {
-    const viewModel = super.getViewModel(payload, errors);
+  getViewModel(context) {
+    const viewModel = super.getViewModel(context);
     let {
       formGroup
     } = viewModel;

package/.server/server/plugins/engine/components/AutocompleteField.js.map

@@ -1 +1 @@
-{"version":3,"file":"AutocompleteField.js","names":["SelectField","messageTemplate","AutocompleteField","constructor","def","props","options","formSchema","required","messages","customValidationMessages","getViewModel","payload","errors","viewModel","formGroup","attributes"],"sources":["../../../../../src/server/plugins/engine/components/AutocompleteField.ts"],"sourcesContent":["import { type AutocompleteFieldComponent } from '@defra/forms-model'\n\nimport { SelectField } from '~/src/server/plugins/engine/components/SelectField.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type FormPayload,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\n\nexport class AutocompleteField extends SelectField {\n  declare options: AutocompleteFieldComponent['options']\n\n  constructor(\n    def: AutocompleteFieldComponent,\n    props: ConstructorParameters<typeof SelectField>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n    let { formSchema } = this\n\n    if (options.required !== false) {\n      const messages = options.customValidationMessages\n\n      formSchema = formSchema.messages({\n        'any.only':\n          messages?.['any.only'] ?? (messageTemplate.required as string),\n        'any.required':\n          messages?.['any.required'] ?? (messageTemplate.required as string)\n      })\n    }\n\n    this.options = options\n    this.formSchema = formSchema\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const viewModel = super.getViewModel(payload, errors)\n    let { formGroup } = viewModel\n\n    formGroup ??= {}\n    formGroup.attributes = {\n      'data-module': 'govuk-accessible-autocomplete'\n    }\n\n    return {\n      ...viewModel,\n      formGroup\n    }\n  }\n}\n"],"mappings":"AAEA,SAASA,WAAW;AACpB,SAASC,eAAe;AAMxB,OAAO,MAAMC,iBAAiB,SAASF,WAAW,CAAC;EAGjDG,WAAWA,CACTC,GAA+B,EAC/BC,KAAmD,EACnD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IACvB,IAAI;MAAEG;IAAW,CAAC,GAAG,IAAI;IAEzB,IAAID,OAAO,CAACE,QAAQ,KAAK,KAAK,EAAE;MAC9B,MAAMC,QAAQ,GAAGH,OAAO,CAACI,wBAAwB;MAEjDH,UAAU,GAAGA,UAAU,CAACE,QAAQ,CAAC;QAC/B,UAAU,EACRA,QAAQ,GAAG,UAAU,CAAC,IAAKR,eAAe,CAACO,QAAmB;QAChE,cAAc,EACZC,QAAQ,GAAG,cAAc,CAAC,IAAKR,eAAe,CAACO;MACnD,CAAC,CAAC;IACJ;IAEA,IAAI,CAACF,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,UAAU,GAAGA,UAAU;EAC9B;EAEAI,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,IAAI;MAAEE;IAAU,CAAC,GAAGD,SAAS;IAE7BC,SAAS,KAAK,CAAC,CAAC;IAChBA,SAAS,CAACC,UAAU,GAAG;MACrB,aAAa,EAAE;IACjB,CAAC;IAED,OAAO;MACL,GAAGF,SAAS;MACZC;IACF,CAAC;EACH;AACF","ignoreList":[]}
+{"version":3,"file":"AutocompleteField.js","names":["SelectField","messageTemplate","AutocompleteField","constructor","def","props","options","formSchema","required","messages","customValidationMessages","getViewModel","context","viewModel","formGroup","attributes"],"sources":["../../../../../src/server/plugins/engine/components/AutocompleteField.ts"],"sourcesContent":["import { type AutocompleteFieldComponent } from '@defra/forms-model'\n\nimport { SelectField } from '~/src/server/plugins/engine/components/SelectField.js'\nimport { type RenderContext } from '~/src/server/plugins/engine/components/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\n\nexport class AutocompleteField extends SelectField {\n  declare options: AutocompleteFieldComponent['options']\n\n  constructor(\n    def: AutocompleteFieldComponent,\n    props: ConstructorParameters<typeof SelectField>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n    let { formSchema } = this\n\n    if (options.required !== false) {\n      const messages = options.customValidationMessages\n\n      formSchema = formSchema.messages({\n        'any.only':\n          messages?.['any.only'] ?? (messageTemplate.required as string),\n        'any.required':\n          messages?.['any.required'] ?? (messageTemplate.required as string)\n      })\n    }\n\n    this.options = options\n    this.formSchema = formSchema\n  }\n\n  getViewModel(context: RenderContext) {\n    const viewModel = super.getViewModel(context)\n    let { formGroup } = viewModel\n\n    formGroup ??= {}\n    formGroup.attributes = {\n      'data-module': 'govuk-accessible-autocomplete'\n    }\n\n    return {\n      ...viewModel,\n      formGroup\n    }\n  }\n}\n"],"mappings":"AAEA,SAASA,WAAW;AAEpB,SAASC,eAAe;AAExB,OAAO,MAAMC,iBAAiB,SAASF,WAAW,CAAC;EAGjDG,WAAWA,CACTC,GAA+B,EAC/BC,KAAmD,EACnD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IACvB,IAAI;MAAEG;IAAW,CAAC,GAAG,IAAI;IAEzB,IAAID,OAAO,CAACE,QAAQ,KAAK,KAAK,EAAE;MAC9B,MAAMC,QAAQ,GAAGH,OAAO,CAACI,wBAAwB;MAEjDH,UAAU,GAAGA,UAAU,CAACE,QAAQ,CAAC;QAC/B,UAAU,EACRA,QAAQ,GAAG,UAAU,CAAC,IAAKR,eAAe,CAACO,QAAmB;QAChE,cAAc,EACZC,QAAQ,GAAG,cAAc,CAAC,IAAKR,eAAe,CAACO;MACnD,CAAC,CAAC;IACJ;IAEA,IAAI,CAACF,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,UAAU,GAAGA,UAAU;EAC9B;EAEAI,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAMC,SAAS,GAAG,KAAK,CAACF,YAAY,CAACC,OAAO,CAAC;IAC7C,IAAI;MAAEE;IAAU,CAAC,GAAGD,SAAS;IAE7BC,SAAS,KAAK,CAAC,CAAC;IAChBA,SAAS,CAACC,UAAU,GAAG;MACrB,aAAa,EAAE;IACjB,CAAC;IAED,OAAO;MACL,GAAGF,SAAS;MACZC;IACF,CAAC;EACH;AACF","ignoreList":[]}

package/.server/server/plugins/engine/components/CheckboxesField.d.ts

@@ -1,6 +1,7 @@
 import { type CheckboxesFieldComponent, type Item } from '@defra/forms-model';
 import { type ArraySchema } from 'joi';
 import { SelectionControlField } from '../../../../server/plugins/engine/components/SelectionControlField.js';
+import { type Translator } from '../../../../server/plugins/engine/i18n/types.js';
 import { type ErrorMessageTemplateList, type FormState, type FormStateValue, type FormSubmissionState } from '../../../../server/plugins/engine/types.js';
 export declare class CheckboxesField extends SelectionControlField {
     options: CheckboxesFieldComponent['options'];
@@ -10,9 +11,9 @@ export declare class CheckboxesField extends SelectionControlField {
     constructor(def: CheckboxesFieldComponent, props: ConstructorParameters<typeof SelectionControlField>[1]);
     getFormValueFromState(state: FormSubmissionState): (string | number | boolean)[] | undefined;
     getFormValue(value?: FormStateValue | FormState): (string | number | boolean)[] | undefined;
-    getDisplayStringFromFormValue(selected: (string | number | boolean)[] | undefined): string;
+    getDisplayStringFromFormValue(selected: (string | number | boolean)[] | undefined, translator: Translator): string;
     getContextValueFromFormValue(values: (string | number | boolean)[] | undefined): (string | number | boolean)[];
-    getDisplayStringFromState(state: FormSubmissionState): string;
+    getDisplayStringFromState(state: FormSubmissionState, translator: Translator): string;
     getContextValueFromState(state: FormSubmissionState): (string | number | boolean)[];
     /**
      * For error preview page that shows all possible errors on a component

package/.server/server/plugins/engine/components/CheckboxesField.js

@@ -52,16 +52,14 @@ export class CheckboxesField extends SelectionControlField {
   getFormValue(value) {
     return this.isValue(value) ? value : undefined;
   }
-  getDisplayStringFromFormValue(selected) {
+  getDisplayStringFromFormValue(selected, translator) {
     const {
       items
     } = this;
     if (!selected) {
       return '';
     }
-
-    // Map selected values to text
-    return items.filter(item => selected.includes(item.value)).map(item => item.text).join(', ');
+    return items.filter(item => selected.includes(item.value)).map(item => translator.tListItem(item, 'text') || item.text).join(', ');
   }
   getContextValueFromFormValue(values) {
     /**
@@ -77,12 +75,9 @@ export class CheckboxesField extends SelectionControlField {
      */
     return values ?? [];
   }
-  getDisplayStringFromState(state) {
-    // Selected checkbox values
+  getDisplayStringFromState(state, translator) {
     const selected = this.getFormValueFromState(state) ?? [];
-
-    // Map selected values to text
-    return this.getDisplayStringFromFormValue(selected);
+    return this.getDisplayStringFromFormValue(selected, translator);
   }
   getContextValueFromState(state) {
     const values = this.getFormValueFromState(state);

package/.server/server/plugins/engine/components/CheckboxesField.js.map

@@ -1 +1 @@
-{"version":3,"file":"CheckboxesField.js","names":["joi","isFormValue","SelectionControlField","messageTemplate","CheckboxesField","constructor","def","props","listType","type","options","schema","formSchema","array","itemsSchema","valid","values","label","items","single","required","messages","arrayMin","arrayMax","arrayLength","optional","length","min","max","default","stateSchema","allow","getFormValueFromState","state","name","getFormValue","selected","filter","item","includes","value","map","undefined","isValue","getDisplayStringFromFormValue","text","join","getContextValueFromFormValue","getDisplayStringFromState","getContextValueFromState","getAllPossibleErrors","parentErrors","advancedSettingsErrors","template","Array","isArray","every"],"sources":["../../../../../src/server/plugins/engine/components/CheckboxesField.ts"],"sourcesContent":["import { type CheckboxesFieldComponent, type Item } from '@defra/forms-model'\nimport joi, { type ArraySchema } from 'joi'\n\nimport { isFormValue } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { SelectionControlField } from '~/src/server/plugins/engine/components/SelectionControlField.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { type QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nexport class CheckboxesField extends SelectionControlField {\n  declare options: CheckboxesFieldComponent['options']\n  declare schema: CheckboxesFieldComponent['schema']\n  declare formSchema: ArraySchema<string> | ArraySchema<number>\n  declare stateSchema: ArraySchema<string> | ArraySchema<number>\n\n  constructor(\n    def: CheckboxesFieldComponent,\n    props: ConstructorParameters<typeof SelectionControlField>[1]\n  ) {\n    super(def, props)\n\n    const { listType: type } = this\n    const { options, schema } = def\n\n    let formSchema =\n      type === 'string' ? joi.array<string>() : joi.array<number>()\n\n    const itemsSchema = joi[type]()\n      .valid(...this.values)\n      .label(this.label)\n\n    formSchema = formSchema\n      .items(itemsSchema)\n      .single()\n      .label(this.label)\n      .required()\n      .messages({\n        'array.min': messageTemplate.arrayMin as string,\n        'array.max': messageTemplate.arrayMax as string,\n        'array.length': messageTemplate.arrayLength as string\n      })\n\n    if (options.required === false) {\n      formSchema = formSchema.optional()\n    }\n\n    if (typeof schema?.length === 'number') {\n      formSchema = formSchema.length(schema.length)\n    } else {\n      if (typeof schema?.min === 'number') {\n        formSchema = formSchema.min(schema.min)\n      }\n\n      if (typeof schema?.max === 'number') {\n        formSchema = formSchema.max(schema.max)\n      }\n    }\n\n    this.formSchema = formSchema.default([])\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const { items, name } = this\n\n    // State checkbox values\n    const values = this.getFormValue(state[name]) ?? []\n\n    // Map (or discard) state values to item values\n    const selected = items\n      .filter((item) => values.includes(item.value))\n      .map((item) => item.value)\n\n    return selected.length ? selected : undefined\n  }\n\n  getFormValue(value?: FormStateValue | FormState) {\n    return this.isValue(value) ? value : undefined\n  }\n\n  getDisplayStringFromFormValue(\n    selected: (string | number | boolean)[] | undefined\n  ) {\n    const { items } = this\n\n    if (!selected) {\n      return ''\n    }\n\n    // Map selected values to text\n    return items\n      .filter((item) => selected.includes(item.value))\n      .map((item) => item.text)\n      .join(', ')\n  }\n\n  getContextValueFromFormValue(\n    values: (string | number | boolean)[] | undefined\n  ): (string | number | boolean)[] {\n    /**\n     * For evaluation context purposes, optional {@link CheckboxesField}\n     * with an undefined value (i.e. nothing selected) should default to [].\n     * This way conditions are not evaluated against `undefined` which throws errors.\n     * Currently these errors are caught and the evaluation returns default `false`.\n     * @see {@link QuestionPageController.getNextPath} for `undefined` return value\n     * @see {@link FormModel.makeCondition} for try/catch block with default `false`\n     * For negative conditions this is a problem because E.g.\n     * The condition: 'selectedchecks' does not contain 'someval'\n     * should return true IF 'selectedchecks' is undefined, not throw and return false.\n     */\n    return values ?? []\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState) {\n    // Selected checkbox values\n    const selected = this.getFormValueFromState(state) ?? []\n\n    // Map selected values to text\n    return this.getDisplayStringFromFormValue(selected)\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    const values = this.getFormValueFromState(state)\n\n    return this.getContextValueFromFormValue(values)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return CheckboxesField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    const parentErrors = SelectionControlField.getAllPossibleErrors()\n\n    return {\n      ...parentErrors,\n      advancedSettingsErrors: [\n        ...parentErrors.advancedSettingsErrors,\n        { type: 'array.min', template: messageTemplate.arrayMin },\n        { type: 'array.max', template: messageTemplate.arrayMax },\n        { type: 'array.length', template: messageTemplate.arrayLength }\n      ]\n    }\n  }\n\n  isValue(value?: FormStateValue | FormState): value is Item['value'][] {\n    if (!Array.isArray(value)) {\n      return false\n    }\n\n    // Skip checks when empty\n    if (!value.length) {\n      return true\n    }\n\n    return value.every(isFormValue)\n  }\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAA4B,KAAK;AAE3C,SAASC,WAAW;AACpB,SAASC,qBAAqB;AAG9B,SAASC,eAAe;AAQxB,OAAO,MAAMC,eAAe,SAASF,qBAAqB,CAAC;EAMzDG,WAAWA,CACTC,GAA6B,EAC7BC,KAA6D,EAC7D;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,QAAQ,EAAEC;IAAK,CAAC,GAAG,IAAI;IAC/B,MAAM;MAAEC,OAAO;MAAEC;IAAO,CAAC,GAAGL,GAAG;IAE/B,IAAIM,UAAU,GACZH,IAAI,KAAK,QAAQ,GAAGT,GAAG,CAACa,KAAK,CAAS,CAAC,GAAGb,GAAG,CAACa,KAAK,CAAS,CAAC;IAE/D,MAAMC,WAAW,GAAGd,GAAG,CAACS,IAAI,CAAC,CAAC,CAAC,CAC5BM,KAAK,CAAC,GAAG,IAAI,CAACC,MAAM,CAAC,CACrBC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC;IAEpBL,UAAU,GAAGA,UAAU,CACpBM,KAAK,CAACJ,WAAW,CAAC,CAClBK,MAAM,CAAC,CAAC,CACRF,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBG,QAAQ,CAAC,CAAC,CACVC,QAAQ,CAAC;MACR,WAAW,EAAElB,eAAe,CAACmB,QAAkB;MAC/C,WAAW,EAAEnB,eAAe,CAACoB,QAAkB;MAC/C,cAAc,EAAEpB,eAAe,CAACqB;IAClC,CAAC,CAAC;IAEJ,IAAId,OAAO,CAACU,QAAQ,KAAK,KAAK,EAAE;MAC9BR,UAAU,GAAGA,UAAU,CAACa,QAAQ,CAAC,CAAC;IACpC;IAEA,IAAI,OAAOd,MAAM,EAAEe,MAAM,KAAK,QAAQ,EAAE;MACtCd,UAAU,GAAGA,UAAU,CAACc,MAAM,CAACf,MAAM,CAACe,MAAM,CAAC;IAC/C,CAAC,MAAM;MACL,IAAI,OAAOf,MAAM,EAAEgB,GAAG,KAAK,QAAQ,EAAE;QACnCf,UAAU,GAAGA,UAAU,CAACe,GAAG,CAAChB,MAAM,CAACgB,GAAG,CAAC;MACzC;MAEA,IAAI,OAAOhB,MAAM,EAAEiB,GAAG,KAAK,QAAQ,EAAE;QACnChB,UAAU,GAAGA,UAAU,CAACgB,GAAG,CAACjB,MAAM,CAACiB,GAAG,CAAC;MACzC;IACF;IAEA,IAAI,CAAChB,UAAU,GAAGA,UAAU,CAACiB,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGlB,UAAU,CAACiB,OAAO,CAAC,IAAI,CAAC,CAACE,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACrB,OAAO,GAAGA,OAAO;EACxB;EAEAsB,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAM;MAAEf,KAAK;MAAEgB;IAAK,CAAC,GAAG,IAAI;;IAE5B;IACA,MAAMlB,MAAM,GAAG,IAAI,CAACmB,YAAY,CAACF,KAAK,CAACC,IAAI,CAAC,CAAC,IAAI,EAAE;;IAEnD;IACA,MAAME,QAAQ,GAAGlB,KAAK,CACnBmB,MAAM,CAAEC,IAAI,IAAKtB,MAAM,CAACuB,QAAQ,CAACD,IAAI,CAACE,KAAK,CAAC,CAAC,CAC7CC,GAAG,CAAEH,IAAI,IAAKA,IAAI,CAACE,KAAK,CAAC;IAE5B,OAAOJ,QAAQ,CAACV,MAAM,GAAGU,QAAQ,GAAGM,SAAS;EAC/C;EAEAP,YAAYA,CAACK,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACG,OAAO,CAACH,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAChD;EAEAE,6BAA6BA,CAC3BR,QAAmD,EACnD;IACA,MAAM;MAAElB;IAAM,CAAC,GAAG,IAAI;IAEtB,IAAI,CAACkB,QAAQ,EAAE;MACb,OAAO,EAAE;IACX;;IAEA;IACA,OAAOlB,KAAK,CACTmB,MAAM,CAAEC,IAAI,IAAKF,QAAQ,CAACG,QAAQ,CAACD,IAAI,CAACE,KAAK,CAAC,CAAC,CAC/CC,GAAG,CAAEH,IAAI,IAAKA,IAAI,CAACO,IAAI,CAAC,CACxBC,IAAI,CAAC,IAAI,CAAC;EACf;EAEAC,4BAA4BA,CAC1B/B,MAAiD,EAClB;IAC/B;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACI,OAAOA,MAAM,IAAI,EAAE;EACrB;EAEAgC,yBAAyBA,CAACf,KAA0B,EAAE;IACpD;IACA,MAAMG,QAAQ,GAAG,IAAI,CAACJ,qBAAqB,CAACC,KAAK,CAAC,IAAI,EAAE;;IAExD;IACA,OAAO,IAAI,CAACW,6BAA6B,CAACR,QAAQ,CAAC;EACrD;EAEAa,wBAAwBA,CAAChB,KAA0B,EAAE;IACnD,MAAMjB,MAAM,GAAG,IAAI,CAACgB,qBAAqB,CAACC,KAAK,CAAC;IAEhD,OAAO,IAAI,CAACc,4BAA4B,CAAC/B,MAAM,CAAC;EAClD;;EAEA;AACF;AACA;EACEkC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO9C,eAAe,CAAC8C,oBAAoB,CAAC,CAAC;EAC/C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,MAAMC,YAAY,GAAGjD,qBAAqB,CAACgD,oBAAoB,CAAC,CAAC;IAEjE,OAAO;MACL,GAAGC,YAAY;MACfC,sBAAsB,EAAE,CACtB,GAAGD,YAAY,CAACC,sBAAsB,EACtC;QAAE3C,IAAI,EAAE,WAAW;QAAE4C,QAAQ,EAAElD,eAAe,CAACmB;MAAS,CAAC,EACzD;QAAEb,IAAI,EAAE,WAAW;QAAE4C,QAAQ,EAAElD,eAAe,CAACoB;MAAS,CAAC,EACzD;QAAEd,IAAI,EAAE,cAAc;QAAE4C,QAAQ,EAAElD,eAAe,CAACqB;MAAY,CAAC;IAEnE,CAAC;EACH;EAEAmB,OAAOA,CAACH,KAAkC,EAA4B;IACpE,IAAI,CAACc,KAAK,CAACC,OAAO,CAACf,KAAK,CAAC,EAAE;MACzB,OAAO,KAAK;IACd;;IAEA;IACA,IAAI,CAACA,KAAK,CAACd,MAAM,EAAE;MACjB,OAAO,IAAI;IACb;IAEA,OAAOc,KAAK,CAACgB,KAAK,CAACvD,WAAW,CAAC;EACjC;AACF","ignoreList":[]}
+{"version":3,"file":"CheckboxesField.js","names":["joi","isFormValue","SelectionControlField","messageTemplate","CheckboxesField","constructor","def","props","listType","type","options","schema","formSchema","array","itemsSchema","valid","values","label","items","single","required","messages","arrayMin","arrayMax","arrayLength","optional","length","min","max","default","stateSchema","allow","getFormValueFromState","state","name","getFormValue","selected","filter","item","includes","value","map","undefined","isValue","getDisplayStringFromFormValue","translator","tListItem","text","join","getContextValueFromFormValue","getDisplayStringFromState","getContextValueFromState","getAllPossibleErrors","parentErrors","advancedSettingsErrors","template","Array","isArray","every"],"sources":["../../../../../src/server/plugins/engine/components/CheckboxesField.ts"],"sourcesContent":["import { type CheckboxesFieldComponent, type Item } from '@defra/forms-model'\nimport joi, { type ArraySchema } from 'joi'\n\nimport { isFormValue } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { SelectionControlField } from '~/src/server/plugins/engine/components/SelectionControlField.js'\nimport { type Translator } from '~/src/server/plugins/engine/i18n/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { type QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nexport class CheckboxesField extends SelectionControlField {\n  declare options: CheckboxesFieldComponent['options']\n  declare schema: CheckboxesFieldComponent['schema']\n  declare formSchema: ArraySchema<string> | ArraySchema<number>\n  declare stateSchema: ArraySchema<string> | ArraySchema<number>\n\n  constructor(\n    def: CheckboxesFieldComponent,\n    props: ConstructorParameters<typeof SelectionControlField>[1]\n  ) {\n    super(def, props)\n\n    const { listType: type } = this\n    const { options, schema } = def\n\n    let formSchema =\n      type === 'string' ? joi.array<string>() : joi.array<number>()\n\n    const itemsSchema = joi[type]()\n      .valid(...this.values)\n      .label(this.label)\n\n    formSchema = formSchema\n      .items(itemsSchema)\n      .single()\n      .label(this.label)\n      .required()\n      .messages({\n        'array.min': messageTemplate.arrayMin,\n        'array.max': messageTemplate.arrayMax,\n        'array.length': messageTemplate.arrayLength\n      })\n\n    if (options.required === false) {\n      formSchema = formSchema.optional()\n    }\n\n    if (typeof schema?.length === 'number') {\n      formSchema = formSchema.length(schema.length)\n    } else {\n      if (typeof schema?.min === 'number') {\n        formSchema = formSchema.min(schema.min)\n      }\n\n      if (typeof schema?.max === 'number') {\n        formSchema = formSchema.max(schema.max)\n      }\n    }\n\n    this.formSchema = formSchema.default([])\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const { items, name } = this\n\n    // State checkbox values\n    const values = this.getFormValue(state[name]) ?? []\n\n    // Map (or discard) state values to item values\n    const selected = items\n      .filter((item) => values.includes(item.value))\n      .map((item) => item.value)\n\n    return selected.length ? selected : undefined\n  }\n\n  getFormValue(value?: FormStateValue | FormState) {\n    return this.isValue(value) ? value : undefined\n  }\n\n  getDisplayStringFromFormValue(\n    selected: (string | number | boolean)[] | undefined,\n    translator: Translator\n  ) {\n    const { items } = this\n\n    if (!selected) {\n      return ''\n    }\n\n    return items\n      .filter((item) => selected.includes(item.value))\n      .map((item) => translator.tListItem(item, 'text') || item.text)\n      .join(', ')\n  }\n\n  getContextValueFromFormValue(\n    values: (string | number | boolean)[] | undefined\n  ): (string | number | boolean)[] {\n    /**\n     * For evaluation context purposes, optional {@link CheckboxesField}\n     * with an undefined value (i.e. nothing selected) should default to [].\n     * This way conditions are not evaluated against `undefined` which throws errors.\n     * Currently these errors are caught and the evaluation returns default `false`.\n     * @see {@link QuestionPageController.getNextPath} for `undefined` return value\n     * @see {@link FormModel.makeCondition} for try/catch block with default `false`\n     * For negative conditions this is a problem because E.g.\n     * The condition: 'selectedchecks' does not contain 'someval'\n     * should return true IF 'selectedchecks' is undefined, not throw and return false.\n     */\n    return values ?? []\n  }\n\n  getDisplayStringFromState(\n    state: FormSubmissionState,\n    translator: Translator\n  ) {\n    const selected = this.getFormValueFromState(state) ?? []\n    return this.getDisplayStringFromFormValue(selected, translator)\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    const values = this.getFormValueFromState(state)\n\n    return this.getContextValueFromFormValue(values)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return CheckboxesField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    const parentErrors = SelectionControlField.getAllPossibleErrors()\n\n    return {\n      ...parentErrors,\n      advancedSettingsErrors: [\n        ...parentErrors.advancedSettingsErrors,\n        { type: 'array.min', template: messageTemplate.arrayMin },\n        { type: 'array.max', template: messageTemplate.arrayMax },\n        { type: 'array.length', template: messageTemplate.arrayLength }\n      ]\n    }\n  }\n\n  isValue(value?: FormStateValue | FormState): value is Item['value'][] {\n    if (!Array.isArray(value)) {\n      return false\n    }\n\n    // Skip checks when empty\n    if (!value.length) {\n      return true\n    }\n\n    return value.every(isFormValue)\n  }\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAA4B,KAAK;AAE3C,SAASC,WAAW;AACpB,SAASC,qBAAqB;AAI9B,SAASC,eAAe;AAQxB,OAAO,MAAMC,eAAe,SAASF,qBAAqB,CAAC;EAMzDG,WAAWA,CACTC,GAA6B,EAC7BC,KAA6D,EAC7D;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,QAAQ,EAAEC;IAAK,CAAC,GAAG,IAAI;IAC/B,MAAM;MAAEC,OAAO;MAAEC;IAAO,CAAC,GAAGL,GAAG;IAE/B,IAAIM,UAAU,GACZH,IAAI,KAAK,QAAQ,GAAGT,GAAG,CAACa,KAAK,CAAS,CAAC,GAAGb,GAAG,CAACa,KAAK,CAAS,CAAC;IAE/D,MAAMC,WAAW,GAAGd,GAAG,CAACS,IAAI,CAAC,CAAC,CAAC,CAC5BM,KAAK,CAAC,GAAG,IAAI,CAACC,MAAM,CAAC,CACrBC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC;IAEpBL,UAAU,GAAGA,UAAU,CACpBM,KAAK,CAACJ,WAAW,CAAC,CAClBK,MAAM,CAAC,CAAC,CACRF,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBG,QAAQ,CAAC,CAAC,CACVC,QAAQ,CAAC;MACR,WAAW,EAAElB,eAAe,CAACmB,QAAQ;MACrC,WAAW,EAAEnB,eAAe,CAACoB,QAAQ;MACrC,cAAc,EAAEpB,eAAe,CAACqB;IAClC,CAAC,CAAC;IAEJ,IAAId,OAAO,CAACU,QAAQ,KAAK,KAAK,EAAE;MAC9BR,UAAU,GAAGA,UAAU,CAACa,QAAQ,CAAC,CAAC;IACpC;IAEA,IAAI,OAAOd,MAAM,EAAEe,MAAM,KAAK,QAAQ,EAAE;MACtCd,UAAU,GAAGA,UAAU,CAACc,MAAM,CAACf,MAAM,CAACe,MAAM,CAAC;IAC/C,CAAC,MAAM;MACL,IAAI,OAAOf,MAAM,EAAEgB,GAAG,KAAK,QAAQ,EAAE;QACnCf,UAAU,GAAGA,UAAU,CAACe,GAAG,CAAChB,MAAM,CAACgB,GAAG,CAAC;MACzC;MAEA,IAAI,OAAOhB,MAAM,EAAEiB,GAAG,KAAK,QAAQ,EAAE;QACnChB,UAAU,GAAGA,UAAU,CAACgB,GAAG,CAACjB,MAAM,CAACiB,GAAG,CAAC;MACzC;IACF;IAEA,IAAI,CAAChB,UAAU,GAAGA,UAAU,CAACiB,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGlB,UAAU,CAACiB,OAAO,CAAC,IAAI,CAAC,CAACE,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACrB,OAAO,GAAGA,OAAO;EACxB;EAEAsB,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAM;MAAEf,KAAK;MAAEgB;IAAK,CAAC,GAAG,IAAI;;IAE5B;IACA,MAAMlB,MAAM,GAAG,IAAI,CAACmB,YAAY,CAACF,KAAK,CAACC,IAAI,CAAC,CAAC,IAAI,EAAE;;IAEnD;IACA,MAAME,QAAQ,GAAGlB,KAAK,CACnBmB,MAAM,CAAEC,IAAI,IAAKtB,MAAM,CAACuB,QAAQ,CAACD,IAAI,CAACE,KAAK,CAAC,CAAC,CAC7CC,GAAG,CAAEH,IAAI,IAAKA,IAAI,CAACE,KAAK,CAAC;IAE5B,OAAOJ,QAAQ,CAACV,MAAM,GAAGU,QAAQ,GAAGM,SAAS;EAC/C;EAEAP,YAAYA,CAACK,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACG,OAAO,CAACH,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAChD;EAEAE,6BAA6BA,CAC3BR,QAAmD,EACnDS,UAAsB,EACtB;IACA,MAAM;MAAE3B;IAAM,CAAC,GAAG,IAAI;IAEtB,IAAI,CAACkB,QAAQ,EAAE;MACb,OAAO,EAAE;IACX;IAEA,OAAOlB,KAAK,CACTmB,MAAM,CAAEC,IAAI,IAAKF,QAAQ,CAACG,QAAQ,CAACD,IAAI,CAACE,KAAK,CAAC,CAAC,CAC/CC,GAAG,CAAEH,IAAI,IAAKO,UAAU,CAACC,SAAS,CAACR,IAAI,EAAE,MAAM,CAAC,IAAIA,IAAI,CAACS,IAAI,CAAC,CAC9DC,IAAI,CAAC,IAAI,CAAC;EACf;EAEAC,4BAA4BA,CAC1BjC,MAAiD,EAClB;IAC/B;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACI,OAAOA,MAAM,IAAI,EAAE;EACrB;EAEAkC,yBAAyBA,CACvBjB,KAA0B,EAC1BY,UAAsB,EACtB;IACA,MAAMT,QAAQ,GAAG,IAAI,CAACJ,qBAAqB,CAACC,KAAK,CAAC,IAAI,EAAE;IACxD,OAAO,IAAI,CAACW,6BAA6B,CAACR,QAAQ,EAAES,UAAU,CAAC;EACjE;EAEAM,wBAAwBA,CAAClB,KAA0B,EAAE;IACnD,MAAMjB,MAAM,GAAG,IAAI,CAACgB,qBAAqB,CAACC,KAAK,CAAC;IAEhD,OAAO,IAAI,CAACgB,4BAA4B,CAACjC,MAAM,CAAC;EAClD;;EAEA;AACF;AACA;EACEoC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOhD,eAAe,CAACgD,oBAAoB,CAAC,CAAC;EAC/C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,MAAMC,YAAY,GAAGnD,qBAAqB,CAACkD,oBAAoB,CAAC,CAAC;IAEjE,OAAO;MACL,GAAGC,YAAY;MACfC,sBAAsB,EAAE,CACtB,GAAGD,YAAY,CAACC,sBAAsB,EACtC;QAAE7C,IAAI,EAAE,WAAW;QAAE8C,QAAQ,EAAEpD,eAAe,CAACmB;MAAS,CAAC,EACzD;QAAEb,IAAI,EAAE,WAAW;QAAE8C,QAAQ,EAAEpD,eAAe,CAACoB;MAAS,CAAC,EACzD;QAAEd,IAAI,EAAE,cAAc;QAAE8C,QAAQ,EAAEpD,eAAe,CAACqB;MAAY,CAAC;IAEnE,CAAC;EACH;EAEAmB,OAAOA,CAACH,KAAkC,EAA4B;IACpE,IAAI,CAACgB,KAAK,CAACC,OAAO,CAACjB,KAAK,CAAC,EAAE;MACzB,OAAO,KAAK;IACd;;IAEA;IACA,IAAI,CAACA,KAAK,CAACd,MAAM,EAAE;MACjB,OAAO,IAAI;IACb;IAEA,OAAOc,KAAK,CAACkB,KAAK,CAACzD,WAAW,CAAC;EACjC;AACF","ignoreList":[]}

package/.server/server/plugins/engine/components/ComponentCollection.d.ts

@@ -1,11 +1,11 @@
 import { type ComponentDef } from '@defra/forms-model';
-import { type CustomValidator, type ErrorReportCollection, type ObjectSchema } from 'joi';
+import joi, { type CustomValidator, type ErrorReportCollection, type ObjectSchema } from 'joi';
 import { type Component, type Field, type Guidance } from '../../../../server/plugins/engine/components/helpers/components.js';
-import { type ComponentViewModel } from '../../../../server/plugins/engine/components/types.js';
+import { type ComponentViewModel, type RenderContext } from '../../../../server/plugins/engine/components/types.js';
+import { type Translator } from '../../../../server/plugins/engine/i18n/types.js';
 import { type FormModel } from '../../../../server/plugins/engine/models/index.js';
 import { type PageControllerClass } from '../../../../server/plugins/engine/pageControllers/helpers/pages.js';
 import { type FormPayload, type FormSubmissionError, type FormSubmissionState, type FormValidationResult } from '../../../../server/plugins/engine/types.js';
-import { type FormQuery } from '../../../../server/routes/types.js';
 export declare class ComponentCollection {
     page?: PageControllerClass;
     parent?: Component;
@@ -37,18 +37,19 @@ export declare class ComponentCollection {
     /**
      * Get all errors for all fields in this collection
      */
-    getErrors(errors?: FormSubmissionError[]): FormSubmissionError[] | undefined;
+    getErrors(translator: Translator, errors?: FormSubmissionError[]): FormSubmissionError[] | undefined;
     /**
      * Get view errors for all fields in this collection.
      * For most fields this means filtering to the first error in the list.
      * Composite fields like UKAddress can choose to return more than one error.
      */
-    getViewErrors(errors?: FormSubmissionError[]): FormSubmissionError[] | undefined;
-    getViewModel(payload: FormPayload, errors?: FormSubmissionError[], query?: FormQuery): ComponentViewModel[];
+    getViewErrors(translator: Translator, errors?: FormSubmissionError[]): FormSubmissionError[] | undefined;
+    getViewModel(context: RenderContext): ComponentViewModel[];
+    overrideParentTitle(formSchema: joi.ObjectSchema<FormPayload>, translator: Translator | undefined): joi.ObjectSchema<FormPayload>;
     /**
      * Validate form payload
      */
-    validate(value?: FormPayload): FormValidationResult<FormPayload>;
+    validate(value?: FormPayload, translator?: Translator): FormValidationResult<FormPayload>;
     /**
      * Helper to get errors from all fields
      */

package/.server/server/plugins/engine/components/ComponentCollection.js

@@ -1,8 +1,8 @@
 import joi from 'joi';
-import { FormComponent, isFormState, isFormValue } from "./FormComponent.js";
+import { isFormState, isFormValue } from "./FormComponent.js";
 import { createComponent } from "./helpers/components.js";
 import { getErrors } from "../helpers.js";
-import { validationOptions as opts } from "../pageControllers/validationOptions.js";
+import { buildLanguageMessages, validationOptions as opts } from "../pageControllers/validationOptions.js";
 export class ComponentCollection {
   page;
   parent;
@@ -31,47 +31,6 @@ export class ComponentCollection {
         [name]: field.stateSchema
       });
     }
-
-    // Add parent field title to collection field errors
-    formSchema = formSchema.error(errors => {
-      return errors.flatMap(error => {
-        if (!isErrorContext(error.local) || error.local.title) {
-          return error;
-        }
-
-        // Use field key or first missing child field
-        let {
-          missing,
-          key = missing?.[0]
-        } = error.local;
-
-        // But avoid numeric key used by array payloads
-        if (typeof key === 'number') {
-          key = error.path[0];
-        }
-
-        // Find the parent field
-        const parent = fields.find(item => item.name === key?.split('__').shift());
-
-        // Find the child field
-        const child = (parent?.collection?.fields ?? fields).find(item => item.name === key);
-
-        // Update error with child label
-        if (child && (!error.local.label || error.local.label === 'value')) {
-          error.local.label = child.title;
-        }
-
-        // Fix error summary links for missing fields
-        if (missing?.length) {
-          error.path = missing;
-          error.local.key = missing[0];
-        }
-
-        // Update error with parent title
-        error.local.title ??= parent?.label;
-        return error;
-      });
-    });
     if (schema?.peers) {
       formSchema = formSchema.and(...schema.peers, {
         isPresent: isFormValue
@@ -143,8 +102,8 @@ export class ComponentCollection {
   /**
    * Get all errors for all fields in this collection
    */
-  getErrors(errors) {
-    return this.getFieldErrors(field => field.getErrors(errors), errors);
+  getErrors(translator, errors) {
+    return this.getFieldErrors(field => field.getErrors(translator, errors), errors);
   }
 
   /**
@@ -152,10 +111,10 @@ export class ComponentCollection {
    * For most fields this means filtering to the first error in the list.
    * Composite fields like UKAddress can choose to return more than one error.
    */
-  getViewErrors(errors) {
-    return this.getFieldErrors(field => field.getViewErrors(errors), errors);
+  getViewErrors(translator, errors) {
+    return this.getFieldErrors(field => field.getViewErrors(translator, errors), errors);
   }
-  getViewModel(payload, errors, query = {}) {
+  getViewModel(context) {
     const {
       components
     } = this;
@@ -164,7 +123,7 @@ export class ComponentCollection {
         isFormComponent,
         type
       } = component;
-      const model = component instanceof FormComponent ? component.getViewModel(payload, errors, query) : component.getViewModel();
+      const model = component.getViewModel(context);
       return {
         type,
         isFormComponent,
@@ -173,12 +132,108 @@ export class ComponentCollection {
     });
     return result;
   }
+  overrideParentTitle(formSchema, translator) {
+    // Add parent field title to collection field errors
+    return formSchema.error(errors => {
+      return errors.flatMap(error => {
+        if (!isErrorContext(error.local) || error.local.title) {
+          return error;
+        }
+
+        // Use field key or first missing child field
+        let {
+          missing,
+          key = missing?.[0]
+        } = error.local;
+
+        // But avoid numeric key used by array payloads
+        if (typeof key === 'number') {
+          key = error.path[0];
+        }
+
+        // Find the parent field
+        const parent = this.fields.find(item => item.name === key?.split('__').shift());
+
+        // Find the child field
+        const child = (parent?.collection?.fields ?? this.fields).find(item => item.name === key);
+
+        // Update error with child label
+        if (child && (!error.local.label || error.local.label === 'value')) {
+          error.local.label = child.title;
+        }
+
+        // Fix error summary links for missing fields
+        if (missing?.length) {
+          error.path = missing;
+          error.local.key = missing[0];
+        }
+
+        // Update error with parent title
+        if (translator && parent) {
+          error.local.title ??= translator.tComponent(parent, 'title');
+        } else {
+          error.local.title ??= parent?.label;
+        }
+        return error;
+      });
+    });
+  }
 
   /**
    * Validate form payload
    */
-  validate(value = {}) {
-    const result = this.formSchema.validate(value, opts);
+  validate(value = {}, translator) {
+    const messages = translator ? buildLanguageMessages(translator.t) : undefined;
+
+    // When translating, override Joi labels (and custom schema messages where
+    // needed) so #label/#title in message templates resolve in the correct language.
+    let schema = this.formSchema;
+    // Add parent field title to collection field errors
+    schema = this.overrideParentTitle(schema, translator);
+    if (translator) {
+      const {
+        t
+      } = translator;
+      const labelOverrides = {};
+      for (const field of this.fields) {
+        if (field.collection) {
+          // Composite field: translate each sub-field's label using the key constant
+          // (e.g. 'components.addressField.line1' → "Llinell cyfeiriad 1") and apply
+          // any field-type-specific message overrides (e.g. objectMissing for dates).
+          const messagesOverride = field.getValidationMessagesOverride(translator);
+          for (const subField of field.collection.fields) {
+            const translatedSubLabel = t(subField.title) || subField.label;
+            let patchedSchema = subField.formSchema.label(translatedSubLabel);
+            if (messagesOverride) {
+              patchedSchema = patchedSchema.messages(messagesOverride);
+            }
+            labelOverrides[subField.name] = patchedSchema;
+          }
+        } else {
+          const translatedLabel = translator.tComponent(field, 'shortDescription') || translator.tComponent(field, 'title');
+          const messagesOverride = field.getValidationMessagesOverride(translator);
+          let patchedSchema = field.formSchema;
+          if (translatedLabel && translatedLabel !== field.label) {
+            patchedSchema = patchedSchema.label(translatedLabel);
+          }
+          if (messagesOverride) {
+            patchedSchema = patchedSchema.messages(messagesOverride);
+          }
+          if (patchedSchema !== field.formSchema) {
+            labelOverrides[field.name] = patchedSchema;
+          }
+        }
+      }
+      if (Object.keys(labelOverrides).length) {
+        schema = schema.keys(labelOverrides);
+      }
+    }
+    const result = schema.validate(value, {
+      ...opts,
+      ...(messages && {
+        messages
+      })
+    });
     const details = result.error?.details;
     return {
       value: result.value ?? {},