@defra/forms-engine-plugin 5.0.0-alpha.3 → 5.0.0-alpha.6

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

@@ -1,4 +1,4 @@
-import { type ComponentDef, type MarkdownComponent } from '@defra/forms-model'
+import { type MarkdownComponent } from '@defra/forms-model'
 
 import { ComponentBase } from './ComponentBase.js'
 import { type RenderContext } from './types.js'
@@ -28,8 +28,7 @@ export class Markdown extends ComponentBase {
 
     return {
       ...viewModel,
-      content:
-        tComponent(this as unknown as ComponentDef, 'content') || content,
+      content: tComponent(this.def, 'content') || content,
       headerStartLevel: this.headerStartLevel
     }
   }

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

@@ -124,6 +124,7 @@ export interface ViewModel extends Record<string, unknown> {
   upload?: {
     count: number
     summaryList: SummaryList
+    uploadingLabel?: string
   }
 }
 

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

@@ -60,6 +60,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 +85,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": {
@@ -135,7 +158,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",
@@ -237,7 +264,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]]",
@@ -262,10 +293,15 @@
     },
 
     "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"
     },
 

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

@@ -60,6 +60,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 +91,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": {
@@ -262,6 +269,7 @@
     },
 
     "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",

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

@@ -22,6 +22,7 @@ export type FormDefinitionTranslations = Record<
         hint: string
         content: string
         shortDescription: string
+        errorDescription: string
         paymentDescription: string
       }>
     >

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

@@ -212,12 +212,12 @@ function ItemRepeat(
   translator: Translator
 ): DetailItemRepeat {
   const { collection, repeat } = page
-  const { name, title } = repeat.options
-
+  const { name } = repeat.options
+  const { t, tPage } = translator
+  const title = tPage(page.pageDef, 'repeatTitle') || repeat.options.title
   const values = page.getListFromState(state)
   const count = values.length
-  const value =
-    count === 0 ? '' : translator.t('pages.repeater.pageTitle', { count })
+  const value = count === 0 ? '' : t('pages.repeater.pageTitle', { count })
 
   return {
     name,

package/src/server/plugins/engine/outputFormatters/adapter/v1.ts

@@ -3,6 +3,7 @@ import {
   type SubmitResponsePayload
 } from '@defra/forms-model'
 
+import { EN_GB } from '../../../../constants.js'
 import {
   getFormVersion,
   type checkFormStatus
@@ -42,18 +43,14 @@ export function format(
     formSlug: formMetadata?.slug ?? '',
     status: formStatus.state,
     isPreview: formStatus.isPreview,
-    notificationEmail: formMetadata?.notificationEmail ?? ''
+    notificationEmail: formMetadata?.notificationEmail ?? '',
+    language: context.translator?.language ?? EN_GB
   }
 
   if (versionMetadata) {
     meta.versionMetadata = versionMetadata
   }
 
-  const definitionLanguage = model.def.metadata?.language
-  if (typeof definitionLanguage === 'string') {
-    meta.language = definitionLanguage
-  }
-
   const main = Object.fromEntries(
     Object.entries(v2Main).map(([key, value]) => {
       if (value === undefined) {

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

@@ -188,17 +188,19 @@ export class FileUploadPageController extends QuestionPageController {
 
       const { filename } = fileToRemove.status.form.file
 
-      const { t } = this.getTranslator(request)
+      const translator = this.getTranslator(request)
+      const { t } = translator
 
       return h.view(this.fileDeleteViewName, {
         ...viewModel,
         context,
         backLink: this.getBackLink(request, context, t),
-        pageTitle: `Are you sure you want to remove this file?`,
+        pageTitle: t('pages.fileUpload.removeFileTitle'),
         itemTitle: filename,
-        confirmation: { text: 'You cannot recover removed files.' },
-        buttonConfirm: { text: 'Remove file' },
-        buttonCancel: { text: 'Cancel' }
+        confirmation: { text: t('pages.fileUpload.removeFileBody') },
+        buttonConfirm: { text: t('pages.fileUpload.removeFileButton') },
+        buttonCancel: { text: t('pages.fileUpload.cancel') },
+        t
       } satisfies ItemDeletePageViewModel)
     }
   }
@@ -266,6 +268,7 @@ export class FileUploadPageController extends QuestionPageController {
   ): FeaturedFormPageViewModel {
     const { fileUpload } = this
     const { state } = context
+    const { t } = translator
 
     const upload = this.getUploadFromState(state)
 
@@ -277,6 +280,12 @@ export class FileUploadPageController extends QuestionPageController {
       ({ model }) => model.id === fileUpload.name
     )
 
+    formComponent.model.upload = {
+      count: formComponent.model.upload?.count ?? 0,
+      summaryList: formComponent.model.upload?.summaryList ?? { rows: [] },
+      uploadingLabel: t('components.fileUploadField.uploading')
+    }
+
     const index = components.indexOf(formComponent)
 
     const proxyUrl = getProxyUrlForLocalDevelopment(upload?.uploadUrl)
@@ -290,7 +299,8 @@ export class FileUploadPageController extends QuestionPageController {
       // Split out components before/after
       componentsBefore: components.slice(0, index),
       components: components.slice(index),
-      proxyUrl
+      proxyUrl,
+      t
     }
   }
 

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

@@ -406,9 +406,9 @@ export class RepeatPageController extends QuestionPageController {
     const { query } = request
     const { isForceAccess, errors } = context
 
-    const { t } = translator
+    const { t, tPage } = translator
 
-    const { title } = repeat.options
+    const title = tPage(this.pageDef, 'repeatTitle') || repeat.options.title
 
     const summaryList: SummaryList = {
       classes: 'govuk-summary-list--long-actions',

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

@@ -481,6 +481,7 @@ export async function submitForm(
       emailAddress,
       items,
       submitResponse,
+      translator.language,
       formMetadata
     )
   } catch (err) {
@@ -557,7 +558,12 @@ function submitData(
     retrievalKey,
     referenceNumber,
     main: buildMainRecords(items, translator),
-    repeaters: buildRepeaterRecords(items, translator)
+    repeaters: buildRepeaterRecords(items, translator),
+    // Only populate the language property if the form is multi-language enabled
+    // @ts-expect-error - dynamic language property
+    language: model.def.metadata?.translations?.cy
+      ? translator.language
+      : undefined
   }
   return submit(payload)
 }

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

@@ -28,6 +28,7 @@ export async function submit(
   emailAddress: string,
   items: DetailItem[],
   submitResponse: SubmitResponsePayload,
+  _language: string,
   formMetadata?: FormMetadata
 ) {
   if (!templateId) {

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/types.ts

@@ -71,6 +71,7 @@ export interface OutputService {
     emailAddress: string,
     items: DetailItem[],
     submitResponse: SubmitResponsePayload,
+    language: string,
     formMetadata?: FormMetadata
   ) => Promise<void>
 }