@defra/forms-engine-plugin 4.0.5 → 4.0.7

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

@@ -0,0 +1,164 @@
+import { ComponentType } from '@defra/forms-model';
+import { ComponentCollection } from "./ComponentCollection.js";
+import { FormComponent, isFormState } from "./FormComponent.js";
+import { createLocationFieldValidator, getLocationFieldViewModel } from "./LocationFieldHelpers.js";
+import { NumberField } from "./NumberField.js";
+import { messageTemplate } from "../pageControllers/validationOptions.js";
+import { convertToLanguageMessages } from "../../../utils/type-utils.js";
+export class LatLongField extends FormComponent {
+  constructor(def, props) {
+    super(def, props);
+    const {
+      name,
+      options,
+      schema
+    } = def;
+    const isRequired = options.required !== false;
+
+    // Read schema values from def.schema with fallback defaults
+    const latitudeMin = schema?.latitude?.min ?? 49;
+    const latitudeMax = schema?.latitude?.max ?? 60;
+    const longitudeMin = schema?.longitude?.min ?? -9;
+    const longitudeMax = schema?.longitude?.max ?? 2;
+    const customValidationMessages = convertToLanguageMessages({
+      'any.required': messageTemplate.objectMissing,
+      'number.base': messageTemplate.objectMissing,
+      'number.precision': '{{#label}} must have no more than 7 decimal places',
+      'number.unsafe': '{{#label}} must be a valid number'
+    });
+    const latitudeMessages = convertToLanguageMessages({
+      ...customValidationMessages,
+      'number.base': `Enter a valid latitude for ${this.title} like 51.519450`,
+      'number.min': `Latitude for ${this.title} must be between ${latitudeMin} and ${latitudeMax}`,
+      'number.max': `Latitude for ${this.title} must be between ${latitudeMin} and ${latitudeMax}`
+    });
+    const longitudeMessages = convertToLanguageMessages({
+      ...customValidationMessages,
+      'number.base': `Enter a valid longitude for ${this.title} like -0.127758`,
+      'number.min': `Longitude for ${this.title} must be between ${longitudeMin} and ${longitudeMax}`,
+      'number.max': `Longitude for ${this.title} must be between ${longitudeMin} and ${longitudeMax}`
+    });
+    this.collection = new ComponentCollection([{
+      type: ComponentType.NumberField,
+      name: `${name}__latitude`,
+      title: 'Latitude',
+      schema: {
+        min: latitudeMin,
+        max: latitudeMax,
+        precision: 7
+      },
+      options: {
+        required: isRequired,
+        optionalText: true,
+        classes: 'govuk-input--width-10',
+        suffix: '°',
+        customValidationMessages: latitudeMessages
+      }
+    }, {
+      type: ComponentType.NumberField,
+      name: `${name}__longitude`,
+      title: 'Longitude',
+      schema: {
+        min: longitudeMin,
+        max: longitudeMax,
+        precision: 7
+      },
+      options: {
+        required: isRequired,
+        optionalText: true,
+        classes: 'govuk-input--width-10',
+        suffix: '°',
+        customValidationMessages: longitudeMessages
+      }
+    }], {
+      ...props,
+      parent: this
+    }, {
+      custom: getValidatorLatLong(this),
+      peers: [`${name}__latitude`, `${name}__longitude`]
+    });
+    this.options = options;
+    this.formSchema = this.collection.formSchema;
+    this.stateSchema = this.collection.stateSchema;
+  }
+  getFormValueFromState(state) {
+    const value = super.getFormValueFromState(state);
+    return LatLongField.isLatLong(value) ? value : undefined;
+  }
+  getDisplayStringFromFormValue(value) {
+    if (!value) {
+      return '';
+    }
+
+    // CYA page format: <<latvalue, langvalue>>
+    return `${value.latitude}, ${value.longitude}`;
+  }
+  getDisplayStringFromState(state) {
+    const value = this.getFormValueFromState(state);
+    return this.getDisplayStringFromFormValue(value);
+  }
+  getContextValueFromFormValue(value) {
+    if (!value) {
+      return null;
+    }
+
+    // Output format: Lat: <<entry>>\nLong: <<entry>>
+    return `Lat: ${value.latitude}\nLong: ${value.longitude}`;
+  }
+  getContextValueFromState(state) {
+    const value = this.getFormValueFromState(state);
+    return this.getContextValueFromFormValue(value);
+  }
+  getViewModel(payload, errors) {
+    const viewModel = super.getViewModel(payload, errors);
+    return getLocationFieldViewModel(this, viewModel, payload, errors);
+  }
+  isState(value) {
+    return LatLongField.isLatLong(value);
+  }
+
+  /**
+   * For error preview page that shows all possible errors on a component
+   */
+  getAllPossibleErrors() {
+    return LatLongField.getAllPossibleErrors();
+  }
+
+  /**
+   * Static version of getAllPossibleErrors that doesn't require a component instance.
+   */
+  static getAllPossibleErrors() {
+    return {
+      baseErrors: [{
+        type: 'required',
+        template: messageTemplate.required
+      }, {
+        type: 'latitudeFormat',
+        template: 'Enter a valid latitude for [short description] like 51.519450'
+      }, {
+        type: 'longitudeFormat',
+        template: 'Enter a valid longitude for [short description] like -0.127758'
+      }],
+      advancedSettingsErrors: [{
+        type: 'latitudeMin',
+        template: 'Latitude for [short description] must be between 49 and 60'
+      }, {
+        type: 'latitudeMax',
+        template: 'Latitude for [short description] must be between 49 and 60'
+      }, {
+        type: 'longitudeMin',
+        template: 'Longitude for [short description] must be between -9 and 2'
+      }, {
+        type: 'longitudeMax',
+        template: 'Longitude for [short description] must be between -9 and 2'
+      }]
+    };
+  }
+  static isLatLong(value) {
+    return isFormState(value) && NumberField.isNumber(value.latitude) && NumberField.isNumber(value.longitude);
+  }
+}
+export function getValidatorLatLong(component) {
+  return createLocationFieldValidator(component);
+}
+//# sourceMappingURL=LatLongField.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LatLongField.js","names":["ComponentType","ComponentCollection","FormComponent","isFormState","createLocationFieldValidator","getLocationFieldViewModel","NumberField","messageTemplate","convertToLanguageMessages","LatLongField","constructor","def","props","name","options","schema","isRequired","required","latitudeMin","latitude","min","latitudeMax","max","longitudeMin","longitude","longitudeMax","customValidationMessages","objectMissing","latitudeMessages","title","longitudeMessages","collection","type","precision","optionalText","classes","suffix","parent","custom","getValidatorLatLong","peers","formSchema","stateSchema","getFormValueFromState","state","value","isLatLong","undefined","getDisplayStringFromFormValue","getDisplayStringFromState","getContextValueFromFormValue","getContextValueFromState","getViewModel","payload","errors","viewModel","isState","getAllPossibleErrors","baseErrors","template","advancedSettingsErrors","isNumber","component"],"sources":["../../../../../src/server/plugins/engine/components/LatLongField.ts"],"sourcesContent":["import { ComponentType, type LatLongFieldComponent } from '@defra/forms-model'\nimport { type LanguageMessages, type ObjectSchema } from 'joi'\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  createLocationFieldValidator,\n  getLocationFieldViewModel\n} from '~/src/server/plugins/engine/components/LocationFieldHelpers.js'\nimport { NumberField } from '~/src/server/plugins/engine/components/NumberField.js'\nimport { type LatLongState } 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\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\n    const latitudeMax = schema?.latitude?.max ?? 60\n    const longitudeMin = schema?.longitude?.min ?? -9\n    const longitudeMax = schema?.longitude?.max ?? 2\n\n    const customValidationMessages: LanguageMessages =\n      convertToLanguageMessages({\n        'any.required': messageTemplate.objectMissing,\n        'number.base': messageTemplate.objectMissing,\n        'number.precision':\n          '{{#label}} must have no more than 7 decimal places',\n        'number.unsafe': '{{#label}} must be a valid number'\n      })\n\n    const latitudeMessages: LanguageMessages = convertToLanguageMessages({\n      ...customValidationMessages,\n      'number.base': `Enter a valid latitude for ${this.title} like 51.519450`,\n      'number.min': `Latitude for ${this.title} must be between ${latitudeMin} and ${latitudeMax}`,\n      'number.max': `Latitude for ${this.title} must be between ${latitudeMin} and ${latitudeMax}`\n    })\n\n    const longitudeMessages: LanguageMessages = convertToLanguageMessages({\n      ...customValidationMessages,\n      'number.base': `Enter a valid longitude for ${this.title} like -0.127758`,\n      'number.min': `Longitude for ${this.title} must be between ${longitudeMin} and ${longitudeMax}`,\n      'number.max': `Longitude for ${this.title} must be between ${longitudeMin} and ${longitudeMax}`\n    })\n\n    this.collection = new ComponentCollection(\n      [\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__latitude`,\n          title: 'Latitude',\n          schema: { min: latitudeMin, max: latitudeMax, precision: 7 },\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: 'Longitude',\n          schema: { min: longitudeMin, max: longitudeMax, precision: 7 },\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        custom: getValidatorLatLong(this),\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(value: LatLongState | undefined): string {\n    if (!value) {\n      return ''\n    }\n\n    // CYA page format: <<latvalue, langvalue>>\n    return `${value.latitude}, ${value.longitude}`\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\n    return this.getDisplayStringFromFormValue(value)\n  }\n\n  getContextValueFromFormValue(value: LatLongState | undefined): string | null {\n    if (!value) {\n      return null\n    }\n\n    // Output format: Lat: <<entry>>\\nLong: <<entry>>\n    return `Lat: ${value.latitude}\\nLong: ${value.longitude}`\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  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:\n            'Enter a valid latitude for [short description] like 51.519450'\n        },\n        {\n          type: 'longitudeFormat',\n          template:\n            'Enter a valid longitude for [short description] like -0.127758'\n        }\n      ],\n      advancedSettingsErrors: [\n        {\n          type: 'latitudeMin',\n          template: 'Latitude for [short description] must be between 49 and 60'\n        },\n        {\n          type: 'latitudeMax',\n          template: 'Latitude for [short description] must be between 49 and 60'\n        },\n        {\n          type: 'longitudeMin',\n          template: 'Longitude for [short description] must be between -9 and 2'\n        },\n        {\n          type: 'longitudeMax',\n          template: 'Longitude for [short description] must be between -9 and 2'\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\nexport function getValidatorLatLong(component: LatLongField) {\n  return createLocationFieldValidator(component)\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAAoC,oBAAoB;AAG9E,SAASC,mBAAmB;AAC5B,SACEC,aAAa,EACbC,WAAW;AAEb,SACEC,4BAA4B,EAC5BC,yBAAyB;AAE3B,SAASC,WAAW;AAEpB,SAASC,eAAe;AASxB,SAASC,yBAAyB;AAElC,OAAO,MAAMC,YAAY,SAASP,aAAa,CAAC;EAM9CQ,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,EAAE;IAC/C,MAAMC,WAAW,GAAGN,MAAM,EAAEI,QAAQ,EAAEG,GAAG,IAAI,EAAE;IAC/C,MAAMC,YAAY,GAAGR,MAAM,EAAES,SAAS,EAAEJ,GAAG,IAAI,CAAC,CAAC;IACjD,MAAMK,YAAY,GAAGV,MAAM,EAAES,SAAS,EAAEF,GAAG,IAAI,CAAC;IAEhD,MAAMI,wBAA0C,GAC9ClB,yBAAyB,CAAC;MACxB,cAAc,EAAED,eAAe,CAACoB,aAAa;MAC7C,aAAa,EAAEpB,eAAe,CAACoB,aAAa;MAC5C,kBAAkB,EAChB,oDAAoD;MACtD,eAAe,EAAE;IACnB,CAAC,CAAC;IAEJ,MAAMC,gBAAkC,GAAGpB,yBAAyB,CAAC;MACnE,GAAGkB,wBAAwB;MAC3B,aAAa,EAAE,8BAA8B,IAAI,CAACG,KAAK,iBAAiB;MACxE,YAAY,EAAE,gBAAgB,IAAI,CAACA,KAAK,oBAAoBX,WAAW,QAAQG,WAAW,EAAE;MAC5F,YAAY,EAAE,gBAAgB,IAAI,CAACQ,KAAK,oBAAoBX,WAAW,QAAQG,WAAW;IAC5F,CAAC,CAAC;IAEF,MAAMS,iBAAmC,GAAGtB,yBAAyB,CAAC;MACpE,GAAGkB,wBAAwB;MAC3B,aAAa,EAAE,+BAA+B,IAAI,CAACG,KAAK,iBAAiB;MACzE,YAAY,EAAE,iBAAiB,IAAI,CAACA,KAAK,oBAAoBN,YAAY,QAAQE,YAAY,EAAE;MAC/F,YAAY,EAAE,iBAAiB,IAAI,CAACI,KAAK,oBAAoBN,YAAY,QAAQE,YAAY;IAC/F,CAAC,CAAC;IAEF,IAAI,CAACM,UAAU,GAAG,IAAI9B,mBAAmB,CACvC,CACE;MACE+B,IAAI,EAAEhC,aAAa,CAACM,WAAW;MAC/BO,IAAI,EAAE,GAAGA,IAAI,YAAY;MACzBgB,KAAK,EAAE,UAAU;MACjBd,MAAM,EAAE;QAAEK,GAAG,EAAEF,WAAW;QAAEI,GAAG,EAAED,WAAW;QAAEY,SAAS,EAAE;MAAE,CAAC;MAC5DnB,OAAO,EAAE;QACPG,QAAQ,EAAED,UAAU;QACpBkB,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,uBAAuB;QAChCC,MAAM,EAAE,GAAG;QACXV,wBAAwB,EAAEE;MAC5B;IACF,CAAC,EACD;MACEI,IAAI,EAAEhC,aAAa,CAACM,WAAW;MAC/BO,IAAI,EAAE,GAAGA,IAAI,aAAa;MAC1BgB,KAAK,EAAE,WAAW;MAClBd,MAAM,EAAE;QAAEK,GAAG,EAAEG,YAAY;QAAED,GAAG,EAAEG,YAAY;QAAEQ,SAAS,EAAE;MAAE,CAAC;MAC9DnB,OAAO,EAAE;QACPG,QAAQ,EAAED,UAAU;QACpBkB,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,uBAAuB;QAChCC,MAAM,EAAE,GAAG;QACXV,wBAAwB,EAAEI;MAC5B;IACF,CAAC,CACF,EACD;MAAE,GAAGlB,KAAK;MAAEyB,MAAM,EAAE;IAAK,CAAC,EAC1B;MACEC,MAAM,EAAEC,mBAAmB,CAAC,IAAI,CAAC;MACjCC,KAAK,EAAE,CAAC,GAAG3B,IAAI,YAAY,EAAE,GAAGA,IAAI,aAAa;IACnD,CACF,CAAC;IAED,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAAC2B,UAAU,GAAG,IAAI,CAACV,UAAU,CAACU,UAAU;IAC5C,IAAI,CAACC,WAAW,GAAG,IAAI,CAACX,UAAU,CAACW,WAAW;EAChD;EAEAC,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAMC,KAAK,GAAG,KAAK,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAChD,OAAOnC,YAAY,CAACqC,SAAS,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAC1D;EAEAC,6BAA6BA,CAACH,KAA+B,EAAU;IACrE,IAAI,CAACA,KAAK,EAAE;MACV,OAAO,EAAE;IACX;;IAEA;IACA,OAAO,GAAGA,KAAK,CAAC1B,QAAQ,KAAK0B,KAAK,CAACrB,SAAS,EAAE;EAChD;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,CAACL,KAA+B,EAAiB;IAC3E,IAAI,CAACA,KAAK,EAAE;MACV,OAAO,IAAI;IACb;;IAEA;IACA,OAAO,QAAQA,KAAK,CAAC1B,QAAQ,WAAW0B,KAAK,CAACrB,SAAS,EAAE;EAC3D;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,OAAOjD,yBAAyB,CAAC,IAAI,EAAEkD,SAAS,EAAEF,OAAO,EAAEC,MAAM,CAAC;EACpE;EAEAE,OAAOA,CAACX,KAAkC,EAAE;IAC1C,OAAOpC,YAAY,CAACqC,SAAS,CAACD,KAAK,CAAC;EACtC;;EAEA;AACF;AACA;EACEY,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOhD,YAAY,CAACgD,oBAAoB,CAAC,CAAC;EAC5C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAE1B,IAAI,EAAE,UAAU;QAAE2B,QAAQ,EAAEpD,eAAe,CAACU;MAAS,CAAC,EACxD;QACEe,IAAI,EAAE,gBAAgB;QACtB2B,QAAQ,EACN;MACJ,CAAC,EACD;QACE3B,IAAI,EAAE,iBAAiB;QACvB2B,QAAQ,EACN;MACJ,CAAC,CACF;MACDC,sBAAsB,EAAE,CACtB;QACE5B,IAAI,EAAE,aAAa;QACnB2B,QAAQ,EAAE;MACZ,CAAC,EACD;QACE3B,IAAI,EAAE,aAAa;QACnB2B,QAAQ,EAAE;MACZ,CAAC,EACD;QACE3B,IAAI,EAAE,cAAc;QACpB2B,QAAQ,EAAE;MACZ,CAAC,EACD;QACE3B,IAAI,EAAE,cAAc;QACpB2B,QAAQ,EAAE;MACZ,CAAC;IAEL,CAAC;EACH;EAEA,OAAOb,SAASA,CAACD,KAAkC,EAAyB;IAC1E,OACE1C,WAAW,CAAC0C,KAAK,CAAC,IAClBvC,WAAW,CAACuD,QAAQ,CAAChB,KAAK,CAAC1B,QAAQ,CAAC,IACpCb,WAAW,CAACuD,QAAQ,CAAChB,KAAK,CAACrB,SAAS,CAAC;EAEzC;AACF;AAEA,OAAO,SAASe,mBAAmBA,CAACuB,SAAuB,EAAE;EAC3D,OAAO1D,4BAA4B,CAAC0D,SAAS,CAAC;AAChD","ignoreList":[]}

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

