@defra/forms-engine-plugin 4.7.2 → 4.8.0

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

@@ -1,79 +0,0 @@
-import { ComponentType, type ListComponent } from '@defra/forms-model'
-
-import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
-import { type Guidance } from '~/src/server/plugins/engine/components/helpers/components.js'
-import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import definition from '~/test/form/definitions/basic.js'
-
-describe('List', () => {
-  let model: FormModel
-
-  beforeEach(() => {
-    model = new FormModel(definition, {
-      basePath: 'test'
-    })
-  })
-
-  describe('Defaults', () => {
-    let def: ListComponent
-    let collection: ComponentCollection
-    let guidance: Guidance
-
-    beforeEach(() => {
-      def = {
-        title: 'List guidance',
-        name: 'myComponent',
-        type: ComponentType.List,
-        list: 'licenceLengthDays',
-        options: {}
-      } satisfies ListComponent
-
-      collection = new ComponentCollection([def], { model })
-      guidance = collection.guidance[0]
-    })
-
-    describe('View model', () => {
-      it('sets Nunjucks component defaults', () => {
-        const viewModel = guidance.getViewModel()
-
-        expect(viewModel).toEqual(
-          expect.objectContaining({
-            attributes: {},
-            content: {
-              title: def.title,
-              text: ''
-            }
-          })
-        )
-      })
-    })
-
-    describe('List items', () => {
-      it('returns list items', () => {
-        expect(guidance).toHaveProperty('items', [
-          {
-            id: '52fc51fc-c75a-4b08-9c9e-6bd99b9bc49b',
-            text: '1 day',
-            value: 1,
-            description:
-              'Valid for 24 hours from the start time that you select'
-          },
-          {
-            id: '56b7b34f-23b3-4446-ac8e-b2443d18588e',
-            text: '8 day',
-            value: 8,
-            description:
-              'Valid for 8 consecutive days from the start time that you select'
-          },
-          {
-            id: '1af54fbc-eec2-4e1e-bd53-2415abf62677',
-            text: '12 months',
-            value: 365,
-            description:
-              '12-month licences are now valid for 365 days from their start date and can be purchased at any time during the year'
-          }
-        ])
-      })
-    })
-  })
-})

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

