@defra/forms-engine-plugin 4.0.10 → 4.0.12

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

@@ -1,9 +1,5 @@
 import { type NumberFieldComponent } from '@defra/forms-model'
-import joi, {
-  type CustomHelpers,
-  type CustomValidator,
-  type NumberSchema
-} from 'joi'
+import joi, { type CustomValidator, type NumberSchema } from 'joi'
 
 import {
   FormComponent,
@@ -165,154 +161,29 @@ export class NumberField extends FormComponent {
   }
 }
 
-/**
- * Validates string length of a numeric value
- * @param value - The numeric value to validate
- * @param minLength - Minimum required string length
- * @param maxLength - Maximum allowed string length
- * @returns Object with validation result
- */
-export function validateStringLength(
-  value: number,
-  minLength?: number,
-  maxLength?: number
-): { isValid: boolean; error?: 'minLength' | 'maxLength' } {
-  if (typeof minLength !== 'number' && typeof maxLength !== 'number') {
-    return { isValid: true }
-  }
-
-  const valueStr = String(value)
-
-  if (typeof minLength === 'number' && valueStr.length < minLength) {
-    return { isValid: false, error: 'minLength' }
-  }
-
-  if (typeof maxLength === 'number' && valueStr.length > maxLength) {
-    return { isValid: false, error: 'maxLength' }
-  }
-
-  return { isValid: true }
-}
-
-/**
- * Validates minimum decimal precision
- * @param value - The numeric value to validate
- * @param minPrecision - Minimum required decimal places
- * @returns true if valid, false if invalid
- */
-export function validateMinimumPrecision(
-  value: number,
-  minPrecision: number
-): boolean {
-  if (Number.isInteger(value)) {
-    return false
-  }
-
-  const valueStr = String(value)
-  const decimalIndex = valueStr.indexOf('.')
-
-  if (decimalIndex !== -1) {
-    const decimalPlaces = valueStr.length - decimalIndex - 1
-    return decimalPlaces >= minPrecision
-  }
-
-  return false
-}
-
-/**
- * Helper function to handle length validation errors
- * Returns the appropriate error response based on the validation result
- */
-function handleLengthValidationError(
-  lengthCheck: ReturnType<typeof validateStringLength>,
-  helpers: CustomHelpers,
-  custom: string | undefined,
-  minLength: number | undefined,
-  maxLength: number | undefined
-) {
-  if (!lengthCheck.isValid && lengthCheck.error) {
-    const errorType = `number.${lengthCheck.error}`
-
-    if (custom) {
-      // Only pass the relevant length value in context
-      const contextData =
-        lengthCheck.error === 'minLength'
-          ? { minLength: minLength ?? 0 }
-          : { maxLength: maxLength ?? 0 }
-      return helpers.message({ custom }, contextData)
-    }
-
-    const context =
-      lengthCheck.error === 'minLength'
-        ? { minLength: minLength ?? 0 }
-        : { maxLength: maxLength ?? 0 }
-    return helpers.error(errorType, context)
-  }
-  return null
-}
-
 export function getValidatorPrecision(component: NumberField) {
   const validator: CustomValidator = (value: number, helpers) => {
     const { options, schema } = component
+
     const { customValidationMessage: custom } = options
-    const {
-      precision: limit,
-      minPrecision,
-      minLength,
-      maxLength
-    } = schema as {
-      precision?: number
-      minPrecision?: number
-      minLength?: number
-      maxLength?: number
-    }
+    const { precision: limit } = schema
 
     if (!limit || limit <= 0) {
-      const lengthCheck = validateStringLength(value, minLength, maxLength)
-      const error = handleLengthValidationError(
-        lengthCheck,
-        helpers,
-        custom,
-        minLength,
-        maxLength
-      )
-      if (error) return error
       return value
     }
 
-    // Validate precision (max decimal places)
     const validationSchema = joi
       .number()
       .precision(limit)
       .prefs({ convert: false })
 
     try {
-      joi.attempt(value, validationSchema)
+      return joi.attempt(value, validationSchema)
     } catch {
       return custom
         ? helpers.message({ custom }, { limit })
         : helpers.error('number.precision', { limit })
     }
-
-    // Validate minimum precision (min decimal places)
-    if (typeof minPrecision === 'number' && minPrecision > 0) {
-      if (!validateMinimumPrecision(value, minPrecision)) {
-        return helpers.error('number.minPrecision', { minPrecision })
-      }
-    }
-
-    // Check string length validation after precision checks
-    const lengthCheck = validateStringLength(value, minLength, maxLength)
-    const error = handleLengthValidationError(
-      lengthCheck,
-      helpers,
-      custom,
-      minLength,
-      maxLength
-    )
-    if (error) return error
-
-    return value
   }
 
   return validator

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

@@ -100,46 +100,24 @@ describe('OsGridRefField', () => {
         const result1 = collection.validate(getFormData('SD865005'))
         const result2 = collection.validate(getFormData('SD 865 005'))
 
-        // Test 8-digit parcel ID format (2x4)
-        const result3 = collection.validate(getFormData('TQ12345678'))
-        const result4 = collection.validate(getFormData('TQ 1234 5678'))
-
-        // Test 10-digit OS grid reference format (2x5)
-        const result5 = collection.validate(getFormData('SU1234567890'))
-        const result6 = collection.validate(getFormData('SU 12345 67890'))
-
         // Test case-insensitive
-        const result7 = collection.validate(getFormData('nt12345678'))
-
-        // Test various valid OS grid formats
-        const result8 = collection.validate(getFormData('SN 1232 1223')) // parcel ID format
-        const result9 = collection.validate(getFormData('SN 12324 12234')) // OS grid ref format
-        const result10 = collection.validate(getFormData('ST 6789 6789')) // parcel ID with different letters
-        const result11 = collection.validate(getFormData('SO 12345 12345')) // OS grid ref with different letters
+        const result3 = collection.validate(getFormData('nt123456'))
 
         expect(result1.errors).toBeUndefined()
         expect(result2.errors).toBeUndefined()
         expect(result3.errors).toBeUndefined()
-        expect(result4.errors).toBeUndefined()
-        expect(result5.errors).toBeUndefined()
-        expect(result6.errors).toBeUndefined()
-        expect(result7.errors).toBeUndefined()
-        expect(result8.errors).toBeUndefined()
-        expect(result9.errors).toBeUndefined()
-        expect(result10.errors).toBeUndefined()
-        expect(result11.errors).toBeUndefined()
       })
 
-      it('formats values with spaces per GDS guidance', () => {
+      it('retains values with spaces per GDS guidance', () => {
         const result1 = collection.validate(getFormData('SD865005'))
         const result2 = collection.validate(getFormData('TQ 1234 5678'))
         const result3 = collection.validate(getFormData('SU1234567890'))
         const result4 = collection.validate(getFormData('TQ12345678'))
 
-        expect(result1.value.myComponent).toBe('SD 865 005')
+        expect(result1.value.myComponent).toBe('SD865005')
         expect(result2.value.myComponent).toBe('TQ 1234 5678')
-        expect(result3.value.myComponent).toBe('SU 12345 67890')
-        expect(result4.value.myComponent).toBe('TQ 1234 5678')
+        expect(result3.value.myComponent).toBe('SU1234567890')
+        expect(result4.value.myComponent).toBe('TQ12345678')
       })
 
       it('adds errors for empty value', () => {
@@ -289,16 +267,16 @@ describe('OsGridRefField', () => {
         },
         assertions: [
           {
-            input: getFormData('  TQ12345678'),
-            output: { value: getFormData('TQ 1234 5678') }
+            input: getFormData('  TQ123456'),
+            output: { value: getFormData('TQ123456') }
           },
           {
-            input: getFormData('TQ12345678  '),
-            output: { value: getFormData('TQ 1234 5678') }
+            input: getFormData('TQ123456  '),
+            output: { value: getFormData('TQ123456') }
           },
           {
-            input: getFormData('  TQ12345678 \n\n'),
-            output: { value: getFormData('TQ 1234 5678') }
+            input: getFormData('  TQ123456 \n\n'),
+            output: { value: getFormData('TQ123456') }
           }
         ]
       },

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

@@ -1,5 +1,4 @@
 import { type OsGridRefFieldComponent } from '@defra/forms-model'
-import type joi from 'joi'
 
 import { LocationFieldBase } from '~/src/server/plugins/engine/components/LocationFieldBase.js'
 
@@ -9,45 +8,13 @@ export class OsGridRefField extends LocationFieldBase {
   protected getValidationConfig() {
     // Regex for OS grid references and parcel IDs
     // Validates specific valid OS grid letter combinations with:
-    // - 6 digits (e.g., SD865005 or SD 865 005)
-    // - 8 digits in 2 blocks of 4 (parcel ID) e.g., ST 6789 6789
-    // - 10 digits in 2 blocks of 5 (OS grid reference) e.g., SO 12345 12345
-    const osGridPattern =
-      /^(?:[sn][a-hj-z]|[to][abfglmqrvw]|h[l-z]|j[lmqrvw])\s?(?:\d{3}\s?\d{3}|\d{4}\s?\d{4}|\d{5}\s?\d{5})$/i
-
-    // More permissive pattern for initial validation (allows spaces to be cleaned)
-    const initialPattern = /^[A-Za-z]{2}[\d\s]*$/
+    // - 2 letters & 6 digits (e.g., SD865005 or SD 865 005)
+    const pattern =
+      /^((([sS]|[nN])[a-hA-Hj-zJ-Z])|(([tT]|[oO])[abfglmqrvwABFGLMQRVW])|([hH][l-zL-Z])|([jJ][lmqrvwLMQRVW]))\s?(([0-9]{3})\s?([0-9]{3}))$/
 
     return {
-      pattern: initialPattern,
-      patternErrorMessage: `Enter a valid OS grid reference for ${this.title} like TQ123456`,
-      customValidation: (value: string, helpers: joi.CustomHelpers) => {
-        // Strip spaces from the input for processing
-        const cleanValue = value.replace(/\s/g, '')
-        const letters = cleanValue.substring(0, 2)
-        const numbers = cleanValue.substring(2)
-
-        // Validate number length
-        if (
-          numbers.length !== 6 &&
-          numbers.length !== 8 &&
-          numbers.length !== 10
-        ) {
-          return helpers.error('string.pattern.base')
-        }
-
-        // Format with spaces: XX 123 456, XX 1234 5678, or XX 12345 67890
-        const halfLength = numbers.length / 2
-        const formattedValue = `${letters} ${numbers.substring(0, halfLength)} ${numbers.substring(halfLength)}`
-
-        // Validate the formatted value against the OS grid pattern
-        if (!osGridPattern.test(formattedValue)) {
-          return helpers.error('string.pattern.base')
-        }
-
-        // Return formatted value with spaces per GDS guidance
-        return formattedValue
-      }
+      pattern,
+      patternErrorMessage: `Enter a valid OS grid reference for ${this.title} like TQ123456`
     }
   }
 

package/src/server/plugins/engine/pageControllers/helpers/helpers.test.ts

@@ -11,7 +11,6 @@ import { PageController } from '~/src/server/plugins/engine/pageControllers/Page
 import { getProxyUrlForLocalDevelopment } from '~/src/server/plugins/engine/pageControllers/helpers/index.js'
 import {
   createPage,
-  isPageController,
   type PageControllerType
 } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
 import {
@@ -26,7 +25,10 @@ import {
 import definition from '~/test/form/definitions/blank.js'
 
 describe('Page controller helpers', () => {
-  const examples = PageTypes.map((pageType) => {
+  const examples = PageTypes.filter(
+    (pageType) =>
+      pageType.controller !== ControllerType.SummaryWithConfirmationEmail
+  ).map((pageType) => {
     const pageDef = structuredClone(pageType)
 
     let controller: PageControllerType | undefined
@@ -67,10 +69,6 @@ describe('Page controller helpers', () => {
         controller = SummaryPageController
         break
 
-      case ControllerType.SummaryWithConfirmationEmail:
-        controller = SummaryPageController
-        break
-
       case ControllerType.Status:
         controller = StatusPageController
         break
@@ -155,24 +153,6 @@ describe('Page controller helpers', () => {
     })
   })
 
-  describe('Helper: isPageController', () => {
-    it.each([...examples])(
-      "allows valid page controller '$pageDef.controller'",
-      ({ pageDef }) => {
-        expect(isPageController(pageDef.controller)).toBe(true)
-      }
-    )
-
-    it.each([
-      { name: './pages/unknown.js' },
-      { name: 'UnknownPageController' },
-      { name: undefined },
-      { name: '' }
-    ])("rejects invalid page controller '$name'", ({ name }) => {
-      expect(isPageController(name)).toBe(false)
-    })
-  })
-
   describe('Helper: getProxyUrlForLocalDevelopment', () => {
     it('returns null if uploadUrl is undefined', () => {
       expect(getProxyUrlForLocalDevelopment(undefined)).toBeNull()

package/src/server/plugins/engine/pageControllers/helpers/pages.ts

@@ -1,23 +1,12 @@
 import {
   ControllerType,
   controllerNameFromPath,
-  isControllerName,
   type Page
 } from '@defra/forms-model'
 
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
 import * as PageControllers from '~/src/server/plugins/engine/pageControllers/index.js'
 
-export function isPageController(
-  controllerName?: string | ControllerType
-): controllerName is keyof typeof PageControllers {
-  // Handle SummaryWithConfirmationEmail as it uses SummaryPageController
-  if (controllerName === ControllerType.SummaryWithConfirmationEmail) {
-    return true
-  }
-  return isControllerName(controllerName) && controllerName in PageControllers
-}
-
 export type PageControllerClass = InstanceType<PageControllerType>
 export type PageControllerType =
   (typeof PageControllers)[keyof typeof PageControllers]
@@ -56,10 +45,6 @@ export function createPage(model: FormModel, pageDef: Page) {
       controller = new PageControllers.SummaryPageController(model, pageDef)
       break
 
-    case ControllerType.SummaryWithConfirmationEmail:
-      controller = new PageControllers.SummaryPageController(model, pageDef)
-      break
-
     case ControllerType.Status:
       controller = new PageControllers.StatusPageController(model, pageDef)
       break