@defra/forms-engine-plugin 5.0.0-alpha → 5.0.0-alpha.10

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

@@ -58,7 +58,21 @@ export const messages: LanguageMessagesExt = {
   'date.min': messageTemplate.dateMin,
   'date.max': messageTemplate.dateMax,
 
-  'object.invalidjson': messageTemplate.format
+  'array.min': messageTemplate.arrayMin,
+  'array.max': messageTemplate.arrayMax,
+  'array.length': messageTemplate.arrayLength,
+
+  'features.min': messageTemplate.featuresMin,
+  'features.max': messageTemplate.featuresMax,
+  'features.length': messageTemplate.featuresLength,
+
+  'files.min': messageTemplate.filesMin,
+  'files.max': messageTemplate.filesMax,
+  'filees.length': messageTemplate.filesLength,
+
+  'object.invalidjson': messageTemplate.format,
+
+  'phoneNumber.invalid': messageTemplate.format
 }
 
 export const messagesPre: LanguageMessages =
@@ -76,6 +90,7 @@ export function buildLanguageMessages(
     'string.email': vm.format,
     'string.pattern.base': vm.pattern,
     'string.maxWords': vm.maxWords,
+    'string.unicode': vm.unicode,
     'number.base': vm.number,
     'number.precision': vm.numberPrecision,
     'number.integer': vm.numberInteger,
@@ -91,7 +106,17 @@ export function buildLanguageMessages(
     'date.format': vm.dateFormat,
     'date.min': vm.dateMin,
     'date.max': vm.dateMax,
-    'object.invalidjson': vm.format
+    'array.min': vm.arrayMin,
+    'array.max': vm.arrayMax,
+    'array.length': vm.arrayLength,
+    'features.min': vm.featuresMin,
+    'features.max': vm.featuresMax,
+    'features.length': vm.featuresLength,
+    'files.min': vm.filesMin,
+    'files.max': vm.filesMax,
+    'files.length': vm.filesLength,
+    'object.invalidjson': vm.format,
+    'phoneNumber.invalid': vm.format
   } as unknown as LanguageMessages
 }
 

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

@@ -50,6 +50,7 @@ export const formAdapterSubmissionMessageDataSchema =
         reference: Joi.string().required(),
         amount: Joi.number().required(),
         description: Joi.string().required(),
+        descriptionInEng: Joi.string().optional(),
         createdAt: Joi.string().required()
       })
       .optional(),

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

@@ -558,6 +558,7 @@ export interface FormAdapterPayment {
   reference: string
   amount: number
   description: string
+  descriptionInEng?: string
   createdAt: string
 }
 

package/src/server/plugins/engine/views/components/_location-field-base.html

@@ -70,7 +70,9 @@
 
   {% set hasErrors = showFieldsetError and component.model.errorMessage %}
 
