@defra/forms-engine-plugin 4.0.6 → 4.0.8

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

@@ -0,0 +1,166 @@
+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";
+
+// British National Grid coordinate limits
+const DEFAULT_EASTING_MIN = 0;
+const DEFAULT_EASTING_MAX = 70000;
+const DEFAULT_NORTHING_MIN = 0;
+const DEFAULT_NORTHING_MAX = 1300000;
+export class EastingNorthingField extends FormComponent {
+  constructor(def, props) {
+    super(def, props);
+    const {
+      name,
+      options,
+      schema
+    } = def;
+    const isRequired = options.required !== false;
+    const eastingMin = schema?.easting?.min ?? DEFAULT_EASTING_MIN;
+    const eastingMax = schema?.easting?.max ?? DEFAULT_EASTING_MAX;
+    const northingMin = schema?.northing?.min ?? DEFAULT_NORTHING_MIN;
+    const northingMax = schema?.northing?.max ?? DEFAULT_NORTHING_MAX;
+    const customValidationMessages = convertToLanguageMessages({
+      'any.required': messageTemplate.objectMissing,
+      'number.base': messageTemplate.objectMissing,
+      'number.min': `{{#label}} for ${this.title} must be between {{#limit}} and ${eastingMax}`,
+      'number.max': `{{#label}} for ${this.title} must be between ${eastingMin} and {{#limit}}`,
+      'number.precision': `{{#label}} for ${this.title} must be between 1 and 5 digits`,
+      'number.integer': `{{#label}} for ${this.title} must be between 1 and 5 digits`,
+      'number.unsafe': `{{#label}} for ${this.title} must be between 1 and 5 digits`
+    });
+    const northingValidationMessages = convertToLanguageMessages({
+      'any.required': messageTemplate.objectMissing,
+      'number.base': messageTemplate.objectMissing,
+      'number.min': `{{#label}} for ${this.title} must be between {{#limit}} and ${northingMax}`,
+      'number.max': `{{#label}} for ${this.title} must be between ${northingMin} and {{#limit}}`,
+      'number.precision': `{{#label}} for ${this.title} must be between 1 and 7 digits`,
+      'number.integer': `{{#label}} for ${this.title} must be between 1 and 7 digits`,
+      'number.unsafe': `{{#label}} for ${this.title} must be between 1 and 7 digits`
+    });
+    this.collection = new ComponentCollection([{
+      type: ComponentType.NumberField,
+      name: `${name}__easting`,
+      title: 'Easting',
+      schema: {
+        min: eastingMin,
+        max: eastingMax,
+        precision: 0
+      },
+      options: {
+        required: isRequired,
+        optionalText: true,
+        classes: 'govuk-input--width-10',
+        customValidationMessages
+      }
+    }, {
+      type: ComponentType.NumberField,
+      name: `${name}__northing`,
+      title: 'Northing',
+      schema: {
+        min: northingMin,
+        max: northingMax,
+        precision: 0
+      },
+      options: {
+        required: isRequired,
+        optionalText: true,
+        classes: 'govuk-input--width-10',
+        customValidationMessages: northingValidationMessages
+      }
+    }], {
+      ...props,
+      parent: this
+    }, {
+      custom: getValidatorEastingNorthing(this),
+      peers: [`${name}__easting`, `${name}__northing`]
+    });
+    this.options = options;
+    this.formSchema = this.collection.formSchema;
+    this.stateSchema = this.collection.stateSchema;
+  }
+  getFormValueFromState(state) {
+    const value = super.getFormValueFromState(state);
+    return EastingNorthingField.isEastingNorthing(value) ? value : undefined;
+  }
+  getDisplayStringFromFormValue(value) {
+    if (!value) {
+      return '';
+    }
+
+    // CYA page format: <<northingvalue, eastingvalue>>
+    return `${value.northing}, ${value.easting}`;
+  }
+  getDisplayStringFromState(state) {
+    const value = this.getFormValueFromState(state);
+    return this.getDisplayStringFromFormValue(value);
+  }
+  getContextValueFromFormValue(value) {
+    if (!value) {
+      return null;
+    }
+
+    // Output format: Northing: <<entry>>\nEasting: <<entry>>
+    return `Northing: ${value.northing}\nEasting: ${value.easting}`;
+  }
+  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 EastingNorthingField.isEastingNorthing(value);
+  }
+
+  /**
+   * For error preview page that shows all possible errors on a component
+   */
+  getAllPossibleErrors() {
+    return EastingNorthingField.getAllPossibleErrors();
+  }
+
+  /**
+   * Static version of getAllPossibleErrors that doesn't require a component instance.
+   */
+  static getAllPossibleErrors() {
+    return {
+      baseErrors: [{
+        type: 'required',
+        template: messageTemplate.required
+      }, {
+        type: 'eastingFormat',
+        template: 'Easting for [short description] must be between 1 and 5 digits'
+      }, {
+        type: 'northingFormat',
+        template: 'Northing for [short description] must be between 1 and 7 digits'
+      }],
+      advancedSettingsErrors: [{
+        type: 'eastingMin',
+        template: `Easting for [short description] must be between ${DEFAULT_EASTING_MIN} and ${DEFAULT_EASTING_MAX}`
+      }, {
+        type: 'eastingMax',
+        template: `Easting for [short description] must be between ${DEFAULT_EASTING_MIN} and ${DEFAULT_EASTING_MAX}`
+      }, {
+        type: 'northingMin',
+        template: `Northing for [short description] must be between ${DEFAULT_NORTHING_MIN} and ${DEFAULT_NORTHING_MAX}`
+      }, {
+        type: 'northingMax',
+        template: `Northing for [short description] must be between ${DEFAULT_NORTHING_MIN} and ${DEFAULT_NORTHING_MAX}`
+      }]
+    };
+  }
+  static isEastingNorthing(value) {
+    return isFormState(value) && NumberField.isNumber(value.easting) && NumberField.isNumber(value.northing);
+  }
+}
+export function getValidatorEastingNorthing(component) {
+  return createLocationFieldValidator(component);
+}
+//# sourceMappingURL=EastingNorthingField.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EastingNorthingField.js","names":["ComponentType","ComponentCollection","FormComponent","isFormState","createLocationFieldValidator","getLocationFieldViewModel","NumberField","messageTemplate","convertToLanguageMessages","DEFAULT_EASTING_MIN","DEFAULT_EASTING_MAX","DEFAULT_NORTHING_MIN","DEFAULT_NORTHING_MAX","EastingNorthingField","constructor","def","props","name","options","schema","isRequired","required","eastingMin","easting","min","eastingMax","max","northingMin","northing","northingMax","customValidationMessages","objectMissing","title","northingValidationMessages","collection","type","precision","optionalText","classes","parent","custom","getValidatorEastingNorthing","peers","formSchema","stateSchema","getFormValueFromState","state","value","isEastingNorthing","undefined","getDisplayStringFromFormValue","getDisplayStringFromState","getContextValueFromFormValue","getContextValueFromState","getViewModel","payload","errors","viewModel","isState","getAllPossibleErrors","baseErrors","template","advancedSettingsErrors","isNumber","component"],"sources":["../../../../../src/server/plugins/engine/components/EastingNorthingField.ts"],"sourcesContent":["import {\n  ComponentType,\n  type EastingNorthingFieldComponent\n} from '@defra/forms-model'\nimport { type LanguageMessages, type ObjectSchema } from 'joi'\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 EastingNorthingState } from '~/src/server/plugins/engine/components/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport { convertToLanguageMessages } from '~/src/server/utils/type-utils.js'\n\n// British National Grid coordinate limits\nconst DEFAULT_EASTING_MIN = 0\nconst DEFAULT_EASTING_MAX = 70000\nconst DEFAULT_NORTHING_MIN = 0\nconst DEFAULT_NORTHING_MAX = 1300000\n\nexport class EastingNorthingField extends FormComponent {\n  declare options: EastingNorthingFieldComponent['options']\n  declare formSchema: ObjectSchema<FormPayload>\n  declare stateSchema: ObjectSchema<FormState>\n  declare collection: ComponentCollection\n\n  constructor(\n    def: EastingNorthingFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { name, options, schema } = def\n\n    const isRequired = options.required !== false\n\n    const eastingMin = schema?.easting?.min ?? DEFAULT_EASTING_MIN\n    const eastingMax = schema?.easting?.max ?? DEFAULT_EASTING_MAX\n    const northingMin = schema?.northing?.min ?? DEFAULT_NORTHING_MIN\n    const northingMax = schema?.northing?.max ?? DEFAULT_NORTHING_MAX\n\n    const customValidationMessages: LanguageMessages =\n      convertToLanguageMessages({\n        'any.required': messageTemplate.objectMissing,\n        'number.base': messageTemplate.objectMissing,\n        'number.min': `{{#label}} for ${this.title} must be between {{#limit}} and ${eastingMax}`,\n        'number.max': `{{#label}} for ${this.title} must be between ${eastingMin} and {{#limit}}`,\n        'number.precision': `{{#label}} for ${this.title} must be between 1 and 5 digits`,\n        'number.integer': `{{#label}} for ${this.title} must be between 1 and 5 digits`,\n        'number.unsafe': `{{#label}} for ${this.title} must be between 1 and 5 digits`\n      })\n\n    const northingValidationMessages: LanguageMessages =\n      convertToLanguageMessages({\n        'any.required': messageTemplate.objectMissing,\n        'number.base': messageTemplate.objectMissing,\n        'number.min': `{{#label}} for ${this.title} must be between {{#limit}} and ${northingMax}`,\n        'number.max': `{{#label}} for ${this.title} must be between ${northingMin} and {{#limit}}`,\n        'number.precision': `{{#label}} for ${this.title} must be between 1 and 7 digits`,\n        'number.integer': `{{#label}} for ${this.title} must be between 1 and 7 digits`,\n        'number.unsafe': `{{#label}} for ${this.title} must be between 1 and 7 digits`\n      })\n\n    this.collection = new ComponentCollection(\n      [\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__easting`,\n          title: 'Easting',\n          schema: { min: eastingMin, max: eastingMax, precision: 0 },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-10',\n            customValidationMessages\n          }\n        },\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__northing`,\n          title: 'Northing',\n          schema: { min: northingMin, max: northingMax, precision: 0 },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-10',\n            customValidationMessages: northingValidationMessages\n          }\n        }\n      ],\n      { ...props, parent: this },\n      {\n        custom: getValidatorEastingNorthing(this),\n        peers: [`${name}__easting`, `${name}__northing`]\n      }\n    )\n\n    this.options = options\n    this.formSchema = this.collection.formSchema\n    this.stateSchema = this.collection.stateSchema\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const value = super.getFormValueFromState(state)\n    return EastingNorthingField.isEastingNorthing(value) ? value : undefined\n  }\n\n  getDisplayStringFromFormValue(\n    value: EastingNorthingState | undefined\n  ): string {\n    if (!value) {\n      return ''\n    }\n\n    // CYA page format: <<northingvalue, eastingvalue>>\n    return `${value.northing}, ${value.easting}`\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\n    return this.getDisplayStringFromFormValue(value)\n  }\n\n  getContextValueFromFormValue(\n    value: EastingNorthingState | undefined\n  ): string | null {\n    if (!value) {\n      return null\n    }\n\n    // Output format: Northing: <<entry>>\\nEasting: <<entry>>\n    return `Northing: ${value.northing}\\nEasting: ${value.easting}`\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 EastingNorthingField.isEastingNorthing(value)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return EastingNorthingField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'required', template: messageTemplate.required },\n        {\n          type: 'eastingFormat',\n          template:\n            'Easting for [short description] must be between 1 and 5 digits'\n        },\n        {\n          type: 'northingFormat',\n          template:\n            'Northing for [short description] must be between 1 and 7 digits'\n        }\n      ],\n      advancedSettingsErrors: [\n        {\n          type: 'eastingMin',\n          template: `Easting for [short description] must be between ${DEFAULT_EASTING_MIN} and ${DEFAULT_EASTING_MAX}`\n        },\n        {\n          type: 'eastingMax',\n          template: `Easting for [short description] must be between ${DEFAULT_EASTING_MIN} and ${DEFAULT_EASTING_MAX}`\n        },\n        {\n          type: 'northingMin',\n          template: `Northing for [short description] must be between ${DEFAULT_NORTHING_MIN} and ${DEFAULT_NORTHING_MAX}`\n        },\n        {\n          type: 'northingMax',\n          template: `Northing for [short description] must be between ${DEFAULT_NORTHING_MIN} and ${DEFAULT_NORTHING_MAX}`\n        }\n      ]\n    }\n  }\n\n  static isEastingNorthing(\n    value?: FormStateValue | FormState\n  ): value is EastingNorthingState {\n    return (\n      isFormState(value) &&\n      NumberField.isNumber(value.easting) &&\n      NumberField.isNumber(value.northing)\n    )\n  }\n}\n\nexport function getValidatorEastingNorthing(component: EastingNorthingField) {\n  return createLocationFieldValidator(component)\n}\n"],"mappings":"AAAA,SACEA,aAAa,QAER,oBAAoB;AAG3B,SAASC,mBAAmB;AAC5B,SACEC,aAAa,EACbC,WAAW;AAEb,SACEC,4BAA4B,EAC5BC,yBAAyB;AAE3B,SAASC,WAAW;AAEpB,SAASC,eAAe;AASxB,SAASC,yBAAyB;;AAElC;AACA,MAAMC,mBAAmB,GAAG,CAAC;AAC7B,MAAMC,mBAAmB,GAAG,KAAK;AACjC,MAAMC,oBAAoB,GAAG,CAAC;AAC9B,MAAMC,oBAAoB,GAAG,OAAO;AAEpC,OAAO,MAAMC,oBAAoB,SAASX,aAAa,CAAC;EAMtDY,WAAWA,CACTC,GAAkC,EAClCC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,IAAI;MAAEC,OAAO;MAAEC;IAAO,CAAC,GAAGJ,GAAG;IAErC,MAAMK,UAAU,GAAGF,OAAO,CAACG,QAAQ,KAAK,KAAK;IAE7C,MAAMC,UAAU,GAAGH,MAAM,EAAEI,OAAO,EAAEC,GAAG,IAAIf,mBAAmB;IAC9D,MAAMgB,UAAU,GAAGN,MAAM,EAAEI,OAAO,EAAEG,GAAG,IAAIhB,mBAAmB;IAC9D,MAAMiB,WAAW,GAAGR,MAAM,EAAES,QAAQ,EAAEJ,GAAG,IAAIb,oBAAoB;IACjE,MAAMkB,WAAW,GAAGV,MAAM,EAAES,QAAQ,EAAEF,GAAG,IAAId,oBAAoB;IAEjE,MAAMkB,wBAA0C,GAC9CtB,yBAAyB,CAAC;MACxB,cAAc,EAAED,eAAe,CAACwB,aAAa;MAC7C,aAAa,EAAExB,eAAe,CAACwB,aAAa;MAC5C,YAAY,EAAE,kBAAkB,IAAI,CAACC,KAAK,mCAAmCP,UAAU,EAAE;MACzF,YAAY,EAAE,kBAAkB,IAAI,CAACO,KAAK,oBAAoBV,UAAU,iBAAiB;MACzF,kBAAkB,EAAE,kBAAkB,IAAI,CAACU,KAAK,iCAAiC;MACjF,gBAAgB,EAAE,kBAAkB,IAAI,CAACA,KAAK,iCAAiC;MAC/E,eAAe,EAAE,kBAAkB,IAAI,CAACA,KAAK;IAC/C,CAAC,CAAC;IAEJ,MAAMC,0BAA4C,GAChDzB,yBAAyB,CAAC;MACxB,cAAc,EAAED,eAAe,CAACwB,aAAa;MAC7C,aAAa,EAAExB,eAAe,CAACwB,aAAa;MAC5C,YAAY,EAAE,kBAAkB,IAAI,CAACC,KAAK,mCAAmCH,WAAW,EAAE;MAC1F,YAAY,EAAE,kBAAkB,IAAI,CAACG,KAAK,oBAAoBL,WAAW,iBAAiB;MAC1F,kBAAkB,EAAE,kBAAkB,IAAI,CAACK,KAAK,iCAAiC;MACjF,gBAAgB,EAAE,kBAAkB,IAAI,CAACA,KAAK,iCAAiC;MAC/E,eAAe,EAAE,kBAAkB,IAAI,CAACA,KAAK;IAC/C,CAAC,CAAC;IAEJ,IAAI,CAACE,UAAU,GAAG,IAAIjC,mBAAmB,CACvC,CACE;MACEkC,IAAI,EAAEnC,aAAa,CAACM,WAAW;MAC/BW,IAAI,EAAE,GAAGA,IAAI,WAAW;MACxBe,KAAK,EAAE,SAAS;MAChBb,MAAM,EAAE;QAAEK,GAAG,EAAEF,UAAU;QAAEI,GAAG,EAAED,UAAU;QAAEW,SAAS,EAAE;MAAE,CAAC;MAC1DlB,OAAO,EAAE;QACPG,QAAQ,EAAED,UAAU;QACpBiB,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,uBAAuB;QAChCR;MACF;IACF,CAAC,EACD;MACEK,IAAI,EAAEnC,aAAa,CAACM,WAAW;MAC/BW,IAAI,EAAE,GAAGA,IAAI,YAAY;MACzBe,KAAK,EAAE,UAAU;MACjBb,MAAM,EAAE;QAAEK,GAAG,EAAEG,WAAW;QAAED,GAAG,EAAEG,WAAW;QAAEO,SAAS,EAAE;MAAE,CAAC;MAC5DlB,OAAO,EAAE;QACPG,QAAQ,EAAED,UAAU;QACpBiB,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,uBAAuB;QAChCR,wBAAwB,EAAEG;MAC5B;IACF,CAAC,CACF,EACD;MAAE,GAAGjB,KAAK;MAAEuB,MAAM,EAAE;IAAK,CAAC,EAC1B;MACEC,MAAM,EAAEC,2BAA2B,CAAC,IAAI,CAAC;MACzCC,KAAK,EAAE,CAAC,GAAGzB,IAAI,WAAW,EAAE,GAAGA,IAAI,YAAY;IACjD,CACF,CAAC;IAED,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACyB,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,OAAOjC,oBAAoB,CAACmC,iBAAiB,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAC1E;EAEAC,6BAA6BA,CAC3BH,KAAuC,EAC/B;IACR,IAAI,CAACA,KAAK,EAAE;MACV,OAAO,EAAE;IACX;;IAEA;IACA,OAAO,GAAGA,KAAK,CAACnB,QAAQ,KAAKmB,KAAK,CAACxB,OAAO,EAAE;EAC9C;EAEA4B,yBAAyBA,CAACL,KAA0B,EAAE;IACpD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACI,6BAA6B,CAACH,KAAK,CAAC;EAClD;EAEAK,4BAA4BA,CAC1BL,KAAuC,EACxB;IACf,IAAI,CAACA,KAAK,EAAE;MACV,OAAO,IAAI;IACb;;IAEA;IACA,OAAO,aAAaA,KAAK,CAACnB,QAAQ,cAAcmB,KAAK,CAACxB,OAAO,EAAE;EACjE;EAEA8B,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,OAAOnD,yBAAyB,CAAC,IAAI,EAAEoD,SAAS,EAAEF,OAAO,EAAEC,MAAM,CAAC;EACpE;EAEAE,OAAOA,CAACX,KAAkC,EAAE;IAC1C,OAAOlC,oBAAoB,CAACmC,iBAAiB,CAACD,KAAK,CAAC;EACtD;;EAEA;AACF;AACA;EACEY,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO9C,oBAAoB,CAAC8C,oBAAoB,CAAC,CAAC;EACpD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEzB,IAAI,EAAE,UAAU;QAAE0B,QAAQ,EAAEtD,eAAe,CAACc;MAAS,CAAC,EACxD;QACEc,IAAI,EAAE,eAAe;QACrB0B,QAAQ,EACN;MACJ,CAAC,EACD;QACE1B,IAAI,EAAE,gBAAgB;QACtB0B,QAAQ,EACN;MACJ,CAAC,CACF;MACDC,sBAAsB,EAAE,CACtB;QACE3B,IAAI,EAAE,YAAY;QAClB0B,QAAQ,EAAE,mDAAmDpD,mBAAmB,QAAQC,mBAAmB;MAC7G,CAAC,EACD;QACEyB,IAAI,EAAE,YAAY;QAClB0B,QAAQ,EAAE,mDAAmDpD,mBAAmB,QAAQC,mBAAmB;MAC7G,CAAC,EACD;QACEyB,IAAI,EAAE,aAAa;QACnB0B,QAAQ,EAAE,oDAAoDlD,oBAAoB,QAAQC,oBAAoB;MAChH,CAAC,EACD;QACEuB,IAAI,EAAE,aAAa;QACnB0B,QAAQ,EAAE,oDAAoDlD,oBAAoB,QAAQC,oBAAoB;MAChH,CAAC;IAEL,CAAC;EACH;EAEA,OAAOoC,iBAAiBA,CACtBD,KAAkC,EACH;IAC/B,OACE5C,WAAW,CAAC4C,KAAK,CAAC,IAClBzC,WAAW,CAACyD,QAAQ,CAAChB,KAAK,CAACxB,OAAO,CAAC,IACnCjB,WAAW,CAACyD,QAAQ,CAAChB,KAAK,CAACnB,QAAQ,CAAC;EAExC;AACF;AAEA,OAAO,SAASa,2BAA2BA,CAACuB,SAA+B,EAAE;EAC3E,OAAO5D,4BAA4B,CAAC4D,SAAS,CAAC;AAChD","ignoreList":[]}

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

