@defra/forms-engine-plugin 0.1.11 → 0.1.12

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

@@ -1,5 +1,6 @@
 import { type ResponseToolkit } from '@hapi/hapi'
 
+import { FORM_PREFIX } from '~/src/server/constants.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'
 import { type FormRequest } from '~/src/server/routes/types.js'
@@ -10,6 +11,8 @@ describe('PageController', () => {
   let controller1: PageController
   let controller2: PageController
 
+  const testBasePath = `${FORM_PREFIX}/test`
+
   beforeEach(() => {
     const { pages } = definition
 
@@ -17,7 +20,7 @@ describe('PageController', () => {
     const page2 = pages[1]
 
     model = new FormModel(definition, {
-      basePath: 'test'
+      basePath: testBasePath
     })
 
     controller1 = new PageController(model, page1)
@@ -31,8 +34,8 @@ describe('PageController', () => {
     })
 
     it('returns href', () => {
-      expect(controller1).toHaveProperty('href', '/test/licence')
-      expect(controller2).toHaveProperty('href', '/test/full-name')
+      expect(controller1).toHaveProperty('href', `${testBasePath}/licence`)
+      expect(controller2).toHaveProperty('href', `${testBasePath}/full-name`)
     })
 
     it('returns keys (empty)', () => {
@@ -99,11 +102,11 @@ describe('PageController', () => {
   describe('Path methods', () => {
     describe('Link href', () => {
       it('prefixes paths into link hrefs', () => {
-        const href1 = controller1.getHref('/')
+        const href1 = controller1.getHref('')
         const href2 = controller1.getHref('/page-one')
 
-        expect(href1).toBe('/test')
-        expect(href2).toBe('/test/page-one')
+        expect(href1).toBe(testBasePath)
+        expect(href2).toBe(`${testBasePath}/page-one`)
       })
     })
 

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

@@ -135,12 +135,22 @@ export class PageController {
     return def.phaseBanner?.phase
   }
 
-  getHref(path: string) {
-    const { model } = this
+  getHref(path: string): string {
+    const basePath = this.model.basePath
 
-    return path === '/'
-      ? `/${model.basePath}` // Strip trailing slash
-      : `/${model.basePath}${path}`
+    if (path === '/') {
+      return `/${basePath}`
+    }
+
+    // if ever the path is not prefixed with a slash, add it
+    const relativeTargetPath = path.startsWith('/') ? path.substring(1) : path
+    let finalPath = `/${basePath}`
+    if (relativeTargetPath) {
+      finalPath += `/${relativeTargetPath}`
+    }
+    finalPath = finalPath.replace(/\/{2,}/g, '/')
+
+    return finalPath
   }
 
   getStartPath() {

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

@@ -398,7 +398,7 @@ export class QuestionPageController extends PageController {
       const { evaluationState } = context
 
       const viewModel = this.getViewModel(request, context)
-      viewModel.errors = collection.getErrors(viewModel.errors)
+      viewModel.errors = collection.getViewErrors(viewModel.errors)
 
       /**
        * Content components can be hidden based on a condition. If the condition evaluates to true, it is safe to be kept, otherwise discard it
@@ -498,7 +498,7 @@ export class QuestionPageController extends PageController {
        */
       if (context.errors || isForceAccess) {
         const viewModel = this.getViewModel(request, context)
-        viewModel.errors = collection.getErrors(viewModel.errors)
+        viewModel.errors = collection.getViewErrors(viewModel.errors)
 
         // Filter our components based on their conditions using our evaluated state
         viewModel.components = this.filterConditionalComponents(

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

@@ -1,7 +1,12 @@
-import { type PageSummary, type SubmitPayload } from '@defra/forms-model'
+import {
+  hasComponentsEvenIfNoNext,
+  type Page,
+  type SubmitPayload
+} from '@defra/forms-model'
 import Boom from '@hapi/boom'
 import { type ResponseToolkit, 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'
 import { getAnswer } from '~/src/server/plugins/engine/components/helpers.js'
 import {
@@ -30,15 +35,21 @@ import {
 } from '~/src/server/routes/types.js'
 
 export class SummaryPageController extends QuestionPageController {
-  declare pageDef: PageSummary
+  declare pageDef: Page
 
   /**
    * The controller which is used when Page["controller"] is defined as "./pages/summary.js"
    */
 
-  constructor(model: FormModel, pageDef: PageSummary) {
+  constructor(model: FormModel, pageDef: Page) {
     super(model, pageDef)
     this.viewName = 'summary'
+
+    // Components collection
+    this.collection = new ComponentCollection(
+      hasComponentsEvenIfNoNext(pageDef) ? pageDef.components : [],
+      { model, page: this }
+    )
   }
 
   getSummaryViewModel(
@@ -47,11 +58,16 @@ export class SummaryPageController extends QuestionPageController {
   ): SummaryViewModel {
     const viewModel = new SummaryViewModel(request, this, context)
 
+    const { query } = request
+    const { payload, errors } = context
+    const components = this.collection.getViewModel(payload, errors, query)
+
     // We already figure these out in the base page controller. Take them and apply them to our page-specific model.
     // This is a stop-gap until we can add proper inheritance in place.
     viewModel.backLink = this.getBackLink(request, context)
     viewModel.feedbackLink = this.feedbackLink
     viewModel.phaseTag = this.phaseTag
+    viewModel.components = components
 
     return viewModel
   }
@@ -96,7 +112,7 @@ export class SummaryPageController extends QuestionPageController {
 
       // Get the form metadata using the `slug` param
       const { notificationEmail } = await getFormMetadata(params.slug)
-      const { isPreview } = checkFormStatus(request.path)
+      const { isPreview } = checkFormStatus(request.params)
       const emailAddress = notificationEmail ?? this.model.def.outputEmail
 
       checkEmailAddressForLiveFormSubmission(emailAddress, isPreview)
@@ -138,8 +154,7 @@ async function submitForm(
 ) {
   await extendFileRetention(model, state, emailAddress)
 
-  const { path } = request
-  const formStatus = checkFormStatus(path)
+  const formStatus = checkFormStatus(request.params)
   const logTags = ['submit', 'submissionApi']
 
   request.logger.info(logTags, 'Preparing email', formStatus)

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

@@ -1,32 +1,45 @@
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 // Declaration above is needed for: https://github.com/hapijs/joi/issues/3064
 
-import joi, { type LanguageMessages, type ValidationOptions } from 'joi'
+import joi, {
+  type JoiExpression,
+  type LanguageMessages,
+  type LanguageMessagesExt,
+  type ReferenceOptions,
+  type ValidationOptions
+} from 'joi'
 import lowerFirst from 'lodash/lowerFirst.js'
 
 const opts = {
   functions: {
     lowerFirst
   }
-}
+} as ReferenceOptions
 
 /**
  * see @link https://joi.dev/api/?v=17.4.2#template-syntax for template syntax
  */
-export const messageTemplate = {
-  // @ts-expect-error - joi.expression options type issue
-  required: joi.expression('Enter {{lowerFirst(#label)}}', opts),
-  // @ts-expect-error - joi.expression options type issue
-  selectRequired: joi.expression('Select {{lowerFirst(#label)}}', opts),
+export const messageTemplate: Record<string, JoiExpression> = {
+  required: joi.expression(
+    'Enter {{lowerFirst(#label)}}',
+    opts
+  ) as JoiExpression,
+  selectRequired: joi.expression(
+    'Select {{lowerFirst(#label)}}',
+    opts
+  ) as JoiExpression,
+  selectYesNoRequired: '{{#label}} - select yes or no',
   max: '{{#label}} must be {{#limit}} characters or less',
   min: '{{#label}} must be {{#limit}} characters or more',
-  // @ts-expect-error - joi.expression options type issue
-  pattern: joi.expression('Enter a valid {{lowerFirst(#label)}}', opts),
+  minMax: '{{#label}} must be between {{#min}} and {{#max}} characters',
+  pattern: joi.expression(
+    'Enter a valid {{lowerFirst(#label)}}',
+    opts
+  ) as JoiExpression,
   format: joi.expression(
     'Enter {{lowerFirst(#label)}} in the correct format',
-    // @ts-expect-error - joi.expression options type issue
     opts
-  ),
+  ) as JoiExpression,
   number: '{{#label}} must be a number',
   numberPrecision: '{{#label}} must have {{#limit}} or fewer decimal places',
   numberInteger: '{{#label}} must be a whole number',
@@ -36,19 +49,17 @@ export const messageTemplate = {
 
   // Nested fields use component title
 
-  // @ts-expect-error - joi.expression options type issue
-  objectRequired: joi.expression('Enter {{#label}}', opts),
+  objectRequired: joi.expression('Enter {{#label}}', opts) as JoiExpression,
   objectMissing: joi.expression(
     '{{#title}} must include a {{lowerFirst(#label)}}',
-    // @ts-expect-error - joi.expression options type issue
     opts
-  ),
+  ) as JoiExpression,
   dateFormat: '{{#title}} must be a real date',
   dateMin: '{{#title}} must be the same as or after {{#limit}}',
   dateMax: '{{#title}} must be the same as or before {{#limit}}'
 }
 
-export const messages: LanguageMessages = {
+export const messages: LanguageMessagesExt = {
   'string.base': messageTemplate.required,
   'string.min': messageTemplate.min,
   'string.empty': messageTemplate.required,
@@ -77,9 +88,12 @@ export const messages: LanguageMessages = {
   'date.max': messageTemplate.dateMax
 }
 
+export const messagesPre: LanguageMessages =
+  messages as unknown as LanguageMessages
+
 export const validationOptions: ValidationOptions = {
   abortEarly: false,
-  messages,
+  messages: messagesPre,
   errors: {
     wrap: {
       array: false,

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

@@ -105,6 +105,8 @@ export const plugin = {
   dependencies: ['@hapi/crumb', '@hapi/yar', 'hapi-pino'],
   multiple: true,
   async register(server: Server, options: PluginOptions) {
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- hapi types are wrong
+    const prefix = server.realm.modifiers.route.prefix ?? ''
     const {
       model,
       services = defaultServices,
@@ -193,9 +195,9 @@ export const plugin = {
         return h.continue
       }
 
-      const { params, path } = request
+      const { params } = request
       const { slug } = params
-      const { isPreview, state: formState } = checkFormStatus(path)
+      const { isPreview, state: formState } = checkFormStatus(params)
 
       // Get the form metadata using the `slug` param
       const metadata = await formsService.getFormMetadata(slug)
@@ -241,9 +243,11 @@ export const plugin = {
         )
 
         // Set up the basePath for the model
-        const basePath = isPreview
-          ? `${PREVIEW_PATH_PREFIX.substring(1)}/${formState}/${slug}`
-          : slug
+        const basePath = (
+          isPreview
+            ? `${prefix}${PREVIEW_PATH_PREFIX}/${formState}/${slug}`
+            : `${prefix}/${slug}`
+        ).substring(1)
 
         // Construct the form model
         const model = new FormModel(

package/src/server/plugins/engine/services/notifyService.ts

@@ -19,8 +19,7 @@ export async function submit(
   submitResponse: SubmitResponsePayload
 ) {
   const logTags = ['submit', 'email']
-  const { path } = request
-  const formStatus = checkFormStatus(path)
+  const formStatus = checkFormStatus(request.params)
 
   // Get submission email personalisation
   request.logger.info(logTags, 'Getting personalisation data')

package/src/server/plugins/engine/services/uploadService.js

@@ -10,12 +10,19 @@ const stagingPrefix = config.get('stagingPrefix')
  * Initiates a CDP file upload
  * @param {string} path - the path of the page in the form
  * @param {string} retrievalKey - the retrieval key for the files
- * @param {string} [mimeTypes] - the csv string of accepted mimeTypes
+ * @param {string} [mimeTypesCsv] - the csv string of accepted mimeTypes
  */
-export async function initiateUpload(path, retrievalKey, mimeTypes) {
+export async function initiateUpload(path, retrievalKey, mimeTypesCsv) {
   const postJsonByType =
     /** @type {typeof postJson<UploadInitiateResponse>} */ (postJson)
 
+  const mimeTypesList = mimeTypesCsv
+    ?.split(',')
+    .map((type) => type.trim())
+    .filter((type) => type !== '')
+
+  const mimeTypes = mimeTypesList?.length ? mimeTypesList : undefined
+
   const payload = {
     redirect: path,
     callback: `${submissionUrl}/file`,
@@ -24,10 +31,7 @@ export async function initiateUpload(path, retrievalKey, mimeTypes) {
     metadata: {
       retrievalKey
     },
-    mimeTypes: mimeTypes
-      ?.split(',')
-      .map((type) => type.trim())
-      .filter((type) => type !== '')
+    mimeTypes
     // maxFileSize: 25 * 1000 * 1000
   }
 

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

@@ -4,7 +4,7 @@ import {
   type List,
   type Page
 } from '@defra/forms-model'
-import { type ValidationErrorItem } from 'joi'
+import { type JoiExpression, type ValidationErrorItem } from 'joi'
 
 import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'
 import { type Component } from '~/src/server/plugins/engine/components/helpers.js'
@@ -316,3 +316,12 @@ export type PageViewModel =
   | FeaturedFormPageViewModel
 
 export type FilterFunction = (value: unknown) => unknown
+export interface ErrorMessageTemplate {
+  type: string
+  template: JoiExpression
+}
+
+export interface ErrorMessageTemplateList {
+  baseErrors: ErrorMessageTemplate[]
+  advancedSettingsErrors: ErrorMessageTemplate[]
+}

package/src/server/plugins/engine/views/components/html.html

@@ -1,3 +1,3 @@
 {% macro Html(component) %}
-    {{ component.model.content | safe }}
+  {{ component.model.content | safe }}
 {% endmacro %}

package/src/server/plugins/engine/views/components/markdown.html

@@ -0,0 +1,5 @@
+{% macro Markdown(component) %}
+  <div class="app-prose-scope">
+    {{ component.model.content | markdown | safe }}
+  </div>
+{% endmacro %}

package/src/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 "partials/components.html" import componentList with context %}
 
 {% block content %}
   <div class="govuk-grid-row">
@@ -34,11 +35,16 @@
 
         {% if declaration %}
           <h2 class="govuk-heading-m" id="declaration">Declaration</h2>
+          <div class="govuk-body">
           {{ declaration | safe }}
+          </div>
         {% endif %}
 
+        {{ 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 declaration else "Send" }}
+          {{ "Accept and send" if isDeclaration else "Send" }}
         </button>
       </form>
     </div>

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

@@ -7,8 +7,8 @@ import { StatusCodes } from 'http-status-codes'
 import pkg from '~/package.json' with { type: 'json' }
 import { config } from '~/src/config/index.js'
 import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
-import { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'
 import {
+  checkFormStatus,
   encodeUrl,
   safeGenerateCrumb
 } from '~/src/server/plugins/engine/helpers.js'
@@ -22,9 +22,9 @@ let webpackManifest
  * @param {FormRequest | FormRequestPayload | null} request
  */
 export function context(request) {
-  const { params, path, response } = request ?? {}
+  const { params, response } = request ?? {}
 
-  const isPreviewMode = path?.startsWith(PREVIEW_PATH_PREFIX)
+  const { isPreview: isPreviewMode, state: formState } = checkFormStatus(params)
 
   // Only add the slug in to the context if the response is OK.
   // Footer meta links are not rendered when the slug is missing.
@@ -62,7 +62,7 @@ export function context(request) {
     },
     crumb: safeGenerateCrumb(request),
     currentPath: `${request.path}${request.url.search}`,
-    previewMode: isPreviewMode ? params?.state : undefined,
+    previewMode: isPreviewMode ? formState : undefined,
     slug: isResponseOK ? params?.slug : undefined
   }
 

package/src/server/plugins/nunjucks/enviroment.test.js

@@ -88,7 +88,9 @@ describe('Nunjucks environment', () => {
         }
       }
 
-      const result = checkComponentTemplates.call(nunjucksCtx, component)
+      const result = /** @type {{ model: { content: string } }} */ (
+        checkComponentTemplates.call(nunjucksCtx, component)
+      )
 
       expect(helpers.evaluateTemplate).toHaveBeenCalledWith(
         'Some {{ context.someData }} content',
@@ -114,7 +116,9 @@ describe('Nunjucks environment', () => {
         }
       }
 
-      const result = checkComponentTemplates.call(nunjucksCtx, component)
+      const result = /** @type {{ model: { content: string } }} */ (
+        checkComponentTemplates.call(nunjucksCtx, component)
+      )
 
       expect(helpers.evaluateTemplate).not.toHaveBeenCalled()
 
@@ -136,7 +140,9 @@ describe('Nunjucks environment', () => {
         }
       }
 
-      const result = checkComponentTemplates.call(nunjucksCtx, component)
+      const result = /** @type {{ model: { label?: { text: string } } }} */ (
+        checkComponentTemplates.call(nunjucksCtx, component)
+      )
 
       expect(helpers.evaluateTemplate).toHaveBeenCalledWith(
         'Label with {{ context.someData }}',

package/src/server/utils/type-utils.ts

@@ -0,0 +1,15 @@
+import Joi, {
+  type JoiExpression,
+  type LanguageMessages,
+  type LanguageMessagesExt
+} from 'joi'
+
+export function convertToLanguageMessages(
+  extLanguageMessages: LanguageMessagesExt
+): LanguageMessages {
+  return extLanguageMessages as unknown as LanguageMessages
+}
+
+export function createJoiExpression(expr: string): JoiExpression {
+  return Joi.expression(expr) as unknown as JoiExpression
+}

package/src/typings/joi/index.d.ts

@@ -19,4 +19,12 @@ declare module 'joi' {
       title?: string
     }
   }
+
+  interface JoiExpressionReturn {
+    render: (p1, p2, p3, p4, p5) => string
+  }
+
+  type JoiExpression = JoiExpressionReturn | string
+
+  type LanguageMessagesExt = Record<string, JoiExpression>
 }