@defra/forms-engine-plugin 0.0.1

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

@@ -0,0 +1,210 @@
+import { ComponentBase } from "./ComponentBase.js";
+import { optionalText } from "./constants.js";
+export class FormComponent extends ComponentBase {
+  type;
+  hint;
+  isFormComponent = true;
+  constructor(def, props) {
+    super(def, props);
+    const {
+      hint,
+      type
+    } = def;
+    this.type = type;
+    this.hint = hint;
+  }
+  get keys() {
+    const {
+      collection,
+      name
+    } = this;
+    if (collection) {
+      const {
+        fields
+      } = collection;
+      return [name, ...fields.map(({
+        name
+      }) => name)];
+    }
+    return [name];
+  }
+  getFormDataFromState(state) {
+    const {
+      collection,
+      name
+    } = this;
+    if (collection) {
+      return collection.getFormDataFromState(state);
+    }
+    return {
+      [name]: this.getFormValue(state[name])
+    };
+  }
+  getFormValueFromState(state) {
+    const {
+      collection,
+      name
+    } = this;
+    if (collection) {
+      return collection.getFormValueFromState(state);
+    }
+    return this.getFormValue(state[name]);
+  }
+  getFormValue(value) {
+    return this.isValue(value) ? value : undefined;
+  }
+  getStateFromValidForm(payload) {
+    const {
+      collection,
+      name
+    } = this;
+    if (collection) {
+      return collection.getStateFromValidForm(payload);
+    }
+    return {
+      [name]: this.getFormValue(payload[name]) ?? null
+    };
+  }
+  getErrors(errors) {
+    const {
+      name
+    } = this;
+
+    // Filter component and child errors only
+    const list = errors?.filter(error => error.name === name || error.path.includes(name) || this.keys.includes(error.name));
+    if (!list?.length) {
+      return;
+    }
+    return list;
+  }
+  getError(errors) {
+    return this.getErrors(errors)?.[0];
+  }
+  getViewModel(payload, errors) {
+    const {
+      hint,
+      name,
+      options = {},
+      title,
+      viewModel
+    } = this;
+    const isRequired = !('required' in options) || options.required !== false;
+    const hideOptional = 'optionalText' in options && options.optionalText;
+    const label = `${title}${!isRequired && !hideOptional ? optionalText : ''}`;
+    if (hint) {
+      viewModel.hint = {
+        text: hint
+      };
+    }
+
+    // Filter component errors only
+    const componentErrors = this.getErrors(errors);
+    const componentError = this.getError(componentErrors);
+    if (componentErrors) {
+      viewModel.errors = componentErrors;
+    }
+    if (componentError) {
+      viewModel.errorMessage = {
+        text: componentError.text
+      };
+    }
+    return {
+      ...viewModel,
+      label: {
+        text: label
+      },
+      id: name,
+      name,
+      value: payload[name]
+    };
+  }
+  getDisplayStringFromState(state) {
+    const value = this.getFormValueFromState(state);
+    return this.isValue(value) ? value.toString() : '';
+  }
+  getContextValueFromState(state) {
+    const value = this.getFormValueFromState(state);
+
+    // Filter object field values
+    if (this.isState(value)) {
+      const values = Object.values(value).filter(isFormValue);
+      return values.length ? values : null;
+    }
+
+    // Filter array field values
+    if (this.isValue(value) && Array.isArray(value)) {
+      return value.filter(isFormValue);
+    }
+    return this.isValue(value) ? value : null;
+  }
+  isValue(value) {
+    return isFormValue(value);
+  }
+  isState(value) {
+    return isFormState(value);
+  }
+}
+
+/**
+ * Check for form value
+ */
+export function isFormValue(value) {
+  return typeof value === 'string' && value.length > 0 || typeof value === 'number' || typeof value === 'boolean';
+}
+
+/**
+ * Check for form state with nested values
+ */
+export function isFormState(value) {
+  if (value === null || typeof value !== 'object' || Array.isArray(value)) {
+    return false;
+  }
+
+  // Skip empty objects
+  return !!Object.values(value).length;
+}
+
+/**
+ * Check for repeat list state
+ */
+export function isRepeatState(value) {
+  if (!Array.isArray(value)) {
+    return false;
+  }
+
+  // Skip checks when empty
+  if (!value.length) {
+    return true;
+  }
+  return value.every(isRepeatValue);
+}
+
+/**
+ * Check for repeat list value
+ */
+export function isRepeatValue(value) {
+  return isFormState(value) && typeof value.itemId === 'string';
+}
+
+/**
+ * Check for upload state
+ */
+export function isUploadState(value) {
+  if (!Array.isArray(value)) {
+    return false;
+  }
+
+  // Skip checks when empty
+  if (!value.length) {
+    return true;
+  }
+  return value.every(isUploadValue);
+}
+
+/**
+ * Check for upload state value
+ */
+export function isUploadValue(value) {
+  return isFormState(value) && typeof value.uploadId === 'string';
+}
+//# sourceMappingURL=FormComponent.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FormComponent.js","names":["ComponentBase","optionalText","FormComponent","type","hint","isFormComponent","constructor","def","props","keys","collection","name","fields","map","getFormDataFromState","state","getFormValue","getFormValueFromState","value","isValue","undefined","getStateFromValidForm","payload","getErrors","errors","list","filter","error","path","includes","length","getError","getViewModel","options","title","viewModel","isRequired","required","hideOptional","label","text","componentErrors","componentError","errorMessage","id","getDisplayStringFromState","toString","getContextValueFromState","isState","values","Object","isFormValue","Array","isArray","isFormState","isRepeatState","every","isRepeatValue","itemId","isUploadState","isUploadValue","uploadId"],"sources":["../../../../../src/server/plugins/engine/components/FormComponent.ts"],"sourcesContent":["import { type FormComponentsDef, type Item } from '@defra/forms-model'\n\nimport { ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js'\nimport { optionalText } from '~/src/server/plugins/engine/components/constants.js'\nimport {\n  type FileState,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState,\n  type FormValue,\n  type RepeatItemState,\n  type RepeatListState,\n  type UploadState\n} from '~/src/server/plugins/engine/types.js'\n\nexport class FormComponent extends ComponentBase {\n  type: FormComponentsDef['type']\n  hint: FormComponentsDef['hint']\n\n  isFormComponent = true\n\n  constructor(\n    def: FormComponentsDef,\n    props: ConstructorParameters<typeof ComponentBase>[1]\n  ) {\n    super(def, props)\n\n    const { hint, type } = def\n\n    this.type = type\n    this.hint = hint\n  }\n\n  get keys() {\n    const { collection, name } = this\n\n    if (collection) {\n      const { fields } = collection\n      return [name, ...fields.map(({ name }) => name)]\n    }\n\n    return [name]\n  }\n\n  getFormDataFromState(state: FormSubmissionState): FormPayload {\n    const { collection, name } = this\n\n    if (collection) {\n      return collection.getFormDataFromState(state)\n    }\n\n    return {\n      [name]: this.getFormValue(state[name])\n    }\n  }\n\n  getFormValueFromState(state: FormSubmissionState): FormValue | FormPayload {\n    const { collection, name } = this\n\n    if (collection) {\n      return collection.getFormValueFromState(state)\n    }\n\n    return this.getFormValue(state[name])\n  }\n\n  getFormValue(value?: FormStateValue | FormState) {\n    return this.isValue(value) ? value : undefined\n  }\n\n  getStateFromValidForm(payload: FormPayload): FormState {\n    const { collection, name } = this\n\n    if (collection) {\n      return collection.getStateFromValidForm(payload)\n    }\n\n    return {\n      [name]: this.getFormValue(payload[name]) ?? null\n    }\n  }\n\n  getErrors(errors?: FormSubmissionError[]): FormSubmissionError[] | undefined {\n    const { name } = this\n\n    // Filter component and child errors only\n    const list = errors?.filter(\n      (error) =>\n        error.name === name ||\n        error.path.includes(name) ||\n        this.keys.includes(error.name)\n    )\n\n    if (!list?.length) {\n      return\n    }\n\n    return list\n  }\n\n  getError(errors?: FormSubmissionError[]): FormSubmissionError | undefined {\n    return this.getErrors(errors)?.[0]\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const { hint, name, options = {}, title, viewModel } = this\n\n    const isRequired = !('required' in options) || options.required !== false\n    const hideOptional = 'optionalText' in options && options.optionalText\n    const label = `${title}${!isRequired && !hideOptional ? optionalText : ''}`\n\n    if (hint) {\n      viewModel.hint = {\n        text: hint\n      }\n    }\n\n    // Filter component errors only\n    const componentErrors = this.getErrors(errors)\n    const componentError = this.getError(componentErrors)\n\n    if (componentErrors) {\n      viewModel.errors = componentErrors\n    }\n\n    if (componentError) {\n      viewModel.errorMessage = {\n        text: componentError.text\n      }\n    }\n\n    return {\n      ...viewModel,\n      label: {\n        text: label\n      },\n      id: name,\n      name,\n      value: payload[name]\n    }\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState): string {\n    const value = this.getFormValueFromState(state)\n    return this.isValue(value) ? value.toString() : ''\n  }\n\n  getContextValueFromState(\n    state: FormSubmissionState\n  ): Item['value'] | Item['value'][] | null {\n    const value = this.getFormValueFromState(state)\n\n    // Filter object field values\n    if (this.isState(value)) {\n      const values = Object.values(value).filter(isFormValue)\n      return values.length ? values : null\n    }\n\n    // Filter array field values\n    if (this.isValue(value) && Array.isArray(value)) {\n      return value.filter(isFormValue)\n    }\n\n    return this.isValue(value) ? value : null\n  }\n\n  isValue(\n    value?: FormStateValue | FormState\n  ): value is NonNullable<FormStateValue> {\n    return isFormValue(value)\n  }\n\n  isState(value?: FormStateValue | FormState): value is FormState {\n    return isFormState(value)\n  }\n}\n\n/**\n * Check for form value\n */\nexport function isFormValue(\n  value?: unknown\n): value is string | number | boolean {\n  return (\n    (typeof value === 'string' && value.length > 0) ||\n    typeof value === 'number' ||\n    typeof value === 'boolean'\n  )\n}\n\n/**\n * Check for form state with nested values\n */\nexport function isFormState(value?: unknown): value is FormState {\n  if (value === null || typeof value !== 'object' || Array.isArray(value)) {\n    return false\n  }\n\n  // Skip empty objects\n  return !!Object.values(value).length\n}\n\n/**\n * Check for repeat list state\n */\nexport function isRepeatState(value?: unknown): value is RepeatListState {\n  if (!Array.isArray(value)) {\n    return false\n  }\n\n  // Skip checks when empty\n  if (!value.length) {\n    return true\n  }\n\n  return value.every(isRepeatValue)\n}\n\n/**\n * Check for repeat list value\n */\nexport function isRepeatValue(value?: unknown): value is RepeatItemState {\n  return isFormState(value) && typeof value.itemId === 'string'\n}\n\n/**\n * Check for upload state\n */\nexport function isUploadState(value?: unknown): value is UploadState {\n  if (!Array.isArray(value)) {\n    return false\n  }\n\n  // Skip checks when empty\n  if (!value.length) {\n    return true\n  }\n\n  return value.every(isUploadValue)\n}\n\n/**\n * Check for upload state value\n */\nexport function isUploadValue(value?: unknown): value is FileState {\n  return isFormState(value) && typeof value.uploadId === 'string'\n}\n"],"mappings":"AAEA,SAASA,aAAa;AACtB,SAASC,YAAY;AAcrB,OAAO,MAAMC,aAAa,SAASF,aAAa,CAAC;EAC/CG,IAAI;EACJC,IAAI;EAEJC,eAAe,GAAG,IAAI;EAEtBC,WAAWA,CACTC,GAAsB,EACtBC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEJ,IAAI;MAAED;IAAK,CAAC,GAAGI,GAAG;IAE1B,IAAI,CAACJ,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,IAAI,GAAGA,IAAI;EAClB;EAEA,IAAIK,IAAIA,CAAA,EAAG;IACT,MAAM;MAAEC,UAAU;MAAEC;IAAK,CAAC,GAAG,IAAI;IAEjC,IAAID,UAAU,EAAE;MACd,MAAM;QAAEE;MAAO,CAAC,GAAGF,UAAU;MAC7B,OAAO,CAACC,IAAI,EAAE,GAAGC,MAAM,CAACC,GAAG,CAAC,CAAC;QAAEF;MAAK,CAAC,KAAKA,IAAI,CAAC,CAAC;IAClD;IAEA,OAAO,CAACA,IAAI,CAAC;EACf;EAEAG,oBAAoBA,CAACC,KAA0B,EAAe;IAC5D,MAAM;MAAEL,UAAU;MAAEC;IAAK,CAAC,GAAG,IAAI;IAEjC,IAAID,UAAU,EAAE;MACd,OAAOA,UAAU,CAACI,oBAAoB,CAACC,KAAK,CAAC;IAC/C;IAEA,OAAO;MACL,CAACJ,IAAI,GAAG,IAAI,CAACK,YAAY,CAACD,KAAK,CAACJ,IAAI,CAAC;IACvC,CAAC;EACH;EAEAM,qBAAqBA,CAACF,KAA0B,EAA2B;IACzE,MAAM;MAAEL,UAAU;MAAEC;IAAK,CAAC,GAAG,IAAI;IAEjC,IAAID,UAAU,EAAE;MACd,OAAOA,UAAU,CAACO,qBAAqB,CAACF,KAAK,CAAC;IAChD;IAEA,OAAO,IAAI,CAACC,YAAY,CAACD,KAAK,CAACJ,IAAI,CAAC,CAAC;EACvC;EAEAK,YAAYA,CAACE,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACC,OAAO,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAChD;EAEAC,qBAAqBA,CAACC,OAAoB,EAAa;IACrD,MAAM;MAAEZ,UAAU;MAAEC;IAAK,CAAC,GAAG,IAAI;IAEjC,IAAID,UAAU,EAAE;MACd,OAAOA,UAAU,CAACW,qBAAqB,CAACC,OAAO,CAAC;IAClD;IAEA,OAAO;MACL,CAACX,IAAI,GAAG,IAAI,CAACK,YAAY,CAACM,OAAO,CAACX,IAAI,CAAC,CAAC,IAAI;IAC9C,CAAC;EACH;EAEAY,SAASA,CAACC,MAA8B,EAAqC;IAC3E,MAAM;MAAEb;IAAK,CAAC,GAAG,IAAI;;IAErB;IACA,MAAMc,IAAI,GAAGD,MAAM,EAAEE,MAAM,CACxBC,KAAK,IACJA,KAAK,CAAChB,IAAI,KAAKA,IAAI,IACnBgB,KAAK,CAACC,IAAI,CAACC,QAAQ,CAAClB,IAAI,CAAC,IACzB,IAAI,CAACF,IAAI,CAACoB,QAAQ,CAACF,KAAK,CAAChB,IAAI,CACjC,CAAC;IAED,IAAI,CAACc,IAAI,EAAEK,MAAM,EAAE;MACjB;IACF;IAEA,OAAOL,IAAI;EACb;EAEAM,QAAQA,CAACP,MAA8B,EAAmC;IACxE,OAAO,IAAI,CAACD,SAAS,CAACC,MAAM,CAAC,GAAG,CAAC,CAAC;EACpC;EAEAQ,YAAYA,CAACV,OAAoB,EAAEE,MAA8B,EAAE;IACjE,MAAM;MAAEpB,IAAI;MAAEO,IAAI;MAAEsB,OAAO,GAAG,CAAC,CAAC;MAAEC,KAAK;MAAEC;IAAU,CAAC,GAAG,IAAI;IAE3D,MAAMC,UAAU,GAAG,EAAE,UAAU,IAAIH,OAAO,CAAC,IAAIA,OAAO,CAACI,QAAQ,KAAK,KAAK;IACzE,MAAMC,YAAY,GAAG,cAAc,IAAIL,OAAO,IAAIA,OAAO,CAAChC,YAAY;IACtE,MAAMsC,KAAK,GAAG,GAAGL,KAAK,GAAG,CAACE,UAAU,IAAI,CAACE,YAAY,GAAGrC,YAAY,GAAG,EAAE,EAAE;IAE3E,IAAIG,IAAI,EAAE;MACR+B,SAAS,CAAC/B,IAAI,GAAG;QACfoC,IAAI,EAAEpC;MACR,CAAC;IACH;;IAEA;IACA,MAAMqC,eAAe,GAAG,IAAI,CAAClB,SAAS,CAACC,MAAM,CAAC;IAC9C,MAAMkB,cAAc,GAAG,IAAI,CAACX,QAAQ,CAACU,eAAe,CAAC;IAErD,IAAIA,eAAe,EAAE;MACnBN,SAAS,CAACX,MAAM,GAAGiB,eAAe;IACpC;IAEA,IAAIC,cAAc,EAAE;MAClBP,SAAS,CAACQ,YAAY,GAAG;QACvBH,IAAI,EAAEE,cAAc,CAACF;MACvB,CAAC;IACH;IAEA,OAAO;MACL,GAAGL,SAAS;MACZI,KAAK,EAAE;QACLC,IAAI,EAAED;MACR,CAAC;MACDK,EAAE,EAAEjC,IAAI;MACRA,IAAI;MACJO,KAAK,EAAEI,OAAO,CAACX,IAAI;IACrB,CAAC;EACH;EAEAkC,yBAAyBA,CAAC9B,KAA0B,EAAU;IAC5D,MAAMG,KAAK,GAAG,IAAI,CAACD,qBAAqB,CAACF,KAAK,CAAC;IAC/C,OAAO,IAAI,CAACI,OAAO,CAACD,KAAK,CAAC,GAAGA,KAAK,CAAC4B,QAAQ,CAAC,CAAC,GAAG,EAAE;EACpD;EAEAC,wBAAwBA,CACtBhC,KAA0B,EACc;IACxC,MAAMG,KAAK,GAAG,IAAI,CAACD,qBAAqB,CAACF,KAAK,CAAC;;IAE/C;IACA,IAAI,IAAI,CAACiC,OAAO,CAAC9B,KAAK,CAAC,EAAE;MACvB,MAAM+B,MAAM,GAAGC,MAAM,CAACD,MAAM,CAAC/B,KAAK,CAAC,CAACQ,MAAM,CAACyB,WAAW,CAAC;MACvD,OAAOF,MAAM,CAACnB,MAAM,GAAGmB,MAAM,GAAG,IAAI;IACtC;;IAEA;IACA,IAAI,IAAI,CAAC9B,OAAO,CAACD,KAAK,CAAC,IAAIkC,KAAK,CAACC,OAAO,CAACnC,KAAK,CAAC,EAAE;MAC/C,OAAOA,KAAK,CAACQ,MAAM,CAACyB,WAAW,CAAC;IAClC;IAEA,OAAO,IAAI,CAAChC,OAAO,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAG,IAAI;EAC3C;EAEAC,OAAOA,CACLD,KAAkC,EACI;IACtC,OAAOiC,WAAW,CAACjC,KAAK,CAAC;EAC3B;EAEA8B,OAAOA,CAAC9B,KAAkC,EAAsB;IAC9D,OAAOoC,WAAW,CAACpC,KAAK,CAAC;EAC3B;AACF;;AAEA;AACA;AACA;AACA,OAAO,SAASiC,WAAWA,CACzBjC,KAAe,EACqB;EACpC,OACG,OAAOA,KAAK,KAAK,QAAQ,IAAIA,KAAK,CAACY,MAAM,GAAG,CAAC,IAC9C,OAAOZ,KAAK,KAAK,QAAQ,IACzB,OAAOA,KAAK,KAAK,SAAS;AAE9B;;AAEA;AACA;AACA;AACA,OAAO,SAASoC,WAAWA,CAACpC,KAAe,EAAsB;EAC/D,IAAIA,KAAK,KAAK,IAAI,IAAI,OAAOA,KAAK,KAAK,QAAQ,IAAIkC,KAAK,CAACC,OAAO,CAACnC,KAAK,CAAC,EAAE;IACvE,OAAO,KAAK;EACd;;EAEA;EACA,OAAO,CAAC,CAACgC,MAAM,CAACD,MAAM,CAAC/B,KAAK,CAAC,CAACY,MAAM;AACtC;;AAEA;AACA;AACA;AACA,OAAO,SAASyB,aAAaA,CAACrC,KAAe,EAA4B;EACvE,IAAI,CAACkC,KAAK,CAACC,OAAO,CAACnC,KAAK,CAAC,EAAE;IACzB,OAAO,KAAK;EACd;;EAEA;EACA,IAAI,CAACA,KAAK,CAACY,MAAM,EAAE;IACjB,OAAO,IAAI;EACb;EAEA,OAAOZ,KAAK,CAACsC,KAAK,CAACC,aAAa,CAAC;AACnC;;AAEA;AACA;AACA;AACA,OAAO,SAASA,aAAaA,CAACvC,KAAe,EAA4B;EACvE,OAAOoC,WAAW,CAACpC,KAAK,CAAC,IAAI,OAAOA,KAAK,CAACwC,MAAM,KAAK,QAAQ;AAC/D;;AAEA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAACzC,KAAe,EAAwB;EACnE,IAAI,CAACkC,KAAK,CAACC,OAAO,CAACnC,KAAK,CAAC,EAAE;IACzB,OAAO,KAAK;EACd;;EAEA;EACA,IAAI,CAACA,KAAK,CAACY,MAAM,EAAE;IACjB,OAAO,IAAI;EACb;EAEA,OAAOZ,KAAK,CAACsC,KAAK,CAACI,aAAa,CAAC;AACnC;;AAEA;AACA;AACA;AACA,OAAO,SAASA,aAAaA,CAAC1C,KAAe,EAAsB;EACjE,OAAOoC,WAAW,CAACpC,KAAK,CAAC,IAAI,OAAOA,KAAK,CAAC2C,QAAQ,KAAK,QAAQ;AACjE","ignoreList":[]}

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