@@ -0,0 +1,134 @@
+import { type FormComponentsDef } from '@defra/forms-model';
+import joi, { type LanguageMessages, type StringSchema } from 'joi';
+import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js';
+import { type ErrorMessageTemplateList, type FormPayload, type FormState, type FormStateValue, type FormSubmissionError, type FormSubmissionState } from '~/src/server/plugins/engine/types.js';
+interface LocationFieldOptions {
+    instructionText?: string;
+    required?: boolean;
+    customValidationMessage?: string;
+    customValidationMessages?: LanguageMessages;
+    classes?: string;
+}
+interface ValidationConfig {
+    pattern: RegExp;
+    patternErrorMessage: string;
+    customValidation?: (value: string, helpers: joi.CustomHelpers) => string | joi.ErrorReport;
+    additionalMessages?: LanguageMessages;
+}
+/**
+ * Abstract base class for location-based field components
+ */
+export declare abstract class LocationFieldBase extends FormComponent {
+    options: LocationFieldOptions;
+    formSchema: StringSchema;
+    stateSchema: StringSchema;
+    instructionText?: string;
+    protected abstract getValidationConfig(): ValidationConfig;
+    protected abstract getErrorTemplates(): {
+        type: string;
+        template: string;
+    }[];
+    constructor(def: FormComponentsDef, props: ConstructorParameters<typeof FormComponent>[1]);
+    getFormValueFromState(state: FormSubmissionState): string | undefined;
+    getFormValue(value?: FormStateValue | FormState): string | undefined;
+    isValue(value?: FormStateValue | FormState): value is string;
+    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+        label: {
+            text: string;
+        };
+        id: string;
+        name: string;
+        value: import("~/src/server/plugins/engine/types.js").FormValue;
+        type?: string;
+        hint?: {
+            id?: string;
+            text: string;
+        };
+        prefix?: import("./types.js").ComponentText;
+        suffix?: import("./types.js").ComponentText;
+        classes?: string;
+        condition?: string;
+        errors?: FormSubmissionError[];
+        errorMessage?: {
+            text: string;
+        };
+        summaryHtml?: string;
+        html?: string;
+        attributes: {
+            autocomplete?: string;
+            maxlength?: number;
+            multiple?: string;
+            accept?: string;
+            inputmode?: string;
+        };
+        content?: import("./types.js").Content | import("./types.js").Content[] | string;
+        maxlength?: number;
+        maxwords?: number;
+        rows?: number;
+        items?: import("./types.js").ListItem[] | import("./types.js").DateInputItem[];
+        fieldset?: {
+            attributes?: string | Record<string, string>;
+            legend?: import("./types.js").Label;
+        };
+        formGroup?: {
+            classes?: string;
+            attributes?: string | Record<string, string>;
+        };
+        components?: import("./types.js").ComponentViewModel[];
+        upload?: {
+            count: number;
+            summaryList: import("~/src/server/plugins/engine/types.js").SummaryList;
+        };
+    } | {
+        instructionText: string;
+        label: {
+            text: string;
+        };
+        id: string;
+        name: string;
+        value: import("~/src/server/plugins/engine/types.js").FormValue;
+        type?: string;
+        hint?: {
+            id?: string;
+            text: string;
+        };
+        prefix?: import("./types.js").ComponentText;
+        suffix?: import("./types.js").ComponentText;
+        classes?: string;
+        condition?: string;
+        errors?: FormSubmissionError[];
+        errorMessage?: {
+            text: string;
+        };
+        summaryHtml?: string;
+        html?: string;
+        attributes: {
+            autocomplete?: string;
+            maxlength?: number;
+            multiple?: string;
+            accept?: string;
+            inputmode?: string;
+        };
+        content?: import("./types.js").Content | import("./types.js").Content[] | string;
+        maxlength?: number;
+        maxwords?: number;
+        rows?: number;
+        items?: import("./types.js").ListItem[] | import("./types.js").DateInputItem[];
+        fieldset?: {
+            attributes?: string | Record<string, string>;
+            legend?: import("./types.js").Label;
+        };
+        formGroup?: {
+            classes?: string;
+            attributes?: string | Record<string, string>;
+        };
+        components?: import("./types.js").ComponentViewModel[];
+        upload?: {
+            count: number;
+            summaryList: import("~/src/server/plugins/engine/types.js").SummaryList;
+        };
+    };
+    getAllPossibleErrors(): ErrorMessageTemplateList;
+    static isText(value?: FormStateValue | FormState): value is string;
+}
+export {};

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

