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

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

@@ -1,27 +1,27 @@
 import { type AutocompleteFieldComponent, type SelectFieldComponent } from '@defra/forms-model';
 import { ListFormComponent } from '../../../../server/plugins/engine/components/ListFormComponent.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 SelectField extends ListFormComponent {
     options: SelectFieldComponent['options'] | AutocompleteFieldComponent['options'];
     constructor(def: SelectFieldComponent | AutocompleteFieldComponent, props: ConstructorParameters<typeof ListFormComponent>[1]);
-    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
-        items: import("./types.js").ListItem[];
+    getViewModel(context: RenderContext): {
+        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;
         };
@@ -34,23 +34,23 @@ export declare class SelectField extends ListFormComponent {
             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;
         };
         formGroup?: {
             classes?: string;
             attributes?: string | Record<string, string>;
         };
         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/SelectField.js

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

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

@@ -1 +1 @@
-{"version":3,"file":"SelectField.js","names":["ListFormComponent","SelectField","constructor","def","props","options","formSchema","required","allow","empty","getViewModel","payload","errors","viewModel","items","value"],"sources":["../../../../../src/server/plugins/engine/components/SelectField.ts"],"sourcesContent":["import {\n  type AutocompleteFieldComponent,\n  type SelectFieldComponent\n} from '@defra/forms-model'\n\nimport { ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js'\nimport {\n  type FormPayload,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\n\nexport class SelectField extends ListFormComponent {\n  declare options:\n    | SelectFieldComponent['options']\n    | AutocompleteFieldComponent['options']\n\n  constructor(\n    def: SelectFieldComponent | AutocompleteFieldComponent,\n    props: ConstructorParameters<typeof ListFormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n    let { formSchema } = this\n\n    if (options.required === false) {\n      formSchema = formSchema.allow('')\n    } else {\n      formSchema = formSchema.empty('')\n    }\n\n    this.formSchema = formSchema\n    this.options = options\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const viewModel = super.getViewModel(payload, errors)\n    let { items } = viewModel\n\n    items = [{ value: '' }, ...items]\n\n    return {\n      ...viewModel,\n      items\n    }\n  }\n}\n"],"mappings":"AAKA,SAASA,iBAAiB;AAM1B,OAAO,MAAMC,WAAW,SAASD,iBAAiB,CAAC;EAKjDE,WAAWA,CACTC,GAAsD,EACtDC,KAAyD,EACzD;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;MAC9BD,UAAU,GAAGA,UAAU,CAACE,KAAK,CAAC,EAAE,CAAC;IACnC,CAAC,MAAM;MACLF,UAAU,GAAGA,UAAU,CAACG,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAI,CAACH,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACD,OAAO,GAAGA,OAAO;EACxB;EAEAK,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,IAAI;MAAEE;IAAM,CAAC,GAAGD,SAAS;IAEzBC,KAAK,GAAG,CAAC;MAAEC,KAAK,EAAE;IAAG,CAAC,EAAE,GAAGD,KAAK,CAAC;IAEjC,OAAO;MACL,GAAGD,SAAS;MACZC;IACF,CAAC;EACH;AACF","ignoreList":[]}
+{"version":3,"file":"SelectField.js","names":["ListFormComponent","SelectField","constructor","def","props","options","formSchema","required","allow","empty","getViewModel","context","viewModel","items","value"],"sources":["../../../../../src/server/plugins/engine/components/SelectField.ts"],"sourcesContent":["import {\n  type AutocompleteFieldComponent,\n  type SelectFieldComponent\n} from '@defra/forms-model'\n\nimport { ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js'\nimport { type RenderContext } from '~/src/server/plugins/engine/components/types.js'\n\nexport class SelectField extends ListFormComponent {\n  declare options:\n    | SelectFieldComponent['options']\n    | AutocompleteFieldComponent['options']\n\n  constructor(\n    def: SelectFieldComponent | AutocompleteFieldComponent,\n    props: ConstructorParameters<typeof ListFormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n    let { formSchema } = this\n\n    if (options.required === false) {\n      formSchema = formSchema.allow('')\n    } else {\n      formSchema = formSchema.empty('')\n    }\n\n    this.formSchema = formSchema\n    this.options = options\n  }\n\n  getViewModel(context: RenderContext) {\n    const viewModel = super.getViewModel(context)\n    let { items } = viewModel\n\n    items = [{ value: '' }, ...items]\n\n    return {\n      ...viewModel,\n      items\n    }\n  }\n}\n"],"mappings":"AAKA,SAASA,iBAAiB;AAG1B,OAAO,MAAMC,WAAW,SAASD,iBAAiB,CAAC;EAKjDE,WAAWA,CACTC,GAAsD,EACtDC,KAAyD,EACzD;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;MAC9BD,UAAU,GAAGA,UAAU,CAACE,KAAK,CAAC,EAAE,CAAC;IACnC,CAAC,MAAM;MACLF,UAAU,GAAGA,UAAU,CAACG,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAI,CAACH,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACD,OAAO,GAAGA,OAAO;EACxB;EAEAK,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAMC,SAAS,GAAG,KAAK,CAACF,YAAY,CAACC,OAAO,CAAC;IAC7C,IAAI;MAAEE;IAAM,CAAC,GAAGD,SAAS;IAEzBC,KAAK,GAAG,CAAC;MAAEC,KAAK,EAAE;IAAG,CAAC,EAAE,GAAGD,KAAK,CAAC;IAEjC,OAAO;MACL,GAAGD,SAAS;MACZC;IACF,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -1,11 +1,11 @@
 import { ListFormComponent } from '../../../../server/plugins/engine/components/ListFormComponent.js';
-import { type ListItem } from '../../../../server/plugins/engine/components/types.js';
-import { type ErrorMessageTemplateList, type FormPayload, type FormSubmissionError } from '../../../../server/plugins/engine/types.js';
+import { type ListItem, type RenderContext } from '../../../../server/plugins/engine/components/types.js';
+import { type ErrorMessageTemplateList } from '../../../../server/plugins/engine/types.js';
 /**
  * "Selection controls" are checkboxes and radios (and switches), as per Material UI nomenclature.
  */
 export declare class SelectionControlField extends ListFormComponent {
-    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+    getViewModel(context: RenderContext): {
         fieldset: {
             attributes?: string | Record<string, string>;
             legend?: import("../../../../server/plugins/engine/components/types.js").Label;
@@ -26,7 +26,7 @@ export declare class SelectionControlField extends ListFormComponent {
         suffix?: import("../../../../server/plugins/engine/components/types.js").ComponentText;
         classes?: string;
         condition?: string;
-        errors?: FormSubmissionError[];
+        errors?: import("../../../../server/plugins/engine/types.js").FormSubmissionError[];
         errorMessage?: {
             text: string;
         };

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

@@ -4,11 +4,11 @@ import { messageTemplate } from "../pageControllers/validationOptions.js";
  * "Selection controls" are checkboxes and radios (and switches), as per Material UI nomenclature.
  */
 export class SelectionControlField extends ListFormComponent {
-  getViewModel(payload, errors) {
+  getViewModel(context) {
     const {
       options
     } = this;
-    const viewModel = super.getViewModel(payload, errors);
+    const viewModel = super.getViewModel(context);
     let {
       fieldset,
       items,

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

@@ -1 +1 @@
-{"version":3,"file":"SelectionControlField.js","names":["ListFormComponent","messageTemplate","SelectionControlField","getViewModel","payload","errors","options","viewModel","fieldset","items","label","legend","text","classes","map","item","selected","checked","itemModel","bold","getAllPossibleErrors","baseErrors","type","template","selectRequired","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/SelectionControlField.ts"],"sourcesContent":["import { ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js'\nimport { type ListItem } from '~/src/server/plugins/engine/components/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\n\n/**\n * \"Selection controls\" are checkboxes and radios (and switches), as per Material UI nomenclature.\n */\nexport class SelectionControlField extends ListFormComponent {\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const { options } = this\n\n    const viewModel = super.getViewModel(payload, errors)\n    let { fieldset, items, label } = viewModel\n\n    fieldset ??= {\n      legend: {\n        text: label.text,\n        classes: 'govuk-fieldset__legend--m'\n      }\n    }\n\n    items = items.map((item) => {\n      const { selected: checked } = item\n      const itemModel = { ...item, checked } satisfies ListItem\n\n      if ('bold' in options && options.bold) {\n        itemModel.label ??= {}\n        itemModel.label.classes = 'govuk-label--s'\n      }\n\n      return itemModel\n    })\n\n    return {\n      ...viewModel,\n      fieldset,\n      items\n    }\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return SelectionControlField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'selectRequired', template: messageTemplate.selectRequired }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAAA,SAASA,iBAAiB;AAE1B,SAASC,eAAe;AAOxB;AACA;AACA;AACA,OAAO,MAAMC,qBAAqB,SAASF,iBAAiB,CAAC;EAC3DG,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAM;MAAEC;IAAQ,CAAC,GAAG,IAAI;IAExB,MAAMC,SAAS,GAAG,KAAK,CAACJ,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,IAAI;MAAEG,QAAQ;MAAEC,KAAK;MAAEC;IAAM,CAAC,GAAGH,SAAS;IAE1CC,QAAQ,KAAK;MACXG,MAAM,EAAE;QACNC,IAAI,EAAEF,KAAK,CAACE,IAAI;QAChBC,OAAO,EAAE;MACX;IACF,CAAC;IAEDJ,KAAK,GAAGA,KAAK,CAACK,GAAG,CAAEC,IAAI,IAAK;MAC1B,MAAM;QAAEC,QAAQ,EAAEC;MAAQ,CAAC,GAAGF,IAAI;MAClC,MAAMG,SAAS,GAAG;QAAE,GAAGH,IAAI;QAAEE;MAAQ,CAAoB;MAEzD,IAAI,MAAM,IAAIX,OAAO,IAAIA,OAAO,CAACa,IAAI,EAAE;QACrCD,SAAS,CAACR,KAAK,KAAK,CAAC,CAAC;QACtBQ,SAAS,CAACR,KAAK,CAACG,OAAO,GAAG,gBAAgB;MAC5C;MAEA,OAAOK,SAAS;IAClB,CAAC,CAAC;IAEF,OAAO;MACL,GAAGX,SAAS;MACZC,QAAQ;MACRC;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACEW,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOlB,qBAAqB,CAACkB,oBAAoB,CAAC,CAAC;EACrD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEC,IAAI,EAAE,gBAAgB;QAAEC,QAAQ,EAAEtB,eAAe,CAACuB;MAAe,CAAC,CACrE;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}
+{"version":3,"file":"SelectionControlField.js","names":["ListFormComponent","messageTemplate","SelectionControlField","getViewModel","context","options","viewModel","fieldset","items","label","legend","text","classes","map","item","selected","checked","itemModel","bold","getAllPossibleErrors","baseErrors","type","template","selectRequired","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/SelectionControlField.ts"],"sourcesContent":["import { ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js'\nimport {\n  type ListItem,\n  type RenderContext\n} from '~/src/server/plugins/engine/components/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport { type ErrorMessageTemplateList } from '~/src/server/plugins/engine/types.js'\n\n/**\n * \"Selection controls\" are checkboxes and radios (and switches), as per Material UI nomenclature.\n */\nexport class SelectionControlField extends ListFormComponent {\n  getViewModel(context: RenderContext) {\n    const { options } = this\n\n    const viewModel = super.getViewModel(context)\n    let { fieldset, items, label } = viewModel\n\n    fieldset ??= {\n      legend: {\n        text: label.text,\n        classes: 'govuk-fieldset__legend--m'\n      }\n    }\n\n    items = items.map((item) => {\n      const { selected: checked } = item\n      const itemModel = { ...item, checked } satisfies ListItem\n\n      if ('bold' in options && options.bold) {\n        itemModel.label ??= {}\n        itemModel.label.classes = 'govuk-label--s'\n      }\n\n      return itemModel\n    })\n\n    return {\n      ...viewModel,\n      fieldset,\n      items\n    }\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return SelectionControlField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'selectRequired', template: messageTemplate.selectRequired }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAAA,SAASA,iBAAiB;AAK1B,SAASC,eAAe;AAGxB;AACA;AACA;AACA,OAAO,MAAMC,qBAAqB,SAASF,iBAAiB,CAAC;EAC3DG,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAM;MAAEC;IAAQ,CAAC,GAAG,IAAI;IAExB,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,CAAC;IAC7C,IAAI;MAAEG,QAAQ;MAAEC,KAAK;MAAEC;IAAM,CAAC,GAAGH,SAAS;IAE1CC,QAAQ,KAAK;MACXG,MAAM,EAAE;QACNC,IAAI,EAAEF,KAAK,CAACE,IAAI;QAChBC,OAAO,EAAE;MACX;IACF,CAAC;IAEDJ,KAAK,GAAGA,KAAK,CAACK,GAAG,CAAEC,IAAI,IAAK;MAC1B,MAAM;QAAEC,QAAQ,EAAEC;MAAQ,CAAC,GAAGF,IAAI;MAClC,MAAMG,SAAS,GAAG;QAAE,GAAGH,IAAI;QAAEE;MAAQ,CAAoB;MAEzD,IAAI,MAAM,IAAIX,OAAO,IAAIA,OAAO,CAACa,IAAI,EAAE;QACrCD,SAAS,CAACR,KAAK,KAAK,CAAC,CAAC;QACtBQ,SAAS,CAACR,KAAK,CAACG,OAAO,GAAG,gBAAgB;MAC5C;MAEA,OAAOK,SAAS;IAClB,CAAC,CAAC;IAEF,OAAO;MACL,GAAGX,SAAS;MACZC,QAAQ;MACRC;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACEW,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOjB,qBAAqB,CAACiB,oBAAoB,CAAC,CAAC;EACrD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEC,IAAI,EAAE,gBAAgB;QAAEC,QAAQ,EAAErB,eAAe,CAACsB;MAAe,CAAC,CACrE;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -1,13 +1,14 @@
 import { type TelephoneNumberFieldComponent } from '@defra/forms-model';
 import { type StringSchema } from 'joi';
 import { FormComponent } from '../../../../server/plugins/engine/components/FormComponent.js';
-import { type ErrorMessageTemplateList, type FormPayload, type FormSubmissionError } from '../../../../server/plugins/engine/types.js';
+import { type RenderContext } from '../../../../server/plugins/engine/components/types.js';
+import { type ErrorMessageTemplateList } from '../../../../server/plugins/engine/types.js';
 export declare class TelephoneNumberField extends FormComponent {
     options: TelephoneNumberFieldComponent['options'];
     formSchema: StringSchema;
     stateSchema: StringSchema;
     constructor(def: TelephoneNumberFieldComponent, props: ConstructorParameters<typeof FormComponent>[1]);
-    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+    getViewModel(context: RenderContext): {
         type: string;
         label: {
             text: string;
@@ -19,11 +20,11 @@ export declare class TelephoneNumberField extends FormComponent {
             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("../../../../server/plugins/engine/types.js").FormSubmissionError[];
         errorMessage?: {
             text: string;
         };
@@ -36,21 +37,21 @@ export declare class TelephoneNumberField extends FormComponent {
             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;
-        items?: import("./types.js").ListItem[] | import("./types.js").DateInputItem[];
+        items?: import("../../../../server/plugins/engine/components/types.js").ListItem[] | import("../../../../server/plugins/engine/components/types.js").DateInputItem[];
         fieldset?: {
             attributes?: string | Record<string, string>;
-            legend?: import("./types.js").Label;
+            legend?: import("../../../../server/plugins/engine/components/types.js").Label;
         };
         formGroup?: {
             classes?: string;
             attributes?: string | Record<string, string>;
         };
         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;

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

@@ -33,8 +33,8 @@ export class TelephoneNumberField extends FormComponent {
     this.stateSchema = formSchema.default(null).allow(null);
     this.options = options;
   }
-  getViewModel(payload, errors) {
-    const viewModel = super.getViewModel(payload, errors);
+  getViewModel(context) {
+    const viewModel = super.getViewModel(context);
     const {
       attributes
     } = viewModel;

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

@@ -1 +1 @@
-{"version":3,"file":"TelephoneNumberField.js","names":["FormComponent","addClassOptionIfNone","INVALID_ERROR_CODE","joi","messageTemplate","TelephoneNumberField","constructor","def","props","options","format","formSchema","string","trim","phoneNumber","label","required","allow","customValidationMessage","message","messages","customValidationMessages","default","stateSchema","getViewModel","payload","errors","viewModel","attributes","autocomplete","type","getAllPossibleErrors","baseErrors","template","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/TelephoneNumberField.ts"],"sourcesContent":["import { type TelephoneNumberFieldComponent } from '@defra/forms-model'\nimport { type StringSchema } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers/index.js'\nimport {\n  INVALID_ERROR_CODE,\n  joi\n} from '~/src/server/plugins/engine/components/helpers/telephone.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\n\nexport class TelephoneNumberField extends FormComponent {\n  declare options: TelephoneNumberFieldComponent['options']\n  declare formSchema: StringSchema\n  declare stateSchema: StringSchema\n\n  constructor(\n    def: TelephoneNumberFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n    const { format } = options\n\n    let formSchema = joi\n      .string()\n      .trim()\n      .phoneNumber({ format })\n      .label(this.label)\n      .required()\n\n    if (options.required === false) {\n      formSchema = formSchema.allow('')\n    }\n\n    if (options.customValidationMessage) {\n      const message = options.customValidationMessage\n\n      formSchema = formSchema.messages({\n        'any.required': message,\n        'string.empty': message,\n        'string.pattern.base': message,\n        [INVALID_ERROR_CODE]: message\n      })\n    } else if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\n\n    addClassOptionIfNone(options, 'govuk-input--width-20')\n\n    this.formSchema = formSchema.default('')\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const viewModel = super.getViewModel(payload, errors)\n    const { attributes } = viewModel\n\n    attributes.autocomplete = 'tel'\n\n    return {\n      ...viewModel,\n      type: 'tel'\n    }\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return TelephoneNumberField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'required', template: messageTemplate.required },\n        { type: 'format', template: messageTemplate.format }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAGA,SAASA,aAAa;AACtB,SAASC,oBAAoB;AAC7B,SACEC,kBAAkB,EAClBC,GAAG;AAEL,SAASC,eAAe;AAOxB,OAAO,MAAMC,oBAAoB,SAASL,aAAa,CAAC;EAKtDM,WAAWA,CACTC,GAAkC,EAClCC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IACvB,MAAM;MAAEG;IAAO,CAAC,GAAGD,OAAO;IAE1B,IAAIE,UAAU,GAAGR,GAAG,CACjBS,MAAM,CAAC,CAAC,CACRC,IAAI,CAAC,CAAC,CACNC,WAAW,CAAC;MAAEJ;IAAO,CAAC,CAAC,CACvBK,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,QAAQ,CAAC,CAAC;IAEb,IAAIP,OAAO,CAACO,QAAQ,KAAK,KAAK,EAAE;MAC9BL,UAAU,GAAGA,UAAU,CAACM,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAIR,OAAO,CAACS,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGV,OAAO,CAACS,uBAAuB;MAE/CP,UAAU,GAAGA,UAAU,CAACS,QAAQ,CAAC;QAC/B,cAAc,EAAED,OAAO;QACvB,cAAc,EAAEA,OAAO;QACvB,qBAAqB,EAAEA,OAAO;QAC9B,CAACjB,kBAAkB,GAAGiB;MACxB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIV,OAAO,CAACY,wBAAwB,EAAE;MAC3CV,UAAU,GAAGA,UAAU,CAACS,QAAQ,CAACX,OAAO,CAACY,wBAAwB,CAAC;IACpE;IAEApB,oBAAoB,CAACQ,OAAO,EAAE,uBAAuB,CAAC;IAEtD,IAAI,CAACE,UAAU,GAAGA,UAAU,CAACW,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGZ,UAAU,CAACW,OAAO,CAAC,IAAI,CAAC,CAACL,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACR,OAAO,GAAGA,OAAO;EACxB;EAEAe,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,MAAM;MAAEE;IAAW,CAAC,GAAGD,SAAS;IAEhCC,UAAU,CAACC,YAAY,GAAG,KAAK;IAE/B,OAAO;MACL,GAAGF,SAAS;MACZG,IAAI,EAAE;IACR,CAAC;EACH;;EAEA;AACF;AACA;EACEC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO1B,oBAAoB,CAAC0B,oBAAoB,CAAC,CAAC;EACpD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEF,IAAI,EAAE,UAAU;QAAEG,QAAQ,EAAE7B,eAAe,CAACY;MAAS,CAAC,EACxD;QAAEc,IAAI,EAAE,QAAQ;QAAEG,QAAQ,EAAE7B,eAAe,CAACM;MAAO,CAAC,CACrD;MACDwB,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}
+{"version":3,"file":"TelephoneNumberField.js","names":["FormComponent","addClassOptionIfNone","INVALID_ERROR_CODE","joi","messageTemplate","TelephoneNumberField","constructor","def","props","options","format","formSchema","string","trim","phoneNumber","label","required","allow","customValidationMessage","message","messages","customValidationMessages","default","stateSchema","getViewModel","context","viewModel","attributes","autocomplete","type","getAllPossibleErrors","baseErrors","template","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/TelephoneNumberField.ts"],"sourcesContent":["import { type TelephoneNumberFieldComponent } from '@defra/forms-model'\nimport { type StringSchema } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers/index.js'\nimport {\n  INVALID_ERROR_CODE,\n  joi\n} from '~/src/server/plugins/engine/components/helpers/telephone.js'\nimport { type RenderContext } from '~/src/server/plugins/engine/components/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport { type ErrorMessageTemplateList } from '~/src/server/plugins/engine/types.js'\n\nexport class TelephoneNumberField extends FormComponent {\n  declare options: TelephoneNumberFieldComponent['options']\n  declare formSchema: StringSchema\n  declare stateSchema: StringSchema\n\n  constructor(\n    def: TelephoneNumberFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n    const { format } = options\n\n    let formSchema = joi\n      .string()\n      .trim()\n      .phoneNumber({ format })\n      .label(this.label)\n      .required()\n\n    if (options.required === false) {\n      formSchema = formSchema.allow('')\n    }\n\n    if (options.customValidationMessage) {\n      const message = options.customValidationMessage\n\n      formSchema = formSchema.messages({\n        'any.required': message,\n        'string.empty': message,\n        'string.pattern.base': message,\n        [INVALID_ERROR_CODE]: message\n      })\n    } else if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\n\n    addClassOptionIfNone(options, 'govuk-input--width-20')\n\n    this.formSchema = formSchema.default('')\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n  }\n\n  getViewModel(context: RenderContext) {\n    const viewModel = super.getViewModel(context)\n    const { attributes } = viewModel\n\n    attributes.autocomplete = 'tel'\n\n    return {\n      ...viewModel,\n      type: 'tel'\n    }\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return TelephoneNumberField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'required', template: messageTemplate.required },\n        { type: 'format', template: messageTemplate.format }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAGA,SAASA,aAAa;AACtB,SAASC,oBAAoB;AAC7B,SACEC,kBAAkB,EAClBC,GAAG;AAGL,SAASC,eAAe;AAGxB,OAAO,MAAMC,oBAAoB,SAASL,aAAa,CAAC;EAKtDM,WAAWA,CACTC,GAAkC,EAClCC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IACvB,MAAM;MAAEG;IAAO,CAAC,GAAGD,OAAO;IAE1B,IAAIE,UAAU,GAAGR,GAAG,CACjBS,MAAM,CAAC,CAAC,CACRC,IAAI,CAAC,CAAC,CACNC,WAAW,CAAC;MAAEJ;IAAO,CAAC,CAAC,CACvBK,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,QAAQ,CAAC,CAAC;IAEb,IAAIP,OAAO,CAACO,QAAQ,KAAK,KAAK,EAAE;MAC9BL,UAAU,GAAGA,UAAU,CAACM,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAIR,OAAO,CAACS,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGV,OAAO,CAACS,uBAAuB;MAE/CP,UAAU,GAAGA,UAAU,CAACS,QAAQ,CAAC;QAC/B,cAAc,EAAED,OAAO;QACvB,cAAc,EAAEA,OAAO;QACvB,qBAAqB,EAAEA,OAAO;QAC9B,CAACjB,kBAAkB,GAAGiB;MACxB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIV,OAAO,CAACY,wBAAwB,EAAE;MAC3CV,UAAU,GAAGA,UAAU,CAACS,QAAQ,CAACX,OAAO,CAACY,wBAAwB,CAAC;IACpE;IAEApB,oBAAoB,CAACQ,OAAO,EAAE,uBAAuB,CAAC;IAEtD,IAAI,CAACE,UAAU,GAAGA,UAAU,CAACW,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGZ,UAAU,CAACW,OAAO,CAAC,IAAI,CAAC,CAACL,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACR,OAAO,GAAGA,OAAO;EACxB;EAEAe,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAMC,SAAS,GAAG,KAAK,CAACF,YAAY,CAACC,OAAO,CAAC;IAC7C,MAAM;MAAEE;IAAW,CAAC,GAAGD,SAAS;IAEhCC,UAAU,CAACC,YAAY,GAAG,KAAK;IAE/B,OAAO;MACL,GAAGF,SAAS;MACZG,IAAI,EAAE;IACR,CAAC;EACH;;EAEA;AACF;AACA;EACEC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOzB,oBAAoB,CAACyB,oBAAoB,CAAC,CAAC;EACpD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEF,IAAI,EAAE,UAAU;QAAEG,QAAQ,EAAE5B,eAAe,CAACY;MAAS,CAAC,EACxD;QAAEa,IAAI,EAAE,QAAQ;QAAEG,QAAQ,EAAE5B,eAAe,CAACM;MAAO,CAAC,CACrD;MACDuB,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -2,6 +2,8 @@ import { type UkAddressFieldComponent } from '@defra/forms-model';
 import { type ObjectSchema } from 'joi';
 import { ComponentCollection } from '../../../../server/plugins/engine/components/ComponentCollection.js';
 import { FormComponent } from '../../../../server/plugins/engine/components/FormComponent.js';
+import { type RenderContext } from '../../../../server/plugins/engine/components/types.js';
+import { type Translator } from '../../../../server/plugins/engine/i18n/types.js';
 import { type FormRequestPayload, type FormResponseToolkit } from '../../../../server/plugins/engine/types/index.js';
 import { type ErrorMessageTemplateList, type FormPayload, type FormState, type FormStateValue, type FormSubmissionError, type FormSubmissionState, type PostcodeLookupExternalArgs } from '../../../../server/plugins/engine/types.js';
 export declare class UkAddressField extends FormComponent {
@@ -13,19 +15,19 @@ export declare class UkAddressField extends FormComponent {
     getFormValueFromState(state: FormSubmissionState): UkAddressState | undefined;
     getContextValueFromFormValue(value: UkAddressState | undefined): string[] | null;
     getContextValueFromState(state: FormSubmissionState): string[] | null;
-    getDisplayStringFromFormValue(value: UkAddressState | undefined): string;
-    getDisplayStringFromState(state: FormSubmissionState): string;
+    getDisplayStringFromFormValue(value: UkAddressState | undefined, _translator: Translator): string;
+    getDisplayStringFromState(state: FormSubmissionState, translator: Translator): string;
     /**
      * Returns one error per child field
      */
-    getViewErrors(errors?: FormSubmissionError[]): FormSubmissionError[] | undefined;
-    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+    getViewErrors(translator: Translator, errors?: FormSubmissionError[]): FormSubmissionError[] | undefined;
+    getViewModel(context: RenderContext): {
         value: string | undefined;
         fieldset: {
             attributes?: string | Record<string, string>;
-            legend?: import("../../../../server/plugins/engine/types/index.js").Label;
+            legend?: import("../../../../server/plugins/engine/components/types.js").Label;
         };
-        components: import("../../../../server/plugins/engine/types/index.js").ComponentViewModel[];
+        components: import("../../../../server/plugins/engine/components/types.js").ComponentViewModel[];
         usePostcodeLookup: boolean;
         label: {
             text: string;
@@ -37,8 +39,8 @@ export declare class UkAddressField extends FormComponent {
             id?: string;
             text: string;
         };
-        prefix?: import("../../../../server/plugins/engine/types/index.js").ComponentText;
-        suffix?: import("../../../../server/plugins/engine/types/index.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[];
@@ -54,11 +56,11 @@ export declare class UkAddressField extends FormComponent {
             accept?: string;
             inputmode?: string;
         };
-        content?: import("../../../../server/plugins/engine/types/index.js").Content | import("../../../../server/plugins/engine/types/index.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;
-        items?: import("../../../../server/plugins/engine/types/index.js").ListItem[] | import("../../../../server/plugins/engine/types/index.js").DateInputItem[];
+        items?: import("../../../../server/plugins/engine/components/types.js").ListItem[] | import("../../../../server/plugins/engine/components/types.js").DateInputItem[];
         formGroup?: {
             classes?: string;
             attributes?: string | Record<string, string>;

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

@@ -4,6 +4,7 @@ import { ComponentCollection } from "./ComponentCollection.js";
 import { FormComponent, isFormState } from "./FormComponent.js";
 import { TextField } from "./TextField.js";
 import { dispatch } from "../../postcode-lookup/routes/index.js";
+import { resolveLanguage } from "../../../utils/utils.js";
 export class UkAddressField extends FormComponent {
   constructor(def, props) {
     super(def, props);
@@ -17,7 +18,7 @@ export class UkAddressField extends FormComponent {
     this.collection = new ComponentCollection([{
       type: ComponentType.TextField,
       name: `${name}__uprn`,
-      title: 'UPRN',
+      title: 'components.addressField.uprn',
       schema: {},
       options: {
         required: false,
@@ -26,7 +27,7 @@ export class UkAddressField extends FormComponent {
     }, {
       type: ComponentType.TextField,
       name: `${name}__addressLine1`,
-      title: 'Address line 1',
+      title: 'components.addressField.line1',
       schema: {
         max: 100
       },
@@ -38,7 +39,7 @@ export class UkAddressField extends FormComponent {
     }, {
       type: ComponentType.TextField,
       name: `${name}__addressLine2`,
-      title: 'Address line 2',
+      title: 'components.addressField.line2',
       schema: {
         max: 100
       },
@@ -50,7 +51,7 @@ export class UkAddressField extends FormComponent {
     }, {
       type: ComponentType.TextField,
       name: `${name}__town`,
-      title: 'Town or city',
+      title: 'components.addressField.town',
       schema: {
         max: 100
       },
@@ -63,7 +64,7 @@ export class UkAddressField extends FormComponent {
     }, {
       type: ComponentType.TextField,
       name: `${name}__county`,
-      title: 'County',
+      title: 'components.addressField.county',
       schema: {
         max: 100
       },
@@ -75,7 +76,7 @@ export class UkAddressField extends FormComponent {
     }, {
       type: ComponentType.TextField,
       name: `${name}__postcode`,
-      title: 'Postcode',
+      title: 'components.addressField.postcode',
       schema: {
         regex: '^[a-zA-Z]{1,2}\\d[a-zA-Z\\d]?\\s?\\d[a-zA-Z]{2}$'
       },
@@ -107,19 +108,22 @@ export class UkAddressField extends FormComponent {
     const value = this.getFormValueFromState(state);
     return this.getContextValueFromFormValue(value);
   }
-  getDisplayStringFromFormValue(value) {
+  getDisplayStringFromFormValue(value, _translator) {
     return this.getContextValueFromFormValue(value)?.join(', ') ?? '';
   }
-  getDisplayStringFromState(state) {
+  getDisplayStringFromState(state, translator) {
     const value = this.getFormValueFromState(state);
-    return this.getDisplayStringFromFormValue(value);
+    return this.getDisplayStringFromFormValue(value, translator);
   }
 
   /**
    * Returns one error per child field
    */
-  getViewErrors(errors) {
-    const uniqueErrors = this.getErrors(errors)?.filter((error, index, self) => index === self.findIndex(err => err.name === error.name));
+  getViewErrors(translator, errors) {
+    const {
+      t
+    } = translator;
+    const uniqueErrors = this.getErrors(translator, errors)?.filter((error, index, self) => index === self.findIndex(err => err.name === error.name));
 
     // When using postcode lookup, the address fields are hidden
     // so we replace any individual validation messages with a single one
@@ -132,18 +136,24 @@ export class UkAddressField extends FormComponent {
         name,
         path: [name],
         href: `#${name}`,
-        text: `Enter ${lowerFirst(label)}`
+        text: t('components.addressField.enterAddress', {
+          shortDescription: lowerFirst(label)
+        })
       }];
     }
     return uniqueErrors;
   }
-  getViewModel(payload, errors) {
+  getViewModel(context) {
+    const {
+      payload,
+      translator
+    } = context;
     const {
       collection,
       name,
       options
     } = this;
-    const viewModel = super.getViewModel(payload, errors);
+    const viewModel = super.getViewModel(context);
     let {
       fieldset,
       hint,
@@ -165,7 +175,7 @@ export class UkAddressField extends FormComponent {
         'aria-describedby': hint.id
       };
     }
-    const components = collection.getViewModel(payload, errors);
+    const components = collection.getViewModel(context);
 
     // Hide UPRN
     const uprn = components.at(0);
@@ -178,7 +188,7 @@ export class UkAddressField extends FormComponent {
 
     // Postcode lookup
     const usePostcodeLookup = this.shouldUsePostcodeLookup();
-    const value = usePostcodeLookup ? this.getDisplayStringFromState(payload) : undefined;
+    const value = usePostcodeLookup ? this.getDisplayStringFromState(payload, translator) : undefined;
     return {
       ...viewModel,
       value,
@@ -232,13 +242,15 @@ export class UkAddressField extends FormComponent {
       controller,
       component
     } = args;
+    const language = resolveLanguage(request);
     return dispatch(request, h, {
       formName: controller.model.name,
       componentName: component.name,
       componentHint: component.hint,
       componentTitle: component.title || controller.title,
       step: args.actionArgs.step,
-      sourceUrl: args.sourceUrl
+      sourceUrl: args.sourceUrl,
+      language
     });
   }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"UkAddressField.js","names":["ComponentType","lowerFirst","ComponentCollection","FormComponent","isFormState","TextField","dispatch","UkAddressField","constructor","def","props","name","options","isRequired","required","hideOptional","optionalText","hideTitle","collection","type","title","schema","classes","max","autocomplete","regex","parent","formSchema","stateSchema","getFormValueFromState","state","value","isState","undefined","getContextValueFromFormValue","Object","entries","filter","key","Boolean","map","getContextValueFromState","getDisplayStringFromFormValue","join","getDisplayStringFromState","getViewErrors","errors","uniqueErrors","getErrors","error","index","self","findIndex","err","shouldUsePostcodeLookup","length","label","path","href","text","getViewModel","payload","viewModel","fieldset","hint","legend","id","attributes","components","uprn","at","Error","model","formGroup","usePostcodeLookup","isUkAddress","getAllPossibleErrors","ordnanceSurveyApiKey","baseErrors","template","advancedSettingsErrors","isText","addressLine1","town","postcode","dispatcher","request","h","args","controller","component","formName","componentName","componentHint","componentTitle","step","actionArgs","sourceUrl"],"sources":["../../../../../src/server/plugins/engine/components/UkAddressField.ts"],"sourcesContent":["import { ComponentType, type UkAddressFieldComponent } from '@defra/forms-model'\nimport { type ObjectSchema } from 'joi'\nimport lowerFirst from 'lodash/lowerFirst.js'\n\nimport { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport {\n  FormComponent,\n  isFormState\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { TextField } from '~/src/server/plugins/engine/components/TextField.js'\nimport { type QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'\nimport {\n  type FormRequestPayload,\n  type FormResponseToolkit\n} from '~/src/server/plugins/engine/types/index.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState,\n  type PostcodeLookupExternalArgs\n} from '~/src/server/plugins/engine/types.js'\nimport { dispatch } from '~/src/server/plugins/postcode-lookup/routes/index.js'\n\nexport class UkAddressField extends FormComponent {\n  declare options: UkAddressFieldComponent['options']\n  declare formSchema: ObjectSchema<FormPayload>\n  declare stateSchema: ObjectSchema<FormState>\n  declare collection: ComponentCollection\n\n  constructor(\n    def: UkAddressFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { name, options } = def\n\n    const isRequired = options.required !== false\n    const hideOptional = !!options.optionalText\n    const hideTitle = !!options.hideTitle\n\n    this.collection = new ComponentCollection(\n      [\n        {\n          type: ComponentType.TextField,\n          name: `${name}__uprn`,\n          title: 'UPRN',\n          schema: {},\n          options: {\n            required: false,\n            classes: 'hidden'\n          }\n        },\n        {\n          type: ComponentType.TextField,\n          name: `${name}__addressLine1`,\n          title: 'Address line 1',\n          schema: { max: 100 },\n          options: {\n            autocomplete: 'address-line1',\n            required: isRequired,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        },\n        {\n          type: ComponentType.TextField,\n          name: `${name}__addressLine2`,\n          title: 'Address line 2',\n          schema: { max: 100 },\n          options: {\n            autocomplete: 'address-line2',\n            required: false,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        },\n        {\n          type: ComponentType.TextField,\n          name: `${name}__town`,\n          title: 'Town or city',\n          schema: { max: 100 },\n          options: {\n            autocomplete: 'address-level2',\n            classes: 'govuk-!-width-two-thirds',\n            required: isRequired,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        },\n        {\n          type: ComponentType.TextField,\n          name: `${name}__county`,\n          title: 'County',\n          schema: { max: 100 },\n          options: {\n            autocomplete: 'address-level1',\n            required: false,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        },\n        {\n          type: ComponentType.TextField,\n          name: `${name}__postcode`,\n          title: 'Postcode',\n          schema: {\n            regex: '^[a-zA-Z]{1,2}\\\\d[a-zA-Z\\\\d]?\\\\s?\\\\d[a-zA-Z]{2}$'\n          },\n          options: {\n            autocomplete: 'postal-code',\n            classes: 'govuk-input--width-10',\n            required: isRequired,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        }\n      ],\n      { ...props, parent: this }\n    )\n\n    this.options = options\n    this.formSchema = this.collection.formSchema\n    this.stateSchema = this.collection.stateSchema\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const value = super.getFormValueFromState(state)\n    return this.isState(value) ? value : undefined\n  }\n\n  getContextValueFromFormValue(value: UkAddressState | undefined) {\n    if (!value) {\n      return null\n    }\n\n    return Object.entries(value)\n      .filter(([key, value]) => key !== 'uprn' && Boolean(value))\n      .map(([, value]) => value)\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\n    return this.getContextValueFromFormValue(value)\n  }\n\n  getDisplayStringFromFormValue(value: UkAddressState | undefined): string {\n    return this.getContextValueFromFormValue(value)?.join(', ') ?? ''\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\n    return this.getDisplayStringFromFormValue(value)\n  }\n\n  /**\n   * Returns one error per child field\n   */\n  getViewErrors(\n    errors?: FormSubmissionError[]\n  ): FormSubmissionError[] | undefined {\n    const uniqueErrors = this.getErrors(errors)?.filter(\n      (error, index, self) =>\n        index === self.findIndex((err) => err.name === error.name)\n    )\n\n    // When using postcode lookup, the address fields are hidden\n    // so we replace any individual validation messages with a single one\n    if (this.shouldUsePostcodeLookup() && uniqueErrors?.length) {\n      const { name, label } = this\n\n      return [\n        {\n          name,\n          path: [name],\n          href: `#${name}`,\n          text: `Enter ${lowerFirst(label)}`\n        }\n      ]\n    }\n\n    return uniqueErrors\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const { collection, name, options } = this\n\n    const viewModel = super.getViewModel(payload, errors)\n    let { fieldset, hint, label } = viewModel\n\n    fieldset ??= {\n      legend: {\n        text: label.text,\n\n        /**\n         * For screen readers, only hide legend visually. This can be overridden\n         * by single component {@link QuestionPageController | `showTitle` handling}\n         */\n        classes: options.hideTitle\n          ? 'govuk-visually-hidden'\n          : 'govuk-fieldset__legend--m'\n      }\n    }\n\n    if (hint) {\n      hint.id ??= `${name}-hint`\n      fieldset.attributes ??= {\n        'aria-describedby': hint.id\n      }\n    }\n\n    const components = collection.getViewModel(payload, errors)\n\n    // Hide UPRN\n    const uprn = components.at(0)\n\n    if (!uprn) {\n      throw new Error('No UPRN')\n    }\n\n    uprn.model.formGroup = { classes: 'app-hidden' }\n\n    // Postcode lookup\n    const usePostcodeLookup = this.shouldUsePostcodeLookup()\n\n    const value = usePostcodeLookup\n      ? this.getDisplayStringFromState(payload)\n      : undefined\n\n    return {\n      ...viewModel,\n      value,\n      fieldset,\n      components,\n      usePostcodeLookup\n    }\n  }\n\n  isState(value?: FormStateValue | FormState): value is UkAddressState {\n    return UkAddressField.isUkAddress(value)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return UkAddressField.getAllPossibleErrors()\n  }\n\n  private shouldUsePostcodeLookup() {\n    return !!(this.options.usePostcodeLookup && this.model.ordnanceSurveyApiKey)\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'required', template: 'Enter address line 1' },\n        { type: 'required', template: 'Enter town or city' },\n        { type: 'required', template: 'Enter postcode' },\n        { type: 'format', template: 'Enter valid postcode' }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n\n  static isUkAddress(\n    value?: FormStateValue | FormState\n  ): value is UkAddressState {\n    return (\n      isFormState(value) &&\n      TextField.isText(value.addressLine1) &&\n      TextField.isText(value.town) &&\n      TextField.isText(value.postcode)\n    )\n  }\n\n  // eslint-disable-next-line @typescript-eslint/require-await\n  static async dispatcher(\n    request: FormRequestPayload,\n    h: FormResponseToolkit,\n    args: PostcodeLookupExternalArgs\n  ) {\n    const { controller, component } = args\n\n    return dispatch(request, h, {\n      formName: controller.model.name,\n      componentName: component.name,\n      componentHint: component.hint,\n      componentTitle: component.title || controller.title,\n      step: args.actionArgs.step,\n      sourceUrl: args.sourceUrl\n    })\n  }\n}\n\nexport interface UkAddressState extends Record<string, string> {\n  uprn: string\n  addressLine1: string\n  addressLine2: string\n  town: string\n  county: string\n  postcode: string\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAAsC,oBAAoB;AAEhF,OAAOC,UAAU,MAAM,sBAAsB;AAE7C,SAASC,mBAAmB;AAC5B,SACEC,aAAa,EACbC,WAAW;AAEb,SAASC,SAAS;AAelB,SAASC,QAAQ;AAEjB,OAAO,MAAMC,cAAc,SAASJ,aAAa,CAAC;EAMhDK,WAAWA,CACTC,GAA4B,EAC5BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,IAAI;MAAEC;IAAQ,CAAC,GAAGH,GAAG;IAE7B,MAAMI,UAAU,GAAGD,OAAO,CAACE,QAAQ,KAAK,KAAK;IAC7C,MAAMC,YAAY,GAAG,CAAC,CAACH,OAAO,CAACI,YAAY;IAC3C,MAAMC,SAAS,GAAG,CAAC,CAACL,OAAO,CAACK,SAAS;IAErC,IAAI,CAACC,UAAU,GAAG,IAAIhB,mBAAmB,CACvC,CACE;MACEiB,IAAI,EAAEnB,aAAa,CAACK,SAAS;MAC7BM,IAAI,EAAE,GAAGA,IAAI,QAAQ;MACrBS,KAAK,EAAE,MAAM;MACbC,MAAM,EAAE,CAAC,CAAC;MACVT,OAAO,EAAE;QACPE,QAAQ,EAAE,KAAK;QACfQ,OAAO,EAAE;MACX;IACF,CAAC,EACD;MACEH,IAAI,EAAEnB,aAAa,CAACK,SAAS;MAC7BM,IAAI,EAAE,GAAGA,IAAI,gBAAgB;MAC7BS,KAAK,EAAE,gBAAgB;MACvBC,MAAM,EAAE;QAAEE,GAAG,EAAE;MAAI,CAAC;MACpBX,OAAO,EAAE;QACPY,YAAY,EAAE,eAAe;QAC7BV,QAAQ,EAAED,UAAU;QACpBG,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,EACD;MACEE,IAAI,EAAEnB,aAAa,CAACK,SAAS;MAC7BM,IAAI,EAAE,GAAGA,IAAI,gBAAgB;MAC7BS,KAAK,EAAE,gBAAgB;MACvBC,MAAM,EAAE;QAAEE,GAAG,EAAE;MAAI,CAAC;MACpBX,OAAO,EAAE;QACPY,YAAY,EAAE,eAAe;QAC7BV,QAAQ,EAAE,KAAK;QACfE,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,EACD;MACEE,IAAI,EAAEnB,aAAa,CAACK,SAAS;MAC7BM,IAAI,EAAE,GAAGA,IAAI,QAAQ;MACrBS,KAAK,EAAE,cAAc;MACrBC,MAAM,EAAE;QAAEE,GAAG,EAAE;MAAI,CAAC;MACpBX,OAAO,EAAE;QACPY,YAAY,EAAE,gBAAgB;QAC9BF,OAAO,EAAE,0BAA0B;QACnCR,QAAQ,EAAED,UAAU;QACpBG,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,EACD;MACEE,IAAI,EAAEnB,aAAa,CAACK,SAAS;MAC7BM,IAAI,EAAE,GAAGA,IAAI,UAAU;MACvBS,KAAK,EAAE,QAAQ;MACfC,MAAM,EAAE;QAAEE,GAAG,EAAE;MAAI,CAAC;MACpBX,OAAO,EAAE;QACPY,YAAY,EAAE,gBAAgB;QAC9BV,QAAQ,EAAE,KAAK;QACfE,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,EACD;MACEE,IAAI,EAAEnB,aAAa,CAACK,SAAS;MAC7BM,IAAI,EAAE,GAAGA,IAAI,YAAY;MACzBS,KAAK,EAAE,UAAU;MACjBC,MAAM,EAAE;QACNI,KAAK,EAAE;MACT,CAAC;MACDb,OAAO,EAAE;QACPY,YAAY,EAAE,aAAa;QAC3BF,OAAO,EAAE,uBAAuB;QAChCR,QAAQ,EAAED,UAAU;QACpBG,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,CACF,EACD;MAAE,GAAGP,KAAK;MAAEgB,MAAM,EAAE;IAAK,CAC3B,CAAC;IAED,IAAI,CAACd,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACe,UAAU,GAAG,IAAI,CAACT,UAAU,CAACS,UAAU;IAC5C,IAAI,CAACC,WAAW,GAAG,IAAI,CAACV,UAAU,CAACU,WAAW;EAChD;EAEAC,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAMC,KAAK,GAAG,KAAK,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAChD,OAAO,IAAI,CAACE,OAAO,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAChD;EAEAC,4BAA4BA,CAACH,KAAiC,EAAE;IAC9D,IAAI,CAACA,KAAK,EAAE;MACV,OAAO,IAAI;IACb;IAEA,OAAOI,MAAM,CAACC,OAAO,CAACL,KAAK,CAAC,CACzBM,MAAM,CAAC,CAAC,CAACC,GAAG,EAAEP,KAAK,CAAC,KAAKO,GAAG,KAAK,MAAM,IAAIC,OAAO,CAACR,KAAK,CAAC,CAAC,CAC1DS,GAAG,CAAC,CAAC,GAAGT,KAAK,CAAC,KAAKA,KAAK,CAAC;EAC9B;EAEAU,wBAAwBA,CAACX,KAA0B,EAAE;IACnD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACI,4BAA4B,CAACH,KAAK,CAAC;EACjD;EAEAW,6BAA6BA,CAACX,KAAiC,EAAU;IACvE,OAAO,IAAI,CAACG,4BAA4B,CAACH,KAAK,CAAC,EAAEY,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;EACnE;EAEAC,yBAAyBA,CAACd,KAA0B,EAAE;IACpD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACY,6BAA6B,CAACX,KAAK,CAAC;EAClD;;EAEA;AACF;AACA;EACEc,aAAaA,CACXC,MAA8B,EACK;IACnC,MAAMC,YAAY,GAAG,IAAI,CAACC,SAAS,CAACF,MAAM,CAAC,EAAET,MAAM,CACjD,CAACY,KAAK,EAAEC,KAAK,EAAEC,IAAI,KACjBD,KAAK,KAAKC,IAAI,CAACC,SAAS,CAAEC,GAAG,IAAKA,GAAG,CAAC1C,IAAI,KAAKsC,KAAK,CAACtC,IAAI,CAC7D,CAAC;;IAED;IACA;IACA,IAAI,IAAI,CAAC2C,uBAAuB,CAAC,CAAC,IAAIP,YAAY,EAAEQ,MAAM,EAAE;MAC1D,MAAM;QAAE5C,IAAI;QAAE6C;MAAM,CAAC,GAAG,IAAI;MAE5B,OAAO,CACL;QACE7C,IAAI;QACJ8C,IAAI,EAAE,CAAC9C,IAAI,CAAC;QACZ+C,IAAI,EAAE,IAAI/C,IAAI,EAAE;QAChBgD,IAAI,EAAE,SAAS1D,UAAU,CAACuD,KAAK,CAAC;MAClC,CAAC,CACF;IACH;IAEA,OAAOT,YAAY;EACrB;EAEAa,YAAYA,CAACC,OAAoB,EAAEf,MAA8B,EAAE;IACjE,MAAM;MAAE5B,UAAU;MAAEP,IAAI;MAAEC;IAAQ,CAAC,GAAG,IAAI;IAE1C,MAAMkD,SAAS,GAAG,KAAK,CAACF,YAAY,CAACC,OAAO,EAAEf,MAAM,CAAC;IACrD,IAAI;MAAEiB,QAAQ;MAAEC,IAAI;MAAER;IAAM,CAAC,GAAGM,SAAS;IAEzCC,QAAQ,KAAK;MACXE,MAAM,EAAE;QACNN,IAAI,EAAEH,KAAK,CAACG,IAAI;QAEhB;AACR;AACA;AACA;QACQrC,OAAO,EAAEV,OAAO,CAACK,SAAS,GACtB,uBAAuB,GACvB;MACN;IACF,CAAC;IAED,IAAI+C,IAAI,EAAE;MACRA,IAAI,CAACE,EAAE,KAAK,GAAGvD,IAAI,OAAO;MAC1BoD,QAAQ,CAACI,UAAU,KAAK;QACtB,kBAAkB,EAAEH,IAAI,CAACE;MAC3B,CAAC;IACH;IAEA,MAAME,UAAU,GAAGlD,UAAU,CAAC0C,YAAY,CAACC,OAAO,EAAEf,MAAM,CAAC;;IAE3D;IACA,MAAMuB,IAAI,GAAGD,UAAU,CAACE,EAAE,CAAC,CAAC,CAAC;IAE7B,IAAI,CAACD,IAAI,EAAE;MACT,MAAM,IAAIE,KAAK,CAAC,SAAS,CAAC;IAC5B;IAEAF,IAAI,CAACG,KAAK,CAACC,SAAS,GAAG;MAAEnD,OAAO,EAAE;IAAa,CAAC;;IAEhD;IACA,MAAMoD,iBAAiB,GAAG,IAAI,CAACpB,uBAAuB,CAAC,CAAC;IAExD,MAAMvB,KAAK,GAAG2C,iBAAiB,GAC3B,IAAI,CAAC9B,yBAAyB,CAACiB,OAAO,CAAC,GACvC5B,SAAS;IAEb,OAAO;MACL,GAAG6B,SAAS;MACZ/B,KAAK;MACLgC,QAAQ;MACRK,UAAU;MACVM;IACF,CAAC;EACH;EAEA1C,OAAOA,CAACD,KAAkC,EAA2B;IACnE,OAAOxB,cAAc,CAACoE,WAAW,CAAC5C,KAAK,CAAC;EAC1C;;EAEA;AACF;AACA;EACE6C,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOrE,cAAc,CAACqE,oBAAoB,CAAC,CAAC;EAC9C;EAEQtB,uBAAuBA,CAAA,EAAG;IAChC,OAAO,CAAC,EAAE,IAAI,CAAC1C,OAAO,CAAC8D,iBAAiB,IAAI,IAAI,CAACF,KAAK,CAACK,oBAAoB,CAAC;EAC9E;;EAEA;AACF;AACA;EACE,OAAOD,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLE,UAAU,EAAE,CACV;QAAE3D,IAAI,EAAE,UAAU;QAAE4D,QAAQ,EAAE;MAAuB,CAAC,EACtD;QAAE5D,IAAI,EAAE,UAAU;QAAE4D,QAAQ,EAAE;MAAqB,CAAC,EACpD;QAAE5D,IAAI,EAAE,UAAU;QAAE4D,QAAQ,EAAE;MAAiB,CAAC,EAChD;QAAE5D,IAAI,EAAE,QAAQ;QAAE4D,QAAQ,EAAE;MAAuB,CAAC,CACrD;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;EAEA,OAAOL,WAAWA,CAChB5C,KAAkC,EACT;IACzB,OACE3B,WAAW,CAAC2B,KAAK,CAAC,IAClB1B,SAAS,CAAC4E,MAAM,CAAClD,KAAK,CAACmD,YAAY,CAAC,IACpC7E,SAAS,CAAC4E,MAAM,CAAClD,KAAK,CAACoD,IAAI,CAAC,IAC5B9E,SAAS,CAAC4E,MAAM,CAAClD,KAAK,CAACqD,QAAQ,CAAC;EAEpC;;EAEA;EACA,aAAaC,UAAUA,CACrBC,OAA2B,EAC3BC,CAAsB,EACtBC,IAAgC,EAChC;IACA,MAAM;MAAEC,UAAU;MAAEC;IAAU,CAAC,GAAGF,IAAI;IAEtC,OAAOlF,QAAQ,CAACgF,OAAO,EAAEC,CAAC,EAAE;MAC1BI,QAAQ,EAAEF,UAAU,CAACjB,KAAK,CAAC7D,IAAI;MAC/BiF,aAAa,EAAEF,SAAS,CAAC/E,IAAI;MAC7BkF,aAAa,EAAEH,SAAS,CAAC1B,IAAI;MAC7B8B,cAAc,EAAEJ,SAAS,CAACtE,KAAK,IAAIqE,UAAU,CAACrE,KAAK;MACnD2E,IAAI,EAAEP,IAAI,CAACQ,UAAU,CAACD,IAAI;MAC1BE,SAAS,EAAET,IAAI,CAACS;IAClB,CAAC,CAAC;EACJ;AACF","ignoreList":[]}
+{"version":3,"file":"UkAddressField.js","names":["ComponentType","lowerFirst","ComponentCollection","FormComponent","isFormState","TextField","dispatch","resolveLanguage","UkAddressField","constructor","def","props","name","options","isRequired","required","hideOptional","optionalText","hideTitle","collection","type","title","schema","classes","max","autocomplete","regex","parent","formSchema","stateSchema","getFormValueFromState","state","value","isState","undefined","getContextValueFromFormValue","Object","entries","filter","key","Boolean","map","getContextValueFromState","getDisplayStringFromFormValue","_translator","join","getDisplayStringFromState","translator","getViewErrors","errors","t","uniqueErrors","getErrors","error","index","self","findIndex","err","shouldUsePostcodeLookup","length","label","path","href","text","shortDescription","getViewModel","context","payload","viewModel","fieldset","hint","legend","id","attributes","components","uprn","at","Error","model","formGroup","usePostcodeLookup","isUkAddress","getAllPossibleErrors","ordnanceSurveyApiKey","baseErrors","template","advancedSettingsErrors","isText","addressLine1","town","postcode","dispatcher","request","h","args","controller","component","language","formName","componentName","componentHint","componentTitle","step","actionArgs","sourceUrl"],"sources":["../../../../../src/server/plugins/engine/components/UkAddressField.ts"],"sourcesContent":["import { ComponentType, type UkAddressFieldComponent } from '@defra/forms-model'\nimport { type ObjectSchema } from 'joi'\nimport lowerFirst from 'lodash/lowerFirst.js'\n\nimport { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport {\n  FormComponent,\n  isFormState\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { TextField } from '~/src/server/plugins/engine/components/TextField.js'\nimport { type RenderContext } from '~/src/server/plugins/engine/components/types.js'\nimport { type Translator } from '~/src/server/plugins/engine/i18n/types.js'\nimport {\n  type FormRequestPayload,\n  type FormResponseToolkit\n} from '~/src/server/plugins/engine/types/index.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState,\n  type PostcodeLookupExternalArgs\n} from '~/src/server/plugins/engine/types.js'\nimport { dispatch } from '~/src/server/plugins/postcode-lookup/routes/index.js'\nimport { resolveLanguage } from '~/src/server/utils/utils.js'\n\nexport class UkAddressField extends FormComponent {\n  declare options: UkAddressFieldComponent['options']\n  declare formSchema: ObjectSchema<FormPayload>\n  declare stateSchema: ObjectSchema<FormState>\n  declare collection: ComponentCollection\n\n  constructor(\n    def: UkAddressFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { name, options } = def\n\n    const isRequired = options.required !== false\n    const hideOptional = !!options.optionalText\n    const hideTitle = !!options.hideTitle\n    this.collection = new ComponentCollection(\n      [\n        {\n          type: ComponentType.TextField,\n          name: `${name}__uprn`,\n          title: 'components.addressField.uprn',\n          schema: {},\n          options: {\n            required: false,\n            classes: 'hidden'\n          }\n        },\n        {\n          type: ComponentType.TextField,\n          name: `${name}__addressLine1`,\n          title: 'components.addressField.line1',\n          schema: { max: 100 },\n          options: {\n            autocomplete: 'address-line1',\n            required: isRequired,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        },\n        {\n          type: ComponentType.TextField,\n          name: `${name}__addressLine2`,\n          title: 'components.addressField.line2',\n          schema: { max: 100 },\n          options: {\n            autocomplete: 'address-line2',\n            required: false,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        },\n        {\n          type: ComponentType.TextField,\n          name: `${name}__town`,\n          title: 'components.addressField.town',\n          schema: { max: 100 },\n          options: {\n            autocomplete: 'address-level2',\n            classes: 'govuk-!-width-two-thirds',\n            required: isRequired,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        },\n        {\n          type: ComponentType.TextField,\n          name: `${name}__county`,\n          title: 'components.addressField.county',\n          schema: { max: 100 },\n          options: {\n            autocomplete: 'address-level1',\n            required: false,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        },\n        {\n          type: ComponentType.TextField,\n          name: `${name}__postcode`,\n          title: 'components.addressField.postcode',\n          schema: {\n            regex: '^[a-zA-Z]{1,2}\\\\d[a-zA-Z\\\\d]?\\\\s?\\\\d[a-zA-Z]{2}$'\n          },\n          options: {\n            autocomplete: 'postal-code',\n            classes: 'govuk-input--width-10',\n            required: isRequired,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        }\n      ],\n      { ...props, parent: this }\n    )\n\n    this.options = options\n    this.formSchema = this.collection.formSchema\n    this.stateSchema = this.collection.stateSchema\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const value = super.getFormValueFromState(state)\n    return this.isState(value) ? value : undefined\n  }\n\n  getContextValueFromFormValue(value: UkAddressState | undefined) {\n    if (!value) {\n      return null\n    }\n\n    return Object.entries(value)\n      .filter(([key, value]) => key !== 'uprn' && Boolean(value))\n      .map(([, value]) => value)\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\n    return this.getContextValueFromFormValue(value)\n  }\n\n  getDisplayStringFromFormValue(\n    value: UkAddressState | undefined,\n    _translator: Translator\n  ): string {\n    return this.getContextValueFromFormValue(value)?.join(', ') ?? ''\n  }\n\n  getDisplayStringFromState(\n    state: FormSubmissionState,\n    translator: Translator\n  ) {\n    const value = this.getFormValueFromState(state)\n\n    return this.getDisplayStringFromFormValue(value, translator)\n  }\n\n  /**\n   * Returns one error per child field\n   */\n  getViewErrors(\n    translator: Translator,\n    errors?: FormSubmissionError[]\n  ): FormSubmissionError[] | undefined {\n    const { t } = translator\n\n    const uniqueErrors = this.getErrors(translator, errors)?.filter(\n      (error, index, self) =>\n        index === self.findIndex((err) => err.name === error.name)\n    )\n\n    // When using postcode lookup, the address fields are hidden\n    // so we replace any individual validation messages with a single one\n    if (this.shouldUsePostcodeLookup() && uniqueErrors?.length) {\n      const { name, label } = this\n\n      return [\n        {\n          name,\n          path: [name],\n          href: `#${name}`,\n          text: t('components.addressField.enterAddress', {\n            shortDescription: lowerFirst(label)\n          })\n        }\n      ]\n    }\n\n    return uniqueErrors\n  }\n\n  getViewModel(context: RenderContext) {\n    const { payload, translator } = context\n    const { collection, name, options } = this\n\n    const viewModel = super.getViewModel(context)\n    let { fieldset, hint, label } = viewModel\n\n    fieldset ??= {\n      legend: {\n        text: label.text,\n\n        /**\n         * For screen readers, only hide legend visually. This can be overridden\n         * by single component {@link QuestionPageController | `showTitle` handling}\n         */\n        classes: options.hideTitle\n          ? 'govuk-visually-hidden'\n          : 'govuk-fieldset__legend--m'\n      }\n    }\n\n    if (hint) {\n      hint.id ??= `${name}-hint`\n      fieldset.attributes ??= {\n        'aria-describedby': hint.id\n      }\n    }\n\n    const components = collection.getViewModel(context)\n\n    // Hide UPRN\n    const uprn = components.at(0)\n\n    if (!uprn) {\n      throw new Error('No UPRN')\n    }\n\n    uprn.model.formGroup = { classes: 'app-hidden' }\n\n    // Postcode lookup\n    const usePostcodeLookup = this.shouldUsePostcodeLookup()\n\n    const value = usePostcodeLookup\n      ? this.getDisplayStringFromState(payload, translator)\n      : undefined\n\n    return {\n      ...viewModel,\n      value,\n      fieldset,\n      components,\n      usePostcodeLookup\n    }\n  }\n\n  isState(value?: FormStateValue | FormState): value is UkAddressState {\n    return UkAddressField.isUkAddress(value)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return UkAddressField.getAllPossibleErrors()\n  }\n\n  private shouldUsePostcodeLookup() {\n    return !!(this.options.usePostcodeLookup && this.model.ordnanceSurveyApiKey)\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'required', template: 'Enter address line 1' },\n        { type: 'required', template: 'Enter town or city' },\n        { type: 'required', template: 'Enter postcode' },\n        { type: 'format', template: 'Enter valid postcode' }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n\n  static isUkAddress(\n    value?: FormStateValue | FormState\n  ): value is UkAddressState {\n    return (\n      isFormState(value) &&\n      TextField.isText(value.addressLine1) &&\n      TextField.isText(value.town) &&\n      TextField.isText(value.postcode)\n    )\n  }\n\n  // eslint-disable-next-line @typescript-eslint/require-await\n  static async dispatcher(\n    request: FormRequestPayload,\n    h: FormResponseToolkit,\n    args: PostcodeLookupExternalArgs\n  ) {\n    const { controller, component } = args\n    const language = resolveLanguage(request)\n\n    return dispatch(request, h, {\n      formName: controller.model.name,\n      componentName: component.name,\n      componentHint: component.hint,\n      componentTitle: component.title || controller.title,\n      step: args.actionArgs.step,\n      sourceUrl: args.sourceUrl,\n      language\n    })\n  }\n}\n\nexport interface UkAddressState extends Record<string, string> {\n  uprn: string\n  addressLine1: string\n  addressLine2: string\n  town: string\n  county: string\n  postcode: string\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAAsC,oBAAoB;AAEhF,OAAOC,UAAU,MAAM,sBAAsB;AAE7C,SAASC,mBAAmB;AAC5B,SACEC,aAAa,EACbC,WAAW;AAEb,SAASC,SAAS;AAgBlB,SAASC,QAAQ;AACjB,SAASC,eAAe;AAExB,OAAO,MAAMC,cAAc,SAASL,aAAa,CAAC;EAMhDM,WAAWA,CACTC,GAA4B,EAC5BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,IAAI;MAAEC;IAAQ,CAAC,GAAGH,GAAG;IAE7B,MAAMI,UAAU,GAAGD,OAAO,CAACE,QAAQ,KAAK,KAAK;IAC7C,MAAMC,YAAY,GAAG,CAAC,CAACH,OAAO,CAACI,YAAY;IAC3C,MAAMC,SAAS,GAAG,CAAC,CAACL,OAAO,CAACK,SAAS;IACrC,IAAI,CAACC,UAAU,GAAG,IAAIjB,mBAAmB,CACvC,CACE;MACEkB,IAAI,EAAEpB,aAAa,CAACK,SAAS;MAC7BO,IAAI,EAAE,GAAGA,IAAI,QAAQ;MACrBS,KAAK,EAAE,8BAA8B;MACrCC,MAAM,EAAE,CAAC,CAAC;MACVT,OAAO,EAAE;QACPE,QAAQ,EAAE,KAAK;QACfQ,OAAO,EAAE;MACX;IACF,CAAC,EACD;MACEH,IAAI,EAAEpB,aAAa,CAACK,SAAS;MAC7BO,IAAI,EAAE,GAAGA,IAAI,gBAAgB;MAC7BS,KAAK,EAAE,+BAA+B;MACtCC,MAAM,EAAE;QAAEE,GAAG,EAAE;MAAI,CAAC;MACpBX,OAAO,EAAE;QACPY,YAAY,EAAE,eAAe;QAC7BV,QAAQ,EAAED,UAAU;QACpBG,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,EACD;MACEE,IAAI,EAAEpB,aAAa,CAACK,SAAS;MAC7BO,IAAI,EAAE,GAAGA,IAAI,gBAAgB;MAC7BS,KAAK,EAAE,+BAA+B;MACtCC,MAAM,EAAE;QAAEE,GAAG,EAAE;MAAI,CAAC;MACpBX,OAAO,EAAE;QACPY,YAAY,EAAE,eAAe;QAC7BV,QAAQ,EAAE,KAAK;QACfE,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,EACD;MACEE,IAAI,EAAEpB,aAAa,CAACK,SAAS;MAC7BO,IAAI,EAAE,GAAGA,IAAI,QAAQ;MACrBS,KAAK,EAAE,8BAA8B;MACrCC,MAAM,EAAE;QAAEE,GAAG,EAAE;MAAI,CAAC;MACpBX,OAAO,EAAE;QACPY,YAAY,EAAE,gBAAgB;QAC9BF,OAAO,EAAE,0BAA0B;QACnCR,QAAQ,EAAED,UAAU;QACpBG,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,EACD;MACEE,IAAI,EAAEpB,aAAa,CAACK,SAAS;MAC7BO,IAAI,EAAE,GAAGA,IAAI,UAAU;MACvBS,KAAK,EAAE,gCAAgC;MACvCC,MAAM,EAAE;QAAEE,GAAG,EAAE;MAAI,CAAC;MACpBX,OAAO,EAAE;QACPY,YAAY,EAAE,gBAAgB;QAC9BV,QAAQ,EAAE,KAAK;QACfE,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,EACD;MACEE,IAAI,EAAEpB,aAAa,CAACK,SAAS;MAC7BO,IAAI,EAAE,GAAGA,IAAI,YAAY;MACzBS,KAAK,EAAE,kCAAkC;MACzCC,MAAM,EAAE;QACNI,KAAK,EAAE;MACT,CAAC;MACDb,OAAO,EAAE;QACPY,YAAY,EAAE,aAAa;QAC3BF,OAAO,EAAE,uBAAuB;QAChCR,QAAQ,EAAED,UAAU;QACpBG,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,CACF,EACD;MAAE,GAAGP,KAAK;MAAEgB,MAAM,EAAE;IAAK,CAC3B,CAAC;IAED,IAAI,CAACd,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACe,UAAU,GAAG,IAAI,CAACT,UAAU,CAACS,UAAU;IAC5C,IAAI,CAACC,WAAW,GAAG,IAAI,CAACV,UAAU,CAACU,WAAW;EAChD;EAEAC,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAMC,KAAK,GAAG,KAAK,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAChD,OAAO,IAAI,CAACE,OAAO,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAChD;EAEAC,4BAA4BA,CAACH,KAAiC,EAAE;IAC9D,IAAI,CAACA,KAAK,EAAE;MACV,OAAO,IAAI;IACb;IAEA,OAAOI,MAAM,CAACC,OAAO,CAACL,KAAK,CAAC,CACzBM,MAAM,CAAC,CAAC,CAACC,GAAG,EAAEP,KAAK,CAAC,KAAKO,GAAG,KAAK,MAAM,IAAIC,OAAO,CAACR,KAAK,CAAC,CAAC,CAC1DS,GAAG,CAAC,CAAC,GAAGT,KAAK,CAAC,KAAKA,KAAK,CAAC;EAC9B;EAEAU,wBAAwBA,CAACX,KAA0B,EAAE;IACnD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACI,4BAA4B,CAACH,KAAK,CAAC;EACjD;EAEAW,6BAA6BA,CAC3BX,KAAiC,EACjCY,WAAuB,EACf;IACR,OAAO,IAAI,CAACT,4BAA4B,CAACH,KAAK,CAAC,EAAEa,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;EACnE;EAEAC,yBAAyBA,CACvBf,KAA0B,EAC1BgB,UAAsB,EACtB;IACA,MAAMf,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACY,6BAA6B,CAACX,KAAK,EAAEe,UAAU,CAAC;EAC9D;;EAEA;AACF;AACA;EACEC,aAAaA,CACXD,UAAsB,EACtBE,MAA8B,EACK;IACnC,MAAM;MAAEC;IAAE,CAAC,GAAGH,UAAU;IAExB,MAAMI,YAAY,GAAG,IAAI,CAACC,SAAS,CAACL,UAAU,EAAEE,MAAM,CAAC,EAAEX,MAAM,CAC7D,CAACe,KAAK,EAAEC,KAAK,EAAEC,IAAI,KACjBD,KAAK,KAAKC,IAAI,CAACC,SAAS,CAAEC,GAAG,IAAKA,GAAG,CAAC7C,IAAI,KAAKyC,KAAK,CAACzC,IAAI,CAC7D,CAAC;;IAED;IACA;IACA,IAAI,IAAI,CAAC8C,uBAAuB,CAAC,CAAC,IAAIP,YAAY,EAAEQ,MAAM,EAAE;MAC1D,MAAM;QAAE/C,IAAI;QAAEgD;MAAM,CAAC,GAAG,IAAI;MAE5B,OAAO,CACL;QACEhD,IAAI;QACJiD,IAAI,EAAE,CAACjD,IAAI,CAAC;QACZkD,IAAI,EAAE,IAAIlD,IAAI,EAAE;QAChBmD,IAAI,EAAEb,CAAC,CAAC,sCAAsC,EAAE;UAC9Cc,gBAAgB,EAAE/D,UAAU,CAAC2D,KAAK;QACpC,CAAC;MACH,CAAC,CACF;IACH;IAEA,OAAOT,YAAY;EACrB;EAEAc,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAM;MAAEC,OAAO;MAAEpB;IAAW,CAAC,GAAGmB,OAAO;IACvC,MAAM;MAAE/C,UAAU;MAAEP,IAAI;MAAEC;IAAQ,CAAC,GAAG,IAAI;IAE1C,MAAMuD,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,CAAC;IAC7C,IAAI;MAAEG,QAAQ;MAAEC,IAAI;MAAEV;IAAM,CAAC,GAAGQ,SAAS;IAEzCC,QAAQ,KAAK;MACXE,MAAM,EAAE;QACNR,IAAI,EAAEH,KAAK,CAACG,IAAI;QAEhB;AACR;AACA;AACA;QACQxC,OAAO,EAAEV,OAAO,CAACK,SAAS,GACtB,uBAAuB,GACvB;MACN;IACF,CAAC;IAED,IAAIoD,IAAI,EAAE;MACRA,IAAI,CAACE,EAAE,KAAK,GAAG5D,IAAI,OAAO;MAC1ByD,QAAQ,CAACI,UAAU,KAAK;QACtB,kBAAkB,EAAEH,IAAI,CAACE;MAC3B,CAAC;IACH;IAEA,MAAME,UAAU,GAAGvD,UAAU,CAAC8C,YAAY,CAACC,OAAO,CAAC;;IAEnD;IACA,MAAMS,IAAI,GAAGD,UAAU,CAACE,EAAE,CAAC,CAAC,CAAC;IAE7B,IAAI,CAACD,IAAI,EAAE;MACT,MAAM,IAAIE,KAAK,CAAC,SAAS,CAAC;IAC5B;IAEAF,IAAI,CAACG,KAAK,CAACC,SAAS,GAAG;MAAExD,OAAO,EAAE;IAAa,CAAC;;IAEhD;IACA,MAAMyD,iBAAiB,GAAG,IAAI,CAACtB,uBAAuB,CAAC,CAAC;IAExD,MAAM1B,KAAK,GAAGgD,iBAAiB,GAC3B,IAAI,CAAClC,yBAAyB,CAACqB,OAAO,EAAEpB,UAAU,CAAC,GACnDb,SAAS;IAEb,OAAO;MACL,GAAGkC,SAAS;MACZpC,KAAK;MACLqC,QAAQ;MACRK,UAAU;MACVM;IACF,CAAC;EACH;EAEA/C,OAAOA,CAACD,KAAkC,EAA2B;IACnE,OAAOxB,cAAc,CAACyE,WAAW,CAACjD,KAAK,CAAC;EAC1C;;EAEA;AACF;AACA;EACEkD,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO1E,cAAc,CAAC0E,oBAAoB,CAAC,CAAC;EAC9C;EAEQxB,uBAAuBA,CAAA,EAAG;IAChC,OAAO,CAAC,EAAE,IAAI,CAAC7C,OAAO,CAACmE,iBAAiB,IAAI,IAAI,CAACF,KAAK,CAACK,oBAAoB,CAAC;EAC9E;;EAEA;AACF;AACA;EACE,OAAOD,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLE,UAAU,EAAE,CACV;QAAEhE,IAAI,EAAE,UAAU;QAAEiE,QAAQ,EAAE;MAAuB,CAAC,EACtD;QAAEjE,IAAI,EAAE,UAAU;QAAEiE,QAAQ,EAAE;MAAqB,CAAC,EACpD;QAAEjE,IAAI,EAAE,UAAU;QAAEiE,QAAQ,EAAE;MAAiB,CAAC,EAChD;QAAEjE,IAAI,EAAE,QAAQ;QAAEiE,QAAQ,EAAE;MAAuB,CAAC,CACrD;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;EAEA,OAAOL,WAAWA,CAChBjD,KAAkC,EACT;IACzB,OACE5B,WAAW,CAAC4B,KAAK,CAAC,IAClB3B,SAAS,CAACkF,MAAM,CAACvD,KAAK,CAACwD,YAAY,CAAC,IACpCnF,SAAS,CAACkF,MAAM,CAACvD,KAAK,CAACyD,IAAI,CAAC,IAC5BpF,SAAS,CAACkF,MAAM,CAACvD,KAAK,CAAC0D,QAAQ,CAAC;EAEpC;;EAEA;EACA,aAAaC,UAAUA,CACrBC,OAA2B,EAC3BC,CAAsB,EACtBC,IAAgC,EAChC;IACA,MAAM;MAAEC,UAAU;MAAEC;IAAU,CAAC,GAAGF,IAAI;IACtC,MAAMG,QAAQ,GAAG1F,eAAe,CAACqF,OAAO,CAAC;IAEzC,OAAOtF,QAAQ,CAACsF,OAAO,EAAEC,CAAC,EAAE;MAC1BK,QAAQ,EAAEH,UAAU,CAACjB,KAAK,CAAClE,IAAI;MAC/BuF,aAAa,EAAEH,SAAS,CAACpF,IAAI;MAC7BwF,aAAa,EAAEJ,SAAS,CAAC1B,IAAI;MAC7B+B,cAAc,EAAEL,SAAS,CAAC3E,KAAK,IAAI0E,UAAU,CAAC1E,KAAK;MACnDiF,IAAI,EAAER,IAAI,CAACS,UAAU,CAACD,IAAI;MAC1BE,SAAS,EAAEV,IAAI,CAACU,SAAS;MACzBP;IACF,CAAC,CAAC;EACJ;AACF","ignoreList":[]}

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

@@ -1,5 +1,7 @@
 import { type YesNoFieldComponent } from '@defra/forms-model';
+import { type LanguageMessages } from 'joi';
 import { SelectionControlField } from '../../../../server/plugins/engine/components/SelectionControlField.js';
+import { type Translator } from '../../../../server/plugins/engine/i18n/types.js';
 import { type ErrorMessageTemplateList } from '../../../../server/plugins/engine/types.js';
 /**
  * @description
@@ -8,6 +10,7 @@ import { type ErrorMessageTemplateList } from '../../../../server/plugins/engine
 export declare class YesNoField extends SelectionControlField {
     options: YesNoFieldComponent['options'];
     constructor(def: YesNoFieldComponent, props: ConstructorParameters<typeof SelectionControlField>[1]);
+    getValidationMessagesOverride(translator: Translator): LanguageMessages;
     /**
      * For error preview page that shows all possible errors on a component
      */

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

@@ -1,6 +1,7 @@
 import { SchemaVersion, yesNoListId, yesNoListName } from '@defra/forms-model';
 import { SelectionControlField } from "./SelectionControlField.js";
 import { addClassOptionIfNone } from "./helpers/index.js";
+import { buildValidationMessages } from "../i18n/buildValidationMessages.js";
 import { messageTemplate } from "../pageControllers/validationOptions.js";
 import { convertToLanguageMessages } from "../../../utils/type-utils.js";
 
@@ -30,6 +31,14 @@ export class YesNoField extends SelectionControlField {
     this.formSchema = formSchema;
     this.options = options;
   }
+  getValidationMessagesOverride(translator) {
+    const {
+      selectYesNoRequired
+    } = buildValidationMessages(translator.t);
+    return convertToLanguageMessages({
+      'any.required': selectYesNoRequired
+    });
+  }
 
   /**
    * For error preview page that shows all possible errors on a component

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

@@ -1 +1 @@
-{"version":3,"file":"YesNoField.js","names":["SchemaVersion","yesNoListId","yesNoListName","SelectionControlField","addClassOptionIfNone","messageTemplate","convertToLanguageMessages","YesNoField","constructor","def","props","list","model","schemaVersion","V1","options","formSchema","required","optional","messages","selectYesNoRequired","getAllPossibleErrors","baseErrors","type","template","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/YesNoField.ts"],"sourcesContent":["import {\n  SchemaVersion,\n  yesNoListId,\n  yesNoListName,\n  type YesNoFieldComponent\n} from '@defra/forms-model'\n\nimport { SelectionControlField } from '~/src/server/plugins/engine/components/SelectionControlField.js'\nimport { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers/index.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport { type ErrorMessageTemplateList } from '~/src/server/plugins/engine/types.js'\nimport { convertToLanguageMessages } from '~/src/server/utils/type-utils.js'\n\n/**\n * @description\n * YesNoField is a radiosField with predefined values.\n */\nexport class YesNoField extends SelectionControlField {\n  declare options: YesNoFieldComponent['options']\n\n  constructor(\n    def: YesNoFieldComponent,\n    props: ConstructorParameters<typeof SelectionControlField>[1]\n  ) {\n    super(\n      {\n        ...def,\n        list:\n          props.model.schemaVersion === SchemaVersion.V1\n            ? yesNoListName\n            : yesNoListId\n      },\n      props\n    )\n\n    const { options } = def\n    let { formSchema } = this\n\n    addClassOptionIfNone(options, 'govuk-radios--inline')\n\n    if (options.required === false) {\n      formSchema = formSchema.optional()\n    }\n\n    formSchema = formSchema.messages(\n      convertToLanguageMessages({\n        'any.required': messageTemplate.selectYesNoRequired\n      })\n    )\n\n    this.formSchema = formSchema\n    this.options = options\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return YesNoField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        {\n          type: 'selectYesNoRequired',\n          template: messageTemplate.selectYesNoRequired\n        }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAAA,SACEA,aAAa,EACbC,WAAW,EACXC,aAAa,QAER,oBAAoB;AAE3B,SAASC,qBAAqB;AAC9B,SAASC,oBAAoB;AAC7B,SAASC,eAAe;AAExB,SAASC,yBAAyB;;AAElC;AACA;AACA;AACA;AACA,OAAO,MAAMC,UAAU,SAASJ,qBAAqB,CAAC;EAGpDK,WAAWA,CACTC,GAAwB,EACxBC,KAA6D,EAC7D;IACA,KAAK,CACH;MACE,GAAGD,GAAG;MACNE,IAAI,EACFD,KAAK,CAACE,KAAK,CAACC,aAAa,KAAKb,aAAa,CAACc,EAAE,GAC1CZ,aAAa,GACbD;IACR,CAAC,EACDS,KACF,CAAC;IAED,MAAM;MAAEK;IAAQ,CAAC,GAAGN,GAAG;IACvB,IAAI;MAAEO;IAAW,CAAC,GAAG,IAAI;IAEzBZ,oBAAoB,CAACW,OAAO,EAAE,sBAAsB,CAAC;IAErD,IAAIA,OAAO,CAACE,QAAQ,KAAK,KAAK,EAAE;MAC9BD,UAAU,GAAGA,UAAU,CAACE,QAAQ,CAAC,CAAC;IACpC;IAEAF,UAAU,GAAGA,UAAU,CAACG,QAAQ,CAC9Bb,yBAAyB,CAAC;MACxB,cAAc,EAAED,eAAe,CAACe;IAClC,CAAC,CACH,CAAC;IAED,IAAI,CAACJ,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACD,OAAO,GAAGA,OAAO;EACxB;;EAEA;AACF;AACA;EACEM,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOd,UAAU,CAACc,oBAAoB,CAAC,CAAC;EAC1C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QACEC,IAAI,EAAE,qBAAqB;QAC3BC,QAAQ,EAAEnB,eAAe,CAACe;MAC5B,CAAC,CACF;MACDK,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}
+{"version":3,"file":"YesNoField.js","names":["SchemaVersion","yesNoListId","yesNoListName","SelectionControlField","addClassOptionIfNone","buildValidationMessages","messageTemplate","convertToLanguageMessages","YesNoField","constructor","def","props","list","model","schemaVersion","V1","options","formSchema","required","optional","messages","selectYesNoRequired","getValidationMessagesOverride","translator","t","getAllPossibleErrors","baseErrors","type","template","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/YesNoField.ts"],"sourcesContent":["import {\n  SchemaVersion,\n  yesNoListId,\n  yesNoListName,\n  type YesNoFieldComponent\n} from '@defra/forms-model'\nimport { type LanguageMessages } from 'joi'\n\nimport { SelectionControlField } from '~/src/server/plugins/engine/components/SelectionControlField.js'\nimport { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers/index.js'\nimport { buildValidationMessages } from '~/src/server/plugins/engine/i18n/buildValidationMessages.js'\nimport { type Translator } from '~/src/server/plugins/engine/i18n/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport { type ErrorMessageTemplateList } from '~/src/server/plugins/engine/types.js'\nimport { convertToLanguageMessages } from '~/src/server/utils/type-utils.js'\n\n/**\n * @description\n * YesNoField is a radiosField with predefined values.\n */\nexport class YesNoField extends SelectionControlField {\n  declare options: YesNoFieldComponent['options']\n\n  constructor(\n    def: YesNoFieldComponent,\n    props: ConstructorParameters<typeof SelectionControlField>[1]\n  ) {\n    super(\n      {\n        ...def,\n        list:\n          props.model.schemaVersion === SchemaVersion.V1\n            ? yesNoListName\n            : yesNoListId\n      },\n      props\n    )\n\n    const { options } = def\n    let { formSchema } = this\n\n    addClassOptionIfNone(options, 'govuk-radios--inline')\n\n    if (options.required === false) {\n      formSchema = formSchema.optional()\n    }\n\n    formSchema = formSchema.messages(\n      convertToLanguageMessages({\n        'any.required': messageTemplate.selectYesNoRequired\n      })\n    )\n\n    this.formSchema = formSchema\n    this.options = options\n  }\n\n  getValidationMessagesOverride(translator: Translator): LanguageMessages {\n    const { selectYesNoRequired } = buildValidationMessages(translator.t)\n    return convertToLanguageMessages({\n      'any.required': selectYesNoRequired\n    })\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return YesNoField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        {\n          type: 'selectYesNoRequired',\n          template: messageTemplate.selectYesNoRequired\n        }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAAA,SACEA,aAAa,EACbC,WAAW,EACXC,aAAa,QAER,oBAAoB;AAG3B,SAASC,qBAAqB;AAC9B,SAASC,oBAAoB;AAC7B,SAASC,uBAAuB;AAEhC,SAASC,eAAe;AAExB,SAASC,yBAAyB;;AAElC;AACA;AACA;AACA;AACA,OAAO,MAAMC,UAAU,SAASL,qBAAqB,CAAC;EAGpDM,WAAWA,CACTC,GAAwB,EACxBC,KAA6D,EAC7D;IACA,KAAK,CACH;MACE,GAAGD,GAAG;MACNE,IAAI,EACFD,KAAK,CAACE,KAAK,CAACC,aAAa,KAAKd,aAAa,CAACe,EAAE,GAC1Cb,aAAa,GACbD;IACR,CAAC,EACDU,KACF,CAAC;IAED,MAAM;MAAEK;IAAQ,CAAC,GAAGN,GAAG;IACvB,IAAI;MAAEO;IAAW,CAAC,GAAG,IAAI;IAEzBb,oBAAoB,CAACY,OAAO,EAAE,sBAAsB,CAAC;IAErD,IAAIA,OAAO,CAACE,QAAQ,KAAK,KAAK,EAAE;MAC9BD,UAAU,GAAGA,UAAU,CAACE,QAAQ,CAAC,CAAC;IACpC;IAEAF,UAAU,GAAGA,UAAU,CAACG,QAAQ,CAC9Bb,yBAAyB,CAAC;MACxB,cAAc,EAAED,eAAe,CAACe;IAClC,CAAC,CACH,CAAC;IAED,IAAI,CAACJ,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACD,OAAO,GAAGA,OAAO;EACxB;EAEAM,6BAA6BA,CAACC,UAAsB,EAAoB;IACtE,MAAM;MAAEF;IAAoB,CAAC,GAAGhB,uBAAuB,CAACkB,UAAU,CAACC,CAAC,CAAC;IACrE,OAAOjB,yBAAyB,CAAC;MAC/B,cAAc,EAAEc;IAClB,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;EACEI,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOjB,UAAU,CAACiB,oBAAoB,CAAC,CAAC;EAC1C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QACEC,IAAI,EAAE,qBAAqB;QAC3BC,QAAQ,EAAEtB,eAAe,CAACe;MAC5B,CAAC,CACF;MACDQ,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}