@defra/forms-engine-plugin 4.5.0 → 4.5.1

package/.server/server/constants.d.ts

@@ -1,3 +1,4 @@
+export const FORM_VERSION_METADATA_KEY: "$$__formVersion";
 export const PREVIEW_PATH_PREFIX: "/preview";
 export const FORM_PREFIX: "";
 export const EXTERNAL_STATE_PAYLOAD: "EXTERNAL_STATE_PAYLOAD";

package/.server/server/constants.js

@@ -1,3 +1,4 @@
+export const FORM_VERSION_METADATA_KEY = '$$__formVersion';
 export const PREVIEW_PATH_PREFIX = '/preview';
 export const FORM_PREFIX = '';
 export const EXTERNAL_STATE_PAYLOAD = 'EXTERNAL_STATE_PAYLOAD';

package/.server/server/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","names":["PREVIEW_PATH_PREFIX","FORM_PREFIX","EXTERNAL_STATE_PAYLOAD","EXTERNAL_STATE_APPENDAGE","COMPONENT_STATE_ERROR","PAYMENT_EXPIRED_NOTIFICATION"],"sources":["../../src/server/constants.js"],"sourcesContent":["export const PREVIEW_PATH_PREFIX = '/preview'\nexport const FORM_PREFIX = ''\nexport const EXTERNAL_STATE_PAYLOAD = 'EXTERNAL_STATE_PAYLOAD'\nexport const EXTERNAL_STATE_APPENDAGE = 'EXTERNAL_STATE_APPENDAGE'\nexport const COMPONENT_STATE_ERROR = 'COMPONENT_STATE_ERROR'\nexport const PAYMENT_EXPIRED_NOTIFICATION = 'PAYMENT_EXPIRED_NOTIFICATION'\n"],"mappings":"AAAA,OAAO,MAAMA,mBAAmB,GAAG,UAAU;AAC7C,OAAO,MAAMC,WAAW,GAAG,EAAE;AAC7B,OAAO,MAAMC,sBAAsB,GAAG,wBAAwB;AAC9D,OAAO,MAAMC,wBAAwB,GAAG,0BAA0B;AAClE,OAAO,MAAMC,qBAAqB,GAAG,uBAAuB;AAC5D,OAAO,MAAMC,4BAA4B,GAAG,8BAA8B","ignoreList":[]}
+{"version":3,"file":"constants.js","names":["FORM_VERSION_METADATA_KEY","PREVIEW_PATH_PREFIX","FORM_PREFIX","EXTERNAL_STATE_PAYLOAD","EXTERNAL_STATE_APPENDAGE","COMPONENT_STATE_ERROR","PAYMENT_EXPIRED_NOTIFICATION"],"sources":["../../src/server/constants.js"],"sourcesContent":["export const FORM_VERSION_METADATA_KEY = '$$__formVersion'\nexport const PREVIEW_PATH_PREFIX = '/preview'\nexport const FORM_PREFIX = ''\nexport const EXTERNAL_STATE_PAYLOAD = 'EXTERNAL_STATE_PAYLOAD'\nexport const EXTERNAL_STATE_APPENDAGE = 'EXTERNAL_STATE_APPENDAGE'\nexport const COMPONENT_STATE_ERROR = 'COMPONENT_STATE_ERROR'\nexport const PAYMENT_EXPIRED_NOTIFICATION = 'PAYMENT_EXPIRED_NOTIFICATION'\n"],"mappings":"AAAA,OAAO,MAAMA,yBAAyB,GAAG,iBAAiB;AAC1D,OAAO,MAAMC,mBAAmB,GAAG,UAAU;AAC7C,OAAO,MAAMC,WAAW,GAAG,EAAE;AAC7B,OAAO,MAAMC,sBAAsB,GAAG,wBAAwB;AAC9D,OAAO,MAAMC,wBAAwB,GAAG,0BAA0B;AAClE,OAAO,MAAMC,qBAAqB,GAAG,uBAAuB;AAC5D,OAAO,MAAMC,4BAA4B,GAAG,8BAA8B","ignoreList":[]}

package/.server/server/plugins/engine/beta/form-context.d.ts

