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

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

@@ -8,13 +8,14 @@ import {
 } from '@defra/forms-model'
 import Boom from '@hapi/boom'
 import { type ResponseToolkit, type Server } from '@hapi/hapi'
-import { format, parseISO } from 'date-fns'
+import { format, parseISO, type Locale } from 'date-fns'
+import { cy, enGB } from 'date-fns/locale'
 import { StatusCodes } from 'http-status-codes'
 import { type Schema, type ValidationErrorItem } from 'joi'
 import { Liquid } from 'liquidjs'
 
 import { logger } from '../../common/helpers/logging/logger.js'
-import { FORM_VERSION_METADATA_KEY } from '../../constants.js'
+import { CY, EN_GB, FORM_VERSION_METADATA_KEY } from '../../constants.js'
 import {
   getAnswer,
   type Field
@@ -300,19 +301,24 @@ export function checkEmailAddressForLiveFormSubmission(
 
 /**
  * Parses the errors from {@link Schema.validate} so they can be rendered by govuk-frontend templates
+ * @param language - the target language for translations
  * @param [details] - provided by {@link Schema.validate}
  */
 export function getErrors(
+  language: string | undefined,
   details?: ValidationErrorItem[]
 ): FormSubmissionError[] | undefined {
   if (!details?.length) {
     return
   }
 
-  return details.map(getError)
+  return details.map((detail) => getError(language, detail))
 }
 
-export function getError(detail: ValidationErrorItem): FormSubmissionError {
+export function getError(
+  language: string | undefined,
+  detail: ValidationErrorItem
+): FormSubmissionError {
   const { context, message, path } = detail
 
   const name = context?.key ?? ''
@@ -320,7 +326,10 @@ export function getError(detail: ValidationErrorItem): FormSubmissionError {
 
   const text = message.replace(
     /\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z)/,
-    (text) => format(parseISO(text), 'd MMMM yyyy')
+    (text) =>
+      format(parseISO(text), 'd MMMM yyyy', {
+        locale: toLanguageLocale(language)
+      })
   )
 
   return {
@@ -410,3 +419,41 @@ export function getFormVersion(
     | FormVersionMetadata
     | undefined
 }
+
+const payLanguageCodes = {
+  [EN_GB]: 'en',
+  [CY]: 'cy'
+} as Record<string, string>
+
+const languageLocales = {
+  [EN_GB]: enGB,
+  [CY]: cy
+} as Record<string, Locale>
+
+const defaultLanguageCode = 'en'
+const defaultLanguageLocale = enGB
+
+/**
+ * Converts a BCP 47 language tag to the ISO 639-1 code GOV.UK Pay accepts.
+ * Defaults to English if the language is not supported.
+ * @param { string | undefined } language - BCP 47 language code
+ * @returns {string} language code required by GOV.UK Pay
+ */
+export function toPayLanguageCode(language: string | undefined): string {
+  return payLanguageCodes[language ?? 'unknown'] ?? defaultLanguageCode
+}
+
+/**
+ * Converts a BCP 47 language tag to the date-fns Locale (for date formatting).
+ * Defaults to English if the language is not supported.
+ * @param { string | undefined } language - BCP 47 language code
+ * @returns {Locale} language locale
+ */
+export function toLanguageLocale(language: string | undefined): Locale {
+  return languageLocales[language ?? 'unknown'] ?? defaultLanguageLocale
+}
+
+/**
+ * @import { FormsService } from '../../types.js'
+ * @import { Locale } from 'date-fns/locale'
+ */

package/src/server/plugins/engine/i18n/buildValidationMessages.ts

@@ -56,13 +56,16 @@ export function buildValidationMessages(t: (key: string) => string) {
     dateMin: t('components.dateField.validation.dateMin'),
     dateMax: t('components.dateField.validation.dateMax'),
 
-    unicode: 'validation.unicode',
-    arrayMin: 'validation.array.min',
-    arrayMax: 'validation.array.max',
-    arrayLength: 'validation.array.length',
-    featuresMin: 'validation.features.min',
-    featuresMax: 'validation.features.max',
-    featuresLength: 'validation.features.length'
+    unicode: t('validation.unicode'),
+    arrayMin: t('validation.arrayMin'),
+    arrayMax: t('validation.arrayMax'),
+    arrayLength: t('validation.arrayLength'),
+    featuresMin: t('validation.featuresMin'),
+    featuresMax: t('validation.featuresMax'),
+    featuresLength: t('validation.featuresLength'),
+    filesMin: t('validation.filesMin'),
+    filesMax: t('validation.filesMax'),
+    filesLength: t('validation.filesLength')
   }
 }
 

package/src/server/plugins/engine/i18n/createFormTranslator.ts

@@ -1,26 +1,40 @@
-import { type FormDefinition } from '@defra/forms-model'
+import {
+  yesNoListNoItemId,
+  yesNoListYesItemId,
+  type FormDefinition,
+  type FormMetadata
+} from '@defra/forms-model'
 import { type i18n } from 'i18next'
 
+import { CY } from '../../../constants.js'
 import { createTranslator } from './createTranslator.js'
 import { extractBaseTranslations } from './extractBaseTranslations.js'
 import { createFormI18nInstance } from './index.js'
-import {
-  type FormDefinitionTranslations,
-  type Translator
-} from './types.js'
+import { type FormDefinitionTranslations } from './types.js'
 
 export function createFormTranslator(
-  def: FormDefinition,
+  metadata: FormMetadata,
+  definition: FormDefinition | undefined,
   language: string
-): Translator {
-  const baseTranslations = extractBaseTranslations(def)
+) {
+  const baseTranslations = extractBaseTranslations(definition)
   const i18nInstance = createFormI18nInstance(baseTranslations)
-  loadFormTranslations(def, i18nInstance)
+  loadFormTranslations(definition, i18nInstance)
+  extractMetadataBaseTranslations(metadata, i18nInstance)
+
+  const translator = createTranslator(i18nInstance, language)
 
-  return createTranslator(i18nInstance, language)
+  return translator
 }
 
-export function loadFormTranslations(def: FormDefinition, i18nInstance: i18n) {
+export function loadFormTranslations(
+  def: FormDefinition | undefined,
+  i18nInstance: i18n
+) {
+  if (!def) {
+    return
+  }
+
   const formTranslations = def.metadata?.translations as
     | FormDefinitionTranslations
     | undefined
@@ -28,6 +42,43 @@ export function loadFormTranslations(def: FormDefinition, i18nInstance: i18n) {
   if (formTranslations) {
     for (const [lng, resources] of Object.entries(formTranslations)) {
       i18nInstance.addResourceBundle(lng, 'form', resources, true, true)
+
+      // Temporary workaround - until we develop a better solution
+      if (lng === CY) {
+        i18nInstance.addResource(
+          lng,
+          'form',
+          `listItems.${yesNoListYesItemId}.text`,
+          'Ie'
+        )
+        i18nInstance.addResource(
+          lng,
+          'form',
+          `listItems.${yesNoListNoItemId}.text`,
+          'Nage'
+        )
+      }
+    }
+  }
+}
+
+export function extractMetadataBaseTranslations(
+  metadata: FormMetadata | undefined,
+  i18nInstance: i18n
+) {
+  if (metadata) {
+    const translations = {
+      'form.title': metadata.title,
+      'form.contact.email.address': metadata.contact?.email?.address ?? '',
+      'form.contact.email.responseTime':
+        metadata.contact?.email?.responseTime ?? '',
+      'form.contact.online.url': metadata.contact?.online?.url ?? '',
+      'form.contact.online.text': metadata.contact?.online?.text ?? '',
+      'form.contact.phone': metadata.contact?.phone ?? '',
+      'form.submissionGuidance': metadata.submissionGuidance ?? '',
+      'form.privacyNoticeText': metadata.privacyNoticeText ?? '',
+      'form.privacyNoticeUrl': metadata.privacyNoticeUrl ?? ''
     }
+    i18nInstance.addResourceBundle('en-GB', 'form', translations, true, true)
   }
 }

package/src/server/plugins/engine/i18n/extractBaseTranslations.ts

@@ -7,13 +7,19 @@ import { type FormDefinitionTranslations } from './types.js'
 
 type BaseTranslations = FormDefinitionTranslations[string]
 
-export function extractBaseTranslations(def: FormDefinition): BaseTranslations {
+export function extractBaseTranslations(
+  def: FormDefinition | undefined
+): BaseTranslations {
   const pages: BaseTranslations['pages'] = {}
   const components: BaseTranslations['components'] = {}
   const sections: BaseTranslations['sections'] = {}
   const listItems: BaseTranslations['listItems'] = {}
   const form: BaseTranslations['form'] = {}
 
+  if (!def) {
+    return { pages, components, sections, listItems, form }
+  }
+
   for (const page of def.pages) {
     if (page.id && page.title) {
       pages[page.id] = { title: page.title }

package/src/server/plugins/engine/i18n/form.ts

@@ -0,0 +1,54 @@
+import { type FormMetadata, type FormStatus } from '@defra/forms-model'
+import Boom from '@hapi/boom'
+import { LRUCache } from 'lru-cache'
+
+import { getPluginOptions } from '../helpers.js'
+import { createFormTranslator } from './createFormTranslator.js'
+import { type Translator } from './types.js'
+import { type AnyFormRequest } from '../types.js'
+
+const cache = new LRUCache({
+  max: 100,
+  ttl: 1000 * 60 * 15 // 15 minutes
+})
+
+/**
+ * Get translator for plugin, for the current form's metadata (as well as the plugin-specific boilerplate).
+ * This is an async call so we can read the form definition inside this call.
+ * See docs/features/multi-language.md for the language and translation flow overview.
+ * @param {AnyFormRequest} request
+ * @param {FormMetadata} metadata - the metadata of the form
+ * @param {FormStatus} status - the form status to use when retrieving the definition
+ * @param {string} language - the language to use for the translator
+ */
+export async function getCachedPluginTranslator(
+  request: AnyFormRequest,
+  metadata: FormMetadata,
+  status: FormStatus,
+  language: string
+) {
+  const key = `${metadata.id}-${status}-${language}-plugin-meta`
+
+  if (cache.has(key)) {
+    return cache.get(key) as unknown as Translator
+  }
+
+  const { services } = getPluginOptions(request.server)
+
+  const definition = await services?.formsService.getFormDefinition(
+    metadata.id,
+    status
+  )
+
+  if (!definition) {
+    throw Boom.notFound(
+      `FormDefinition not found for form ${metadata.id} and status ${status}`
+    )
+  }
+
+  const translator = createFormTranslator(metadata, definition, language)
+
+  cache.set(key, translator)
+
+  return translator
+}

package/src/server/plugins/engine/i18n/languages.ts

@@ -0,0 +1,19 @@
+import { type FormDefinition } from '@defra/forms-model'
+
+/**
+ * Return a list of available languages.
+ * Empty array if only English, or an array of English and Welsh if translations have been defined.
+ * @param {FormDefinition} def
+ */
+export function getAvailableLanguages(
+  def: FormDefinition
+): { name: string; code: string }[] {
+  // @ts-expect-error - dynamic property
+  if (def.metadata?.translations?.cy) {
+    return [
+      { name: 'English', code: 'en-GB' },
+      { name: 'Cymraeg', code: 'cy' }
+    ]
+  }
+  return []
+}

package/src/server/plugins/engine/i18n/translations/cy.json

@@ -14,7 +14,17 @@
     "numberInteger": "Rhaid i {{#label}} fod yn rhif cyfan",
     "numberMin": "Rhaid i {{#label}} fod yn {{#limit}} neu uwch",
     "numberMax": "Rhaid i {{#label}} fod yn {{#limit}} neu is",
-    "maxWords": "Rhaid i {{#label}} fod yn {{#limit}} o eiriau neu lai"
+    "maxWords": "Rhaid i {{#label}} fod yn {{#limit}} o eiriau neu lai",
+    "unicode": "Mae {{#label}} yn cynnwys nodau annilys, er enghraifft, dashes hirion",
+    "arrayMin": "Dewiswch o leiaf {{#limit}} o opsiynau o'r rhestr",
+    "arrayMax": "Dim ond {{#limit}} y gellir eu dewis o'r rhestr",
+    "arrayLength": "Dewiswch ddim ond {{#limit}} o opsiynau o'r rhestr",
+    "featuresMin": "Diffiniwch o leiaf {{#limit}} nodwedd",
+    "featuresMax": "Dim ond {{#limit}} nodwedd y gellir eu diffinio",
+    "featuresLength": "Diffiniwch nodweddion {{#limit}} yn union",
+    "filesMin": "Rhaid i chi uwchlwytho {{#limit}} o ffeiliau neu fwy",
+    "filesMax": "Dim ond {{#limit}} o ffeiliau neu lai y gallwch eu huwchlwytho",
+    "filesLength": "Rhaid i chi uwchlwytho'n union {{#limit}} o ffeiliau"
   },
 
   "errors": {
@@ -29,7 +39,14 @@
     "continue": "Parhau",
     "saveAndExit": "Cadw a gadael",
     "draft": "ddrafft",
-    "live": "fyw"
+    "live": "fyw",
+    "or": "neu",
+    "and": "a",
+    "england": "Lloegr",
+    "wales": "Cymru",
+    "northernIreland": "Gogledd Iwerddon",
+    "scotland": "Yr Alban",
+    "sendFeedback": "Anfon adborth"
   },
 
   "pages": {
@@ -60,6 +77,12 @@
       "totalAmount": "Cyfanswm",
       "reference": "Cyfeirnod",
       "dateOfPayment": "Dyddiad talu",
+      "fileUpload_zero": "Ni uwchlwythwyd unrhyw ffeiliau",
+      "fileUpload_one": "Uwchlwythwyd [[count]] ffeil",
+      "fileUpload_two": "Uwchlwythwyd dwy feil",
+      "fileUpload_few": "Uwchlwythwyd [[count]] ffeil",
+      "fileUpload_many": "Uwchlwythwyd [[count]] o ffeiliau",
+      "fileUpload_other": "Uwchlwythwyd [[count]] ffeil",
       "submissionFailed": "Roedd problem ac ni chyflwynwyd eich ffurflen. Ceisiwch gyflwyno'r ffurflen eto",
       "submissionFailedContactSuffix": " neu gallwch [[contactUsLink]] a dyfynnu'ch cyfeirnod i drefnu ad-daliad",
       "contactUsLinkText": "cysylltu â ni (yn agor mewn tab newydd)",
@@ -79,17 +102,34 @@
       "change": "Newid",
       "notProvided": "Heb ei ddarparu",
       "visuallyHiddenItem": "eitem [[index]]",
+      "pageTitle_zero": "Nid ydych wedi ychwanegu unrhyw atebion",
       "pageTitle_one": "Rydych wedi ychwanegu [[count]] ateb",
+      "pageTitle_two": "Rydych wedi ychwanegu dau ateb",
+      "pageTitle_few": "Rydych wedi ychwanegu [[count]] ateb",
+      "pageTitle_many": "Rydych wedi ychwanegu [[count]] o atebion",
       "pageTitle_other": "Rydych wedi ychwanegu [[count]] ateb",
+      "tooMany_zero": "Ni allwch ychwanegu unrhyw atebion",
       "tooMany_one": "Dim ond hyd at [[count]] ateb y gallwch ei ychwanegu",
+      "tooMany_two": "Dim ond hyd at ddau gateb y gallwch eu hychwanegu",
+      "tooMany_few": "Dim ond hyd at [[count]] ateb y gallwch eu hychwanegu",
+      "tooMany_many": "Dim ond hyd at [[count]] o atebion y gallwch eu hychwanegu",
       "tooMany_other": "Dim ond hyd at [[count]] ateb y gallwch eu hychwanegu",
+      "tooFew_zero": "Rhaid i chi ychwanegu atebion",
       "tooFew_one": "Rhaid i chi ychwanegu o leiaf [[count]] ateb",
+      "tooFew_two": "Rhaid i chi ychwanegu o leiaf ddau gateb",
+      "tooFew_few": "Rhaid i chi ychwanegu o leiaf [[count]] ateb",
+      "tooFew_many": "Rhaid i chi ychwanegu o leiaf [[count]] o atebion",
       "tooFew_other": "Rhaid i chi ychwanegu o leiaf [[count]] ateb"
     },
 
     "fileUpload": {
       "upload": "Uwchlwytho ffeil",
-      "maxFilesReached": "Rydych wedi cyrraedd nifer uchaf y ffeiliau. Tynnwch ffeil i uwchlwytho rhagor."
+      "maxFilesReached": "Rydych wedi cyrraedd nifer uchaf y ffeiliau. Tynnwch ffeil i uwchlwytho rhagor.",
+      "remove": "Tynnu",
+      "removeFileTitle": "Ydych chi'n siŵr eich bod chi eisiau dileu'r ffeil hon?",
+      "removeFileBody": "Ni allwch adfer ffeiliau a dynnwyd.",
+      "removeFileButton": "Dileu ffeil",
+      "cancel": "Canslo"
     },
 
     "exit": {
@@ -111,6 +151,7 @@
         "body": "Os hoffech dderbyn e-bost prawf, [[link]] yr hoffech i gyflwyniadau ffurflen fynd iddo.",
         "linkText": "nodwch y cyfeiriad e-bost (yn agor mewn tab newydd)"
       },
+      "bannerTitle": "Pwysig",
       "bannerForce": "Rhagolwg o ffurflen [[previewMode]] yw hon. Peidiwch â rhoi gwybodaeth bersonol.",
       "bannerText": "Dyma ragolwg o dudalen ffurflen [[previewMode]] rydych chi'n ei golygu.",
       "previousPages": "Mae'n dibynnu ar atebion o dudalennau cynharach yn y ffurflen. Yn y fersiwn fyw, bydd angen i ddefnyddwyr gwblhau'r cwestiynau hynny yn gyntaf."
@@ -134,7 +175,11 @@
     "findAnAddressInstead": "dod o hyd i gyfeiriad yn lle hynny",
     "noAddressFoundTitle": "Ni chanfuwyd cyfeiriad",
     "noAddressFoundBody": "Ni allem ddod o hyd i gyfeiriad cyfatebol",
+    "addressFound_zero": "Ni chanfuwyd unrhyw gyfeiriadau ar gyfer",
     "addressFound_one": "Canfuwyd [[count]] cyfeiriad ar gyfer",
+    "addressFound_two": "Canfuwyd dau gyfeiriad ar gyfer",
+    "addressFound_few": "Canfuwyd [[count]] chyfeiriad ar gyfer",
+    "addressFound_many": "Canfuwyd [[count]] o gyfeiriadau ar gyfer",
     "addressFound_other": "Canfuwyd [[count]] cyfeiriad ar gyfer",
     "validation": {
       "invalidPostcode": "Nodwch god post dilys neu nodwch gyfeiriad â llaw",
@@ -220,9 +265,9 @@
 
     "yesNoField": {
       "yes": "Ie",
-      "no": "Na",
+      "no": "Nage",
       "validation": {
-        "selectYesNoRequired": "{{#label}} - dewiswch ie neu na"
+        "selectYesNoRequired": "{{#label}} - dewiswch ie neu nage"
       }
     },
 
@@ -236,7 +281,11 @@
     },
 
     "geospatialField": {
+      "added_zero": "Ni ychwanegwyd unrhyw leoliadau",
       "added_one": "Ychwanegwyd [[count]] lleoliad",
+      "added_two": "Ychwanegwyd dau leoliad",
+      "added_few": "Ychwanegwyd [[count]] lleoliad",
+      "added_many": "Ychwanegwyd [[count]] o leoliadau",
       "added_other": "Ychwanegwyd [[count]] lleoliad",
       "validation": {
         "descriptionRequired": "Rhowch ddisgrifiad ar gyfer lleoliad [[count]]",
@@ -245,7 +294,7 @@
     },
 
     "paymentField": {
-      "detailsRequired": "Angen manylion talu",
+      "detailsRequired": "Angen talu",
       "pendingTransaction": "Mae'n bosibl y gwelwch drafodiad ar y gweill yn eich cyfrif banc ond dim ond pan fyddwch yn cyflwyno'r ffurflen y codir tâl arnoch.",
       "addPaymentDetails": "Ychwanegu manylion talu",
       "cannotTakePayment": "Mae problem ac ni allwn dderbyn taliad. Cysylltwch â ni (manylion yn nhroedyn y ffurflen hon) neu cadwch eich cynnydd a dychwelyd at y ffurflen yn ddiweddarach.",
@@ -261,11 +310,29 @@
     },
 
     "fileUploadField": {
+      "uploading": "Yn uwchlwytho…",
       "uploaded": "Wedi'i uwchlwytho",
       "uploadFailed": "Roedd problem gyda'ch ffeiliau a uwchlwythwyd. Uwchlwythwch nhw eto cyn cyflwyno'r ffurflen.",
       "uploadedFilesHeading": "Ffeiliau a uwchlwythwyd",
+      "filesCount_zero": "Uwchlwythwyd [[count]] o ffeiliau",
       "filesCount_one": "Uwchlwythwyd [[count]] ffeil",
+      "filesCount_two": "Uwchlwythwyd [[count]] ffeil",
+      "filesCount_few": "Uwchlwythwyd [[count]] ffeil",
+      "filesCount_many": "Uwchlwythwyd [[count]] o ffeiliau",
       "filesCount_other": "Uwchlwythwyd [[count]] ffeil"
+    },
+
+    "characterCount": {
+      "_comment": "Note the use of %{count} instead of [[count]]. This is because we are passing to the govuk template, not passing to Joi",
+      "underLimit": {
+        "one": "Mae gennych %{count} nod ar ôl",
+        "other": "Mae gennych %{count} nod ar ôl"
+      },
+      "atLimit": "Mae gennych 0 nod ar ôl",
+      "overLimit": {
+        "one": "Mae gennych %{count} nod yn ormod",
+        "other": "Mae gennych %{count} nod yn ormod"
+      }
     }
   }
 }

package/src/server/plugins/engine/i18n/translations/en-GB.json

@@ -14,7 +14,17 @@
     "numberInteger": "{{#label}} must be a whole number",
     "numberMin": "{{#label}} must be {{#limit}} or higher",
     "numberMax": "{{#label}} must be {{#limit}} or lower",
-    "maxWords": "{{#label}} must be {{#limit}} words or fewer"
+    "maxWords": "{{#label}} must be {{#limit}} words or fewer",
+    "unicode": "{{#label}} includes invalid characters, for example, long dashes",
+    "arrayMin": "Select at least {{#limit}} options from the list",
+    "arrayMax": "Only {{#limit}} can be selected from the list",
+    "arrayLength": "Select only {{#limit}} options from the list",
+    "featuresMin": "Define at least {{#limit}} features",
+    "featuresMax": "Only {{#limit}} features can be defined",
+    "featuresLength": "Define exactly {{#limit}} features",
+    "filesMin": "You must upload {{#limit}} files or more",
+    "filesMax": "You can only upload {{#limit}} files or less",
+    "filesLength": "You must upload exactly {{#limit}} files"
   },
 
   "errors": {
@@ -29,7 +39,14 @@
     "continue": "Continue",
     "saveAndExit": "Save and exit",
     "draft": "draft",
-    "live": "live"
+    "live": "live",
+    "or": "or",
+    "and": "and",
+    "england": "England",
+    "wales": "Wales",
+    "northernIreland": "Northern Ireland",
+    "scotland": "Scotland",
+    "sendFeedback": "Send feedback"
   },
 
   "pages": {
@@ -60,6 +77,8 @@
       "totalAmount": "Total amount",
       "reference": "Reference",
       "dateOfPayment": "Date of payment",
+      "fileUpload_one": "Uploaded [[count]] file",
+      "fileUpload_other": "Uploaded [[count]] files",
       "submissionFailed": "There was a problem and your form was not submitted. Try submitting the form again",
       "submissionFailedContactSuffix": " or you can [[contactUsLink]] and quote your reference number to arrange a refund",
       "contactUsLinkText": "contact us (opens in new tab)",
@@ -89,7 +108,12 @@
 
     "fileUpload": {
       "upload": "Upload file",
-      "maxFilesReached": "You have reached the maximum number of files. Please remove a file to upload more."
+      "maxFilesReached": "You have reached the maximum number of files. Please remove a file to upload more.",
+      "remove": "Remove",
+      "removeFileTitle": "Are you sure you want to remove this file?",
+      "removeFileBody": "You cannot recover removed files.",
+      "removeFileButton": "Remove file",
+      "cancel": "Cancel"
     },
 
     "exit": {
@@ -111,6 +135,7 @@
         "body": "If you want to receive a test email, [[link]] you want form submissions to go to.",
         "linkText": "enter the email address (opens in new tab)"
       },
+      "bannerTitle": "Important",
       "bannerForce": "This is a preview of a [[previewMode]] form. Do not enter personal information.",
       "bannerText": "This is a preview of a [[previewMode]] form page you are editing.",
       "previousPages": "It depends on answers from earlier pages in the form. In the live version, users will need to complete those questions first."
@@ -245,7 +270,7 @@
     },
 
     "paymentField": {
-      "detailsRequired": "Payment details required",
+      "detailsRequired": "Payment required",
       "pendingTransaction": "You may see a pending transaction in your bank account but you will only be charged when you submit the form.",
       "addPaymentDetails": "Add payment details",
       "cannotTakePayment": "There is a problem and we cannot take a payment. Contact us (details in the footer of this form) or save your progress and return to the form later.",
@@ -261,11 +286,25 @@
     },
 
     "fileUploadField": {
+      "uploading": "Uploading…",
       "uploaded": "Uploaded",
       "uploadFailed": "There was a problem with your uploaded files. Re-upload them before submitting the form again.",
       "uploadedFilesHeading": "Uploaded files",
       "filesCount_one": "[[count]] file uploaded",
       "filesCount_other": "[[count]] files uploaded"
+    },
+
+    "characterCount": {
+      "_comment": "Note the use of %{count} instead of [[count]]. This is because we are passing to the govuk template, not passing to Joi",
+      "underLimit": {
+        "one": "You have %{count} character remaining",
+        "other": "You have %{count} characters remaining"
+      },
+      "atLimit": "You have 0 characters remaining",
+      "overLimit": {
+        "one": "You have %{count} character too many",
+        "other": "You have %{count} characters too many"
+      }
     }
   }
 }

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

@@ -22,6 +22,8 @@ export type FormDefinitionTranslations = Record<
         hint: string
         content: string
         shortDescription: string
+        errorDescription: string
+        paymentDescription: string
       }>
     >
     sections: Record<string, Partial<Pick<Section, 'title'>>>

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

@@ -22,6 +22,13 @@ export {
   resolveFormModel
 } from './form-context.js'
 export * from './form-availability.js'
+export { getAvailableLanguages } from './i18n/languages.js'
+export {
+  extractMetadataBaseTranslations,
+  loadFormTranslations
+} from './i18n/createFormTranslator.js'
+export { extractBaseTranslations } from './i18n/extractBaseTranslations.js'
+export { applyUrlParam } from '../nunjucks/filters/applyUrlParam.js'
 
 const globals = {
   checkComponentTemplates,

package/src/server/plugins/engine/models/FormModel.ts

@@ -31,6 +31,7 @@ import { type i18n } from 'i18next'
 import joi from 'joi'
 
 import { logger } from '../../../common/helpers/logging/logger.js'
+import { EN_GB } from '../../../constants.js'
 import { type ListFormComponent } from '../components/ListFormComponent.js'
 import {} from '../components/YesNoField.js'
 import {
@@ -47,6 +48,7 @@ import { loadFormTranslations } from '../i18n/createFormTranslator.js'
 import { createTranslator } from '../i18n/createTranslator.js'
 import { extractBaseTranslations } from '../i18n/extractBaseTranslations.js'
 import { createFormI18nInstance } from '../i18n/index.js'
+import { getAvailableLanguages } from '../i18n/languages.js'
 import { type Translator } from '../i18n/types.js'
 import { type ExecutableCondition } from './types.js'
 import { type PageController } from '../pageControllers/PageController.js'
@@ -240,7 +242,12 @@ export class FormModel {
   }
 
   /** Returns a scoped translator pair for the given language. */
-  createTranslator(language = 'en-GB'): Translator {
+  createTranslator(language = EN_GB): Translator {
+    // @ts-expect-error - dynamic language lookup
+    if (!this.def.metadata?.translations?.[language]) {
+      // If not translations defined in the FormDefinition, always default to English
+      language = EN_GB
+    }
     return createTranslator(this.i18nInstance, language)
   }
 
@@ -662,7 +669,7 @@ function validateFormState(
 
   // Add relevant state errors
   if (error) {
-    const errorsState = error.details.map(getError)
+    const errorsState = error.details.map((item) => getError(EN_GB, item))
     return { ...context, errors: errors.concat(errorsState) }
   }
 
@@ -679,16 +686,3 @@ function getReferenceNumber(state: FormSubmissionState): string {
 
   return state.$$__referenceNumber
 }
-
-export function getAvailableLanguages(
-  def: FormDefinition
-): { name: string; code: string }[] {
-  // @ts-expect-error - dynamic property
-  if (def.metadata?.translations?.cy) {
-    return [
-      { name: 'English', code: 'en-GB' },
-      { name: 'Cymraeg', code: 'cy' }
-    ]
-  }
-  return []
-}