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

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

@@ -0,0 +1,271 @@
+{
+  "validation": {
+    "required": "Enter {{lowerFirst(#label)}}",
+    "selectRequired": "Select {{lowerFirst(#label)}}",
+    "pattern": "Enter a valid {{lowerFirst(#label)}}",
+    "format": "Enter {{lowerFirst(#label)}} in the correct format",
+    "objectRequired": "Enter {{#label}}",
+    "objectMissing": "{{#title}} must include a {{lowerFirst(#label)}}",
+    "max": "{{#label}} must be {{#limit}} characters or less",
+    "min": "{{#label}} must be {{#limit}} characters or more",
+    "minMax": "{{#label}} must be between {{#min}} and {{#max}} characters",
+    "number": "{{#label}} must be a number",
+    "numberPrecision": "{{#label}} must have {{#limit}} or fewer decimal places",
+    "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"
+  },
+
+  "errors": {
+    "title": "There is a problem",
+    "optionsMismatch": "Options are different because you changed a previous answer"
+  },
+
+  "common": {
+    "optional": "(optional)",
+    "warningIconFallback": "Warning",
+    "back": "Back",
+    "continue": "Continue",
+    "saveAndExit": "Save and exit",
+    "draft": "draft",
+    "live": "live"
+  },
+
+  "pages": {
+    "question": {
+      "paymentCancelledBannerTitle": "Important",
+      "paymentCancelledTitle": "Your payment has been cancelled",
+      "paymentCancelledBody": "Your payment details were deleted because the form was inactive for 5 days.",
+      "paymentCancelledAction": "Add your payment details again.",
+      "backToAddAnother": "Go back to add another",
+      "backToCheckAnswers": "Go back to check answers",
+      "startNow": "Start now"
+    },
+
+    "summary": {
+      "title": "Check your answers before sending your form",
+      "change": "Change",
+      "notProvided": "Not provided",
+      "declaration": "Declaration",
+      "acceptAndSubmit": "Accept and submit",
+      "payAndSubmit": "Pay and submit",
+      "submit": "Submit",
+      "saveAndExit": "Save and exit",
+      "paymentSuccessBannerTitle": "Success",
+      "paymentSuccessTitle": "We have your payment details",
+      "paymentSuccessBody": "Your payment is on hold. We will charge you when you submit the form.",
+      "paymentDetailsTitle": "Payment details",
+      "paymentFor": "Payment for",
+      "totalAmount": "Total amount",
+      "reference": "Reference",
+      "dateOfPayment": "Date of payment",
+      "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)",
+      "confirmationEmail": "Confirmation email (optional)",
+      "confirmationEmailHint": "Enter your email address to receive a confirmation email and a copy of your answers"
+    },
+
+    "repeater": {
+      "removeAnswer": "Are you sure you want to remove this answer?",
+      "remove": "Remove",
+      "cancel": "Cancel",
+      "lastItemCannotBeRemoved": "Last list item cannot be removed",
+      "itemToRemoveNotFound": "List item to remove not found",
+      "continue": "Continue",
+      "addAnother": "Add another",
+      "saveAndExit": "Save and exit",
+      "change": "Change",
+      "notProvided": "Not provided",
+      "visuallyHiddenItem": "item [[index]]",
+      "pageTitle_one": "You have added [[count]] answer",
+      "pageTitle_other": "You have added [[count]] answers",
+      "tooMany_one": "You can only add up to [[count]] answer",
+      "tooMany_other": "You can only add up to [[count]] answers",
+      "tooFew_one": "You must add at least [[count]] answer",
+      "tooFew_other": "You must add at least [[count]] answers"
+    },
+
+    "fileUpload": {
+      "upload": "Upload file",
+      "maxFilesReached": "You have reached the maximum number of files. Please remove a file to upload more."
+    },
+
+    "exit": {
+      "defaultTitle": "Your progress has been saved",
+      "whatHappensNext": "What happens next",
+      "body": "Your form progress has been saved. You can return to complete your application at any time using the link provided.",
+      "returnToApplication": "Return to application"
+    },
+
+    "confirmation": {
+      "formSubmitted": "Form submitted",
+      "whatHappensNext": "What happens next",
+      "referenceNumber": "Your reference number",
+      "feedbackLink": "What do you think of this service? (takes 30 seconds)"
+    },
+
+    "preview": {
+      "warnMissingNotificationEmail": {
+        "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)"
+      },
+      "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."
+    }
+  },
+
+  "postcodeLookup": {
+    "postcodeLabel": "Postcode",
+    "postcodeHint": "For example, AA3 1AB",
+    "buildingNameLabel": "Building name or number (optional)",
+    "buildingNameHint": "For example, 15 or Prospect Cottage",
+    "selectAddress": "Select an address",
+    "addressLine1Label": "Address line 1",
+    "addressLine2Label": "Address line 2 (optional)",
+    "townLabel": "Town or city",
+    "countyLabel": "County (optional)",
+    "findAddress": "Find address",
+    "enterManually": "enter address manually",
+    "searchAgain": "Search again",
+    "useThisAddress": "Use this address",
+    "findAnAddressInstead": "find an address instead",
+    "noAddressFoundTitle": "No address found",
+    "noAddressFoundBody": "We could not find an address that matches",
+    "addressFound_one": "[[count]] address found for",
+    "addressFound_other": "[[count]] addresses found for",
+    "validation": {
+      "invalidPostcode": "Enter a valid postcode or enter an address manually",
+      "requiredPostcode": "Enter a postcode",
+      "selectAddress": "Select an address",
+      "requiredAddressLine1": "Enter address line 1",
+      "requiredTown": "Enter town or city",
+      "invalidManualPostcode": "Enter a valid postcode",
+      "requiredManualPostcode": "Enter postcode"
+    }
+  },
+
+  "components": {
+    "dateField": {
+      "day": "Day",
+      "month": "Month",
+      "year": "Year",
+      "validation": {
+        "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}}"
+      }
+    },
+
+    "monthYearField": {
+      "month": "Month",
+      "year": "Year"
+    },
+
+    "addressField": {
+      "uprn": "UPRN",
+      "line1": "Address line 1",
+      "line2": "Address line 2",
+      "town": "Town or city",
+      "county": "County",
+      "postcode": "Postcode",
+      "enterAddress": "Enter [[shortDescription]]",
+      "findAddress": "Find an address",
+      "selectedAddress": "Selected address:",
+      "useDifferentAddress": "Use a different address",
+      "enterManually": "enter address manually"
+    },
+
+    "latLongField": {
+      "latitude": "Latitude",
+      "longitude": "Longitude",
+      "latitudeRequired": "Enter latitude",
+      "longitudeRequired": "Enter longitude",
+      "precision": "{{#label}} must have no more than 7 decimal places",
+      "notANumber": "{{#label}} must be a valid number",
+      "latitudeBase": "Enter a valid latitude for [[fieldLabel]] like 51.519450",
+      "longitudeBase": "Enter a valid longitude for [[fieldLabel]] like -0.127758",
+      "latitudeRange": "Latitude for [[fieldLabel]] must be between [[min]] and [[max]]",
+      "longitudeRange": "Longitude for [[fieldLabel]] must be between [[min]] and [[max]]"
+    },
+
+    "eastingNorthingField": {
+      "easting": "Easting",
+      "northing": "Northing",
+      "eastingRequired": "Enter easting",
+      "northingRequired": "Enter northing",
+      "eastingDigits": "{{#label}} for [[fieldLabel]] must be between 1 and 6 digits",
+      "northingDigits": "{{#label}} for [[fieldLabel]] must be between 1 and 7 digits",
+      "eastingRange": "{{#label}} for [[fieldLabel]] must be between [[min]] and [[max]]",
+      "northingRange": "{{#label}} for [[fieldLabel]] must be between [[min]] and [[max]]"
+    },
+
+    "nationalGridField": {
+      "required": "Enter {{lowerFirst(#title)}}",
+      "pattern": "Enter a valid National Grid field number for {{lowerFirst(#title)}} like NG 1234 5678",
+      "howToFind": "How to find location details"
+    },
+
+    "osGridRefField": {
+      "required": "Enter {{lowerFirst(#title)}}",
+      "pattern": "Enter a valid OS grid reference for {{lowerFirst(#title)}} like TQ123456",
+      "howToFind": "How to find location details"
+    },
+
+    "locationFieldBase": {
+      "howToFind": "How to find location details"
+    },
+
+    "yesNoField": {
+      "yes": "Yes",
+      "no": "No",
+      "validation": {
+        "selectYesNoRequired": "{{#label}} - select yes or no"
+      }
+    },
+
+    "declarationField": {
+      "defaultLabel": "I understand and agree",
+      "defaultConfirmationLabel": "I confirm that I understand and accept this declaration",
+      "notProvided": "Not provided",
+      "validation": {
+        "declarationRequired": "You must confirm you understand and agree with the {{lowerFirst(#label)}} to continue"
+      }
+    },
+
+    "geospatialField": {
+      "added_one": "Added [[count]] location",
+      "added_other": "Added [[count]] locations",
+      "validation": {
+        "descriptionRequired": "Enter description for location [[count]]",
+        "wrongCountry": "Location [[count]] must be within [[country]]"
+      }
+    },
+
+    "paymentField": {
+      "detailsRequired": "Payment details 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.",
+      "testApiKey": "Add a valid test API key before you can preview the payment journey.",
+      "completePayment": "Complete the payment to continue",
+      "paymentExpired": "Your payment authorisation has expired. Please add your payment details again.",
+      "submissionFailed": "There was a problem and your form was not submitted. Try submitting the form again.",
+      "canSubmitAfterPayment": "You can submit the form after you have added your payment details.",
+      "preAuthorisedTitle": "You have already authorised a payment for this form",
+      "preAuthorisedBody": "Continue to submit the form. You will not be charged twice.",
+      "totalAmountLabel": "Total amount:",
+      "paymentAmountMismatch": "The pre-authorised payment amount is somehow different from that requested. Try adding payment details again."
+    },
+
+    "fileUploadField": {
+      "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"
+    }
+  }
+}

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

