@defra/forms-engine-plugin 4.5.6 → 4.6.0

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

@@ -32,11 +32,9 @@ export declare class EmailAddressField extends FormComponent {
             multiple?: string;
             accept
             /**
-             * Static version of getAllPossibleErrors that doesn't require a component instance.
+             * For error preview page that shows all possible errors on a component
              */
-            ? /**
-             * Static version of getAllPossibleErrors that doesn't require a component instance.
-             */: string;
+            ?: string;
             inputmode?: string;
         };
         content?: import("./types.js").Content | import("./types.js").Content[] | string;

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

@@ -1,3 +1,4 @@
+import { preventUnicodeInEmail } from '@defra/forms-model';
 import joi from 'joi';
 import { FormComponent } from "./FormComponent.js";
 import { messageTemplate } from "../pageControllers/validationOptions.js";
@@ -7,7 +8,7 @@ export class EmailAddressField extends FormComponent {
     const {
       options
     } = def;
-    let formSchema = joi.string().email().trim().label(this.label).required();
+    let formSchema = joi.string().trim().email().custom((value, helpers) => preventUnicodeInEmail(value, helpers)).label(this.label).required();
     if (options.required === false) {
       formSchema = formSchema.allow('');
     }
@@ -55,6 +56,9 @@ export class EmailAddressField extends FormComponent {
       }, {
         type: 'format',
         template: messageTemplate.format
+      }, {
+        type: 'unicode',
+        template: messageTemplate.unicode
       }],
       advancedSettingsErrors: []
     };

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