@@ -1,253 +0,0 @@
-import { ComponentType } from '@defra/forms-model'
-import type joi from 'joi'
-import { type LanguageMessages } from 'joi'
-
-import { LocationFieldBase } from '~/src/server/plugins/engine/components/LocationFieldBase.js'
-import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import definition from '~/test/form/definitions/blank.js'
-import { getFormData } from '~/test/helpers/component-helpers.js'
-
-class TestLocationField extends LocationFieldBase {
-  protected getValidationConfig() {
-    return {
-      pattern: /^TEST\d{4}$/i,
-      patternErrorMessage: 'Enter a valid test code like TEST1234',
-      additionalMessages: {
-        'string.custom': 'This is a custom error from additional messages'
-      } as LanguageMessages,
-      customValidation: (value: string, helpers: joi.CustomHelpers) => {
-        if (value === 'FAIL0000') {
-          return helpers.error('string.custom')
-        }
-        return value
-      }
-    }
-  }
-
-  protected getErrorTemplates() {
-    return [
-      {
-        type: 'pattern',
-        template:
-          'Enter a valid test code for [short description] like TEST1234'
-      },
-      {
-        type: 'custom',
-        template: 'This is a custom error template'
-      }
-    ]
-  }
-}
-
-describe('LocationFieldBase', () => {
-  let model: FormModel
-
-  beforeEach(() => {
-    model = new FormModel(definition, {
-      basePath: 'test'
-    })
-  })
-
-  describe('customValidationMessage with additionalMessages', () => {
-    it('should merge custom validation message with additional message keys', () => {
-      const def = {
-        title: 'Test location field',
-        name: 'myComponent',
-        type: ComponentType.TextField,
-        options: {
-          customValidationMessage: 'This is a unified custom error'
-        },
-        schema: {}
-      } as ConstructorParameters<typeof TestLocationField>[0]
-
-      const field = new TestLocationField(def, { model })
-
-      const result2 = field.formSchema.validate('INVALID')
-      const result3 = field.formSchema.validate('FAIL0000')
-
-      expect(result2.error?.message).toBe('This is a unified custom error')
-      expect(result3.error?.message).toBe('This is a unified custom error')
-    })
-  })
-
-  describe('getViewModel with instructionText', () => {
-    it('should include parsed markdown instruction text', () => {
-      const def = {
-        title: 'Test location field',
-        name: 'myComponent',
-        type: ComponentType.TextField,
-        options: {
-          instructionText: 'This is **bold** text'
-        },
-        schema: {}
-      } as ConstructorParameters<typeof TestLocationField>[0]
-
-      const field = new TestLocationField(def, { model })
-      const viewModel = field.getViewModel(getFormData('TEST1234'))
-
-      const instructionText =
-        'instructionText' in viewModel ? viewModel.instructionText : undefined
-      expect(instructionText).toBeTruthy()
-      expect(instructionText).toContain('bold')
-    })
-
-    it('should not include instructionText when not provided', () => {
-      const def = {
-        title: 'Test location field',
-        name: 'myComponent',
-        type: ComponentType.TextField,
-        options: {},
-        schema: {}
-      } as ConstructorParameters<typeof TestLocationField>[0]
-
-      const field = new TestLocationField(def, { model })
-      const viewModel = field.getViewModel(getFormData('TEST1234'))
-
-      expect(
-        'instructionText' in viewModel ? viewModel.instructionText : undefined
-      ).toBeUndefined()
-    })
-  })
-
-  describe('getAllPossibleErrors', () => {
-    it('should return base errors with custom error templates', () => {
-      const def = {
-        title: 'Test location field',
-        name: 'myComponent',
-        type: ComponentType.TextField,
-        options: {},
-        schema: {}
-      } as ConstructorParameters<typeof TestLocationField>[0]
-
-      const field = new TestLocationField(def, { model })
-      const errors = field.getAllPossibleErrors()
-
-      expect(errors.baseErrors).toHaveLength(3)
-      expect(errors.baseErrors).toEqual(
-        expect.arrayContaining([
-          expect.objectContaining({ type: 'required' }),
-          expect.objectContaining({ type: 'pattern' }),
-          expect.objectContaining({ type: 'custom' })
-        ])
-      )
-      expect(errors.advancedSettingsErrors).toEqual([])
-    })
-  })
-
-  describe('isValue and getFormValue', () => {
-    it('should correctly identify string values', () => {
-      const def = {
-        title: 'Test location field',
-        name: 'myComponent',
-        type: ComponentType.TextField,
-        options: {},
-        schema: {}
-      } as ConstructorParameters<typeof TestLocationField>[0]
-
-      const field = new TestLocationField(def, { model })
-
-      expect(field.isValue('TEST1234')).toBe(true)
-      expect(field.isValue('')).toBe(false)
-      expect(field.isValue(null)).toBe(false)
-      expect(field.isValue(undefined)).toBe(false)
-      expect(field.isValue(123)).toBe(false)
-      expect(field.isValue({ test: 'value' })).toBe(false)
-    })
-
-    it('should return value when it is a non-empty string', () => {
-      const def = {
-        title: 'Test location field',
-        name: 'myComponent',
-        type: ComponentType.TextField,
-        options: {},
-        schema: {}
-      } as ConstructorParameters<typeof TestLocationField>[0]
-
-      const field = new TestLocationField(def, { model })
-
-      expect(field.getFormValue('TEST1234')).toBe('TEST1234')
-      expect(field.getFormValue('')).toBeUndefined()
-      expect(field.getFormValue(null)).toBeUndefined()
-      expect(field.getFormValue(undefined)).toBeUndefined()
-    })
-
-    it('should get value from state', () => {
-      const def = {
-        title: 'Test location field',
-        name: 'myComponent',
-        type: ComponentType.TextField,
-        options: {},
-        schema: {}
-      } as ConstructorParameters<typeof TestLocationField>[0]
-
-      const field = new TestLocationField(def, { model })
-
-      const state1 = { myComponent: 'TEST1234' }
-      const state2 = { myComponent: null }
-      const state3 = { myComponent: '' }
-
-      expect(field.getFormValueFromState(state1)).toBe('TEST1234')
-      expect(field.getFormValueFromState(state2)).toBeUndefined()
-      expect(field.getFormValueFromState(state3)).toBeUndefined()
-    })
-  })
-
-  describe('optional field validation', () => {
-    it('should allow empty values when required is false', () => {
-      const def = {
-        title: 'Test location field',
-        name: 'myComponent',
-        type: ComponentType.TextField,
-        options: {
-          required: false
-        },
-        schema: {}
-      } as ConstructorParameters<typeof TestLocationField>[0]
-
-      const field = new TestLocationField(def, { model })
-      const result = field.formSchema.validate('')
-
-      expect(result.error).toBeUndefined()
-      expect(result.value).toBe('')
-    })
-
-    it('should validate pattern even for optional fields when value is provided', () => {
-      const def = {
-        title: 'Test location field',
-        name: 'myComponent',
-        type: ComponentType.TextField,
-        options: {
-          required: false
-        },
-        schema: {}
-      } as ConstructorParameters<typeof TestLocationField>[0]
-
-      const field = new TestLocationField(def, { model })
-      const result = field.formSchema.validate('INVALID')
-
-      expect(result.error).toBeDefined()
-    })
-  })
-
-  describe('customValidationMessages', () => {
-    it('should use custom validation messages when provided', () => {
-      const def = {
-        title: 'Test location field',
-        name: 'myComponent',
-        type: ComponentType.TextField,
-        options: {
-          customValidationMessages: {
-            'string.pattern.base': 'Custom pattern error message',
-            'string.custom': 'Custom error message'
-          }
-        },
-        schema: {}
-      } as ConstructorParameters<typeof TestLocationField>[0]
-
-      const field = new TestLocationField(def, { model })
-      const result = field.formSchema.validate('INVALID')
-
-      expect(result.error?.message).toBe('Custom pattern error message')
-    })
-  })
-})