@@ -0,0 +1,41 @@
+import { type ComponentDef, type Item, type Page, type Section } from '@defra/forms-model';
+/**
+ * Structure of the `translations` block in a form definition.
+ * Also used to derive the valid property keys for the typed tX functions.
+ */
+export type FormDefinitionTranslations = Record<string, {
+    pages: Record<string, Partial<{
+        title: string;
+        repeatTitle: string;
+    }>>;
+    components: Record<string, Partial<{
+        title: string;
+        hint: string;
+        content: string;
+        shortDescription: string;
+    }>>;
+    sections: Record<string, Partial<Pick<Section, 'title'>>>;
+    listItems: Record<string, Partial<Pick<Item, 'text' | 'hint'>>>;
+    form: Record<string, string>;
+}>;
+type EntityTranslations = FormDefinitionTranslations[string];
+/**
+ * Scoped translator returned by model.createTranslator(language).
+ * t          — plugin namespace (UI strings, buttons, errors, sub-field labels)
+ * tForm      — form namespace: form attributes, currently only form name
+ * tPage      — form namespace: page titles
+ * tComponent — form namespace: component titles, hints, shortDescriptions
+ * tSection   — form namespace: section titles
+ * tListItem  — form namespace: list item text
+ * language   - current language
+ */
+export interface Translator {
+    t: (key: string, opts?: Record<string, unknown>) => string;
+    tForm: (prop: string) => string;
+    tPage: (page: Page, prop: keyof EntityTranslations['pages'][string]) => string;
+    tComponent: (component: ComponentDef, prop: keyof EntityTranslations['components'][string]) => string;
+    tSection: (section: Section, prop: keyof EntityTranslations['sections'][string]) => string;
+    tListItem: (item: Item, prop: keyof EntityTranslations['listItems'][string]) => string;
+    language: string;
+}
+export {};

