@defra/forms-engine-plugin 0.1.11 → 0.1.12

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

@@ -1 +1 @@
-{"version":3,"file":"ListFormComponent.js","names":["joi","FormComponent","ListFormComponent","list","listType","items","values","map","value","constructor","def","props","options","title","model","getList","type","formSchema","valid","label","required","customValidationMessages","messages","stateSchema","default","allow","getFormValueFromState","state","name","isValue","flat","selected","filter","item","includes","at","getDisplayStringFromState","text","join","getViewModel","payload","errors","listItems","viewModel","itemModel","description","hint"],"sources":["../../../../../src/server/plugins/engine/components/ListFormComponent.ts"],"sourcesContent":["import {\n  type Item,\n  type List,\n  type ListComponentsDef,\n  type SelectionComponentsDef,\n  type YesNoFieldComponent\n} from '@defra/forms-model'\nimport joi, {\n  type ArraySchema,\n  type BooleanSchema,\n  type NumberSchema,\n  type StringSchema\n} from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type ListItem } from '~/src/server/plugins/engine/components/types.js'\nimport {\n  type FormPayload,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nexport class ListFormComponent extends FormComponent {\n  declare options: Extract<\n    SelectionComponentsDef,\n    { options: object }\n  >['options']\n\n  declare formSchema:\n    | ArraySchema<string>\n    | ArraySchema<number>\n    | BooleanSchema<string>\n    | NumberSchema<string>\n    | NumberSchema\n    | StringSchema\n\n  declare stateSchema:\n    | ArraySchema<string>\n    | ArraySchema<number>\n    | BooleanSchema<string>\n    | NumberSchema<string>\n    | NumberSchema\n    | StringSchema\n\n  list?: List\n  listType: List['type'] = 'string'\n\n  get items(): Item[] {\n    return this.list?.items ?? []\n  }\n\n  get values(): Item['value'][] {\n    return this.items.map(({ value }) => value)\n  }\n\n  constructor(\n    def:\n      | SelectionComponentsDef // Allow for Yes/No field custom list\n      | (YesNoFieldComponent & Pick<ListComponentsDef, 'list'>),\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options, title } = def\n    const { model } = props\n\n    if ('list' in def) {\n      this.list = model.getList(def.list)\n      this.listType = this.list?.type ?? 'string'\n    }\n\n    let formSchema = joi[this.listType]()\n      .valid(...this.values)\n      .label(title)\n      .required()\n\n    if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\n\n    this.formSchema = formSchema\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n  }\n\n  getFormValueFromState(\n    state: FormSubmissionState\n  ): Item['value'] | Item['value'][] | undefined {\n    const { name, items } = this\n\n    const value = state[name]\n\n    // Allow for array values via subclass\n    const values = this.isValue(value) ? [value].flat() : []\n    const selected = items.filter((item) => values.includes(item.value))\n\n    return selected.at(0)?.value\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState) {\n    const { items } = this\n\n    // Allow for array values via subclass\n    const value = this.getFormValueFromState(state)\n    const values = [value ?? []].flat()\n\n    return items\n      .filter((item) => values.includes(item.value))\n      .map((item) => item.text)\n      .join(', ')\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const { items: listItems } = this\n\n    const viewModel = super.getViewModel(payload, errors)\n    const { value } = viewModel\n\n    // Support multiple values for checkboxes\n    const values = this.isValue(value) ? [value].flat() : []\n\n    const items = listItems.map((item) => {\n      const selected = values.includes(item.value)\n      const itemModel: ListItem = { ...item, selected }\n\n      if (item.description) {\n        itemModel.hint = {\n          text: item.description\n        }\n      }\n\n      return itemModel\n    })\n\n    return {\n      ...viewModel,\n      items\n    }\n  }\n}\n"],"mappings":"AAOA,OAAOA,GAAG,MAKH,KAAK;AAEZ,SAASC,aAAa;AAQtB,OAAO,MAAMC,iBAAiB,SAASD,aAAa,CAAC;EAsBnDE,IAAI;EACJC,QAAQ,GAAiB,QAAQ;EAEjC,IAAIC,KAAKA,CAAA,EAAW;IAClB,OAAO,IAAI,CAACF,IAAI,EAAEE,KAAK,IAAI,EAAE;EAC/B;EAEA,IAAIC,MAAMA,CAAA,EAAoB;IAC5B,OAAO,IAAI,CAACD,KAAK,CAACE,GAAG,CAAC,CAAC;MAAEC;IAAM,CAAC,KAAKA,KAAK,CAAC;EAC7C;EAEAC,WAAWA,CACTC,GAE2D,EAC3DC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,OAAO;MAAEC;IAAM,CAAC,GAAGH,GAAG;IAC9B,MAAM;MAAEI;IAAM,CAAC,GAAGH,KAAK;IAEvB,IAAI,MAAM,IAAID,GAAG,EAAE;MACjB,IAAI,CAACP,IAAI,GAAGW,KAAK,CAACC,OAAO,CAACL,GAAG,CAACP,IAAI,CAAC;MACnC,IAAI,CAACC,QAAQ,GAAG,IAAI,CAACD,IAAI,EAAEa,IAAI,IAAI,QAAQ;IAC7C;IAEA,IAAIC,UAAU,GAAGjB,GAAG,CAAC,IAAI,CAACI,QAAQ,CAAC,CAAC,CAAC,CAClCc,KAAK,CAAC,GAAG,IAAI,CAACZ,MAAM,CAAC,CACrBa,KAAK,CAACN,KAAK,CAAC,CACZO,QAAQ,CAAC,CAAC;IAEb,IAAIR,OAAO,CAACS,wBAAwB,EAAE;MACpCJ,UAAU,GAAGA,UAAU,CAACK,QAAQ,CAACV,OAAO,CAACS,wBAAwB,CAAC;IACpE;IAEA,IAAI,CAACJ,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACM,WAAW,GAAGN,UAAU,CAACO,OAAO,CAAC,IAAI,CAAC,CAACC,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACb,OAAO,GAAGA,OAAO;EACxB;EAEAc,qBAAqBA,CACnBC,KAA0B,EACmB;IAC7C,MAAM;MAAEC,IAAI;MAAEvB;IAAM,CAAC,GAAG,IAAI;IAE5B,MAAMG,KAAK,GAAGmB,KAAK,CAACC,IAAI,CAAC;;IAEzB;IACA,MAAMtB,MAAM,GAAG,IAAI,CAACuB,OAAO,CAACrB,KAAK,CAAC,GAAG,CAACA,KAAK,CAAC,CAACsB,IAAI,CAAC,CAAC,GAAG,EAAE;IACxD,MAAMC,QAAQ,GAAG1B,KAAK,CAAC2B,MAAM,CAAEC,IAAI,IAAK3B,MAAM,CAAC4B,QAAQ,CAACD,IAAI,CAACzB,KAAK,CAAC,CAAC;IAEpE,OAAOuB,QAAQ,CAACI,EAAE,CAAC,CAAC,CAAC,EAAE3B,KAAK;EAC9B;EAEA4B,yBAAyBA,CAACT,KAA0B,EAAE;IACpD,MAAM;MAAEtB;IAAM,CAAC,GAAG,IAAI;;IAEtB;IACA,MAAMG,KAAK,GAAG,IAAI,CAACkB,qBAAqB,CAACC,KAAK,CAAC;IAC/C,MAAMrB,MAAM,GAAG,CAACE,KAAK,IAAI,EAAE,CAAC,CAACsB,IAAI,CAAC,CAAC;IAEnC,OAAOzB,KAAK,CACT2B,MAAM,CAAEC,IAAI,IAAK3B,MAAM,CAAC4B,QAAQ,CAACD,IAAI,CAACzB,KAAK,CAAC,CAAC,CAC7CD,GAAG,CAAE0B,IAAI,IAAKA,IAAI,CAACI,IAAI,CAAC,CACxBC,IAAI,CAAC,IAAI,CAAC;EACf;EAEAC,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAM;MAAEpC,KAAK,EAAEqC;IAAU,CAAC,GAAG,IAAI;IAEjC,MAAMC,SAAS,GAAG,KAAK,CAACJ,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,MAAM;MAAEjC;IAAM,CAAC,GAAGmC,SAAS;;IAE3B;IACA,MAAMrC,MAAM,GAAG,IAAI,CAACuB,OAAO,CAACrB,KAAK,CAAC,GAAG,CAACA,KAAK,CAAC,CAACsB,IAAI,CAAC,CAAC,GAAG,EAAE;IAExD,MAAMzB,KAAK,GAAGqC,SAAS,CAACnC,GAAG,CAAE0B,IAAI,IAAK;MACpC,MAAMF,QAAQ,GAAGzB,MAAM,CAAC4B,QAAQ,CAACD,IAAI,CAACzB,KAAK,CAAC;MAC5C,MAAMoC,SAAmB,GAAG;QAAE,GAAGX,IAAI;QAAEF;MAAS,CAAC;MAEjD,IAAIE,IAAI,CAACY,WAAW,EAAE;QACpBD,SAAS,CAACE,IAAI,GAAG;UACfT,IAAI,EAAEJ,IAAI,CAACY;QACb,CAAC;MACH;MAEA,OAAOD,SAAS;IAClB,CAAC,CAAC;IAEF,OAAO;MACL,GAAGD,SAAS;MACZtC;IACF,CAAC;EACH;AACF","ignoreList":[]}
+{"version":3,"file":"ListFormComponent.js","names":["joi","FormComponent","messageTemplate","ListFormComponent","list","listType","items","values","map","value","constructor","def","props","options","model","getList","type","formSchema","valid","label","required","customValidationMessages","messages","stateSchema","default","allow","getFormValueFromState","state","name","isValue","flat","selected","filter","item","includes","at","getDisplayStringFromState","text","join","getViewModel","payload","errors","listItems","viewModel","itemModel","description","hint","getAllPossibleErrors","baseErrors","template","selectRequired","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/ListFormComponent.ts"],"sourcesContent":["import {\n  type Item,\n  type List,\n  type ListComponentsDef,\n  type SelectionComponentsDef,\n  type YesNoFieldComponent\n} from '@defra/forms-model'\nimport joi, {\n  type ArraySchema,\n  type BooleanSchema,\n  type NumberSchema,\n  type StringSchema\n} from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type ListItem } from '~/src/server/plugins/engine/components/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nexport class ListFormComponent extends FormComponent {\n  declare options: Extract<\n    SelectionComponentsDef,\n    { options: object }\n  >['options']\n\n  declare formSchema:\n    | ArraySchema<string>\n    | ArraySchema<number>\n    | BooleanSchema<string>\n    | NumberSchema<string>\n    | NumberSchema\n    | StringSchema\n\n  declare stateSchema:\n    | ArraySchema<string>\n    | ArraySchema<number>\n    | BooleanSchema<string>\n    | NumberSchema<string>\n    | NumberSchema\n    | StringSchema\n\n  list?: List\n  listType: List['type'] = 'string'\n\n  get items(): Item[] {\n    return this.list?.items ?? []\n  }\n\n  get values(): Item['value'][] {\n    return this.items.map(({ value }) => value)\n  }\n\n  constructor(\n    def:\n      | SelectionComponentsDef // Allow for Yes/No field custom list\n      | (YesNoFieldComponent & Pick<ListComponentsDef, 'list'>),\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n    const { model } = props\n\n    if ('list' in def) {\n      this.list = model.getList(def.list)\n      this.listType = this.list?.type ?? 'string'\n    }\n\n    let formSchema = joi[this.listType]()\n      .valid(...this.values)\n      .label(this.label)\n      .required()\n\n    if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\n\n    this.formSchema = formSchema\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n  }\n\n  getFormValueFromState(\n    state: FormSubmissionState\n  ): Item['value'] | Item['value'][] | undefined {\n    const { name, items } = this\n\n    const value = state[name]\n\n    // Allow for array values via subclass\n    const values = this.isValue(value) ? [value].flat() : []\n    const selected = items.filter((item) => values.includes(item.value))\n\n    return selected.at(0)?.value\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState) {\n    const { items } = this\n\n    // Allow for array values via subclass\n    const value = this.getFormValueFromState(state)\n    const values = [value ?? []].flat()\n\n    return items\n      .filter((item) => values.includes(item.value))\n      .map((item) => item.text)\n      .join(', ')\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const { items: listItems } = this\n\n    const viewModel = super.getViewModel(payload, errors)\n    const { value } = viewModel\n\n    // Support multiple values for checkboxes\n    const values = this.isValue(value) ? [value].flat() : []\n\n    const items = listItems.map((item) => {\n      const selected = values.includes(item.value)\n      const itemModel: ListItem = { ...item, selected }\n\n      if (item.description) {\n        itemModel.hint = {\n          text: item.description\n        }\n      }\n\n      return itemModel\n    })\n\n    return {\n      ...viewModel,\n      items\n    }\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'selectRequired', template: messageTemplate.selectRequired }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAOA,OAAOA,GAAG,MAKH,KAAK;AAEZ,SAASC,aAAa;AAEtB,SAASC,eAAe;AAQxB,OAAO,MAAMC,iBAAiB,SAASF,aAAa,CAAC;EAsBnDG,IAAI;EACJC,QAAQ,GAAiB,QAAQ;EAEjC,IAAIC,KAAKA,CAAA,EAAW;IAClB,OAAO,IAAI,CAACF,IAAI,EAAEE,KAAK,IAAI,EAAE;EAC/B;EAEA,IAAIC,MAAMA,CAAA,EAAoB;IAC5B,OAAO,IAAI,CAACD,KAAK,CAACE,GAAG,CAAC,CAAC;MAAEC;IAAM,CAAC,KAAKA,KAAK,CAAC;EAC7C;EAEAC,WAAWA,CACTC,GAE2D,EAC3DC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IACvB,MAAM;MAAEG;IAAM,CAAC,GAAGF,KAAK;IAEvB,IAAI,MAAM,IAAID,GAAG,EAAE;MACjB,IAAI,CAACP,IAAI,GAAGU,KAAK,CAACC,OAAO,CAACJ,GAAG,CAACP,IAAI,CAAC;MACnC,IAAI,CAACC,QAAQ,GAAG,IAAI,CAACD,IAAI,EAAEY,IAAI,IAAI,QAAQ;IAC7C;IAEA,IAAIC,UAAU,GAAGjB,GAAG,CAAC,IAAI,CAACK,QAAQ,CAAC,CAAC,CAAC,CAClCa,KAAK,CAAC,GAAG,IAAI,CAACX,MAAM,CAAC,CACrBY,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,QAAQ,CAAC,CAAC;IAEb,IAAIP,OAAO,CAACQ,wBAAwB,EAAE;MACpCJ,UAAU,GAAGA,UAAU,CAACK,QAAQ,CAACT,OAAO,CAACQ,wBAAwB,CAAC;IACpE;IAEA,IAAI,CAACJ,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACM,WAAW,GAAGN,UAAU,CAACO,OAAO,CAAC,IAAI,CAAC,CAACC,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACZ,OAAO,GAAGA,OAAO;EACxB;EAEAa,qBAAqBA,CACnBC,KAA0B,EACmB;IAC7C,MAAM;MAAEC,IAAI;MAAEtB;IAAM,CAAC,GAAG,IAAI;IAE5B,MAAMG,KAAK,GAAGkB,KAAK,CAACC,IAAI,CAAC;;IAEzB;IACA,MAAMrB,MAAM,GAAG,IAAI,CAACsB,OAAO,CAACpB,KAAK,CAAC,GAAG,CAACA,KAAK,CAAC,CAACqB,IAAI,CAAC,CAAC,GAAG,EAAE;IACxD,MAAMC,QAAQ,GAAGzB,KAAK,CAAC0B,MAAM,CAAEC,IAAI,IAAK1B,MAAM,CAAC2B,QAAQ,CAACD,IAAI,CAACxB,KAAK,CAAC,CAAC;IAEpE,OAAOsB,QAAQ,CAACI,EAAE,CAAC,CAAC,CAAC,EAAE1B,KAAK;EAC9B;EAEA2B,yBAAyBA,CAACT,KAA0B,EAAE;IACpD,MAAM;MAAErB;IAAM,CAAC,GAAG,IAAI;;IAEtB;IACA,MAAMG,KAAK,GAAG,IAAI,CAACiB,qBAAqB,CAACC,KAAK,CAAC;IAC/C,MAAMpB,MAAM,GAAG,CAACE,KAAK,IAAI,EAAE,CAAC,CAACqB,IAAI,CAAC,CAAC;IAEnC,OAAOxB,KAAK,CACT0B,MAAM,CAAEC,IAAI,IAAK1B,MAAM,CAAC2B,QAAQ,CAACD,IAAI,CAACxB,KAAK,CAAC,CAAC,CAC7CD,GAAG,CAAEyB,IAAI,IAAKA,IAAI,CAACI,IAAI,CAAC,CACxBC,IAAI,CAAC,IAAI,CAAC;EACf;EAEAC,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAM;MAAEnC,KAAK,EAAEoC;IAAU,CAAC,GAAG,IAAI;IAEjC,MAAMC,SAAS,GAAG,KAAK,CAACJ,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,MAAM;MAAEhC;IAAM,CAAC,GAAGkC,SAAS;;IAE3B;IACA,MAAMpC,MAAM,GAAG,IAAI,CAACsB,OAAO,CAACpB,KAAK,CAAC,GAAG,CAACA,KAAK,CAAC,CAACqB,IAAI,CAAC,CAAC,GAAG,EAAE;IAExD,MAAMxB,KAAK,GAAGoC,SAAS,CAAClC,GAAG,CAAEyB,IAAI,IAAK;MACpC,MAAMF,QAAQ,GAAGxB,MAAM,CAAC2B,QAAQ,CAACD,IAAI,CAACxB,KAAK,CAAC;MAC5C,MAAMmC,SAAmB,GAAG;QAAE,GAAGX,IAAI;QAAEF;MAAS,CAAC;MAEjD,IAAIE,IAAI,CAACY,WAAW,EAAE;QACpBD,SAAS,CAACE,IAAI,GAAG;UACfT,IAAI,EAAEJ,IAAI,CAACY;QACb,CAAC;MACH;MAEA,OAAOD,SAAS;IAClB,CAAC,CAAC;IAEF,OAAO;MACL,GAAGD,SAAS;MACZrC;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACEyC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO;MACLC,UAAU,EAAE,CACV;QAAEhC,IAAI,EAAE,gBAAgB;QAAEiC,QAAQ,EAAE/C,eAAe,CAACgD;MAAe,CAAC,CACrE;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -0,0 +1,24 @@
+import { ComponentBase } from "./ComponentBase.js";
+export class Markdown extends ComponentBase {
+  content;
+  constructor(def, props) {
+    super(def, props);
+    const {
+      content,
+      options
+    } = def;
+    this.content = content;
+    this.options = options;
+  }
+  getViewModel() {
+    const {
+      content,
+      viewModel
+    } = this;
+    return {
+      ...viewModel,
+      content
+    };
+  }
+}
+//# sourceMappingURL=Markdown.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Markdown.js","names":["ComponentBase","Markdown","content","constructor","def","props","options","getViewModel","viewModel"],"sources":["../../../../../src/server/plugins/engine/components/Markdown.ts"],"sourcesContent":["import { type MarkdownComponent } from '@defra/forms-model'\n\nimport { ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js'\n\nexport class Markdown extends ComponentBase {\n  declare options: MarkdownComponent['options']\n  content: MarkdownComponent['content']\n\n  constructor(\n    def: MarkdownComponent,\n    props: ConstructorParameters<typeof ComponentBase>[1]\n  ) {\n    super(def, props)\n\n    const { content, options } = def\n\n    this.content = content\n    this.options = options\n  }\n\n  getViewModel() {\n    const { content, viewModel } = this\n\n    return {\n      ...viewModel,\n      content\n    }\n  }\n}\n"],"mappings":"AAEA,SAASA,aAAa;AAEtB,OAAO,MAAMC,QAAQ,SAASD,aAAa,CAAC;EAE1CE,OAAO;EAEPC,WAAWA,CACTC,GAAsB,EACtBC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEH,OAAO;MAAEI;IAAQ,CAAC,GAAGF,GAAG;IAEhC,IAAI,CAACF,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACI,OAAO,GAAGA,OAAO;EACxB;EAEAC,YAAYA,CAAA,EAAG;IACb,MAAM;MAAEL,OAAO;MAAEM;IAAU,CAAC,GAAG,IAAI;IAEnC,OAAO;MACL,GAAGA,SAAS;MACZN;IACF,CAAC;EACH;AACF","ignoreList":[]}

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 { messageTemplate } from "../pageControllers/validationOptions.js";
+import { convertToLanguageMessages } from "../../../utils/type-utils.js";
 export class MonthYearField extends FormComponent {
   constructor(def, props) {
     super(def, props);
@@ -12,15 +13,17 @@ export class MonthYearField extends FormComponent {
       options
     } = def;
     const isRequired = options.required !== false;
-    const customValidationMessages = {
+    const customValidationMessages = convertToLanguageMessages({
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
       'any.required': messageTemplate.objectMissing,
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
       'number.base': messageTemplate.objectMissing,
       'number.precision': messageTemplate.dateFormat,
       'number.integer': messageTemplate.dateFormat,
       'number.unsafe': messageTemplate.dateFormat,
       'number.min': messageTemplate.dateFormat,
       'number.max': messageTemplate.dateFormat
-    };
+    });
     this.collection = new ComponentCollection([{
       type: ComponentType.NumberField,
       name: `${name}__month`,
@@ -146,6 +149,31 @@ export class MonthYearField extends FormComponent {
   isState(value) {
     return MonthYearField.isMonthYear(value);
   }
+
+  /**
+   * For error preview page that shows all possible errors on a component
+   */
+  getAllPossibleErrors() {
+    return {
+      baseErrors: [{
+        type: 'required',
+        template: messageTemplate.required
+      }, {
+        type: 'dateFormatMonth',
+        template: '{{#label}} must include a month'
+      }, {
+        type: 'dateFormatYear',
+        template: '{{#label}} must include a year'
+      }],
+      advancedSettingsErrors: [{
+        type: 'dateMin',
+        template: messageTemplate.dateMin
+      }, {
+        type: 'dateMax',
+        template: messageTemplate.dateMax
+      }]
+    };
+  }
   static isMonthYear(value) {
     return isFormState(value) && NumberField.isNumber(value.month) && NumberField.isNumber(value.year);
   }

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","messageTemplate","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","getDisplayStringFromState","date","Date","setMonth","month","monthString","toLocaleString","year","getContextValueFromState","getViewModel","payload","errors","viewModel","fieldset","label","hasError","some","error","items","map","model","errorMessage","toString","text","trim","id","legend","isState","isNumber","component","validator","helpers","values","getStateFromValidForm","context","missing","keys","key"],"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 { type DateInputItem } from '~/src/server/plugins/engine/components/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\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 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      '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  getDisplayStringFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\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  getContextValueFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\n    if (\n      !value ||\n      !isValid(\n        parse(`${value.year}-${value.month}-01`, 'yyyy-MM-dd', new Date())\n      )\n    ) {\n      return null\n    }\n\n    return format(`${value.year}-${value.month}-01`, 'yyyy-MM')\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  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 interface MonthYearState extends Record<string, number> {\n  month: number\n  year: number\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    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;AAEpB,SAASC,eAAe;AASxB,OAAO,MAAMC,cAAc,SAASL,aAAa,CAAC;EAMhDM,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,GAAG;MACjD,cAAc,EAAET,eAAe,CAACU,aAAa;MAC7C,aAAa,EAAEV,eAAe,CAACU,aAAa;MAC5C,kBAAkB,EAAEV,eAAe,CAACW,UAAU;MAC9C,gBAAgB,EAAEX,eAAe,CAACW,UAAU;MAC5C,eAAe,EAAEX,eAAe,CAACW,UAAU;MAC3C,YAAY,EAAEX,eAAe,CAACW,UAAU;MACxC,YAAY,EAAEX,eAAe,CAACW;IAChC,CAAC;IAED,IAAI,CAACC,UAAU,GAAG,IAAIjB,mBAAmB,CACvC,CACE;MACEkB,IAAI,EAAEtB,aAAa,CAACQ,WAAW;MAC/BM,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,EAAEtB,aAAa,CAACQ,WAAW;MAC/BM,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,yBAAyBA,CAACJ,KAA0B,EAAE;IACpD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,IAAI,CAACC,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,wBAAwBA,CAACZ,KAA0B,EAAE;IACnD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,IACE,CAACC,KAAK,IACN,CAACpC,OAAO,CACNC,KAAK,CAAC,GAAGmC,KAAK,CAACU,IAAI,IAAIV,KAAK,CAACO,KAAK,KAAK,EAAE,YAAY,EAAE,IAAIF,IAAI,CAAC,CAAC,CACnE,CAAC,EACD;MACA,OAAO,IAAI;IACb;IAEA,OAAO1C,MAAM,CAAC,GAAGqC,KAAK,CAACU,IAAI,IAAIV,KAAK,CAACO,KAAK,KAAK,EAAE,SAAS,CAAC;EAC7D;EAEAK,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAM;MAAE/B,UAAU;MAAEP;IAAK,CAAC,GAAG,IAAI;IAEjC,MAAMuC,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,CAAC5C,IAAI,KAAKA,IAAI,CAAC;;IAE7D;IACA,MAAM6C,KAAsB,GAAGtC,UAAU,CACtC6B,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC,CAC7BQ,GAAG,CAAC,CAAC;MAAEC;IAAM,CAAC,KAAK;MAClB,IAAI;QAAEN,KAAK;QAAEjC,IAAI;QAAEgB,KAAK;QAAET,OAAO;QAAEiC;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;QAC5BjC,OAAO,GAAG,GAAGA,OAAO,qBAAqB,CAACoC,IAAI,CAAC,CAAC;MAClD;;MAEA;MACA;MACA,IAAI,CAAC1D,WAAW,CAAC+B,KAAK,CAAC,EAAE;QACvBA,KAAK,GAAGE,SAAS;MACnB;MAEA,OAAO;QACLe,KAAK;QACLW,EAAE,EAAEL,KAAK,CAACK,EAAE;QACZpD,IAAI,EAAE+C,KAAK,CAAC/C,IAAI;QAChBQ,IAAI;QACJgB,KAAK;QACLT;MACF,CAAC;IACH,CAAC,CAAC;IAEJyB,QAAQ,KAAK;MACXa,MAAM,EAAE;QACNH,IAAI,EAAET,KAAK,CAACS,IAAI;QAChBnC,OAAO,EAAE;MACX;IACF,CAAC;IAED,OAAO;MACL,GAAGwB,SAAS;MACZC,QAAQ;MACRK;IACF,CAAC;EACH;EAEAS,OAAOA,CAAC9B,KAAkC,EAAE;IAC1C,OAAO5B,cAAc,CAAC6B,WAAW,CAACD,KAAK,CAAC;EAC1C;EAEA,OAAOC,WAAWA,CAChBD,KAAkC,EACT;IACzB,OACEhC,WAAW,CAACgC,KAAK,CAAC,IAClB9B,WAAW,CAAC6D,QAAQ,CAAC/B,KAAK,CAACO,KAAK,CAAC,IACjCrC,WAAW,CAAC6D,QAAQ,CAAC/B,KAAK,CAACU,IAAI,CAAC;EAEpC;AACF;AAOA,OAAO,SAAShB,qBAAqBA,CAACsC,SAAyB,EAAE;EAC/D,MAAMC,SAA0B,GAAGA,CAACpB,OAAoB,EAAEqB,OAAO,KAAK;IACpE,MAAM;MAAEnD,UAAU;MAAEP,IAAI;MAAEC;IAAQ,CAAC,GAAGuD,SAAS;IAE/C,MAAMG,MAAM,GAAGH,SAAS,CAAClC,qBAAqB,CAC5CkC,SAAS,CAACI,qBAAqB,CAACvB,OAAO,CACzC,CAAC;IAED,MAAMwB,OAAgB,GAAG;MACvBC,OAAO,EAAEvD,UAAU,CAACwD,IAAI;MACxBC,GAAG,EAAEhE;IACP,CAAC;IAED,IAAI,CAACwD,SAAS,CAACF,OAAO,CAACK,MAAM,CAAC,EAAE;MAC9B,OAAO1D,OAAO,CAACE,QAAQ,KAAK,KAAK,GAC7BuD,OAAO,CAACd,KAAK,CAAC,iBAAiB,EAAEiB,OAAO,CAAC,GACzCxB,OAAO;IACb;IAEA,OAAOA,OAAO;EAChB,CAAC;EAED,OAAOoB,SAAS;AAClB","ignoreList":[]}
+{"version":3,"file":"MonthYearField.js","names":["ComponentType","format","isValid","parse","ComponentCollection","FormComponent","isFormState","isFormValue","NumberField","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","getDisplayStringFromState","date","Date","setMonth","month","monthString","toLocaleString","year","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"],"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 { type DateInputItem } from '~/src/server/plugins/engine/components/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport { convertToLanguageMessages } from '~/src/server/utils/type-utils.js'\n\nexport class 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        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n        'any.required': messageTemplate.objectMissing,\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\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  getDisplayStringFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\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  getContextValueFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\n    if (\n      !value ||\n      !isValid(\n        parse(`${value.year}-${value.month}-01`, 'yyyy-MM-dd', new Date())\n      )\n    ) {\n      return null\n    }\n\n    return format(`${value.year}-${value.month}-01`, 'yyyy-MM')\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 {\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: 'dateMin', template: messageTemplate.dateMin },\n        { type: 'dateMax', 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 interface MonthYearState extends Record<string, number> {\n  month: number\n  year: number\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    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;AAEpB,SAASC,eAAe;AASxB,SAASC,yBAAyB;AAElC,OAAO,MAAMC,cAAc,SAASN,aAAa,CAAC;EAMhDO,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;MACA,cAAc,EAAED,eAAe,CAACW,aAAa;MAC7C;MACA,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,IAAIlB,mBAAmB,CACvC,CACE;MACEmB,IAAI,EAAEvB,aAAa,CAACQ,WAAW;MAC/BO,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,EAAEvB,aAAa,CAACQ,WAAW;MAC/BO,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,yBAAyBA,CAACJ,KAA0B,EAAE;IACpD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,IAAI,CAACC,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,wBAAwBA,CAACZ,KAA0B,EAAE;IACnD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,IACE,CAACC,KAAK,IACN,CAACrC,OAAO,CACNC,KAAK,CAAC,GAAGoC,KAAK,CAACU,IAAI,IAAIV,KAAK,CAACO,KAAK,KAAK,EAAE,YAAY,EAAE,IAAIF,IAAI,CAAC,CAAC,CACnE,CAAC,EACD;MACA,OAAO,IAAI;IACb;IAEA,OAAO3C,MAAM,CAAC,GAAGsC,KAAK,CAACU,IAAI,IAAIV,KAAK,CAACO,KAAK,KAAK,EAAE,SAAS,CAAC;EAC7D;EAEAK,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAM;MAAE/B,UAAU;MAAEP;IAAK,CAAC,GAAG,IAAI;IAEjC,MAAMuC,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,CAAC5C,IAAI,KAAKA,IAAI,CAAC;;IAE7D;IACA,MAAM6C,KAAsB,GAAGtC,UAAU,CACtC6B,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC,CAC7BQ,GAAG,CAAC,CAAC;MAAEC;IAAM,CAAC,KAAK;MAClB,IAAI;QAAEN,KAAK;QAAEjC,IAAI;QAAEgB,KAAK;QAAET,OAAO;QAAEiC;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;QAC5BjC,OAAO,GAAG,GAAGA,OAAO,qBAAqB,CAACoC,IAAI,CAAC,CAAC;MAClD;;MAEA;MACA;MACA,IAAI,CAAC3D,WAAW,CAACgC,KAAK,CAAC,EAAE;QACvBA,KAAK,GAAGE,SAAS;MACnB;MAEA,OAAO;QACLe,KAAK;QACLW,EAAE,EAAEL,KAAK,CAACK,EAAE;QACZpD,IAAI,EAAE+C,KAAK,CAAC/C,IAAI;QAChBQ,IAAI;QACJgB,KAAK;QACLT;MACF,CAAC;IACH,CAAC,CAAC;IAEJyB,QAAQ,KAAK;MACXa,MAAM,EAAE;QACNH,IAAI,EAAET,KAAK,CAACS,IAAI;QAChBnC,OAAO,EAAE;MACX;IACF,CAAC;IAED,OAAO;MACL,GAAGwB,SAAS;MACZC,QAAQ;MACRK;IACF,CAAC;EACH;EAEAS,OAAOA,CAAC9B,KAAkC,EAAE;IAC1C,OAAO5B,cAAc,CAAC6B,WAAW,CAACD,KAAK,CAAC;EAC1C;;EAEA;AACF;AACA;EACE+B,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO;MACLC,UAAU,EAAE,CACV;QAAEhD,IAAI,EAAE,UAAU;QAAEiD,QAAQ,EAAE/D,eAAe,CAACS;MAAS,CAAC,EACxD;QACEK,IAAI,EAAE,iBAAiB;QACvBiD,QAAQ,EAAE;MACZ,CAAC,EACD;QAAEjD,IAAI,EAAE,gBAAgB;QAAEiD,QAAQ,EAAE;MAAiC,CAAC,CACvE;MACDC,sBAAsB,EAAE,CACtB;QAAElD,IAAI,EAAE,SAAS;QAAEiD,QAAQ,EAAE/D,eAAe,CAACiE;MAAQ,CAAC,EACtD;QAAEnD,IAAI,EAAE,SAAS;QAAEiD,QAAQ,EAAE/D,eAAe,CAACkE;MAAQ,CAAC;IAE1D,CAAC;EACH;EAEA,OAAOnC,WAAWA,CAChBD,KAAkC,EACT;IACzB,OACEjC,WAAW,CAACiC,KAAK,CAAC,IAClB/B,WAAW,CAACoE,QAAQ,CAACrC,KAAK,CAACO,KAAK,CAAC,IACjCtC,WAAW,CAACoE,QAAQ,CAACrC,KAAK,CAACU,IAAI,CAAC;EAEpC;AACF;AAOA,OAAO,SAAShB,qBAAqBA,CAAC4C,SAAyB,EAAE;EAC/D,MAAMC,SAA0B,GAAGA,CAAC1B,OAAoB,EAAE2B,OAAO,KAAK;IACpE,MAAM;MAAEzD,UAAU;MAAEP,IAAI;MAAEC;IAAQ,CAAC,GAAG6D,SAAS;IAE/C,MAAMG,MAAM,GAAGH,SAAS,CAACxC,qBAAqB,CAC5CwC,SAAS,CAACI,qBAAqB,CAAC7B,OAAO,CACzC,CAAC;IAED,MAAM8B,OAAgB,GAAG;MACvBC,OAAO,EAAE7D,UAAU,CAAC8D,IAAI;MACxBC,GAAG,EAAEtE;IACP,CAAC;IAED,IAAI,CAAC8D,SAAS,CAACR,OAAO,CAACW,MAAM,CAAC,EAAE;MAC9B,OAAOhE,OAAO,CAACE,QAAQ,KAAK,KAAK,GAC7B6D,OAAO,CAACpB,KAAK,CAAC,iBAAiB,EAAEuB,OAAO,CAAC,GACzC9B,OAAO;IACb;IAEA,OAAOA,OAAO;EAChB,CAAC;EAED,OAAO0B,SAAS;AAClB","ignoreList":[]}

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

@@ -1,15 +1,15 @@
 import Joi from 'joi';
 import { FormComponent } from "./FormComponent.js";
+import { messageTemplate } from "../pageControllers/validationOptions.js";
 export class MultilineTextField extends FormComponent {
   isCharacterOrWordCount = false;
   constructor(def, props) {
     super(def, props);
     const {
       schema,
-      options,
-      title
+      options
     } = def;
-    let formSchema = Joi.string().trim().label(title).required();
+    let formSchema = Joi.string().trim().label(this.label).required();
     if (options.required === false) {
       formSchema = formSchema.allow('');
     }
@@ -45,6 +45,9 @@ export class MultilineTextField extends FormComponent {
       });
     } else if (options.customValidationMessages) {
       formSchema = formSchema.messages(options.customValidationMessages);
+    } else if (typeof schema.max === 'number' && typeof schema.min === 'number') {
+      const minMaxErrorText = this.buildMinMaxText(schema.min, schema.max);
+      formSchema = formSchema.ruleset.min(schema.min).max(schema.max).message(minMaxErrorText);
     }
     this.formSchema = formSchema.default('');
     this.stateSchema = formSchema.default(null).allow(null);
@@ -80,6 +83,32 @@ export class MultilineTextField extends FormComponent {
       rows
     };
   }
+  buildMinMaxText(min, max) {
+    const minMaxError = messageTemplate.minMax;
+    return minMaxError.replace('{{#min}}', min ? min.toString() : '[min length]').replace('{{#max}}', max ? max.toString() : '[max length]');
+  }
+
+  /**
+   * For error preview page that shows all possible errors on a component
+   */
+  getAllPossibleErrors() {
+    return {
+      baseErrors: [{
+        type: 'required',
+        template: messageTemplate.required
+      }],
+      advancedSettingsErrors: [{
+        type: 'min',
+        template: messageTemplate.min
+      }, {
+        type: 'max',
+        template: messageTemplate.max
+      }, {
+        type: 'minMax',
+        template: this.buildMinMaxText(this.schema.min, this.schema.max)
+      }]
+    };
+  }
 }
 function getValidatorMaxWords(component) {
   const validator = (value, helpers) => {

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

@@ -1 +1 @@
-{"version":3,"file":"MultilineTextField.js","names":["Joi","FormComponent","MultilineTextField","isCharacterOrWordCount","constructor","def","props","schema","options","title","formSchema","string","trim","label","required","allow","length","max","min","maxWords","custom","getValidatorMaxWords","regex","pattern","RegExp","customValidationMessage","message","messages","customValidationMessages","default","stateSchema","getViewModel","payload","errors","viewModel","maxlength","maxwords","rows","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 {\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, title } = def\n\n    let formSchema = Joi.string().trim().label(title).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    }\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\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;AAMtB,OAAO,MAAMC,kBAAkB,SAASD,aAAa,CAAC;EAMpDE,sBAAsB,GAAG,KAAK;EAE9BC,WAAWA,CACTC,GAAgC,EAChCC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,MAAM;MAAEC,OAAO;MAAEC;IAAM,CAAC,GAAGJ,GAAG;IAEtC,IAAIK,UAAU,GAAGV,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,CAAC,CAACC,KAAK,CAACJ,KAAK,CAAC,CAACK,QAAQ,CAAC,CAAC;IAE5D,IAAIN,OAAO,CAACM,QAAQ,KAAK,KAAK,EAAE;MAC9BJ,UAAU,GAAGA,UAAU,CAACK,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAI,OAAOR,MAAM,CAACS,MAAM,KAAK,QAAQ,EAAE;MACrC,IAAI,OAAOT,MAAM,CAACU,GAAG,KAAK,QAAQ,EAAE;QAClCP,UAAU,GAAGA,UAAU,CAACO,GAAG,CAACV,MAAM,CAACU,GAAG,CAAC;QACvC,IAAI,CAACd,sBAAsB,GAAG,IAAI;MACpC;MAEA,IAAI,OAAOI,MAAM,CAACW,GAAG,KAAK,QAAQ,EAAE;QAClCR,UAAU,GAAGA,UAAU,CAACQ,GAAG,CAACX,MAAM,CAACW,GAAG,CAAC;MACzC;IACF,CAAC,MAAM;MACLR,UAAU,GAAGA,UAAU,CAACM,MAAM,CAACT,MAAM,CAACS,MAAM,CAAC;IAC/C;IAEA,IAAI,OAAOR,OAAO,CAACW,QAAQ,KAAK,QAAQ,EAAE;MACxCT,UAAU,GAAGA,UAAU,CAACU,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;MACxCZ,UAAU,GAAGA,UAAU,CAACa,OAAO,CAACA,OAAO,CAAC;IAC1C;IAEA,IAAIf,OAAO,CAACiB,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGlB,OAAO,CAACiB,uBAAuB;MAE/Cf,UAAU,GAAGA,UAAU,CAACiB,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;MAC3ClB,UAAU,GAAGA,UAAU,CAACiB,QAAQ,CAACnB,OAAO,CAACoB,wBAAwB,CAAC;IACpE;IAEA,IAAI,CAAClB,UAAU,GAAGA,UAAU,CAACmB,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGpB,UAAU,CAACmB,OAAO,CAAC,IAAI,CAAC,CAACd,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACP,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACD,MAAM,GAAGA,MAAM;EACtB;EAEAwB,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAM;MAAE1B,MAAM;MAAEC,OAAO;MAAEL;IAAuB,CAAC,GAAG,IAAI;IAExD,MAAM+B,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,IAAI;MAAEE,SAAS;MAAEC,QAAQ;MAAEC;IAAK,CAAC,GAAGH,SAAS;IAE7C,IAAI3B,MAAM,CAACU,GAAG,EAAE;MACdkB,SAAS,GAAG5B,MAAM,CAACU,GAAG;IACxB;IAEA,IAAIT,OAAO,CAACW,QAAQ,EAAE;MACpBiB,QAAQ,GAAG5B,OAAO,CAACW,QAAQ;IAC7B;IAEA,IAAIX,OAAO,CAAC6B,IAAI,EAAE;MAChBA,IAAI,GAAG7B,OAAO,CAAC6B,IAAI;IACrB;IAEA,OAAO;MACL,GAAGH,SAAS;MACZ/B,sBAAsB;MACtBgC,SAAS;MACTC,QAAQ;MACRC;IACF,CAAC;EACH;AACF;AAEA,SAAShB,oBAAoBA,CAACiB,SAA6B,EAAE;EAC3D,MAAMC,SAA0B,GAAGA,CAACC,KAAa,EAAEC,OAAO,KAAK;IAC7D,MAAM;MAAEjC;IAAQ,CAAC,GAAG8B,SAAS;IAE7B,MAAM;MACJb,uBAAuB,EAAEL,MAAM;MAC/BD,QAAQ,EAAEuB,KAAK,CAAC;IAClB,CAAC,GAAGlC,OAAO;IAEX,IAAI,CAACkC,KAAK,IAAIC,KAAK,CAACH,KAAK,CAAC,IAAIE,KAAK,EAAE;MACnC,OAAOF,KAAK;IACd;IAEA,OAAOpB,MAAM,GACTqB,OAAO,CAACf,OAAO,CAAC;MAAEN;IAAO,CAAC,EAAE;MAAEsB;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,CAAC9B,MAAM;EACtB;EAEA,OAAOuB,SAAS;AAClB","ignoreList":[]}
+{"version":3,"file":"MultilineTextField.js","names":["Joi","FormComponent","messageTemplate","MultilineTextField","isCharacterOrWordCount","constructor","def","props","schema","options","formSchema","string","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","replace","toString","getAllPossibleErrors","baseErrors","type","template","advancedSettingsErrors","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().trim().label(this.label).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    return {\n      baseErrors: [{ type: 'required', template: messageTemplate.required }],\n      advancedSettingsErrors: [\n        { type: 'min', template: messageTemplate.min },\n        { type: 'max', template: messageTemplate.max },\n        {\n          type: 'minMax',\n          template: this.buildMinMaxText(this.schema.min, this.schema.max)\n        }\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,CAACC,IAAI,CAAC,CAAC,CAACC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CAACC,QAAQ,CAAC,CAAC;IAEjE,IAAIL,OAAO,CAACK,QAAQ,KAAK,KAAK,EAAE;MAC9BJ,UAAU,GAAGA,UAAU,CAACK,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAI,OAAOP,MAAM,CAACQ,MAAM,KAAK,QAAQ,EAAE;MACrC,IAAI,OAAOR,MAAM,CAACS,GAAG,KAAK,QAAQ,EAAE;QAClCP,UAAU,GAAGA,UAAU,CAACO,GAAG,CAACT,MAAM,CAACS,GAAG,CAAC;QACvC,IAAI,CAACb,sBAAsB,GAAG,IAAI;MACpC;MAEA,IAAI,OAAOI,MAAM,CAACU,GAAG,KAAK,QAAQ,EAAE;QAClCR,UAAU,GAAGA,UAAU,CAACQ,GAAG,CAACV,MAAM,CAACU,GAAG,CAAC;MACzC;IACF,CAAC,MAAM;MACLR,UAAU,GAAGA,UAAU,CAACM,MAAM,CAACR,MAAM,CAACQ,MAAM,CAAC;IAC/C;IAEA,IAAI,OAAOP,OAAO,CAACU,QAAQ,KAAK,QAAQ,EAAE;MACxCT,UAAU,GAAGA,UAAU,CAACU,MAAM,CAC5BC,oBAAoB,CAAC,IAAI,CAAC,EAC1B,sBACF,CAAC;MAED,IAAI,CAACjB,sBAAsB,GAAG,IAAI;IACpC;IAEA,IAAII,MAAM,CAACc,KAAK,EAAE;MAChB,MAAMC,OAAO,GAAG,IAAIC,MAAM,CAAChB,MAAM,CAACc,KAAK,CAAC;MACxCZ,UAAU,GAAGA,UAAU,CAACa,OAAO,CAACA,OAAO,CAAC;IAC1C;IAEA,IAAId,OAAO,CAACgB,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGjB,OAAO,CAACgB,uBAAuB;MAE/Cf,UAAU,GAAGA,UAAU,CAACiB,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,IAAIjB,OAAO,CAACmB,wBAAwB,EAAE;MAC3ClB,UAAU,GAAGA,UAAU,CAACiB,QAAQ,CAAClB,OAAO,CAACmB,wBAAwB,CAAC;IACpE,CAAC,MAAM,IACL,OAAOpB,MAAM,CAACS,GAAG,KAAK,QAAQ,IAC9B,OAAOT,MAAM,CAACU,GAAG,KAAK,QAAQ,EAC9B;MACA,MAAMW,eAAe,GAAG,IAAI,CAACC,eAAe,CAACtB,MAAM,CAACU,GAAG,EAAEV,MAAM,CAACS,GAAG,CAAC;MACpEP,UAAU,GAAGA,UAAU,CAACqB,OAAO,CAC5Bb,GAAG,CAACV,MAAM,CAACU,GAAG,CAAC,CACfD,GAAG,CAACT,MAAM,CAACS,GAAG,CAAC,CACfS,OAAO,CAACG,eAAe,CAAC;IAC7B;IAEA,IAAI,CAACnB,UAAU,GAAGA,UAAU,CAACsB,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGvB,UAAU,CAACsB,OAAO,CAAC,IAAI,CAAC,CAACjB,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACN,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACD,MAAM,GAAGA,MAAM;EACtB;EAEA0B,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAM;MAAE5B,MAAM;MAAEC,OAAO;MAAEL;IAAuB,CAAC,GAAG,IAAI;IAExD,MAAMiC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,IAAI;MAAEE,SAAS;MAAEC,QAAQ;MAAEC;IAAK,CAAC,GAAGH,SAAS;IAE7C,IAAI7B,MAAM,CAACS,GAAG,EAAE;MACdqB,SAAS,GAAG9B,MAAM,CAACS,GAAG;IACxB;IAEA,IAAIR,OAAO,CAACU,QAAQ,EAAE;MACpBoB,QAAQ,GAAG9B,OAAO,CAACU,QAAQ;IAC7B;IAEA,IAAIV,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;EAEAV,eAAeA,CAACZ,GAAY,EAAED,GAAY,EAAU;IAClD,MAAMwB,WAAW,GAAGvC,eAAe,CAACwC,MAAgB;IACpD,OAAOD,WAAW,CACfE,OAAO,CAAC,UAAU,EAAEzB,GAAG,GAAGA,GAAG,CAAC0B,QAAQ,CAAC,CAAC,GAAG,cAAc,CAAC,CAC1DD,OAAO,CAAC,UAAU,EAAE1B,GAAG,GAAGA,GAAG,CAAC2B,QAAQ,CAAC,CAAC,GAAG,cAAc,CAAC;EAC/D;;EAEA;AACF;AACA;EACEC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO;MACLC,UAAU,EAAE,CAAC;QAAEC,IAAI,EAAE,UAAU;QAAEC,QAAQ,EAAE9C,eAAe,CAACY;MAAS,CAAC,CAAC;MACtEmC,sBAAsB,EAAE,CACtB;QAAEF,IAAI,EAAE,KAAK;QAAEC,QAAQ,EAAE9C,eAAe,CAACgB;MAAI,CAAC,EAC9C;QAAE6B,IAAI,EAAE,KAAK;QAAEC,QAAQ,EAAE9C,eAAe,CAACe;MAAI,CAAC,EAC9C;QACE8B,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAE,IAAI,CAAClB,eAAe,CAAC,IAAI,CAACtB,MAAM,CAACU,GAAG,EAAE,IAAI,CAACV,MAAM,CAACS,GAAG;MACjE,CAAC;IAEL,CAAC;EACH;AACF;AAEA,SAASI,oBAAoBA,CAAC6B,SAA6B,EAAE;EAC3D,MAAMC,SAA0B,GAAGA,CAACC,KAAa,EAAEC,OAAO,KAAK;IAC7D,MAAM;MAAE5C;IAAQ,CAAC,GAAGyC,SAAS;IAE7B,MAAM;MACJzB,uBAAuB,EAAEL,MAAM;MAC/BD,QAAQ,EAAEmC,KAAK,CAAC;IAClB,CAAC,GAAG7C,OAAO;IAEX,IAAI,CAAC6C,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":[]}

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

@@ -6,15 +6,15 @@ export class NumberField extends FormComponent {
     super(def, props);
     const {
       options,
-      schema,
-      title
+      schema
     } = def;
-    let formSchema = joi.number().custom(getValidatorPrecision(this)).label(title).required();
+    let formSchema = joi.number().custom(getValidatorPrecision(this)).label(this.label).required();
     if (options.required === false) {
       formSchema = formSchema.allow('');
     } else {
       const messages = options.customValidationMessages;
       formSchema = formSchema.empty('').messages({
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         'any.required': messages?.['any.required'] ?? messageTemplate.required
       });
     }
@@ -98,6 +98,31 @@ export class NumberField extends FormComponent {
   isValue(value) {
     return NumberField.isNumber(value);
   }
+
+  /**
+   * For error preview page that shows all possible errors on a component
+   */
+  getAllPossibleErrors() {
+    return {
+      baseErrors: [{
+        type: 'required',
+        template: messageTemplate.required
+      }, {
+        type: 'numberInteger',
+        template: messageTemplate.numberInteger
+      }],
+      advancedSettingsErrors: [{
+        type: 'numberMin',
+        template: messageTemplate.numberMin
+      }, {
+        type: 'numberMax',
+        template: messageTemplate.numberMax
+      }, {
+        type: 'numberPrecision',
+        template: messageTemplate.numberPrecision
+      }]
+    };
+  }
   static isNumber(value) {
     return typeof value === 'number';
   }

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","title","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","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 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, title } = def\n\n    let formSchema = joi\n      .number()\n      .custom(getValidatorPrecision(this))\n      .label(title)\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': messages?.['any.required'] ?? messageTemplate.required\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  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;AASxB,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,MAAM;MAAEC;IAAM,CAAC,GAAGJ,GAAG;IAEtC,IAAIK,UAAU,GAAGX,GAAG,CACjBY,MAAM,CAAC,CAAC,CACRC,MAAM,CAACC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CACnCC,KAAK,CAACL,KAAK,CAAC,CACZM,QAAQ,CAAC,CAAC;IAEb,IAAIR,OAAO,CAACQ,QAAQ,KAAK,KAAK,EAAE;MAC9BL,UAAU,GAAGA,UAAU,CAACM,KAAK,CAAC,EAAE,CAAC;IACnC,CAAC,MAAM;MACL,MAAMC,QAAQ,GAAGV,OAAO,CAACW,wBAAwB;MAEjDR,UAAU,GAAGA,UAAU,CAACS,KAAK,CAAC,EAAE,CAAC,CAACF,QAAQ,CAAC;QACzC,cAAc,EAAEA,QAAQ,GAAG,cAAc,CAAC,IAAIf,eAAe,CAACa;MAChE,CAAC,CAAC;IACJ;IAEA,IAAI,OAAOP,MAAM,CAACY,GAAG,KAAK,QAAQ,EAAE;MAClCV,UAAU,GAAGA,UAAU,CAACU,GAAG,CAACZ,MAAM,CAACY,GAAG,CAAC;IACzC;IAEA,IAAI,OAAOZ,MAAM,CAACa,GAAG,KAAK,QAAQ,EAAE;MAClCX,UAAU,GAAGA,UAAU,CAACW,GAAG,CAACb,MAAM,CAACa,GAAG,CAAC;IACzC;IAEA,IAAI,OAAOb,MAAM,CAACc,SAAS,KAAK,QAAQ,IAAId,MAAM,CAACc,SAAS,IAAI,CAAC,EAAE;MACjEZ,UAAU,GAAGA,UAAU,CAACa,OAAO,CAAC,CAAC;IACnC;IAEA,IAAIhB,OAAO,CAACiB,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGlB,OAAO,CAACiB,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,IAAIlB,OAAO,CAACW,wBAAwB,EAAE;MAC3CR,UAAU,GAAGA,UAAU,CAACO,QAAQ,CAACV,OAAO,CAACW,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,CAACT,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,MAAM,GAAGA,MAAM;EACtB;EAEAoB,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;MAAE9B,OAAO;MAAEC;IAAO,CAAC,GAAG,IAAI;IAEhC,MAAM8B,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,OAAO9B,MAAM,CAACc,SAAS,KAAK,WAAW,IAAId,MAAM,CAACc,SAAS,IAAI,CAAC,EAAE;MACpE;MACA;MACAiB,UAAU,CAACG,SAAS,GAAG,SAAS;IAClC;IAEA,IAAInC,OAAO,CAACiC,MAAM,EAAE;MAClBA,MAAM,GAAG;QACPG,IAAI,EAAEpC,OAAO,CAACiC;MAChB,CAAC;IACH;IAEA,IAAIjC,OAAO,CAACkC,MAAM,EAAE;MAClBA,MAAM,GAAG;QACPE,IAAI,EAAEpC,OAAO,CAACkC;MAChB,CAAC;IACH;;IAEA;IACA;IACA,IAAI,CAACxC,WAAW,CAAC+B,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,OAAO7B,WAAW,CAACyC,QAAQ,CAACZ,KAAK,CAAC;EACpC;EAEA,OAAOY,QAAQA,CAACZ,KAAkC,EAAmB;IACnE,OAAO,OAAOA,KAAK,KAAK,QAAQ;EAClC;AACF;AAEA,OAAO,SAASnB,qBAAqBA,CAACgC,SAAsB,EAAE;EAC5D,MAAMC,SAA0B,GAAGA,CAACd,KAAa,EAAEe,OAAO,KAAK;IAC7D,MAAM;MAAExC,OAAO;MAAEC;IAAO,CAAC,GAAGqC,SAAS;IAErC,MAAM;MAAErB,uBAAuB,EAAEZ;IAAO,CAAC,GAAGL,OAAO;IACnD,MAAM;MAAEe,SAAS,EAAE0B;IAAM,CAAC,GAAGxC,MAAM;IAEnC,IAAI,CAACwC,KAAK,IAAIA,KAAK,IAAI,CAAC,EAAE;MACxB,OAAOhB,KAAK;IACd;IAEA,MAAMiB,gBAAgB,GAAGlD,GAAG,CACzBY,MAAM,CAAC,CAAC,CACRW,SAAS,CAAC0B,KAAK,CAAC,CAChBE,KAAK,CAAC;MAAEC,OAAO,EAAE;IAAM,CAAC,CAAC;IAE5B,IAAI;MACF,OAAOpD,GAAG,CAACqD,OAAO,CAACpB,KAAK,EAAEiB,gBAAgB,CAAC;IAC7C,CAAC,CAAC,MAAM;MACN,OAAOrC,MAAM,GACTmC,OAAO,CAACtB,OAAO,CAAC;QAAEb;MAAO,CAAC,EAAE;QAAEoC;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","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        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\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 {\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;QACA,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,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":[]}

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

@@ -1,4 +1,5 @@
 import { ListFormComponent } from "./ListFormComponent.js";
+import { messageTemplate } from "../pageControllers/validationOptions.js";
 /**
  * "Selection controls" are checkboxes and radios (and switches), as per Material UI nomenclature.
  */
@@ -39,5 +40,18 @@ export class SelectionControlField extends ListFormComponent {
       items
     };
   }
+
+  /**
+   * For error preview page that shows all possible errors on a component
+   */
+  getAllPossibleErrors() {
+    return {
+      baseErrors: [{
+        type: 'selectRequired',
+        template: messageTemplate.selectRequired
+      }],
+      advancedSettingsErrors: []
+    };
+  }
 }
 //# sourceMappingURL=SelectionControlField.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"SelectionControlField.js","names":["ListFormComponent","SelectionControlField","getViewModel","payload","errors","options","viewModel","fieldset","items","label","legend","text","classes","map","item","selected","checked","itemModel","bold"],"sources":["../../../../../src/server/plugins/engine/components/SelectionControlField.ts"],"sourcesContent":["import { ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js'\nimport { type ListItem } from '~/src/server/plugins/engine/components/types.js'\nimport {\n  type FormPayload,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\n\n/**\n * \"Selection controls\" are checkboxes and radios (and switches), as per Material UI nomenclature.\n */\nexport class SelectionControlField extends ListFormComponent {\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const { options } = this\n\n    const viewModel = super.getViewModel(payload, errors)\n    let { fieldset, items, label } = viewModel\n\n    fieldset ??= {\n      legend: {\n        text: label.text,\n        classes: 'govuk-fieldset__legend--m'\n      }\n    }\n\n    items = items.map((item) => {\n      const { selected: checked } = item\n      const itemModel = { ...item, checked } satisfies ListItem\n\n      if ('bold' in options && options.bold) {\n        itemModel.label ??= {}\n        itemModel.label.classes = 'govuk-label--s'\n      }\n\n      return itemModel\n    })\n\n    return {\n      ...viewModel,\n      fieldset,\n      items\n    }\n  }\n}\n"],"mappings":"AAAA,SAASA,iBAAiB;AAO1B;AACA;AACA;AACA,OAAO,MAAMC,qBAAqB,SAASD,iBAAiB,CAAC;EAC3DE,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAM;MAAEC;IAAQ,CAAC,GAAG,IAAI;IAExB,MAAMC,SAAS,GAAG,KAAK,CAACJ,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,IAAI;MAAEG,QAAQ;MAAEC,KAAK;MAAEC;IAAM,CAAC,GAAGH,SAAS;IAE1CC,QAAQ,KAAK;MACXG,MAAM,EAAE;QACNC,IAAI,EAAEF,KAAK,CAACE,IAAI;QAChBC,OAAO,EAAE;MACX;IACF,CAAC;IAEDJ,KAAK,GAAGA,KAAK,CAACK,GAAG,CAAEC,IAAI,IAAK;MAC1B,MAAM;QAAEC,QAAQ,EAAEC;MAAQ,CAAC,GAAGF,IAAI;MAClC,MAAMG,SAAS,GAAG;QAAE,GAAGH,IAAI;QAAEE;MAAQ,CAAoB;MAEzD,IAAI,MAAM,IAAIX,OAAO,IAAIA,OAAO,CAACa,IAAI,EAAE;QACrCD,SAAS,CAACR,KAAK,KAAK,CAAC,CAAC;QACtBQ,SAAS,CAACR,KAAK,CAACG,OAAO,GAAG,gBAAgB;MAC5C;MAEA,OAAOK,SAAS;IAClB,CAAC,CAAC;IAEF,OAAO;MACL,GAAGX,SAAS;MACZC,QAAQ;MACRC;IACF,CAAC;EACH;AACF","ignoreList":[]}
+{"version":3,"file":"SelectionControlField.js","names":["ListFormComponent","messageTemplate","SelectionControlField","getViewModel","payload","errors","options","viewModel","fieldset","items","label","legend","text","classes","map","item","selected","checked","itemModel","bold","getAllPossibleErrors","baseErrors","type","template","selectRequired","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/SelectionControlField.ts"],"sourcesContent":["import { ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js'\nimport { type ListItem } from '~/src/server/plugins/engine/components/types.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\n\n/**\n * \"Selection controls\" are checkboxes and radios (and switches), as per Material UI nomenclature.\n */\nexport class SelectionControlField extends ListFormComponent {\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const { options } = this\n\n    const viewModel = super.getViewModel(payload, errors)\n    let { fieldset, items, label } = viewModel\n\n    fieldset ??= {\n      legend: {\n        text: label.text,\n        classes: 'govuk-fieldset__legend--m'\n      }\n    }\n\n    items = items.map((item) => {\n      const { selected: checked } = item\n      const itemModel = { ...item, checked } satisfies ListItem\n\n      if ('bold' in options && options.bold) {\n        itemModel.label ??= {}\n        itemModel.label.classes = 'govuk-label--s'\n      }\n\n      return itemModel\n    })\n\n    return {\n      ...viewModel,\n      fieldset,\n      items\n    }\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'selectRequired', template: messageTemplate.selectRequired }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAAA,SAASA,iBAAiB;AAE1B,SAASC,eAAe;AAOxB;AACA;AACA;AACA,OAAO,MAAMC,qBAAqB,SAASF,iBAAiB,CAAC;EAC3DG,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAM;MAAEC;IAAQ,CAAC,GAAG,IAAI;IAExB,MAAMC,SAAS,GAAG,KAAK,CAACJ,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,IAAI;MAAEG,QAAQ;MAAEC,KAAK;MAAEC;IAAM,CAAC,GAAGH,SAAS;IAE1CC,QAAQ,KAAK;MACXG,MAAM,EAAE;QACNC,IAAI,EAAEF,KAAK,CAACE,IAAI;QAChBC,OAAO,EAAE;MACX;IACF,CAAC;IAEDJ,KAAK,GAAGA,KAAK,CAACK,GAAG,CAAEC,IAAI,IAAK;MAC1B,MAAM;QAAEC,QAAQ,EAAEC;MAAQ,CAAC,GAAGF,IAAI;MAClC,MAAMG,SAAS,GAAG;QAAE,GAAGH,IAAI;QAAEE;MAAQ,CAAoB;MAEzD,IAAI,MAAM,IAAIX,OAAO,IAAIA,OAAO,CAACa,IAAI,EAAE;QACrCD,SAAS,CAACR,KAAK,KAAK,CAAC,CAAC;QACtBQ,SAAS,CAACR,KAAK,CAACG,OAAO,GAAG,gBAAgB;MAC5C;MAEA,OAAOK,SAAS;IAClB,CAAC,CAAC;IAEF,OAAO;MACL,GAAGX,SAAS;MACZC,QAAQ;MACRC;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACEW,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO;MACLC,UAAU,EAAE,CACV;QAAEC,IAAI,EAAE,gBAAgB;QAAEC,QAAQ,EAAEtB,eAAe,CAACuB;MAAe,CAAC,CACrE;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -1,15 +1,15 @@
 import joi from 'joi';
 import { FormComponent } from "./FormComponent.js";
 import { addClassOptionIfNone } from "./helpers.js";
+import { messageTemplate } from "../pageControllers/validationOptions.js";
 const PATTERN = /^[0-9\\\s+()-]*$/;
 export class TelephoneNumberField extends FormComponent {
   constructor(def, props) {
     super(def, props);
     const {
-      options,
-      title
+      options
     } = def;
-    let formSchema = joi.string().trim().pattern(PATTERN).label(title).required();
+    let formSchema = joi.string().trim().pattern(PATTERN).label(this.label).required();
     if (options.required === false) {
       formSchema = formSchema.allow('');
     }
@@ -39,5 +39,21 @@ export class TelephoneNumberField extends FormComponent {
       type: 'tel'
     };
   }
+
+  /**
+   * For error preview page that shows all possible errors on a component
+   */
+  getAllPossibleErrors() {
+    return {
+      baseErrors: [{
+        type: 'required',
+        template: messageTemplate.required
+      }, {
+        type: 'format',
+        template: messageTemplate.format
+      }],
+      advancedSettingsErrors: []
+    };
+  }
 }
 //# sourceMappingURL=TelephoneNumberField.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"TelephoneNumberField.js","names":["joi","FormComponent","addClassOptionIfNone","PATTERN","TelephoneNumberField","constructor","def","props","options","title","formSchema","string","trim","pattern","label","required","allow","customValidationMessage","message","messages","customValidationMessages","default","stateSchema","getViewModel","payload","errors","viewModel","attributes","autocomplete","type"],"sources":["../../../../../src/server/plugins/engine/components/TelephoneNumberField.ts"],"sourcesContent":["import { type TelephoneNumberFieldComponent } from '@defra/forms-model'\nimport joi, { type StringSchema } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers.js'\nimport {\n  type FormPayload,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\n\nconst PATTERN = /^[0-9\\\\\\s+()-]*$/\n\nexport class TelephoneNumberField extends FormComponent {\n  declare options: TelephoneNumberFieldComponent['options']\n  declare formSchema: StringSchema\n  declare stateSchema: StringSchema\n\n  constructor(\n    def: TelephoneNumberFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options, title } = def\n\n    let formSchema = joi\n      .string()\n      .trim()\n      .pattern(PATTERN)\n      .label(title)\n      .required()\n\n    if (options.required === false) {\n      formSchema = formSchema.allow('')\n    }\n\n    if (options.customValidationMessage) {\n      const message = options.customValidationMessage\n\n      formSchema = formSchema.messages({\n        'any.required': message,\n        'string.empty': message,\n        'string.pattern.base': message\n      })\n    } else if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\n\n    addClassOptionIfNone(options, 'govuk-input--width-20')\n\n    this.formSchema = formSchema.default('')\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const viewModel = super.getViewModel(payload, errors)\n    const { attributes } = viewModel\n\n    attributes.autocomplete = 'tel'\n\n    return {\n      ...viewModel,\n      type: 'tel'\n    }\n  }\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAA6B,KAAK;AAE5C,SAASC,aAAa;AACtB,SAASC,oBAAoB;AAM7B,MAAMC,OAAO,GAAG,kBAAkB;AAElC,OAAO,MAAMC,oBAAoB,SAASH,aAAa,CAAC;EAKtDI,WAAWA,CACTC,GAAkC,EAClCC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,OAAO;MAAEC;IAAM,CAAC,GAAGH,GAAG;IAE9B,IAAII,UAAU,GAAGV,GAAG,CACjBW,MAAM,CAAC,CAAC,CACRC,IAAI,CAAC,CAAC,CACNC,OAAO,CAACV,OAAO,CAAC,CAChBW,KAAK,CAACL,KAAK,CAAC,CACZM,QAAQ,CAAC,CAAC;IAEb,IAAIP,OAAO,CAACO,QAAQ,KAAK,KAAK,EAAE;MAC9BL,UAAU,GAAGA,UAAU,CAACM,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAIR,OAAO,CAACS,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGV,OAAO,CAACS,uBAAuB;MAE/CP,UAAU,GAAGA,UAAU,CAACS,QAAQ,CAAC;QAC/B,cAAc,EAAED,OAAO;QACvB,cAAc,EAAEA,OAAO;QACvB,qBAAqB,EAAEA;MACzB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIV,OAAO,CAACY,wBAAwB,EAAE;MAC3CV,UAAU,GAAGA,UAAU,CAACS,QAAQ,CAACX,OAAO,CAACY,wBAAwB,CAAC;IACpE;IAEAlB,oBAAoB,CAACM,OAAO,EAAE,uBAAuB,CAAC;IAEtD,IAAI,CAACE,UAAU,GAAGA,UAAU,CAACW,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGZ,UAAU,CAACW,OAAO,CAAC,IAAI,CAAC,CAACL,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACR,OAAO,GAAGA,OAAO;EACxB;EAEAe,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,MAAM;MAAEE;IAAW,CAAC,GAAGD,SAAS;IAEhCC,UAAU,CAACC,YAAY,GAAG,KAAK;IAE/B,OAAO;MACL,GAAGF,SAAS;MACZG,IAAI,EAAE;IACR,CAAC;EACH;AACF","ignoreList":[]}
+{"version":3,"file":"TelephoneNumberField.js","names":["joi","FormComponent","addClassOptionIfNone","messageTemplate","PATTERN","TelephoneNumberField","constructor","def","props","options","formSchema","string","trim","pattern","label","required","allow","customValidationMessage","message","messages","customValidationMessages","default","stateSchema","getViewModel","payload","errors","viewModel","attributes","autocomplete","type","getAllPossibleErrors","baseErrors","template","format","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/TelephoneNumberField.ts"],"sourcesContent":["import { type TelephoneNumberFieldComponent } from '@defra/forms-model'\nimport joi, { type StringSchema } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers.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\nconst PATTERN = /^[0-9\\\\\\s+()-]*$/\n\nexport class TelephoneNumberField extends FormComponent {\n  declare options: TelephoneNumberFieldComponent['options']\n  declare formSchema: StringSchema\n  declare stateSchema: StringSchema\n\n  constructor(\n    def: TelephoneNumberFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n\n    let formSchema = joi\n      .string()\n      .trim()\n      .pattern(PATTERN)\n      .label(this.label)\n      .required()\n\n    if (options.required === false) {\n      formSchema = formSchema.allow('')\n    }\n\n    if (options.customValidationMessage) {\n      const message = options.customValidationMessage\n\n      formSchema = formSchema.messages({\n        'any.required': message,\n        'string.empty': message,\n        'string.pattern.base': message\n      })\n    } else if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\n\n    addClassOptionIfNone(options, 'govuk-input--width-20')\n\n    this.formSchema = formSchema.default('')\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const viewModel = super.getViewModel(payload, errors)\n    const { attributes } = viewModel\n\n    attributes.autocomplete = 'tel'\n\n    return {\n      ...viewModel,\n      type: 'tel'\n    }\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'required', template: messageTemplate.required },\n        { type: 'format', template: messageTemplate.format }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAA6B,KAAK;AAE5C,SAASC,aAAa;AACtB,SAASC,oBAAoB;AAC7B,SAASC,eAAe;AAOxB,MAAMC,OAAO,GAAG,kBAAkB;AAElC,OAAO,MAAMC,oBAAoB,SAASJ,aAAa,CAAC;EAKtDK,WAAWA,CACTC,GAAkC,EAClCC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IAEvB,IAAIG,UAAU,GAAGV,GAAG,CACjBW,MAAM,CAAC,CAAC,CACRC,IAAI,CAAC,CAAC,CACNC,OAAO,CAACT,OAAO,CAAC,CAChBU,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,IAAIP,OAAO,CAACQ,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGT,OAAO,CAACQ,uBAAuB;MAE/CP,UAAU,GAAGA,UAAU,CAACS,QAAQ,CAAC;QAC/B,cAAc,EAAED,OAAO;QACvB,cAAc,EAAEA,OAAO;QACvB,qBAAqB,EAAEA;MACzB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIT,OAAO,CAACW,wBAAwB,EAAE;MAC3CV,UAAU,GAAGA,UAAU,CAACS,QAAQ,CAACV,OAAO,CAACW,wBAAwB,CAAC;IACpE;IAEAlB,oBAAoB,CAACO,OAAO,EAAE,uBAAuB,CAAC;IAEtD,IAAI,CAACC,UAAU,GAAGA,UAAU,CAACW,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGZ,UAAU,CAACW,OAAO,CAAC,IAAI,CAAC,CAACL,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACP,OAAO,GAAGA,OAAO;EACxB;EAEAc,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,MAAM;MAAEE;IAAW,CAAC,GAAGD,SAAS;IAEhCC,UAAU,CAACC,YAAY,GAAG,KAAK;IAE/B,OAAO;MACL,GAAGF,SAAS;MACZG,IAAI,EAAE;IACR,CAAC;EACH;;EAEA;AACF;AACA;EACEC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO;MACLC,UAAU,EAAE,CACV;QAAEF,IAAI,EAAE,UAAU;QAAEG,QAAQ,EAAE7B,eAAe,CAACY;MAAS,CAAC,EACxD;QAAEc,IAAI,EAAE,QAAQ;QAAEG,QAAQ,EAAE7B,eAAe,CAAC8B;MAAO,CAAC,CACrD;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -1,14 +1,14 @@
 import joi from 'joi';
 import { FormComponent, isFormValue } from "./FormComponent.js";
+import { messageTemplate } from "../pageControllers/validationOptions.js";
 export class TextField extends FormComponent {
   constructor(def, props) {
     super(def, props);
     const {
-      options,
-      title
+      options
     } = def;
     const schema = 'schema' in def ? def.schema : {};
-    let formSchema = joi.string().trim().label(title).required();
+    let formSchema = joi.string().trim().label(this.label).required();
     if (options.required === false) {
       formSchema = formSchema.allow('');
     }
@@ -56,6 +56,25 @@ export class TextField extends FormComponent {
   isValue(value) {
     return TextField.isText(value);
   }
+
+  /**
+   * For error preview page that shows all possible errors on a component
+   */
+  getAllPossibleErrors() {
+    return {
+      baseErrors: [{
+        type: 'required',
+        template: messageTemplate.required
+      }],
+      advancedSettingsErrors: [{
+        type: 'min',
+        template: messageTemplate.min
+      }, {
+        type: 'max',
+        template: messageTemplate.max
+      }]
+    };
+  }
   static isText(value) {
     return isFormValue(value) && typeof value === 'string';
   }

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

@@ -1 +1 @@
-{"version":3,"file":"TextField.js","names":["joi","FormComponent","isFormValue","TextField","constructor","def","props","options","title","schema","formSchema","string","trim","label","required","allow","length","max","min","regex","pattern","RegExp","customValidationMessage","message","messages","customValidationMessages","default","stateSchema","getFormValueFromState","state","name","getFormValue","value","isValue","undefined","isText"],"sources":["../../../../../src/server/plugins/engine/components/TextField.ts"],"sourcesContent":["import {\n  type EmailAddressFieldComponent,\n  type TextFieldComponent\n} from '@defra/forms-model'\nimport joi, { type StringSchema } from 'joi'\n\nimport {\n  FormComponent,\n  isFormValue\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport {\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nexport class TextField extends FormComponent {\n  declare options:\n    | TextFieldComponent['options']\n    | EmailAddressFieldComponent['options']\n\n  declare schema: TextFieldComponent['schema']\n\n  declare formSchema: StringSchema\n  declare stateSchema: StringSchema\n\n  constructor(\n    def: TextFieldComponent | EmailAddressFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options, title } = def\n    const schema = 'schema' in def ? def.schema : {}\n\n    let formSchema = joi.string().trim().label(title).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      }\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 (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      })\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  isValue(value?: FormStateValue | FormState): value is string {\n    return TextField.isText(value)\n  }\n\n  static isText(value?: FormStateValue | FormState): value is string {\n    return isFormValue(value) && typeof value === 'string'\n  }\n}\n"],"mappings":"AAIA,OAAOA,GAAG,MAA6B,KAAK;AAE5C,SACEC,aAAa,EACbC,WAAW;AAQb,OAAO,MAAMC,SAAS,SAASF,aAAa,CAAC;EAU3CG,WAAWA,CACTC,GAAoD,EACpDC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,OAAO;MAAEC;IAAM,CAAC,GAAGH,GAAG;IAC9B,MAAMI,MAAM,GAAG,QAAQ,IAAIJ,GAAG,GAAGA,GAAG,CAACI,MAAM,GAAG,CAAC,CAAC;IAEhD,IAAIC,UAAU,GAAGV,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,CAAC,CAACC,KAAK,CAACL,KAAK,CAAC,CAACM,QAAQ,CAAC,CAAC;IAE5D,IAAIP,OAAO,CAACO,QAAQ,KAAK,KAAK,EAAE;MAC9BJ,UAAU,GAAGA,UAAU,CAACK,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAI,OAAON,MAAM,CAACO,MAAM,KAAK,QAAQ,EAAE;MACrC,IAAI,OAAOP,MAAM,CAACQ,GAAG,KAAK,QAAQ,EAAE;QAClCP,UAAU,GAAGA,UAAU,CAACO,GAAG,CAACR,MAAM,CAACQ,GAAG,CAAC;MACzC;MAEA,IAAI,OAAOR,MAAM,CAACS,GAAG,KAAK,QAAQ,EAAE;QAClCR,UAAU,GAAGA,UAAU,CAACQ,GAAG,CAACT,MAAM,CAACS,GAAG,CAAC;MACzC;IACF,CAAC,MAAM;MACLR,UAAU,GAAGA,UAAU,CAACM,MAAM,CAACP,MAAM,CAACO,MAAM,CAAC;IAC/C;IAEA,IAAIP,MAAM,CAACU,KAAK,EAAE;MAChB,MAAMC,OAAO,GAAG,IAAIC,MAAM,CAACZ,MAAM,CAACU,KAAK,CAAC;MACxCT,UAAU,GAAGA,UAAU,CAACU,OAAO,CAACA,OAAO,CAAC;IAC1C;IAEA,IAAIb,OAAO,CAACe,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGhB,OAAO,CAACe,uBAAuB;MAE/CZ,UAAU,GAAGA,UAAU,CAACc,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;MACzB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIhB,OAAO,CAACkB,wBAAwB,EAAE;MAC3Cf,UAAU,GAAGA,UAAU,CAACc,QAAQ,CAACjB,OAAO,CAACkB,wBAAwB,CAAC;IACpE;IAEA,IAAI,CAACf,UAAU,GAAGA,UAAU,CAACgB,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGjB,UAAU,CAACgB,OAAO,CAAC,IAAI,CAAC,CAACX,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACR,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACE,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;EAEAD,OAAOA,CAACD,KAAkC,EAAmB;IAC3D,OAAO7B,SAAS,CAACgC,MAAM,CAACH,KAAK,CAAC;EAChC;EAEA,OAAOG,MAAMA,CAACH,KAAkC,EAAmB;IACjE,OAAO9B,WAAW,CAAC8B,KAAK,CAAC,IAAI,OAAOA,KAAK,KAAK,QAAQ;EACxD;AACF","ignoreList":[]}
+{"version":3,"file":"TextField.js","names":["joi","FormComponent","isFormValue","messageTemplate","TextField","constructor","def","props","options","schema","formSchema","string","trim","label","required","allow","length","max","min","regex","pattern","RegExp","customValidationMessage","message","messages","customValidationMessages","default","stateSchema","getFormValueFromState","state","name","getFormValue","value","isValue","undefined","isText","getAllPossibleErrors","baseErrors","type","template","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/TextField.ts"],"sourcesContent":["import {\n  type EmailAddressFieldComponent,\n  type TextFieldComponent\n} from '@defra/forms-model'\nimport joi, { type StringSchema } 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 FormState,\n  type FormStateValue,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nexport class TextField extends FormComponent {\n  declare options:\n    | TextFieldComponent['options']\n    | EmailAddressFieldComponent['options']\n\n  declare schema: TextFieldComponent['schema']\n\n  declare formSchema: StringSchema\n  declare stateSchema: StringSchema\n\n  constructor(\n    def: TextFieldComponent | EmailAddressFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n    const schema = 'schema' in def ? def.schema : {}\n\n    let formSchema = joi.string().trim().label(this.label).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      }\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 (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      })\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  isValue(value?: FormStateValue | FormState): value is string {\n    return TextField.isText(value)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  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  static isText(value?: FormStateValue | FormState): value is string {\n    return isFormValue(value) && typeof value === 'string'\n  }\n}\n"],"mappings":"AAIA,OAAOA,GAAG,MAA6B,KAAK;AAE5C,SACEC,aAAa,EACbC,WAAW;AAEb,SAASC,eAAe;AAQxB,OAAO,MAAMC,SAAS,SAASH,aAAa,CAAC;EAU3CI,WAAWA,CACTC,GAAoD,EACpDC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IACvB,MAAMG,MAAM,GAAG,QAAQ,IAAIH,GAAG,GAAGA,GAAG,CAACG,MAAM,GAAG,CAAC,CAAC;IAEhD,IAAIC,UAAU,GAAGV,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,CAAC,CAACC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CAACC,QAAQ,CAAC,CAAC;IAEjE,IAAIN,OAAO,CAACM,QAAQ,KAAK,KAAK,EAAE;MAC9BJ,UAAU,GAAGA,UAAU,CAACK,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAI,OAAON,MAAM,CAACO,MAAM,KAAK,QAAQ,EAAE;MACrC,IAAI,OAAOP,MAAM,CAACQ,GAAG,KAAK,QAAQ,EAAE;QAClCP,UAAU,GAAGA,UAAU,CAACO,GAAG,CAACR,MAAM,CAACQ,GAAG,CAAC;MACzC;MAEA,IAAI,OAAOR,MAAM,CAACS,GAAG,KAAK,QAAQ,EAAE;QAClCR,UAAU,GAAGA,UAAU,CAACQ,GAAG,CAACT,MAAM,CAACS,GAAG,CAAC;MACzC;IACF,CAAC,MAAM;MACLR,UAAU,GAAGA,UAAU,CAACM,MAAM,CAACP,MAAM,CAACO,MAAM,CAAC;IAC/C;IAEA,IAAIP,MAAM,CAACU,KAAK,EAAE;MAChB,MAAMC,OAAO,GAAG,IAAIC,MAAM,CAACZ,MAAM,CAACU,KAAK,CAAC;MACxCT,UAAU,GAAGA,UAAU,CAACU,OAAO,CAACA,OAAO,CAAC;IAC1C;IAEA,IAAIZ,OAAO,CAACc,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGf,OAAO,CAACc,uBAAuB;MAE/CZ,UAAU,GAAGA,UAAU,CAACc,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;MACzB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIf,OAAO,CAACiB,wBAAwB,EAAE;MAC3Cf,UAAU,GAAGA,UAAU,CAACc,QAAQ,CAAChB,OAAO,CAACiB,wBAAwB,CAAC;IACpE;IAEA,IAAI,CAACf,UAAU,GAAGA,UAAU,CAACgB,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGjB,UAAU,CAACgB,OAAO,CAAC,IAAI,CAAC,CAACX,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACP,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;EAEAD,OAAOA,CAACD,KAAkC,EAAmB;IAC3D,OAAO5B,SAAS,CAAC+B,MAAM,CAACH,KAAK,CAAC;EAChC;;EAEA;AACF;AACA;EACEI,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO;MACLC,UAAU,EAAE,CAAC;QAAEC,IAAI,EAAE,UAAU;QAAEC,QAAQ,EAAEpC,eAAe,CAACW;MAAS,CAAC,CAAC;MACtE0B,sBAAsB,EAAE,CACtB;QAAEF,IAAI,EAAE,KAAK;QAAEC,QAAQ,EAAEpC,eAAe,CAACe;MAAI,CAAC,EAC9C;QAAEoB,IAAI,EAAE,KAAK;QAAEC,QAAQ,EAAEpC,eAAe,CAACc;MAAI,CAAC;IAElD,CAAC;EACH;EAEA,OAAOkB,MAAMA,CAACH,KAAkC,EAAmB;IACjE,OAAO9B,WAAW,CAAC8B,KAAK,CAAC,IAAI,OAAOA,KAAK,KAAK,QAAQ;EACxD;AACF","ignoreList":[]}