@defra/forms-engine-plugin 2.1.10 → 3.0.1

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

@@ -1,4 +1,4 @@
-import { FormStatus, idSchema, notificationEmailAddressSchema, slugSchema, titleSchema } from '@defra/forms-model';
+import { FormStatus, formVersionMetadataSchema, idSchema, notificationEmailAddressSchema, slugSchema, titleSchema } from '@defra/forms-model';
 import Joi from 'joi';
 import { FormAdapterSubmissionSchemaVersion } from "./enums.js";
 export const formAdapterSubmissionMessageMetaSchema = Joi.object().keys({
@@ -10,7 +10,8 @@ export const formAdapterSubmissionMessageMetaSchema = Joi.object().keys({
   formSlug: slugSchema,
   status: Joi.string().valid(...Object.values(FormStatus)).required(),
   isPreview: Joi.boolean().required(),
-  notificationEmail: notificationEmailAddressSchema.required()
+  notificationEmail: notificationEmailAddressSchema.required(),
+  versionMetadata: formVersionMetadataSchema.optional()
 });
 export const formAdapterSubmissionMessageDataSchema = Joi.object().keys({
   main: Joi.object(),

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

@@ -1 +1 @@
-{"version":3,"file":"schema.js","names":["FormStatus","idSchema","notificationEmailAddressSchema","slugSchema","titleSchema","Joi","FormAdapterSubmissionSchemaVersion","formAdapterSubmissionMessageMetaSchema","object","keys","schemaVersion","string","valid","Object","values","timestamp","date","required","referenceNumber","formName","formId","formSlug","status","isPreview","boolean","notificationEmail","formAdapterSubmissionMessageDataSchema","main","repeaters","files","pattern","array","items","fileName","fileId","userDownloadLink","formAdapterSubmissionMessageResultSchema","formAdapterSubmissionMessagePayloadSchema","meta","data","result"],"sources":["../../../../../src/server/plugins/engine/types/schema.ts"],"sourcesContent":["import {\n  FormStatus,\n  idSchema,\n  notificationEmailAddressSchema,\n  slugSchema,\n  titleSchema\n} from '@defra/forms-model'\nimport Joi from 'joi'\n\nimport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\nimport {\n  type FormAdapterSubmissionMessageData,\n  type FormAdapterSubmissionMessageMeta,\n  type FormAdapterSubmissionMessagePayload,\n  type FormAdapterSubmissionMessageResult\n} from '~/src/server/plugins/engine/types.js'\n\nexport const formAdapterSubmissionMessageMetaSchema =\n  Joi.object<FormAdapterSubmissionMessageMeta>().keys({\n    schemaVersion: Joi.string().valid(\n      ...Object.values(FormAdapterSubmissionSchemaVersion)\n    ),\n    timestamp: Joi.date().required(),\n    referenceNumber: Joi.string().required(),\n    formName: titleSchema,\n    formId: idSchema,\n    formSlug: slugSchema,\n    status: Joi.string()\n      .valid(...Object.values(FormStatus))\n      .required(),\n    isPreview: Joi.boolean().required(),\n    notificationEmail: notificationEmailAddressSchema.required()\n  })\n\nexport const formAdapterSubmissionMessageDataSchema =\n  Joi.object<FormAdapterSubmissionMessageData>().keys({\n    main: Joi.object(),\n    repeaters: Joi.object(),\n    files: Joi.object().pattern(\n      Joi.string(),\n      Joi.array().items(\n        Joi.object().keys({\n          fileName: Joi.string().required(),\n          fileId: Joi.string().required(),\n          userDownloadLink: Joi.string().required()\n        })\n      )\n    )\n  })\n\nexport const formAdapterSubmissionMessageResultSchema =\n  Joi.object<FormAdapterSubmissionMessageResult>().keys({\n    files: Joi.object()\n      .keys({\n        main: Joi.string().required(),\n        repeaters: Joi.object()\n      })\n      .required()\n  })\n\nexport const formAdapterSubmissionMessagePayloadSchema =\n  Joi.object<FormAdapterSubmissionMessagePayload>().keys({\n    meta: formAdapterSubmissionMessageMetaSchema.required(),\n    data: formAdapterSubmissionMessageDataSchema.required(),\n    result: formAdapterSubmissionMessageResultSchema.required()\n  })\n"],"mappings":"AAAA,SACEA,UAAU,EACVC,QAAQ,EACRC,8BAA8B,EAC9BC,UAAU,EACVC,WAAW,QACN,oBAAoB;AAC3B,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,kCAAkC;AAQ3C,OAAO,MAAMC,sCAAsC,GACjDF,GAAG,CAACG,MAAM,CAAmC,CAAC,CAACC,IAAI,CAAC;EAClDC,aAAa,EAAEL,GAAG,CAACM,MAAM,CAAC,CAAC,CAACC,KAAK,CAC/B,GAAGC,MAAM,CAACC,MAAM,CAACR,kCAAkC,CACrD,CAAC;EACDS,SAAS,EAAEV,GAAG,CAACW,IAAI,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAChCC,eAAe,EAAEb,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;EACxCE,QAAQ,EAAEf,WAAW;EACrBgB,MAAM,EAAEnB,QAAQ;EAChBoB,QAAQ,EAAElB,UAAU;EACpBmB,MAAM,EAAEjB,GAAG,CAACM,MAAM,CAAC,CAAC,CACjBC,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAACd,UAAU,CAAC,CAAC,CACnCiB,QAAQ,CAAC,CAAC;EACbM,SAAS,EAAElB,GAAG,CAACmB,OAAO,CAAC,CAAC,CAACP,QAAQ,CAAC,CAAC;EACnCQ,iBAAiB,EAAEvB,8BAA8B,CAACe,QAAQ,CAAC;AAC7D,CAAC,CAAC;AAEJ,OAAO,MAAMS,sCAAsC,GACjDrB,GAAG,CAACG,MAAM,CAAmC,CAAC,CAACC,IAAI,CAAC;EAClDkB,IAAI,EAAEtB,GAAG,CAACG,MAAM,CAAC,CAAC;EAClBoB,SAAS,EAAEvB,GAAG,CAACG,MAAM,CAAC,CAAC;EACvBqB,KAAK,EAAExB,GAAG,CAACG,MAAM,CAAC,CAAC,CAACsB,OAAO,CACzBzB,GAAG,CAACM,MAAM,CAAC,CAAC,EACZN,GAAG,CAAC0B,KAAK,CAAC,CAAC,CAACC,KAAK,CACf3B,GAAG,CAACG,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;IAChBwB,QAAQ,EAAE5B,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IACjCiB,MAAM,EAAE7B,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IAC/BkB,gBAAgB,EAAE9B,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC;EAC1C,CAAC,CACH,CACF;AACF,CAAC,CAAC;AAEJ,OAAO,MAAMmB,wCAAwC,GACnD/B,GAAG,CAACG,MAAM,CAAqC,CAAC,CAACC,IAAI,CAAC;EACpDoB,KAAK,EAAExB,GAAG,CAACG,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;IACJkB,IAAI,EAAEtB,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IAC7BW,SAAS,EAAEvB,GAAG,CAACG,MAAM,CAAC;EACxB,CAAC,CAAC,CACDS,QAAQ,CAAC;AACd,CAAC,CAAC;AAEJ,OAAO,MAAMoB,yCAAyC,GACpDhC,GAAG,CAACG,MAAM,CAAsC,CAAC,CAACC,IAAI,CAAC;EACrD6B,IAAI,EAAE/B,sCAAsC,CAACU,QAAQ,CAAC,CAAC;EACvDsB,IAAI,EAAEb,sCAAsC,CAACT,QAAQ,CAAC,CAAC;EACvDuB,MAAM,EAAEJ,wCAAwC,CAACnB,QAAQ,CAAC;AAC5D,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"schema.js","names":["FormStatus","formVersionMetadataSchema","idSchema","notificationEmailAddressSchema","slugSchema","titleSchema","Joi","FormAdapterSubmissionSchemaVersion","formAdapterSubmissionMessageMetaSchema","object","keys","schemaVersion","string","valid","Object","values","timestamp","date","required","referenceNumber","formName","formId","formSlug","status","isPreview","boolean","notificationEmail","versionMetadata","optional","formAdapterSubmissionMessageDataSchema","main","repeaters","files","pattern","array","items","fileName","fileId","userDownloadLink","formAdapterSubmissionMessageResultSchema","formAdapterSubmissionMessagePayloadSchema","meta","data","result"],"sources":["../../../../../src/server/plugins/engine/types/schema.ts"],"sourcesContent":["import {\n  FormStatus,\n  formVersionMetadataSchema,\n  idSchema,\n  notificationEmailAddressSchema,\n  slugSchema,\n  titleSchema\n} from '@defra/forms-model'\nimport Joi from 'joi'\n\nimport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\nimport {\n  type FormAdapterSubmissionMessageData,\n  type FormAdapterSubmissionMessageMeta,\n  type FormAdapterSubmissionMessagePayload,\n  type FormAdapterSubmissionMessageResult\n} from '~/src/server/plugins/engine/types.js'\n\nexport const formAdapterSubmissionMessageMetaSchema =\n  Joi.object<FormAdapterSubmissionMessageMeta>().keys({\n    schemaVersion: Joi.string().valid(\n      ...Object.values(FormAdapterSubmissionSchemaVersion)\n    ),\n    timestamp: Joi.date().required(),\n    referenceNumber: Joi.string().required(),\n    formName: titleSchema,\n    formId: idSchema,\n    formSlug: slugSchema,\n    status: Joi.string()\n      .valid(...Object.values(FormStatus))\n      .required(),\n    isPreview: Joi.boolean().required(),\n    notificationEmail: notificationEmailAddressSchema.required(),\n    versionMetadata: formVersionMetadataSchema.optional()\n  })\n\nexport const formAdapterSubmissionMessageDataSchema =\n  Joi.object<FormAdapterSubmissionMessageData>().keys({\n    main: Joi.object(),\n    repeaters: Joi.object(),\n    files: Joi.object().pattern(\n      Joi.string(),\n      Joi.array().items(\n        Joi.object().keys({\n          fileName: Joi.string().required(),\n          fileId: Joi.string().required(),\n          userDownloadLink: Joi.string().required()\n        })\n      )\n    )\n  })\n\nexport const formAdapterSubmissionMessageResultSchema =\n  Joi.object<FormAdapterSubmissionMessageResult>().keys({\n    files: Joi.object()\n      .keys({\n        main: Joi.string().required(),\n        repeaters: Joi.object()\n      })\n      .required()\n  })\n\nexport const formAdapterSubmissionMessagePayloadSchema =\n  Joi.object<FormAdapterSubmissionMessagePayload>().keys({\n    meta: formAdapterSubmissionMessageMetaSchema.required(),\n    data: formAdapterSubmissionMessageDataSchema.required(),\n    result: formAdapterSubmissionMessageResultSchema.required()\n  })\n"],"mappings":"AAAA,SACEA,UAAU,EACVC,yBAAyB,EACzBC,QAAQ,EACRC,8BAA8B,EAC9BC,UAAU,EACVC,WAAW,QACN,oBAAoB;AAC3B,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,kCAAkC;AAQ3C,OAAO,MAAMC,sCAAsC,GACjDF,GAAG,CAACG,MAAM,CAAmC,CAAC,CAACC,IAAI,CAAC;EAClDC,aAAa,EAAEL,GAAG,CAACM,MAAM,CAAC,CAAC,CAACC,KAAK,CAC/B,GAAGC,MAAM,CAACC,MAAM,CAACR,kCAAkC,CACrD,CAAC;EACDS,SAAS,EAAEV,GAAG,CAACW,IAAI,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAChCC,eAAe,EAAEb,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;EACxCE,QAAQ,EAAEf,WAAW;EACrBgB,MAAM,EAAEnB,QAAQ;EAChBoB,QAAQ,EAAElB,UAAU;EACpBmB,MAAM,EAAEjB,GAAG,CAACM,MAAM,CAAC,CAAC,CACjBC,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAACf,UAAU,CAAC,CAAC,CACnCkB,QAAQ,CAAC,CAAC;EACbM,SAAS,EAAElB,GAAG,CAACmB,OAAO,CAAC,CAAC,CAACP,QAAQ,CAAC,CAAC;EACnCQ,iBAAiB,EAAEvB,8BAA8B,CAACe,QAAQ,CAAC,CAAC;EAC5DS,eAAe,EAAE1B,yBAAyB,CAAC2B,QAAQ,CAAC;AACtD,CAAC,CAAC;AAEJ,OAAO,MAAMC,sCAAsC,GACjDvB,GAAG,CAACG,MAAM,CAAmC,CAAC,CAACC,IAAI,CAAC;EAClDoB,IAAI,EAAExB,GAAG,CAACG,MAAM,CAAC,CAAC;EAClBsB,SAAS,EAAEzB,GAAG,CAACG,MAAM,CAAC,CAAC;EACvBuB,KAAK,EAAE1B,GAAG,CAACG,MAAM,CAAC,CAAC,CAACwB,OAAO,CACzB3B,GAAG,CAACM,MAAM,CAAC,CAAC,EACZN,GAAG,CAAC4B,KAAK,CAAC,CAAC,CAACC,KAAK,CACf7B,GAAG,CAACG,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;IAChB0B,QAAQ,EAAE9B,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IACjCmB,MAAM,EAAE/B,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IAC/BoB,gBAAgB,EAAEhC,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC;EAC1C,CAAC,CACH,CACF;AACF,CAAC,CAAC;AAEJ,OAAO,MAAMqB,wCAAwC,GACnDjC,GAAG,CAACG,MAAM,CAAqC,CAAC,CAACC,IAAI,CAAC;EACpDsB,KAAK,EAAE1B,GAAG,CAACG,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;IACJoB,IAAI,EAAExB,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IAC7Ba,SAAS,EAAEzB,GAAG,CAACG,MAAM,CAAC;EACxB,CAAC,CAAC,CACDS,QAAQ,CAAC;AACd,CAAC,CAAC;AAEJ,OAAO,MAAMsB,yCAAyC,GACpDlC,GAAG,CAACG,MAAM,CAAsC,CAAC,CAACC,IAAI,CAAC;EACrD+B,IAAI,EAAEjC,sCAAsC,CAACU,QAAQ,CAAC,CAAC;EACvDwB,IAAI,EAAEb,sCAAsC,CAACX,QAAQ,CAAC,CAAC;EACvDyB,MAAM,EAAEJ,wCAAwC,CAACrB,QAAQ,CAAC;AAC5D,CAAC,CAAC","ignoreList":[]}

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

@@ -1,5 +1,5 @@
-import { type ComponentDef, type Event, type FormDefinition, type FormMetadata, type Item, type List, type Page } from '@defra/forms-model';
-import { type PluginProperties, type Request } from '@hapi/hapi';
+import { type ComponentDef, type Event, type FormDefinition, type FormMetadata, type FormVersionMetadata, type Item, type List, type Page } from '@defra/forms-model';
+import { type PluginProperties, type Request, type ResponseObject } from '@hapi/hapi';
 import { type JoiExpression, type ValidationErrorItem } from 'joi';
 import { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js';
 import { type Component } from '~/src/server/plugins/engine/components/helpers/components.js';
@@ -11,10 +11,12 @@ import { type PageController } from '~/src/server/plugins/engine/pageControllers
 import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js';
 import { type FileStatus, type FormAdapterSubmissionSchemaVersion, type UploadStatus } from '~/src/server/plugins/engine/types/enums.js';
 import { type ViewContext } from '~/src/server/plugins/nunjucks/types.js';
-import { type FormAction, type FormParams, type FormRequest, type FormRequestPayload, type FormStatus } from '~/src/server/routes/types.js';
+import { type FormAction, type FormParams, type FormRequest, type FormRequestPayload, type FormResponseToolkit, type FormStatus } from '~/src/server/routes/types.js';
+import { type CacheService } from '~/src/server/services/cacheService.js';
 import { type RequestOptions } from '~/src/server/services/httpService.js';
 import { type Services } from '~/src/server/types.js';
-type RequestType = Request | FormRequest | FormRequestPayload;
+export type AnyFormRequest = FormRequest | FormRequestPayload;
+export type AnyRequest = Request | AnyFormRequest;
 /**
  * Form submission state stores the following in Redis:
  * Props containing user's submitted values as `{ [inputId]: value }` or as `{ [sectionName]: { [inputName]: value } }`
@@ -119,6 +121,7 @@ export interface FormContext {
     pageMap: Map<string, PageControllerClass>;
     componentMap: Map<string, Component>;
     referenceNumber: string;
+    submittedVersionNumber?: number;
 }
 export type FormContextRequest = ({
     method: 'get';
@@ -230,7 +233,7 @@ export interface FormPageViewModel extends PageViewModelBase {
     context: FormContext;
     errors?: FormSubmissionError[];
     hasMissingNotificationEmail?: boolean;
-    allowSaveAndReturn: boolean;
+    allowSaveAndExit: boolean;
 }
 export interface RepeaterSummaryPageViewModel extends PageViewModelBase {
     context: FormContext;
@@ -257,19 +260,16 @@ export interface ErrorMessageTemplateList {
     advancedSettingsErrors: ErrorMessageTemplate[];
 }
 export type PreparePageEventRequestOptions = (options: RequestOptions, event: Event, page: PageControllerClass, context: FormContext) => void;
-export type OnRequestCallback = (request: FormRequest | FormRequestPayload, params: FormParams, definition: FormDefinition, metadata: FormMetadata) => void;
+export type OnRequestCallback = (request: AnyFormRequest, params: FormParams, definition: FormDefinition, metadata: FormMetadata) => void;
+export type SaveAndExitHandler = (request: FormRequestPayload, h: FormResponseToolkit, context: FormContext) => ResponseObject;
 export interface PluginOptions {
     model?: FormModel;
     services?: Services;
     controllers?: Record<string, typeof PageController>;
-    cacheName?: string;
+    cache?: CacheService | string;
     globals?: Record<string, GlobalFunction>;
     filters?: Record<string, FilterFunction>;
-    saveAndReturn?: {
-        keyGenerator: (request: RequestType) => string;
-        sessionHydrator: (request: RequestType) => Promise<FormSubmissionState>;
-        sessionPersister: (state: FormSubmissionState, request: RequestType) => Promise<void>;
-    };
+    saveAndExit?: SaveAndExitHandler;
     pluginPath?: string;
     nunjucks: {
         baseLayoutPath: string;
@@ -290,6 +290,7 @@ export interface FormAdapterSubmissionMessageMeta {
     status: FormStatus;
     isPreview: boolean;
     notificationEmail: string;
+    versionMetadata?: FormVersionMetadata;
 }
 export type FormAdapterSubmissionMessageMetaSerialised = Omit<FormAdapterSubmissionMessageMeta, 'schemaVersion' | 'timestamp' | 'status'> & {
     schemaVersion: number;

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":["FileStatus","UploadStatus"],"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 UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport { type FileUploadField } from '~/src/server/plugins/engine/components/index.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel,\n  type DatePartsState,\n  type MonthYearState\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItemField } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport {\n  type FileStatus,\n  type FormAdapterSubmissionSchemaVersion,\n  type UploadStatus\n} from '~/src/server/plugins/engine/types/enums.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  type FormStatus\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 {\n  FileStatus,\n  UploadStatus\n} from '~/src/server/plugins/engine/types/enums.js'\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\nexport interface FormAdapterSubmissionMessageMeta {\n  schemaVersion: FormAdapterSubmissionSchemaVersion\n  timestamp: Date\n  referenceNumber: string\n  formName: string\n  formId: string\n  formSlug: string\n  status: FormStatus\n  isPreview: boolean\n  notificationEmail: string\n}\n\nexport type FormAdapterSubmissionMessageMetaSerialised = Omit<\n  FormAdapterSubmissionMessageMeta,\n  'schemaVersion' | 'timestamp' | 'status'\n> & {\n  schemaVersion: number\n  status: string\n  timestamp: string\n}\nexport interface FormAdapterFile {\n  fileName: string\n  fileId: string\n  userDownloadLink: string\n}\n\nexport interface FormAdapterSubmissionMessageResult {\n  files: {\n    main: string\n    repeaters: Record<string, string>\n  }\n}\n\n/**\n * A detail item specifically for files\n */\nexport type FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {\n  field: FileUploadField\n}\nexport type RichFormValue =\n  | FormValue\n  | FormPayload\n  | DatePartsState\n  | MonthYearState\n  | UkAddressState\n\nexport interface FormAdapterSubmissionMessageData {\n  main: Record<string, RichFormValue>\n  repeaters: Record<string, Record<string, RichFormValue>[]>\n  files: Record<string, FormAdapterFile[]>\n}\n\nexport interface FormAdapterSubmissionMessagePayload {\n  meta: FormAdapterSubmissionMessageMeta\n  data: FormAdapterSubmissionMessageData\n  result: FormAdapterSubmissionMessageResult\n}\n\nexport interface FormAdapterSubmissionMessage\n  extends FormAdapterSubmissionMessagePayload {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface FormAdapterSubmissionService {\n  handleFormSubmission: (\n    submissionMessage: FormAdapterSubmissionMessage\n  ) => unknown\n}\n"],"mappings":"AA6CA;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,SACEA,UAAU,EACVC,YAAY;;AA6Nd;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"types.js","names":["FileStatus","UploadStatus"],"sources":["../../../../src/server/plugins/engine/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Event,\n  type FormDefinition,\n  type FormMetadata,\n  type FormVersionMetadata,\n  type Item,\n  type List,\n  type Page\n} from '@defra/forms-model'\nimport {\n  type PluginProperties,\n  type Request,\n  type ResponseObject\n} from '@hapi/hapi'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport { type FileUploadField } from '~/src/server/plugins/engine/components/index.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel,\n  type DatePartsState,\n  type MonthYearState\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItemField } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport {\n  type FileStatus,\n  type FormAdapterSubmissionSchemaVersion,\n  type UploadStatus\n} from '~/src/server/plugins/engine/types/enums.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  type FormResponseToolkit,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\nimport { type RequestOptions } from '~/src/server/services/httpService.js'\nimport { type Services } from '~/src/server/types.js'\n\nexport type AnyFormRequest = FormRequest | FormRequestPayload\nexport type AnyRequest = Request | AnyFormRequest\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  submittedVersionNumber?: number\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 {\n  FileStatus,\n  UploadStatus\n} from '~/src/server/plugins/engine/types/enums.js'\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  allowSaveAndExit: 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: AnyFormRequest,\n  params: FormParams,\n  definition: FormDefinition,\n  metadata: FormMetadata\n) => void\n\nexport type SaveAndExitHandler = (\n  request: FormRequestPayload,\n  h: FormResponseToolkit,\n  context: FormContext\n) => ResponseObject\n\nexport interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cache?: CacheService | string\n  globals?: Record<string, GlobalFunction>\n  filters?: Record<string, FilterFunction>\n  saveAndExit?: SaveAndExitHandler\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\nexport interface FormAdapterSubmissionMessageMeta {\n  schemaVersion: FormAdapterSubmissionSchemaVersion\n  timestamp: Date\n  referenceNumber: string\n  formName: string\n  formId: string\n  formSlug: string\n  status: FormStatus\n  isPreview: boolean\n  notificationEmail: string\n  versionMetadata?: FormVersionMetadata\n}\n\nexport type FormAdapterSubmissionMessageMetaSerialised = Omit<\n  FormAdapterSubmissionMessageMeta,\n  'schemaVersion' | 'timestamp' | 'status'\n> & {\n  schemaVersion: number\n  status: string\n  timestamp: string\n}\nexport interface FormAdapterFile {\n  fileName: string\n  fileId: string\n  userDownloadLink: string\n}\n\nexport interface FormAdapterSubmissionMessageResult {\n  files: {\n    main: string\n    repeaters: Record<string, string>\n  }\n}\n\n/**\n * A detail item specifically for files\n */\nexport type FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {\n  field: FileUploadField\n}\nexport type RichFormValue =\n  | FormValue\n  | FormPayload\n  | DatePartsState\n  | MonthYearState\n  | UkAddressState\n\nexport interface FormAdapterSubmissionMessageData {\n  main: Record<string, RichFormValue>\n  repeaters: Record<string, Record<string, RichFormValue>[]>\n  files: Record<string, FormAdapterFile[]>\n}\n\nexport interface FormAdapterSubmissionMessagePayload {\n  meta: FormAdapterSubmissionMessageMeta\n  data: FormAdapterSubmissionMessageData\n  result: FormAdapterSubmissionMessageResult\n}\n\nexport interface FormAdapterSubmissionMessage\n  extends FormAdapterSubmissionMessagePayload {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface FormAdapterSubmissionService {\n  handleFormSubmission: (\n    submissionMessage: FormAdapterSubmissionMessage\n  ) => unknown\n}\n"],"mappings":"AAqDA;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;;AAsGA,SACEA,UAAU,EACVC,YAAY;;AA6Nd;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/engine/views/partials/form.html

@@ -13,12 +13,12 @@
       preventDoubleClick: true
     }) }}
 
-    {% if allowSaveAndReturn %}
+    {% if allowSaveAndExit %}
       {{ govukButton({
-        text: "Save and return",
+        text: "Save and exit",
         classes: "govuk-button--secondary",
         name: "action",
-        value: "save-and-return",
+        value: "save-and-exit",
         preventDoubleClick: true
       }) }}
     {% endif %}

package/.server/server/plugins/engine/views/summary.html

@@ -2,6 +2,7 @@
 
 {% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
 {% from "govuk/components/summary-list/macro.njk" import govukSummaryList %}
+{% from "govuk/components/button/macro.njk" import govukButton %}
 {% from "partials/components.html" import componentList with context %}
 
 {% block content %}
@@ -31,7 +32,6 @@
 
       <form method="post" novalidate>
         <input type="hidden" name="crumb" value="{{ crumb }}">
-        <input type="hidden" name="action" value="send">
 
         {% if declaration %}
           <h2 class="govuk-heading-m" id="declaration">Declaration</h2>
@@ -42,10 +42,26 @@
 
         {{ componentList(components) }}
 
-        {% set isDeclaration = declaration or components | length %}
-        <button data-prevent-double-click="true" class="govuk-button" data-module="govuk-button">
-          {{ "Accept and send" if isDeclaration else "Send" }}
-        </button>
+        <div class="govuk-button-group">
+          {% set isDeclaration = declaration or components | length %}
+
+          {{ govukButton({
+            text: "Accept and send" if isDeclaration else "Send",
+            name: "action",
+            value: "send",
+            preventDoubleClick: true
+          }) }}
+
+          {% if allowSaveAndExit %}
+            {{ govukButton({
+              text: "Save and exit",
+              classes: "govuk-button--secondary",
+              name: "action",
+              value: "save-and-exit",
+              preventDoubleClick: true
+            }) }}
+          {% endif %}
+        </div>
       </form>
     </div>
   </div>

package/.server/server/plugins/nunjucks/context.d.ts

@@ -1,16 +1,15 @@
 /**
- * @param {FormRequest | FormRequestPayload | null} request
+ * @param {AnyFormRequest | null} request
  */
-export function context(request: FormRequest | FormRequestPayload | null): Promise<ViewContext>;
+export function context(request: AnyFormRequest | null): Promise<ViewContext>;
 /**
  * Returns the context for the devtool. Consumers won't have access to this.
- * @param {FormRequest | FormRequestPayload | null} _request
+ * @param {AnyFormRequest | null} _request
  * @returns {Record<string, unknown> & { assetPath: string, getDxtAssetPath: (asset: string) => string }}
  */
-export function devtoolContext(_request: FormRequest | FormRequestPayload | null): Record<string, unknown> & {
+export function devtoolContext(_request: AnyFormRequest | null): Record<string, unknown> & {
     assetPath: string;
     getDxtAssetPath: (asset: string) => string;
 };
-import type { FormRequest } from '~/src/server/routes/types.js';
-import type { FormRequestPayload } from '~/src/server/routes/types.js';
+import type { AnyFormRequest } from '~/src/server/plugins/engine/types.js';
 import type { ViewContext } from '~/src/server/plugins/nunjucks/types.js';

package/.server/server/plugins/nunjucks/context.js

@@ -11,7 +11,7 @@ const logger = createLogger();
 let webpackManifest;
 
 /**
- * @param {FormRequest | FormRequestPayload | null} request
+ * @param {AnyFormRequest | null} request
  */
 export async function context(request) {
   const {
@@ -53,7 +53,7 @@ export async function context(request) {
 
 /**
  * Returns the context for the devtool. Consumers won't have access to this.
- * @param {FormRequest | FormRequestPayload | null} _request
+ * @param {AnyFormRequest | null} _request
  * @returns {Record<string, unknown> & { assetPath: string, getDxtAssetPath: (asset: string) => string }}
  */
 export function devtoolContext(_request) {
@@ -84,6 +84,6 @@ export function devtoolContext(_request) {
 
 /**
  * @import { ViewContext } from '~/src/server/plugins/nunjucks/types.js'
- * @import { FormRequest, FormRequestPayload } from '~/src/server/routes/types.js'
+ * @import { AnyFormRequest } from '~/src/server/plugins/engine/types.js'
  */
 //# sourceMappingURL=context.js.map

package/.server/server/plugins/nunjucks/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","names":["readFileSync","basename","join","Boom","StatusCodes","config","createLogger","checkFormStatus","encodeUrl","safeGenerateCrumb","logger","webpackManifest","context","request","params","response","isPreview","isPreviewMode","state","formState","isResponseOK","isBoom","statusCode","OK","pluginStorage","server","plugins","consumerViewContext","Error","baseLayoutPath","viewContext","ctx","crumb","currentPath","path","url","search","previewMode","undefined","slug","devtoolContext","_request","manifestPath","get","JSON","parse","info","cdpEnvironment","designerUrl","feedbackLink","phaseTag","serviceName","serviceVersion","assetPath","getDxtAssetPath","asset"],"sources":["../../../../src/server/plugins/nunjucks/context.js"],"sourcesContent":["import { readFileSync } from 'node:fs'\nimport { basename, join } from 'node:path'\n\nimport Boom from '@hapi/boom'\nimport { StatusCodes } from 'http-status-codes'\n\nimport { config } from '~/src/config/index.js'\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport {\n  checkFormStatus,\n  encodeUrl,\n  safeGenerateCrumb\n} from '~/src/server/plugins/engine/helpers.js'\n\nconst logger = createLogger()\n\n/** @type {Record<string, string> | undefined} */\nlet webpackManifest\n\n/**\n * @param {FormRequest | FormRequestPayload | null} request\n */\nexport async function context(request) {\n  const { params, response } = request ?? {}\n\n  const { isPreview: isPreviewMode, state: formState } = checkFormStatus(params)\n\n  // Only add the slug in to the context if the response is OK.\n  // Footer meta links are not rendered when the slug is missing.\n  const isResponseOK =\n    !Boom.isBoom(response) && response?.statusCode === StatusCodes.OK\n\n  const pluginStorage = request?.server.plugins['forms-engine-plugin']\n\n  let consumerViewContext = {}\n\n  if (!pluginStorage) {\n    throw Error('context called before plugin registered')\n  }\n\n  if (!pluginStorage.baseLayoutPath) {\n    throw Error('Missing baseLayoutPath in plugin.options.nunjucks')\n  }\n\n  if (typeof pluginStorage.viewContext === 'function') {\n    consumerViewContext = await pluginStorage.viewContext(request)\n  }\n\n  /** @type {ViewContext} */\n  const ctx = {\n    // take consumers props first so we can override it\n    ...consumerViewContext,\n    baseLayoutPath: pluginStorage.baseLayoutPath,\n    crumb: safeGenerateCrumb(request),\n    currentPath: `${request.path}${request.url.search}`,\n    previewMode: isPreviewMode ? formState : undefined,\n    slug: isResponseOK ? params?.slug : undefined\n  }\n\n  return ctx\n}\n\n/**\n * Returns the context for the devtool. Consumers won't have access to this.\n * @param {FormRequest | FormRequestPayload | null} _request\n * @returns {Record<string, unknown> & { assetPath: string, getDxtAssetPath: (asset: string) => string }}\n */\nexport function devtoolContext(_request) {\n  const manifestPath = join(config.get('publicDir'), 'assets-manifest.json')\n\n  if (!webpackManifest) {\n    try {\n      // eslint-disable-next-line -- Allow JSON type 'any'\n      webpackManifest = JSON.parse(readFileSync(manifestPath, 'utf-8'))\n    } catch {\n      logger.info(\n        `[webpackManifestMissing] Webpack ${basename(manifestPath)} not found - running without asset manifest`\n      )\n    }\n  }\n\n  return {\n    config: {\n      cdpEnvironment: config.get('cdpEnvironment'),\n      designerUrl: config.get('designerUrl'),\n      feedbackLink: encodeUrl(config.get('feedbackLink')),\n      phaseTag: config.get('phaseTag'),\n      serviceName: config.get('serviceName'),\n      serviceVersion: config.get('serviceVersion')\n    },\n    assetPath: '/assets',\n    getDxtAssetPath: (asset = '') => {\n      return `/${webpackManifest?.[asset] ?? asset}`\n    }\n  }\n}\n\n/**\n * @import { ViewContext } from '~/src/server/plugins/nunjucks/types.js'\n * @import { FormRequest, FormRequestPayload } from '~/src/server/routes/types.js'\n */\n"],"mappings":"AAAA,SAASA,YAAY,QAAQ,SAAS;AACtC,SAASC,QAAQ,EAAEC,IAAI,QAAQ,WAAW;AAE1C,OAAOC,IAAI,MAAM,YAAY;AAC7B,SAASC,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,MAAM;AACf,SAASC,YAAY;AACrB,SACEC,eAAe,EACfC,SAAS,EACTC,iBAAiB;AAGnB,MAAMC,MAAM,GAAGJ,YAAY,CAAC,CAAC;;AAE7B;AACA,IAAIK,eAAe;;AAEnB;AACA;AACA;AACA,OAAO,eAAeC,OAAOA,CAACC,OAAO,EAAE;EACrC,MAAM;IAAEC,MAAM;IAAEC;EAAS,CAAC,GAAGF,OAAO,IAAI,CAAC,CAAC;EAE1C,MAAM;IAAEG,SAAS,EAAEC,aAAa;IAAEC,KAAK,EAAEC;EAAU,CAAC,GAAGZ,eAAe,CAACO,MAAM,CAAC;;EAE9E;EACA;EACA,MAAMM,YAAY,GAChB,CAACjB,IAAI,CAACkB,MAAM,CAACN,QAAQ,CAAC,IAAIA,QAAQ,EAAEO,UAAU,KAAKlB,WAAW,CAACmB,EAAE;EAEnE,MAAMC,aAAa,GAAGX,OAAO,EAAEY,MAAM,CAACC,OAAO,CAAC,qBAAqB,CAAC;EAEpE,IAAIC,mBAAmB,GAAG,CAAC,CAAC;EAE5B,IAAI,CAACH,aAAa,EAAE;IAClB,MAAMI,KAAK,CAAC,yCAAyC,CAAC;EACxD;EAEA,IAAI,CAACJ,aAAa,CAACK,cAAc,EAAE;IACjC,MAAMD,KAAK,CAAC,mDAAmD,CAAC;EAClE;EAEA,IAAI,OAAOJ,aAAa,CAACM,WAAW,KAAK,UAAU,EAAE;IACnDH,mBAAmB,GAAG,MAAMH,aAAa,CAACM,WAAW,CAACjB,OAAO,CAAC;EAChE;;EAEA;EACA,MAAMkB,GAAG,GAAG;IACV;IACA,GAAGJ,mBAAmB;IACtBE,cAAc,EAAEL,aAAa,CAACK,cAAc;IAC5CG,KAAK,EAAEvB,iBAAiB,CAACI,OAAO,CAAC;IACjCoB,WAAW,EAAE,GAAGpB,OAAO,CAACqB,IAAI,GAAGrB,OAAO,CAACsB,GAAG,CAACC,MAAM,EAAE;IACnDC,WAAW,EAAEpB,aAAa,GAAGE,SAAS,GAAGmB,SAAS;IAClDC,IAAI,EAAEnB,YAAY,GAAGN,MAAM,EAAEyB,IAAI,GAAGD;EACtC,CAAC;EAED,OAAOP,GAAG;AACZ;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASS,cAAcA,CAACC,QAAQ,EAAE;EACvC,MAAMC,YAAY,GAAGxC,IAAI,CAACG,MAAM,CAACsC,GAAG,CAAC,WAAW,CAAC,EAAE,sBAAsB,CAAC;EAE1E,IAAI,CAAChC,eAAe,EAAE;IACpB,IAAI;MACF;MACAA,eAAe,GAAGiC,IAAI,CAACC,KAAK,CAAC7C,YAAY,CAAC0C,YAAY,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC,CAAC,MAAM;MACNhC,MAAM,CAACoC,IAAI,CACT,oCAAoC7C,QAAQ,CAACyC,YAAY,CAAC,6CAC5D,CAAC;IACH;EACF;EAEA,OAAO;IACLrC,MAAM,EAAE;MACN0C,cAAc,EAAE1C,MAAM,CAACsC,GAAG,CAAC,gBAAgB,CAAC;MAC5CK,WAAW,EAAE3C,MAAM,CAACsC,GAAG,CAAC,aAAa,CAAC;MACtCM,YAAY,EAAEzC,SAAS,CAACH,MAAM,CAACsC,GAAG,CAAC,cAAc,CAAC,CAAC;MACnDO,QAAQ,EAAE7C,MAAM,CAACsC,GAAG,CAAC,UAAU,CAAC;MAChCQ,WAAW,EAAE9C,MAAM,CAACsC,GAAG,CAAC,aAAa,CAAC;MACtCS,cAAc,EAAE/C,MAAM,CAACsC,GAAG,CAAC,gBAAgB;IAC7C,CAAC;IACDU,SAAS,EAAE,SAAS;IACpBC,eAAe,EAAEA,CAACC,KAAK,GAAG,EAAE,KAAK;MAC/B,OAAO,IAAI5C,eAAe,GAAG4C,KAAK,CAAC,IAAIA,KAAK,EAAE;IAChD;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"context.js","names":["readFileSync","basename","join","Boom","StatusCodes","config","createLogger","checkFormStatus","encodeUrl","safeGenerateCrumb","logger","webpackManifest","context","request","params","response","isPreview","isPreviewMode","state","formState","isResponseOK","isBoom","statusCode","OK","pluginStorage","server","plugins","consumerViewContext","Error","baseLayoutPath","viewContext","ctx","crumb","currentPath","path","url","search","previewMode","undefined","slug","devtoolContext","_request","manifestPath","get","JSON","parse","info","cdpEnvironment","designerUrl","feedbackLink","phaseTag","serviceName","serviceVersion","assetPath","getDxtAssetPath","asset"],"sources":["../../../../src/server/plugins/nunjucks/context.js"],"sourcesContent":["import { readFileSync } from 'node:fs'\nimport { basename, join } from 'node:path'\n\nimport Boom from '@hapi/boom'\nimport { StatusCodes } from 'http-status-codes'\n\nimport { config } from '~/src/config/index.js'\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport {\n  checkFormStatus,\n  encodeUrl,\n  safeGenerateCrumb\n} from '~/src/server/plugins/engine/helpers.js'\n\nconst logger = createLogger()\n\n/** @type {Record<string, string> | undefined} */\nlet webpackManifest\n\n/**\n * @param {AnyFormRequest | null} request\n */\nexport async function context(request) {\n  const { params, response } = request ?? {}\n\n  const { isPreview: isPreviewMode, state: formState } = checkFormStatus(params)\n\n  // Only add the slug in to the context if the response is OK.\n  // Footer meta links are not rendered when the slug is missing.\n  const isResponseOK =\n    !Boom.isBoom(response) && response?.statusCode === StatusCodes.OK\n\n  const pluginStorage = request?.server.plugins['forms-engine-plugin']\n\n  let consumerViewContext = {}\n\n  if (!pluginStorage) {\n    throw Error('context called before plugin registered')\n  }\n\n  if (!pluginStorage.baseLayoutPath) {\n    throw Error('Missing baseLayoutPath in plugin.options.nunjucks')\n  }\n\n  if (typeof pluginStorage.viewContext === 'function') {\n    consumerViewContext = await pluginStorage.viewContext(request)\n  }\n\n  /** @type {ViewContext} */\n  const ctx = {\n    // take consumers props first so we can override it\n    ...consumerViewContext,\n    baseLayoutPath: pluginStorage.baseLayoutPath,\n    crumb: safeGenerateCrumb(request),\n    currentPath: `${request.path}${request.url.search}`,\n    previewMode: isPreviewMode ? formState : undefined,\n    slug: isResponseOK ? params?.slug : undefined\n  }\n\n  return ctx\n}\n\n/**\n * Returns the context for the devtool. Consumers won't have access to this.\n * @param {AnyFormRequest | null} _request\n * @returns {Record<string, unknown> & { assetPath: string, getDxtAssetPath: (asset: string) => string }}\n */\nexport function devtoolContext(_request) {\n  const manifestPath = join(config.get('publicDir'), 'assets-manifest.json')\n\n  if (!webpackManifest) {\n    try {\n      // eslint-disable-next-line -- Allow JSON type 'any'\n      webpackManifest = JSON.parse(readFileSync(manifestPath, 'utf-8'))\n    } catch {\n      logger.info(\n        `[webpackManifestMissing] Webpack ${basename(manifestPath)} not found - running without asset manifest`\n      )\n    }\n  }\n\n  return {\n    config: {\n      cdpEnvironment: config.get('cdpEnvironment'),\n      designerUrl: config.get('designerUrl'),\n      feedbackLink: encodeUrl(config.get('feedbackLink')),\n      phaseTag: config.get('phaseTag'),\n      serviceName: config.get('serviceName'),\n      serviceVersion: config.get('serviceVersion')\n    },\n    assetPath: '/assets',\n    getDxtAssetPath: (asset = '') => {\n      return `/${webpackManifest?.[asset] ?? asset}`\n    }\n  }\n}\n\n/**\n * @import { ViewContext } from '~/src/server/plugins/nunjucks/types.js'\n * @import { AnyFormRequest } from '~/src/server/plugins/engine/types.js'\n */\n"],"mappings":"AAAA,SAASA,YAAY,QAAQ,SAAS;AACtC,SAASC,QAAQ,EAAEC,IAAI,QAAQ,WAAW;AAE1C,OAAOC,IAAI,MAAM,YAAY;AAC7B,SAASC,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,MAAM;AACf,SAASC,YAAY;AACrB,SACEC,eAAe,EACfC,SAAS,EACTC,iBAAiB;AAGnB,MAAMC,MAAM,GAAGJ,YAAY,CAAC,CAAC;;AAE7B;AACA,IAAIK,eAAe;;AAEnB;AACA;AACA;AACA,OAAO,eAAeC,OAAOA,CAACC,OAAO,EAAE;EACrC,MAAM;IAAEC,MAAM;IAAEC;EAAS,CAAC,GAAGF,OAAO,IAAI,CAAC,CAAC;EAE1C,MAAM;IAAEG,SAAS,EAAEC,aAAa;IAAEC,KAAK,EAAEC;EAAU,CAAC,GAAGZ,eAAe,CAACO,MAAM,CAAC;;EAE9E;EACA;EACA,MAAMM,YAAY,GAChB,CAACjB,IAAI,CAACkB,MAAM,CAACN,QAAQ,CAAC,IAAIA,QAAQ,EAAEO,UAAU,KAAKlB,WAAW,CAACmB,EAAE;EAEnE,MAAMC,aAAa,GAAGX,OAAO,EAAEY,MAAM,CAACC,OAAO,CAAC,qBAAqB,CAAC;EAEpE,IAAIC,mBAAmB,GAAG,CAAC,CAAC;EAE5B,IAAI,CAACH,aAAa,EAAE;IAClB,MAAMI,KAAK,CAAC,yCAAyC,CAAC;EACxD;EAEA,IAAI,CAACJ,aAAa,CAACK,cAAc,EAAE;IACjC,MAAMD,KAAK,CAAC,mDAAmD,CAAC;EAClE;EAEA,IAAI,OAAOJ,aAAa,CAACM,WAAW,KAAK,UAAU,EAAE;IACnDH,mBAAmB,GAAG,MAAMH,aAAa,CAACM,WAAW,CAACjB,OAAO,CAAC;EAChE;;EAEA;EACA,MAAMkB,GAAG,GAAG;IACV;IACA,GAAGJ,mBAAmB;IACtBE,cAAc,EAAEL,aAAa,CAACK,cAAc;IAC5CG,KAAK,EAAEvB,iBAAiB,CAACI,OAAO,CAAC;IACjCoB,WAAW,EAAE,GAAGpB,OAAO,CAACqB,IAAI,GAAGrB,OAAO,CAACsB,GAAG,CAACC,MAAM,EAAE;IACnDC,WAAW,EAAEpB,aAAa,GAAGE,SAAS,GAAGmB,SAAS;IAClDC,IAAI,EAAEnB,YAAY,GAAGN,MAAM,EAAEyB,IAAI,GAAGD;EACtC,CAAC;EAED,OAAOP,GAAG;AACZ;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASS,cAAcA,CAACC,QAAQ,EAAE;EACvC,MAAMC,YAAY,GAAGxC,IAAI,CAACG,MAAM,CAACsC,GAAG,CAAC,WAAW,CAAC,EAAE,sBAAsB,CAAC;EAE1E,IAAI,CAAChC,eAAe,EAAE;IACpB,IAAI;MACF;MACAA,eAAe,GAAGiC,IAAI,CAACC,KAAK,CAAC7C,YAAY,CAAC0C,YAAY,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC,CAAC,MAAM;MACNhC,MAAM,CAACoC,IAAI,CACT,oCAAoC7C,QAAQ,CAACyC,YAAY,CAAC,6CAC5D,CAAC;IACH;EACF;EAEA,OAAO;IACLrC,MAAM,EAAE;MACN0C,cAAc,EAAE1C,MAAM,CAACsC,GAAG,CAAC,gBAAgB,CAAC;MAC5CK,WAAW,EAAE3C,MAAM,CAACsC,GAAG,CAAC,aAAa,CAAC;MACtCM,YAAY,EAAEzC,SAAS,CAACH,MAAM,CAACsC,GAAG,CAAC,cAAc,CAAC,CAAC;MACnDO,QAAQ,EAAE7C,MAAM,CAACsC,GAAG,CAAC,UAAU,CAAC;MAChCQ,WAAW,EAAE9C,MAAM,CAACsC,GAAG,CAAC,aAAa,CAAC;MACtCS,cAAc,EAAE/C,MAAM,CAACsC,GAAG,CAAC,gBAAgB;IAC7C,CAAC;IACDU,SAAS,EAAE,SAAS;IACpBC,eAAe,EAAEA,CAACC,KAAK,GAAG,EAAE,KAAK;MAC/B,OAAO,IAAI5C,eAAe,GAAG4C,KAAK,CAAC,IAAIA,KAAK,EAAE;IAChD;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/routes/types.d.ts

@@ -1,4 +1,4 @@
-import { type ReqRefDefaults, type Request } from '@hapi/hapi';
+import { type ReqRefDefaults, type Request, type ResponseToolkit } from '@hapi/hapi';
 import { type FormPayload } from '~/src/server/plugins/engine/types.js';
 export interface FormQuery extends Partial<Record<string, string>> {
     /**
@@ -25,13 +25,14 @@ export interface FormRequestPayloadRefs extends FormRequestRefs {
 }
 export type FormRequest = Request<FormRequestRefs>;
 export type FormRequestPayload = Request<FormRequestPayloadRefs>;
+export type FormResponseToolkit = Pick<ResponseToolkit, 'redirect' | 'view'>;
 export declare enum FormAction {
     Continue = "continue",
     Validate = "validate",
     Delete = "delete",
     AddAnother = "add-another",
     Send = "send",
-    SaveAndReturn = "save-and-return"
+    SaveAndExit = "save-and-exit"
 }
 export declare enum FormStatus {
     Draft = "draft",

package/.server/server/routes/types.js

@@ -4,7 +4,7 @@ export let FormAction = /*#__PURE__*/function (FormAction) {
   FormAction["Delete"] = "delete";
   FormAction["AddAnother"] = "add-another";
   FormAction["Send"] = "send";
-  FormAction["SaveAndReturn"] = "save-and-return";
+  FormAction["SaveAndExit"] = "save-and-exit";
   return FormAction;
 }({});
 export let FormStatus = /*#__PURE__*/function (FormStatus) {

package/.server/server/routes/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":["FormAction","FormStatus"],"sources":["../../../src/server/routes/types.ts"],"sourcesContent":["import { type ReqRefDefaults, type Request } from '@hapi/hapi'\n\nimport { type FormPayload } from '~/src/server/plugins/engine/types.js'\n\nexport interface FormQuery extends Partial<Record<string, string>> {\n  /**\n   * Allow preview URL direct access without relevant page checks\n   */\n  force?: string\n\n  /**\n   * Redirect location after 'continue' form action\n   */\n  returnUrl?: string\n}\n\nexport interface FormParams extends Partial<Record<string, string>> {\n  path: string\n  slug: string\n  state?: FormStatus\n}\n\nexport interface FormRequestRefs\n  extends Omit<ReqRefDefaults, 'Params' | 'Payload' | 'Query'> {\n  Params: FormParams\n  Payload: object | undefined\n  Query: FormQuery\n}\n\nexport interface FormRequestPayloadRefs extends FormRequestRefs {\n  Payload: FormPayload\n}\n\nexport type FormRequest = Request<FormRequestRefs>\nexport type FormRequestPayload = Request<FormRequestPayloadRefs>\n\nexport enum FormAction {\n  Continue = 'continue',\n  Validate = 'validate',\n  Delete = 'delete',\n  AddAnother = 'add-another',\n  Send = 'send',\n  SaveAndReturn = 'save-and-return'\n}\n\nexport enum FormStatus {\n  Draft = 'draft',\n  Live = 'live'\n}\n"],"mappings":"AAoCA,WAAYA,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA;AAStB,WAAYC,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA","ignoreList":[]}
+{"version":3,"file":"types.js","names":["FormAction","FormStatus"],"sources":["../../../src/server/routes/types.ts"],"sourcesContent":["import {\n  type ReqRefDefaults,\n  type Request,\n  type ResponseToolkit\n} from '@hapi/hapi'\n\nimport { type FormPayload } from '~/src/server/plugins/engine/types.js'\n\nexport interface FormQuery extends Partial<Record<string, string>> {\n  /**\n   * Allow preview URL direct access without relevant page checks\n   */\n  force?: string\n\n  /**\n   * Redirect location after 'continue' form action\n   */\n  returnUrl?: string\n}\n\nexport interface FormParams extends Partial<Record<string, string>> {\n  path: string\n  slug: string\n  state?: FormStatus\n}\n\nexport interface FormRequestRefs\n  extends Omit<ReqRefDefaults, 'Params' | 'Payload' | 'Query'> {\n  Params: FormParams\n  Payload: object | undefined\n  Query: FormQuery\n}\n\nexport interface FormRequestPayloadRefs extends FormRequestRefs {\n  Payload: FormPayload\n}\n\nexport type FormRequest = Request<FormRequestRefs>\nexport type FormRequestPayload = Request<FormRequestPayloadRefs>\nexport type FormResponseToolkit = Pick<ResponseToolkit, 'redirect' | 'view'>\n\nexport enum FormAction {\n  Continue = 'continue',\n  Validate = 'validate',\n  Delete = 'delete',\n  AddAnother = 'add-another',\n  Send = 'send',\n  SaveAndExit = 'save-and-exit'\n}\n\nexport enum FormStatus {\n  Draft = 'draft',\n  Live = 'live'\n}\n"],"mappings":"AAyCA,WAAYA,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA;AAStB,WAAYC,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA","ignoreList":[]}

package/.server/server/schemas/index.js

@@ -1,7 +1,7 @@
 import Joi from 'joi';
 import { FormAction, FormStatus } from "../routes/types.js";
 export const stateSchema = Joi.string().valid(FormStatus.Draft, FormStatus.Live).required();
-export const actionSchema = Joi.string().valid(FormAction.Continue, FormAction.Validate, FormAction.Delete, FormAction.AddAnother, FormAction.Send, FormAction.SaveAndReturn).default(FormAction.Validate).optional();
+export const actionSchema = Joi.string().valid(FormAction.Continue, FormAction.Validate, FormAction.Delete, FormAction.AddAnother, FormAction.Send, FormAction.SaveAndExit).default(FormAction.Validate).optional();
 export const pathSchema = Joi.string().required();
 export const itemIdSchema = Joi.string().uuid().required();
 export const crumbSchema = Joi.string().optional().allow('');

package/.server/server/schemas/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Joi","FormAction","FormStatus","stateSchema","string","valid","Draft","Live","required","actionSchema","Continue","Validate","Delete","AddAnother","Send","SaveAndReturn","default","optional","pathSchema","itemIdSchema","uuid","crumbSchema","allow","confirmSchema","boolean","empty","paramsSchema","object","keys","action","confirm","crumb","itemId"],"sources":["../../../src/server/schemas/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { type FormPayloadParams } from '~/src/server/plugins/engine/types.js'\nimport { FormAction, FormStatus } from '~/src/server/routes/types.js'\n\nexport const stateSchema = Joi.string<FormStatus>()\n  .valid(FormStatus.Draft, FormStatus.Live)\n  .required()\n\nexport const actionSchema = Joi.string<FormAction>()\n  .valid(\n    FormAction.Continue,\n    FormAction.Validate,\n    FormAction.Delete,\n    FormAction.AddAnother,\n    FormAction.Send,\n    FormAction.SaveAndReturn\n  )\n  .default(FormAction.Validate)\n  .optional()\n\nexport const pathSchema = Joi.string().required()\nexport const itemIdSchema = Joi.string().uuid().required()\nexport const crumbSchema = Joi.string().optional().allow('')\nexport const confirmSchema = Joi.boolean().empty(false)\n\nexport const paramsSchema = Joi.object<FormPayloadParams>()\n  .keys({\n    action: actionSchema,\n    confirm: confirmSchema,\n    crumb: crumbSchema,\n    itemId: itemIdSchema.optional()\n  })\n  .default({})\n  .optional()\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAGrB,SAASC,UAAU,EAAEC,UAAU;AAE/B,OAAO,MAAMC,WAAW,GAAGH,GAAG,CAACI,MAAM,CAAa,CAAC,CAChDC,KAAK,CAACH,UAAU,CAACI,KAAK,EAAEJ,UAAU,CAACK,IAAI,CAAC,CACxCC,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMC,YAAY,GAAGT,GAAG,CAACI,MAAM,CAAa,CAAC,CACjDC,KAAK,CACJJ,UAAU,CAACS,QAAQ,EACnBT,UAAU,CAACU,QAAQ,EACnBV,UAAU,CAACW,MAAM,EACjBX,UAAU,CAACY,UAAU,EACrBZ,UAAU,CAACa,IAAI,EACfb,UAAU,CAACc,aACb,CAAC,CACAC,OAAO,CAACf,UAAU,CAACU,QAAQ,CAAC,CAC5BM,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMC,UAAU,GAAGlB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACI,QAAQ,CAAC,CAAC;AACjD,OAAO,MAAMW,YAAY,GAAGnB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACgB,IAAI,CAAC,CAAC,CAACZ,QAAQ,CAAC,CAAC;AAC1D,OAAO,MAAMa,WAAW,GAAGrB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACa,QAAQ,CAAC,CAAC,CAACK,KAAK,CAAC,EAAE,CAAC;AAC5D,OAAO,MAAMC,aAAa,GAAGvB,GAAG,CAACwB,OAAO,CAAC,CAAC,CAACC,KAAK,CAAC,KAAK,CAAC;AAEvD,OAAO,MAAMC,YAAY,GAAG1B,GAAG,CAAC2B,MAAM,CAAoB,CAAC,CACxDC,IAAI,CAAC;EACJC,MAAM,EAAEpB,YAAY;EACpBqB,OAAO,EAAEP,aAAa;EACtBQ,KAAK,EAAEV,WAAW;EAClBW,MAAM,EAAEb,YAAY,CAACF,QAAQ,CAAC;AAChC,CAAC,CAAC,CACDD,OAAO,CAAC,CAAC,CAAC,CAAC,CACXC,QAAQ,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Joi","FormAction","FormStatus","stateSchema","string","valid","Draft","Live","required","actionSchema","Continue","Validate","Delete","AddAnother","Send","SaveAndExit","default","optional","pathSchema","itemIdSchema","uuid","crumbSchema","allow","confirmSchema","boolean","empty","paramsSchema","object","keys","action","confirm","crumb","itemId"],"sources":["../../../src/server/schemas/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { type FormPayloadParams } from '~/src/server/plugins/engine/types.js'\nimport { FormAction, FormStatus } from '~/src/server/routes/types.js'\n\nexport const stateSchema = Joi.string<FormStatus>()\n  .valid(FormStatus.Draft, FormStatus.Live)\n  .required()\n\nexport const actionSchema = Joi.string<FormAction>()\n  .valid(\n    FormAction.Continue,\n    FormAction.Validate,\n    FormAction.Delete,\n    FormAction.AddAnother,\n    FormAction.Send,\n    FormAction.SaveAndExit\n  )\n  .default(FormAction.Validate)\n  .optional()\n\nexport const pathSchema = Joi.string().required()\nexport const itemIdSchema = Joi.string().uuid().required()\nexport const crumbSchema = Joi.string().optional().allow('')\nexport const confirmSchema = Joi.boolean().empty(false)\n\nexport const paramsSchema = Joi.object<FormPayloadParams>()\n  .keys({\n    action: actionSchema,\n    confirm: confirmSchema,\n    crumb: crumbSchema,\n    itemId: itemIdSchema.optional()\n  })\n  .default({})\n  .optional()\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAGrB,SAASC,UAAU,EAAEC,UAAU;AAE/B,OAAO,MAAMC,WAAW,GAAGH,GAAG,CAACI,MAAM,CAAa,CAAC,CAChDC,KAAK,CAACH,UAAU,CAACI,KAAK,EAAEJ,UAAU,CAACK,IAAI,CAAC,CACxCC,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMC,YAAY,GAAGT,GAAG,CAACI,MAAM,CAAa,CAAC,CACjDC,KAAK,CACJJ,UAAU,CAACS,QAAQ,EACnBT,UAAU,CAACU,QAAQ,EACnBV,UAAU,CAACW,MAAM,EACjBX,UAAU,CAACY,UAAU,EACrBZ,UAAU,CAACa,IAAI,EACfb,UAAU,CAACc,WACb,CAAC,CACAC,OAAO,CAACf,UAAU,CAACU,QAAQ,CAAC,CAC5BM,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMC,UAAU,GAAGlB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACI,QAAQ,CAAC,CAAC;AACjD,OAAO,MAAMW,YAAY,GAAGnB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACgB,IAAI,CAAC,CAAC,CAACZ,QAAQ,CAAC,CAAC;AAC1D,OAAO,MAAMa,WAAW,GAAGrB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACa,QAAQ,CAAC,CAAC,CAACK,KAAK,CAAC,EAAE,CAAC;AAC5D,OAAO,MAAMC,aAAa,GAAGvB,GAAG,CAACwB,OAAO,CAAC,CAAC,CAACC,KAAK,CAAC,KAAK,CAAC;AAEvD,OAAO,MAAMC,YAAY,GAAG1B,GAAG,CAAC2B,MAAM,CAAoB,CAAC,CACxDC,IAAI,CAAC;EACJC,MAAM,EAAEpB,YAAY;EACpBqB,OAAO,EAAEP,aAAa;EACtBQ,KAAK,EAAEV,WAAW;EAClBW,MAAM,EAAEb,YAAY,CAACF,QAAQ,CAAC;AAChC,CAAC,CAAC,CACDD,OAAO,CAAC,CAAC,CAAC,CAAC,CACXC,QAAQ,CAAC,CAAC","ignoreList":[]}

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

@@ -1,6 +1,5 @@
-import { type Request, type Server } from '@hapi/hapi';
-import { type FormPayload, type FormState, type FormSubmissionError, type FormSubmissionState } from '~/src/server/plugins/engine/types.js';
-import { type FormRequest, type FormRequestPayload } from '~/src/server/routes/types.js';
+import { type Server } from '@hapi/hapi';
+import { type AnyFormRequest, type AnyRequest, type FormPayload, type FormState, type FormSubmissionError, type FormSubmissionState } from '~/src/server/plugins/engine/types.js';
 export declare enum ADDITIONAL_IDENTIFIER {
     Confirmation = ":confirmation"
 }
@@ -12,40 +11,33 @@ export declare class CacheService {
         cache: string | undefined;
         segment: string;
     }>;
-    generateKey?: (request: Request | FormRequest | FormRequestPayload) => string;
-    customFetcher?: (request: Request | FormRequest | FormRequestPayload) => Promise<FormSubmissionState | null>;
     logger: Server['logger'];
-    constructor({ server, cacheName, options }: {
+    constructor({ server, cacheName }: {
         server: Server;
         cacheName?: string;
-        options?: {
-            keyGenerator?: (request: Request | FormRequest | FormRequestPayload) => string;
-            sessionHydrator?: (request: Request | FormRequest | FormRequestPayload) => Promise<FormSubmissionState | null>;
-        };
     });
-    getState(request: Request | FormRequest | FormRequestPayload): Promise<FormSubmissionState>;
-    setState(request: FormRequest | FormRequestPayload, state: FormSubmissionState): Promise<FormSubmissionState>;
-    getConfirmationState(request: FormRequest | FormRequestPayload): Promise<{
+    getState(request: AnyRequest): Promise<FormSubmissionState>;
+    setState(request: AnyFormRequest, state: FormSubmissionState): Promise<FormSubmissionState>;
+    getConfirmationState(request: AnyFormRequest): Promise<{
         confirmed?: true;
     }>;
-    setConfirmationState(request: FormRequest | FormRequestPayload, confirmationState: {
+    setConfirmationState(request: AnyFormRequest, confirmationState: {
         confirmed?: true;
     }): Promise<void>;
-    clearState(request: FormRequest | FormRequestPayload): Promise<void>;
-    getFlash(request: FormRequest | FormRequestPayload): {
+    clearState(request: AnyFormRequest): Promise<void>;
+    getFlash(request: AnyFormRequest): {
         errors: FormSubmissionError[];
     } | undefined;
-    setFlash(request: FormRequest | FormRequestPayload, message: {
+    setFlash(request: AnyFormRequest, message: {
         errors: FormSubmissionError[];
     }): void;
-    private defaultKeyGenerator;
     /**
      * The key used to store user session data against.
      * 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`
      * @param request - hapi request object
      * @param additionalIdentifier - appended to the id
      */
-    Key(request: Request | FormRequest | FormRequestPayload, additionalIdentifier?: ADDITIONAL_IDENTIFIER): {
+    Key(request: AnyRequest, additionalIdentifier?: ADDITIONAL_IDENTIFIER): {
         segment: string;
         id: string;
     };

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

@@ -10,23 +10,14 @@ export class CacheService {
    * 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}
    */
   cache;
-  generateKey;
-  customFetcher;
   logger;
   constructor({
     server,
-    cacheName,
-    options
+    cacheName
   }) {
-    const {
-      keyGenerator,
-      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.cache = server.cache({
       cache: cacheName,
       segment: 'formSubmission'
@@ -35,16 +26,7 @@ export class CacheService {
   }
   async getState(request) {
     const key = this.Key(request);
-    let cached = await this.cache.get(key);
-
-    // If nothing in Redis, attempt to rehydrate from backend DB
-    if (!cached && this.customFetcher) {
-      const rehydrated = await this.customFetcher(request);
-      if (rehydrated != null) {
-        await this.cache.set(key, rehydrated, config.get('sessionTimeout'));
-        cached = await this.getState(request);
-      }
-    }
+    const cached = await this.cache.get(key);
     return cached ?? {};
   }
   async setState(request, state) {
@@ -79,14 +61,6 @@ export class CacheService {
     const key = this.Key(request);
     request.yar.flash(key.id, message);
   }
-  defaultKeyGenerator(request) {
-    if (!request.yar.id) {
-      throw new Error('No session ID found');
-    }
-    const state = request.params.state || '';
-    const slug = request.params.slug || '';
-    return `${request.yar.id}:${state}:${slug}:`;
-  }
 
   /**
    * The key used to store user session data against.
@@ -95,10 +69,15 @@ export class CacheService {
    * @param additionalIdentifier - appended to the id
    */
   Key(request, additionalIdentifier) {
-    const baseKey = this.generateKey ? this.generateKey(request) : this.defaultKeyGenerator(request);
+    if (!request.yar.id) {
+      throw new Error('No session ID found');
+    }
+    const state = request.params.state || '';
+    const slug = request.params.slug || '';
+    const key = `${request.yar.id}:${state}:${slug}:`;
     return {
       segment: partition,
-      id: `${baseKey}${additionalIdentifier ?? ''}`
+      id: `${key}${additionalIdentifier ?? ''}`
     };
   }
 }

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

@@ -1 +1 @@
-{"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":[]}
+{"version":3,"file":"cacheService.js","names":["Hoek","config","partition","ADDITIONAL_IDENTIFIER","CacheService","cache","logger","constructor","server","cacheName","log","segment","getState","request","key","Key","cached","get","setState","state","ttl","set","getConfirmationState","Confirmation","value","setConfirmationState","confirmationState","clearState","yar","id","drop","getFlash","messages","flash","Array","isArray","length","at","setFlash","message","additionalIdentifier","Error","params","slug","merge","update","mergeArrays"],"sources":["../../../src/server/services/cacheService.ts"],"sourcesContent":["import { 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 AnyFormRequest,\n  type AnyRequest,\n  type FormPayload,\n  type FormState,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/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  logger: Server['logger']\n\n  constructor({ server, cacheName }: { server: Server; cacheName?: string }) {\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\n    this.cache = server.cache({ cache: cacheName, segment: 'formSubmission' })\n    this.logger = server.logger\n  }\n\n  async getState(request: AnyRequest): Promise<FormSubmissionState> {\n    const key = this.Key(request)\n    const cached = await this.cache.get(key)\n\n    return cached ?? {}\n  }\n\n  async setState(request: AnyFormRequest, state: FormSubmissionState) {\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: AnyFormRequest\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: AnyFormRequest,\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: AnyFormRequest) {\n    if (request.yar.id) {\n      await this.cache.drop(this.Key(request))\n    }\n  }\n\n  getFlash(\n    request: AnyFormRequest\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: AnyFormRequest,\n    message: { errors: FormSubmissionError[] }\n  ) {\n    const key = this.Key(request)\n\n    request.yar.flash(key.id, message)\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(request: AnyRequest, additionalIdentifier?: ADDITIONAL_IDENTIFIER) {\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    const key = `${request.yar.id}:${state}:${slug}:`\n\n    return {\n      segment: partition,\n      id: `${key}${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;AAWf,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,MAAM;EAENC,WAAWA,CAAC;IAAEC,MAAM;IAAEC;EAAkD,CAAC,EAAE;IACzE,IAAI,CAACA,SAAS,EAAE;MACdD,MAAM,CAACE,GAAG,CACR,MAAM,EACN,mGACF,CAAC;IACH;IAEA,IAAI,CAACL,KAAK,GAAGG,MAAM,CAACH,KAAK,CAAC;MAAEA,KAAK,EAAEI,SAAS;MAAEE,OAAO,EAAE;IAAiB,CAAC,CAAC;IAC1E,IAAI,CAACL,MAAM,GAAGE,MAAM,CAACF,MAAM;EAC7B;EAEA,MAAMM,QAAQA,CAACC,OAAmB,EAAgC;IAChE,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMG,MAAM,GAAG,MAAM,IAAI,CAACX,KAAK,CAACY,GAAG,CAACH,GAAG,CAAC;IAExC,OAAOE,MAAM,IAAI,CAAC,CAAC;EACrB;EAEA,MAAME,QAAQA,CAACL,OAAuB,EAAEM,KAA0B,EAAE;IAClE,MAAML,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMO,GAAG,GAAGnB,MAAM,CAACgB,GAAG,CAAC,gBAAgB,CAAC;IAExC,MAAM,IAAI,CAACZ,KAAK,CAACgB,GAAG,CAACP,GAAG,EAAEK,KAAK,EAAEC,GAAG,CAAC;IAErC,OAAO,IAAI,CAACR,QAAQ,CAACC,OAAO,CAAC;EAC/B;EAEA,MAAMS,oBAAoBA,CACxBT,OAAuB,EACQ;IAC/B,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAEV,qBAAqB,CAACoB,YAAY,CAAC;IACjE,MAAMC,KAAK,GAAG,MAAM,IAAI,CAACnB,KAAK,CAACY,GAAG,CAACH,GAAG,CAAC;IAEvC,OAAOU,KAAK,IAAI,CAAC,CAAC;EACpB;EAEA,MAAMC,oBAAoBA,CACxBZ,OAAuB,EACvBa,iBAAuC,EACvC;IACA,MAAMZ,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAEV,qBAAqB,CAACoB,YAAY,CAAC;IACjE,MAAMH,GAAG,GAAGnB,MAAM,CAACgB,GAAG,CAAC,4BAA4B,CAAC;IAEpD,OAAO,IAAI,CAACZ,KAAK,CAACgB,GAAG,CAACP,GAAG,EAAEY,iBAAiB,EAAEN,GAAG,CAAC;EACpD;EAEA,MAAMO,UAAUA,CAACd,OAAuB,EAAE;IACxC,IAAIA,OAAO,CAACe,GAAG,CAACC,EAAE,EAAE;MAClB,MAAM,IAAI,CAACxB,KAAK,CAACyB,IAAI,CAAC,IAAI,CAACf,GAAG,CAACF,OAAO,CAAC,CAAC;IAC1C;EACF;EAEAkB,QAAQA,CACNlB,OAAuB,EACwB;IAC/C,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMmB,QAAQ,GAAGnB,OAAO,CAACe,GAAG,CAACK,KAAK,CAACnB,GAAG,CAACe,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,CACNzB,OAAuB,EACvB0B,OAA0C,EAC1C;IACA,MAAMzB,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAE7BA,OAAO,CAACe,GAAG,CAACK,KAAK,CAACnB,GAAG,CAACe,EAAE,EAAEU,OAAO,CAAC;EACpC;;EAEA;AACF;AACA;AACA;AACA;AACA;EACExB,GAAGA,CAACF,OAAmB,EAAE2B,oBAA4C,EAAE;IACrE,IAAI,CAAC3B,OAAO,CAACe,GAAG,CAACC,EAAE,EAAE;MACnB,MAAM,IAAIY,KAAK,CAAC,qBAAqB,CAAC;IACxC;IAEA,MAAMtB,KAAK,GAAIN,OAAO,CAAC6B,MAAM,CAACvB,KAAK,IAAe,EAAE;IACpD,MAAMwB,IAAI,GAAI9B,OAAO,CAAC6B,MAAM,CAACC,IAAI,IAAe,EAAE;IAClD,MAAM7B,GAAG,GAAG,GAAGD,OAAO,CAACe,GAAG,CAACC,EAAE,IAAIV,KAAK,IAAIwB,IAAI,GAAG;IAEjD,OAAO;MACLhC,OAAO,EAAET,SAAS;MAClB2B,EAAE,EAAE,GAAGf,GAAG,GAAG0B,oBAAoB,IAAI,EAAE;IACzC,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,KAAKA,CACnBzB,KAAgB,EAChB0B,MAAc,EACH;EACX,OAAO7C,IAAI,CAAC4C,KAAK,CAACzB,KAAK,EAAE0B,MAAM,EAAE;IAC/BC,WAAW,EAAE;EACf,CAAC,CAAC;AACJ","ignoreList":[]}

package/.server/server/types.d.ts

@@ -1,9 +1,11 @@
 import { type FormDefinition, type FormMetadata, type SubmitPayload, type SubmitResponsePayload } from '@defra/forms-model';
+import { type Server } from '@hapi/hapi';
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
 import { type DetailItem } from '~/src/server/plugins/engine/models/types.js';
 import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js';
 import { type FormContext, type OnRequestCallback, type PluginOptions, type PreparePageEventRequestOptions } from '~/src/server/plugins/engine/types.js';
 import { type FormRequestPayload, type FormStatus } from '~/src/server/routes/types.js';
+import { type CacheService } from '~/src/server/services/cacheService.js';
 export interface FormsService {
     getFormMetadata: (slug: string) => Promise<FormMetadata>;
     getFormDefinition: (id: string, state: FormStatus) => Promise<FormDefinition | undefined>;
@@ -28,7 +30,8 @@ export interface RouteConfig {
     controllers?: Record<string, typeof PageController>;
     preparePageEventRequestOptions?: PreparePageEventRequestOptions;
     onRequest?: OnRequestCallback;
-    saveAndReturn?: PluginOptions['saveAndReturn'];
+    saveAndExit?: PluginOptions['saveAndExit'];
+    cacheServiceCreator?: (server: Server) => CacheService;
 }
 export interface OutputService {
     submit: (context: FormContext, request: FormRequestPayload, model: FormModel, emailAddress: string, items: DetailItem[], submitResponse: SubmitResponsePayload, formMetadata?: FormMetadata) => Promise<void>;