package/.server/server/plugins/engine/i18n/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/.server/server/plugins/engine/i18n/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../../../../src/server/plugins/engine/i18n/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Item,\n  type Page,\n  type Section\n} from '@defra/forms-model'\n\n/**\n * Structure of the `translations` block in a form definition.\n * Also used to derive the valid property keys for the typed tX functions.\n */\nexport type FormDefinitionTranslations = Record<\n  string,\n  {\n    pages: Record<string, Partial<{ title: string; repeatTitle: string }>>\n    // ComponentDef is a discriminated union; Pick across the full union is not feasible.\n    // The four keys below are the complete set of translatable component properties.\n    components: Record<\n      string,\n      Partial<{\n        title: string\n        hint: string\n        content: string\n        shortDescription: string\n      }>\n    >\n    sections: Record<string, Partial<Pick<Section, 'title'>>>\n    listItems: Record<string, Partial<Pick<Item, 'text' | 'hint'>>>\n    form: Record<string, string>\n  }\n>\n\ntype EntityTranslations = FormDefinitionTranslations[string]\n\n/**\n * Scoped translator returned by model.createTranslator(language).\n * t          — plugin namespace (UI strings, buttons, errors, sub-field labels)\n * tForm      — form namespace: form attributes, currently only form name\n * tPage      — form namespace: page titles\n * tComponent — form namespace: component titles, hints, shortDescriptions\n * tSection   — form namespace: section titles\n * tListItem  — form namespace: list item text\n * language   - current language\n */\nexport interface Translator {\n  t: (key: string, opts?: Record<string, unknown>) => string\n  tForm: (prop: string) => string\n  tPage: (page: Page, prop: keyof EntityTranslations['pages'][string]) => string\n  tComponent: (\n    component: ComponentDef,\n    prop: keyof EntityTranslations['components'][string]\n  ) => string\n  tSection: (\n    section: Section,\n    prop: keyof EntityTranslations['sections'][string]\n  ) => string\n  tListItem: (\n    item: Item,\n    prop: keyof EntityTranslations['listItems'][string]\n  ) => string\n  language: string\n}\n"],"mappings":"","ignoreList":[]}

package/.server/server/plugins/engine/index.js

@@ -1,7 +1,7 @@
 import { markdownToHtml } from '@defra/forms-model';
 import { engine } from "./helpers.js";
 import { plugin } from "./plugin.js";
-import { checkComponentTemplates, checkErrorTemplates, evaluate, govukRebrand } from "../nunjucks/environment.js";
+import { checkComponentTemplates, checkErrorTemplates, evaluate, govukRebrand, tGlobal } from "../nunjucks/environment.js";
 import * as filters from "../nunjucks/filters/index.js";
 export { getPageHref } from "./helpers.js";
 export { context } from "../nunjucks/context.js";
@@ -11,7 +11,8 @@ const globals = {
   checkComponentTemplates,
   checkErrorTemplates,
   evaluate,
-  govukRebrand
+  govukRebrand,
+  t: tGlobal
 };
 export const VIEW_PATH = 'src/server/plugins/engine/views';
 export const PLUGIN_PATH = 'node_modules/@defra/forms-engine-plugin';

package/.server/server/plugins/engine/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["markdownToHtml","engine","plugin","checkComponentTemplates","checkErrorTemplates","evaluate","govukRebrand","filters","getPageHref","context","getFirstJourneyPage","getFormContext","getFormModel","resolveFormModel","globals","VIEW_PATH","PLUGIN_PATH","STATE_NOT_YET_VALIDATED","CURRENT_PAGE_PATH_KEY","MAGIC_LINK_GROUP_ID","prepareNunjucksEnvironment","env","pluginOptions","name","nunjucksFilter","Object","entries","addFilter","text","startingHeaderLevel","baseUrl","nunjucksGlobal","addGlobal","filter","registerFilter","forEach","fn"],"sources":["../../../../src/server/plugins/engine/index.ts"],"sourcesContent":["import { markdownToHtml } from '@defra/forms-model'\nimport { type Environment } from 'nunjucks'\n\nimport { engine } from '~/src/server/plugins/engine/helpers.js'\nimport { plugin } from '~/src/server/plugins/engine/plugin.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\nimport {\n  checkComponentTemplates,\n  checkErrorTemplates,\n  evaluate,\n  govukRebrand\n} from '~/src/server/plugins/nunjucks/environment.js'\nimport * as filters from '~/src/server/plugins/nunjucks/filters/index.js'\n\nexport { getPageHref } from '~/src/server/plugins/engine/helpers.js'\nexport { context } from '~/src/server/plugins/nunjucks/context.js'\nexport {\n  getFirstJourneyPage,\n  getFormContext,\n  getFormModel,\n  resolveFormModel\n} from '~/src/server/plugins/engine/form-context.js'\nexport * from '~/src/server/plugins/engine/form-availability.js'\n\nconst globals = {\n  checkComponentTemplates,\n  checkErrorTemplates,\n  evaluate,\n  govukRebrand\n}\n\nexport const VIEW_PATH = 'src/server/plugins/engine/views'\nexport const PLUGIN_PATH = 'node_modules/@defra/forms-engine-plugin'\n\nexport const STATE_NOT_YET_VALIDATED = '__stateNotYetValidated'\nexport const CURRENT_PAGE_PATH_KEY = '__currentPagePath'\nexport const MAGIC_LINK_GROUP_ID = '__magicLinkGroupId'\n\nexport const prepareNunjucksEnvironment = function (\n  env: Environment,\n  pluginOptions: PluginOptions\n) {\n  for (const [name, nunjucksFilter] of Object.entries(filters)) {\n    env.addFilter(name, nunjucksFilter)\n  }\n\n  env.addFilter('markdown', (text: string, startingHeaderLevel?: number) =>\n    markdownToHtml(text, {\n      baseUrl: pluginOptions.baseUrl,\n      startingHeaderLevel\n    })\n  )\n\n  for (const [name, nunjucksGlobal] of Object.entries(globals)) {\n    env.addGlobal(name, nunjucksGlobal)\n  }\n\n  // Apply any additional filters to both the liquid and nunjucks engines\n  if (pluginOptions.filters) {\n    for (const [name, filter] of Object.entries(pluginOptions.filters)) {\n      env.addFilter(name, filter)\n      engine.registerFilter(name, filter)\n    }\n  }\n\n  // Apply any additional globals to nunjucks engines\n  if (pluginOptions.globals) {\n    Object.entries(pluginOptions.globals).forEach(([name, fn]) => {\n      env.addGlobal(name, fn)\n    })\n  }\n}\n\nexport default plugin\n"],"mappings":"AAAA,SAASA,cAAc,QAAQ,oBAAoB;AAGnD,SAASC,MAAM;AACf,SAASC,MAAM;AAEf,SACEC,uBAAuB,EACvBC,mBAAmB,EACnBC,QAAQ,EACRC,YAAY;AAEd,OAAO,KAAKC,OAAO;AAEnB,SAASC,WAAW;AACpB,SAASC,OAAO;AAChB,SACEC,mBAAmB,EACnBC,cAAc,EACdC,YAAY,EACZC,gBAAgB;AAElB;AAEA,MAAMC,OAAO,GAAG;EACdX,uBAAuB;EACvBC,mBAAmB;EACnBC,QAAQ;EACRC;AACF,CAAC;AAED,OAAO,MAAMS,SAAS,GAAG,iCAAiC;AAC1D,OAAO,MAAMC,WAAW,GAAG,yCAAyC;AAEpE,OAAO,MAAMC,uBAAuB,GAAG,wBAAwB;AAC/D,OAAO,MAAMC,qBAAqB,GAAG,mBAAmB;AACxD,OAAO,MAAMC,mBAAmB,GAAG,oBAAoB;AAEvD,OAAO,MAAMC,0BAA0B,GAAG,SAAAA,CACxCC,GAAgB,EAChBC,aAA4B,EAC5B;EACA,KAAK,MAAM,CAACC,IAAI,EAAEC,cAAc,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACnB,OAAO,CAAC,EAAE;IAC5Dc,GAAG,CAACM,SAAS,CAACJ,IAAI,EAAEC,cAAc,CAAC;EACrC;EAEAH,GAAG,CAACM,SAAS,CAAC,UAAU,EAAE,CAACC,IAAY,EAAEC,mBAA4B,KACnE7B,cAAc,CAAC4B,IAAI,EAAE;IACnBE,OAAO,EAAER,aAAa,CAACQ,OAAO;IAC9BD;EACF,CAAC,CACH,CAAC;EAED,KAAK,MAAM,CAACN,IAAI,EAAEQ,cAAc,CAAC,IAAIN,MAAM,CAACC,OAAO,CAACZ,OAAO,CAAC,EAAE;IAC5DO,GAAG,CAACW,SAAS,CAACT,IAAI,EAAEQ,cAAc,CAAC;EACrC;;EAEA;EACA,IAAIT,aAAa,CAACf,OAAO,EAAE;IACzB,KAAK,MAAM,CAACgB,IAAI,EAAEU,MAAM,CAAC,IAAIR,MAAM,CAACC,OAAO,CAACJ,aAAa,CAACf,OAAO,CAAC,EAAE;MAClEc,GAAG,CAACM,SAAS,CAACJ,IAAI,EAAEU,MAAM,CAAC;MAC3BhC,MAAM,CAACiC,cAAc,CAACX,IAAI,EAAEU,MAAM,CAAC;IACrC;EACF;;EAEA;EACA,IAAIX,aAAa,CAACR,OAAO,EAAE;IACzBW,MAAM,CAACC,OAAO,CAACJ,aAAa,CAACR,OAAO,CAAC,CAACqB,OAAO,CAAC,CAAC,CAACZ,IAAI,EAAEa,EAAE,CAAC,KAAK;MAC5Df,GAAG,CAACW,SAAS,CAACT,IAAI,EAAEa,EAAE,CAAC;IACzB,CAAC,CAAC;EACJ;AACF,CAAC;AAED,eAAelC,MAAM","ignoreList":[]}
+{"version":3,"file":"index.js","names":["markdownToHtml","engine","plugin","checkComponentTemplates","checkErrorTemplates","evaluate","govukRebrand","tGlobal","filters","getPageHref","context","getFirstJourneyPage","getFormContext","getFormModel","resolveFormModel","globals","t","VIEW_PATH","PLUGIN_PATH","STATE_NOT_YET_VALIDATED","CURRENT_PAGE_PATH_KEY","MAGIC_LINK_GROUP_ID","prepareNunjucksEnvironment","env","pluginOptions","name","nunjucksFilter","Object","entries","addFilter","text","startingHeaderLevel","baseUrl","nunjucksGlobal","addGlobal","filter","registerFilter","forEach","fn"],"sources":["../../../../src/server/plugins/engine/index.ts"],"sourcesContent":["import { markdownToHtml } from '@defra/forms-model'\nimport { type Environment } from 'nunjucks'\n\nimport { engine } from '~/src/server/plugins/engine/helpers.js'\nimport { plugin } from '~/src/server/plugins/engine/plugin.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\nimport {\n  checkComponentTemplates,\n  checkErrorTemplates,\n  evaluate,\n  govukRebrand,\n  tGlobal\n} from '~/src/server/plugins/nunjucks/environment.js'\nimport * as filters from '~/src/server/plugins/nunjucks/filters/index.js'\n\nexport { getPageHref } from '~/src/server/plugins/engine/helpers.js'\nexport { context } from '~/src/server/plugins/nunjucks/context.js'\nexport {\n  getFirstJourneyPage,\n  getFormContext,\n  getFormModel,\n  resolveFormModel\n} from '~/src/server/plugins/engine/form-context.js'\nexport * from '~/src/server/plugins/engine/form-availability.js'\n\nconst globals = {\n  checkComponentTemplates,\n  checkErrorTemplates,\n  evaluate,\n  govukRebrand,\n  t: tGlobal\n}\n\nexport const VIEW_PATH = 'src/server/plugins/engine/views'\nexport const PLUGIN_PATH = 'node_modules/@defra/forms-engine-plugin'\n\nexport const STATE_NOT_YET_VALIDATED = '__stateNotYetValidated'\nexport const CURRENT_PAGE_PATH_KEY = '__currentPagePath'\nexport const MAGIC_LINK_GROUP_ID = '__magicLinkGroupId'\n\nexport const prepareNunjucksEnvironment = function (\n  env: Environment,\n  pluginOptions: PluginOptions\n) {\n  for (const [name, nunjucksFilter] of Object.entries(filters)) {\n    env.addFilter(name, nunjucksFilter)\n  }\n\n  env.addFilter('markdown', (text: string, startingHeaderLevel?: number) =>\n    markdownToHtml(text, {\n      baseUrl: pluginOptions.baseUrl,\n      startingHeaderLevel\n    })\n  )\n\n  for (const [name, nunjucksGlobal] of Object.entries(globals)) {\n    env.addGlobal(name, nunjucksGlobal)\n  }\n\n  // Apply any additional filters to both the liquid and nunjucks engines\n  if (pluginOptions.filters) {\n    for (const [name, filter] of Object.entries(pluginOptions.filters)) {\n      env.addFilter(name, filter)\n      engine.registerFilter(name, filter)\n    }\n  }\n\n  // Apply any additional globals to nunjucks engines\n  if (pluginOptions.globals) {\n    Object.entries(pluginOptions.globals).forEach(([name, fn]) => {\n      env.addGlobal(name, fn)\n    })\n  }\n}\n\nexport default plugin\n"],"mappings":"AAAA,SAASA,cAAc,QAAQ,oBAAoB;AAGnD,SAASC,MAAM;AACf,SAASC,MAAM;AAEf,SACEC,uBAAuB,EACvBC,mBAAmB,EACnBC,QAAQ,EACRC,YAAY,EACZC,OAAO;AAET,OAAO,KAAKC,OAAO;AAEnB,SAASC,WAAW;AACpB,SAASC,OAAO;AAChB,SACEC,mBAAmB,EACnBC,cAAc,EACdC,YAAY,EACZC,gBAAgB;AAElB;AAEA,MAAMC,OAAO,GAAG;EACdZ,uBAAuB;EACvBC,mBAAmB;EACnBC,QAAQ;EACRC,YAAY;EACZU,CAAC,EAAET;AACL,CAAC;AAED,OAAO,MAAMU,SAAS,GAAG,iCAAiC;AAC1D,OAAO,MAAMC,WAAW,GAAG,yCAAyC;AAEpE,OAAO,MAAMC,uBAAuB,GAAG,wBAAwB;AAC/D,OAAO,MAAMC,qBAAqB,GAAG,mBAAmB;AACxD,OAAO,MAAMC,mBAAmB,GAAG,oBAAoB;AAEvD,OAAO,MAAMC,0BAA0B,GAAG,SAAAA,CACxCC,GAAgB,EAChBC,aAA4B,EAC5B;EACA,KAAK,MAAM,CAACC,IAAI,EAAEC,cAAc,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACpB,OAAO,CAAC,EAAE;IAC5De,GAAG,CAACM,SAAS,CAACJ,IAAI,EAAEC,cAAc,CAAC;EACrC;EAEAH,GAAG,CAACM,SAAS,CAAC,UAAU,EAAE,CAACC,IAAY,EAAEC,mBAA4B,KACnE/B,cAAc,CAAC8B,IAAI,EAAE;IACnBE,OAAO,EAAER,aAAa,CAACQ,OAAO;IAC9BD;EACF,CAAC,CACH,CAAC;EAED,KAAK,MAAM,CAACN,IAAI,EAAEQ,cAAc,CAAC,IAAIN,MAAM,CAACC,OAAO,CAACb,OAAO,CAAC,EAAE;IAC5DQ,GAAG,CAACW,SAAS,CAACT,IAAI,EAAEQ,cAAc,CAAC;EACrC;;EAEA;EACA,IAAIT,aAAa,CAAChB,OAAO,EAAE;IACzB,KAAK,MAAM,CAACiB,IAAI,EAAEU,MAAM,CAAC,IAAIR,MAAM,CAACC,OAAO,CAACJ,aAAa,CAAChB,OAAO,CAAC,EAAE;MAClEe,GAAG,CAACM,SAAS,CAACJ,IAAI,EAAEU,MAAM,CAAC;MAC3BlC,MAAM,CAACmC,cAAc,CAACX,IAAI,EAAEU,MAAM,CAAC;IACrC;EACF;;EAEA;EACA,IAAIX,aAAa,CAACT,OAAO,EAAE;IACzBY,MAAM,CAACC,OAAO,CAACJ,aAAa,CAACT,OAAO,CAAC,CAACsB,OAAO,CAAC,CAAC,CAACZ,IAAI,EAAEa,EAAE,CAAC,KAAK;MAC5Df,GAAG,CAACW,SAAS,CAACT,IAAI,EAAEa,EAAE,CAAC;IACzB,CAAC,CAAC;EACJ;AACF,CAAC;AAED,eAAepC,MAAM","ignoreList":[]}

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