@@ -9,7 +9,6 @@ export interface FormModelOptions {
     services?: Services;
     controllers?: Record<string, typeof PageController>;
     basePath?: string;
-    versionNumber?: number;
     ordnanceSurveyApiKey?: string;
     formId?: string;
     routePrefix?: string;

package/.server/server/plugins/engine/beta/form-context.js

@@ -1,7 +1,7 @@
 import Boom from '@hapi/boom';
 import { isEqual } from 'date-fns';
 import { PREVIEW_PATH_PREFIX } from "../../../constants.js";
-import { checkEmailAddressForLiveFormSubmission, getCacheService } from "../helpers.js";
+import { checkEmailAddressForLiveFormSubmission, getCacheService, getFormVersion } from "../helpers.js";
 import { FormModel } from "../models/index.js";
 import { TerminalPageController } from "../pageControllers/index.js";
 import * as defaultServices from "../services/index.js";
@@ -14,11 +14,11 @@ export async function getFormModel(slug, state, options = {}) {
   const isPreview = isPreviewState(state, options);
   const formState = resolveState(state);
   const metadata = await formsService.getFormMetadata(slug);
-  const versionNumber = options.versionNumber ?? metadata.versions?.[0]?.versionNumber;
   const definition = await formsService.getFormDefinition(metadata.id, formState);
   if (!definition) {
     throw Boom.notFound(`No definition found for form metadata ${metadata.id} (${slug}) ${state}`);
   }
+  const versionNumber = getFormVersion(definition)?.versionNumber;
   return new FormModel(definition, {
     basePath: options.basePath ?? buildBasePath(options.routePrefix ?? '', slug, formState, isPreview),
     versionNumber,
@@ -83,9 +83,10 @@ export async function resolveFormModel(server, slug, state, options = {}) {
     }
     checkEmailAddressForLiveFormSubmission(metadata.notificationEmail, isPreview);
     const routePrefix = options.routePrefix ?? server.realm.modifiers.route.prefix;
+    const versionNumber = getFormVersion(definition)?.versionNumber;
     const model = new FormModel(definition, {
       basePath: options.basePath ?? buildBasePath(routePrefix, slug, formState, isPreview),
-      versionNumber: options.versionNumber ?? metadata.versions?.[0]?.versionNumber,
+      versionNumber,
       ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,
       formId: options.formId ?? metadata.id
     }, services, options.controllers);

package/.server/server/plugins/engine/beta/form-context.js.map

@@ -1 +1 @@
-{"version":3,"file":"form-context.js","names":["Boom","isEqual","PREVIEW_PATH_PREFIX","checkEmailAddressForLiveFormSubmission","getCacheService","FormModel","TerminalPageController","defaultServices","FormStatus","getFormModel","slug","state","options","services","formsService","isPreview","isPreviewState","formState","resolveState","metadata","getFormMetadata","versionNumber","versions","definition","getFormDefinition","id","notFound","basePath","buildBasePath","routePrefix","ordnanceSurveyApiKey","formId","controllers","getFormContext","server","yar","Live","formModel","resolveFormModel","cacheService","summaryRequest","app","method","params","path","query","url","URL","cachedState","getState","$$__referenceNumber","errors","stateMetadata","models","Map","cache","cacheKey","entry","get","updatedAt","notificationEmail","realm","modifiers","route","prefix","model","set","base","replace","startsWith","slice","getFirstJourneyPage","context","relevantPages","undefined","lastPageReached","at","penultimatePageReached"],"sources":["../../../../../src/server/plugins/engine/beta/form-context.ts"],"sourcesContent":["import Boom from '@hapi/boom'\nimport { type Request, type Server } from '@hapi/hapi'\nimport { isEqual } from 'date-fns'\n\nimport { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'\nimport {\n  checkEmailAddressForLiveFormSubmission,\n  getCacheService\n} from '~/src/server/plugins/engine/helpers.js'\nimport { FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { TerminalPageController } from '~/src/server/plugins/engine/pageControllers/index.js'\nimport * as defaultServices from '~/src/server/plugins/engine/services/index.js'\nimport {\n  type AnyRequest,\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport { FormStatus } from '~/src/server/routes/types.js'\nimport { type Services } from '~/src/server/types.js'\n\ntype JourneyState = FormStatus | 'preview'\n\nexport interface FormModelOptions {\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  basePath?: string\n  versionNumber?: number\n  ordnanceSurveyApiKey?: string\n  formId?: string\n  routePrefix?: string\n  isPreview?: boolean\n}\n\nexport interface FormContextOptions extends FormModelOptions {\n  errors?: FormSubmissionError[]\n}\n\ntype SummaryRequest = FormContextRequest & {\n  yar: Request['yar']\n}\n\nexport async function getFormModel(\n  slug: string,\n  state: JourneyState,\n  options: FormModelOptions = {}\n) {\n  const services = options.services ?? defaultServices\n  const { formsService } = services\n  const isPreview = isPreviewState(state, options)\n  const formState = resolveState(state)\n\n  const metadata = await formsService.getFormMetadata(slug)\n  const versionNumber =\n    options.versionNumber ?? metadata.versions?.[0]?.versionNumber\n\n  const definition = await formsService.getFormDefinition(\n    metadata.id,\n    formState\n  )\n\n  if (!definition) {\n    throw Boom.notFound(\n      `No definition found for form metadata ${metadata.id} (${slug}) ${state}`\n    )\n  }\n\n  return new FormModel(\n    definition,\n    {\n      basePath:\n        options.basePath ??\n        buildBasePath(options.routePrefix ?? '', slug, formState, isPreview),\n      versionNumber,\n      ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,\n      formId: options.formId ?? metadata.id\n    },\n    services,\n    options.controllers\n  )\n}\n\nexport async function getFormContext(\n  { server, yar }: Pick<Request, 'server' | 'yar'>,\n  slug: string,\n  state: JourneyState = FormStatus.Live,\n  options: FormContextOptions = {}\n): Promise<FormContext> {\n  const formModel = await resolveFormModel(server, slug, state, options)\n\n  const cacheService = getCacheService(server)\n\n  const summaryRequest: SummaryRequest = {\n    app: {},\n    method: 'get',\n    params: {\n      path: 'summary',\n      slug,\n      ...(isPreviewState(state, options) && {\n        state: resolveState(state)\n      })\n    },\n    path: `/${formModel.basePath}/summary`,\n    query: {},\n    url: new URL(\n      `/${formModel.basePath}/summary`,\n      'https://form-context.local'\n    ),\n    server,\n    yar\n  }\n\n  const cachedState = await cacheService.getState(\n    summaryRequest as unknown as AnyRequest\n  )\n\n  const formState = {\n    ...cachedState,\n    $$__referenceNumber: cachedState.$$__referenceNumber\n  } as unknown as FormSubmissionState\n\n  return formModel.getFormContext(\n    summaryRequest,\n    formState,\n    options.errors ?? []\n  )\n}\n\nexport async function resolveFormModel(\n  server: Server,\n  slug: string,\n  state: JourneyState,\n  options: FormModelOptions = {}\n) {\n  const services = options.services ?? defaultServices\n  const { formsService } = services\n\n  const metadata = await formsService.getFormMetadata(slug)\n  const formState = resolveState(state)\n  const isPreview = options.isPreview ?? isPreviewState(state, options)\n  const stateMetadata = metadata[formState]\n\n  if (!stateMetadata) {\n    throw Boom.notFound(\n      `No '${formState}' state for form metadata ${metadata.id}`\n    )\n  }\n\n  // The models cache is created lazily per server instance\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n  if (!server.app.models) {\n    server.app.models = new Map<string, { model: FormModel; updatedAt: Date }>()\n  }\n\n  const cache = server.app.models as Map<\n    string,\n    { model: FormModel; updatedAt: Date }\n  >\n\n  const cacheKey = `${metadata.id}_${formState}_${isPreview}`\n  let entry = cache.get(cacheKey)\n\n  if (!entry || !isEqual(entry.updatedAt, stateMetadata.updatedAt)) {\n    const definition = await formsService.getFormDefinition(\n      metadata.id,\n      formState\n    )\n\n    if (!definition) {\n      throw Boom.notFound(\n        `No definition found for form metadata ${metadata.id} (${slug}) ${state}`\n      )\n    }\n\n    checkEmailAddressForLiveFormSubmission(\n      metadata.notificationEmail,\n      isPreview\n    )\n\n    const routePrefix =\n      options.routePrefix ?? server.realm.modifiers.route.prefix\n\n    const model = new FormModel(\n      definition,\n      {\n        basePath:\n          options.basePath ??\n          buildBasePath(routePrefix, slug, formState, isPreview),\n        versionNumber:\n          options.versionNumber ?? metadata.versions?.[0]?.versionNumber,\n        ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,\n        formId: options.formId ?? metadata.id\n      },\n      services,\n      options.controllers\n    )\n\n    entry = { model, updatedAt: stateMetadata.updatedAt }\n    cache.set(cacheKey, entry)\n  }\n\n  return entry.model\n}\n\nfunction buildBasePath(\n  routePrefix: string,\n  slug: string,\n  state: FormStatus,\n  isPreview: boolean\n) {\n  const base = (\n    isPreview\n      ? `${routePrefix}${PREVIEW_PATH_PREFIX}/${state}/${slug}`\n      : `${routePrefix}/${slug}`\n  ).replace(/\\/{2,}/g, '/')\n\n  return base.startsWith('/') ? base.slice(1) : base\n}\n\nexport function getFirstJourneyPage(\n  context?: Pick<FormContext, 'relevantPages'>\n) {\n  if (!context?.relevantPages) {\n    return undefined\n  }\n\n  const lastPageReached = context.relevantPages.at(-1)\n  const penultimatePageReached = context.relevantPages.at(-2)\n\n  if (\n    lastPageReached instanceof TerminalPageController &&\n    penultimatePageReached\n  ) {\n    return penultimatePageReached\n  }\n\n  return lastPageReached\n}\n\nfunction resolveState(state: JourneyState): FormStatus {\n  return state === 'preview' ? FormStatus.Live : state\n}\n\nfunction isPreviewState(\n  state: JourneyState,\n  options: FormModelOptions = {}\n): boolean {\n  return options.isPreview ?? state === 'preview'\n}\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAE7B,SAASC,OAAO,QAAQ,UAAU;AAElC,SAASC,mBAAmB;AAC5B,SACEC,sCAAsC,EACtCC,eAAe;AAEjB,SAASC,SAAS;AAElB,SAASC,sBAAsB;AAC/B,OAAO,KAAKC,eAAe;AAQ3B,SAASC,UAAU;AAwBnB,OAAO,eAAeC,YAAYA,CAChCC,IAAY,EACZC,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EAC9B;EACA,MAAMC,QAAQ,GAAGD,OAAO,CAACC,QAAQ,IAAIN,eAAe;EACpD,MAAM;IAAEO;EAAa,CAAC,GAAGD,QAAQ;EACjC,MAAME,SAAS,GAAGC,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC;EAChD,MAAMK,SAAS,GAAGC,YAAY,CAACP,KAAK,CAAC;EAErC,MAAMQ,QAAQ,GAAG,MAAML,YAAY,CAACM,eAAe,CAACV,IAAI,CAAC;EACzD,MAAMW,aAAa,GACjBT,OAAO,CAACS,aAAa,IAAIF,QAAQ,CAACG,QAAQ,GAAG,CAAC,CAAC,EAAED,aAAa;EAEhE,MAAME,UAAU,GAAG,MAAMT,YAAY,CAACU,iBAAiB,CACrDL,QAAQ,CAACM,EAAE,EACXR,SACF,CAAC;EAED,IAAI,CAACM,UAAU,EAAE;IACf,MAAMvB,IAAI,CAAC0B,QAAQ,CACjB,yCAAyCP,QAAQ,CAACM,EAAE,KAAKf,IAAI,KAAKC,KAAK,EACzE,CAAC;EACH;EAEA,OAAO,IAAIN,SAAS,CAClBkB,UAAU,EACV;IACEI,QAAQ,EACNf,OAAO,CAACe,QAAQ,IAChBC,aAAa,CAAChB,OAAO,CAACiB,WAAW,IAAI,EAAE,EAAEnB,IAAI,EAAEO,SAAS,EAAEF,SAAS,CAAC;IACtEM,aAAa;IACbS,oBAAoB,EAAElB,OAAO,CAACkB,oBAAoB;IAClDC,MAAM,EAAEnB,OAAO,CAACmB,MAAM,IAAIZ,QAAQ,CAACM;EACrC,CAAC,EACDZ,QAAQ,EACRD,OAAO,CAACoB,WACV,CAAC;AACH;AAEA,OAAO,eAAeC,cAAcA,CAClC;EAAEC,MAAM;EAAEC;AAAqC,CAAC,EAChDzB,IAAY,EACZC,KAAmB,GAAGH,UAAU,CAAC4B,IAAI,EACrCxB,OAA2B,GAAG,CAAC,CAAC,EACV;EACtB,MAAMyB,SAAS,GAAG,MAAMC,gBAAgB,CAACJ,MAAM,EAAExB,IAAI,EAAEC,KAAK,EAAEC,OAAO,CAAC;EAEtE,MAAM2B,YAAY,GAAGnC,eAAe,CAAC8B,MAAM,CAAC;EAE5C,MAAMM,cAA8B,GAAG;IACrCC,GAAG,EAAE,CAAC,CAAC;IACPC,MAAM,EAAE,KAAK;IACbC,MAAM,EAAE;MACNC,IAAI,EAAE,SAAS;MACflC,IAAI;MACJ,IAAIM,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC,IAAI;QACpCD,KAAK,EAAEO,YAAY,CAACP,KAAK;MAC3B,CAAC;IACH,CAAC;IACDiC,IAAI,EAAE,IAAIP,SAAS,CAACV,QAAQ,UAAU;IACtCkB,KAAK,EAAE,CAAC,CAAC;IACTC,GAAG,EAAE,IAAIC,GAAG,CACV,IAAIV,SAAS,CAACV,QAAQ,UAAU,EAChC,4BACF,CAAC;IACDO,MAAM;IACNC;EACF,CAAC;EAED,MAAMa,WAAW,GAAG,MAAMT,YAAY,CAACU,QAAQ,CAC7CT,cACF,CAAC;EAED,MAAMvB,SAAS,GAAG;IAChB,GAAG+B,WAAW;IACdE,mBAAmB,EAAEF,WAAW,CAACE;EACnC,CAAmC;EAEnC,OAAOb,SAAS,CAACJ,cAAc,CAC7BO,cAAc,EACdvB,SAAS,EACTL,OAAO,CAACuC,MAAM,IAAI,EACpB,CAAC;AACH;AAEA,OAAO,eAAeb,gBAAgBA,CACpCJ,MAAc,EACdxB,IAAY,EACZC,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EAC9B;EACA,MAAMC,QAAQ,GAAGD,OAAO,CAACC,QAAQ,IAAIN,eAAe;EACpD,MAAM;IAAEO;EAAa,CAAC,GAAGD,QAAQ;EAEjC,MAAMM,QAAQ,GAAG,MAAML,YAAY,CAACM,eAAe,CAACV,IAAI,CAAC;EACzD,MAAMO,SAAS,GAAGC,YAAY,CAACP,KAAK,CAAC;EACrC,MAAMI,SAAS,GAAGH,OAAO,CAACG,SAAS,IAAIC,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC;EACrE,MAAMwC,aAAa,GAAGjC,QAAQ,CAACF,SAAS,CAAC;EAEzC,IAAI,CAACmC,aAAa,EAAE;IAClB,MAAMpD,IAAI,CAAC0B,QAAQ,CACjB,OAAOT,SAAS,6BAA6BE,QAAQ,CAACM,EAAE,EAC1D,CAAC;EACH;;EAEA;EACA;EACA,IAAI,CAACS,MAAM,CAACO,GAAG,CAACY,MAAM,EAAE;IACtBnB,MAAM,CAACO,GAAG,CAACY,MAAM,GAAG,IAAIC,GAAG,CAAgD,CAAC;EAC9E;EAEA,MAAMC,KAAK,GAAGrB,MAAM,CAACO,GAAG,CAACY,MAGxB;EAED,MAAMG,QAAQ,GAAG,GAAGrC,QAAQ,CAACM,EAAE,IAAIR,SAAS,IAAIF,SAAS,EAAE;EAC3D,IAAI0C,KAAK,GAAGF,KAAK,CAACG,GAAG,CAACF,QAAQ,CAAC;EAE/B,IAAI,CAACC,KAAK,IAAI,CAACxD,OAAO,CAACwD,KAAK,CAACE,SAAS,EAAEP,aAAa,CAACO,SAAS,CAAC,EAAE;IAChE,MAAMpC,UAAU,GAAG,MAAMT,YAAY,CAACU,iBAAiB,CACrDL,QAAQ,CAACM,EAAE,EACXR,SACF,CAAC;IAED,IAAI,CAACM,UAAU,EAAE;MACf,MAAMvB,IAAI,CAAC0B,QAAQ,CACjB,yCAAyCP,QAAQ,CAACM,EAAE,KAAKf,IAAI,KAAKC,KAAK,EACzE,CAAC;IACH;IAEAR,sCAAsC,CACpCgB,QAAQ,CAACyC,iBAAiB,EAC1B7C,SACF,CAAC;IAED,MAAMc,WAAW,GACfjB,OAAO,CAACiB,WAAW,IAAIK,MAAM,CAAC2B,KAAK,CAACC,SAAS,CAACC,KAAK,CAACC,MAAM;IAE5D,MAAMC,KAAK,GAAG,IAAI5D,SAAS,CACzBkB,UAAU,EACV;MACEI,QAAQ,EACNf,OAAO,CAACe,QAAQ,IAChBC,aAAa,CAACC,WAAW,EAAEnB,IAAI,EAAEO,SAAS,EAAEF,SAAS,CAAC;MACxDM,aAAa,EACXT,OAAO,CAACS,aAAa,IAAIF,QAAQ,CAACG,QAAQ,GAAG,CAAC,CAAC,EAAED,aAAa;MAChES,oBAAoB,EAAElB,OAAO,CAACkB,oBAAoB;MAClDC,MAAM,EAAEnB,OAAO,CAACmB,MAAM,IAAIZ,QAAQ,CAACM;IACrC,CAAC,EACDZ,QAAQ,EACRD,OAAO,CAACoB,WACV,CAAC;IAEDyB,KAAK,GAAG;MAAEQ,KAAK;MAAEN,SAAS,EAAEP,aAAa,CAACO;IAAU,CAAC;IACrDJ,KAAK,CAACW,GAAG,CAACV,QAAQ,EAAEC,KAAK,CAAC;EAC5B;EAEA,OAAOA,KAAK,CAACQ,KAAK;AACpB;AAEA,SAASrC,aAAaA,CACpBC,WAAmB,EACnBnB,IAAY,EACZC,KAAiB,EACjBI,SAAkB,EAClB;EACA,MAAMoD,IAAI,GAAG,CACXpD,SAAS,GACL,GAAGc,WAAW,GAAG3B,mBAAmB,IAAIS,KAAK,IAAID,IAAI,EAAE,GACvD,GAAGmB,WAAW,IAAInB,IAAI,EAAE,EAC5B0D,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;EAEzB,OAAOD,IAAI,CAACE,UAAU,CAAC,GAAG,CAAC,GAAGF,IAAI,CAACG,KAAK,CAAC,CAAC,CAAC,GAAGH,IAAI;AACpD;AAEA,OAAO,SAASI,mBAAmBA,CACjCC,OAA4C,EAC5C;EACA,IAAI,CAACA,OAAO,EAAEC,aAAa,EAAE;IAC3B,OAAOC,SAAS;EAClB;EAEA,MAAMC,eAAe,GAAGH,OAAO,CAACC,aAAa,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC;EACpD,MAAMC,sBAAsB,GAAGL,OAAO,CAACC,aAAa,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC;EAE3D,IACED,eAAe,YAAYrE,sBAAsB,IACjDuE,sBAAsB,EACtB;IACA,OAAOA,sBAAsB;EAC/B;EAEA,OAAOF,eAAe;AACxB;AAEA,SAASzD,YAAYA,CAACP,KAAmB,EAAc;EACrD,OAAOA,KAAK,KAAK,SAAS,GAAGH,UAAU,CAAC4B,IAAI,GAAGzB,KAAK;AACtD;AAEA,SAASK,cAAcA,CACrBL,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EACrB;EACT,OAAOA,OAAO,CAACG,SAAS,IAAIJ,KAAK,KAAK,SAAS;AACjD","ignoreList":[]}
+{"version":3,"file":"form-context.js","names":["Boom","isEqual","PREVIEW_PATH_PREFIX","checkEmailAddressForLiveFormSubmission","getCacheService","getFormVersion","FormModel","TerminalPageController","defaultServices","FormStatus","getFormModel","slug","state","options","services","formsService","isPreview","isPreviewState","formState","resolveState","metadata","getFormMetadata","definition","getFormDefinition","id","notFound","versionNumber","basePath","buildBasePath","routePrefix","ordnanceSurveyApiKey","formId","controllers","getFormContext","server","yar","Live","formModel","resolveFormModel","cacheService","summaryRequest","app","method","params","path","query","url","URL","cachedState","getState","$$__referenceNumber","errors","stateMetadata","models","Map","cache","cacheKey","entry","get","updatedAt","notificationEmail","realm","modifiers","route","prefix","model","set","base","replace","startsWith","slice","getFirstJourneyPage","context","relevantPages","undefined","lastPageReached","at","penultimatePageReached"],"sources":["../../../../../src/server/plugins/engine/beta/form-context.ts"],"sourcesContent":["import Boom from '@hapi/boom'\nimport { type Request, type Server } from '@hapi/hapi'\nimport { isEqual } from 'date-fns'\n\nimport { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'\nimport {\n  checkEmailAddressForLiveFormSubmission,\n  getCacheService,\n  getFormVersion\n} from '~/src/server/plugins/engine/helpers.js'\nimport { FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { TerminalPageController } from '~/src/server/plugins/engine/pageControllers/index.js'\nimport * as defaultServices from '~/src/server/plugins/engine/services/index.js'\nimport {\n  type AnyRequest,\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport { FormStatus } from '~/src/server/routes/types.js'\nimport { type Services } from '~/src/server/types.js'\n\ntype JourneyState = FormStatus | 'preview'\n\nexport interface FormModelOptions {\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  basePath?: string\n  ordnanceSurveyApiKey?: string\n  formId?: string\n  routePrefix?: string\n  isPreview?: boolean\n}\n\nexport interface FormContextOptions extends FormModelOptions {\n  errors?: FormSubmissionError[]\n}\n\ntype SummaryRequest = FormContextRequest & {\n  yar: Request['yar']\n}\n\nexport async function getFormModel(\n  slug: string,\n  state: JourneyState,\n  options: FormModelOptions = {}\n) {\n  const services = options.services ?? defaultServices\n  const { formsService } = services\n  const isPreview = isPreviewState(state, options)\n  const formState = resolveState(state)\n\n  const metadata = await formsService.getFormMetadata(slug)\n\n  const definition = await formsService.getFormDefinition(\n    metadata.id,\n    formState\n  )\n\n  if (!definition) {\n    throw Boom.notFound(\n      `No definition found for form metadata ${metadata.id} (${slug}) ${state}`\n    )\n  }\n\n  const versionNumber = getFormVersion(definition)?.versionNumber\n\n  return new FormModel(\n    definition,\n    {\n      basePath:\n        options.basePath ??\n        buildBasePath(options.routePrefix ?? '', slug, formState, isPreview),\n      versionNumber,\n      ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,\n      formId: options.formId ?? metadata.id\n    },\n    services,\n    options.controllers\n  )\n}\n\nexport async function getFormContext(\n  { server, yar }: Pick<Request, 'server' | 'yar'>,\n  slug: string,\n  state: JourneyState = FormStatus.Live,\n  options: FormContextOptions = {}\n): Promise<FormContext> {\n  const formModel = await resolveFormModel(server, slug, state, options)\n\n  const cacheService = getCacheService(server)\n\n  const summaryRequest: SummaryRequest = {\n    app: {},\n    method: 'get',\n    params: {\n      path: 'summary',\n      slug,\n      ...(isPreviewState(state, options) && {\n        state: resolveState(state)\n      })\n    },\n    path: `/${formModel.basePath}/summary`,\n    query: {},\n    url: new URL(\n      `/${formModel.basePath}/summary`,\n      'https://form-context.local'\n    ),\n    server,\n    yar\n  }\n\n  const cachedState = await cacheService.getState(\n    summaryRequest as unknown as AnyRequest\n  )\n\n  const formState = {\n    ...cachedState,\n    $$__referenceNumber: cachedState.$$__referenceNumber\n  } as unknown as FormSubmissionState\n\n  return formModel.getFormContext(\n    summaryRequest,\n    formState,\n    options.errors ?? []\n  )\n}\n\nexport async function resolveFormModel(\n  server: Server,\n  slug: string,\n  state: JourneyState,\n  options: FormModelOptions = {}\n) {\n  const services = options.services ?? defaultServices\n  const { formsService } = services\n\n  const metadata = await formsService.getFormMetadata(slug)\n  const formState = resolveState(state)\n  const isPreview = options.isPreview ?? isPreviewState(state, options)\n  const stateMetadata = metadata[formState]\n\n  if (!stateMetadata) {\n    throw Boom.notFound(\n      `No '${formState}' state for form metadata ${metadata.id}`\n    )\n  }\n\n  // The models cache is created lazily per server instance\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n  if (!server.app.models) {\n    server.app.models = new Map<string, { model: FormModel; updatedAt: Date }>()\n  }\n\n  const cache = server.app.models as Map<\n    string,\n    { model: FormModel; updatedAt: Date }\n  >\n\n  const cacheKey = `${metadata.id}_${formState}_${isPreview}`\n  let entry = cache.get(cacheKey)\n\n  if (!entry || !isEqual(entry.updatedAt, stateMetadata.updatedAt)) {\n    const definition = await formsService.getFormDefinition(\n      metadata.id,\n      formState\n    )\n\n    if (!definition) {\n      throw Boom.notFound(\n        `No definition found for form metadata ${metadata.id} (${slug}) ${state}`\n      )\n    }\n\n    checkEmailAddressForLiveFormSubmission(\n      metadata.notificationEmail,\n      isPreview\n    )\n\n    const routePrefix =\n      options.routePrefix ?? server.realm.modifiers.route.prefix\n\n    const versionNumber = getFormVersion(definition)?.versionNumber\n\n    const model = new FormModel(\n      definition,\n      {\n        basePath:\n          options.basePath ??\n          buildBasePath(routePrefix, slug, formState, isPreview),\n        versionNumber,\n        ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,\n        formId: options.formId ?? metadata.id\n      },\n      services,\n      options.controllers\n    )\n\n    entry = { model, updatedAt: stateMetadata.updatedAt }\n    cache.set(cacheKey, entry)\n  }\n\n  return entry.model\n}\n\nfunction buildBasePath(\n  routePrefix: string,\n  slug: string,\n  state: FormStatus,\n  isPreview: boolean\n) {\n  const base = (\n    isPreview\n      ? `${routePrefix}${PREVIEW_PATH_PREFIX}/${state}/${slug}`\n      : `${routePrefix}/${slug}`\n  ).replace(/\\/{2,}/g, '/')\n\n  return base.startsWith('/') ? base.slice(1) : base\n}\n\nexport function getFirstJourneyPage(\n  context?: Pick<FormContext, 'relevantPages'>\n) {\n  if (!context?.relevantPages) {\n    return undefined\n  }\n\n  const lastPageReached = context.relevantPages.at(-1)\n  const penultimatePageReached = context.relevantPages.at(-2)\n\n  if (\n    lastPageReached instanceof TerminalPageController &&\n    penultimatePageReached\n  ) {\n    return penultimatePageReached\n  }\n\n  return lastPageReached\n}\n\nfunction resolveState(state: JourneyState): FormStatus {\n  return state === 'preview' ? FormStatus.Live : state\n}\n\nfunction isPreviewState(\n  state: JourneyState,\n  options: FormModelOptions = {}\n): boolean {\n  return options.isPreview ?? state === 'preview'\n}\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAE7B,SAASC,OAAO,QAAQ,UAAU;AAElC,SAASC,mBAAmB;AAC5B,SACEC,sCAAsC,EACtCC,eAAe,EACfC,cAAc;AAEhB,SAASC,SAAS;AAElB,SAASC,sBAAsB;AAC/B,OAAO,KAAKC,eAAe;AAQ3B,SAASC,UAAU;AAuBnB,OAAO,eAAeC,YAAYA,CAChCC,IAAY,EACZC,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EAC9B;EACA,MAAMC,QAAQ,GAAGD,OAAO,CAACC,QAAQ,IAAIN,eAAe;EACpD,MAAM;IAAEO;EAAa,CAAC,GAAGD,QAAQ;EACjC,MAAME,SAAS,GAAGC,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC;EAChD,MAAMK,SAAS,GAAGC,YAAY,CAACP,KAAK,CAAC;EAErC,MAAMQ,QAAQ,GAAG,MAAML,YAAY,CAACM,eAAe,CAACV,IAAI,CAAC;EAEzD,MAAMW,UAAU,GAAG,MAAMP,YAAY,CAACQ,iBAAiB,CACrDH,QAAQ,CAACI,EAAE,EACXN,SACF,CAAC;EAED,IAAI,CAACI,UAAU,EAAE;IACf,MAAMtB,IAAI,CAACyB,QAAQ,CACjB,yCAAyCL,QAAQ,CAACI,EAAE,KAAKb,IAAI,KAAKC,KAAK,EACzE,CAAC;EACH;EAEA,MAAMc,aAAa,GAAGrB,cAAc,CAACiB,UAAU,CAAC,EAAEI,aAAa;EAE/D,OAAO,IAAIpB,SAAS,CAClBgB,UAAU,EACV;IACEK,QAAQ,EACNd,OAAO,CAACc,QAAQ,IAChBC,aAAa,CAACf,OAAO,CAACgB,WAAW,IAAI,EAAE,EAAElB,IAAI,EAAEO,SAAS,EAAEF,SAAS,CAAC;IACtEU,aAAa;IACbI,oBAAoB,EAAEjB,OAAO,CAACiB,oBAAoB;IAClDC,MAAM,EAAElB,OAAO,CAACkB,MAAM,IAAIX,QAAQ,CAACI;EACrC,CAAC,EACDV,QAAQ,EACRD,OAAO,CAACmB,WACV,CAAC;AACH;AAEA,OAAO,eAAeC,cAAcA,CAClC;EAAEC,MAAM;EAAEC;AAAqC,CAAC,EAChDxB,IAAY,EACZC,KAAmB,GAAGH,UAAU,CAAC2B,IAAI,EACrCvB,OAA2B,GAAG,CAAC,CAAC,EACV;EACtB,MAAMwB,SAAS,GAAG,MAAMC,gBAAgB,CAACJ,MAAM,EAAEvB,IAAI,EAAEC,KAAK,EAAEC,OAAO,CAAC;EAEtE,MAAM0B,YAAY,GAAGnC,eAAe,CAAC8B,MAAM,CAAC;EAE5C,MAAMM,cAA8B,GAAG;IACrCC,GAAG,EAAE,CAAC,CAAC;IACPC,MAAM,EAAE,KAAK;IACbC,MAAM,EAAE;MACNC,IAAI,EAAE,SAAS;MACfjC,IAAI;MACJ,IAAIM,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC,IAAI;QACpCD,KAAK,EAAEO,YAAY,CAACP,KAAK;MAC3B,CAAC;IACH,CAAC;IACDgC,IAAI,EAAE,IAAIP,SAAS,CAACV,QAAQ,UAAU;IACtCkB,KAAK,EAAE,CAAC,CAAC;IACTC,GAAG,EAAE,IAAIC,GAAG,CACV,IAAIV,SAAS,CAACV,QAAQ,UAAU,EAChC,4BACF,CAAC;IACDO,MAAM;IACNC;EACF,CAAC;EAED,MAAMa,WAAW,GAAG,MAAMT,YAAY,CAACU,QAAQ,CAC7CT,cACF,CAAC;EAED,MAAMtB,SAAS,GAAG;IAChB,GAAG8B,WAAW;IACdE,mBAAmB,EAAEF,WAAW,CAACE;EACnC,CAAmC;EAEnC,OAAOb,SAAS,CAACJ,cAAc,CAC7BO,cAAc,EACdtB,SAAS,EACTL,OAAO,CAACsC,MAAM,IAAI,EACpB,CAAC;AACH;AAEA,OAAO,eAAeb,gBAAgBA,CACpCJ,MAAc,EACdvB,IAAY,EACZC,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EAC9B;EACA,MAAMC,QAAQ,GAAGD,OAAO,CAACC,QAAQ,IAAIN,eAAe;EACpD,MAAM;IAAEO;EAAa,CAAC,GAAGD,QAAQ;EAEjC,MAAMM,QAAQ,GAAG,MAAML,YAAY,CAACM,eAAe,CAACV,IAAI,CAAC;EACzD,MAAMO,SAAS,GAAGC,YAAY,CAACP,KAAK,CAAC;EACrC,MAAMI,SAAS,GAAGH,OAAO,CAACG,SAAS,IAAIC,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC;EACrE,MAAMuC,aAAa,GAAGhC,QAAQ,CAACF,SAAS,CAAC;EAEzC,IAAI,CAACkC,aAAa,EAAE;IAClB,MAAMpD,IAAI,CAACyB,QAAQ,CACjB,OAAOP,SAAS,6BAA6BE,QAAQ,CAACI,EAAE,EAC1D,CAAC;EACH;;EAEA;EACA;EACA,IAAI,CAACU,MAAM,CAACO,GAAG,CAACY,MAAM,EAAE;IACtBnB,MAAM,CAACO,GAAG,CAACY,MAAM,GAAG,IAAIC,GAAG,CAAgD,CAAC;EAC9E;EAEA,MAAMC,KAAK,GAAGrB,MAAM,CAACO,GAAG,CAACY,MAGxB;EAED,MAAMG,QAAQ,GAAG,GAAGpC,QAAQ,CAACI,EAAE,IAAIN,SAAS,IAAIF,SAAS,EAAE;EAC3D,IAAIyC,KAAK,GAAGF,KAAK,CAACG,GAAG,CAACF,QAAQ,CAAC;EAE/B,IAAI,CAACC,KAAK,IAAI,CAACxD,OAAO,CAACwD,KAAK,CAACE,SAAS,EAAEP,aAAa,CAACO,SAAS,CAAC,EAAE;IAChE,MAAMrC,UAAU,GAAG,MAAMP,YAAY,CAACQ,iBAAiB,CACrDH,QAAQ,CAACI,EAAE,EACXN,SACF,CAAC;IAED,IAAI,CAACI,UAAU,EAAE;MACf,MAAMtB,IAAI,CAACyB,QAAQ,CACjB,yCAAyCL,QAAQ,CAACI,EAAE,KAAKb,IAAI,KAAKC,KAAK,EACzE,CAAC;IACH;IAEAT,sCAAsC,CACpCiB,QAAQ,CAACwC,iBAAiB,EAC1B5C,SACF,CAAC;IAED,MAAMa,WAAW,GACfhB,OAAO,CAACgB,WAAW,IAAIK,MAAM,CAAC2B,KAAK,CAACC,SAAS,CAACC,KAAK,CAACC,MAAM;IAE5D,MAAMtC,aAAa,GAAGrB,cAAc,CAACiB,UAAU,CAAC,EAAEI,aAAa;IAE/D,MAAMuC,KAAK,GAAG,IAAI3D,SAAS,CACzBgB,UAAU,EACV;MACEK,QAAQ,EACNd,OAAO,CAACc,QAAQ,IAChBC,aAAa,CAACC,WAAW,EAAElB,IAAI,EAAEO,SAAS,EAAEF,SAAS,CAAC;MACxDU,aAAa;MACbI,oBAAoB,EAAEjB,OAAO,CAACiB,oBAAoB;MAClDC,MAAM,EAAElB,OAAO,CAACkB,MAAM,IAAIX,QAAQ,CAACI;IACrC,CAAC,EACDV,QAAQ,EACRD,OAAO,CAACmB,WACV,CAAC;IAEDyB,KAAK,GAAG;MAAEQ,KAAK;MAAEN,SAAS,EAAEP,aAAa,CAACO;IAAU,CAAC;IACrDJ,KAAK,CAACW,GAAG,CAACV,QAAQ,EAAEC,KAAK,CAAC;EAC5B;EAEA,OAAOA,KAAK,CAACQ,KAAK;AACpB;AAEA,SAASrC,aAAaA,CACpBC,WAAmB,EACnBlB,IAAY,EACZC,KAAiB,EACjBI,SAAkB,EAClB;EACA,MAAMmD,IAAI,GAAG,CACXnD,SAAS,GACL,GAAGa,WAAW,GAAG3B,mBAAmB,IAAIU,KAAK,IAAID,IAAI,EAAE,GACvD,GAAGkB,WAAW,IAAIlB,IAAI,EAAE,EAC5ByD,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;EAEzB,OAAOD,IAAI,CAACE,UAAU,CAAC,GAAG,CAAC,GAAGF,IAAI,CAACG,KAAK,CAAC,CAAC,CAAC,GAAGH,IAAI;AACpD;AAEA,OAAO,SAASI,mBAAmBA,CACjCC,OAA4C,EAC5C;EACA,IAAI,CAACA,OAAO,EAAEC,aAAa,EAAE;IAC3B,OAAOC,SAAS;EAClB;EAEA,MAAMC,eAAe,GAAGH,OAAO,CAACC,aAAa,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC;EACpD,MAAMC,sBAAsB,GAAGL,OAAO,CAACC,aAAa,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC;EAE3D,IACED,eAAe,YAAYpE,sBAAsB,IACjDsE,sBAAsB,EACtB;IACA,OAAOA,sBAAsB;EAC/B;EAEA,OAAOF,eAAe;AACxB;AAEA,SAASxD,YAAYA,CAACP,KAAmB,EAAc;EACrD,OAAOA,KAAK,KAAK,SAAS,GAAGH,UAAU,CAAC2B,IAAI,GAAGxB,KAAK;AACtD;AAEA,SAASK,cAAcA,CACrBL,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EACrB;EACT,OAAOA,OAAO,CAACG,SAAS,IAAIJ,KAAK,KAAK,SAAS;AACjD","ignoreList":[]}

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

@@ -85,4 +85,12 @@ export declare function handleLegacyRedirect(h: ResponseToolkit, targetUrl: stri
  * If the page doesn't have a title, set it from the title of the first form component
  * @param def - the form definition
  */
+export interface FormVersionMetadata {
+    versionNumber: number;
+    createdAt: Date;
+}
+/**
+ * Extracts form version metadata from a form definition
+ */
+export declare function getFormVersion(definition: Pick<FormDefinition, 'metadata'>): FormVersionMetadata | undefined;
 export declare function setPageTitles(def: FormDefinition): void;

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

@@ -4,6 +4,7 @@ import { format, parseISO } from 'date-fns';
 import { StatusCodes } from 'http-status-codes';
 import { Liquid } from 'liquidjs';
 import { createLogger } from "../../common/helpers/logging/logger.js";
+import { FORM_VERSION_METADATA_KEY } from "../../constants.js";
 import { getAnswer } from "./components/helpers/components.js";
 import { stripParam } from "./pageControllers/helpers/state.js";
 import { FormAction, FormStatus } from "../../routes/types.js";
@@ -292,6 +293,13 @@ export function handleLegacyRedirect(h, targetUrl) {
  * If the page doesn't have a title, set it from the title of the first form component
  * @param def - the form definition
  */
+
+/**
+ * Extracts form version metadata from a form definition
+ */
+export function getFormVersion(definition) {
+  return definition.metadata?.[FORM_VERSION_METADATA_KEY];
+}
 export function setPageTitles(def) {
   def.pages.forEach(page => {
     if (!page.title) {

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","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":[]}
+{"version":3,"file":"helpers.js","names":["ControllerPath","Engine","getErrorMessage","hasComponents","isFormType","Boom","format","parseISO","StatusCodes","Liquid","createLogger","FORM_VERSION_METADATA_KEY","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","getFormVersion","definition","metadata","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 { FORM_VERSION_METADATA_KEY } from '~/src/server/constants.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 interface FormVersionMetadata {\n  versionNumber: number\n  createdAt: Date\n}\n\n/**\n * Extracts form version metadata from a form definition\n */\nexport function getFormVersion(\n  definition: Pick<FormDefinition, 'metadata'>\n): FormVersionMetadata | undefined {\n  return definition.metadata?.[FORM_VERSION_METADATA_KEY] as\n    | FormVersionMetadata\n    | undefined\n}\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,SAASC,yBAAyB;AAClC,SACEC,SAAS;AAKX,SAASC,UAAU;AAOnB,SACEC,UAAU,EACVC,UAAU;AAMZ,MAAMC,MAAM,GAAGN,YAAY,CAAC,CAAC;AAE7B,OAAO,MAAMO,MAAM,GAAG,IAAIR,MAAM,CAAC;EAC/BS,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,CAACpD,WAAW,CAACqD,SAAS,CAAC,GACpCL,QAAQ,CAACI,IAAI,CAACpD,WAAW,CAACsD,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,MAAM9D,eAAe,CAACiE,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,MAAM3B,IAAI,CAACuF,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,KAAKhB,MAAM,CAAC+F,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,GAAGjG,cAAc,CAACoG,KAAK;EAC3D;EAEA,MAAMH,SAAS,GAAGX,aAAa,CAACI,KAAK,EAAEQ,GAAG,CAACG,SAAS,CAAC;EACrD,OAAOJ,SAAS,GAAG,IAAIA,SAAS,EAAE,GAAGjG,cAAc,CAACoG,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,MAAMlG,IAAI,CAACwG,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,IAAKhH,MAAM,CAACC,QAAQ,CAAC+G,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;;AAMA;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAC5BC,UAA4C,EACX;EACjC,OAAOA,UAAU,CAACC,QAAQ,GAAG1I,yBAAyB,CAAC;AAGzD;AAEA,OAAO,SAAS2I,aAAaA,CAACpD,GAAmB,EAAE;EACjDA,GAAG,CAACrE,KAAK,CAAC0H,OAAO,CAAEvH,IAAI,IAAK;IAC1B,IAAI,CAACA,IAAI,CAACwH,KAAK,EAAE;MACf,IAAIrJ,aAAa,CAAC6B,IAAI,CAAC,EAAE;QACvB;QACA,MAAMyH,kBAAkB,GAAGzH,IAAI,CAACM,UAAU,CAACwD,IAAI,CAAEvD,SAAS,IACxDnC,UAAU,CAACmC,SAAS,CAACmH,IAAI,CAC3B,CAAC;QAED1H,IAAI,CAACwH,KAAK,GAAGC,kBAAkB,EAAED,KAAK,IAAI,EAAE;MAC9C;IACF;EACF,CAAC,CAAC;AACJ","ignoreList":[]}

package/.server/server/plugins/engine/outputFormatters/adapter/v1.js

@@ -1,3 +1,4 @@
+import { getFormVersion } from "../../helpers.js";
 import { categoriseData } from "../machine/v2.js";
 import { FormAdapterSubmissionSchemaVersion } from "../../types/enums.js";
 export function format(context, items, model, submitResponse, formStatus, formMetadata) {
@@ -6,7 +7,7 @@ export function format(context, items, model, submitResponse, formStatus, formMe
     main: v2Main,
     ...v2Data
   } = categoriseData(items);
-  const versionMetadata = getVersionMetadata(context.submittedVersionNumber, formMetadata);
+  const versionMetadata = getFormVersion(model.def) ?? getVersionMetadata(context.submittedVersionNumber, formMetadata);
   const meta = {
     schemaVersion: FormAdapterSubmissionSchemaVersion.V1,
     timestamp: new Date(),

package/.server/server/plugins/engine/outputFormatters/adapter/v1.js.map

@@ -1 +1 @@
-{"version":3,"file":"v1.js","names":["categoriseData","FormAdapterSubmissionSchemaVersion","format","context","items","model","submitResponse","formStatus","formMetadata","csvFiles","extractCsvFiles","main","v2Main","v2Data","versionMetadata","getVersionMetadata","submittedVersionNumber","meta","schemaVersion","V1","timestamp","Date","referenceNumber","formName","name","formId","id","formSlug","slug","status","state","isPreview","notificationEmail","Object","fromEntries","entries","map","key","value","undefined","data","result","files","payload","JSON","stringify","versions","length","submittedVersion","find","v","versionNumber","createdAt","firstVersion","repeaters"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/adapter/v1.ts"],"sourcesContent":["import {\n  type FormMetadata,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\n\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { categoriseData } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'\nimport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\nimport {\n  type FormAdapterSubmissionMessageData,\n  type FormAdapterSubmissionMessageMeta,\n  type FormAdapterSubmissionMessagePayload,\n  type FormAdapterSubmissionMessageResult,\n  type FormContext\n} from '~/src/server/plugins/engine/types.js'\n\nexport function format(\n  context: FormContext,\n  items: DetailItem[],\n  model: FormModel,\n  submitResponse: SubmitResponsePayload,\n  formStatus: ReturnType<typeof checkFormStatus>,\n  formMetadata?: FormMetadata\n): string {\n  const csvFiles = extractCsvFiles(submitResponse)\n\n  const { main: v2Main, ...v2Data } = categoriseData(items)\n\n  const versionMetadata = getVersionMetadata(\n    context.submittedVersionNumber,\n    formMetadata\n  )\n\n  const meta: FormAdapterSubmissionMessageMeta = {\n    schemaVersion: FormAdapterSubmissionSchemaVersion.V1,\n    timestamp: new Date(),\n    referenceNumber: context.referenceNumber,\n    formName: model.name,\n    formId: formMetadata?.id ?? '',\n    formSlug: formMetadata?.slug ?? '',\n    status: formStatus.state,\n    isPreview: formStatus.isPreview,\n    notificationEmail: formMetadata?.notificationEmail ?? ''\n  }\n\n  if (versionMetadata) {\n    meta.versionMetadata = versionMetadata\n  }\n\n  const main = Object.fromEntries(\n    Object.entries(v2Main).map(([key, value]) => {\n      if (value === undefined) {\n        return [key, null]\n      }\n\n      return [key, value]\n    })\n  )\n\n  const data: FormAdapterSubmissionMessageData = {\n    main,\n    ...v2Data\n  }\n\n  const result: FormAdapterSubmissionMessageResult = {\n    files: csvFiles\n  }\n\n  const payload: FormAdapterSubmissionMessagePayload = {\n    meta,\n    data,\n    result\n  }\n\n  return JSON.stringify(payload)\n}\n\nexport function getVersionMetadata(\n  submittedVersionNumber: number | undefined,\n  formMetadata?: FormMetadata\n): { versionNumber: number; createdAt: Date } | undefined {\n  if (!formMetadata?.versions?.length) {\n    return undefined\n  }\n\n  if (submittedVersionNumber !== undefined) {\n    const submittedVersion = formMetadata.versions.find(\n      (v) => v.versionNumber === submittedVersionNumber\n    )\n    if (submittedVersion) {\n      return {\n        versionNumber: submittedVersion.versionNumber,\n        createdAt: submittedVersion.createdAt\n      }\n    }\n  }\n\n  // fallback to first available version\n  const firstVersion = formMetadata.versions[0]\n  return {\n    versionNumber: firstVersion.versionNumber,\n    createdAt: firstVersion.createdAt\n  }\n}\n\nfunction extractCsvFiles(\n  submitResponse: SubmitResponsePayload\n): FormAdapterSubmissionMessageResult['files'] {\n  const result =\n    submitResponse.result as Partial<FormAdapterSubmissionMessageResult>\n\n  return {\n    main: result.files?.main ?? '',\n    repeaters: result.files?.repeaters ?? {}\n  }\n}\n"],"mappings":"AAQA,SAASA,cAAc;AACvB,SAASC,kCAAkC;AAS3C,OAAO,SAASC,MAAMA,CACpBC,OAAoB,EACpBC,KAAmB,EACnBC,KAAgB,EAChBC,cAAqC,EACrCC,UAA8C,EAC9CC,YAA2B,EACnB;EACR,MAAMC,QAAQ,GAAGC,eAAe,CAACJ,cAAc,CAAC;EAEhD,MAAM;IAAEK,IAAI,EAAEC,MAAM;IAAE,GAAGC;EAAO,CAAC,GAAGb,cAAc,CAACI,KAAK,CAAC;EAEzD,MAAMU,eAAe,GAAGC,kBAAkB,CACxCZ,OAAO,CAACa,sBAAsB,EAC9BR,YACF,CAAC;EAED,MAAMS,IAAsC,GAAG;IAC7CC,aAAa,EAAEjB,kCAAkC,CAACkB,EAAE;IACpDC,SAAS,EAAE,IAAIC,IAAI,CAAC,CAAC;IACrBC,eAAe,EAAEnB,OAAO,CAACmB,eAAe;IACxCC,QAAQ,EAAElB,KAAK,CAACmB,IAAI;IACpBC,MAAM,EAAEjB,YAAY,EAAEkB,EAAE,IAAI,EAAE;IAC9BC,QAAQ,EAAEnB,YAAY,EAAEoB,IAAI,IAAI,EAAE;IAClCC,MAAM,EAAEtB,UAAU,CAACuB,KAAK;IACxBC,SAAS,EAAExB,UAAU,CAACwB,SAAS;IAC/BC,iBAAiB,EAAExB,YAAY,EAAEwB,iBAAiB,IAAI;EACxD,CAAC;EAED,IAAIlB,eAAe,EAAE;IACnBG,IAAI,CAACH,eAAe,GAAGA,eAAe;EACxC;EAEA,MAAMH,IAAI,GAAGsB,MAAM,CAACC,WAAW,CAC7BD,MAAM,CAACE,OAAO,CAACvB,MAAM,CAAC,CAACwB,GAAG,CAAC,CAAC,CAACC,GAAG,EAAEC,KAAK,CAAC,KAAK;IAC3C,IAAIA,KAAK,KAAKC,SAAS,EAAE;MACvB,OAAO,CAACF,GAAG,EAAE,IAAI,CAAC;IACpB;IAEA,OAAO,CAACA,GAAG,EAAEC,KAAK,CAAC;EACrB,CAAC,CACH,CAAC;EAED,MAAME,IAAsC,GAAG;IAC7C7B,IAAI;IACJ,GAAGE;EACL,CAAC;EAED,MAAM4B,MAA0C,GAAG;IACjDC,KAAK,EAAEjC;EACT,CAAC;EAED,MAAMkC,OAA4C,GAAG;IACnD1B,IAAI;IACJuB,IAAI;IACJC;EACF,CAAC;EAED,OAAOG,IAAI,CAACC,SAAS,CAACF,OAAO,CAAC;AAChC;AAEA,OAAO,SAAS5B,kBAAkBA,CAChCC,sBAA0C,EAC1CR,YAA2B,EAC6B;EACxD,IAAI,CAACA,YAAY,EAAEsC,QAAQ,EAAEC,MAAM,EAAE;IACnC,OAAOR,SAAS;EAClB;EAEA,IAAIvB,sBAAsB,KAAKuB,SAAS,EAAE;IACxC,MAAMS,gBAAgB,GAAGxC,YAAY,CAACsC,QAAQ,CAACG,IAAI,CAChDC,CAAC,IAAKA,CAAC,CAACC,aAAa,KAAKnC,sBAC7B,CAAC;IACD,IAAIgC,gBAAgB,EAAE;MACpB,OAAO;QACLG,aAAa,EAAEH,gBAAgB,CAACG,aAAa;QAC7CC,SAAS,EAAEJ,gBAAgB,CAACI;MAC9B,CAAC;IACH;EACF;;EAEA;EACA,MAAMC,YAAY,GAAG7C,YAAY,CAACsC,QAAQ,CAAC,CAAC,CAAC;EAC7C,OAAO;IACLK,aAAa,EAAEE,YAAY,CAACF,aAAa;IACzCC,SAAS,EAAEC,YAAY,CAACD;EAC1B,CAAC;AACH;AAEA,SAAS1C,eAAeA,CACtBJ,cAAqC,EACQ;EAC7C,MAAMmC,MAAM,GACVnC,cAAc,CAACmC,MAAqD;EAEtE,OAAO;IACL9B,IAAI,EAAE8B,MAAM,CAACC,KAAK,EAAE/B,IAAI,IAAI,EAAE;IAC9B2C,SAAS,EAAEb,MAAM,CAACC,KAAK,EAAEY,SAAS,IAAI,CAAC;EACzC,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"v1.js","names":["getFormVersion","categoriseData","FormAdapterSubmissionSchemaVersion","format","context","items","model","submitResponse","formStatus","formMetadata","csvFiles","extractCsvFiles","main","v2Main","v2Data","versionMetadata","def","getVersionMetadata","submittedVersionNumber","meta","schemaVersion","V1","timestamp","Date","referenceNumber","formName","name","formId","id","formSlug","slug","status","state","isPreview","notificationEmail","Object","fromEntries","entries","map","key","value","undefined","data","result","files","payload","JSON","stringify","versions","length","submittedVersion","find","v","versionNumber","createdAt","firstVersion","repeaters"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/adapter/v1.ts"],"sourcesContent":["import {\n  type FormMetadata,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\n\nimport {\n  getFormVersion,\n  type checkFormStatus\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { categoriseData } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'\nimport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\nimport {\n  type FormAdapterSubmissionMessageData,\n  type FormAdapterSubmissionMessageMeta,\n  type FormAdapterSubmissionMessagePayload,\n  type FormAdapterSubmissionMessageResult,\n  type FormContext\n} from '~/src/server/plugins/engine/types.js'\n\nexport function format(\n  context: FormContext,\n  items: DetailItem[],\n  model: FormModel,\n  submitResponse: SubmitResponsePayload,\n  formStatus: ReturnType<typeof checkFormStatus>,\n  formMetadata?: FormMetadata\n): string {\n  const csvFiles = extractCsvFiles(submitResponse)\n\n  const { main: v2Main, ...v2Data } = categoriseData(items)\n\n  const versionMetadata =\n    getFormVersion(model.def) ??\n    getVersionMetadata(context.submittedVersionNumber, formMetadata)\n\n  const meta: FormAdapterSubmissionMessageMeta = {\n    schemaVersion: FormAdapterSubmissionSchemaVersion.V1,\n    timestamp: new Date(),\n    referenceNumber: context.referenceNumber,\n    formName: model.name,\n    formId: formMetadata?.id ?? '',\n    formSlug: formMetadata?.slug ?? '',\n    status: formStatus.state,\n    isPreview: formStatus.isPreview,\n    notificationEmail: formMetadata?.notificationEmail ?? ''\n  }\n\n  if (versionMetadata) {\n    meta.versionMetadata = versionMetadata\n  }\n\n  const main = Object.fromEntries(\n    Object.entries(v2Main).map(([key, value]) => {\n      if (value === undefined) {\n        return [key, null]\n      }\n\n      return [key, value]\n    })\n  )\n\n  const data: FormAdapterSubmissionMessageData = {\n    main,\n    ...v2Data\n  }\n\n  const result: FormAdapterSubmissionMessageResult = {\n    files: csvFiles\n  }\n\n  const payload: FormAdapterSubmissionMessagePayload = {\n    meta,\n    data,\n    result\n  }\n\n  return JSON.stringify(payload)\n}\n\nexport function getVersionMetadata(\n  submittedVersionNumber: number | undefined,\n  formMetadata?: FormMetadata\n): { versionNumber: number; createdAt: Date } | undefined {\n  if (!formMetadata?.versions?.length) {\n    return undefined\n  }\n\n  if (submittedVersionNumber !== undefined) {\n    const submittedVersion = formMetadata.versions.find(\n      (v) => v.versionNumber === submittedVersionNumber\n    )\n    if (submittedVersion) {\n      return {\n        versionNumber: submittedVersion.versionNumber,\n        createdAt: submittedVersion.createdAt\n      }\n    }\n  }\n\n  // fallback to first available version\n  const firstVersion = formMetadata.versions[0]\n  return {\n    versionNumber: firstVersion.versionNumber,\n    createdAt: firstVersion.createdAt\n  }\n}\n\nfunction extractCsvFiles(\n  submitResponse: SubmitResponsePayload\n): FormAdapterSubmissionMessageResult['files'] {\n  const result =\n    submitResponse.result as Partial<FormAdapterSubmissionMessageResult>\n\n  return {\n    main: result.files?.main ?? '',\n    repeaters: result.files?.repeaters ?? {}\n  }\n}\n"],"mappings":"AAKA,SACEA,cAAc;AAKhB,SAASC,cAAc;AACvB,SAASC,kCAAkC;AAS3C,OAAO,SAASC,MAAMA,CACpBC,OAAoB,EACpBC,KAAmB,EACnBC,KAAgB,EAChBC,cAAqC,EACrCC,UAA8C,EAC9CC,YAA2B,EACnB;EACR,MAAMC,QAAQ,GAAGC,eAAe,CAACJ,cAAc,CAAC;EAEhD,MAAM;IAAEK,IAAI,EAAEC,MAAM;IAAE,GAAGC;EAAO,CAAC,GAAGb,cAAc,CAACI,KAAK,CAAC;EAEzD,MAAMU,eAAe,GACnBf,cAAc,CAACM,KAAK,CAACU,GAAG,CAAC,IACzBC,kBAAkB,CAACb,OAAO,CAACc,sBAAsB,EAAET,YAAY,CAAC;EAElE,MAAMU,IAAsC,GAAG;IAC7CC,aAAa,EAAElB,kCAAkC,CAACmB,EAAE;IACpDC,SAAS,EAAE,IAAIC,IAAI,CAAC,CAAC;IACrBC,eAAe,EAAEpB,OAAO,CAACoB,eAAe;IACxCC,QAAQ,EAAEnB,KAAK,CAACoB,IAAI;IACpBC,MAAM,EAAElB,YAAY,EAAEmB,EAAE,IAAI,EAAE;IAC9BC,QAAQ,EAAEpB,YAAY,EAAEqB,IAAI,IAAI,EAAE;IAClCC,MAAM,EAAEvB,UAAU,CAACwB,KAAK;IACxBC,SAAS,EAAEzB,UAAU,CAACyB,SAAS;IAC/BC,iBAAiB,EAAEzB,YAAY,EAAEyB,iBAAiB,IAAI;EACxD,CAAC;EAED,IAAInB,eAAe,EAAE;IACnBI,IAAI,CAACJ,eAAe,GAAGA,eAAe;EACxC;EAEA,MAAMH,IAAI,GAAGuB,MAAM,CAACC,WAAW,CAC7BD,MAAM,CAACE,OAAO,CAACxB,MAAM,CAAC,CAACyB,GAAG,CAAC,CAAC,CAACC,GAAG,EAAEC,KAAK,CAAC,KAAK;IAC3C,IAAIA,KAAK,KAAKC,SAAS,EAAE;MACvB,OAAO,CAACF,GAAG,EAAE,IAAI,CAAC;IACpB;IAEA,OAAO,CAACA,GAAG,EAAEC,KAAK,CAAC;EACrB,CAAC,CACH,CAAC;EAED,MAAME,IAAsC,GAAG;IAC7C9B,IAAI;IACJ,GAAGE;EACL,CAAC;EAED,MAAM6B,MAA0C,GAAG;IACjDC,KAAK,EAAElC;EACT,CAAC;EAED,MAAMmC,OAA4C,GAAG;IACnD1B,IAAI;IACJuB,IAAI;IACJC;EACF,CAAC;EAED,OAAOG,IAAI,CAACC,SAAS,CAACF,OAAO,CAAC;AAChC;AAEA,OAAO,SAAS5B,kBAAkBA,CAChCC,sBAA0C,EAC1CT,YAA2B,EAC6B;EACxD,IAAI,CAACA,YAAY,EAAEuC,QAAQ,EAAEC,MAAM,EAAE;IACnC,OAAOR,SAAS;EAClB;EAEA,IAAIvB,sBAAsB,KAAKuB,SAAS,EAAE;IACxC,MAAMS,gBAAgB,GAAGzC,YAAY,CAACuC,QAAQ,CAACG,IAAI,CAChDC,CAAC,IAAKA,CAAC,CAACC,aAAa,KAAKnC,sBAC7B,CAAC;IACD,IAAIgC,gBAAgB,EAAE;MACpB,OAAO;QACLG,aAAa,EAAEH,gBAAgB,CAACG,aAAa;QAC7CC,SAAS,EAAEJ,gBAAgB,CAACI;MAC9B,CAAC;IACH;EACF;;EAEA;EACA,MAAMC,YAAY,GAAG9C,YAAY,CAACuC,QAAQ,CAAC,CAAC,CAAC;EAC7C,OAAO;IACLK,aAAa,EAAEE,YAAY,CAACF,aAAa;IACzCC,SAAS,EAAEC,YAAY,CAACD;EAC1B,CAAC;AACH;AAEA,SAAS3C,eAAeA,CACtBJ,cAAqC,EACQ;EAC7C,MAAMoC,MAAM,GACVpC,cAAc,CAACoC,MAAqD;EAEtE,OAAO;IACL/B,IAAI,EAAE+B,MAAM,CAACC,KAAK,EAAEhC,IAAI,IAAI,EAAE;IAC9B4C,SAAS,EAAEb,MAAM,CAACC,KAAK,EAAEY,SAAS,IAAI,CAAC;EACzC,CAAC;AACH","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.5.0",
+  "version": "4.5.1",
   "description": "Defra forms engine",
   "type": "module",
   "files": [

package/src/server/constants.js

@@ -1,3 +1,4 @@
+export const FORM_VERSION_METADATA_KEY = '$$__formVersion'
 export const PREVIEW_PATH_PREFIX = '/preview'
 export const FORM_PREFIX = ''
 export const EXTERNAL_STATE_PAYLOAD = 'EXTERNAL_STATE_PAYLOAD'

package/src/server/plugins/engine/beta/form-context.test.ts

@@ -44,7 +44,7 @@ jest.mock('../pageControllers/index.ts', () => {
 })
 
 jest.mock('../helpers.ts', () => ({
-  __esModule: true,
+  ...jest.requireActual('../helpers.ts'),
   getCacheService: (...args: unknown[]) => mockGetCacheService(...args),
   checkEmailAddressForLiveFormSubmission: (...args: unknown[]) =>
     mockCheckEmailAddressForLiveFormSubmission(...args)
@@ -134,10 +134,17 @@ describe('getFormModel helper', () => {
   class CustomController extends PageController {}
   const controllers = { CustomController }
   const metadata = {
-    id: 'form-meta-123',
-    versions: [{ versionNumber: 17 }]
+    id: 'form-meta-123'
+  }
+  const definition = {
+    pages: [{ path: '/start' }],
+    metadata: {
+      $$__formVersion: {
+        versionNumber: 17,
+        createdAt: new Date('2024-10-15T10:00:00Z')
+      }
+    }
   }
-  const definition = { pages: [{ path: '/start' }] }
   let formsService: FormsService
   let services: Services
   let formModelInstance: { id: string }
@@ -176,7 +183,7 @@ describe('getFormModel helper', () => {
       definition,
       {
         basePath: slug,
-        versionNumber: metadata.versions[0].versionNumber,
+        versionNumber: 17,
         ordnanceSurveyApiKey: undefined,
         formId: metadata.id
       },
@@ -210,11 +217,18 @@ describe('getFormModel helper', () => {
 
 describe('resolveFormModel helper', () => {
   const slug = 'tb-origin'
-  const definition = { pages: [] }
+  const definition = {
+    pages: [],
+    metadata: {
+      $$__formVersion: {
+        versionNumber: 9,
+        createdAt: new Date('2024-10-15T10:00:00Z')
+      }
+    }
+  }
   const metadata = {
     id: 'metadata-123',
     live: { updatedAt: new Date('2024-10-15T10:00:00Z') },
-    versions: [{ versionNumber: 9 }],
     notificationEmail: 'enrique.chase@defra.gov.uk'
   }
   let server: Request['server']
@@ -274,7 +288,7 @@ describe('resolveFormModel helper', () => {
       definition,
       expect.objectContaining({
         basePath: 'forms/preview/live/tb-origin',
-        versionNumber: metadata.versions[0].versionNumber,
+        versionNumber: 9,
         ordnanceSurveyApiKey: 'os-api-key',
         formId: metadata.id
       }),

package/src/server/plugins/engine/beta/form-context.ts

@@ -5,7 +5,8 @@ import { isEqual } from 'date-fns'
 import { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'
 import {
   checkEmailAddressForLiveFormSubmission,
-  getCacheService
+  getCacheService,
+  getFormVersion
 } from '~/src/server/plugins/engine/helpers.js'
 import { FormModel } from '~/src/server/plugins/engine/models/index.js'
 import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'
@@ -27,7 +28,6 @@ export interface FormModelOptions {
   services?: Services
   controllers?: Record<string, typeof PageController>
   basePath?: string
-  versionNumber?: number
   ordnanceSurveyApiKey?: string
   formId?: string
   routePrefix?: string
@@ -53,8 +53,6 @@ export async function getFormModel(
   const formState = resolveState(state)
 
   const metadata = await formsService.getFormMetadata(slug)
-  const versionNumber =
-    options.versionNumber ?? metadata.versions?.[0]?.versionNumber
 
   const definition = await formsService.getFormDefinition(
     metadata.id,
@@ -67,6 +65,8 @@ export async function getFormModel(
     )
   }
 
+  const versionNumber = getFormVersion(definition)?.versionNumber
+
   return new FormModel(
     definition,
     {
@@ -182,14 +182,15 @@ export async function resolveFormModel(
     const routePrefix =
       options.routePrefix ?? server.realm.modifiers.route.prefix
 
+    const versionNumber = getFormVersion(definition)?.versionNumber
+
     const model = new FormModel(
       definition,
       {
         basePath:
           options.basePath ??
           buildBasePath(routePrefix, slug, formState, isPreview),
-        versionNumber:
-          options.versionNumber ?? metadata.versions?.[0]?.versionNumber,
+        versionNumber,
         ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,
         formId: options.formId ?? metadata.id
       },

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

@@ -16,6 +16,7 @@ import { type Schema, type ValidationErrorItem } from 'joi'
 import { Liquid } from 'liquidjs'
 
 import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
+import { FORM_VERSION_METADATA_KEY } from '~/src/server/constants.js'
 import {
   getAnswer,
   type Field
@@ -416,6 +417,22 @@ export function handleLegacyRedirect(h: ResponseToolkit, targetUrl: string) {
  * If the page doesn't have a title, set it from the title of the first form component
  * @param def - the form definition
  */
+export interface FormVersionMetadata {
+  versionNumber: number
+  createdAt: Date
+}
+
+/**
+ * Extracts form version metadata from a form definition
+ */
+export function getFormVersion(
+  definition: Pick<FormDefinition, 'metadata'>
+): FormVersionMetadata | undefined {
+  return definition.metadata?.[FORM_VERSION_METADATA_KEY] as
+    | FormVersionMetadata
+    | undefined
+}
+
 export function setPageTitles(def: FormDefinition) {
   def.pages.forEach((page) => {
     if (!page.title) {

package/src/server/plugins/engine/outputFormatters/adapter/v1.test.ts

@@ -764,6 +764,60 @@ describe('Adapter v1 formatter', () => {
   })
 
   describe('version metadata handling', () => {
+    it('should prefer $$__formVersion from definition metadata over formMetadata.versions', () => {
+      const definitionWithFormVersion = {
+        ...definition,
+        metadata: {
+          $$__formVersion: {
+            versionNumber: 42,
+            createdAt: new Date('2024-06-01T00:00:00.000Z')
+          }
+        }
+      }
+
+      const modelWithFormVersion = new FormModel(definitionWithFormVersion, {
+        basePath: 'test'
+      })
+
+      const contextWithFormVersion = modelWithFormVersion.getFormContext(
+        request,
+        state
+      )
+
+      const formMetadata: Partial<FormMetadata> = {
+        id: 'form-123',
+        slug: 'test-form',
+        title: 'Test Form',
+        notificationEmail: 'test@example.com',
+        versions: [
+          {
+            versionNumber: 1,
+            createdAt: new Date('2024-01-01T00:00:00.000Z')
+          }
+        ]
+      }
+
+      const formStatus = {
+        isPreview: false,
+        state: FormStatus.Live
+      }
+
+      const body = format(
+        contextWithFormVersion,
+        items,
+        modelWithFormVersion,
+        submitResponse,
+        formStatus,
+        formMetadata as FormMetadata
+      )
+      const parsedBody = JSON.parse(body) as FormAdapterSubmissionMessagePayload
+
+      expect(parsedBody.meta.versionMetadata).toEqual({
+        versionNumber: 42,
+        createdAt: '2024-06-01T00:00:00.000Z'
+      })
+    })
+
     it('should include versionMetadata when context has submittedVersionNumber and formMetadata has versions', () => {
       const formMetadata: Partial<FormMetadata> = {
         id: 'form-123',

package/src/server/plugins/engine/outputFormatters/adapter/v1.ts

@@ -3,7 +3,10 @@ import {
   type SubmitResponsePayload
 } from '@defra/forms-model'
 
-import { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'
+import {
+  getFormVersion,
+  type checkFormStatus
+} from '~/src/server/plugins/engine/helpers.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { type DetailItem } from '~/src/server/plugins/engine/models/types.js'
 import { categoriseData } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'
@@ -28,10 +31,9 @@ export function format(
 
   const { main: v2Main, ...v2Data } = categoriseData(items)
 
-  const versionMetadata = getVersionMetadata(
-    context.submittedVersionNumber,
-    formMetadata
-  )
+  const versionMetadata =
+    getFormVersion(model.def) ??
+    getVersionMetadata(context.submittedVersionNumber, formMetadata)
 
   const meta: FormAdapterSubmissionMessageMeta = {
     schemaVersion: FormAdapterSubmissionSchemaVersion.V1,