-  <div class="govuk-form-group app-location-field {{ "govuk-form-group--error" if hasErrors }}" data-locationtype="{{component.type | lower}}">
+  <div class="govuk-form-group app-location-field {{ "govuk-form-group--error" if hasErrors }}"
+    data-locationtype="{{component.type | lower}}"
+    data-maplayers="{{component.model.mapLayers}}">
     {{ govukFieldset({
       legend: {
         text: component.model.fieldset.legend.text,

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

@@ -3,7 +3,7 @@
 {% macro FileUploadField(component) %}
   {% set upload = component.model.upload %}
 
-  <div id="uploadedFilesContainer">
+  <div id="uploadedFilesContainer" data-uploadinglabel="{{ upload.uploadingLabel }}">
     <h2 class="govuk-heading-m">{{ t('components.fileUploadField.uploadedFilesHeading') }}</h2>
     {% if upload.count %}
       <p class="govuk-body" role="alert">{{ t('components.fileUploadField.filesCount', { count: upload.count }) }}</p>

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

@@ -1,7 +1,10 @@
 {% from "govuk/components/textarea/macro.njk" import govukTextarea %}
 
 {% macro GeospatialField(component) %}
-  <div class="app-geospatial-field" data-country="{{component.model.country}}" data-geometryTypes="{{component.model.geometryTypes}}">
+  <div class="app-geospatial-field"
+    data-country="{{component.model.country}}"
+    data-geometryTypes="{{component.model.geometryTypes}}"
+    data-maplayers="{{component.model.mapLayers}}">
     {{ govukTextarea(component.model) }}
   </div>
 {% endmacro %}

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

@@ -3,7 +3,18 @@
 
 {% macro MultilineTextField(component) %}
   {% if component.model.isCharacterOrWordCount == true %}
-    {{ govukCharacterCount(component.model) }}
+    {% set characterParams = component.model | merge({
+      charactersUnderLimitText: {
+        one: t('components.characterCount.underLimit.one'),
+        other: t('components.characterCount.underLimit.other')
+      },
+      charactersAtLimitText: t('components.characterCount.atLimit'),
+      charactersOverLimitText: {
+        one: t('components.characterCount.overLimit.one'),
+        other: t('components.characterCount.overLimit.other')
+      }
+    } ) %}
+    {{ govukCharacterCount(characterParams) }}
   {% else %}
     {{ govukTextarea(component.model) }}
   {% endif %}

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

@@ -16,7 +16,7 @@
       <p class="govuk-body">{{ t('components.paymentField.preAuthorisedBody') }}</p>
     {% else %}
       {# No pre-authorisation - show payment form #}
-      <h2 class="govuk-heading-m">{{ model.label.text if model.label and model.label.text else t('components.paymentField.detailsRequired') }}</h2>
+      <h2 class="govuk-heading-m">{{ t('components.paymentField.detailsRequired') }}</h2>
 
       <p class="govuk-body">{{ description }}</p>
 

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

@@ -61,7 +61,7 @@
               },
               classes: "govuk-button--secondary govuk-!-margin-right-1 govuk-!-margin-bottom-0"
             }) }}
-            <p class="govuk-body govuk-!-margin-bottom-0">or <button class="govuk-link govuk-button--link govuk-!-margin-right-1 govuk-!-margin-bottom-0" name="action" value="external-{{component.model.name}}--step:manual">{{ t('components.addressField.enterManually') }}</button></p>
+            <p class="govuk-body govuk-!-margin-bottom-0">{{ t('common.or')}} <button class="govuk-link govuk-button--link govuk-!-margin-right-1 govuk-!-margin-bottom-0" name="action" value="external-{{component.model.name}}--step:manual">{{ t('components.addressField.enterManually') }}</button></p>
           </div>
           {# Include a line break if this is the last component #}
           {% if components[components.length - 1] == component %}

package/src/server/plugins/engine/views/partials/preview-banner.html

@@ -8,7 +8,9 @@
   </p>
 {%- endmacro -%}
 
-{% call govukNotificationBanner() %}
+{% call govukNotificationBanner({
+  titleText: t('pages.preview.bannerTitle')
+}) %}
   {% set previewModeTranslated = t('common.' + previewMode) %}
   {% if not context.isForceAccess %}
     <p class="govuk-notification-banner__heading govuk-!-margin-bottom-0">

package/src/server/plugins/map/routes/index.js

@@ -218,5 +218,5 @@ function getGeospatialCountries() {
 /**
  * @import { ServerRoute } from '@hapi/hapi'
  * @import { FeatureCollection } from 'geojson'
- * @import { MapConfiguration, MapProxyGetRequestRefs, MapGeocodeGetRequestRefs, MapReverseGeocodeGetRequestRefs, GeospatialCountriesGetRequestRefs } from '../types.js'
+ * @import { MapConfiguration, MapProxyGetRequestRefs, MapGeocodeGetRequestRefs, GeospatialCountriesGetRequestRefs } from '../types.js'
  */

package/src/server/plugins/map/types.js

@@ -21,13 +21,6 @@
  * @property {string} query - name query
  */
 
-/**
- * Map reverse geocode query params
- * @typedef {object} MapReverseGeocodeQuery
- * @property {number} easting - the Easting point
- * @property {number} northing - the Northing point
- */
-
 /**
  * Geospatial countries query params
  * @typedef {object} GeospatialCountriesQuery
@@ -47,12 +40,6 @@
  * @property {MapGeocodeQuery} Query - Request query
  */
 
-/**
- * Map reverse geocode get request
- * @typedef {object} MapReverseGeocodeGetRequestRefs
- * @property {MapReverseGeocodeQuery} Query - Request query
- */
-
 /**
  * Map countries geojson get request
  * @typedef {object} GeospatialCountriesGetRequestRefs
@@ -62,11 +49,9 @@
 /**
  * @typedef {MapProxyGetRequestRefs} MapProxyRequestRefs
  * @typedef {MapGeocodeGetRequestRefs} MapGeocodeRequestRefs
- * @typedef {MapReverseGeocodeGetRequestRefs} MapReverseGeocodeRequestRefs
  * @typedef {Request<MapGeocodeGetRequestRefs>} MapProxyGetRequest
  * @typedef {Request<MapGeocodeGetRequestRefs>} MapGeocodeGetRequest
- * @typedef {Request<MapReverseGeocodeGetRequestRefs>} MapReverseGeocodeGetRequest
- * @typedef {MapProxyGetRequest | MapGeocodeGetRequest | MapReverseGeocodeGetRequest} MapRequest
+ * @typedef {MapProxyGetRequest | MapGeocodeGetRequest } MapRequest
  */
 
 //

package/src/server/plugins/nunjucks/filters/applyUrlParam.js

@@ -0,0 +1,17 @@
+/**
+ * Nunjucks filter to add/replace a parameter on a query string of a url.
+ * Currently only used in forms-runner.
+ * @param {string} urlPath - existing relative url with query string
+ * @param {string} paramName - name of parameter
+ * @param {string} paramValue - value of parameter
+ * @returns {string}
+ */
+export function applyUrlParam(urlPath, paramName, paramValue) {
+  if (typeof urlPath !== 'string') {
+    return ''
+  }
+  const url = new URL(urlPath, 'https://dummy')
+  url.searchParams.set(paramName, paramValue)
+
+  return url.pathname + url.search
+}

package/src/server/plugins/nunjucks/filters/index.js

@@ -6,3 +6,4 @@ export { href } from './href.js'
 export { field } from './field.js'
 export { page } from './page.js'
 export { merge } from './merge.js'
+export { applyUrlParam } from './applyUrlParam.js'

package/src/server/plugins/payment/helper.js

@@ -1,5 +1,6 @@
 import { format } from 'date-fns'
 
+import { toLanguageLocale } from '../engine/helpers.js'
 import { PaymentService } from './service.js'
 
 export const DEFAULT_PAYMENT_HELP_URL =
@@ -28,10 +29,29 @@ export async function createPaymentService(
 /**
  * Formats a payment date for display
  * @param {string} isoString - ISO date string
+ * @param {string} language - the target language
  * @returns {string} Formatted date string (e.g., "26 January 2026 5:01pm")
  */
-export function formatPaymentDate(isoString) {
-  return format(new Date(isoString), 'd MMMM yyyy h:mmaaa')
+export function formatPaymentDate(isoString, language) {
+  return formatDateForLanguage(
+    new Date(isoString),
+    'd MMMM yyyy h:mmaaa',
+    language
+  )
+}
+
+/**
+ * Formats a date for display in a specific language.
+ * To use additional languages, the appropriate module must be imported from 'date-fns/locale'
+ * @param { Date | string } date - the date
+ * @param {string} formatMask - the format mask
+ * @param {string} language - the target language
+ * @returns {string} Formatted date string (e.g., "26 January 2026 5:01pm")
+ */
+export function formatDateForLanguage(date, formatMask, language) {
+  return format(date, formatMask, {
+    locale: toLanguageLocale(language)
+  })
 }
 
 /**

package/src/server/plugins/payment/service.js

@@ -1,6 +1,7 @@
 import { StatusCodes } from 'http-status-codes'
 
 import { logger } from '../../common/helpers/logging/logger.js'
+import { toPayLanguageCode } from '../engine/helpers.js'
 import {
   buildPaymentInfo,
   convertPenceToPounds
@@ -38,7 +39,7 @@ export class PaymentService {
    * @param {string} returnUrl
    * @param {string} reference
    * @param {boolean} isLivePayment
-   * @param {{ formId: string, slug: string } | undefined } metadata
+   * @param {{ formId: string, slug: string, language: string } | undefined } metadata
    * @param {string} [email] - optional email to prepopulate on GOV.UK Pay
    */
   async createPayment(
@@ -50,6 +51,8 @@ export class PaymentService {
     metadata,
     email
   ) {
+    const language = toPayLanguageCode(metadata?.language)
+
     try {
       /** @type {CreatePaymentRequest} */
       const payload = {
@@ -58,7 +61,8 @@ export class PaymentService {
         reference,
         metadata,
         return_url: returnUrl,
-        delayed_capture: true
+        delayed_capture: true,
+        language
       }
 
       // Prepopulate email on GOV.UK Pay if provided

package/src/server/plugins/payment/types.js

@@ -18,6 +18,7 @@
  * @property {string} reference - Unique reference for the payment
  * @property {string} description - Human-readable description of the payment
  * @property {string} return_url - URL to redirect the user to after payment
+ * @property {string} language - the desired language for translations
  * @property {boolean} [delayed_capture] - Whether to delay capturing the payment
  * @property {{ formId: string, slug: string }} [metadata] - Additional metadata for the payment
  * @property {string} [email] - Email to prepopulate on GOV.UK Pay (max 254 chars)

package/src/server/plugins/postcode-lookup/models/index.js

@@ -16,6 +16,7 @@ const countyFieldName = 'county'
 const postcodeFieldName = 'postcode'
 
 const GOVUK_MARGIN_RIGHT_1 = 'govuk-!-margin-right-1'
+const COMMON_BACK = 'common.back'
 
 export const steps = {
   // Step 1: Postcode/building name input
@@ -403,19 +404,20 @@ function getHref(step) {
 /**
  * The postcode lookup details form view model
  * @param {PostcodeLookupSessionData} data
+ * @param {Translator} translator
  * @param {PostcodeLookupDetailsData} [payload]
  * @param {Error} [err]
  */
-export function detailsViewModel(data, payload, err) {
-  const {
-    componentTitle: pageTitle,
-    formName,
-    sourceUrl,
-    language = 'en-GB'
-  } = data.initial
+export function detailsViewModel(data, translator, payload, err) {
+  const { componentId, componentHint, sourceUrl, languages } = data.initial
+
+  const { t, tComponent, tForm } = translator
+
+  const component = /** @type {ComponentDef} */ ({ id: componentId })
 
   const backLink = {
-    href: sourceUrl
+    href: sourceUrl,
+    text: t(COMMON_BACK)
   }
 
   const { errors, postcodeQueryError, buildingNameQueryError } =
@@ -425,42 +427,53 @@ export function detailsViewModel(data, payload, err) {
     payload ?? data.details,
     postcodeQueryError,
     buildingNameQueryError,
-    language
+    translator.language
   )
 
+  const hint = componentHint && {
+    text: tComponent(component, 'hint')
+  }
+
   const continueButton = {
-    text: i18nT('postcodeLookup.findAddress', language),
+    text: t('postcodeLookup.findAddress'),
     classes: GOVUK_MARGIN_RIGHT_1
   }
   const manualLink = {
-    text: i18nT('postcodeLookup.enterManually', language),
+    text: t('postcodeLookup.enterManually'),
     href: getHref(steps.manual)
   }
 
+  const selector = languages?.length ? { languages } : {}
+
   return {
     step: steps.details,
     showTitle: true,
-    name: formName,
+    name: tForm('title'),
     serviceUrl: sourceUrl,
-    pageTitle,
+    pageTitle: tComponent(component, 'title'),
+    hint,
     backLink,
     errors,
     fields,
-    buttons: { continueButton, manualLink }
+    buttons: { continueButton, manualLink },
+    t,
+    language: translator.language,
+    ...selector
   }
 }
 
 /**
  * The postcode lookup select form view model
  * @param {{ session: PostcodeLookupSessionData, apiKey: string }} data
+ * @param {Translator} translator
  * @param {PostcodeLookupSelectPayload} [payload]
  * @param {Error} [err]
  */
-export async function selectViewModel(data, payload, err) {
+export async function selectViewModel(data, translator, payload, err) {
   const { session, apiKey } = data
   const { details, initial } = session
   const { postcodeQuery, buildingNameQuery } = details
-  const language = initial.language ?? 'en-GB'
+  const { language, t, tComponent, tForm } = translator
 
   const {
     hasAddresses,
@@ -471,12 +484,18 @@ export async function selectViewModel(data, payload, err) {
   } = await getAddresses(postcodeQuery, buildingNameQuery, apiKey)
 
   const title = hasAddresses
-    ? initial.componentTitle
-    : i18nT('postcodeLookup.noAddressFoundTitle', language)
+    ? tComponent(
+        /** @type {ComponentDef} */ ({ id: initial.componentId }),
+        'title'
+      )
+    : t('postcodeLookup.noAddressFoundTitle')
   const formPath = initial.sourceUrl
   const href = getHref()
 
-  const backLink = { href }
+  const backLink = {
+    href,
+    text: t(COMMON_BACK)
+  }
 
   const { errors, uprnError } = buildErrors(err)
 
@@ -490,7 +509,7 @@ export async function selectViewModel(data, payload, err) {
     language
   )
 
-  const searchAgainText = i18nT('postcodeLookup.searchAgain', language)
+  const searchAgainText = t('postcodeLookup.searchAgain')
 
   const searchAgainLink = {
     text: searchAgainText,
@@ -499,27 +518,29 @@ export async function selectViewModel(data, payload, err) {
 
   const continueButton = {
     href: hasAddresses ? undefined : href,
-    text: hasAddresses
-      ? i18nT('postcodeLookup.useThisAddress', language)
-      : searchAgainText,
+    text: hasAddresses ? t('postcodeLookup.useThisAddress') : searchAgainText,
     classes: GOVUK_MARGIN_RIGHT_1
   }
   const manualLink = {
-    text: i18nT('postcodeLookup.enterManually', language),
+    text: t('postcodeLookup.enterManually'),
     href: `${href}?step=${steps.manual}`
   }
 
   const addressesFoundText = hasAddresses
-    ? i18nT('postcodeLookup.addressFound', language, { count: addressCount })
+    ? t('postcodeLookup.addressFound', { count: addressCount })
     : undefined
   const noAddressFoundText = !hasAddresses
-    ? i18nT('postcodeLookup.noAddressFoundBody', language)
+    ? t('postcodeLookup.noAddressFoundBody')
     : undefined
 
+  const selector = initial.languages?.length
+    ? { languages: initial.languages }
+    : {}
+
   return {
     step: steps.select,
     showTitle: true,
-    name: title,
+    name: tForm('title'),
     serviceUrl: formPath,
     pageTitle: title,
     backLink,
@@ -533,28 +554,32 @@ export async function selectViewModel(data, payload, err) {
     hasMultipleAddresses,
     addressesFoundText,
     noAddressFoundText,
-    buttons: { continueButton, manualLink }
+    buttons: { continueButton, manualLink },
+    t,
+    language,
+    ...selector
   }
 }
 
 /**
  * The postcode lookup manual form view model
  * @param {PostcodeLookupSessionData} data
+ * @param {Translator} translator
  * @param {PostcodeLookupManualPayload} [payload]
  * @param {Error} [err]
  */
-export function manualViewModel(data, payload, err) {
-  const {
-    componentTitle,
-    sourceUrl,
-    componentHint,
-    language = 'en-GB'
-  } = data.initial
+export function manualViewModel(data, translator, payload, err) {
+  const { componentId, sourceUrl, componentHint, languages } = data.initial
   const formPath = sourceUrl
   const href = getHref()
 
+  const { t, tComponent, tForm } = translator
+
+  const component = /** @type {ComponentDef} */ ({ id: componentId })
+
   const backLink = {
-    href
+    href,
+    text: t(COMMON_BACK)
   }
 
   const {
@@ -567,7 +592,7 @@ export function manualViewModel(data, payload, err) {
   } = buildErrors(err)
 
   const hint = componentHint && {
-    text: componentHint
+    text: tComponent(component, 'hint')
   }
 
   const fields = getManualFields(
@@ -577,29 +602,34 @@ export function manualViewModel(data, payload, err) {
     townError,
     countyError,
     postcodeError,
-    language
+    translator.language
   )
 
   const continueButton = {
-    text: i18nT('postcodeLookup.useThisAddress', language),
+    text: t('postcodeLookup.useThisAddress'),
     classes: GOVUK_MARGIN_RIGHT_1
   }
   const detailsLink = {
-    text: i18nT('postcodeLookup.findAnAddressInstead', language),
+    text: t('postcodeLookup.findAnAddressInstead'),
     href
   }
 
+  const selector = languages?.length ? { languages } : {}
+
   return {
     step: steps.manual,
     showTitle: true,
-    name: componentTitle,
+    name: tForm('title'),
     serviceUrl: formPath,
-    pageTitle: componentTitle,
+    pageTitle: tComponent(component, 'title'),
     backLink,
     errors,
     hint,
     fields,
-    buttons: { continueButton, detailsLink }
+    buttons: { continueButton, detailsLink },
+    t,
+    language: translator.language,
+    ...selector
   }
 }
 
@@ -607,5 +637,7 @@ export function manualViewModel(data, payload, err) {
 
 /**
  * @import { ObjectSchema, ValidationErrorItem } from 'joi'
+ * @import { ComponentDef } from '@defra/forms-model'
  * @import { Address, PostcodeLookupDetailsData, PostcodeLookupDetailsPayload, PostcodeLookupManualPayload, PostcodeLookupSelectPayload, PostcodeLookupSessionData } from '../types.js'
+ * @import { Translator } from '../../engine/i18n/types.js'
  */