@defra/forms-engine-plugin 4.0.23 → 4.0.25

package/src/server/plugins/engine/components/OsGridRefField.ts

@@ -1,6 +1,7 @@
 import { type OsGridRefFieldComponent } from '@defra/forms-model'
 
 import { LocationFieldBase } from '~/src/server/plugins/engine/components/LocationFieldBase.js'
+import { createLowerFirstExpression } from '~/src/server/plugins/engine/components/helpers/index.js'
 
 export class OsGridRefField extends LocationFieldBase {
   declare options: OsGridRefFieldComponent['options']
@@ -15,10 +16,15 @@ export class OsGridRefField extends LocationFieldBase {
     const pattern =
       /^((([sS]|[nN])[a-hA-Hj-zJ-Z])|(([tT]|[oO])[abfglmqrvwABFGLMQRVW])|([hH][l-zL-Z])|([jJ][lmqrvwLMQRVW]))\s?(([0-9]{3})\s?([0-9]{3})|([0-9]{4})\s?([0-9]{4})|([0-9]{5})\s?([0-9]{5}))$/
 
+    const patternTemplate =
+      'Enter a valid OS grid reference for {{lowerFirst(#title)}} like TQ123456'
+
     return {
       pattern,
-      patternErrorMessage: `Enter a valid OS grid reference for {{#title}} like TQ123456`,
-      requiredMessage: 'Enter {{#title}}'
+      patternErrorMessage: createLowerFirstExpression(patternTemplate),
+      requiredMessage: createLowerFirstExpression(
+        'Enter {{lowerFirst(#title)}}'
+      )
     }
   }
 
@@ -26,7 +32,9 @@ export class OsGridRefField extends LocationFieldBase {
     return [
       {
         type: 'pattern',
-        template: 'Enter a valid OS grid reference for {{#title}} like TQ123456'
+        template: createLowerFirstExpression(
+          'Enter a valid OS grid reference for {{lowerFirst(#title)}} like TQ123456'
+        )
       }
     ]
   }

package/src/server/plugins/engine/components/helpers/helpers.test.ts

@@ -6,6 +6,10 @@ import { LatLongField } from '~/src/server/plugins/engine/components/LatLongFiel
 import { NationalGridFieldNumberField } from '~/src/server/plugins/engine/components/NationalGridFieldNumberField.js'
 import { OsGridRefField } from '~/src/server/plugins/engine/components/OsGridRefField.js'
 import { createComponent } from '~/src/server/plugins/engine/components/helpers/components.js'
+import {
+  createLowerFirstExpression,
+  lowerFirstExpressionOptions
+} from '~/src/server/plugins/engine/components/helpers/index.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/basic.js'
 
@@ -123,3 +127,39 @@ describe('ComponentBase tests', () => {
     expect(component.title).toBe('Context Field')
   })
 })
+
+describe('lowerFirst expression helpers', () => {
+  test('lowerFirstExpressionOptions should have lowerFirst function', () => {
+    expect(lowerFirstExpressionOptions).toHaveProperty('functions')
+    expect(lowerFirstExpressionOptions).toHaveProperty(
+      'functions.lowerFirst',
+      expect.any(Function)
+    )
+  })
+
+  test('createLowerFirstExpression should create a Joi expression', () => {
+    const template = 'Enter {{lowerFirst(#title)}}'
+    const expression = createLowerFirstExpression(template)
+
+    expect(expression).toBeDefined()
+    expect(typeof expression).toBe('object')
+    expect(expression).toHaveProperty('_template')
+  })
+
+  test('createLowerFirstExpression should render template with lowerFirst', () => {
+    const template = 'Enter {{lowerFirst(#title)}}'
+    const expression = createLowerFirstExpression(template)
+
+    // Check the rendered template is stored
+    expect(expression).toHaveProperty('rendered', template)
+  })
+
+  test('createLowerFirstExpression should support multiple interpolations', () => {
+    const template =
+      'Easting for {{lowerFirst(#title)}} must be between {{#min}} and {{#max}}'
+    const expression = createLowerFirstExpression(template)
+
+    expect(expression).toBeDefined()
+    expect(expression).toHaveProperty('rendered', template)
+  })
+})

package/src/server/plugins/engine/components/helpers/index.ts

@@ -1,4 +1,6 @@
 import { type ComponentDef } from '@defra/forms-model'
+import joi, { type JoiExpression, type ReferenceOptions } from 'joi'
+import lowerFirst from 'lodash/lowerFirst.js'
 
 /**
  * Prevent Markdown formatting
@@ -36,3 +38,19 @@ export const addClassOptionIfNone = (
 ) => {
   options.classes ??= className
 }
+
+/**
+ * Configuration for Joi expressions that use lowerFirst function
+ */
+export const lowerFirstExpressionOptions = {
+  functions: {
+    lowerFirst
+  }
+} as ReferenceOptions
+
+/**
+ * Creates a Joi expression with lowerFirst function support
+ * Used for error messages in location field components
+ */
+export const createLowerFirstExpression = (template: string): JoiExpression =>
+  joi.expression(template, lowerFirstExpressionOptions) as JoiExpression

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

@@ -33,8 +33,11 @@ export const prepareNunjucksEnvironment = function (
     env.addFilter(name, nunjucksFilter)
   }
 
-  env.addFilter('markdown', (text: string) =>
-    markdownToHtml(text, pluginOptions.baseUrl)
+  env.addFilter('markdown', (text: string, startingHeaderLevel?: number) =>
+    markdownToHtml(text, {
+      baseUrl: pluginOptions.baseUrl,
+      startingHeaderLevel
+    })
   )
 
   for (const [name, nunjucksGlobal] of Object.entries(globals)) {

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

@@ -5,7 +5,7 @@
 {% macro DeclarationField(component) %}
   {% set content %}
     <div class="app-prose-scope">
-      {{ component.model.content | markdown | safe }}
+      {{ component.model.content | markdown(component.model.headerStartLevel)  | safe }}
     </div>
   {% endset %}
   {% set checkboxes = component.model | merge({ formGroup: { beforeInputs: { html: content } } }) %}

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

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

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

@@ -12,7 +12,7 @@
       }) }}
       <h2 class="govuk-heading-m">What happens next</h2>
       <div class="app-prose-scope">
-        {{ submissionGuidance | markdown | safe }}
+        {{ submissionGuidance | markdown(3) | safe }}
       </div>
     </div>
   </div>