@defra/forms-engine-plugin 0.0.1

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

@@ -0,0 +1,130 @@
+import { ComponentType } from '@defra/forms-model';
+import { ComponentCollection } from "./ComponentCollection.js";
+import { FormComponent, isFormState } from "./FormComponent.js";
+import { TextField } from "./TextField.js";
+export class UkAddressField extends FormComponent {
+  constructor(def, props) {
+    super(def, props);
+    const {
+      name,
+      options
+    } = def;
+    const isRequired = options.required !== false;
+    const hideOptional = !!options.optionalText;
+    const hideTitle = !!options.hideTitle;
+    this.collection = new ComponentCollection([{
+      type: ComponentType.TextField,
+      name: `${name}__addressLine1`,
+      title: 'Address line 1',
+      schema: {
+        max: 100
+      },
+      options: {
+        autocomplete: 'address-line1',
+        required: isRequired,
+        optionalText: !isRequired && (hideOptional || !hideTitle)
+      }
+    }, {
+      type: ComponentType.TextField,
+      name: `${name}__addressLine2`,
+      title: 'Address line 2',
+      schema: {
+        max: 100
+      },
+      options: {
+        autocomplete: 'address-line2',
+        required: false,
+        optionalText: !isRequired && (hideOptional || !hideTitle)
+      }
+    }, {
+      type: ComponentType.TextField,
+      name: `${name}__town`,
+      title: 'Town or city',
+      schema: {
+        max: 100
+      },
+      options: {
+        autocomplete: 'address-level2',
+        classes: 'govuk-!-width-two-thirds',
+        required: isRequired,
+        optionalText: !isRequired && (hideOptional || !hideTitle)
+      }
+    }, {
+      type: ComponentType.TextField,
+      name: `${name}__postcode`,
+      title: 'Postcode',
+      schema: {
+        regex: '^[a-zA-Z]{1,2}\\d[a-zA-Z\\d]?\\s?\\d[a-zA-Z]{2}$'
+      },
+      options: {
+        autocomplete: 'postal-code',
+        classes: 'govuk-input--width-10',
+        required: isRequired,
+        optionalText: !isRequired && (hideOptional || !hideTitle)
+      }
+    }], {
+      ...props,
+      parent: this
+    });
+    this.options = options;
+    this.formSchema = this.collection.formSchema;
+    this.stateSchema = this.collection.stateSchema;
+  }
+  getFormValueFromState(state) {
+    const value = super.getFormValueFromState(state);
+    return this.isState(value) ? value : undefined;
+  }
+  getDisplayStringFromState(state) {
+    return this.getContextValueFromState(state)?.join(', ') ?? '';
+  }
+  getContextValueFromState(state) {
+    const value = this.getFormValueFromState(state);
+    if (!value) {
+      return null;
+    }
+    return Object.values(value).filter(Boolean);
+  }
+  getViewModel(payload, errors) {
+    const {
+      collection,
+      name,
+      options
+    } = this;
+    const viewModel = super.getViewModel(payload, errors);
+    let {
+      components,
+      fieldset,
+      hint,
+      label
+    } = viewModel;
+    fieldset ??= {
+      legend: {
+        text: label.text,
+        /**
+         * For screen readers, only hide legend visually. This can be overridden
+         * by single component {@link QuestionPageController | `showTitle` handling}
+         */
+        classes: options.hideTitle ? 'govuk-visually-hidden' : 'govuk-fieldset__legend--m'
+      }
+    };
+    if (hint) {
+      hint.id ??= `${name}-hint`;
+      fieldset.attributes ??= {
+        'aria-describedby': hint.id
+      };
+    }
+    components = collection.getViewModel(payload, errors);
+    return {
+      ...viewModel,
+      fieldset,
+      components
+    };
+  }
+  isState(value) {
+    return UkAddressField.isUkAddress(value);
+  }
+  static isUkAddress(value) {
+    return isFormState(value) && TextField.isText(value.addressLine1) && TextField.isText(value.town) && TextField.isText(value.postcode);
+  }
+}
+//# sourceMappingURL=UkAddressField.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UkAddressField.js","names":["ComponentType","ComponentCollection","FormComponent","isFormState","TextField","UkAddressField","constructor","def","props","name","options","isRequired","required","hideOptional","optionalText","hideTitle","collection","type","title","schema","max","autocomplete","classes","regex","parent","formSchema","stateSchema","getFormValueFromState","state","value","isState","undefined","getDisplayStringFromState","getContextValueFromState","join","Object","values","filter","Boolean","getViewModel","payload","errors","viewModel","components","fieldset","hint","label","legend","text","id","attributes","isUkAddress","isText","addressLine1","town","postcode"],"sources":["../../../../../src/server/plugins/engine/components/UkAddressField.ts"],"sourcesContent":["import { ComponentType, type UkAddressFieldComponent } from '@defra/forms-model'\nimport { type ObjectSchema } from 'joi'\n\nimport { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport {\n  FormComponent,\n  isFormState\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { TextField } from '~/src/server/plugins/engine/components/TextField.js'\nimport { type QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.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 UkAddressField extends FormComponent {\n  declare options: UkAddressFieldComponent['options']\n  declare formSchema: ObjectSchema<FormPayload>\n  declare stateSchema: ObjectSchema<FormState>\n  declare collection: ComponentCollection\n\n  constructor(\n    def: UkAddressFieldComponent,\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    const hideOptional = !!options.optionalText\n    const hideTitle = !!options.hideTitle\n\n    this.collection = new ComponentCollection(\n      [\n        {\n          type: ComponentType.TextField,\n          name: `${name}__addressLine1`,\n          title: 'Address line 1',\n          schema: { max: 100 },\n          options: {\n            autocomplete: 'address-line1',\n            required: isRequired,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        },\n        {\n          type: ComponentType.TextField,\n          name: `${name}__addressLine2`,\n          title: 'Address line 2',\n          schema: { max: 100 },\n          options: {\n            autocomplete: 'address-line2',\n            required: false,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        },\n        {\n          type: ComponentType.TextField,\n          name: `${name}__town`,\n          title: 'Town or city',\n          schema: { max: 100 },\n          options: {\n            autocomplete: 'address-level2',\n            classes: 'govuk-!-width-two-thirds',\n            required: isRequired,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        },\n        {\n          type: ComponentType.TextField,\n          name: `${name}__postcode`,\n          title: 'Postcode',\n          schema: {\n            regex: '^[a-zA-Z]{1,2}\\\\d[a-zA-Z\\\\d]?\\\\s?\\\\d[a-zA-Z]{2}$'\n          },\n          options: {\n            autocomplete: 'postal-code',\n            classes: 'govuk-input--width-10',\n            required: isRequired,\n            optionalText: !isRequired && (hideOptional || !hideTitle)\n          }\n        }\n      ],\n      { ...props, parent: this }\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 this.isState(value) ? value : undefined\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState) {\n    return this.getContextValueFromState(state)?.join(', ') ?? ''\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    const value = this.getFormValueFromState(state)\n\n    if (!value) {\n      return null\n    }\n\n    return Object.values(value).filter(Boolean)\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const { collection, name, options } = this\n\n    const viewModel = super.getViewModel(payload, errors)\n    let { components, fieldset, hint, label } = viewModel\n\n    fieldset ??= {\n      legend: {\n        text: label.text,\n\n        /**\n         * For screen readers, only hide legend visually. This can be overridden\n         * by single component {@link QuestionPageController | `showTitle` handling}\n         */\n        classes: options.hideTitle\n          ? 'govuk-visually-hidden'\n          : 'govuk-fieldset__legend--m'\n      }\n    }\n\n    if (hint) {\n      hint.id ??= `${name}-hint`\n      fieldset.attributes ??= {\n        'aria-describedby': hint.id\n      }\n    }\n\n    components = collection.getViewModel(payload, errors)\n\n    return {\n      ...viewModel,\n      fieldset,\n      components\n    }\n  }\n\n  isState(value?: FormStateValue | FormState): value is UkAddressState {\n    return UkAddressField.isUkAddress(value)\n  }\n\n  static isUkAddress(\n    value?: FormStateValue | FormState\n  ): value is UkAddressState {\n    return (\n      isFormState(value) &&\n      TextField.isText(value.addressLine1) &&\n      TextField.isText(value.town) &&\n      TextField.isText(value.postcode)\n    )\n  }\n}\n\nexport interface UkAddressState extends Record<string, string> {\n  addressLine1: string\n  addressLine2: string\n  town: string\n  postcode: string\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAAsC,oBAAoB;AAGhF,SAASC,mBAAmB;AAC5B,SACEC,aAAa,EACbC,WAAW;AAEb,SAASC,SAAS;AAUlB,OAAO,MAAMC,cAAc,SAASH,aAAa,CAAC;EAMhDI,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;IAC7C,MAAMC,YAAY,GAAG,CAAC,CAACH,OAAO,CAACI,YAAY;IAC3C,MAAMC,SAAS,GAAG,CAAC,CAACL,OAAO,CAACK,SAAS;IAErC,IAAI,CAACC,UAAU,GAAG,IAAIf,mBAAmB,CACvC,CACE;MACEgB,IAAI,EAAEjB,aAAa,CAACI,SAAS;MAC7BK,IAAI,EAAE,GAAGA,IAAI,gBAAgB;MAC7BS,KAAK,EAAE,gBAAgB;MACvBC,MAAM,EAAE;QAAEC,GAAG,EAAE;MAAI,CAAC;MACpBV,OAAO,EAAE;QACPW,YAAY,EAAE,eAAe;QAC7BT,QAAQ,EAAED,UAAU;QACpBG,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,EACD;MACEE,IAAI,EAAEjB,aAAa,CAACI,SAAS;MAC7BK,IAAI,EAAE,GAAGA,IAAI,gBAAgB;MAC7BS,KAAK,EAAE,gBAAgB;MACvBC,MAAM,EAAE;QAAEC,GAAG,EAAE;MAAI,CAAC;MACpBV,OAAO,EAAE;QACPW,YAAY,EAAE,eAAe;QAC7BT,QAAQ,EAAE,KAAK;QACfE,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,EACD;MACEE,IAAI,EAAEjB,aAAa,CAACI,SAAS;MAC7BK,IAAI,EAAE,GAAGA,IAAI,QAAQ;MACrBS,KAAK,EAAE,cAAc;MACrBC,MAAM,EAAE;QAAEC,GAAG,EAAE;MAAI,CAAC;MACpBV,OAAO,EAAE;QACPW,YAAY,EAAE,gBAAgB;QAC9BC,OAAO,EAAE,0BAA0B;QACnCV,QAAQ,EAAED,UAAU;QACpBG,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,EACD;MACEE,IAAI,EAAEjB,aAAa,CAACI,SAAS;MAC7BK,IAAI,EAAE,GAAGA,IAAI,YAAY;MACzBS,KAAK,EAAE,UAAU;MACjBC,MAAM,EAAE;QACNI,KAAK,EAAE;MACT,CAAC;MACDb,OAAO,EAAE;QACPW,YAAY,EAAE,aAAa;QAC3BC,OAAO,EAAE,uBAAuB;QAChCV,QAAQ,EAAED,UAAU;QACpBG,YAAY,EAAE,CAACH,UAAU,KAAKE,YAAY,IAAI,CAACE,SAAS;MAC1D;IACF,CAAC,CACF,EACD;MAAE,GAAGP,KAAK;MAAEgB,MAAM,EAAE;IAAK,CAC3B,CAAC;IAED,IAAI,CAACd,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACe,UAAU,GAAG,IAAI,CAACT,UAAU,CAACS,UAAU;IAC5C,IAAI,CAACC,WAAW,GAAG,IAAI,CAACV,UAAU,CAACU,WAAW;EAChD;EAEAC,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAMC,KAAK,GAAG,KAAK,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAChD,OAAO,IAAI,CAACE,OAAO,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGE,SAAS;EAChD;EAEAC,yBAAyBA,CAACJ,KAA0B,EAAE;IACpD,OAAO,IAAI,CAACK,wBAAwB,CAACL,KAAK,CAAC,EAAEM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;EAC/D;EAEAD,wBAAwBA,CAACL,KAA0B,EAAE;IACnD,MAAMC,KAAK,GAAG,IAAI,CAACF,qBAAqB,CAACC,KAAK,CAAC;IAE/C,IAAI,CAACC,KAAK,EAAE;MACV,OAAO,IAAI;IACb;IAEA,OAAOM,MAAM,CAACC,MAAM,CAACP,KAAK,CAAC,CAACQ,MAAM,CAACC,OAAO,CAAC;EAC7C;EAEAC,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAM;MAAEzB,UAAU;MAAEP,IAAI;MAAEC;IAAQ,CAAC,GAAG,IAAI;IAE1C,MAAMgC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,IAAI;MAAEE,UAAU;MAAEC,QAAQ;MAAEC,IAAI;MAAEC;IAAM,CAAC,GAAGJ,SAAS;IAErDE,QAAQ,KAAK;MACXG,MAAM,EAAE;QACNC,IAAI,EAAEF,KAAK,CAACE,IAAI;QAEhB;AACR;AACA;AACA;QACQ1B,OAAO,EAAEZ,OAAO,CAACK,SAAS,GACtB,uBAAuB,GACvB;MACN;IACF,CAAC;IAED,IAAI8B,IAAI,EAAE;MACRA,IAAI,CAACI,EAAE,KAAK,GAAGxC,IAAI,OAAO;MAC1BmC,QAAQ,CAACM,UAAU,KAAK;QACtB,kBAAkB,EAAEL,IAAI,CAACI;MAC3B,CAAC;IACH;IAEAN,UAAU,GAAG3B,UAAU,CAACuB,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IAErD,OAAO;MACL,GAAGC,SAAS;MACZE,QAAQ;MACRD;IACF,CAAC;EACH;EAEAb,OAAOA,CAACD,KAAkC,EAA2B;IACnE,OAAOxB,cAAc,CAAC8C,WAAW,CAACtB,KAAK,CAAC;EAC1C;EAEA,OAAOsB,WAAWA,CAChBtB,KAAkC,EACT;IACzB,OACE1B,WAAW,CAAC0B,KAAK,CAAC,IAClBzB,SAAS,CAACgD,MAAM,CAACvB,KAAK,CAACwB,YAAY,CAAC,IACpCjD,SAAS,CAACgD,MAAM,CAACvB,KAAK,CAACyB,IAAI,CAAC,IAC5BlD,SAAS,CAACgD,MAAM,CAACvB,KAAK,CAAC0B,QAAQ,CAAC;EAEpC;AACF","ignoreList":[]}

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

