@defra/forms-engine-plugin 3.0.9 → 4.0.0

package/src/server/plugins/engine/routes/repeaters/summary.test.ts

@@ -0,0 +1,75 @@
+import { getRoutes } from '~/src/server/plugins/engine/routes/repeaters/summary.js'
+import { type OnRequestCallback } from '~/src/server/plugins/engine/types.js'
+
+describe('repeater summary routes', () => {
+  describe('route configuration', () => {
+    it('should return all expected routes', () => {
+      const routes = getRoutes({}, {}, undefined)
+
+      expect(routes).toHaveLength(4)
+
+      const expectedPaths = [
+        '/{slug}/{path}/summary',
+        '/preview/{state}/{slug}/{path}/summary'
+      ]
+
+      expectedPaths.forEach((path) => {
+        const getRoute = routes.find(
+          (route) => route.method === 'get' && route.path === path
+        )
+        const postRoute = routes.find(
+          (route) => route.method === 'post' && route.path === path
+        )
+
+        expect(getRoute).toBeDefined()
+        expect(postRoute).toBeDefined()
+      })
+    })
+
+    it('should pass onRequest callback to handlers', () => {
+      const onRequestCallback: OnRequestCallback = jest
+        .fn()
+        .mockResolvedValue(undefined)
+      const routes = getRoutes({}, {}, onRequestCallback)
+
+      // Test that the handlers are created with the onRequest callback
+      const getRoute = routes.find(
+        (route) =>
+          route.method === 'get' && route.path === '/{slug}/{path}/summary'
+      )
+      const postRoute = routes.find(
+        (route) =>
+          route.method === 'post' && route.path === '/{slug}/{path}/summary'
+      )
+
+      expect(getRoute?.handler).toBeDefined()
+      expect(postRoute?.handler).toBeDefined()
+    })
+  })
+
+  describe('handler functionality', () => {
+    it('should create handlers that accept onRequest callback', () => {
+      const onRequestCallback: OnRequestCallback = jest
+        .fn()
+        .mockResolvedValue(undefined)
+      const routes = getRoutes({}, {}, onRequestCallback)
+
+      // Test that the handlers are created with the onRequest callback
+      const getRoute = routes.find(
+        (route) =>
+          route.method === 'get' && route.path === '/{slug}/{path}/summary'
+      )
+      const postRoute = routes.find(
+        (route) =>
+          route.method === 'post' && route.path === '/{slug}/{path}/summary'
+      )
+
+      expect(getRoute?.handler).toBeDefined()
+      expect(postRoute?.handler).toBeDefined()
+
+      // Test that handlers are functions
+      expect(typeof getRoute?.handler).toBe('function')
+      expect(typeof postRoute?.handler).toBe('function')
+    })
+  })
+})

package/src/server/plugins/engine/routes/repeaters/summary.ts

@@ -6,6 +6,7 @@ import Joi from 'joi'
 
 import { RepeatPageController } from '~/src/server/plugins/engine/pageControllers/RepeatPageController.js'
 import { redirectOrMakeHandler } from '~/src/server/plugins/engine/routes/index.js'
