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

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

@@ -1,5 +1,4 @@
 import {
-  type ComponentDef,
   type FormComponentsDef,
   type FormMetadata,
   type Item
@@ -158,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
   }
 
@@ -178,15 +180,14 @@ export class FormComponent extends ComponentBase {
     const isRequired = !('required' in options) || options.required !== false
     const hideOptional = 'optionalText' in options && options.optionalText
 
-    const resolvedTitle =
-      tComponent(this as unknown as ComponentDef, 'title') || title
+    const resolvedTitle = tComponent(this.def, 'title') || title
     const optionalTag =
       !isRequired && !hideOptional ? ` ${t('common.optional')}` : ''
     const label = `${resolvedTitle}${optionalTag}`
 
     if (hint) {
       viewModel.hint = {
-        text: tComponent(this as unknown as ComponentDef, 'hint') || hint
+        text: tComponent(this.def, 'hint') || hint
       }
     }
 

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

@@ -1,14 +1,19 @@
 import { type GeospatialFieldComponent } from '@defra/forms-model'
 import { type ArraySchema } from 'joi'
 
+import { EN_GB } from '../../../constants.js'
 import { type ComponentBase } from './ComponentBase.js'
 import {
   FormComponent,
   isGeospatialState
 } from './FormComponent.js'
 import { getMapLayers } from './LocationFieldHelpers.js'
-import { getGeospatialSchema } from './helpers/geospatial.js'
+import {
+  determineLimits,
+  getGeospatialSchema
+} from './helpers/geospatial.js'
 import { type RenderContext } from './types.js'
+import { t as tPlugin } from '../i18n/index.js'
 import { type Translator } from '../i18n/types.js'
 import { messageTemplate } from '../pageControllers/validationOptions.js'
 import {
@@ -24,6 +29,7 @@ export class GeospatialField extends FormComponent {
   declare options: GeospatialFieldComponent['options']
   declare formSchema: ArraySchema<GeospatialState>
   declare stateSchema: ArraySchema<GeospatialState>
+  declare limits: { min?: number; max?: number; length?: number }
 
   constructor(
     def: GeospatialFieldComponent,
@@ -33,20 +39,24 @@ export class GeospatialField extends FormComponent {
 
     const { options } = def
 
-    const formSchema = getGeospatialSchema(def).label(this.label).messages({
-      'array.min': messageTemplate.featuresMin,
-      'array.max': messageTemplate.featuresMax,
-      'array.length': messageTemplate.featuresLength
-    })
+    let formSchema = getGeospatialSchema(def).label(this.label)
+
+    const isOptional = options.required === false
+    const limits = determineLimits(def, isOptional)
+
+    formSchema = formSchema.messages(
+      GeospatialField.buildErrorMessages(EN_GB, limits)
+    )
 
     this.formSchema = formSchema
     this.stateSchema = formSchema.default(null)
 
-    if (options.required === false) {
+    if (isOptional) {
       this.stateSchema = this.stateSchema.allow(null)
     }
 
     this.options = options
+    this.limits = limits
   }
 
   getFormValueFromState(state: FormSubmissionState) {
@@ -101,6 +111,7 @@ export class GeospatialField extends FormComponent {
 
     return {
       ...viewModel,
+      lang: context.translator.language,
       country: this.options.countries?.at(0),
       geometryTypes: this.options.geometryTypes,
       mapLayers: getMapLayers(this),
@@ -125,7 +136,10 @@ export class GeospatialField extends FormComponent {
         err.href = `#description_${err.path[1]}`
         err.text = translator.t(
           'components.geospatialField.validation.wrongCountry',
-          { count: Number(err.path[1]) + 1, country: err.context.country }
+          {
+            count: Number(err.path[1]) + 1,
+            country: translator.t(`common.${err.context.country}`)
+          }
         )
       }
     })
@@ -144,6 +158,13 @@ export class GeospatialField extends FormComponent {
     return isGeospatialState(value)
   }
 
+  getValidationMessagesOverride(translator: Translator) {
+    const { language } = translator
+    return {
+      [this.name]: GeospatialField.buildErrorMessages(language, this.limits)
+    }
+  }
+
   /**
    * For error preview page that shows all possible errors on a component
    */
@@ -164,11 +185,28 @@ export class GeospatialField extends FormComponent {
         { type: 'required', template: messageTemplate.selectRequired },
         {
           type: 'array.min',
-          template: '{{#title}} must contain at least 1 items'
+          template: '{{#title}} must contain at least 1 item'
         },
         { type: 'object.invalidjson', template: messageTemplate.format }
       ],
       advancedSettingsErrors: []
     }
   }
+
+  static buildErrorMessages(
+    language: string,
+    limits: { min?: number; max?: number; length?: number } = {}
+  ) {
+    return {
+      'array.min': tPlugin('validation.featuresMin', language, {
+        count: limits.min ?? 1
+      }),
+      'array.max': tPlugin('validation.featuresMax', language, {
+        count: limits.max ?? 1
+      }),
+      'array.length': tPlugin('validation.featuresLength', language, {
+        count: limits.length ?? 1
+      })
+    }
+  }
 }

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
@@ -28,7 +31,6 @@ import {
   type FormSubmissionError,
   type FormSubmissionState
 } from '../types.js'
-import { convertToLanguageMessages } from '../../../utils/type-utils.js'
 
 // Precision constants
 // UK latitude/longitude requires high precision for accurate location (within ~11mm)
@@ -50,59 +52,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 +120,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 +146,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 +172,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 +255,92 @@ 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 = {
+      '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 = {
+      ...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 = {
+      ...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/ListFormComponent.ts

@@ -31,16 +31,16 @@ export class ListFormComponent extends FormComponent {
   >['options']
 
   declare formSchema:
-    | ArraySchema<string>
-    | ArraySchema<number>
+    | ArraySchema<string[]>
+    | ArraySchema<number[]>
     | BooleanSchema<string>
     | NumberSchema<string>
     | NumberSchema
     | StringSchema
 
   declare stateSchema:
-    | ArraySchema<string>
-    | ArraySchema<number>
+    | ArraySchema<string[]>
+    | ArraySchema<number[]>
     | BooleanSchema<string>
     | NumberSchema<string>
     | NumberSchema

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

@@ -9,16 +9,20 @@ import {
   FormComponent,
   isFormValue
 } from './FormComponent.js'
-import { addClassOptionIfNone } from './helpers/index.js'
+import {
+  addClassOptionIfNone,
+  withCustomValidationOverrides
+} from './helpers/index.js'
 import { type RenderContext } from './types.js'
+import { buildValidationMessages } from '../i18n/buildValidationMessages.js'
 import { messageTemplate } from '../pageControllers/validationOptions.js'
+import { type Translator } from '../types/index.js'
 import {
   type ErrorMessageTemplateList,
   type FormState,
   type FormStateValue,
   type FormSubmissionState
 } from '../types.js'
-import { convertToLanguageMessages } from '../../../utils/type-utils.js'
 
 interface LocationFieldOptions {
   instructionText?: string
@@ -43,7 +47,9 @@ export abstract class LocationFieldBase extends FormComponent {
   declare stateSchema: StringSchema
   instructionText?: string
 
-  protected abstract getValidationConfig(): ValidationConfig
+  protected abstract getValidationConfig(
+    translator: Translator | undefined
+  ): ValidationConfig
   protected abstract getErrorTemplates(): {
     type: string
     template: JoiExpression
@@ -61,14 +67,14 @@ export abstract class LocationFieldBase extends FormComponent {
 
     addClassOptionIfNone(locationOptions, 'govuk-input--width-10')
 
-    const config = this.getValidationConfig()
+    const config = this.getValidationConfig(undefined)
     const requiredMessage = config.requiredMessage ?? messageTemplate.required
 
-    const messages = convertToLanguageMessages({
+    const messages = {
       'any.required': requiredMessage,
       'string.empty': requiredMessage,
       'string.pattern.base': config.patternErrorMessage
-    })
+    } as LanguageMessages
 
     let formSchema = joi
       .string()
@@ -121,18 +127,45 @@ export abstract class LocationFieldBase extends FormComponent {
   getViewModel(context: RenderContext) {
     const viewModel = super.getViewModel(context)
 
+    Object.assign(viewModel, {
+      lang: context.translator.language
+    })
+
     if (this.instructionText) {
+      const { tComponent } = context.translator
       return {
         ...viewModel,
-        instructionText: this.instructionText
+        instructionText:
+          tComponent(this.def, 'instructionText') || this.instructionText
       }
     }
 
     return viewModel
   }
 
+  getValidationMessagesOverride(translator: Translator) {
+    const { customValidationMessage, customValidationMessages } = this.options
+    const { t } = translator
+    const config = this.getValidationConfig(translator)
+    const defaults = {
+      'any.required':
+        config.requiredMessage ?? buildValidationMessages(t).objectRequired,
+      'string.empty':
+        config.requiredMessage ?? buildValidationMessages(t).objectRequired,
+      'string.pattern.base': config.patternErrorMessage
+    }
+
+    return {
+      [this.name]: withCustomValidationOverrides(
+        defaults,
+        customValidationMessage,
+        customValidationMessages
+      )
+    }
+  }
+
   getAllPossibleErrors(): ErrorMessageTemplateList {
-    const config = this.getValidationConfig()
+    const config = this.getValidationConfig(undefined)
 
     return {
       baseErrors: [

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

@@ -1,6 +1,6 @@
 import { type Context, type CustomValidator } from 'joi'
 
-import { type EastingNorthingField } from './EastingNorthingField.js'
+import { EastingNorthingField } from './EastingNorthingField.js'
 import { isFormValue } from './FormComponent.js'
 import { type GeospatialField } from './GeospatialField.js'
 import { type LatLongField } from './LatLongField.js'
@@ -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)
     }
   }
 
@@ -187,13 +190,24 @@ export function getLocationFieldViewModel(
     ...viewModel,
     fieldset,
     items,
-    mapLayers: getMapLayers(component)
+    mapLayers: getMapLayers(component),
+    country:
+      component instanceof EastingNorthingField
+        ? component.options.countries?.at(0)
+        : undefined,
+    lang: context.translator.language
   }
 
   if (component.options.instructionText) {
+    const { t, tComponent } = context.translator
+
     return {
       ...result,
-      instructionText: component.options.instructionText
+      instructionSummary: t('components.locationFieldBase.howToFind'),
+      instructionText:
+        tComponent(component.def, 'instructionText') ||
+        component.options.instructionText,
+      t
     }
   }
 

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
     }
   }