@defra/forms-engine-plugin 2.0.2 → 2.0.3

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

@@ -63,7 +63,7 @@ export declare function getCacheService(server: Server): import("../../services/
 export declare function getSaveAndReturnHelpers(server: Server): {
     keyGenerator: (request: FormRequest | FormRequestPayload | import("@hapi/hapi").Request<import("@hapi/hapi").ReqRefDefaults>) => string;
     sessionHydrator: (request: FormRequest | FormRequestPayload | import("@hapi/hapi").Request<import("@hapi/hapi").ReqRefDefaults>) => Promise<import("~/src/server/plugins/engine/types.js").FormSubmissionState>;
-    sessionPersister: (key: string, state: import("~/src/server/plugins/engine/types.js").FormSubmissionState, request: FormRequest | FormRequestPayload | import("@hapi/hapi").Request<import("@hapi/hapi").ReqRefDefaults>) => Promise<void>;
+    sessionPersister: (state: import("~/src/server/plugins/engine/types.js").FormSubmissionState, request: FormRequest | FormRequestPayload | import("@hapi/hapi").Request<import("@hapi/hapi").ReqRefDefaults>) => Promise<void>;
 } | undefined;
 export declare function getPluginOptions(server: Server): {
     baseLayoutPath: string;

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

@@ -1,7 +1,8 @@
 import { ComponentType, ControllerType, Engine, hasComponents, hasNext, hasRepeater } from '@defra/forms-model';
+import Boom from '@hapi/boom';
 import { ComponentCollection } from "../components/ComponentCollection.js";
 import { optionalText } from "../components/constants.js";
-import { getCacheService, getErrors, normalisePath, proceed } from "../helpers.js";
+import { getCacheService, getErrors, getSaveAndReturnHelpers, normalisePath, proceed } from "../helpers.js";
 import { PageController } from "./PageController.js";
 import { FormAction } from "../../../routes/types.js";
 import { actionSchema, crumbSchema, paramsSchema } from "../../../schemas/index.js";
@@ -458,7 +459,13 @@ export class QuestionPageController extends PageController {
     } = context;
 
     // Save the current state and redirect to exit page
-    await this.setState(request, state);
+    const saveAndReturn = getSaveAndReturnHelpers(request.server);
+    if (!saveAndReturn?.sessionPersister) {
+      throw Boom.internal('Server misconfigured for save and return');
+    }
+    await saveAndReturn.sessionPersister(state, request);
+    const cacheService = getCacheService(request.server);
+    await cacheService.clearState(request);
     return h.redirect(this.getHref('/exit'));
   }
 

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

@@ -1 +1 @@
-{"version":3,"file":"QuestionPageController.js","names":["ComponentType","ControllerType","Engine","hasComponents","hasNext","hasRepeater","ComponentCollection","optionalText","getCacheService","getErrors","normalisePath","proceed","PageController","FormAction","actionSchema","crumbSchema","paramsSchema","merge","QuestionPageController","collection","errorSummaryTitle","allowSaveAndReturn","constructor","model","pageDef","components","page","formSchema","keys","crumb","action","next","def","filter","path","linkPath","pages","some","pagePath","allowContinue","engine","V2","controller","Terminal","length","getItemId","request","itemId","getFormParams","params","getViewModel","context","viewModel","query","payload","errors","pageTitle","showTitle","formComponents","isFormComponent","fieldset","label","isPageHeading","labelOrLegend","legend","size","classes","isOptional","fields","at","options","required","text","backLink","getBackLink","shouldShowSaveAndReturn","server","getRelevantPath","paths","startPath","getStartPath","relevantPath","getNextPath","evaluationState","summaryPath","getSummaryPath","statusPath","getStatusPath","defaultPath","undefined","pageIndex","indexOf","nextPage","slice","find","condition","conditionResult","fn","nextLink","link","conditions","getFormDataFromState","state","result","validate","abortEarly","stripUnknown","value","getStateFromValidForm","details","getState","cacheService","setState","mergeState","update","updated","filterConditionalComponents","filtered","component","content","type","Details","map","evaluatedComponent","Array","isArray","item","items","makeGetRouteHandler","h","viewName","getViewErrors","hasMissingNotificationEmail","view","isForceAccess","formsService","services","getFormMetadata","includes","notificationEmail","slug","returnUrl","href","backPath","endsWith","getHref","makePostRouteHandler","SaveAndReturn","handleSaveAndReturn","nextPath","nextUrl","redirect","getRouteOptions","ext","onPostHandler","method","_request","continue","postRouteOptions","parse","maxBytes","Number","MAX_SAFE_INTEGER","failAction"],"sources":["../../../../../src/server/plugins/engine/pageControllers/QuestionPageController.ts"],"sourcesContent":["import {\n  ComponentType,\n  ControllerType,\n  Engine,\n  hasComponents,\n  hasNext,\n  hasRepeater,\n  type Link,\n  type Page\n} from '@defra/forms-model'\nimport { type ResponseToolkit, type RouteOptions } from '@hapi/hapi'\nimport { type ValidationErrorItem } from 'joi'\n\nimport { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport { optionalText } from '~/src/server/plugins/engine/components/constants.js'\nimport { type BackLink } from '~/src/server/plugins/engine/components/types.js'\nimport {\n  getCacheService,\n  getErrors,\n  normalisePath,\n  proceed\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type FormContextRequest,\n  type FormPageViewModel,\n  type FormPayload,\n  type FormPayloadParams,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  FormAction,\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs,\n  type FormRequestRefs\n} from '~/src/server/routes/types.js'\nimport {\n  actionSchema,\n  crumbSchema,\n  paramsSchema\n} from '~/src/server/schemas/index.js'\nimport { merge } from '~/src/server/services/cacheService.js'\n\nexport class QuestionPageController extends PageController {\n  collection: ComponentCollection\n  errorSummaryTitle = 'There is a problem'\n  allowSaveAndReturn = true\n\n  constructor(model: FormModel, pageDef: Page) {\n    super(model, pageDef)\n\n    // Components collection\n    this.collection = new ComponentCollection(\n      hasComponents(pageDef) ? pageDef.components : [],\n      { model, page: this }\n    )\n\n    this.collection.formSchema = this.collection.formSchema.keys({\n      crumb: crumbSchema,\n      action: actionSchema\n    })\n  }\n\n  get next(): Link[] {\n    const { def, pageDef } = this\n\n    if (!hasNext(pageDef)) {\n      return []\n    }\n\n    // Remove stale links\n    return pageDef.next.filter(({ path }) => {\n      const linkPath = normalisePath(path)\n\n      return def.pages.some((page) => {\n        const pagePath = normalisePath(page.path)\n        return pagePath === linkPath\n      })\n    })\n  }\n\n  get allowContinue(): boolean {\n    if (this.model.engine === Engine.V2) {\n      return this.pageDef.controller !== ControllerType.Terminal\n    }\n\n    return this.next.length > 0\n  }\n\n  getItemId(request?: FormContextRequest) {\n    const { itemId } = this.getFormParams(request)\n    return itemId ?? request?.params.itemId\n  }\n\n  /**\n   * Used for mapping form payloads and errors to govuk-frontend's template api, so a page can be rendered\n   * @param request - the hapi request\n   * @param context - the form context\n   */\n  getViewModel(\n    request: FormContextRequest,\n    context: FormContext\n  ): FormPageViewModel {\n    const { collection, viewModel } = this\n    const { query } = request\n    const { payload, errors } = context\n\n    let { pageTitle, showTitle } = viewModel\n\n    const components = collection.getViewModel(payload, errors, query)\n    const formComponents = components.filter(\n      ({ isFormComponent }) => isFormComponent\n    )\n\n    // Single form component? Hide title and customise label or legend instead\n    if (formComponents.length === 1) {\n      const { model } = formComponents[0]\n      const { fieldset, label } = model\n\n      // Set as page heading when not following other content\n      const isPageHeading = formComponents[0] === components[0]\n\n      // Check for legend or label\n      const labelOrLegend = fieldset?.legend ?? label\n\n      // Use legend or label as page heading\n      if (labelOrLegend) {\n        const size = isPageHeading ? 'l' : 'm'\n\n        labelOrLegend.classes =\n          labelOrLegend === label\n            ? `govuk-label--${size}`\n            : `govuk-fieldset__legend--${size}`\n\n        if (isPageHeading) {\n          labelOrLegend.isPageHeading = isPageHeading\n\n          // Check for optional in label\n          const isOptional =\n            this.collection.fields.at(0)?.options.required === false\n\n          if (pageTitle) {\n            labelOrLegend.text = isOptional\n              ? `${pageTitle}${optionalText}`\n              : pageTitle\n          }\n\n          pageTitle = pageTitle || labelOrLegend.text\n        }\n      }\n\n      showTitle = !isPageHeading\n    } else if (formComponents.length > 1) {\n      // When there is more than one form component,\n      // adjust the label/legends to give equal prominence\n      for (const { model } of formComponents) {\n        if (model.fieldset?.legend) {\n          model.fieldset.legend.classes = 'govuk-fieldset__legend--m'\n        }\n        if (model.label) {\n          model.label.classes = 'govuk-label--m'\n        }\n      }\n    }\n\n    return {\n      ...viewModel,\n      backLink: this.getBackLink(request, context),\n      context,\n      showTitle,\n      components,\n      errors,\n      allowSaveAndReturn: this.shouldShowSaveAndReturn(request.server)\n    }\n  }\n\n  getRelevantPath(\n    request: FormRequest | FormRequestPayload,\n    context: FormContext\n  ) {\n    const { paths } = context\n\n    const startPath = this.getStartPath()\n    const relevantPath = paths.at(-1) ?? startPath\n\n    return !paths.length\n      ? startPath // First possible path\n      : relevantPath // Last possible path\n  }\n\n  /**\n   * Apply conditions to evaluation state to determine next page path\n   */\n  getNextPath(context: FormContext) {\n    const { model, next, path } = this\n    const { evaluationState } = context\n\n    const summaryPath = this.getSummaryPath()\n    const statusPath = this.getStatusPath()\n\n    // Walk from summary page (no next links) to status page\n    let defaultPath = path === summaryPath ? statusPath : undefined\n\n    if (model.engine === Engine.V2) {\n      if (this.pageDef.controller !== ControllerType.Terminal) {\n        const { pages } = this.model\n        const pageIndex = pages.indexOf(this)\n\n        // The \"next\" page is the first found after the current which is\n        // either unconditional or has a condition that evaluates to \"true\"\n        const nextPage = pages.slice(pageIndex + 1).find((page) => {\n          const { condition } = page\n\n          if (condition) {\n            const conditionResult = condition.fn(evaluationState)\n\n            if (!conditionResult) {\n              return false\n            }\n          }\n\n          return true\n        })\n\n        return nextPage?.path ?? defaultPath\n      } else {\n        return defaultPath\n      }\n    }\n\n    const nextLink = next.find((link) => {\n      const { condition } = link\n\n      if (condition) {\n        return model.conditions[condition]?.fn(evaluationState) ?? false\n      }\n\n      defaultPath = link.path\n      return false\n    })\n\n    return nextLink?.path ?? defaultPath\n  }\n\n  /**\n   * Gets the form payload (from state) for this page only\n   */\n  getFormDataFromState(\n    request: FormContextRequest | undefined,\n    state: FormSubmissionState\n  ): FormPayload {\n    const { collection } = this\n\n    // Form params from request\n    const params = this.getFormParams(request)\n\n    // Form payload from state\n    const payload = collection.getFormDataFromState(state)\n\n    return {\n      ...params,\n      ...payload\n    }\n  }\n\n  /**\n   * Gets form params (from payload) for this page only\n   */\n  getFormParams(request?: FormContextRequest): FormPayloadParams {\n    const { payload } = request ?? {}\n\n    const result = paramsSchema.validate(payload, {\n      abortEarly: false,\n      stripUnknown: true\n    })\n\n    return result.value as FormPayloadParams\n  }\n\n  getStateFromValidForm(\n    request: FormContextRequest,\n    state: FormSubmissionState,\n    payload: FormPayload\n  ): FormState {\n    return this.collection.getStateFromValidForm(payload)\n  }\n\n  getErrors(details?: ValidationErrorItem[]) {\n    return getErrors(details)\n  }\n\n  async getState(request: FormRequest | FormRequestPayload) {\n    const { query } = request\n\n    // Skip get for preview URL direct access\n    if ('force' in query) {\n      return {}\n    }\n\n    const cacheService = getCacheService(request.server)\n\n    return cacheService.getState(request)\n  }\n\n  async setState(\n    request: FormRequest | FormRequestPayload,\n    state: FormSubmissionState\n  ) {\n    const { query } = request\n\n    // Skip set for preview URL direct access\n    if ('force' in query) {\n      return state\n    }\n\n    const cacheService = getCacheService(request.server)\n\n    return cacheService.setState(request, state)\n  }\n\n  async mergeState(\n    request: FormRequest | FormRequestPayload,\n    state: FormSubmissionState,\n    update: object\n  ) {\n    const { query } = request\n\n    // Merge state before set\n    const updated = merge(state, update)\n\n    // Skip set for preview URL direct access\n    if ('force' in query) {\n      return updated\n    }\n\n    const cacheService = getCacheService(request.server)\n\n    return cacheService.setState(request, updated)\n  }\n\n  filterConditionalComponents(\n    viewModel: FormPageViewModel,\n    model: FormModel,\n    evaluationState: Partial<Record<string, FormStateValue>>\n  ) {\n    // Filter our components based on their conditions using our evaluated state\n    let filtered = viewModel.components.filter((component) => {\n      if (\n        (!!component.model.content ||\n          component.type === ComponentType.Details) &&\n        component.model.condition\n      ) {\n        const condition = model.conditions[component.model.condition]\n        return condition?.fn(evaluationState)\n      }\n      return true\n    })\n\n    /**\n     * For conditional reveal components (which we no longer support until GDS resolves the related accessibility issues {@link https://github.com/alphagov/govuk-frontend/issues/1991}\n     */\n    filtered = filtered.map((component) => {\n      const evaluatedComponent = component\n      const content = evaluatedComponent.model.content\n      if (Array.isArray(content)) {\n        evaluatedComponent.model.content = content.filter((item) =>\n          item.condition\n            ? model.conditions[item.condition]?.fn(evaluationState)\n            : true\n        )\n      }\n      // apply condition to items for radios, checkboxes etc\n      const items = evaluatedComponent.model.items\n\n      if (Array.isArray(items)) {\n        evaluatedComponent.model.items = items.filter((item) =>\n          item.condition\n            ? model.conditions[item.condition]?.fn(evaluationState)\n            : true\n        )\n      }\n\n      return evaluatedComponent\n    })\n\n    return filtered\n  }\n\n  makeGetRouteHandler() {\n    return async (\n      request: FormRequest,\n      context: FormContext,\n      h: Pick<ResponseToolkit, 'redirect' | 'view'>\n    ) => {\n      const { collection, model, viewName } = this\n      const { evaluationState } = context\n\n      const viewModel = this.getViewModel(request, context)\n      viewModel.errors = collection.getViewErrors(viewModel.errors)\n\n      /**\n       * Content components can be hidden based on a condition. If the condition evaluates to true, it is safe to be kept, otherwise discard it\n       */\n\n      // Filter our components based on their conditions using our evaluated state\n      viewModel.components = this.filterConditionalComponents(\n        viewModel,\n        model,\n        evaluationState\n      )\n\n      viewModel.hasMissingNotificationEmail =\n        await this.hasMissingNotificationEmail(request, context)\n\n      return h.view(viewName, viewModel)\n    }\n  }\n\n  async hasMissingNotificationEmail(\n    request: FormRequest,\n    context: FormContext\n  ) {\n    const { path } = this\n    const { params } = request\n    const { isForceAccess } = context\n\n    const startPath = this.getStartPath()\n    const summaryPath = this.getSummaryPath()\n    const { formsService } = this.model.services\n    const { getFormMetadata } = formsService\n\n    // Warn the user if the form has no notification email set only on start page and summary page\n    if ([startPath, summaryPath].includes(path) && !isForceAccess) {\n      const { notificationEmail } = await getFormMetadata(params.slug)\n      return !notificationEmail\n    }\n\n    return false\n  }\n\n  /**\n   * Get the back link for a given progress.\n   */\n  protected getBackLink(\n    request: FormContextRequest,\n    context: FormContext\n  ): BackLink | undefined {\n    const { pageDef } = this\n    const { path, query } = request\n    const { returnUrl } = query\n    const { paths } = context\n\n    const itemId = this.getItemId(request)\n\n    // Check answers back link\n    if (returnUrl) {\n      return {\n        text:\n          hasRepeater(pageDef) && itemId\n            ? 'Go back to add another'\n            : 'Go back to check answers',\n        href: returnUrl\n      }\n    }\n\n    // Item delete pages etc\n    const backPath =\n      itemId && !path.endsWith(itemId)\n        ? paths.at(-1) // Back to main page\n        : paths.at(-2) // Back to previous page\n\n    // No back link\n    if (!backPath) {\n      return\n    }\n\n    // Default back link\n    return {\n      text: 'Back',\n      href: this.getHref(backPath)\n    }\n  }\n\n  makePostRouteHandler() {\n    return async (\n      request: FormRequestPayload,\n      context: FormContext,\n      h: Pick<ResponseToolkit, 'redirect' | 'view'>\n    ) => {\n      const { collection, viewName, model } = this\n      const { isForceAccess, state, evaluationState } = context\n\n      /**\n       * If there are any errors, render the page with the parsed errors\n       * @todo Refactor to match POST REDIRECT GET pattern\n       */\n      if (context.errors || isForceAccess) {\n        const viewModel = this.getViewModel(request, context)\n        viewModel.errors = collection.getViewErrors(viewModel.errors)\n\n        // Filter our components based on their conditions using our evaluated state\n        viewModel.components = this.filterConditionalComponents(\n          viewModel,\n          model,\n          evaluationState\n        )\n\n        return h.view(viewName, viewModel)\n      }\n\n      // Check if this is a save-and-return action\n      const { action } = request.payload\n      if (action === FormAction.SaveAndReturn) {\n        return this.handleSaveAndReturn(request, context, h)\n      }\n\n      // Save and proceed\n      await this.setState(request, state)\n      return this.proceed(request, h, this.getNextPath(context))\n    }\n  }\n\n  proceed(\n    request: FormContextRequest,\n    h: Pick<ResponseToolkit, 'redirect' | 'view'>,\n    nextPath?: string\n  ) {\n    const nextUrl = nextPath\n      ? this.getHref(nextPath) // Redirect to next page\n      : this.href // Redirect to current page (refresh)\n\n    return proceed(request, h, nextUrl)\n  }\n\n  /**\n   * Handle save-and-return action by processing form data and redirecting to exit page\n   */\n  async handleSaveAndReturn(\n    request: FormRequestPayload,\n    context: FormContext,\n    h: Pick<ResponseToolkit, 'redirect' | 'view'>\n  ) {\n    const { state } = context\n\n    // Save the current state and redirect to exit page\n    await this.setState(request, state)\n    return h.redirect(this.getHref('/exit'))\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get getRouteOptions(): RouteOptions<FormRequestRefs> {\n    return {\n      ext: {\n        onPostHandler: {\n          method(_request, h) {\n            return h.continue\n          }\n        }\n      }\n    }\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get postRouteOptions(): RouteOptions<FormRequestPayloadRefs> {\n    return {\n      payload: {\n        parse: true,\n        maxBytes: Number.MAX_SAFE_INTEGER,\n        failAction: 'ignore'\n      },\n      ext: {\n        onPostHandler: {\n          method(_request, h) {\n            return h.continue\n          }\n        }\n      }\n    }\n  }\n}\n"],"mappings":"AAAA,SACEA,aAAa,EACbC,cAAc,EACdC,MAAM,EACNC,aAAa,EACbC,OAAO,EACPC,WAAW,QAGN,oBAAoB;AAI3B,SAASC,mBAAmB;AAC5B,SAASC,YAAY;AAErB,SACEC,eAAe,EACfC,SAAS,EACTC,aAAa,EACbC,OAAO;AAGT,SAASC,cAAc;AAWvB,SACEC,UAAU;AAMZ,SACEC,YAAY,EACZC,WAAW,EACXC,YAAY;AAEd,SAASC,KAAK;AAEd,OAAO,MAAMC,sBAAsB,SAASN,cAAc,CAAC;EACzDO,UAAU;EACVC,iBAAiB,GAAG,oBAAoB;EACxCC,kBAAkB,GAAG,IAAI;EAEzBC,WAAWA,CAACC,KAAgB,EAAEC,OAAa,EAAE;IAC3C,KAAK,CAACD,KAAK,EAAEC,OAAO,CAAC;;IAErB;IACA,IAAI,CAACL,UAAU,GAAG,IAAIb,mBAAmB,CACvCH,aAAa,CAACqB,OAAO,CAAC,GAAGA,OAAO,CAACC,UAAU,GAAG,EAAE,EAChD;MAAEF,KAAK;MAAEG,IAAI,EAAE;IAAK,CACtB,CAAC;IAED,IAAI,CAACP,UAAU,CAACQ,UAAU,GAAG,IAAI,CAACR,UAAU,CAACQ,UAAU,CAACC,IAAI,CAAC;MAC3DC,KAAK,EAAEd,WAAW;MAClBe,MAAM,EAAEhB;IACV,CAAC,CAAC;EACJ;EAEA,IAAIiB,IAAIA,CAAA,EAAW;IACjB,MAAM;MAAEC,GAAG;MAAER;IAAQ,CAAC,GAAG,IAAI;IAE7B,IAAI,CAACpB,OAAO,CAACoB,OAAO,CAAC,EAAE;MACrB,OAAO,EAAE;IACX;;IAEA;IACA,OAAOA,OAAO,CAACO,IAAI,CAACE,MAAM,CAAC,CAAC;MAAEC;IAAK,CAAC,KAAK;MACvC,MAAMC,QAAQ,GAAGzB,aAAa,CAACwB,IAAI,CAAC;MAEpC,OAAOF,GAAG,CAACI,KAAK,CAACC,IAAI,CAAEX,IAAI,IAAK;QAC9B,MAAMY,QAAQ,GAAG5B,aAAa,CAACgB,IAAI,CAACQ,IAAI,CAAC;QACzC,OAAOI,QAAQ,KAAKH,QAAQ;MAC9B,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ;EAEA,IAAII,aAAaA,CAAA,EAAY;IAC3B,IAAI,IAAI,CAAChB,KAAK,CAACiB,MAAM,KAAKtC,MAAM,CAACuC,EAAE,EAAE;MACnC,OAAO,IAAI,CAACjB,OAAO,CAACkB,UAAU,KAAKzC,cAAc,CAAC0C,QAAQ;IAC5D;IAEA,OAAO,IAAI,CAACZ,IAAI,CAACa,MAAM,GAAG,CAAC;EAC7B;EAEAC,SAASA,CAACC,OAA4B,EAAE;IACtC,MAAM;MAAEC;IAAO,CAAC,GAAG,IAAI,CAACC,aAAa,CAACF,OAAO,CAAC;IAC9C,OAAOC,MAAM,IAAID,OAAO,EAAEG,MAAM,CAACF,MAAM;EACzC;;EAEA;AACF;AACA;AACA;AACA;EACEG,YAAYA,CACVJ,OAA2B,EAC3BK,OAAoB,EACD;IACnB,MAAM;MAAEhC,UAAU;MAAEiC;IAAU,CAAC,GAAG,IAAI;IACtC,MAAM;MAAEC;IAAM,CAAC,GAAGP,OAAO;IACzB,MAAM;MAAEQ,OAAO;MAAEC;IAAO,CAAC,GAAGJ,OAAO;IAEnC,IAAI;MAAEK,SAAS;MAAEC;IAAU,CAAC,GAAGL,SAAS;IAExC,MAAM3B,UAAU,GAAGN,UAAU,CAAC+B,YAAY,CAACI,OAAO,EAAEC,MAAM,EAAEF,KAAK,CAAC;IAClE,MAAMK,cAAc,GAAGjC,UAAU,CAACQ,MAAM,CACtC,CAAC;MAAE0B;IAAgB,CAAC,KAAKA,eAC3B,CAAC;;IAED;IACA,IAAID,cAAc,CAACd,MAAM,KAAK,CAAC,EAAE;MAC/B,MAAM;QAAErB;MAAM,CAAC,GAAGmC,cAAc,CAAC,CAAC,CAAC;MACnC,MAAM;QAAEE,QAAQ;QAAEC;MAAM,CAAC,GAAGtC,KAAK;;MAEjC;MACA,MAAMuC,aAAa,GAAGJ,cAAc,CAAC,CAAC,CAAC,KAAKjC,UAAU,CAAC,CAAC,CAAC;;MAEzD;MACA,MAAMsC,aAAa,GAAGH,QAAQ,EAAEI,MAAM,IAAIH,KAAK;;MAE/C;MACA,IAAIE,aAAa,EAAE;QACjB,MAAME,IAAI,GAAGH,aAAa,GAAG,GAAG,GAAG,GAAG;QAEtCC,aAAa,CAACG,OAAO,GACnBH,aAAa,KAAKF,KAAK,GACnB,gBAAgBI,IAAI,EAAE,GACtB,2BAA2BA,IAAI,EAAE;QAEvC,IAAIH,aAAa,EAAE;UACjBC,aAAa,CAACD,aAAa,GAAGA,aAAa;;UAE3C;UACA,MAAMK,UAAU,GACd,IAAI,CAAChD,UAAU,CAACiD,MAAM,CAACC,EAAE,CAAC,CAAC,CAAC,EAAEC,OAAO,CAACC,QAAQ,KAAK,KAAK;UAE1D,IAAIf,SAAS,EAAE;YACbO,aAAa,CAACS,IAAI,GAAGL,UAAU,GAC3B,GAAGX,SAAS,GAAGjD,YAAY,EAAE,GAC7BiD,SAAS;UACf;UAEAA,SAAS,GAAGA,SAAS,IAAIO,aAAa,CAACS,IAAI;QAC7C;MACF;MAEAf,SAAS,GAAG,CAACK,aAAa;IAC5B,CAAC,MAAM,IAAIJ,cAAc,CAACd,MAAM,GAAG,CAAC,EAAE;MACpC;MACA;MACA,KAAK,MAAM;QAAErB;MAAM,CAAC,IAAImC,cAAc,EAAE;QACtC,IAAInC,KAAK,CAACqC,QAAQ,EAAEI,MAAM,EAAE;UAC1BzC,KAAK,CAACqC,QAAQ,CAACI,MAAM,CAACE,OAAO,GAAG,2BAA2B;QAC7D;QACA,IAAI3C,KAAK,CAACsC,KAAK,EAAE;UACftC,KAAK,CAACsC,KAAK,CAACK,OAAO,GAAG,gBAAgB;QACxC;MACF;IACF;IAEA,OAAO;MACL,GAAGd,SAAS;MACZqB,QAAQ,EAAE,IAAI,CAACC,WAAW,CAAC5B,OAAO,EAAEK,OAAO,CAAC;MAC5CA,OAAO;MACPM,SAAS;MACThC,UAAU;MACV8B,MAAM;MACNlC,kBAAkB,EAAE,IAAI,CAACsD,uBAAuB,CAAC7B,OAAO,CAAC8B,MAAM;IACjE,CAAC;EACH;EAEAC,eAAeA,CACb/B,OAAyC,EACzCK,OAAoB,EACpB;IACA,MAAM;MAAE2B;IAAM,CAAC,GAAG3B,OAAO;IAEzB,MAAM4B,SAAS,GAAG,IAAI,CAACC,YAAY,CAAC,CAAC;IACrC,MAAMC,YAAY,GAAGH,KAAK,CAACT,EAAE,CAAC,CAAC,CAAC,CAAC,IAAIU,SAAS;IAE9C,OAAO,CAACD,KAAK,CAAClC,MAAM,GAChBmC,SAAS,CAAC;IAAA,EACVE,YAAY,EAAC;EACnB;;EAEA;AACF;AACA;EACEC,WAAWA,CAAC/B,OAAoB,EAAE;IAChC,MAAM;MAAE5B,KAAK;MAAEQ,IAAI;MAAEG;IAAK,CAAC,GAAG,IAAI;IAClC,MAAM;MAAEiD;IAAgB,CAAC,GAAGhC,OAAO;IAEnC,MAAMiC,WAAW,GAAG,IAAI,CAACC,cAAc,CAAC,CAAC;IACzC,MAAMC,UAAU,GAAG,IAAI,CAACC,aAAa,CAAC,CAAC;;IAEvC;IACA,IAAIC,WAAW,GAAGtD,IAAI,KAAKkD,WAAW,GAAGE,UAAU,GAAGG,SAAS;IAE/D,IAAIlE,KAAK,CAACiB,MAAM,KAAKtC,MAAM,CAACuC,EAAE,EAAE;MAC9B,IAAI,IAAI,CAACjB,OAAO,CAACkB,UAAU,KAAKzC,cAAc,CAAC0C,QAAQ,EAAE;QACvD,MAAM;UAAEP;QAAM,CAAC,GAAG,IAAI,CAACb,KAAK;QAC5B,MAAMmE,SAAS,GAAGtD,KAAK,CAACuD,OAAO,CAAC,IAAI,CAAC;;QAErC;QACA;QACA,MAAMC,QAAQ,GAAGxD,KAAK,CAACyD,KAAK,CAACH,SAAS,GAAG,CAAC,CAAC,CAACI,IAAI,CAAEpE,IAAI,IAAK;UACzD,MAAM;YAAEqE;UAAU,CAAC,GAAGrE,IAAI;UAE1B,IAAIqE,SAAS,EAAE;YACb,MAAMC,eAAe,GAAGD,SAAS,CAACE,EAAE,CAACd,eAAe,CAAC;YAErD,IAAI,CAACa,eAAe,EAAE;cACpB,OAAO,KAAK;YACd;UACF;UAEA,OAAO,IAAI;QACb,CAAC,CAAC;QAEF,OAAOJ,QAAQ,EAAE1D,IAAI,IAAIsD,WAAW;MACtC,CAAC,MAAM;QACL,OAAOA,WAAW;MACpB;IACF;IAEA,MAAMU,QAAQ,GAAGnE,IAAI,CAAC+D,IAAI,CAAEK,IAAI,IAAK;MACnC,MAAM;QAAEJ;MAAU,CAAC,GAAGI,IAAI;MAE1B,IAAIJ,SAAS,EAAE;QACb,OAAOxE,KAAK,CAAC6E,UAAU,CAACL,SAAS,CAAC,EAAEE,EAAE,CAACd,eAAe,CAAC,IAAI,KAAK;MAClE;MAEAK,WAAW,GAAGW,IAAI,CAACjE,IAAI;MACvB,OAAO,KAAK;IACd,CAAC,CAAC;IAEF,OAAOgE,QAAQ,EAAEhE,IAAI,IAAIsD,WAAW;EACtC;;EAEA;AACF;AACA;EACEa,oBAAoBA,CAClBvD,OAAuC,EACvCwD,KAA0B,EACb;IACb,MAAM;MAAEnF;IAAW,CAAC,GAAG,IAAI;;IAE3B;IACA,MAAM8B,MAAM,GAAG,IAAI,CAACD,aAAa,CAACF,OAAO,CAAC;;IAE1C;IACA,MAAMQ,OAAO,GAAGnC,UAAU,CAACkF,oBAAoB,CAACC,KAAK,CAAC;IAEtD,OAAO;MACL,GAAGrD,MAAM;MACT,GAAGK;IACL,CAAC;EACH;;EAEA;AACF;AACA;EACEN,aAAaA,CAACF,OAA4B,EAAqB;IAC7D,MAAM;MAAEQ;IAAQ,CAAC,GAAGR,OAAO,IAAI,CAAC,CAAC;IAEjC,MAAMyD,MAAM,GAAGvF,YAAY,CAACwF,QAAQ,CAAClD,OAAO,EAAE;MAC5CmD,UAAU,EAAE,KAAK;MACjBC,YAAY,EAAE;IAChB,CAAC,CAAC;IAEF,OAAOH,MAAM,CAACI,KAAK;EACrB;EAEAC,qBAAqBA,CACnB9D,OAA2B,EAC3BwD,KAA0B,EAC1BhD,OAAoB,EACT;IACX,OAAO,IAAI,CAACnC,UAAU,CAACyF,qBAAqB,CAACtD,OAAO,CAAC;EACvD;EAEA7C,SAASA,CAACoG,OAA+B,EAAE;IACzC,OAAOpG,SAAS,CAACoG,OAAO,CAAC;EAC3B;EAEA,MAAMC,QAAQA,CAAChE,OAAyC,EAAE;IACxD,MAAM;MAAEO;IAAM,CAAC,GAAGP,OAAO;;IAEzB;IACA,IAAI,OAAO,IAAIO,KAAK,EAAE;MACpB,OAAO,CAAC,CAAC;IACX;IAEA,MAAM0D,YAAY,GAAGvG,eAAe,CAACsC,OAAO,CAAC8B,MAAM,CAAC;IAEpD,OAAOmC,YAAY,CAACD,QAAQ,CAAChE,OAAO,CAAC;EACvC;EAEA,MAAMkE,QAAQA,CACZlE,OAAyC,EACzCwD,KAA0B,EAC1B;IACA,MAAM;MAAEjD;IAAM,CAAC,GAAGP,OAAO;;IAEzB;IACA,IAAI,OAAO,IAAIO,KAAK,EAAE;MACpB,OAAOiD,KAAK;IACd;IAEA,MAAMS,YAAY,GAAGvG,eAAe,CAACsC,OAAO,CAAC8B,MAAM,CAAC;IAEpD,OAAOmC,YAAY,CAACC,QAAQ,CAAClE,OAAO,EAAEwD,KAAK,CAAC;EAC9C;EAEA,MAAMW,UAAUA,CACdnE,OAAyC,EACzCwD,KAA0B,EAC1BY,MAAc,EACd;IACA,MAAM;MAAE7D;IAAM,CAAC,GAAGP,OAAO;;IAEzB;IACA,MAAMqE,OAAO,GAAGlG,KAAK,CAACqF,KAAK,EAAEY,MAAM,CAAC;;IAEpC;IACA,IAAI,OAAO,IAAI7D,KAAK,EAAE;MACpB,OAAO8D,OAAO;IAChB;IAEA,MAAMJ,YAAY,GAAGvG,eAAe,CAACsC,OAAO,CAAC8B,MAAM,CAAC;IAEpD,OAAOmC,YAAY,CAACC,QAAQ,CAAClE,OAAO,EAAEqE,OAAO,CAAC;EAChD;EAEAC,2BAA2BA,CACzBhE,SAA4B,EAC5B7B,KAAgB,EAChB4D,eAAwD,EACxD;IACA;IACA,IAAIkC,QAAQ,GAAGjE,SAAS,CAAC3B,UAAU,CAACQ,MAAM,CAAEqF,SAAS,IAAK;MACxD,IACE,CAAC,CAAC,CAACA,SAAS,CAAC/F,KAAK,CAACgG,OAAO,IACxBD,SAAS,CAACE,IAAI,KAAKxH,aAAa,CAACyH,OAAO,KAC1CH,SAAS,CAAC/F,KAAK,CAACwE,SAAS,EACzB;QACA,MAAMA,SAAS,GAAGxE,KAAK,CAAC6E,UAAU,CAACkB,SAAS,CAAC/F,KAAK,CAACwE,SAAS,CAAC;QAC7D,OAAOA,SAAS,EAAEE,EAAE,CAACd,eAAe,CAAC;MACvC;MACA,OAAO,IAAI;IACb,CAAC,CAAC;;IAEF;AACJ;AACA;IACIkC,QAAQ,GAAGA,QAAQ,CAACK,GAAG,CAAEJ,SAAS,IAAK;MACrC,MAAMK,kBAAkB,GAAGL,SAAS;MACpC,MAAMC,OAAO,GAAGI,kBAAkB,CAACpG,KAAK,CAACgG,OAAO;MAChD,IAAIK,KAAK,CAACC,OAAO,CAACN,OAAO,CAAC,EAAE;QAC1BI,kBAAkB,CAACpG,KAAK,CAACgG,OAAO,GAAGA,OAAO,CAACtF,MAAM,CAAE6F,IAAI,IACrDA,IAAI,CAAC/B,SAAS,GACVxE,KAAK,CAAC6E,UAAU,CAAC0B,IAAI,CAAC/B,SAAS,CAAC,EAAEE,EAAE,CAACd,eAAe,CAAC,GACrD,IACN,CAAC;MACH;MACA;MACA,MAAM4C,KAAK,GAAGJ,kBAAkB,CAACpG,KAAK,CAACwG,KAAK;MAE5C,IAAIH,KAAK,CAACC,OAAO,CAACE,KAAK,CAAC,EAAE;QACxBJ,kBAAkB,CAACpG,KAAK,CAACwG,KAAK,GAAGA,KAAK,CAAC9F,MAAM,CAAE6F,IAAI,IACjDA,IAAI,CAAC/B,SAAS,GACVxE,KAAK,CAAC6E,UAAU,CAAC0B,IAAI,CAAC/B,SAAS,CAAC,EAAEE,EAAE,CAACd,eAAe,CAAC,GACrD,IACN,CAAC;MACH;MAEA,OAAOwC,kBAAkB;IAC3B,CAAC,CAAC;IAEF,OAAON,QAAQ;EACjB;EAEAW,mBAAmBA,CAAA,EAAG;IACpB,OAAO,OACLlF,OAAoB,EACpBK,OAAoB,EACpB8E,CAA6C,KAC1C;MACH,MAAM;QAAE9G,UAAU;QAAEI,KAAK;QAAE2G;MAAS,CAAC,GAAG,IAAI;MAC5C,MAAM;QAAE/C;MAAgB,CAAC,GAAGhC,OAAO;MAEnC,MAAMC,SAAS,GAAG,IAAI,CAACF,YAAY,CAACJ,OAAO,EAAEK,OAAO,CAAC;MACrDC,SAAS,CAACG,MAAM,GAAGpC,UAAU,CAACgH,aAAa,CAAC/E,SAAS,CAACG,MAAM,CAAC;;MAE7D;AACN;AACA;;MAEM;MACAH,SAAS,CAAC3B,UAAU,GAAG,IAAI,CAAC2F,2BAA2B,CACrDhE,SAAS,EACT7B,KAAK,EACL4D,eACF,CAAC;MAED/B,SAAS,CAACgF,2BAA2B,GACnC,MAAM,IAAI,CAACA,2BAA2B,CAACtF,OAAO,EAAEK,OAAO,CAAC;MAE1D,OAAO8E,CAAC,CAACI,IAAI,CAACH,QAAQ,EAAE9E,SAAS,CAAC;IACpC,CAAC;EACH;EAEA,MAAMgF,2BAA2BA,CAC/BtF,OAAoB,EACpBK,OAAoB,EACpB;IACA,MAAM;MAAEjB;IAAK,CAAC,GAAG,IAAI;IACrB,MAAM;MAAEe;IAAO,CAAC,GAAGH,OAAO;IAC1B,MAAM;MAAEwF;IAAc,CAAC,GAAGnF,OAAO;IAEjC,MAAM4B,SAAS,GAAG,IAAI,CAACC,YAAY,CAAC,CAAC;IACrC,MAAMI,WAAW,GAAG,IAAI,CAACC,cAAc,CAAC,CAAC;IACzC,MAAM;MAAEkD;IAAa,CAAC,GAAG,IAAI,CAAChH,KAAK,CAACiH,QAAQ;IAC5C,MAAM;MAAEC;IAAgB,CAAC,GAAGF,YAAY;;IAExC;IACA,IAAI,CAACxD,SAAS,EAAEK,WAAW,CAAC,CAACsD,QAAQ,CAACxG,IAAI,CAAC,IAAI,CAACoG,aAAa,EAAE;MAC7D,MAAM;QAAEK;MAAkB,CAAC,GAAG,MAAMF,eAAe,CAACxF,MAAM,CAAC2F,IAAI,CAAC;MAChE,OAAO,CAACD,iBAAiB;IAC3B;IAEA,OAAO,KAAK;EACd;;EAEA;AACF;AACA;EACYjE,WAAWA,CACnB5B,OAA2B,EAC3BK,OAAoB,EACE;IACtB,MAAM;MAAE3B;IAAQ,CAAC,GAAG,IAAI;IACxB,MAAM;MAAEU,IAAI;MAAEmB;IAAM,CAAC,GAAGP,OAAO;IAC/B,MAAM;MAAE+F;IAAU,CAAC,GAAGxF,KAAK;IAC3B,MAAM;MAAEyB;IAAM,CAAC,GAAG3B,OAAO;IAEzB,MAAMJ,MAAM,GAAG,IAAI,CAACF,SAAS,CAACC,OAAO,CAAC;;IAEtC;IACA,IAAI+F,SAAS,EAAE;MACb,OAAO;QACLrE,IAAI,EACFnE,WAAW,CAACmB,OAAO,CAAC,IAAIuB,MAAM,GAC1B,wBAAwB,GACxB,0BAA0B;QAChC+F,IAAI,EAAED;MACR,CAAC;IACH;;IAEA;IACA,MAAME,QAAQ,GACZhG,MAAM,IAAI,CAACb,IAAI,CAAC8G,QAAQ,CAACjG,MAAM,CAAC,GAC5B+B,KAAK,CAACT,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAAA,EACbS,KAAK,CAACT,EAAE,CAAC,CAAC,CAAC,CAAC,EAAC;;IAEnB;IACA,IAAI,CAAC0E,QAAQ,EAAE;MACb;IACF;;IAEA;IACA,OAAO;MACLvE,IAAI,EAAE,MAAM;MACZsE,IAAI,EAAE,IAAI,CAACG,OAAO,CAACF,QAAQ;IAC7B,CAAC;EACH;EAEAG,oBAAoBA,CAAA,EAAG;IACrB,OAAO,OACLpG,OAA2B,EAC3BK,OAAoB,EACpB8E,CAA6C,KAC1C;MACH,MAAM;QAAE9G,UAAU;QAAE+G,QAAQ;QAAE3G;MAAM,CAAC,GAAG,IAAI;MAC5C,MAAM;QAAE+G,aAAa;QAAEhC,KAAK;QAAEnB;MAAgB,CAAC,GAAGhC,OAAO;;MAEzD;AACN;AACA;AACA;MACM,IAAIA,OAAO,CAACI,MAAM,IAAI+E,aAAa,EAAE;QACnC,MAAMlF,SAAS,GAAG,IAAI,CAACF,YAAY,CAACJ,OAAO,EAAEK,OAAO,CAAC;QACrDC,SAAS,CAACG,MAAM,GAAGpC,UAAU,CAACgH,aAAa,CAAC/E,SAAS,CAACG,MAAM,CAAC;;QAE7D;QACAH,SAAS,CAAC3B,UAAU,GAAG,IAAI,CAAC2F,2BAA2B,CACrDhE,SAAS,EACT7B,KAAK,EACL4D,eACF,CAAC;QAED,OAAO8C,CAAC,CAACI,IAAI,CAACH,QAAQ,EAAE9E,SAAS,CAAC;MACpC;;MAEA;MACA,MAAM;QAAEtB;MAAO,CAAC,GAAGgB,OAAO,CAACQ,OAAO;MAClC,IAAIxB,MAAM,KAAKjB,UAAU,CAACsI,aAAa,EAAE;QACvC,OAAO,IAAI,CAACC,mBAAmB,CAACtG,OAAO,EAAEK,OAAO,EAAE8E,CAAC,CAAC;MACtD;;MAEA;MACA,MAAM,IAAI,CAACjB,QAAQ,CAAClE,OAAO,EAAEwD,KAAK,CAAC;MACnC,OAAO,IAAI,CAAC3F,OAAO,CAACmC,OAAO,EAAEmF,CAAC,EAAE,IAAI,CAAC/C,WAAW,CAAC/B,OAAO,CAAC,CAAC;IAC5D,CAAC;EACH;EAEAxC,OAAOA,CACLmC,OAA2B,EAC3BmF,CAA6C,EAC7CoB,QAAiB,EACjB;IACA,MAAMC,OAAO,GAAGD,QAAQ,GACpB,IAAI,CAACJ,OAAO,CAACI,QAAQ,CAAC,CAAC;IAAA,EACvB,IAAI,CAACP,IAAI,EAAC;;IAEd,OAAOnI,OAAO,CAACmC,OAAO,EAAEmF,CAAC,EAAEqB,OAAO,CAAC;EACrC;;EAEA;AACF;AACA;EACE,MAAMF,mBAAmBA,CACvBtG,OAA2B,EAC3BK,OAAoB,EACpB8E,CAA6C,EAC7C;IACA,MAAM;MAAE3B;IAAM,CAAC,GAAGnD,OAAO;;IAEzB;IACA,MAAM,IAAI,CAAC6D,QAAQ,CAAClE,OAAO,EAAEwD,KAAK,CAAC;IACnC,OAAO2B,CAAC,CAACsB,QAAQ,CAAC,IAAI,CAACN,OAAO,CAAC,OAAO,CAAC,CAAC;EAC1C;;EAEA;AACF;AACA;EACE,IAAIO,eAAeA,CAAA,EAAkC;IACnD,OAAO;MACLC,GAAG,EAAE;QACHC,aAAa,EAAE;UACbC,MAAMA,CAACC,QAAQ,EAAE3B,CAAC,EAAE;YAClB,OAAOA,CAAC,CAAC4B,QAAQ;UACnB;QACF;MACF;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACE,IAAIC,gBAAgBA,CAAA,EAAyC;IAC3D,OAAO;MACLxG,OAAO,EAAE;QACPyG,KAAK,EAAE,IAAI;QACXC,QAAQ,EAAEC,MAAM,CAACC,gBAAgB;QACjCC,UAAU,EAAE;MACd,CAAC;MACDV,GAAG,EAAE;QACHC,aAAa,EAAE;UACbC,MAAMA,CAACC,QAAQ,EAAE3B,CAAC,EAAE;YAClB,OAAOA,CAAC,CAAC4B,QAAQ;UACnB;QACF;MACF;IACF,CAAC;EACH;AACF","ignoreList":[]}
+{"version":3,"file":"QuestionPageController.js","names":["ComponentType","ControllerType","Engine","hasComponents","hasNext","hasRepeater","Boom","ComponentCollection","optionalText","getCacheService","getErrors","getSaveAndReturnHelpers","normalisePath","proceed","PageController","FormAction","actionSchema","crumbSchema","paramsSchema","merge","QuestionPageController","collection","errorSummaryTitle","allowSaveAndReturn","constructor","model","pageDef","components","page","formSchema","keys","crumb","action","next","def","filter","path","linkPath","pages","some","pagePath","allowContinue","engine","V2","controller","Terminal","length","getItemId","request","itemId","getFormParams","params","getViewModel","context","viewModel","query","payload","errors","pageTitle","showTitle","formComponents","isFormComponent","fieldset","label","isPageHeading","labelOrLegend","legend","size","classes","isOptional","fields","at","options","required","text","backLink","getBackLink","shouldShowSaveAndReturn","server","getRelevantPath","paths","startPath","getStartPath","relevantPath","getNextPath","evaluationState","summaryPath","getSummaryPath","statusPath","getStatusPath","defaultPath","undefined","pageIndex","indexOf","nextPage","slice","find","condition","conditionResult","fn","nextLink","link","conditions","getFormDataFromState","state","result","validate","abortEarly","stripUnknown","value","getStateFromValidForm","details","getState","cacheService","setState","mergeState","update","updated","filterConditionalComponents","filtered","component","content","type","Details","map","evaluatedComponent","Array","isArray","item","items","makeGetRouteHandler","h","viewName","getViewErrors","hasMissingNotificationEmail","view","isForceAccess","formsService","services","getFormMetadata","includes","notificationEmail","slug","returnUrl","href","backPath","endsWith","getHref","makePostRouteHandler","SaveAndReturn","handleSaveAndReturn","nextPath","nextUrl","saveAndReturn","sessionPersister","internal","clearState","redirect","getRouteOptions","ext","onPostHandler","method","_request","continue","postRouteOptions","parse","maxBytes","Number","MAX_SAFE_INTEGER","failAction"],"sources":["../../../../../src/server/plugins/engine/pageControllers/QuestionPageController.ts"],"sourcesContent":["import {\n  ComponentType,\n  ControllerType,\n  Engine,\n  hasComponents,\n  hasNext,\n  hasRepeater,\n  type Link,\n  type Page\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type ResponseToolkit, type RouteOptions } from '@hapi/hapi'\nimport { type ValidationErrorItem } from 'joi'\n\nimport { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport { optionalText } from '~/src/server/plugins/engine/components/constants.js'\nimport { type BackLink } from '~/src/server/plugins/engine/components/types.js'\nimport {\n  getCacheService,\n  getErrors,\n  getSaveAndReturnHelpers,\n  normalisePath,\n  proceed\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type FormContextRequest,\n  type FormPageViewModel,\n  type FormPayload,\n  type FormPayloadParams,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  FormAction,\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs,\n  type FormRequestRefs\n} from '~/src/server/routes/types.js'\nimport {\n  actionSchema,\n  crumbSchema,\n  paramsSchema\n} from '~/src/server/schemas/index.js'\nimport { merge } from '~/src/server/services/cacheService.js'\n\nexport class QuestionPageController extends PageController {\n  collection: ComponentCollection\n  errorSummaryTitle = 'There is a problem'\n  allowSaveAndReturn = true\n\n  constructor(model: FormModel, pageDef: Page) {\n    super(model, pageDef)\n\n    // Components collection\n    this.collection = new ComponentCollection(\n      hasComponents(pageDef) ? pageDef.components : [],\n      { model, page: this }\n    )\n\n    this.collection.formSchema = this.collection.formSchema.keys({\n      crumb: crumbSchema,\n      action: actionSchema\n    })\n  }\n\n  get next(): Link[] {\n    const { def, pageDef } = this\n\n    if (!hasNext(pageDef)) {\n      return []\n    }\n\n    // Remove stale links\n    return pageDef.next.filter(({ path }) => {\n      const linkPath = normalisePath(path)\n\n      return def.pages.some((page) => {\n        const pagePath = normalisePath(page.path)\n        return pagePath === linkPath\n      })\n    })\n  }\n\n  get allowContinue(): boolean {\n    if (this.model.engine === Engine.V2) {\n      return this.pageDef.controller !== ControllerType.Terminal\n    }\n\n    return this.next.length > 0\n  }\n\n  getItemId(request?: FormContextRequest) {\n    const { itemId } = this.getFormParams(request)\n    return itemId ?? request?.params.itemId\n  }\n\n  /**\n   * Used for mapping form payloads and errors to govuk-frontend's template api, so a page can be rendered\n   * @param request - the hapi request\n   * @param context - the form context\n   */\n  getViewModel(\n    request: FormContextRequest,\n    context: FormContext\n  ): FormPageViewModel {\n    const { collection, viewModel } = this\n    const { query } = request\n    const { payload, errors } = context\n\n    let { pageTitle, showTitle } = viewModel\n\n    const components = collection.getViewModel(payload, errors, query)\n    const formComponents = components.filter(\n      ({ isFormComponent }) => isFormComponent\n    )\n\n    // Single form component? Hide title and customise label or legend instead\n    if (formComponents.length === 1) {\n      const { model } = formComponents[0]\n      const { fieldset, label } = model\n\n      // Set as page heading when not following other content\n      const isPageHeading = formComponents[0] === components[0]\n\n      // Check for legend or label\n      const labelOrLegend = fieldset?.legend ?? label\n\n      // Use legend or label as page heading\n      if (labelOrLegend) {\n        const size = isPageHeading ? 'l' : 'm'\n\n        labelOrLegend.classes =\n          labelOrLegend === label\n            ? `govuk-label--${size}`\n            : `govuk-fieldset__legend--${size}`\n\n        if (isPageHeading) {\n          labelOrLegend.isPageHeading = isPageHeading\n\n          // Check for optional in label\n          const isOptional =\n            this.collection.fields.at(0)?.options.required === false\n\n          if (pageTitle) {\n            labelOrLegend.text = isOptional\n              ? `${pageTitle}${optionalText}`\n              : pageTitle\n          }\n\n          pageTitle = pageTitle || labelOrLegend.text\n        }\n      }\n\n      showTitle = !isPageHeading\n    } else if (formComponents.length > 1) {\n      // When there is more than one form component,\n      // adjust the label/legends to give equal prominence\n      for (const { model } of formComponents) {\n        if (model.fieldset?.legend) {\n          model.fieldset.legend.classes = 'govuk-fieldset__legend--m'\n        }\n        if (model.label) {\n          model.label.classes = 'govuk-label--m'\n        }\n      }\n    }\n\n    return {\n      ...viewModel,\n      backLink: this.getBackLink(request, context),\n      context,\n      showTitle,\n      components,\n      errors,\n      allowSaveAndReturn: this.shouldShowSaveAndReturn(request.server)\n    }\n  }\n\n  getRelevantPath(\n    request: FormRequest | FormRequestPayload,\n    context: FormContext\n  ) {\n    const { paths } = context\n\n    const startPath = this.getStartPath()\n    const relevantPath = paths.at(-1) ?? startPath\n\n    return !paths.length\n      ? startPath // First possible path\n      : relevantPath // Last possible path\n  }\n\n  /**\n   * Apply conditions to evaluation state to determine next page path\n   */\n  getNextPath(context: FormContext) {\n    const { model, next, path } = this\n    const { evaluationState } = context\n\n    const summaryPath = this.getSummaryPath()\n    const statusPath = this.getStatusPath()\n\n    // Walk from summary page (no next links) to status page\n    let defaultPath = path === summaryPath ? statusPath : undefined\n\n    if (model.engine === Engine.V2) {\n      if (this.pageDef.controller !== ControllerType.Terminal) {\n        const { pages } = this.model\n        const pageIndex = pages.indexOf(this)\n\n        // The \"next\" page is the first found after the current which is\n        // either unconditional or has a condition that evaluates to \"true\"\n        const nextPage = pages.slice(pageIndex + 1).find((page) => {\n          const { condition } = page\n\n          if (condition) {\n            const conditionResult = condition.fn(evaluationState)\n\n            if (!conditionResult) {\n              return false\n            }\n          }\n\n          return true\n        })\n\n        return nextPage?.path ?? defaultPath\n      } else {\n        return defaultPath\n      }\n    }\n\n    const nextLink = next.find((link) => {\n      const { condition } = link\n\n      if (condition) {\n        return model.conditions[condition]?.fn(evaluationState) ?? false\n      }\n\n      defaultPath = link.path\n      return false\n    })\n\n    return nextLink?.path ?? defaultPath\n  }\n\n  /**\n   * Gets the form payload (from state) for this page only\n   */\n  getFormDataFromState(\n    request: FormContextRequest | undefined,\n    state: FormSubmissionState\n  ): FormPayload {\n    const { collection } = this\n\n    // Form params from request\n    const params = this.getFormParams(request)\n\n    // Form payload from state\n    const payload = collection.getFormDataFromState(state)\n\n    return {\n      ...params,\n      ...payload\n    }\n  }\n\n  /**\n   * Gets form params (from payload) for this page only\n   */\n  getFormParams(request?: FormContextRequest): FormPayloadParams {\n    const { payload } = request ?? {}\n\n    const result = paramsSchema.validate(payload, {\n      abortEarly: false,\n      stripUnknown: true\n    })\n\n    return result.value as FormPayloadParams\n  }\n\n  getStateFromValidForm(\n    request: FormContextRequest,\n    state: FormSubmissionState,\n    payload: FormPayload\n  ): FormState {\n    return this.collection.getStateFromValidForm(payload)\n  }\n\n  getErrors(details?: ValidationErrorItem[]) {\n    return getErrors(details)\n  }\n\n  async getState(request: FormRequest | FormRequestPayload) {\n    const { query } = request\n\n    // Skip get for preview URL direct access\n    if ('force' in query) {\n      return {}\n    }\n\n    const cacheService = getCacheService(request.server)\n\n    return cacheService.getState(request)\n  }\n\n  async setState(\n    request: FormRequest | FormRequestPayload,\n    state: FormSubmissionState\n  ) {\n    const { query } = request\n\n    // Skip set for preview URL direct access\n    if ('force' in query) {\n      return state\n    }\n\n    const cacheService = getCacheService(request.server)\n\n    return cacheService.setState(request, state)\n  }\n\n  async mergeState(\n    request: FormRequest | FormRequestPayload,\n    state: FormSubmissionState,\n    update: object\n  ) {\n    const { query } = request\n\n    // Merge state before set\n    const updated = merge(state, update)\n\n    // Skip set for preview URL direct access\n    if ('force' in query) {\n      return updated\n    }\n\n    const cacheService = getCacheService(request.server)\n\n    return cacheService.setState(request, updated)\n  }\n\n  filterConditionalComponents(\n    viewModel: FormPageViewModel,\n    model: FormModel,\n    evaluationState: Partial<Record<string, FormStateValue>>\n  ) {\n    // Filter our components based on their conditions using our evaluated state\n    let filtered = viewModel.components.filter((component) => {\n      if (\n        (!!component.model.content ||\n          component.type === ComponentType.Details) &&\n        component.model.condition\n      ) {\n        const condition = model.conditions[component.model.condition]\n        return condition?.fn(evaluationState)\n      }\n      return true\n    })\n\n    /**\n     * For conditional reveal components (which we no longer support until GDS resolves the related accessibility issues {@link https://github.com/alphagov/govuk-frontend/issues/1991}\n     */\n    filtered = filtered.map((component) => {\n      const evaluatedComponent = component\n      const content = evaluatedComponent.model.content\n      if (Array.isArray(content)) {\n        evaluatedComponent.model.content = content.filter((item) =>\n          item.condition\n            ? model.conditions[item.condition]?.fn(evaluationState)\n            : true\n        )\n      }\n      // apply condition to items for radios, checkboxes etc\n      const items = evaluatedComponent.model.items\n\n      if (Array.isArray(items)) {\n        evaluatedComponent.model.items = items.filter((item) =>\n          item.condition\n            ? model.conditions[item.condition]?.fn(evaluationState)\n            : true\n        )\n      }\n\n      return evaluatedComponent\n    })\n\n    return filtered\n  }\n\n  makeGetRouteHandler() {\n    return async (\n      request: FormRequest,\n      context: FormContext,\n      h: Pick<ResponseToolkit, 'redirect' | 'view'>\n    ) => {\n      const { collection, model, viewName } = this\n      const { evaluationState } = context\n\n      const viewModel = this.getViewModel(request, context)\n      viewModel.errors = collection.getViewErrors(viewModel.errors)\n\n      /**\n       * Content components can be hidden based on a condition. If the condition evaluates to true, it is safe to be kept, otherwise discard it\n       */\n\n      // Filter our components based on their conditions using our evaluated state\n      viewModel.components = this.filterConditionalComponents(\n        viewModel,\n        model,\n        evaluationState\n      )\n\n      viewModel.hasMissingNotificationEmail =\n        await this.hasMissingNotificationEmail(request, context)\n\n      return h.view(viewName, viewModel)\n    }\n  }\n\n  async hasMissingNotificationEmail(\n    request: FormRequest,\n    context: FormContext\n  ) {\n    const { path } = this\n    const { params } = request\n    const { isForceAccess } = context\n\n    const startPath = this.getStartPath()\n    const summaryPath = this.getSummaryPath()\n    const { formsService } = this.model.services\n    const { getFormMetadata } = formsService\n\n    // Warn the user if the form has no notification email set only on start page and summary page\n    if ([startPath, summaryPath].includes(path) && !isForceAccess) {\n      const { notificationEmail } = await getFormMetadata(params.slug)\n      return !notificationEmail\n    }\n\n    return false\n  }\n\n  /**\n   * Get the back link for a given progress.\n   */\n  protected getBackLink(\n    request: FormContextRequest,\n    context: FormContext\n  ): BackLink | undefined {\n    const { pageDef } = this\n    const { path, query } = request\n    const { returnUrl } = query\n    const { paths } = context\n\n    const itemId = this.getItemId(request)\n\n    // Check answers back link\n    if (returnUrl) {\n      return {\n        text:\n          hasRepeater(pageDef) && itemId\n            ? 'Go back to add another'\n            : 'Go back to check answers',\n        href: returnUrl\n      }\n    }\n\n    // Item delete pages etc\n    const backPath =\n      itemId && !path.endsWith(itemId)\n        ? paths.at(-1) // Back to main page\n        : paths.at(-2) // Back to previous page\n\n    // No back link\n    if (!backPath) {\n      return\n    }\n\n    // Default back link\n    return {\n      text: 'Back',\n      href: this.getHref(backPath)\n    }\n  }\n\n  makePostRouteHandler() {\n    return async (\n      request: FormRequestPayload,\n      context: FormContext,\n      h: Pick<ResponseToolkit, 'redirect' | 'view'>\n    ) => {\n      const { collection, viewName, model } = this\n      const { isForceAccess, state, evaluationState } = context\n\n      /**\n       * If there are any errors, render the page with the parsed errors\n       * @todo Refactor to match POST REDIRECT GET pattern\n       */\n      if (context.errors || isForceAccess) {\n        const viewModel = this.getViewModel(request, context)\n        viewModel.errors = collection.getViewErrors(viewModel.errors)\n\n        // Filter our components based on their conditions using our evaluated state\n        viewModel.components = this.filterConditionalComponents(\n          viewModel,\n          model,\n          evaluationState\n        )\n\n        return h.view(viewName, viewModel)\n      }\n\n      // Check if this is a save-and-return action\n      const { action } = request.payload\n      if (action === FormAction.SaveAndReturn) {\n        return this.handleSaveAndReturn(request, context, h)\n      }\n\n      // Save and proceed\n      await this.setState(request, state)\n      return this.proceed(request, h, this.getNextPath(context))\n    }\n  }\n\n  proceed(\n    request: FormContextRequest,\n    h: Pick<ResponseToolkit, 'redirect' | 'view'>,\n    nextPath?: string\n  ) {\n    const nextUrl = nextPath\n      ? this.getHref(nextPath) // Redirect to next page\n      : this.href // Redirect to current page (refresh)\n\n    return proceed(request, h, nextUrl)\n  }\n\n  /**\n   * Handle save-and-return action by processing form data and redirecting to exit page\n   */\n  async handleSaveAndReturn(\n    request: FormRequestPayload,\n    context: FormContext,\n    h: Pick<ResponseToolkit, 'redirect' | 'view'>\n  ) {\n    const { state } = context\n\n    // Save the current state and redirect to exit page\n    const saveAndReturn = getSaveAndReturnHelpers(request.server)\n\n    if (!saveAndReturn?.sessionPersister) {\n      throw Boom.internal('Server misconfigured for save and return')\n    }\n\n    await saveAndReturn.sessionPersister(state, request)\n\n    const cacheService = getCacheService(request.server)\n    await cacheService.clearState(request)\n\n    return h.redirect(this.getHref('/exit'))\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get getRouteOptions(): RouteOptions<FormRequestRefs> {\n    return {\n      ext: {\n        onPostHandler: {\n          method(_request, h) {\n            return h.continue\n          }\n        }\n      }\n    }\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get postRouteOptions(): RouteOptions<FormRequestPayloadRefs> {\n    return {\n      payload: {\n        parse: true,\n        maxBytes: Number.MAX_SAFE_INTEGER,\n        failAction: 'ignore'\n      },\n      ext: {\n        onPostHandler: {\n          method(_request, h) {\n            return h.continue\n          }\n        }\n      }\n    }\n  }\n}\n"],"mappings":"AAAA,SACEA,aAAa,EACbC,cAAc,EACdC,MAAM,EACNC,aAAa,EACbC,OAAO,EACPC,WAAW,QAGN,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAI7B,SAASC,mBAAmB;AAC5B,SAASC,YAAY;AAErB,SACEC,eAAe,EACfC,SAAS,EACTC,uBAAuB,EACvBC,aAAa,EACbC,OAAO;AAGT,SAASC,cAAc;AAWvB,SACEC,UAAU;AAMZ,SACEC,YAAY,EACZC,WAAW,EACXC,YAAY;AAEd,SAASC,KAAK;AAEd,OAAO,MAAMC,sBAAsB,SAASN,cAAc,CAAC;EACzDO,UAAU;EACVC,iBAAiB,GAAG,oBAAoB;EACxCC,kBAAkB,GAAG,IAAI;EAEzBC,WAAWA,CAACC,KAAgB,EAAEC,OAAa,EAAE;IAC3C,KAAK,CAACD,KAAK,EAAEC,OAAO,CAAC;;IAErB;IACA,IAAI,CAACL,UAAU,GAAG,IAAId,mBAAmB,CACvCJ,aAAa,CAACuB,OAAO,CAAC,GAAGA,OAAO,CAACC,UAAU,GAAG,EAAE,EAChD;MAAEF,KAAK;MAAEG,IAAI,EAAE;IAAK,CACtB,CAAC;IAED,IAAI,CAACP,UAAU,CAACQ,UAAU,GAAG,IAAI,CAACR,UAAU,CAACQ,UAAU,CAACC,IAAI,CAAC;MAC3DC,KAAK,EAAEd,WAAW;MAClBe,MAAM,EAAEhB;IACV,CAAC,CAAC;EACJ;EAEA,IAAIiB,IAAIA,CAAA,EAAW;IACjB,MAAM;MAAEC,GAAG;MAAER;IAAQ,CAAC,GAAG,IAAI;IAE7B,IAAI,CAACtB,OAAO,CAACsB,OAAO,CAAC,EAAE;MACrB,OAAO,EAAE;IACX;;IAEA;IACA,OAAOA,OAAO,CAACO,IAAI,CAACE,MAAM,CAAC,CAAC;MAAEC;IAAK,CAAC,KAAK;MACvC,MAAMC,QAAQ,GAAGzB,aAAa,CAACwB,IAAI,CAAC;MAEpC,OAAOF,GAAG,CAACI,KAAK,CAACC,IAAI,CAAEX,IAAI,IAAK;QAC9B,MAAMY,QAAQ,GAAG5B,aAAa,CAACgB,IAAI,CAACQ,IAAI,CAAC;QACzC,OAAOI,QAAQ,KAAKH,QAAQ;MAC9B,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ;EAEA,IAAII,aAAaA,CAAA,EAAY;IAC3B,IAAI,IAAI,CAAChB,KAAK,CAACiB,MAAM,KAAKxC,MAAM,CAACyC,EAAE,EAAE;MACnC,OAAO,IAAI,CAACjB,OAAO,CAACkB,UAAU,KAAK3C,cAAc,CAAC4C,QAAQ;IAC5D;IAEA,OAAO,IAAI,CAACZ,IAAI,CAACa,MAAM,GAAG,CAAC;EAC7B;EAEAC,SAASA,CAACC,OAA4B,EAAE;IACtC,MAAM;MAAEC;IAAO,CAAC,GAAG,IAAI,CAACC,aAAa,CAACF,OAAO,CAAC;IAC9C,OAAOC,MAAM,IAAID,OAAO,EAAEG,MAAM,CAACF,MAAM;EACzC;;EAEA;AACF;AACA;AACA;AACA;EACEG,YAAYA,CACVJ,OAA2B,EAC3BK,OAAoB,EACD;IACnB,MAAM;MAAEhC,UAAU;MAAEiC;IAAU,CAAC,GAAG,IAAI;IACtC,MAAM;MAAEC;IAAM,CAAC,GAAGP,OAAO;IACzB,MAAM;MAAEQ,OAAO;MAAEC;IAAO,CAAC,GAAGJ,OAAO;IAEnC,IAAI;MAAEK,SAAS;MAAEC;IAAU,CAAC,GAAGL,SAAS;IAExC,MAAM3B,UAAU,GAAGN,UAAU,CAAC+B,YAAY,CAACI,OAAO,EAAEC,MAAM,EAAEF,KAAK,CAAC;IAClE,MAAMK,cAAc,GAAGjC,UAAU,CAACQ,MAAM,CACtC,CAAC;MAAE0B;IAAgB,CAAC,KAAKA,eAC3B,CAAC;;IAED;IACA,IAAID,cAAc,CAACd,MAAM,KAAK,CAAC,EAAE;MAC/B,MAAM;QAAErB;MAAM,CAAC,GAAGmC,cAAc,CAAC,CAAC,CAAC;MACnC,MAAM;QAAEE,QAAQ;QAAEC;MAAM,CAAC,GAAGtC,KAAK;;MAEjC;MACA,MAAMuC,aAAa,GAAGJ,cAAc,CAAC,CAAC,CAAC,KAAKjC,UAAU,CAAC,CAAC,CAAC;;MAEzD;MACA,MAAMsC,aAAa,GAAGH,QAAQ,EAAEI,MAAM,IAAIH,KAAK;;MAE/C;MACA,IAAIE,aAAa,EAAE;QACjB,MAAME,IAAI,GAAGH,aAAa,GAAG,GAAG,GAAG,GAAG;QAEtCC,aAAa,CAACG,OAAO,GACnBH,aAAa,KAAKF,KAAK,GACnB,gBAAgBI,IAAI,EAAE,GACtB,2BAA2BA,IAAI,EAAE;QAEvC,IAAIH,aAAa,EAAE;UACjBC,aAAa,CAACD,aAAa,GAAGA,aAAa;;UAE3C;UACA,MAAMK,UAAU,GACd,IAAI,CAAChD,UAAU,CAACiD,MAAM,CAACC,EAAE,CAAC,CAAC,CAAC,EAAEC,OAAO,CAACC,QAAQ,KAAK,KAAK;UAE1D,IAAIf,SAAS,EAAE;YACbO,aAAa,CAACS,IAAI,GAAGL,UAAU,GAC3B,GAAGX,SAAS,GAAGlD,YAAY,EAAE,GAC7BkD,SAAS;UACf;UAEAA,SAAS,GAAGA,SAAS,IAAIO,aAAa,CAACS,IAAI;QAC7C;MACF;MAEAf,SAAS,GAAG,CAACK,aAAa;IAC5B,CAAC,MAAM,IAAIJ,cAAc,CAACd,MAAM,GAAG,CAAC,EAAE;MACpC;MACA;MACA,KAAK,MAAM;QAAErB;MAAM,CAAC,IAAImC,cAAc,EAAE;QACtC,IAAInC,KAAK,CAACqC,QAAQ,EAAEI,MAAM,EAAE;UAC1BzC,KAAK,CAACqC,QAAQ,CAACI,MAAM,CAACE,OAAO,GAAG,2BAA2B;QAC7D;QACA,IAAI3C,KAAK,CAACsC,KAAK,EAAE;UACftC,KAAK,CAACsC,KAAK,CAACK,OAAO,GAAG,gBAAgB;QACxC;MACF;IACF;IAEA,OAAO;MACL,GAAGd,SAAS;MACZqB,QAAQ,EAAE,IAAI,CAACC,WAAW,CAAC5B,OAAO,EAAEK,OAAO,CAAC;MAC5CA,OAAO;MACPM,SAAS;MACThC,UAAU;MACV8B,MAAM;MACNlC,kBAAkB,EAAE,IAAI,CAACsD,uBAAuB,CAAC7B,OAAO,CAAC8B,MAAM;IACjE,CAAC;EACH;EAEAC,eAAeA,CACb/B,OAAyC,EACzCK,OAAoB,EACpB;IACA,MAAM;MAAE2B;IAAM,CAAC,GAAG3B,OAAO;IAEzB,MAAM4B,SAAS,GAAG,IAAI,CAACC,YAAY,CAAC,CAAC;IACrC,MAAMC,YAAY,GAAGH,KAAK,CAACT,EAAE,CAAC,CAAC,CAAC,CAAC,IAAIU,SAAS;IAE9C,OAAO,CAACD,KAAK,CAAClC,MAAM,GAChBmC,SAAS,CAAC;IAAA,EACVE,YAAY,EAAC;EACnB;;EAEA;AACF;AACA;EACEC,WAAWA,CAAC/B,OAAoB,EAAE;IAChC,MAAM;MAAE5B,KAAK;MAAEQ,IAAI;MAAEG;IAAK,CAAC,GAAG,IAAI;IAClC,MAAM;MAAEiD;IAAgB,CAAC,GAAGhC,OAAO;IAEnC,MAAMiC,WAAW,GAAG,IAAI,CAACC,cAAc,CAAC,CAAC;IACzC,MAAMC,UAAU,GAAG,IAAI,CAACC,aAAa,CAAC,CAAC;;IAEvC;IACA,IAAIC,WAAW,GAAGtD,IAAI,KAAKkD,WAAW,GAAGE,UAAU,GAAGG,SAAS;IAE/D,IAAIlE,KAAK,CAACiB,MAAM,KAAKxC,MAAM,CAACyC,EAAE,EAAE;MAC9B,IAAI,IAAI,CAACjB,OAAO,CAACkB,UAAU,KAAK3C,cAAc,CAAC4C,QAAQ,EAAE;QACvD,MAAM;UAAEP;QAAM,CAAC,GAAG,IAAI,CAACb,KAAK;QAC5B,MAAMmE,SAAS,GAAGtD,KAAK,CAACuD,OAAO,CAAC,IAAI,CAAC;;QAErC;QACA;QACA,MAAMC,QAAQ,GAAGxD,KAAK,CAACyD,KAAK,CAACH,SAAS,GAAG,CAAC,CAAC,CAACI,IAAI,CAAEpE,IAAI,IAAK;UACzD,MAAM;YAAEqE;UAAU,CAAC,GAAGrE,IAAI;UAE1B,IAAIqE,SAAS,EAAE;YACb,MAAMC,eAAe,GAAGD,SAAS,CAACE,EAAE,CAACd,eAAe,CAAC;YAErD,IAAI,CAACa,eAAe,EAAE;cACpB,OAAO,KAAK;YACd;UACF;UAEA,OAAO,IAAI;QACb,CAAC,CAAC;QAEF,OAAOJ,QAAQ,EAAE1D,IAAI,IAAIsD,WAAW;MACtC,CAAC,MAAM;QACL,OAAOA,WAAW;MACpB;IACF;IAEA,MAAMU,QAAQ,GAAGnE,IAAI,CAAC+D,IAAI,CAAEK,IAAI,IAAK;MACnC,MAAM;QAAEJ;MAAU,CAAC,GAAGI,IAAI;MAE1B,IAAIJ,SAAS,EAAE;QACb,OAAOxE,KAAK,CAAC6E,UAAU,CAACL,SAAS,CAAC,EAAEE,EAAE,CAACd,eAAe,CAAC,IAAI,KAAK;MAClE;MAEAK,WAAW,GAAGW,IAAI,CAACjE,IAAI;MACvB,OAAO,KAAK;IACd,CAAC,CAAC;IAEF,OAAOgE,QAAQ,EAAEhE,IAAI,IAAIsD,WAAW;EACtC;;EAEA;AACF;AACA;EACEa,oBAAoBA,CAClBvD,OAAuC,EACvCwD,KAA0B,EACb;IACb,MAAM;MAAEnF;IAAW,CAAC,GAAG,IAAI;;IAE3B;IACA,MAAM8B,MAAM,GAAG,IAAI,CAACD,aAAa,CAACF,OAAO,CAAC;;IAE1C;IACA,MAAMQ,OAAO,GAAGnC,UAAU,CAACkF,oBAAoB,CAACC,KAAK,CAAC;IAEtD,OAAO;MACL,GAAGrD,MAAM;MACT,GAAGK;IACL,CAAC;EACH;;EAEA;AACF;AACA;EACEN,aAAaA,CAACF,OAA4B,EAAqB;IAC7D,MAAM;MAAEQ;IAAQ,CAAC,GAAGR,OAAO,IAAI,CAAC,CAAC;IAEjC,MAAMyD,MAAM,GAAGvF,YAAY,CAACwF,QAAQ,CAAClD,OAAO,EAAE;MAC5CmD,UAAU,EAAE,KAAK;MACjBC,YAAY,EAAE;IAChB,CAAC,CAAC;IAEF,OAAOH,MAAM,CAACI,KAAK;EACrB;EAEAC,qBAAqBA,CACnB9D,OAA2B,EAC3BwD,KAA0B,EAC1BhD,OAAoB,EACT;IACX,OAAO,IAAI,CAACnC,UAAU,CAACyF,qBAAqB,CAACtD,OAAO,CAAC;EACvD;EAEA9C,SAASA,CAACqG,OAA+B,EAAE;IACzC,OAAOrG,SAAS,CAACqG,OAAO,CAAC;EAC3B;EAEA,MAAMC,QAAQA,CAAChE,OAAyC,EAAE;IACxD,MAAM;MAAEO;IAAM,CAAC,GAAGP,OAAO;;IAEzB;IACA,IAAI,OAAO,IAAIO,KAAK,EAAE;MACpB,OAAO,CAAC,CAAC;IACX;IAEA,MAAM0D,YAAY,GAAGxG,eAAe,CAACuC,OAAO,CAAC8B,MAAM,CAAC;IAEpD,OAAOmC,YAAY,CAACD,QAAQ,CAAChE,OAAO,CAAC;EACvC;EAEA,MAAMkE,QAAQA,CACZlE,OAAyC,EACzCwD,KAA0B,EAC1B;IACA,MAAM;MAAEjD;IAAM,CAAC,GAAGP,OAAO;;IAEzB;IACA,IAAI,OAAO,IAAIO,KAAK,EAAE;MACpB,OAAOiD,KAAK;IACd;IAEA,MAAMS,YAAY,GAAGxG,eAAe,CAACuC,OAAO,CAAC8B,MAAM,CAAC;IAEpD,OAAOmC,YAAY,CAACC,QAAQ,CAAClE,OAAO,EAAEwD,KAAK,CAAC;EAC9C;EAEA,MAAMW,UAAUA,CACdnE,OAAyC,EACzCwD,KAA0B,EAC1BY,MAAc,EACd;IACA,MAAM;MAAE7D;IAAM,CAAC,GAAGP,OAAO;;IAEzB;IACA,MAAMqE,OAAO,GAAGlG,KAAK,CAACqF,KAAK,EAAEY,MAAM,CAAC;;IAEpC;IACA,IAAI,OAAO,IAAI7D,KAAK,EAAE;MACpB,OAAO8D,OAAO;IAChB;IAEA,MAAMJ,YAAY,GAAGxG,eAAe,CAACuC,OAAO,CAAC8B,MAAM,CAAC;IAEpD,OAAOmC,YAAY,CAACC,QAAQ,CAAClE,OAAO,EAAEqE,OAAO,CAAC;EAChD;EAEAC,2BAA2BA,CACzBhE,SAA4B,EAC5B7B,KAAgB,EAChB4D,eAAwD,EACxD;IACA;IACA,IAAIkC,QAAQ,GAAGjE,SAAS,CAAC3B,UAAU,CAACQ,MAAM,CAAEqF,SAAS,IAAK;MACxD,IACE,CAAC,CAAC,CAACA,SAAS,CAAC/F,KAAK,CAACgG,OAAO,IACxBD,SAAS,CAACE,IAAI,KAAK1H,aAAa,CAAC2H,OAAO,KAC1CH,SAAS,CAAC/F,KAAK,CAACwE,SAAS,EACzB;QACA,MAAMA,SAAS,GAAGxE,KAAK,CAAC6E,UAAU,CAACkB,SAAS,CAAC/F,KAAK,CAACwE,SAAS,CAAC;QAC7D,OAAOA,SAAS,EAAEE,EAAE,CAACd,eAAe,CAAC;MACvC;MACA,OAAO,IAAI;IACb,CAAC,CAAC;;IAEF;AACJ;AACA;IACIkC,QAAQ,GAAGA,QAAQ,CAACK,GAAG,CAAEJ,SAAS,IAAK;MACrC,MAAMK,kBAAkB,GAAGL,SAAS;MACpC,MAAMC,OAAO,GAAGI,kBAAkB,CAACpG,KAAK,CAACgG,OAAO;MAChD,IAAIK,KAAK,CAACC,OAAO,CAACN,OAAO,CAAC,EAAE;QAC1BI,kBAAkB,CAACpG,KAAK,CAACgG,OAAO,GAAGA,OAAO,CAACtF,MAAM,CAAE6F,IAAI,IACrDA,IAAI,CAAC/B,SAAS,GACVxE,KAAK,CAAC6E,UAAU,CAAC0B,IAAI,CAAC/B,SAAS,CAAC,EAAEE,EAAE,CAACd,eAAe,CAAC,GACrD,IACN,CAAC;MACH;MACA;MACA,MAAM4C,KAAK,GAAGJ,kBAAkB,CAACpG,KAAK,CAACwG,KAAK;MAE5C,IAAIH,KAAK,CAACC,OAAO,CAACE,KAAK,CAAC,EAAE;QACxBJ,kBAAkB,CAACpG,KAAK,CAACwG,KAAK,GAAGA,KAAK,CAAC9F,MAAM,CAAE6F,IAAI,IACjDA,IAAI,CAAC/B,SAAS,GACVxE,KAAK,CAAC6E,UAAU,CAAC0B,IAAI,CAAC/B,SAAS,CAAC,EAAEE,EAAE,CAACd,eAAe,CAAC,GACrD,IACN,CAAC;MACH;MAEA,OAAOwC,kBAAkB;IAC3B,CAAC,CAAC;IAEF,OAAON,QAAQ;EACjB;EAEAW,mBAAmBA,CAAA,EAAG;IACpB,OAAO,OACLlF,OAAoB,EACpBK,OAAoB,EACpB8E,CAA6C,KAC1C;MACH,MAAM;QAAE9G,UAAU;QAAEI,KAAK;QAAE2G;MAAS,CAAC,GAAG,IAAI;MAC5C,MAAM;QAAE/C;MAAgB,CAAC,GAAGhC,OAAO;MAEnC,MAAMC,SAAS,GAAG,IAAI,CAACF,YAAY,CAACJ,OAAO,EAAEK,OAAO,CAAC;MACrDC,SAAS,CAACG,MAAM,GAAGpC,UAAU,CAACgH,aAAa,CAAC/E,SAAS,CAACG,MAAM,CAAC;;MAE7D;AACN;AACA;;MAEM;MACAH,SAAS,CAAC3B,UAAU,GAAG,IAAI,CAAC2F,2BAA2B,CACrDhE,SAAS,EACT7B,KAAK,EACL4D,eACF,CAAC;MAED/B,SAAS,CAACgF,2BAA2B,GACnC,MAAM,IAAI,CAACA,2BAA2B,CAACtF,OAAO,EAAEK,OAAO,CAAC;MAE1D,OAAO8E,CAAC,CAACI,IAAI,CAACH,QAAQ,EAAE9E,SAAS,CAAC;IACpC,CAAC;EACH;EAEA,MAAMgF,2BAA2BA,CAC/BtF,OAAoB,EACpBK,OAAoB,EACpB;IACA,MAAM;MAAEjB;IAAK,CAAC,GAAG,IAAI;IACrB,MAAM;MAAEe;IAAO,CAAC,GAAGH,OAAO;IAC1B,MAAM;MAAEwF;IAAc,CAAC,GAAGnF,OAAO;IAEjC,MAAM4B,SAAS,GAAG,IAAI,CAACC,YAAY,CAAC,CAAC;IACrC,MAAMI,WAAW,GAAG,IAAI,CAACC,cAAc,CAAC,CAAC;IACzC,MAAM;MAAEkD;IAAa,CAAC,GAAG,IAAI,CAAChH,KAAK,CAACiH,QAAQ;IAC5C,MAAM;MAAEC;IAAgB,CAAC,GAAGF,YAAY;;IAExC;IACA,IAAI,CAACxD,SAAS,EAAEK,WAAW,CAAC,CAACsD,QAAQ,CAACxG,IAAI,CAAC,IAAI,CAACoG,aAAa,EAAE;MAC7D,MAAM;QAAEK;MAAkB,CAAC,GAAG,MAAMF,eAAe,CAACxF,MAAM,CAAC2F,IAAI,CAAC;MAChE,OAAO,CAACD,iBAAiB;IAC3B;IAEA,OAAO,KAAK;EACd;;EAEA;AACF;AACA;EACYjE,WAAWA,CACnB5B,OAA2B,EAC3BK,OAAoB,EACE;IACtB,MAAM;MAAE3B;IAAQ,CAAC,GAAG,IAAI;IACxB,MAAM;MAAEU,IAAI;MAAEmB;IAAM,CAAC,GAAGP,OAAO;IAC/B,MAAM;MAAE+F;IAAU,CAAC,GAAGxF,KAAK;IAC3B,MAAM;MAAEyB;IAAM,CAAC,GAAG3B,OAAO;IAEzB,MAAMJ,MAAM,GAAG,IAAI,CAACF,SAAS,CAACC,OAAO,CAAC;;IAEtC;IACA,IAAI+F,SAAS,EAAE;MACb,OAAO;QACLrE,IAAI,EACFrE,WAAW,CAACqB,OAAO,CAAC,IAAIuB,MAAM,GAC1B,wBAAwB,GACxB,0BAA0B;QAChC+F,IAAI,EAAED;MACR,CAAC;IACH;;IAEA;IACA,MAAME,QAAQ,GACZhG,MAAM,IAAI,CAACb,IAAI,CAAC8G,QAAQ,CAACjG,MAAM,CAAC,GAC5B+B,KAAK,CAACT,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAAA,EACbS,KAAK,CAACT,EAAE,CAAC,CAAC,CAAC,CAAC,EAAC;;IAEnB;IACA,IAAI,CAAC0E,QAAQ,EAAE;MACb;IACF;;IAEA;IACA,OAAO;MACLvE,IAAI,EAAE,MAAM;MACZsE,IAAI,EAAE,IAAI,CAACG,OAAO,CAACF,QAAQ;IAC7B,CAAC;EACH;EAEAG,oBAAoBA,CAAA,EAAG;IACrB,OAAO,OACLpG,OAA2B,EAC3BK,OAAoB,EACpB8E,CAA6C,KAC1C;MACH,MAAM;QAAE9G,UAAU;QAAE+G,QAAQ;QAAE3G;MAAM,CAAC,GAAG,IAAI;MAC5C,MAAM;QAAE+G,aAAa;QAAEhC,KAAK;QAAEnB;MAAgB,CAAC,GAAGhC,OAAO;;MAEzD;AACN;AACA;AACA;MACM,IAAIA,OAAO,CAACI,MAAM,IAAI+E,aAAa,EAAE;QACnC,MAAMlF,SAAS,GAAG,IAAI,CAACF,YAAY,CAACJ,OAAO,EAAEK,OAAO,CAAC;QACrDC,SAAS,CAACG,MAAM,GAAGpC,UAAU,CAACgH,aAAa,CAAC/E,SAAS,CAACG,MAAM,CAAC;;QAE7D;QACAH,SAAS,CAAC3B,UAAU,GAAG,IAAI,CAAC2F,2BAA2B,CACrDhE,SAAS,EACT7B,KAAK,EACL4D,eACF,CAAC;QAED,OAAO8C,CAAC,CAACI,IAAI,CAACH,QAAQ,EAAE9E,SAAS,CAAC;MACpC;;MAEA;MACA,MAAM;QAAEtB;MAAO,CAAC,GAAGgB,OAAO,CAACQ,OAAO;MAClC,IAAIxB,MAAM,KAAKjB,UAAU,CAACsI,aAAa,EAAE;QACvC,OAAO,IAAI,CAACC,mBAAmB,CAACtG,OAAO,EAAEK,OAAO,EAAE8E,CAAC,CAAC;MACtD;;MAEA;MACA,MAAM,IAAI,CAACjB,QAAQ,CAAClE,OAAO,EAAEwD,KAAK,CAAC;MACnC,OAAO,IAAI,CAAC3F,OAAO,CAACmC,OAAO,EAAEmF,CAAC,EAAE,IAAI,CAAC/C,WAAW,CAAC/B,OAAO,CAAC,CAAC;IAC5D,CAAC;EACH;EAEAxC,OAAOA,CACLmC,OAA2B,EAC3BmF,CAA6C,EAC7CoB,QAAiB,EACjB;IACA,MAAMC,OAAO,GAAGD,QAAQ,GACpB,IAAI,CAACJ,OAAO,CAACI,QAAQ,CAAC,CAAC;IAAA,EACvB,IAAI,CAACP,IAAI,EAAC;;IAEd,OAAOnI,OAAO,CAACmC,OAAO,EAAEmF,CAAC,EAAEqB,OAAO,CAAC;EACrC;;EAEA;AACF;AACA;EACE,MAAMF,mBAAmBA,CACvBtG,OAA2B,EAC3BK,OAAoB,EACpB8E,CAA6C,EAC7C;IACA,MAAM;MAAE3B;IAAM,CAAC,GAAGnD,OAAO;;IAEzB;IACA,MAAMoG,aAAa,GAAG9I,uBAAuB,CAACqC,OAAO,CAAC8B,MAAM,CAAC;IAE7D,IAAI,CAAC2E,aAAa,EAAEC,gBAAgB,EAAE;MACpC,MAAMpJ,IAAI,CAACqJ,QAAQ,CAAC,0CAA0C,CAAC;IACjE;IAEA,MAAMF,aAAa,CAACC,gBAAgB,CAAClD,KAAK,EAAExD,OAAO,CAAC;IAEpD,MAAMiE,YAAY,GAAGxG,eAAe,CAACuC,OAAO,CAAC8B,MAAM,CAAC;IACpD,MAAMmC,YAAY,CAAC2C,UAAU,CAAC5G,OAAO,CAAC;IAEtC,OAAOmF,CAAC,CAAC0B,QAAQ,CAAC,IAAI,CAACV,OAAO,CAAC,OAAO,CAAC,CAAC;EAC1C;;EAEA;AACF;AACA;EACE,IAAIW,eAAeA,CAAA,EAAkC;IACnD,OAAO;MACLC,GAAG,EAAE;QACHC,aAAa,EAAE;UACbC,MAAMA,CAACC,QAAQ,EAAE/B,CAAC,EAAE;YAClB,OAAOA,CAAC,CAACgC,QAAQ;UACnB;QACF;MACF;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACE,IAAIC,gBAAgBA,CAAA,EAAyC;IAC3D,OAAO;MACL5G,OAAO,EAAE;QACP6G,KAAK,EAAE,IAAI;QACXC,QAAQ,EAAEC,MAAM,CAACC,gBAAgB;QACjCC,UAAU,EAAE;MACd,CAAC;MACDV,GAAG,EAAE;QACHC,aAAa,EAAE;UACbC,MAAMA,CAACC,QAAQ,EAAE/B,CAAC,EAAE;YAClB,OAAOA,CAAC,CAACgC,QAAQ;UACnB;QACF;MACF;IACF,CAAC;EACH;AACF","ignoreList":[]}

package/.server/server/plugins/engine/plugin.js

@@ -26,8 +26,7 @@ export const plugin = {
       cacheName,
       options: {
         keyGenerator: saveAndReturn?.keyGenerator,
-        sessionHydrator: saveAndReturn?.sessionHydrator,
-        sessionPersister: saveAndReturn?.sessionPersister
+        sessionHydrator: saveAndReturn?.sessionHydrator
       }
     });
     await registerVision(server, options);

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

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","names":["validatePluginOptions","getRoutes","getSaveAndReturnExitRoutes","getFileUploadStatusRoutes","makeLoadFormPreHandler","getQuestionRoutes","getRepeaterItemDeleteRoutes","getRepeaterSummaryRoutes","registerVision","CacheService","plugin","name","dependencies","multiple","register","server","options","model","cacheName","saveAndReturn","nunjucks","nunjucksOptions","viewContext","preparePageEventRequestOptions","cacheService","keyGenerator","sessionHydrator","sessionPersister","expose","baseLayoutPath","app","itemCache","Map","models","loadFormPreHandler","getRouteOptions","pre","method","postRouteOptions","payload","parse","routes","route"],"sources":["../../../../src/server/plugins/engine/plugin.ts"],"sourcesContent":["import {\n  type Lifecycle,\n  type Plugin,\n  type RouteOptions,\n  type Server,\n  type ServerRoute\n} from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { validatePluginOptions } from '~/src/server/plugins/engine/options.js'\nimport { getRoutes as getSaveAndReturnExitRoutes } from '~/src/server/plugins/engine/routes/exit.js'\nimport { getRoutes as getFileUploadStatusRoutes } from '~/src/server/plugins/engine/routes/file-upload.js'\nimport { makeLoadFormPreHandler } from '~/src/server/plugins/engine/routes/index.js'\nimport { getRoutes as getQuestionRoutes } from '~/src/server/plugins/engine/routes/questions.js'\nimport { getRoutes as getRepeaterItemDeleteRoutes } from '~/src/server/plugins/engine/routes/repeaters/item-delete.js'\nimport { getRoutes as getRepeaterSummaryRoutes } from '~/src/server/plugins/engine/routes/repeaters/summary.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\nimport { registerVision } from '~/src/server/plugins/engine/vision.js'\nimport {\n  type FormRequestPayloadRefs,\n  type FormRequestRefs\n} from '~/src/server/routes/types.js'\nimport { CacheService } from '~/src/server/services/index.js'\n\nexport const plugin = {\n  name: '@defra/forms-engine-plugin',\n  dependencies: ['@hapi/crumb', '@hapi/yar', 'hapi-pino'],\n  multiple: true,\n  async register(server: Server, options: PluginOptions) {\n    options = validatePluginOptions(options)\n\n    const {\n      model,\n      cacheName,\n      saveAndReturn,\n      nunjucks: nunjucksOptions,\n      viewContext,\n      preparePageEventRequestOptions\n    } = options\n\n    const cacheService = new CacheService({\n      server,\n      cacheName,\n      options: {\n        keyGenerator: saveAndReturn?.keyGenerator,\n        sessionHydrator: saveAndReturn?.sessionHydrator,\n        sessionPersister: saveAndReturn?.sessionPersister\n      }\n    })\n\n    await registerVision(server, options)\n\n    server.expose('baseLayoutPath', nunjucksOptions.baseLayoutPath)\n    server.expose('viewContext', viewContext)\n    server.expose('cacheService', cacheService)\n    server.expose('saveAndReturn', saveAndReturn)\n\n    server.app.model = model\n\n    // In-memory cache of FormModel items, exposed\n    // (for testing purposes) through `server.app.models`\n    const itemCache = new Map<string, { model: FormModel; updatedAt: Date }>()\n    server.app.models = itemCache\n\n    const loadFormPreHandler = makeLoadFormPreHandler(server, options)\n\n    const getRouteOptions: RouteOptions<FormRequestRefs> = {\n      pre: [\n        {\n          method:\n            loadFormPreHandler as unknown as Lifecycle.Method<FormRequestRefs>\n        }\n      ]\n    }\n\n    const postRouteOptions: RouteOptions<FormRequestPayloadRefs> = {\n      payload: {\n        parse: true\n      },\n      pre: [\n        {\n          method:\n            loadFormPreHandler as unknown as Lifecycle.Method<FormRequestPayloadRefs>\n        }\n      ]\n    }\n\n    const routes = [\n      ...getQuestionRoutes(\n        getRouteOptions,\n        postRouteOptions,\n        preparePageEventRequestOptions\n      ),\n      ...getRepeaterSummaryRoutes(getRouteOptions, postRouteOptions),\n      ...getRepeaterItemDeleteRoutes(getRouteOptions, postRouteOptions),\n      ...getSaveAndReturnExitRoutes(getRouteOptions),\n      ...getFileUploadStatusRoutes()\n    ]\n\n    server.route(routes as unknown as ServerRoute[]) // TODO\n  }\n} satisfies Plugin<PluginOptions>\n"],"mappings":"AASA,SAASA,qBAAqB;AAC9B,SAASC,SAAS,IAAIC,0BAA0B;AAChD,SAASD,SAAS,IAAIE,yBAAyB;AAC/C,SAASC,sBAAsB;AAC/B,SAASH,SAAS,IAAII,iBAAiB;AACvC,SAASJ,SAAS,IAAIK,2BAA2B;AACjD,SAASL,SAAS,IAAIM,wBAAwB;AAE9C,SAASC,cAAc;AAKvB,SAASC,YAAY;AAErB,OAAO,MAAMC,MAAM,GAAG;EACpBC,IAAI,EAAE,4BAA4B;EAClCC,YAAY,EAAE,CAAC,aAAa,EAAE,WAAW,EAAE,WAAW,CAAC;EACvDC,QAAQ,EAAE,IAAI;EACd,MAAMC,QAAQA,CAACC,MAAc,EAAEC,OAAsB,EAAE;IACrDA,OAAO,GAAGhB,qBAAqB,CAACgB,OAAO,CAAC;IAExC,MAAM;MACJC,KAAK;MACLC,SAAS;MACTC,aAAa;MACbC,QAAQ,EAAEC,eAAe;MACzBC,WAAW;MACXC;IACF,CAAC,GAAGP,OAAO;IAEX,MAAMQ,YAAY,GAAG,IAAIf,YAAY,CAAC;MACpCM,MAAM;MACNG,SAAS;MACTF,OAAO,EAAE;QACPS,YAAY,EAAEN,aAAa,EAAEM,YAAY;QACzCC,eAAe,EAAEP,aAAa,EAAEO,eAAe;QAC/CC,gBAAgB,EAAER,aAAa,EAAEQ;MACnC;IACF,CAAC,CAAC;IAEF,MAAMnB,cAAc,CAACO,MAAM,EAAEC,OAAO,CAAC;IAErCD,MAAM,CAACa,MAAM,CAAC,gBAAgB,EAAEP,eAAe,CAACQ,cAAc,CAAC;IAC/Dd,MAAM,CAACa,MAAM,CAAC,aAAa,EAAEN,WAAW,CAAC;IACzCP,MAAM,CAACa,MAAM,CAAC,cAAc,EAAEJ,YAAY,CAAC;IAC3CT,MAAM,CAACa,MAAM,CAAC,eAAe,EAAET,aAAa,CAAC;IAE7CJ,MAAM,CAACe,GAAG,CAACb,KAAK,GAAGA,KAAK;;IAExB;IACA;IACA,MAAMc,SAAS,GAAG,IAAIC,GAAG,CAAgD,CAAC;IAC1EjB,MAAM,CAACe,GAAG,CAACG,MAAM,GAAGF,SAAS;IAE7B,MAAMG,kBAAkB,GAAG9B,sBAAsB,CAACW,MAAM,EAAEC,OAAO,CAAC;IAElE,MAAMmB,eAA8C,GAAG;MACrDC,GAAG,EAAE,CACH;QACEC,MAAM,EACJH;MACJ,CAAC;IAEL,CAAC;IAED,MAAMI,gBAAsD,GAAG;MAC7DC,OAAO,EAAE;QACPC,KAAK,EAAE;MACT,CAAC;MACDJ,GAAG,EAAE,CACH;QACEC,MAAM,EACJH;MACJ,CAAC;IAEL,CAAC;IAED,MAAMO,MAAM,GAAG,CACb,GAAGpC,iBAAiB,CAClB8B,eAAe,EACfG,gBAAgB,EAChBf,8BACF,CAAC,EACD,GAAGhB,wBAAwB,CAAC4B,eAAe,EAAEG,gBAAgB,CAAC,EAC9D,GAAGhC,2BAA2B,CAAC6B,eAAe,EAAEG,gBAAgB,CAAC,EACjE,GAAGpC,0BAA0B,CAACiC,eAAe,CAAC,EAC9C,GAAGhC,yBAAyB,CAAC,CAAC,CAC/B;IAEDY,MAAM,CAAC2B,KAAK,CAACD,MAAkC,CAAC,EAAC;EACnD;AACF,CAAiC","ignoreList":[]}
+{"version":3,"file":"plugin.js","names":["validatePluginOptions","getRoutes","getSaveAndReturnExitRoutes","getFileUploadStatusRoutes","makeLoadFormPreHandler","getQuestionRoutes","getRepeaterItemDeleteRoutes","getRepeaterSummaryRoutes","registerVision","CacheService","plugin","name","dependencies","multiple","register","server","options","model","cacheName","saveAndReturn","nunjucks","nunjucksOptions","viewContext","preparePageEventRequestOptions","cacheService","keyGenerator","sessionHydrator","expose","baseLayoutPath","app","itemCache","Map","models","loadFormPreHandler","getRouteOptions","pre","method","postRouteOptions","payload","parse","routes","route"],"sources":["../../../../src/server/plugins/engine/plugin.ts"],"sourcesContent":["import {\n  type Lifecycle,\n  type Plugin,\n  type RouteOptions,\n  type Server,\n  type ServerRoute\n} from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { validatePluginOptions } from '~/src/server/plugins/engine/options.js'\nimport { getRoutes as getSaveAndReturnExitRoutes } from '~/src/server/plugins/engine/routes/exit.js'\nimport { getRoutes as getFileUploadStatusRoutes } from '~/src/server/plugins/engine/routes/file-upload.js'\nimport { makeLoadFormPreHandler } from '~/src/server/plugins/engine/routes/index.js'\nimport { getRoutes as getQuestionRoutes } from '~/src/server/plugins/engine/routes/questions.js'\nimport { getRoutes as getRepeaterItemDeleteRoutes } from '~/src/server/plugins/engine/routes/repeaters/item-delete.js'\nimport { getRoutes as getRepeaterSummaryRoutes } from '~/src/server/plugins/engine/routes/repeaters/summary.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\nimport { registerVision } from '~/src/server/plugins/engine/vision.js'\nimport {\n  type FormRequestPayloadRefs,\n  type FormRequestRefs\n} from '~/src/server/routes/types.js'\nimport { CacheService } from '~/src/server/services/index.js'\n\nexport const plugin = {\n  name: '@defra/forms-engine-plugin',\n  dependencies: ['@hapi/crumb', '@hapi/yar', 'hapi-pino'],\n  multiple: true,\n  async register(server: Server, options: PluginOptions) {\n    options = validatePluginOptions(options)\n\n    const {\n      model,\n      cacheName,\n      saveAndReturn,\n      nunjucks: nunjucksOptions,\n      viewContext,\n      preparePageEventRequestOptions\n    } = options\n\n    const cacheService = new CacheService({\n      server,\n      cacheName,\n      options: {\n        keyGenerator: saveAndReturn?.keyGenerator,\n        sessionHydrator: saveAndReturn?.sessionHydrator\n      }\n    })\n\n    await registerVision(server, options)\n\n    server.expose('baseLayoutPath', nunjucksOptions.baseLayoutPath)\n    server.expose('viewContext', viewContext)\n    server.expose('cacheService', cacheService)\n    server.expose('saveAndReturn', saveAndReturn)\n\n    server.app.model = model\n\n    // In-memory cache of FormModel items, exposed\n    // (for testing purposes) through `server.app.models`\n    const itemCache = new Map<string, { model: FormModel; updatedAt: Date }>()\n    server.app.models = itemCache\n\n    const loadFormPreHandler = makeLoadFormPreHandler(server, options)\n\n    const getRouteOptions: RouteOptions<FormRequestRefs> = {\n      pre: [\n        {\n          method:\n            loadFormPreHandler as unknown as Lifecycle.Method<FormRequestRefs>\n        }\n      ]\n    }\n\n    const postRouteOptions: RouteOptions<FormRequestPayloadRefs> = {\n      payload: {\n        parse: true\n      },\n      pre: [\n        {\n          method:\n            loadFormPreHandler as unknown as Lifecycle.Method<FormRequestPayloadRefs>\n        }\n      ]\n    }\n\n    const routes = [\n      ...getQuestionRoutes(\n        getRouteOptions,\n        postRouteOptions,\n        preparePageEventRequestOptions\n      ),\n      ...getRepeaterSummaryRoutes(getRouteOptions, postRouteOptions),\n      ...getRepeaterItemDeleteRoutes(getRouteOptions, postRouteOptions),\n      ...getSaveAndReturnExitRoutes(getRouteOptions),\n      ...getFileUploadStatusRoutes()\n    ]\n\n    server.route(routes as unknown as ServerRoute[]) // TODO\n  }\n} satisfies Plugin<PluginOptions>\n"],"mappings":"AASA,SAASA,qBAAqB;AAC9B,SAASC,SAAS,IAAIC,0BAA0B;AAChD,SAASD,SAAS,IAAIE,yBAAyB;AAC/C,SAASC,sBAAsB;AAC/B,SAASH,SAAS,IAAII,iBAAiB;AACvC,SAASJ,SAAS,IAAIK,2BAA2B;AACjD,SAASL,SAAS,IAAIM,wBAAwB;AAE9C,SAASC,cAAc;AAKvB,SAASC,YAAY;AAErB,OAAO,MAAMC,MAAM,GAAG;EACpBC,IAAI,EAAE,4BAA4B;EAClCC,YAAY,EAAE,CAAC,aAAa,EAAE,WAAW,EAAE,WAAW,CAAC;EACvDC,QAAQ,EAAE,IAAI;EACd,MAAMC,QAAQA,CAACC,MAAc,EAAEC,OAAsB,EAAE;IACrDA,OAAO,GAAGhB,qBAAqB,CAACgB,OAAO,CAAC;IAExC,MAAM;MACJC,KAAK;MACLC,SAAS;MACTC,aAAa;MACbC,QAAQ,EAAEC,eAAe;MACzBC,WAAW;MACXC;IACF,CAAC,GAAGP,OAAO;IAEX,MAAMQ,YAAY,GAAG,IAAIf,YAAY,CAAC;MACpCM,MAAM;MACNG,SAAS;MACTF,OAAO,EAAE;QACPS,YAAY,EAAEN,aAAa,EAAEM,YAAY;QACzCC,eAAe,EAAEP,aAAa,EAAEO;MAClC;IACF,CAAC,CAAC;IAEF,MAAMlB,cAAc,CAACO,MAAM,EAAEC,OAAO,CAAC;IAErCD,MAAM,CAACY,MAAM,CAAC,gBAAgB,EAAEN,eAAe,CAACO,cAAc,CAAC;IAC/Db,MAAM,CAACY,MAAM,CAAC,aAAa,EAAEL,WAAW,CAAC;IACzCP,MAAM,CAACY,MAAM,CAAC,cAAc,EAAEH,YAAY,CAAC;IAC3CT,MAAM,CAACY,MAAM,CAAC,eAAe,EAAER,aAAa,CAAC;IAE7CJ,MAAM,CAACc,GAAG,CAACZ,KAAK,GAAGA,KAAK;;IAExB;IACA;IACA,MAAMa,SAAS,GAAG,IAAIC,GAAG,CAAgD,CAAC;IAC1EhB,MAAM,CAACc,GAAG,CAACG,MAAM,GAAGF,SAAS;IAE7B,MAAMG,kBAAkB,GAAG7B,sBAAsB,CAACW,MAAM,EAAEC,OAAO,CAAC;IAElE,MAAMkB,eAA8C,GAAG;MACrDC,GAAG,EAAE,CACH;QACEC,MAAM,EACJH;MACJ,CAAC;IAEL,CAAC;IAED,MAAMI,gBAAsD,GAAG;MAC7DC,OAAO,EAAE;QACPC,KAAK,EAAE;MACT,CAAC;MACDJ,GAAG,EAAE,CACH;QACEC,MAAM,EACJH;MACJ,CAAC;IAEL,CAAC;IAED,MAAMO,MAAM,GAAG,CACb,GAAGnC,iBAAiB,CAClB6B,eAAe,EACfG,gBAAgB,EAChBd,8BACF,CAAC,EACD,GAAGhB,wBAAwB,CAAC2B,eAAe,EAAEG,gBAAgB,CAAC,EAC9D,GAAG/B,2BAA2B,CAAC4B,eAAe,EAAEG,gBAAgB,CAAC,EACjE,GAAGnC,0BAA0B,CAACgC,eAAe,CAAC,EAC9C,GAAG/B,yBAAyB,CAAC,CAAC,CAC/B;IAEDY,MAAM,CAAC0B,KAAK,CAACD,MAAkC,CAAC,EAAC;EACnD;AACF,CAAiC","ignoreList":[]}

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