@@ -0,0 +1,28 @@
+import { SelectionControlField } from "./SelectionControlField.js";
+import { addClassOptionIfNone } from "./helpers.js";
+
+/**
+ * @description
+ * YesNoField is a radiosField with predefined values.
+ */
+export class YesNoField extends SelectionControlField {
+  constructor(def, props) {
+    super({
+      ...def,
+      list: '__yesNo'
+    }, props);
+    const {
+      options
+    } = def;
+    let {
+      formSchema
+    } = this;
+    addClassOptionIfNone(options, 'govuk-radios--inline');
+    if (options.required === false) {
+      formSchema = formSchema.optional();
+    }
+    this.formSchema = formSchema;
+    this.options = options;
+  }
+}
+//# sourceMappingURL=YesNoField.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"YesNoField.js","names":["SelectionControlField","addClassOptionIfNone","YesNoField","constructor","def","props","list","options","formSchema","required","optional"],"sources":["../../../../../src/server/plugins/engine/components/YesNoField.ts"],"sourcesContent":["import { type YesNoFieldComponent } from '@defra/forms-model'\n\nimport { SelectionControlField } from '~/src/server/plugins/engine/components/SelectionControlField.js'\nimport { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers.js'\n\n/**\n * @description\n * YesNoField is a radiosField with predefined values.\n */\nexport class YesNoField extends SelectionControlField {\n  declare options: YesNoFieldComponent['options']\n\n  constructor(\n    def: YesNoFieldComponent,\n    props: ConstructorParameters<typeof SelectionControlField>[1]\n  ) {\n    super({ ...def, list: '__yesNo' }, props)\n\n    const { options } = def\n    let { formSchema } = this\n\n    addClassOptionIfNone(options, 'govuk-radios--inline')\n\n    if (options.required === false) {\n      formSchema = formSchema.optional()\n    }\n\n    this.formSchema = formSchema\n    this.options = options\n  }\n}\n"],"mappings":"AAEA,SAASA,qBAAqB;AAC9B,SAASC,oBAAoB;;AAE7B;AACA;AACA;AACA;AACA,OAAO,MAAMC,UAAU,SAASF,qBAAqB,CAAC;EAGpDG,WAAWA,CACTC,GAAwB,EACxBC,KAA6D,EAC7D;IACA,KAAK,CAAC;MAAE,GAAGD,GAAG;MAAEE,IAAI,EAAE;IAAU,CAAC,EAAED,KAAK,CAAC;IAEzC,MAAM;MAAEE;IAAQ,CAAC,GAAGH,GAAG;IACvB,IAAI;MAAEI;IAAW,CAAC,GAAG,IAAI;IAEzBP,oBAAoB,CAACM,OAAO,EAAE,sBAAsB,CAAC;IAErD,IAAIA,OAAO,CAACE,QAAQ,KAAK,KAAK,EAAE;MAC9BD,UAAU,GAAGA,UAAU,CAACE,QAAQ,CAAC,CAAC;IACpC;IAEA,IAAI,CAACF,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACD,OAAO,GAAGA,OAAO;EACxB;AACF","ignoreList":[]}

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

