@defra/forms-engine-plugin 1.0.1 → 1.0.3

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

@@ -0,0 +1,137 @@
+// List summary GET route
+import { slugSchema } from '@defra/forms-model'
+import Boom from '@hapi/boom'
+import {
+  type ResponseToolkit,
+  type RouteOptions,
+  type ServerRoute
+} from '@hapi/hapi'
+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 FormRequest,
+  type FormRequestPayload,
+  type FormRequestPayloadRefs,
+  type FormRequestRefs
+} from '~/src/server/routes/types.js'
+import {
+  actionSchema,
+  crumbSchema,
+  pathSchema,
+  stateSchema
+} from '~/src/server/schemas/index.js'
+
+function getHandler(
+  request: FormRequest,
+  h: Pick<ResponseToolkit, 'redirect' | 'view'>
+) {
+  const { params } = request
+
+  return redirectOrMakeHandler(request, h, (page, context) => {
+    if (!(page instanceof RepeatPageController)) {
+      throw Boom.notFound(`No repeater page found for /${params.path}`)
+    }
+
+    return page.makeGetListSummaryRouteHandler()(request, context, h)
+  })
+}
+
+function postHandler(
+  request: FormRequestPayload,
+  h: Pick<ResponseToolkit, 'redirect' | 'view'>
+) {
+  const { params } = request
+
+  return redirectOrMakeHandler(request, h, (page, context) => {
+    const { isForceAccess } = context
+
+    if (isForceAccess || !(page instanceof RepeatPageController)) {
+      throw Boom.notFound(`No repeater page found for /${params.path}`)
+    }
+
+    return page.makePostListSummaryRouteHandler()(request, context, h)
+  })
+}
+
+export function getRoutes(
+  getRouteOptions: RouteOptions<FormRequestRefs>,
+  postRouteOptions: RouteOptions<FormRequestPayloadRefs>
+): (ServerRoute<FormRequestRefs> | ServerRoute<FormRequestPayloadRefs>)[] {
+  return [
+    {
+      method: 'get',
+      path: '/{slug}/{path}/summary',
+      handler: getHandler,
+      options: {
+        ...getRouteOptions,
+        validate: {
+          params: Joi.object().keys({
+            slug: slugSchema,
+            path: pathSchema
+          })
+        }
+      }
+    },
+
+    {
+      method: 'get',
+      path: '/preview/{state}/{slug}/{path}/summary',
+      handler: getHandler,
+      options: {
+        ...getRouteOptions,
+        validate: {
+          params: Joi.object().keys({
+            state: stateSchema,
+            slug: slugSchema,
+            path: pathSchema
+          })
+        }
+      }
+    },
+
+    {
+      method: 'post',
+      path: '/{slug}/{path}/summary',
+      handler: postHandler,
+      options: {
+        ...postRouteOptions,
+        validate: {
+          params: Joi.object().keys({
+            slug: slugSchema,
+            path: pathSchema
+          }),
+          payload: Joi.object()
+            .keys({
+              crumb: crumbSchema,
+              action: actionSchema
+            })
+            .required()
+        }
+      }
+    },
+
+    {
+      method: 'post',
+      path: '/preview/{state}/{slug}/{path}/summary',
+      handler: postHandler,
+      options: {
+        ...postRouteOptions,
+        validate: {
+          params: Joi.object().keys({
+            state: stateSchema,
+            slug: slugSchema,
+            path: pathSchema
+          }),
+          payload: Joi.object()
+            .keys({
+              crumb: crumbSchema,
+              action: actionSchema
+            })
+            .required()
+        }
+      }
+    }
+  ]
+}

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

@@ -4,6 +4,7 @@ import {
   type List,
   type Page
 } from '@defra/forms-model'
+import { type PluginProperties, type Request } from '@hapi/hapi'
 import { type JoiExpression, type ValidationErrorItem } from 'joi'
 
 import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'
