@defra/forms-engine-plugin 5.0.0-alpha.11 → 5.0.0-alpha.12

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

@@ -16,15 +16,24 @@
     "numberMax": "{{#label}} must be {{#limit}} or lower",
     "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"
+    "arrayMin_one": "Select at least {{#limit}} option from the list",
+    "arrayMin_other": "Select at least {{#limit}} options from the list",
+    "arrayMax_one": "Only {{#limit}} option can be selected from the list",
+    "arrayMax_other": "Only {{#limit}} options can be selected from the list",
+    "arrayLength_one": "Select only {{#limit}} option from the list",
+    "arrayLength_other": "Select only {{#limit}} options from the list",
+    "featuresMin_one": "Define at least {{#limit}} feature",
+    "featuresMin_other": "Define at least {{#limit}} features",
+    "featuresMax_one": "Only {{#limit}} feature can be defined",
+    "featuresMax_other": "Only {{#limit}} features can be defined",
+    "featuresLength_one": "Define exactly {{#limit}} feature",
+    "featuresLength_other": "Define exactly {{#limit}} features",
+    "filesMin_one": "You must upload {{#limit}} file or more",
+    "filesMin_other": "You must upload {{#limit}} files or more",
+    "filesMax_one": "You can only upload {{#limit}} file or less",
+    "filesMax_other": "You can only upload {{#limit}} files or less",
+    "filesLength_one": "You must upload exactly {{#limit}} file",
+    "filesLength_other": "You must upload exactly {{#limit}} files"
   },
 
   "errors": {
@@ -44,7 +53,7 @@
     "and": "and",
     "england": "England",
     "wales": "Wales",
-    "northernIreland": "Northern Ireland",
+    "northern-ireland": "Northern Ireland",
     "scotland": "Scotland",
     "sendFeedback": "Send feedback"
   },
@@ -145,6 +154,16 @@
       "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."
+    },
+
+    "formUnavailable": {
+      "title": "Sorry, this form is unavailable",
+      "subHeading": "'[[formTitle]]' is no longer available.",
+      "contactDetailsHeading": "Contact details for [[organisationName]]",
+      "telephone": "Telephone",
+      "callCharges": "Find out about call charges",
+      "email": "Email",
+      "onlineContactForm": "Online contact form"
     }
   },
 

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

@@ -24,6 +24,7 @@ export type FormDefinitionTranslations = Record<
         shortDescription: string
         errorDescription: string
         paymentDescription: string
+        instructionText: string
       }>
     >
     sections: Record<string, Partial<Pick<Section, 'title'>>>

package/src/server/plugins/engine/models/unavailable-view-model.ts

@@ -1,19 +1,40 @@
-import { type FormMetadata, type FormMetadataContact } from '@defra/forms-model'
+import {
+  type FormDefinition,
+  type FormMetadata,
+  type FormMetadataContact
+} from '@defra/forms-model'
+
+import { createFormTranslator } from '../i18n/createFormTranslator.js'
+import { getAvailableLanguages } from '../i18n/languages.js'
+import { type Translator } from '../types/index.js'
 
 export interface UnavailableViewModel {
   pageTitle: string
   formTitle: string
   organisationName: string
   contact?: FormMetadataContact
+  context: { translator: Translator }
+  language: string
+  languages: { code: string; name: string }[]
 }
 
 export function unavailableViewModel(
-  metadata: FormMetadata
+  metadata: FormMetadata,
+  definition: FormDefinition | undefined,
+  language: string
 ): UnavailableViewModel {
+  const translator = createFormTranslator(metadata, definition, language)
+  const { t, tForm } = translator
   return {
-    pageTitle: 'Sorry, this form is unavailable',
-    formTitle: metadata.title,
+    pageTitle: t('pages.formUnavailable.title'),
+    formTitle: tForm('title') || metadata.title,
     organisationName: metadata.organisation,
-    contact: metadata.contact
+    contact: metadata.contact,
+    context: { translator },
+    language,
+    // Always get Welsh and English
+    languages: getAvailableLanguages({
+      metadata: { translations: { cy: {} } }
+    } as unknown as FormDefinition)
   }
 }

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