@@ -0,0 +1,2 @@
+export const optionalText = ' (optional)';
+//# sourceMappingURL=constants.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","names":["optionalText"],"sources":["../../../../../src/server/plugins/engine/components/constants.ts"],"sourcesContent":["export const optionalText = ' (optional)'\n"],"mappings":"AAAA,OAAO,MAAMA,YAAY,GAAG,aAAa","ignoreList":[]}

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

@@ -0,0 +1,219 @@
+import { ComponentType } from '@defra/forms-model';
+import { Marked } from 'marked';
+import { config } from "../../../../config/index.js";
+import { ListFormComponent } from "./ListFormComponent.js";
+import * as Components from "./index.js";
+const designerUrl = config.get('designerUrl');
+const markdown = new Marked({
+  breaks: true,
+  gfm: true,
+  /**
+   * Render paragraphs without `<p>` wrappers
+   * for check answers summary list `<dd>`
+   */
+  extensions: [{
+    name: 'paragraph',
+    renderer({
+      tokens = []
+    }) {
+      const text = this.parser.parseInline(tokens);
+      return tokens.length > 1 ? `${text}<br>` : text;
+    }
+  }],
+  /**
+   * Restrict allowed Markdown tokens
+   */
+  walkTokens(token) {
+    const tokens = ['br', 'escape', 'list', 'list_item', 'paragraph', 'space', 'text'];
+    if (!tokens.includes(token.type)) {
+      token.type = 'text';
+    }
+  }
+});
+
+// All component instances
+
+// Field component instances only
+
+// Guidance component instances only
+
+/**
+ * Create field instance for each {@link ComponentDef} type
+ */
+export function createComponent(def, options) {
+  let component;
+  switch (def.type) {
+    case ComponentType.AutocompleteField:
+      component = new Components.AutocompleteField(def, options);
+      break;
+    case ComponentType.CheckboxesField:
+      component = new Components.CheckboxesField(def, options);
+      break;
+    case ComponentType.DatePartsField:
+      component = new Components.DatePartsField(def, options);
+      break;
+    case ComponentType.Details:
+      component = new Components.Details(def, options);
+      break;
+    case ComponentType.EmailAddressField:
+      component = new Components.EmailAddressField(def, options);
+      break;
+    case ComponentType.Html:
+      component = new Components.Html(def, options);
+      break;
+    case ComponentType.InsetText:
+      component = new Components.InsetText(def, options);
+      break;
+    case ComponentType.List:
+      component = new Components.List(def, options);
+      break;
+    case ComponentType.MultilineTextField:
+      component = new Components.MultilineTextField(def, options);
+      break;
+    case ComponentType.NumberField:
+      component = new Components.NumberField(def, options);
+      break;
+    case ComponentType.RadiosField:
+      component = new Components.RadiosField(def, options);
+      break;
+    case ComponentType.SelectField:
+      component = new Components.SelectField(def, options);
+      break;
+    case ComponentType.TelephoneNumberField:
+      component = new Components.TelephoneNumberField(def, options);
+      break;
+    case ComponentType.TextField:
+      component = new Components.TextField(def, options);
+      break;
+    case ComponentType.UkAddressField:
+      component = new Components.UkAddressField(def, options);
+      break;
+    case ComponentType.YesNoField:
+      component = new Components.YesNoField(def, options);
+      break;
+    case ComponentType.MonthYearField:
+      component = new Components.MonthYearField(def, options);
+      break;
+    case ComponentType.FileUploadField:
+      component = new Components.FileUploadField(def, options);
+      break;
+  }
+  if (typeof component === 'undefined') {
+    throw new Error(`Component type ${def.type} does not exist`);
+  }
+  return component;
+}
+
+/**
+ * Get formatted answer for a field
+ */
+export function getAnswer(field, state, options = {
+  format: 'summary'
+}) {
+  // Use escaped display text for GOV.UK Notify emails
+  if (options.format === 'email') {
+    return getAnswerMarkdown(field, state, {
+      format: 'email'
+    });
+  }
+
+  // Use context value for submission data
+  if (options.format === 'data') {
+    const context = field.getContextValueFromState(state);
+    return context?.toString() ?? '';
+  }
+
+  // Use display HTML for check answers summary (multi line)
+  if (field instanceof ListFormComponent || field instanceof Components.MultilineTextField || field instanceof Components.UkAddressField) {
+    return markdown.parse(getAnswerMarkdown(field, state), {
+      async: false
+    }).trim();
+  }
+
+  // Use display text for check answers summary (single line)
+  return field.getDisplayStringFromState(state);
+}
+
+/**
+ * Get formatted answer for a field (Markdown only)
+ */
+export function getAnswerMarkdown(field, state, options = {
+  format: 'summary'
+}) {
+  const answer = field.getDisplayStringFromState(state);
+
+  // Use escaped display text
+  let answerEscaped = `${escapeMarkdown(answer)}\n`;
+  if (field instanceof Components.FileUploadField) {
+    const files = field.getFormValueFromState(state);
+
+    // Skip empty files
+    if (!files?.length) {
+      return answerEscaped;
+    }
+    answerEscaped = `${escapeMarkdown(answer)}:\n\n`;
+
+    // Append bullet points
+    answerEscaped += files.map(({
+      status
+    }) => {
+      const {
+        file
+      } = status.form;
+      const filename = escapeMarkdown(file.filename);
+      return `* [${filename}](${designerUrl}/file-download/${file.fileId})\n`;
+    }).join('');
+  } else if (field instanceof ListFormComponent) {
+    const values = [field.getContextValueFromState(state)].flat();
+    const items = field.items.filter(({
+      value
+    }) => values.includes(value));
+
+    // Skip empty values
+    if (!items.length) {
+      return answerEscaped;
+    }
+    answerEscaped = '';
+
+    // Append bullet points
+    answerEscaped += items.map(item => {
+      const label = escapeMarkdown(item.text);
+      const value = escapeMarkdown(`(${item.value})`);
+      let line = label;
+
+      // Prepend bullet points for checkboxes only
+      if (field instanceof Components.CheckboxesField) {
+        line = `* ${line}`;
+      }
+
+      // Append raw values in parentheses
+      // e.g. `* None of the above (false)`
+      return options.format === 'email' && `${item.value}`.toLowerCase() !== item.text.toLowerCase() ? `${line} ${value}\n` : `${line}\n`;
+    }).join('');
+  } else if (field instanceof Components.MultilineTextField) {
+    // Preserve Multiline text new lines
+    answerEscaped = answer.split(/\r?\n/).map(escapeMarkdown).join('\n').concat('\n');
+  } else if (field instanceof Components.UkAddressField) {
+    // Format UK addresses into new lines
+    answerEscaped = (field.getContextValueFromState(state) ?? []).map(escapeMarkdown).join('\n').concat('\n');
+  }
+  return answerEscaped;
+}
+
+/**
+ * Prevent Markdown formatting
+ * @see {@link https://pandoc.org/chunkedhtml-demo/8.11-backslash-escapes.html}
+ */
+export function escapeMarkdown(answer) {
+  const punctuation = ['`', "'", '*', '_', '{', '}', '[', ']', '(', ')', '#', '+', '-', '.', '!'];
+  for (const character of punctuation) {
+    answer = answer.toString().replaceAll(character, `\\${character}`);
+  }
+  return answer;
+}
+export const addClassOptionIfNone = (options, className) => {
+  if (!options.classes) {
+    options.classes = className;
+  }
+};
+//# sourceMappingURL=helpers.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","names":["ComponentType","Marked","config","ListFormComponent","Components","designerUrl","get","markdown","breaks","gfm","extensions","name","renderer","tokens","text","parser","parseInline","length","walkTokens","token","includes","type","createComponent","def","options","component","AutocompleteField","CheckboxesField","DatePartsField","Details","EmailAddressField","Html","InsetText","List","MultilineTextField","NumberField","RadiosField","SelectField","TelephoneNumberField","TextField","UkAddressField","YesNoField","MonthYearField","FileUploadField","Error","getAnswer","field","state","format","getAnswerMarkdown","context","getContextValueFromState","toString","parse","async","trim","getDisplayStringFromState","answer","answerEscaped","escapeMarkdown","files","getFormValueFromState","map","status","file","form","filename","fileId","join","values","flat","items","filter","value","item","label","line","toLowerCase","split","concat","punctuation","character","replaceAll","addClassOptionIfNone","className","classes"],"sources":["../../../../../src/server/plugins/engine/components/helpers.ts"],"sourcesContent":["import { ComponentType, type ComponentDef } from '@defra/forms-model'\nimport { Marked, type Token } from 'marked'\n\nimport { config } from '~/src/config/index.js'\nimport { type ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js'\nimport { ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js'\nimport * as Components from '~/src/server/plugins/engine/components/index.js'\nimport { type FormState } from '~/src/server/plugins/engine/types.js'\n\nconst designerUrl = config.get('designerUrl')\n\nconst markdown = new Marked({\n  breaks: true,\n  gfm: true,\n\n  /**\n   * Render paragraphs without `<p>` wrappers\n   * for check answers summary list `<dd>`\n   */\n  extensions: [\n    {\n      name: 'paragraph',\n      renderer({ tokens = [] }) {\n        const text = this.parser.parseInline(tokens)\n        return tokens.length > 1 ? `${text}<br>` : text\n      }\n    }\n  ],\n\n  /**\n   * Restrict allowed Markdown tokens\n   */\n  walkTokens(token) {\n    const tokens: Token['type'][] = [\n      'br',\n      'escape',\n      'list',\n      'list_item',\n      'paragraph',\n      'space',\n      'text'\n    ]\n\n    if (!tokens.includes(token.type)) {\n      token.type = 'text'\n    }\n  }\n})\n\n// All component instances\nexport type Component = InstanceType<\n  (typeof Components)[keyof typeof Components]\n>\n\n// Field component instances only\nexport type Field = InstanceType<\n  | typeof Components.AutocompleteField\n  | typeof Components.CheckboxesField\n  | typeof Components.DatePartsField\n  | typeof Components.EmailAddressField\n  | typeof Components.MonthYearField\n  | typeof Components.MultilineTextField\n  | typeof Components.NumberField\n  | typeof Components.SelectField\n  | typeof Components.TelephoneNumberField\n  | typeof Components.TextField\n  | typeof Components.UkAddressField\n  | typeof Components.FileUploadField\n>\n\n// Guidance component instances only\nexport type Guidance = InstanceType<\n  | typeof Components.Details\n  | typeof Components.Html\n  | typeof Components.InsetText\n  | typeof Components.List\n>\n\n/**\n * Create field instance for each {@link ComponentDef} type\n */\nexport function createComponent(\n  def: ComponentDef,\n  options: ConstructorParameters<typeof ComponentBase>[1]\n): Component {\n  let component: Component | undefined\n\n  switch (def.type) {\n    case ComponentType.AutocompleteField:\n      component = new Components.AutocompleteField(def, options)\n      break\n\n    case ComponentType.CheckboxesField:\n      component = new Components.CheckboxesField(def, options)\n      break\n\n    case ComponentType.DatePartsField:\n      component = new Components.DatePartsField(def, options)\n      break\n\n    case ComponentType.Details:\n      component = new Components.Details(def, options)\n      break\n\n    case ComponentType.EmailAddressField:\n      component = new Components.EmailAddressField(def, options)\n      break\n\n    case ComponentType.Html:\n      component = new Components.Html(def, options)\n      break\n\n    case ComponentType.InsetText:\n      component = new Components.InsetText(def, options)\n      break\n\n    case ComponentType.List:\n      component = new Components.List(def, options)\n      break\n\n    case ComponentType.MultilineTextField:\n      component = new Components.MultilineTextField(def, options)\n      break\n\n    case ComponentType.NumberField:\n      component = new Components.NumberField(def, options)\n      break\n\n    case ComponentType.RadiosField:\n      component = new Components.RadiosField(def, options)\n      break\n\n    case ComponentType.SelectField:\n      component = new Components.SelectField(def, options)\n      break\n\n    case ComponentType.TelephoneNumberField:\n      component = new Components.TelephoneNumberField(def, options)\n      break\n\n    case ComponentType.TextField:\n      component = new Components.TextField(def, options)\n      break\n\n    case ComponentType.UkAddressField:\n      component = new Components.UkAddressField(def, options)\n      break\n\n    case ComponentType.YesNoField:\n      component = new Components.YesNoField(def, options)\n      break\n\n    case ComponentType.MonthYearField:\n      component = new Components.MonthYearField(def, options)\n      break\n\n    case ComponentType.FileUploadField:\n      component = new Components.FileUploadField(def, options)\n      break\n  }\n\n  if (typeof component === 'undefined') {\n    throw new Error(`Component type ${def.type} does not exist`)\n  }\n\n  return component\n}\n\n/**\n * Get formatted answer for a field\n */\nexport function getAnswer(\n  field: Field,\n  state: FormState,\n  options: {\n    format:\n      | 'data' // Submission data\n      | 'email' // GOV.UK Notify emails\n      | 'summary' // Check answers summary\n  } = { format: 'summary' }\n) {\n  // Use escaped display text for GOV.UK Notify emails\n  if (options.format === 'email') {\n    return getAnswerMarkdown(field, state, { format: 'email' })\n  }\n\n  // Use context value for submission data\n  if (options.format === 'data') {\n    const context = field.getContextValueFromState(state)\n    return context?.toString() ?? ''\n  }\n\n  // Use display HTML for check answers summary (multi line)\n  if (\n    field instanceof ListFormComponent ||\n    field instanceof Components.MultilineTextField ||\n    field instanceof Components.UkAddressField\n  ) {\n    return markdown\n      .parse(getAnswerMarkdown(field, state), { async: false })\n      .trim()\n  }\n\n  // Use display text for check answers summary (single line)\n  return field.getDisplayStringFromState(state)\n}\n\n/**\n * Get formatted answer for a field (Markdown only)\n */\nexport function getAnswerMarkdown(\n  field: Field,\n  state: FormState,\n  options: {\n    format:\n      | 'email' // GOV.UK Notify emails\n      | 'summary' // Check answers summary\n  } = { format: 'summary' }\n) {\n  const answer = field.getDisplayStringFromState(state)\n\n  // Use escaped display text\n  let answerEscaped = `${escapeMarkdown(answer)}\\n`\n\n  if (field instanceof Components.FileUploadField) {\n    const files = field.getFormValueFromState(state)\n\n    // Skip empty files\n    if (!files?.length) {\n      return answerEscaped\n    }\n\n    answerEscaped = `${escapeMarkdown(answer)}:\\n\\n`\n\n    // Append bullet points\n    answerEscaped += files\n      .map(({ status }) => {\n        const { file } = status.form\n        const filename = escapeMarkdown(file.filename)\n        return `* [${filename}](${designerUrl}/file-download/${file.fileId})\\n`\n      })\n      .join('')\n  } else if (field instanceof ListFormComponent) {\n    const values = [field.getContextValueFromState(state)].flat()\n    const items = field.items.filter(({ value }) => values.includes(value))\n\n    // Skip empty values\n    if (!items.length) {\n      return answerEscaped\n    }\n\n    answerEscaped = ''\n\n    // Append bullet points\n    answerEscaped += items\n      .map((item) => {\n        const label = escapeMarkdown(item.text)\n        const value = escapeMarkdown(`(${item.value})`)\n\n        let line = label\n\n        // Prepend bullet points for checkboxes only\n        if (field instanceof Components.CheckboxesField) {\n          line = `* ${line}`\n        }\n\n        // Append raw values in parentheses\n        // e.g. `* None of the above (false)`\n        return options.format === 'email' &&\n          `${item.value}`.toLowerCase() !== item.text.toLowerCase()\n          ? `${line} ${value}\\n`\n          : `${line}\\n`\n      })\n      .join('')\n  } else if (field instanceof Components.MultilineTextField) {\n    // Preserve Multiline text new lines\n    answerEscaped = answer\n      .split(/\\r?\\n/)\n      .map(escapeMarkdown)\n      .join('\\n')\n      .concat('\\n')\n  } else if (field instanceof Components.UkAddressField) {\n    // Format UK addresses into new lines\n    answerEscaped = (field.getContextValueFromState(state) ?? [])\n      .map(escapeMarkdown)\n      .join('\\n')\n      .concat('\\n')\n  }\n\n  return answerEscaped\n}\n\n/**\n * Prevent Markdown formatting\n * @see {@link https://pandoc.org/chunkedhtml-demo/8.11-backslash-escapes.html}\n */\nexport function escapeMarkdown(answer: string) {\n  const punctuation = [\n    '`',\n    \"'\",\n    '*',\n    '_',\n    '{',\n    '}',\n    '[',\n    ']',\n    '(',\n    ')',\n    '#',\n    '+',\n    '-',\n    '.',\n    '!'\n  ]\n\n  for (const character of punctuation) {\n    answer = answer.toString().replaceAll(character, `\\\\${character}`)\n  }\n\n  return answer\n}\n\nexport const addClassOptionIfNone = (\n  options: Extract<ComponentDef, { options: { classes?: string } }>['options'],\n  className: string\n) => {\n  if (!options.classes) {\n    options.classes = className\n  }\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAA2B,oBAAoB;AACrE,SAASC,MAAM,QAAoB,QAAQ;AAE3C,SAASC,MAAM;AAEf,SAASC,iBAAiB;AAC1B,OAAO,KAAKC,UAAU;AAGtB,MAAMC,WAAW,GAAGH,MAAM,CAACI,GAAG,CAAC,aAAa,CAAC;AAE7C,MAAMC,QAAQ,GAAG,IAAIN,MAAM,CAAC;EAC1BO,MAAM,EAAE,IAAI;EACZC,GAAG,EAAE,IAAI;EAET;AACF;AACA;AACA;EACEC,UAAU,EAAE,CACV;IACEC,IAAI,EAAE,WAAW;IACjBC,QAAQA,CAAC;MAAEC,MAAM,GAAG;IAAG,CAAC,EAAE;MACxB,MAAMC,IAAI,GAAG,IAAI,CAACC,MAAM,CAACC,WAAW,CAACH,MAAM,CAAC;MAC5C,OAAOA,MAAM,CAACI,MAAM,GAAG,CAAC,GAAG,GAAGH,IAAI,MAAM,GAAGA,IAAI;IACjD;EACF,CAAC,CACF;EAED;AACF;AACA;EACEI,UAAUA,CAACC,KAAK,EAAE;IAChB,MAAMN,MAAuB,GAAG,CAC9B,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,WAAW,EACX,WAAW,EACX,OAAO,EACP,MAAM,CACP;IAED,IAAI,CAACA,MAAM,CAACO,QAAQ,CAACD,KAAK,CAACE,IAAI,CAAC,EAAE;MAChCF,KAAK,CAACE,IAAI,GAAG,MAAM;IACrB;EACF;AACF,CAAC,CAAC;;AAEF;;AAKA;;AAgBA;;AAQA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAC7BC,GAAiB,EACjBC,OAAuD,EAC5C;EACX,IAAIC,SAAgC;EAEpC,QAAQF,GAAG,CAACF,IAAI;IACd,KAAKrB,aAAa,CAAC0B,iBAAiB;MAClCD,SAAS,GAAG,IAAIrB,UAAU,CAACsB,iBAAiB,CAACH,GAAG,EAAEC,OAAO,CAAC;MAC1D;IAEF,KAAKxB,aAAa,CAAC2B,eAAe;MAChCF,SAAS,GAAG,IAAIrB,UAAU,CAACuB,eAAe,CAACJ,GAAG,EAAEC,OAAO,CAAC;MACxD;IAEF,KAAKxB,aAAa,CAAC4B,cAAc;MAC/BH,SAAS,GAAG,IAAIrB,UAAU,CAACwB,cAAc,CAACL,GAAG,EAAEC,OAAO,CAAC;MACvD;IAEF,KAAKxB,aAAa,CAAC6B,OAAO;MACxBJ,SAAS,GAAG,IAAIrB,UAAU,CAACyB,OAAO,CAACN,GAAG,EAAEC,OAAO,CAAC;MAChD;IAEF,KAAKxB,aAAa,CAAC8B,iBAAiB;MAClCL,SAAS,GAAG,IAAIrB,UAAU,CAAC0B,iBAAiB,CAACP,GAAG,EAAEC,OAAO,CAAC;MAC1D;IAEF,KAAKxB,aAAa,CAAC+B,IAAI;MACrBN,SAAS,GAAG,IAAIrB,UAAU,CAAC2B,IAAI,CAACR,GAAG,EAAEC,OAAO,CAAC;MAC7C;IAEF,KAAKxB,aAAa,CAACgC,SAAS;MAC1BP,SAAS,GAAG,IAAIrB,UAAU,CAAC4B,SAAS,CAACT,GAAG,EAAEC,OAAO,CAAC;MAClD;IAEF,KAAKxB,aAAa,CAACiC,IAAI;MACrBR,SAAS,GAAG,IAAIrB,UAAU,CAAC6B,IAAI,CAACV,GAAG,EAAEC,OAAO,CAAC;MAC7C;IAEF,KAAKxB,aAAa,CAACkC,kBAAkB;MACnCT,SAAS,GAAG,IAAIrB,UAAU,CAAC8B,kBAAkB,CAACX,GAAG,EAAEC,OAAO,CAAC;MAC3D;IAEF,KAAKxB,aAAa,CAACmC,WAAW;MAC5BV,SAAS,GAAG,IAAIrB,UAAU,CAAC+B,WAAW,CAACZ,GAAG,EAAEC,OAAO,CAAC;MACpD;IAEF,KAAKxB,aAAa,CAACoC,WAAW;MAC5BX,SAAS,GAAG,IAAIrB,UAAU,CAACgC,WAAW,CAACb,GAAG,EAAEC,OAAO,CAAC;MACpD;IAEF,KAAKxB,aAAa,CAACqC,WAAW;MAC5BZ,SAAS,GAAG,IAAIrB,UAAU,CAACiC,WAAW,CAACd,GAAG,EAAEC,OAAO,CAAC;MACpD;IAEF,KAAKxB,aAAa,CAACsC,oBAAoB;MACrCb,SAAS,GAAG,IAAIrB,UAAU,CAACkC,oBAAoB,CAACf,GAAG,EAAEC,OAAO,CAAC;MAC7D;IAEF,KAAKxB,aAAa,CAACuC,SAAS;MAC1Bd,SAAS,GAAG,IAAIrB,UAAU,CAACmC,SAAS,CAAChB,GAAG,EAAEC,OAAO,CAAC;MAClD;IAEF,KAAKxB,aAAa,CAACwC,cAAc;MAC/Bf,SAAS,GAAG,IAAIrB,UAAU,CAACoC,cAAc,CAACjB,GAAG,EAAEC,OAAO,CAAC;MACvD;IAEF,KAAKxB,aAAa,CAACyC,UAAU;MAC3BhB,SAAS,GAAG,IAAIrB,UAAU,CAACqC,UAAU,CAAClB,GAAG,EAAEC,OAAO,CAAC;MACnD;IAEF,KAAKxB,aAAa,CAAC0C,cAAc;MAC/BjB,SAAS,GAAG,IAAIrB,UAAU,CAACsC,cAAc,CAACnB,GAAG,EAAEC,OAAO,CAAC;MACvD;IAEF,KAAKxB,aAAa,CAAC2C,eAAe;MAChClB,SAAS,GAAG,IAAIrB,UAAU,CAACuC,eAAe,CAACpB,GAAG,EAAEC,OAAO,CAAC;MACxD;EACJ;EAEA,IAAI,OAAOC,SAAS,KAAK,WAAW,EAAE;IACpC,MAAM,IAAImB,KAAK,CAAC,kBAAkBrB,GAAG,CAACF,IAAI,iBAAiB,CAAC;EAC9D;EAEA,OAAOI,SAAS;AAClB;;AAEA;AACA;AACA;AACA,OAAO,SAASoB,SAASA,CACvBC,KAAY,EACZC,KAAgB,EAChBvB,OAKC,GAAG;EAAEwB,MAAM,EAAE;AAAU,CAAC,EACzB;EACA;EACA,IAAIxB,OAAO,CAACwB,MAAM,KAAK,OAAO,EAAE;IAC9B,OAAOC,iBAAiB,CAACH,KAAK,EAAEC,KAAK,EAAE;MAAEC,MAAM,EAAE;IAAQ,CAAC,CAAC;EAC7D;;EAEA;EACA,IAAIxB,OAAO,CAACwB,MAAM,KAAK,MAAM,EAAE;IAC7B,MAAME,OAAO,GAAGJ,KAAK,CAACK,wBAAwB,CAACJ,KAAK,CAAC;IACrD,OAAOG,OAAO,EAAEE,QAAQ,CAAC,CAAC,IAAI,EAAE;EAClC;;EAEA;EACA,IACEN,KAAK,YAAY3C,iBAAiB,IAClC2C,KAAK,YAAY1C,UAAU,CAAC8B,kBAAkB,IAC9CY,KAAK,YAAY1C,UAAU,CAACoC,cAAc,EAC1C;IACA,OAAOjC,QAAQ,CACZ8C,KAAK,CAACJ,iBAAiB,CAACH,KAAK,EAAEC,KAAK,CAAC,EAAE;MAAEO,KAAK,EAAE;IAAM,CAAC,CAAC,CACxDC,IAAI,CAAC,CAAC;EACX;;EAEA;EACA,OAAOT,KAAK,CAACU,yBAAyB,CAACT,KAAK,CAAC;AAC/C;;AAEA;AACA;AACA;AACA,OAAO,SAASE,iBAAiBA,CAC/BH,KAAY,EACZC,KAAgB,EAChBvB,OAIC,GAAG;EAAEwB,MAAM,EAAE;AAAU,CAAC,EACzB;EACA,MAAMS,MAAM,GAAGX,KAAK,CAACU,yBAAyB,CAACT,KAAK,CAAC;;EAErD;EACA,IAAIW,aAAa,GAAG,GAAGC,cAAc,CAACF,MAAM,CAAC,IAAI;EAEjD,IAAIX,KAAK,YAAY1C,UAAU,CAACuC,eAAe,EAAE;IAC/C,MAAMiB,KAAK,GAAGd,KAAK,CAACe,qBAAqB,CAACd,KAAK,CAAC;;IAEhD;IACA,IAAI,CAACa,KAAK,EAAE3C,MAAM,EAAE;MAClB,OAAOyC,aAAa;IACtB;IAEAA,aAAa,GAAG,GAAGC,cAAc,CAACF,MAAM,CAAC,OAAO;;IAEhD;IACAC,aAAa,IAAIE,KAAK,CACnBE,GAAG,CAAC,CAAC;MAAEC;IAAO,CAAC,KAAK;MACnB,MAAM;QAAEC;MAAK,CAAC,GAAGD,MAAM,CAACE,IAAI;MAC5B,MAAMC,QAAQ,GAAGP,cAAc,CAACK,IAAI,CAACE,QAAQ,CAAC;MAC9C,OAAO,MAAMA,QAAQ,KAAK7D,WAAW,kBAAkB2D,IAAI,CAACG,MAAM,KAAK;IACzE,CAAC,CAAC,CACDC,IAAI,CAAC,EAAE,CAAC;EACb,CAAC,MAAM,IAAItB,KAAK,YAAY3C,iBAAiB,EAAE;IAC7C,MAAMkE,MAAM,GAAG,CAACvB,KAAK,CAACK,wBAAwB,CAACJ,KAAK,CAAC,CAAC,CAACuB,IAAI,CAAC,CAAC;IAC7D,MAAMC,KAAK,GAAGzB,KAAK,CAACyB,KAAK,CAACC,MAAM,CAAC,CAAC;MAAEC;IAAM,CAAC,KAAKJ,MAAM,CAACjD,QAAQ,CAACqD,KAAK,CAAC,CAAC;;IAEvE;IACA,IAAI,CAACF,KAAK,CAACtD,MAAM,EAAE;MACjB,OAAOyC,aAAa;IACtB;IAEAA,aAAa,GAAG,EAAE;;IAElB;IACAA,aAAa,IAAIa,KAAK,CACnBT,GAAG,CAAEY,IAAI,IAAK;MACb,MAAMC,KAAK,GAAGhB,cAAc,CAACe,IAAI,CAAC5D,IAAI,CAAC;MACvC,MAAM2D,KAAK,GAAGd,cAAc,CAAC,IAAIe,IAAI,CAACD,KAAK,GAAG,CAAC;MAE/C,IAAIG,IAAI,GAAGD,KAAK;;MAEhB;MACA,IAAI7B,KAAK,YAAY1C,UAAU,CAACuB,eAAe,EAAE;QAC/CiD,IAAI,GAAG,KAAKA,IAAI,EAAE;MACpB;;MAEA;MACA;MACA,OAAOpD,OAAO,CAACwB,MAAM,KAAK,OAAO,IAC/B,GAAG0B,IAAI,CAACD,KAAK,EAAE,CAACI,WAAW,CAAC,CAAC,KAAKH,IAAI,CAAC5D,IAAI,CAAC+D,WAAW,CAAC,CAAC,GACvD,GAAGD,IAAI,IAAIH,KAAK,IAAI,GACpB,GAAGG,IAAI,IAAI;IACjB,CAAC,CAAC,CACDR,IAAI,CAAC,EAAE,CAAC;EACb,CAAC,MAAM,IAAItB,KAAK,YAAY1C,UAAU,CAAC8B,kBAAkB,EAAE;IACzD;IACAwB,aAAa,GAAGD,MAAM,CACnBqB,KAAK,CAAC,OAAO,CAAC,CACdhB,GAAG,CAACH,cAAc,CAAC,CACnBS,IAAI,CAAC,IAAI,CAAC,CACVW,MAAM,CAAC,IAAI,CAAC;EACjB,CAAC,MAAM,IAAIjC,KAAK,YAAY1C,UAAU,CAACoC,cAAc,EAAE;IACrD;IACAkB,aAAa,GAAG,CAACZ,KAAK,CAACK,wBAAwB,CAACJ,KAAK,CAAC,IAAI,EAAE,EACzDe,GAAG,CAACH,cAAc,CAAC,CACnBS,IAAI,CAAC,IAAI,CAAC,CACVW,MAAM,CAAC,IAAI,CAAC;EACjB;EAEA,OAAOrB,aAAa;AACtB;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAACF,MAAc,EAAE;EAC7C,MAAMuB,WAAW,GAAG,CAClB,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,CACJ;EAED,KAAK,MAAMC,SAAS,IAAID,WAAW,EAAE;IACnCvB,MAAM,GAAGA,MAAM,CAACL,QAAQ,CAAC,CAAC,CAAC8B,UAAU,CAACD,SAAS,EAAE,KAAKA,SAAS,EAAE,CAAC;EACpE;EAEA,OAAOxB,MAAM;AACf;AAEA,OAAO,MAAM0B,oBAAoB,GAAGA,CAClC3D,OAA4E,EAC5E4D,SAAiB,KACd;EACH,IAAI,CAAC5D,OAAO,CAAC6D,OAAO,EAAE;IACpB7D,OAAO,CAAC6D,OAAO,GAAGD,SAAS;EAC7B;AACF,CAAC","ignoreList":[]}

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