@@ -2,6 +2,7 @@ import { SchemaVersion, type ComponentDef, type ConditionWrapper, type Condition
 import { Parser, type Value } from 'expr-eval-fork';
 import joi from 'joi';
 import { type Component } from '../../../../server/plugins/engine/components/helpers/components.js';
+import { type Translator } from '../../../../server/plugins/engine/i18n/types.js';
 import { type ExecutableCondition } from '../../../../server/plugins/engine/models/types.js';
 import { type PageController } from '../../../../server/plugins/engine/pageControllers/PageController.js';
 import { type PageControllerClass } from '../../../../server/plugins/engine/pageControllers/helpers/pages.js';
@@ -23,6 +24,7 @@ export declare class FormModel {
     conditions: Partial<Record<string, ExecutableCondition>>;
     pages: PageControllerClass[];
     services: Services;
+    private readonly i18nInstance;
     controllers?: Record<string, typeof PageController>;
     pageDefMap: Map<string, Page>;
     listDefMap: Map<string, List>;
@@ -36,6 +38,8 @@ export declare class FormModel {
         ordnanceSurveyApiKey?: string;
         formId?: string;
     }, services?: Services, controllers?: Record<string, typeof PageController>);
+    /** Returns a scoped translator pair for the given language. */
+    createTranslator(language?: string): Translator;
     /**
      * build the entire model schema from individual pages/sections and filter out answers
      * for pages which are no longer accessible due to an answer that has been changed
@@ -53,7 +57,7 @@ export declare class FormModel {
     /**
      * Form context for the current page
      */
-    getFormContext(request: FormContextRequest, state: FormSubmissionState, errors?: FormSubmissionError[]): FormContext;
+    getFormContext(request: FormContextRequest, state: FormSubmissionState, errors?: FormSubmissionError[], translator?: Translator): FormContext;
     private initialiseContext;
     private assignEvaluationState;
     private assignRelevantState;
@@ -73,3 +77,7 @@ export declare class FormModel {
      */
     moreThanOnePaymentQuestion(): boolean;
 }
+export declare function getAvailableLanguages(def: FormDefinition): {
+    name: string;
+    code: string;
+}[];

package/.server/server/plugins/engine/models/FormModel.js

@@ -6,7 +6,11 @@ import { logger } from "../../../common/helpers/logging/logger.js";
 import "../components/YesNoField.js";
 import { hasListFormField } from "../components/helpers/components.js";
 import { todayAsDateOnly } from "../date-helper.js";
-import { findPage, getError, getPage, setPageTitles } from "../helpers.js";
+import { findPage, getError, getPage } from "../helpers.js";
+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 { createPage } from "../pageControllers/helpers/pages.js";
 import { validationOptions as opts } from "../pageControllers/validationOptions.js";
 import * as defaultServices from "../services/index.js";
@@ -29,6 +33,7 @@ export class FormModel {
   conditions;
   pages;
   services;
+  i18nInstance;
   controllers;
   pageDefMap;
   listDefMap;
@@ -53,8 +58,12 @@ export class FormModel {
     // Make a clone of the shallow copy returned
     // by joi so as not to change the source data.
     def = structuredClone(result.value);
+    const baseTranslations = extractBaseTranslations(def);
+    this.i18nInstance = createFormI18nInstance(baseTranslations);
+    loadFormTranslations(def, this.i18nInstance);
 
-    // Add default lists
+    // Add default lists. Yes/No text stored as i18n key constants so they
+    // resolve to the user's language at render time via the translator.
     def.lists.push({
       id: def.schema === SchemaVersion.V1 ? yesNoListName : yesNoListId,
       name: '__yesNo',
@@ -62,17 +71,14 @@ export class FormModel {
       type: 'boolean',
       items: [{
         id: '02900d42-83d1-4c72-a719-c4e8228952fa',
-        text: 'Yes',
+        text: 'components.yesNoField.yes',
         value: true
       }, {
         id: 'f39000eb-c51b-4019-8f82-bbda0423f04d',
-        text: 'No',
+        text: 'components.yesNoField.no',
         value: false
       }]
     });
-
-    // Fix up page titles
-    setPageTitles(def);
     this.engine = def.engine;
     this.schemaVersion = def.schema ?? SchemaVersion.V1;
     this.def = def;
@@ -113,7 +119,7 @@ export class FormModel {
     // Check for user-provided status page (optional)
     controller === ControllerType.Status)) {
       this.pages.push(createPage(this, {
-        title: 'Form submitted',
+        title: 'pages.confirmation.formSubmitted',
         path: ControllerPath.Status,
         controller: ControllerType.Status
       }));
@@ -122,6 +128,11 @@ export class FormModel {
     this.componentMap = new Map(this.pages.flatMap(page => page.collection.components.map(component => [component.name, component])));
   }
 
+  /** Returns a scoped translator pair for the given language. */
+  createTranslator(language = 'en-GB') {
+    return createTranslator(this.i18nInstance, language);
+  }
+
   /**
    * build the entire model schema from individual pages/sections and filter out answers
    * for pages which are no longer accessible due to an answer that has been changed
@@ -207,7 +218,7 @@ export class FormModel {
   /**
    * Form context for the current page
    */
-  getFormContext(request, state, errors) {
+  getFormContext(request, state, errors, translator) {
     const {
       query
     } = request;
@@ -234,11 +245,13 @@ export class FormModel {
       componentDefMap: this.componentDefMap,
       pageMap: this.pageMap,
       componentMap: this.componentMap,
-      referenceNumber: getReferenceNumber(state)
+      referenceNumber: getReferenceNumber(state),
+      languages: getAvailableLanguages(this.def),
+      translator
     };
 
     // Validate current page
-    context = validateFormPayload(request, page, context);
+    context = validateFormPayload(request, page, context, translator);
 
     // Find start page
     let nextPage = findPage(this, startPath);
@@ -252,7 +265,7 @@ export class FormModel {
       this.assignRelevantState(context, nextPage);
 
       // Stop at current page
-      if (this.pageStateIsInvalid(context, nextPage) || nextPage.path === currentPath) {
+      if (this.pageStateIsInvalid(context, nextPage, translator) || nextPage.path === currentPath) {
         break;
       }
 
@@ -301,7 +314,7 @@ export class FormModel {
       }
     }
   }
-  pageStateIsInvalid(context, page) {
+  pageStateIsInvalid(context, page, translator) {
     // Get any list-bound fields on the page
     const listFields = page.collection.fields.filter(hasListFormField);
 
@@ -315,12 +328,12 @@ export class FormModel {
       if (list !== undefined && field.type !== ComponentType.YesNoField) {
         const hasOptionalItems = list.items.filter(item => item.condition).length > 0;
         if (hasOptionalItems) {
-          return this.fieldStateIsInvalid(context, field, list);
+          return this.fieldStateIsInvalid(context, field, list, translator);
         }
       }
     }
   }
-  fieldStateIsInvalid(context, field, list) {
+  fieldStateIsInvalid(context, field, list, translator) {
     const {
       evaluationState,
       state
@@ -342,7 +355,7 @@ export class FormModel {
       }
       if (isInvalid) {
         context.errors ??= [];
-        const text = 'Options are different because you changed a previous answer';
+        const text = (translator ?? this.createTranslator('en-GB')).t('errors.optionsMismatch');
         context.errors.push({
           text,
           name: field.name,
@@ -399,7 +412,7 @@ export class FormModel {
 /**
  * Validate current page only
  */
-function validateFormPayload(request, page, context) {
+function validateFormPayload(request, page, context, translator) {
   const {
     collection
   } = page;
@@ -433,7 +446,7 @@ function validateFormPayload(request, page, context) {
   } = collection.validate({
     ...payload,
     ...update
-  });
+  }, translator);
 
   // Add sanitised payload (ready to save)
   const formState = page.getStateFromValidForm(request, state, value);
@@ -482,4 +495,17 @@ function getReferenceNumber(state) {
   }
   return state.$$__referenceNumber;
 }
+export function getAvailableLanguages(def) {
+  // @ts-expect-error - dynamic property
+  if (def.metadata?.translations?.cy) {
+    return [{
+      name: 'English',
+      code: 'en-GB'
+    }, {
+      name: 'Cymraeg',
+      code: 'cy'
+    }];
+  }
+  return [];
+}
 //# sourceMappingURL=FormModel.js.map