@@ -0,0 +1,85 @@
+import joi from 'joi';
+import { FormComponent, isFormValue } from "./FormComponent.js";
+import { addClassOptionIfNone } from "./helpers/index.js";
+import { markdown } from "./markdownParser.js";
+import { messageTemplate } from "../pageControllers/validationOptions.js";
+/**
+ * Abstract base class for location-based field components
+ */
+export class LocationFieldBase extends FormComponent {
+  instructionText;
+  constructor(def, props) {
+    super(def, props);
+    const {
+      options
+    } = def;
+    const locationOptions = options;
+    this.instructionText = locationOptions.instructionText;
+    addClassOptionIfNone(locationOptions, 'govuk-input--width-10');
+    const config = this.getValidationConfig();
+    let formSchema = joi.string().trim().label(this.label).required().pattern(config.pattern).messages({
+      'string.pattern.base': config.patternErrorMessage,
+      ...config.additionalMessages
+    });
+    if (config.customValidation) {
+      formSchema = formSchema.custom(config.customValidation);
+    }
+    if (locationOptions.required === false) {
+      formSchema = formSchema.allow('');
+    }
+    if (locationOptions.customValidationMessage) {
+      const message = locationOptions.customValidationMessage;
+      const messageKeys = ['any.required', 'string.empty', 'string.pattern.base'];
+      if (config.additionalMessages) {
+        messageKeys.push(...Object.keys(config.additionalMessages));
+      }
+      const messages = messageKeys.reduce((acc, key) => {
+        acc[key] = message;
+        return acc;
+      }, {});
+      formSchema = formSchema.messages(messages);
+    } else if (locationOptions.customValidationMessages) {
+      formSchema = formSchema.messages(locationOptions.customValidationMessages);
+    }
+    this.formSchema = formSchema.default('');
+    this.stateSchema = formSchema.default(null).allow(null);
+    this.options = locationOptions;
+  }
+  getFormValueFromState(state) {
+    const {
+      name
+    } = this;
+    return this.getFormValue(state[name]);
+  }
+  getFormValue(value) {
+    return this.isValue(value) ? value : undefined;
+  }
+  isValue(value) {
+    return LocationFieldBase.isText(value);
+  }
+  getViewModel(payload, errors) {
+    const viewModel = super.getViewModel(payload, errors);
+    if (this.instructionText) {
+      return {
+        ...viewModel,
+        instructionText: markdown.parse(this.instructionText, {
+          async: false
+        })
+      };
+    }
+    return viewModel;
+  }
+  getAllPossibleErrors() {
+    return {
+      baseErrors: [{
+        type: 'required',
+        template: messageTemplate.required
+      }, ...this.getErrorTemplates()],
+      advancedSettingsErrors: []
+    };
+  }
+  static isText(value) {
+    return isFormValue(value) && typeof value === 'string';
+  }
+}
+//# sourceMappingURL=LocationFieldBase.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LocationFieldBase.js","names":["joi","FormComponent","isFormValue","addClassOptionIfNone","markdown","messageTemplate","LocationFieldBase","instructionText","constructor","def","props","options","locationOptions","config","getValidationConfig","formSchema","string","trim","label","required","pattern","messages","patternErrorMessage","additionalMessages","customValidation","custom","allow","customValidationMessage","message","messageKeys","push","Object","keys","reduce","acc","key","customValidationMessages","default","stateSchema","getFormValueFromState","state","name","getFormValue","value","isValue","undefined","isText","getViewModel","payload","errors","viewModel","parse","async","getAllPossibleErrors","baseErrors","type","template","getErrorTemplates","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/LocationFieldBase.ts"],"sourcesContent":["import { type FormComponentsDef } from '@defra/forms-model'\nimport joi, { type LanguageMessages, type StringSchema } 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 { markdown } from '~/src/server/plugins/engine/components/markdownParser.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\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: string\n  customValidation?: (\n    value: string,\n    helpers: joi.CustomHelpers\n  ) => string | joi.ErrorReport\n  additionalMessages?: LanguageMessages\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: string\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\n    let formSchema = joi\n      .string()\n      .trim()\n      .label(this.label)\n      .required()\n      .pattern(config.pattern)\n      .messages({\n        'string.pattern.base': config.patternErrorMessage,\n        ...config.additionalMessages\n      })\n\n    if (config.customValidation) {\n      formSchema = formSchema.custom(config.customValidation)\n    }\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      if (config.additionalMessages) {\n        messageKeys.push(...Object.keys(config.additionalMessages))\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(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const viewModel = super.getViewModel(payload, errors)\n\n    if (this.instructionText) {\n      return {\n        ...viewModel,\n        instructionText: markdown.parse(this.instructionText, { async: false })\n      }\n    }\n\n    return viewModel\n  }\n\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'required', template: messageTemplate.required },\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,MAAoD,KAAK;AAEnE,SACEC,aAAa,EACbC,WAAW;AAEb,SAASC,oBAAoB;AAC7B,SAASC,QAAQ;AACjB,SAASC,eAAe;AA4BxB;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;IAEzC,IAAIC,UAAU,GAAGf,GAAG,CACjBgB,MAAM,CAAC,CAAC,CACRC,IAAI,CAAC,CAAC,CACNC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,QAAQ,CAAC,CAAC,CACVC,OAAO,CAACP,MAAM,CAACO,OAAO,CAAC,CACvBC,QAAQ,CAAC;MACR,qBAAqB,EAAER,MAAM,CAACS,mBAAmB;MACjD,GAAGT,MAAM,CAACU;IACZ,CAAC,CAAC;IAEJ,IAAIV,MAAM,CAACW,gBAAgB,EAAE;MAC3BT,UAAU,GAAGA,UAAU,CAACU,MAAM,CAACZ,MAAM,CAACW,gBAAgB,CAAC;IACzD;IAEA,IAAIZ,eAAe,CAACO,QAAQ,KAAK,KAAK,EAAE;MACtCJ,UAAU,GAAGA,UAAU,CAACW,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAId,eAAe,CAACe,uBAAuB,EAAE;MAC3C,MAAMC,OAAO,GAAGhB,eAAe,CAACe,uBAAuB;MACvD,MAAME,WAAW,GAAG,CAClB,cAAc,EACd,cAAc,EACd,qBAAqB,CACtB;MAED,IAAIhB,MAAM,CAACU,kBAAkB,EAAE;QAC7BM,WAAW,CAACC,IAAI,CAAC,GAAGC,MAAM,CAACC,IAAI,CAACnB,MAAM,CAACU,kBAAkB,CAAC,CAAC;MAC7D;MAEA,MAAMF,QAAQ,GAAGQ,WAAW,CAACI,MAAM,CAAmB,CAACC,GAAG,EAAEC,GAAG,KAAK;QAClED,GAAG,CAACC,GAAG,CAAC,GAAGP,OAAO;QAClB,OAAOM,GAAG;MACZ,CAAC,EAAE,CAAC,CAAC,CAAC;MAENnB,UAAU,GAAGA,UAAU,CAACM,QAAQ,CAACA,QAAQ,CAAC;IAC5C,CAAC,MAAM,IAAIT,eAAe,CAACwB,wBAAwB,EAAE;MACnDrB,UAAU,GAAGA,UAAU,CAACM,QAAQ,CAACT,eAAe,CAACwB,wBAAwB,CAAC;IAC5E;IAEA,IAAI,CAACrB,UAAU,GAAGA,UAAU,CAACsB,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGvB,UAAU,CAACsB,OAAO,CAAC,IAAI,CAAC,CAACX,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACf,OAAO,GAAGC,eAAe;EAChC;EAEA2B,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,OAAOrC,iBAAiB,CAACwC,MAAM,CAACH,KAAK,CAAC;EACxC;EAEAI,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IAErD,IAAI,IAAI,CAAC1C,eAAe,EAAE;MACxB,OAAO;QACL,GAAG2C,SAAS;QACZ3C,eAAe,EAAEH,QAAQ,CAAC+C,KAAK,CAAC,IAAI,CAAC5C,eAAe,EAAE;UAAE6C,KAAK,EAAE;QAAM,CAAC;MACxE,CAAC;IACH;IAEA,OAAOF,SAAS;EAClB;EAEAG,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO;MACLC,UAAU,EAAE,CACV;QAAEC,IAAI,EAAE,UAAU;QAAEC,QAAQ,EAAEnD,eAAe,CAACc;MAAS,CAAC,EACxD,GAAG,IAAI,CAACsC,iBAAiB,CAAC,CAAC,CAC5B;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;EAEA,OAAOZ,MAAMA,CAACH,KAAkC,EAAmB;IACjE,OAAOzC,WAAW,CAACyC,KAAK,CAAC,IAAI,OAAOA,KAAK,KAAK,QAAQ;EACxD;AACF","ignoreList":[]}

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

