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

package/src/server/plugins/postcode-lookup/models/index.js

@@ -16,6 +16,7 @@ const countyFieldName = 'county'
 const postcodeFieldName = 'postcode'
 
 const GOVUK_MARGIN_RIGHT_1 = 'govuk-!-margin-right-1'
+const COMMON_BACK = 'common.back'
 
 export const steps = {
   // Step 1: Postcode/building name input
@@ -403,19 +404,20 @@ function getHref(step) {
 /**
  * The postcode lookup details form view model
  * @param {PostcodeLookupSessionData} data
+ * @param {Translator} translator
  * @param {PostcodeLookupDetailsData} [payload]
  * @param {Error} [err]
  */
-export function detailsViewModel(data, payload, err) {
-  const {
-    componentTitle: pageTitle,
-    formName,
-    sourceUrl,
-    language = 'en-GB'
-  } = data.initial
+export function detailsViewModel(data, translator, payload, err) {
+  const { componentId, componentHint, sourceUrl, languages } = data.initial
+
+  const { t, tComponent, tForm } = translator
+
+  const component = /** @type {ComponentDef} */ ({ id: componentId })
 
   const backLink = {
-    href: sourceUrl
+    href: sourceUrl,
+    text: t(COMMON_BACK)
   }
 
   const { errors, postcodeQueryError, buildingNameQueryError } =
@@ -425,42 +427,53 @@ export function detailsViewModel(data, payload, err) {
     payload ?? data.details,
     postcodeQueryError,
     buildingNameQueryError,
-    language
+    translator.language
   )
 
+  const hint = componentHint && {
+    text: tComponent(component, 'hint')
+  }
+
   const continueButton = {
-    text: i18nT('postcodeLookup.findAddress', language),
+    text: t('postcodeLookup.findAddress'),
     classes: GOVUK_MARGIN_RIGHT_1
   }
   const manualLink = {
-    text: i18nT('postcodeLookup.enterManually', language),
+    text: t('postcodeLookup.enterManually'),
     href: getHref(steps.manual)
   }
 
+  const selector = languages?.length ? { languages } : {}
+
   return {
     step: steps.details,
     showTitle: true,
-    name: formName,
+    name: tForm('title'),
     serviceUrl: sourceUrl,
-    pageTitle,
+    pageTitle: tComponent(component, 'title'),
+    hint,
     backLink,
     errors,
     fields,
-    buttons: { continueButton, manualLink }
+    buttons: { continueButton, manualLink },
+    t,
+    language: translator.language,
+    ...selector
   }
 }
 
 /**
  * The postcode lookup select form view model
  * @param {{ session: PostcodeLookupSessionData, apiKey: string }} data
+ * @param {Translator} translator
  * @param {PostcodeLookupSelectPayload} [payload]
  * @param {Error} [err]
  */
-export async function selectViewModel(data, payload, err) {
+export async function selectViewModel(data, translator, payload, err) {
   const { session, apiKey } = data
   const { details, initial } = session
   const { postcodeQuery, buildingNameQuery } = details
-  const language = initial.language ?? 'en-GB'
+  const { language, t, tComponent, tForm } = translator
 
   const {
     hasAddresses,
@@ -471,12 +484,18 @@ export async function selectViewModel(data, payload, err) {
   } = await getAddresses(postcodeQuery, buildingNameQuery, apiKey)
 
   const title = hasAddresses
-    ? initial.componentTitle
-    : i18nT('postcodeLookup.noAddressFoundTitle', language)
+    ? tComponent(
+        /** @type {ComponentDef} */ ({ id: initial.componentId }),
+        'title'
+      )
+    : t('postcodeLookup.noAddressFoundTitle')
   const formPath = initial.sourceUrl
   const href = getHref()
 
-  const backLink = { href }
+  const backLink = {
+    href,
+    text: t(COMMON_BACK)
+  }
 
   const { errors, uprnError } = buildErrors(err)
 
@@ -490,7 +509,7 @@ export async function selectViewModel(data, payload, err) {
     language
   )
 
-  const searchAgainText = i18nT('postcodeLookup.searchAgain', language)
+  const searchAgainText = t('postcodeLookup.searchAgain')
 
   const searchAgainLink = {
     text: searchAgainText,
@@ -499,27 +518,29 @@ export async function selectViewModel(data, payload, err) {
 
   const continueButton = {
     href: hasAddresses ? undefined : href,
-    text: hasAddresses
-      ? i18nT('postcodeLookup.useThisAddress', language)
-      : searchAgainText,
+    text: hasAddresses ? t('postcodeLookup.useThisAddress') : searchAgainText,
     classes: GOVUK_MARGIN_RIGHT_1
   }
   const manualLink = {
-    text: i18nT('postcodeLookup.enterManually', language),
+    text: t('postcodeLookup.enterManually'),
     href: `${href}?step=${steps.manual}`
   }
 
   const addressesFoundText = hasAddresses
-    ? i18nT('postcodeLookup.addressFound', language, { count: addressCount })
+    ? t('postcodeLookup.addressFound', { count: addressCount })
     : undefined
   const noAddressFoundText = !hasAddresses
-    ? i18nT('postcodeLookup.noAddressFoundBody', language)
+    ? t('postcodeLookup.noAddressFoundBody')
     : undefined
 
+  const selector = initial.languages?.length
+    ? { languages: initial.languages }
+    : {}
+
   return {
     step: steps.select,
     showTitle: true,
-    name: title,
+    name: tForm('title'),
     serviceUrl: formPath,
     pageTitle: title,
     backLink,
@@ -533,28 +554,32 @@ export async function selectViewModel(data, payload, err) {
     hasMultipleAddresses,
     addressesFoundText,
     noAddressFoundText,
-    buttons: { continueButton, manualLink }
+    buttons: { continueButton, manualLink },
+    t,
+    language,
+    ...selector
   }
 }
 
 /**
  * The postcode lookup manual form view model
  * @param {PostcodeLookupSessionData} data
+ * @param {Translator} translator
  * @param {PostcodeLookupManualPayload} [payload]
  * @param {Error} [err]
  */
-export function manualViewModel(data, payload, err) {
-  const {
-    componentTitle,
-    sourceUrl,
-    componentHint,
-    language = 'en-GB'
-  } = data.initial
+export function manualViewModel(data, translator, payload, err) {
+  const { componentId, sourceUrl, componentHint, languages } = data.initial
   const formPath = sourceUrl
   const href = getHref()
 
+  const { t, tComponent, tForm } = translator
+
+  const component = /** @type {ComponentDef} */ ({ id: componentId })
+
   const backLink = {
-    href
+    href,
+    text: t(COMMON_BACK)
   }
 
   const {
@@ -567,7 +592,7 @@ export function manualViewModel(data, payload, err) {
   } = buildErrors(err)
 
   const hint = componentHint && {
-    text: componentHint
+    text: tComponent(component, 'hint')
   }
 
   const fields = getManualFields(
@@ -577,29 +602,34 @@ export function manualViewModel(data, payload, err) {
     townError,
     countyError,
     postcodeError,
-    language
+    translator.language
   )
 
   const continueButton = {
-    text: i18nT('postcodeLookup.useThisAddress', language),
+    text: t('postcodeLookup.useThisAddress'),
     classes: GOVUK_MARGIN_RIGHT_1
   }
   const detailsLink = {
-    text: i18nT('postcodeLookup.findAnAddressInstead', language),
+    text: t('postcodeLookup.findAnAddressInstead'),
     href
   }
 
+  const selector = languages?.length ? { languages } : {}
+
   return {
     step: steps.manual,
     showTitle: true,
-    name: componentTitle,
+    name: tForm('title'),
     serviceUrl: formPath,
-    pageTitle: componentTitle,
+    pageTitle: tComponent(component, 'title'),
     backLink,
     errors,
     hint,
     fields,
-    buttons: { continueButton, detailsLink }
+    buttons: { continueButton, detailsLink },
+    t,
+    language: translator.language,
+    ...selector
   }
 }
 
@@ -607,5 +637,7 @@ export function manualViewModel(data, payload, err) {
 
 /**
  * @import { ObjectSchema, ValidationErrorItem } from 'joi'
+ * @import { ComponentDef } from '@defra/forms-model'
  * @import { Address, PostcodeLookupDetailsData, PostcodeLookupDetailsPayload, PostcodeLookupManualPayload, PostcodeLookupSelectPayload, PostcodeLookupSessionData } from '../types.js'
+ * @import { Translator } from '../../engine/i18n/types.js'
  */

package/src/server/plugins/postcode-lookup/routes/index.js

@@ -3,6 +3,7 @@ import { StatusCodes } from 'http-status-codes'
 import Joi from 'joi'
 
 import { EXTERNAL_STATE_APPENDAGE } from '../../../constants.js'
+import { getCachedPluginTranslator } from '../../engine/i18n/form.js'
 import {
   JOURNEY_BASE_URL,
   createDetailsPayloadSchema,
@@ -15,6 +16,7 @@ import {
   steps
 } from '../models/index.js'
 import * as service from '../service.js'
+import { resolveLanguage } from '../../../utils/utils.js'
 
 const viewName = 'postcode-lookup-details'
 
@@ -22,7 +24,7 @@ const viewName = 'postcode-lookup-details'
  * Get the session state associated with this journey
  * @param {PostcodeLookupRequest} request
  */
-function getSessionState(request) {
+export function getSessionState(request) {
   /**
    * @type {PostcodeLookupSessionData | null | undefined}
    */
@@ -63,6 +65,32 @@ function flashComponentState(request, componentName, address) {
 
   request.yar.flash(EXTERNAL_STATE_APPENDAGE, appendage, true)
 }
+/**
+ * Get a cached translator, or create a new one if not in the cache
+ * @param {PostcodeLookupRequest} request
+ * @param {PostcodeLookupDispatchData} initial
+ * @param { string | string[] | undefined } language
+ */
+export async function getDispatchTranslator(request, initial, language) {
+  const { formId, formStatus } = initial
+
+  // Override language if passed as a query param
+  if (language) {
+    request.yar.set('language', language)
+  }
+
+  const typedReq = /** @type {AnyFormRequest} */ (/** @type {any} */ (request))
+  const lang = resolveLanguage(typedReq)
+
+  const translator = await getCachedPluginTranslator(
+    typedReq,
+    /** @type {FormMetadata} */ ({ id: formId }),
+    formStatus,
+    lang
+  )
+
+  return translator
+}
 
 /**
  * Initialises and dispatches the request to the postcode lookup journey
@@ -101,15 +129,21 @@ function getRoute() {
   return {
     method: 'GET',
     path: JOURNEY_BASE_URL,
-    handler(request, h) {
+    async handler(request, h) {
       const { query } = request
-      const { step } = query
+      const { step, language } = query
       const session = getSessionState(request)
 
+      const translator = await getDispatchTranslator(
+        request,
+        session.initial,
+        language
+      )
+
       const model =
         step === steps.manual
-          ? manualViewModel(session)
-          : detailsViewModel(session)
+          ? manualViewModel(session, translator)
+          : detailsViewModel(session, translator)
 
       return h.view(viewName, model)
     },
@@ -117,7 +151,8 @@ function getRoute() {
       validate: {
         query: Joi.object()
           .keys({
-            step: Joi.string().allow(steps.details, steps.manual).optional()
+            step: Joi.string().allow(steps.details, steps.manual).optional(),
+            language: Joi.string().allow('en-GB', 'cy').optional()
           })
           .optional()
       }
@@ -172,7 +207,13 @@ function postRoute(options) {
 async function detailsPostHandler(request, h, options) {
   const session = getSessionState(request)
   const { ordnanceSurveyApiKey: apiKey } = options
-  const language = session.initial.language ?? 'en-GB'
+  const translator = await getDispatchTranslator(
+    request,
+    session.initial,
+    request.query.language
+  )
+  const language = translator.language
+
   const { value: details, error } = createDetailsPayloadSchema(
     language
   ).validate(request.payload)
@@ -180,7 +221,7 @@ async function detailsPostHandler(request, h, options) {
   let model
 
   if (error) {
-    model = detailsViewModel(session, details, error)
+    model = detailsViewModel(session, translator, details, error)
 
     return h.view(viewName, model)
   }
@@ -191,7 +232,7 @@ async function detailsPostHandler(request, h, options) {
   // Store the updated session
   request.yar.set(JOURNEY_BASE_URL, session)
 
-  model = await selectViewModel({ session, apiKey })
+  model = await selectViewModel({ session, apiKey }, translator)
 
   return h.view(viewName, model)
 }
@@ -205,13 +246,23 @@ async function detailsPostHandler(request, h, options) {
 async function selectPostHandler(request, h, options) {
   const session = getSessionState(request)
   const { ordnanceSurveyApiKey: apiKey } = options
-  const language = session.initial.language ?? 'en-GB'
+  const translator = await getDispatchTranslator(
+    request,
+    session.initial,
+    request.query.language
+  )
+  const language = translator.language
   const { value: select, error } = createSelectPayloadSchema(language).validate(
     request.payload
   )
 
   if (error) {
-    const model = await selectViewModel({ session, apiKey }, select, error)
+    const model = await selectViewModel(
+      { session, apiKey },
+      translator,
+      select,
+      error
+    )
 
     return h.view(viewName, model)
   }
@@ -235,9 +286,14 @@ async function selectPostHandler(request, h, options) {
  * @param {PostcodeLookupPostRequest} request
  * @param {ResponseToolkit<PostcodeLookupPostRequestRefs>} h
  */
-function manualPostHandler(request, h) {
+async function manualPostHandler(request, h) {
   const session = getSessionState(request)
-  const language = session.initial.language ?? 'en-GB'
+  const translator = await getDispatchTranslator(
+    request,
+    session.initial,
+    request.query.language
+  )
+  const language = translator.language
 
   const { value: manual, error } = createManualPayloadSchema(language).validate(
     request.payload,
@@ -247,7 +303,7 @@ function manualPostHandler(request, h) {
   )
 
   if (error) {
-    const model = manualViewModel(session, manual, error)
+    const model = manualViewModel(session, translator, manual, error)
 
     return h.view(viewName, model)
   }
@@ -261,7 +317,8 @@ function manualPostHandler(request, h) {
 
 /**
  * @import { ResponseToolkit, ServerRoute } from '@hapi/hapi'
- * @import { PostcodeLookupManualPayload, PostcodeLookupDetailsPayload, PostcodeLookupSelectPayload, Address, PostcodeLookupGetRequestRefs, PostcodeLookupPostRequestRefs, PostcodeLookupRequest, PostcodeLookupPostRequest, PostcodeLookupConfiguration, PostcodeLookupDispatchData, PostcodeLookupSessionData } from '../types.js'
+ * @import { FormMetadata } from '@defra/forms-model'
+ * @import { PostcodeLookupManualPayload, Address, PostcodeLookupGetRequestRefs, PostcodeLookupPostRequestRefs, PostcodeLookupRequest, PostcodeLookupPostRequest, PostcodeLookupConfiguration, PostcodeLookupDispatchData, PostcodeLookupSessionData } from '../types.js'
  * @import { FormRequestPayload, FormResponseToolkit } from '../../../routes/types.js'
- * @import { ExternalStateAppendage } from '../../engine/types.js'
+ * @import { AnyFormRequest, ExternalStateAppendage } from '../../engine/types.js'
  */

package/src/server/plugins/postcode-lookup/types.js

@@ -14,12 +14,16 @@
 /**
  * @typedef {{
  *   sourceUrl: string,
+ *   formId: string
  *   formName: string
+ *   formStatus: FormStatus
+ *   componentId: string
  *   componentName: string
  *   componentTitle: string,
  *   componentHint?: string
  *   step?: string
  *   language?: string
+ *   languages?: { name: string, code: string}[]
  * }} PostcodeLookupDispatchData
  */
 
@@ -49,6 +53,7 @@
  * Postcode lookup query params
  * @typedef {object} PostcodeLookupQuery
  * @property {string} [step] - step
+ * @property {string} [language] - language
  */
 
 /**
@@ -140,5 +145,5 @@
 
 /**
  * @import { Request } from '@hapi/hapi'
- * @import { FormPayload } from '../engine/types.js'
+ * @import { FormStatus } from '@defra/forms-model'
  */

package/src/server/plugins/postcode-lookup/views/postcode-lookup-details.html

@@ -33,7 +33,7 @@
             <!-- Postcode lookup select -->
             <!-- Postcode lookup details display -->
             {%- set detailsHtml -%}
-              <strong>{{ details.postcodeQuery }}</strong>{% if details.buildingNameQuery %} and <strong>{{ details.buildingNameQuery }}</strong>{% endif %}
+              <strong>{{ details.postcodeQuery }}</strong>{% if details.buildingNameQuery %} {{ t('common.and')}} <strong>{{ details.buildingNameQuery }}</strong>{% endif %}
             {%- endset -%}
 
             {% if hasAddresses %}
@@ -72,9 +72,9 @@
           {{ govukButton(buttons.continueButton) }}
 
           {% if buttons.manualLink %}
-            <p class="govuk-body">or <a class="govuk-link govuk-link--no-visited-state" href="{{ buttons.manualLink.href }}">{{buttons.manualLink.text}}</a></p>
+            <p class="govuk-body">{{ t('common.or')}} <a class="govuk-link govuk-link--no-visited-state" href="{{ buttons.manualLink.href }}">{{buttons.manualLink.text}}</a></p>
           {% elif buttons.detailsLink %}
-            <p class="govuk-body">or <a class="govuk-link govuk-link--no-visited-state" href="{{ buttons.detailsLink.href }}">{{buttons.detailsLink.text}}</a></p>
+            <p class="govuk-body">{{ t('common.or')}} <a class="govuk-link govuk-link--no-visited-state" href="{{ buttons.detailsLink.href }}">{{buttons.detailsLink.text}}</a></p>
           {% endif %}
         </div>
       </form>

package/src/server/utils/type-utils.ts

@@ -1,14 +1,4 @@
-import Joi, {
-  type JoiExpression,
-  type LanguageMessages,
-  type LanguageMessagesExt
-} from 'joi'
-
-export function convertToLanguageMessages(
-  extLanguageMessages: LanguageMessagesExt
-): LanguageMessages {
-  return extLanguageMessages as unknown as LanguageMessages
-}
+import Joi, { type JoiExpression } from 'joi'
 
 export function createJoiExpression(expr: string): JoiExpression {
   return Joi.expression(expr) as unknown as JoiExpression