@defra/forms-engine-plugin 4.1.2 → 4.1.3-alpha.2

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

@@ -71,8 +71,13 @@ export function proceed(request, h, nextUrl) {
   } = query;
   const isReturnAllowed = payload && 'action' in payload ? payload.action === FormAction.Continue || payload.action === FormAction.Validate : false;
 
+  // On POST, strip all query params to prevent them persisting across pages.
+  // On GET, forward params (minus returnUrl) so pre-population query params
+  // survive dispatch redirects (e.g. ?formId= reaching the start page).
+  const nextQuery = method === 'get' ? stripParam(query, 'returnUrl') : undefined;
+
   // Redirect to return location (optional)
-  const response = isReturnAllowed && isPathRelative(returnUrl) ? h.redirect(returnUrl) : h.redirect(redirectPath(nextUrl, stripParam(query, 'returnUrl')));
+  const response = isReturnAllowed && isPathRelative(returnUrl) ? h.redirect(returnUrl) : h.redirect(redirectPath(nextUrl, nextQuery));
 
   // Redirect POST to GET to avoid resubmission
   return method === 'post' ? response.code(StatusCodes.SEE_OTHER) : response.code(StatusCodes.MOVED_TEMPORARILY);

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

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","names":["ControllerPath","Engine","getErrorMessage","hasComponents","isFormType","Boom","format","parseISO","StatusCodes","Liquid","createLogger","getAnswer","stripParam","FormAction","FormStatus","logger","engine","outputEscape","jsTruthy","ownPropertyOnly","registerFilter","template","globals","context","evaluated","evaluateTemplate","path","pageDef","pages","get","query","page","pageMap","undefined","getPageHref","name","componentDef","components","component","componentMap","isFormComponent","answer","relevantState","proceed","request","h","nextUrl","method","payload","returnUrl","isReturnAllowed","action","Continue","Validate","response","isPathRelative","redirect","redirectPath","code","SEE_OTHER","MOVED_TEMPORARILY","encodeUrl","link","URL","toString","err","error","pathOrQuery","queryOnly","Error","getHref","isRelative","params","Object","entries","filter","url","value","searchParams","set","pathname","search","href","startsWith","normalisePath","trim","replace","getPage","model","findPage","notFound","findPath","find","getStartPath","V2","startPath","def","at","Start","startPage","checkFormStatus","isPreview","state","Live","Draft","checkEmailAddressForLiveFormSubmission","emailAddress","internal","getErrors","details","length","map","getError","detail","message","key","text","createError","componentName","safeGenerateCrumb","server","plugins","crumb","generate","route","settings","getExponentialBackoffDelay","depth","BASE_DELAY_MS","CAP_DELAY_MS","delay","Math","min","pageDefMap","componentDefMap","parseAndRenderSync","getCacheService","getPluginOptions","cacheService","getSaveAndExitHelpers","saveAndExit","handleLegacyRedirect","targetUrl","permanent","takeover","setPageTitles","forEach","title","firstFormComponent","type"],"sources":["../../../../src/server/plugins/engine/helpers.ts"],"sourcesContent":["import {\n  ControllerPath,\n  Engine,\n  getErrorMessage,\n  hasComponents,\n  isFormType,\n  type ComponentDef,\n  type FormDefinition,\n  type Page\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type ResponseToolkit, type Server } from '@hapi/hapi'\nimport { format, parseISO } from 'date-fns'\nimport { StatusCodes } from 'http-status-codes'\nimport { type Schema, type ValidationErrorItem } from 'joi'\nimport { Liquid } from 'liquidjs'\n\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport {\n  getAnswer,\n  type Field\n} from '~/src/server/plugins/engine/components/helpers/components.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 { stripParam } from '~/src/server/plugins/engine/pageControllers/helpers/state.js'\nimport {\n  type AnyFormRequest,\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  FormAction,\n  FormStatus,\n  type FormParams,\n  type FormQuery,\n  type FormResponseToolkit\n} from '~/src/server/routes/types.js'\n\nconst logger = createLogger()\n\nexport const engine = new Liquid({\n  outputEscape: 'escape',\n  jsTruthy: true,\n  ownPropertyOnly: false\n})\n\nexport interface GlobalScope {\n  context: FormContext\n  pages: Map<string, Page>\n  components: Map<string, ComponentDef>\n}\n\nengine.registerFilter('evaluate', function (template?: string) {\n  if (typeof template !== 'string') {\n    return template\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const evaluated = evaluateTemplate(template, globals.context)\n\n  return evaluated\n})\n\nengine.registerFilter('page', function (path?: string) {\n  if (typeof path !== 'string') {\n    return\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const pageDef = globals.pages.get(path)\n\n  return pageDef\n})\n\nengine.registerFilter('href', function (path: string, query?: FormQuery) {\n  if (typeof path !== 'string') {\n    return\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const page = globals.context.pageMap.get(path)\n\n  if (page === undefined) {\n    return\n  }\n\n  return getPageHref(page, query)\n})\n\nengine.registerFilter('field', function (name: string) {\n  if (typeof name !== 'string') {\n    return\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const componentDef = globals.components.get(name)\n\n  return componentDef\n})\n\nengine.registerFilter('answer', function (name: string) {\n  if (typeof name !== 'string') {\n    return\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const component = globals.context.componentMap.get(name)\n\n  if (!component?.isFormComponent) {\n    return\n  }\n\n  const answer = getAnswer(component as Field, globals.context.relevantState)\n\n  return answer\n})\n\nexport function proceed(\n  request: Pick<FormContextRequest, 'method' | 'payload' | 'query'>,\n  h: FormResponseToolkit,\n  nextUrl: string\n) {\n  const { method, payload, query } = request\n  const { returnUrl } = query\n\n  const isReturnAllowed =\n    payload && 'action' in payload\n      ? payload.action === FormAction.Continue ||\n        payload.action === FormAction.Validate\n      : false\n\n  // Redirect to return location (optional)\n  const response =\n    isReturnAllowed && isPathRelative(returnUrl)\n      ? h.redirect(returnUrl)\n      : h.redirect(redirectPath(nextUrl, stripParam(query, 'returnUrl')))\n\n  // Redirect POST to GET to avoid resubmission\n  return method === 'post'\n    ? response.code(StatusCodes.SEE_OTHER)\n    : response.code(StatusCodes.MOVED_TEMPORARILY)\n}\n\n/**\n * Encodes a URL, returning undefined if the process fails.\n */\nexport function encodeUrl(link?: string) {\n  if (link) {\n    try {\n      return new URL(link).toString() // escape the search params without breaking the ? and & reserved characters in rfc2368\n    } catch (err) {\n      logger.error(\n        err,\n        `[urlEncodingFailed] Failed to encode URL: ${link} - ${getErrorMessage(err)}`\n      )\n      throw err\n    }\n  }\n}\n\n/**\n * Get page href\n */\nexport function getPageHref(\n  page: PageControllerClass,\n  query?: FormQuery\n): string\n\n/**\n * Get page href by path\n */\nexport function getPageHref(\n  page: PageControllerClass,\n  path: string,\n  query?: FormQuery\n): string\n\nexport function getPageHref(\n  page: PageControllerClass,\n  pathOrQuery?: string | FormQuery,\n  queryOnly: FormQuery = {}\n) {\n  const path = typeof pathOrQuery === 'string' ? pathOrQuery : page.path\n  const query = typeof pathOrQuery === 'object' ? pathOrQuery : queryOnly\n\n  if (!isPathRelative(path)) {\n    throw Error(`Only relative URLs are allowed: ${path}`)\n  }\n\n  // Return path with page href as base\n  return redirectPath(page.getHref(path), query)\n}\n\n/**\n * Get redirect path with optional query params\n */\nexport function redirectPath(nextUrl: string, query: FormQuery = {}) {\n  const isRelative = isPathRelative(nextUrl)\n\n  // Filter string query params only\n  const params = Object.entries(query).filter(\n    (query): query is [string, string] => typeof query[1] === 'string'\n  )\n\n  // Build URL with relative path support\n  const url = isRelative\n    ? new URL(nextUrl, 'http://example.com')\n    : new URL(nextUrl)\n\n  // Append query params\n  for (const [name, value] of params) {\n    url.searchParams.set(name, value)\n  }\n\n  if (isRelative) {\n    return `${url.pathname}${url.search}`\n  }\n\n  return url.href\n}\n\nexport function isPathRelative(path?: string) {\n  return (path ?? '').startsWith('/')\n}\n\nexport function normalisePath(path = '') {\n  return path\n    .trim() // Trim empty spaces\n    .replace(/^\\//, '') // Remove leading slash\n    .replace(/\\/$/, '') // Remove trailing slash\n}\n\nexport function getPage(\n  model: FormModel | undefined,\n  request: FormContextRequest\n) {\n  const { params } = request\n\n  const page = findPage(model, `/${params.path}`)\n\n  if (!page) {\n    throw Boom.notFound(`No page found for /${params.path}`)\n  }\n\n  return page\n}\n\nexport function findPage(model: FormModel | undefined, path?: string) {\n  const findPath = `/${normalisePath(path)}`\n  return model?.pages.find(({ path }) => path === findPath)\n}\n\nexport function getStartPath(model?: FormModel) {\n  if (model?.engine === Engine.V2) {\n    const startPath = normalisePath(model.def.pages.at(0)?.path)\n    return startPath ? `/${startPath}` : ControllerPath.Start\n  }\n\n  const startPath = normalisePath(model?.def.startPage)\n  return startPath ? `/${startPath}` : ControllerPath.Start\n}\n\nexport function checkFormStatus(params?: FormParams) {\n  const isPreview = !!params?.state\n\n  let state = FormStatus.Live\n\n  if (isPreview && params.state === FormStatus.Draft) {\n    state = FormStatus.Draft\n  }\n\n  return {\n    isPreview,\n    state\n  }\n}\n\nexport function checkEmailAddressForLiveFormSubmission(\n  emailAddress: string | undefined,\n  isPreview: boolean\n) {\n  if (!emailAddress && !isPreview) {\n    throw Boom.internal(\n      'An email address is required to complete the form submission'\n    )\n  }\n}\n\n/**\n * Parses the errors from {@link Schema.validate} so they can be rendered by govuk-frontend templates\n * @param [details] - provided by {@link Schema.validate}\n */\nexport function getErrors(\n  details?: ValidationErrorItem[]\n): FormSubmissionError[] | undefined {\n  if (!details?.length) {\n    return\n  }\n\n  return details.map(getError)\n}\n\nexport function getError(detail: ValidationErrorItem): FormSubmissionError {\n  const { context, message, path } = detail\n\n  const name = context?.key ?? ''\n  const href = `#${name}`\n\n  const text = message.replace(\n    /\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d\\.\\d+([+-][0-2]\\d:[0-5]\\d|Z)/,\n    (text) => format(parseISO(text), 'd MMMM yyyy')\n  )\n\n  return {\n    path,\n    href,\n    name,\n    text,\n    context\n  }\n}\n\nexport function createError(componentName: string, message: string) {\n  return {\n    href: `#${componentName}`,\n    name: componentName,\n    text: message\n  }\n}\n\n/**\n * A small helper to safely generate a crumb token.\n * Checks that the crumb plugin is available, that crumb\n * is not disabled on the current route, and that cookies/state are present.\n */\nexport function safeGenerateCrumb(\n  request: AnyFormRequest | null\n): string | undefined {\n  // no request or no .state\n  if (!request?.state) {\n    return undefined\n  }\n\n  // crumb plugin or its generate method doesn't exist\n  if (!request.server.plugins.crumb.generate) {\n    return undefined\n  }\n\n  // crumb is explicitly disabled for this route\n  if (request.route.settings.plugins?.crumb === false) {\n    return undefined\n  }\n\n  return request.server.plugins.crumb.generate(request)\n}\n\n/**\n * Calculates an exponential backoff delay (in milliseconds) based on the current retry depth,\n * using a base delay of 2000ms (2 seconds) and doubling for each additional depth, while capping the delay at 25,000ms (25 seconds).\n * @param depth - The current retry depth (1, 2, 3, …)\n * @returns The calculated delay in milliseconds.\n */\nexport function getExponentialBackoffDelay(depth: number): number {\n  const BASE_DELAY_MS = 2000 // 2 seconds initial delay\n  const CAP_DELAY_MS = 25000 // cap each delay to 25 seconds\n  const delay = BASE_DELAY_MS * 2 ** (depth - 1)\n  return Math.min(delay, CAP_DELAY_MS)\n}\n\nexport function evaluateTemplate(\n  template: string,\n  context: FormContext\n): string {\n  const globals: GlobalScope = {\n    context,\n    pages: context.pageDefMap,\n    components: context.componentDefMap\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n  return engine.parseAndRenderSync(template, context.relevantState, {\n    globals\n  })\n}\n\nexport function getCacheService(server: Server) {\n  return getPluginOptions(server).cacheService\n}\n\nexport function getSaveAndExitHelpers(server: Server) {\n  return getPluginOptions(server).saveAndExit\n}\n\nexport function getPluginOptions(server: Server) {\n  return server.plugins['forms-engine-plugin']\n}\n\n/**\n * Handles logging and issuing a permanent redirect for legacy routes.\n * @param h - The Hapi response toolkit.\n * @param targetUrl - The URL to redirect to.\n * @returns The Hapi response object configured for permanent redirect.\n */\nexport function handleLegacyRedirect(h: ResponseToolkit, targetUrl: string) {\n  return h.redirect(targetUrl).permanent().takeover()\n}\n\n/**\n * If the page doesn't have a title, set it from the title of the first form component\n * @param def - the form definition\n */\nexport function setPageTitles(def: FormDefinition) {\n  def.pages.forEach((page) => {\n    if (!page.title) {\n      if (hasComponents(page)) {\n        // Set the page title from the first form component\n        const firstFormComponent = page.components.find((component) =>\n          isFormType(component.type)\n        )\n\n        page.title = firstFormComponent?.title ?? ''\n      }\n    }\n  })\n}\n"],"mappings":"AAAA,SACEA,cAAc,EACdC,MAAM,EACNC,eAAe,EACfC,aAAa,EACbC,UAAU,QAIL,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAE7B,SAASC,MAAM,EAAEC,QAAQ,QAAQ,UAAU;AAC3C,SAASC,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,MAAM,QAAQ,UAAU;AAEjC,SAASC,YAAY;AACrB,SACEC,SAAS;AAKX,SAASC,UAAU;AAOnB,SACEC,UAAU,EACVC,UAAU;AAMZ,MAAMC,MAAM,GAAGL,YAAY,CAAC,CAAC;AAE7B,OAAO,MAAMM,MAAM,GAAG,IAAIP,MAAM,CAAC;EAC/BQ,YAAY,EAAE,QAAQ;EACtBC,QAAQ,EAAE,IAAI;EACdC,eAAe,EAAE;AACnB,CAAC,CAAC;AAQFH,MAAM,CAACI,cAAc,CAAC,UAAU,EAAE,UAAUC,QAAiB,EAAE;EAC7D,IAAI,OAAOA,QAAQ,KAAK,QAAQ,EAAE;IAChC,OAAOA,QAAQ;EACjB;EAEA,MAAMC,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAME,SAAS,GAAGC,gBAAgB,CAACJ,QAAQ,EAAEC,OAAO,CAACC,OAAO,CAAC;EAE7D,OAAOC,SAAS;AAClB,CAAC,CAAC;AAEFR,MAAM,CAACI,cAAc,CAAC,MAAM,EAAE,UAAUM,IAAa,EAAE;EACrD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMJ,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMK,OAAO,GAAGL,OAAO,CAACM,KAAK,CAACC,GAAG,CAACH,IAAI,CAAC;EAEvC,OAAOC,OAAO;AAChB,CAAC,CAAC;AAEFX,MAAM,CAACI,cAAc,CAAC,MAAM,EAAE,UAAUM,IAAY,EAAEI,KAAiB,EAAE;EACvE,IAAI,OAAOJ,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMJ,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMS,IAAI,GAAGT,OAAO,CAACC,OAAO,CAACS,OAAO,CAACH,GAAG,CAACH,IAAI,CAAC;EAE9C,IAAIK,IAAI,KAAKE,SAAS,EAAE;IACtB;EACF;EAEA,OAAOC,WAAW,CAACH,IAAI,EAAED,KAAK,CAAC;AACjC,CAAC,CAAC;AAEFd,MAAM,CAACI,cAAc,CAAC,OAAO,EAAE,UAAUe,IAAY,EAAE;EACrD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMb,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMc,YAAY,GAAGd,OAAO,CAACe,UAAU,CAACR,GAAG,CAACM,IAAI,CAAC;EAEjD,OAAOC,YAAY;AACrB,CAAC,CAAC;AAEFpB,MAAM,CAACI,cAAc,CAAC,QAAQ,EAAE,UAAUe,IAAY,EAAE;EACtD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMb,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMgB,SAAS,GAAGhB,OAAO,CAACC,OAAO,CAACgB,YAAY,CAACV,GAAG,CAACM,IAAI,CAAC;EAExD,IAAI,CAACG,SAAS,EAAEE,eAAe,EAAE;IAC/B;EACF;EAEA,MAAMC,MAAM,GAAG9B,SAAS,CAAC2B,SAAS,EAAWhB,OAAO,CAACC,OAAO,CAACmB,aAAa,CAAC;EAE3E,OAAOD,MAAM;AACf,CAAC,CAAC;AAEF,OAAO,SAASE,OAAOA,CACrBC,OAAiE,EACjEC,CAAsB,EACtBC,OAAe,EACf;EACA,MAAM;IAAEC,MAAM;IAAEC,OAAO;IAAElB;EAAM,CAAC,GAAGc,OAAO;EAC1C,MAAM;IAAEK;EAAU,CAAC,GAAGnB,KAAK;EAE3B,MAAMoB,eAAe,GACnBF,OAAO,IAAI,QAAQ,IAAIA,OAAO,GAC1BA,OAAO,CAACG,MAAM,KAAKtC,UAAU,CAACuC,QAAQ,IACtCJ,OAAO,CAACG,MAAM,KAAKtC,UAAU,CAACwC,QAAQ,GACtC,KAAK;;EAEX;EACA,MAAMC,QAAQ,GACZJ,eAAe,IAAIK,cAAc,CAACN,SAAS,CAAC,GACxCJ,CAAC,CAACW,QAAQ,CAACP,SAAS,CAAC,GACrBJ,CAAC,CAACW,QAAQ,CAACC,YAAY,CAACX,OAAO,EAAElC,UAAU,CAACkB,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC;;EAEvE;EACA,OAAOiB,MAAM,KAAK,MAAM,GACpBO,QAAQ,CAACI,IAAI,CAAClD,WAAW,CAACmD,SAAS,CAAC,GACpCL,QAAQ,CAACI,IAAI,CAAClD,WAAW,CAACoD,iBAAiB,CAAC;AAClD;;AAEA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACC,IAAa,EAAE;EACvC,IAAIA,IAAI,EAAE;IACR,IAAI;MACF,OAAO,IAAIC,GAAG,CAACD,IAAI,CAAC,CAACE,QAAQ,CAAC,CAAC,EAAC;IAClC,CAAC,CAAC,OAAOC,GAAG,EAAE;MACZlD,MAAM,CAACmD,KAAK,CACVD,GAAG,EACH,6CAA6CH,IAAI,MAAM5D,eAAe,CAAC+D,GAAG,CAAC,EAC7E,CAAC;MACD,MAAMA,GAAG;IACX;EACF;AACF;;AAEA;AACA;AACA;;AAMA;AACA;AACA;;AAOA,OAAO,SAAS/B,WAAWA,CACzBH,IAAyB,EACzBoC,WAAgC,EAChCC,SAAoB,GAAG,CAAC,CAAC,EACzB;EACA,MAAM1C,IAAI,GAAG,OAAOyC,WAAW,KAAK,QAAQ,GAAGA,WAAW,GAAGpC,IAAI,CAACL,IAAI;EACtE,MAAMI,KAAK,GAAG,OAAOqC,WAAW,KAAK,QAAQ,GAAGA,WAAW,GAAGC,SAAS;EAEvE,IAAI,CAACb,cAAc,CAAC7B,IAAI,CAAC,EAAE;IACzB,MAAM2C,KAAK,CAAC,mCAAmC3C,IAAI,EAAE,CAAC;EACxD;;EAEA;EACA,OAAO+B,YAAY,CAAC1B,IAAI,CAACuC,OAAO,CAAC5C,IAAI,CAAC,EAAEI,KAAK,CAAC;AAChD;;AAEA;AACA;AACA;AACA,OAAO,SAAS2B,YAAYA,CAACX,OAAe,EAAEhB,KAAgB,GAAG,CAAC,CAAC,EAAE;EACnE,MAAMyC,UAAU,GAAGhB,cAAc,CAACT,OAAO,CAAC;;EAE1C;EACA,MAAM0B,MAAM,GAAGC,MAAM,CAACC,OAAO,CAAC5C,KAAK,CAAC,CAAC6C,MAAM,CACxC7C,KAAK,IAAgC,OAAOA,KAAK,CAAC,CAAC,CAAC,KAAK,QAC5D,CAAC;;EAED;EACA,MAAM8C,GAAG,GAAGL,UAAU,GAClB,IAAIR,GAAG,CAACjB,OAAO,EAAE,oBAAoB,CAAC,GACtC,IAAIiB,GAAG,CAACjB,OAAO,CAAC;;EAEpB;EACA,KAAK,MAAM,CAACX,IAAI,EAAE0C,KAAK,CAAC,IAAIL,MAAM,EAAE;IAClCI,GAAG,CAACE,YAAY,CAACC,GAAG,CAAC5C,IAAI,EAAE0C,KAAK,CAAC;EACnC;EAEA,IAAIN,UAAU,EAAE;IACd,OAAO,GAAGK,GAAG,CAACI,QAAQ,GAAGJ,GAAG,CAACK,MAAM,EAAE;EACvC;EAEA,OAAOL,GAAG,CAACM,IAAI;AACjB;AAEA,OAAO,SAAS3B,cAAcA,CAAC7B,IAAa,EAAE;EAC5C,OAAO,CAACA,IAAI,IAAI,EAAE,EAAEyD,UAAU,CAAC,GAAG,CAAC;AACrC;AAEA,OAAO,SAASC,aAAaA,CAAC1D,IAAI,GAAG,EAAE,EAAE;EACvC,OAAOA,IAAI,CACR2D,IAAI,CAAC,CAAC,CAAC;EAAA,CACPC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;EAAA,CACnBA,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAC;AACxB;AAEA,OAAO,SAASC,OAAOA,CACrBC,KAA4B,EAC5B5C,OAA2B,EAC3B;EACA,MAAM;IAAE4B;EAAO,CAAC,GAAG5B,OAAO;EAE1B,MAAMb,IAAI,GAAG0D,QAAQ,CAACD,KAAK,EAAE,IAAIhB,MAAM,CAAC9C,IAAI,EAAE,CAAC;EAE/C,IAAI,CAACK,IAAI,EAAE;IACT,MAAM1B,IAAI,CAACqF,QAAQ,CAAC,sBAAsBlB,MAAM,CAAC9C,IAAI,EAAE,CAAC;EAC1D;EAEA,OAAOK,IAAI;AACb;AAEA,OAAO,SAAS0D,QAAQA,CAACD,KAA4B,EAAE9D,IAAa,EAAE;EACpE,MAAMiE,QAAQ,GAAG,IAAIP,aAAa,CAAC1D,IAAI,CAAC,EAAE;EAC1C,OAAO8D,KAAK,EAAE5D,KAAK,CAACgE,IAAI,CAAC,CAAC;IAAElE;EAAK,CAAC,KAAKA,IAAI,KAAKiE,QAAQ,CAAC;AAC3D;AAEA,OAAO,SAASE,YAAYA,CAACL,KAAiB,EAAE;EAC9C,IAAIA,KAAK,EAAExE,MAAM,KAAKf,MAAM,CAAC6F,EAAE,EAAE;IAC/B,MAAMC,SAAS,GAAGX,aAAa,CAACI,KAAK,CAACQ,GAAG,CAACpE,KAAK,CAACqE,EAAE,CAAC,CAAC,CAAC,EAAEvE,IAAI,CAAC;IAC5D,OAAOqE,SAAS,GAAG,IAAIA,SAAS,EAAE,GAAG/F,cAAc,CAACkG,KAAK;EAC3D;EAEA,MAAMH,SAAS,GAAGX,aAAa,CAACI,KAAK,EAAEQ,GAAG,CAACG,SAAS,CAAC;EACrD,OAAOJ,SAAS,GAAG,IAAIA,SAAS,EAAE,GAAG/F,cAAc,CAACkG,KAAK;AAC3D;AAEA,OAAO,SAASE,eAAeA,CAAC5B,MAAmB,EAAE;EACnD,MAAM6B,SAAS,GAAG,CAAC,CAAC7B,MAAM,EAAE8B,KAAK;EAEjC,IAAIA,KAAK,GAAGxF,UAAU,CAACyF,IAAI;EAE3B,IAAIF,SAAS,IAAI7B,MAAM,CAAC8B,KAAK,KAAKxF,UAAU,CAAC0F,KAAK,EAAE;IAClDF,KAAK,GAAGxF,UAAU,CAAC0F,KAAK;EAC1B;EAEA,OAAO;IACLH,SAAS;IACTC;EACF,CAAC;AACH;AAEA,OAAO,SAASG,sCAAsCA,CACpDC,YAAgC,EAChCL,SAAkB,EAClB;EACA,IAAI,CAACK,YAAY,IAAI,CAACL,SAAS,EAAE;IAC/B,MAAMhG,IAAI,CAACsG,QAAQ,CACjB,8DACF,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CACvBC,OAA+B,EACI;EACnC,IAAI,CAACA,OAAO,EAAEC,MAAM,EAAE;IACpB;EACF;EAEA,OAAOD,OAAO,CAACE,GAAG,CAACC,QAAQ,CAAC;AAC9B;AAEA,OAAO,SAASA,QAAQA,CAACC,MAA2B,EAAuB;EACzE,MAAM;IAAE1F,OAAO;IAAE2F,OAAO;IAAExF;EAAK,CAAC,GAAGuF,MAAM;EAEzC,MAAM9E,IAAI,GAAGZ,OAAO,EAAE4F,GAAG,IAAI,EAAE;EAC/B,MAAMjC,IAAI,GAAG,IAAI/C,IAAI,EAAE;EAEvB,MAAMiF,IAAI,GAAGF,OAAO,CAAC5B,OAAO,CAC1B,0EAA0E,EACzE8B,IAAI,IAAK9G,MAAM,CAACC,QAAQ,CAAC6G,IAAI,CAAC,EAAE,aAAa,CAChD,CAAC;EAED,OAAO;IACL1F,IAAI;IACJwD,IAAI;IACJ/C,IAAI;IACJiF,IAAI;IACJ7F;EACF,CAAC;AACH;AAEA,OAAO,SAAS8F,WAAWA,CAACC,aAAqB,EAAEJ,OAAe,EAAE;EAClE,OAAO;IACLhC,IAAI,EAAE,IAAIoC,aAAa,EAAE;IACzBnF,IAAI,EAAEmF,aAAa;IACnBF,IAAI,EAAEF;EACR,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASK,iBAAiBA,CAC/B3E,OAA8B,EACV;EACpB;EACA,IAAI,CAACA,OAAO,EAAE0D,KAAK,EAAE;IACnB,OAAOrE,SAAS;EAClB;;EAEA;EACA,IAAI,CAACW,OAAO,CAAC4E,MAAM,CAACC,OAAO,CAACC,KAAK,CAACC,QAAQ,EAAE;IAC1C,OAAO1F,SAAS;EAClB;;EAEA;EACA,IAAIW,OAAO,CAACgF,KAAK,CAACC,QAAQ,CAACJ,OAAO,EAAEC,KAAK,KAAK,KAAK,EAAE;IACnD,OAAOzF,SAAS;EAClB;EAEA,OAAOW,OAAO,CAAC4E,MAAM,CAACC,OAAO,CAACC,KAAK,CAACC,QAAQ,CAAC/E,OAAO,CAAC;AACvD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASkF,0BAA0BA,CAACC,KAAa,EAAU;EAChE,MAAMC,aAAa,GAAG,IAAI,EAAC;EAC3B,MAAMC,YAAY,GAAG,KAAK,EAAC;EAC3B,MAAMC,KAAK,GAAGF,aAAa,GAAG,CAAC,KAAKD,KAAK,GAAG,CAAC,CAAC;EAC9C,OAAOI,IAAI,CAACC,GAAG,CAACF,KAAK,EAAED,YAAY,CAAC;AACtC;AAEA,OAAO,SAASxG,gBAAgBA,CAC9BJ,QAAgB,EAChBE,OAAoB,EACZ;EACR,MAAMD,OAAoB,GAAG;IAC3BC,OAAO;IACPK,KAAK,EAAEL,OAAO,CAAC8G,UAAU;IACzBhG,UAAU,EAAEd,OAAO,CAAC+G;EACtB,CAAC;;EAED;EACA,OAAOtH,MAAM,CAACuH,kBAAkB,CAAClH,QAAQ,EAAEE,OAAO,CAACmB,aAAa,EAAE;IAChEpB;EACF,CAAC,CAAC;AACJ;AAEA,OAAO,SAASkH,eAAeA,CAAChB,MAAc,EAAE;EAC9C,OAAOiB,gBAAgB,CAACjB,MAAM,CAAC,CAACkB,YAAY;AAC9C;AAEA,OAAO,SAASC,qBAAqBA,CAACnB,MAAc,EAAE;EACpD,OAAOiB,gBAAgB,CAACjB,MAAM,CAAC,CAACoB,WAAW;AAC7C;AAEA,OAAO,SAASH,gBAAgBA,CAACjB,MAAc,EAAE;EAC/C,OAAOA,MAAM,CAACC,OAAO,CAAC,qBAAqB,CAAC;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASoB,oBAAoBA,CAAChG,CAAkB,EAAEiG,SAAiB,EAAE;EAC1E,OAAOjG,CAAC,CAACW,QAAQ,CAACsF,SAAS,CAAC,CAACC,SAAS,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;AACrD;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAACjD,GAAmB,EAAE;EACjDA,GAAG,CAACpE,KAAK,CAACsH,OAAO,CAAEnH,IAAI,IAAK;IAC1B,IAAI,CAACA,IAAI,CAACoH,KAAK,EAAE;MACf,IAAIhJ,aAAa,CAAC4B,IAAI,CAAC,EAAE;QACvB;QACA,MAAMqH,kBAAkB,GAAGrH,IAAI,CAACM,UAAU,CAACuD,IAAI,CAAEtD,SAAS,IACxDlC,UAAU,CAACkC,SAAS,CAAC+G,IAAI,CAC3B,CAAC;QAEDtH,IAAI,CAACoH,KAAK,GAAGC,kBAAkB,EAAED,KAAK,IAAI,EAAE;MAC9C;IACF;EACF,CAAC,CAAC;AACJ","ignoreList":[]}
+{"version":3,"file":"helpers.js","names":["ControllerPath","Engine","getErrorMessage","hasComponents","isFormType","Boom","format","parseISO","StatusCodes","Liquid","createLogger","getAnswer","stripParam","FormAction","FormStatus","logger","engine","outputEscape","jsTruthy","ownPropertyOnly","registerFilter","template","globals","context","evaluated","evaluateTemplate","path","pageDef","pages","get","query","page","pageMap","undefined","getPageHref","name","componentDef","components","component","componentMap","isFormComponent","answer","relevantState","proceed","request","h","nextUrl","method","payload","returnUrl","isReturnAllowed","action","Continue","Validate","nextQuery","response","isPathRelative","redirect","redirectPath","code","SEE_OTHER","MOVED_TEMPORARILY","encodeUrl","link","URL","toString","err","error","pathOrQuery","queryOnly","Error","getHref","isRelative","params","Object","entries","filter","url","value","searchParams","set","pathname","search","href","startsWith","normalisePath","trim","replace","getPage","model","findPage","notFound","findPath","find","getStartPath","V2","startPath","def","at","Start","startPage","checkFormStatus","isPreview","state","Live","Draft","checkEmailAddressForLiveFormSubmission","emailAddress","internal","getErrors","details","length","map","getError","detail","message","key","text","createError","componentName","safeGenerateCrumb","server","plugins","crumb","generate","route","settings","getExponentialBackoffDelay","depth","BASE_DELAY_MS","CAP_DELAY_MS","delay","Math","min","pageDefMap","componentDefMap","parseAndRenderSync","getCacheService","getPluginOptions","cacheService","getSaveAndExitHelpers","saveAndExit","handleLegacyRedirect","targetUrl","permanent","takeover","setPageTitles","forEach","title","firstFormComponent","type"],"sources":["../../../../src/server/plugins/engine/helpers.ts"],"sourcesContent":["import {\n  ControllerPath,\n  Engine,\n  getErrorMessage,\n  hasComponents,\n  isFormType,\n  type ComponentDef,\n  type FormDefinition,\n  type Page\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type ResponseToolkit, type Server } from '@hapi/hapi'\nimport { format, parseISO } from 'date-fns'\nimport { StatusCodes } from 'http-status-codes'\nimport { type Schema, type ValidationErrorItem } from 'joi'\nimport { Liquid } from 'liquidjs'\n\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport {\n  getAnswer,\n  type Field\n} from '~/src/server/plugins/engine/components/helpers/components.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 { stripParam } from '~/src/server/plugins/engine/pageControllers/helpers/state.js'\nimport {\n  type AnyFormRequest,\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  FormAction,\n  FormStatus,\n  type FormParams,\n  type FormQuery,\n  type FormResponseToolkit\n} from '~/src/server/routes/types.js'\n\nconst logger = createLogger()\n\nexport const engine = new Liquid({\n  outputEscape: 'escape',\n  jsTruthy: true,\n  ownPropertyOnly: false\n})\n\nexport interface GlobalScope {\n  context: FormContext\n  pages: Map<string, Page>\n  components: Map<string, ComponentDef>\n}\n\nengine.registerFilter('evaluate', function (template?: string) {\n  if (typeof template !== 'string') {\n    return template\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const evaluated = evaluateTemplate(template, globals.context)\n\n  return evaluated\n})\n\nengine.registerFilter('page', function (path?: string) {\n  if (typeof path !== 'string') {\n    return\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const pageDef = globals.pages.get(path)\n\n  return pageDef\n})\n\nengine.registerFilter('href', function (path: string, query?: FormQuery) {\n  if (typeof path !== 'string') {\n    return\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const page = globals.context.pageMap.get(path)\n\n  if (page === undefined) {\n    return\n  }\n\n  return getPageHref(page, query)\n})\n\nengine.registerFilter('field', function (name: string) {\n  if (typeof name !== 'string') {\n    return\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const componentDef = globals.components.get(name)\n\n  return componentDef\n})\n\nengine.registerFilter('answer', function (name: string) {\n  if (typeof name !== 'string') {\n    return\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const component = globals.context.componentMap.get(name)\n\n  if (!component?.isFormComponent) {\n    return\n  }\n\n  const answer = getAnswer(component as Field, globals.context.relevantState)\n\n  return answer\n})\n\nexport function proceed(\n  request: Pick<FormContextRequest, 'method' | 'payload' | 'query'>,\n  h: FormResponseToolkit,\n  nextUrl: string\n) {\n  const { method, payload, query } = request\n  const { returnUrl } = query\n\n  const isReturnAllowed =\n    payload && 'action' in payload\n      ? payload.action === FormAction.Continue ||\n        payload.action === FormAction.Validate\n      : false\n\n  // On POST, strip all query params to prevent them persisting across pages.\n  // On GET, forward params (minus returnUrl) so pre-population query params\n  // survive dispatch redirects (e.g. ?formId= reaching the start page).\n  const nextQuery =\n    method === 'get' ? stripParam(query, 'returnUrl') : undefined\n\n  // Redirect to return location (optional)\n  const response =\n    isReturnAllowed && isPathRelative(returnUrl)\n      ? h.redirect(returnUrl)\n      : h.redirect(redirectPath(nextUrl, nextQuery))\n\n  // Redirect POST to GET to avoid resubmission\n  return method === 'post'\n    ? response.code(StatusCodes.SEE_OTHER)\n    : response.code(StatusCodes.MOVED_TEMPORARILY)\n}\n\n/**\n * Encodes a URL, returning undefined if the process fails.\n */\nexport function encodeUrl(link?: string) {\n  if (link) {\n    try {\n      return new URL(link).toString() // escape the search params without breaking the ? and & reserved characters in rfc2368\n    } catch (err) {\n      logger.error(\n        err,\n        `[urlEncodingFailed] Failed to encode URL: ${link} - ${getErrorMessage(err)}`\n      )\n      throw err\n    }\n  }\n}\n\n/**\n * Get page href\n */\nexport function getPageHref(\n  page: PageControllerClass,\n  query?: FormQuery\n): string\n\n/**\n * Get page href by path\n */\nexport function getPageHref(\n  page: PageControllerClass,\n  path: string,\n  query?: FormQuery\n): string\n\nexport function getPageHref(\n  page: PageControllerClass,\n  pathOrQuery?: string | FormQuery,\n  queryOnly: FormQuery = {}\n) {\n  const path = typeof pathOrQuery === 'string' ? pathOrQuery : page.path\n  const query = typeof pathOrQuery === 'object' ? pathOrQuery : queryOnly\n\n  if (!isPathRelative(path)) {\n    throw Error(`Only relative URLs are allowed: ${path}`)\n  }\n\n  // Return path with page href as base\n  return redirectPath(page.getHref(path), query)\n}\n\n/**\n * Get redirect path with optional query params\n */\nexport function redirectPath(nextUrl: string, query: FormQuery = {}) {\n  const isRelative = isPathRelative(nextUrl)\n\n  // Filter string query params only\n  const params = Object.entries(query).filter(\n    (query): query is [string, string] => typeof query[1] === 'string'\n  )\n\n  // Build URL with relative path support\n  const url = isRelative\n    ? new URL(nextUrl, 'http://example.com')\n    : new URL(nextUrl)\n\n  // Append query params\n  for (const [name, value] of params) {\n    url.searchParams.set(name, value)\n  }\n\n  if (isRelative) {\n    return `${url.pathname}${url.search}`\n  }\n\n  return url.href\n}\n\nexport function isPathRelative(path?: string) {\n  return (path ?? '').startsWith('/')\n}\n\nexport function normalisePath(path = '') {\n  return path\n    .trim() // Trim empty spaces\n    .replace(/^\\//, '') // Remove leading slash\n    .replace(/\\/$/, '') // Remove trailing slash\n}\n\nexport function getPage(\n  model: FormModel | undefined,\n  request: FormContextRequest\n) {\n  const { params } = request\n\n  const page = findPage(model, `/${params.path}`)\n\n  if (!page) {\n    throw Boom.notFound(`No page found for /${params.path}`)\n  }\n\n  return page\n}\n\nexport function findPage(model: FormModel | undefined, path?: string) {\n  const findPath = `/${normalisePath(path)}`\n  return model?.pages.find(({ path }) => path === findPath)\n}\n\nexport function getStartPath(model?: FormModel) {\n  if (model?.engine === Engine.V2) {\n    const startPath = normalisePath(model.def.pages.at(0)?.path)\n    return startPath ? `/${startPath}` : ControllerPath.Start\n  }\n\n  const startPath = normalisePath(model?.def.startPage)\n  return startPath ? `/${startPath}` : ControllerPath.Start\n}\n\nexport function checkFormStatus(params?: FormParams) {\n  const isPreview = !!params?.state\n\n  let state = FormStatus.Live\n\n  if (isPreview && params.state === FormStatus.Draft) {\n    state = FormStatus.Draft\n  }\n\n  return {\n    isPreview,\n    state\n  }\n}\n\nexport function checkEmailAddressForLiveFormSubmission(\n  emailAddress: string | undefined,\n  isPreview: boolean\n) {\n  if (!emailAddress && !isPreview) {\n    throw Boom.internal(\n      'An email address is required to complete the form submission'\n    )\n  }\n}\n\n/**\n * Parses the errors from {@link Schema.validate} so they can be rendered by govuk-frontend templates\n * @param [details] - provided by {@link Schema.validate}\n */\nexport function getErrors(\n  details?: ValidationErrorItem[]\n): FormSubmissionError[] | undefined {\n  if (!details?.length) {\n    return\n  }\n\n  return details.map(getError)\n}\n\nexport function getError(detail: ValidationErrorItem): FormSubmissionError {\n  const { context, message, path } = detail\n\n  const name = context?.key ?? ''\n  const href = `#${name}`\n\n  const text = message.replace(\n    /\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d\\.\\d+([+-][0-2]\\d:[0-5]\\d|Z)/,\n    (text) => format(parseISO(text), 'd MMMM yyyy')\n  )\n\n  return {\n    path,\n    href,\n    name,\n    text,\n    context\n  }\n}\n\nexport function createError(componentName: string, message: string) {\n  return {\n    href: `#${componentName}`,\n    name: componentName,\n    text: message\n  }\n}\n\n/**\n * A small helper to safely generate a crumb token.\n * Checks that the crumb plugin is available, that crumb\n * is not disabled on the current route, and that cookies/state are present.\n */\nexport function safeGenerateCrumb(\n  request: AnyFormRequest | null\n): string | undefined {\n  // no request or no .state\n  if (!request?.state) {\n    return undefined\n  }\n\n  // crumb plugin or its generate method doesn't exist\n  if (!request.server.plugins.crumb.generate) {\n    return undefined\n  }\n\n  // crumb is explicitly disabled for this route\n  if (request.route.settings.plugins?.crumb === false) {\n    return undefined\n  }\n\n  return request.server.plugins.crumb.generate(request)\n}\n\n/**\n * Calculates an exponential backoff delay (in milliseconds) based on the current retry depth,\n * using a base delay of 2000ms (2 seconds) and doubling for each additional depth, while capping the delay at 25,000ms (25 seconds).\n * @param depth - The current retry depth (1, 2, 3, …)\n * @returns The calculated delay in milliseconds.\n */\nexport function getExponentialBackoffDelay(depth: number): number {\n  const BASE_DELAY_MS = 2000 // 2 seconds initial delay\n  const CAP_DELAY_MS = 25000 // cap each delay to 25 seconds\n  const delay = BASE_DELAY_MS * 2 ** (depth - 1)\n  return Math.min(delay, CAP_DELAY_MS)\n}\n\nexport function evaluateTemplate(\n  template: string,\n  context: FormContext\n): string {\n  const globals: GlobalScope = {\n    context,\n    pages: context.pageDefMap,\n    components: context.componentDefMap\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n  return engine.parseAndRenderSync(template, context.relevantState, {\n    globals\n  })\n}\n\nexport function getCacheService(server: Server) {\n  return getPluginOptions(server).cacheService\n}\n\nexport function getSaveAndExitHelpers(server: Server) {\n  return getPluginOptions(server).saveAndExit\n}\n\nexport function getPluginOptions(server: Server) {\n  return server.plugins['forms-engine-plugin']\n}\n\n/**\n * Handles logging and issuing a permanent redirect for legacy routes.\n * @param h - The Hapi response toolkit.\n * @param targetUrl - The URL to redirect to.\n * @returns The Hapi response object configured for permanent redirect.\n */\nexport function handleLegacyRedirect(h: ResponseToolkit, targetUrl: string) {\n  return h.redirect(targetUrl).permanent().takeover()\n}\n\n/**\n * If the page doesn't have a title, set it from the title of the first form component\n * @param def - the form definition\n */\nexport function setPageTitles(def: FormDefinition) {\n  def.pages.forEach((page) => {\n    if (!page.title) {\n      if (hasComponents(page)) {\n        // Set the page title from the first form component\n        const firstFormComponent = page.components.find((component) =>\n          isFormType(component.type)\n        )\n\n        page.title = firstFormComponent?.title ?? ''\n      }\n    }\n  })\n}\n"],"mappings":"AAAA,SACEA,cAAc,EACdC,MAAM,EACNC,eAAe,EACfC,aAAa,EACbC,UAAU,QAIL,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAE7B,SAASC,MAAM,EAAEC,QAAQ,QAAQ,UAAU;AAC3C,SAASC,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,MAAM,QAAQ,UAAU;AAEjC,SAASC,YAAY;AACrB,SACEC,SAAS;AAKX,SAASC,UAAU;AAOnB,SACEC,UAAU,EACVC,UAAU;AAMZ,MAAMC,MAAM,GAAGL,YAAY,CAAC,CAAC;AAE7B,OAAO,MAAMM,MAAM,GAAG,IAAIP,MAAM,CAAC;EAC/BQ,YAAY,EAAE,QAAQ;EACtBC,QAAQ,EAAE,IAAI;EACdC,eAAe,EAAE;AACnB,CAAC,CAAC;AAQFH,MAAM,CAACI,cAAc,CAAC,UAAU,EAAE,UAAUC,QAAiB,EAAE;EAC7D,IAAI,OAAOA,QAAQ,KAAK,QAAQ,EAAE;IAChC,OAAOA,QAAQ;EACjB;EAEA,MAAMC,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAME,SAAS,GAAGC,gBAAgB,CAACJ,QAAQ,EAAEC,OAAO,CAACC,OAAO,CAAC;EAE7D,OAAOC,SAAS;AAClB,CAAC,CAAC;AAEFR,MAAM,CAACI,cAAc,CAAC,MAAM,EAAE,UAAUM,IAAa,EAAE;EACrD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMJ,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMK,OAAO,GAAGL,OAAO,CAACM,KAAK,CAACC,GAAG,CAACH,IAAI,CAAC;EAEvC,OAAOC,OAAO;AAChB,CAAC,CAAC;AAEFX,MAAM,CAACI,cAAc,CAAC,MAAM,EAAE,UAAUM,IAAY,EAAEI,KAAiB,EAAE;EACvE,IAAI,OAAOJ,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMJ,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMS,IAAI,GAAGT,OAAO,CAACC,OAAO,CAACS,OAAO,CAACH,GAAG,CAACH,IAAI,CAAC;EAE9C,IAAIK,IAAI,KAAKE,SAAS,EAAE;IACtB;EACF;EAEA,OAAOC,WAAW,CAACH,IAAI,EAAED,KAAK,CAAC;AACjC,CAAC,CAAC;AAEFd,MAAM,CAACI,cAAc,CAAC,OAAO,EAAE,UAAUe,IAAY,EAAE;EACrD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMb,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMc,YAAY,GAAGd,OAAO,CAACe,UAAU,CAACR,GAAG,CAACM,IAAI,CAAC;EAEjD,OAAOC,YAAY;AACrB,CAAC,CAAC;AAEFpB,MAAM,CAACI,cAAc,CAAC,QAAQ,EAAE,UAAUe,IAAY,EAAE;EACtD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMb,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMgB,SAAS,GAAGhB,OAAO,CAACC,OAAO,CAACgB,YAAY,CAACV,GAAG,CAACM,IAAI,CAAC;EAExD,IAAI,CAACG,SAAS,EAAEE,eAAe,EAAE;IAC/B;EACF;EAEA,MAAMC,MAAM,GAAG9B,SAAS,CAAC2B,SAAS,EAAWhB,OAAO,CAACC,OAAO,CAACmB,aAAa,CAAC;EAE3E,OAAOD,MAAM;AACf,CAAC,CAAC;AAEF,OAAO,SAASE,OAAOA,CACrBC,OAAiE,EACjEC,CAAsB,EACtBC,OAAe,EACf;EACA,MAAM;IAAEC,MAAM;IAAEC,OAAO;IAAElB;EAAM,CAAC,GAAGc,OAAO;EAC1C,MAAM;IAAEK;EAAU,CAAC,GAAGnB,KAAK;EAE3B,MAAMoB,eAAe,GACnBF,OAAO,IAAI,QAAQ,IAAIA,OAAO,GAC1BA,OAAO,CAACG,MAAM,KAAKtC,UAAU,CAACuC,QAAQ,IACtCJ,OAAO,CAACG,MAAM,KAAKtC,UAAU,CAACwC,QAAQ,GACtC,KAAK;;EAEX;EACA;EACA;EACA,MAAMC,SAAS,GACbP,MAAM,KAAK,KAAK,GAAGnC,UAAU,CAACkB,KAAK,EAAE,WAAW,CAAC,GAAGG,SAAS;;EAE/D;EACA,MAAMsB,QAAQ,GACZL,eAAe,IAAIM,cAAc,CAACP,SAAS,CAAC,GACxCJ,CAAC,CAACY,QAAQ,CAACR,SAAS,CAAC,GACrBJ,CAAC,CAACY,QAAQ,CAACC,YAAY,CAACZ,OAAO,EAAEQ,SAAS,CAAC,CAAC;;EAElD;EACA,OAAOP,MAAM,KAAK,MAAM,GACpBQ,QAAQ,CAACI,IAAI,CAACnD,WAAW,CAACoD,SAAS,CAAC,GACpCL,QAAQ,CAACI,IAAI,CAACnD,WAAW,CAACqD,iBAAiB,CAAC;AAClD;;AAEA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACC,IAAa,EAAE;EACvC,IAAIA,IAAI,EAAE;IACR,IAAI;MACF,OAAO,IAAIC,GAAG,CAACD,IAAI,CAAC,CAACE,QAAQ,CAAC,CAAC,EAAC;IAClC,CAAC,CAAC,OAAOC,GAAG,EAAE;MACZnD,MAAM,CAACoD,KAAK,CACVD,GAAG,EACH,6CAA6CH,IAAI,MAAM7D,eAAe,CAACgE,GAAG,CAAC,EAC7E,CAAC;MACD,MAAMA,GAAG;IACX;EACF;AACF;;AAEA;AACA;AACA;;AAMA;AACA;AACA;;AAOA,OAAO,SAAShC,WAAWA,CACzBH,IAAyB,EACzBqC,WAAgC,EAChCC,SAAoB,GAAG,CAAC,CAAC,EACzB;EACA,MAAM3C,IAAI,GAAG,OAAO0C,WAAW,KAAK,QAAQ,GAAGA,WAAW,GAAGrC,IAAI,CAACL,IAAI;EACtE,MAAMI,KAAK,GAAG,OAAOsC,WAAW,KAAK,QAAQ,GAAGA,WAAW,GAAGC,SAAS;EAEvE,IAAI,CAACb,cAAc,CAAC9B,IAAI,CAAC,EAAE;IACzB,MAAM4C,KAAK,CAAC,mCAAmC5C,IAAI,EAAE,CAAC;EACxD;;EAEA;EACA,OAAOgC,YAAY,CAAC3B,IAAI,CAACwC,OAAO,CAAC7C,IAAI,CAAC,EAAEI,KAAK,CAAC;AAChD;;AAEA;AACA;AACA;AACA,OAAO,SAAS4B,YAAYA,CAACZ,OAAe,EAAEhB,KAAgB,GAAG,CAAC,CAAC,EAAE;EACnE,MAAM0C,UAAU,GAAGhB,cAAc,CAACV,OAAO,CAAC;;EAE1C;EACA,MAAM2B,MAAM,GAAGC,MAAM,CAACC,OAAO,CAAC7C,KAAK,CAAC,CAAC8C,MAAM,CACxC9C,KAAK,IAAgC,OAAOA,KAAK,CAAC,CAAC,CAAC,KAAK,QAC5D,CAAC;;EAED;EACA,MAAM+C,GAAG,GAAGL,UAAU,GAClB,IAAIR,GAAG,CAAClB,OAAO,EAAE,oBAAoB,CAAC,GACtC,IAAIkB,GAAG,CAAClB,OAAO,CAAC;;EAEpB;EACA,KAAK,MAAM,CAACX,IAAI,EAAE2C,KAAK,CAAC,IAAIL,MAAM,EAAE;IAClCI,GAAG,CAACE,YAAY,CAACC,GAAG,CAAC7C,IAAI,EAAE2C,KAAK,CAAC;EACnC;EAEA,IAAIN,UAAU,EAAE;IACd,OAAO,GAAGK,GAAG,CAACI,QAAQ,GAAGJ,GAAG,CAACK,MAAM,EAAE;EACvC;EAEA,OAAOL,GAAG,CAACM,IAAI;AACjB;AAEA,OAAO,SAAS3B,cAAcA,CAAC9B,IAAa,EAAE;EAC5C,OAAO,CAACA,IAAI,IAAI,EAAE,EAAE0D,UAAU,CAAC,GAAG,CAAC;AACrC;AAEA,OAAO,SAASC,aAAaA,CAAC3D,IAAI,GAAG,EAAE,EAAE;EACvC,OAAOA,IAAI,CACR4D,IAAI,CAAC,CAAC,CAAC;EAAA,CACPC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;EAAA,CACnBA,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAC;AACxB;AAEA,OAAO,SAASC,OAAOA,CACrBC,KAA4B,EAC5B7C,OAA2B,EAC3B;EACA,MAAM;IAAE6B;EAAO,CAAC,GAAG7B,OAAO;EAE1B,MAAMb,IAAI,GAAG2D,QAAQ,CAACD,KAAK,EAAE,IAAIhB,MAAM,CAAC/C,IAAI,EAAE,CAAC;EAE/C,IAAI,CAACK,IAAI,EAAE;IACT,MAAM1B,IAAI,CAACsF,QAAQ,CAAC,sBAAsBlB,MAAM,CAAC/C,IAAI,EAAE,CAAC;EAC1D;EAEA,OAAOK,IAAI;AACb;AAEA,OAAO,SAAS2D,QAAQA,CAACD,KAA4B,EAAE/D,IAAa,EAAE;EACpE,MAAMkE,QAAQ,GAAG,IAAIP,aAAa,CAAC3D,IAAI,CAAC,EAAE;EAC1C,OAAO+D,KAAK,EAAE7D,KAAK,CAACiE,IAAI,CAAC,CAAC;IAAEnE;EAAK,CAAC,KAAKA,IAAI,KAAKkE,QAAQ,CAAC;AAC3D;AAEA,OAAO,SAASE,YAAYA,CAACL,KAAiB,EAAE;EAC9C,IAAIA,KAAK,EAAEzE,MAAM,KAAKf,MAAM,CAAC8F,EAAE,EAAE;IAC/B,MAAMC,SAAS,GAAGX,aAAa,CAACI,KAAK,CAACQ,GAAG,CAACrE,KAAK,CAACsE,EAAE,CAAC,CAAC,CAAC,EAAExE,IAAI,CAAC;IAC5D,OAAOsE,SAAS,GAAG,IAAIA,SAAS,EAAE,GAAGhG,cAAc,CAACmG,KAAK;EAC3D;EAEA,MAAMH,SAAS,GAAGX,aAAa,CAACI,KAAK,EAAEQ,GAAG,CAACG,SAAS,CAAC;EACrD,OAAOJ,SAAS,GAAG,IAAIA,SAAS,EAAE,GAAGhG,cAAc,CAACmG,KAAK;AAC3D;AAEA,OAAO,SAASE,eAAeA,CAAC5B,MAAmB,EAAE;EACnD,MAAM6B,SAAS,GAAG,CAAC,CAAC7B,MAAM,EAAE8B,KAAK;EAEjC,IAAIA,KAAK,GAAGzF,UAAU,CAAC0F,IAAI;EAE3B,IAAIF,SAAS,IAAI7B,MAAM,CAAC8B,KAAK,KAAKzF,UAAU,CAAC2F,KAAK,EAAE;IAClDF,KAAK,GAAGzF,UAAU,CAAC2F,KAAK;EAC1B;EAEA,OAAO;IACLH,SAAS;IACTC;EACF,CAAC;AACH;AAEA,OAAO,SAASG,sCAAsCA,CACpDC,YAAgC,EAChCL,SAAkB,EAClB;EACA,IAAI,CAACK,YAAY,IAAI,CAACL,SAAS,EAAE;IAC/B,MAAMjG,IAAI,CAACuG,QAAQ,CACjB,8DACF,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CACvBC,OAA+B,EACI;EACnC,IAAI,CAACA,OAAO,EAAEC,MAAM,EAAE;IACpB;EACF;EAEA,OAAOD,OAAO,CAACE,GAAG,CAACC,QAAQ,CAAC;AAC9B;AAEA,OAAO,SAASA,QAAQA,CAACC,MAA2B,EAAuB;EACzE,MAAM;IAAE3F,OAAO;IAAE4F,OAAO;IAAEzF;EAAK,CAAC,GAAGwF,MAAM;EAEzC,MAAM/E,IAAI,GAAGZ,OAAO,EAAE6F,GAAG,IAAI,EAAE;EAC/B,MAAMjC,IAAI,GAAG,IAAIhD,IAAI,EAAE;EAEvB,MAAMkF,IAAI,GAAGF,OAAO,CAAC5B,OAAO,CAC1B,0EAA0E,EACzE8B,IAAI,IAAK/G,MAAM,CAACC,QAAQ,CAAC8G,IAAI,CAAC,EAAE,aAAa,CAChD,CAAC;EAED,OAAO;IACL3F,IAAI;IACJyD,IAAI;IACJhD,IAAI;IACJkF,IAAI;IACJ9F;EACF,CAAC;AACH;AAEA,OAAO,SAAS+F,WAAWA,CAACC,aAAqB,EAAEJ,OAAe,EAAE;EAClE,OAAO;IACLhC,IAAI,EAAE,IAAIoC,aAAa,EAAE;IACzBpF,IAAI,EAAEoF,aAAa;IACnBF,IAAI,EAAEF;EACR,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASK,iBAAiBA,CAC/B5E,OAA8B,EACV;EACpB;EACA,IAAI,CAACA,OAAO,EAAE2D,KAAK,EAAE;IACnB,OAAOtE,SAAS;EAClB;;EAEA;EACA,IAAI,CAACW,OAAO,CAAC6E,MAAM,CAACC,OAAO,CAACC,KAAK,CAACC,QAAQ,EAAE;IAC1C,OAAO3F,SAAS;EAClB;;EAEA;EACA,IAAIW,OAAO,CAACiF,KAAK,CAACC,QAAQ,CAACJ,OAAO,EAAEC,KAAK,KAAK,KAAK,EAAE;IACnD,OAAO1F,SAAS;EAClB;EAEA,OAAOW,OAAO,CAAC6E,MAAM,CAACC,OAAO,CAACC,KAAK,CAACC,QAAQ,CAAChF,OAAO,CAAC;AACvD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASmF,0BAA0BA,CAACC,KAAa,EAAU;EAChE,MAAMC,aAAa,GAAG,IAAI,EAAC;EAC3B,MAAMC,YAAY,GAAG,KAAK,EAAC;EAC3B,MAAMC,KAAK,GAAGF,aAAa,GAAG,CAAC,KAAKD,KAAK,GAAG,CAAC,CAAC;EAC9C,OAAOI,IAAI,CAACC,GAAG,CAACF,KAAK,EAAED,YAAY,CAAC;AACtC;AAEA,OAAO,SAASzG,gBAAgBA,CAC9BJ,QAAgB,EAChBE,OAAoB,EACZ;EACR,MAAMD,OAAoB,GAAG;IAC3BC,OAAO;IACPK,KAAK,EAAEL,OAAO,CAAC+G,UAAU;IACzBjG,UAAU,EAAEd,OAAO,CAACgH;EACtB,CAAC;;EAED;EACA,OAAOvH,MAAM,CAACwH,kBAAkB,CAACnH,QAAQ,EAAEE,OAAO,CAACmB,aAAa,EAAE;IAChEpB;EACF,CAAC,CAAC;AACJ;AAEA,OAAO,SAASmH,eAAeA,CAAChB,MAAc,EAAE;EAC9C,OAAOiB,gBAAgB,CAACjB,MAAM,CAAC,CAACkB,YAAY;AAC9C;AAEA,OAAO,SAASC,qBAAqBA,CAACnB,MAAc,EAAE;EACpD,OAAOiB,gBAAgB,CAACjB,MAAM,CAAC,CAACoB,WAAW;AAC7C;AAEA,OAAO,SAASH,gBAAgBA,CAACjB,MAAc,EAAE;EAC/C,OAAOA,MAAM,CAACC,OAAO,CAAC,qBAAqB,CAAC;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASoB,oBAAoBA,CAACjG,CAAkB,EAAEkG,SAAiB,EAAE;EAC1E,OAAOlG,CAAC,CAACY,QAAQ,CAACsF,SAAS,CAAC,CAACC,SAAS,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;AACrD;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAACjD,GAAmB,EAAE;EACjDA,GAAG,CAACrE,KAAK,CAACuH,OAAO,CAAEpH,IAAI,IAAK;IAC1B,IAAI,CAACA,IAAI,CAACqH,KAAK,EAAE;MACf,IAAIjJ,aAAa,CAAC4B,IAAI,CAAC,EAAE;QACvB;QACA,MAAMsH,kBAAkB,GAAGtH,IAAI,CAACM,UAAU,CAACwD,IAAI,CAAEvD,SAAS,IACxDlC,UAAU,CAACkC,SAAS,CAACgH,IAAI,CAC3B,CAAC;QAEDvH,IAAI,CAACqH,KAAK,GAAGC,kBAAkB,EAAED,KAAK,IAAI,EAAE;MAC9C;IACF;EACF,CAAC,CAAC;AACJ","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.1.2",
+  "version": "4.1.3-alpha.2",
   "description": "Defra forms engine",
   "type": "module",
   "files": [

package/src/server/plugins/engine/helpers.test.ts

@@ -228,6 +228,46 @@ describe('Helpers', () => {
         expect(h.redirect).not.toHaveBeenCalledWith(request.query.returnUrl)
       }
     )
+
+    it('should not forward custom query params on POST', () => {
+      request = {
+        ...request,
+        method: 'post',
+        query: { parcelId: 'SD5848-9205' }
+      }
+
+      proceed(request, h, '/test/next-page')
+
+      expect(h.redirect).toHaveBeenCalledWith('/test/next-page')
+    })
+
+    it('should forward custom query params on GET so pre-population params survive dispatch redirects', () => {
+      request = {
+        ...request,
+        method: 'get',
+        query: { formId: '69afefa99b7b18cc1cd2c606' }
+      }
+
+      proceed(request, h, '/test/next-page')
+
+      expect(h.redirect).toHaveBeenCalledWith(
+        '/test/next-page?formId=69afefa99b7b18cc1cd2c606'
+      )
+    })
+
+    it('should forward custom query params on GET but not returnUrl', () => {
+      request = {
+        ...request,
+        method: 'get',
+        query: { formId: '69afefa99b7b18cc1cd2c606', returnUrl: '/summary' }
+      }
+
+      proceed(request, h, '/test/next-page')
+
+      expect(h.redirect).toHaveBeenCalledWith(
+        '/test/next-page?formId=69afefa99b7b18cc1cd2c606'
+      )
+    })
   })
 
   describe('encodeUrl', () => {

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

@@ -130,11 +130,17 @@ export function proceed(
         payload.action === FormAction.Validate
       : false
 
+  // On POST, strip all query params to prevent them persisting across pages.
+  // On GET, forward params (minus returnUrl) so pre-population query params
+  // survive dispatch redirects (e.g. ?formId= reaching the start page).
+  const nextQuery =
+    method === 'get' ? stripParam(query, 'returnUrl') : undefined
+
   // Redirect to return location (optional)
   const response =
     isReturnAllowed && isPathRelative(returnUrl)
       ? h.redirect(returnUrl)
-      : h.redirect(redirectPath(nextUrl, stripParam(query, 'returnUrl')))
+      : h.redirect(redirectPath(nextUrl, nextQuery))
 
   // Redirect POST to GET to avoid resubmission
   return method === 'post'