@@ -0,0 +1,24 @@
+import { ComponentBase } from "./ComponentBase.js";
+export class Html 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=Html.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Html.js","names":["ComponentBase","Html","content","constructor","def","props","options","getViewModel","viewModel"],"sources":["../../../../../src/server/plugins/engine/components/Html.ts"],"sourcesContent":["import { type HtmlComponent } from '@defra/forms-model'\n\nimport { ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js'\n\nexport class Html extends ComponentBase {\n  declare options: HtmlComponent['options']\n  content: HtmlComponent['content']\n\n  constructor(\n    def: HtmlComponent,\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,IAAI,SAASD,aAAa,CAAC;EAEtCE,OAAO;EAEPC,WAAWA,CACTC,GAAkB,EAClBC,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/InsetText.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"InsetText.js","names":["ComponentBase","InsetText","content","constructor","def","props","getViewModel","viewModel"],"sources":["../../../../../src/server/plugins/engine/components/InsetText.ts"],"sourcesContent":["import { type InsetTextComponent } from '@defra/forms-model'\n\nimport { ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js'\n\nexport class InsetText extends ComponentBase {\n  content: InsetTextComponent['content']\n\n  constructor(\n    def: InsetTextComponent,\n    props: ConstructorParameters<typeof ComponentBase>[1]\n  ) {\n    super(def, props)\n\n    const { content } = def\n\n    this.content = content\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,SAAS,SAASD,aAAa,CAAC;EAC3CE,OAAO;EAEPC,WAAWA,CACTC,GAAuB,EACvBC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEH;IAAQ,CAAC,GAAGE,GAAG;IAEvB,IAAI,CAACF,OAAO,GAAGA,OAAO;EACxB;EAEAI,YAAYA,CAAA,EAAG;IACb,MAAM;MAAEJ,OAAO;MAAEK;IAAU,CAAC,GAAG,IAAI;IAEnC,OAAO;MACL,GAAGA,SAAS;MACZL;IACF,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -0,0 +1,65 @@
+import { ComponentBase } from "./ComponentBase.js";
+export class List extends ComponentBase {
+  hint;
+  list;
+  get items() {
+    return this.list?.items ?? [];
+  }
+  constructor(def, props) {
+    super(def, props);
+    const {
+      hint,
+      list,
+      options
+    } = def;
+    const {
+      model
+    } = props;
+    this.hint = hint;
+    this.list = model.getList(list);
+    this.options = options;
+  }
+  getViewModel() {
+    const {
+      items: listItems,
+      options,
+      viewModel
+    } = this;
+    let {
+      classes,
+      content,
+      items,
+      type
+    } = viewModel;
+    if (options.type) {
+      type = options.type;
+    }
+    if (options.bold) {
+      classes ??= '';
+      classes = `${classes} govuk-!-font-weight-bold`.trim();
+    }
+    content = {
+      title: !options.hideTitle ? this.title : undefined,
+      text: this.hint ?? ''
+    };
+    items = listItems.map(item => {
+      const itemModel = {
+        ...item
+      };
+      if (item.description) {
+        itemModel.hint = {
+          text: item.description
+        };
+      }
+      return itemModel;
+    });
+    return {
+      ...viewModel,
+      type,
+      classes,
+      content,
+      items
+    };
+  }
+}
+//# sourceMappingURL=List.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"List.js","names":["ComponentBase","List","hint","list","items","constructor","def","props","options","model","getList","getViewModel","listItems","viewModel","classes","content","type","bold","trim","title","hideTitle","undefined","text","map","item","itemModel","description"],"sources":["../../../../../src/server/plugins/engine/components/List.ts"],"sourcesContent":["import {\n  type Item,\n  type List as ListType,\n  type ListComponent\n} from '@defra/forms-model'\n\nimport { ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js'\nimport { type ListItem } from '~/src/server/plugins/engine/components/types.js'\n\nexport class List extends ComponentBase {\n  declare options: ListComponent['options']\n  hint: ListComponent['hint']\n  list?: ListType\n\n  get items(): Item[] {\n    return this.list?.items ?? []\n  }\n\n  constructor(\n    def: ListComponent,\n    props: ConstructorParameters<typeof ComponentBase>[1]\n  ) {\n    super(def, props)\n\n    const { hint, list, options } = def\n    const { model } = props\n\n    this.hint = hint\n    this.list = model.getList(list)\n    this.options = options\n  }\n\n  getViewModel() {\n    const { items: listItems, options, viewModel } = this\n\n    let { classes, content, items, type } = viewModel\n\n    if (options.type) {\n      type = options.type\n    }\n\n    if (options.bold) {\n      classes ??= ''\n      classes = `${classes} govuk-!-font-weight-bold`.trim()\n    }\n\n    content = {\n      title: !options.hideTitle ? this.title : undefined,\n      text: this.hint ?? ''\n    }\n\n    items = listItems.map((item) => {\n      const itemModel: ListItem = { ...item }\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      type,\n      classes,\n      content,\n      items\n    }\n  }\n}\n"],"mappings":"AAMA,SAASA,aAAa;AAGtB,OAAO,MAAMC,IAAI,SAASD,aAAa,CAAC;EAEtCE,IAAI;EACJC,IAAI;EAEJ,IAAIC,KAAKA,CAAA,EAAW;IAClB,OAAO,IAAI,CAACD,IAAI,EAAEC,KAAK,IAAI,EAAE;EAC/B;EAEAC,WAAWA,CACTC,GAAkB,EAClBC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEL,IAAI;MAAEC,IAAI;MAAEK;IAAQ,CAAC,GAAGF,GAAG;IACnC,MAAM;MAAEG;IAAM,CAAC,GAAGF,KAAK;IAEvB,IAAI,CAACL,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,IAAI,GAAGM,KAAK,CAACC,OAAO,CAACP,IAAI,CAAC;IAC/B,IAAI,CAACK,OAAO,GAAGA,OAAO;EACxB;EAEAG,YAAYA,CAAA,EAAG;IACb,MAAM;MAAEP,KAAK,EAAEQ,SAAS;MAAEJ,OAAO;MAAEK;IAAU,CAAC,GAAG,IAAI;IAErD,IAAI;MAAEC,OAAO;MAAEC,OAAO;MAAEX,KAAK;MAAEY;IAAK,CAAC,GAAGH,SAAS;IAEjD,IAAIL,OAAO,CAACQ,IAAI,EAAE;MAChBA,IAAI,GAAGR,OAAO,CAACQ,IAAI;IACrB;IAEA,IAAIR,OAAO,CAACS,IAAI,EAAE;MAChBH,OAAO,KAAK,EAAE;MACdA,OAAO,GAAG,GAAGA,OAAO,2BAA2B,CAACI,IAAI,CAAC,CAAC;IACxD;IAEAH,OAAO,GAAG;MACRI,KAAK,EAAE,CAACX,OAAO,CAACY,SAAS,GAAG,IAAI,CAACD,KAAK,GAAGE,SAAS;MAClDC,IAAI,EAAE,IAAI,CAACpB,IAAI,IAAI;IACrB,CAAC;IAEDE,KAAK,GAAGQ,SAAS,CAACW,GAAG,CAAEC,IAAI,IAAK;MAC9B,MAAMC,SAAmB,GAAG;QAAE,GAAGD;MAAK,CAAC;MAEvC,IAAIA,IAAI,CAACE,WAAW,EAAE;QACpBD,SAAS,CAACvB,IAAI,GAAG;UACfoB,IAAI,EAAEE,IAAI,CAACE;QACb,CAAC;MACH;MAEA,OAAOD,SAAS;IAClB,CAAC,CAAC;IAEF,OAAO;MACL,GAAGZ,SAAS;MACZG,IAAI;MACJF,OAAO;MACPC,OAAO;MACPX;IACF,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -0,0 +1,87 @@
+import joi from 'joi';
+import { FormComponent } from "./FormComponent.js";
+export class ListFormComponent extends FormComponent {
+  list;
+  listType = 'string';
+  get items() {
+    return this.list?.items ?? [];
+  }
+  get values() {
+    return this.items.map(({
+      value
+    }) => value);
+  }
+  constructor(def, props) {
+    super(def, props);
+    const {
+      options,
+      title
+    } = def;
+    const {
+      model
+    } = props;
+    if ('list' in def) {
+      this.list = model.getList(def.list);
+      this.listType = this.list?.type ?? 'string';
+    }
+    let formSchema = joi[this.listType]().valid(...this.values).label(title).required();
+    if (options.customValidationMessages) {
+      formSchema = formSchema.messages(options.customValidationMessages);
+    }
+    this.formSchema = formSchema;
+    this.stateSchema = formSchema.default(null).allow(null);
+    this.options = options;
+  }
+  getFormValueFromState(state) {
+    const {
+      name,
+      items
+    } = this;
+    const value = state[name];
+
+    // Allow for array values via subclass
+    const values = this.isValue(value) ? [value].flat() : [];
+    const selected = items.filter(item => values.includes(item.value));
+    return selected.at(0)?.value;
+  }
+  getDisplayStringFromState(state) {
+    const {
+      items
+    } = this;
+
+    // Allow for array values via subclass
+    const value = this.getFormValueFromState(state);
+    const values = [value ?? []].flat();
+    return items.filter(item => values.includes(item.value)).map(item => item.text).join(', ');
+  }
+  getViewModel(payload, errors) {
+    const {
+      items: listItems
+    } = this;
+    const viewModel = super.getViewModel(payload, errors);
+    const {
+      value
+    } = viewModel;
+
+    // Support multiple values for checkboxes
+    const values = this.isValue(value) ? [value].flat() : [];
+    const items = listItems.map(item => {
+      const selected = values.includes(item.value);
+      const itemModel = {
+        ...item,
+        selected
+      };
+      if (item.description) {
+        itemModel.hint = {
+          text: item.description
+        };
+      }
+      return itemModel;
+    });
+    return {
+      ...viewModel,
+      items
+    };
+  }
+}
+//# sourceMappingURL=ListFormComponent.js.map

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

@@ -0,0 +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":[]}

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

@@ -0,0 +1,172 @@
+import { ComponentType } from '@defra/forms-model';
+import { format, isValid, parse } from 'date-fns';
+import { ComponentCollection } from "./ComponentCollection.js";
+import { FormComponent, isFormState, isFormValue } from "./FormComponent.js";
+import { NumberField } from "./NumberField.js";
+import { messageTemplate } from "../pageControllers/validationOptions.js";
+export class MonthYearField extends FormComponent {
+  constructor(def, props) {
+    super(def, props);
+    const {
+      name,
+      options
+    } = def;
+    const isRequired = options.required !== false;
+    const customValidationMessages = {
+      'any.required': messageTemplate.objectMissing,
+      '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`,
+      title: 'Month',
+      schema: {
+        min: 1,
+        max: 12,
+        precision: 0
+      },
+      options: {
+        required: isRequired,
+        optionalText: true,
+        classes: 'govuk-input--width-2',
+        customValidationMessages
+      }
+    }, {
+      type: ComponentType.NumberField,
+      name: `${name}__year`,
+      title: 'Year',
+      schema: {
+        min: 1000,
+        max: 3000,
+        precision: 0
+      },
+      options: {
+        required: isRequired,
+        optionalText: true,
+        classes: 'govuk-input--width-4',
+        customValidationMessages
+      }
+    }], {
+      ...props,
+      parent: this
+    }, {
+      custom: getValidatorMonthYear(this),
+      peers: [`${name}__month`, `${name}__year`]
+    });
+    this.options = options;
+    this.formSchema = this.collection.formSchema;
+    this.stateSchema = this.collection.stateSchema;
+  }
+  getFormValueFromState(state) {
+    const value = super.getFormValueFromState(state);
+    return MonthYearField.isMonthYear(value) ? value : undefined;
+  }
+  getDisplayStringFromState(state) {
+    const value = this.getFormValueFromState(state);
+    if (!value) {
+      return '';
+    }
+    const date = new Date();
+    date.setMonth(value.month - 1);
+    const monthString = date.toLocaleString('default', {
+      month: 'long'
+    });
+    return `${monthString} ${value.year}`;
+  }
+  getContextValueFromState(state) {
+    const value = this.getFormValueFromState(state);
+    if (!value || !isValid(parse(`${value.year}-${value.month}-01`, 'yyyy-MM-dd', new Date()))) {
+      return null;
+    }
+    return format(`${value.year}-${value.month}-01`, 'yyyy-MM');
+  }
+  getViewModel(payload, errors) {
+    const {
+      collection,
+      name
+    } = this;
+    const viewModel = super.getViewModel(payload, errors);
+    let {
+      fieldset,
+      label
+    } = viewModel;
+
+    // Check for component errors only
+    const hasError = errors?.some(error => error.name === name);
+
+    // Use the component collection to generate the subitems
+    const items = collection.getViewModel(payload, errors).map(({
+      model
+    }) => {
+      let {
+        label,
+        type,
+        value,
+        classes,
+        errorMessage
+      } = model;
+      if (label) {
+        label.toString = () => label.text; // Date component uses string labels
+      }
+      if (hasError || errorMessage) {
+        classes = `${classes} govuk-input--error`.trim();
+      }
+
+      // Allow any `toString()`-able value so non-numeric
+      // values are shown alongside their error messages
+      if (!isFormValue(value)) {
+        value = undefined;
+      }
+      return {
+        label,
+        id: model.id,
+        name: model.name,
+        type,
+        value,
+        classes
+      };
+    });
+    fieldset ??= {
+      legend: {
+        text: label.text,
+        classes: 'govuk-fieldset__legend--m'
+      }
+    };
+    return {
+      ...viewModel,
+      fieldset,
+      items
+    };
+  }
+  isState(value) {
+    return MonthYearField.isMonthYear(value);
+  }
+  static isMonthYear(value) {
+    return isFormState(value) && NumberField.isNumber(value.month) && NumberField.isNumber(value.year);
+  }
+}
+export function getValidatorMonthYear(component) {
+  const validator = (payload, helpers) => {
+    const {
+      collection,
+      name,
+      options
+    } = component;
+    const values = component.getFormValueFromState(component.getStateFromValidForm(payload));
+    const context = {
+      missing: collection.keys,
+      key: name
+    };
+    if (!component.isState(values)) {
+      return options.required !== false ? helpers.error('object.required', context) : payload;
+    }
+    return payload;
+  };
+  return validator;
+}
+//# sourceMappingURL=MonthYearField.js.map

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

@@ -0,0 +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":[]}