@defra/forms-engine-plugin 4.0.11 → 4.0.13

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

@@ -26,19 +26,6 @@ import { convertToLanguageMessages } from '~/src/server/utils/type-utils.js'
 // Precision constants
 // UK latitude/longitude requires high precision for accurate location (within ~11mm)
 const DECIMAL_PRECISION = 7 // 7 decimal places
-const MIN_DECIMAL_PLACES = 1 // At least 1 decimal place required
-
-// Latitude length constraints
-// Min: 3 chars for values like "52.1" (2 digits + decimal + 1 decimal place)
-// Max: 10 chars for values like "59.1234567" (2 digits + decimal + 7 decimal places)
-const LATITUDE_MIN_LENGTH = 3
-const LATITUDE_MAX_LENGTH = 10
-
-// Longitude length constraints
-// Min: 2 chars for values like "-1" or single digit with decimal (needs min decimal places)
-// Max: 10 chars for values like "-1.1234567" (minus + 1 digit + decimal + 7 decimal places)
-const LONGITUDE_MIN_LENGTH = 2
-const LONGITUDE_MAX_LENGTH = 10
 
 export class LatLongField extends FormComponent {
   declare options: LatLongFieldComponent['options']
@@ -57,10 +44,10 @@ 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
-    const latitudeMax = schema?.latitude?.max ?? 60
-    const longitudeMin = schema?.longitude?.min ?? -9
-    const longitudeMax = schema?.longitude?.max ?? 2
+    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 customValidationMessages: LanguageMessages =
       convertToLanguageMessages({
@@ -68,8 +55,6 @@ export class LatLongField extends FormComponent {
         'number.base': messageTemplate.objectMissing,
         'number.precision':
           '{{#label}} must have no more than 7 decimal places',
-        'number.minPrecision':
-          '{{#label}} must have at least {{#minPrecision}} decimal place',
         'number.unsafe': '{{#label}} must be a valid number'
       })
 
@@ -77,18 +62,14 @@ export class LatLongField extends FormComponent {
       ...customValidationMessages,
       'number.base': `Enter a valid latitude for ${this.title} like 51.519450`,
       'number.min': `Latitude for ${this.title} must be between ${latitudeMin} and ${latitudeMax}`,
-      'number.max': `Latitude for ${this.title} must be between ${latitudeMin} and ${latitudeMax}`,
-      'number.minLength': `Latitude for ${this.title} must be between 3 and 10 characters`,
-      'number.maxLength': `Latitude for ${this.title} must be between 3 and 10 characters`
+      'number.max': `Latitude for ${this.title} must be between ${latitudeMin} and ${latitudeMax}`
     })
 
     const longitudeMessages: LanguageMessages = convertToLanguageMessages({
       ...customValidationMessages,
       'number.base': `Enter a valid longitude for ${this.title} like -0.127758`,
       'number.min': `Longitude for ${this.title} must be between ${longitudeMin} and ${longitudeMax}`,
-      'number.max': `Longitude for ${this.title} must be between ${longitudeMin} and ${longitudeMax}`,
-      'number.minLength': `Longitude for ${this.title} must be between 2 and 10 characters`,
-      'number.maxLength': `Longitude for ${this.title} must be between 2 and 10 characters`
+      'number.max': `Longitude for ${this.title} must be between ${longitudeMin} and ${longitudeMax}`
     })
 
     this.collection = new ComponentCollection(
@@ -100,10 +81,7 @@ export class LatLongField extends FormComponent {
           schema: {
             min: latitudeMin,
             max: latitudeMax,
-            precision: DECIMAL_PRECISION,
-            minPrecision: MIN_DECIMAL_PLACES,
-            minLength: LATITUDE_MIN_LENGTH,
-            maxLength: LATITUDE_MAX_LENGTH
+            precision: DECIMAL_PRECISION
           },
           options: {
             required: isRequired,
@@ -120,10 +98,7 @@ export class LatLongField extends FormComponent {
           schema: {
             min: longitudeMin,
             max: longitudeMax,
-            precision: DECIMAL_PRECISION,
-            minPrecision: MIN_DECIMAL_PLACES,
-            minLength: LONGITUDE_MIN_LENGTH,
-            maxLength: LONGITUDE_MAX_LENGTH
+            precision: DECIMAL_PRECISION
           },
           options: {
             required: isRequired,

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

@@ -28,11 +28,6 @@ interface LocationFieldOptions {
 interface ValidationConfig {
   pattern: RegExp
   patternErrorMessage: string
-  customValidation?: (
-    value: string,
-    helpers: joi.CustomHelpers
-  ) => string | joi.ErrorReport
-  additionalMessages?: LanguageMessages
 }
 
 /**
@@ -71,14 +66,9 @@ export abstract class LocationFieldBase extends FormComponent {
       .required()
       .pattern(config.pattern)
       .messages({
-        'string.pattern.base': config.patternErrorMessage,
-        ...config.additionalMessages
+        'string.pattern.base': config.patternErrorMessage
       })
 
-    if (config.customValidation) {
-      formSchema = formSchema.custom(config.customValidation)
-    }
-
     if (locationOptions.required === false) {
       formSchema = formSchema.allow('')
     }
@@ -91,10 +81,6 @@ export abstract class LocationFieldBase extends FormComponent {
         'string.pattern.base'
       ]
 
-      if (config.additionalMessages) {
-        messageKeys.push(...Object.keys(config.additionalMessages))
-      }
-
       const messages = messageKeys.reduce<LanguageMessages>((acc, key) => {
         acc[key] = message
         return acc

package/src/server/plugins/engine/components/NationalGridFieldNumberField.test.ts

@@ -99,13 +99,27 @@ describe('NationalGridFieldNumberField', () => {
       })
 
       it('accepts valid values', () => {
-        const result1 = collection.validate(getFormData('NG12345678'))
-        const result2 = collection.validate(getFormData('ng12345678'))
-        const result3 = collection.validate(getFormData('AB98765432'))
+        // Test 8-digit parcel ID format (2x4)
+        const result1 = collection.validate(getFormData('TQ12345678'))
+        const result2 = collection.validate(getFormData('TQ 1234 5678'))
+
+        // Test 10-digit OS grid reference format (2x5)
+        const result3 = collection.validate(getFormData('SU1234567890'))
+        const result4 = collection.validate(getFormData('SU 12345 67890'))
+
+        expect(result1.errors).toBeUndefined()
+        expect(result2.errors).toBeUndefined()
+        expect(result3.errors).toBeUndefined()
+        expect(result4.errors).toBeUndefined()
+
+        // Test case-insensitive
+        const result5 = collection.validate(getFormData('nt12345678'))
 
         expect(result1.errors).toBeUndefined()
         expect(result2.errors).toBeUndefined()
         expect(result3.errors).toBeUndefined()
+        expect(result4.errors).toBeUndefined()
+        expect(result5.errors).toBeUndefined()
       })
 
       it('formats values with spaces per GDS guidance', () => {
@@ -114,8 +128,8 @@ describe('NationalGridFieldNumberField', () => {
         const result3 = collection.validate(getFormData('NG12345,678'))
 
         expect(result1.value.myComponent).toBe('NG 1234 5678')
-        expect(result2.value.myComponent).toBe('NG 1234 5678')
-        expect(result3.value.myComponent).toBe('NG 1234 5678')
+        expect(result2.value.myComponent).toBe('NG12345678')
+        expect(result3.value.myComponent).toBe('NG12345,678')
       })
 
       it('adds errors for empty value', () => {
@@ -258,15 +272,15 @@ describe('NationalGridFieldNumberField', () => {
         assertions: [
           {
             input: getFormData('  NG12345678'),
-            output: { value: getFormData('NG 1234 5678') }
+            output: { value: getFormData('NG12345678') }
           },
           {
             input: getFormData('NG12345678  '),
-            output: { value: getFormData('NG 1234 5678') }
+            output: { value: getFormData('NG12345678') }
           },
           {
             input: getFormData('  NG12345678 \n\n'),
-            output: { value: getFormData('NG 1234 5678') }
+            output: { value: getFormData('NG12345678') }
           }
         ]
       },

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

@@ -1,5 +1,4 @@
 import { type NationalGridFieldNumberFieldComponent } from '@defra/forms-model'
-import type joi from 'joi'
 
 import { LocationFieldBase } from '~/src/server/plugins/engine/components/LocationFieldBase.js'
 
@@ -7,26 +6,16 @@ export class NationalGridFieldNumberField extends LocationFieldBase {
   declare options: NationalGridFieldNumberFieldComponent['options']
 
   protected getValidationConfig() {
-    return {
-      // Pattern allows spaces and commas in the input since custom validation will clean them
-      pattern: /^[A-Z]{2}[\d\s,]*$/i,
-      patternErrorMessage: `Enter a valid National Grid field number for ${this.title} like NG 1234 5678`,
-      customValidation: (value: string, helpers: joi.CustomHelpers) => {
-        // Strip spaces and commas for validation
-        const cleanValue = value.replace(/[\s,]/g, '')
-
-        // Check if it matches the exact pattern after cleaning
-        if (!/^[A-Z]{2}\d{8}$/i.test(cleanValue)) {
-          return helpers.error('string.pattern.base')
-        }
-
-        // Format with spaces per GDS guidance: NG 1234 5678
-        const letters = cleanValue.substring(0, 2)
-        const numbers = cleanValue.substring(2)
-        const formattedValue = `${letters} ${numbers.substring(0, 4)} ${numbers.substring(4)}`
+    // Regex for OS grid references and parcel IDs
+    // Validates specific valid OS grid letter combinations with:
+    // - 2 letters & 8 digits in 2 blocks of 4 (parcel ID) e.g., ST 6789 6789
+    // - 2 letters & 10 digits in 2 blocks of 5 (OS grid reference) e.g., SO 12345 12345
+    const pattern =
+      /^((([sS]|[nN])[a-hA-Hj-zJ-Z])|(([tT]|[oO])[abfglmqrvwABFGLMQRVW])|([hH][l-zL-Z])|([jJ][lmqrvwLMQRVW]))\s?(([0-9]{4})\s?([0-9]{4})|([0-9]{5})\s?([0-9]{5}))$/
 
-        return formattedValue
-      }
+    return {
+      pattern,
+      patternErrorMessage: `Enter a valid National Grid field number for ${this.title} like NG 1234 5678`
     }
   }