@defra/forms-engine-plugin 5.0.0-alpha.2 → 5.0.0-alpha.5

package/src/client/javascripts/sssi-dataset.js

@@ -49,50 +49,47 @@ export function sssiScotlandRequestTransformer(url, { bbox }) {
   }
 }
 
-export default {
-  datasets: [
-    {
-      id: 'sssi-england',
-      label: 'Sites of Special Scientific Interest',
-      dynamicGeoJSON: {
-        url: englandWFS,
-        idProperty: 'ref_code',
-        transformRequest: sssiEnglandRequestTransformer
-      },
-      minZoom,
-      style,
-      showInKey: true,
-      showInMenu: false
+export default [
+  {
+    id: 'sssi-england',
+    label: 'Sites of Special Scientific Interest',
+    dynamicGeoJSON: {
+      url: englandWFS,
+      idProperty: 'ref_code',
+      transformRequest: sssiEnglandRequestTransformer
     },
-    {
-      id: 'sssi-wales',
-      label: 'SSSI Wales',
-      dynamicGeoJSON: {
-        url: walesWFS,
-        idProperty: 'id',
-        transformRequest: sssiWalesRequestTransformer
-      },
-      minZoom,
-      style,
-      showInKey: false,
-      showInMenu: false
+    minZoom,
+    style,
+    showInKey: true,
+    showInMenu: false
+  },
+  {
+    id: 'sssi-wales',
+    label: 'SSSI Wales',
+    dynamicGeoJSON: {
+      url: walesWFS,
+      idProperty: 'id',
+      transformRequest: sssiWalesRequestTransformer
     },
-    {
-      id: 'sssi-scotland',
-      label: 'SSSI Scotland',
-      dynamicGeoJSON: {
-        url: scotlandWFS,
-        idProperty: 'OBJECTID',
-        transformRequest: sssiScotlandRequestTransformer
-      },
-      minZoom,
-      style,
-      showInKey: false,
-      showInMenu: false
-    }
-  ]
-}
-
+    minZoom,
+    style,
+    showInKey: false,
+    showInMenu: false
+  },
+  {
+    id: 'sssi-scotland',
+    label: 'SSSI Scotland',
+    dynamicGeoJSON: {
+      url: scotlandWFS,
+      idProperty: 'OBJECTID',
+      transformRequest: sssiScotlandRequestTransformer
+    },
+    minZoom,
+    style,
+    showInKey: false,
+    showInMenu: false
+  }
+]
 /**
  * @typedef {object} TransformRequestOptions
  * @property {string[]} bbox - the bounding box coordinates

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

@@ -169,7 +169,7 @@ export class FileUploadField extends FormComponent {
       return ''
     }
 
-    return translator.t('components.fileUploadField.filesCount', {
+    return translator.t('pages.summary.fileUpload', {
       count: files.length
     })
   }
@@ -244,7 +244,7 @@ export class FileUploadField extends FormComponent {
 
         items.push({
           href,
-          text: 'Remove',
+          text: t('pages.fileUpload.remove'),
           classes: 'govuk-link--no-visited-state',
           attributes: { id: `${id}__${index}` },
           visuallyHiddenText: file.filename

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

@@ -45,6 +45,7 @@ export class PaymentField extends FormComponent {
   declare options: PaymentFieldComponent['options']
   declare formSchema: ObjectSchema
   declare stateSchema: ObjectSchema
+  declare def: PaymentFieldComponent
   isAppendageStateSingleObject = true
 
   constructor(
@@ -54,6 +55,7 @@ export class PaymentField extends FormComponent {
     super(def, props)
 
     this.options = def.options
+    this.def = def
 
     const paymentStateSchema = joi
       .object({
@@ -110,6 +112,8 @@ export class PaymentField extends FormComponent {
   getViewModel(context: RenderContext) {
     const { payload } = context
     const viewModel = super.getViewModel(context)
+    const { translator } = context
+    const { tComponent } = translator
 
     // Payload is pre-populated from state if a payment has already been made
     const paymentState = this.isPaymentState(payload[this.name] as unknown)
@@ -124,7 +128,8 @@ export class PaymentField extends FormComponent {
     return {
       ...viewModel,
       amount: formatCurrency(amount),
-      description: this.options.description,
+      description:
+        tComponent(this.def, 'paymentDescription') || this.options.description,
       paymentState
     }
   }

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

@@ -1,4 +1,8 @@
-import { type FormDefinition } from '@defra/forms-model'
+import {
+  yesNoListNoItemId,
+  yesNoListYesItemId,
+  type FormDefinition
+} from '@defra/forms-model'
 import { type i18n } from 'i18next'
 
 import { createTranslator } from './createTranslator.js'
@@ -28,6 +32,22 @@ 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'
+        )
+      }
     }
   }
 }

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": {
@@ -111,6 +134,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 +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",
@@ -220,7 +248,7 @@
 
     "yesNoField": {
       "yes": "Ie",
-      "no": "Na",
+      "no": "Nage",
       "validation": {
         "selectYesNoRequired": "{{#label}} - dewiswch ie neu na"
       }
@@ -236,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]]",
@@ -245,7 +277,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 +293,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

@@ -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": {
@@ -111,6 +118,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 +253,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 +269,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,7 @@ export type FormDefinitionTranslations = Record<
         hint: string
         content: string
         shortDescription: string
+        paymentDescription: string
       }>
     >
     sections: Record<string, Partial<Pick<Section, 'title'>>>

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

@@ -174,9 +174,14 @@ export class QuestionPageController extends PageController {
           if (!pageTitle) {
             pageTitle = labelOrLegend.text
           }
-          labelOrLegend.text = isOptional
-            ? `${pageTitle} ${t('common.optional')}`
-            : pageTitle
+
+          // The question text may have already appended 'optional' in the relevant language
+          const optionalWord = t('common.optional')
+          const optionalAlreadyAppended = pageTitle.endsWith(` ${optionalWord}`)
+          labelOrLegend.text =
+            isOptional && !optionalAlreadyAppended
+              ? `${pageTitle} ${optionalWord}`
+              : pageTitle
         }
 
         // Fallback if still no pageTitle set

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/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/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">