@defra/forms-engine-plugin 4.22.0 → 5.0.0-alpha

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

@@ -4,6 +4,7 @@ import { ComponentCollection } from "./ComponentCollection.js";
 import { FormComponent, isFormState, isFormValue } from "./FormComponent.js";
 import { NumberField } from "./NumberField.js";
 import { parseStrictDate } from "../date-helper.js";
+import { buildValidationMessages } from "../i18n/buildValidationMessages.js";
 import { messageTemplate } from "../pageControllers/validationOptions.js";
 import { convertToLanguageMessages } from "../../../utils/type-utils.js";
 export class MonthYearField extends FormComponent {
@@ -26,7 +27,7 @@ export class MonthYearField extends FormComponent {
     this.collection = new ComponentCollection([{
       type: ComponentType.NumberField,
       name: `${name}__month`,
-      title: 'Month',
+      title: 'components.monthYearField.month',
       schema: {
         min: 1,
         max: 12,
@@ -41,7 +42,7 @@ export class MonthYearField extends FormComponent {
     }, {
       type: ComponentType.NumberField,
       name: `${name}__year`,
-      title: 'Year',
+      title: 'components.monthYearField.year',
       schema: {
         min: 1000,
         max: 3000,
@@ -68,7 +69,7 @@ export class MonthYearField extends FormComponent {
     const value = super.getFormValueFromState(state);
     return MonthYearField.isMonthYear(value) ? value : undefined;
   }
-  getDisplayStringFromFormValue(value) {
+  getDisplayStringFromFormValue(value, _translator) {
     if (!value) {
       return '';
     }
@@ -79,9 +80,9 @@ export class MonthYearField extends FormComponent {
     });
     return `${monthString} ${value.year}`;
   }
-  getDisplayStringFromState(state) {
+  getDisplayStringFromState(state, translator) {
     const value = this.getFormValueFromState(state);
-    return this.getDisplayStringFromFormValue(value);
+    return this.getDisplayStringFromFormValue(value, translator);
   }
   getContextValueFromFormValue(value) {
     if (!value || !isValid(parseStrictDate(value, `${value.year}-${value.month}-01`, 'yyyy-MM-dd', new Date()))) {
@@ -93,12 +94,29 @@ export class MonthYearField extends FormComponent {
     const value = this.getFormValueFromState(state);
     return this.getContextValueFromFormValue(value);
   }
-  getViewModel(payload, errors) {
+  getValidationMessagesOverride(translator) {
+    const {
+      t
+    } = translator;
+    return convertToLanguageMessages({
+      'any.required': buildValidationMessages(t).objectMissing,
+      'number.base': buildValidationMessages(t).objectMissing,
+      'number.precision': buildValidationMessages(t).dateFormat,
+      'number.integer': buildValidationMessages(t).dateFormat,
+      'number.unsafe': buildValidationMessages(t).dateFormat,
+      'number.min': buildValidationMessages(t).dateFormat,
+      'number.max': buildValidationMessages(t).dateFormat
+    });
+  }
+  getViewModel(context) {
+    const {
+      errors
+    } = context;
     const {
       collection,
       name
     } = this;
-    const viewModel = super.getViewModel(payload, errors);
+    const viewModel = super.getViewModel(context);
     let {
       fieldset,
       label
@@ -108,7 +126,7 @@ export class MonthYearField extends FormComponent {
     const hasError = errors?.some(error => error.name === name);
 
     // Use the component collection to generate the subitems
-    const items = collection.getViewModel(payload, errors).map(({
+    const items = collection.getViewModel(context).map(({
       model
     }) => {
       let {

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

@@ -1 +1 @@
-{"version":3,"file":"MonthYearField.js","names":["ComponentType","format","isValid","parse","ComponentCollection","FormComponent","isFormState","isFormValue","NumberField","parseStrictDate","messageTemplate","convertToLanguageMessages","MonthYearField","constructor","def","props","name","options","isRequired","required","customValidationMessages","objectMissing","dateFormat","collection","type","title","schema","min","max","precision","optionalText","classes","parent","custom","getValidatorMonthYear","peers","formSchema","stateSchema","getFormValueFromState","state","value","isMonthYear","undefined","getDisplayStringFromFormValue","date","Date","setMonth","month","monthString","toLocaleString","year","getDisplayStringFromState","getContextValueFromFormValue","getContextValueFromState","getViewModel","payload","errors","viewModel","fieldset","label","hasError","some","error","items","map","model","errorMessage","toString","text","trim","id","legend","isState","getAllPossibleErrors","baseErrors","template","advancedSettingsErrors","dateMin","dateMax","isNumber","component","validator","helpers","values","getStateFromValidForm","context","missing","keys","key","earliestDate","earliestMonthYear","limit","latestDate","latestMonthYear"],"sources":["../../../../../src/server/plugins/engine/components/MonthYearField.ts"],"sourcesContent":["import { ComponentType, type MonthYearFieldComponent } from '@defra/forms-model'\nimport { format, isValid, parse } from 'date-fns'\nimport {\n  type Context,\n  type CustomValidator,\n  type LanguageMessages,\n  type ObjectSchema\n} from 'joi'\n\nimport { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport {\n  FormComponent,\n  isFormState,\n  isFormValue\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { NumberField } from '~/src/server/plugins/engine/components/NumberField.js'\nimport {\n  type DateInputItem,\n  type MonthYearState\n} from '~/src/server/plugins/engine/components/types.js'\nimport { parseStrictDate } from '~/src/server/plugins/engine/date-helper.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 MonthYearField extends FormComponent {\n  declare options: MonthYearFieldComponent['options']\n  declare formSchema: ObjectSchema<FormPayload>\n  declare stateSchema: ObjectSchema<FormState>\n  declare collection: ComponentCollection\n\n  constructor(\n    def: MonthYearFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { name, options } = def\n\n    const isRequired = options.required !== false\n\n    const customValidationMessages: LanguageMessages =\n      convertToLanguageMessages({\n        'any.required': messageTemplate.objectMissing,\n        'number.base': messageTemplate.objectMissing,\n        'number.precision': messageTemplate.dateFormat,\n        'number.integer': messageTemplate.dateFormat,\n        'number.unsafe': messageTemplate.dateFormat,\n        'number.min': messageTemplate.dateFormat,\n        'number.max': messageTemplate.dateFormat\n      })\n\n    this.collection = new ComponentCollection(\n      [\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__month`,\n          title: 'Month',\n          schema: { min: 1, max: 12, precision: 0 },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-2',\n            customValidationMessages\n          }\n        },\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__year`,\n          title: 'Year',\n          schema: { min: 1000, max: 3000, precision: 0 },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-4',\n            customValidationMessages\n          }\n        }\n      ],\n      { ...props, parent: this },\n      {\n        custom: getValidatorMonthYear(this),\n        peers: [`${name}__month`, `${name}__year`]\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 MonthYearField.isMonthYear(value) ? value : undefined\n  }\n\n  getDisplayStringFromFormValue(value: MonthYearState | undefined): string {\n    if (!value) {\n      return ''\n    }\n\n    const date = new Date()\n    date.setMonth(value.month - 1)\n\n    const monthString = date.toLocaleString('default', { month: 'long' })\n    return `${monthString} ${value.year}`\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\n    return this.getDisplayStringFromFormValue(value)\n  }\n\n  getContextValueFromFormValue(\n    value: MonthYearState | undefined\n  ): string | null {\n    if (\n      !value ||\n      !isValid(\n        parseStrictDate(\n          value,\n          `${value.year}-${value.month}-01`,\n          'yyyy-MM-dd',\n          new Date()\n        )\n      )\n    ) {\n      return null\n    }\n\n    return format(`${value.year}-${value.month}-01`, 'yyyy-MM')\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 { collection, name } = this\n\n    const viewModel = super.getViewModel(payload, errors)\n    let { fieldset, 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 }) => {\n        let { label, type, value, classes, errorMessage } = model\n\n        if (label) {\n          label.toString = () => label.text // Date component uses 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        }\n      })\n\n    fieldset ??= {\n      legend: {\n        text: label.text,\n        classes: 'govuk-fieldset__legend--m'\n      }\n    }\n\n    return {\n      ...viewModel,\n      fieldset,\n      items\n    }\n  }\n\n  isState(value?: FormStateValue | FormState) {\n    return MonthYearField.isMonthYear(value)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return MonthYearField.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: 'dateFormatMonth',\n          template: '{{#label}} must include a month'\n        },\n        { type: 'dateFormatYear', template: '{{#label}} must include a year' }\n      ],\n      advancedSettingsErrors: [\n        { type: 'dateEarliest', template: messageTemplate.dateMin },\n        { type: 'dateLatest', template: messageTemplate.dateMax }\n      ]\n    }\n  }\n\n  static isMonthYear(\n    value?: FormStateValue | FormState\n  ): value is MonthYearState {\n    return (\n      isFormState(value) &&\n      NumberField.isNumber(value.month) &&\n      NumberField.isNumber(value.year)\n    )\n  }\n}\n\nexport function getValidatorMonthYear(component: MonthYearField) {\n  const validator: CustomValidator = (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    const date = parse(\n      `${values.year}-${values.month}-01`,\n      'yyyy-MM-dd',\n      new Date()\n    )\n\n    if (!isValid(date)) {\n      return helpers.error('date.format', context)\n    }\n\n    // Minimum date from today\n    const earliestDate = options.earliestMonthYear\n      ? new Date(`${options.earliestMonthYear}-01`)\n      : undefined\n\n    if (earliestDate && date < earliestDate) {\n      return helpers.error('date.min', { ...context, limit: earliestDate })\n    }\n\n    // Maximum date from today\n    const latestDate = options.latestMonthYear\n      ? new Date(`${options.latestMonthYear}-01`)\n      : undefined\n\n    if (latestDate && date > latestDate) {\n      return helpers.error('date.max', { ...context, limit: latestDate })\n    }\n\n    return payload\n  }\n\n  return validator\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAAsC,oBAAoB;AAChF,SAASC,MAAM,EAAEC,OAAO,EAAEC,KAAK,QAAQ,UAAU;AAQjD,SAASC,mBAAmB;AAC5B,SACEC,aAAa,EACbC,WAAW,EACXC,WAAW;AAEb,SAASC,WAAW;AAKpB,SAASC,eAAe;AACxB,SAASC,eAAe;AASxB,SAASC,yBAAyB;AAElC,OAAO,MAAMC,cAAc,SAASP,aAAa,CAAC;EAMhDQ,WAAWA,CACTC,GAA4B,EAC5BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,IAAI;MAAEC;IAAQ,CAAC,GAAGH,GAAG;IAE7B,MAAMI,UAAU,GAAGD,OAAO,CAACE,QAAQ,KAAK,KAAK;IAE7C,MAAMC,wBAA0C,GAC9CT,yBAAyB,CAAC;MACxB,cAAc,EAAED,eAAe,CAACW,aAAa;MAC7C,aAAa,EAAEX,eAAe,CAACW,aAAa;MAC5C,kBAAkB,EAAEX,eAAe,CAACY,UAAU;MAC9C,gBAAgB,EAAEZ,eAAe,CAACY,UAAU;MAC5C,eAAe,EAAEZ,eAAe,CAACY,UAAU;MAC3C,YAAY,EAAEZ,eAAe,CAACY,UAAU;MACxC,YAAY,EAAEZ,eAAe,CAACY;IAChC,CAAC,CAAC;IAEJ,IAAI,CAACC,UAAU,GAAG,IAAInB,mBAAmB,CACvC,CACE;MACEoB,IAAI,EAAExB,aAAa,CAACQ,WAAW;MAC/BQ,IAAI,EAAE,GAAGA,IAAI,SAAS;MACtBS,KAAK,EAAE,OAAO;MACdC,MAAM,EAAE;QAAEC,GAAG,EAAE,CAAC;QAAEC,GAAG,EAAE,EAAE;QAAEC,SAAS,EAAE;MAAE,CAAC;MACzCZ,OAAO,EAAE;QACPE,QAAQ,EAAED,UAAU;QACpBY,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,sBAAsB;QAC/BX;MACF;IACF,CAAC,EACD;MACEI,IAAI,EAAExB,aAAa,CAACQ,WAAW;MAC/BQ,IAAI,EAAE,GAAGA,IAAI,QAAQ;MACrBS,KAAK,EAAE,MAAM;MACbC,MAAM,EAAE;QAAEC,GAAG,EAAE,IAAI;QAAEC,GAAG,EAAE,IAAI;QAAEC,SAAS,EAAE;MAAE,CAAC;MAC9CZ,OAAO,EAAE;QACPE,QAAQ,EAAED,UAAU;QACpBY,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,sBAAsB;QAC/BX;MACF;IACF,CAAC,CACF,EACD;MAAE,GAAGL,KAAK;MAAEiB,MAAM,EAAE;IAAK,CAAC,EAC1B;MACEC,MAAM,EAAEC,qBAAqB,CAAC,IAAI,CAAC;MACnCC,KAAK,EAAE,CAAC,GAAGnB,IAAI,SAAS,EAAE,GAAGA,IAAI,QAAQ;IAC3C,CACF,CAAC;IAED,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACmB,UAAU,GAAG,IAAI,CAACb,UAAU,CAACa,UAAU;IAC5C,IAAI,CAACC,WAAW,GAAG,IAAI,CAACd,UAAU,CAACc,WAAW;EAChD;EAEAC,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAMC,KAAK,GAAG,KAAK,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAChD,OAAO3B,cAAc,CAAC6B,WAAW,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAC9D;EAEAC,6BAA6BA,CAACH,KAAiC,EAAU;IACvE,IAAI,CAACA,KAAK,EAAE;MACV,OAAO,EAAE;IACX;IAEA,MAAMI,IAAI,GAAG,IAAIC,IAAI,CAAC,CAAC;IACvBD,IAAI,CAACE,QAAQ,CAACN,KAAK,CAACO,KAAK,GAAG,CAAC,CAAC;IAE9B,MAAMC,WAAW,GAAGJ,IAAI,CAACK,cAAc,CAAC,SAAS,EAAE;MAAEF,KAAK,EAAE;IAAO,CAAC,CAAC;IACrE,OAAO,GAAGC,WAAW,IAAIR,KAAK,CAACU,IAAI,EAAE;EACvC;EAEAC,yBAAyBA,CAACZ,KAA0B,EAAE;IACpD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACI,6BAA6B,CAACH,KAAK,CAAC;EAClD;EAEAY,4BAA4BA,CAC1BZ,KAAiC,EAClB;IACf,IACE,CAACA,KAAK,IACN,CAACtC,OAAO,CACNO,eAAe,CACb+B,KAAK,EACL,GAAGA,KAAK,CAACU,IAAI,IAAIV,KAAK,CAACO,KAAK,KAAK,EACjC,YAAY,EACZ,IAAIF,IAAI,CAAC,CACX,CACF,CAAC,EACD;MACA,OAAO,IAAI;IACb;IAEA,OAAO5C,MAAM,CAAC,GAAGuC,KAAK,CAACU,IAAI,IAAIV,KAAK,CAACO,KAAK,KAAK,EAAE,SAAS,CAAC;EAC7D;EAEAM,wBAAwBA,CAACd,KAA0B,EAAE;IACnD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACa,4BAA4B,CAACZ,KAAK,CAAC;EACjD;EAEAc,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAM;MAAEjC,UAAU;MAAEP;IAAK,CAAC,GAAG,IAAI;IAEjC,MAAMyC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,IAAI;MAAEE,QAAQ;MAAEC;IAAM,CAAC,GAAGF,SAAS;;IAEnC;IACA,MAAMG,QAAQ,GAAGJ,MAAM,EAAEK,IAAI,CAAEC,KAAK,IAAKA,KAAK,CAAC9C,IAAI,KAAKA,IAAI,CAAC;;IAE7D;IACA,MAAM+C,KAAsB,GAAGxC,UAAU,CACtC+B,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC,CAC7BQ,GAAG,CAAC,CAAC;MAAEC;IAAM,CAAC,KAAK;MAClB,IAAI;QAAEN,KAAK;QAAEnC,IAAI;QAAEgB,KAAK;QAAET,OAAO;QAAEmC;MAAa,CAAC,GAAGD,KAAK;MAEzD,IAAIN,KAAK,EAAE;QACTA,KAAK,CAACQ,QAAQ,GAAG,MAAMR,KAAK,CAACS,IAAI,EAAC;MACpC;MAEA,IAAIR,QAAQ,IAAIM,YAAY,EAAE;QAC5BnC,OAAO,GAAG,GAAGA,OAAO,qBAAqB,CAACsC,IAAI,CAAC,CAAC;MAClD;;MAEA;MACA;MACA,IAAI,CAAC9D,WAAW,CAACiC,KAAK,CAAC,EAAE;QACvBA,KAAK,GAAGE,SAAS;MACnB;MAEA,OAAO;QACLiB,KAAK;QACLW,EAAE,EAAEL,KAAK,CAACK,EAAE;QACZtD,IAAI,EAAEiD,KAAK,CAACjD,IAAI;QAChBQ,IAAI;QACJgB,KAAK;QACLT;MACF,CAAC;IACH,CAAC,CAAC;IAEJ2B,QAAQ,KAAK;MACXa,MAAM,EAAE;QACNH,IAAI,EAAET,KAAK,CAACS,IAAI;QAChBrC,OAAO,EAAE;MACX;IACF,CAAC;IAED,OAAO;MACL,GAAG0B,SAAS;MACZC,QAAQ;MACRK;IACF,CAAC;EACH;EAEAS,OAAOA,CAAChC,KAAkC,EAAE;IAC1C,OAAO5B,cAAc,CAAC6B,WAAW,CAACD,KAAK,CAAC;EAC1C;;EAEA;AACF;AACA;EACEiC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO7D,cAAc,CAAC6D,oBAAoB,CAAC,CAAC;EAC9C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAElD,IAAI,EAAE,UAAU;QAAEmD,QAAQ,EAAEjE,eAAe,CAACS;MAAS,CAAC,EACxD;QACEK,IAAI,EAAE,iBAAiB;QACvBmD,QAAQ,EAAE;MACZ,CAAC,EACD;QAAEnD,IAAI,EAAE,gBAAgB;QAAEmD,QAAQ,EAAE;MAAiC,CAAC,CACvE;MACDC,sBAAsB,EAAE,CACtB;QAAEpD,IAAI,EAAE,cAAc;QAAEmD,QAAQ,EAAEjE,eAAe,CAACmE;MAAQ,CAAC,EAC3D;QAAErD,IAAI,EAAE,YAAY;QAAEmD,QAAQ,EAAEjE,eAAe,CAACoE;MAAQ,CAAC;IAE7D,CAAC;EACH;EAEA,OAAOrC,WAAWA,CAChBD,KAAkC,EACT;IACzB,OACElC,WAAW,CAACkC,KAAK,CAAC,IAClBhC,WAAW,CAACuE,QAAQ,CAACvC,KAAK,CAACO,KAAK,CAAC,IACjCvC,WAAW,CAACuE,QAAQ,CAACvC,KAAK,CAACU,IAAI,CAAC;EAEpC;AACF;AAEA,OAAO,SAAShB,qBAAqBA,CAAC8C,SAAyB,EAAE;EAC/D,MAAMC,SAA0B,GAAGA,CAAC1B,OAAoB,EAAE2B,OAAO,KAAK;IACpE,MAAM;MAAE3D,UAAU;MAAEP,IAAI;MAAEC;IAAQ,CAAC,GAAG+D,SAAS;IAE/C,MAAMG,MAAM,GAAGH,SAAS,CAAC1C,qBAAqB,CAC5C0C,SAAS,CAACI,qBAAqB,CAAC7B,OAAO,CACzC,CAAC;IAED,MAAM8B,OAAgB,GAAG;MACvBC,OAAO,EAAE/D,UAAU,CAACgE,IAAI;MACxBC,GAAG,EAAExE;IACP,CAAC;IAED,IAAI,CAACgE,SAAS,CAACR,OAAO,CAACW,MAAM,CAAC,EAAE;MAC9B,OAAOlE,OAAO,CAACE,QAAQ,KAAK,KAAK,GAC7B+D,OAAO,CAACpB,KAAK,CAAC,iBAAiB,EAAEuB,OAAO,CAAC,GACzC9B,OAAO;IACb;IAEA,MAAMX,IAAI,GAAGzC,KAAK,CAChB,GAAGgF,MAAM,CAACjC,IAAI,IAAIiC,MAAM,CAACpC,KAAK,KAAK,EACnC,YAAY,EACZ,IAAIF,IAAI,CAAC,CACX,CAAC;IAED,IAAI,CAAC3C,OAAO,CAAC0C,IAAI,CAAC,EAAE;MAClB,OAAOsC,OAAO,CAACpB,KAAK,CAAC,aAAa,EAAEuB,OAAO,CAAC;IAC9C;;IAEA;IACA,MAAMI,YAAY,GAAGxE,OAAO,CAACyE,iBAAiB,GAC1C,IAAI7C,IAAI,CAAC,GAAG5B,OAAO,CAACyE,iBAAiB,KAAK,CAAC,GAC3ChD,SAAS;IAEb,IAAI+C,YAAY,IAAI7C,IAAI,GAAG6C,YAAY,EAAE;MACvC,OAAOP,OAAO,CAACpB,KAAK,CAAC,UAAU,EAAE;QAAE,GAAGuB,OAAO;QAAEM,KAAK,EAAEF;MAAa,CAAC,CAAC;IACvE;;IAEA;IACA,MAAMG,UAAU,GAAG3E,OAAO,CAAC4E,eAAe,GACtC,IAAIhD,IAAI,CAAC,GAAG5B,OAAO,CAAC4E,eAAe,KAAK,CAAC,GACzCnD,SAAS;IAEb,IAAIkD,UAAU,IAAIhD,IAAI,GAAGgD,UAAU,EAAE;MACnC,OAAOV,OAAO,CAACpB,KAAK,CAAC,UAAU,EAAE;QAAE,GAAGuB,OAAO;QAAEM,KAAK,EAAEC;MAAW,CAAC,CAAC;IACrE;IAEA,OAAOrC,OAAO;EAChB,CAAC;EAED,OAAO0B,SAAS;AAClB","ignoreList":[]}
+{"version":3,"file":"MonthYearField.js","names":["ComponentType","format","isValid","parse","ComponentCollection","FormComponent","isFormState","isFormValue","NumberField","parseStrictDate","buildValidationMessages","messageTemplate","convertToLanguageMessages","MonthYearField","constructor","def","props","name","options","isRequired","required","customValidationMessages","objectMissing","dateFormat","collection","type","title","schema","min","max","precision","optionalText","classes","parent","custom","getValidatorMonthYear","peers","formSchema","stateSchema","getFormValueFromState","state","value","isMonthYear","undefined","getDisplayStringFromFormValue","_translator","date","Date","setMonth","month","monthString","toLocaleString","year","getDisplayStringFromState","translator","getContextValueFromFormValue","getContextValueFromState","getValidationMessagesOverride","t","getViewModel","context","errors","viewModel","fieldset","label","hasError","some","error","items","map","model","errorMessage","toString","text","trim","id","legend","isState","getAllPossibleErrors","baseErrors","template","advancedSettingsErrors","dateMin","dateMax","isNumber","component","validator","payload","helpers","values","getStateFromValidForm","missing","keys","key","earliestDate","earliestMonthYear","limit","latestDate","latestMonthYear"],"sources":["../../../../../src/server/plugins/engine/components/MonthYearField.ts"],"sourcesContent":["import { ComponentType, type MonthYearFieldComponent } from '@defra/forms-model'\nimport { format, isValid, parse } from 'date-fns'\nimport {\n  type Context,\n  type CustomValidator,\n  type LanguageMessages,\n  type ObjectSchema\n} from 'joi'\n\nimport { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport {\n  FormComponent,\n  isFormState,\n  isFormValue\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { NumberField } from '~/src/server/plugins/engine/components/NumberField.js'\nimport {\n  type DateInputItem,\n  type MonthYearState,\n  type RenderContext\n} from '~/src/server/plugins/engine/components/types.js'\nimport { parseStrictDate } from '~/src/server/plugins/engine/date-helper.js'\nimport { buildValidationMessages } from '~/src/server/plugins/engine/i18n/buildValidationMessages.js'\nimport { type Translator } from '~/src/server/plugins/engine/i18n/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport { convertToLanguageMessages } from '~/src/server/utils/type-utils.js'\n\nexport class MonthYearField extends FormComponent {\n  declare options: MonthYearFieldComponent['options']\n  declare formSchema: ObjectSchema<FormPayload>\n  declare stateSchema: ObjectSchema<FormState>\n  declare collection: ComponentCollection\n\n  constructor(\n    def: MonthYearFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { name, options } = def\n\n    const isRequired = options.required !== false\n\n    const customValidationMessages: LanguageMessages =\n      convertToLanguageMessages({\n        'any.required': messageTemplate.objectMissing,\n        'number.base': messageTemplate.objectMissing,\n        'number.precision': messageTemplate.dateFormat,\n        'number.integer': messageTemplate.dateFormat,\n        'number.unsafe': messageTemplate.dateFormat,\n        'number.min': messageTemplate.dateFormat,\n        'number.max': messageTemplate.dateFormat\n      })\n\n    this.collection = new ComponentCollection(\n      [\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__month`,\n          title: 'components.monthYearField.month',\n          schema: { min: 1, max: 12, precision: 0 },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-2',\n            customValidationMessages\n          }\n        },\n        {\n          type: ComponentType.NumberField,\n          name: `${name}__year`,\n          title: 'components.monthYearField.year',\n          schema: { min: 1000, max: 3000, precision: 0 },\n          options: {\n            required: isRequired,\n            optionalText: true,\n            classes: 'govuk-input--width-4',\n            customValidationMessages\n          }\n        }\n      ],\n      { ...props, parent: this },\n      {\n        custom: getValidatorMonthYear(this),\n        peers: [`${name}__month`, `${name}__year`]\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 MonthYearField.isMonthYear(value) ? value : undefined\n  }\n\n  getDisplayStringFromFormValue(\n    value: MonthYearState | undefined,\n    _translator: Translator\n  ): string {\n    if (!value) {\n      return ''\n    }\n\n    const date = new Date()\n    date.setMonth(value.month - 1)\n\n    const monthString = date.toLocaleString('default', { month: 'long' })\n    return `${monthString} ${value.year}`\n  }\n\n  getDisplayStringFromState(\n    state: FormSubmissionState,\n    translator: Translator\n  ) {\n    const value = this.getFormValueFromState(state)\n\n    return this.getDisplayStringFromFormValue(value, translator)\n  }\n\n  getContextValueFromFormValue(\n    value: MonthYearState | undefined\n  ): string | null {\n    if (\n      !value ||\n      !isValid(\n        parseStrictDate(\n          value,\n          `${value.year}-${value.month}-01`,\n          'yyyy-MM-dd',\n          new Date()\n        )\n      )\n    ) {\n      return null\n    }\n\n    return format(`${value.year}-${value.month}-01`, 'yyyy-MM')\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\n    return this.getContextValueFromFormValue(value)\n  }\n\n  getValidationMessagesOverride(translator: Translator) {\n    const { t } = translator\n    return convertToLanguageMessages({\n      'any.required': buildValidationMessages(t).objectMissing,\n      'number.base': buildValidationMessages(t).objectMissing,\n      'number.precision': buildValidationMessages(t).dateFormat,\n      'number.integer': buildValidationMessages(t).dateFormat,\n      'number.unsafe': buildValidationMessages(t).dateFormat,\n      'number.min': buildValidationMessages(t).dateFormat,\n      'number.max': buildValidationMessages(t).dateFormat\n    })\n  }\n\n  getViewModel(context: RenderContext) {\n    const { errors } = context\n    const { collection, name } = this\n\n    const viewModel = super.getViewModel(context)\n    let { fieldset, 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(context)\n      .map(({ model }) => {\n        let { label, type, value, classes, errorMessage } = model\n\n        if (label) {\n          label.toString = () => label.text // Date component uses 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        }\n      })\n\n    fieldset ??= {\n      legend: {\n        text: label.text,\n        classes: 'govuk-fieldset__legend--m'\n      }\n    }\n\n    return {\n      ...viewModel,\n      fieldset,\n      items\n    }\n  }\n\n  isState(value?: FormStateValue | FormState) {\n    return MonthYearField.isMonthYear(value)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return MonthYearField.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: 'dateFormatMonth',\n          template: '{{#label}} must include a month'\n        },\n        { type: 'dateFormatYear', template: '{{#label}} must include a year' }\n      ],\n      advancedSettingsErrors: [\n        { type: 'dateEarliest', template: messageTemplate.dateMin },\n        { type: 'dateLatest', template: messageTemplate.dateMax }\n      ]\n    }\n  }\n\n  static isMonthYear(\n    value?: FormStateValue | FormState\n  ): value is MonthYearState {\n    return (\n      isFormState(value) &&\n      NumberField.isNumber(value.month) &&\n      NumberField.isNumber(value.year)\n    )\n  }\n}\n\nexport function getValidatorMonthYear(component: MonthYearField) {\n  const validator: CustomValidator = (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    const date = parse(\n      `${values.year}-${values.month}-01`,\n      'yyyy-MM-dd',\n      new Date()\n    )\n\n    if (!isValid(date)) {\n      return helpers.error('date.format', context)\n    }\n\n    // Minimum date from today\n    const earliestDate = options.earliestMonthYear\n      ? new Date(`${options.earliestMonthYear}-01`)\n      : undefined\n\n    if (earliestDate && date < earliestDate) {\n      return helpers.error('date.min', { ...context, limit: earliestDate })\n    }\n\n    // Maximum date from today\n    const latestDate = options.latestMonthYear\n      ? new Date(`${options.latestMonthYear}-01`)\n      : undefined\n\n    if (latestDate && date > latestDate) {\n      return helpers.error('date.max', { ...context, limit: latestDate })\n    }\n\n    return payload\n  }\n\n  return validator\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAAsC,oBAAoB;AAChF,SAASC,MAAM,EAAEC,OAAO,EAAEC,KAAK,QAAQ,UAAU;AAQjD,SAASC,mBAAmB;AAC5B,SACEC,aAAa,EACbC,WAAW,EACXC,WAAW;AAEb,SAASC,WAAW;AAMpB,SAASC,eAAe;AACxB,SAASC,uBAAuB;AAEhC,SAASC,eAAe;AAQxB,SAASC,yBAAyB;AAElC,OAAO,MAAMC,cAAc,SAASR,aAAa,CAAC;EAMhDS,WAAWA,CACTC,GAA4B,EAC5BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,IAAI;MAAEC;IAAQ,CAAC,GAAGH,GAAG;IAE7B,MAAMI,UAAU,GAAGD,OAAO,CAACE,QAAQ,KAAK,KAAK;IAE7C,MAAMC,wBAA0C,GAC9CT,yBAAyB,CAAC;MACxB,cAAc,EAAED,eAAe,CAACW,aAAa;MAC7C,aAAa,EAAEX,eAAe,CAACW,aAAa;MAC5C,kBAAkB,EAAEX,eAAe,CAACY,UAAU;MAC9C,gBAAgB,EAAEZ,eAAe,CAACY,UAAU;MAC5C,eAAe,EAAEZ,eAAe,CAACY,UAAU;MAC3C,YAAY,EAAEZ,eAAe,CAACY,UAAU;MACxC,YAAY,EAAEZ,eAAe,CAACY;IAChC,CAAC,CAAC;IAEJ,IAAI,CAACC,UAAU,GAAG,IAAIpB,mBAAmB,CACvC,CACE;MACEqB,IAAI,EAAEzB,aAAa,CAACQ,WAAW;MAC/BS,IAAI,EAAE,GAAGA,IAAI,SAAS;MACtBS,KAAK,EAAE,iCAAiC;MACxCC,MAAM,EAAE;QAAEC,GAAG,EAAE,CAAC;QAAEC,GAAG,EAAE,EAAE;QAAEC,SAAS,EAAE;MAAE,CAAC;MACzCZ,OAAO,EAAE;QACPE,QAAQ,EAAED,UAAU;QACpBY,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,sBAAsB;QAC/BX;MACF;IACF,CAAC,EACD;MACEI,IAAI,EAAEzB,aAAa,CAACQ,WAAW;MAC/BS,IAAI,EAAE,GAAGA,IAAI,QAAQ;MACrBS,KAAK,EAAE,gCAAgC;MACvCC,MAAM,EAAE;QAAEC,GAAG,EAAE,IAAI;QAAEC,GAAG,EAAE,IAAI;QAAEC,SAAS,EAAE;MAAE,CAAC;MAC9CZ,OAAO,EAAE;QACPE,QAAQ,EAAED,UAAU;QACpBY,YAAY,EAAE,IAAI;QAClBC,OAAO,EAAE,sBAAsB;QAC/BX;MACF;IACF,CAAC,CACF,EACD;MAAE,GAAGL,KAAK;MAAEiB,MAAM,EAAE;IAAK,CAAC,EAC1B;MACEC,MAAM,EAAEC,qBAAqB,CAAC,IAAI,CAAC;MACnCC,KAAK,EAAE,CAAC,GAAGnB,IAAI,SAAS,EAAE,GAAGA,IAAI,QAAQ;IAC3C,CACF,CAAC;IAED,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACmB,UAAU,GAAG,IAAI,CAACb,UAAU,CAACa,UAAU;IAC5C,IAAI,CAACC,WAAW,GAAG,IAAI,CAACd,UAAU,CAACc,WAAW;EAChD;EAEAC,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAMC,KAAK,GAAG,KAAK,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAChD,OAAO3B,cAAc,CAAC6B,WAAW,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAC9D;EAEAC,6BAA6BA,CAC3BH,KAAiC,EACjCI,WAAuB,EACf;IACR,IAAI,CAACJ,KAAK,EAAE;MACV,OAAO,EAAE;IACX;IAEA,MAAMK,IAAI,GAAG,IAAIC,IAAI,CAAC,CAAC;IACvBD,IAAI,CAACE,QAAQ,CAACP,KAAK,CAACQ,KAAK,GAAG,CAAC,CAAC;IAE9B,MAAMC,WAAW,GAAGJ,IAAI,CAACK,cAAc,CAAC,SAAS,EAAE;MAAEF,KAAK,EAAE;IAAO,CAAC,CAAC;IACrE,OAAO,GAAGC,WAAW,IAAIT,KAAK,CAACW,IAAI,EAAE;EACvC;EAEAC,yBAAyBA,CACvBb,KAA0B,EAC1Bc,UAAsB,EACtB;IACA,MAAMb,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACI,6BAA6B,CAACH,KAAK,EAAEa,UAAU,CAAC;EAC9D;EAEAC,4BAA4BA,CAC1Bd,KAAiC,EAClB;IACf,IACE,CAACA,KAAK,IACN,CAACvC,OAAO,CACNO,eAAe,CACbgC,KAAK,EACL,GAAGA,KAAK,CAACW,IAAI,IAAIX,KAAK,CAACQ,KAAK,KAAK,EACjC,YAAY,EACZ,IAAIF,IAAI,CAAC,CACX,CACF,CAAC,EACD;MACA,OAAO,IAAI;IACb;IAEA,OAAO9C,MAAM,CAAC,GAAGwC,KAAK,CAACW,IAAI,IAAIX,KAAK,CAACQ,KAAK,KAAK,EAAE,SAAS,CAAC;EAC7D;EAEAO,wBAAwBA,CAAChB,KAA0B,EAAE;IACnD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,OAAO,IAAI,CAACe,4BAA4B,CAACd,KAAK,CAAC;EACjD;EAEAgB,6BAA6BA,CAACH,UAAsB,EAAE;IACpD,MAAM;MAAEI;IAAE,CAAC,GAAGJ,UAAU;IACxB,OAAO1C,yBAAyB,CAAC;MAC/B,cAAc,EAAEF,uBAAuB,CAACgD,CAAC,CAAC,CAACpC,aAAa;MACxD,aAAa,EAAEZ,uBAAuB,CAACgD,CAAC,CAAC,CAACpC,aAAa;MACvD,kBAAkB,EAAEZ,uBAAuB,CAACgD,CAAC,CAAC,CAACnC,UAAU;MACzD,gBAAgB,EAAEb,uBAAuB,CAACgD,CAAC,CAAC,CAACnC,UAAU;MACvD,eAAe,EAAEb,uBAAuB,CAACgD,CAAC,CAAC,CAACnC,UAAU;MACtD,YAAY,EAAEb,uBAAuB,CAACgD,CAAC,CAAC,CAACnC,UAAU;MACnD,YAAY,EAAEb,uBAAuB,CAACgD,CAAC,CAAC,CAACnC;IAC3C,CAAC,CAAC;EACJ;EAEAoC,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAM;MAAEC;IAAO,CAAC,GAAGD,OAAO;IAC1B,MAAM;MAAEpC,UAAU;MAAEP;IAAK,CAAC,GAAG,IAAI;IAEjC,MAAM6C,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,CAAC;IAC7C,IAAI;MAAEG,QAAQ;MAAEC;IAAM,CAAC,GAAGF,SAAS;;IAEnC;IACA,MAAMG,QAAQ,GAAGJ,MAAM,EAAEK,IAAI,CAAEC,KAAK,IAAKA,KAAK,CAAClD,IAAI,KAAKA,IAAI,CAAC;;IAE7D;IACA,MAAMmD,KAAsB,GAAG5C,UAAU,CACtCmC,YAAY,CAACC,OAAO,CAAC,CACrBS,GAAG,CAAC,CAAC;MAAEC;IAAM,CAAC,KAAK;MAClB,IAAI;QAAEN,KAAK;QAAEvC,IAAI;QAAEgB,KAAK;QAAET,OAAO;QAAEuC;MAAa,CAAC,GAAGD,KAAK;MAEzD,IAAIN,KAAK,EAAE;QACTA,KAAK,CAACQ,QAAQ,GAAG,MAAMR,KAAK,CAACS,IAAI,EAAC;MACpC;MAEA,IAAIR,QAAQ,IAAIM,YAAY,EAAE;QAC5BvC,OAAO,GAAG,GAAGA,OAAO,qBAAqB,CAAC0C,IAAI,CAAC,CAAC;MAClD;;MAEA;MACA;MACA,IAAI,CAACnE,WAAW,CAACkC,KAAK,CAAC,EAAE;QACvBA,KAAK,GAAGE,SAAS;MACnB;MAEA,OAAO;QACLqB,KAAK;QACLW,EAAE,EAAEL,KAAK,CAACK,EAAE;QACZ1D,IAAI,EAAEqD,KAAK,CAACrD,IAAI;QAChBQ,IAAI;QACJgB,KAAK;QACLT;MACF,CAAC;IACH,CAAC,CAAC;IAEJ+B,QAAQ,KAAK;MACXa,MAAM,EAAE;QACNH,IAAI,EAAET,KAAK,CAACS,IAAI;QAChBzC,OAAO,EAAE;MACX;IACF,CAAC;IAED,OAAO;MACL,GAAG8B,SAAS;MACZC,QAAQ;MACRK;IACF,CAAC;EACH;EAEAS,OAAOA,CAACpC,KAAkC,EAAE;IAC1C,OAAO5B,cAAc,CAAC6B,WAAW,CAACD,KAAK,CAAC;EAC1C;;EAEA;AACF;AACA;EACEqC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOjE,cAAc,CAACiE,oBAAoB,CAAC,CAAC;EAC9C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEtD,IAAI,EAAE,UAAU;QAAEuD,QAAQ,EAAErE,eAAe,CAACS;MAAS,CAAC,EACxD;QACEK,IAAI,EAAE,iBAAiB;QACvBuD,QAAQ,EAAE;MACZ,CAAC,EACD;QAAEvD,IAAI,EAAE,gBAAgB;QAAEuD,QAAQ,EAAE;MAAiC,CAAC,CACvE;MACDC,sBAAsB,EAAE,CACtB;QAAExD,IAAI,EAAE,cAAc;QAAEuD,QAAQ,EAAErE,eAAe,CAACuE;MAAQ,CAAC,EAC3D;QAAEzD,IAAI,EAAE,YAAY;QAAEuD,QAAQ,EAAErE,eAAe,CAACwE;MAAQ,CAAC;IAE7D,CAAC;EACH;EAEA,OAAOzC,WAAWA,CAChBD,KAAkC,EACT;IACzB,OACEnC,WAAW,CAACmC,KAAK,CAAC,IAClBjC,WAAW,CAAC4E,QAAQ,CAAC3C,KAAK,CAACQ,KAAK,CAAC,IACjCzC,WAAW,CAAC4E,QAAQ,CAAC3C,KAAK,CAACW,IAAI,CAAC;EAEpC;AACF;AAEA,OAAO,SAASjB,qBAAqBA,CAACkD,SAAyB,EAAE;EAC/D,MAAMC,SAA0B,GAAGA,CAACC,OAAoB,EAAEC,OAAO,KAAK;IACpE,MAAM;MAAEhE,UAAU;MAAEP,IAAI;MAAEC;IAAQ,CAAC,GAAGmE,SAAS;IAE/C,MAAMI,MAAM,GAAGJ,SAAS,CAAC9C,qBAAqB,CAC5C8C,SAAS,CAACK,qBAAqB,CAACH,OAAO,CACzC,CAAC;IAED,MAAM3B,OAAgB,GAAG;MACvB+B,OAAO,EAAEnE,UAAU,CAACoE,IAAI;MACxBC,GAAG,EAAE5E;IACP,CAAC;IAED,IAAI,CAACoE,SAAS,CAACR,OAAO,CAACY,MAAM,CAAC,EAAE;MAC9B,OAAOvE,OAAO,CAACE,QAAQ,KAAK,KAAK,GAC7BoE,OAAO,CAACrB,KAAK,CAAC,iBAAiB,EAAEP,OAAO,CAAC,GACzC2B,OAAO;IACb;IAEA,MAAMzC,IAAI,GAAG3C,KAAK,CAChB,GAAGsF,MAAM,CAACrC,IAAI,IAAIqC,MAAM,CAACxC,KAAK,KAAK,EACnC,YAAY,EACZ,IAAIF,IAAI,CAAC,CACX,CAAC;IAED,IAAI,CAAC7C,OAAO,CAAC4C,IAAI,CAAC,EAAE;MAClB,OAAO0C,OAAO,CAACrB,KAAK,CAAC,aAAa,EAAEP,OAAO,CAAC;IAC9C;;IAEA;IACA,MAAMkC,YAAY,GAAG5E,OAAO,CAAC6E,iBAAiB,GAC1C,IAAIhD,IAAI,CAAC,GAAG7B,OAAO,CAAC6E,iBAAiB,KAAK,CAAC,GAC3CpD,SAAS;IAEb,IAAImD,YAAY,IAAIhD,IAAI,GAAGgD,YAAY,EAAE;MACvC,OAAON,OAAO,CAACrB,KAAK,CAAC,UAAU,EAAE;QAAE,GAAGP,OAAO;QAAEoC,KAAK,EAAEF;MAAa,CAAC,CAAC;IACvE;;IAEA;IACA,MAAMG,UAAU,GAAG/E,OAAO,CAACgF,eAAe,GACtC,IAAInD,IAAI,CAAC,GAAG7B,OAAO,CAACgF,eAAe,KAAK,CAAC,GACzCvD,SAAS;IAEb,IAAIsD,UAAU,IAAInD,IAAI,GAAGmD,UAAU,EAAE;MACnC,OAAOT,OAAO,CAACrB,KAAK,CAAC,UAAU,EAAE;QAAE,GAAGP,OAAO;QAAEoC,KAAK,EAAEC;MAAW,CAAC,CAAC;IACrE;IAEA,OAAOV,OAAO;EAChB,CAAC;EAED,OAAOD,SAAS;AAClB","ignoreList":[]}

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

@@ -2,7 +2,8 @@ import { type MultilineTextFieldComponent } from '@defra/forms-model';
 import { type StringSchema } from 'joi';
 import { type ComponentBase } from '../../../../server/plugins/engine/components/ComponentBase.js';
 import { FormComponent } from '../../../../server/plugins/engine/components/FormComponent.js';
-import { type ErrorMessageTemplateList, type FormPayload, type FormSubmissionError } from '../../../../server/plugins/engine/types.js';
+import { type RenderContext } from '../../../../server/plugins/engine/components/types.js';
+import { type ErrorMessageTemplateList } from '../../../../server/plugins/engine/types.js';
 export declare class MultilineTextField extends FormComponent {
     options: MultilineTextFieldComponent['options'];
     schema: MultilineTextFieldComponent['schema'];
@@ -10,7 +11,7 @@ export declare class MultilineTextField extends FormComponent {
     stateSchema: StringSchema;
     isCharacterOrWordCount: boolean;
     constructor(def: MultilineTextFieldComponent, props: ConstructorParameters<typeof ComponentBase>[1]);
-    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+    getViewModel(context: RenderContext): {
         isCharacterOrWordCount: boolean;
         maxlength: number | undefined;
         maxwords: number | undefined;
@@ -26,11 +27,11 @@ export declare class MultilineTextField extends FormComponent {
             id?: string;
             text: string;
         };
-        prefix?: import("./types.js").ComponentText;
-        suffix?: import("./types.js").ComponentText;
+        prefix?: import("../../../../server/plugins/engine/components/types.js").ComponentText;
+        suffix?: import("../../../../server/plugins/engine/components/types.js").ComponentText;
         classes?: string;
         condition?: string;
-        errors?: FormSubmissionError[];
+        errors?: import("../../../../server/plugins/engine/types.js").FormSubmissionError[];
         errorMessage?: {
             text: string;
         };
@@ -43,18 +44,18 @@ export declare class MultilineTextField extends FormComponent {
             accept?: string;
             inputmode?: string;
         };
-        content?: import("./types.js").Content | import("./types.js").Content[] | string;
-        items?: import("./types.js").ListItem[] | import("./types.js").DateInputItem[];
+        content?: import("../../../../server/plugins/engine/components/types.js").Content | import("../../../../server/plugins/engine/components/types.js").Content[] | string;
+        items?: import("../../../../server/plugins/engine/components/types.js").ListItem[] | import("../../../../server/plugins/engine/components/types.js").DateInputItem[];
         fieldset?: {
             attributes?: string | Record<string, string>;
-            legend?: import("./types.js").Label;
+            legend?: import("../../../../server/plugins/engine/components/types.js").Label;
         };
         formGroup?: {
             classes?: string;
             attributes?: string | Record<string, string>;
         };
         showFieldsetError?: boolean;
-        components?: import("./types.js").ComponentViewModel[];
+        components?: import("../../../../server/plugins/engine/components/types.js").ComponentViewModel[];
         upload?: {
             count: number;
             summaryList: import("../../../../server/plugins/engine/types.js").SummaryList;

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

@@ -54,13 +54,13 @@ export class MultilineTextField extends FormComponent {
     this.options = options;
     this.schema = schema;
   }
-  getViewModel(payload, errors) {
+  getViewModel(context) {
     const {
       schema,
       options,
       isCharacterOrWordCount
     } = this;
-    const viewModel = super.getViewModel(payload, errors);
+    const viewModel = super.getViewModel(context);
     let {
       maxlength,
       maxwords,

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

@@ -1 +1 @@
-{"version":3,"file":"MultilineTextField.js","names":["Joi","FormComponent","messageTemplate","MultilineTextField","isCharacterOrWordCount","constructor","def","props","schema","options","formSchema","string","replace","trim","label","required","allow","length","max","min","maxWords","custom","getValidatorMaxWords","regex","pattern","RegExp","customValidationMessage","message","messages","customValidationMessages","minMaxErrorText","buildMinMaxText","ruleset","default","stateSchema","getViewModel","payload","errors","viewModel","maxlength","maxwords","rows","minMaxError","minMax","toString","getAllPossibleErrors","staticErrors","advancedSettingsErrors","type","template","baseErrors","component","validator","value","helpers","limit","count","error","text","tokens","match"],"sources":["../../../../../src/server/plugins/engine/components/MultilineTextField.ts"],"sourcesContent":["import { type MultilineTextFieldComponent } from '@defra/forms-model'\nimport Joi, { type CustomValidator, type StringSchema } from 'joi'\n\nimport { type ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js'\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\n\nexport class MultilineTextField extends FormComponent {\n  declare options: MultilineTextFieldComponent['options']\n  declare schema: MultilineTextFieldComponent['schema']\n  declare formSchema: StringSchema\n  declare stateSchema: StringSchema\n\n  isCharacterOrWordCount = false\n\n  constructor(\n    def: MultilineTextFieldComponent,\n    props: ConstructorParameters<typeof ComponentBase>[1]\n  ) {\n    super(def, props)\n\n    const { schema, options } = def\n\n    let formSchema = Joi.string()\n      .replace(/\\r\\n/g, '\\n')\n      .trim()\n      .label(this.label)\n      .required()\n\n    if (options.required === false) {\n      formSchema = formSchema.allow('')\n    }\n\n    if (typeof schema.length !== 'number') {\n      if (typeof schema.max === 'number') {\n        formSchema = formSchema.max(schema.max)\n        this.isCharacterOrWordCount = true\n      }\n\n      if (typeof schema.min === 'number') {\n        formSchema = formSchema.min(schema.min)\n      }\n    } else {\n      formSchema = formSchema.length(schema.length)\n    }\n\n    if (typeof options.maxWords === 'number') {\n      formSchema = formSchema.custom(\n        getValidatorMaxWords(this),\n        'max words validation'\n      )\n\n      this.isCharacterOrWordCount = true\n    }\n\n    if (schema.regex) {\n      const pattern = new RegExp(schema.regex)\n      formSchema = formSchema.pattern(pattern)\n    }\n\n    if (options.customValidationMessage) {\n      const message = options.customValidationMessage\n\n      formSchema = formSchema.messages({\n        'any.required': message,\n        'string.empty': message,\n        'string.max': message,\n        'string.min': message,\n        'string.length': message,\n        'string.pattern.base': message,\n        'string.maxWords': message\n      })\n    } else if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    } else if (\n      typeof schema.max === 'number' &&\n      typeof schema.min === 'number'\n    ) {\n      const minMaxErrorText = this.buildMinMaxText(schema.min, schema.max)\n      formSchema = formSchema.ruleset\n        .min(schema.min)\n        .max(schema.max)\n        .message(minMaxErrorText)\n    }\n\n    this.formSchema = formSchema.default('')\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n    this.schema = schema\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const { schema, options, isCharacterOrWordCount } = this\n\n    const viewModel = super.getViewModel(payload, errors)\n    let { maxlength, maxwords, rows } = viewModel\n\n    if (schema.max) {\n      maxlength = schema.max\n    }\n\n    if (options.maxWords) {\n      maxwords = options.maxWords\n    }\n\n    if (options.rows) {\n      rows = options.rows\n    }\n\n    return {\n      ...viewModel,\n      isCharacterOrWordCount,\n      maxlength,\n      maxwords,\n      rows\n    }\n  }\n\n  buildMinMaxText(min?: number, max?: number): string {\n    const minMaxError = messageTemplate.minMax as string\n    return minMaxError\n      .replace('{{#min}}', min ? min.toString() : '[min length]')\n      .replace('{{#max}}', max ? max.toString() : '[max length]')\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    const staticErrors = MultilineTextField.getAllPossibleErrors()\n    return {\n      ...staticErrors,\n      advancedSettingsErrors: [\n        ...staticErrors.advancedSettingsErrors,\n        {\n          type: 'minMax',\n          template: this.buildMinMaxText(this.schema.min, this.schema.max)\n        }\n      ]\n    }\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [{ type: 'required', template: messageTemplate.required }],\n      advancedSettingsErrors: [\n        { type: 'min', template: messageTemplate.min },\n        { type: 'max', template: messageTemplate.max }\n      ]\n    }\n  }\n}\n\nfunction getValidatorMaxWords(component: MultilineTextField) {\n  const validator: CustomValidator = (value: string, helpers) => {\n    const { options } = component\n\n    const {\n      customValidationMessage: custom,\n      maxWords: limit // See {{#limit}} variable\n    } = options\n\n    if (!limit || count(value) <= limit) {\n      return value\n    }\n\n    return custom\n      ? helpers.message({ custom }, { limit })\n      : helpers.error('string.maxWords', { limit })\n  }\n\n  /**\n   * Count the number of words in the given text\n   * @see GOV.UK Frontend {@link https://github.com/alphagov/govuk-frontend/blob/v5.4.0/packages/govuk-frontend/src/govuk/components/character-count/character-count.mjs#L343 | Character count `maxwords` implementation}\n   */\n  function count(text: string) {\n    const tokens = text.match(/\\S+/g) ?? []\n    return tokens.length\n  }\n\n  return validator\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAAmD,KAAK;AAGlE,SAASC,aAAa;AACtB,SAASC,eAAe;AAOxB,OAAO,MAAMC,kBAAkB,SAASF,aAAa,CAAC;EAMpDG,sBAAsB,GAAG,KAAK;EAE9BC,WAAWA,CACTC,GAAgC,EAChCC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,MAAM;MAAEC;IAAQ,CAAC,GAAGH,GAAG;IAE/B,IAAII,UAAU,GAAGV,GAAG,CAACW,MAAM,CAAC,CAAC,CAC1BC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CACtBC,IAAI,CAAC,CAAC,CACNC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,QAAQ,CAAC,CAAC;IAEb,IAAIN,OAAO,CAACM,QAAQ,KAAK,KAAK,EAAE;MAC9BL,UAAU,GAAGA,UAAU,CAACM,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAI,OAAOR,MAAM,CAACS,MAAM,KAAK,QAAQ,EAAE;MACrC,IAAI,OAAOT,MAAM,CAACU,GAAG,KAAK,QAAQ,EAAE;QAClCR,UAAU,GAAGA,UAAU,CAACQ,GAAG,CAACV,MAAM,CAACU,GAAG,CAAC;QACvC,IAAI,CAACd,sBAAsB,GAAG,IAAI;MACpC;MAEA,IAAI,OAAOI,MAAM,CAACW,GAAG,KAAK,QAAQ,EAAE;QAClCT,UAAU,GAAGA,UAAU,CAACS,GAAG,CAACX,MAAM,CAACW,GAAG,CAAC;MACzC;IACF,CAAC,MAAM;MACLT,UAAU,GAAGA,UAAU,CAACO,MAAM,CAACT,MAAM,CAACS,MAAM,CAAC;IAC/C;IAEA,IAAI,OAAOR,OAAO,CAACW,QAAQ,KAAK,QAAQ,EAAE;MACxCV,UAAU,GAAGA,UAAU,CAACW,MAAM,CAC5BC,oBAAoB,CAAC,IAAI,CAAC,EAC1B,sBACF,CAAC;MAED,IAAI,CAAClB,sBAAsB,GAAG,IAAI;IACpC;IAEA,IAAII,MAAM,CAACe,KAAK,EAAE;MAChB,MAAMC,OAAO,GAAG,IAAIC,MAAM,CAACjB,MAAM,CAACe,KAAK,CAAC;MACxCb,UAAU,GAAGA,UAAU,CAACc,OAAO,CAACA,OAAO,CAAC;IAC1C;IAEA,IAAIf,OAAO,CAACiB,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGlB,OAAO,CAACiB,uBAAuB;MAE/ChB,UAAU,GAAGA,UAAU,CAACkB,QAAQ,CAAC;QAC/B,cAAc,EAAED,OAAO;QACvB,cAAc,EAAEA,OAAO;QACvB,YAAY,EAAEA,OAAO;QACrB,YAAY,EAAEA,OAAO;QACrB,eAAe,EAAEA,OAAO;QACxB,qBAAqB,EAAEA,OAAO;QAC9B,iBAAiB,EAAEA;MACrB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIlB,OAAO,CAACoB,wBAAwB,EAAE;MAC3CnB,UAAU,GAAGA,UAAU,CAACkB,QAAQ,CAACnB,OAAO,CAACoB,wBAAwB,CAAC;IACpE,CAAC,MAAM,IACL,OAAOrB,MAAM,CAACU,GAAG,KAAK,QAAQ,IAC9B,OAAOV,MAAM,CAACW,GAAG,KAAK,QAAQ,EAC9B;MACA,MAAMW,eAAe,GAAG,IAAI,CAACC,eAAe,CAACvB,MAAM,CAACW,GAAG,EAAEX,MAAM,CAACU,GAAG,CAAC;MACpER,UAAU,GAAGA,UAAU,CAACsB,OAAO,CAC5Bb,GAAG,CAACX,MAAM,CAACW,GAAG,CAAC,CACfD,GAAG,CAACV,MAAM,CAACU,GAAG,CAAC,CACfS,OAAO,CAACG,eAAe,CAAC;IAC7B;IAEA,IAAI,CAACpB,UAAU,GAAGA,UAAU,CAACuB,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGxB,UAAU,CAACuB,OAAO,CAAC,IAAI,CAAC,CAACjB,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACP,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACD,MAAM,GAAGA,MAAM;EACtB;EAEA2B,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAM;MAAE7B,MAAM;MAAEC,OAAO;MAAEL;IAAuB,CAAC,GAAG,IAAI;IAExD,MAAMkC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,IAAI;MAAEE,SAAS;MAAEC,QAAQ;MAAEC;IAAK,CAAC,GAAGH,SAAS;IAE7C,IAAI9B,MAAM,CAACU,GAAG,EAAE;MACdqB,SAAS,GAAG/B,MAAM,CAACU,GAAG;IACxB;IAEA,IAAIT,OAAO,CAACW,QAAQ,EAAE;MACpBoB,QAAQ,GAAG/B,OAAO,CAACW,QAAQ;IAC7B;IAEA,IAAIX,OAAO,CAACgC,IAAI,EAAE;MAChBA,IAAI,GAAGhC,OAAO,CAACgC,IAAI;IACrB;IAEA,OAAO;MACL,GAAGH,SAAS;MACZlC,sBAAsB;MACtBmC,SAAS;MACTC,QAAQ;MACRC;IACF,CAAC;EACH;EAEAV,eAAeA,CAACZ,GAAY,EAAED,GAAY,EAAU;IAClD,MAAMwB,WAAW,GAAGxC,eAAe,CAACyC,MAAgB;IACpD,OAAOD,WAAW,CACf9B,OAAO,CAAC,UAAU,EAAEO,GAAG,GAAGA,GAAG,CAACyB,QAAQ,CAAC,CAAC,GAAG,cAAc,CAAC,CAC1DhC,OAAO,CAAC,UAAU,EAAEM,GAAG,GAAGA,GAAG,CAAC0B,QAAQ,CAAC,CAAC,GAAG,cAAc,CAAC;EAC/D;;EAEA;AACF;AACA;EACEC,oBAAoBA,CAAA,EAA6B;IAC/C,MAAMC,YAAY,GAAG3C,kBAAkB,CAAC0C,oBAAoB,CAAC,CAAC;IAC9D,OAAO;MACL,GAAGC,YAAY;MACfC,sBAAsB,EAAE,CACtB,GAAGD,YAAY,CAACC,sBAAsB,EACtC;QACEC,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAE,IAAI,CAAClB,eAAe,CAAC,IAAI,CAACvB,MAAM,CAACW,GAAG,EAAE,IAAI,CAACX,MAAM,CAACU,GAAG;MACjE,CAAC;IAEL,CAAC;EACH;;EAEA;AACF;AACA;EACE,OAAO2B,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLK,UAAU,EAAE,CAAC;QAAEF,IAAI,EAAE,UAAU;QAAEC,QAAQ,EAAE/C,eAAe,CAACa;MAAS,CAAC,CAAC;MACtEgC,sBAAsB,EAAE,CACtB;QAAEC,IAAI,EAAE,KAAK;QAAEC,QAAQ,EAAE/C,eAAe,CAACiB;MAAI,CAAC,EAC9C;QAAE6B,IAAI,EAAE,KAAK;QAAEC,QAAQ,EAAE/C,eAAe,CAACgB;MAAI,CAAC;IAElD,CAAC;EACH;AACF;AAEA,SAASI,oBAAoBA,CAAC6B,SAA6B,EAAE;EAC3D,MAAMC,SAA0B,GAAGA,CAACC,KAAa,EAAEC,OAAO,KAAK;IAC7D,MAAM;MAAE7C;IAAQ,CAAC,GAAG0C,SAAS;IAE7B,MAAM;MACJzB,uBAAuB,EAAEL,MAAM;MAC/BD,QAAQ,EAAEmC,KAAK,CAAC;IAClB,CAAC,GAAG9C,OAAO;IAEX,IAAI,CAAC8C,KAAK,IAAIC,KAAK,CAACH,KAAK,CAAC,IAAIE,KAAK,EAAE;MACnC,OAAOF,KAAK;IACd;IAEA,OAAOhC,MAAM,GACTiC,OAAO,CAAC3B,OAAO,CAAC;MAAEN;IAAO,CAAC,EAAE;MAAEkC;IAAM,CAAC,CAAC,GACtCD,OAAO,CAACG,KAAK,CAAC,iBAAiB,EAAE;MAAEF;IAAM,CAAC,CAAC;EACjD,CAAC;;EAED;AACF;AACA;AACA;EACE,SAASC,KAAKA,CAACE,IAAY,EAAE;IAC3B,MAAMC,MAAM,GAAGD,IAAI,CAACE,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE;IACvC,OAAOD,MAAM,CAAC1C,MAAM;EACtB;EAEA,OAAOmC,SAAS;AAClB","ignoreList":[]}
+{"version":3,"file":"MultilineTextField.js","names":["Joi","FormComponent","messageTemplate","MultilineTextField","isCharacterOrWordCount","constructor","def","props","schema","options","formSchema","string","replace","trim","label","required","allow","length","max","min","maxWords","custom","getValidatorMaxWords","regex","pattern","RegExp","customValidationMessage","message","messages","customValidationMessages","minMaxErrorText","buildMinMaxText","ruleset","default","stateSchema","getViewModel","context","viewModel","maxlength","maxwords","rows","minMaxError","minMax","toString","getAllPossibleErrors","staticErrors","advancedSettingsErrors","type","template","baseErrors","component","validator","value","helpers","limit","count","error","text","tokens","match"],"sources":["../../../../../src/server/plugins/engine/components/MultilineTextField.ts"],"sourcesContent":["import { type MultilineTextFieldComponent } from '@defra/forms-model'\nimport Joi, { type CustomValidator, type StringSchema } from 'joi'\n\nimport { type ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js'\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type RenderContext } from '~/src/server/plugins/engine/components/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport { type ErrorMessageTemplateList } from '~/src/server/plugins/engine/types.js'\n\nexport class MultilineTextField extends FormComponent {\n  declare options: MultilineTextFieldComponent['options']\n  declare schema: MultilineTextFieldComponent['schema']\n  declare formSchema: StringSchema\n  declare stateSchema: StringSchema\n\n  isCharacterOrWordCount = false\n\n  constructor(\n    def: MultilineTextFieldComponent,\n    props: ConstructorParameters<typeof ComponentBase>[1]\n  ) {\n    super(def, props)\n\n    const { schema, options } = def\n\n    let formSchema = Joi.string()\n      .replace(/\\r\\n/g, '\\n')\n      .trim()\n      .label(this.label)\n      .required()\n\n    if (options.required === false) {\n      formSchema = formSchema.allow('')\n    }\n\n    if (typeof schema.length !== 'number') {\n      if (typeof schema.max === 'number') {\n        formSchema = formSchema.max(schema.max)\n        this.isCharacterOrWordCount = true\n      }\n\n      if (typeof schema.min === 'number') {\n        formSchema = formSchema.min(schema.min)\n      }\n    } else {\n      formSchema = formSchema.length(schema.length)\n    }\n\n    if (typeof options.maxWords === 'number') {\n      formSchema = formSchema.custom(\n        getValidatorMaxWords(this),\n        'max words validation'\n      )\n\n      this.isCharacterOrWordCount = true\n    }\n\n    if (schema.regex) {\n      const pattern = new RegExp(schema.regex)\n      formSchema = formSchema.pattern(pattern)\n    }\n\n    if (options.customValidationMessage) {\n      const message = options.customValidationMessage\n\n      formSchema = formSchema.messages({\n        'any.required': message,\n        'string.empty': message,\n        'string.max': message,\n        'string.min': message,\n        'string.length': message,\n        'string.pattern.base': message,\n        'string.maxWords': message\n      })\n    } else if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    } else if (\n      typeof schema.max === 'number' &&\n      typeof schema.min === 'number'\n    ) {\n      const minMaxErrorText = this.buildMinMaxText(schema.min, schema.max)\n      formSchema = formSchema.ruleset\n        .min(schema.min)\n        .max(schema.max)\n        .message(minMaxErrorText)\n    }\n\n    this.formSchema = formSchema.default('')\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n    this.schema = schema\n  }\n\n  getViewModel(context: RenderContext) {\n    const { schema, options, isCharacterOrWordCount } = this\n\n    const viewModel = super.getViewModel(context)\n    let { maxlength, maxwords, rows } = viewModel\n\n    if (schema.max) {\n      maxlength = schema.max\n    }\n\n    if (options.maxWords) {\n      maxwords = options.maxWords\n    }\n\n    if (options.rows) {\n      rows = options.rows\n    }\n\n    return {\n      ...viewModel,\n      isCharacterOrWordCount,\n      maxlength,\n      maxwords,\n      rows\n    }\n  }\n\n  buildMinMaxText(min?: number, max?: number): string {\n    const minMaxError = messageTemplate.minMax\n    return minMaxError\n      .replace('{{#min}}', min ? min.toString() : '[min length]')\n      .replace('{{#max}}', max ? max.toString() : '[max length]')\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    const staticErrors = MultilineTextField.getAllPossibleErrors()\n    return {\n      ...staticErrors,\n      advancedSettingsErrors: [\n        ...staticErrors.advancedSettingsErrors,\n        {\n          type: 'minMax',\n          template: this.buildMinMaxText(this.schema.min, this.schema.max)\n        }\n      ]\n    }\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [{ type: 'required', template: messageTemplate.required }],\n      advancedSettingsErrors: [\n        { type: 'min', template: messageTemplate.min },\n        { type: 'max', template: messageTemplate.max }\n      ]\n    }\n  }\n}\n\nfunction getValidatorMaxWords(component: MultilineTextField) {\n  const validator: CustomValidator = (value: string, helpers) => {\n    const { options } = component\n\n    const {\n      customValidationMessage: custom,\n      maxWords: limit // See {{#limit}} variable\n    } = options\n\n    if (!limit || count(value) <= limit) {\n      return value\n    }\n\n    return custom\n      ? helpers.message({ custom }, { limit })\n      : helpers.error('string.maxWords', { limit })\n  }\n\n  /**\n   * Count the number of words in the given text\n   * @see GOV.UK Frontend {@link https://github.com/alphagov/govuk-frontend/blob/v5.4.0/packages/govuk-frontend/src/govuk/components/character-count/character-count.mjs#L343 | Character count `maxwords` implementation}\n   */\n  function count(text: string) {\n    const tokens = text.match(/\\S+/g) ?? []\n    return tokens.length\n  }\n\n  return validator\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAAmD,KAAK;AAGlE,SAASC,aAAa;AAEtB,SAASC,eAAe;AAGxB,OAAO,MAAMC,kBAAkB,SAASF,aAAa,CAAC;EAMpDG,sBAAsB,GAAG,KAAK;EAE9BC,WAAWA,CACTC,GAAgC,EAChCC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,MAAM;MAAEC;IAAQ,CAAC,GAAGH,GAAG;IAE/B,IAAII,UAAU,GAAGV,GAAG,CAACW,MAAM,CAAC,CAAC,CAC1BC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CACtBC,IAAI,CAAC,CAAC,CACNC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,QAAQ,CAAC,CAAC;IAEb,IAAIN,OAAO,CAACM,QAAQ,KAAK,KAAK,EAAE;MAC9BL,UAAU,GAAGA,UAAU,CAACM,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAI,OAAOR,MAAM,CAACS,MAAM,KAAK,QAAQ,EAAE;MACrC,IAAI,OAAOT,MAAM,CAACU,GAAG,KAAK,QAAQ,EAAE;QAClCR,UAAU,GAAGA,UAAU,CAACQ,GAAG,CAACV,MAAM,CAACU,GAAG,CAAC;QACvC,IAAI,CAACd,sBAAsB,GAAG,IAAI;MACpC;MAEA,IAAI,OAAOI,MAAM,CAACW,GAAG,KAAK,QAAQ,EAAE;QAClCT,UAAU,GAAGA,UAAU,CAACS,GAAG,CAACX,MAAM,CAACW,GAAG,CAAC;MACzC;IACF,CAAC,MAAM;MACLT,UAAU,GAAGA,UAAU,CAACO,MAAM,CAACT,MAAM,CAACS,MAAM,CAAC;IAC/C;IAEA,IAAI,OAAOR,OAAO,CAACW,QAAQ,KAAK,QAAQ,EAAE;MACxCV,UAAU,GAAGA,UAAU,CAACW,MAAM,CAC5BC,oBAAoB,CAAC,IAAI,CAAC,EAC1B,sBACF,CAAC;MAED,IAAI,CAAClB,sBAAsB,GAAG,IAAI;IACpC;IAEA,IAAII,MAAM,CAACe,KAAK,EAAE;MAChB,MAAMC,OAAO,GAAG,IAAIC,MAAM,CAACjB,MAAM,CAACe,KAAK,CAAC;MACxCb,UAAU,GAAGA,UAAU,CAACc,OAAO,CAACA,OAAO,CAAC;IAC1C;IAEA,IAAIf,OAAO,CAACiB,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGlB,OAAO,CAACiB,uBAAuB;MAE/ChB,UAAU,GAAGA,UAAU,CAACkB,QAAQ,CAAC;QAC/B,cAAc,EAAED,OAAO;QACvB,cAAc,EAAEA,OAAO;QACvB,YAAY,EAAEA,OAAO;QACrB,YAAY,EAAEA,OAAO;QACrB,eAAe,EAAEA,OAAO;QACxB,qBAAqB,EAAEA,OAAO;QAC9B,iBAAiB,EAAEA;MACrB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIlB,OAAO,CAACoB,wBAAwB,EAAE;MAC3CnB,UAAU,GAAGA,UAAU,CAACkB,QAAQ,CAACnB,OAAO,CAACoB,wBAAwB,CAAC;IACpE,CAAC,MAAM,IACL,OAAOrB,MAAM,CAACU,GAAG,KAAK,QAAQ,IAC9B,OAAOV,MAAM,CAACW,GAAG,KAAK,QAAQ,EAC9B;MACA,MAAMW,eAAe,GAAG,IAAI,CAACC,eAAe,CAACvB,MAAM,CAACW,GAAG,EAAEX,MAAM,CAACU,GAAG,CAAC;MACpER,UAAU,GAAGA,UAAU,CAACsB,OAAO,CAC5Bb,GAAG,CAACX,MAAM,CAACW,GAAG,CAAC,CACfD,GAAG,CAACV,MAAM,CAACU,GAAG,CAAC,CACfS,OAAO,CAACG,eAAe,CAAC;IAC7B;IAEA,IAAI,CAACpB,UAAU,GAAGA,UAAU,CAACuB,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGxB,UAAU,CAACuB,OAAO,CAAC,IAAI,CAAC,CAACjB,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACP,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACD,MAAM,GAAGA,MAAM;EACtB;EAEA2B,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAM;MAAE5B,MAAM;MAAEC,OAAO;MAAEL;IAAuB,CAAC,GAAG,IAAI;IAExD,MAAMiC,SAAS,GAAG,KAAK,CAACF,YAAY,CAACC,OAAO,CAAC;IAC7C,IAAI;MAAEE,SAAS;MAAEC,QAAQ;MAAEC;IAAK,CAAC,GAAGH,SAAS;IAE7C,IAAI7B,MAAM,CAACU,GAAG,EAAE;MACdoB,SAAS,GAAG9B,MAAM,CAACU,GAAG;IACxB;IAEA,IAAIT,OAAO,CAACW,QAAQ,EAAE;MACpBmB,QAAQ,GAAG9B,OAAO,CAACW,QAAQ;IAC7B;IAEA,IAAIX,OAAO,CAAC+B,IAAI,EAAE;MAChBA,IAAI,GAAG/B,OAAO,CAAC+B,IAAI;IACrB;IAEA,OAAO;MACL,GAAGH,SAAS;MACZjC,sBAAsB;MACtBkC,SAAS;MACTC,QAAQ;MACRC;IACF,CAAC;EACH;EAEAT,eAAeA,CAACZ,GAAY,EAAED,GAAY,EAAU;IAClD,MAAMuB,WAAW,GAAGvC,eAAe,CAACwC,MAAM;IAC1C,OAAOD,WAAW,CACf7B,OAAO,CAAC,UAAU,EAAEO,GAAG,GAAGA,GAAG,CAACwB,QAAQ,CAAC,CAAC,GAAG,cAAc,CAAC,CAC1D/B,OAAO,CAAC,UAAU,EAAEM,GAAG,GAAGA,GAAG,CAACyB,QAAQ,CAAC,CAAC,GAAG,cAAc,CAAC;EAC/D;;EAEA;AACF;AACA;EACEC,oBAAoBA,CAAA,EAA6B;IAC/C,MAAMC,YAAY,GAAG1C,kBAAkB,CAACyC,oBAAoB,CAAC,CAAC;IAC9D,OAAO;MACL,GAAGC,YAAY;MACfC,sBAAsB,EAAE,CACtB,GAAGD,YAAY,CAACC,sBAAsB,EACtC;QACEC,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAE,IAAI,CAACjB,eAAe,CAAC,IAAI,CAACvB,MAAM,CAACW,GAAG,EAAE,IAAI,CAACX,MAAM,CAACU,GAAG;MACjE,CAAC;IAEL,CAAC;EACH;;EAEA;AACF;AACA;EACE,OAAO0B,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLK,UAAU,EAAE,CAAC;QAAEF,IAAI,EAAE,UAAU;QAAEC,QAAQ,EAAE9C,eAAe,CAACa;MAAS,CAAC,CAAC;MACtE+B,sBAAsB,EAAE,CACtB;QAAEC,IAAI,EAAE,KAAK;QAAEC,QAAQ,EAAE9C,eAAe,CAACiB;MAAI,CAAC,EAC9C;QAAE4B,IAAI,EAAE,KAAK;QAAEC,QAAQ,EAAE9C,eAAe,CAACgB;MAAI,CAAC;IAElD,CAAC;EACH;AACF;AAEA,SAASI,oBAAoBA,CAAC4B,SAA6B,EAAE;EAC3D,MAAMC,SAA0B,GAAGA,CAACC,KAAa,EAAEC,OAAO,KAAK;IAC7D,MAAM;MAAE5C;IAAQ,CAAC,GAAGyC,SAAS;IAE7B,MAAM;MACJxB,uBAAuB,EAAEL,MAAM;MAC/BD,QAAQ,EAAEkC,KAAK,CAAC;IAClB,CAAC,GAAG7C,OAAO;IAEX,IAAI,CAAC6C,KAAK,IAAIC,KAAK,CAACH,KAAK,CAAC,IAAIE,KAAK,EAAE;MACnC,OAAOF,KAAK;IACd;IAEA,OAAO/B,MAAM,GACTgC,OAAO,CAAC1B,OAAO,CAAC;MAAEN;IAAO,CAAC,EAAE;MAAEiC;IAAM,CAAC,CAAC,GACtCD,OAAO,CAACG,KAAK,CAAC,iBAAiB,EAAE;MAAEF;IAAM,CAAC,CAAC;EACjD,CAAC;;EAED;AACF;AACA;AACA;EACE,SAASC,KAAKA,CAACE,IAAY,EAAE;IAC3B,MAAMC,MAAM,GAAGD,IAAI,CAACE,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE;IACvC,OAAOD,MAAM,CAACzC,MAAM;EACtB;EAEA,OAAOkC,SAAS;AAClB","ignoreList":[]}

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

@@ -1,5 +1,6 @@
 import { type NationalGridFieldNumberFieldComponent } from '@defra/forms-model';
 import { LocationFieldBase } from '../../../../server/plugins/engine/components/LocationFieldBase.js';
+import { type ErrorMessageTemplateList } from '../../../../server/plugins/engine/types.js';
 export declare class NationalGridFieldNumberField extends LocationFieldBase {
     options: NationalGridFieldNumberFieldComponent['options'];
     protected getValidationConfig(): {
@@ -14,5 +15,5 @@ export declare class NationalGridFieldNumberField extends LocationFieldBase {
     /**
      * Static version of getAllPossibleErrors that doesn't require a component instance.
      */
-    static getAllPossibleErrors(): import("../types.js").ErrorMessageTemplateList;
+    static getAllPossibleErrors(): ErrorMessageTemplateList;
 }

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

@@ -1,22 +1,22 @@
 import { LocationFieldBase } from "./LocationFieldBase.js";
 import { createLowerFirstExpression } from "./helpers/index.js";
+import { t } from "../i18n/index.js";
 export class NationalGridFieldNumberField extends LocationFieldBase {
   getValidationConfig() {
     // Regex for OS national grid field references (NGFR)
     // Validates specific valid OS grid letter combinations with:
     // - 2 letters & 8 digits in 2 blocks of 4 e.g. ST 6789 6789
     const pattern = /^((([sS]|[nN])[a-hA-Hj-zJ-Z])|(([tT]|[oO])[abfglmqrvwABFGLMQRVW])|([hH][l-zL-Z])|([jJ][lmqrvwLMQRVW]))\s?([0-9]{4})\s?([0-9]{4})$/;
-    const patternTemplate = 'Enter a valid National Grid field number for {{lowerFirst(#title)}} like NG 1234 5678';
     return {
       pattern,
-      patternErrorMessage: createLowerFirstExpression(patternTemplate),
-      requiredMessage: createLowerFirstExpression('Enter {{lowerFirst(#title)}}')
+      patternErrorMessage: createLowerFirstExpression(t('components.nationalGridField.pattern', 'en-GB')),
+      requiredMessage: createLowerFirstExpression(t('components.nationalGridField.required', 'en-GB'))
     };
   }
   getErrorTemplates() {
     return [{
       type: 'pattern',
-      template: createLowerFirstExpression('Enter a valid National Grid field number for {{lowerFirst(#title)}} like NG 1234 5678')
+      template: createLowerFirstExpression(t('components.nationalGridField.pattern', 'en-GB'))
     }];
   }
 
@@ -24,8 +24,16 @@ export class NationalGridFieldNumberField extends LocationFieldBase {
    * Static version of getAllPossibleErrors that doesn't require a component instance.
    */
   static getAllPossibleErrors() {
-    const instance = Object.create(NationalGridFieldNumberField.prototype);
-    return instance.getAllPossibleErrors();
+    return {
+      baseErrors: [{
+        type: 'required',
+        template: createLowerFirstExpression(t('components.nationalGridField.required', 'en-GB'))
+      }, {
+        type: 'pattern',
+        template: createLowerFirstExpression(t('components.nationalGridField.pattern', 'en-GB'))
+      }],
+      advancedSettingsErrors: []
+    };
   }
 }
 //# sourceMappingURL=NationalGridFieldNumberField.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"NationalGridFieldNumberField.js","names":["LocationFieldBase","createLowerFirstExpression","NationalGridFieldNumberField","getValidationConfig","pattern","patternTemplate","patternErrorMessage","requiredMessage","getErrorTemplates","type","template","getAllPossibleErrors","instance","Object","create","prototype"],"sources":["../../../../../src/server/plugins/engine/components/NationalGridFieldNumberField.ts"],"sourcesContent":["import { type NationalGridFieldNumberFieldComponent } from '@defra/forms-model'\n\nimport { LocationFieldBase } from '~/src/server/plugins/engine/components/LocationFieldBase.js'\nimport { createLowerFirstExpression } from '~/src/server/plugins/engine/components/helpers/index.js'\n\nexport class NationalGridFieldNumberField extends LocationFieldBase {\n  declare options: NationalGridFieldNumberFieldComponent['options']\n\n  protected getValidationConfig() {\n    // Regex for OS national grid field references (NGFR)\n    // Validates specific valid OS grid letter combinations with:\n    // - 2 letters & 8 digits in 2 blocks of 4 e.g. ST 6789 6789\n    const pattern =\n      /^((([sS]|[nN])[a-hA-Hj-zJ-Z])|(([tT]|[oO])[abfglmqrvwABFGLMQRVW])|([hH][l-zL-Z])|([jJ][lmqrvwLMQRVW]))\\s?([0-9]{4})\\s?([0-9]{4})$/\n\n    const patternTemplate =\n      'Enter a valid National Grid field number for {{lowerFirst(#title)}} like NG 1234 5678'\n\n    return {\n      pattern,\n      patternErrorMessage: createLowerFirstExpression(patternTemplate),\n      requiredMessage: createLowerFirstExpression(\n        'Enter {{lowerFirst(#title)}}'\n      )\n    }\n  }\n\n  protected getErrorTemplates() {\n    return [\n      {\n        type: 'pattern',\n        template: createLowerFirstExpression(\n          'Enter a valid National Grid field number for {{lowerFirst(#title)}} like NG 1234 5678'\n        )\n      }\n    ]\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors() {\n    const instance = Object.create(\n      NationalGridFieldNumberField.prototype\n    ) as NationalGridFieldNumberField\n    return instance.getAllPossibleErrors()\n  }\n}\n"],"mappings":"AAEA,SAASA,iBAAiB;AAC1B,SAASC,0BAA0B;AAEnC,OAAO,MAAMC,4BAA4B,SAASF,iBAAiB,CAAC;EAGxDG,mBAAmBA,CAAA,EAAG;IAC9B;IACA;IACA;IACA,MAAMC,OAAO,GACX,mIAAmI;IAErI,MAAMC,eAAe,GACnB,uFAAuF;IAEzF,OAAO;MACLD,OAAO;MACPE,mBAAmB,EAAEL,0BAA0B,CAACI,eAAe,CAAC;MAChEE,eAAe,EAAEN,0BAA0B,CACzC,8BACF;IACF,CAAC;EACH;EAEUO,iBAAiBA,CAAA,EAAG;IAC5B,OAAO,CACL;MACEC,IAAI,EAAE,SAAS;MACfC,QAAQ,EAAET,0BAA0B,CAClC,uFACF;IACF,CAAC,CACF;EACH;;EAEA;AACF;AACA;EACE,OAAOU,oBAAoBA,CAAA,EAAG;IAC5B,MAAMC,QAAQ,GAAGC,MAAM,CAACC,MAAM,CAC5BZ,4BAA4B,CAACa,SAC/B,CAAiC;IACjC,OAAOH,QAAQ,CAACD,oBAAoB,CAAC,CAAC;EACxC;AACF","ignoreList":[]}
+{"version":3,"file":"NationalGridFieldNumberField.js","names":["LocationFieldBase","createLowerFirstExpression","t","NationalGridFieldNumberField","getValidationConfig","pattern","patternErrorMessage","requiredMessage","getErrorTemplates","type","template","getAllPossibleErrors","baseErrors","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/NationalGridFieldNumberField.ts"],"sourcesContent":["import { type NationalGridFieldNumberFieldComponent } from '@defra/forms-model'\n\nimport { LocationFieldBase } from '~/src/server/plugins/engine/components/LocationFieldBase.js'\nimport { createLowerFirstExpression } from '~/src/server/plugins/engine/components/helpers/index.js'\nimport { t } from '~/src/server/plugins/engine/i18n/index.js'\nimport { type ErrorMessageTemplateList } from '~/src/server/plugins/engine/types.js'\n\nexport class NationalGridFieldNumberField extends LocationFieldBase {\n  declare options: NationalGridFieldNumberFieldComponent['options']\n\n  protected getValidationConfig() {\n    // Regex for OS national grid field references (NGFR)\n    // Validates specific valid OS grid letter combinations with:\n    // - 2 letters & 8 digits in 2 blocks of 4 e.g. ST 6789 6789\n    const pattern =\n      /^((([sS]|[nN])[a-hA-Hj-zJ-Z])|(([tT]|[oO])[abfglmqrvwABFGLMQRVW])|([hH][l-zL-Z])|([jJ][lmqrvwLMQRVW]))\\s?([0-9]{4})\\s?([0-9]{4})$/\n\n    return {\n      pattern,\n      patternErrorMessage: createLowerFirstExpression(\n        t('components.nationalGridField.pattern', 'en-GB')\n      ),\n      requiredMessage: createLowerFirstExpression(\n        t('components.nationalGridField.required', 'en-GB')\n      )\n    }\n  }\n\n  protected getErrorTemplates() {\n    return [\n      {\n        type: 'pattern',\n        template: createLowerFirstExpression(\n          t('components.nationalGridField.pattern', 'en-GB')\n        )\n      }\n    ]\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        {\n          type: 'required',\n          template: createLowerFirstExpression(\n            t('components.nationalGridField.required', 'en-GB')\n          )\n        },\n        {\n          type: 'pattern',\n          template: createLowerFirstExpression(\n            t('components.nationalGridField.pattern', 'en-GB')\n          )\n        }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAEA,SAASA,iBAAiB;AAC1B,SAASC,0BAA0B;AACnC,SAASC,CAAC;AAGV,OAAO,MAAMC,4BAA4B,SAASH,iBAAiB,CAAC;EAGxDI,mBAAmBA,CAAA,EAAG;IAC9B;IACA;IACA;IACA,MAAMC,OAAO,GACX,mIAAmI;IAErI,OAAO;MACLA,OAAO;MACPC,mBAAmB,EAAEL,0BAA0B,CAC7CC,CAAC,CAAC,sCAAsC,EAAE,OAAO,CACnD,CAAC;MACDK,eAAe,EAAEN,0BAA0B,CACzCC,CAAC,CAAC,uCAAuC,EAAE,OAAO,CACpD;IACF,CAAC;EACH;EAEUM,iBAAiBA,CAAA,EAAG;IAC5B,OAAO,CACL;MACEC,IAAI,EAAE,SAAS;MACfC,QAAQ,EAAET,0BAA0B,CAClCC,CAAC,CAAC,sCAAsC,EAAE,OAAO,CACnD;IACF,CAAC,CACF;EACH;;EAEA;AACF;AACA;EACE,OAAOS,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QACEH,IAAI,EAAE,UAAU;QAChBC,QAAQ,EAAET,0BAA0B,CAClCC,CAAC,CAAC,uCAAuC,EAAE,OAAO,CACpD;MACF,CAAC,EACD;QACEO,IAAI,EAAE,SAAS;QACfC,QAAQ,EAAET,0BAA0B,CAClCC,CAAC,CAAC,sCAAsC,EAAE,OAAO,CACnD;MACF,CAAC,CACF;MACDW,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -1,7 +1,8 @@
 import { type NumberFieldComponent } from '@defra/forms-model';
 import joi, { type NumberSchema } from 'joi';
 import { FormComponent } from '../../../../server/plugins/engine/components/FormComponent.js';
-import { type ErrorMessageTemplateList, type FormPayload, type FormState, type FormStateValue, type FormSubmissionError, type FormSubmissionState } from '../../../../server/plugins/engine/types.js';
+import { type RenderContext } from '../../../../server/plugins/engine/components/types.js';
+import { type ErrorMessageTemplateList, type FormState, type FormStateValue, type FormSubmissionState } from '../../../../server/plugins/engine/types.js';
 export declare class NumberField extends FormComponent {
     options: NumberFieldComponent['options'];
     schema: NumberFieldComponent['schema'];
@@ -10,7 +11,7 @@ export declare class NumberField extends FormComponent {
     constructor(def: NumberFieldComponent, props: ConstructorParameters<typeof FormComponent>[1]);
     getFormValueFromState(state: FormSubmissionState): number | undefined;
     getFormValue(value?: FormStateValue | FormState): number | undefined;
-    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+    getViewModel(context: RenderContext): {
         attributes: {
             autocomplete?: string;
             maxlength?: number;
@@ -18,8 +19,8 @@ export declare class NumberField extends FormComponent {
             accept?: string;
             inputmode?: string;
         };
-        prefix: import("./types.js").ComponentText | undefined;
-        suffix: import("./types.js").ComponentText | undefined;
+        prefix: import("../../../../server/plugins/engine/components/types.js").ComponentText | undefined;
+        suffix: import("../../../../server/plugins/engine/components/types.js").ComponentText | undefined;
         value: string | number | boolean | undefined;
         label: {
             text: string;
@@ -33,27 +34,27 @@ export declare class NumberField extends FormComponent {
         };
         classes?: string;
         condition?: string;
-        errors?: FormSubmissionError[];
+        errors?: import("../../../../server/plugins/engine/types.js").FormSubmissionError[];
         errorMessage?: {
             text: string;
         };
         summaryHtml?: string;
         html?: string;
-        content?: import("./types.js").Content | import("./types.js").Content[] | string;
+        content?: import("../../../../server/plugins/engine/components/types.js").Content | import("../../../../server/plugins/engine/components/types.js").Content[] | string;
         maxlength?: number;
         maxwords?: number;
         rows?: number;
-        items?: import("./types.js").ListItem[] | import("./types.js").DateInputItem[];
+        items?: import("../../../../server/plugins/engine/components/types.js").ListItem[] | import("../../../../server/plugins/engine/components/types.js").DateInputItem[];
         fieldset?: {
             attributes?: string | Record<string, string>;
-            legend?: import("./types.js").Label;
+            legend?: import("../../../../server/plugins/engine/components/types.js").Label;
         };
         formGroup?: {
             classes?: string;
             attributes?: string | Record<string, string>;
         };
         showFieldsetError?: boolean;
-        components?: import("./types.js").ComponentViewModel[];
+        components?: import("../../../../server/plugins/engine/components/types.js").ComponentViewModel[];
         upload?: {
             count: number;
             summaryList: import("../../../../server/plugins/engine/types.js").SummaryList;

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

@@ -53,12 +53,12 @@ export class NumberField extends FormComponent {
   getFormValue(value) {
     return this.isValue(value) ? value : undefined;
   }
-  getViewModel(payload, errors) {
+  getViewModel(context) {
     const {
       options,
       schema
     } = this;
-    const viewModel = super.getViewModel(payload, errors);
+    const viewModel = super.getViewModel(context);
     let {
       attributes,
       prefix,

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

@@ -1 +1 @@
-{"version":3,"file":"NumberField.js","names":["joi","FormComponent","isFormValue","messageTemplate","NumberField","constructor","def","props","options","schema","formSchema","number","custom","getValidatorPrecision","label","required","allow","messages","customValidationMessages","empty","min","max","precision","integer","customValidationMessage","message","default","stateSchema","getFormValueFromState","state","name","getFormValue","value","isValue","undefined","getViewModel","payload","errors","viewModel","attributes","prefix","suffix","inputmode","text","isNumber","getAllPossibleErrors","baseErrors","type","template","numberInteger","advancedSettingsErrors","numberMin","numberMax","numberPrecision","component","validator","helpers","limit","validationSchema","prefs","convert","attempt","error"],"sources":["../../../../../src/server/plugins/engine/components/NumberField.ts"],"sourcesContent":["import { type NumberFieldComponent } from '@defra/forms-model'\nimport joi, { type CustomValidator, type NumberSchema } from 'joi'\n\nimport {\n  FormComponent,\n  isFormValue\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nexport class NumberField extends FormComponent {\n  declare options: NumberFieldComponent['options']\n  declare schema: NumberFieldComponent['schema']\n  declare formSchema: NumberSchema\n  declare stateSchema: NumberSchema\n\n  constructor(\n    def: NumberFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options, schema } = def\n\n    let formSchema = joi\n      .number()\n      .custom(getValidatorPrecision(this))\n      .label(this.label)\n      .required()\n\n    if (options.required === false) {\n      formSchema = formSchema.allow('')\n    } else {\n      const messages = options.customValidationMessages\n\n      formSchema = formSchema.empty('').messages({\n        'any.required':\n          messages?.['any.required'] ?? (messageTemplate.required as string)\n      })\n    }\n\n    if (typeof schema.min === 'number') {\n      formSchema = formSchema.min(schema.min)\n    }\n\n    if (typeof schema.max === 'number') {\n      formSchema = formSchema.max(schema.max)\n    }\n\n    if (typeof schema.precision === 'number' && schema.precision <= 0) {\n      formSchema = formSchema.integer()\n    }\n\n    if (options.customValidationMessage) {\n      const message = options.customValidationMessage\n\n      formSchema = formSchema.messages({\n        'any.required': message,\n        'number.base': message,\n        'number.precision': message,\n        'number.integer': message,\n        'number.min': message,\n        'number.max': message\n      })\n    } else if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\n\n    this.formSchema = formSchema.default('')\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n    this.schema = schema\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  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const { options, schema } = this\n\n    const viewModel = super.getViewModel(payload, errors)\n    let { attributes, prefix, suffix, value } = viewModel\n\n    if (typeof schema.precision === 'undefined' || schema.precision <= 0) {\n      // If precision isn't provided or provided and\n      // less than or equal to 0, use numeric inputmode\n      attributes.inputmode = 'numeric'\n    }\n\n    if (options.prefix) {\n      prefix = {\n        text: options.prefix\n      }\n    }\n\n    if (options.suffix) {\n      suffix = {\n        text: options.suffix\n      }\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      ...viewModel,\n      attributes,\n      prefix,\n      suffix,\n      value\n    }\n  }\n\n  isValue(value?: FormStateValue | FormState) {\n    return NumberField.isNumber(value)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return NumberField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'required', template: messageTemplate.required },\n        { type: 'numberInteger', template: messageTemplate.numberInteger }\n      ],\n      advancedSettingsErrors: [\n        { type: 'numberMin', template: messageTemplate.numberMin },\n        { type: 'numberMax', template: messageTemplate.numberMax },\n        { type: 'numberPrecision', template: messageTemplate.numberPrecision }\n      ]\n    }\n  }\n\n  static isNumber(value?: FormStateValue | FormState): value is number {\n    return typeof value === 'number'\n  }\n}\n\nexport function getValidatorPrecision(component: NumberField) {\n  const validator: CustomValidator = (value: number, helpers) => {\n    const { options, schema } = component\n\n    const { customValidationMessage: custom } = options\n    const { precision: limit } = schema\n\n    if (!limit || limit <= 0) {\n      return value\n    }\n\n    const validationSchema = joi\n      .number()\n      .precision(limit)\n      .prefs({ convert: false })\n\n    try {\n      return joi.attempt(value, validationSchema)\n    } catch {\n      return custom\n        ? helpers.message({ custom }, { limit })\n        : helpers.error('number.precision', { limit })\n    }\n  }\n\n  return validator\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAAmD,KAAK;AAElE,SACEC,aAAa,EACbC,WAAW;AAEb,SAASC,eAAe;AAUxB,OAAO,MAAMC,WAAW,SAASH,aAAa,CAAC;EAM7CI,WAAWA,CACTC,GAAyB,EACzBC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,OAAO;MAAEC;IAAO,CAAC,GAAGH,GAAG;IAE/B,IAAII,UAAU,GAAGV,GAAG,CACjBW,MAAM,CAAC,CAAC,CACRC,MAAM,CAACC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CACnCC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,QAAQ,CAAC,CAAC;IAEb,IAAIP,OAAO,CAACO,QAAQ,KAAK,KAAK,EAAE;MAC9BL,UAAU,GAAGA,UAAU,CAACM,KAAK,CAAC,EAAE,CAAC;IACnC,CAAC,MAAM;MACL,MAAMC,QAAQ,GAAGT,OAAO,CAACU,wBAAwB;MAEjDR,UAAU,GAAGA,UAAU,CAACS,KAAK,CAAC,EAAE,CAAC,CAACF,QAAQ,CAAC;QACzC,cAAc,EACZA,QAAQ,GAAG,cAAc,CAAC,IAAKd,eAAe,CAACY;MACnD,CAAC,CAAC;IACJ;IAEA,IAAI,OAAON,MAAM,CAACW,GAAG,KAAK,QAAQ,EAAE;MAClCV,UAAU,GAAGA,UAAU,CAACU,GAAG,CAACX,MAAM,CAACW,GAAG,CAAC;IACzC;IAEA,IAAI,OAAOX,MAAM,CAACY,GAAG,KAAK,QAAQ,EAAE;MAClCX,UAAU,GAAGA,UAAU,CAACW,GAAG,CAACZ,MAAM,CAACY,GAAG,CAAC;IACzC;IAEA,IAAI,OAAOZ,MAAM,CAACa,SAAS,KAAK,QAAQ,IAAIb,MAAM,CAACa,SAAS,IAAI,CAAC,EAAE;MACjEZ,UAAU,GAAGA,UAAU,CAACa,OAAO,CAAC,CAAC;IACnC;IAEA,IAAIf,OAAO,CAACgB,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGjB,OAAO,CAACgB,uBAAuB;MAE/Cd,UAAU,GAAGA,UAAU,CAACO,QAAQ,CAAC;QAC/B,cAAc,EAAEQ,OAAO;QACvB,aAAa,EAAEA,OAAO;QACtB,kBAAkB,EAAEA,OAAO;QAC3B,gBAAgB,EAAEA,OAAO;QACzB,YAAY,EAAEA,OAAO;QACrB,YAAY,EAAEA;MAChB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIjB,OAAO,CAACU,wBAAwB,EAAE;MAC3CR,UAAU,GAAGA,UAAU,CAACO,QAAQ,CAACT,OAAO,CAACU,wBAAwB,CAAC;IACpE;IAEA,IAAI,CAACR,UAAU,GAAGA,UAAU,CAACgB,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGjB,UAAU,CAACgB,OAAO,CAAC,IAAI,CAAC,CAACV,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACR,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,MAAM,GAAGA,MAAM;EACtB;EAEAmB,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;EAEAC,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAM;MAAE7B,OAAO;MAAEC;IAAO,CAAC,GAAG,IAAI;IAEhC,MAAM6B,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,IAAI;MAAEE,UAAU;MAAEC,MAAM;MAAEC,MAAM;MAAET;IAAM,CAAC,GAAGM,SAAS;IAErD,IAAI,OAAO7B,MAAM,CAACa,SAAS,KAAK,WAAW,IAAIb,MAAM,CAACa,SAAS,IAAI,CAAC,EAAE;MACpE;MACA;MACAiB,UAAU,CAACG,SAAS,GAAG,SAAS;IAClC;IAEA,IAAIlC,OAAO,CAACgC,MAAM,EAAE;MAClBA,MAAM,GAAG;QACPG,IAAI,EAAEnC,OAAO,CAACgC;MAChB,CAAC;IACH;IAEA,IAAIhC,OAAO,CAACiC,MAAM,EAAE;MAClBA,MAAM,GAAG;QACPE,IAAI,EAAEnC,OAAO,CAACiC;MAChB,CAAC;IACH;;IAEA;IACA;IACA,IAAI,CAACvC,WAAW,CAAC8B,KAAK,CAAC,EAAE;MACvBA,KAAK,GAAGE,SAAS;IACnB;IAEA,OAAO;MACL,GAAGI,SAAS;MACZC,UAAU;MACVC,MAAM;MACNC,MAAM;MACNT;IACF,CAAC;EACH;EAEAC,OAAOA,CAACD,KAAkC,EAAE;IAC1C,OAAO5B,WAAW,CAACwC,QAAQ,CAACZ,KAAK,CAAC;EACpC;;EAEA;AACF;AACA;EACEa,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOzC,WAAW,CAACyC,oBAAoB,CAAC,CAAC;EAC3C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEC,IAAI,EAAE,UAAU;QAAEC,QAAQ,EAAE7C,eAAe,CAACY;MAAS,CAAC,EACxD;QAAEgC,IAAI,EAAE,eAAe;QAAEC,QAAQ,EAAE7C,eAAe,CAAC8C;MAAc,CAAC,CACnE;MACDC,sBAAsB,EAAE,CACtB;QAAEH,IAAI,EAAE,WAAW;QAAEC,QAAQ,EAAE7C,eAAe,CAACgD;MAAU,CAAC,EAC1D;QAAEJ,IAAI,EAAE,WAAW;QAAEC,QAAQ,EAAE7C,eAAe,CAACiD;MAAU,CAAC,EAC1D;QAAEL,IAAI,EAAE,iBAAiB;QAAEC,QAAQ,EAAE7C,eAAe,CAACkD;MAAgB,CAAC;IAE1E,CAAC;EACH;EAEA,OAAOT,QAAQA,CAACZ,KAAkC,EAAmB;IACnE,OAAO,OAAOA,KAAK,KAAK,QAAQ;EAClC;AACF;AAEA,OAAO,SAASnB,qBAAqBA,CAACyC,SAAsB,EAAE;EAC5D,MAAMC,SAA0B,GAAGA,CAACvB,KAAa,EAAEwB,OAAO,KAAK;IAC7D,MAAM;MAAEhD,OAAO;MAAEC;IAAO,CAAC,GAAG6C,SAAS;IAErC,MAAM;MAAE9B,uBAAuB,EAAEZ;IAAO,CAAC,GAAGJ,OAAO;IACnD,MAAM;MAAEc,SAAS,EAAEmC;IAAM,CAAC,GAAGhD,MAAM;IAEnC,IAAI,CAACgD,KAAK,IAAIA,KAAK,IAAI,CAAC,EAAE;MACxB,OAAOzB,KAAK;IACd;IAEA,MAAM0B,gBAAgB,GAAG1D,GAAG,CACzBW,MAAM,CAAC,CAAC,CACRW,SAAS,CAACmC,KAAK,CAAC,CAChBE,KAAK,CAAC;MAAEC,OAAO,EAAE;IAAM,CAAC,CAAC;IAE5B,IAAI;MACF,OAAO5D,GAAG,CAAC6D,OAAO,CAAC7B,KAAK,EAAE0B,gBAAgB,CAAC;IAC7C,CAAC,CAAC,MAAM;MACN,OAAO9C,MAAM,GACT4C,OAAO,CAAC/B,OAAO,CAAC;QAAEb;MAAO,CAAC,EAAE;QAAE6C;MAAM,CAAC,CAAC,GACtCD,OAAO,CAACM,KAAK,CAAC,kBAAkB,EAAE;QAAEL;MAAM,CAAC,CAAC;IAClD;EACF,CAAC;EAED,OAAOF,SAAS;AAClB","ignoreList":[]}
+{"version":3,"file":"NumberField.js","names":["joi","FormComponent","isFormValue","messageTemplate","NumberField","constructor","def","props","options","schema","formSchema","number","custom","getValidatorPrecision","label","required","allow","messages","customValidationMessages","empty","min","max","precision","integer","customValidationMessage","message","default","stateSchema","getFormValueFromState","state","name","getFormValue","value","isValue","undefined","getViewModel","context","viewModel","attributes","prefix","suffix","inputmode","text","isNumber","getAllPossibleErrors","baseErrors","type","template","numberInteger","advancedSettingsErrors","numberMin","numberMax","numberPrecision","component","validator","helpers","limit","validationSchema","prefs","convert","attempt","error"],"sources":["../../../../../src/server/plugins/engine/components/NumberField.ts"],"sourcesContent":["import { type NumberFieldComponent } from '@defra/forms-model'\nimport joi, { type CustomValidator, type NumberSchema } from 'joi'\n\nimport {\n  FormComponent,\n  isFormValue\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type RenderContext } from '~/src/server/plugins/engine/components/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nexport class NumberField extends FormComponent {\n  declare options: NumberFieldComponent['options']\n  declare schema: NumberFieldComponent['schema']\n  declare formSchema: NumberSchema\n  declare stateSchema: NumberSchema\n\n  constructor(\n    def: NumberFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options, schema } = def\n\n    let formSchema = joi\n      .number()\n      .custom(getValidatorPrecision(this))\n      .label(this.label)\n      .required()\n\n    if (options.required === false) {\n      formSchema = formSchema.allow('')\n    } else {\n      const messages = options.customValidationMessages\n\n      formSchema = formSchema.empty('').messages({\n        'any.required':\n          messages?.['any.required'] ?? (messageTemplate.required as string)\n      })\n    }\n\n    if (typeof schema.min === 'number') {\n      formSchema = formSchema.min(schema.min)\n    }\n\n    if (typeof schema.max === 'number') {\n      formSchema = formSchema.max(schema.max)\n    }\n\n    if (typeof schema.precision === 'number' && schema.precision <= 0) {\n      formSchema = formSchema.integer()\n    }\n\n    if (options.customValidationMessage) {\n      const message = options.customValidationMessage\n\n      formSchema = formSchema.messages({\n        'any.required': message,\n        'number.base': message,\n        'number.precision': message,\n        'number.integer': message,\n        'number.min': message,\n        'number.max': message\n      })\n    } else if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\n\n    this.formSchema = formSchema.default('')\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n    this.schema = schema\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  getViewModel(context: RenderContext) {\n    const { options, schema } = this\n\n    const viewModel = super.getViewModel(context)\n    let { attributes, prefix, suffix, value } = viewModel\n\n    if (typeof schema.precision === 'undefined' || schema.precision <= 0) {\n      // If precision isn't provided or provided and\n      // less than or equal to 0, use numeric inputmode\n      attributes.inputmode = 'numeric'\n    }\n\n    if (options.prefix) {\n      prefix = {\n        text: options.prefix\n      }\n    }\n\n    if (options.suffix) {\n      suffix = {\n        text: options.suffix\n      }\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      ...viewModel,\n      attributes,\n      prefix,\n      suffix,\n      value\n    }\n  }\n\n  isValue(value?: FormStateValue | FormState) {\n    return NumberField.isNumber(value)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return NumberField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'required', template: messageTemplate.required },\n        { type: 'numberInteger', template: messageTemplate.numberInteger }\n      ],\n      advancedSettingsErrors: [\n        { type: 'numberMin', template: messageTemplate.numberMin },\n        { type: 'numberMax', template: messageTemplate.numberMax },\n        { type: 'numberPrecision', template: messageTemplate.numberPrecision }\n      ]\n    }\n  }\n\n  static isNumber(value?: FormStateValue | FormState): value is number {\n    return typeof value === 'number'\n  }\n}\n\nexport function getValidatorPrecision(component: NumberField) {\n  const validator: CustomValidator = (value: number, helpers) => {\n    const { options, schema } = component\n\n    const { customValidationMessage: custom } = options\n    const { precision: limit } = schema\n\n    if (!limit || limit <= 0) {\n      return value\n    }\n\n    const validationSchema = joi\n      .number()\n      .precision(limit)\n      .prefs({ convert: false })\n\n    try {\n      return joi.attempt(value, validationSchema)\n    } catch {\n      return custom\n        ? helpers.message({ custom }, { limit })\n        : helpers.error('number.precision', { limit })\n    }\n  }\n\n  return validator\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAAmD,KAAK;AAElE,SACEC,aAAa,EACbC,WAAW;AAGb,SAASC,eAAe;AAQxB,OAAO,MAAMC,WAAW,SAASH,aAAa,CAAC;EAM7CI,WAAWA,CACTC,GAAyB,EACzBC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,OAAO;MAAEC;IAAO,CAAC,GAAGH,GAAG;IAE/B,IAAII,UAAU,GAAGV,GAAG,CACjBW,MAAM,CAAC,CAAC,CACRC,MAAM,CAACC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CACnCC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,QAAQ,CAAC,CAAC;IAEb,IAAIP,OAAO,CAACO,QAAQ,KAAK,KAAK,EAAE;MAC9BL,UAAU,GAAGA,UAAU,CAACM,KAAK,CAAC,EAAE,CAAC;IACnC,CAAC,MAAM;MACL,MAAMC,QAAQ,GAAGT,OAAO,CAACU,wBAAwB;MAEjDR,UAAU,GAAGA,UAAU,CAACS,KAAK,CAAC,EAAE,CAAC,CAACF,QAAQ,CAAC;QACzC,cAAc,EACZA,QAAQ,GAAG,cAAc,CAAC,IAAKd,eAAe,CAACY;MACnD,CAAC,CAAC;IACJ;IAEA,IAAI,OAAON,MAAM,CAACW,GAAG,KAAK,QAAQ,EAAE;MAClCV,UAAU,GAAGA,UAAU,CAACU,GAAG,CAACX,MAAM,CAACW,GAAG,CAAC;IACzC;IAEA,IAAI,OAAOX,MAAM,CAACY,GAAG,KAAK,QAAQ,EAAE;MAClCX,UAAU,GAAGA,UAAU,CAACW,GAAG,CAACZ,MAAM,CAACY,GAAG,CAAC;IACzC;IAEA,IAAI,OAAOZ,MAAM,CAACa,SAAS,KAAK,QAAQ,IAAIb,MAAM,CAACa,SAAS,IAAI,CAAC,EAAE;MACjEZ,UAAU,GAAGA,UAAU,CAACa,OAAO,CAAC,CAAC;IACnC;IAEA,IAAIf,OAAO,CAACgB,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGjB,OAAO,CAACgB,uBAAuB;MAE/Cd,UAAU,GAAGA,UAAU,CAACO,QAAQ,CAAC;QAC/B,cAAc,EAAEQ,OAAO;QACvB,aAAa,EAAEA,OAAO;QACtB,kBAAkB,EAAEA,OAAO;QAC3B,gBAAgB,EAAEA,OAAO;QACzB,YAAY,EAAEA,OAAO;QACrB,YAAY,EAAEA;MAChB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIjB,OAAO,CAACU,wBAAwB,EAAE;MAC3CR,UAAU,GAAGA,UAAU,CAACO,QAAQ,CAACT,OAAO,CAACU,wBAAwB,CAAC;IACpE;IAEA,IAAI,CAACR,UAAU,GAAGA,UAAU,CAACgB,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGjB,UAAU,CAACgB,OAAO,CAAC,IAAI,CAAC,CAACV,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACR,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,MAAM,GAAGA,MAAM;EACtB;EAEAmB,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;EAEAC,YAAYA,CAACC,OAAsB,EAAE;IACnC,MAAM;MAAE5B,OAAO;MAAEC;IAAO,CAAC,GAAG,IAAI;IAEhC,MAAM4B,SAAS,GAAG,KAAK,CAACF,YAAY,CAACC,OAAO,CAAC;IAC7C,IAAI;MAAEE,UAAU;MAAEC,MAAM;MAAEC,MAAM;MAAER;IAAM,CAAC,GAAGK,SAAS;IAErD,IAAI,OAAO5B,MAAM,CAACa,SAAS,KAAK,WAAW,IAAIb,MAAM,CAACa,SAAS,IAAI,CAAC,EAAE;MACpE;MACA;MACAgB,UAAU,CAACG,SAAS,GAAG,SAAS;IAClC;IAEA,IAAIjC,OAAO,CAAC+B,MAAM,EAAE;MAClBA,MAAM,GAAG;QACPG,IAAI,EAAElC,OAAO,CAAC+B;MAChB,CAAC;IACH;IAEA,IAAI/B,OAAO,CAACgC,MAAM,EAAE;MAClBA,MAAM,GAAG;QACPE,IAAI,EAAElC,OAAO,CAACgC;MAChB,CAAC;IACH;;IAEA;IACA;IACA,IAAI,CAACtC,WAAW,CAAC8B,KAAK,CAAC,EAAE;MACvBA,KAAK,GAAGE,SAAS;IACnB;IAEA,OAAO;MACL,GAAGG,SAAS;MACZC,UAAU;MACVC,MAAM;MACNC,MAAM;MACNR;IACF,CAAC;EACH;EAEAC,OAAOA,CAACD,KAAkC,EAAE;IAC1C,OAAO5B,WAAW,CAACuC,QAAQ,CAACX,KAAK,CAAC;EACpC;;EAEA;AACF;AACA;EACEY,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOxC,WAAW,CAACwC,oBAAoB,CAAC,CAAC;EAC3C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEC,IAAI,EAAE,UAAU;QAAEC,QAAQ,EAAE5C,eAAe,CAACY;MAAS,CAAC,EACxD;QAAE+B,IAAI,EAAE,eAAe;QAAEC,QAAQ,EAAE5C,eAAe,CAAC6C;MAAc,CAAC,CACnE;MACDC,sBAAsB,EAAE,CACtB;QAAEH,IAAI,EAAE,WAAW;QAAEC,QAAQ,EAAE5C,eAAe,CAAC+C;MAAU,CAAC,EAC1D;QAAEJ,IAAI,EAAE,WAAW;QAAEC,QAAQ,EAAE5C,eAAe,CAACgD;MAAU,CAAC,EAC1D;QAAEL,IAAI,EAAE,iBAAiB;QAAEC,QAAQ,EAAE5C,eAAe,CAACiD;MAAgB,CAAC;IAE1E,CAAC;EACH;EAEA,OAAOT,QAAQA,CAACX,KAAkC,EAAmB;IACnE,OAAO,OAAOA,KAAK,KAAK,QAAQ;EAClC;AACF;AAEA,OAAO,SAASnB,qBAAqBA,CAACwC,SAAsB,EAAE;EAC5D,MAAMC,SAA0B,GAAGA,CAACtB,KAAa,EAAEuB,OAAO,KAAK;IAC7D,MAAM;MAAE/C,OAAO;MAAEC;IAAO,CAAC,GAAG4C,SAAS;IAErC,MAAM;MAAE7B,uBAAuB,EAAEZ;IAAO,CAAC,GAAGJ,OAAO;IACnD,MAAM;MAAEc,SAAS,EAAEkC;IAAM,CAAC,GAAG/C,MAAM;IAEnC,IAAI,CAAC+C,KAAK,IAAIA,KAAK,IAAI,CAAC,EAAE;MACxB,OAAOxB,KAAK;IACd;IAEA,MAAMyB,gBAAgB,GAAGzD,GAAG,CACzBW,MAAM,CAAC,CAAC,CACRW,SAAS,CAACkC,KAAK,CAAC,CAChBE,KAAK,CAAC;MAAEC,OAAO,EAAE;IAAM,CAAC,CAAC;IAE5B,IAAI;MACF,OAAO3D,GAAG,CAAC4D,OAAO,CAAC5B,KAAK,EAAEyB,gBAAgB,CAAC;IAC7C,CAAC,CAAC,MAAM;MACN,OAAO7C,MAAM,GACT2C,OAAO,CAAC9B,OAAO,CAAC;QAAEb;MAAO,CAAC,EAAE;QAAE4C;MAAM,CAAC,CAAC,GACtCD,OAAO,CAACM,KAAK,CAAC,kBAAkB,EAAE;QAAEL;MAAM,CAAC,CAAC;IAClD;EACF,CAAC;EAED,OAAOF,SAAS;AAClB","ignoreList":[]}

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

@@ -1,5 +1,6 @@
 import { type OsGridRefFieldComponent } from '@defra/forms-model';
 import { LocationFieldBase } from '../../../../server/plugins/engine/components/LocationFieldBase.js';
+import { type ErrorMessageTemplateList } from '../../../../server/plugins/engine/types.js';
 export declare class OsGridRefField extends LocationFieldBase {
     options: OsGridRefFieldComponent['options'];
     protected getValidationConfig(): {
@@ -14,5 +15,5 @@ export declare class OsGridRefField extends LocationFieldBase {
     /**
      * Static version of getAllPossibleErrors that doesn't require a component instance.
      */
-    static getAllPossibleErrors(): import("../types.js").ErrorMessageTemplateList;
+    static getAllPossibleErrors(): ErrorMessageTemplateList;
 }

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

@@ -1,5 +1,6 @@
 import { LocationFieldBase } from "./LocationFieldBase.js";
 import { createLowerFirstExpression } from "./helpers/index.js";
+import { t } from "../i18n/index.js";
 export class OsGridRefField extends LocationFieldBase {
   getValidationConfig() {
     // Regex for OS national grid references (NGR)
@@ -9,17 +10,16 @@ export class OsGridRefField extends LocationFieldBase {
     // - 2 letters & 10 digits in 2 blocks of 5 e.g. SO 12345 12345
     // Optional spaces between each block
     const pattern = /^((([sS]|[nN])[a-hA-Hj-zJ-Z])|(([tT]|[oO])[abfglmqrvwABFGLMQRVW])|([hH][l-zL-Z])|([jJ][lmqrvwLMQRVW]))\s?(([0-9]{3})\s?([0-9]{3})|([0-9]{4})\s?([0-9]{4})|([0-9]{5})\s?([0-9]{5}))$/;
-    const patternTemplate = 'Enter a valid OS grid reference for {{lowerFirst(#title)}} like TQ123456';
     return {
       pattern,
-      patternErrorMessage: createLowerFirstExpression(patternTemplate),
-      requiredMessage: createLowerFirstExpression('Enter {{lowerFirst(#title)}}')
+      patternErrorMessage: createLowerFirstExpression(t('components.osGridRefField.pattern', 'en-GB')),
+      requiredMessage: createLowerFirstExpression(t('components.osGridRefField.required', 'en-GB'))
     };
   }
   getErrorTemplates() {
     return [{
       type: 'pattern',
-      template: createLowerFirstExpression('Enter a valid OS grid reference for {{lowerFirst(#title)}} like TQ123456')
+      template: createLowerFirstExpression(t('components.osGridRefField.pattern', 'en-GB'))
     }];
   }
 
@@ -27,8 +27,16 @@ export class OsGridRefField extends LocationFieldBase {
    * Static version of getAllPossibleErrors that doesn't require a component instance.
    */
   static getAllPossibleErrors() {
-    const instance = Object.create(OsGridRefField.prototype);
-    return instance.getAllPossibleErrors();
+    return {
+      baseErrors: [{
+        type: 'required',
+        template: createLowerFirstExpression(t('components.osGridRefField.required', 'en-GB'))
+      }, {
+        type: 'pattern',
+        template: createLowerFirstExpression(t('components.osGridRefField.pattern', 'en-GB'))
+      }],
+      advancedSettingsErrors: []
+    };
   }
 }
 //# sourceMappingURL=OsGridRefField.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"OsGridRefField.js","names":["LocationFieldBase","createLowerFirstExpression","OsGridRefField","getValidationConfig","pattern","patternTemplate","patternErrorMessage","requiredMessage","getErrorTemplates","type","template","getAllPossibleErrors","instance","Object","create","prototype"],"sources":["../../../../../src/server/plugins/engine/components/OsGridRefField.ts"],"sourcesContent":["import { type OsGridRefFieldComponent } from '@defra/forms-model'\n\nimport { LocationFieldBase } from '~/src/server/plugins/engine/components/LocationFieldBase.js'\nimport { createLowerFirstExpression } from '~/src/server/plugins/engine/components/helpers/index.js'\n\nexport class OsGridRefField extends LocationFieldBase {\n  declare options: OsGridRefFieldComponent['options']\n\n  protected getValidationConfig() {\n    // Regex for OS national grid references (NGR)\n    // Validates specific valid OS grid letter combinations with:\n    // - 2 letters & 6 digits in 2 blocks of 3 e.g. ST 678 678\n    // - 2 letters & 8 digits in 2 blocks of 4 e.g. ST 6789 6789\n    // - 2 letters & 10 digits in 2 blocks of 5 e.g. SO 12345 12345\n    // Optional spaces between each block\n    const pattern =\n      /^((([sS]|[nN])[a-hA-Hj-zJ-Z])|(([tT]|[oO])[abfglmqrvwABFGLMQRVW])|([hH][l-zL-Z])|([jJ][lmqrvwLMQRVW]))\\s?(([0-9]{3})\\s?([0-9]{3})|([0-9]{4})\\s?([0-9]{4})|([0-9]{5})\\s?([0-9]{5}))$/\n\n    const patternTemplate =\n      'Enter a valid OS grid reference for {{lowerFirst(#title)}} like TQ123456'\n\n    return {\n      pattern,\n      patternErrorMessage: createLowerFirstExpression(patternTemplate),\n      requiredMessage: createLowerFirstExpression(\n        'Enter {{lowerFirst(#title)}}'\n      )\n    }\n  }\n\n  protected getErrorTemplates() {\n    return [\n      {\n        type: 'pattern',\n        template: createLowerFirstExpression(\n          'Enter a valid OS grid reference for {{lowerFirst(#title)}} like TQ123456'\n        )\n      }\n    ]\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors() {\n    const instance = Object.create(OsGridRefField.prototype) as OsGridRefField\n    return instance.getAllPossibleErrors()\n  }\n}\n"],"mappings":"AAEA,SAASA,iBAAiB;AAC1B,SAASC,0BAA0B;AAEnC,OAAO,MAAMC,cAAc,SAASF,iBAAiB,CAAC;EAG1CG,mBAAmBA,CAAA,EAAG;IAC9B;IACA;IACA;IACA;IACA;IACA;IACA,MAAMC,OAAO,GACX,qLAAqL;IAEvL,MAAMC,eAAe,GACnB,0EAA0E;IAE5E,OAAO;MACLD,OAAO;MACPE,mBAAmB,EAAEL,0BAA0B,CAACI,eAAe,CAAC;MAChEE,eAAe,EAAEN,0BAA0B,CACzC,8BACF;IACF,CAAC;EACH;EAEUO,iBAAiBA,CAAA,EAAG;IAC5B,OAAO,CACL;MACEC,IAAI,EAAE,SAAS;MACfC,QAAQ,EAAET,0BAA0B,CAClC,0EACF;IACF,CAAC,CACF;EACH;;EAEA;AACF;AACA;EACE,OAAOU,oBAAoBA,CAAA,EAAG;IAC5B,MAAMC,QAAQ,GAAGC,MAAM,CAACC,MAAM,CAACZ,cAAc,CAACa,SAAS,CAAmB;IAC1E,OAAOH,QAAQ,CAACD,oBAAoB,CAAC,CAAC;EACxC;AACF","ignoreList":[]}
+{"version":3,"file":"OsGridRefField.js","names":["LocationFieldBase","createLowerFirstExpression","t","OsGridRefField","getValidationConfig","pattern","patternErrorMessage","requiredMessage","getErrorTemplates","type","template","getAllPossibleErrors","baseErrors","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/OsGridRefField.ts"],"sourcesContent":["import { type OsGridRefFieldComponent } from '@defra/forms-model'\n\nimport { LocationFieldBase } from '~/src/server/plugins/engine/components/LocationFieldBase.js'\nimport { createLowerFirstExpression } from '~/src/server/plugins/engine/components/helpers/index.js'\nimport { t } from '~/src/server/plugins/engine/i18n/index.js'\nimport { type ErrorMessageTemplateList } from '~/src/server/plugins/engine/types.js'\n\nexport class OsGridRefField extends LocationFieldBase {\n  declare options: OsGridRefFieldComponent['options']\n\n  protected getValidationConfig() {\n    // Regex for OS national grid references (NGR)\n    // Validates specific valid OS grid letter combinations with:\n    // - 2 letters & 6 digits in 2 blocks of 3 e.g. ST 678 678\n    // - 2 letters & 8 digits in 2 blocks of 4 e.g. ST 6789 6789\n    // - 2 letters & 10 digits in 2 blocks of 5 e.g. SO 12345 12345\n    // Optional spaces between each block\n    const pattern =\n      /^((([sS]|[nN])[a-hA-Hj-zJ-Z])|(([tT]|[oO])[abfglmqrvwABFGLMQRVW])|([hH][l-zL-Z])|([jJ][lmqrvwLMQRVW]))\\s?(([0-9]{3})\\s?([0-9]{3})|([0-9]{4})\\s?([0-9]{4})|([0-9]{5})\\s?([0-9]{5}))$/\n\n    return {\n      pattern,\n      patternErrorMessage: createLowerFirstExpression(\n        t('components.osGridRefField.pattern', 'en-GB')\n      ),\n      requiredMessage: createLowerFirstExpression(\n        t('components.osGridRefField.required', 'en-GB')\n      )\n    }\n  }\n\n  protected getErrorTemplates() {\n    return [\n      {\n        type: 'pattern',\n        template: createLowerFirstExpression(\n          t('components.osGridRefField.pattern', 'en-GB')\n        )\n      }\n    ]\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        {\n          type: 'required',\n          template: createLowerFirstExpression(\n            t('components.osGridRefField.required', 'en-GB')\n          )\n        },\n        {\n          type: 'pattern',\n          template: createLowerFirstExpression(\n            t('components.osGridRefField.pattern', 'en-GB')\n          )\n        }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAEA,SAASA,iBAAiB;AAC1B,SAASC,0BAA0B;AACnC,SAASC,CAAC;AAGV,OAAO,MAAMC,cAAc,SAASH,iBAAiB,CAAC;EAG1CI,mBAAmBA,CAAA,EAAG;IAC9B;IACA;IACA;IACA;IACA;IACA;IACA,MAAMC,OAAO,GACX,qLAAqL;IAEvL,OAAO;MACLA,OAAO;MACPC,mBAAmB,EAAEL,0BAA0B,CAC7CC,CAAC,CAAC,mCAAmC,EAAE,OAAO,CAChD,CAAC;MACDK,eAAe,EAAEN,0BAA0B,CACzCC,CAAC,CAAC,oCAAoC,EAAE,OAAO,CACjD;IACF,CAAC;EACH;EAEUM,iBAAiBA,CAAA,EAAG;IAC5B,OAAO,CACL;MACEC,IAAI,EAAE,SAAS;MACfC,QAAQ,EAAET,0BAA0B,CAClCC,CAAC,CAAC,mCAAmC,EAAE,OAAO,CAChD;IACF,CAAC,CACF;EACH;;EAEA;AACF;AACA;EACE,OAAOS,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QACEH,IAAI,EAAE,UAAU;QAChBC,QAAQ,EAAET,0BAA0B,CAClCC,CAAC,CAAC,oCAAoC,EAAE,OAAO,CACjD;MACF,CAAC,EACD;QACEO,IAAI,EAAE,SAAS;QACfC,QAAQ,EAAET,0BAA0B,CAClCC,CAAC,CAAC,mCAAmC,EAAE,OAAO,CAChD;MACF,CAAC,CACF;MACDW,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}