@@ -26,7 +26,7 @@ export const opts = {
  * import messageTemplate directly and get the English version.
  */
 export const messageTemplate: ValidationMessages = buildValidationMessages(
-  (key) => t(key, 'en-GB')
+  (key, options) => t(key, 'en-GB', options)
 )
 
 export const messages: LanguageMessagesExt = {
@@ -79,7 +79,7 @@ export const messagesPre: LanguageMessages =
   messages as unknown as LanguageMessages
 
 export function buildLanguageMessages(
-  t: (key: string) => string
+  t: (key: string, options?: Record<string, unknown>) => string
 ): LanguageMessages {
   const vm = buildValidationMessages(t)
   return {

package/src/server/plugins/engine/unavailable-response.ts

@@ -2,6 +2,8 @@ import { type Request, type ResponseToolkit, type Server } from '@hapi/hapi'
 
 import { isOfflineBoom } from './form-availability.js'
 import { unavailableViewModel } from './models/unavailable-view-model.js'
+import { type AnyFormRequest } from './types.js'
+import { resolveLanguage } from '../../utils/utils.js'
 
 /**
  * Registers a server-wide onPreResponse extension that intercepts the offline
@@ -17,10 +19,12 @@ export function registerUnavailableResponse(server: Server) {
       return h.continue
     }
 
-    const { metadata } = response.data
+    const { metadata, definition } = response.data
+
+    const language = resolveLanguage(request as unknown as AnyFormRequest)
 
     return h
-      .view('unavailable', unavailableViewModel(metadata))
+      .view('unavailable', unavailableViewModel(metadata, definition, language))
       .header('Cache-Control', 'no-store, no-cache, must-revalidate')
       .header('X-Robots-Tag', 'noindex, nofollow')
       .code(200)

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

@@ -61,7 +61,7 @@
   {% set detailsHtml %}
     {% if component.model.instructionText %}
       {{ govukDetails({
-        summaryText: t('components.locationFieldBase.howToFind'),
+        summaryText: component.model.instructionSummary,
         html: component.model.instructionText | markdown | safe,
         classes: "govuk-!-margin-top-3"
       }) }}

package/src/server/plugins/engine/views/unavailable.html

@@ -1,32 +1,35 @@
 {% extends baseLayoutPath %}
 
+{% set t = context.translator.t %}
+{% set tForm = context.translator.tForm %}
+
 {% block content %}
   <div class="govuk-grid-row">
     <div class="govuk-grid-column-two-thirds">
-      <h1 class="govuk-heading-l">Sorry, this form is unavailable</h1>
-      <p class="govuk-body">'{{ formTitle }}' is no longer available.</p>
-      <h2 class="govuk-heading-m">Contact details for {{ organisationName }}</h2>
+      <h1 class="govuk-heading-l">{{ t('pages.formUnavailable.title') }}</h1>
+      <p class="govuk-body">{{ t('pages.formUnavailable.subHeading', { formTitle: formTitle }) }}</p>
+      <h2 class="govuk-heading-m">{{ t('pages.formUnavailable.contactDetailsHeading', { organisationName: organisationName }) }}</h2>
 
       {% if contact.phone %}
-        <h3 class="govuk-heading-s">Telephone</h3>
+        <h3 class="govuk-heading-s">{{ t('pages.formUnavailable.telephone') }}</h3>
         <div class="app-prose-scope">
-          {{ contact.phone | markdown(3) | safe }}
+          {{ tForm('contact.phone') | markdown(3) | safe }}
         </div>
-        <p class="govuk-body"><a href="https://www.gov.uk/call-charges" class="govuk-link govuk-link--no-visited-state">Find out about call charges</a></p>
+        <p class="govuk-body"><a href="https://www.gov.uk/call-charges" class="govuk-link govuk-link--no-visited-state">{{ t('pages.formUnavailable.callCharges') }}</a></p>
       {% endif %}
 
       {% if contact.email %}
-        <h3 class="govuk-heading-s">Email</h3>
+        <h3 class="govuk-heading-s">{{ t('pages.formUnavailable.email') }}</h3>
         <ul class="govuk-list">
-          <li><a class="govuk-link govuk-link--no-visited-state" href="mailto:{{ contact.email.address }}">{{ contact.email.address }}</a></li>
-          <li>{{ contact.email.responseTime }}</li>
+          <li><a class="govuk-link govuk-link--no-visited-state" href="mailto:{{ tForm('contact.email.address') }}">{{ tForm('contact.email.address') }}</a></li>
+          <li>{{ tForm('contact.email.responseTime') }}</li>
         </ul>
       {% endif %}
 
       {% if contact.online %}
-        <h3 class="govuk-heading-s">Online contact form</h3>
+        <h3 class="govuk-heading-s">{{ t('pages.formUnavailable.onlineContactForm') }}</h3>
         <ul class="govuk-list">
-          <li><a class="govuk-link govuk-link--no-visited-state" href="{{ contact.online.url }}">{{ contact.online.text }}</a></li>
+          <li><a class="govuk-link govuk-link--no-visited-state" href="{{ tForm('contact.online.url') }}">{{ tForm('contact.online.text') }}</a></li>
         </ul>
       {% endif %}
     </div>