@@ -13,10 +14,16 @@ import {
   type ComponentText,
   type ComponentViewModel
 } from '~/src/server/plugins/engine/components/types.js'
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
 import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'
 import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'
 import { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'
-import { type FormAction, type FormRequest } from '~/src/server/routes/types.js'
+import {
+  type FormAction,
+  type FormRequest,
+  type FormRequestPayload
+} from '~/src/server/routes/types.js'
+import { type Services } from '~/src/server/types.js'
 
 /**
  * Form submission state stores the following in Redis:
@@ -325,3 +332,21 @@ export interface ErrorMessageTemplateList {
   baseErrors: ErrorMessageTemplate[]
   advancedSettingsErrors: ErrorMessageTemplate[]
 }
+
+export interface PluginOptions {
+  model?: FormModel
+  services?: Services
+  controllers?: Record<string, typeof PageController>
+  cacheName?: string
+  filters?: Record<string, FilterFunction>
+  keyGenerator?: (request: Request | FormRequest | FormRequestPayload) => string
+  sessionHydrator?: (
+    request: Request | FormRequest | FormRequestPayload
+  ) => Promise<FormSubmissionState>
+  pluginPath?: string
+  nunjucks: {
+    baseLayoutPath: string
+    paths: string[]
+  }
+  viewContext: PluginProperties['forms-engine-plugin']['viewContext']
+}

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

@@ -0,0 +1,95 @@
+import { existsSync } from 'fs'
+import { dirname, join } from 'path'
+import { fileURLToPath } from 'url'
+
+import { type Server } from '@hapi/hapi'
+import vision from '@hapi/vision'
+import nunjucks, { type Environment } from 'nunjucks'
+import resolvePkg from 'resolve'
+
+import {
+  VIEW_PATH,
+  context,
+  prepareNunjucksEnvironment
+} from '~/src/server/plugins/engine/index.js'
+import { type PluginOptions } from '~/src/server/plugins/engine/types.js'
+
+export async function registerVision(
+  server: Server,
+  pluginOptions: PluginOptions
+) {
+  const packageRoot = findPackageRoot()
+  const govukFrontendPath = dirname(
+    resolvePkg.sync('govuk-frontend/package.json')
+  )
+
+  const viewPathResolved = join(packageRoot, VIEW_PATH)
+
+  const paths = [
+    ...pluginOptions.nunjucks.paths,
+    viewPathResolved,
+    join(govukFrontendPath, 'dist')
+  ]
+
+  await server.register({
+    plugin: vision,
+    options: {
+      engines: {
+        html: {
+          compile: (
+            path: string,
+            compileOptions: { environment: Environment }
+          ) => {
+            const template = nunjucks.compile(path, compileOptions.environment)
+
+            return (context: object | undefined) => {
+              return template.render(context)
+            }
+          },
+          prepare: (
+            options: EngineConfigurationObject,
+            next: (err?: Error) => void
+          ) => {
+            // Nunjucks also needs an additional path configuration
+            // to use the templates and macros from `govuk-frontend`
+            const environment = nunjucks.configure(paths)
+
+            // Applies custom filters and globals for nunjucks
+            // that are required by the `forms-engine-plugin`
+            prepareNunjucksEnvironment(environment, pluginOptions.filters)
+
+            options.compileOptions.environment = environment
+
+            next()
+          }
+        }
+      },
+      path: paths,
+      // Provides global context used with all templates
+      context
+    }
+  })
+}
+
+interface CompileOptions {
+  environment: Environment
+}
+
+export interface EngineConfigurationObject {
+  compileOptions: CompileOptions
+}
+
+export function findPackageRoot() {
+  const currentFileName = fileURLToPath(import.meta.url)
+  const currentDirectoryName = dirname(currentFileName)
+
+  let dir = currentDirectoryName
+  while (dir !== '/') {
+    if (existsSync(join(dir, 'package.json'))) {
+      return dir
+    }
+    dir = dirname(dir)
+  }
+
+  throw new Error('package.json not found in parent directories')
+}