allow plugin consumer to provide viewContext props

Author: alexluckett

src/server/plugins/engine/configureEnginePlugin.ts

@@ -27,7 +27,14 @@ export const configureEnginePlugin = async ({
 
   return {
     plugin,
-    options: { model, services, controllers, baseLayoutPath: 'layout.html' }
+    options: {
+      model,
+      services,
+      controllers,
+      viewContext: {
+        baseLayoutPath: 'layout.html'
+      }
+    }
   }
 }
 

src/server/plugins/engine/plugin.ts

@@ -73,7 +73,9 @@ export interface PluginOptions {
   viewPaths?: string[]
   filters?: Record<string, FilterFunction>
   pluginPath?: string
-  baseLayoutPath: string
+  viewContext: {
+    baseLayoutPath: string
+  }
 }
 
 export const plugin = {
@@ -89,7 +91,7 @@ export const plugin = {
       viewPaths,
       filters,
       pluginPath = PLUGIN_PATH,
-      baseLayoutPath
+      viewContext
     } = options
     const { formsService } = services
     const cacheService = new CacheService(server, cacheName)
@@ -150,7 +152,7 @@ export const plugin = {
       }
     })
 
-    server.expose('baseLayoutPath', baseLayoutPath)
+    server.expose('viewContext', viewContext)
     server.expose('cacheService', cacheService)
 
     server.app.model = model

src/server/plugins/engine/views/confirmation.html

@@ -1,4 +1,4 @@
-{% extends pluginOptions.baseLayoutPath %}
+{% extends baseLayoutPath %}
 
 {% from "govuk/components/panel/macro.njk" import govukPanel %}
 

src/server/plugins/engine/views/index.html

@@ -1,4 +1,4 @@
-{% extends pluginOptions.baseLayoutPath %}
+{% extends baseLayoutPath %}
 
 {% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
 {% from "partials/components.html" import componentList with context %}

src/server/plugins/engine/views/item-delete.html

@@ -1,4 +1,4 @@
-{% extends pluginOptions.baseLayoutPath %}
+{% extends baseLayoutPath %}
 
 {% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
 {% from "govuk/components/button/macro.njk" import govukButton %}

src/server/plugins/engine/views/repeat-list-summary.html

@@ -1,4 +1,4 @@
-{% extends pluginOptions.baseLayoutPath %}
+{% extends baseLayoutPath %}
 
 {% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
 {% from "govuk/components/button/macro.njk" import govukButton %}

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

@@ -1,4 +1,4 @@
-{% extends pluginOptions.baseLayoutPath %}
+{% extends baseLayoutPath %}
 
 {% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
 {% from "govuk/components/summary-list/macro.njk" import govukSummaryList %}

src/server/plugins/nunjucks/context.js

@@ -46,6 +46,7 @@ export function context(request) {
 
   /** @type {ViewContext} */
   const ctx = {
+    ...request?.server.plugins['forms-engine-plugin'].viewContext, // take consumers props first so we can override it
     appVersion: pkg.version,
     assetPath: '/assets',
     config: {
@@ -57,10 +58,6 @@ export function context(request) {
       serviceName: config.get('serviceName'),
       serviceVersion: config.get('serviceVersion')
     },
-    pluginOptions: {
-      baseLayoutPath:
-        request?.server.plugins['forms-engine-plugin'].baseLayoutPath
-    },
     crumb: safeGenerateCrumb(request),
     cspNonce: request?.plugins.blankie?.nonces?.script,
     currentPath: request ? `${request.path}${request.url.search}` : undefined,

src/server/plugins/nunjucks/types.js

@@ -9,11 +9,6 @@
  * @property {object} [context] - Nunjucks render context
  */
 
-/**
- * @typedef {object} PluginOptions
- * @property {string} [baseLayoutPath] - Page layout to extend
- */
-
 /**
  * @typedef {object} ViewContext - Nunjucks view context
  * @property {string} appVersion - Application version
@@ -27,7 +22,7 @@
  * @property {string} [slug] - Form slug
  * @property {(asset?: string) => string} getAssetPath - Asset path resolver
  * @property {FormContext} [context] - the current form context
- * @property {PluginOptions} [pluginOptions] - the current form context
+ * @property {PluginOptions['viewContext']} [injectedViewContext] - the current form context
  */
 
 /**
@@ -43,4 +38,5 @@
  * @import { CookieConsent } from '~/src/common/types.js'
  * @import { config } from '~/src/config/index.js'
  * @import { FormContext } from '~/src/server/plugins/engine/types.js'
+ * @import { PluginOptions } from '~/src/server/plugins/engine/plugin.js'
  */

src/typings/hapi/index.d.ts

@@ -5,6 +5,7 @@ import { type ServerYar, type Yar } from '@hapi/yar'
 import { type Logger } from 'pino'
 
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
+import { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'
 import {
   type FormRequest,
   type FormRequestPayload
@@ -20,7 +21,7 @@ declare module '@hapi/hapi' {
     }
     'forms-engine-plugin': {
       cacheService: CacheService
-      baseLayoutPath: string
+      viewContext: ViewContext
     }
   }