@@ -0,0 +1,25 @@
+/**
+ * IMPORTANT: Exported Components must follow the naming convention implemented in {@link @defra/forms-model#ComponentType}
+ * In the Form JSON, components have a type property which is the name of the components, e.g. DatePartsField.
+ * Components are loaded in the ComponentsCollection constructor.
+ */
+
+export { AutocompleteField } from "./AutocompleteField.js";
+export { CheckboxesField } from "./CheckboxesField.js";
+export { DatePartsField } from "./DatePartsField.js";
+export { Details } from "./Details.js";
+export { EmailAddressField } from "./EmailAddressField.js";
+export { Html } from "./Html.js";
+export { InsetText } from "./InsetText.js";
+export { List } from "./List.js";
+export { MultilineTextField } from "./MultilineTextField.js";
+export { NumberField } from "./NumberField.js";
+export { RadiosField } from "./RadiosField.js";
+export { SelectField } from "./SelectField.js";
+export { TelephoneNumberField } from "./TelephoneNumberField.js";
+export { TextField } from "./TextField.js";
+export { UkAddressField } from "./UkAddressField.js";
+export { YesNoField } from "./YesNoField.js";
+export { MonthYearField } from "./MonthYearField.js";
+export { FileUploadField } from "./FileUploadField.js";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["AutocompleteField","CheckboxesField","DatePartsField","Details","EmailAddressField","Html","InsetText","List","MultilineTextField","NumberField","RadiosField","SelectField","TelephoneNumberField","TextField","UkAddressField","YesNoField","MonthYearField","FileUploadField"],"sources":["../../../../../src/server/plugins/engine/components/index.ts"],"sourcesContent":["/**\n * IMPORTANT: Exported Components must follow the naming convention implemented in {@link @defra/forms-model#ComponentType}\n * In the Form JSON, components have a type property which is the name of the components, e.g. DatePartsField.\n * Components are loaded in the ComponentsCollection constructor.\n */\n\nexport { AutocompleteField } from '~/src/server/plugins/engine/components/AutocompleteField.js'\nexport { CheckboxesField } from '~/src/server/plugins/engine/components/CheckboxesField.js'\nexport { DatePartsField } from '~/src/server/plugins/engine/components/DatePartsField.js'\nexport { Details } from '~/src/server/plugins/engine/components/Details.js'\nexport { EmailAddressField } from '~/src/server/plugins/engine/components/EmailAddressField.js'\nexport { Html } from '~/src/server/plugins/engine/components/Html.js'\nexport { InsetText } from '~/src/server/plugins/engine/components/InsetText.js'\nexport { List } from '~/src/server/plugins/engine/components/List.js'\nexport { MultilineTextField } from '~/src/server/plugins/engine/components/MultilineTextField.js'\nexport { NumberField } from '~/src/server/plugins/engine/components/NumberField.js'\nexport { RadiosField } from '~/src/server/plugins/engine/components/RadiosField.js'\nexport { SelectField } from '~/src/server/plugins/engine/components/SelectField.js'\nexport { TelephoneNumberField } from '~/src/server/plugins/engine/components/TelephoneNumberField.js'\nexport { TextField } from '~/src/server/plugins/engine/components/TextField.js'\nexport { UkAddressField } from '~/src/server/plugins/engine/components/UkAddressField.js'\nexport { YesNoField } from '~/src/server/plugins/engine/components/YesNoField.js'\nexport { MonthYearField } from '~/src/server/plugins/engine/components/MonthYearField.js'\nexport { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;;AAEA,SAASA,iBAAiB;AAC1B,SAASC,eAAe;AACxB,SAASC,cAAc;AACvB,SAASC,OAAO;AAChB,SAASC,iBAAiB;AAC1B,SAASC,IAAI;AACb,SAASC,SAAS;AAClB,SAASC,IAAI;AACb,SAASC,kBAAkB;AAC3B,SAASC,WAAW;AACpB,SAASC,WAAW;AACpB,SAASC,WAAW;AACpB,SAASC,oBAAoB;AAC7B,SAASC,SAAS;AAClB,SAASC,cAAc;AACvB,SAASC,UAAU;AACnB,SAASC,cAAc;AACvB,SAASC,eAAe","ignoreList":[]}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../../../../src/server/plugins/engine/components/types.ts"],"sourcesContent":["import { type ComponentType, type Item } from '@defra/forms-model'\n\nimport {\n  type FormSubmissionError,\n  type FormValue,\n  type SummaryList\n} from '~/src/server/plugins/engine/types.js'\n\nexport type ComponentText = {\n  classes?: string\n  attributes?: string | Record<string, string>\n} & (\n  | {\n      text: string\n      html?: string\n    }\n  | {\n      text?: string\n      html: string\n    }\n)\n\nexport interface Label {\n  text: string\n  classes?: string\n  html?: string\n  isPageHeading?: boolean\n}\n\nexport interface Content {\n  title?: string\n  text: string\n  condition?: string\n}\n\nexport interface BackLink {\n  text: string\n  href: string\n}\n\nexport type ListItemLabel = Omit<Label, 'text' | 'isPageHeading'>\n\nexport interface ListItem {\n  text?: string\n  value?: Item['value']\n  hint?: {\n    id?: string\n    text: string\n  }\n  checked?: boolean\n  selected?: boolean\n  label?: ListItemLabel\n  condition?: string\n}\n\nexport interface DateInputItem {\n  label?: Label\n  type?: string\n  id?: string\n  name?: string\n  value?: Item['value']\n  classes?: string\n  condition?: undefined\n}\n\nexport interface ViewModel extends Record<string, unknown> {\n  label?: Label\n  type?: string\n  id?: string\n  name?: string\n  value?: FormValue\n  hint?: {\n    id?: string\n    text: string\n  }\n  prefix?: ComponentText\n  suffix?: ComponentText\n  classes?: string\n  condition?: string\n  errors?: FormSubmissionError[]\n  errorMessage?: {\n    text: string\n  }\n  summaryHtml?: string\n  html?: string\n  attributes: {\n    autocomplete?: string\n    maxlength?: number\n    multiple?: string\n    accept?: string\n    inputmode?: string\n  }\n  content?: Content | Content[] | string\n  maxlength?: number\n  maxwords?: number\n  rows?: number\n  items?: ListItem[] | DateInputItem[]\n  fieldset?: {\n    attributes?: string | Record<string, string>\n    legend?: Label\n  }\n  formGroup?: {\n    classes?: string\n    attributes?: string | Record<string, string>\n  }\n  components?: ComponentViewModel[]\n  upload?: {\n    count: number\n    summaryList: SummaryList\n  }\n}\n\nexport interface ComponentViewModel {\n  type: ComponentType\n  isFormComponent: boolean\n  model: ViewModel\n}\n"],"mappings":"","ignoreList":[]}

