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

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

@@ -1,11 +1,12 @@
 import { type DeclarationFieldComponent, type Item } from '@defra/forms-model';
-import { type ArraySchema, type BooleanSchema, type StringSchema } from 'joi';
+import { type ArraySchema, type BooleanSchema, type LanguageMessages, type StringSchema } from 'joi';
 import { FormComponent } from '../../../../server/plugins/engine/components/FormComponent.js';
-import { type ErrorMessageTemplateList, type FormPayload, type FormState, type FormStateValue, type FormSubmissionError, type FormSubmissionState, type FormValue } from '../../../../server/plugins/engine/types.js';
+import { type RenderContext } from '../../../../server/plugins/engine/components/types.js';
+import { type Translator } from '../../../../server/plugins/engine/i18n/types.js';
+import { type ErrorMessageTemplateList, type FormPayload, type FormState, type FormStateValue, type FormSubmissionState, type FormValue } from '../../../../server/plugins/engine/types.js';
 export declare class DeclarationField extends FormComponent {
-    private readonly DEFAULT_DECLARATION_LABEL;
     options: DeclarationFieldComponent['options'];
-    declarationConfirmationLabel: string;
+    declarationConfirmationLabel: string | undefined;
     formSchema: ArraySchema<StringSchema[]>;
     stateSchema: BooleanSchema;
     content: string;
@@ -16,14 +17,15 @@ export declare class DeclarationField extends FormComponent {
     getStateFromValidForm(payload: FormPayload): FormState;
     getContextValueFromFormValue(value: FormValue | FormPayload): boolean;
     getFormValue(value?: FormStateValue | FormState): (string | number | boolean)[] | undefined;
-    getDisplayStringFromFormValue(value: FormValue | FormPayload): string;
-    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+    getValidationMessagesOverride(translator: Translator): LanguageMessages;
+    getDisplayStringFromFormValue(value: FormValue | FormPayload, translator: Translator): string;
+    getViewModel(context: RenderContext): {
         hint: {
             text: string;
         } | undefined;
         fieldset: {
             attributes?: string | Record<string, string>;
-            legend?: import("./types.js").Label;
+            legend?: import("../../../../server/plugins/engine/components/types.js").Label;
         };
         content: string;
         items: {
@@ -39,11 +41,11 @@ export declare class DeclarationField extends FormComponent {
         name: string;
         value: FormValue;
         type?: 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;
         };
@@ -64,7 +66,7 @@ export declare class DeclarationField extends FormComponent {
             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/DeclarationField.js

@@ -1,9 +1,9 @@
 import { ComponentType, hasFormComponents, isFormType } from '@defra/forms-model';
 import joi from 'joi';
 import { FormComponent, isFormValue } from "./FormComponent.js";
+import { buildValidationMessages } from "../i18n/buildValidationMessages.js";
 import { messageTemplate } from "../pageControllers/validationOptions.js";
 export class DeclarationField extends FormComponent {
-  DEFAULT_DECLARATION_LABEL = 'I understand and agree';
   headerStartLevel;
   constructor(def, props) {
     super(def, props);
@@ -24,7 +24,9 @@ export class DeclarationField extends FormComponent {
     this.stateSchema = joi.boolean().cast('string').label(this.label).required();
     this.options = options;
     this.content = content;
-    this.declarationConfirmationLabel = options.declarationConfirmationLabel ?? this.DEFAULT_DECLARATION_LABEL;
+    // Store only the form-authored label (if provided). If absent, getViewModel
+    // resolves the default via t() at render time so the correct language is used.
+    this.declarationConfirmationLabel = options.declarationConfirmationLabel;
     const formComponents = hasFormComponents(props.page?.pageDef) ? props.page.pageDef.components : [];
     const numOfQuestionsOnPage = formComponents.filter(q => isFormType(q.type)).length;
     const hasGuidance = formComponents.some((comp, idx) => comp.type === ComponentType.Markdown && idx === 0);
@@ -62,17 +64,37 @@ export class DeclarationField extends FormComponent {
   getFormValue(value) {
     return this.isValue(value) ? value : undefined;
   }
-  getDisplayStringFromFormValue(value) {
-    return value === 'true' ? this.declarationConfirmationLabel : 'Not provided';
+  getValidationMessagesOverride(translator) {
+    const {
+      declarationRequired
+    } = buildValidationMessages(translator.t);
+    const msg = declarationRequired;
+    return {
+      'any.required': msg,
+      'any.unknown': msg,
+      'array.includesRequiredUnknowns': msg
+    };
+  }
+  getDisplayStringFromFormValue(value, translator) {
+    const {
+      t
+    } = translator;
+    return value === 'true' ? this.declarationConfirmationLabel ?? t('components.declarationField.defaultLabel') : t('components.declarationField.notProvided');
   }
-  getViewModel(payload, errors) {
-    const defaultDeclarationConfirmationLabel = 'I confirm that I understand and accept this declaration';
+  getViewModel(context) {
+    const {
+      payload
+    } = context;
+    const {
+      t,
+      tComponent
+    } = context.translator;
     const {
       hint,
-      content,
-      declarationConfirmationLabel = defaultDeclarationConfirmationLabel
+      declarationConfirmationLabel = t('components.declarationField.defaultLabel')
     } = this;
-    const viewModel = super.getViewModel(payload, errors);
+    const content = tComponent(this, 'content');
+    const viewModel = super.getViewModel(context);
     let {
       fieldset,
       label

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

@@ -1 +1 @@
-{"version":3,"file":"DeclarationField.js","names":["ComponentType","hasFormComponents","isFormType","joi","FormComponent","isFormValue","messageTemplate","DeclarationField","DEFAULT_DECLARATION_LABEL","headerStartLevel","constructor","def","props","options","content","checkboxSchema","string","valid","required","formSchema","array","items","strip","label","single","messages","declarationRequired","stateSchema","boolean","cast","declarationConfirmationLabel","formComponents","page","pageDef","components","numOfQuestionsOnPage","filter","q","type","length","hasGuidance","some","comp","idx","Markdown","getFormValueFromState","state","name","getFormDataFromState","getStateFromValidForm","payload","payloadValue","value","isValue","every","v","getContextValueFromFormValue","getFormValue","undefined","getDisplayStringFromFormValue","getViewModel","errors","defaultDeclarationConfirmationLabel","hint","viewModel","fieldset","legend","text","classes","isChecked","Array","isArray","x","checked","getAllPossibleErrors","baseErrors","template","advancedSettingsErrors","isBool"],"sources":["../../../../../src/server/plugins/engine/components/DeclarationField.ts"],"sourcesContent":["import {\n  ComponentType,\n  hasFormComponents,\n  isFormType,\n  type DeclarationFieldComponent,\n  type Item\n} from '@defra/forms-model'\nimport joi, {\n  type ArraySchema,\n  type BooleanSchema,\n  type StringSchema\n} from 'joi'\n\nimport {\n  FormComponent,\n  isFormValue\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState,\n  type FormValue\n} from '~/src/server/plugins/engine/types.js'\n\nexport class DeclarationField extends FormComponent {\n  private readonly DEFAULT_DECLARATION_LABEL = 'I understand and agree'\n\n  declare options: DeclarationFieldComponent['options']\n\n  declare declarationConfirmationLabel: string\n\n  declare formSchema: ArraySchema<StringSchema[]>\n  declare stateSchema: BooleanSchema\n  declare content: string\n  headerStartLevel: number\n\n  constructor(\n    def: DeclarationFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options, content } = def\n\n    let checkboxSchema = joi.string().valid('true')\n\n    if (options.required !== false) {\n      checkboxSchema = checkboxSchema.required()\n    }\n\n    const formSchema = joi\n      .array()\n      .items(checkboxSchema, joi.string().valid('unchecked').strip())\n      .label(this.label)\n      .single()\n      .messages({\n        'any.required': messageTemplate.declarationRequired as string,\n        'any.unknown': messageTemplate.declarationRequired as string,\n        'array.includesRequiredUnknowns':\n          messageTemplate.declarationRequired as string\n      }) as ArraySchema<StringSchema[]>\n\n    this.formSchema = formSchema\n    this.stateSchema = joi.boolean().cast('string').label(this.label).required()\n\n    this.options = options\n    this.content = content\n    this.declarationConfirmationLabel =\n      options.declarationConfirmationLabel ?? this.DEFAULT_DECLARATION_LABEL\n    const formComponents = hasFormComponents(props.page?.pageDef)\n      ? props.page.pageDef.components\n      : []\n    const numOfQuestionsOnPage = formComponents.filter((q) =>\n      isFormType(q.type)\n    ).length\n    const hasGuidance = formComponents.some(\n      (comp, idx) => comp.type === ComponentType.Markdown && idx === 0\n    )\n    this.headerStartLevel = numOfQuestionsOnPage < 2 && !hasGuidance ? 2 : 3\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const { name } = this\n    return state[name] === true ? 'true' : 'false'\n  }\n\n  getFormDataFromState(state: FormSubmissionState): FormPayload {\n    const { name } = this\n    return { [name]: state[name] === true ? 'true' : 'false' }\n  }\n\n  getStateFromValidForm(payload: FormPayload): FormState {\n    const { name } = this\n    const payloadValue = payload[name]\n    const value =\n      this.isValue(payloadValue) &&\n      payloadValue.length > 0 &&\n      payloadValue.every((v) => {\n        return v === 'true'\n      })\n\n    return { [name]: value }\n  }\n\n  getContextValueFromFormValue(value: FormValue | FormPayload): boolean {\n    return value === 'true'\n  }\n\n  getFormValue(value?: FormStateValue | FormState) {\n    return this.isValue(value) ? value : undefined\n  }\n\n  getDisplayStringFromFormValue(value: FormValue | FormPayload): string {\n    return value === 'true' ? this.declarationConfirmationLabel : 'Not provided'\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const defaultDeclarationConfirmationLabel =\n      'I confirm that I understand and accept this declaration'\n    const {\n      hint,\n      content,\n      declarationConfirmationLabel = defaultDeclarationConfirmationLabel\n    } = this\n\n    const viewModel = super.getViewModel(payload, errors)\n    let { fieldset, label } = viewModel\n\n    fieldset ??= {\n      legend: {\n        text: label.text,\n        classes: 'govuk-fieldset__legend--m'\n      }\n    }\n\n    const payloadValue = payload[this.name]\n    const isChecked =\n      payloadValue === 'true' ||\n      payloadValue === true ||\n      (Array.isArray(payloadValue) && payloadValue.some((x) => x === 'true'))\n\n    return {\n      ...viewModel,\n      hint: hint ? { text: hint } : undefined,\n      fieldset,\n      content,\n      items: [\n        {\n          text: declarationConfirmationLabel,\n          value: 'true',\n          checked: isChecked\n        }\n      ],\n      headerStartLevel: this.headerStartLevel\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  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return DeclarationField.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.declarationRequired }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n\n  static isBool(value?: FormStateValue | FormState): value is boolean {\n    return isFormValue(value) && typeof value === 'boolean'\n  }\n}\n"],"mappings":"AAAA,SACEA,aAAa,EACbC,iBAAiB,EACjBC,UAAU,QAGL,oBAAoB;AAC3B,OAAOC,GAAG,MAIH,KAAK;AAEZ,SACEC,aAAa,EACbC,WAAW;AAEb,SAASC,eAAe;AAWxB,OAAO,MAAMC,gBAAgB,SAASH,aAAa,CAAC;EACjCI,yBAAyB,GAAG,wBAAwB;EASrEC,gBAAgB;EAEhBC,WAAWA,CACTC,GAA8B,EAC9BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,OAAO;MAAEC;IAAQ,CAAC,GAAGH,GAAG;IAEhC,IAAII,cAAc,GAAGZ,GAAG,CAACa,MAAM,CAAC,CAAC,CAACC,KAAK,CAAC,MAAM,CAAC;IAE/C,IAAIJ,OAAO,CAACK,QAAQ,KAAK,KAAK,EAAE;MAC9BH,cAAc,GAAGA,cAAc,CAACG,QAAQ,CAAC,CAAC;IAC5C;IAEA,MAAMC,UAAU,GAAGhB,GAAG,CACnBiB,KAAK,CAAC,CAAC,CACPC,KAAK,CAACN,cAAc,EAAEZ,GAAG,CAACa,MAAM,CAAC,CAAC,CAACC,KAAK,CAAC,WAAW,CAAC,CAACK,KAAK,CAAC,CAAC,CAAC,CAC9DC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,MAAM,CAAC,CAAC,CACRC,QAAQ,CAAC;MACR,cAAc,EAAEnB,eAAe,CAACoB,mBAA6B;MAC7D,aAAa,EAAEpB,eAAe,CAACoB,mBAA6B;MAC5D,gCAAgC,EAC9BpB,eAAe,CAACoB;IACpB,CAAC,CAAgC;IAEnC,IAAI,CAACP,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACQ,WAAW,GAAGxB,GAAG,CAACyB,OAAO,CAAC,CAAC,CAACC,IAAI,CAAC,QAAQ,CAAC,CAACN,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CAACL,QAAQ,CAAC,CAAC;IAE5E,IAAI,CAACL,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACgB,4BAA4B,GAC/BjB,OAAO,CAACiB,4BAA4B,IAAI,IAAI,CAACtB,yBAAyB;IACxE,MAAMuB,cAAc,GAAG9B,iBAAiB,CAACW,KAAK,CAACoB,IAAI,EAAEC,OAAO,CAAC,GACzDrB,KAAK,CAACoB,IAAI,CAACC,OAAO,CAACC,UAAU,GAC7B,EAAE;IACN,MAAMC,oBAAoB,GAAGJ,cAAc,CAACK,MAAM,CAAEC,CAAC,IACnDnC,UAAU,CAACmC,CAAC,CAACC,IAAI,CACnB,CAAC,CAACC,MAAM;IACR,MAAMC,WAAW,GAAGT,cAAc,CAACU,IAAI,CACrC,CAACC,IAAI,EAAEC,GAAG,KAAKD,IAAI,CAACJ,IAAI,KAAKtC,aAAa,CAAC4C,QAAQ,IAAID,GAAG,KAAK,CACjE,CAAC;IACD,IAAI,CAAClC,gBAAgB,GAAG0B,oBAAoB,GAAG,CAAC,IAAI,CAACK,WAAW,GAAG,CAAC,GAAG,CAAC;EAC1E;EAEAK,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAM;MAAEC;IAAK,CAAC,GAAG,IAAI;IACrB,OAAOD,KAAK,CAACC,IAAI,CAAC,KAAK,IAAI,GAAG,MAAM,GAAG,OAAO;EAChD;EAEAC,oBAAoBA,CAACF,KAA0B,EAAe;IAC5D,MAAM;MAAEC;IAAK,CAAC,GAAG,IAAI;IACrB,OAAO;MAAE,CAACA,IAAI,GAAGD,KAAK,CAACC,IAAI,CAAC,KAAK,IAAI,GAAG,MAAM,GAAG;IAAQ,CAAC;EAC5D;EAEAE,qBAAqBA,CAACC,OAAoB,EAAa;IACrD,MAAM;MAAEH;IAAK,CAAC,GAAG,IAAI;IACrB,MAAMI,YAAY,GAAGD,OAAO,CAACH,IAAI,CAAC;IAClC,MAAMK,KAAK,GACT,IAAI,CAACC,OAAO,CAACF,YAAY,CAAC,IAC1BA,YAAY,CAACZ,MAAM,GAAG,CAAC,IACvBY,YAAY,CAACG,KAAK,CAAEC,CAAC,IAAK;MACxB,OAAOA,CAAC,KAAK,MAAM;IACrB,CAAC,CAAC;IAEJ,OAAO;MAAE,CAACR,IAAI,GAAGK;IAAM,CAAC;EAC1B;EAEAI,4BAA4BA,CAACJ,KAA8B,EAAW;IACpE,OAAOA,KAAK,KAAK,MAAM;EACzB;EAEAK,YAAYA,CAACL,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACC,OAAO,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGM,SAAS;EAChD;EAEAC,6BAA6BA,CAACP,KAA8B,EAAU;IACpE,OAAOA,KAAK,KAAK,MAAM,GAAG,IAAI,CAACtB,4BAA4B,GAAG,cAAc;EAC9E;EAEA8B,YAAYA,CAACV,OAAoB,EAAEW,MAA8B,EAAE;IACjE,MAAMC,mCAAmC,GACvC,yDAAyD;IAC3D,MAAM;MACJC,IAAI;MACJjD,OAAO;MACPgB,4BAA4B,GAAGgC;IACjC,CAAC,GAAG,IAAI;IAER,MAAME,SAAS,GAAG,KAAK,CAACJ,YAAY,CAACV,OAAO,EAAEW,MAAM,CAAC;IACrD,IAAI;MAAEI,QAAQ;MAAE1C;IAAM,CAAC,GAAGyC,SAAS;IAEnCC,QAAQ,KAAK;MACXC,MAAM,EAAE;QACNC,IAAI,EAAE5C,KAAK,CAAC4C,IAAI;QAChBC,OAAO,EAAE;MACX;IACF,CAAC;IAED,MAAMjB,YAAY,GAAGD,OAAO,CAAC,IAAI,CAACH,IAAI,CAAC;IACvC,MAAMsB,SAAS,GACblB,YAAY,KAAK,MAAM,IACvBA,YAAY,KAAK,IAAI,IACpBmB,KAAK,CAACC,OAAO,CAACpB,YAAY,CAAC,IAAIA,YAAY,CAACV,IAAI,CAAE+B,CAAC,IAAKA,CAAC,KAAK,MAAM,CAAE;IAEzE,OAAO;MACL,GAAGR,SAAS;MACZD,IAAI,EAAEA,IAAI,GAAG;QAAEI,IAAI,EAAEJ;MAAK,CAAC,GAAGL,SAAS;MACvCO,QAAQ;MACRnD,OAAO;MACPO,KAAK,EAAE,CACL;QACE8C,IAAI,EAAErC,4BAA4B;QAClCsB,KAAK,EAAE,MAAM;QACbqB,OAAO,EAAEJ;MACX,CAAC,CACF;MACD5D,gBAAgB,EAAE,IAAI,CAACA;IACzB,CAAC;EACH;EAEA4C,OAAOA,CAACD,KAAkC,EAA4B;IACpE,IAAI,CAACkB,KAAK,CAACC,OAAO,CAACnB,KAAK,CAAC,EAAE;MACzB,OAAO,KAAK;IACd;;IAEA;IACA,IAAI,CAACA,KAAK,CAACb,MAAM,EAAE;MACjB,OAAO,IAAI;IACb;IAEA,OAAOa,KAAK,CAACE,KAAK,CAACjD,WAAW,CAAC;EACjC;;EAEA;AACF;AACA;EACEqE,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOnE,gBAAgB,CAACmE,oBAAoB,CAAC,CAAC;EAChD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAErC,IAAI,EAAE,UAAU;QAAEsC,QAAQ,EAAEtE,eAAe,CAACoB;MAAoB,CAAC,CACpE;MACDmD,sBAAsB,EAAE;IAC1B,CAAC;EACH;EAEA,OAAOC,MAAMA,CAAC1B,KAAkC,EAAoB;IAClE,OAAO/C,WAAW,CAAC+C,KAAK,CAAC,IAAI,OAAOA,KAAK,KAAK,SAAS;EACzD;AACF","ignoreList":[]}
+{"version":3,"file":"DeclarationField.js","names":["ComponentType","hasFormComponents","isFormType","joi","FormComponent","isFormValue","buildValidationMessages","messageTemplate","DeclarationField","headerStartLevel","constructor","def","props","options","content","checkboxSchema","string","valid","required","formSchema","array","items","strip","label","single","messages","declarationRequired","stateSchema","boolean","cast","declarationConfirmationLabel","formComponents","page","pageDef","components","numOfQuestionsOnPage","filter","q","type","length","hasGuidance","some","comp","idx","Markdown","getFormValueFromState","state","name","getFormDataFromState","getStateFromValidForm","payload","payloadValue","value","isValue","every","v","getContextValueFromFormValue","getFormValue","undefined","getValidationMessagesOverride","translator","t","msg","getDisplayStringFromFormValue","getViewModel","context","tComponent","hint","viewModel","fieldset","legend","text","classes","isChecked","Array","isArray","x","checked","getAllPossibleErrors","baseErrors","template","advancedSettingsErrors","isBool"],"sources":["../../../../../src/server/plugins/engine/components/DeclarationField.ts"],"sourcesContent":["import {\n  ComponentType,\n  hasFormComponents,\n  isFormType,\n  type ComponentDef,\n  type DeclarationFieldComponent,\n  type Item\n} from '@defra/forms-model'\nimport joi, {\n  type ArraySchema,\n  type BooleanSchema,\n  type LanguageMessages,\n  type StringSchema\n} from 'joi'\n\nimport {\n  FormComponent,\n  isFormValue\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type RenderContext } from '~/src/server/plugins/engine/components/types.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 {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionState,\n  type FormValue\n} from '~/src/server/plugins/engine/types.js'\n\nexport class DeclarationField extends FormComponent {\n  declare options: DeclarationFieldComponent['options']\n\n  declare declarationConfirmationLabel: string | undefined\n\n  declare formSchema: ArraySchema<StringSchema[]>\n  declare stateSchema: BooleanSchema\n  declare content: string\n  headerStartLevel: number\n\n  constructor(\n    def: DeclarationFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options, content } = def\n\n    let checkboxSchema = joi.string().valid('true')\n\n    if (options.required !== false) {\n      checkboxSchema = checkboxSchema.required()\n    }\n\n    const formSchema = joi\n      .array()\n      .items(checkboxSchema, joi.string().valid('unchecked').strip())\n      .label(this.label)\n      .single()\n      .messages({\n        'any.required': messageTemplate.declarationRequired as string,\n        'any.unknown': messageTemplate.declarationRequired as string,\n        'array.includesRequiredUnknowns':\n          messageTemplate.declarationRequired as string\n      }) as ArraySchema<StringSchema[]>\n\n    this.formSchema = formSchema\n    this.stateSchema = joi.boolean().cast('string').label(this.label).required()\n\n    this.options = options\n    this.content = content\n    // Store only the form-authored label (if provided). If absent, getViewModel\n    // resolves the default via t() at render time so the correct language is used.\n    this.declarationConfirmationLabel = options.declarationConfirmationLabel\n    const formComponents = hasFormComponents(props.page?.pageDef)\n      ? props.page.pageDef.components\n      : []\n    const numOfQuestionsOnPage = formComponents.filter((q) =>\n      isFormType(q.type)\n    ).length\n    const hasGuidance = formComponents.some(\n      (comp, idx) => comp.type === ComponentType.Markdown && idx === 0\n    )\n    this.headerStartLevel = numOfQuestionsOnPage < 2 && !hasGuidance ? 2 : 3\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const { name } = this\n    return state[name] === true ? 'true' : 'false'\n  }\n\n  getFormDataFromState(state: FormSubmissionState): FormPayload {\n    const { name } = this\n    return { [name]: state[name] === true ? 'true' : 'false' }\n  }\n\n  getStateFromValidForm(payload: FormPayload): FormState {\n    const { name } = this\n    const payloadValue = payload[name]\n    const value =\n      this.isValue(payloadValue) &&\n      payloadValue.length > 0 &&\n      payloadValue.every((v) => {\n        return v === 'true'\n      })\n\n    return { [name]: value }\n  }\n\n  getContextValueFromFormValue(value: FormValue | FormPayload): boolean {\n    return value === 'true'\n  }\n\n  getFormValue(value?: FormStateValue | FormState) {\n    return this.isValue(value) ? value : undefined\n  }\n\n  getValidationMessagesOverride(translator: Translator) {\n    const { declarationRequired } = buildValidationMessages(translator.t)\n    const msg = declarationRequired as unknown as string\n    return {\n      'any.required': msg,\n      'any.unknown': msg,\n      'array.includesRequiredUnknowns': msg\n    } as unknown as LanguageMessages\n  }\n\n  getDisplayStringFromFormValue(\n    value: FormValue | FormPayload,\n    translator: Translator\n  ): string {\n    const { t } = translator\n    return value === 'true'\n      ? (this.declarationConfirmationLabel ??\n          t('components.declarationField.defaultLabel'))\n      : t('components.declarationField.notProvided')\n  }\n\n  getViewModel(context: RenderContext) {\n    const { payload } = context\n    const { t, tComponent } = context.translator\n\n    const {\n      hint,\n      declarationConfirmationLabel = t(\n        'components.declarationField.defaultLabel'\n      )\n    } = this\n    const content = tComponent(this as unknown as ComponentDef, 'content')\n\n    const viewModel = super.getViewModel(context)\n    let { fieldset, label } = viewModel\n\n    fieldset ??= {\n      legend: {\n        text: label.text,\n        classes: 'govuk-fieldset__legend--m'\n      }\n    }\n\n    const payloadValue = payload[this.name]\n    const isChecked =\n      payloadValue === 'true' ||\n      payloadValue === true ||\n      (Array.isArray(payloadValue) && payloadValue.some((x) => x === 'true'))\n\n    return {\n      ...viewModel,\n      hint: hint ? { text: hint } : undefined,\n      fieldset,\n      content,\n      items: [\n        {\n          text: declarationConfirmationLabel,\n          value: 'true',\n          checked: isChecked\n        }\n      ],\n      headerStartLevel: this.headerStartLevel\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  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return DeclarationField.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.declarationRequired }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n\n  static isBool(value?: FormStateValue | FormState): value is boolean {\n    return isFormValue(value) && typeof value === 'boolean'\n  }\n}\n"],"mappings":"AAAA,SACEA,aAAa,EACbC,iBAAiB,EACjBC,UAAU,QAIL,oBAAoB;AAC3B,OAAOC,GAAG,MAKH,KAAK;AAEZ,SACEC,aAAa,EACbC,WAAW;AAGb,SAASC,uBAAuB;AAEhC,SAASC,eAAe;AAUxB,OAAO,MAAMC,gBAAgB,SAASJ,aAAa,CAAC;EAQlDK,gBAAgB;EAEhBC,WAAWA,CACTC,GAA8B,EAC9BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,OAAO;MAAEC;IAAQ,CAAC,GAAGH,GAAG;IAEhC,IAAII,cAAc,GAAGZ,GAAG,CAACa,MAAM,CAAC,CAAC,CAACC,KAAK,CAAC,MAAM,CAAC;IAE/C,IAAIJ,OAAO,CAACK,QAAQ,KAAK,KAAK,EAAE;MAC9BH,cAAc,GAAGA,cAAc,CAACG,QAAQ,CAAC,CAAC;IAC5C;IAEA,MAAMC,UAAU,GAAGhB,GAAG,CACnBiB,KAAK,CAAC,CAAC,CACPC,KAAK,CAACN,cAAc,EAAEZ,GAAG,CAACa,MAAM,CAAC,CAAC,CAACC,KAAK,CAAC,WAAW,CAAC,CAACK,KAAK,CAAC,CAAC,CAAC,CAC9DC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,MAAM,CAAC,CAAC,CACRC,QAAQ,CAAC;MACR,cAAc,EAAElB,eAAe,CAACmB,mBAA6B;MAC7D,aAAa,EAAEnB,eAAe,CAACmB,mBAA6B;MAC5D,gCAAgC,EAC9BnB,eAAe,CAACmB;IACpB,CAAC,CAAgC;IAEnC,IAAI,CAACP,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACQ,WAAW,GAAGxB,GAAG,CAACyB,OAAO,CAAC,CAAC,CAACC,IAAI,CAAC,QAAQ,CAAC,CAACN,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CAACL,QAAQ,CAAC,CAAC;IAE5E,IAAI,CAACL,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB;IACA;IACA,IAAI,CAACgB,4BAA4B,GAAGjB,OAAO,CAACiB,4BAA4B;IACxE,MAAMC,cAAc,GAAG9B,iBAAiB,CAACW,KAAK,CAACoB,IAAI,EAAEC,OAAO,CAAC,GACzDrB,KAAK,CAACoB,IAAI,CAACC,OAAO,CAACC,UAAU,GAC7B,EAAE;IACN,MAAMC,oBAAoB,GAAGJ,cAAc,CAACK,MAAM,CAAEC,CAAC,IACnDnC,UAAU,CAACmC,CAAC,CAACC,IAAI,CACnB,CAAC,CAACC,MAAM;IACR,MAAMC,WAAW,GAAGT,cAAc,CAACU,IAAI,CACrC,CAACC,IAAI,EAAEC,GAAG,KAAKD,IAAI,CAACJ,IAAI,KAAKtC,aAAa,CAAC4C,QAAQ,IAAID,GAAG,KAAK,CACjE,CAAC;IACD,IAAI,CAAClC,gBAAgB,GAAG0B,oBAAoB,GAAG,CAAC,IAAI,CAACK,WAAW,GAAG,CAAC,GAAG,CAAC;EAC1E;EAEAK,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAM;MAAEC;IAAK,CAAC,GAAG,IAAI;IACrB,OAAOD,KAAK,CAACC,IAAI,CAAC,KAAK,IAAI,GAAG,MAAM,GAAG,OAAO;EAChD;EAEAC,oBAAoBA,CAACF,KAA0B,EAAe;IAC5D,MAAM;MAAEC;IAAK,CAAC,GAAG,IAAI;IACrB,OAAO;MAAE,CAACA,IAAI,GAAGD,KAAK,CAACC,IAAI,CAAC,KAAK,IAAI,GAAG,MAAM,GAAG;IAAQ,CAAC;EAC5D;EAEAE,qBAAqBA,CAACC,OAAoB,EAAa;IACrD,MAAM;MAAEH;IAAK,CAAC,GAAG,IAAI;IACrB,MAAMI,YAAY,GAAGD,OAAO,CAACH,IAAI,CAAC;IAClC,MAAMK,KAAK,GACT,IAAI,CAACC,OAAO,CAACF,YAAY,CAAC,IAC1BA,YAAY,CAACZ,MAAM,GAAG,CAAC,IACvBY,YAAY,CAACG,KAAK,CAAEC,CAAC,IAAK;MACxB,OAAOA,CAAC,KAAK,MAAM;IACrB,CAAC,CAAC;IAEJ,OAAO;MAAE,CAACR,IAAI,GAAGK;IAAM,CAAC;EAC1B;EAEAI,4BAA4BA,CAACJ,KAA8B,EAAW;IACpE,OAAOA,KAAK,KAAK,MAAM;EACzB;EAEAK,YAAYA,CAACL,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACC,OAAO,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGM,SAAS;EAChD;EAEAC,6BAA6BA,CAACC,UAAsB,EAAE;IACpD,MAAM;MAAElC;IAAoB,CAAC,GAAGpB,uBAAuB,CAACsD,UAAU,CAACC,CAAC,CAAC;IACrE,MAAMC,GAAG,GAAGpC,mBAAwC;IACpD,OAAO;MACL,cAAc,EAAEoC,GAAG;MACnB,aAAa,EAAEA,GAAG;MAClB,gCAAgC,EAAEA;IACpC,CAAC;EACH;EAEAC,6BAA6BA,CAC3BX,KAA8B,EAC9BQ,UAAsB,EACd;IACR,MAAM;MAAEC;IAAE,CAAC,GAAGD,UAAU;IACxB,OAAOR,KAAK,KAAK,MAAM,GAClB,IAAI,CAACtB,4BAA4B,IAChC+B,CAAC,CAAC,0CAA0C,CAAC,GAC/CA,CAAC,CAAC,yCAAyC,CAAC;EAClD;EAEAG,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAM;MAAEf;IAAQ,CAAC,GAAGe,OAAO;IAC3B,MAAM;MAAEJ,CAAC;MAAEK;IAAW,CAAC,GAAGD,OAAO,CAACL,UAAU;IAE5C,MAAM;MACJO,IAAI;MACJrC,4BAA4B,GAAG+B,CAAC,CAC9B,0CACF;IACF,CAAC,GAAG,IAAI;IACR,MAAM/C,OAAO,GAAGoD,UAAU,CAAC,IAAI,EAA6B,SAAS,CAAC;IAEtE,MAAME,SAAS,GAAG,KAAK,CAACJ,YAAY,CAACC,OAAO,CAAC;IAC7C,IAAI;MAAEI,QAAQ;MAAE9C;IAAM,CAAC,GAAG6C,SAAS;IAEnCC,QAAQ,KAAK;MACXC,MAAM,EAAE;QACNC,IAAI,EAAEhD,KAAK,CAACgD,IAAI;QAChBC,OAAO,EAAE;MACX;IACF,CAAC;IAED,MAAMrB,YAAY,GAAGD,OAAO,CAAC,IAAI,CAACH,IAAI,CAAC;IACvC,MAAM0B,SAAS,GACbtB,YAAY,KAAK,MAAM,IACvBA,YAAY,KAAK,IAAI,IACpBuB,KAAK,CAACC,OAAO,CAACxB,YAAY,CAAC,IAAIA,YAAY,CAACV,IAAI,CAAEmC,CAAC,IAAKA,CAAC,KAAK,MAAM,CAAE;IAEzE,OAAO;MACL,GAAGR,SAAS;MACZD,IAAI,EAAEA,IAAI,GAAG;QAAEI,IAAI,EAAEJ;MAAK,CAAC,GAAGT,SAAS;MACvCW,QAAQ;MACRvD,OAAO;MACPO,KAAK,EAAE,CACL;QACEkD,IAAI,EAAEzC,4BAA4B;QAClCsB,KAAK,EAAE,MAAM;QACbyB,OAAO,EAAEJ;MACX,CAAC,CACF;MACDhE,gBAAgB,EAAE,IAAI,CAACA;IACzB,CAAC;EACH;EAEA4C,OAAOA,CAACD,KAAkC,EAA4B;IACpE,IAAI,CAACsB,KAAK,CAACC,OAAO,CAACvB,KAAK,CAAC,EAAE;MACzB,OAAO,KAAK;IACd;;IAEA;IACA,IAAI,CAACA,KAAK,CAACb,MAAM,EAAE;MACjB,OAAO,IAAI;IACb;IAEA,OAAOa,KAAK,CAACE,KAAK,CAACjD,WAAW,CAAC;EACjC;;EAEA;AACF;AACA;EACEyE,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOtE,gBAAgB,CAACsE,oBAAoB,CAAC,CAAC;EAChD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEzC,IAAI,EAAE,UAAU;QAAE0C,QAAQ,EAAEzE,eAAe,CAACmB;MAAoB,CAAC,CACpE;MACDuD,sBAAsB,EAAE;IAC1B,CAAC;EACH;EAEA,OAAOC,MAAMA,CAAC9B,KAAkC,EAAoB;IAClE,OAAO/C,WAAW,CAAC+C,KAAK,CAAC,IAAI,OAAOA,KAAK,KAAK,SAAS;EACzD;AACF","ignoreList":[]}

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

@@ -2,7 +2,8 @@ import { type EastingNorthingFieldComponent } 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 EastingNorthingState } from '../../../../server/plugins/engine/components/types.js';
+import { type EastingNorthingState, type RenderContext } from '../../../../server/plugins/engine/components/types.js';
+import { type Translator } from '../../../../server/plugins/engine/i18n/types.js';
 import { type ErrorMessageTemplateList, type FormPayload, type FormState, type FormStateValue, type FormSubmissionError, type FormSubmissionState } from '../../../../server/plugins/engine/types.js';
 export declare class EastingNorthingField extends FormComponent {
     options: EastingNorthingFieldComponent['options'];
@@ -11,16 +12,17 @@ export declare class EastingNorthingField extends FormComponent {
     collection: ComponentCollection;
     constructor(def: EastingNorthingFieldComponent, props: ConstructorParameters<typeof FormComponent>[1]);
     getFormValueFromState(state: FormSubmissionState): EastingNorthingState | undefined;
-    getDisplayStringFromFormValue(value: EastingNorthingState | undefined): string;
-    getDisplayStringFromState(state: FormSubmissionState): string;
+    getDisplayStringFromFormValue(value: EastingNorthingState | undefined, _translator: Translator): string;
+    getDisplayStringFromState(state: FormSubmissionState, translator: Translator): string;
     getContextValueFromFormValue(value: EastingNorthingState | undefined): string | null;
     getContextValueFromState(state: FormSubmissionState): string | null;
-    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+    getViewModel(context: RenderContext): {
         fieldset: {
             attributes?: string | Record<string, string>;
             legend?: import("../../../../server/plugins/engine/components/types.js").Label;
         };
         items: import("../../../../server/plugins/engine/components/types.js").DateInputItem[];
+        mapLayers: string;
         label: import("../../../../server/plugins/engine/components/types.js").Label;
         type?: string;
         id: string;
@@ -68,6 +70,7 @@ export declare class EastingNorthingField extends FormComponent {
             legend?: import("../../../../server/plugins/engine/components/types.js").Label;
         };
         items: import("../../../../server/plugins/engine/components/types.js").DateInputItem[];
+        mapLayers: string;
         label: import("../../../../server/plugins/engine/components/types.js").Label;
         type?: string;
         id: string;
@@ -109,7 +112,7 @@ export declare class EastingNorthingField extends FormComponent {
             summaryList: import("../../../../server/plugins/engine/types.js").SummaryList;
         };
     };
-    getViewErrors(errors?: FormSubmissionError[]): FormSubmissionError[] | undefined;
+    getViewErrors(translator: Translator, errors?: FormSubmissionError[]): FormSubmissionError[] | undefined;
     isState(value?: FormStateValue | FormState): value is EastingNorthingState;
     /**
      * For error preview page that shows all possible errors on a component

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

@@ -5,6 +5,7 @@ import { FormComponent, isFormState } from "./FormComponent.js";
 import { deduplicateErrorsByHref, getLocationFieldViewModel } from "./LocationFieldHelpers.js";
 import { NumberField } from "./NumberField.js";
 import { createLowerFirstExpression } from "./helpers/index.js";
+import { t as tPlugin } from "../i18n/index.js";
 import { messageTemplate } from "../pageControllers/validationOptions.js";
 import { convertToLanguageMessages } from "../../../utils/type-utils.js";
 
@@ -26,24 +27,43 @@ export class EastingNorthingField extends FormComponent {
     const eastingMax = schema?.easting?.max ?? DEFAULT_EASTING_MAX;
     const northingMin = schema?.northing?.min ?? DEFAULT_NORTHING_MIN;
     const northingMax = schema?.northing?.max ?? DEFAULT_NORTHING_MAX;
-    const eastingRequired = 'Enter easting';
-    const northingRequired = 'Enter northing';
-    const eastingDigitsMessage = `{{#label}} for ${lowerFirst(this.label)} must be between 1 and 6 digits`;
-    const northingDigitsMessage = `{{#label}} for ${lowerFirst(this.label)} must be between 1 and 7 digits`;
+    const fieldLabel = lowerFirst(this.label);
+    const eastingDigitsMessage = tPlugin('components.eastingNorthingField.eastingDigits', 'en-GB', {
+      fieldLabel
+    });
+    const northingDigitsMessage = tPlugin('components.eastingNorthingField.northingDigits', 'en-GB', {
+      fieldLabel
+    });
     const customValidationMessages = convertToLanguageMessages({
-      'any.required': eastingRequired,
-      'number.base': eastingRequired,
-      'number.min': `{{#label}} for ${lowerFirst(this.label)} must be between {{#limit}} and ${eastingMax}`,
-      'number.max': `{{#label}} for ${lowerFirst(this.label)} must be between ${eastingMin} and {{#limit}}`,
+      'any.required': tPlugin('components.eastingNorthingField.eastingRequired', 'en-GB'),
+      'number.base': tPlugin('components.eastingNorthingField.eastingRequired', 'en-GB'),
+      'number.min': tPlugin('components.eastingNorthingField.eastingRange', 'en-GB', {
+        fieldLabel,
+        min: eastingMin,
+        max: eastingMax
+      }),
+      'number.max': tPlugin('components.eastingNorthingField.eastingRange', 'en-GB', {
+        fieldLabel,
+        min: eastingMin,
+        max: eastingMax
+      }),
       'number.precision': eastingDigitsMessage,
       'number.integer': eastingDigitsMessage,
       'number.unsafe': eastingDigitsMessage
     });
     const northingValidationMessages = convertToLanguageMessages({
-      'any.required': northingRequired,
-      'number.base': northingRequired,
-      'number.min': `{{#label}} for ${lowerFirst(this.label)} must be between {{#limit}} and ${northingMax}`,
-      'number.max': `{{#label}} for ${lowerFirst(this.label)} must be between ${northingMin} and {{#limit}}`,
+      'any.required': tPlugin('components.eastingNorthingField.northingRequired', 'en-GB'),
+      'number.base': tPlugin('components.eastingNorthingField.northingRequired', 'en-GB'),
+      'number.min': tPlugin('components.eastingNorthingField.northingRange', 'en-GB', {
+        fieldLabel,
+        min: northingMin,
+        max: northingMax
+      }),
+      'number.max': tPlugin('components.eastingNorthingField.northingRange', 'en-GB', {
+        fieldLabel,
+        min: northingMin,
+        max: northingMax
+      }),
       'number.precision': northingDigitsMessage,
       'number.integer': northingDigitsMessage,
       'number.unsafe': northingDigitsMessage
@@ -51,7 +71,7 @@ export class EastingNorthingField extends FormComponent {
     this.collection = new ComponentCollection([{
       type: ComponentType.NumberField,
       name: `${name}__easting`,
-      title: 'Easting',
+      title: 'components.eastingNorthingField.easting',
       schema: {
         min: eastingMin,
         max: eastingMax,
@@ -66,7 +86,7 @@ export class EastingNorthingField extends FormComponent {
     }, {
       type: ComponentType.NumberField,
       name: `${name}__northing`,
-      title: 'Northing',
+      title: 'components.eastingNorthingField.northing',
       schema: {
         min: northingMin,
         max: northingMax,
@@ -92,7 +112,7 @@ export class EastingNorthingField extends FormComponent {
     const value = super.getFormValueFromState(state);
     return EastingNorthingField.isEastingNorthing(value) ? value : undefined;
   }
-  getDisplayStringFromFormValue(value) {
+  getDisplayStringFromFormValue(value, _translator) {
     if (!value) {
       return '';
     }
@@ -100,9 +120,9 @@ export class EastingNorthingField extends FormComponent {
     // CYA page format: <<eastingvalue, northingvalue>>
     return `${value.easting}, ${value.northing}`;
   }
-  getDisplayStringFromState(state) {
+  getDisplayStringFromState(state, translator) {
     const value = this.getFormValueFromState(state);
-    return this.getDisplayStringFromFormValue(value);
+    return this.getDisplayStringFromFormValue(value, translator);
   }
   getContextValueFromFormValue(value) {
     if (!value) {
@@ -114,12 +134,12 @@ export class EastingNorthingField extends FormComponent {
     const value = this.getFormValueFromState(state);
     return this.getContextValueFromFormValue(value);
   }
-  getViewModel(payload, errors) {
-    const viewModel = super.getViewModel(payload, errors);
-    return getLocationFieldViewModel(this, viewModel, payload, errors);
+  getViewModel(context) {
+    const viewModel = super.getViewModel(context);
+    return getLocationFieldViewModel(this, viewModel, context);
   }
-  getViewErrors(errors) {
-    const allErrors = this.getErrors(errors);
+  getViewErrors(translator, errors) {
+    const allErrors = this.getErrors(translator, errors);
     return deduplicateErrorsByHref(allErrors);
   }
   isState(value) {

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

@@ -1 +1 @@
-{"version":3,"file":"EastingNorthingField.js","names":["ComponentType","lowerFirst","ComponentCollection","FormComponent","isFormState","deduplicateErrorsByHref","getLocationFieldViewModel","NumberField","createLowerFirstExpression","messageTemplate","convertToLanguageMessages","DEFAULT_EASTING_MIN","DEFAULT_EASTING_MAX","DEFAULT_NORTHING_MIN","DEFAULT_NORTHING_MAX","EastingNorthingField","constructor","def","props","name","options","schema","isRequired","required","eastingMin","easting","min","eastingMax","max","northingMin","northing","northingMax","eastingRequired","northingRequired","eastingDigitsMessage","label","northingDigitsMessage","customValidationMessages","northingValidationMessages","collection","type","title","precision","optionalText","classes","parent","peers","formSchema","stateSchema","getFormValueFromState","state","value","isEastingNorthing","undefined","getDisplayStringFromFormValue","getDisplayStringFromState","getContextValueFromFormValue","getContextValueFromState","getViewModel","payload","errors","viewModel","getViewErrors","allErrors","getErrors","isState","getAllPossibleErrors","baseErrors","template","advancedSettingsErrors","isNumber"],"sources":["../../../../../src/server/plugins/engine/components/EastingNorthingField.ts"],"sourcesContent":["import {\n  ComponentType,\n  type EastingNorthingFieldComponent\n} from '@defra/forms-model'\nimport { type LanguageMessages, 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 {\n  deduplicateErrorsByHref,\n  getLocationFieldViewModel\n} from '~/src/server/plugins/engine/components/LocationFieldHelpers.js'\nimport { NumberField } from '~/src/server/plugins/engine/components/NumberField.js'\nimport { createLowerFirstExpression } from '~/src/server/plugins/engine/components/helpers/index.js'\nimport { type EastingNorthingState } 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 FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport { convertToLanguageMessages } from '~/src/server/utils/type-utils.js'\n\n// British National Grid coordinate limits\nconst DEFAULT_EASTING_MIN = 0\nconst DEFAULT_EASTING_MAX = 700000\nconst DEFAULT_NORTHING_MIN = 0\nconst DEFAULT_NORTHING_MAX = 1300000\n\nexport class EastingNorthingField extends FormComponent {\n  declare options: EastingNorthingFieldComponent['options']\n  declare formSchema: ObjectSchema<FormPayload>\n  declare stateSchema: ObjectSchema<FormState>\n  declare collection: ComponentCollection\n\n  constructor(\n    def: EastingNorthingFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { name, options, schema } = def\n\n    const isRequired = options.required !== false\n\n    const eastingMin = schema?.easting?.min ?? DEFAULT_EASTING_MIN\n    const eastingMax = schema?.easting?.max ?? DEFAULT_EASTING_MAX\n    const northingMin = schema?.northing?.min ?? DEFAULT_NORTHING_MIN\n    const northingMax = schema?.northing?.max ?? DEFAULT_NORTHING_MAX\n\n    const eastingRequired = 'Enter easting'\n    const northingRequired = 'Enter northing'\n\n    const eastingDigitsMessage = `{{#label}} for ${lowerFirst(this.label)} must be between 1 and 6 digits`\n    const northingDigitsMessage = `{{#label}} for ${lowerFirst(this.label)} must be between 1 and 7 digits`\n\n    const customValidationMessages: LanguageMessages =\n      convertToLanguageMessages({\n        'any.required': eastingRequired,\n        'number.base': eastingRequired,\n        'number.min': `{{#label}} for ${lowerFirst(this.label)} must be between {{#limit}} and ${eastingMax}`,\n        'number.max': `{{#label}} for ${lowerFirst(this.label)} must be between ${eastingMin} and {{#limit}}`,\n        'number.precision': eastingDigitsMessage,\n        'number.integer': eastingDigitsMessage,\n        'number.unsafe': eastingDigitsMessage\n      })\n\n    const northingValidationMessages: LanguageMessages =\n      convertToLanguageMessages({\n        'any.required': northingRequired,\n        'number.base': northingRequired,\n        'number.min': `{{#label}} for ${lowerFirst(this.label)} must be between {{#limit}} and ${northingMax}`,\n        'number.max': `{{#label}} for ${lowerFirst(this.label)} must be between ${northingMin} and {{#limit}}`,\n        'number.precision': northingDigitsMessage,\n        'number.integer': northingDigitsMessage,\n        'number.unsafe': northingDigitsMessage\n      })\n\n    this.collection = new ComponentCollection(\n      [\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__easting`,\n          title: 'Easting',\n          schema: {\n            min: eastingMin,\n            max: eastingMax,\n            precision: 0\n          },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-10',\n            customValidationMessages\n          }\n        },\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__northing`,\n          title: 'Northing',\n          schema: {\n            min: northingMin,\n            max: northingMax,\n            precision: 0\n          },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-10',\n            customValidationMessages: northingValidationMessages\n          }\n        }\n      ],\n      { ...props, parent: this },\n      {\n        peers: [`${name}__easting`, `${name}__northing`]\n      }\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 EastingNorthingField.isEastingNorthing(value) ? value : undefined\n  }\n\n  getDisplayStringFromFormValue(\n    value: EastingNorthingState | undefined\n  ): string {\n    if (!value) {\n      return ''\n    }\n\n    // CYA page format: <<eastingvalue, northingvalue>>\n    return `${value.easting}, ${value.northing}`\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\n    return this.getDisplayStringFromFormValue(value)\n  }\n\n  getContextValueFromFormValue(\n    value: EastingNorthingState | undefined\n  ): string | null {\n    if (!value) {\n      return null\n    }\n\n    return `Easting: ${value.easting}\\nNorthing: ${value.northing}`\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\n    return this.getContextValueFromFormValue(value)\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const viewModel = super.getViewModel(payload, errors)\n    return getLocationFieldViewModel(this, viewModel, payload, errors)\n  }\n\n  getViewErrors(\n    errors?: FormSubmissionError[]\n  ): FormSubmissionError[] | undefined {\n    const allErrors = this.getErrors(errors)\n    return deduplicateErrorsByHref(allErrors)\n  }\n\n  isState(value?: FormStateValue | FormState) {\n    return EastingNorthingField.isEastingNorthing(value)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return EastingNorthingField.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        {\n          type: 'eastingFormat',\n          template: createLowerFirstExpression(\n            'Easting for {{lowerFirst(#title)}} must be between 1 and 6 digits'\n          )\n        },\n        {\n          type: 'northingFormat',\n          template: createLowerFirstExpression(\n            'Northing for {{lowerFirst(#title)}} must be between 1 and 7 digits'\n          )\n        }\n      ],\n      advancedSettingsErrors: [\n        {\n          type: 'eastingMin',\n          template: createLowerFirstExpression(\n            `Easting for {{lowerFirst(#title)}} must be between ${DEFAULT_EASTING_MIN} and ${DEFAULT_EASTING_MAX}`\n          )\n        },\n        {\n          type: 'eastingMax',\n          template: createLowerFirstExpression(\n            `Easting for {{lowerFirst(#title)}} must be between ${DEFAULT_EASTING_MIN} and ${DEFAULT_EASTING_MAX}`\n          )\n        },\n        {\n          type: 'northingMin',\n          template: createLowerFirstExpression(\n            `Northing for {{lowerFirst(#title)}} must be between ${DEFAULT_NORTHING_MIN} and ${DEFAULT_NORTHING_MAX}`\n          )\n        },\n        {\n          type: 'northingMax',\n          template: createLowerFirstExpression(\n            `Northing for {{lowerFirst(#title)}} must be between ${DEFAULT_NORTHING_MIN} and ${DEFAULT_NORTHING_MAX}`\n          )\n        }\n      ]\n    }\n  }\n\n  static isEastingNorthing(\n    value?: FormStateValue | FormState\n  ): value is EastingNorthingState {\n    return (\n      isFormState(value) &&\n      NumberField.isNumber(value.easting) &&\n      NumberField.isNumber(value.northing)\n    )\n  }\n}\n"],"mappings":"AAAA,SACEA,aAAa,QAER,oBAAoB;AAE3B,OAAOC,UAAU,MAAM,sBAAsB;AAE7C,SAASC,mBAAmB;AAC5B,SACEC,aAAa,EACbC,WAAW;AAEb,SACEC,uBAAuB,EACvBC,yBAAyB;AAE3B,SAASC,WAAW;AACpB,SAASC,0BAA0B;AAEnC,SAASC,eAAe;AASxB,SAASC,yBAAyB;;AAElC;AACA,MAAMC,mBAAmB,GAAG,CAAC;AAC7B,MAAMC,mBAAmB,GAAG,MAAM;AAClC,MAAMC,oBAAoB,GAAG,CAAC;AAC9B,MAAMC,oBAAoB,GAAG,OAAO;AAEpC,OAAO,MAAMC,oBAAoB,SAASZ,aAAa,CAAC;EAMtDa,WAAWA,CACTC,GAAkC,EAClCC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,IAAI;MAAEC,OAAO;MAAEC;IAAO,CAAC,GAAGJ,GAAG;IAErC,MAAMK,UAAU,GAAGF,OAAO,CAACG,QAAQ,KAAK,KAAK;IAE7C,MAAMC,UAAU,GAAGH,MAAM,EAAEI,OAAO,EAAEC,GAAG,IAAIf,mBAAmB;IAC9D,MAAMgB,UAAU,GAAGN,MAAM,EAAEI,OAAO,EAAEG,GAAG,IAAIhB,mBAAmB;IAC9D,MAAMiB,WAAW,GAAGR,MAAM,EAAES,QAAQ,EAAEJ,GAAG,IAAIb,oBAAoB;IACjE,MAAMkB,WAAW,GAAGV,MAAM,EAAES,QAAQ,EAAEF,GAAG,IAAId,oBAAoB;IAEjE,MAAMkB,eAAe,GAAG,eAAe;IACvC,MAAMC,gBAAgB,GAAG,gBAAgB;IAEzC,MAAMC,oBAAoB,GAAG,kBAAkBjC,UAAU,CAAC,IAAI,CAACkC,KAAK,CAAC,iCAAiC;IACtG,MAAMC,qBAAqB,GAAG,kBAAkBnC,UAAU,CAAC,IAAI,CAACkC,KAAK,CAAC,iCAAiC;IAEvG,MAAME,wBAA0C,GAC9C3B,yBAAyB,CAAC;MACxB,cAAc,EAAEsB,eAAe;MAC/B,aAAa,EAAEA,eAAe;MAC9B,YAAY,EAAE,kBAAkB/B,UAAU,CAAC,IAAI,CAACkC,KAAK,CAAC,mCAAmCR,UAAU,EAAE;MACrG,YAAY,EAAE,kBAAkB1B,UAAU,CAAC,IAAI,CAACkC,KAAK,CAAC,oBAAoBX,UAAU,iBAAiB;MACrG,kBAAkB,EAAEU,oBAAoB;MACxC,gBAAgB,EAAEA,oBAAoB;MACtC,eAAe,EAAEA;IACnB,CAAC,CAAC;IAEJ,MAAMI,0BAA4C,GAChD5B,yBAAyB,CAAC;MACxB,cAAc,EAAEuB,gBAAgB;MAChC,aAAa,EAAEA,gBAAgB;MAC/B,YAAY,EAAE,kBAAkBhC,UAAU,CAAC,IAAI,CAACkC,KAAK,CAAC,mCAAmCJ,WAAW,EAAE;MACtG,YAAY,EAAE,kBAAkB9B,UAAU,CAAC,IAAI,CAACkC,KAAK,CAAC,oBAAoBN,WAAW,iBAAiB;MACtG,kBAAkB,EAAEO,qBAAqB;MACzC,gBAAgB,EAAEA,qBAAqB;MACvC,eAAe,EAAEA;IACnB,CAAC,CAAC;IAEJ,IAAI,CAACG,UAAU,GAAG,IAAIrC,mBAAmB,CACvC,CACE;MACEsC,IAAI,EAAExC,aAAa,CAACO,WAAW;MAC/BY,IAAI,EAAE,GAAGA,IAAI,WAAW;MACxBsB,KAAK,EAAE,SAAS;MAChBpB,MAAM,EAAE;QACNK,GAAG,EAAEF,UAAU;QACfI,GAAG,EAAED,UAAU;QACfe,SAAS,EAAE;MACb,CAAC;MACDtB,OAAO,EAAE;QACPG,QAAQ,EAAED,UAAU;QACpBqB,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,uBAAuB;QAChCP;MACF;IACF,CAAC,EACD;MACEG,IAAI,EAAExC,aAAa,CAACO,WAAW;MAC/BY,IAAI,EAAE,GAAGA,IAAI,YAAY;MACzBsB,KAAK,EAAE,UAAU;MACjBpB,MAAM,EAAE;QACNK,GAAG,EAAEG,WAAW;QAChBD,GAAG,EAAEG,WAAW;QAChBW,SAAS,EAAE;MACb,CAAC;MACDtB,OAAO,EAAE;QACPG,QAAQ,EAAED,UAAU;QACpBqB,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,uBAAuB;QAChCP,wBAAwB,EAAEC;MAC5B;IACF,CAAC,CACF,EACD;MAAE,GAAGpB,KAAK;MAAE2B,MAAM,EAAE;IAAK,CAAC,EAC1B;MACEC,KAAK,EAAE,CAAC,GAAG3B,IAAI,WAAW,EAAE,GAAGA,IAAI,YAAY;IACjD,CACF,CAAC;IAED,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAAC2B,UAAU,GAAG,IAAI,CAACR,UAAU,CAACQ,UAAU;IAC5C,IAAI,CAACC,WAAW,GAAG,IAAI,CAACT,UAAU,CAACS,WAAW;EAChD;EAEAC,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAMC,KAAK,GAAG,KAAK,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAChD,OAAOnC,oBAAoB,CAACqC,iBAAiB,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAC1E;EAEAC,6BAA6BA,CAC3BH,KAAuC,EAC/B;IACR,IAAI,CAACA,KAAK,EAAE;MACV,OAAO,EAAE;IACX;;IAEA;IACA,OAAO,GAAGA,KAAK,CAAC1B,OAAO,KAAK0B,KAAK,CAACrB,QAAQ,EAAE;EAC9C;EAEAyB,yBAAyBA,CAACL,KAA0B,EAAE;IACpD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACI,6BAA6B,CAACH,KAAK,CAAC;EAClD;EAEAK,4BAA4BA,CAC1BL,KAAuC,EACxB;IACf,IAAI,CAACA,KAAK,EAAE;MACV,OAAO,IAAI;IACb;IAEA,OAAO,YAAYA,KAAK,CAAC1B,OAAO,eAAe0B,KAAK,CAACrB,QAAQ,EAAE;EACjE;EAEA2B,wBAAwBA,CAACP,KAA0B,EAAE;IACnD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACM,4BAA4B,CAACL,KAAK,CAAC;EACjD;EAEAO,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,OAAOtD,yBAAyB,CAAC,IAAI,EAAEuD,SAAS,EAAEF,OAAO,EAAEC,MAAM,CAAC;EACpE;EAEAE,aAAaA,CACXF,MAA8B,EACK;IACnC,MAAMG,SAAS,GAAG,IAAI,CAACC,SAAS,CAACJ,MAAM,CAAC;IACxC,OAAOvD,uBAAuB,CAAC0D,SAAS,CAAC;EAC3C;EAEAE,OAAOA,CAACd,KAAkC,EAAE;IAC1C,OAAOpC,oBAAoB,CAACqC,iBAAiB,CAACD,KAAK,CAAC;EACtD;;EAEA;AACF;AACA;EACEe,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOnD,oBAAoB,CAACmD,oBAAoB,CAAC,CAAC;EACpD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAE3B,IAAI,EAAE,UAAU;QAAE4B,QAAQ,EAAE3D,eAAe,CAACc;MAAS,CAAC,EACxD;QACEiB,IAAI,EAAE,eAAe;QACrB4B,QAAQ,EAAE5D,0BAA0B,CAClC,mEACF;MACF,CAAC,EACD;QACEgC,IAAI,EAAE,gBAAgB;QACtB4B,QAAQ,EAAE5D,0BAA0B,CAClC,oEACF;MACF,CAAC,CACF;MACD6D,sBAAsB,EAAE,CACtB;QACE7B,IAAI,EAAE,YAAY;QAClB4B,QAAQ,EAAE5D,0BAA0B,CAClC,sDAAsDG,mBAAmB,QAAQC,mBAAmB,EACtG;MACF,CAAC,EACD;QACE4B,IAAI,EAAE,YAAY;QAClB4B,QAAQ,EAAE5D,0BAA0B,CAClC,sDAAsDG,mBAAmB,QAAQC,mBAAmB,EACtG;MACF,CAAC,EACD;QACE4B,IAAI,EAAE,aAAa;QACnB4B,QAAQ,EAAE5D,0BAA0B,CAClC,uDAAuDK,oBAAoB,QAAQC,oBAAoB,EACzG;MACF,CAAC,EACD;QACE0B,IAAI,EAAE,aAAa;QACnB4B,QAAQ,EAAE5D,0BAA0B,CAClC,uDAAuDK,oBAAoB,QAAQC,oBAAoB,EACzG;MACF,CAAC;IAEL,CAAC;EACH;EAEA,OAAOsC,iBAAiBA,CACtBD,KAAkC,EACH;IAC/B,OACE/C,WAAW,CAAC+C,KAAK,CAAC,IAClB5C,WAAW,CAAC+D,QAAQ,CAACnB,KAAK,CAAC1B,OAAO,CAAC,IACnClB,WAAW,CAAC+D,QAAQ,CAACnB,KAAK,CAACrB,QAAQ,CAAC;EAExC;AACF","ignoreList":[]}
+{"version":3,"file":"EastingNorthingField.js","names":["ComponentType","lowerFirst","ComponentCollection","FormComponent","isFormState","deduplicateErrorsByHref","getLocationFieldViewModel","NumberField","createLowerFirstExpression","t","tPlugin","messageTemplate","convertToLanguageMessages","DEFAULT_EASTING_MIN","DEFAULT_EASTING_MAX","DEFAULT_NORTHING_MIN","DEFAULT_NORTHING_MAX","EastingNorthingField","constructor","def","props","name","options","schema","isRequired","required","eastingMin","easting","min","eastingMax","max","northingMin","northing","northingMax","fieldLabel","label","eastingDigitsMessage","northingDigitsMessage","customValidationMessages","northingValidationMessages","collection","type","title","precision","optionalText","classes","parent","peers","formSchema","stateSchema","getFormValueFromState","state","value","isEastingNorthing","undefined","getDisplayStringFromFormValue","_translator","getDisplayStringFromState","translator","getContextValueFromFormValue","getContextValueFromState","getViewModel","context","viewModel","getViewErrors","errors","allErrors","getErrors","isState","getAllPossibleErrors","baseErrors","template","advancedSettingsErrors","isNumber"],"sources":["../../../../../src/server/plugins/engine/components/EastingNorthingField.ts"],"sourcesContent":["import {\n  ComponentType,\n  type EastingNorthingFieldComponent\n} from '@defra/forms-model'\nimport { type LanguageMessages, 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 {\n  deduplicateErrorsByHref,\n  getLocationFieldViewModel\n} from '~/src/server/plugins/engine/components/LocationFieldHelpers.js'\nimport { NumberField } from '~/src/server/plugins/engine/components/NumberField.js'\nimport { createLowerFirstExpression } from '~/src/server/plugins/engine/components/helpers/index.js'\nimport {\n  type EastingNorthingState,\n  type RenderContext\n} from '~/src/server/plugins/engine/components/types.js'\nimport { t as tPlugin } from '~/src/server/plugins/engine/i18n/index.js'\nimport { type Translator } from '~/src/server/plugins/engine/i18n/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport { convertToLanguageMessages } from '~/src/server/utils/type-utils.js'\n\n// British National Grid coordinate limits\nconst DEFAULT_EASTING_MIN = 0\nconst DEFAULT_EASTING_MAX = 700000\nconst DEFAULT_NORTHING_MIN = 0\nconst DEFAULT_NORTHING_MAX = 1300000\n\nexport class EastingNorthingField extends FormComponent {\n  declare options: EastingNorthingFieldComponent['options']\n  declare formSchema: ObjectSchema<FormPayload>\n  declare stateSchema: ObjectSchema<FormState>\n  declare collection: ComponentCollection\n\n  constructor(\n    def: EastingNorthingFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { name, options, schema } = def\n\n    const isRequired = options.required !== false\n\n    const eastingMin = schema?.easting?.min ?? DEFAULT_EASTING_MIN\n    const eastingMax = schema?.easting?.max ?? DEFAULT_EASTING_MAX\n    const northingMin = schema?.northing?.min ?? DEFAULT_NORTHING_MIN\n    const northingMax = schema?.northing?.max ?? DEFAULT_NORTHING_MAX\n\n    const fieldLabel = lowerFirst(this.label)\n\n    const eastingDigitsMessage = tPlugin(\n      'components.eastingNorthingField.eastingDigits',\n      'en-GB',\n      { fieldLabel }\n    )\n    const northingDigitsMessage = tPlugin(\n      'components.eastingNorthingField.northingDigits',\n      'en-GB',\n      { fieldLabel }\n    )\n\n    const customValidationMessages: LanguageMessages =\n      convertToLanguageMessages({\n        'any.required': tPlugin(\n          'components.eastingNorthingField.eastingRequired',\n          'en-GB'\n        ),\n        'number.base': tPlugin(\n          'components.eastingNorthingField.eastingRequired',\n          'en-GB'\n        ),\n        'number.min': tPlugin(\n          'components.eastingNorthingField.eastingRange',\n          'en-GB',\n          {\n            fieldLabel,\n            min: eastingMin,\n            max: eastingMax\n          }\n        ),\n        'number.max': tPlugin(\n          'components.eastingNorthingField.eastingRange',\n          'en-GB',\n          {\n            fieldLabel,\n            min: eastingMin,\n            max: eastingMax\n          }\n        ),\n        'number.precision': eastingDigitsMessage,\n        'number.integer': eastingDigitsMessage,\n        'number.unsafe': eastingDigitsMessage\n      })\n\n    const northingValidationMessages: LanguageMessages =\n      convertToLanguageMessages({\n        'any.required': tPlugin(\n          'components.eastingNorthingField.northingRequired',\n          'en-GB'\n        ),\n        'number.base': tPlugin(\n          'components.eastingNorthingField.northingRequired',\n          'en-GB'\n        ),\n        'number.min': tPlugin(\n          'components.eastingNorthingField.northingRange',\n          'en-GB',\n          {\n            fieldLabel,\n            min: northingMin,\n            max: northingMax\n          }\n        ),\n        'number.max': tPlugin(\n          'components.eastingNorthingField.northingRange',\n          'en-GB',\n          {\n            fieldLabel,\n            min: northingMin,\n            max: northingMax\n          }\n        ),\n        'number.precision': northingDigitsMessage,\n        'number.integer': northingDigitsMessage,\n        'number.unsafe': northingDigitsMessage\n      })\n\n    this.collection = new ComponentCollection(\n      [\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__easting`,\n          title: 'components.eastingNorthingField.easting',\n          schema: {\n            min: eastingMin,\n            max: eastingMax,\n            precision: 0\n          },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-10',\n            customValidationMessages\n          }\n        },\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__northing`,\n          title: 'components.eastingNorthingField.northing',\n          schema: {\n            min: northingMin,\n            max: northingMax,\n            precision: 0\n          },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-10',\n            customValidationMessages: northingValidationMessages\n          }\n        }\n      ],\n      { ...props, parent: this },\n      {\n        peers: [`${name}__easting`, `${name}__northing`]\n      }\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 EastingNorthingField.isEastingNorthing(value) ? value : undefined\n  }\n\n  getDisplayStringFromFormValue(\n    value: EastingNorthingState | undefined,\n    _translator: Translator\n  ): string {\n    if (!value) {\n      return ''\n    }\n\n    // CYA page format: <<eastingvalue, northingvalue>>\n    return `${value.easting}, ${value.northing}`\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  getContextValueFromFormValue(\n    value: EastingNorthingState | undefined\n  ): string | null {\n    if (!value) {\n      return null\n    }\n\n    return `Easting: ${value.easting}\\nNorthing: ${value.northing}`\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\n    return this.getContextValueFromFormValue(value)\n  }\n\n  getViewModel(context: RenderContext) {\n    const viewModel = super.getViewModel(context)\n    return getLocationFieldViewModel(this, viewModel, context)\n  }\n\n  getViewErrors(\n    translator: Translator,\n    errors?: FormSubmissionError[]\n  ): FormSubmissionError[] | undefined {\n    const allErrors = this.getErrors(translator, errors)\n    return deduplicateErrorsByHref(allErrors)\n  }\n\n  isState(value?: FormStateValue | FormState) {\n    return EastingNorthingField.isEastingNorthing(value)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return EastingNorthingField.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        {\n          type: 'eastingFormat',\n          template: createLowerFirstExpression(\n            'Easting for {{lowerFirst(#title)}} must be between 1 and 6 digits'\n          )\n        },\n        {\n          type: 'northingFormat',\n          template: createLowerFirstExpression(\n            'Northing for {{lowerFirst(#title)}} must be between 1 and 7 digits'\n          )\n        }\n      ],\n      advancedSettingsErrors: [\n        {\n          type: 'eastingMin',\n          template: createLowerFirstExpression(\n            `Easting for {{lowerFirst(#title)}} must be between ${DEFAULT_EASTING_MIN} and ${DEFAULT_EASTING_MAX}`\n          )\n        },\n        {\n          type: 'eastingMax',\n          template: createLowerFirstExpression(\n            `Easting for {{lowerFirst(#title)}} must be between ${DEFAULT_EASTING_MIN} and ${DEFAULT_EASTING_MAX}`\n          )\n        },\n        {\n          type: 'northingMin',\n          template: createLowerFirstExpression(\n            `Northing for {{lowerFirst(#title)}} must be between ${DEFAULT_NORTHING_MIN} and ${DEFAULT_NORTHING_MAX}`\n          )\n        },\n        {\n          type: 'northingMax',\n          template: createLowerFirstExpression(\n            `Northing for {{lowerFirst(#title)}} must be between ${DEFAULT_NORTHING_MIN} and ${DEFAULT_NORTHING_MAX}`\n          )\n        }\n      ]\n    }\n  }\n\n  static isEastingNorthing(\n    value?: FormStateValue | FormState\n  ): value is EastingNorthingState {\n    return (\n      isFormState(value) &&\n      NumberField.isNumber(value.easting) &&\n      NumberField.isNumber(value.northing)\n    )\n  }\n}\n"],"mappings":"AAAA,SACEA,aAAa,QAER,oBAAoB;AAE3B,OAAOC,UAAU,MAAM,sBAAsB;AAE7C,SAASC,mBAAmB;AAC5B,SACEC,aAAa,EACbC,WAAW;AAEb,SACEC,uBAAuB,EACvBC,yBAAyB;AAE3B,SAASC,WAAW;AACpB,SAASC,0BAA0B;AAKnC,SAASC,CAAC,IAAIC,OAAO;AAErB,SAASC,eAAe;AASxB,SAASC,yBAAyB;;AAElC;AACA,MAAMC,mBAAmB,GAAG,CAAC;AAC7B,MAAMC,mBAAmB,GAAG,MAAM;AAClC,MAAMC,oBAAoB,GAAG,CAAC;AAC9B,MAAMC,oBAAoB,GAAG,OAAO;AAEpC,OAAO,MAAMC,oBAAoB,SAASd,aAAa,CAAC;EAMtDe,WAAWA,CACTC,GAAkC,EAClCC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,IAAI;MAAEC,OAAO;MAAEC;IAAO,CAAC,GAAGJ,GAAG;IAErC,MAAMK,UAAU,GAAGF,OAAO,CAACG,QAAQ,KAAK,KAAK;IAE7C,MAAMC,UAAU,GAAGH,MAAM,EAAEI,OAAO,EAAEC,GAAG,IAAIf,mBAAmB;IAC9D,MAAMgB,UAAU,GAAGN,MAAM,EAAEI,OAAO,EAAEG,GAAG,IAAIhB,mBAAmB;IAC9D,MAAMiB,WAAW,GAAGR,MAAM,EAAES,QAAQ,EAAEJ,GAAG,IAAIb,oBAAoB;IACjE,MAAMkB,WAAW,GAAGV,MAAM,EAAES,QAAQ,EAAEF,GAAG,IAAId,oBAAoB;IAEjE,MAAMkB,UAAU,GAAGjC,UAAU,CAAC,IAAI,CAACkC,KAAK,CAAC;IAEzC,MAAMC,oBAAoB,GAAG1B,OAAO,CAClC,+CAA+C,EAC/C,OAAO,EACP;MAAEwB;IAAW,CACf,CAAC;IACD,MAAMG,qBAAqB,GAAG3B,OAAO,CACnC,gDAAgD,EAChD,OAAO,EACP;MAAEwB;IAAW,CACf,CAAC;IAED,MAAMI,wBAA0C,GAC9C1B,yBAAyB,CAAC;MACxB,cAAc,EAAEF,OAAO,CACrB,iDAAiD,EACjD,OACF,CAAC;MACD,aAAa,EAAEA,OAAO,CACpB,iDAAiD,EACjD,OACF,CAAC;MACD,YAAY,EAAEA,OAAO,CACnB,8CAA8C,EAC9C,OAAO,EACP;QACEwB,UAAU;QACVN,GAAG,EAAEF,UAAU;QACfI,GAAG,EAAED;MACP,CACF,CAAC;MACD,YAAY,EAAEnB,OAAO,CACnB,8CAA8C,EAC9C,OAAO,EACP;QACEwB,UAAU;QACVN,GAAG,EAAEF,UAAU;QACfI,GAAG,EAAED;MACP,CACF,CAAC;MACD,kBAAkB,EAAEO,oBAAoB;MACxC,gBAAgB,EAAEA,oBAAoB;MACtC,eAAe,EAAEA;IACnB,CAAC,CAAC;IAEJ,MAAMG,0BAA4C,GAChD3B,yBAAyB,CAAC;MACxB,cAAc,EAAEF,OAAO,CACrB,kDAAkD,EAClD,OACF,CAAC;MACD,aAAa,EAAEA,OAAO,CACpB,kDAAkD,EAClD,OACF,CAAC;MACD,YAAY,EAAEA,OAAO,CACnB,+CAA+C,EAC/C,OAAO,EACP;QACEwB,UAAU;QACVN,GAAG,EAAEG,WAAW;QAChBD,GAAG,EAAEG;MACP,CACF,CAAC;MACD,YAAY,EAAEvB,OAAO,CACnB,+CAA+C,EAC/C,OAAO,EACP;QACEwB,UAAU;QACVN,GAAG,EAAEG,WAAW;QAChBD,GAAG,EAAEG;MACP,CACF,CAAC;MACD,kBAAkB,EAAEI,qBAAqB;MACzC,gBAAgB,EAAEA,qBAAqB;MACvC,eAAe,EAAEA;IACnB,CAAC,CAAC;IAEJ,IAAI,CAACG,UAAU,GAAG,IAAItC,mBAAmB,CACvC,CACE;MACEuC,IAAI,EAAEzC,aAAa,CAACO,WAAW;MAC/Bc,IAAI,EAAE,GAAGA,IAAI,WAAW;MACxBqB,KAAK,EAAE,yCAAyC;MAChDnB,MAAM,EAAE;QACNK,GAAG,EAAEF,UAAU;QACfI,GAAG,EAAED,UAAU;QACfc,SAAS,EAAE;MACb,CAAC;MACDrB,OAAO,EAAE;QACPG,QAAQ,EAAED,UAAU;QACpBoB,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,uBAAuB;QAChCP;MACF;IACF,CAAC,EACD;MACEG,IAAI,EAAEzC,aAAa,CAACO,WAAW;MAC/Bc,IAAI,EAAE,GAAGA,IAAI,YAAY;MACzBqB,KAAK,EAAE,0CAA0C;MACjDnB,MAAM,EAAE;QACNK,GAAG,EAAEG,WAAW;QAChBD,GAAG,EAAEG,WAAW;QAChBU,SAAS,EAAE;MACb,CAAC;MACDrB,OAAO,EAAE;QACPG,QAAQ,EAAED,UAAU;QACpBoB,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,uBAAuB;QAChCP,wBAAwB,EAAEC;MAC5B;IACF,CAAC,CACF,EACD;MAAE,GAAGnB,KAAK;MAAE0B,MAAM,EAAE;IAAK,CAAC,EAC1B;MACEC,KAAK,EAAE,CAAC,GAAG1B,IAAI,WAAW,EAAE,GAAGA,IAAI,YAAY;IACjD,CACF,CAAC;IAED,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAAC0B,UAAU,GAAG,IAAI,CAACR,UAAU,CAACQ,UAAU;IAC5C,IAAI,CAACC,WAAW,GAAG,IAAI,CAACT,UAAU,CAACS,WAAW;EAChD;EAEAC,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAMC,KAAK,GAAG,KAAK,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAChD,OAAOlC,oBAAoB,CAACoC,iBAAiB,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAC1E;EAEAC,6BAA6BA,CAC3BH,KAAuC,EACvCI,WAAuB,EACf;IACR,IAAI,CAACJ,KAAK,EAAE;MACV,OAAO,EAAE;IACX;;IAEA;IACA,OAAO,GAAGA,KAAK,CAACzB,OAAO,KAAKyB,KAAK,CAACpB,QAAQ,EAAE;EAC9C;EAEAyB,yBAAyBA,CACvBN,KAA0B,EAC1BO,UAAsB,EACtB;IACA,MAAMN,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACI,6BAA6B,CAACH,KAAK,EAAEM,UAAU,CAAC;EAC9D;EAEAC,4BAA4BA,CAC1BP,KAAuC,EACxB;IACf,IAAI,CAACA,KAAK,EAAE;MACV,OAAO,IAAI;IACb;IAEA,OAAO,YAAYA,KAAK,CAACzB,OAAO,eAAeyB,KAAK,CAACpB,QAAQ,EAAE;EACjE;EAEA4B,wBAAwBA,CAACT,KAA0B,EAAE;IACnD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACQ,4BAA4B,CAACP,KAAK,CAAC;EACjD;EAEAS,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAMC,SAAS,GAAG,KAAK,CAACF,YAAY,CAACC,OAAO,CAAC;IAC7C,OAAOxD,yBAAyB,CAAC,IAAI,EAAEyD,SAAS,EAAED,OAAO,CAAC;EAC5D;EAEAE,aAAaA,CACXN,UAAsB,EACtBO,MAA8B,EACK;IACnC,MAAMC,SAAS,GAAG,IAAI,CAACC,SAAS,CAACT,UAAU,EAAEO,MAAM,CAAC;IACpD,OAAO5D,uBAAuB,CAAC6D,SAAS,CAAC;EAC3C;EAEAE,OAAOA,CAAChB,KAAkC,EAAE;IAC1C,OAAOnC,oBAAoB,CAACoC,iBAAiB,CAACD,KAAK,CAAC;EACtD;;EAEA;AACF;AACA;EACEiB,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOpD,oBAAoB,CAACoD,oBAAoB,CAAC,CAAC;EACpD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAE7B,IAAI,EAAE,UAAU;QAAE8B,QAAQ,EAAE5D,eAAe,CAACc;MAAS,CAAC,EACxD;QACEgB,IAAI,EAAE,eAAe;QACrB8B,QAAQ,EAAE/D,0BAA0B,CAClC,mEACF;MACF,CAAC,EACD;QACEiC,IAAI,EAAE,gBAAgB;QACtB8B,QAAQ,EAAE/D,0BAA0B,CAClC,oEACF;MACF,CAAC,CACF;MACDgE,sBAAsB,EAAE,CACtB;QACE/B,IAAI,EAAE,YAAY;QAClB8B,QAAQ,EAAE/D,0BAA0B,CAClC,sDAAsDK,mBAAmB,QAAQC,mBAAmB,EACtG;MACF,CAAC,EACD;QACE2B,IAAI,EAAE,YAAY;QAClB8B,QAAQ,EAAE/D,0BAA0B,CAClC,sDAAsDK,mBAAmB,QAAQC,mBAAmB,EACtG;MACF,CAAC,EACD;QACE2B,IAAI,EAAE,aAAa;QACnB8B,QAAQ,EAAE/D,0BAA0B,CAClC,uDAAuDO,oBAAoB,QAAQC,oBAAoB,EACzG;MACF,CAAC,EACD;QACEyB,IAAI,EAAE,aAAa;QACnB8B,QAAQ,EAAE/D,0BAA0B,CAClC,uDAAuDO,oBAAoB,QAAQC,oBAAoB,EACzG;MACF,CAAC;IAEL,CAAC;EACH;EAEA,OAAOqC,iBAAiBA,CACtBD,KAAkC,EACH;IAC/B,OACEhD,WAAW,CAACgD,KAAK,CAAC,IAClB7C,WAAW,CAACkE,QAAQ,CAACrB,KAAK,CAACzB,OAAO,CAAC,IACnCpB,WAAW,CAACkE,QAAQ,CAACrB,KAAK,CAACpB,QAAQ,CAAC;EAExC;AACF","ignoreList":[]}

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

@@ -1,10 +1,11 @@
 import { type EmailAddressFieldComponent } from '@defra/forms-model';
 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 EmailAddressField extends FormComponent {
     options: EmailAddressFieldComponent['options'];
     constructor(def: EmailAddressFieldComponent, props: ConstructorParameters<typeof FormComponent>[1]);
-    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+    getViewModel(context: RenderContext): {
         type: string;
         label: {
             text: string;
@@ -16,11 +17,11 @@ export declare class EmailAddressField 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;
         };
@@ -30,28 +31,24 @@ export declare class EmailAddressField extends FormComponent {
             autocomplete?: string;
             maxlength?: number;
             multiple?: string;
-            accept
-            /**
-             * For error preview page that shows all possible errors on a component
-             */
-            ?: string;
+            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/EmailAddressField.js

@@ -26,8 +26,8 @@ export class EmailAddressField 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/EmailAddressField.js.map

@@ -1 +1 @@
-{"version":3,"file":"EmailAddressField.js","names":["preventUnicodeInEmail","joi","FormComponent","messageTemplate","EmailAddressField","constructor","def","props","options","formSchema","string","trim","email","custom","value","helpers","label","required","allow","customValidationMessage","message","messages","customValidationMessages","default","stateSchema","getViewModel","payload","errors","viewModel","attributes","autocomplete","type","getAllPossibleErrors","baseErrors","template","format","unicode","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/EmailAddressField.ts"],"sourcesContent":["import {\n  preventUnicodeInEmail,\n  type EmailAddressFieldComponent\n} from '@defra/forms-model'\nimport joi, { type CustomHelpers } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.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 EmailAddressField extends FormComponent {\n  declare options: EmailAddressFieldComponent['options']\n\n  constructor(\n    def: EmailAddressFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n\n    let formSchema = joi\n      .string()\n      .trim()\n      .email()\n      .custom((value, helpers: CustomHelpers<string>) =>\n        preventUnicodeInEmail(value, helpers)\n      )\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.email': message\n      })\n    } else if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\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 = 'email'\n\n    return {\n      ...viewModel,\n      type: 'email'\n    }\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return EmailAddressField.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        { type: 'unicode', template: messageTemplate.unicode }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAAA,SACEA,qBAAqB,QAEhB,oBAAoB;AAC3B,OAAOC,GAAG,MAA8B,KAAK;AAE7C,SAASC,aAAa;AACtB,SAASC,eAAe;AAOxB,OAAO,MAAMC,iBAAiB,SAASF,aAAa,CAAC;EAGnDG,WAAWA,CACTC,GAA+B,EAC/BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IAEvB,IAAIG,UAAU,GAAGR,GAAG,CACjBS,MAAM,CAAC,CAAC,CACRC,IAAI,CAAC,CAAC,CACNC,KAAK,CAAC,CAAC,CACPC,MAAM,CAAC,CAACC,KAAK,EAAEC,OAA8B,KAC5Cf,qBAAqB,CAACc,KAAK,EAAEC,OAAO,CACtC,CAAC,CACAC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,QAAQ,CAAC,CAAC;IAEb,IAAIT,OAAO,CAACS,QAAQ,KAAK,KAAK,EAAE;MAC9BR,UAAU,GAAGA,UAAU,CAACS,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAIV,OAAO,CAACW,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGZ,OAAO,CAACW,uBAAuB;MAE/CV,UAAU,GAAGA,UAAU,CAACY,QAAQ,CAAC;QAC/B,cAAc,EAAED,OAAO;QACvB,cAAc,EAAEA,OAAO;QACvB,cAAc,EAAEA;MAClB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIZ,OAAO,CAACc,wBAAwB,EAAE;MAC3Cb,UAAU,GAAGA,UAAU,CAACY,QAAQ,CAACb,OAAO,CAACc,wBAAwB,CAAC;IACpE;IAEA,IAAI,CAACb,UAAU,GAAGA,UAAU,CAACc,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGf,UAAU,CAACc,OAAO,CAAC,IAAI,CAAC,CAACL,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACV,OAAO,GAAGA,OAAO;EACxB;EAEAiB,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,OAAO;IAEjC,OAAO;MACL,GAAGF,SAAS;MACZG,IAAI,EAAE;IACR,CAAC;EACH;;EAEA;AACF;AACA;EACEC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO5B,iBAAiB,CAAC4B,oBAAoB,CAAC,CAAC;EACjD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEF,IAAI,EAAE,UAAU;QAAEG,QAAQ,EAAE/B,eAAe,CAACc;MAAS,CAAC,EACxD;QAAEc,IAAI,EAAE,QAAQ;QAAEG,QAAQ,EAAE/B,eAAe,CAACgC;MAAO,CAAC,EACpD;QAAEJ,IAAI,EAAE,SAAS;QAAEG,QAAQ,EAAE/B,eAAe,CAACiC;MAAQ,CAAC,CACvD;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}
+{"version":3,"file":"EmailAddressField.js","names":["preventUnicodeInEmail","joi","FormComponent","messageTemplate","EmailAddressField","constructor","def","props","options","formSchema","string","trim","email","custom","value","helpers","label","required","allow","customValidationMessage","message","messages","customValidationMessages","default","stateSchema","getViewModel","context","viewModel","attributes","autocomplete","type","getAllPossibleErrors","baseErrors","template","format","unicode","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/EmailAddressField.ts"],"sourcesContent":["import {\n  preventUnicodeInEmail,\n  type EmailAddressFieldComponent\n} from '@defra/forms-model'\nimport joi, { type CustomHelpers } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.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 EmailAddressField extends FormComponent {\n  declare options: EmailAddressFieldComponent['options']\n\n  constructor(\n    def: EmailAddressFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n\n    let formSchema = joi\n      .string()\n      .trim()\n      .email()\n      .custom((value, helpers: CustomHelpers<string>) =>\n        preventUnicodeInEmail(value, helpers)\n      )\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.email': message\n      })\n    } else if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\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 = 'email'\n\n    return {\n      ...viewModel,\n      type: 'email'\n    }\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return EmailAddressField.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        { type: 'unicode', template: messageTemplate.unicode }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAAA,SACEA,qBAAqB,QAEhB,oBAAoB;AAC3B,OAAOC,GAAG,MAA8B,KAAK;AAE7C,SAASC,aAAa;AAEtB,SAASC,eAAe;AAGxB,OAAO,MAAMC,iBAAiB,SAASF,aAAa,CAAC;EAGnDG,WAAWA,CACTC,GAA+B,EAC/BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IAEvB,IAAIG,UAAU,GAAGR,GAAG,CACjBS,MAAM,CAAC,CAAC,CACRC,IAAI,CAAC,CAAC,CACNC,KAAK,CAAC,CAAC,CACPC,MAAM,CAAC,CAACC,KAAK,EAAEC,OAA8B,KAC5Cf,qBAAqB,CAACc,KAAK,EAAEC,OAAO,CACtC,CAAC,CACAC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,QAAQ,CAAC,CAAC;IAEb,IAAIT,OAAO,CAACS,QAAQ,KAAK,KAAK,EAAE;MAC9BR,UAAU,GAAGA,UAAU,CAACS,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAIV,OAAO,CAACW,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGZ,OAAO,CAACW,uBAAuB;MAE/CV,UAAU,GAAGA,UAAU,CAACY,QAAQ,CAAC;QAC/B,cAAc,EAAED,OAAO;QACvB,cAAc,EAAEA,OAAO;QACvB,cAAc,EAAEA;MAClB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIZ,OAAO,CAACc,wBAAwB,EAAE;MAC3Cb,UAAU,GAAGA,UAAU,CAACY,QAAQ,CAACb,OAAO,CAACc,wBAAwB,CAAC;IACpE;IAEA,IAAI,CAACb,UAAU,GAAGA,UAAU,CAACc,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGf,UAAU,CAACc,OAAO,CAAC,IAAI,CAAC,CAACL,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACV,OAAO,GAAGA,OAAO;EACxB;EAEAiB,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,OAAO;IAEjC,OAAO;MACL,GAAGF,SAAS;MACZG,IAAI,EAAE;IACR,CAAC;EACH;;EAEA;AACF;AACA;EACEC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO3B,iBAAiB,CAAC2B,oBAAoB,CAAC,CAAC;EACjD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEF,IAAI,EAAE,UAAU;QAAEG,QAAQ,EAAE9B,eAAe,CAACc;MAAS,CAAC,EACxD;QAAEa,IAAI,EAAE,QAAQ;QAAEG,QAAQ,EAAE9B,eAAe,CAAC+B;MAAO,CAAC,EACpD;QAAEJ,IAAI,EAAE,SAAS;QAAEG,QAAQ,EAAE9B,eAAe,CAACgC;MAAQ,CAAC,CACvD;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -1,8 +1,10 @@
 import { type FileUploadFieldComponent, type FormMetadata } from '@defra/forms-model';
 import joi, { type ArraySchema } from 'joi';
 import { FormComponent } from '../../../../server/plugins/engine/components/FormComponent.js';
-import { type ErrorMessageTemplateList, type FileState, type FileUpload, type FileUploadMetadata, type FormContext, type FormPayload, type FormState, type FormStateValue, type FormSubmissionError, type FormSubmissionState, type SummaryList, type UploadState, type UploadStatusFileResponse, type UploadStatusResponse } from '../../../../server/plugins/engine/types.js';
-import { type FormQuery, type FormRequestPayload } from '../../../../server/routes/types.js';
+import { type RenderContext } from '../../../../server/plugins/engine/components/types.js';
+import { type Translator } from '../../../../server/plugins/engine/i18n/types.js';
+import { type ErrorMessageTemplateList, type FileState, type FileUpload, type FileUploadMetadata, type FormContext, type FormState, type FormStateValue, type FormSubmissionState, type SummaryList, type UploadState, type UploadStatusFileResponse, type UploadStatusResponse } from '../../../../server/plugins/engine/types.js';
+import { type FormRequestPayload } from '../../../../server/routes/types.js';
 export declare const uploadIdSchema: joi.StringSchema<string>;
 export declare const fileSchema: joi.ObjectSchema<FileUpload>;
 export declare const tempFileSchema: joi.ObjectSchema<FileUpload>;
@@ -21,11 +23,11 @@ export declare class FileUploadField extends FormComponent {
     constructor(def: FileUploadFieldComponent, props: ConstructorParameters<typeof FormComponent>[1]);
     getFormValueFromState(state: FormSubmissionState): UploadState | undefined;
     getFormValue(value?: FormStateValue | FormState): UploadState | undefined;
-    getDisplayStringFromFormValue(files: FileState[] | undefined): string;
-    getDisplayStringFromState(state: FormSubmissionState): string;
+    getDisplayStringFromFormValue(files: FileState[] | undefined, translator: Translator): string;
+    getDisplayStringFromState(state: FormSubmissionState, translator: Translator): string;
     getContextValueFromFormValue(files: UploadState | undefined): string[] | null;
     getContextValueFromState(state: FormSubmissionState): string[] | null;
-    getViewModel(payload: FormPayload, errors?: FormSubmissionError[], query?: FormQuery): {
+    getViewModel(context: RenderContext): {
         upload: {
             count: number;
             summaryList: SummaryList;
@@ -42,11 +44,11 @@ export declare class FileUploadField 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;
         };
@@ -59,21 +61,21 @@ export declare class FileUploadField 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[];
     };
     isValue(value?: FormStateValue | FormState): value is UploadState;
     /**