@@ -0,0 +1,121 @@
+import { type LatLongFieldComponent } from '@defra/forms-model';
+import { type ObjectSchema } from 'joi';
+import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js';
+import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js';
+import { type LatLongState } from '~/src/server/plugins/engine/components/types.js';
+import { type ErrorMessageTemplateList, type FormPayload, type FormState, type FormStateValue, type FormSubmissionError, type FormSubmissionState } from '~/src/server/plugins/engine/types.js';
+export declare class LatLongField extends FormComponent {
+    options: LatLongFieldComponent['options'];
+    formSchema: ObjectSchema<FormPayload>;
+    stateSchema: ObjectSchema<FormState>;
+    collection: ComponentCollection;
+    constructor(def: LatLongFieldComponent, props: ConstructorParameters<typeof FormComponent>[1]);
+    getFormValueFromState(state: FormSubmissionState): LatLongState | undefined;
+    getDisplayStringFromFormValue(value: LatLongState | undefined): string;
+    getDisplayStringFromState(state: FormSubmissionState): string;
+    getContextValueFromFormValue(value: LatLongState | undefined): string | null;
+    getContextValueFromState(state: FormSubmissionState): string | null;
+    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+        fieldset: {
+            attributes?: string | Record<string, string>;
+            legend?: import("~/src/server/plugins/engine/components/types.js").Label;
+        };
+        items: import("~/src/server/plugins/engine/components/types.js").DateInputItem[];
+        label: import("~/src/server/plugins/engine/components/types.js").Label;
+        type?: string;
+        id: string;
+        name: string;
+        value: import("~/src/server/plugins/engine/types.js").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?: import("~/src/server/plugins/engine/components/types.js").Label;
+        };
+        items: import("~/src/server/plugins/engine/components/types.js").DateInputItem[];
+        label: import("~/src/server/plugins/engine/components/types.js").Label;
+        type?: string;
+        id: string;
+        name: string;
+        value: import("~/src/server/plugins/engine/types.js").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;
+        };
+    };
+    isState(value?: FormStateValue | FormState): value is LatLongState;
+    /**
+     * For error preview page that shows all possible errors on a component
+     */
+    getAllPossibleErrors(): ErrorMessageTemplateList;
+    /**
+     * Static version of getAllPossibleErrors that doesn't require a component instance.
+     */
+    static getAllPossibleErrors(): ErrorMessageTemplateList;
+    static isLatLong(value?: FormStateValue | FormState): value is LatLongState;
+}
+export declare function getValidatorLatLong(component: LatLongField): import("joi").CustomValidator;

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 {};