@@ -0,0 +1,108 @@
+import { type CustomValidator } from 'joi';
+import { type EastingNorthingField } from '~/src/server/plugins/engine/components/EastingNorthingField.js';
+import { type LatLongField } from '~/src/server/plugins/engine/components/LatLongField.js';
+import { type DateInputItem, type Label, type ViewModel } from '~/src/server/plugins/engine/components/types.js';
+import { type FormPayload, type FormSubmissionError, type FormValue } from '~/src/server/plugins/engine/types.js';
+export type LocationField = InstanceType<typeof EastingNorthingField> | InstanceType<typeof LatLongField>;
+export declare function getLocationFieldViewModel(component: LocationField, viewModel: ViewModel & {
+    label: Label;
+    id: string;
+    name: string;
+    value: FormValue;
+}, payload: FormPayload, errors?: FormSubmissionError[]): {
+    fieldset: {
+        attributes?: string | Record<string, string>;
+        legend?: Label;
+    };
+    items: DateInputItem[];
+    label: Label;
+    type?: string;
+    id: string;
+    name: string;
+    value: FormValue;
+    hint?: {
+        id?: string;
+        text: string;
+    };
+    prefix?: import("~/src/server/plugins/engine/components/types.js").ComponentText;
+    suffix?: import("~/src/server/plugins/engine/components/types.js").ComponentText;
+    classes?: string;
+    condition?: string;
+    errors?: FormSubmissionError[];
+    errorMessage?: {
+        text: string;
+    };
+    summaryHtml?: string;
+    html?: string;
+    attributes: {
+        autocomplete?: string;
+        maxlength?: number;
+        multiple?: string;
+        accept?: string;
+        inputmode?: string;
+    };
+    content?: import("~/src/server/plugins/engine/components/types.js").Content | import("~/src/server/plugins/engine/components/types.js").Content[] | string;
+    maxlength?: number;
+    maxwords?: number;
+    rows?: number;
+    formGroup?: {
+        classes?: string;
+        attributes?: string | Record<string, string>;
+    };
+    components?: import("~/src/server/plugins/engine/components/types.js").ComponentViewModel[];
+    upload?: {
+        count: number;
+        summaryList: import("~/src/server/plugins/engine/types.js").SummaryList;
+    };
+} | {
+    instructionText: string;
+    fieldset: {
+        attributes?: string | Record<string, string>;
+        legend?: Label;
+    };
+    items: DateInputItem[];
+    label: Label;
+    type?: string;
+    id: string;
+    name: string;
+    value: FormValue;
+    hint?: {
+        id?: string;
+        text: string;
+    };
+    prefix?: import("~/src/server/plugins/engine/components/types.js").ComponentText;
+    suffix?: import("~/src/server/plugins/engine/components/types.js").ComponentText;
+    classes?: string;
+    condition?: string;
+    errors?: FormSubmissionError[];
+    errorMessage?: {
+        text: string;
+    };
+    summaryHtml?: string;
+    html?: string;
+    attributes: {
+        autocomplete?: string;
+        maxlength?: number;
+        multiple?: string;
+        accept?: string;
+        inputmode?: string;
+    };
+    content?: import("~/src/server/plugins/engine/components/types.js").Content | import("~/src/server/plugins/engine/components/types.js").Content[] | string;
+    maxlength?: number;
+    maxwords?: number;
+    rows?: number;
+    formGroup?: {
+        classes?: string;
+        attributes?: string | Record<string, string>;
+    };
+    components?: import("~/src/server/plugins/engine/components/types.js").ComponentViewModel[];
+    upload?: {
+        count: number;
+        summaryList: import("~/src/server/plugins/engine/types.js").SummaryList;
+    };
+};
+/**
+ * Validator factory for location-based fields.
+ * This creates a validator that ensures all required fields are present.
+ */
+export declare function createLocationFieldValidator(component: LocationField): CustomValidator;

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