+import { type OnRequestCallback } from '~/src/server/plugins/engine/types.js'
 import {
   type FormRequest,
   type FormRequestPayload,
@@ -20,41 +21,46 @@ import {
   stateSchema
 } from '~/src/server/schemas/index.js'
 
-function getHandler(request: FormRequest, h: FormResponseToolkit) {
-  const { params } = request
+function getHandler(onRequest?: OnRequestCallback) {
+  return async function (request: FormRequest, h: FormResponseToolkit) {
+    const { params } = request
 
-  return redirectOrMakeHandler(request, h, (page, context) => {
-    if (!(page instanceof RepeatPageController)) {
-      throw Boom.notFound(`No repeater page found for /${params.path}`)
-    }
+    return redirectOrMakeHandler(request, h, onRequest, (page, context) => {
+      if (!(page instanceof RepeatPageController)) {
+        throw Boom.notFound(`No repeater page found for /${params.path}`)
+      }
 
-    return page.makeGetListSummaryRouteHandler()(request, context, h)
-  })
+      return page.makeGetListSummaryRouteHandler()(request, context, h)
+    })
+  }
 }
 
-function postHandler(request: FormRequestPayload, h: FormResponseToolkit) {
-  const { params } = request
+function postHandler(onRequest?: OnRequestCallback) {
+  return async function (request: FormRequestPayload, h: FormResponseToolkit) {
+    const { params } = request
 
-  return redirectOrMakeHandler(request, h, (page, context) => {
-    const { isForceAccess } = context
+    return redirectOrMakeHandler(request, h, onRequest, (page, context) => {
+      const { isForceAccess } = context
 
-    if (isForceAccess || !(page instanceof RepeatPageController)) {
-      throw Boom.notFound(`No repeater page found for /${params.path}`)
-    }
+      if (isForceAccess || !(page instanceof RepeatPageController)) {
+        throw Boom.notFound(`No repeater page found for /${params.path}`)
+      }
 
-    return page.makePostListSummaryRouteHandler()(request, context, h)
-  })
+      return page.makePostListSummaryRouteHandler()(request, context, h)
+    })
+  }
 }
 
 export function getRoutes(
   getRouteOptions: RouteOptions<FormRequestRefs>,
-  postRouteOptions: RouteOptions<FormRequestPayloadRefs>
+  postRouteOptions: RouteOptions<FormRequestPayloadRefs>,
+  onRequest?: OnRequestCallback
 ): (ServerRoute<FormRequestRefs> | ServerRoute<FormRequestPayloadRefs>)[] {
   return [
     {
       method: 'get',
       path: '/{slug}/{path}/summary',
-      handler: getHandler,
+      handler: getHandler(onRequest),
       options: {
         ...getRouteOptions,
         validate: {
@@ -69,7 +75,7 @@ export function getRoutes(
     {
       method: 'get',
       path: '/preview/{state}/{slug}/{path}/summary',
-      handler: getHandler,
+      handler: getHandler(onRequest),
       options: {
         ...getRouteOptions,
         validate: {
@@ -85,7 +91,7 @@ export function getRoutes(
     {
       method: 'post',
       path: '/{slug}/{path}/summary',
-      handler: postHandler,
+      handler: postHandler(onRequest),
       options: {
         ...postRouteOptions,
         validate: {
@@ -106,7 +112,7 @@ export function getRoutes(
     {
       method: 'post',
       path: '/preview/{state}/{slug}/{path}/summary',
-      handler: postHandler,
+      handler: postHandler(onRequest),
       options: {
         ...postRouteOptions,
         validate: {

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

@@ -1,8 +1,6 @@
 import {
   type ComponentDef,
   type Event,
-  type FormDefinition,
-  type FormMetadata,
   type FormVersionMetadata,
   type Item,
   type List,
@@ -38,7 +36,6 @@ import {
 import { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'
 import {
   type FormAction,
-  type FormParams,
   type FormRequest,
   type FormRequestPayload,
   type FormResponseToolkit,
@@ -368,10 +365,12 @@ export type PreparePageEventRequestOptions = (
 
 export type OnRequestCallback = (
   request: AnyFormRequest,
-  params: FormParams,
-  definition: FormDefinition,
-  metadata: FormMetadata
-) => void
+  h: FormResponseToolkit,
+  context: FormContext
+) =>
+  | ResponseObject
+  | FormResponseToolkit['continue']
+  | Promise<ResponseObject | FormResponseToolkit['continue']>
 
 export type SaveAndExitHandler = (
   request: FormRequestPayload,

package/src/server/routes/types.ts

@@ -37,7 +37,10 @@ export interface FormRequestPayloadRefs extends FormRequestRefs {
 
 export type FormRequest = Request<FormRequestRefs>
 export type FormRequestPayload = Request<FormRequestPayloadRefs>
-export type FormResponseToolkit = Pick<ResponseToolkit, 'redirect' | 'view'>
+export type FormResponseToolkit = Pick<
+  ResponseToolkit,
+  'redirect' | 'view' | 'continue'
+>
 
 export enum FormAction {
   Continue = 'continue',