@defra/forms-engine-plugin 5.0.0-alpha.3 → 5.0.0-alpha.31

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

@@ -4,11 +4,9 @@ import { ComponentCollection } from "./ComponentCollection.js";
 import { FormComponent, isFormState } from "./FormComponent.js";
 import { deduplicateErrorsByHref, getLocationFieldViewModel } from "./LocationFieldHelpers.js";
 import { NumberField } from "./NumberField.js";
-import { createLowerFirstExpression } from "./helpers/index.js";
+import { createLowerFirstExpression, getTranslatedLabel } 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";
-
 // Precision constants
 // UK latitude/longitude requires high precision for accurate location (within ~11mm)
 const DECIMAL_PRECISION = 7; // 7 decimal places
@@ -22,45 +20,16 @@ export class LatLongField extends FormComponent {
       schema
     } = def;
     const isRequired = options.required !== false;
-
-    // Read schema values from def.schema with fallback defaults
-    const latitudeMin = schema?.latitude?.min ?? 49.85;
-    const latitudeMax = schema?.latitude?.max ?? 60.859;
-    const longitudeMin = schema?.longitude?.min ?? -13.687;
-    const longitudeMax = schema?.longitude?.max ?? 1.767;
-    const fieldLabel = lowerFirst(this.label);
-    const customValidationMessages = convertToLanguageMessages({
-      'number.precision': tPlugin('components.latLongField.precision', 'en-GB'),
-      'number.unsafe': tPlugin('components.latLongField.notANumber', 'en-GB')
-    });
-    const latitudeRangeMessage = tPlugin('components.latLongField.latitudeRange', 'en-GB', {
-      fieldLabel,
-      min: latitudeMin,
-      max: latitudeMax
-    });
-    const longitudeRangeMessage = tPlugin('components.latLongField.longitudeRange', 'en-GB', {
-      fieldLabel,
-      min: longitudeMin,
-      max: longitudeMax
-    });
-    const latitudeMessages = convertToLanguageMessages({
-      ...customValidationMessages,
-      'any.required': tPlugin('components.latLongField.latitudeRequired', 'en-GB'),
-      'number.base': tPlugin('components.latLongField.latitudeBase', 'en-GB', {
-        fieldLabel
-      }),
-      'number.min': latitudeRangeMessage,
-      'number.max': latitudeRangeMessage
-    });
-    const longitudeMessages = convertToLanguageMessages({
-      ...customValidationMessages,
-      'any.required': tPlugin('components.latLongField.longitudeRequired', 'en-GB'),
-      'number.base': tPlugin('components.latLongField.longitudeBase', 'en-GB', {
-        fieldLabel
-      }),
-      'number.min': longitudeRangeMessage,
-      'number.max': longitudeRangeMessage
-    });
+    const {
+      latitudeMin,
+      latitudeMax,
+      longitudeMin,
+      longitudeMax
+    } = LatLongField.getMinMax(schema);
+    const {
+      latitudeMessages,
+      longitudeMessages
+    } = LatLongField.buildErrorMessages(this.label, latitudeMin, latitudeMax, longitudeMin, longitudeMax, 'en-GB');
     this.collection = new ComponentCollection([{
       type: ComponentType.NumberField,
       name: `${name}__latitude`,
@@ -107,13 +76,16 @@ export class LatLongField extends FormComponent {
     const value = super.getFormValueFromState(state);
     return LatLongField.isLatLong(value) ? value : undefined;
   }
-  getDisplayStringFromFormValue(value, _translator) {
+  getDisplayStringFromFormValue(value, translator) {
     if (!value) {
       return '';
     }
+    const {
+      t
+    } = translator;
 
-    // CYA page format: <<latvalue, langvalue>>
-    return `${value.latitude}, ${value.longitude}`;
+    // Output format: Latitude: <<entry>>\nLongitude: <<entry>>
+    return `${t('components.latLongField.latitude')}: ${value.latitude}\n${t('components.latLongField.longitude')}: ${value.longitude}`;
   }
   getDisplayStringFromState(state, translator) {
     const value = this.getFormValueFromState(state);
@@ -123,9 +95,7 @@ export class LatLongField extends FormComponent {
     if (!value) {
       return null;
     }
-
-    // Output format: Latitude: <<entry>>\nLongitude: <<entry>>
-    return `Latitude: ${value.latitude}\nLongitude: ${value.longitude}`;
+    return `${value.latitude}, ${value.longitude}`;
   }
   getContextValueFromState(state) {
     const value = this.getFormValueFromState(state);
@@ -142,6 +112,24 @@ export class LatLongField extends FormComponent {
   isState(value) {
     return LatLongField.isLatLong(value);
   }
+  getValidationMessagesOverride(translator) {
+    const def = this.def;
+    const translatedLabel = getTranslatedLabel(def, translator);
+    const {
+      latitudeMin,
+      latitudeMax,
+      longitudeMin,
+      longitudeMax
+    } = LatLongField.getMinMax(def.schema);
+    const {
+      latitudeMessages,
+      longitudeMessages
+    } = LatLongField.buildErrorMessages(translatedLabel, latitudeMin, latitudeMax, longitudeMin, longitudeMax, translator.language);
+    return {
+      [`${this.name}__latitude`]: latitudeMessages,
+      [`${this.name}__longitude`]: longitudeMessages
+    };
+  }
 
   /**
    * For error preview page that shows all possible errors on a component
@@ -183,5 +171,54 @@ export class LatLongField extends FormComponent {
   static isLatLong(value) {
     return isFormState(value) && NumberField.isNumber(value.latitude) && NumberField.isNumber(value.longitude);
   }
+  static buildErrorMessages(label, latitudeMin, latitudeMax, longitudeMin, longitudeMax, language) {
+    const fieldLabel = lowerFirst(label);
+    const customValidationMessages = {
+      'number.precision': tPlugin('components.latLongField.precision', language),
+      'number.unsafe': tPlugin('components.latLongField.notANumber', language)
+    };
+    const latitudeRangeMessage = tPlugin('components.latLongField.latitudeRange', language, {
+      fieldLabel,
+      min: latitudeMin,
+      max: latitudeMax
+    });
+    const longitudeRangeMessage = tPlugin('components.latLongField.longitudeRange', language, {
+      fieldLabel,
+      min: longitudeMin,
+      max: longitudeMax
+    });
+    const latitudeMessages = {
+      ...customValidationMessages,
+      'any.required': tPlugin('components.latLongField.latitudeRequired', language),
+      'number.base': tPlugin('components.latLongField.latitudeBase', language, {
+        fieldLabel
+      }),
+      'number.min': latitudeRangeMessage,
+      'number.max': latitudeRangeMessage
+    };
+    const longitudeMessages = {
+      ...customValidationMessages,
+      'any.required': tPlugin('components.latLongField.longitudeRequired', language),
+      'number.base': tPlugin('components.latLongField.longitudeBase', language, {
+        fieldLabel
+      }),
+      'number.min': longitudeRangeMessage,
+      'number.max': longitudeRangeMessage
+    };
+    return {
+      latitudeMessages,
+      longitudeMessages
+    };
+  }
+
+  // Read schema values from def.schema with fallback defaults
+  static getMinMax(schema) {
+    return {
+      latitudeMin: schema?.latitude?.min ?? 49.85,
+      latitudeMax: schema?.latitude?.max ?? 60.859,
+      longitudeMin: schema?.longitude?.min ?? -13.687,
+      longitudeMax: schema?.longitude?.max ?? 1.767
+    };
+  }
 }
 //# sourceMappingURL=LatLongField.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"LatLongField.js","names":["ComponentType","lowerFirst","ComponentCollection","FormComponent","isFormState","deduplicateErrorsByHref","getLocationFieldViewModel","NumberField","createLowerFirstExpression","t","tPlugin","messageTemplate","convertToLanguageMessages","DECIMAL_PRECISION","LatLongField","constructor","def","props","name","options","schema","isRequired","required","latitudeMin","latitude","min","latitudeMax","max","longitudeMin","longitude","longitudeMax","fieldLabel","label","customValidationMessages","latitudeRangeMessage","longitudeRangeMessage","latitudeMessages","longitudeMessages","collection","type","title","precision","optionalText","classes","suffix","parent","peers","formSchema","stateSchema","getFormValueFromState","state","value","isLatLong","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/LatLongField.ts"],"sourcesContent":["import { ComponentType, type LatLongFieldComponent } 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 LatLongState,\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// Precision constants\n// UK latitude/longitude requires high precision for accurate location (within ~11mm)\nconst DECIMAL_PRECISION = 7 // 7 decimal places\n\nexport class LatLongField extends FormComponent {\n  declare options: LatLongFieldComponent['options']\n  declare formSchema: ObjectSchema<FormPayload>\n  declare stateSchema: ObjectSchema<FormState>\n  declare collection: ComponentCollection\n\n  constructor(\n    def: LatLongFieldComponent,\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    // Read schema values from def.schema with fallback defaults\n    const latitudeMin = schema?.latitude?.min ?? 49.85\n    const latitudeMax = schema?.latitude?.max ?? 60.859\n    const longitudeMin = schema?.longitude?.min ?? -13.687\n    const longitudeMax = schema?.longitude?.max ?? 1.767\n\n    const fieldLabel = lowerFirst(this.label)\n\n    const customValidationMessages: LanguageMessages =\n      convertToLanguageMessages({\n        'number.precision': tPlugin(\n          'components.latLongField.precision',\n          'en-GB'\n        ),\n        'number.unsafe': tPlugin('components.latLongField.notANumber', 'en-GB')\n      })\n\n    const latitudeRangeMessage = tPlugin(\n      'components.latLongField.latitudeRange',\n      'en-GB',\n      { fieldLabel, min: latitudeMin, max: latitudeMax }\n    )\n    const longitudeRangeMessage = tPlugin(\n      'components.latLongField.longitudeRange',\n      'en-GB',\n      { fieldLabel, min: longitudeMin, max: longitudeMax }\n    )\n\n    const latitudeMessages: LanguageMessages = convertToLanguageMessages({\n      ...customValidationMessages,\n      'any.required': tPlugin(\n        'components.latLongField.latitudeRequired',\n        'en-GB'\n      ),\n      'number.base': tPlugin('components.latLongField.latitudeBase', 'en-GB', {\n        fieldLabel\n      }),\n      'number.min': latitudeRangeMessage,\n      'number.max': latitudeRangeMessage\n    })\n\n    const longitudeMessages: LanguageMessages = convertToLanguageMessages({\n      ...customValidationMessages,\n      'any.required': tPlugin(\n        'components.latLongField.longitudeRequired',\n        'en-GB'\n      ),\n      'number.base': tPlugin('components.latLongField.longitudeBase', 'en-GB', {\n        fieldLabel\n      }),\n      'number.min': longitudeRangeMessage,\n      'number.max': longitudeRangeMessage\n    })\n\n    this.collection = new ComponentCollection(\n      [\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__latitude`,\n          title: 'components.latLongField.latitude',\n          schema: {\n            min: latitudeMin,\n            max: latitudeMax,\n            precision: DECIMAL_PRECISION\n          },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-10',\n            suffix: '°',\n            customValidationMessages: latitudeMessages\n          }\n        },\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__longitude`,\n          title: 'components.latLongField.longitude',\n          schema: {\n            min: longitudeMin,\n            max: longitudeMax,\n            precision: DECIMAL_PRECISION\n          },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-10',\n            suffix: '°',\n            customValidationMessages: longitudeMessages\n          }\n        }\n      ],\n      { ...props, parent: this },\n      {\n        peers: [`${name}__latitude`, `${name}__longitude`]\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 LatLongField.isLatLong(value) ? value : undefined\n  }\n\n  getDisplayStringFromFormValue(\n    value: LatLongState | undefined,\n    _translator: Translator\n  ): string {\n    if (!value) {\n      return ''\n    }\n\n    // CYA page format: <<latvalue, langvalue>>\n    return `${value.latitude}, ${value.longitude}`\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(value: LatLongState | undefined): string | null {\n    if (!value) {\n      return null\n    }\n\n    // Output format: Latitude: <<entry>>\\nLongitude: <<entry>>\n    return `Latitude: ${value.latitude}\\nLongitude: ${value.longitude}`\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 LatLongField.isLatLong(value)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return LatLongField.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: 'latitudeFormat',\n          template: createLowerFirstExpression(\n            'Enter a valid latitude for {{lowerFirst(#title)}} like 51.519450'\n          )\n        },\n        {\n          type: 'longitudeFormat',\n          template: createLowerFirstExpression(\n            'Enter a valid longitude for {{lowerFirst(#title)}} like -0.127758'\n          )\n        }\n      ],\n      advancedSettingsErrors: [\n        {\n          type: 'latitudeMin',\n          template: createLowerFirstExpression(\n            'Latitude for {{lowerFirst(#title)}} must be between 49 and 60'\n          )\n        },\n        {\n          type: 'latitudeMax',\n          template: createLowerFirstExpression(\n            'Latitude for {{lowerFirst(#title)}} must be between 49 and 60'\n          )\n        },\n        {\n          type: 'longitudeMin',\n          template: createLowerFirstExpression(\n            'Longitude for {{lowerFirst(#title)}} must be between -9 and 2'\n          )\n        },\n        {\n          type: 'longitudeMax',\n          template: createLowerFirstExpression(\n            'Longitude for {{lowerFirst(#title)}} must be between -9 and 2'\n          )\n        }\n      ]\n    }\n  }\n\n  static isLatLong(value?: FormStateValue | FormState): value is LatLongState {\n    return (\n      isFormState(value) &&\n      NumberField.isNumber(value.latitude) &&\n      NumberField.isNumber(value.longitude)\n    )\n  }\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAAoC,oBAAoB;AAE9E,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;AACA,MAAMC,iBAAiB,GAAG,CAAC,EAAC;;AAE5B,OAAO,MAAMC,YAAY,SAASX,aAAa,CAAC;EAM9CY,WAAWA,CACTC,GAA0B,EAC1BC,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;IACA,MAAMC,WAAW,GAAGH,MAAM,EAAEI,QAAQ,EAAEC,GAAG,IAAI,KAAK;IAClD,MAAMC,WAAW,GAAGN,MAAM,EAAEI,QAAQ,EAAEG,GAAG,IAAI,MAAM;IACnD,MAAMC,YAAY,GAAGR,MAAM,EAAES,SAAS,EAAEJ,GAAG,IAAI,CAAC,MAAM;IACtD,MAAMK,YAAY,GAAGV,MAAM,EAAES,SAAS,EAAEF,GAAG,IAAI,KAAK;IAEpD,MAAMI,UAAU,GAAG9B,UAAU,CAAC,IAAI,CAAC+B,KAAK,CAAC;IAEzC,MAAMC,wBAA0C,GAC9CrB,yBAAyB,CAAC;MACxB,kBAAkB,EAAEF,OAAO,CACzB,mCAAmC,EACnC,OACF,CAAC;MACD,eAAe,EAAEA,OAAO,CAAC,oCAAoC,EAAE,OAAO;IACxE,CAAC,CAAC;IAEJ,MAAMwB,oBAAoB,GAAGxB,OAAO,CAClC,uCAAuC,EACvC,OAAO,EACP;MAAEqB,UAAU;MAAEN,GAAG,EAAEF,WAAW;MAAEI,GAAG,EAAED;IAAY,CACnD,CAAC;IACD,MAAMS,qBAAqB,GAAGzB,OAAO,CACnC,wCAAwC,EACxC,OAAO,EACP;MAAEqB,UAAU;MAAEN,GAAG,EAAEG,YAAY;MAAED,GAAG,EAAEG;IAAa,CACrD,CAAC;IAED,MAAMM,gBAAkC,GAAGxB,yBAAyB,CAAC;MACnE,GAAGqB,wBAAwB;MAC3B,cAAc,EAAEvB,OAAO,CACrB,0CAA0C,EAC1C,OACF,CAAC;MACD,aAAa,EAAEA,OAAO,CAAC,sCAAsC,EAAE,OAAO,EAAE;QACtEqB;MACF,CAAC,CAAC;MACF,YAAY,EAAEG,oBAAoB;MAClC,YAAY,EAAEA;IAChB,CAAC,CAAC;IAEF,MAAMG,iBAAmC,GAAGzB,yBAAyB,CAAC;MACpE,GAAGqB,wBAAwB;MAC3B,cAAc,EAAEvB,OAAO,CACrB,2CAA2C,EAC3C,OACF,CAAC;MACD,aAAa,EAAEA,OAAO,CAAC,uCAAuC,EAAE,OAAO,EAAE;QACvEqB;MACF,CAAC,CAAC;MACF,YAAY,EAAEI,qBAAqB;MACnC,YAAY,EAAEA;IAChB,CAAC,CAAC;IAEF,IAAI,CAACG,UAAU,GAAG,IAAIpC,mBAAmB,CACvC,CACE;MACEqC,IAAI,EAAEvC,aAAa,CAACO,WAAW;MAC/BW,IAAI,EAAE,GAAGA,IAAI,YAAY;MACzBsB,KAAK,EAAE,kCAAkC;MACzCpB,MAAM,EAAE;QACNK,GAAG,EAAEF,WAAW;QAChBI,GAAG,EAAED,WAAW;QAChBe,SAAS,EAAE5B;MACb,CAAC;MACDM,OAAO,EAAE;QACPG,QAAQ,EAAED,UAAU;QACpBqB,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,uBAAuB;QAChCC,MAAM,EAAE,GAAG;QACXX,wBAAwB,EAAEG;MAC5B;IACF,CAAC,EACD;MACEG,IAAI,EAAEvC,aAAa,CAACO,WAAW;MAC/BW,IAAI,EAAE,GAAGA,IAAI,aAAa;MAC1BsB,KAAK,EAAE,mCAAmC;MAC1CpB,MAAM,EAAE;QACNK,GAAG,EAAEG,YAAY;QACjBD,GAAG,EAAEG,YAAY;QACjBW,SAAS,EAAE5B;MACb,CAAC;MACDM,OAAO,EAAE;QACPG,QAAQ,EAAED,UAAU;QACpBqB,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,uBAAuB;QAChCC,MAAM,EAAE,GAAG;QACXX,wBAAwB,EAAEI;MAC5B;IACF,CAAC,CACF,EACD;MAAE,GAAGpB,KAAK;MAAE4B,MAAM,EAAE;IAAK,CAAC,EAC1B;MACEC,KAAK,EAAE,CAAC,GAAG5B,IAAI,YAAY,EAAE,GAAGA,IAAI,aAAa;IACnD,CACF,CAAC;IAED,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAAC4B,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,OAAOpC,YAAY,CAACsC,SAAS,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAC1D;EAEAC,6BAA6BA,CAC3BH,KAA+B,EAC/BI,WAAuB,EACf;IACR,IAAI,CAACJ,KAAK,EAAE;MACV,OAAO,EAAE;IACX;;IAEA;IACA,OAAO,GAAGA,KAAK,CAAC3B,QAAQ,KAAK2B,KAAK,CAACtB,SAAS,EAAE;EAChD;EAEA2B,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,CAACP,KAA+B,EAAiB;IAC3E,IAAI,CAACA,KAAK,EAAE;MACV,OAAO,IAAI;IACb;;IAEA;IACA,OAAO,aAAaA,KAAK,CAAC3B,QAAQ,gBAAgB2B,KAAK,CAACtB,SAAS,EAAE;EACrE;EAEA8B,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,OAAOvD,yBAAyB,CAAC,IAAI,EAAEwD,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,OAAO3D,uBAAuB,CAAC4D,SAAS,CAAC;EAC3C;EAEAE,OAAOA,CAAChB,KAAkC,EAAE;IAC1C,OAAOrC,YAAY,CAACsC,SAAS,CAACD,KAAK,CAAC;EACtC;;EAEA;AACF;AACA;EACEiB,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOtD,YAAY,CAACsD,oBAAoB,CAAC,CAAC;EAC5C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAE9B,IAAI,EAAE,UAAU;QAAE+B,QAAQ,EAAE3D,eAAe,CAACW;MAAS,CAAC,EACxD;QACEiB,IAAI,EAAE,gBAAgB;QACtB+B,QAAQ,EAAE9D,0BAA0B,CAClC,kEACF;MACF,CAAC,EACD;QACE+B,IAAI,EAAE,iBAAiB;QACvB+B,QAAQ,EAAE9D,0BAA0B,CAClC,mEACF;MACF,CAAC,CACF;MACD+D,sBAAsB,EAAE,CACtB;QACEhC,IAAI,EAAE,aAAa;QACnB+B,QAAQ,EAAE9D,0BAA0B,CAClC,+DACF;MACF,CAAC,EACD;QACE+B,IAAI,EAAE,aAAa;QACnB+B,QAAQ,EAAE9D,0BAA0B,CAClC,+DACF;MACF,CAAC,EACD;QACE+B,IAAI,EAAE,cAAc;QACpB+B,QAAQ,EAAE9D,0BAA0B,CAClC,+DACF;MACF,CAAC,EACD;QACE+B,IAAI,EAAE,cAAc;QACpB+B,QAAQ,EAAE9D,0BAA0B,CAClC,+DACF;MACF,CAAC;IAEL,CAAC;EACH;EAEA,OAAO4C,SAASA,CAACD,KAAkC,EAAyB;IAC1E,OACE/C,WAAW,CAAC+C,KAAK,CAAC,IAClB5C,WAAW,CAACiE,QAAQ,CAACrB,KAAK,CAAC3B,QAAQ,CAAC,IACpCjB,WAAW,CAACiE,QAAQ,CAACrB,KAAK,CAACtB,SAAS,CAAC;EAEzC;AACF","ignoreList":[]}
+{"version":3,"file":"LatLongField.js","names":["ComponentType","lowerFirst","ComponentCollection","FormComponent","isFormState","deduplicateErrorsByHref","getLocationFieldViewModel","NumberField","createLowerFirstExpression","getTranslatedLabel","t","tPlugin","messageTemplate","DECIMAL_PRECISION","LatLongField","constructor","def","props","name","options","schema","isRequired","required","latitudeMin","latitudeMax","longitudeMin","longitudeMax","getMinMax","latitudeMessages","longitudeMessages","buildErrorMessages","label","collection","type","title","min","max","precision","optionalText","classes","suffix","customValidationMessages","parent","peers","formSchema","stateSchema","getFormValueFromState","state","value","isLatLong","undefined","getDisplayStringFromFormValue","translator","latitude","longitude","getDisplayStringFromState","getContextValueFromFormValue","getContextValueFromState","getViewModel","context","viewModel","getViewErrors","errors","allErrors","getErrors","isState","getValidationMessagesOverride","translatedLabel","language","getAllPossibleErrors","baseErrors","template","advancedSettingsErrors","isNumber","fieldLabel","latitudeRangeMessage","longitudeRangeMessage"],"sources":["../../../../../src/server/plugins/engine/components/LatLongField.ts"],"sourcesContent":["import { ComponentType, type LatLongFieldComponent } 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 {\n  createLowerFirstExpression,\n  getTranslatedLabel\n} from '~/src/server/plugins/engine/components/helpers/index.js'\nimport {\n  type LatLongState,\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'\n\n// Precision constants\n// UK latitude/longitude requires high precision for accurate location (within ~11mm)\nconst DECIMAL_PRECISION = 7 // 7 decimal places\n\nexport class LatLongField extends FormComponent {\n  declare options: LatLongFieldComponent['options']\n  declare formSchema: ObjectSchema<FormPayload>\n  declare stateSchema: ObjectSchema<FormState>\n  declare collection: ComponentCollection\n\n  constructor(\n    def: LatLongFieldComponent,\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 { latitudeMin, latitudeMax, longitudeMin, longitudeMax } =\n      LatLongField.getMinMax(schema)\n\n    const { latitudeMessages, longitudeMessages } =\n      LatLongField.buildErrorMessages(\n        this.label,\n        latitudeMin,\n        latitudeMax,\n        longitudeMin,\n        longitudeMax,\n        'en-GB'\n      )\n\n    this.collection = new ComponentCollection(\n      [\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__latitude`,\n          title: 'components.latLongField.latitude',\n          schema: {\n            min: latitudeMin,\n            max: latitudeMax,\n            precision: DECIMAL_PRECISION\n          },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-10',\n            suffix: '°',\n            customValidationMessages: latitudeMessages\n          }\n        },\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__longitude`,\n          title: 'components.latLongField.longitude',\n          schema: {\n            min: longitudeMin,\n            max: longitudeMax,\n            precision: DECIMAL_PRECISION\n          },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-10',\n            suffix: '°',\n            customValidationMessages: longitudeMessages\n          }\n        }\n      ],\n      { ...props, parent: this },\n      {\n        peers: [`${name}__latitude`, `${name}__longitude`]\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 LatLongField.isLatLong(value) ? value : undefined\n  }\n\n  getDisplayStringFromFormValue(\n    value: LatLongState | undefined,\n    translator: Translator\n  ): string {\n    if (!value) {\n      return ''\n    }\n\n    const { t } = translator\n\n    // Output format: Latitude: <<entry>>\\nLongitude: <<entry>>\n    return `${t('components.latLongField.latitude')}: ${value.latitude}\\n${t('components.latLongField.longitude')}: ${value.longitude}`\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(value: LatLongState | undefined): string | null {\n    if (!value) {\n      return null\n    }\n\n    return `${value.latitude}, ${value.longitude}`\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 LatLongField.isLatLong(value)\n  }\n\n  getValidationMessagesOverride(translator: Translator) {\n    const def = this.def as LatLongFieldComponent\n    const translatedLabel = getTranslatedLabel(def, translator)\n    const { latitudeMin, latitudeMax, longitudeMin, longitudeMax } =\n      LatLongField.getMinMax(def.schema)\n    const { latitudeMessages, longitudeMessages } =\n      LatLongField.buildErrorMessages(\n        translatedLabel,\n        latitudeMin,\n        latitudeMax,\n        longitudeMin,\n        longitudeMax,\n        translator.language\n      )\n    return {\n      [`${this.name}__latitude`]: latitudeMessages,\n      [`${this.name}__longitude`]: longitudeMessages\n    }\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return LatLongField.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: 'latitudeFormat',\n          template: createLowerFirstExpression(\n            'Enter a valid latitude for {{lowerFirst(#title)}} like 51.519450'\n          )\n        },\n        {\n          type: 'longitudeFormat',\n          template: createLowerFirstExpression(\n            'Enter a valid longitude for {{lowerFirst(#title)}} like -0.127758'\n          )\n        }\n      ],\n      advancedSettingsErrors: [\n        {\n          type: 'latitudeMin',\n          template: createLowerFirstExpression(\n            'Latitude for {{lowerFirst(#title)}} must be between 49 and 60'\n          )\n        },\n        {\n          type: 'latitudeMax',\n          template: createLowerFirstExpression(\n            'Latitude for {{lowerFirst(#title)}} must be between 49 and 60'\n          )\n        },\n        {\n          type: 'longitudeMin',\n          template: createLowerFirstExpression(\n            'Longitude for {{lowerFirst(#title)}} must be between -9 and 2'\n          )\n        },\n        {\n          type: 'longitudeMax',\n          template: createLowerFirstExpression(\n            'Longitude for {{lowerFirst(#title)}} must be between -9 and 2'\n          )\n        }\n      ]\n    }\n  }\n\n  static isLatLong(value?: FormStateValue | FormState): value is LatLongState {\n    return (\n      isFormState(value) &&\n      NumberField.isNumber(value.latitude) &&\n      NumberField.isNumber(value.longitude)\n    )\n  }\n\n  static buildErrorMessages(\n    label: string,\n    latitudeMin: number,\n    latitudeMax: number,\n    longitudeMin: number,\n    longitudeMax: number,\n    language: string\n  ) {\n    const fieldLabel = lowerFirst(label)\n\n    const customValidationMessages: LanguageMessages = {\n      'number.precision': tPlugin(\n        'components.latLongField.precision',\n        language\n      ),\n      'number.unsafe': tPlugin('components.latLongField.notANumber', language)\n    }\n\n    const latitudeRangeMessage = tPlugin(\n      'components.latLongField.latitudeRange',\n      language,\n      { fieldLabel, min: latitudeMin, max: latitudeMax }\n    )\n    const longitudeRangeMessage = tPlugin(\n      'components.latLongField.longitudeRange',\n      language,\n      { fieldLabel, min: longitudeMin, max: longitudeMax }\n    )\n\n    const latitudeMessages: LanguageMessages = {\n      ...customValidationMessages,\n      'any.required': tPlugin(\n        'components.latLongField.latitudeRequired',\n        language\n      ),\n      'number.base': tPlugin('components.latLongField.latitudeBase', language, {\n        fieldLabel\n      }),\n      'number.min': latitudeRangeMessage,\n      'number.max': latitudeRangeMessage\n    }\n\n    const longitudeMessages: LanguageMessages = {\n      ...customValidationMessages,\n      'any.required': tPlugin(\n        'components.latLongField.longitudeRequired',\n        language\n      ),\n      'number.base': tPlugin(\n        'components.latLongField.longitudeBase',\n        language,\n        {\n          fieldLabel\n        }\n      ),\n      'number.min': longitudeRangeMessage,\n      'number.max': longitudeRangeMessage\n    }\n\n    return {\n      latitudeMessages,\n      longitudeMessages\n    }\n  }\n\n  // Read schema values from def.schema with fallback defaults\n  static getMinMax(\n    schema:\n      | {\n          latitude?: {\n            min?: number\n            max?: number\n          }\n          longitude?: {\n            min?: number\n            max?: number\n          }\n        }\n      | undefined\n  ) {\n    return {\n      latitudeMin: schema?.latitude?.min ?? 49.85,\n      latitudeMax: schema?.latitude?.max ?? 60.859,\n      longitudeMin: schema?.longitude?.min ?? -13.687,\n      longitudeMax: schema?.longitude?.max ?? 1.767\n    }\n  }\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAAoC,oBAAoB;AAE9E,OAAOC,UAAU,MAAM,sBAAsB;AAE7C,SAASC,mBAAmB;AAC5B,SACEC,aAAa,EACbC,WAAW;AAEb,SACEC,uBAAuB,EACvBC,yBAAyB;AAE3B,SAASC,WAAW;AACpB,SACEC,0BAA0B,EAC1BC,kBAAkB;AAMpB,SAASC,CAAC,IAAIC,OAAO;AAErB,SAASC,eAAe;AAUxB;AACA;AACA,MAAMC,iBAAiB,GAAG,CAAC,EAAC;;AAE5B,OAAO,MAAMC,YAAY,SAASX,aAAa,CAAC;EAM9CY,WAAWA,CACTC,GAA0B,EAC1BC,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,MAAM;MAAEC,WAAW;MAAEC,WAAW;MAAEC,YAAY;MAAEC;IAAa,CAAC,GAC5DZ,YAAY,CAACa,SAAS,CAACP,MAAM,CAAC;IAEhC,MAAM;MAAEQ,gBAAgB;MAAEC;IAAkB,CAAC,GAC3Cf,YAAY,CAACgB,kBAAkB,CAC7B,IAAI,CAACC,KAAK,EACVR,WAAW,EACXC,WAAW,EACXC,YAAY,EACZC,YAAY,EACZ,OACF,CAAC;IAEH,IAAI,CAACM,UAAU,GAAG,IAAI9B,mBAAmB,CACvC,CACE;MACE+B,IAAI,EAAEjC,aAAa,CAACO,WAAW;MAC/BW,IAAI,EAAE,GAAGA,IAAI,YAAY;MACzBgB,KAAK,EAAE,kCAAkC;MACzCd,MAAM,EAAE;QACNe,GAAG,EAAEZ,WAAW;QAChBa,GAAG,EAAEZ,WAAW;QAChBa,SAAS,EAAExB;MACb,CAAC;MACDM,OAAO,EAAE;QACPG,QAAQ,EAAED,UAAU;QACpBiB,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,uBAAuB;QAChCC,MAAM,EAAE,GAAG;QACXC,wBAAwB,EAAEb;MAC5B;IACF,CAAC,EACD;MACEK,IAAI,EAAEjC,aAAa,CAACO,WAAW;MAC/BW,IAAI,EAAE,GAAGA,IAAI,aAAa;MAC1BgB,KAAK,EAAE,mCAAmC;MAC1Cd,MAAM,EAAE;QACNe,GAAG,EAAEV,YAAY;QACjBW,GAAG,EAAEV,YAAY;QACjBW,SAAS,EAAExB;MACb,CAAC;MACDM,OAAO,EAAE;QACPG,QAAQ,EAAED,UAAU;QACpBiB,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,uBAAuB;QAChCC,MAAM,EAAE,GAAG;QACXC,wBAAwB,EAAEZ;MAC5B;IACF,CAAC,CACF,EACD;MAAE,GAAGZ,KAAK;MAAEyB,MAAM,EAAE;IAAK,CAAC,EAC1B;MACEC,KAAK,EAAE,CAAC,GAAGzB,IAAI,YAAY,EAAE,GAAGA,IAAI,aAAa;IACnD,CACF,CAAC;IAED,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACyB,UAAU,GAAG,IAAI,CAACZ,UAAU,CAACY,UAAU;IAC5C,IAAI,CAACC,WAAW,GAAG,IAAI,CAACb,UAAU,CAACa,WAAW;EAChD;EAEAC,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAMC,KAAK,GAAG,KAAK,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAChD,OAAOjC,YAAY,CAACmC,SAAS,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAC1D;EAEAC,6BAA6BA,CAC3BH,KAA+B,EAC/BI,UAAsB,EACd;IACR,IAAI,CAACJ,KAAK,EAAE;MACV,OAAO,EAAE;IACX;IAEA,MAAM;MAAEtC;IAAE,CAAC,GAAG0C,UAAU;;IAExB;IACA,OAAO,GAAG1C,CAAC,CAAC,kCAAkC,CAAC,KAAKsC,KAAK,CAACK,QAAQ,KAAK3C,CAAC,CAAC,mCAAmC,CAAC,KAAKsC,KAAK,CAACM,SAAS,EAAE;EACrI;EAEAC,yBAAyBA,CACvBR,KAA0B,EAC1BK,UAAsB,EACtB;IACA,MAAMJ,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACI,6BAA6B,CAACH,KAAK,EAAEI,UAAU,CAAC;EAC9D;EAEAI,4BAA4BA,CAACR,KAA+B,EAAiB;IAC3E,IAAI,CAACA,KAAK,EAAE;MACV,OAAO,IAAI;IACb;IAEA,OAAO,GAAGA,KAAK,CAACK,QAAQ,KAAKL,KAAK,CAACM,SAAS,EAAE;EAChD;EAEAG,wBAAwBA,CAACV,KAA0B,EAAE;IACnD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACS,4BAA4B,CAACR,KAAK,CAAC;EACjD;EAEAU,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAMC,SAAS,GAAG,KAAK,CAACF,YAAY,CAACC,OAAO,CAAC;IAC7C,OAAOrD,yBAAyB,CAAC,IAAI,EAAEsD,SAAS,EAAED,OAAO,CAAC;EAC5D;EAEAE,aAAaA,CACXT,UAAsB,EACtBU,MAA8B,EACK;IACnC,MAAMC,SAAS,GAAG,IAAI,CAACC,SAAS,CAACZ,UAAU,EAAEU,MAAM,CAAC;IACpD,OAAOzD,uBAAuB,CAAC0D,SAAS,CAAC;EAC3C;EAEAE,OAAOA,CAACjB,KAAkC,EAAE;IAC1C,OAAOlC,YAAY,CAACmC,SAAS,CAACD,KAAK,CAAC;EACtC;EAEAkB,6BAA6BA,CAACd,UAAsB,EAAE;IACpD,MAAMpC,GAAG,GAAG,IAAI,CAACA,GAA4B;IAC7C,MAAMmD,eAAe,GAAG1D,kBAAkB,CAACO,GAAG,EAAEoC,UAAU,CAAC;IAC3D,MAAM;MAAE7B,WAAW;MAAEC,WAAW;MAAEC,YAAY;MAAEC;IAAa,CAAC,GAC5DZ,YAAY,CAACa,SAAS,CAACX,GAAG,CAACI,MAAM,CAAC;IACpC,MAAM;MAAEQ,gBAAgB;MAAEC;IAAkB,CAAC,GAC3Cf,YAAY,CAACgB,kBAAkB,CAC7BqC,eAAe,EACf5C,WAAW,EACXC,WAAW,EACXC,YAAY,EACZC,YAAY,EACZ0B,UAAU,CAACgB,QACb,CAAC;IACH,OAAO;MACL,CAAC,GAAG,IAAI,CAAClD,IAAI,YAAY,GAAGU,gBAAgB;MAC5C,CAAC,GAAG,IAAI,CAACV,IAAI,aAAa,GAAGW;IAC/B,CAAC;EACH;;EAEA;AACF;AACA;EACEwC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOvD,YAAY,CAACuD,oBAAoB,CAAC,CAAC;EAC5C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAErC,IAAI,EAAE,UAAU;QAAEsC,QAAQ,EAAE3D,eAAe,CAACU;MAAS,CAAC,EACxD;QACEW,IAAI,EAAE,gBAAgB;QACtBsC,QAAQ,EAAE/D,0BAA0B,CAClC,kEACF;MACF,CAAC,EACD;QACEyB,IAAI,EAAE,iBAAiB;QACvBsC,QAAQ,EAAE/D,0BAA0B,CAClC,mEACF;MACF,CAAC,CACF;MACDgE,sBAAsB,EAAE,CACtB;QACEvC,IAAI,EAAE,aAAa;QACnBsC,QAAQ,EAAE/D,0BAA0B,CAClC,+DACF;MACF,CAAC,EACD;QACEyB,IAAI,EAAE,aAAa;QACnBsC,QAAQ,EAAE/D,0BAA0B,CAClC,+DACF;MACF,CAAC,EACD;QACEyB,IAAI,EAAE,cAAc;QACpBsC,QAAQ,EAAE/D,0BAA0B,CAClC,+DACF;MACF,CAAC,EACD;QACEyB,IAAI,EAAE,cAAc;QACpBsC,QAAQ,EAAE/D,0BAA0B,CAClC,+DACF;MACF,CAAC;IAEL,CAAC;EACH;EAEA,OAAOyC,SAASA,CAACD,KAAkC,EAAyB;IAC1E,OACE5C,WAAW,CAAC4C,KAAK,CAAC,IAClBzC,WAAW,CAACkE,QAAQ,CAACzB,KAAK,CAACK,QAAQ,CAAC,IACpC9C,WAAW,CAACkE,QAAQ,CAACzB,KAAK,CAACM,SAAS,CAAC;EAEzC;EAEA,OAAOxB,kBAAkBA,CACvBC,KAAa,EACbR,WAAmB,EACnBC,WAAmB,EACnBC,YAAoB,EACpBC,YAAoB,EACpB0C,QAAgB,EAChB;IACA,MAAMM,UAAU,GAAGzE,UAAU,CAAC8B,KAAK,CAAC;IAEpC,MAAMU,wBAA0C,GAAG;MACjD,kBAAkB,EAAE9B,OAAO,CACzB,mCAAmC,EACnCyD,QACF,CAAC;MACD,eAAe,EAAEzD,OAAO,CAAC,oCAAoC,EAAEyD,QAAQ;IACzE,CAAC;IAED,MAAMO,oBAAoB,GAAGhE,OAAO,CAClC,uCAAuC,EACvCyD,QAAQ,EACR;MAAEM,UAAU;MAAEvC,GAAG,EAAEZ,WAAW;MAAEa,GAAG,EAAEZ;IAAY,CACnD,CAAC;IACD,MAAMoD,qBAAqB,GAAGjE,OAAO,CACnC,wCAAwC,EACxCyD,QAAQ,EACR;MAAEM,UAAU;MAAEvC,GAAG,EAAEV,YAAY;MAAEW,GAAG,EAAEV;IAAa,CACrD,CAAC;IAED,MAAME,gBAAkC,GAAG;MACzC,GAAGa,wBAAwB;MAC3B,cAAc,EAAE9B,OAAO,CACrB,0CAA0C,EAC1CyD,QACF,CAAC;MACD,aAAa,EAAEzD,OAAO,CAAC,sCAAsC,EAAEyD,QAAQ,EAAE;QACvEM;MACF,CAAC,CAAC;MACF,YAAY,EAAEC,oBAAoB;MAClC,YAAY,EAAEA;IAChB,CAAC;IAED,MAAM9C,iBAAmC,GAAG;MAC1C,GAAGY,wBAAwB;MAC3B,cAAc,EAAE9B,OAAO,CACrB,2CAA2C,EAC3CyD,QACF,CAAC;MACD,aAAa,EAAEzD,OAAO,CACpB,uCAAuC,EACvCyD,QAAQ,EACR;QACEM;MACF,CACF,CAAC;MACD,YAAY,EAAEE,qBAAqB;MACnC,YAAY,EAAEA;IAChB,CAAC;IAED,OAAO;MACLhD,gBAAgB;MAChBC;IACF,CAAC;EACH;;EAEA;EACA,OAAOF,SAASA,CACdP,MAWa,EACb;IACA,OAAO;MACLG,WAAW,EAAEH,MAAM,EAAEiC,QAAQ,EAAElB,GAAG,IAAI,KAAK;MAC3CX,WAAW,EAAEJ,MAAM,EAAEiC,QAAQ,EAAEjB,GAAG,IAAI,MAAM;MAC5CX,YAAY,EAAEL,MAAM,EAAEkC,SAAS,EAAEnB,GAAG,IAAI,CAAC,MAAM;MAC/CT,YAAY,EAAEN,MAAM,EAAEkC,SAAS,EAAElB,GAAG,IAAI;IAC1C,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -52,6 +52,7 @@ export declare class List extends ComponentBase {
         upload?: {
             count: number;
             summaryList: import("../types.js").SummaryList;
+            uploadingLabel?: string;
         };
     };
 }

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

@@ -8,8 +8,8 @@ export declare class ListFormComponent extends FormComponent {
     options: Extract<SelectionComponentsDef, {
         options: object;
     }>['options'];
-    formSchema: ArraySchema<string> | ArraySchema<number> | BooleanSchema<string> | NumberSchema<string> | NumberSchema | StringSchema;
-    stateSchema: ArraySchema<string> | ArraySchema<number> | BooleanSchema<string> | NumberSchema<string> | NumberSchema | StringSchema;
+    formSchema: ArraySchema<string[]> | ArraySchema<number[]> | BooleanSchema<string> | NumberSchema<string> | NumberSchema | StringSchema;
+    stateSchema: ArraySchema<string[]> | ArraySchema<number[]> | BooleanSchema<string> | NumberSchema<string> | NumberSchema | StringSchema;
     list?: List;
     listType: List['type'];
     get items(): Item[];
@@ -65,6 +65,7 @@ export declare class ListFormComponent extends FormComponent {
         upload?: {
             count: number;
             summaryList: import("../../../../server/plugins/engine/types.js").SummaryList;
+            uploadingLabel?: string;
         };
     };
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"ListFormComponent.js","names":["joi","FormComponent","messageTemplate","ListFormComponent","list","listType","items","values","map","value","constructor","def","props","options","model","getList","type","formSchema","valid","label","required","customValidationMessages","messages","stateSchema","default","allow","getFormValueFromState","state","name","isValue","flat","selected","filter","item","includes","at","getDisplayStringFromFormValue","translator","tListItem","text","join","getDisplayStringFromState","getViewModel","context","listItems","viewModel","resolvedText","resolvedHint","hint","hintAttr","itemModel","id","description","getAllPossibleErrors","baseErrors","template","selectRequired","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/ListFormComponent.ts"],"sourcesContent":["import {\n  type Item,\n  type List,\n  type ListComponentsDef,\n  type SelectionComponentsDef,\n  type YesNoFieldComponent\n} from '@defra/forms-model'\nimport joi, {\n  type ArraySchema,\n  type BooleanSchema,\n  type NumberSchema,\n  type StringSchema\n} from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport {\n  type ListItem,\n  type RenderContext\n} from '~/src/server/plugins/engine/components/types.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 FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nexport class ListFormComponent extends FormComponent {\n  declare options: Extract<\n    SelectionComponentsDef,\n    { options: object }\n  >['options']\n\n  declare formSchema:\n    | ArraySchema<string>\n    | ArraySchema<number>\n    | BooleanSchema<string>\n    | NumberSchema<string>\n    | NumberSchema\n    | StringSchema\n\n  declare stateSchema:\n    | ArraySchema<string>\n    | ArraySchema<number>\n    | BooleanSchema<string>\n    | NumberSchema<string>\n    | NumberSchema\n    | StringSchema\n\n  list?: List\n  listType: List['type'] = 'string'\n\n  get items(): Item[] {\n    return this.list?.items ?? []\n  }\n\n  get values(): Item['value'][] {\n    return this.items.map(({ value }) => value)\n  }\n\n  constructor(\n    def:\n      | SelectionComponentsDef // Allow for Yes/No field custom list\n      | (YesNoFieldComponent & Pick<ListComponentsDef, 'list'>),\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n    const { model } = props\n\n    if ('list' in def) {\n      this.list = model.getList(def.list)\n      this.listType = this.list?.type ?? 'string'\n    }\n\n    let formSchema = joi[this.listType]()\n      .valid(...this.values)\n      .label(this.label)\n      .required()\n\n    if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\n\n    this.formSchema = formSchema\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n  }\n\n  getFormValueFromState(\n    state: FormSubmissionState\n  ): Item['value'] | Item['value'][] | undefined {\n    const { name, items } = this\n\n    const value = state[name]\n\n    // Allow for array values via subclass\n    const values = this.isValue(value) ? [value].flat() : []\n    const selected = items.filter((item) => values.includes(item.value))\n\n    return selected.at(0)?.value\n  }\n\n  getDisplayStringFromFormValue(\n    value: string | number | boolean | Item['value'][] | undefined,\n    translator: Translator\n  ): string {\n    const { items } = this\n\n    const values = [value ?? []].flat()\n\n    return items\n      .filter((item) => values.includes(item.value))\n      .map((item) => translator.tListItem(item, 'text') || item.text)\n      .join(', ')\n  }\n\n  getDisplayStringFromState(\n    state: FormSubmissionState,\n    translator: Translator\n  ) {\n    // Allow for array values via subclass\n    const value = this.getFormValueFromState(state)\n\n    return this.getDisplayStringFromFormValue(value, translator)\n  }\n\n  getViewModel(context: RenderContext) {\n    const { items: listItems } = this\n\n    const viewModel = super.getViewModel(context)\n    const { value } = viewModel\n\n    // Support multiple values for checkboxes\n    const values = this.isValue(value) ? [value].flat() : []\n\n    const { tListItem } = context.translator\n\n    const items = listItems.map((item) => {\n      const selected = values.includes(item.value)\n      const resolvedText = tListItem(item, 'text') || item.text\n      const resolvedHint = tListItem(item, 'hint') || item.hint?.text\n      const hintAttr = resolvedHint ? { hint: { text: resolvedHint } } : {}\n      const itemModel: ListItem = {\n        ...item,\n        text: resolvedText,\n        selected,\n        ...hintAttr\n      }\n\n      if ('id' in itemModel) {\n        delete itemModel.id\n      }\n\n      if (item.description) {\n        itemModel.hint = {\n          text: item.description\n        }\n      }\n\n      return itemModel\n    })\n\n    return {\n      ...viewModel,\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 ListFormComponent.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":"AAOA,OAAOA,GAAG,MAKH,KAAK;AAEZ,SAASC,aAAa;AAMtB,SAASC,eAAe;AAMxB,OAAO,MAAMC,iBAAiB,SAASF,aAAa,CAAC;EAsBnDG,IAAI;EACJC,QAAQ,GAAiB,QAAQ;EAEjC,IAAIC,KAAKA,CAAA,EAAW;IAClB,OAAO,IAAI,CAACF,IAAI,EAAEE,KAAK,IAAI,EAAE;EAC/B;EAEA,IAAIC,MAAMA,CAAA,EAAoB;IAC5B,OAAO,IAAI,CAACD,KAAK,CAACE,GAAG,CAAC,CAAC;MAAEC;IAAM,CAAC,KAAKA,KAAK,CAAC;EAC7C;EAEAC,WAAWA,CACTC,GAE2D,EAC3DC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IACvB,MAAM;MAAEG;IAAM,CAAC,GAAGF,KAAK;IAEvB,IAAI,MAAM,IAAID,GAAG,EAAE;MACjB,IAAI,CAACP,IAAI,GAAGU,KAAK,CAACC,OAAO,CAACJ,GAAG,CAACP,IAAI,CAAC;MACnC,IAAI,CAACC,QAAQ,GAAG,IAAI,CAACD,IAAI,EAAEY,IAAI,IAAI,QAAQ;IAC7C;IAEA,IAAIC,UAAU,GAAGjB,GAAG,CAAC,IAAI,CAACK,QAAQ,CAAC,CAAC,CAAC,CAClCa,KAAK,CAAC,GAAG,IAAI,CAACX,MAAM,CAAC,CACrBY,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,QAAQ,CAAC,CAAC;IAEb,IAAIP,OAAO,CAACQ,wBAAwB,EAAE;MACpCJ,UAAU,GAAGA,UAAU,CAACK,QAAQ,CAACT,OAAO,CAACQ,wBAAwB,CAAC;IACpE;IAEA,IAAI,CAACJ,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACM,WAAW,GAAGN,UAAU,CAACO,OAAO,CAAC,IAAI,CAAC,CAACC,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACZ,OAAO,GAAGA,OAAO;EACxB;EAEAa,qBAAqBA,CACnBC,KAA0B,EACmB;IAC7C,MAAM;MAAEC,IAAI;MAAEtB;IAAM,CAAC,GAAG,IAAI;IAE5B,MAAMG,KAAK,GAAGkB,KAAK,CAACC,IAAI,CAAC;;IAEzB;IACA,MAAMrB,MAAM,GAAG,IAAI,CAACsB,OAAO,CAACpB,KAAK,CAAC,GAAG,CAACA,KAAK,CAAC,CAACqB,IAAI,CAAC,CAAC,GAAG,EAAE;IACxD,MAAMC,QAAQ,GAAGzB,KAAK,CAAC0B,MAAM,CAAEC,IAAI,IAAK1B,MAAM,CAAC2B,QAAQ,CAACD,IAAI,CAACxB,KAAK,CAAC,CAAC;IAEpE,OAAOsB,QAAQ,CAACI,EAAE,CAAC,CAAC,CAAC,EAAE1B,KAAK;EAC9B;EAEA2B,6BAA6BA,CAC3B3B,KAA8D,EAC9D4B,UAAsB,EACd;IACR,MAAM;MAAE/B;IAAM,CAAC,GAAG,IAAI;IAEtB,MAAMC,MAAM,GAAG,CAACE,KAAK,IAAI,EAAE,CAAC,CAACqB,IAAI,CAAC,CAAC;IAEnC,OAAOxB,KAAK,CACT0B,MAAM,CAAEC,IAAI,IAAK1B,MAAM,CAAC2B,QAAQ,CAACD,IAAI,CAACxB,KAAK,CAAC,CAAC,CAC7CD,GAAG,CAAEyB,IAAI,IAAKI,UAAU,CAACC,SAAS,CAACL,IAAI,EAAE,MAAM,CAAC,IAAIA,IAAI,CAACM,IAAI,CAAC,CAC9DC,IAAI,CAAC,IAAI,CAAC;EACf;EAEAC,yBAAyBA,CACvBd,KAA0B,EAC1BU,UAAsB,EACtB;IACA;IACA,MAAM5B,KAAK,GAAG,IAAI,CAACiB,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACS,6BAA6B,CAAC3B,KAAK,EAAE4B,UAAU,CAAC;EAC9D;EAEAK,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAM;MAAErC,KAAK,EAAEsC;IAAU,CAAC,GAAG,IAAI;IAEjC,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,CAAC;IAC7C,MAAM;MAAElC;IAAM,CAAC,GAAGoC,SAAS;;IAE3B;IACA,MAAMtC,MAAM,GAAG,IAAI,CAACsB,OAAO,CAACpB,KAAK,CAAC,GAAG,CAACA,KAAK,CAAC,CAACqB,IAAI,CAAC,CAAC,GAAG,EAAE;IAExD,MAAM;MAAEQ;IAAU,CAAC,GAAGK,OAAO,CAACN,UAAU;IAExC,MAAM/B,KAAK,GAAGsC,SAAS,CAACpC,GAAG,CAAEyB,IAAI,IAAK;MACpC,MAAMF,QAAQ,GAAGxB,MAAM,CAAC2B,QAAQ,CAACD,IAAI,CAACxB,KAAK,CAAC;MAC5C,MAAMqC,YAAY,GAAGR,SAAS,CAACL,IAAI,EAAE,MAAM,CAAC,IAAIA,IAAI,CAACM,IAAI;MACzD,MAAMQ,YAAY,GAAGT,SAAS,CAACL,IAAI,EAAE,MAAM,CAAC,IAAIA,IAAI,CAACe,IAAI,EAAET,IAAI;MAC/D,MAAMU,QAAQ,GAAGF,YAAY,GAAG;QAAEC,IAAI,EAAE;UAAET,IAAI,EAAEQ;QAAa;MAAE,CAAC,GAAG,CAAC,CAAC;MACrE,MAAMG,SAAmB,GAAG;QAC1B,GAAGjB,IAAI;QACPM,IAAI,EAAEO,YAAY;QAClBf,QAAQ;QACR,GAAGkB;MACL,CAAC;MAED,IAAI,IAAI,IAAIC,SAAS,EAAE;QACrB,OAAOA,SAAS,CAACC,EAAE;MACrB;MAEA,IAAIlB,IAAI,CAACmB,WAAW,EAAE;QACpBF,SAAS,CAACF,IAAI,GAAG;UACfT,IAAI,EAAEN,IAAI,CAACmB;QACb,CAAC;MACH;MAEA,OAAOF,SAAS;IAClB,CAAC,CAAC;IAEF,OAAO;MACL,GAAGL,SAAS;MACZvC;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACE+C,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOlD,iBAAiB,CAACkD,oBAAoB,CAAC,CAAC;EACjD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEtC,IAAI,EAAE,gBAAgB;QAAEuC,QAAQ,EAAErD,eAAe,CAACsD;MAAe,CAAC,CACrE;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}
+{"version":3,"file":"ListFormComponent.js","names":["joi","FormComponent","messageTemplate","ListFormComponent","list","listType","items","values","map","value","constructor","def","props","options","model","getList","type","formSchema","valid","label","required","customValidationMessages","messages","stateSchema","default","allow","getFormValueFromState","state","name","isValue","flat","selected","filter","item","includes","at","getDisplayStringFromFormValue","translator","tListItem","text","join","getDisplayStringFromState","getViewModel","context","listItems","viewModel","resolvedText","resolvedHint","hint","hintAttr","itemModel","id","description","getAllPossibleErrors","baseErrors","template","selectRequired","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/ListFormComponent.ts"],"sourcesContent":["import {\n  type Item,\n  type List,\n  type ListComponentsDef,\n  type SelectionComponentsDef,\n  type YesNoFieldComponent\n} from '@defra/forms-model'\nimport joi, {\n  type ArraySchema,\n  type BooleanSchema,\n  type NumberSchema,\n  type StringSchema\n} from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport {\n  type ListItem,\n  type RenderContext\n} from '~/src/server/plugins/engine/components/types.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 FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nexport class ListFormComponent extends FormComponent {\n  declare options: Extract<\n    SelectionComponentsDef,\n    { options: object }\n  >['options']\n\n  declare formSchema:\n    | ArraySchema<string[]>\n    | ArraySchema<number[]>\n    | BooleanSchema<string>\n    | NumberSchema<string>\n    | NumberSchema\n    | StringSchema\n\n  declare stateSchema:\n    | ArraySchema<string[]>\n    | ArraySchema<number[]>\n    | BooleanSchema<string>\n    | NumberSchema<string>\n    | NumberSchema\n    | StringSchema\n\n  list?: List\n  listType: List['type'] = 'string'\n\n  get items(): Item[] {\n    return this.list?.items ?? []\n  }\n\n  get values(): Item['value'][] {\n    return this.items.map(({ value }) => value)\n  }\n\n  constructor(\n    def:\n      | SelectionComponentsDef // Allow for Yes/No field custom list\n      | (YesNoFieldComponent & Pick<ListComponentsDef, 'list'>),\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n    const { model } = props\n\n    if ('list' in def) {\n      this.list = model.getList(def.list)\n      this.listType = this.list?.type ?? 'string'\n    }\n\n    let formSchema = joi[this.listType]()\n      .valid(...this.values)\n      .label(this.label)\n      .required()\n\n    if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\n\n    this.formSchema = formSchema\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n  }\n\n  getFormValueFromState(\n    state: FormSubmissionState\n  ): Item['value'] | Item['value'][] | undefined {\n    const { name, items } = this\n\n    const value = state[name]\n\n    // Allow for array values via subclass\n    const values = this.isValue(value) ? [value].flat() : []\n    const selected = items.filter((item) => values.includes(item.value))\n\n    return selected.at(0)?.value\n  }\n\n  getDisplayStringFromFormValue(\n    value: string | number | boolean | Item['value'][] | undefined,\n    translator: Translator\n  ): string {\n    const { items } = this\n\n    const values = [value ?? []].flat()\n\n    return items\n      .filter((item) => values.includes(item.value))\n      .map((item) => translator.tListItem(item, 'text') || item.text)\n      .join(', ')\n  }\n\n  getDisplayStringFromState(\n    state: FormSubmissionState,\n    translator: Translator\n  ) {\n    // Allow for array values via subclass\n    const value = this.getFormValueFromState(state)\n\n    return this.getDisplayStringFromFormValue(value, translator)\n  }\n\n  getViewModel(context: RenderContext) {\n    const { items: listItems } = this\n\n    const viewModel = super.getViewModel(context)\n    const { value } = viewModel\n\n    // Support multiple values for checkboxes\n    const values = this.isValue(value) ? [value].flat() : []\n\n    const { tListItem } = context.translator\n\n    const items = listItems.map((item) => {\n      const selected = values.includes(item.value)\n      const resolvedText = tListItem(item, 'text') || item.text\n      const resolvedHint = tListItem(item, 'hint') || item.hint?.text\n      const hintAttr = resolvedHint ? { hint: { text: resolvedHint } } : {}\n      const itemModel: ListItem = {\n        ...item,\n        text: resolvedText,\n        selected,\n        ...hintAttr\n      }\n\n      if ('id' in itemModel) {\n        delete itemModel.id\n      }\n\n      if (item.description) {\n        itemModel.hint = {\n          text: item.description\n        }\n      }\n\n      return itemModel\n    })\n\n    return {\n      ...viewModel,\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 ListFormComponent.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":"AAOA,OAAOA,GAAG,MAKH,KAAK;AAEZ,SAASC,aAAa;AAMtB,SAASC,eAAe;AAMxB,OAAO,MAAMC,iBAAiB,SAASF,aAAa,CAAC;EAsBnDG,IAAI;EACJC,QAAQ,GAAiB,QAAQ;EAEjC,IAAIC,KAAKA,CAAA,EAAW;IAClB,OAAO,IAAI,CAACF,IAAI,EAAEE,KAAK,IAAI,EAAE;EAC/B;EAEA,IAAIC,MAAMA,CAAA,EAAoB;IAC5B,OAAO,IAAI,CAACD,KAAK,CAACE,GAAG,CAAC,CAAC;MAAEC;IAAM,CAAC,KAAKA,KAAK,CAAC;EAC7C;EAEAC,WAAWA,CACTC,GAE2D,EAC3DC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IACvB,MAAM;MAAEG;IAAM,CAAC,GAAGF,KAAK;IAEvB,IAAI,MAAM,IAAID,GAAG,EAAE;MACjB,IAAI,CAACP,IAAI,GAAGU,KAAK,CAACC,OAAO,CAACJ,GAAG,CAACP,IAAI,CAAC;MACnC,IAAI,CAACC,QAAQ,GAAG,IAAI,CAACD,IAAI,EAAEY,IAAI,IAAI,QAAQ;IAC7C;IAEA,IAAIC,UAAU,GAAGjB,GAAG,CAAC,IAAI,CAACK,QAAQ,CAAC,CAAC,CAAC,CAClCa,KAAK,CAAC,GAAG,IAAI,CAACX,MAAM,CAAC,CACrBY,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,QAAQ,CAAC,CAAC;IAEb,IAAIP,OAAO,CAACQ,wBAAwB,EAAE;MACpCJ,UAAU,GAAGA,UAAU,CAACK,QAAQ,CAACT,OAAO,CAACQ,wBAAwB,CAAC;IACpE;IAEA,IAAI,CAACJ,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACM,WAAW,GAAGN,UAAU,CAACO,OAAO,CAAC,IAAI,CAAC,CAACC,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACZ,OAAO,GAAGA,OAAO;EACxB;EAEAa,qBAAqBA,CACnBC,KAA0B,EACmB;IAC7C,MAAM;MAAEC,IAAI;MAAEtB;IAAM,CAAC,GAAG,IAAI;IAE5B,MAAMG,KAAK,GAAGkB,KAAK,CAACC,IAAI,CAAC;;IAEzB;IACA,MAAMrB,MAAM,GAAG,IAAI,CAACsB,OAAO,CAACpB,KAAK,CAAC,GAAG,CAACA,KAAK,CAAC,CAACqB,IAAI,CAAC,CAAC,GAAG,EAAE;IACxD,MAAMC,QAAQ,GAAGzB,KAAK,CAAC0B,MAAM,CAAEC,IAAI,IAAK1B,MAAM,CAAC2B,QAAQ,CAACD,IAAI,CAACxB,KAAK,CAAC,CAAC;IAEpE,OAAOsB,QAAQ,CAACI,EAAE,CAAC,CAAC,CAAC,EAAE1B,KAAK;EAC9B;EAEA2B,6BAA6BA,CAC3B3B,KAA8D,EAC9D4B,UAAsB,EACd;IACR,MAAM;MAAE/B;IAAM,CAAC,GAAG,IAAI;IAEtB,MAAMC,MAAM,GAAG,CAACE,KAAK,IAAI,EAAE,CAAC,CAACqB,IAAI,CAAC,CAAC;IAEnC,OAAOxB,KAAK,CACT0B,MAAM,CAAEC,IAAI,IAAK1B,MAAM,CAAC2B,QAAQ,CAACD,IAAI,CAACxB,KAAK,CAAC,CAAC,CAC7CD,GAAG,CAAEyB,IAAI,IAAKI,UAAU,CAACC,SAAS,CAACL,IAAI,EAAE,MAAM,CAAC,IAAIA,IAAI,CAACM,IAAI,CAAC,CAC9DC,IAAI,CAAC,IAAI,CAAC;EACf;EAEAC,yBAAyBA,CACvBd,KAA0B,EAC1BU,UAAsB,EACtB;IACA;IACA,MAAM5B,KAAK,GAAG,IAAI,CAACiB,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACS,6BAA6B,CAAC3B,KAAK,EAAE4B,UAAU,CAAC;EAC9D;EAEAK,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAM;MAAErC,KAAK,EAAEsC;IAAU,CAAC,GAAG,IAAI;IAEjC,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,CAAC;IAC7C,MAAM;MAAElC;IAAM,CAAC,GAAGoC,SAAS;;IAE3B;IACA,MAAMtC,MAAM,GAAG,IAAI,CAACsB,OAAO,CAACpB,KAAK,CAAC,GAAG,CAACA,KAAK,CAAC,CAACqB,IAAI,CAAC,CAAC,GAAG,EAAE;IAExD,MAAM;MAAEQ;IAAU,CAAC,GAAGK,OAAO,CAACN,UAAU;IAExC,MAAM/B,KAAK,GAAGsC,SAAS,CAACpC,GAAG,CAAEyB,IAAI,IAAK;MACpC,MAAMF,QAAQ,GAAGxB,MAAM,CAAC2B,QAAQ,CAACD,IAAI,CAACxB,KAAK,CAAC;MAC5C,MAAMqC,YAAY,GAAGR,SAAS,CAACL,IAAI,EAAE,MAAM,CAAC,IAAIA,IAAI,CAACM,IAAI;MACzD,MAAMQ,YAAY,GAAGT,SAAS,CAACL,IAAI,EAAE,MAAM,CAAC,IAAIA,IAAI,CAACe,IAAI,EAAET,IAAI;MAC/D,MAAMU,QAAQ,GAAGF,YAAY,GAAG;QAAEC,IAAI,EAAE;UAAET,IAAI,EAAEQ;QAAa;MAAE,CAAC,GAAG,CAAC,CAAC;MACrE,MAAMG,SAAmB,GAAG;QAC1B,GAAGjB,IAAI;QACPM,IAAI,EAAEO,YAAY;QAClBf,QAAQ;QACR,GAAGkB;MACL,CAAC;MAED,IAAI,IAAI,IAAIC,SAAS,EAAE;QACrB,OAAOA,SAAS,CAACC,EAAE;MACrB;MAEA,IAAIlB,IAAI,CAACmB,WAAW,EAAE;QACpBF,SAAS,CAACF,IAAI,GAAG;UACfT,IAAI,EAAEN,IAAI,CAACmB;QACb,CAAC;MACH;MAEA,OAAOF,SAAS;IAClB,CAAC,CAAC;IAEF,OAAO;MACL,GAAGL,SAAS;MACZvC;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACE+C,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOlD,iBAAiB,CAACkD,oBAAoB,CAAC,CAAC;EACjD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEtC,IAAI,EAAE,gBAAgB;QAAEuC,QAAQ,EAAErD,eAAe,CAACsD;MAAe,CAAC,CACrE;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -1,7 +1,8 @@
 import { type FormComponentsDef } from '@defra/forms-model';
-import { type JoiExpression, type LanguageMessages, type StringSchema } from 'joi';
+import joi, { type JoiExpression, type LanguageMessages, type StringSchema } from 'joi';
 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/types/index.js';
 import { type ErrorMessageTemplateList, type FormState, type FormStateValue, type FormSubmissionState } from '../../../../server/plugins/engine/types.js';
 interface LocationFieldOptions {
     instructionText?: string;
@@ -23,7 +24,7 @@ export declare abstract class LocationFieldBase extends FormComponent {
     formSchema: StringSchema;
     stateSchema: StringSchema;
     instructionText?: string;
-    protected abstract getValidationConfig(): ValidationConfig;
+    protected abstract getValidationConfig(translator: Translator | undefined): ValidationConfig;
     protected abstract getErrorTemplates(): {
         type: string;
         template: JoiExpression;
@@ -79,6 +80,7 @@ export declare abstract class LocationFieldBase extends FormComponent {
         upload?: {
             count: number;
             summaryList: import("../../../../server/plugins/engine/types.js").SummaryList;
+            uploadingLabel?: string;
         };
     } | {
         instructionText: string;
@@ -128,8 +130,12 @@ export declare abstract class LocationFieldBase extends FormComponent {
         upload?: {
             count: number;
             summaryList: import("../../../../server/plugins/engine/types.js").SummaryList;
+            uploadingLabel?: string;
         };
     };
+    getValidationMessagesOverride(translator: Translator): {
+        [x: string]: joi.LanguageMessages;
+    };
     getAllPossibleErrors(): ErrorMessageTemplateList;
     static isText(value?: FormStateValue | FormState): value is string;
 }

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

@@ -1,8 +1,8 @@
 import joi from 'joi';
 import { FormComponent, isFormValue } from "./FormComponent.js";
-import { addClassOptionIfNone } from "./helpers/index.js";
+import { addClassOptionIfNone, withCustomValidationOverrides } from "./helpers/index.js";
+import { buildValidationMessages } from "../i18n/buildValidationMessages.js";
 import { messageTemplate } from "../pageControllers/validationOptions.js";
-import { convertToLanguageMessages } from "../../../utils/type-utils.js";
 /**
  * Abstract base class for location-based field components
  */
@@ -16,13 +16,13 @@ export class LocationFieldBase extends FormComponent {
     const locationOptions = options;
     this.instructionText = locationOptions.instructionText;
     addClassOptionIfNone(locationOptions, 'govuk-input--width-10');
-    const config = this.getValidationConfig();
+    const config = this.getValidationConfig(undefined);
     const requiredMessage = config.requiredMessage ?? messageTemplate.required;
-    const messages = convertToLanguageMessages({
+    const messages = {
       'any.required': requiredMessage,
       'string.empty': requiredMessage,
       'string.pattern.base': config.patternErrorMessage
-    });
+    };
     let formSchema = joi.string().trim().label(this.label).required().pattern(config.pattern).messages(messages);
     if (locationOptions.required === false) {
       formSchema = formSchema.allow('');
@@ -56,16 +56,40 @@ export class LocationFieldBase extends FormComponent {
   }
   getViewModel(context) {
     const viewModel = super.getViewModel(context);
+    Object.assign(viewModel, {
+      lang: context.translator.language
+    });
     if (this.instructionText) {
+      const {
+        tComponent
+      } = context.translator;
       return {
         ...viewModel,
-        instructionText: this.instructionText
+        instructionText: tComponent(this.def, 'instructionText') || this.instructionText
       };
     }
     return viewModel;
   }
+  getValidationMessagesOverride(translator) {
+    const {
+      customValidationMessage,
+      customValidationMessages
+    } = this.options;
+    const {
+      t
+    } = translator;
+    const config = this.getValidationConfig(translator);
+    const defaults = {
+      'any.required': config.requiredMessage ?? buildValidationMessages(t).objectRequired,
+      'string.empty': config.requiredMessage ?? buildValidationMessages(t).objectRequired,
+      'string.pattern.base': config.patternErrorMessage
+    };
+    return {
+      [this.name]: withCustomValidationOverrides(defaults, customValidationMessage, customValidationMessages)
+    };
+  }
   getAllPossibleErrors() {
-    const config = this.getValidationConfig();
+    const config = this.getValidationConfig(undefined);
     return {
       baseErrors: [{
         type: 'required',

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

@@ -1 +1 @@
-{"version":3,"file":"LocationFieldBase.js","names":["joi","FormComponent","isFormValue","addClassOptionIfNone","messageTemplate","convertToLanguageMessages","LocationFieldBase","instructionText","constructor","def","props","options","locationOptions","config","getValidationConfig","requiredMessage","required","messages","patternErrorMessage","formSchema","string","trim","label","pattern","allow","customValidationMessage","message","messageKeys","reduce","acc","key","customValidationMessages","default","stateSchema","getFormValueFromState","state","name","getFormValue","value","isValue","undefined","isText","getViewModel","context","viewModel","getAllPossibleErrors","baseErrors","type","template","getErrorTemplates","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/LocationFieldBase.ts"],"sourcesContent":["import { type FormComponentsDef } from '@defra/forms-model'\nimport joi, {\n  type JoiExpression,\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 { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers/index.js'\nimport { type RenderContext } from '~/src/server/plugins/engine/components/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport { convertToLanguageMessages } from '~/src/server/utils/type-utils.js'\n\ninterface LocationFieldOptions {\n  instructionText?: string\n  required?: boolean\n  customValidationMessage?: string\n  customValidationMessages?: LanguageMessages\n  classes?: string\n}\n\ninterface ValidationConfig {\n  pattern: RegExp\n  patternErrorMessage: JoiExpression\n  requiredMessage?: JoiExpression\n}\n\n/**\n * Abstract base class for location-based field components\n */\nexport abstract class LocationFieldBase extends FormComponent {\n  declare options: LocationFieldOptions\n  declare formSchema: StringSchema\n  declare stateSchema: StringSchema\n  instructionText?: string\n\n  protected abstract getValidationConfig(): ValidationConfig\n  protected abstract getErrorTemplates(): {\n    type: string\n    template: JoiExpression\n  }[]\n\n  constructor(\n    def: FormComponentsDef,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n    const locationOptions = options as LocationFieldOptions\n    this.instructionText = locationOptions.instructionText\n\n    addClassOptionIfNone(locationOptions, 'govuk-input--width-10')\n\n    const config = this.getValidationConfig()\n    const requiredMessage = config.requiredMessage ?? messageTemplate.required\n\n    const messages = convertToLanguageMessages({\n      'any.required': requiredMessage,\n      'string.empty': requiredMessage,\n      'string.pattern.base': config.patternErrorMessage\n    })\n\n    let formSchema = joi\n      .string()\n      .trim()\n      .label(this.label)\n      .required()\n      .pattern(config.pattern)\n      .messages(messages)\n\n    if (locationOptions.required === false) {\n      formSchema = formSchema.allow('')\n    }\n\n    if (locationOptions.customValidationMessage) {\n      const message = locationOptions.customValidationMessage\n      const messageKeys = [\n        'any.required',\n        'string.empty',\n        'string.pattern.base'\n      ]\n\n      const messages = messageKeys.reduce<LanguageMessages>((acc, key) => {\n        acc[key] = message\n        return acc\n      }, {})\n\n      formSchema = formSchema.messages(messages)\n    } else if (locationOptions.customValidationMessages) {\n      formSchema = formSchema.messages(locationOptions.customValidationMessages)\n    }\n\n    this.formSchema = formSchema.default('')\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = locationOptions\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const { name } = this\n    return this.getFormValue(state[name])\n  }\n\n  getFormValue(value?: FormStateValue | FormState) {\n    return this.isValue(value) ? value : undefined\n  }\n\n  isValue(value?: FormStateValue | FormState): value is string {\n    return LocationFieldBase.isText(value)\n  }\n\n  getViewModel(context: RenderContext) {\n    const viewModel = super.getViewModel(context)\n\n    if (this.instructionText) {\n      return {\n        ...viewModel,\n        instructionText: this.instructionText\n      }\n    }\n\n    return viewModel\n  }\n\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    const config = this.getValidationConfig()\n\n    return {\n      baseErrors: [\n        {\n          type: 'required',\n          template: config.requiredMessage ?? messageTemplate.required\n        },\n        ...this.getErrorTemplates()\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n\n  static isText(value?: FormStateValue | FormState): value is string {\n    return isFormValue(value) && typeof value === 'string'\n  }\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAIH,KAAK;AAEZ,SACEC,aAAa,EACbC,WAAW;AAEb,SAASC,oBAAoB;AAE7B,SAASC,eAAe;AAOxB,SAASC,yBAAyB;AAgBlC;AACA;AACA;AACA,OAAO,MAAeC,iBAAiB,SAASL,aAAa,CAAC;EAI5DM,eAAe;EAQfC,WAAWA,CACTC,GAAsB,EACtBC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IACvB,MAAMG,eAAe,GAAGD,OAA+B;IACvD,IAAI,CAACJ,eAAe,GAAGK,eAAe,CAACL,eAAe;IAEtDJ,oBAAoB,CAACS,eAAe,EAAE,uBAAuB,CAAC;IAE9D,MAAMC,MAAM,GAAG,IAAI,CAACC,mBAAmB,CAAC,CAAC;IACzC,MAAMC,eAAe,GAAGF,MAAM,CAACE,eAAe,IAAIX,eAAe,CAACY,QAAQ;IAE1E,MAAMC,QAAQ,GAAGZ,yBAAyB,CAAC;MACzC,cAAc,EAAEU,eAAe;MAC/B,cAAc,EAAEA,eAAe;MAC/B,qBAAqB,EAAEF,MAAM,CAACK;IAChC,CAAC,CAAC;IAEF,IAAIC,UAAU,GAAGnB,GAAG,CACjBoB,MAAM,CAAC,CAAC,CACRC,IAAI,CAAC,CAAC,CACNC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBN,QAAQ,CAAC,CAAC,CACVO,OAAO,CAACV,MAAM,CAACU,OAAO,CAAC,CACvBN,QAAQ,CAACA,QAAQ,CAAC;IAErB,IAAIL,eAAe,CAACI,QAAQ,KAAK,KAAK,EAAE;MACtCG,UAAU,GAAGA,UAAU,CAACK,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAIZ,eAAe,CAACa,uBAAuB,EAAE;MAC3C,MAAMC,OAAO,GAAGd,eAAe,CAACa,uBAAuB;MACvD,MAAME,WAAW,GAAG,CAClB,cAAc,EACd,cAAc,EACd,qBAAqB,CACtB;MAED,MAAMV,QAAQ,GAAGU,WAAW,CAACC,MAAM,CAAmB,CAACC,GAAG,EAAEC,GAAG,KAAK;QAClED,GAAG,CAACC,GAAG,CAAC,GAAGJ,OAAO;QAClB,OAAOG,GAAG;MACZ,CAAC,EAAE,CAAC,CAAC,CAAC;MAENV,UAAU,GAAGA,UAAU,CAACF,QAAQ,CAACA,QAAQ,CAAC;IAC5C,CAAC,MAAM,IAAIL,eAAe,CAACmB,wBAAwB,EAAE;MACnDZ,UAAU,GAAGA,UAAU,CAACF,QAAQ,CAACL,eAAe,CAACmB,wBAAwB,CAAC;IAC5E;IAEA,IAAI,CAACZ,UAAU,GAAGA,UAAU,CAACa,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGd,UAAU,CAACa,OAAO,CAAC,IAAI,CAAC,CAACR,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACb,OAAO,GAAGC,eAAe;EAChC;EAEAsB,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAM;MAAEC;IAAK,CAAC,GAAG,IAAI;IACrB,OAAO,IAAI,CAACC,YAAY,CAACF,KAAK,CAACC,IAAI,CAAC,CAAC;EACvC;EAEAC,YAAYA,CAACC,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACC,OAAO,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAChD;EAEAD,OAAOA,CAACD,KAAkC,EAAmB;IAC3D,OAAOhC,iBAAiB,CAACmC,MAAM,CAACH,KAAK,CAAC;EACxC;EAEAI,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAMC,SAAS,GAAG,KAAK,CAACF,YAAY,CAACC,OAAO,CAAC;IAE7C,IAAI,IAAI,CAACpC,eAAe,EAAE;MACxB,OAAO;QACL,GAAGqC,SAAS;QACZrC,eAAe,EAAE,IAAI,CAACA;MACxB,CAAC;IACH;IAEA,OAAOqC,SAAS;EAClB;EAEAC,oBAAoBA,CAAA,EAA6B;IAC/C,MAAMhC,MAAM,GAAG,IAAI,CAACC,mBAAmB,CAAC,CAAC;IAEzC,OAAO;MACLgC,UAAU,EAAE,CACV;QACEC,IAAI,EAAE,UAAU;QAChBC,QAAQ,EAAEnC,MAAM,CAACE,eAAe,IAAIX,eAAe,CAACY;MACtD,CAAC,EACD,GAAG,IAAI,CAACiC,iBAAiB,CAAC,CAAC,CAC5B;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;EAEA,OAAOT,MAAMA,CAACH,KAAkC,EAAmB;IACjE,OAAOpC,WAAW,CAACoC,KAAK,CAAC,IAAI,OAAOA,KAAK,KAAK,QAAQ;EACxD;AACF","ignoreList":[]}
+{"version":3,"file":"LocationFieldBase.js","names":["joi","FormComponent","isFormValue","addClassOptionIfNone","withCustomValidationOverrides","buildValidationMessages","messageTemplate","LocationFieldBase","instructionText","constructor","def","props","options","locationOptions","config","getValidationConfig","undefined","requiredMessage","required","messages","patternErrorMessage","formSchema","string","trim","label","pattern","allow","customValidationMessage","message","messageKeys","reduce","acc","key","customValidationMessages","default","stateSchema","getFormValueFromState","state","name","getFormValue","value","isValue","isText","getViewModel","context","viewModel","Object","assign","lang","translator","language","tComponent","getValidationMessagesOverride","t","defaults","objectRequired","getAllPossibleErrors","baseErrors","type","template","getErrorTemplates","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/LocationFieldBase.ts"],"sourcesContent":["import { type FormComponentsDef } from '@defra/forms-model'\nimport joi, {\n  type JoiExpression,\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 {\n  addClassOptionIfNone,\n  withCustomValidationOverrides\n} from '~/src/server/plugins/engine/components/helpers/index.js'\nimport { type RenderContext } from '~/src/server/plugins/engine/components/types.js'\nimport { buildValidationMessages } from '~/src/server/plugins/engine/i18n/buildValidationMessages.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport { type Translator } from '~/src/server/plugins/engine/types/index.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\ninterface LocationFieldOptions {\n  instructionText?: string\n  required?: boolean\n  customValidationMessage?: string\n  customValidationMessages?: LanguageMessages\n  classes?: string\n}\n\ninterface ValidationConfig {\n  pattern: RegExp\n  patternErrorMessage: JoiExpression\n  requiredMessage?: JoiExpression\n}\n\n/**\n * Abstract base class for location-based field components\n */\nexport abstract class LocationFieldBase extends FormComponent {\n  declare options: LocationFieldOptions\n  declare formSchema: StringSchema\n  declare stateSchema: StringSchema\n  instructionText?: string\n\n  protected abstract getValidationConfig(\n    translator: Translator | undefined\n  ): ValidationConfig\n  protected abstract getErrorTemplates(): {\n    type: string\n    template: JoiExpression\n  }[]\n\n  constructor(\n    def: FormComponentsDef,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n    const locationOptions = options as LocationFieldOptions\n    this.instructionText = locationOptions.instructionText\n\n    addClassOptionIfNone(locationOptions, 'govuk-input--width-10')\n\n    const config = this.getValidationConfig(undefined)\n    const requiredMessage = config.requiredMessage ?? messageTemplate.required\n\n    const messages = {\n      'any.required': requiredMessage,\n      'string.empty': requiredMessage,\n      'string.pattern.base': config.patternErrorMessage\n    } as LanguageMessages\n\n    let formSchema = joi\n      .string()\n      .trim()\n      .label(this.label)\n      .required()\n      .pattern(config.pattern)\n      .messages(messages)\n\n    if (locationOptions.required === false) {\n      formSchema = formSchema.allow('')\n    }\n\n    if (locationOptions.customValidationMessage) {\n      const message = locationOptions.customValidationMessage\n      const messageKeys = [\n        'any.required',\n        'string.empty',\n        'string.pattern.base'\n      ]\n\n      const messages = messageKeys.reduce<LanguageMessages>((acc, key) => {\n        acc[key] = message\n        return acc\n      }, {})\n\n      formSchema = formSchema.messages(messages)\n    } else if (locationOptions.customValidationMessages) {\n      formSchema = formSchema.messages(locationOptions.customValidationMessages)\n    }\n\n    this.formSchema = formSchema.default('')\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = locationOptions\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const { name } = this\n    return this.getFormValue(state[name])\n  }\n\n  getFormValue(value?: FormStateValue | FormState) {\n    return this.isValue(value) ? value : undefined\n  }\n\n  isValue(value?: FormStateValue | FormState): value is string {\n    return LocationFieldBase.isText(value)\n  }\n\n  getViewModel(context: RenderContext) {\n    const viewModel = super.getViewModel(context)\n\n    Object.assign(viewModel, {\n      lang: context.translator.language\n    })\n\n    if (this.instructionText) {\n      const { tComponent } = context.translator\n      return {\n        ...viewModel,\n        instructionText:\n          tComponent(this.def, 'instructionText') || this.instructionText\n      }\n    }\n\n    return viewModel\n  }\n\n  getValidationMessagesOverride(translator: Translator) {\n    const { customValidationMessage, customValidationMessages } = this.options\n    const { t } = translator\n    const config = this.getValidationConfig(translator)\n    const defaults = {\n      'any.required':\n        config.requiredMessage ?? buildValidationMessages(t).objectRequired,\n      'string.empty':\n        config.requiredMessage ?? buildValidationMessages(t).objectRequired,\n      'string.pattern.base': config.patternErrorMessage\n    }\n\n    return {\n      [this.name]: withCustomValidationOverrides(\n        defaults,\n        customValidationMessage,\n        customValidationMessages\n      )\n    }\n  }\n\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    const config = this.getValidationConfig(undefined)\n\n    return {\n      baseErrors: [\n        {\n          type: 'required',\n          template: config.requiredMessage ?? messageTemplate.required\n        },\n        ...this.getErrorTemplates()\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n\n  static isText(value?: FormStateValue | FormState): value is string {\n    return isFormValue(value) && typeof value === 'string'\n  }\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAIH,KAAK;AAEZ,SACEC,aAAa,EACbC,WAAW;AAEb,SACEC,oBAAoB,EACpBC,6BAA6B;AAG/B,SAASC,uBAAuB;AAChC,SAASC,eAAe;AAuBxB;AACA;AACA;AACA,OAAO,MAAeC,iBAAiB,SAASN,aAAa,CAAC;EAI5DO,eAAe;EAUfC,WAAWA,CACTC,GAAsB,EACtBC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IACvB,MAAMG,eAAe,GAAGD,OAA+B;IACvD,IAAI,CAACJ,eAAe,GAAGK,eAAe,CAACL,eAAe;IAEtDL,oBAAoB,CAACU,eAAe,EAAE,uBAAuB,CAAC;IAE9D,MAAMC,MAAM,GAAG,IAAI,CAACC,mBAAmB,CAACC,SAAS,CAAC;IAClD,MAAMC,eAAe,GAAGH,MAAM,CAACG,eAAe,IAAIX,eAAe,CAACY,QAAQ;IAE1E,MAAMC,QAAQ,GAAG;MACf,cAAc,EAAEF,eAAe;MAC/B,cAAc,EAAEA,eAAe;MAC/B,qBAAqB,EAAEH,MAAM,CAACM;IAChC,CAAqB;IAErB,IAAIC,UAAU,GAAGrB,GAAG,CACjBsB,MAAM,CAAC,CAAC,CACRC,IAAI,CAAC,CAAC,CACNC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBN,QAAQ,CAAC,CAAC,CACVO,OAAO,CAACX,MAAM,CAACW,OAAO,CAAC,CACvBN,QAAQ,CAACA,QAAQ,CAAC;IAErB,IAAIN,eAAe,CAACK,QAAQ,KAAK,KAAK,EAAE;MACtCG,UAAU,GAAGA,UAAU,CAACK,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAIb,eAAe,CAACc,uBAAuB,EAAE;MAC3C,MAAMC,OAAO,GAAGf,eAAe,CAACc,uBAAuB;MACvD,MAAME,WAAW,GAAG,CAClB,cAAc,EACd,cAAc,EACd,qBAAqB,CACtB;MAED,MAAMV,QAAQ,GAAGU,WAAW,CAACC,MAAM,CAAmB,CAACC,GAAG,EAAEC,GAAG,KAAK;QAClED,GAAG,CAACC,GAAG,CAAC,GAAGJ,OAAO;QAClB,OAAOG,GAAG;MACZ,CAAC,EAAE,CAAC,CAAC,CAAC;MAENV,UAAU,GAAGA,UAAU,CAACF,QAAQ,CAACA,QAAQ,CAAC;IAC5C,CAAC,MAAM,IAAIN,eAAe,CAACoB,wBAAwB,EAAE;MACnDZ,UAAU,GAAGA,UAAU,CAACF,QAAQ,CAACN,eAAe,CAACoB,wBAAwB,CAAC;IAC5E;IAEA,IAAI,CAACZ,UAAU,GAAGA,UAAU,CAACa,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGd,UAAU,CAACa,OAAO,CAAC,IAAI,CAAC,CAACR,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACd,OAAO,GAAGC,eAAe;EAChC;EAEAuB,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAM;MAAEC;IAAK,CAAC,GAAG,IAAI;IACrB,OAAO,IAAI,CAACC,YAAY,CAACF,KAAK,CAACC,IAAI,CAAC,CAAC;EACvC;EAEAC,YAAYA,CAACC,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACC,OAAO,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGxB,SAAS;EAChD;EAEAyB,OAAOA,CAACD,KAAkC,EAAmB;IAC3D,OAAOjC,iBAAiB,CAACmC,MAAM,CAACF,KAAK,CAAC;EACxC;EAEAG,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAMC,SAAS,GAAG,KAAK,CAACF,YAAY,CAACC,OAAO,CAAC;IAE7CE,MAAM,CAACC,MAAM,CAACF,SAAS,EAAE;MACvBG,IAAI,EAAEJ,OAAO,CAACK,UAAU,CAACC;IAC3B,CAAC,CAAC;IAEF,IAAI,IAAI,CAAC1C,eAAe,EAAE;MACxB,MAAM;QAAE2C;MAAW,CAAC,GAAGP,OAAO,CAACK,UAAU;MACzC,OAAO;QACL,GAAGJ,SAAS;QACZrC,eAAe,EACb2C,UAAU,CAAC,IAAI,CAACzC,GAAG,EAAE,iBAAiB,CAAC,IAAI,IAAI,CAACF;MACpD,CAAC;IACH;IAEA,OAAOqC,SAAS;EAClB;EAEAO,6BAA6BA,CAACH,UAAsB,EAAE;IACpD,MAAM;MAAEtB,uBAAuB;MAAEM;IAAyB,CAAC,GAAG,IAAI,CAACrB,OAAO;IAC1E,MAAM;MAAEyC;IAAE,CAAC,GAAGJ,UAAU;IACxB,MAAMnC,MAAM,GAAG,IAAI,CAACC,mBAAmB,CAACkC,UAAU,CAAC;IACnD,MAAMK,QAAQ,GAAG;MACf,cAAc,EACZxC,MAAM,CAACG,eAAe,IAAIZ,uBAAuB,CAACgD,CAAC,CAAC,CAACE,cAAc;MACrE,cAAc,EACZzC,MAAM,CAACG,eAAe,IAAIZ,uBAAuB,CAACgD,CAAC,CAAC,CAACE,cAAc;MACrE,qBAAqB,EAAEzC,MAAM,CAACM;IAChC,CAAC;IAED,OAAO;MACL,CAAC,IAAI,CAACkB,IAAI,GAAGlC,6BAA6B,CACxCkD,QAAQ,EACR3B,uBAAuB,EACvBM,wBACF;IACF,CAAC;EACH;EAEAuB,oBAAoBA,CAAA,EAA6B;IAC/C,MAAM1C,MAAM,GAAG,IAAI,CAACC,mBAAmB,CAACC,SAAS,CAAC;IAElD,OAAO;MACLyC,UAAU,EAAE,CACV;QACEC,IAAI,EAAE,UAAU;QAChBC,QAAQ,EAAE7C,MAAM,CAACG,eAAe,IAAIX,eAAe,CAACY;MACtD,CAAC,EACD,GAAG,IAAI,CAAC0C,iBAAiB,CAAC,CAAC,CAC5B;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;EAEA,OAAOnB,MAAMA,CAACF,KAAkC,EAAmB;IACjE,OAAOtC,WAAW,CAACsC,KAAK,CAAC,IAAI,OAAOA,KAAK,KAAK,QAAQ;EACxD;AACF","ignoreList":[]}

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

@@ -1,13 +1,14 @@
 import { type CustomValidator } from 'joi';
-import { type EastingNorthingField } from '../../../../server/plugins/engine/components/EastingNorthingField.js';
+import { EastingNorthingField } from '../../../../server/plugins/engine/components/EastingNorthingField.js';
 import { type GeospatialField } from '../../../../server/plugins/engine/components/GeospatialField.js';
 import { type LatLongField } from '../../../../server/plugins/engine/components/LatLongField.js';
 import { type OsGridRefField } from '../../../../server/plugins/engine/components/OsGridRefField.js';
 import { type DateInputItem, type Label, type RenderContext, type ViewModel } from '../../../../server/plugins/engine/components/types.js';
+import { type Translator } from '../../../../server/plugins/engine/i18n/types.js';
 import { type FormSubmissionError, type FormValue } from '../../../../server/plugins/engine/types.js';
 export type LocationField = InstanceType<typeof EastingNorthingField> | InstanceType<typeof LatLongField>;
-export declare function joinWithAnd(items: string[]): string;
-export declare function formatErrorList(messages: string[]): string;
+export declare function joinWithAnd(items: string[], translator: Translator): string;
+export declare function formatErrorList(messages: string[], translator: Translator): string;
 export declare function mergeCssClasses(...classNames: (string | undefined)[]): string | undefined;
 export declare function deduplicateErrorsByHref(errors?: FormSubmissionError[]): FormSubmissionError[] | undefined;
 export declare function getMapLayers(component: GeospatialField | OsGridRefField | LatLongField | EastingNorthingField): string;
@@ -23,6 +24,8 @@ export declare function getLocationFieldViewModel(component: LocationField, view
     };
     items: DateInputItem[];
     mapLayers: string;
+    country: import("@defra/forms-model").GeospatialFieldOptionsCountry | undefined;
+    lang: string;
     label: Label;
     type?: string;
     id: string;
@@ -62,15 +65,20 @@ export declare function getLocationFieldViewModel(component: LocationField, view
     upload?: {
         count: number;
         summaryList: import("../../../../server/plugins/engine/types.js").SummaryList;
+        uploadingLabel?: string;
     };
 } | {
+    instructionSummary: string;
     instructionText: string;
+    t: (key: string, opts?: Record<string, unknown>) => string;
     fieldset: {
         attributes?: string | Record<string, string>;
         legend?: Label;
     };
     items: DateInputItem[];
     mapLayers: string;
+    country: import("@defra/forms-model").GeospatialFieldOptionsCountry | undefined;
+    lang: string;
     label: Label;
     type?: string;
     id: string;
@@ -110,6 +118,7 @@ export declare function getLocationFieldViewModel(component: LocationField, view
     upload?: {
         count: number;
         summaryList: import("../../../../server/plugins/engine/types.js").SummaryList;
+        uploadingLabel?: string;
     };
 };
 /**

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

@@ -1,3 +1,4 @@
+import { EastingNorthingField } from "./EastingNorthingField.js";
 import { isFormValue } from "./FormComponent.js";
 /**
  * Lowercases the start of a message for concatenation.
@@ -7,22 +8,21 @@ import { isFormValue } from "./FormComponent.js";
  * - "latitude must be..." -> "latitude must be..."
  */
 function lowercaseMessageStart(message) {
-  if (message.startsWith('Enter ')) {
-    return 'enter' + message.slice(5);
-  }
-
-  // Lowercase first character for any other message
+  // Lowercase first character for a message
   return message.charAt(0).toLowerCase() + message.slice(1);
 }
-export function joinWithAnd(items) {
+export function joinWithAnd(items, translator) {
+  const {
+    t
+  } = translator;
   if (items.length === 2) {
-    return `${items[0]} and ${items[1]}`;
+    return `${items[0]} ${t('common.and')} ${items[1]}`;
   }
   const leading = items.slice(0, -1).join(', ');
   const last = items[items.length - 1];
-  return `${leading} and ${last}`;
+  return `${leading} ${t('common.and')} ${last}`;
 }
-export function formatErrorList(messages) {
+export function formatErrorList(messages, translator) {
   if (!messages.length) {
     return '';
   }
@@ -30,7 +30,7 @@ export function formatErrorList(messages) {
     return messages[0];
   }
   const formattedMessages = messages.map((msg, index) => index === 0 ? msg : lowercaseMessageStart(msg));
-  return joinWithAnd(formattedMessages);
+  return joinWithAnd(formattedMessages, translator);
 }
 export function mergeCssClasses(...classNames) {
   const tokens = classNames.flatMap(name => name?.split(/\s+/) ?? []).map(token => token.trim()).filter(Boolean);
@@ -110,7 +110,7 @@ export function getLocationFieldViewModel(component, viewModel, context) {
   viewModel.showFieldsetError = showFieldsetError;
   if (hasFieldErrors) {
     viewModel.errorMessage = {
-      text: fieldErrors.length === 1 ? fieldErrors[0] : formatErrorList(fieldErrors)
+      text: fieldErrors.length === 1 ? fieldErrors[0] : formatErrorList(fieldErrors, context.translator)
     };
   }
   const fieldset = existingFieldset ?? {
@@ -123,12 +123,20 @@ export function getLocationFieldViewModel(component, viewModel, context) {
     ...viewModel,
     fieldset,
     items,
-    mapLayers: getMapLayers(component)
+    mapLayers: getMapLayers(component),
+    country: component instanceof EastingNorthingField ? component.options.countries?.at(0) : undefined,
+    lang: context.translator.language
   };
   if (component.options.instructionText) {
+    const {
+      t,
+      tComponent
+    } = context.translator;
     return {
       ...result,
-      instructionText: component.options.instructionText
+      instructionSummary: t('components.locationFieldBase.howToFind'),
+      instructionText: tComponent(component.def, 'instructionText') || component.options.instructionText,
+      t
     };
   }
   return result;