@@ -273,7 +273,7 @@ export interface PluginOptions {
     saveAndReturn?: {
         keyGenerator: (request: RequestType) => string;
         sessionHydrator: (request: RequestType) => Promise<FormSubmissionState>;
-        sessionPersister: (key: string, state: FormSubmissionState, request: RequestType) => Promise<void>;
+        sessionPersister: (state: FormSubmissionState, request: RequestType) => Promise<void>;
     };
     pluginPath?: string;
     nunjucks: {

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":["UploadStatus","FileStatus"],"sources":["../../../../src/server/plugins/engine/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Event,\n  type FormDefinition,\n  type FormMetadata,\n  type Item,\n  type List,\n  type Page\n} from '@defra/forms-model'\nimport { type PluginProperties, type Request } from '@hapi/hapi'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'\nimport { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'\nimport {\n  type FormAction,\n  type FormParams,\n  type FormRequest,\n  type FormRequestPayload\n} from '~/src/server/routes/types.js'\nimport { type RequestOptions } from '~/src/server/services/httpService.js'\nimport { type Services } from '~/src/server/types.js'\n\ntype RequestType = Request | FormRequest | FormRequestPayload\n\n/**\n * Form submission state stores the following in Redis:\n * Props containing user's submitted values as `{ [inputId]: value }` or as `{ [sectionName]: { [inputName]: value } }`\n *   a) . e.g:\n * ```ts\n *     {\n *       _C9PRHmsgt: 'Ben',\n *       WfLk9McjzX: 'Music',\n *       IK7jkUFCBL: 'Royal Academy of Music'\n *     }\n * ```\n *\n *   b)\n * ```ts\n *   {\n *         checkBeforeYouStart: { ukPassport: true },\n *         applicantDetails: {\n *           numberOfApplicants: 1,\n *           phoneNumber: '77777777',\n *           emailAddress: 'aaa@aaa.com'\n *         },\n *         applicantOneDetails: {\n *           firstName: 'a',\n *           middleName: 'a',\n *           lastName: 'a',\n *           address: { addressLine1: 'a', addressLine2: 'a', town: 'a', postcode: 'a' }\n *         }\n *     }\n * ```\n */\n\n/**\n * Form submission state\n */\nexport type FormSubmissionState = {\n  upload?: Record<string, TempFileState>\n} & FormState\n\nexport interface FormSubmissionError\n  extends Pick<ValidationErrorItem, 'context' | 'path'> {\n  href: string // e.g: '#dateField__day'\n  name: string // e.g: 'dateField__day'\n  text: string // e.g: 'Date field must be a real date'\n}\n\nexport interface FormPayloadParams {\n  action?: FormAction\n  confirm?: true\n  crumb?: string\n  itemId?: string\n}\n\n/**\n * Form POST for question pages\n * (after Joi has converted value types)\n */\nexport type FormPayload = FormPayloadParams & Partial<Record<string, FormValue>>\n\nexport type FormValue =\n  | Item['value']\n  | Item['value'][]\n  | UploadState\n  | RepeatListState\n  | undefined\n\nexport type FormState = Partial<Record<string, FormStateValue>>\nexport type FormStateValue = Exclude<FormValue, undefined> | null\n\nexport interface FormValidationResult<\n  ValueType extends FormPayload | FormSubmissionState\n> {\n  value: ValueType\n  errors: FormSubmissionError[] | undefined\n}\n\nexport interface FormContext {\n  /**\n   * Evaluation form state only (filtered by visited paths),\n   * with values formatted for condition evaluation using\n   * {@link FormComponent.getContextValueFromState}\n   */\n  evaluationState: FormState\n\n  /**\n   * Relevant form state only (filtered by visited paths)\n   */\n  relevantState: FormState\n\n  /**\n   * Relevant pages only (filtered by visited paths)\n   */\n  relevantPages: PageControllerClass[]\n\n  /**\n   * Form submission payload (single page)\n   */\n  payload: FormPayload\n\n  /**\n   * Form submission state (entire form)\n   */\n  state: FormSubmissionState\n\n  /**\n   * Validation errors (entire form)\n   */\n  errors?: FormSubmissionError[]\n\n  /**\n   * Visited paths evaluated from form state\n   */\n  paths: string[]\n\n  /**\n   * Preview URL direct access is allowed\n   */\n  isForceAccess: boolean\n\n  /**\n   * Miscellaneous extra data from event responses\n   */\n  data: object\n\n  pageDefMap: Map<string, Page>\n  listDefMap: Map<string, List>\n  componentDefMap: Map<string, ComponentDef>\n  pageMap: Map<string, PageControllerClass>\n  componentMap: Map<string, Component>\n  referenceNumber: string\n}\n\nexport type FormContextRequest = (\n  | {\n      method: 'get'\n      payload?: undefined\n    }\n  | {\n      method: 'post'\n      payload: FormPayload\n    }\n  | {\n      method: FormRequest['method']\n      payload?: object | undefined\n    }\n) &\n  Pick<\n    FormRequest,\n    'app' | 'method' | 'params' | 'path' | 'query' | 'url' | 'server'\n  >\n\nexport interface UploadInitiateResponse {\n  uploadId: string\n  uploadUrl: string\n  statusUrl: string\n}\n\nexport enum UploadStatus {\n  initiated = 'initiated',\n  pending = 'pending',\n  ready = 'ready'\n}\n\nexport enum FileStatus {\n  complete = 'complete',\n  rejected = 'rejected',\n  pending = 'pending'\n}\n\nexport type UploadState = FileState[]\n\nexport type FileUpload = {\n  fileId: string\n  filename: string\n  contentLength: number\n} & (\n  | {\n      fileStatus: FileStatus.complete | FileStatus.rejected | FileStatus.pending\n      errorMessage?: string\n    }\n  | {\n      fileStatus: FileStatus.complete\n      errorMessage?: undefined\n    }\n)\n\nexport interface FileUploadMetadata {\n  retrievalKey: string\n}\n\nexport type UploadStatusResponse =\n  | {\n      uploadStatus: UploadStatus.initiated\n      metadata: FileUploadMetadata\n      form: { file?: undefined }\n    }\n  | {\n      uploadStatus: UploadStatus.pending | UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles?: number\n    }\n  | {\n      uploadStatus: UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles: 0\n    }\n\nexport type UploadStatusFileResponse = Exclude<\n  UploadStatusResponse,\n  { uploadStatus: UploadStatus.initiated }\n>\n\nexport interface FileState {\n  uploadId: string\n  status: UploadStatusFileResponse\n}\n\nexport interface TempFileState {\n  upload?: UploadInitiateResponse\n  files: UploadState\n}\n\nexport interface RepeatItemState extends FormPayload {\n  itemId: string\n}\n\nexport type RepeatListState = RepeatItemState[]\n\nexport interface CheckAnswers {\n  title?: ComponentText\n  summaryList: SummaryList\n}\n\nexport interface SummaryList {\n  classes?: string\n  rows: SummaryListRow[]\n}\n\nexport interface SummaryListRow {\n  key: ComponentText\n  value: ComponentText\n  actions?: { items: SummaryListAction[] }\n}\n\nexport type SummaryListAction = ComponentText & {\n  href: string\n  visuallyHiddenText: string\n}\n\nexport interface PageViewModelBase extends Partial<ViewContext> {\n  page: PageController\n  name?: string\n  pageTitle: string\n  sectionTitle?: string\n  showTitle: boolean\n  isStartPage: boolean\n  backLink?: BackLink\n  feedbackLink?: string\n  serviceUrl: string\n  phaseTag?: string\n}\n\nexport interface ItemDeletePageViewModel extends PageViewModelBase {\n  context: FormContext\n  itemTitle: string\n  confirmation?: ComponentText\n  buttonConfirm: ComponentText\n  buttonCancel: ComponentText\n}\n\nexport interface FormPageViewModel extends PageViewModelBase {\n  components: ComponentViewModel[]\n  context: FormContext\n  errors?: FormSubmissionError[]\n  hasMissingNotificationEmail?: boolean\n  allowSaveAndReturn: boolean\n}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\n}\n\nexport interface FeaturedFormPageViewModel extends FormPageViewModel {\n  formAction?: string\n  formComponent: ComponentViewModel\n  componentsBefore: ComponentViewModel[]\n  uploadId: string | undefined\n  proxyUrl: string | null\n}\n\nexport type PageViewModel =\n  | PageViewModelBase\n  | ItemDeletePageViewModel\n  | FormPageViewModel\n  | RepeaterSummaryPageViewModel\n  | FeaturedFormPageViewModel\n\nexport type GlobalFunction = (value: unknown) => unknown\nexport type FilterFunction = (value: unknown) => unknown\nexport interface ErrorMessageTemplate {\n  type: string\n  template: JoiExpression\n}\n\nexport interface ErrorMessageTemplateList {\n  baseErrors: ErrorMessageTemplate[]\n  advancedSettingsErrors: ErrorMessageTemplate[]\n}\n\nexport type PreparePageEventRequestOptions = (\n  options: RequestOptions,\n  event: Event,\n  page: PageControllerClass,\n  context: FormContext\n) => void\n\nexport type OnRequestCallback = (\n  request: FormRequest | FormRequestPayload,\n  params: FormParams,\n  definition: FormDefinition,\n  metadata: FormMetadata\n) => void\n\nexport interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cacheName?: string\n  globals?: Record<string, GlobalFunction>\n  filters?: Record<string, FilterFunction>\n  saveAndReturn?: {\n    keyGenerator: (request: RequestType) => string\n    sessionHydrator: (request: RequestType) => Promise<FormSubmissionState>\n    sessionPersister: (\n      key: string,\n      state: FormSubmissionState,\n      request: RequestType\n    ) => Promise<void>\n  }\n  pluginPath?: string\n  nunjucks: {\n    baseLayoutPath: string\n    paths: string[]\n  }\n  viewContext: PluginProperties['forms-engine-plugin']['viewContext']\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  baseUrl: string // base URL of the application, protocol and hostname e.g. \"https://myapp.com\"\n}\n"],"mappings":"AAkCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAmBA;AACA;AACA;AACA;;AAqGA,WAAYA,YAAY,0BAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAA,OAAZA,YAAY;AAAA;AAMxB,WAAYC,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA","ignoreList":[]}
+{"version":3,"file":"types.js","names":["UploadStatus","FileStatus"],"sources":["../../../../src/server/plugins/engine/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Event,\n  type FormDefinition,\n  type FormMetadata,\n  type Item,\n  type List,\n  type Page\n} from '@defra/forms-model'\nimport { type PluginProperties, type Request } from '@hapi/hapi'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'\nimport { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'\nimport {\n  type FormAction,\n  type FormParams,\n  type FormRequest,\n  type FormRequestPayload\n} from '~/src/server/routes/types.js'\nimport { type RequestOptions } from '~/src/server/services/httpService.js'\nimport { type Services } from '~/src/server/types.js'\n\ntype RequestType = Request | FormRequest | FormRequestPayload\n\n/**\n * Form submission state stores the following in Redis:\n * Props containing user's submitted values as `{ [inputId]: value }` or as `{ [sectionName]: { [inputName]: value } }`\n *   a) . e.g:\n * ```ts\n *     {\n *       _C9PRHmsgt: 'Ben',\n *       WfLk9McjzX: 'Music',\n *       IK7jkUFCBL: 'Royal Academy of Music'\n *     }\n * ```\n *\n *   b)\n * ```ts\n *   {\n *         checkBeforeYouStart: { ukPassport: true },\n *         applicantDetails: {\n *           numberOfApplicants: 1,\n *           phoneNumber: '77777777',\n *           emailAddress: 'aaa@aaa.com'\n *         },\n *         applicantOneDetails: {\n *           firstName: 'a',\n *           middleName: 'a',\n *           lastName: 'a',\n *           address: { addressLine1: 'a', addressLine2: 'a', town: 'a', postcode: 'a' }\n *         }\n *     }\n * ```\n */\n\n/**\n * Form submission state\n */\nexport type FormSubmissionState = {\n  upload?: Record<string, TempFileState>\n} & FormState\n\nexport interface FormSubmissionError\n  extends Pick<ValidationErrorItem, 'context' | 'path'> {\n  href: string // e.g: '#dateField__day'\n  name: string // e.g: 'dateField__day'\n  text: string // e.g: 'Date field must be a real date'\n}\n\nexport interface FormPayloadParams {\n  action?: FormAction\n  confirm?: true\n  crumb?: string\n  itemId?: string\n}\n\n/**\n * Form POST for question pages\n * (after Joi has converted value types)\n */\nexport type FormPayload = FormPayloadParams & Partial<Record<string, FormValue>>\n\nexport type FormValue =\n  | Item['value']\n  | Item['value'][]\n  | UploadState\n  | RepeatListState\n  | undefined\n\nexport type FormState = Partial<Record<string, FormStateValue>>\nexport type FormStateValue = Exclude<FormValue, undefined> | null\n\nexport interface FormValidationResult<\n  ValueType extends FormPayload | FormSubmissionState\n> {\n  value: ValueType\n  errors: FormSubmissionError[] | undefined\n}\n\nexport interface FormContext {\n  /**\n   * Evaluation form state only (filtered by visited paths),\n   * with values formatted for condition evaluation using\n   * {@link FormComponent.getContextValueFromState}\n   */\n  evaluationState: FormState\n\n  /**\n   * Relevant form state only (filtered by visited paths)\n   */\n  relevantState: FormState\n\n  /**\n   * Relevant pages only (filtered by visited paths)\n   */\n  relevantPages: PageControllerClass[]\n\n  /**\n   * Form submission payload (single page)\n   */\n  payload: FormPayload\n\n  /**\n   * Form submission state (entire form)\n   */\n  state: FormSubmissionState\n\n  /**\n   * Validation errors (entire form)\n   */\n  errors?: FormSubmissionError[]\n\n  /**\n   * Visited paths evaluated from form state\n   */\n  paths: string[]\n\n  /**\n   * Preview URL direct access is allowed\n   */\n  isForceAccess: boolean\n\n  /**\n   * Miscellaneous extra data from event responses\n   */\n  data: object\n\n  pageDefMap: Map<string, Page>\n  listDefMap: Map<string, List>\n  componentDefMap: Map<string, ComponentDef>\n  pageMap: Map<string, PageControllerClass>\n  componentMap: Map<string, Component>\n  referenceNumber: string\n}\n\nexport type FormContextRequest = (\n  | {\n      method: 'get'\n      payload?: undefined\n    }\n  | {\n      method: 'post'\n      payload: FormPayload\n    }\n  | {\n      method: FormRequest['method']\n      payload?: object | undefined\n    }\n) &\n  Pick<\n    FormRequest,\n    'app' | 'method' | 'params' | 'path' | 'query' | 'url' | 'server'\n  >\n\nexport interface UploadInitiateResponse {\n  uploadId: string\n  uploadUrl: string\n  statusUrl: string\n}\n\nexport enum UploadStatus {\n  initiated = 'initiated',\n  pending = 'pending',\n  ready = 'ready'\n}\n\nexport enum FileStatus {\n  complete = 'complete',\n  rejected = 'rejected',\n  pending = 'pending'\n}\n\nexport type UploadState = FileState[]\n\nexport type FileUpload = {\n  fileId: string\n  filename: string\n  contentLength: number\n} & (\n  | {\n      fileStatus: FileStatus.complete | FileStatus.rejected | FileStatus.pending\n      errorMessage?: string\n    }\n  | {\n      fileStatus: FileStatus.complete\n      errorMessage?: undefined\n    }\n)\n\nexport interface FileUploadMetadata {\n  retrievalKey: string\n}\n\nexport type UploadStatusResponse =\n  | {\n      uploadStatus: UploadStatus.initiated\n      metadata: FileUploadMetadata\n      form: { file?: undefined }\n    }\n  | {\n      uploadStatus: UploadStatus.pending | UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles?: number\n    }\n  | {\n      uploadStatus: UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles: 0\n    }\n\nexport type UploadStatusFileResponse = Exclude<\n  UploadStatusResponse,\n  { uploadStatus: UploadStatus.initiated }\n>\n\nexport interface FileState {\n  uploadId: string\n  status: UploadStatusFileResponse\n}\n\nexport interface TempFileState {\n  upload?: UploadInitiateResponse\n  files: UploadState\n}\n\nexport interface RepeatItemState extends FormPayload {\n  itemId: string\n}\n\nexport type RepeatListState = RepeatItemState[]\n\nexport interface CheckAnswers {\n  title?: ComponentText\n  summaryList: SummaryList\n}\n\nexport interface SummaryList {\n  classes?: string\n  rows: SummaryListRow[]\n}\n\nexport interface SummaryListRow {\n  key: ComponentText\n  value: ComponentText\n  actions?: { items: SummaryListAction[] }\n}\n\nexport type SummaryListAction = ComponentText & {\n  href: string\n  visuallyHiddenText: string\n}\n\nexport interface PageViewModelBase extends Partial<ViewContext> {\n  page: PageController\n  name?: string\n  pageTitle: string\n  sectionTitle?: string\n  showTitle: boolean\n  isStartPage: boolean\n  backLink?: BackLink\n  feedbackLink?: string\n  serviceUrl: string\n  phaseTag?: string\n}\n\nexport interface ItemDeletePageViewModel extends PageViewModelBase {\n  context: FormContext\n  itemTitle: string\n  confirmation?: ComponentText\n  buttonConfirm: ComponentText\n  buttonCancel: ComponentText\n}\n\nexport interface FormPageViewModel extends PageViewModelBase {\n  components: ComponentViewModel[]\n  context: FormContext\n  errors?: FormSubmissionError[]\n  hasMissingNotificationEmail?: boolean\n  allowSaveAndReturn: boolean\n}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\n}\n\nexport interface FeaturedFormPageViewModel extends FormPageViewModel {\n  formAction?: string\n  formComponent: ComponentViewModel\n  componentsBefore: ComponentViewModel[]\n  uploadId: string | undefined\n  proxyUrl: string | null\n}\n\nexport type PageViewModel =\n  | PageViewModelBase\n  | ItemDeletePageViewModel\n  | FormPageViewModel\n  | RepeaterSummaryPageViewModel\n  | FeaturedFormPageViewModel\n\nexport type GlobalFunction = (value: unknown) => unknown\nexport type FilterFunction = (value: unknown) => unknown\nexport interface ErrorMessageTemplate {\n  type: string\n  template: JoiExpression\n}\n\nexport interface ErrorMessageTemplateList {\n  baseErrors: ErrorMessageTemplate[]\n  advancedSettingsErrors: ErrorMessageTemplate[]\n}\n\nexport type PreparePageEventRequestOptions = (\n  options: RequestOptions,\n  event: Event,\n  page: PageControllerClass,\n  context: FormContext\n) => void\n\nexport type OnRequestCallback = (\n  request: FormRequest | FormRequestPayload,\n  params: FormParams,\n  definition: FormDefinition,\n  metadata: FormMetadata\n) => void\n\nexport interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cacheName?: string\n  globals?: Record<string, GlobalFunction>\n  filters?: Record<string, FilterFunction>\n  saveAndReturn?: {\n    keyGenerator: (request: RequestType) => string\n    sessionHydrator: (request: RequestType) => Promise<FormSubmissionState>\n    sessionPersister: (\n      state: FormSubmissionState,\n      request: RequestType\n    ) => Promise<void>\n  }\n  pluginPath?: string\n  nunjucks: {\n    baseLayoutPath: string\n    paths: string[]\n  }\n  viewContext: PluginProperties['forms-engine-plugin']['viewContext']\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  baseUrl: string // base URL of the application, protocol and hostname e.g. \"https://myapp.com\"\n}\n"],"mappings":"AAkCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAmBA;AACA;AACA;AACA;;AAqGA,WAAYA,YAAY,0BAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAA,OAAZA,YAAY;AAAA;AAMxB,WAAYC,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA","ignoreList":[]}

package/.server/server/services/cacheService.d.ts

@@ -14,7 +14,6 @@ export declare class CacheService {
     }>;
     generateKey?: (request: Request | FormRequest | FormRequestPayload) => string;
     customFetcher?: (request: Request | FormRequest | FormRequestPayload) => Promise<FormSubmissionState | null>;
-    customPersister?: (key: string, state: FormSubmissionState, request: Request | FormRequest | FormRequestPayload) => Promise<void>;
     logger: Server['logger'];
     constructor({ server, cacheName, options }: {
         server: Server;
@@ -22,7 +21,6 @@ export declare class CacheService {
         options?: {
             keyGenerator?: (request: Request | FormRequest | FormRequestPayload) => string;
             sessionHydrator?: (request: Request | FormRequest | FormRequestPayload) => Promise<FormSubmissionState | null>;
-            sessionPersister?: (key: string, state: FormSubmissionState, request: Request | FormRequest | FormRequestPayload) => Promise<void>;
         };
     });
     getState(request: Request | FormRequest | FormRequestPayload): Promise<FormSubmissionState>;

package/.server/server/services/cacheService.js

@@ -12,7 +12,6 @@ export class CacheService {
   cache;
   generateKey;
   customFetcher;
-  customPersister;
   logger;
   constructor({
     server,
@@ -21,15 +20,13 @@ export class CacheService {
   }) {
     const {
       keyGenerator,
-      sessionHydrator,
-      sessionPersister
+      sessionHydrator
     } = options ?? {};
     if (!cacheName) {
       server.log('warn', 'You are using the default hapi cache. Please provide a cache name in plugin registration options.');
     }
     this.generateKey = keyGenerator ?? this.defaultKeyGenerator.bind(this);
     this.customFetcher = sessionHydrator ?? undefined;
-    this.customPersister = sessionPersister ?? undefined;
     this.cache = server.cache({
       cache: cacheName,
       segment: 'formSubmission'

package/.server/server/services/cacheService.js.map

@@ -1 +1 @@
-{"version":3,"file":"cacheService.js","names":["Hoek","config","partition","ADDITIONAL_IDENTIFIER","CacheService","cache","generateKey","customFetcher","customPersister","logger","constructor","server","cacheName","options","keyGenerator","sessionHydrator","sessionPersister","log","defaultKeyGenerator","bind","undefined","segment","getState","request","key","Key","cached","get","rehydrated","set","setState","state","ttl","getConfirmationState","Confirmation","value","setConfirmationState","confirmationState","clearState","yar","id","drop","getFlash","messages","flash","Array","isArray","length","at","setFlash","message","Error","params","slug","additionalIdentifier","baseKey","merge","update","mergeArrays"],"sources":["../../../src/server/services/cacheService.ts"],"sourcesContent":["import { type Request, type Server } from '@hapi/hapi'\nimport * as Hoek from '@hapi/hoek'\n\nimport { config } from '~/src/config/index.js'\nimport { type createServer } from '~/src/server/index.js'\nimport {\n  type FormPayload,\n  type FormState,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload\n} from '~/src/server/routes/types.js'\n\nconst partition = 'cache'\n\nexport enum ADDITIONAL_IDENTIFIER {\n  Confirmation = ':confirmation'\n}\n\nexport class CacheService {\n  /**\n   * This service is responsible for getting, storing or deleting a user's session data in the cache. This service has been registered by {@link createServer}\n   */\n  cache\n  generateKey?: (request: Request | FormRequest | FormRequestPayload) => string\n  customFetcher?: (\n    request: Request | FormRequest | FormRequestPayload\n  ) => Promise<FormSubmissionState | null>\n\n  customPersister?: (\n    key: string,\n    state: FormSubmissionState,\n    request: Request | FormRequest | FormRequestPayload\n  ) => Promise<void>\n\n  logger: Server['logger']\n\n  constructor({\n    server,\n    cacheName,\n    options\n  }: {\n    server: Server\n    cacheName?: string\n    options?: {\n      keyGenerator?: (\n        request: Request | FormRequest | FormRequestPayload\n      ) => string\n      sessionHydrator?: (\n        request: Request | FormRequest | FormRequestPayload\n      ) => Promise<FormSubmissionState | null>\n      sessionPersister?: (\n        key: string,\n        state: FormSubmissionState,\n        request: Request | FormRequest | FormRequestPayload\n      ) => Promise<void>\n    }\n  }) {\n    const { keyGenerator, sessionHydrator, sessionPersister } = options ?? {}\n    if (!cacheName) {\n      server.log(\n        'warn',\n        'You are using the default hapi cache. Please provide a cache name in plugin registration options.'\n      )\n    }\n    this.generateKey = keyGenerator ?? this.defaultKeyGenerator.bind(this)\n    this.customFetcher = sessionHydrator ?? undefined\n    this.customPersister = sessionPersister ?? undefined\n    this.cache = server.cache({ cache: cacheName, segment: 'formSubmission' })\n    this.logger = server.logger\n  }\n\n  async getState(\n    request: Request | FormRequest | FormRequestPayload\n  ): Promise<FormSubmissionState> {\n    const key = this.Key(request)\n\n    let cached = await this.cache.get(key)\n\n    // If nothing in Redis, attempt to rehydrate from backend DB\n    if (!cached && this.customFetcher) {\n      const rehydrated = await this.customFetcher(request)\n\n      if (rehydrated != null) {\n        await this.cache.set(key, rehydrated, config.get('sessionTimeout'))\n        cached = await this.getState(request)\n      }\n    }\n\n    return cached ?? {}\n  }\n\n  async setState(\n    request: FormRequest | FormRequestPayload,\n    state: FormSubmissionState\n  ) {\n    const key = this.Key(request)\n    const ttl = config.get('sessionTimeout')\n\n    await this.cache.set(key, state, ttl)\n\n    return this.getState(request)\n  }\n\n  async getConfirmationState(\n    request: FormRequest | FormRequestPayload\n  ): Promise<{ confirmed?: true }> {\n    const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)\n    const value = await this.cache.get(key)\n\n    return value ?? {}\n  }\n\n  async setConfirmationState(\n    request: FormRequest | FormRequestPayload,\n    confirmationState: { confirmed?: true }\n  ) {\n    const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)\n    const ttl = config.get('confirmationSessionTimeout')\n\n    return this.cache.set(key, confirmationState, ttl)\n  }\n\n  async clearState(request: FormRequest | FormRequestPayload) {\n    if (request.yar.id) {\n      await this.cache.drop(this.Key(request))\n    }\n  }\n\n  getFlash(\n    request: FormRequest | FormRequestPayload\n  ): { errors: FormSubmissionError[] } | undefined {\n    const key = this.Key(request)\n    const messages = request.yar.flash(key.id)\n\n    if (Array.isArray(messages) && messages.length) {\n      return messages.at(0) as { errors: FormSubmissionError[] }\n    }\n  }\n\n  setFlash(\n    request: FormRequest | FormRequestPayload,\n    message: { errors: FormSubmissionError[] }\n  ) {\n    const key = this.Key(request)\n\n    request.yar.flash(key.id, message)\n  }\n\n  private defaultKeyGenerator(\n    request: Request | FormRequest | FormRequestPayload\n  ): string {\n    if (!request.yar.id) {\n      throw new Error('No session ID found')\n    }\n\n    const state = (request.params.state as string) || ''\n    const slug = (request.params.slug as string) || ''\n    return `${request.yar.id}:${state}:${slug}:`\n  }\n\n  /**\n   * The key used to store user session data against.\n   * If there are multiple forms on the same runner instance, for example `form-a` and `form-a-feedback` this will prevent CacheService from clearing data from `form-a` if a user gave feedback before they finished `form-a`\n   * @param request - hapi request object\n   * @param additionalIdentifier - appended to the id\n   */\n  Key(\n    request: Request | FormRequest | FormRequestPayload,\n    additionalIdentifier?: ADDITIONAL_IDENTIFIER\n  ) {\n    const baseKey = this.generateKey\n      ? this.generateKey(request)\n      : this.defaultKeyGenerator(request)\n\n    return {\n      segment: partition,\n      id: `${baseKey}${additionalIdentifier ?? ''}`\n    }\n  }\n}\n\n/**\n * State merge helper\n * 1. Merges objects (form fields)\n * 2. Overwrites arrays\n */\nexport function merge<StateType extends FormState | FormPayload>(\n  state: StateType,\n  update: object\n): StateType {\n  return Hoek.merge(state, update, {\n    mergeArrays: false\n  })\n}\n"],"mappings":"AACA,OAAO,KAAKA,IAAI,MAAM,YAAY;AAElC,SAASC,MAAM;AAaf,MAAMC,SAAS,GAAG,OAAO;AAEzB,WAAYC,qBAAqB,0BAArBA,qBAAqB;EAArBA,qBAAqB;EAAA,OAArBA,qBAAqB;AAAA;AAIjC,OAAO,MAAMC,YAAY,CAAC;EACxB;AACF;AACA;EACEC,KAAK;EACLC,WAAW;EACXC,aAAa;EAIbC,eAAe;EAMfC,MAAM;EAENC,WAAWA,CAAC;IACVC,MAAM;IACNC,SAAS;IACTC;EAiBF,CAAC,EAAE;IACD,MAAM;MAAEC,YAAY;MAAEC,eAAe;MAAEC;IAAiB,CAAC,GAAGH,OAAO,IAAI,CAAC,CAAC;IACzE,IAAI,CAACD,SAAS,EAAE;MACdD,MAAM,CAACM,GAAG,CACR,MAAM,EACN,mGACF,CAAC;IACH;IACA,IAAI,CAACX,WAAW,GAAGQ,YAAY,IAAI,IAAI,CAACI,mBAAmB,CAACC,IAAI,CAAC,IAAI,CAAC;IACtE,IAAI,CAACZ,aAAa,GAAGQ,eAAe,IAAIK,SAAS;IACjD,IAAI,CAACZ,eAAe,GAAGQ,gBAAgB,IAAII,SAAS;IACpD,IAAI,CAACf,KAAK,GAAGM,MAAM,CAACN,KAAK,CAAC;MAAEA,KAAK,EAAEO,SAAS;MAAES,OAAO,EAAE;IAAiB,CAAC,CAAC;IAC1E,IAAI,CAACZ,MAAM,GAAGE,MAAM,CAACF,MAAM;EAC7B;EAEA,MAAMa,QAAQA,CACZC,OAAmD,EACrB;IAC9B,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAE7B,IAAIG,MAAM,GAAG,MAAM,IAAI,CAACrB,KAAK,CAACsB,GAAG,CAACH,GAAG,CAAC;;IAEtC;IACA,IAAI,CAACE,MAAM,IAAI,IAAI,CAACnB,aAAa,EAAE;MACjC,MAAMqB,UAAU,GAAG,MAAM,IAAI,CAACrB,aAAa,CAACgB,OAAO,CAAC;MAEpD,IAAIK,UAAU,IAAI,IAAI,EAAE;QACtB,MAAM,IAAI,CAACvB,KAAK,CAACwB,GAAG,CAACL,GAAG,EAAEI,UAAU,EAAE3B,MAAM,CAAC0B,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACnED,MAAM,GAAG,MAAM,IAAI,CAACJ,QAAQ,CAACC,OAAO,CAAC;MACvC;IACF;IAEA,OAAOG,MAAM,IAAI,CAAC,CAAC;EACrB;EAEA,MAAMI,QAAQA,CACZP,OAAyC,EACzCQ,KAA0B,EAC1B;IACA,MAAMP,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMS,GAAG,GAAG/B,MAAM,CAAC0B,GAAG,CAAC,gBAAgB,CAAC;IAExC,MAAM,IAAI,CAACtB,KAAK,CAACwB,GAAG,CAACL,GAAG,EAAEO,KAAK,EAAEC,GAAG,CAAC;IAErC,OAAO,IAAI,CAACV,QAAQ,CAACC,OAAO,CAAC;EAC/B;EAEA,MAAMU,oBAAoBA,CACxBV,OAAyC,EACV;IAC/B,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAEpB,qBAAqB,CAAC+B,YAAY,CAAC;IACjE,MAAMC,KAAK,GAAG,MAAM,IAAI,CAAC9B,KAAK,CAACsB,GAAG,CAACH,GAAG,CAAC;IAEvC,OAAOW,KAAK,IAAI,CAAC,CAAC;EACpB;EAEA,MAAMC,oBAAoBA,CACxBb,OAAyC,EACzCc,iBAAuC,EACvC;IACA,MAAMb,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAEpB,qBAAqB,CAAC+B,YAAY,CAAC;IACjE,MAAMF,GAAG,GAAG/B,MAAM,CAAC0B,GAAG,CAAC,4BAA4B,CAAC;IAEpD,OAAO,IAAI,CAACtB,KAAK,CAACwB,GAAG,CAACL,GAAG,EAAEa,iBAAiB,EAAEL,GAAG,CAAC;EACpD;EAEA,MAAMM,UAAUA,CAACf,OAAyC,EAAE;IAC1D,IAAIA,OAAO,CAACgB,GAAG,CAACC,EAAE,EAAE;MAClB,MAAM,IAAI,CAACnC,KAAK,CAACoC,IAAI,CAAC,IAAI,CAAChB,GAAG,CAACF,OAAO,CAAC,CAAC;IAC1C;EACF;EAEAmB,QAAQA,CACNnB,OAAyC,EACM;IAC/C,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMoB,QAAQ,GAAGpB,OAAO,CAACgB,GAAG,CAACK,KAAK,CAACpB,GAAG,CAACgB,EAAE,CAAC;IAE1C,IAAIK,KAAK,CAACC,OAAO,CAACH,QAAQ,CAAC,IAAIA,QAAQ,CAACI,MAAM,EAAE;MAC9C,OAAOJ,QAAQ,CAACK,EAAE,CAAC,CAAC,CAAC;IACvB;EACF;EAEAC,QAAQA,CACN1B,OAAyC,EACzC2B,OAA0C,EAC1C;IACA,MAAM1B,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAE7BA,OAAO,CAACgB,GAAG,CAACK,KAAK,CAACpB,GAAG,CAACgB,EAAE,EAAEU,OAAO,CAAC;EACpC;EAEQhC,mBAAmBA,CACzBK,OAAmD,EAC3C;IACR,IAAI,CAACA,OAAO,CAACgB,GAAG,CAACC,EAAE,EAAE;MACnB,MAAM,IAAIW,KAAK,CAAC,qBAAqB,CAAC;IACxC;IAEA,MAAMpB,KAAK,GAAIR,OAAO,CAAC6B,MAAM,CAACrB,KAAK,IAAe,EAAE;IACpD,MAAMsB,IAAI,GAAI9B,OAAO,CAAC6B,MAAM,CAACC,IAAI,IAAe,EAAE;IAClD,OAAO,GAAG9B,OAAO,CAACgB,GAAG,CAACC,EAAE,IAAIT,KAAK,IAAIsB,IAAI,GAAG;EAC9C;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE5B,GAAGA,CACDF,OAAmD,EACnD+B,oBAA4C,EAC5C;IACA,MAAMC,OAAO,GAAG,IAAI,CAACjD,WAAW,GAC5B,IAAI,CAACA,WAAW,CAACiB,OAAO,CAAC,GACzB,IAAI,CAACL,mBAAmB,CAACK,OAAO,CAAC;IAErC,OAAO;MACLF,OAAO,EAAEnB,SAAS;MAClBsC,EAAE,EAAE,GAAGe,OAAO,GAAGD,oBAAoB,IAAI,EAAE;IAC7C,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,KAAKA,CACnBzB,KAAgB,EAChB0B,MAAc,EACH;EACX,OAAOzD,IAAI,CAACwD,KAAK,CAACzB,KAAK,EAAE0B,MAAM,EAAE;IAC/BC,WAAW,EAAE;EACf,CAAC,CAAC;AACJ","ignoreList":[]}
+{"version":3,"file":"cacheService.js","names":["Hoek","config","partition","ADDITIONAL_IDENTIFIER","CacheService","cache","generateKey","customFetcher","logger","constructor","server","cacheName","options","keyGenerator","sessionHydrator","log","defaultKeyGenerator","bind","undefined","segment","getState","request","key","Key","cached","get","rehydrated","set","setState","state","ttl","getConfirmationState","Confirmation","value","setConfirmationState","confirmationState","clearState","yar","id","drop","getFlash","messages","flash","Array","isArray","length","at","setFlash","message","Error","params","slug","additionalIdentifier","baseKey","merge","update","mergeArrays"],"sources":["../../../src/server/services/cacheService.ts"],"sourcesContent":["import { type Request, type Server } from '@hapi/hapi'\nimport * as Hoek from '@hapi/hoek'\n\nimport { config } from '~/src/config/index.js'\nimport { type createServer } from '~/src/server/index.js'\nimport {\n  type FormPayload,\n  type FormState,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload\n} from '~/src/server/routes/types.js'\n\nconst partition = 'cache'\n\nexport enum ADDITIONAL_IDENTIFIER {\n  Confirmation = ':confirmation'\n}\n\nexport class CacheService {\n  /**\n   * This service is responsible for getting, storing or deleting a user's session data in the cache. This service has been registered by {@link createServer}\n   */\n  cache\n  generateKey?: (request: Request | FormRequest | FormRequestPayload) => string\n  customFetcher?: (\n    request: Request | FormRequest | FormRequestPayload\n  ) => Promise<FormSubmissionState | null>\n\n  logger: Server['logger']\n\n  constructor({\n    server,\n    cacheName,\n    options\n  }: {\n    server: Server\n    cacheName?: string\n    options?: {\n      keyGenerator?: (\n        request: Request | FormRequest | FormRequestPayload\n      ) => string\n      sessionHydrator?: (\n        request: Request | FormRequest | FormRequestPayload\n      ) => Promise<FormSubmissionState | null>\n    }\n  }) {\n    const { keyGenerator, sessionHydrator } = options ?? {}\n    if (!cacheName) {\n      server.log(\n        'warn',\n        'You are using the default hapi cache. Please provide a cache name in plugin registration options.'\n      )\n    }\n    this.generateKey = keyGenerator ?? this.defaultKeyGenerator.bind(this)\n    this.customFetcher = sessionHydrator ?? undefined\n    this.cache = server.cache({ cache: cacheName, segment: 'formSubmission' })\n    this.logger = server.logger\n  }\n\n  async getState(\n    request: Request | FormRequest | FormRequestPayload\n  ): Promise<FormSubmissionState> {\n    const key = this.Key(request)\n\n    let cached = await this.cache.get(key)\n\n    // If nothing in Redis, attempt to rehydrate from backend DB\n    if (!cached && this.customFetcher) {\n      const rehydrated = await this.customFetcher(request)\n\n      if (rehydrated != null) {\n        await this.cache.set(key, rehydrated, config.get('sessionTimeout'))\n        cached = await this.getState(request)\n      }\n    }\n\n    return cached ?? {}\n  }\n\n  async setState(\n    request: FormRequest | FormRequestPayload,\n    state: FormSubmissionState\n  ) {\n    const key = this.Key(request)\n    const ttl = config.get('sessionTimeout')\n\n    await this.cache.set(key, state, ttl)\n\n    return this.getState(request)\n  }\n\n  async getConfirmationState(\n    request: FormRequest | FormRequestPayload\n  ): Promise<{ confirmed?: true }> {\n    const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)\n    const value = await this.cache.get(key)\n\n    return value ?? {}\n  }\n\n  async setConfirmationState(\n    request: FormRequest | FormRequestPayload,\n    confirmationState: { confirmed?: true }\n  ) {\n    const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)\n    const ttl = config.get('confirmationSessionTimeout')\n\n    return this.cache.set(key, confirmationState, ttl)\n  }\n\n  async clearState(request: FormRequest | FormRequestPayload) {\n    if (request.yar.id) {\n      await this.cache.drop(this.Key(request))\n    }\n  }\n\n  getFlash(\n    request: FormRequest | FormRequestPayload\n  ): { errors: FormSubmissionError[] } | undefined {\n    const key = this.Key(request)\n    const messages = request.yar.flash(key.id)\n\n    if (Array.isArray(messages) && messages.length) {\n      return messages.at(0) as { errors: FormSubmissionError[] }\n    }\n  }\n\n  setFlash(\n    request: FormRequest | FormRequestPayload,\n    message: { errors: FormSubmissionError[] }\n  ) {\n    const key = this.Key(request)\n\n    request.yar.flash(key.id, message)\n  }\n\n  private defaultKeyGenerator(\n    request: Request | FormRequest | FormRequestPayload\n  ): string {\n    if (!request.yar.id) {\n      throw new Error('No session ID found')\n    }\n\n    const state = (request.params.state as string) || ''\n    const slug = (request.params.slug as string) || ''\n    return `${request.yar.id}:${state}:${slug}:`\n  }\n\n  /**\n   * The key used to store user session data against.\n   * If there are multiple forms on the same runner instance, for example `form-a` and `form-a-feedback` this will prevent CacheService from clearing data from `form-a` if a user gave feedback before they finished `form-a`\n   * @param request - hapi request object\n   * @param additionalIdentifier - appended to the id\n   */\n  Key(\n    request: Request | FormRequest | FormRequestPayload,\n    additionalIdentifier?: ADDITIONAL_IDENTIFIER\n  ) {\n    const baseKey = this.generateKey\n      ? this.generateKey(request)\n      : this.defaultKeyGenerator(request)\n\n    return {\n      segment: partition,\n      id: `${baseKey}${additionalIdentifier ?? ''}`\n    }\n  }\n}\n\n/**\n * State merge helper\n * 1. Merges objects (form fields)\n * 2. Overwrites arrays\n */\nexport function merge<StateType extends FormState | FormPayload>(\n  state: StateType,\n  update: object\n): StateType {\n  return Hoek.merge(state, update, {\n    mergeArrays: false\n  })\n}\n"],"mappings":"AACA,OAAO,KAAKA,IAAI,MAAM,YAAY;AAElC,SAASC,MAAM;AAaf,MAAMC,SAAS,GAAG,OAAO;AAEzB,WAAYC,qBAAqB,0BAArBA,qBAAqB;EAArBA,qBAAqB;EAAA,OAArBA,qBAAqB;AAAA;AAIjC,OAAO,MAAMC,YAAY,CAAC;EACxB;AACF;AACA;EACEC,KAAK;EACLC,WAAW;EACXC,aAAa;EAIbC,MAAM;EAENC,WAAWA,CAAC;IACVC,MAAM;IACNC,SAAS;IACTC;EAYF,CAAC,EAAE;IACD,MAAM;MAAEC,YAAY;MAAEC;IAAgB,CAAC,GAAGF,OAAO,IAAI,CAAC,CAAC;IACvD,IAAI,CAACD,SAAS,EAAE;MACdD,MAAM,CAACK,GAAG,CACR,MAAM,EACN,mGACF,CAAC;IACH;IACA,IAAI,CAACT,WAAW,GAAGO,YAAY,IAAI,IAAI,CAACG,mBAAmB,CAACC,IAAI,CAAC,IAAI,CAAC;IACtE,IAAI,CAACV,aAAa,GAAGO,eAAe,IAAII,SAAS;IACjD,IAAI,CAACb,KAAK,GAAGK,MAAM,CAACL,KAAK,CAAC;MAAEA,KAAK,EAAEM,SAAS;MAAEQ,OAAO,EAAE;IAAiB,CAAC,CAAC;IAC1E,IAAI,CAACX,MAAM,GAAGE,MAAM,CAACF,MAAM;EAC7B;EAEA,MAAMY,QAAQA,CACZC,OAAmD,EACrB;IAC9B,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAE7B,IAAIG,MAAM,GAAG,MAAM,IAAI,CAACnB,KAAK,CAACoB,GAAG,CAACH,GAAG,CAAC;;IAEtC;IACA,IAAI,CAACE,MAAM,IAAI,IAAI,CAACjB,aAAa,EAAE;MACjC,MAAMmB,UAAU,GAAG,MAAM,IAAI,CAACnB,aAAa,CAACc,OAAO,CAAC;MAEpD,IAAIK,UAAU,IAAI,IAAI,EAAE;QACtB,MAAM,IAAI,CAACrB,KAAK,CAACsB,GAAG,CAACL,GAAG,EAAEI,UAAU,EAAEzB,MAAM,CAACwB,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACnED,MAAM,GAAG,MAAM,IAAI,CAACJ,QAAQ,CAACC,OAAO,CAAC;MACvC;IACF;IAEA,OAAOG,MAAM,IAAI,CAAC,CAAC;EACrB;EAEA,MAAMI,QAAQA,CACZP,OAAyC,EACzCQ,KAA0B,EAC1B;IACA,MAAMP,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMS,GAAG,GAAG7B,MAAM,CAACwB,GAAG,CAAC,gBAAgB,CAAC;IAExC,MAAM,IAAI,CAACpB,KAAK,CAACsB,GAAG,CAACL,GAAG,EAAEO,KAAK,EAAEC,GAAG,CAAC;IAErC,OAAO,IAAI,CAACV,QAAQ,CAACC,OAAO,CAAC;EAC/B;EAEA,MAAMU,oBAAoBA,CACxBV,OAAyC,EACV;IAC/B,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAElB,qBAAqB,CAAC6B,YAAY,CAAC;IACjE,MAAMC,KAAK,GAAG,MAAM,IAAI,CAAC5B,KAAK,CAACoB,GAAG,CAACH,GAAG,CAAC;IAEvC,OAAOW,KAAK,IAAI,CAAC,CAAC;EACpB;EAEA,MAAMC,oBAAoBA,CACxBb,OAAyC,EACzCc,iBAAuC,EACvC;IACA,MAAMb,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAElB,qBAAqB,CAAC6B,YAAY,CAAC;IACjE,MAAMF,GAAG,GAAG7B,MAAM,CAACwB,GAAG,CAAC,4BAA4B,CAAC;IAEpD,OAAO,IAAI,CAACpB,KAAK,CAACsB,GAAG,CAACL,GAAG,EAAEa,iBAAiB,EAAEL,GAAG,CAAC;EACpD;EAEA,MAAMM,UAAUA,CAACf,OAAyC,EAAE;IAC1D,IAAIA,OAAO,CAACgB,GAAG,CAACC,EAAE,EAAE;MAClB,MAAM,IAAI,CAACjC,KAAK,CAACkC,IAAI,CAAC,IAAI,CAAChB,GAAG,CAACF,OAAO,CAAC,CAAC;IAC1C;EACF;EAEAmB,QAAQA,CACNnB,OAAyC,EACM;IAC/C,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMoB,QAAQ,GAAGpB,OAAO,CAACgB,GAAG,CAACK,KAAK,CAACpB,GAAG,CAACgB,EAAE,CAAC;IAE1C,IAAIK,KAAK,CAACC,OAAO,CAACH,QAAQ,CAAC,IAAIA,QAAQ,CAACI,MAAM,EAAE;MAC9C,OAAOJ,QAAQ,CAACK,EAAE,CAAC,CAAC,CAAC;IACvB;EACF;EAEAC,QAAQA,CACN1B,OAAyC,EACzC2B,OAA0C,EAC1C;IACA,MAAM1B,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAE7BA,OAAO,CAACgB,GAAG,CAACK,KAAK,CAACpB,GAAG,CAACgB,EAAE,EAAEU,OAAO,CAAC;EACpC;EAEQhC,mBAAmBA,CACzBK,OAAmD,EAC3C;IACR,IAAI,CAACA,OAAO,CAACgB,GAAG,CAACC,EAAE,EAAE;MACnB,MAAM,IAAIW,KAAK,CAAC,qBAAqB,CAAC;IACxC;IAEA,MAAMpB,KAAK,GAAIR,OAAO,CAAC6B,MAAM,CAACrB,KAAK,IAAe,EAAE;IACpD,MAAMsB,IAAI,GAAI9B,OAAO,CAAC6B,MAAM,CAACC,IAAI,IAAe,EAAE;IAClD,OAAO,GAAG9B,OAAO,CAACgB,GAAG,CAACC,EAAE,IAAIT,KAAK,IAAIsB,IAAI,GAAG;EAC9C;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE5B,GAAGA,CACDF,OAAmD,EACnD+B,oBAA4C,EAC5C;IACA,MAAMC,OAAO,GAAG,IAAI,CAAC/C,WAAW,GAC5B,IAAI,CAACA,WAAW,CAACe,OAAO,CAAC,GACzB,IAAI,CAACL,mBAAmB,CAACK,OAAO,CAAC;IAErC,OAAO;MACLF,OAAO,EAAEjB,SAAS;MAClBoC,EAAE,EAAE,GAAGe,OAAO,GAAGD,oBAAoB,IAAI,EAAE;IAC7C,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,KAAKA,CACnBzB,KAAgB,EAChB0B,MAAc,EACH;EACX,OAAOvD,IAAI,CAACsD,KAAK,CAACzB,KAAK,EAAE0B,MAAM,EAAE;IAC/BC,WAAW,EAAE;EACf,CAAC,CAAC;AACJ","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -64,7 +64,7 @@
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
     "@defra/forms-model": "^3.0.506",
-    "@defra/hapi-tracing": "^1.0.0",
+    "@defra/hapi-tracing": "^1.26.0",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",
     "@hapi/catbox": "^12.1.1",

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

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
+
 import { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js'
 import { type Field } from '~/src/server/plugins/engine/components/helpers.js'
 import { FormModel } from '~/src/server/plugins/engine/models/index.js'
@@ -8,11 +9,11 @@ import {
   type DetailItemRepeat
 } from '~/src/server/plugins/engine/models/types.js'
 import { format } from '~/src/server/plugins/engine/outputFormatters/machine/v1.js'
+import { buildFormContextRequest } from '~/src/server/plugins/engine/pageControllers/__stubs__/request.js'
 import {
   FileStatus,
   UploadStatus,
-  type FileState,
-  type FormContextRequest
+  type FileState
 } from '~/src/server/plugins/engine/types.js'
 import { FormStatus } from '~/src/server/routes/types.js'
 import definition from '~/test/form/definitions/repeat-mixed.js'
@@ -64,7 +65,7 @@ const state = {
 
 const pageUrl = new URL('http://example.com/repeat/pizza-order/summary')
 
-const request = {
+const request = buildFormContextRequest({
   method: 'get',
   url: pageUrl,
   path: pageUrl.pathname,
@@ -74,7 +75,7 @@ const request = {
   },
   query: {},
   app: { model }
-} satisfies FormContextRequest
+})
 
 const context = model.getFormContext(request, state)
 

package/src/server/plugins/engine/outputFormatters/machine/v2.test.ts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
+
 import { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js'
 import { type Field } from '~/src/server/plugins/engine/components/helpers.js'
 import { FormModel } from '~/src/server/plugins/engine/models/index.js'
@@ -8,11 +9,11 @@ import {
   type DetailItemRepeat
 } from '~/src/server/plugins/engine/models/types.js'
 import { format } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'
+import { buildFormContextRequest } from '~/src/server/plugins/engine/pageControllers/__stubs__/request.js'
 import {
   FileStatus,
   UploadStatus,
-  type FileState,
-  type FormContextRequest
+  type FileState
 } from '~/src/server/plugins/engine/types.js'
 import { FormStatus } from '~/src/server/routes/types.js'
 import definition from '~/test/form/definitions/repeat-mixed.js'
@@ -64,7 +65,7 @@ const state = {
 
 const pageUrl = new URL('http://example.com/repeat/pizza-order/summary')
 
-const request = {
+const request = buildFormContextRequest({
   method: 'get',
   url: pageUrl,
   path: pageUrl.pathname,
@@ -74,7 +75,7 @@ const request = {
   },
   query: {},
   app: { model }
-} satisfies FormContextRequest
+})
 
 const context = model.getFormContext(request, state)
 

package/src/server/plugins/engine/pageControllers/QuestionPageController.test.ts

@@ -1,6 +1,7 @@
 import { type PageQuestion } from '@defra/forms-model'
 import { type ResponseToolkit } from '@hapi/hapi'
 
+import { getCacheService } from '~/src/server/plugins/engine/helpers.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'
 import {
@@ -1333,63 +1334,127 @@ describe('Save and Return functionality', () => {
 
   describe('handleSaveAndReturn', () => {
     it('should save state and redirect to exit page', async () => {
+      const sessionPersisterMock = jest.fn()
       const state: FormSubmissionState = {
         $$__referenceNumber: 'foobar',
         yesNoField: true
       }
       const request = {
         ...requestPage1,
+        server: {
+          plugins: {
+            'forms-engine-plugin': {
+              saveAndReturn: {
+                sessionPersister: sessionPersisterMock
+              },
+              cacheService: {
+                clearState: jest.fn()
+              } as unknown as CacheService
+            }
+          }
+        },
         method: 'post',
         payload: { yesNoField: true, action: 'save-and-return' }
       } as unknown as FormRequestPayload
 
-      const context = model.getFormContext(request, state)
+      const cacheService = getCacheService(request.server)
 
-      jest.spyOn(controller1, 'setState').mockResolvedValue(state)
+      const context = model.getFormContext(request, state)
 
       await controller1.handleSaveAndReturn(request, context, h)
 
-      expect(controller1.setState).toHaveBeenCalledWith(request, state)
+      expect(sessionPersisterMock).toHaveBeenCalledWith(context.state, request)
+      expect(cacheService.clearState).toHaveBeenCalledWith(request)
       expect(h.redirect).toHaveBeenCalledWith('/test/exit')
     })
 
-    it('should handle save-and-return with incomplete data', async () => {
+    it('should throw if sessionPersister inside saveAndReturn options provided', async () => {
+      const sessionPersisterMock = jest.fn()
       const state: FormSubmissionState = {
         $$__referenceNumber: 'foobar',
-        yesNoField: null
+        yesNoField: true
       }
       const request = {
         ...requestPage1,
+        server: {
+          plugins: {
+            'forms-engine-plugin': {
+              // No sessionPersister object
+              saveAndReturn: {}
+            }
+          }
+        },
         method: 'post',
-        payload: { yesNoField: '', action: 'save-and-return' }
+        payload: { yesNoField: true, action: 'save-and-return' }
       } as unknown as FormRequestPayload
 
       const context = model.getFormContext(request, state)
 
-      jest.spyOn(controller1, 'setState').mockResolvedValue(state)
+      await expect(
+        controller1.handleSaveAndReturn(request, context, h)
+      ).rejects.toThrow('Server misconfigured for save and return')
 
-      await controller1.handleSaveAndReturn(request, context, h)
+      expect(sessionPersisterMock).not.toHaveBeenCalled()
+      expect(h.redirect).not.toHaveBeenCalled()
+    })
 
-      expect(controller1.setState).toHaveBeenCalledWith(request, state)
-      expect(h.redirect).toHaveBeenCalledWith('/test/exit')
+    it('should throw if no saveAndReturn options provided', async () => {
+      const sessionPersisterMock = jest.fn()
+      const state: FormSubmissionState = {
+        $$__referenceNumber: 'foobar',
+        yesNoField: true
+      }
+      const request = {
+        ...requestPage1,
+        server: {
+          plugins: {
+            'forms-engine-plugin': {
+              // No saveAndReturn object
+            }
+          }
+        },
+        method: 'post',
+        payload: { yesNoField: true, action: 'save-and-return' }
+      } as unknown as FormRequestPayload
+
+      const context = model.getFormContext(request, state)
+
+      await expect(
+        controller1.handleSaveAndReturn(request, context, h)
+      ).rejects.toThrow('Server misconfigured for save and return')
+
+      expect(sessionPersisterMock).not.toHaveBeenCalled()
+      expect(h.redirect).not.toHaveBeenCalled()
     })
 
-    it('should handle save-and-return with validation errors', async () => {
+    it('should throw if sessionPersister throws as well with validation errors', async () => {
+      const sessionPersisterMock = jest.fn().mockImplementation(() => {
+        throw new Error('Session persister error')
+      })
       const state: FormSubmissionState = { $$__referenceNumber: 'foobar' }
       const request = {
         ...requestPage1,
         method: 'post',
+        server: {
+          plugins: {
+            'forms-engine-plugin': {
+              saveAndReturn: {
+                sessionPersister: sessionPersisterMock
+              }
+            }
+          }
+        },
         payload: { action: 'save-and-return' }
       } as unknown as FormRequestPayload
 
       const context = model.getFormContext(request, state)
 
-      jest.spyOn(controller1, 'setState').mockResolvedValue(state)
-
-      await controller1.handleSaveAndReturn(request, context, h)
+      await expect(
+        controller1.handleSaveAndReturn(request, context, h)
+      ).rejects.toThrow('Session persister error')
 
-      expect(controller1.setState).toHaveBeenCalledWith(request, state)
-      expect(h.redirect).toHaveBeenCalledWith('/test/exit')
+      expect(sessionPersisterMock).toHaveBeenCalledWith(context.state, request)
+      expect(h.redirect).not.toHaveBeenCalledWith('/test/exit')
     })
   })
 

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

@@ -8,6 +8,7 @@ import {
   type Link,
   type Page
 } from '@defra/forms-model'
+import Boom from '@hapi/boom'
 import { type ResponseToolkit, type RouteOptions } from '@hapi/hapi'
 import { type ValidationErrorItem } from 'joi'
 
@@ -17,6 +18,7 @@ import { type BackLink } from '~/src/server/plugins/engine/components/types.js'
 import {
   getCacheService,
   getErrors,
+  getSaveAndReturnHelpers,
   normalisePath,
   proceed
 } from '~/src/server/plugins/engine/helpers.js'
@@ -548,7 +550,17 @@ export class QuestionPageController extends PageController {
     const { state } = context
 
     // Save the current state and redirect to exit page
-    await this.setState(request, state)
+    const saveAndReturn = getSaveAndReturnHelpers(request.server)
+
+    if (!saveAndReturn?.sessionPersister) {
+      throw Boom.internal('Server misconfigured for save and return')
+    }
+
+    await saveAndReturn.sessionPersister(state, request)
+
+    const cacheService = getCacheService(request.server)
+    await cacheService.clearState(request)
+
     return h.redirect(this.getHref('/exit'))
   }
 

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

@@ -43,8 +43,7 @@ export const plugin = {
       cacheName,
       options: {
         keyGenerator: saveAndReturn?.keyGenerator,
-        sessionHydrator: saveAndReturn?.sessionHydrator,
-        sessionPersister: saveAndReturn?.sessionPersister
+        sessionHydrator: saveAndReturn?.sessionHydrator
       }
     })
 

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

@@ -370,7 +370,6 @@ export interface PluginOptions {
     keyGenerator: (request: RequestType) => string
     sessionHydrator: (request: RequestType) => Promise<FormSubmissionState>
     sessionPersister: (
-      key: string,
       state: FormSubmissionState,
       request: RequestType
     ) => Promise<void>

package/src/server/services/cacheService.test.ts

@@ -136,7 +136,7 @@ describe('CacheService', () => {
   })
 
   describe('setState', () => {
-    it('should set state with correct TTL', async () => {
+    it('should set state with correct TTL and return updated state', async () => {
       const mockRequest = {
         yar: { id: 'some-session' },
         params: { state: 'form1', slug: 'page1' }
@@ -146,7 +146,12 @@ describe('CacheService', () => {
 
       jest.spyOn(config, 'get').mockReturnValue(mockTTL)
 
-      await cacheService.setState(mockRequest, mockState)
+      // Mock getState to return the updated state after set
+      jest.spyOn(cacheService, 'getState').mockResolvedValue(mockState)
+
+      await expect(
+        cacheService.setState(mockRequest, mockState)
+      ).resolves.toEqual(mockState)
 
       expect(mockCache.set).toHaveBeenCalledWith(
         {
@@ -156,6 +161,7 @@ describe('CacheService', () => {
         mockState,
         mockTTL
       )
+      expect(cacheService.getState).toHaveBeenCalledWith(mockRequest)
     })
   })
 

package/src/server/services/cacheService.ts

@@ -30,12 +30,6 @@ export class CacheService {
     request: Request | FormRequest | FormRequestPayload
   ) => Promise<FormSubmissionState | null>
 
-  customPersister?: (
-    key: string,
-    state: FormSubmissionState,
-    request: Request | FormRequest | FormRequestPayload
-  ) => Promise<void>
-
   logger: Server['logger']
 
   constructor({
@@ -52,14 +46,9 @@ export class CacheService {
       sessionHydrator?: (
         request: Request | FormRequest | FormRequestPayload
       ) => Promise<FormSubmissionState | null>
-      sessionPersister?: (
-        key: string,
-        state: FormSubmissionState,
-        request: Request | FormRequest | FormRequestPayload
-      ) => Promise<void>
     }
   }) {
-    const { keyGenerator, sessionHydrator, sessionPersister } = options ?? {}
+    const { keyGenerator, sessionHydrator } = options ?? {}
     if (!cacheName) {
       server.log(
         'warn',
@@ -68,7 +57,6 @@ export class CacheService {
     }
     this.generateKey = keyGenerator ?? this.defaultKeyGenerator.bind(this)
     this.customFetcher = sessionHydrator ?? undefined
-    this.customPersister = sessionPersister ?? undefined
     this.cache = server.cache({ cache: cacheName, segment: 'formSubmission' })
     this.logger = server.logger
   }