@defra/forms-engine-plugin 2.1.10 → 3.0.1

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

@@ -2,7 +2,6 @@ import { randomUUID } from 'crypto'
 
 import { type PageRepeat, type Repeat } from '@defra/forms-model'
 import Boom from '@hapi/boom'
-import { type ResponseToolkit } from '@hapi/hapi'
 import Joi from 'joi'
 
 import { isRepeatState } from '~/src/server/plugins/engine/components/FormComponent.js'
@@ -25,7 +24,8 @@ import {
 import {
   FormAction,
   type FormRequest,
-  type FormRequestPayload
+  type FormRequestPayload,
+  type FormResponseToolkit
 } from '~/src/server/routes/types.js'
 
 export class RepeatPageController extends QuestionPageController {
@@ -128,10 +128,7 @@ export class RepeatPageController extends QuestionPageController {
     }
   }
 
-  proceed(
-    request: FormContextRequest,
-    h: Pick<ResponseToolkit, 'redirect' | 'view'>
-  ) {
+  proceed(request: FormContextRequest, h: FormResponseToolkit) {
     const nextPath = this.getSummaryPath(request)
     return super.proceed(request, h, nextPath)
   }
@@ -151,7 +148,7 @@ export class RepeatPageController extends QuestionPageController {
     return async (
       request: FormRequest,
       context: FormContext,
-      h: Pick<ResponseToolkit, 'redirect' | 'view'>
+      h: FormResponseToolkit
     ) => {
       const { path } = this
       const { query } = request
@@ -179,7 +176,7 @@ export class RepeatPageController extends QuestionPageController {
     return (
       request: FormRequest,
       context: FormContext,
-      h: Pick<ResponseToolkit, 'redirect' | 'view'>
+      h: FormResponseToolkit
     ) => {
       const { path } = this
       const { query } = request
@@ -205,7 +202,7 @@ export class RepeatPageController extends QuestionPageController {
     return (
       request: FormRequestPayload,
       context: FormContext,
-      h: Pick<ResponseToolkit, 'redirect' | 'view'>
+      h: FormResponseToolkit
     ) => {
       const { path, repeat } = this
       const { query } = request
@@ -269,7 +266,7 @@ export class RepeatPageController extends QuestionPageController {
     return (
       request: FormRequest,
       context: FormContext,
-      h: Pick<ResponseToolkit, 'redirect' | 'view'>
+      h: FormResponseToolkit
     ) => {
       const { viewModel } = this
       const { state } = context
@@ -304,7 +301,7 @@ export class RepeatPageController extends QuestionPageController {
     return async (
       request: FormRequestPayload,
       context: FormContext,
-      h: Pick<ResponseToolkit, 'redirect' | 'view'>
+      h: FormResponseToolkit
     ) => {
       const { repeat } = this
       const { state } = context

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

@@ -1,6 +1,6 @@
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { StartPageController } from '~/src/server/plugins/engine/pageControllers/StartPageController.js'
-import { serverWithSaveAndReturn } from '~/src/server/plugins/engine/pageControllers/__stubs__/server.js'
+import { serverWithSaveAndExit } from '~/src/server/plugins/engine/pageControllers/__stubs__/server.js'
 import definition from '~/test/form/definitions/basic.js'
 
 describe('StartPageController', () => {
@@ -22,9 +22,9 @@ describe('StartPageController', () => {
     controller = new StartPageController(model, mockPage as any)
   })
 
-  describe('shouldShowSaveAndReturn', () => {
-    it('should return false (StartPageController does not allow save and return)', () => {
-      expect(controller.shouldShowSaveAndReturn(serverWithSaveAndReturn)).toBe(
+  describe('shouldShowSaveAndExit', () => {
+    it('should return false (StartPageController does not allow save and exit)', () => {
+      expect(controller.shouldShowSaveAndExit(serverWithSaveAndExit)).toBe(
         false
       )
     })

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

@@ -9,7 +9,7 @@ export class StartPageController extends QuestionPageController {
    * but start pages should really live on gov.uk (whitehall publisher) so a user can be properly signposted.
    */
 
-  allowSaveAndReturn = false
+  allowSaveAndExit = false
 
   getViewModel(request: FormRequest, context: FormContext) {
     return {

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

@@ -1,6 +1,6 @@
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { StatusPageController } from '~/src/server/plugins/engine/pageControllers/StatusPageController.js'
-import { serverWithSaveAndReturn } from '~/src/server/plugins/engine/pageControllers/__stubs__/server.js'
+import { serverWithSaveAndExit } from '~/src/server/plugins/engine/pageControllers/__stubs__/server.js'
 import definition from '~/test/form/definitions/basic.js'
 
 describe('StatusPageController', () => {
@@ -22,9 +22,9 @@ describe('StatusPageController', () => {
     controller = new StatusPageController(model, mockPage as any)
   })
 
-  describe('shouldShowSaveAndReturn', () => {
-    it('should return false (StatusPageController does not allow save and return)', () => {
-      expect(controller.shouldShowSaveAndReturn(serverWithSaveAndReturn)).toBe(
+  describe('shouldShowSaveAndExit', () => {
+    it('should return false (StatusPageController does not allow save and exit)', () => {
+      expect(controller.shouldShowSaveAndExit(serverWithSaveAndExit)).toBe(
         false
       )
     })

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

@@ -1,15 +1,17 @@
 import { type PageStatus } from '@defra/forms-model'
-import { type ResponseToolkit } from '@hapi/hapi'
 
 import { getCacheService } from '~/src/server/plugins/engine/helpers.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
 import { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'
 import { type FormContext } from '~/src/server/plugins/engine/types.js'
-import { type FormRequest } from '~/src/server/routes/types.js'
+import {
+  type FormRequest,
+  type FormResponseToolkit
+} from '~/src/server/routes/types.js'
 
 export class StatusPageController extends QuestionPageController {
   declare pageDef: PageStatus
-  allowSaveAndReturn = false
+  allowSaveAndExit = false
 
   constructor(model: FormModel, pageDef: PageStatus) {
     super(model, pageDef)
@@ -24,7 +26,7 @@ export class StatusPageController extends QuestionPageController {
     return async (
       request: FormRequest,
       context: FormContext,
-      h: Pick<ResponseToolkit, 'redirect' | 'view'>
+      h: FormResponseToolkit
     ) => {
       const { viewModel, viewName } = this
 

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

@@ -5,7 +5,7 @@ import {
   type SubmitPayload
 } from '@defra/forms-model'
 import Boom from '@hapi/boom'
-import { type ResponseToolkit, type RouteOptions } from '@hapi/hapi'
+import { type RouteOptions } from '@hapi/hapi'
 
 import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
 import { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js'
@@ -30,13 +30,16 @@ import {
   type FormSubmissionState
 } from '~/src/server/plugins/engine/types.js'
 import {
+  FormAction,
   type FormRequest,
   type FormRequestPayload,
-  type FormRequestPayloadRefs
+  type FormRequestPayloadRefs,
+  type FormResponseToolkit
 } from '~/src/server/routes/types.js'
 
 export class SummaryPageController extends QuestionPageController {
   declare pageDef: Page
+  allowSaveAndExit = true
 
   /**
    * The controller which is used when Page["controller"] is defined as "./pages/summary.js"
@@ -69,7 +72,7 @@ export class SummaryPageController extends QuestionPageController {
     viewModel.feedbackLink = this.feedbackLink
     viewModel.phaseTag = this.phaseTag
     viewModel.components = components
-    viewModel.allowSaveAndReturn = this.shouldShowSaveAndReturn(request.server)
+    viewModel.allowSaveAndExit = this.shouldShowSaveAndExit(request.server)
 
     return viewModel
   }
@@ -81,7 +84,7 @@ export class SummaryPageController extends QuestionPageController {
     return async (
       request: FormRequest,
       context: FormContext,
-      h: Pick<ResponseToolkit, 'redirect' | 'view'>
+      h: FormResponseToolkit
     ) => {
       const { viewName } = this
 
@@ -102,10 +105,17 @@ export class SummaryPageController extends QuestionPageController {
     return async (
       request: FormRequestPayload,
       context: FormContext,
-      h: Pick<ResponseToolkit, 'redirect' | 'view'>
+      h: FormResponseToolkit
     ) => {
       const { model } = this
       const { params } = request
+
+      // Check if this is a save-and-exit action
+      const { action } = request.payload
+      if (action === FormAction.SaveAndExit) {
+        return this.handleSaveAndExit(request, context, h)
+      }
+
       const cacheService = getCacheService(request.server)
 
       const { formsService } = this.model.services

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

@@ -1,6 +1,6 @@
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { TerminalPageController } from '~/src/server/plugins/engine/pageControllers/TerminalPageController.js'
-import { serverWithSaveAndReturn } from '~/src/server/plugins/engine/pageControllers/__stubs__/server.js'
+import { serverWithSaveAndExit } from '~/src/server/plugins/engine/pageControllers/__stubs__/server.js'
 import definition from '~/test/form/definitions/basic.js'
 
 describe('TerminalController', () => {
@@ -27,9 +27,9 @@ describe('TerminalController', () => {
     })
   })
 
-  describe('shouldShowSaveAndReturn', () => {
-    it('should return false (TerminalPageController does not allow save and return)', () => {
-      expect(controller1.shouldShowSaveAndReturn(serverWithSaveAndReturn)).toBe(
+  describe('shouldShowSaveAndExit', () => {
+    it('should return false (TerminalPageController does not allow save and exit)', () => {
+      expect(controller1.shouldShowSaveAndExit(serverWithSaveAndExit)).toBe(
         false
       )
     })

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

@@ -1,19 +1,22 @@
 import { type PageTerminal } from '@defra/forms-model'
 import Boom from '@hapi/boom'
-import { type ResponseObject, type ResponseToolkit } from '@hapi/hapi'
+import { type ResponseObject } from '@hapi/hapi'
 
 import { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'
 import { type FormContext } from '~/src/server/plugins/engine/types.js'
-import { type FormRequestPayload } from '~/src/server/routes/types.js'
+import {
+  type FormRequestPayload,
+  type FormResponseToolkit
+} from '~/src/server/routes/types.js'
 
 export class TerminalPageController extends QuestionPageController {
   declare pageDef: PageTerminal
-  allowSaveAndReturn = false
+  allowSaveAndExit = false
 
   makePostRouteHandler(): (
     request: FormRequestPayload,
     context: FormContext,
-    h: Pick<ResponseToolkit, 'redirect' | 'view'>
+    h: FormResponseToolkit
   ) => Promise<ResponseObject> {
     throw Boom.methodNotAllowed('POST method not allowed for terminal pages')
   }

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

@@ -12,16 +12,15 @@ export const server: Server = {
   }
 } as Server // only mocking out properties we care about;
 
-export const serverWithSaveAndReturn: Server = {
+export const serverWithSaveAndExit: Server = {
   plugins: {
     ...server.plugins,
     'forms-engine-plugin': {
       ...server.plugins['forms-engine-plugin'],
-      saveAndReturn: {
-        keyGenerator: jest.fn().mockReturnValue('foobar'),
-        sessionHydrator: jest.fn().mockReturnValue({}),
-        sessionPersister: jest.fn().mockImplementation(() => Promise.resolve())
-      } as Pick<PluginOptions, 'saveAndReturn'>
+      saveAndExit: jest.fn().mockReturnValue({}) as Pick<
+        PluginOptions,
+        'saveAndExit'
+      >
     }
   }
 } as Server // only mocking out properties we care about

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

@@ -8,7 +8,6 @@ import {
 
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
 import { validatePluginOptions } from '~/src/server/plugins/engine/options.js'
-import { getRoutes as getSaveAndReturnExitRoutes } from '~/src/server/plugins/engine/routes/exit.js'
 import { getRoutes as getFileUploadStatusRoutes } from '~/src/server/plugins/engine/routes/file-upload.js'
 import { makeLoadFormPreHandler } from '~/src/server/plugins/engine/routes/index.js'
 import { getRoutes as getQuestionRoutes } from '~/src/server/plugins/engine/routes/questions.js'
@@ -31,28 +30,24 @@ export const plugin = {
 
     const {
       model,
-      cacheName,
-      saveAndReturn,
+      cache,
+      saveAndExit,
       nunjucks: nunjucksOptions,
       viewContext,
       preparePageEventRequestOptions
     } = options
 
-    const cacheService = new CacheService({
-      server,
-      cacheName,
-      options: {
-        keyGenerator: saveAndReturn?.keyGenerator,
-        sessionHydrator: saveAndReturn?.sessionHydrator
-      }
-    })
+    const cacheService =
+      typeof cache === 'string'
+        ? new CacheService({ server, cacheName: cache })
+        : cache
 
     await registerVision(server, options)
 
     server.expose('baseLayoutPath', nunjucksOptions.baseLayoutPath)
     server.expose('viewContext', viewContext)
     server.expose('cacheService', cacheService)
-    server.expose('saveAndReturn', saveAndReturn)
+    server.expose('saveAndExit', saveAndExit)
 
     server.app.model = model
 
@@ -92,7 +87,6 @@ export const plugin = {
       ),
       ...getRepeaterSummaryRoutes(getRouteOptions, postRouteOptions),
       ...getRepeaterItemDeleteRoutes(getRouteOptions, postRouteOptions),
-      ...getSaveAndReturnExitRoutes(getRouteOptions),
       ...getFileUploadStatusRoutes()
     ]
 

package/src/server/plugins/engine/routes/index.ts

@@ -21,17 +21,18 @@ import { type PageControllerClass } from '~/src/server/plugins/engine/pageContro
 import { generateUniqueReference } from '~/src/server/plugins/engine/referenceNumbers.js'
 import * as defaultServices from '~/src/server/plugins/engine/services/index.js'
 import {
+  type AnyFormRequest,
   type FormContext,
   type PluginOptions
 } from '~/src/server/plugins/engine/types.js'
 import {
   type FormRequest,
-  type FormRequestPayload
+  type FormResponseToolkit
 } from '~/src/server/routes/types.js'
 
 export async function redirectOrMakeHandler(
-  request: FormRequest | FormRequestPayload,
-  h: Pick<ResponseToolkit, 'redirect' | 'view'>,
+  request: AnyFormRequest,
+  h: FormResponseToolkit,
   makeHandler: (
     page: PageControllerClass,
     context: FormContext
@@ -92,10 +93,7 @@ export function makeLoadFormPreHandler(server: Server, options: PluginOptions) {
 
   const { formsService } = services
 
-  async function handler(
-    request: FormRequest | FormRequestPayload,
-    h: ResponseToolkit
-  ) {
+  async function handler(request: AnyFormRequest, h: ResponseToolkit) {
     if (server.app.model) {
       request.app.model = server.app.model
 
@@ -153,10 +151,12 @@ export function makeLoadFormPreHandler(server: Server, options: PluginOptions) {
           : `${prefix}/${slug}`
       ).substring(1)
 
+      const versionNumber = metadata.versions?.[0]?.versionNumber
+
       // Construct the form model
       const model = new FormModel(
         definition,
-        { basePath },
+        { basePath, versionNumber },
         services,
         controllers
       )
@@ -181,10 +181,7 @@ export function makeLoadFormPreHandler(server: Server, options: PluginOptions) {
   return handler
 }
 
-export function dispatchHandler(
-  request: FormRequest,
-  h: Pick<ResponseToolkit, 'redirect' | 'view'>
-) {
+export function dispatchHandler(request: FormRequest, h: FormResponseToolkit) {
   const { model } = request.app
 
   const servicePath = model ? `/${model.basePath}` : ''

package/src/server/plugins/engine/routes/questions.test.ts

@@ -1,5 +1,5 @@
 import Boom from '@hapi/boom'
-import { type ResponseObject, type ResponseToolkit } from '@hapi/hapi'
+import { type ResponseObject } from '@hapi/hapi'
 // eslint-disable-next-line n/no-unpublished-import
 import nock from 'nock'
 
@@ -10,10 +10,14 @@ import {
   makeGetHandler,
   makePostHandler
 } from '~/src/server/plugins/engine/routes/questions.js'
-import { type FormContext } from '~/src/server/plugins/engine/types.js'
+import {
+  type AnyFormRequest,
+  type FormContext
+} from '~/src/server/plugins/engine/types.js'
 import {
   type FormRequest,
-  type FormRequestPayload
+  type FormRequestPayload,
+  type FormResponseToolkit
 } from '~/src/server/routes/types.js'
 jest.mock('~/src/server/plugins/engine/models/SummaryViewModel', () => ({
   SummaryViewModel: class {
@@ -35,7 +39,7 @@ jest.mock('~/src/server/plugins/engine/outputFormatters/machine/v1', () => ({
 jest.mock('~/src/server/plugins/engine/routes/index')
 
 describe('makeGetHandler', () => {
-  const hMock: Pick<ResponseToolkit, 'redirect' | 'view'> = {
+  const hMock: FormResponseToolkit = {
     redirect: jest.fn(),
     view: jest.fn()
   }
@@ -64,7 +68,7 @@ describe('makeGetHandler', () => {
       (
         _request: FormRequest,
         context: FormContext,
-        _h: Pick<ResponseToolkit, 'redirect' | 'view'>
+        _h: FormResponseToolkit
       ) => {
         data = context.data
         return Promise.resolve({} as unknown as ResponseObject)
@@ -80,12 +84,8 @@ describe('makeGetHandler', () => {
 
     jest
       .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        (
-          _req: FormRequest | FormRequestPayload,
-          _h: Pick<ResponseToolkit, 'redirect' | 'view'>,
-          fn
-        ) => Promise.resolve(fn(pageMock, contextMock))
+      .mockImplementation((_req: AnyFormRequest, _h: FormResponseToolkit, fn) =>
+        Promise.resolve(fn(pageMock, contextMock))
       )
 
     await makeGetHandler()(requestMock, hMock)
@@ -108,7 +108,7 @@ describe('makeGetHandler', () => {
       (
         _request: FormRequest,
         context: FormContext,
-        _h: Pick<ResponseToolkit, 'redirect' | 'view'>
+        _h: FormResponseToolkit
       ) => {
         data = context.data
         return Promise.resolve({} as unknown as ResponseObject)
@@ -126,12 +126,8 @@ describe('makeGetHandler', () => {
 
     jest
       .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        (
-          _req: FormRequest | FormRequestPayload,
-          _h: Pick<ResponseToolkit, 'redirect' | 'view'>,
-          fn
-        ) => Promise.resolve(fn(pageMock, contextMock))
+      .mockImplementation((_req: AnyFormRequest, _h: FormResponseToolkit, fn) =>
+        Promise.resolve(fn(pageMock, contextMock))
       )
 
     await makeGetHandler()(requestMock, hMock)
@@ -152,7 +148,7 @@ describe('makeGetHandler', () => {
       (
         _request: FormRequest,
         _context: FormContext,
-        _h: Pick<ResponseToolkit, 'redirect' | 'view'>
+        _h: FormResponseToolkit
       ) => {
         return Promise.resolve({} as unknown as ResponseObject)
       }
@@ -168,11 +164,7 @@ describe('makeGetHandler', () => {
     jest
       .mocked(redirectOrMakeHandler)
       .mockImplementation(
-        async (
-          _req: FormRequest | FormRequestPayload,
-          _h: Pick<ResponseToolkit, 'redirect' | 'view'>,
-          fn
-        ) => {
+        async (_req: AnyFormRequest, _h: FormResponseToolkit, fn) => {
           try {
             await fn(pageMock, contextMock)
           } catch (err) {
@@ -190,7 +182,7 @@ describe('makeGetHandler', () => {
 })
 
 describe('makePostHandler', () => {
-  const hMock: Pick<ResponseToolkit, 'redirect' | 'view'> = {
+  const hMock: FormResponseToolkit = {
     redirect: jest.fn(),
     view: jest.fn()
   }
@@ -221,7 +213,7 @@ describe('makePostHandler', () => {
       (
         _request: FormRequest,
         _context: FormContext,
-        _h: Pick<ResponseToolkit, 'redirect' | 'view'>
+        _h: FormResponseToolkit
       ) => {
         // do return a valid ResponseObject wrapped in Promise.resolve
         return mockPostResponse
@@ -238,12 +230,8 @@ describe('makePostHandler', () => {
 
     jest
       .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        (
-          _req: FormRequest | FormRequestPayload,
-          _h: Pick<ResponseToolkit, 'redirect' | 'view'>,
-          fn
-        ) => Promise.resolve(fn(pageMock, contextMock))
+      .mockImplementation((_req: AnyFormRequest, _h: FormResponseToolkit, fn) =>
+        Promise.resolve(fn(pageMock, contextMock))
       )
 
     const response = await makePostHandler()(requestMock, hMock)
@@ -263,7 +251,7 @@ describe('makePostHandler', () => {
       (
         _request: FormRequest,
         _context: FormContext,
-        _h: Pick<ResponseToolkit, 'redirect' | 'view'>
+        _h: FormResponseToolkit
       ) => {
         return Promise.resolve({} as unknown as ResponseObject)
       }
@@ -281,12 +269,8 @@ describe('makePostHandler', () => {
 
     jest
       .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        (
-          _req: FormRequest | FormRequestPayload,
-          _h: Pick<ResponseToolkit, 'redirect' | 'view'>,
-          fn
-        ) => Promise.resolve(fn(pageMock, contextMock))
+      .mockImplementation((_req: AnyFormRequest, _h: FormResponseToolkit, fn) =>
+        Promise.resolve(fn(pageMock, contextMock))
       )
 
     await makePostHandler()(requestMock, hMock)
@@ -309,7 +293,7 @@ describe('makePostHandler', () => {
       (
         _request: FormRequest,
         _context: FormContext,
-        _h: Pick<ResponseToolkit, 'redirect' | 'view'>
+        _h: FormResponseToolkit
       ) => {
         // do return a valid ResponseObject wrapped in Promise.resolve
         return mockPostResponse
@@ -326,12 +310,8 @@ describe('makePostHandler', () => {
 
     jest
       .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        (
-          _req: FormRequest | FormRequestPayload,
-          _h: Pick<ResponseToolkit, 'redirect' | 'view'>,
-          fn
-        ) => Promise.resolve(fn(pageMock, contextMock))
+      .mockImplementation((_req: AnyFormRequest, _h: FormResponseToolkit, fn) =>
+        Promise.resolve(fn(pageMock, contextMock))
       )
 
     await makePostHandler()(requestMock, hMock)
@@ -352,7 +332,7 @@ describe('makePostHandler', () => {
       (
         _request: FormRequest,
         _context: FormContext,
-        _h: Pick<ResponseToolkit, 'redirect' | 'view'>
+        _h: FormResponseToolkit
       ) => {
         return Promise.resolve({} as unknown as ResponseObject)
       }
@@ -369,11 +349,7 @@ describe('makePostHandler', () => {
     jest
       .mocked(redirectOrMakeHandler)
       .mockImplementation(
-        async (
-          _req: FormRequest | FormRequestPayload,
-          _h: Pick<ResponseToolkit, 'redirect' | 'view'>,
-          fn
-        ) => {
+        async (_req: AnyFormRequest, _h: FormResponseToolkit, fn) => {
           try {
             await fn(pageMock, contextMock)
           } catch (err) {
@@ -395,7 +371,7 @@ function createMockPageController(
   routeHandler: (
     request: FormRequest,
     context: FormContext,
-    h: Pick<ResponseToolkit, 'redirect' | 'view'>
+    h: FormResponseToolkit
   ) => ResponseObject | Promise<ResponseObject>
 ): PageControllerClass {
   return {

package/src/server/plugins/engine/routes/questions.ts

@@ -2,7 +2,6 @@ import { hasFormComponents, slugSchema, type Event } from '@defra/forms-model'
 import Boom from '@hapi/boom'
 import {
   type ResponseObject,
-  type ResponseToolkit,
   type RouteOptions,
   type ServerRoute
 } from '@hapi/hapi'
@@ -25,6 +24,7 @@ import {
   redirectOrMakeHandler
 } from '~/src/server/plugins/engine/routes/index.js'
 import {
+  type AnyFormRequest,
   type FormContext,
   type PreparePageEventRequestOptions
 } from '~/src/server/plugins/engine/types.js'
@@ -32,7 +32,8 @@ import {
   type FormRequest,
   type FormRequestPayload,
   type FormRequestPayloadRefs,
-  type FormRequestRefs
+  type FormRequestRefs,
+  type FormResponseToolkit
 } from '~/src/server/routes/types.js'
 import {
   actionSchema,
@@ -44,7 +45,7 @@ import {
 import * as httpService from '~/src/server/services/httpService.js'
 
 async function handleHttpEvent(
-  request: FormRequest | FormRequestPayload,
+  request: AnyFormRequest,
   page: PageControllerClass,
   context: FormContext,
   event: Event,
@@ -75,10 +76,7 @@ async function handleHttpEvent(
 export function makeGetHandler(
   preparePageEventRequestOptions?: PreparePageEventRequestOptions
 ) {
-  return function getHandler(
-    request: FormRequest,
-    h: Pick<ResponseToolkit, 'redirect' | 'view'>
-  ) {
+  return function getHandler(request: FormRequest, h: FormResponseToolkit) {
     const { params } = request
 
     if (normalisePath(params.path) === '') {
@@ -116,7 +114,7 @@ export function makePostHandler(
 ) {
   return function postHandler(
     request: FormRequestPayload,
-    h: Pick<ResponseToolkit, 'redirect' | 'view'>
+    h: FormResponseToolkit
   ) {
     const { query } = request