@defra/forms-engine-plugin 5.0.0-alpha.8 → 5.0.0-alpha.9

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

@@ -15,7 +15,10 @@ import {
   getLocationFieldViewModel
 } from './LocationFieldHelpers.js'
 import { NumberField } from './NumberField.js'
-import { createLowerFirstExpression } from './helpers/index.js'
+import {
+  createLowerFirstExpression,
+  getTranslatedLabel
+} from './helpers/index.js'
 import {
   type EastingNorthingState,
   type RenderContext
@@ -55,89 +58,18 @@ export class EastingNorthingField extends FormComponent {
 
     const isRequired = options.required !== false
 
-    const eastingMin = schema?.easting?.min ?? DEFAULT_EASTING_MIN
-    const eastingMax = schema?.easting?.max ?? DEFAULT_EASTING_MAX
-    const northingMin = schema?.northing?.min ?? DEFAULT_NORTHING_MIN
-    const northingMax = schema?.northing?.max ?? DEFAULT_NORTHING_MAX
-
-    const fieldLabel = lowerFirst(this.label)
+    const { eastingMin, eastingMax, northingMin, northingMax } =
+      EastingNorthingField.getMinMax(schema)
 
-    const eastingDigitsMessage = tPlugin(
-      'components.eastingNorthingField.eastingDigits',
-      'en-GB',
-      { fieldLabel }
-    )
-    const northingDigitsMessage = tPlugin(
-      'components.eastingNorthingField.northingDigits',
-      'en-GB',
-      { fieldLabel }
-    )
-
-    const customValidationMessages: LanguageMessages =
-      convertToLanguageMessages({
-        'any.required': tPlugin(
-          'components.eastingNorthingField.eastingRequired',
-          'en-GB'
-        ),
-        'number.base': tPlugin(
-          'components.eastingNorthingField.eastingRequired',
-          'en-GB'
-        ),
-        'number.min': tPlugin(
-          'components.eastingNorthingField.eastingRange',
-          'en-GB',
-          {
-            fieldLabel,
-            min: eastingMin,
-            max: eastingMax
-          }
-        ),
-        'number.max': tPlugin(
-          'components.eastingNorthingField.eastingRange',
-          'en-GB',
-          {
-            fieldLabel,
-            min: eastingMin,
-            max: eastingMax
-          }
-        ),
-        'number.precision': eastingDigitsMessage,
-        'number.integer': eastingDigitsMessage,
-        'number.unsafe': eastingDigitsMessage
-      })
-
-    const northingValidationMessages: LanguageMessages =
-      convertToLanguageMessages({
-        'any.required': tPlugin(
-          'components.eastingNorthingField.northingRequired',
-          'en-GB'
-        ),
-        'number.base': tPlugin(
-          'components.eastingNorthingField.northingRequired',
-          'en-GB'
-        ),
-        'number.min': tPlugin(
-          'components.eastingNorthingField.northingRange',
-          'en-GB',
-          {
-            fieldLabel,
-            min: northingMin,
-            max: northingMax
-          }
-        ),
-        'number.max': tPlugin(
-          'components.eastingNorthingField.northingRange',
-          'en-GB',
-          {
-            fieldLabel,
-            min: northingMin,
-            max: northingMax
-          }
-        ),
-        'number.precision': northingDigitsMessage,
-        'number.integer': northingDigitsMessage,
-        'number.unsafe': northingDigitsMessage
-      })
+    const { eastingValidationMessages, northingValidationMessages } =
+      EastingNorthingField.buildErrorMessages(
+        this.label,
+        eastingMin,
+        eastingMax,
+        northingMin,
+        northingMax,
+        'en-GB'
+      )
 
     this.collection = new ComponentCollection(
       [
@@ -154,7 +86,7 @@ export class EastingNorthingField extends FormComponent {
             required: isRequired,
             optionalText: true,
             classes: 'govuk-input--width-10',
-            customValidationMessages
+            customValidationMessages: eastingValidationMessages
           }
         },
         {
@@ -192,14 +124,15 @@ export class EastingNorthingField extends FormComponent {
 
   getDisplayStringFromFormValue(
     value: EastingNorthingState | undefined,
-    _translator: Translator
+    translator: Translator
   ): string {
     if (!value) {
       return ''
     }
 
-    // CYA page format: <<eastingvalue, northingvalue>>
-    return `${value.easting}, ${value.northing}`
+    const { t } = translator
+
+    return `${t('components.eastingNorthingField.easting')}: ${value.easting}\n${t('components.eastingNorthingField.northing')}: ${value.northing}`
   }
 
   getDisplayStringFromState(
@@ -218,7 +151,7 @@ export class EastingNorthingField extends FormComponent {
       return null
     }
 
-    return `Easting: ${value.easting}\nNorthing: ${value.northing}`
+    return `${value.easting}, ${value.northing}`
   }
 
   getContextValueFromState(state: FormSubmissionState) {
@@ -244,6 +177,26 @@ export class EastingNorthingField extends FormComponent {
     return EastingNorthingField.isEastingNorthing(value)
   }
 
+  getValidationMessagesOverride(translator: Translator) {
+    const def = this.def as EastingNorthingFieldComponent
+    const translatedLabel = getTranslatedLabel(def, translator)
+    const { eastingMin, eastingMax, northingMin, northingMax } =
+      EastingNorthingField.getMinMax(def.schema)
+    const { eastingValidationMessages, northingValidationMessages } =
+      EastingNorthingField.buildErrorMessages(
+        translatedLabel,
+        eastingMin,
+        eastingMax,
+        northingMin,
+        northingMax,
+        translator.language
+      )
+    return {
+      [`${this.name}__easting`]: eastingValidationMessages,
+      [`${this.name}__northing`]: northingValidationMessages
+    }
+  }
+
   /**
    * For error preview page that shows all possible errors on a component
    */
@@ -309,4 +262,119 @@ export class EastingNorthingField extends FormComponent {
       NumberField.isNumber(value.northing)
     )
   }
+
+  static buildErrorMessages(
+    label: string,
+    eastingMin: number,
+    eastingMax: number,
+    northingMin: number,
+    northingMax: number,
+    language: string
+  ) {
+    const fieldLabel = lowerFirst(label)
+
+    const eastingDigitsMessage = tPlugin(
+      'components.eastingNorthingField.eastingDigits',
+      language,
+      { fieldLabel }
+    )
+    const northingDigitsMessage = tPlugin(
+      'components.eastingNorthingField.northingDigits',
+      language,
+      { fieldLabel }
+    )
+
+    const eastingValidationMessages: LanguageMessages =
+      convertToLanguageMessages({
+        'any.required': tPlugin(
+          'components.eastingNorthingField.eastingRequired',
+          language
+        ),
+        'number.base': tPlugin(
+          'components.eastingNorthingField.eastingRequired',
+          language
+        ),
+        'number.min': tPlugin(
+          'components.eastingNorthingField.eastingRange',
+          language,
+          {
+            fieldLabel,
+            min: eastingMin,
+            max: eastingMax
+          }
+        ),
+        'number.max': tPlugin(
+          'components.eastingNorthingField.eastingRange',
+          language,
+          {
+            fieldLabel,
+            min: eastingMin,
+            max: eastingMax
+          }
+        ),
+        'number.precision': eastingDigitsMessage,
+        'number.integer': eastingDigitsMessage,
+        'number.unsafe': eastingDigitsMessage
+      })
+
+    const northingValidationMessages: LanguageMessages =
+      convertToLanguageMessages({
+        'any.required': tPlugin(
+          'components.eastingNorthingField.northingRequired',
+          language
+        ),
+        'number.base': tPlugin(
+          'components.eastingNorthingField.northingRequired',
+          language
+        ),
+        'number.min': tPlugin(
+          'components.eastingNorthingField.northingRange',
+          language,
+          {
+            fieldLabel,
+            min: northingMin,
+            max: northingMax
+          }
+        ),
+        'number.max': tPlugin(
+          'components.eastingNorthingField.northingRange',
+          language,
+          {
+            fieldLabel,
+            min: northingMin,
+            max: northingMax
+          }
+        ),
+        'number.precision': northingDigitsMessage,
+        'number.integer': northingDigitsMessage,
+        'number.unsafe': northingDigitsMessage
+      })
+    return {
+      eastingValidationMessages,
+      northingValidationMessages
+    }
+  }
+
+  // Read schema values from def.schema with fallback defaults
+  static getMinMax(
+    schema:
+      | {
+          easting?: {
+            min?: number
+            max?: number
+          }
+          northing?: {
+            min?: number
+            max?: number
+          }
+        }
+      | undefined
+  ) {
+    return {
+      eastingMin: schema?.easting?.min ?? DEFAULT_EASTING_MIN,
+      eastingMax: schema?.easting?.max ?? DEFAULT_EASTING_MAX,
+      northingMin: schema?.northing?.min ?? DEFAULT_NORTHING_MIN,
+      northingMax: schema?.northing?.max ?? DEFAULT_NORTHING_MAX
+    }
+  }
 }

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

@@ -157,10 +157,13 @@ export class FormComponent extends ComponentBase {
    * Override in composite fields to return translated Joi message overrides for
    * their sub-fields, applied at validation time so schema-level English messages
    * are replaced with the correct language. Return null to skip message patching.
+   * The return object may contain message overrides at component-level, or sub-field-level.
+   * This would allow different error message overrides per field within a collection e.g.
+   * for EastingNothingField
    */
   getValidationMessagesOverride(
     _translator: Translator
-  ): LanguageMessages | null {
+  ): Record<string, LanguageMessages> | null {
     return null
   }
 

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

@@ -12,7 +12,10 @@ import {
   getLocationFieldViewModel
 } from './LocationFieldHelpers.js'
 import { NumberField } from './NumberField.js'
-import { createLowerFirstExpression } from './helpers/index.js'
+import {
+  createLowerFirstExpression,
+  getTranslatedLabel
+} from './helpers/index.js'
 import {
   type LatLongState,
   type RenderContext
@@ -50,59 +53,18 @@ export class LatLongField extends FormComponent {
 
     const isRequired = options.required !== false
 
-    // Read schema values from def.schema with fallback defaults
-    const latitudeMin = schema?.latitude?.min ?? 49.85
-    const latitudeMax = schema?.latitude?.max ?? 60.859
-    const longitudeMin = schema?.longitude?.min ?? -13.687
-    const longitudeMax = schema?.longitude?.max ?? 1.767
-
-    const fieldLabel = lowerFirst(this.label)
-
-    const customValidationMessages: LanguageMessages =
-      convertToLanguageMessages({
-        'number.precision': tPlugin(
-          'components.latLongField.precision',
-          'en-GB'
-        ),
-        'number.unsafe': tPlugin('components.latLongField.notANumber', 'en-GB')
-      })
-
-    const latitudeRangeMessage = tPlugin(
-      'components.latLongField.latitudeRange',
-      'en-GB',
-      { fieldLabel, min: latitudeMin, max: latitudeMax }
-    )
-    const longitudeRangeMessage = tPlugin(
-      'components.latLongField.longitudeRange',
-      'en-GB',
-      { fieldLabel, min: longitudeMin, max: longitudeMax }
-    )
-
-    const latitudeMessages: LanguageMessages = convertToLanguageMessages({
-      ...customValidationMessages,
-      'any.required': tPlugin(
-        'components.latLongField.latitudeRequired',
-        'en-GB'
-      ),
-      'number.base': tPlugin('components.latLongField.latitudeBase', 'en-GB', {
-        fieldLabel
-      }),
-      'number.min': latitudeRangeMessage,
-      'number.max': latitudeRangeMessage
-    })
+    const { latitudeMin, latitudeMax, longitudeMin, longitudeMax } =
+      LatLongField.getMinMax(schema)
 
-    const longitudeMessages: LanguageMessages = convertToLanguageMessages({
-      ...customValidationMessages,
-      'any.required': tPlugin(
-        'components.latLongField.longitudeRequired',
+    const { latitudeMessages, longitudeMessages } =
+      LatLongField.buildErrorMessages(
+        this.label,
+        latitudeMin,
+        latitudeMax,
+        longitudeMin,
+        longitudeMax,
         'en-GB'
-      ),
-      'number.base': tPlugin('components.latLongField.longitudeBase', 'en-GB', {
-        fieldLabel
-      }),
-      'number.min': longitudeRangeMessage,
-      'number.max': longitudeRangeMessage
-    })
+      )
 
     this.collection = new ComponentCollection(
       [
@@ -159,14 +121,16 @@ export class LatLongField extends FormComponent {
 
   getDisplayStringFromFormValue(
     value: LatLongState | undefined,
-    _translator: Translator
+    translator: Translator
   ): string {
     if (!value) {
       return ''
     }
 
-    // CYA page format: <<latvalue, langvalue>>
-    return `${value.latitude}, ${value.longitude}`
+    const { t } = translator
+
+    // Output format: Latitude: <<entry>>\nLongitude: <<entry>>
+    return `${t('components.latLongField.latitude')}: ${value.latitude}\n${t('components.latLongField.longitude')}: ${value.longitude}`
   }
 
   getDisplayStringFromState(
@@ -183,8 +147,7 @@ export class LatLongField extends FormComponent {
       return null
     }
 
-    // Output format: Latitude: <<entry>>\nLongitude: <<entry>>
-    return `Latitude: ${value.latitude}\nLongitude: ${value.longitude}`
+    return `${value.latitude}, ${value.longitude}`
   }
 
   getContextValueFromState(state: FormSubmissionState) {
@@ -210,6 +173,26 @@ export class LatLongField extends FormComponent {
     return LatLongField.isLatLong(value)
   }
 
+  getValidationMessagesOverride(translator: Translator) {
+    const def = this.def as LatLongFieldComponent
+    const translatedLabel = getTranslatedLabel(def, translator)
+    const { latitudeMin, latitudeMax, longitudeMin, longitudeMax } =
+      LatLongField.getMinMax(def.schema)
+    const { latitudeMessages, longitudeMessages } =
+      LatLongField.buildErrorMessages(
+        translatedLabel,
+        latitudeMin,
+        latitudeMax,
+        longitudeMin,
+        longitudeMax,
+        translator.language
+      )
+    return {
+      [`${this.name}__latitude`]: latitudeMessages,
+      [`${this.name}__longitude`]: longitudeMessages
+    }
+  }
+
   /**
    * For error preview page that shows all possible errors on a component
    */
@@ -273,4 +256,93 @@ export class LatLongField extends FormComponent {
       NumberField.isNumber(value.longitude)
     )
   }
+
+  static buildErrorMessages(
+    label: string,
+    latitudeMin: number,
+    latitudeMax: number,
+    longitudeMin: number,
+    longitudeMax: number,
+    language: string
+  ) {
+    const fieldLabel = lowerFirst(label)
+
+    const customValidationMessages: LanguageMessages =
+      convertToLanguageMessages({
+        'number.precision': tPlugin(
+          'components.latLongField.precision',
+          language
+        ),
+        'number.unsafe': tPlugin('components.latLongField.notANumber', language)
+      })
+
+    const latitudeRangeMessage = tPlugin(
+      'components.latLongField.latitudeRange',
+      language,
+      { fieldLabel, min: latitudeMin, max: latitudeMax }
+    )
+    const longitudeRangeMessage = tPlugin(
+      'components.latLongField.longitudeRange',
+      language,
+      { fieldLabel, min: longitudeMin, max: longitudeMax }
+    )
+
+    const latitudeMessages: LanguageMessages = convertToLanguageMessages({
+      ...customValidationMessages,
+      'any.required': tPlugin(
+        'components.latLongField.latitudeRequired',
+        language
+      ),
+      'number.base': tPlugin('components.latLongField.latitudeBase', language, {
+        fieldLabel
+      }),
+      'number.min': latitudeRangeMessage,
+      'number.max': latitudeRangeMessage
+    })
+
+    const longitudeMessages: LanguageMessages = convertToLanguageMessages({
+      ...customValidationMessages,
+      'any.required': tPlugin(
+        'components.latLongField.longitudeRequired',
+        language
+      ),
+      'number.base': tPlugin(
+        'components.latLongField.longitudeBase',
+        language,
+        {
+          fieldLabel
+        }
+      ),
+      'number.min': longitudeRangeMessage,
+      'number.max': longitudeRangeMessage
+    })
+
+    return {
+      latitudeMessages,
+      longitudeMessages
+    }
+  }
+
+  // Read schema values from def.schema with fallback defaults
+  static getMinMax(
+    schema:
+      | {
+          latitude?: {
+            min?: number
+            max?: number
+          }
+          longitude?: {
+            min?: number
+            max?: number
+          }
+        }
+      | undefined
+  ) {
+    return {
+      latitudeMin: schema?.latitude?.min ?? 49.85,
+      latitudeMax: schema?.latitude?.max ?? 60.859,
+      longitudeMin: schema?.longitude?.min ?? -13.687,
+      longitudeMax: schema?.longitude?.max ?? 1.767
+    }
+  }
 }

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

@@ -11,6 +11,7 @@ import {
   type RenderContext,
   type ViewModel
 } from './types.js'
+import { type Translator } from '../i18n/types.js'
 import {
   type FormPayload,
   type FormSubmissionError,
@@ -29,25 +30,25 @@ export type LocationField =
  * - "latitude must be..." -> "latitude must be..."
  */
 function lowercaseMessageStart(message: string): string {
-  if (message.startsWith('Enter ')) {
-    return 'enter' + message.slice(5)
-  }
-
-  // Lowercase first character for any other message
+  // Lowercase first character for a message
   return message.charAt(0).toLowerCase() + message.slice(1)
 }
 
-export function joinWithAnd(items: string[]): string {
+export function joinWithAnd(items: string[], translator: Translator): string {
+  const { t } = translator
   if (items.length === 2) {
-    return `${items[0]} and ${items[1]}`
+    return `${items[0]} ${t('common.and')} ${items[1]}`
   }
 
   const leading = items.slice(0, -1).join(', ')
   const last = items[items.length - 1]
-  return `${leading} and ${last}`
+  return `${leading} ${t('common.and')} ${last}`
 }
 
-export function formatErrorList(messages: string[]): string {
+export function formatErrorList(
+  messages: string[],
+  translator: Translator
+): string {
   if (!messages.length) {
     return ''
   }
@@ -60,7 +61,7 @@ export function formatErrorList(messages: string[]): string {
     index === 0 ? msg : lowercaseMessageStart(msg)
   )
 
-  return joinWithAnd(formattedMessages)
+  return joinWithAnd(formattedMessages, translator)
 }
 
 export function mergeCssClasses(...classNames: (string | undefined)[]) {
@@ -172,7 +173,9 @@ export function getLocationFieldViewModel(
   if (hasFieldErrors) {
     viewModel.errorMessage = {
       text:
-        fieldErrors.length === 1 ? fieldErrors[0] : formatErrorList(fieldErrors)
+        fieldErrors.length === 1
+          ? fieldErrors[0]
+          : formatErrorList(fieldErrors, context.translator)
     }
   }
 

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

@@ -30,6 +30,7 @@ import {
   type FormStateValue,
   type FormSubmissionState
 } from '../types.js'
+import { formatDateForLanguage } from '../../payment/helper.js'
 import { convertToLanguageMessages } from '../../../utils/type-utils.js'
 
 export class MonthYearField extends FormComponent {
@@ -105,16 +106,18 @@ export class MonthYearField extends FormComponent {
 
   getDisplayStringFromFormValue(
     value: MonthYearState | undefined,
-    _translator: Translator
+    translator: Translator
   ): string {
     if (!value) {
       return ''
     }
 
     const date = new Date()
+    // Force to first day of month in case current date was say 31st and specified month has fewer than 31 days
+    date.setDate(1)
     date.setMonth(value.month - 1)
 
-    const monthString = date.toLocaleString('default', { month: 'long' })
+    const monthString = formatDateForLanguage(date, 'LLLL', translator.language)
     return `${monthString} ${value.year}`
   }
 
@@ -155,15 +158,17 @@ export class MonthYearField extends FormComponent {
 
   getValidationMessagesOverride(translator: Translator) {
     const { t } = translator
-    return convertToLanguageMessages({
-      'any.required': buildValidationMessages(t).objectMissing,
-      'number.base': buildValidationMessages(t).objectMissing,
-      'number.precision': buildValidationMessages(t).dateFormat,
-      'number.integer': buildValidationMessages(t).dateFormat,
-      'number.unsafe': buildValidationMessages(t).dateFormat,
-      'number.min': buildValidationMessages(t).dateFormat,
-      'number.max': buildValidationMessages(t).dateFormat
-    })
+    return {
+      [this.name]: convertToLanguageMessages({
+        'any.required': buildValidationMessages(t).objectMissing,
+        'number.base': buildValidationMessages(t).objectMissing,
+        'number.precision': buildValidationMessages(t).dateFormat,
+        'number.integer': buildValidationMessages(t).dateFormat,
+        'number.unsafe': buildValidationMessages(t).dateFormat,
+        'number.min': buildValidationMessages(t).dateFormat,
+        'number.max': buildValidationMessages(t).dateFormat
+      })
+    }
   }
 
   getViewModel(context: RenderContext) {