@@ -1 +1 @@
-{"version":3,"file":"EmailAddressField.js","names":["joi","FormComponent","messageTemplate","EmailAddressField","constructor","def","props","options","formSchema","string","email","trim","label","required","allow","customValidationMessage","message","messages","customValidationMessages","default","stateSchema","getViewModel","payload","errors","viewModel","attributes","autocomplete","type","getAllPossibleErrors","baseErrors","template","format","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/EmailAddressField.ts"],"sourcesContent":["import { type EmailAddressFieldComponent } from '@defra/forms-model'\nimport joi from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\n\nexport class EmailAddressField extends FormComponent {\n  declare options: EmailAddressFieldComponent['options']\n\n  constructor(\n    def: EmailAddressFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n\n    let formSchema = joi.string().email().trim().label(this.label).required()\n\n    if (options.required === false) {\n      formSchema = formSchema.allow('')\n    }\n\n    if (options.customValidationMessage) {\n      const message = options.customValidationMessage\n\n      formSchema = formSchema.messages({\n        'any.required': message,\n        'string.empty': message,\n        'string.email': message\n      })\n    } else if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\n\n    this.formSchema = formSchema.default('')\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const viewModel = super.getViewModel(payload, errors)\n    const { attributes } = viewModel\n\n    attributes.autocomplete = 'email'\n\n    return {\n      ...viewModel,\n      type: 'email'\n    }\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return EmailAddressField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'required', template: messageTemplate.required },\n        { type: 'format', template: messageTemplate.format }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAAM,KAAK;AAErB,SAASC,aAAa;AACtB,SAASC,eAAe;AAOxB,OAAO,MAAMC,iBAAiB,SAASF,aAAa,CAAC;EAGnDG,WAAWA,CACTC,GAA+B,EAC/BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IAEvB,IAAIG,UAAU,GAAGR,GAAG,CAACS,MAAM,CAAC,CAAC,CAACC,KAAK,CAAC,CAAC,CAACC,IAAI,CAAC,CAAC,CAACC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CAACC,QAAQ,CAAC,CAAC;IAEzE,IAAIN,OAAO,CAACM,QAAQ,KAAK,KAAK,EAAE;MAC9BL,UAAU,GAAGA,UAAU,CAACM,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAIP,OAAO,CAACQ,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGT,OAAO,CAACQ,uBAAuB;MAE/CP,UAAU,GAAGA,UAAU,CAACS,QAAQ,CAAC;QAC/B,cAAc,EAAED,OAAO;QACvB,cAAc,EAAEA,OAAO;QACvB,cAAc,EAAEA;MAClB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIT,OAAO,CAACW,wBAAwB,EAAE;MAC3CV,UAAU,GAAGA,UAAU,CAACS,QAAQ,CAACV,OAAO,CAACW,wBAAwB,CAAC;IACpE;IAEA,IAAI,CAACV,UAAU,GAAGA,UAAU,CAACW,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGZ,UAAU,CAACW,OAAO,CAAC,IAAI,CAAC,CAACL,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACP,OAAO,GAAGA,OAAO;EACxB;EAEAc,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,MAAM;MAAEE;IAAW,CAAC,GAAGD,SAAS;IAEhCC,UAAU,CAACC,YAAY,GAAG,OAAO;IAEjC,OAAO;MACL,GAAGF,SAAS;MACZG,IAAI,EAAE;IACR,CAAC;EACH;;EAEA;AACF;AACA;EACEC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOzB,iBAAiB,CAACyB,oBAAoB,CAAC,CAAC;EACjD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEF,IAAI,EAAE,UAAU;QAAEG,QAAQ,EAAE5B,eAAe,CAACW;MAAS,CAAC,EACxD;QAAEc,IAAI,EAAE,QAAQ;QAAEG,QAAQ,EAAE5B,eAAe,CAAC6B;MAAO,CAAC,CACrD;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}
+{"version":3,"file":"EmailAddressField.js","names":["preventUnicodeInEmail","joi","FormComponent","messageTemplate","EmailAddressField","constructor","def","props","options","formSchema","string","trim","email","custom","value","helpers","label","required","allow","customValidationMessage","message","messages","customValidationMessages","default","stateSchema","getViewModel","payload","errors","viewModel","attributes","autocomplete","type","getAllPossibleErrors","baseErrors","template","format","unicode","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/EmailAddressField.ts"],"sourcesContent":["import {\n  preventUnicodeInEmail,\n  type EmailAddressFieldComponent\n} from '@defra/forms-model'\nimport joi, { type CustomHelpers } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\n\nexport class EmailAddressField extends FormComponent {\n  declare options: EmailAddressFieldComponent['options']\n\n  constructor(\n    def: EmailAddressFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options } = def\n\n    let formSchema = joi\n      .string()\n      .trim()\n      .email()\n      .custom((value, helpers: CustomHelpers<string>) =>\n        preventUnicodeInEmail(value, helpers)\n      )\n      .label(this.label)\n      .required()\n\n    if (options.required === false) {\n      formSchema = formSchema.allow('')\n    }\n\n    if (options.customValidationMessage) {\n      const message = options.customValidationMessage\n\n      formSchema = formSchema.messages({\n        'any.required': message,\n        'string.empty': message,\n        'string.email': message\n      })\n    } else if (options.customValidationMessages) {\n      formSchema = formSchema.messages(options.customValidationMessages)\n    }\n\n    this.formSchema = formSchema.default('')\n    this.stateSchema = formSchema.default(null).allow(null)\n    this.options = options\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const viewModel = super.getViewModel(payload, errors)\n    const { attributes } = viewModel\n\n    attributes.autocomplete = 'email'\n\n    return {\n      ...viewModel,\n      type: 'email'\n    }\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return EmailAddressField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'required', template: messageTemplate.required },\n        { type: 'format', template: messageTemplate.format },\n        { type: 'unicode', template: messageTemplate.unicode }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAAA,SACEA,qBAAqB,QAEhB,oBAAoB;AAC3B,OAAOC,GAAG,MAA8B,KAAK;AAE7C,SAASC,aAAa;AACtB,SAASC,eAAe;AAOxB,OAAO,MAAMC,iBAAiB,SAASF,aAAa,CAAC;EAGnDG,WAAWA,CACTC,GAA+B,EAC/BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC;IAAQ,CAAC,GAAGF,GAAG;IAEvB,IAAIG,UAAU,GAAGR,GAAG,CACjBS,MAAM,CAAC,CAAC,CACRC,IAAI,CAAC,CAAC,CACNC,KAAK,CAAC,CAAC,CACPC,MAAM,CAAC,CAACC,KAAK,EAAEC,OAA8B,KAC5Cf,qBAAqB,CAACc,KAAK,EAAEC,OAAO,CACtC,CAAC,CACAC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,QAAQ,CAAC,CAAC;IAEb,IAAIT,OAAO,CAACS,QAAQ,KAAK,KAAK,EAAE;MAC9BR,UAAU,GAAGA,UAAU,CAACS,KAAK,CAAC,EAAE,CAAC;IACnC;IAEA,IAAIV,OAAO,CAACW,uBAAuB,EAAE;MACnC,MAAMC,OAAO,GAAGZ,OAAO,CAACW,uBAAuB;MAE/CV,UAAU,GAAGA,UAAU,CAACY,QAAQ,CAAC;QAC/B,cAAc,EAAED,OAAO;QACvB,cAAc,EAAEA,OAAO;QACvB,cAAc,EAAEA;MAClB,CAAC,CAAC;IACJ,CAAC,MAAM,IAAIZ,OAAO,CAACc,wBAAwB,EAAE;MAC3Cb,UAAU,GAAGA,UAAU,CAACY,QAAQ,CAACb,OAAO,CAACc,wBAAwB,CAAC;IACpE;IAEA,IAAI,CAACb,UAAU,GAAGA,UAAU,CAACc,OAAO,CAAC,EAAE,CAAC;IACxC,IAAI,CAACC,WAAW,GAAGf,UAAU,CAACc,OAAO,CAAC,IAAI,CAAC,CAACL,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,CAACV,OAAO,GAAGA,OAAO;EACxB;EAEAiB,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;IACrD,MAAM;MAAEE;IAAW,CAAC,GAAGD,SAAS;IAEhCC,UAAU,CAACC,YAAY,GAAG,OAAO;IAEjC,OAAO;MACL,GAAGF,SAAS;MACZG,IAAI,EAAE;IACR,CAAC;EACH;;EAEA;AACF;AACA;EACEC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO5B,iBAAiB,CAAC4B,oBAAoB,CAAC,CAAC;EACjD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEF,IAAI,EAAE,UAAU;QAAEG,QAAQ,EAAE/B,eAAe,CAACc;MAAS,CAAC,EACxD;QAAEc,IAAI,EAAE,QAAQ;QAAEG,QAAQ,EAAE/B,eAAe,CAACgC;MAAO,CAAC,EACpD;QAAEJ,IAAI,EAAE,SAAS;QAAEG,QAAQ,EAAE/B,eAAe,CAACiC;MAAQ,CAAC,CACvD;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}

package/.server/server/plugins/engine/pageControllers/helpers/state.js

@@ -1,7 +1,7 @@
 import { ControllerType, getHiddenFields } from '@defra/forms-model';
-import { validate as isValidUUID } from 'uuid';
 import { getCacheService } from "../../helpers.js";
 import { CURRENT_PAGE_PATH_KEY, STATE_NOT_YET_VALIDATED } from "../../index.js";
+import { isValidUUID } from "../../../../utils/utils.js";
 const GUID_LENGTH = 36;
 
 /**

package/.server/server/plugins/engine/pageControllers/helpers/state.js.map

@@ -1 +1 @@
-{"version":3,"file":"state.js","names":["ControllerType","getHiddenFields","validate","isValidUUID","getCacheService","CURRENT_PAGE_PATH_KEY","STATE_NOT_YET_VALIDATED","GUID_LENGTH","paramLookupFunctions","formId","val","services","formTitle","meta","formsService","getFormMetadataById","title","key","value","stripParam","query","paramToRemove","params","Object","entries","keys","length","undefined","prefillStateFromQueryParameters","request","page","model","hiddenFieldNames","Set","def","map","field","name","size","has","lookupFunc","res","formData","getState","mergeState","checkSaveAndExitRepeater","context","potentiallyInvalidState","state","originalPath","repeaterPaths","pages","filter","controller","Repeat","p","basePath","path","segments","split","lastSegment","at","guidStartIndex","originalPathWithoutGuid","substring","includes","copyNotYetValidatedState","url","pathname","payload","cacheService","server","setState"],"sources":["../../../../../../src/server/plugins/engine/pageControllers/helpers/state.ts"],"sourcesContent":["import { ControllerType, getHiddenFields } from '@defra/forms-model'\nimport { validate as isValidUUID } from 'uuid'\n\nimport { getCacheService } from '~/src/server/plugins/engine/helpers.js'\nimport {\n  CURRENT_PAGE_PATH_KEY,\n  STATE_NOT_YET_VALIDATED\n} from '~/src/server/plugins/engine/index.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport {\n  type AnyFormRequest,\n  type FormContext,\n  type FormStateValue,\n  type FormValue\n} from '~/src/server/plugins/engine/types.js'\nimport { type FormQuery } from '~/src/server/routes/types.js'\nimport { type Services } from '~/src/server/types.js'\n\nconst GUID_LENGTH = 36\n\n/**\n * A series of functions that can transform a pre-fill input parameter e.g lookup a form title based on form id\n */\nconst paramLookupFunctions = {\n  formId: async (val: string, services: Services) => {\n    let formTitle\n    if (val) {\n      const meta = await services.formsService.getFormMetadataById(val)\n      formTitle = meta.title\n    }\n    return {\n      key: 'formName',\n      value: formTitle\n    }\n  }\n} as Partial<\n  Record<\n    string,\n    (\n      val: string,\n      services: Services\n    ) => Promise<{ key: string; value: string | undefined }>\n  >\n>\n\nexport function stripParam(query: FormQuery, paramToRemove: string) {\n  const params = {} as Record<string, FormStateValue | undefined>\n  for (const [key, value = ''] of Object.entries(query)) {\n    if (key !== paramToRemove) {\n      params[key] = value\n    }\n  }\n  return Object.keys(params).length ? (params as FormQuery) : undefined\n}\n\n/**\n * Any hidden parameters defined in the FormDefinition may be pre-filled by URL parameter values.\n * Other parameters are ignored for security reasons.\n * @param request\n * @param model\n */\nexport async function prefillStateFromQueryParameters(\n  request: AnyFormRequest,\n  page: PageControllerClass\n): Promise<boolean> {\n  const { model } = page\n\n  const hiddenFieldNames = new Set(\n    getHiddenFields(model.def).map((field) => field.name)\n  )\n\n  if (!hiddenFieldNames.size) {\n    return false\n  }\n\n  // Remove 'returnUrl' param\n  const query = stripParam(request.query, 'returnUrl')\n\n  if (!query) {\n    return false\n  }\n\n  const params = {} as Record<string, FormStateValue | undefined>\n\n  for (const [key, value = ''] of Object.entries(query)) {\n    if (hiddenFieldNames.has(key)) {\n      const lookupFunc = paramLookupFunctions[key]\n      if (lookupFunc) {\n        const res = await lookupFunc(value, model.services)\n        // Store original value and result\n        params[key] = value\n        params[res.key] = res.value\n      } else {\n        params[key] = value\n      }\n    }\n  }\n\n  const formData = await page.getState(request)\n  await page.mergeState(request, formData, params)\n\n  return true\n}\n\n/**\n * Checks whether the save-and-exit finished on a repeater with partial state\n * @param context - the form context\n */\nexport function checkSaveAndExitRepeater(\n  context: FormContext,\n  model: FormModel\n) {\n  const potentiallyInvalidState = context.state[STATE_NOT_YET_VALIDATED] as\n    | Record<string, FormValue>\n    | undefined\n  if (!potentiallyInvalidState) {\n    return\n  }\n\n  const originalPath = potentiallyInvalidState[CURRENT_PAGE_PATH_KEY]\n\n  const repeaterPaths = model.def.pages\n    .filter((page) => page.controller === ControllerType.Repeat)\n    .map((p) => `/${model.basePath}${p.path}/`)\n\n  if (typeof originalPath !== 'string') {\n    return undefined\n  }\n\n  const segments = originalPath.split('/')\n  const lastSegment = segments.at(-1) ?? ''\n\n  if (!isValidUUID(lastSegment)) {\n    return undefined\n  }\n\n  const guidStartIndex = originalPath.length - GUID_LENGTH\n  const originalPathWithoutGuid = originalPath.substring(0, guidStartIndex)\n\n  if (!repeaterPaths.includes(originalPathWithoutGuid)) {\n    return undefined\n  }\n\n  return originalPath\n}\n\n/**\n * Copies any potentially invalid state into the payload, and removes those values from state\n * NOTE - this method has a side-effect on 'context.state' and 'context.payload'\n * @param request - the form request\n * @param context - the form context\n */\nexport async function copyNotYetValidatedState(\n  request: AnyFormRequest,\n  context: FormContext\n) {\n  const potentiallyInvalidState = context.state[STATE_NOT_YET_VALIDATED] as\n    | Record<string, FormValue>\n    | undefined\n  if (!potentiallyInvalidState) {\n    return\n  }\n\n  const originalPath = potentiallyInvalidState[CURRENT_PAGE_PATH_KEY]\n\n  if (originalPath && originalPath === request.url.pathname) {\n    context.payload = {\n      ...context.payload,\n      ...potentiallyInvalidState,\n      [CURRENT_PAGE_PATH_KEY]: undefined\n    }\n\n    // Remove any temporary 'not yet validated' state now it's been copied to the payload\n    if (context.state[STATE_NOT_YET_VALIDATED]) {\n      context.state[STATE_NOT_YET_VALIDATED] = undefined\n    }\n\n    const cacheService = getCacheService(request.server)\n    await cacheService.setState(request, context.state)\n  }\n}\n"],"mappings":"AAAA,SAASA,cAAc,EAAEC,eAAe,QAAQ,oBAAoB;AACpE,SAASC,QAAQ,IAAIC,WAAW,QAAQ,MAAM;AAE9C,SAASC,eAAe;AACxB,SACEC,qBAAqB,EACrBC,uBAAuB;AAazB,MAAMC,WAAW,GAAG,EAAE;;AAEtB;AACA;AACA;AACA,MAAMC,oBAAoB,GAAG;EAC3BC,MAAM,EAAE,MAAAA,CAAOC,GAAW,EAAEC,QAAkB,KAAK;IACjD,IAAIC,SAAS;IACb,IAAIF,GAAG,EAAE;MACP,MAAMG,IAAI,GAAG,MAAMF,QAAQ,CAACG,YAAY,CAACC,mBAAmB,CAACL,GAAG,CAAC;MACjEE,SAAS,GAAGC,IAAI,CAACG,KAAK;IACxB;IACA,OAAO;MACLC,GAAG,EAAE,UAAU;MACfC,KAAK,EAAEN;IACT,CAAC;EACH;AACF,CAQC;AAED,OAAO,SAASO,UAAUA,CAACC,KAAgB,EAAEC,aAAqB,EAAE;EAClE,MAAMC,MAAM,GAAG,CAAC,CAA+C;EAC/D,KAAK,MAAM,CAACL,GAAG,EAAEC,KAAK,GAAG,EAAE,CAAC,IAAIK,MAAM,CAACC,OAAO,CAACJ,KAAK,CAAC,EAAE;IACrD,IAAIH,GAAG,KAAKI,aAAa,EAAE;MACzBC,MAAM,CAACL,GAAG,CAAC,GAAGC,KAAK;IACrB;EACF;EACA,OAAOK,MAAM,CAACE,IAAI,CAACH,MAAM,CAAC,CAACI,MAAM,GAAIJ,MAAM,GAAiBK,SAAS;AACvE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,+BAA+BA,CACnDC,OAAuB,EACvBC,IAAyB,EACP;EAClB,MAAM;IAAEC;EAAM,CAAC,GAAGD,IAAI;EAEtB,MAAME,gBAAgB,GAAG,IAAIC,GAAG,CAC9BhC,eAAe,CAAC8B,KAAK,CAACG,GAAG,CAAC,CAACC,GAAG,CAAEC,KAAK,IAAKA,KAAK,CAACC,IAAI,CACtD,CAAC;EAED,IAAI,CAACL,gBAAgB,CAACM,IAAI,EAAE;IAC1B,OAAO,KAAK;EACd;;EAEA;EACA,MAAMlB,KAAK,GAAGD,UAAU,CAACU,OAAO,CAACT,KAAK,EAAE,WAAW,CAAC;EAEpD,IAAI,CAACA,KAAK,EAAE;IACV,OAAO,KAAK;EACd;EAEA,MAAME,MAAM,GAAG,CAAC,CAA+C;EAE/D,KAAK,MAAM,CAACL,GAAG,EAAEC,KAAK,GAAG,EAAE,CAAC,IAAIK,MAAM,CAACC,OAAO,CAACJ,KAAK,CAAC,EAAE;IACrD,IAAIY,gBAAgB,CAACO,GAAG,CAACtB,GAAG,CAAC,EAAE;MAC7B,MAAMuB,UAAU,GAAGhC,oBAAoB,CAACS,GAAG,CAAC;MAC5C,IAAIuB,UAAU,EAAE;QACd,MAAMC,GAAG,GAAG,MAAMD,UAAU,CAACtB,KAAK,EAAEa,KAAK,CAACpB,QAAQ,CAAC;QACnD;QACAW,MAAM,CAACL,GAAG,CAAC,GAAGC,KAAK;QACnBI,MAAM,CAACmB,GAAG,CAACxB,GAAG,CAAC,GAAGwB,GAAG,CAACvB,KAAK;MAC7B,CAAC,MAAM;QACLI,MAAM,CAACL,GAAG,CAAC,GAAGC,KAAK;MACrB;IACF;EACF;EAEA,MAAMwB,QAAQ,GAAG,MAAMZ,IAAI,CAACa,QAAQ,CAACd,OAAO,CAAC;EAC7C,MAAMC,IAAI,CAACc,UAAU,CAACf,OAAO,EAAEa,QAAQ,EAAEpB,MAAM,CAAC;EAEhD,OAAO,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASuB,wBAAwBA,CACtCC,OAAoB,EACpBf,KAAgB,EAChB;EACA,MAAMgB,uBAAuB,GAAGD,OAAO,CAACE,KAAK,CAAC1C,uBAAuB,CAExD;EACb,IAAI,CAACyC,uBAAuB,EAAE;IAC5B;EACF;EAEA,MAAME,YAAY,GAAGF,uBAAuB,CAAC1C,qBAAqB,CAAC;EAEnE,MAAM6C,aAAa,GAAGnB,KAAK,CAACG,GAAG,CAACiB,KAAK,CAClCC,MAAM,CAAEtB,IAAI,IAAKA,IAAI,CAACuB,UAAU,KAAKrD,cAAc,CAACsD,MAAM,CAAC,CAC3DnB,GAAG,CAAEoB,CAAC,IAAK,IAAIxB,KAAK,CAACyB,QAAQ,GAAGD,CAAC,CAACE,IAAI,GAAG,CAAC;EAE7C,IAAI,OAAOR,YAAY,KAAK,QAAQ,EAAE;IACpC,OAAOtB,SAAS;EAClB;EAEA,MAAM+B,QAAQ,GAAGT,YAAY,CAACU,KAAK,CAAC,GAAG,CAAC;EACxC,MAAMC,WAAW,GAAGF,QAAQ,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;EAEzC,IAAI,CAAC1D,WAAW,CAACyD,WAAW,CAAC,EAAE;IAC7B,OAAOjC,SAAS;EAClB;EAEA,MAAMmC,cAAc,GAAGb,YAAY,CAACvB,MAAM,GAAGnB,WAAW;EACxD,MAAMwD,uBAAuB,GAAGd,YAAY,CAACe,SAAS,CAAC,CAAC,EAAEF,cAAc,CAAC;EAEzE,IAAI,CAACZ,aAAa,CAACe,QAAQ,CAACF,uBAAuB,CAAC,EAAE;IACpD,OAAOpC,SAAS;EAClB;EAEA,OAAOsB,YAAY;AACrB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeiB,wBAAwBA,CAC5CrC,OAAuB,EACvBiB,OAAoB,EACpB;EACA,MAAMC,uBAAuB,GAAGD,OAAO,CAACE,KAAK,CAAC1C,uBAAuB,CAExD;EACb,IAAI,CAACyC,uBAAuB,EAAE;IAC5B;EACF;EAEA,MAAME,YAAY,GAAGF,uBAAuB,CAAC1C,qBAAqB,CAAC;EAEnE,IAAI4C,YAAY,IAAIA,YAAY,KAAKpB,OAAO,CAACsC,GAAG,CAACC,QAAQ,EAAE;IACzDtB,OAAO,CAACuB,OAAO,GAAG;MAChB,GAAGvB,OAAO,CAACuB,OAAO;MAClB,GAAGtB,uBAAuB;MAC1B,CAAC1C,qBAAqB,GAAGsB;IAC3B,CAAC;;IAED;IACA,IAAImB,OAAO,CAACE,KAAK,CAAC1C,uBAAuB,CAAC,EAAE;MAC1CwC,OAAO,CAACE,KAAK,CAAC1C,uBAAuB,CAAC,GAAGqB,SAAS;IACpD;IAEA,MAAM2C,YAAY,GAAGlE,eAAe,CAACyB,OAAO,CAAC0C,MAAM,CAAC;IACpD,MAAMD,YAAY,CAACE,QAAQ,CAAC3C,OAAO,EAAEiB,OAAO,CAACE,KAAK,CAAC;EACrD;AACF","ignoreList":[]}
+{"version":3,"file":"state.js","names":["ControllerType","getHiddenFields","getCacheService","CURRENT_PAGE_PATH_KEY","STATE_NOT_YET_VALIDATED","isValidUUID","GUID_LENGTH","paramLookupFunctions","formId","val","services","formTitle","meta","formsService","getFormMetadataById","title","key","value","stripParam","query","paramToRemove","params","Object","entries","keys","length","undefined","prefillStateFromQueryParameters","request","page","model","hiddenFieldNames","Set","def","map","field","name","size","has","lookupFunc","res","formData","getState","mergeState","checkSaveAndExitRepeater","context","potentiallyInvalidState","state","originalPath","repeaterPaths","pages","filter","controller","Repeat","p","basePath","path","segments","split","lastSegment","at","guidStartIndex","originalPathWithoutGuid","substring","includes","copyNotYetValidatedState","url","pathname","payload","cacheService","server","setState"],"sources":["../../../../../../src/server/plugins/engine/pageControllers/helpers/state.ts"],"sourcesContent":["import { ControllerType, getHiddenFields } from '@defra/forms-model'\n\nimport { getCacheService } from '~/src/server/plugins/engine/helpers.js'\nimport {\n  CURRENT_PAGE_PATH_KEY,\n  STATE_NOT_YET_VALIDATED\n} from '~/src/server/plugins/engine/index.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport {\n  type AnyFormRequest,\n  type FormContext,\n  type FormStateValue,\n  type FormValue\n} from '~/src/server/plugins/engine/types.js'\nimport { type FormQuery } from '~/src/server/routes/types.js'\nimport { type Services } from '~/src/server/types.js'\nimport { isValidUUID } from '~/src/server/utils/utils.js'\n\nconst GUID_LENGTH = 36\n\n/**\n * A series of functions that can transform a pre-fill input parameter e.g lookup a form title based on form id\n */\nconst paramLookupFunctions = {\n  formId: async (val: string, services: Services) => {\n    let formTitle\n    if (val) {\n      const meta = await services.formsService.getFormMetadataById(val)\n      formTitle = meta.title\n    }\n    return {\n      key: 'formName',\n      value: formTitle\n    }\n  }\n} as Partial<\n  Record<\n    string,\n    (\n      val: string,\n      services: Services\n    ) => Promise<{ key: string; value: string | undefined }>\n  >\n>\n\nexport function stripParam(query: FormQuery, paramToRemove: string) {\n  const params = {} as Record<string, FormStateValue | undefined>\n  for (const [key, value = ''] of Object.entries(query)) {\n    if (key !== paramToRemove) {\n      params[key] = value\n    }\n  }\n  return Object.keys(params).length ? (params as FormQuery) : undefined\n}\n\n/**\n * Any hidden parameters defined in the FormDefinition may be pre-filled by URL parameter values.\n * Other parameters are ignored for security reasons.\n * @param request\n * @param model\n */\nexport async function prefillStateFromQueryParameters(\n  request: AnyFormRequest,\n  page: PageControllerClass\n): Promise<boolean> {\n  const { model } = page\n\n  const hiddenFieldNames = new Set(\n    getHiddenFields(model.def).map((field) => field.name)\n  )\n\n  if (!hiddenFieldNames.size) {\n    return false\n  }\n\n  // Remove 'returnUrl' param\n  const query = stripParam(request.query, 'returnUrl')\n\n  if (!query) {\n    return false\n  }\n\n  const params = {} as Record<string, FormStateValue | undefined>\n\n  for (const [key, value = ''] of Object.entries(query)) {\n    if (hiddenFieldNames.has(key)) {\n      const lookupFunc = paramLookupFunctions[key]\n      if (lookupFunc) {\n        const res = await lookupFunc(value, model.services)\n        // Store original value and result\n        params[key] = value\n        params[res.key] = res.value\n      } else {\n        params[key] = value\n      }\n    }\n  }\n\n  const formData = await page.getState(request)\n  await page.mergeState(request, formData, params)\n\n  return true\n}\n\n/**\n * Checks whether the save-and-exit finished on a repeater with partial state\n * @param context - the form context\n */\nexport function checkSaveAndExitRepeater(\n  context: FormContext,\n  model: FormModel\n) {\n  const potentiallyInvalidState = context.state[STATE_NOT_YET_VALIDATED] as\n    | Record<string, FormValue>\n    | undefined\n  if (!potentiallyInvalidState) {\n    return\n  }\n\n  const originalPath = potentiallyInvalidState[CURRENT_PAGE_PATH_KEY]\n\n  const repeaterPaths = model.def.pages\n    .filter((page) => page.controller === ControllerType.Repeat)\n    .map((p) => `/${model.basePath}${p.path}/`)\n\n  if (typeof originalPath !== 'string') {\n    return undefined\n  }\n\n  const segments = originalPath.split('/')\n  const lastSegment = segments.at(-1) ?? ''\n\n  if (!isValidUUID(lastSegment)) {\n    return undefined\n  }\n\n  const guidStartIndex = originalPath.length - GUID_LENGTH\n  const originalPathWithoutGuid = originalPath.substring(0, guidStartIndex)\n\n  if (!repeaterPaths.includes(originalPathWithoutGuid)) {\n    return undefined\n  }\n\n  return originalPath\n}\n\n/**\n * Copies any potentially invalid state into the payload, and removes those values from state\n * NOTE - this method has a side-effect on 'context.state' and 'context.payload'\n * @param request - the form request\n * @param context - the form context\n */\nexport async function copyNotYetValidatedState(\n  request: AnyFormRequest,\n  context: FormContext\n) {\n  const potentiallyInvalidState = context.state[STATE_NOT_YET_VALIDATED] as\n    | Record<string, FormValue>\n    | undefined\n  if (!potentiallyInvalidState) {\n    return\n  }\n\n  const originalPath = potentiallyInvalidState[CURRENT_PAGE_PATH_KEY]\n\n  if (originalPath && originalPath === request.url.pathname) {\n    context.payload = {\n      ...context.payload,\n      ...potentiallyInvalidState,\n      [CURRENT_PAGE_PATH_KEY]: undefined\n    }\n\n    // Remove any temporary 'not yet validated' state now it's been copied to the payload\n    if (context.state[STATE_NOT_YET_VALIDATED]) {\n      context.state[STATE_NOT_YET_VALIDATED] = undefined\n    }\n\n    const cacheService = getCacheService(request.server)\n    await cacheService.setState(request, context.state)\n  }\n}\n"],"mappings":"AAAA,SAASA,cAAc,EAAEC,eAAe,QAAQ,oBAAoB;AAEpE,SAASC,eAAe;AACxB,SACEC,qBAAqB,EACrBC,uBAAuB;AAYzB,SAASC,WAAW;AAEpB,MAAMC,WAAW,GAAG,EAAE;;AAEtB;AACA;AACA;AACA,MAAMC,oBAAoB,GAAG;EAC3BC,MAAM,EAAE,MAAAA,CAAOC,GAAW,EAAEC,QAAkB,KAAK;IACjD,IAAIC,SAAS;IACb,IAAIF,GAAG,EAAE;MACP,MAAMG,IAAI,GAAG,MAAMF,QAAQ,CAACG,YAAY,CAACC,mBAAmB,CAACL,GAAG,CAAC;MACjEE,SAAS,GAAGC,IAAI,CAACG,KAAK;IACxB;IACA,OAAO;MACLC,GAAG,EAAE,UAAU;MACfC,KAAK,EAAEN;IACT,CAAC;EACH;AACF,CAQC;AAED,OAAO,SAASO,UAAUA,CAACC,KAAgB,EAAEC,aAAqB,EAAE;EAClE,MAAMC,MAAM,GAAG,CAAC,CAA+C;EAC/D,KAAK,MAAM,CAACL,GAAG,EAAEC,KAAK,GAAG,EAAE,CAAC,IAAIK,MAAM,CAACC,OAAO,CAACJ,KAAK,CAAC,EAAE;IACrD,IAAIH,GAAG,KAAKI,aAAa,EAAE;MACzBC,MAAM,CAACL,GAAG,CAAC,GAAGC,KAAK;IACrB;EACF;EACA,OAAOK,MAAM,CAACE,IAAI,CAACH,MAAM,CAAC,CAACI,MAAM,GAAIJ,MAAM,GAAiBK,SAAS;AACvE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,+BAA+BA,CACnDC,OAAuB,EACvBC,IAAyB,EACP;EAClB,MAAM;IAAEC;EAAM,CAAC,GAAGD,IAAI;EAEtB,MAAME,gBAAgB,GAAG,IAAIC,GAAG,CAC9B/B,eAAe,CAAC6B,KAAK,CAACG,GAAG,CAAC,CAACC,GAAG,CAAEC,KAAK,IAAKA,KAAK,CAACC,IAAI,CACtD,CAAC;EAED,IAAI,CAACL,gBAAgB,CAACM,IAAI,EAAE;IAC1B,OAAO,KAAK;EACd;;EAEA;EACA,MAAMlB,KAAK,GAAGD,UAAU,CAACU,OAAO,CAACT,KAAK,EAAE,WAAW,CAAC;EAEpD,IAAI,CAACA,KAAK,EAAE;IACV,OAAO,KAAK;EACd;EAEA,MAAME,MAAM,GAAG,CAAC,CAA+C;EAE/D,KAAK,MAAM,CAACL,GAAG,EAAEC,KAAK,GAAG,EAAE,CAAC,IAAIK,MAAM,CAACC,OAAO,CAACJ,KAAK,CAAC,EAAE;IACrD,IAAIY,gBAAgB,CAACO,GAAG,CAACtB,GAAG,CAAC,EAAE;MAC7B,MAAMuB,UAAU,GAAGhC,oBAAoB,CAACS,GAAG,CAAC;MAC5C,IAAIuB,UAAU,EAAE;QACd,MAAMC,GAAG,GAAG,MAAMD,UAAU,CAACtB,KAAK,EAAEa,KAAK,CAACpB,QAAQ,CAAC;QACnD;QACAW,MAAM,CAACL,GAAG,CAAC,GAAGC,KAAK;QACnBI,MAAM,CAACmB,GAAG,CAACxB,GAAG,CAAC,GAAGwB,GAAG,CAACvB,KAAK;MAC7B,CAAC,MAAM;QACLI,MAAM,CAACL,GAAG,CAAC,GAAGC,KAAK;MACrB;IACF;EACF;EAEA,MAAMwB,QAAQ,GAAG,MAAMZ,IAAI,CAACa,QAAQ,CAACd,OAAO,CAAC;EAC7C,MAAMC,IAAI,CAACc,UAAU,CAACf,OAAO,EAAEa,QAAQ,EAAEpB,MAAM,CAAC;EAEhD,OAAO,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASuB,wBAAwBA,CACtCC,OAAoB,EACpBf,KAAgB,EAChB;EACA,MAAMgB,uBAAuB,GAAGD,OAAO,CAACE,KAAK,CAAC3C,uBAAuB,CAExD;EACb,IAAI,CAAC0C,uBAAuB,EAAE;IAC5B;EACF;EAEA,MAAME,YAAY,GAAGF,uBAAuB,CAAC3C,qBAAqB,CAAC;EAEnE,MAAM8C,aAAa,GAAGnB,KAAK,CAACG,GAAG,CAACiB,KAAK,CAClCC,MAAM,CAAEtB,IAAI,IAAKA,IAAI,CAACuB,UAAU,KAAKpD,cAAc,CAACqD,MAAM,CAAC,CAC3DnB,GAAG,CAAEoB,CAAC,IAAK,IAAIxB,KAAK,CAACyB,QAAQ,GAAGD,CAAC,CAACE,IAAI,GAAG,CAAC;EAE7C,IAAI,OAAOR,YAAY,KAAK,QAAQ,EAAE;IACpC,OAAOtB,SAAS;EAClB;EAEA,MAAM+B,QAAQ,GAAGT,YAAY,CAACU,KAAK,CAAC,GAAG,CAAC;EACxC,MAAMC,WAAW,GAAGF,QAAQ,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;EAEzC,IAAI,CAACvD,WAAW,CAACsD,WAAW,CAAC,EAAE;IAC7B,OAAOjC,SAAS;EAClB;EAEA,MAAMmC,cAAc,GAAGb,YAAY,CAACvB,MAAM,GAAGnB,WAAW;EACxD,MAAMwD,uBAAuB,GAAGd,YAAY,CAACe,SAAS,CAAC,CAAC,EAAEF,cAAc,CAAC;EAEzE,IAAI,CAACZ,aAAa,CAACe,QAAQ,CAACF,uBAAuB,CAAC,EAAE;IACpD,OAAOpC,SAAS;EAClB;EAEA,OAAOsB,YAAY;AACrB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeiB,wBAAwBA,CAC5CrC,OAAuB,EACvBiB,OAAoB,EACpB;EACA,MAAMC,uBAAuB,GAAGD,OAAO,CAACE,KAAK,CAAC3C,uBAAuB,CAExD;EACb,IAAI,CAAC0C,uBAAuB,EAAE;IAC5B;EACF;EAEA,MAAME,YAAY,GAAGF,uBAAuB,CAAC3C,qBAAqB,CAAC;EAEnE,IAAI6C,YAAY,IAAIA,YAAY,KAAKpB,OAAO,CAACsC,GAAG,CAACC,QAAQ,EAAE;IACzDtB,OAAO,CAACuB,OAAO,GAAG;MAChB,GAAGvB,OAAO,CAACuB,OAAO;MAClB,GAAGtB,uBAAuB;MAC1B,CAAC3C,qBAAqB,GAAGuB;IAC3B,CAAC;;IAED;IACA,IAAImB,OAAO,CAACE,KAAK,CAAC3C,uBAAuB,CAAC,EAAE;MAC1CyC,OAAO,CAACE,KAAK,CAAC3C,uBAAuB,CAAC,GAAGsB,SAAS;IACpD;IAEA,MAAM2C,YAAY,GAAGnE,eAAe,CAAC0B,OAAO,CAAC0C,MAAM,CAAC;IACpD,MAAMD,YAAY,CAACE,QAAQ,CAAC3C,OAAO,EAAEiB,OAAO,CAACE,KAAK,CAAC;EACrD;AACF","ignoreList":[]}

package/.server/server/plugins/engine/pageControllers/validationOptions.js

@@ -21,6 +21,7 @@ export const messageTemplate = {
   minMax: '{{#label}} must be between {{#min}} and {{#max}} characters',
   pattern: joi.expression('Enter a valid {{lowerFirst(#label)}}', opts),
   format: joi.expression('Enter {{lowerFirst(#label)}} in the correct format', opts),
+  unicode: '{{#label}} includes invalid characters, for example, long dashes',
   number: '{{#label}} must be a number',
   numberPrecision: '{{#label}} must have {{#limit}} or fewer decimal places',
   numberInteger: '{{#label}} must be a whole number',
@@ -41,6 +42,7 @@ export const messages = {
   'string.empty': messageTemplate.required,
   'string.max': messageTemplate.max,
   'string.email': messageTemplate.format,
+  'string.unicode': messageTemplate.unicode,
   'string.pattern.base': messageTemplate.pattern,
   'string.maxWords': messageTemplate.maxWords,
   'number.base': messageTemplate.number,

package/.server/server/plugins/engine/pageControllers/validationOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"validationOptions.js","names":["joi","lowerFirstPreserveProperNouns","opts","functions","lowerFirst","messageTemplate","declarationRequired","expression","required","selectRequired","selectYesNoRequired","max","min","minMax","pattern","format","number","numberPrecision","numberInteger","numberMin","numberMax","maxWords","objectRequired","objectMissing","dateFormat","dateMin","dateMax","messages","messagesPre","validationOptions","abortEarly","errors","wrap","array","label"],"sources":["../../../../../src/server/plugins/engine/pageControllers/validationOptions.ts"],"sourcesContent":["// Declaration above is needed for: https://github.com/hapijs/joi/issues/3064\n\nimport joi, {\n  type JoiExpression,\n  type LanguageMessages,\n  type LanguageMessagesExt,\n  type ReferenceOptions,\n  type ValidationOptions\n} from 'joi'\n\nimport { lowerFirstPreserveProperNouns } from '~/src/server/plugins/engine/components/helpers/index.js'\n\nconst opts = {\n  functions: {\n    lowerFirst: lowerFirstPreserveProperNouns\n  }\n} as ReferenceOptions\n\n/**\n * see @link https://joi.dev/api/?v=17.4.2#template-syntax for template syntax\n */\nexport const messageTemplate: Record<string, JoiExpression> = {\n  declarationRequired: joi.expression(\n    'You must confirm you understand and agree with the {{lowerFirst(#label)}} to continue',\n    opts\n  ) as JoiExpression,\n  required: joi.expression(\n    'Enter {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  selectRequired: joi.expression(\n    'Select {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  selectYesNoRequired: '{{#label}} - select yes or no',\n  max: '{{#label}} must be {{#limit}} characters or less',\n  min: '{{#label}} must be {{#limit}} characters or more',\n  minMax: '{{#label}} must be between {{#min}} and {{#max}} characters',\n  pattern: joi.expression(\n    'Enter a valid {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  format: joi.expression(\n    'Enter {{lowerFirst(#label)}} in the correct format',\n    opts\n  ) as JoiExpression,\n  number: '{{#label}} must be a number',\n  numberPrecision: '{{#label}} must have {{#limit}} or fewer decimal places',\n  numberInteger: '{{#label}} must be a whole number',\n  numberMin: '{{#label}} must be {{#limit}} or higher',\n  numberMax: '{{#label}} must be {{#limit}} or lower',\n  maxWords: '{{#label}} must be {{#limit}} words or fewer',\n\n  // Nested fields use component title\n\n  objectRequired: joi.expression('Enter {{#label}}', opts) as JoiExpression,\n  objectMissing: joi.expression(\n    '{{#title}} must include a {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  dateFormat: '{{#title}} must be a real date',\n  dateMin: '{{#title}} must be the same as or after {{#limit}}',\n  dateMax: '{{#title}} must be the same as or before {{#limit}}'\n}\n\nexport const messages: LanguageMessagesExt = {\n  'string.base': messageTemplate.required,\n  'string.min': messageTemplate.min,\n  'string.empty': messageTemplate.required,\n  'string.max': messageTemplate.max,\n  'string.email': messageTemplate.format,\n  'string.pattern.base': messageTemplate.pattern,\n  'string.maxWords': messageTemplate.maxWords,\n\n  'number.base': messageTemplate.number,\n  'number.precision': messageTemplate.numberPrecision,\n  'number.integer': messageTemplate.numberInteger,\n  'number.unsafe': messageTemplate.format,\n  'number.min': messageTemplate.numberMin,\n  'number.max': messageTemplate.numberMax,\n\n  'object.required': messageTemplate.objectRequired,\n  'object.and': messageTemplate.objectMissing,\n\n  'any.only': messageTemplate.selectRequired,\n  'any.required': messageTemplate.selectRequired,\n  'any.empty': messageTemplate.required,\n\n  'date.base': messageTemplate.dateFormat,\n  'date.format': messageTemplate.dateFormat,\n  'date.min': messageTemplate.dateMin,\n  'date.max': messageTemplate.dateMax,\n\n  'object.invalidjson': messageTemplate.format\n}\n\nexport const messagesPre: LanguageMessages =\n  messages as unknown as LanguageMessages\n\nexport const validationOptions: ValidationOptions = {\n  abortEarly: false,\n  messages: messagesPre,\n  errors: {\n    wrap: {\n      array: false,\n      label: false\n    }\n  }\n}\n"],"mappings":"AAAA;;AAEA,OAAOA,GAAG,MAMH,KAAK;AAEZ,SAASC,6BAA6B;AAEtC,MAAMC,IAAI,GAAG;EACXC,SAAS,EAAE;IACTC,UAAU,EAAEH;EACd;AACF,CAAqB;;AAErB;AACA;AACA;AACA,OAAO,MAAMI,eAA8C,GAAG;EAC5DC,mBAAmB,EAAEN,GAAG,CAACO,UAAU,CACjC,uFAAuF,EACvFL,IACF,CAAkB;EAClBM,QAAQ,EAAER,GAAG,CAACO,UAAU,CACtB,8BAA8B,EAC9BL,IACF,CAAkB;EAClBO,cAAc,EAAET,GAAG,CAACO,UAAU,CAC5B,+BAA+B,EAC/BL,IACF,CAAkB;EAClBQ,mBAAmB,EAAE,+BAA+B;EACpDC,GAAG,EAAE,kDAAkD;EACvDC,GAAG,EAAE,kDAAkD;EACvDC,MAAM,EAAE,6DAA6D;EACrEC,OAAO,EAAEd,GAAG,CAACO,UAAU,CACrB,sCAAsC,EACtCL,IACF,CAAkB;EAClBa,MAAM,EAAEf,GAAG,CAACO,UAAU,CACpB,oDAAoD,EACpDL,IACF,CAAkB;EAClBc,MAAM,EAAE,6BAA6B;EACrCC,eAAe,EAAE,yDAAyD;EAC1EC,aAAa,EAAE,mCAAmC;EAClDC,SAAS,EAAE,yCAAyC;EACpDC,SAAS,EAAE,wCAAwC;EACnDC,QAAQ,EAAE,8CAA8C;EAExD;;EAEAC,cAAc,EAAEtB,GAAG,CAACO,UAAU,CAAC,kBAAkB,EAAEL,IAAI,CAAkB;EACzEqB,aAAa,EAAEvB,GAAG,CAACO,UAAU,CAC3B,kDAAkD,EAClDL,IACF,CAAkB;EAClBsB,UAAU,EAAE,gCAAgC;EAC5CC,OAAO,EAAE,oDAAoD;EAC7DC,OAAO,EAAE;AACX,CAAC;AAED,OAAO,MAAMC,QAA6B,GAAG;EAC3C,aAAa,EAAEtB,eAAe,CAACG,QAAQ;EACvC,YAAY,EAAEH,eAAe,CAACO,GAAG;EACjC,cAAc,EAAEP,eAAe,CAACG,QAAQ;EACxC,YAAY,EAAEH,eAAe,CAACM,GAAG;EACjC,cAAc,EAAEN,eAAe,CAACU,MAAM;EACtC,qBAAqB,EAAEV,eAAe,CAACS,OAAO;EAC9C,iBAAiB,EAAET,eAAe,CAACgB,QAAQ;EAE3C,aAAa,EAAEhB,eAAe,CAACW,MAAM;EACrC,kBAAkB,EAAEX,eAAe,CAACY,eAAe;EACnD,gBAAgB,EAAEZ,eAAe,CAACa,aAAa;EAC/C,eAAe,EAAEb,eAAe,CAACU,MAAM;EACvC,YAAY,EAAEV,eAAe,CAACc,SAAS;EACvC,YAAY,EAAEd,eAAe,CAACe,SAAS;EAEvC,iBAAiB,EAAEf,eAAe,CAACiB,cAAc;EACjD,YAAY,EAAEjB,eAAe,CAACkB,aAAa;EAE3C,UAAU,EAAElB,eAAe,CAACI,cAAc;EAC1C,cAAc,EAAEJ,eAAe,CAACI,cAAc;EAC9C,WAAW,EAAEJ,eAAe,CAACG,QAAQ;EAErC,WAAW,EAAEH,eAAe,CAACmB,UAAU;EACvC,aAAa,EAAEnB,eAAe,CAACmB,UAAU;EACzC,UAAU,EAAEnB,eAAe,CAACoB,OAAO;EACnC,UAAU,EAAEpB,eAAe,CAACqB,OAAO;EAEnC,oBAAoB,EAAErB,eAAe,CAACU;AACxC,CAAC;AAED,OAAO,MAAMa,WAA6B,GACxCD,QAAuC;AAEzC,OAAO,MAAME,iBAAoC,GAAG;EAClDC,UAAU,EAAE,KAAK;EACjBH,QAAQ,EAAEC,WAAW;EACrBG,MAAM,EAAE;IACNC,IAAI,EAAE;MACJC,KAAK,EAAE,KAAK;MACZC,KAAK,EAAE;IACT;EACF;AACF,CAAC","ignoreList":[]}
+{"version":3,"file":"validationOptions.js","names":["joi","lowerFirstPreserveProperNouns","opts","functions","lowerFirst","messageTemplate","declarationRequired","expression","required","selectRequired","selectYesNoRequired","max","min","minMax","pattern","format","unicode","number","numberPrecision","numberInteger","numberMin","numberMax","maxWords","objectRequired","objectMissing","dateFormat","dateMin","dateMax","messages","messagesPre","validationOptions","abortEarly","errors","wrap","array","label"],"sources":["../../../../../src/server/plugins/engine/pageControllers/validationOptions.ts"],"sourcesContent":["// Declaration above is needed for: https://github.com/hapijs/joi/issues/3064\n\nimport joi, {\n  type JoiExpression,\n  type LanguageMessages,\n  type LanguageMessagesExt,\n  type ReferenceOptions,\n  type ValidationOptions\n} from 'joi'\n\nimport { lowerFirstPreserveProperNouns } from '~/src/server/plugins/engine/components/helpers/index.js'\n\nconst opts = {\n  functions: {\n    lowerFirst: lowerFirstPreserveProperNouns\n  }\n} as ReferenceOptions\n\n/**\n * see @link https://joi.dev/api/?v=17.4.2#template-syntax for template syntax\n */\nexport const messageTemplate: Record<string, JoiExpression> = {\n  declarationRequired: joi.expression(\n    'You must confirm you understand and agree with the {{lowerFirst(#label)}} to continue',\n    opts\n  ) as JoiExpression,\n  required: joi.expression(\n    'Enter {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  selectRequired: joi.expression(\n    'Select {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  selectYesNoRequired: '{{#label}} - select yes or no',\n  max: '{{#label}} must be {{#limit}} characters or less',\n  min: '{{#label}} must be {{#limit}} characters or more',\n  minMax: '{{#label}} must be between {{#min}} and {{#max}} characters',\n  pattern: joi.expression(\n    'Enter a valid {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  format: joi.expression(\n    'Enter {{lowerFirst(#label)}} in the correct format',\n    opts\n  ) as JoiExpression,\n  unicode: '{{#label}} includes invalid characters, for example, long dashes',\n  number: '{{#label}} must be a number',\n  numberPrecision: '{{#label}} must have {{#limit}} or fewer decimal places',\n  numberInteger: '{{#label}} must be a whole number',\n  numberMin: '{{#label}} must be {{#limit}} or higher',\n  numberMax: '{{#label}} must be {{#limit}} or lower',\n  maxWords: '{{#label}} must be {{#limit}} words or fewer',\n\n  // Nested fields use component title\n\n  objectRequired: joi.expression('Enter {{#label}}', opts) as JoiExpression,\n  objectMissing: joi.expression(\n    '{{#title}} must include a {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  dateFormat: '{{#title}} must be a real date',\n  dateMin: '{{#title}} must be the same as or after {{#limit}}',\n  dateMax: '{{#title}} must be the same as or before {{#limit}}'\n}\n\nexport const messages: LanguageMessagesExt = {\n  'string.base': messageTemplate.required,\n  'string.min': messageTemplate.min,\n  'string.empty': messageTemplate.required,\n  'string.max': messageTemplate.max,\n  'string.email': messageTemplate.format,\n  'string.unicode': messageTemplate.unicode,\n  'string.pattern.base': messageTemplate.pattern,\n  'string.maxWords': messageTemplate.maxWords,\n\n  'number.base': messageTemplate.number,\n  'number.precision': messageTemplate.numberPrecision,\n  'number.integer': messageTemplate.numberInteger,\n  'number.unsafe': messageTemplate.format,\n  'number.min': messageTemplate.numberMin,\n  'number.max': messageTemplate.numberMax,\n\n  'object.required': messageTemplate.objectRequired,\n  'object.and': messageTemplate.objectMissing,\n\n  'any.only': messageTemplate.selectRequired,\n  'any.required': messageTemplate.selectRequired,\n  'any.empty': messageTemplate.required,\n\n  'date.base': messageTemplate.dateFormat,\n  'date.format': messageTemplate.dateFormat,\n  'date.min': messageTemplate.dateMin,\n  'date.max': messageTemplate.dateMax,\n\n  'object.invalidjson': messageTemplate.format\n}\n\nexport const messagesPre: LanguageMessages =\n  messages as unknown as LanguageMessages\n\nexport const validationOptions: ValidationOptions = {\n  abortEarly: false,\n  messages: messagesPre,\n  errors: {\n    wrap: {\n      array: false,\n      label: false\n    }\n  }\n}\n"],"mappings":"AAAA;;AAEA,OAAOA,GAAG,MAMH,KAAK;AAEZ,SAASC,6BAA6B;AAEtC,MAAMC,IAAI,GAAG;EACXC,SAAS,EAAE;IACTC,UAAU,EAAEH;EACd;AACF,CAAqB;;AAErB;AACA;AACA;AACA,OAAO,MAAMI,eAA8C,GAAG;EAC5DC,mBAAmB,EAAEN,GAAG,CAACO,UAAU,CACjC,uFAAuF,EACvFL,IACF,CAAkB;EAClBM,QAAQ,EAAER,GAAG,CAACO,UAAU,CACtB,8BAA8B,EAC9BL,IACF,CAAkB;EAClBO,cAAc,EAAET,GAAG,CAACO,UAAU,CAC5B,+BAA+B,EAC/BL,IACF,CAAkB;EAClBQ,mBAAmB,EAAE,+BAA+B;EACpDC,GAAG,EAAE,kDAAkD;EACvDC,GAAG,EAAE,kDAAkD;EACvDC,MAAM,EAAE,6DAA6D;EACrEC,OAAO,EAAEd,GAAG,CAACO,UAAU,CACrB,sCAAsC,EACtCL,IACF,CAAkB;EAClBa,MAAM,EAAEf,GAAG,CAACO,UAAU,CACpB,oDAAoD,EACpDL,IACF,CAAkB;EAClBc,OAAO,EAAE,kEAAkE;EAC3EC,MAAM,EAAE,6BAA6B;EACrCC,eAAe,EAAE,yDAAyD;EAC1EC,aAAa,EAAE,mCAAmC;EAClDC,SAAS,EAAE,yCAAyC;EACpDC,SAAS,EAAE,wCAAwC;EACnDC,QAAQ,EAAE,8CAA8C;EAExD;;EAEAC,cAAc,EAAEvB,GAAG,CAACO,UAAU,CAAC,kBAAkB,EAAEL,IAAI,CAAkB;EACzEsB,aAAa,EAAExB,GAAG,CAACO,UAAU,CAC3B,kDAAkD,EAClDL,IACF,CAAkB;EAClBuB,UAAU,EAAE,gCAAgC;EAC5CC,OAAO,EAAE,oDAAoD;EAC7DC,OAAO,EAAE;AACX,CAAC;AAED,OAAO,MAAMC,QAA6B,GAAG;EAC3C,aAAa,EAAEvB,eAAe,CAACG,QAAQ;EACvC,YAAY,EAAEH,eAAe,CAACO,GAAG;EACjC,cAAc,EAAEP,eAAe,CAACG,QAAQ;EACxC,YAAY,EAAEH,eAAe,CAACM,GAAG;EACjC,cAAc,EAAEN,eAAe,CAACU,MAAM;EACtC,gBAAgB,EAAEV,eAAe,CAACW,OAAO;EACzC,qBAAqB,EAAEX,eAAe,CAACS,OAAO;EAC9C,iBAAiB,EAAET,eAAe,CAACiB,QAAQ;EAE3C,aAAa,EAAEjB,eAAe,CAACY,MAAM;EACrC,kBAAkB,EAAEZ,eAAe,CAACa,eAAe;EACnD,gBAAgB,EAAEb,eAAe,CAACc,aAAa;EAC/C,eAAe,EAAEd,eAAe,CAACU,MAAM;EACvC,YAAY,EAAEV,eAAe,CAACe,SAAS;EACvC,YAAY,EAAEf,eAAe,CAACgB,SAAS;EAEvC,iBAAiB,EAAEhB,eAAe,CAACkB,cAAc;EACjD,YAAY,EAAElB,eAAe,CAACmB,aAAa;EAE3C,UAAU,EAAEnB,eAAe,CAACI,cAAc;EAC1C,cAAc,EAAEJ,eAAe,CAACI,cAAc;EAC9C,WAAW,EAAEJ,eAAe,CAACG,QAAQ;EAErC,WAAW,EAAEH,eAAe,CAACoB,UAAU;EACvC,aAAa,EAAEpB,eAAe,CAACoB,UAAU;EACzC,UAAU,EAAEpB,eAAe,CAACqB,OAAO;EACnC,UAAU,EAAErB,eAAe,CAACsB,OAAO;EAEnC,oBAAoB,EAAEtB,eAAe,CAACU;AACxC,CAAC;AAED,OAAO,MAAMc,WAA6B,GACxCD,QAAuC;AAEzC,OAAO,MAAME,iBAAoC,GAAG;EAClDC,UAAU,EAAE,KAAK;EACjBH,QAAQ,EAAEC,WAAW;EACrBG,MAAM,EAAE;IACNC,IAAI,EAAE;MACJC,KAAK,EAAE,KAAK;MACZC,KAAK,EAAE;IACT;EACF;AACF,CAAC","ignoreList":[]}

package/.server/server/utils/utils.d.ts

@@ -5,3 +5,9 @@
  * @returns {Record<string, string> | undefined} The merged headers, or undefined if no tracing header is available.
  */
 export function applyTraceHeaders(existingHeaders?: Record<string, string> | undefined, header?: string): Record<string, string> | undefined;
+/**
+ * Validates if a string conforms to the uuid structure
+ * @param {string} str
+ * @returns
+ */
+export function isValidUUID(str: string): boolean;

package/.server/server/utils/utils.js

@@ -1,4 +1,5 @@
 import { getTraceId } from '@defra/hapi-tracing';
+import Joi from 'joi';
 import { config } from "../../config/index.js";
 
 /**
@@ -17,4 +18,16 @@ export function applyTraceHeaders(existingHeaders, header = config.get('tracing'
   } : undefined;
   return existingHeaders ? Object.assign(existingHeaders, headers) : headers;
 }
+
+/**
+ * Validates if a string conforms to the uuid structure
+ * @param {string} str
+ * @returns
+ */
+export function isValidUUID(str) {
+  const {
+    error
+  } = Joi.string().uuid().validate(str);
+  return error === undefined;
+}
 //# sourceMappingURL=utils.js.map

package/.server/server/utils/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","names":["getTraceId","config","applyTraceHeaders","existingHeaders","header","get","traceId","headers","undefined","Object","assign"],"sources":["../../../src/server/utils/utils.js"],"sourcesContent":["import { getTraceId } from '@defra/hapi-tracing'\n\nimport { config } from '~/src/config/index.js'\n\n/**\n * Returns a set of headers to use in an HTTP request, merging them with any existing headers in options.\n * @param {Record<string, string> | undefined} [existingHeaders] - Optional existing headers to merge with the tracing headers.\n * @param {string} [header] - The tracing header name to use.\n * @returns {Record<string, string> | undefined} The merged headers, or undefined if no tracing header is available.\n */\nexport function applyTraceHeaders(\n  existingHeaders,\n  header = config.get('tracing').header\n) {\n  if (!header) {\n    return existingHeaders\n  }\n\n  const traceId = getTraceId()\n\n  const headers = traceId ? { [header]: traceId } : undefined\n\n  return existingHeaders ? Object.assign(existingHeaders, headers) : headers\n}\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,qBAAqB;AAEhD,SAASC,MAAM;;AAEf;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,iBAAiBA,CAC/BC,eAAe,EACfC,MAAM,GAAGH,MAAM,CAACI,GAAG,CAAC,SAAS,CAAC,CAACD,MAAM,EACrC;EACA,IAAI,CAACA,MAAM,EAAE;IACX,OAAOD,eAAe;EACxB;EAEA,MAAMG,OAAO,GAAGN,UAAU,CAAC,CAAC;EAE5B,MAAMO,OAAO,GAAGD,OAAO,GAAG;IAAE,CAACF,MAAM,GAAGE;EAAQ,CAAC,GAAGE,SAAS;EAE3D,OAAOL,eAAe,GAAGM,MAAM,CAACC,MAAM,CAACP,eAAe,EAAEI,OAAO,CAAC,GAAGA,OAAO;AAC5E","ignoreList":[]}
+{"version":3,"file":"utils.js","names":["getTraceId","Joi","config","applyTraceHeaders","existingHeaders","header","get","traceId","headers","undefined","Object","assign","isValidUUID","str","error","string","uuid","validate"],"sources":["../../../src/server/utils/utils.js"],"sourcesContent":["import { getTraceId } from '@defra/hapi-tracing'\nimport Joi from 'joi'\n\nimport { config } from '~/src/config/index.js'\n\n/**\n * Returns a set of headers to use in an HTTP request, merging them with any existing headers in options.\n * @param {Record<string, string> | undefined} [existingHeaders] - Optional existing headers to merge with the tracing headers.\n * @param {string} [header] - The tracing header name to use.\n * @returns {Record<string, string> | undefined} The merged headers, or undefined if no tracing header is available.\n */\nexport function applyTraceHeaders(\n  existingHeaders,\n  header = config.get('tracing').header\n) {\n  if (!header) {\n    return existingHeaders\n  }\n\n  const traceId = getTraceId()\n\n  const headers = traceId ? { [header]: traceId } : undefined\n\n  return existingHeaders ? Object.assign(existingHeaders, headers) : headers\n}\n\n/**\n * Validates if a string conforms to the uuid structure\n * @param {string} str\n * @returns\n */\nexport function isValidUUID(str) {\n  const { error } = Joi.string().uuid().validate(str)\n  return error === undefined\n}\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,qBAAqB;AAChD,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,MAAM;;AAEf;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,iBAAiBA,CAC/BC,eAAe,EACfC,MAAM,GAAGH,MAAM,CAACI,GAAG,CAAC,SAAS,CAAC,CAACD,MAAM,EACrC;EACA,IAAI,CAACA,MAAM,EAAE;IACX,OAAOD,eAAe;EACxB;EAEA,MAAMG,OAAO,GAAGP,UAAU,CAAC,CAAC;EAE5B,MAAMQ,OAAO,GAAGD,OAAO,GAAG;IAAE,CAACF,MAAM,GAAGE;EAAQ,CAAC,GAAGE,SAAS;EAE3D,OAAOL,eAAe,GAAGM,MAAM,CAACC,MAAM,CAACP,eAAe,EAAEI,OAAO,CAAC,GAAGA,OAAO;AAC5E;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,WAAWA,CAACC,GAAG,EAAE;EAC/B,MAAM;IAAEC;EAAM,CAAC,GAAGb,GAAG,CAACc,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,CAAC,CAACC,QAAQ,CAACJ,GAAG,CAAC;EACnD,OAAOC,KAAK,KAAKL,SAAS;AAC5B","ignoreList":[]}

package/.server/server/utils/utils.test.js

@@ -1,6 +1,6 @@
 import { getTraceId } from '@defra/hapi-tracing';
 import { config } from "../../config/index.js";
-import { applyTraceHeaders } from "./utils.js";
+import { applyTraceHeaders, isValidUUID } from "./utils.js";
 jest.mock('@defra/hapi-tracing');
 describe('Header helper functions', () => {
   it('should include the trace id in the headers if available', () => {
@@ -45,5 +45,41 @@ describe('Header helper functions', () => {
     const result = applyTraceHeaders(existingHeaders, '');
     expect(result).toBe(existingHeaders);
   });
+  it.each([{
+    uuid: '1f457a37-7b99-452e-8324-df9e041abff2',
+    valid: true
+  }, {
+    uuid: '0c9a2690-9a0c-4a2c-98d7-e9ef95615ac9',
+    valid: true
+  }, {
+    uuid: 'f223de3b-5ae5-44b2-8cee-ea8439adc335',
+    valid: true
+  }, {
+    uuid: '82ecc90c-bc47-4ec5-80af-1a9fc1c4c08c',
+    valid: true
+  }, {
+    uuid: 'd99ff582-ecce-474f-a44b-bc5961d977c5',
+    valid: true
+  }, {
+    uuid: '7afffc8a-81ab-4aa6-a8f5-ecf6a600a781',
+    valid: true
+  }, {
+    uuid: '7afffc8a81ab4aa6a8f5ecf6a600a781',
+    valid: true
+  }, {
+    uuid: '',
+    valid: false
+  }, {
+    uuid: 'uuid',
+    valid: false
+  }, {
+    uuid: 'h4f84ef8-b5e1-4544-94aa-1b671d50d8cb',
+    valid: false
+  }])('should validate uuid appropriately %s', ({
+    uuid,
+    valid
+  }) => {
+    expect(isValidUUID(uuid)).toBe(valid);
+  });
 });
 //# sourceMappingURL=utils.test.js.map

package/.server/server/utils/utils.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.test.js","names":["getTraceId","config","applyTraceHeaders","jest","mock","describe","it","mocked","mockReturnValue","result","expect","toEqual","get","header","toBeUndefined","existingHeaders","Authorization","toBe"],"sources":["../../../src/server/utils/utils.test.js"],"sourcesContent":["import { getTraceId } from '@defra/hapi-tracing'\n\nimport { config } from '~/src/config/index.js'\nimport { applyTraceHeaders } from '~/src/server/utils/utils.js'\n\njest.mock('@defra/hapi-tracing')\n\ndescribe('Header helper functions', () => {\n  it('should include the trace id in the headers if available', () => {\n    jest.mocked(getTraceId).mockReturnValue('my-trace-id')\n\n    const result = applyTraceHeaders() // Updated to applyTraceHeaders\n    expect(result).toEqual({\n      [config.get('tracing').header]: 'my-trace-id'\n    })\n  })\n\n  it('should exclude the trace id in the headers if missing', () => {\n    jest.mocked(getTraceId).mockReturnValue(null)\n\n    const result = applyTraceHeaders() // Updated to applyTraceHeaders\n    expect(result).toBeUndefined()\n  })\n\n  it('should merge existing headers with the trace id if available', () => {\n    jest.mocked(getTraceId).mockReturnValue('my-trace-id')\n\n    const existingHeaders = { Authorization: 'Bearer token' }\n    const result = applyTraceHeaders(existingHeaders) // Updated to applyTraceHeaders\n\n    expect(result).toEqual({\n      Authorization: 'Bearer token',\n      [config.get('tracing').header]: 'my-trace-id'\n    })\n  })\n\n  it('should return existing headers without modification if trace id is missing', () => {\n    jest.mocked(getTraceId).mockReturnValue(null)\n\n    const existingHeaders = { Authorization: 'Bearer token' }\n    const result = applyTraceHeaders(existingHeaders) // Updated to applyTraceHeaders\n\n    expect(result).toEqual({\n      Authorization: 'Bearer token'\n    })\n  })\n\n  it('should return existing headers if tracing header configuration is missing', () => {\n    const existingHeaders = { Authorization: 'Bearer token' }\n    const result = applyTraceHeaders(existingHeaders, '')\n\n    expect(result).toBe(existingHeaders)\n  })\n})\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,qBAAqB;AAEhD,SAASC,MAAM;AACf,SAASC,iBAAiB;AAE1BC,IAAI,CAACC,IAAI,CAAC,qBAAqB,CAAC;AAEhCC,QAAQ,CAAC,yBAAyB,EAAE,MAAM;EACxCC,EAAE,CAAC,yDAAyD,EAAE,MAAM;IAClEH,IAAI,CAACI,MAAM,CAACP,UAAU,CAAC,CAACQ,eAAe,CAAC,aAAa,CAAC;IAEtD,MAAMC,MAAM,GAAGP,iBAAiB,CAAC,CAAC,EAAC;IACnCQ,MAAM,CAACD,MAAM,CAAC,CAACE,OAAO,CAAC;MACrB,CAACV,MAAM,CAACW,GAAG,CAAC,SAAS,CAAC,CAACC,MAAM,GAAG;IAClC,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFP,EAAE,CAAC,uDAAuD,EAAE,MAAM;IAChEH,IAAI,CAACI,MAAM,CAACP,UAAU,CAAC,CAACQ,eAAe,CAAC,IAAI,CAAC;IAE7C,MAAMC,MAAM,GAAGP,iBAAiB,CAAC,CAAC,EAAC;IACnCQ,MAAM,CAACD,MAAM,CAAC,CAACK,aAAa,CAAC,CAAC;EAChC,CAAC,CAAC;EAEFR,EAAE,CAAC,8DAA8D,EAAE,MAAM;IACvEH,IAAI,CAACI,MAAM,CAACP,UAAU,CAAC,CAACQ,eAAe,CAAC,aAAa,CAAC;IAEtD,MAAMO,eAAe,GAAG;MAAEC,aAAa,EAAE;IAAe,CAAC;IACzD,MAAMP,MAAM,GAAGP,iBAAiB,CAACa,eAAe,CAAC,EAAC;;IAElDL,MAAM,CAACD,MAAM,CAAC,CAACE,OAAO,CAAC;MACrBK,aAAa,EAAE,cAAc;MAC7B,CAACf,MAAM,CAACW,GAAG,CAAC,SAAS,CAAC,CAACC,MAAM,GAAG;IAClC,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFP,EAAE,CAAC,4EAA4E,EAAE,MAAM;IACrFH,IAAI,CAACI,MAAM,CAACP,UAAU,CAAC,CAACQ,eAAe,CAAC,IAAI,CAAC;IAE7C,MAAMO,eAAe,GAAG;MAAEC,aAAa,EAAE;IAAe,CAAC;IACzD,MAAMP,MAAM,GAAGP,iBAAiB,CAACa,eAAe,CAAC,EAAC;;IAElDL,MAAM,CAACD,MAAM,CAAC,CAACE,OAAO,CAAC;MACrBK,aAAa,EAAE;IACjB,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFV,EAAE,CAAC,2EAA2E,EAAE,MAAM;IACpF,MAAMS,eAAe,GAAG;MAAEC,aAAa,EAAE;IAAe,CAAC;IACzD,MAAMP,MAAM,GAAGP,iBAAiB,CAACa,eAAe,EAAE,EAAE,CAAC;IAErDL,MAAM,CAACD,MAAM,CAAC,CAACQ,IAAI,CAACF,eAAe,CAAC;EACtC,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"utils.test.js","names":["getTraceId","config","applyTraceHeaders","isValidUUID","jest","mock","describe","it","mocked","mockReturnValue","result","expect","toEqual","get","header","toBeUndefined","existingHeaders","Authorization","toBe","each","uuid","valid"],"sources":["../../../src/server/utils/utils.test.js"],"sourcesContent":["import { getTraceId } from '@defra/hapi-tracing'\n\nimport { config } from '~/src/config/index.js'\nimport { applyTraceHeaders, isValidUUID } from '~/src/server/utils/utils.js'\n\njest.mock('@defra/hapi-tracing')\n\ndescribe('Header helper functions', () => {\n  it('should include the trace id in the headers if available', () => {\n    jest.mocked(getTraceId).mockReturnValue('my-trace-id')\n\n    const result = applyTraceHeaders() // Updated to applyTraceHeaders\n    expect(result).toEqual({\n      [config.get('tracing').header]: 'my-trace-id'\n    })\n  })\n\n  it('should exclude the trace id in the headers if missing', () => {\n    jest.mocked(getTraceId).mockReturnValue(null)\n\n    const result = applyTraceHeaders() // Updated to applyTraceHeaders\n    expect(result).toBeUndefined()\n  })\n\n  it('should merge existing headers with the trace id if available', () => {\n    jest.mocked(getTraceId).mockReturnValue('my-trace-id')\n\n    const existingHeaders = { Authorization: 'Bearer token' }\n    const result = applyTraceHeaders(existingHeaders) // Updated to applyTraceHeaders\n\n    expect(result).toEqual({\n      Authorization: 'Bearer token',\n      [config.get('tracing').header]: 'my-trace-id'\n    })\n  })\n\n  it('should return existing headers without modification if trace id is missing', () => {\n    jest.mocked(getTraceId).mockReturnValue(null)\n\n    const existingHeaders = { Authorization: 'Bearer token' }\n    const result = applyTraceHeaders(existingHeaders) // Updated to applyTraceHeaders\n\n    expect(result).toEqual({\n      Authorization: 'Bearer token'\n    })\n  })\n\n  it('should return existing headers if tracing header configuration is missing', () => {\n    const existingHeaders = { Authorization: 'Bearer token' }\n    const result = applyTraceHeaders(existingHeaders, '')\n\n    expect(result).toBe(existingHeaders)\n  })\n\n  it.each([\n    { uuid: '1f457a37-7b99-452e-8324-df9e041abff2', valid: true },\n    { uuid: '0c9a2690-9a0c-4a2c-98d7-e9ef95615ac9', valid: true },\n    { uuid: 'f223de3b-5ae5-44b2-8cee-ea8439adc335', valid: true },\n    { uuid: '82ecc90c-bc47-4ec5-80af-1a9fc1c4c08c', valid: true },\n    { uuid: 'd99ff582-ecce-474f-a44b-bc5961d977c5', valid: true },\n    { uuid: '7afffc8a-81ab-4aa6-a8f5-ecf6a600a781', valid: true },\n    { uuid: '7afffc8a81ab4aa6a8f5ecf6a600a781', valid: true },\n    { uuid: '', valid: false },\n    { uuid: 'uuid', valid: false },\n    { uuid: 'h4f84ef8-b5e1-4544-94aa-1b671d50d8cb', valid: false }\n  ])('should validate uuid appropriately %s', ({ uuid, valid }) => {\n    expect(isValidUUID(uuid)).toBe(valid)\n  })\n})\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,qBAAqB;AAEhD,SAASC,MAAM;AACf,SAASC,iBAAiB,EAAEC,WAAW;AAEvCC,IAAI,CAACC,IAAI,CAAC,qBAAqB,CAAC;AAEhCC,QAAQ,CAAC,yBAAyB,EAAE,MAAM;EACxCC,EAAE,CAAC,yDAAyD,EAAE,MAAM;IAClEH,IAAI,CAACI,MAAM,CAACR,UAAU,CAAC,CAACS,eAAe,CAAC,aAAa,CAAC;IAEtD,MAAMC,MAAM,GAAGR,iBAAiB,CAAC,CAAC,EAAC;IACnCS,MAAM,CAACD,MAAM,CAAC,CAACE,OAAO,CAAC;MACrB,CAACX,MAAM,CAACY,GAAG,CAAC,SAAS,CAAC,CAACC,MAAM,GAAG;IAClC,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFP,EAAE,CAAC,uDAAuD,EAAE,MAAM;IAChEH,IAAI,CAACI,MAAM,CAACR,UAAU,CAAC,CAACS,eAAe,CAAC,IAAI,CAAC;IAE7C,MAAMC,MAAM,GAAGR,iBAAiB,CAAC,CAAC,EAAC;IACnCS,MAAM,CAACD,MAAM,CAAC,CAACK,aAAa,CAAC,CAAC;EAChC,CAAC,CAAC;EAEFR,EAAE,CAAC,8DAA8D,EAAE,MAAM;IACvEH,IAAI,CAACI,MAAM,CAACR,UAAU,CAAC,CAACS,eAAe,CAAC,aAAa,CAAC;IAEtD,MAAMO,eAAe,GAAG;MAAEC,aAAa,EAAE;IAAe,CAAC;IACzD,MAAMP,MAAM,GAAGR,iBAAiB,CAACc,eAAe,CAAC,EAAC;;IAElDL,MAAM,CAACD,MAAM,CAAC,CAACE,OAAO,CAAC;MACrBK,aAAa,EAAE,cAAc;MAC7B,CAAChB,MAAM,CAACY,GAAG,CAAC,SAAS,CAAC,CAACC,MAAM,GAAG;IAClC,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFP,EAAE,CAAC,4EAA4E,EAAE,MAAM;IACrFH,IAAI,CAACI,MAAM,CAACR,UAAU,CAAC,CAACS,eAAe,CAAC,IAAI,CAAC;IAE7C,MAAMO,eAAe,GAAG;MAAEC,aAAa,EAAE;IAAe,CAAC;IACzD,MAAMP,MAAM,GAAGR,iBAAiB,CAACc,eAAe,CAAC,EAAC;;IAElDL,MAAM,CAACD,MAAM,CAAC,CAACE,OAAO,CAAC;MACrBK,aAAa,EAAE;IACjB,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFV,EAAE,CAAC,2EAA2E,EAAE,MAAM;IACpF,MAAMS,eAAe,GAAG;MAAEC,aAAa,EAAE;IAAe,CAAC;IACzD,MAAMP,MAAM,GAAGR,iBAAiB,CAACc,eAAe,EAAE,EAAE,CAAC;IAErDL,MAAM,CAACD,MAAM,CAAC,CAACQ,IAAI,CAACF,eAAe,CAAC;EACtC,CAAC,CAAC;EAEFT,EAAE,CAACY,IAAI,CAAC,CACN;IAAEC,IAAI,EAAE,sCAAsC;IAAEC,KAAK,EAAE;EAAK,CAAC,EAC7D;IAAED,IAAI,EAAE,sCAAsC;IAAEC,KAAK,EAAE;EAAK,CAAC,EAC7D;IAAED,IAAI,EAAE,sCAAsC;IAAEC,KAAK,EAAE;EAAK,CAAC,EAC7D;IAAED,IAAI,EAAE,sCAAsC;IAAEC,KAAK,EAAE;EAAK,CAAC,EAC7D;IAAED,IAAI,EAAE,sCAAsC;IAAEC,KAAK,EAAE;EAAK,CAAC,EAC7D;IAAED,IAAI,EAAE,sCAAsC;IAAEC,KAAK,EAAE;EAAK,CAAC,EAC7D;IAAED,IAAI,EAAE,kCAAkC;IAAEC,KAAK,EAAE;EAAK,CAAC,EACzD;IAAED,IAAI,EAAE,EAAE;IAAEC,KAAK,EAAE;EAAM,CAAC,EAC1B;IAAED,IAAI,EAAE,MAAM;IAAEC,KAAK,EAAE;EAAM,CAAC,EAC9B;IAAED,IAAI,EAAE,sCAAsC;IAAEC,KAAK,EAAE;EAAM,CAAC,CAC/D,CAAC,CAAC,uCAAuC,EAAE,CAAC;IAAED,IAAI;IAAEC;EAAM,CAAC,KAAK;IAC/DV,MAAM,CAACR,WAAW,CAACiB,IAAI,CAAC,CAAC,CAACF,IAAI,CAACG,KAAK,CAAC;EACvC,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.5.6",
+  "version": "4.6.0",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -83,7 +83,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.637",
+    "@defra/forms-model": "^3.0.644",
     "@defra/hapi-tracing": "^1.29.0",
     "@defra/interactive-map": "^0.0.17-alpha",
     "@elastic/ecs-pino-format": "^1.5.0",

package/src/server/plugins/engine/components/EmailAddressField.ts

@@ -1,5 +1,8 @@
-import { type EmailAddressFieldComponent } from '@defra/forms-model'
-import joi from 'joi'
+import {
+  preventUnicodeInEmail,
+  type EmailAddressFieldComponent
+} from '@defra/forms-model'
+import joi, { type CustomHelpers } from 'joi'
 
 import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'
 import { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
@@ -20,7 +23,15 @@ export class EmailAddressField extends FormComponent {
 
     const { options } = def
 
-    let formSchema = joi.string().email().trim().label(this.label).required()
+    let formSchema = joi
+      .string()
+      .trim()
+      .email()
+      .custom((value, helpers: CustomHelpers<string>) =>
+        preventUnicodeInEmail(value, helpers)
+      )
+      .label(this.label)
+      .required()
 
     if (options.required === false) {
       formSchema = formSchema.allow('')
@@ -69,7 +80,8 @@ export class EmailAddressField extends FormComponent {
     return {
       baseErrors: [
         { type: 'required', template: messageTemplate.required },
-        { type: 'format', template: messageTemplate.format }
+        { type: 'format', template: messageTemplate.format },
+        { type: 'unicode', template: messageTemplate.unicode }
       ],
       advancedSettingsErrors: []
     }

package/src/server/plugins/engine/pageControllers/helpers/state.ts

@@ -1,5 +1,4 @@
 import { ControllerType, getHiddenFields } from '@defra/forms-model'
-import { validate as isValidUUID } from 'uuid'
 
 import { getCacheService } from '~/src/server/plugins/engine/helpers.js'
 import {
@@ -16,6 +15,7 @@ import {
 } from '~/src/server/plugins/engine/types.js'
 import { type FormQuery } from '~/src/server/routes/types.js'
 import { type Services } from '~/src/server/types.js'
+import { isValidUUID } from '~/src/server/utils/utils.js'
 
 const GUID_LENGTH = 36
 

package/src/server/plugins/engine/pageControllers/validationOptions.ts

@@ -44,6 +44,7 @@ export const messageTemplate: Record<string, JoiExpression> = {
     'Enter {{lowerFirst(#label)}} in the correct format',
     opts
   ) as JoiExpression,
+  unicode: '{{#label}} includes invalid characters, for example, long dashes',
   number: '{{#label}} must be a number',
   numberPrecision: '{{#label}} must have {{#limit}} or fewer decimal places',
   numberInteger: '{{#label}} must be a whole number',
@@ -69,6 +70,7 @@ export const messages: LanguageMessagesExt = {
   'string.empty': messageTemplate.required,
   'string.max': messageTemplate.max,
   'string.email': messageTemplate.format,
+  'string.unicode': messageTemplate.unicode,
   'string.pattern.base': messageTemplate.pattern,
   'string.maxWords': messageTemplate.maxWords,
 

package/src/server/utils/utils.js

@@ -1,4 +1,5 @@
 import { getTraceId } from '@defra/hapi-tracing'
+import Joi from 'joi'
 
 import { config } from '~/src/config/index.js'
 
@@ -22,3 +23,13 @@ export function applyTraceHeaders(
 
   return existingHeaders ? Object.assign(existingHeaders, headers) : headers
 }
+
+/**
+ * Validates if a string conforms to the uuid structure
+ * @param {string} str
+ * @returns
+ */
+export function isValidUUID(str) {
+  const { error } = Joi.string().uuid().validate(str)
+  return error === undefined
+}

package/src/server/utils/utils.test.js

@@ -1,7 +1,7 @@
 import { getTraceId } from '@defra/hapi-tracing'
 
 import { config } from '~/src/config/index.js'
-import { applyTraceHeaders } from '~/src/server/utils/utils.js'
+import { applyTraceHeaders, isValidUUID } from '~/src/server/utils/utils.js'
 
 jest.mock('@defra/hapi-tracing')
 
@@ -51,4 +51,19 @@ describe('Header helper functions', () => {
 
     expect(result).toBe(existingHeaders)
   })
+
+  it.each([
+    { uuid: '1f457a37-7b99-452e-8324-df9e041abff2', valid: true },
+    { uuid: '0c9a2690-9a0c-4a2c-98d7-e9ef95615ac9', valid: true },
+    { uuid: 'f223de3b-5ae5-44b2-8cee-ea8439adc335', valid: true },
+    { uuid: '82ecc90c-bc47-4ec5-80af-1a9fc1c4c08c', valid: true },
+    { uuid: 'd99ff582-ecce-474f-a44b-bc5961d977c5', valid: true },
+    { uuid: '7afffc8a-81ab-4aa6-a8f5-ecf6a600a781', valid: true },
+    { uuid: '7afffc8a81ab4aa6a8f5ecf6a600a781', valid: true },
+    { uuid: '', valid: false },
+    { uuid: 'uuid', valid: false },
+    { uuid: 'h4f84ef8-b5e1-4544-94aa-1b671d50d8cb', valid: false }
+  ])('should validate uuid appropriately %s', ({ uuid, valid }) => {
+    expect(isValidUUID(uuid)).toBe(valid)
+  })
 })