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

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

@@ -15,7 +15,11 @@ import {
   getLocationFieldViewModel
 } from './LocationFieldHelpers.js'
 import { NumberField } from './NumberField.js'
-import { createLowerFirstExpression } from './helpers/index.js'
+import { getEastingNorthingCountryValidator } from './helpers/geospatial.js'
+import {
+  createLowerFirstExpression,
+  getTranslatedLabel
+} from './helpers/index.js'
 import {
   type EastingNorthingState,
   type RenderContext
@@ -31,7 +35,6 @@ import {
   type FormSubmissionError,
   type FormSubmissionState
 } from '../types.js'
-import { convertToLanguageMessages } from '../../../utils/type-utils.js'
 
 // British National Grid coordinate limits
 const DEFAULT_EASTING_MIN = 0
@@ -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
           }
         },
         {
@@ -181,6 +113,18 @@ export class EastingNorthingField extends FormComponent {
     )
 
     this.options = options
+
+    const country = options.countries?.at(0)
+
+    if (country) {
+      this.collection.formSchema = this.collection.formSchema.custom(
+        getEastingNorthingCountryValidator(this, country)
+      )
+      this.collection.stateSchema = this.collection.stateSchema.custom(
+        getEastingNorthingCountryValidator(this, country)
+      )
+    }
+
     this.formSchema = this.collection.formSchema
     this.stateSchema = this.collection.stateSchema
   }
@@ -192,14 +136,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 +163,7 @@ export class EastingNorthingField extends FormComponent {
       return null
     }
 
-    return `Easting: ${value.easting}\nNorthing: ${value.northing}`
+    return `${value.easting}, ${value.northing}`
   }
 
   getContextValueFromState(state: FormSubmissionState) {
@@ -232,6 +177,24 @@ export class EastingNorthingField extends FormComponent {
     return getLocationFieldViewModel(this, viewModel, context)
   }
 
+  getErrors(
+    translator: Translator,
+    errors?: FormSubmissionError[]
+  ): FormSubmissionError[] | undefined {
+    const fieldErrors = super.getErrors(translator, errors)
+
+    fieldErrors?.forEach((err) => {
+      if (err.context?.country) {
+        err.text = translator.t(
+          'components.eastingNorthingField.wrongCountry',
+          { country: translator.t(`common.${err.context.country}`) }
+        )
+      }
+    })
+
+    return fieldErrors
+  }
+
   getViewErrors(
     translator: Translator,
     errors?: FormSubmissionError[]
@@ -244,6 +207,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 +292,117 @@ 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 = {
+      '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 = {
+      '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/EmailAddressField.ts

@@ -40,7 +40,8 @@ export class EmailAddressField extends FormComponent {
       formSchema = formSchema.messages({
         'any.required': message,
         'string.empty': message,
-        'string.email': message
+        'string.email': message,
+        'string.unicode': message
       })
     } else if (options.customValidationMessages) {
       formSchema = formSchema.messages(options.customValidationMessages)

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

@@ -5,11 +5,13 @@ import {
 import Boom from '@hapi/boom'
 import joi, { type ArraySchema } from 'joi'
 
+import { EN_GB } from '../../../constants.js'
 import {
   FormComponent,
   isUploadState
 } from './FormComponent.js'
 import { type RenderContext } from './types.js'
+import { t as tPlugin } from '../i18n/index.js'
 import { type Translator } from '../i18n/types.js'
 import { InvalidComponentStateError } from '../pageControllers/errors.js'
 import { messageTemplate } from '../pageControllers/validationOptions.js'
@@ -50,7 +52,9 @@ export const tempFileSchema = fileSchema.append({
     .string()
     .valid(FileStatus.complete, FileStatus.rejected, FileStatus.pending)
     .required(),
-  errorMessage: joi.string().optional()
+  errorMessage: joi.string().optional(),
+  errorCode: joi.string().optional(),
+  errorParams: joi.any().optional()
 })
 
 export const formFileSchema = fileSchema.append({
@@ -109,6 +113,7 @@ export class FileUploadField extends FormComponent {
   declare schema: FileUploadFieldComponent['schema']
   declare formSchema: ArraySchema<FileState>
   declare stateSchema: ArraySchema<FileState>
+  declare limits: { min?: number; max?: number; length?: number }
 
   constructor(
     def: FileUploadFieldComponent,
@@ -128,20 +133,32 @@ export class FileUploadField extends FormComponent {
       formSchema = formSchema.optional()
     }
 
+    const limits: { min?: number; max?: number; length?: number } = {}
+
     if (typeof schema.length !== 'number') {
       if (typeof schema.max === 'number') {
         formSchema = formSchema.max(schema.max)
+        limits.max = schema.max
       }
 
       if (typeof schema.min === 'number') {
         formSchema = formSchema.min(schema.min)
+        limits.min = schema.min
       } else if (options.required !== false) {
         formSchema = formSchema.min(1)
+        limits.min = 1
       }
     } else {
       formSchema = formSchema.length(schema.length)
+      limits.length = schema.length
     }
 
+    this.limits = limits
+
+    formSchema = formSchema.messages(
+      FileUploadField.buildErrorMessages(EN_GB, limits)
+    )
+
     this.formSchema = formSchema.items(formItemSchema)
     this.stateSchema = formSchema
       .items(formItemSchema)
@@ -169,7 +186,7 @@ export class FileUploadField extends FormComponent {
       return ''
     }
 
-    return translator.t('components.fileUploadField.filesCount', {
+    return translator.t('pages.summary.fileUpload', {
       count: files.length
     })
   }
@@ -244,7 +261,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
@@ -300,6 +317,13 @@ export class FileUploadField extends FormComponent {
     return isUploadState(value)
   }
 
+  getValidationMessagesOverride(translator: Translator) {
+    const { language } = translator
+    return {
+      [this.name]: FileUploadField.buildErrorMessages(language, this.limits)
+    }
+  }
+
   /**
    * For error preview page that shows all possible errors on a component
    */
@@ -403,4 +427,21 @@ export class FileUploadField extends FormComponent {
       ]
     }
   }
+
+  static buildErrorMessages(
+    language: string,
+    limits: { min?: number; max?: number; length?: number } = {}
+  ) {
+    return {
+      'array.min': tPlugin('validation.filesMin', language, {
+        count: limits.min ?? 1
+      }),
+      'array.max': tPlugin('validation.filesMax', language, {
+        count: limits.max ?? 1
+      }),
+      'array.length': tPlugin('validation.filesLength', language, {
+        count: limits.length ?? 1
+      })
+    }
+  }
 }

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