package/.server/server/plugins/engine/configureEnginePlugin.js

@@ -0,0 +1,44 @@
+import { join, parse } from 'node:path';
+import { FormModel } from "./models/FormModel.js";
+import { plugin } from "./plugin.js";
+export const configureEnginePlugin = async ({
+  formFileName,
+  formFilePath,
+  services,
+  controllers
+} = {}) => {
+  let model;
+  if (formFileName && formFilePath) {
+    const definition = await getForm(join(formFilePath, formFileName));
+    const {
+      name
+    } = parse(formFileName);
+    model = new FormModel(definition, {
+      basePath: name
+    }, services, controllers);
+  }
+  return {
+    plugin,
+    options: {
+      model,
+      services,
+      controllers
+    }
+  };
+};
+export async function getForm(importPath) {
+  const {
+    ext
+  } = parse(importPath);
+  const attributes = {
+    type: ext === '.json' ? 'json' : 'module'
+  };
+  const formImport = import(importPath, {
+    with: attributes
+  });
+  const {
+    default: definition
+  } = await formImport;
+  return definition;
+}
+//# sourceMappingURL=configureEnginePlugin.js.map

package/.server/server/plugins/engine/configureEnginePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configureEnginePlugin.js","names":["join","parse","FormModel","plugin","configureEnginePlugin","formFileName","formFilePath","services","controllers","model","definition","getForm","name","basePath","options","importPath","ext","attributes","type","formImport","with","default"],"sources":["../../../../src/server/plugins/engine/configureEnginePlugin.ts"],"sourcesContent":["import { join, parse } from 'node:path'\n\nimport { type FormDefinition } from '@defra/forms-model'\nimport { type ServerRegisterPluginObject } from '@hapi/hapi'\n\nimport { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport {\n  plugin,\n  type PluginOptions\n} from '~/src/server/plugins/engine/plugin.js'\nimport { type RouteConfig } from '~/src/server/types.js'\n\nexport const configureEnginePlugin = async ({\n  formFileName,\n  formFilePath,\n  services,\n  controllers\n}: RouteConfig = {}): Promise<ServerRegisterPluginObject<PluginOptions>> => {\n  let model: FormModel | undefined\n\n  if (formFileName && formFilePath) {\n    const definition = await getForm(join(formFilePath, formFileName))\n    const { name } = parse(formFileName)\n\n    model = new FormModel(definition, { basePath: name }, services, controllers)\n  }\n\n  return {\n    plugin,\n    options: { model, services, controllers }\n  }\n}\n\nexport async function getForm(importPath: string) {\n  const { ext } = parse(importPath)\n\n  const attributes: ImportAttributes = {\n    type: ext === '.json' ? 'json' : 'module'\n  }\n\n  const formImport = import(importPath, { with: attributes }) as Promise<{\n    default: FormDefinition\n  }>\n\n  const { default: definition } = await formImport\n  return definition\n}\n"],"mappings":"AAAA,SAASA,IAAI,EAAEC,KAAK,QAAQ,WAAW;AAKvC,SAASC,SAAS;AAClB,SACEC,MAAM;AAKR,OAAO,MAAMC,qBAAqB,GAAG,MAAAA,CAAO;EAC1CC,YAAY;EACZC,YAAY;EACZC,QAAQ;EACRC;AACW,CAAC,GAAG,CAAC,CAAC,KAAyD;EAC1E,IAAIC,KAA4B;EAEhC,IAAIJ,YAAY,IAAIC,YAAY,EAAE;IAChC,MAAMI,UAAU,GAAG,MAAMC,OAAO,CAACX,IAAI,CAACM,YAAY,EAAED,YAAY,CAAC,CAAC;IAClE,MAAM;MAAEO;IAAK,CAAC,GAAGX,KAAK,CAACI,YAAY,CAAC;IAEpCI,KAAK,GAAG,IAAIP,SAAS,CAACQ,UAAU,EAAE;MAAEG,QAAQ,EAAED;IAAK,CAAC,EAAEL,QAAQ,EAAEC,WAAW,CAAC;EAC9E;EAEA,OAAO;IACLL,MAAM;IACNW,OAAO,EAAE;MAAEL,KAAK;MAAEF,QAAQ;MAAEC;IAAY;EAC1C,CAAC;AACH,CAAC;AAED,OAAO,eAAeG,OAAOA,CAACI,UAAkB,EAAE;EAChD,MAAM;IAAEC;EAAI,CAAC,GAAGf,KAAK,CAACc,UAAU,CAAC;EAEjC,MAAME,UAA4B,GAAG;IACnCC,IAAI,EAAEF,GAAG,KAAK,OAAO,GAAG,MAAM,GAAG;EACnC,CAAC;EAED,MAAMG,UAAU,GAAG,MAAM,CAACJ,UAAU,EAAE;IAAEK,IAAI,EAAEH;EAAW,CAAC,CAExD;EAEF,MAAM;IAAEI,OAAO,EAAEX;EAAW,CAAC,GAAG,MAAMS,UAAU;EAChD,OAAOT,UAAU;AACnB","ignoreList":[]}