@@ -0,0 +1,96 @@
+import { isFormValue } from "./FormComponent.js";
+import { markdown } from "./markdownParser.js";
+export function getLocationFieldViewModel(component, viewModel, payload, errors) {
+  const {
+    collection,
+    name
+  } = component;
+  const {
+    fieldset: existingFieldset,
+    label
+  } = viewModel;
+
+  // Check for component errors only
+  const hasError = errors?.some(error => error.name === name);
+
+  // Use the component collection to generate the subitems
+  const items = collection.getViewModel(payload, errors).map(({
+    model
+  }) => {
+    let {
+      label,
+      type,
+      value,
+      classes,
+      prefix,
+      suffix,
+      errorMessage
+    } = model;
+    if (label) {
+      label.toString = () => label.text; // Use string labels
+    }
+    if (hasError || errorMessage) {
+      classes = `${classes ?? ''} govuk-input--error`.trim();
+    }
+
+    // Allow any `toString()`-able value so non-numeric
+    // values are shown alongside their error messages
+    if (!isFormValue(value)) {
+      value = undefined;
+    }
+    return {
+      label,
+      id: model.id,
+      name: model.name,
+      type,
+      value,
+      classes,
+      prefix,
+      suffix
+    };
+  });
+  const fieldset = existingFieldset ?? {
+    legend: {
+      text: label.text,
+      classes: 'govuk-fieldset__legend--m'
+    }
+  };
+  const result = {
+    ...viewModel,
+    fieldset,
+    items
+  };
+  if (component.options.instructionText) {
+    return {
+      ...result,
+      instructionText: markdown.parse(component.options.instructionText, {
+        async: false
+      })
+    };
+  }
+  return result;
+}
+
+/**
+ * Validator factory for location-based fields.
+ * This creates a validator that ensures all required fields are present.
+ */
+export function createLocationFieldValidator(component) {
+  return (payload, helpers) => {
+    const {
+      collection,
+      name,
+      options
+    } = component;
+    const values = component.getFormValueFromState(component.getStateFromValidForm(payload));
+    const context = {
+      missing: collection.keys,
+      key: name
+    };
+    if (!component.isState(values)) {
+      return options.required !== false ? helpers.error('object.required', context) : payload;
+    }
+    return payload;
+  };
+}
+//# sourceMappingURL=LocationFieldHelpers.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LocationFieldHelpers.js","names":["isFormValue","markdown","getLocationFieldViewModel","component","viewModel","payload","errors","collection","name","fieldset","existingFieldset","label","hasError","some","error","items","getViewModel","map","model","type","value","classes","prefix","suffix","errorMessage","toString","text","trim","undefined","id","legend","result","options","instructionText","parse","async","createLocationFieldValidator","helpers","values","getFormValueFromState","getStateFromValidForm","context","missing","keys","key","isState","required"],"sources":["../../../../../src/server/plugins/engine/components/LocationFieldHelpers.ts"],"sourcesContent":["import { type Context, type CustomValidator } from 'joi'\n\nimport { type EastingNorthingField } from '~/src/server/plugins/engine/components/EastingNorthingField.js'\nimport { isFormValue } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type LatLongField } from '~/src/server/plugins/engine/components/LatLongField.js'\nimport { markdown } from '~/src/server/plugins/engine/components/markdownParser.js'\nimport {\n  type DateInputItem,\n  type Label,\n  type ViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport {\n  type FormPayload,\n  type FormSubmissionError,\n  type FormValue\n} from '~/src/server/plugins/engine/types.js'\n\nexport type LocationField =\n  | InstanceType<typeof EastingNorthingField>\n  | InstanceType<typeof LatLongField>\n\nexport function getLocationFieldViewModel(\n  component: LocationField,\n  viewModel: ViewModel & {\n    label: Label\n    id: string\n    name: string\n    value: FormValue\n  },\n  payload: FormPayload,\n  errors?: FormSubmissionError[]\n) {\n  const { collection, name } = component\n  const { fieldset: existingFieldset, label } = viewModel\n\n  // Check for component errors only\n  const hasError = errors?.some((error) => error.name === name)\n\n  // Use the component collection to generate the subitems\n  const items: DateInputItem[] = collection\n    .getViewModel(payload, errors)\n    .map(({ model }): DateInputItem => {\n      let { label, type, value, classes, prefix, suffix, errorMessage } = model\n\n      if (label) {\n        label.toString = () => label.text // Use string labels\n      }\n\n      if (hasError || errorMessage) {\n        classes = `${classes ?? ''} govuk-input--error`.trim()\n      }\n\n      // Allow any `toString()`-able value so non-numeric\n      // values are shown alongside their error messages\n      if (!isFormValue(value)) {\n        value = undefined\n      }\n\n      return {\n        label,\n        id: model.id,\n        name: model.name,\n        type,\n        value,\n        classes,\n        prefix,\n        suffix\n      }\n    })\n\n  const fieldset = existingFieldset ?? {\n    legend: {\n      text: label.text,\n      classes: 'govuk-fieldset__legend--m'\n    }\n  }\n\n  const result = {\n    ...viewModel,\n    fieldset,\n    items\n  }\n\n  if (component.options.instructionText) {\n    return {\n      ...result,\n      instructionText: markdown.parse(component.options.instructionText, {\n        async: false\n      })\n    }\n  }\n\n  return result\n}\n\n/**\n * Validator factory for location-based fields.\n * This creates a validator that ensures all required fields are present.\n */\nexport function createLocationFieldValidator(\n  component: LocationField\n): CustomValidator {\n  return (payload: FormPayload, helpers) => {\n    const { collection, name, options } = component\n\n    const values = component.getFormValueFromState(\n      component.getStateFromValidForm(payload)\n    )\n\n    const context: Context = {\n      missing: collection.keys,\n      key: name\n    }\n\n    if (!component.isState(values)) {\n      return options.required !== false\n        ? helpers.error('object.required', context)\n        : payload\n    }\n\n    return payload\n  }\n}\n"],"mappings":"AAGA,SAASA,WAAW;AAEpB,SAASC,QAAQ;AAgBjB,OAAO,SAASC,yBAAyBA,CACvCC,SAAwB,EACxBC,SAKC,EACDC,OAAoB,EACpBC,MAA8B,EAC9B;EACA,MAAM;IAAEC,UAAU;IAAEC;EAAK,CAAC,GAAGL,SAAS;EACtC,MAAM;IAAEM,QAAQ,EAAEC,gBAAgB;IAAEC;EAAM,CAAC,GAAGP,SAAS;;EAEvD;EACA,MAAMQ,QAAQ,GAAGN,MAAM,EAAEO,IAAI,CAAEC,KAAK,IAAKA,KAAK,CAACN,IAAI,KAAKA,IAAI,CAAC;;EAE7D;EACA,MAAMO,KAAsB,GAAGR,UAAU,CACtCS,YAAY,CAACX,OAAO,EAAEC,MAAM,CAAC,CAC7BW,GAAG,CAAC,CAAC;IAAEC;EAAM,CAAC,KAAoB;IACjC,IAAI;MAAEP,KAAK;MAAEQ,IAAI;MAAEC,KAAK;MAAEC,OAAO;MAAEC,MAAM;MAAEC,MAAM;MAAEC;IAAa,CAAC,GAAGN,KAAK;IAEzE,IAAIP,KAAK,EAAE;MACTA,KAAK,CAACc,QAAQ,GAAG,MAAMd,KAAK,CAACe,IAAI,EAAC;IACpC;IAEA,IAAId,QAAQ,IAAIY,YAAY,EAAE;MAC5BH,OAAO,GAAG,GAAGA,OAAO,IAAI,EAAE,qBAAqB,CAACM,IAAI,CAAC,CAAC;IACxD;;IAEA;IACA;IACA,IAAI,CAAC3B,WAAW,CAACoB,KAAK,CAAC,EAAE;MACvBA,KAAK,GAAGQ,SAAS;IACnB;IAEA,OAAO;MACLjB,KAAK;MACLkB,EAAE,EAAEX,KAAK,CAACW,EAAE;MACZrB,IAAI,EAAEU,KAAK,CAACV,IAAI;MAChBW,IAAI;MACJC,KAAK;MACLC,OAAO;MACPC,MAAM;MACNC;IACF,CAAC;EACH,CAAC,CAAC;EAEJ,MAAMd,QAAQ,GAAGC,gBAAgB,IAAI;IACnCoB,MAAM,EAAE;MACNJ,IAAI,EAAEf,KAAK,CAACe,IAAI;MAChBL,OAAO,EAAE;IACX;EACF,CAAC;EAED,MAAMU,MAAM,GAAG;IACb,GAAG3B,SAAS;IACZK,QAAQ;IACRM;EACF,CAAC;EAED,IAAIZ,SAAS,CAAC6B,OAAO,CAACC,eAAe,EAAE;IACrC,OAAO;MACL,GAAGF,MAAM;MACTE,eAAe,EAAEhC,QAAQ,CAACiC,KAAK,CAAC/B,SAAS,CAAC6B,OAAO,CAACC,eAAe,EAAE;QACjEE,KAAK,EAAE;MACT,CAAC;IACH,CAAC;EACH;EAEA,OAAOJ,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASK,4BAA4BA,CAC1CjC,SAAwB,EACP;EACjB,OAAO,CAACE,OAAoB,EAAEgC,OAAO,KAAK;IACxC,MAAM;MAAE9B,UAAU;MAAEC,IAAI;MAAEwB;IAAQ,CAAC,GAAG7B,SAAS;IAE/C,MAAMmC,MAAM,GAAGnC,SAAS,CAACoC,qBAAqB,CAC5CpC,SAAS,CAACqC,qBAAqB,CAACnC,OAAO,CACzC,CAAC;IAED,MAAMoC,OAAgB,GAAG;MACvBC,OAAO,EAAEnC,UAAU,CAACoC,IAAI;MACxBC,GAAG,EAAEpC;IACP,CAAC;IAED,IAAI,CAACL,SAAS,CAAC0C,OAAO,CAACP,MAAM,CAAC,EAAE;MAC9B,OAAON,OAAO,CAACc,QAAQ,KAAK,KAAK,GAC7BT,OAAO,CAACvB,KAAK,CAAC,iBAAiB,EAAE2B,OAAO,CAAC,GACzCpC,OAAO;IACb;IAEA,OAAOA,OAAO;EAChB,CAAC;AACH","ignoreList":[]}

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

@@ -0,0 +1,19 @@
+import { type NationalGridFieldNumberFieldComponent } from '@defra/forms-model';
+import type joi from 'joi';
+import { LocationFieldBase } from '~/src/server/plugins/engine/components/LocationFieldBase.js';
+export declare class NationalGridFieldNumberField extends LocationFieldBase {
+    options: NationalGridFieldNumberFieldComponent['options'];
+    protected getValidationConfig(): {
+        pattern: RegExp;
+        patternErrorMessage: string;
+        customValidation: (value: string, helpers: joi.CustomHelpers) => string | joi.ErrorReport;
+    };
+    protected getErrorTemplates(): {
+        type: string;
+        template: string;
+    }[];
+    /**
+     * Static version of getAllPossibleErrors that doesn't require a component instance.
+     */
+    static getAllPossibleErrors(): import("../types.js").ErrorMessageTemplateList;
+}