@defra/forms-engine-plugin 4.7.2 → 4.8.0

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

@@ -1,256 +0,0 @@
-import { ComponentType, type YesNoFieldComponent } from '@defra/forms-model'
-
-import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
-import {
-  getAnswer,
-  type Field
-} from '~/src/server/plugins/engine/components/helpers/components.js'
-import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import { listYesNoExamples } from '~/test/fixtures/list.js'
-import definition from '~/test/form/definitions/blank.js'
-import { getFormData, getFormState } from '~/test/helpers/component-helpers.js'
-
-describe('YesNoField', () => {
-  let def: YesNoFieldComponent
-  let model: FormModel
-  let collection: ComponentCollection
-  let field: Field
-
-  beforeEach(() => {
-    def = {
-      title: 'Example yes/no',
-      name: 'myComponent',
-      type: ComponentType.YesNoField,
-      options: {}
-    } satisfies YesNoFieldComponent
-
-    model = new FormModel(definition, {
-      basePath: 'test'
-    })
-
-    collection = new ComponentCollection([def], { model })
-    field = collection.fields[0]
-  })
-
-  describe('Schema', () => {
-    it('uses component title as label', () => {
-      const { formSchema } = collection
-      const { keys } = formSchema.describe()
-
-      expect(keys).toHaveProperty(
-        'myComponent',
-        expect.objectContaining({
-          flags: expect.objectContaining({
-            label: 'Example yes/no'
-          })
-        })
-      )
-    })
-
-    it('uses component name as keys', () => {
-      const { formSchema } = collection
-      const { keys } = formSchema.describe()
-
-      expect(field.keys).toEqual(['myComponent'])
-      expect(field.collection).toBeUndefined()
-
-      for (const key of field.keys) {
-        expect(keys).toHaveProperty(key)
-      }
-    })
-
-    it('is required by default', () => {
-      const { formSchema } = collection
-      const { keys } = formSchema.describe()
-
-      expect(keys).toHaveProperty(
-        'myComponent',
-        expect.objectContaining({
-          flags: expect.objectContaining({
-            presence: 'required'
-          })
-        })
-      )
-    })
-
-    it('is optional when configured', () => {
-      const collectionOptional = new ComponentCollection(
-        [{ ...def, options: { required: false } }],
-        { model }
-      )
-
-      const { formSchema } = collectionOptional
-      const { keys } = formSchema.describe()
-
-      expect(keys).toHaveProperty(
-        'myComponent',
-        expect.objectContaining({
-          flags: expect.objectContaining({
-            presence: 'optional'
-          })
-        })
-      )
-
-      const result = collectionOptional.validate(getFormData())
-      expect(result.errors).toBeUndefined()
-    })
-
-    it('is configured with radio items', () => {
-      const { formSchema } = collection
-      const { keys } = formSchema.describe()
-
-      expect(keys).toHaveProperty(
-        'myComponent',
-        expect.objectContaining({
-          allow: [true, false],
-          type: 'boolean'
-        })
-      )
-    })
-
-    it('accepts valid values', () => {
-      const result1 = collection.validate(getFormData('true'))
-      const result2 = collection.validate(getFormData('false'))
-
-      expect(result1.errors).toBeUndefined()
-      expect(result2.errors).toBeUndefined()
-    })
-
-    it('adds errors for empty value', () => {
-      const result = collection.validate(getFormData())
-
-      expect(result.errors).toEqual([
-        expect.objectContaining({
-          text: 'Example yes/no - select yes or no'
-        })
-      ])
-    })
-
-    it('adds errors for invalid values', () => {
-      const result1 = collection.validate(getFormData('invalid'))
-      const result2 = collection.validate(getFormData(['true']))
-      const result3 = collection.validate(getFormData(['true', 'false']))
-
-      expect(result1.errors).toBeTruthy()
-      expect(result2.errors).toBeTruthy()
-      expect(result3.errors).toBeTruthy()
-    })
-  })
-
-  describe('State', () => {
-    it('returns text from state', () => {
-      const state1 = getFormState(true)
-      const state2 = getFormState(false)
-      const state3 = getFormState(null)
-
-      const answer1 = getAnswer(field, state1)
-      const answer2 = getAnswer(field, state2)
-      const answer3 = getAnswer(field, state3)
-
-      expect(answer1).toBe('Yes')
-      expect(answer2).toBe('No')
-      expect(answer3).toBe('')
-    })
-
-    it('returns payload from state', () => {
-      const state1 = getFormState(true)
-      const state2 = getFormState(false)
-      const state3 = getFormState(null)
-
-      const payload1 = field.getFormDataFromState(state1)
-      const payload2 = field.getFormDataFromState(state2)
-      const payload3 = field.getFormDataFromState(state3)
-
-      expect(payload1).toEqual(getFormData(true))
-      expect(payload2).toEqual(getFormData(false))
-      expect(payload3).toEqual(getFormData())
-    })
-
-    it('returns value from state', () => {
-      const state1 = getFormState(true)
-      const state2 = getFormState(false)
-      const state3 = getFormState(null)
-
-      const value1 = field.getFormValueFromState(state1)
-      const value2 = field.getFormValueFromState(state2)
-      const value3 = field.getFormValueFromState(state3)
-
-      expect(value1).toBe(true)
-      expect(value2).toBe(false)
-      expect(value3).toBeUndefined()
-    })
-
-    it('returns context for conditions and form submission', () => {
-      const state1 = getFormState(true)
-      const state2 = getFormState(false)
-      const state3 = getFormState(null)
-
-      const value1 = field.getContextValueFromState(state1)
-      const value2 = field.getContextValueFromState(state2)
-      const value3 = field.getContextValueFromState(state3)
-
-      expect(value1).toBe(true)
-      expect(value2).toBe(false)
-      expect(value3).toBeNull()
-    })
-
-    it('returns state from payload', () => {
-      const payload1 = getFormData(true)
-      const payload2 = getFormData(false)
-      const payload3 = getFormData()
-
-      const value1 = field.getStateFromValidForm(payload1)
-      const value2 = field.getStateFromValidForm(payload2)
-      const value3 = field.getStateFromValidForm(payload3)
-
-      expect(value1).toEqual(getFormState(true))
-      expect(value2).toEqual(getFormState(false))
-      expect(value3).toEqual(getFormState(null))
-    })
-  })
-
-  describe('View model', () => {
-    const items = listYesNoExamples
-
-    it('sets Nunjucks component defaults', () => {
-      const item = items[0]
-
-      const viewModel = field.getViewModel(getFormData(item.value))
-
-      expect(viewModel).toEqual(
-        expect.objectContaining({
-          label: { text: def.title },
-          name: 'myComponent',
-          id: 'myComponent',
-          value: item.value
-        })
-      )
-    })
-
-    it.each([...items])('sets Nunjucks component radio items', (item) => {
-      const viewModel = field.getViewModel(getFormData(item.value))
-
-      expect(viewModel.items?.[0]).not.toMatchObject({
-        value: '' // First item is never empty
-      })
-
-      expect(viewModel.items).toEqual(
-        expect.arrayContaining([
-          expect.objectContaining({
-            text: item.text,
-            value: item.value,
-            checked: true
-          })
-        ])
-      )
-    })
-  })
-
-  describe('AllPossibleErrors', () => {
-    it('should return errors', () => {
-      const errors = field.getAllPossibleErrors()
-      expect(errors.baseErrors).not.toBeEmpty()
-      expect(errors.advancedSettingsErrors).toBeEmpty()
-    })
-  })
-})

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

@@ -1,399 +0,0 @@
-import {
-  ComponentType,
-  type DeclarationFieldComponent,
-  type EastingNorthingFieldComponent,
-  type GeospatialFieldComponent,
-  type LatLongFieldComponent,
-  type NationalGridFieldNumberFieldComponent,
-  type OsGridRefFieldComponent
-} from '@defra/forms-model'
-
-import { validState } from '~/src/server/plugins/engine/components/helpers/__stubs__/geospatial.js'
-import {
-  getAnswer,
-  getAnswerMarkdown
-} from '~/src/server/plugins/engine/components/helpers/components.js'
-import {
-  DeclarationField,
-  EastingNorthingField,
-  GeospatialField,
-  LatLongField,
-  NationalGridFieldNumberField,
-  OsGridRefField
-} from '~/src/server/plugins/engine/components/index.js'
-import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import definition from '~/test/form/definitions/blank.js'
-
-describe('Location field formatting', () => {
-  let model: FormModel
-
-  beforeEach(() => {
-    model = new FormModel(definition, {
-      basePath: 'test'
-    })
-  })
-
-  describe('EastingNorthingField', () => {
-    let field: EastingNorthingField
-
-    beforeEach(() => {
-      const def: EastingNorthingFieldComponent = {
-        type: ComponentType.EastingNorthingField,
-        name: 'locationEN',
-        title: 'Location',
-        options: {}
-      }
-      field = new EastingNorthingField(def, { model })
-    })
-
-    it('formats for email output with labels on separate lines', () => {
-      const state = {
-        locationEN__easting: 123456,
-        locationEN__northing: 654321
-      }
-
-      const answer = getAnswer(field, state, { format: 'email' })
-      expect(answer).toBe('Easting: 123456\nNorthing: 654321\n')
-    })
-
-    it('formats for data output', () => {
-      const state = {
-        locationEN__easting: 123456,
-        locationEN__northing: 654321
-      }
-
-      const answer = getAnswer(field, state, { format: 'data' })
-      expect(answer).toBe('Easting: 123456\nNorthing: 654321')
-    })
-
-    it('formats for summary display', () => {
-      const state = {
-        locationEN__easting: 123456,
-        locationEN__northing: 654321
-      }
-
-      const answer = getAnswer(field, state, { format: 'summary' })
-      // Should render as HTML from markdown
-      expect(answer).toContain('Easting: 123456')
-      expect(answer).toContain('Northing: 654321')
-    })
-
-    it('returns empty string when no values', () => {
-      const state = {}
-
-      const answer = getAnswer(field, state, { format: 'email' })
-      expect(answer).toBe('')
-    })
-  })
-
-  describe('LatLongField', () => {
-    let field: LatLongField
-
-    beforeEach(() => {
-      const def: LatLongFieldComponent = {
-        type: ComponentType.LatLongField,
-        name: 'locationLL',
-        title: 'Coordinates',
-        options: {}
-      }
-      field = new LatLongField(def, { model })
-    })
-
-    it('formats for email output with labels on separate lines', () => {
-      const state = {
-        locationLL__latitude: 51.51945,
-        locationLL__longitude: -0.127758
-      }
-
-      const answer = getAnswer(field, state, { format: 'email' })
-      expect(answer).toBe('Latitude: 51.51945\nLongitude: -0.127758\n')
-    })
-
-    it('formats for data output', () => {
-      const state = {
-        locationLL__latitude: 51.51945,
-        locationLL__longitude: -0.127758
-      }
-
-      const answer = getAnswer(field, state, { format: 'data' })
-      expect(answer).toBe('Latitude: 51.51945\nLongitude: -0.127758')
-    })
-
-    it('formats for summary display', () => {
-      const state = {
-        locationLL__latitude: 51.51945,
-        locationLL__longitude: -0.127758
-      }
-
-      const answer = getAnswer(field, state, { format: 'summary' })
-      // Should render as HTML from markdown
-      expect(answer).toContain('Latitude: 51.51945')
-      expect(answer).toContain('Longitude: -0.127758')
-    })
-
-    it('returns empty string when no values', () => {
-      const state = {}
-
-      const answer = getAnswer(field, state, { format: 'email' })
-      expect(answer).toBe('')
-    })
-  })
-
-  describe('OsGridRefField', () => {
-    let field: OsGridRefField
-
-    beforeEach(() => {
-      const def: OsGridRefFieldComponent = {
-        type: ComponentType.OsGridRefField,
-        name: 'gridRef',
-        title: 'OS Grid Reference',
-        options: {}
-      }
-      field = new OsGridRefField(def, { model })
-    })
-
-    it('formats for email output as single value', () => {
-      const state = {
-        gridRef: 'TQ123456'
-      }
-
-      const answer = getAnswer(field, state, { format: 'email' })
-      expect(answer).toBe('TQ123456\n')
-    })
-
-    it('formats for data output', () => {
-      const state = {
-        gridRef: 'TQ123456'
-      }
-
-      const answer = getAnswer(field, state, { format: 'data' })
-      expect(answer).toBe('TQ123456')
-    })
-
-    it('formats for summary display', () => {
-      const state = {
-        gridRef: 'TQ123456'
-      }
-
-      const answer = getAnswer(field, state, { format: 'summary' })
-      expect(answer).toBe('TQ123456')
-    })
-  })
-
-  describe('NationalGridFieldNumberField', () => {
-    let field: NationalGridFieldNumberField
-
-    beforeEach(() => {
-      const def: NationalGridFieldNumberFieldComponent = {
-        type: ComponentType.NationalGridFieldNumberField,
-        name: 'ngField',
-        title: 'National Grid Field Number',
-        options: {}
-      }
-      field = new NationalGridFieldNumberField(def, { model })
-    })
-
-    it('formats for email output as single value', () => {
-      const state = {
-        ngField: 'NG12345678'
-      }
-
-      const answer = getAnswer(field, state, { format: 'email' })
-      expect(answer).toBe('NG12345678\n')
-    })
-
-    it('formats for data output', () => {
-      const state = {
-        ngField: 'NG12345678'
-      }
-
-      const answer = getAnswer(field, state, { format: 'data' })
-      expect(answer).toBe('NG12345678')
-    })
-
-    it('formats for summary display', () => {
-      const state = {
-        ngField: 'NG12345678'
-      }
-
-      const answer = getAnswer(field, state, { format: 'summary' })
-      expect(answer).toBe('NG12345678')
-    })
-  })
-
-  describe('GeospatialField', () => {
-    let field: GeospatialField
-
-    beforeEach(() => {
-      const def: GeospatialFieldComponent = {
-        type: ComponentType.GeospatialField,
-        name: 'geoField',
-        title: 'Geospatial',
-        options: {}
-      }
-      field = new GeospatialField(def, { model })
-    })
-
-    it('formats for email output as single value', () => {
-      const state = {
-        geoField: validState
-      }
-
-      const answer = getAnswer(field, state, { format: 'email' })
-      expect(answer).toBe('Added 4 locations\n')
-    })
-
-    it('formats for data output', () => {
-      const state = {
-        geoField: validState
-      }
-
-      const answer = getAnswer(field, state, { format: 'data' })
-      expect(answer).toBe('a,b,c,d')
-    })
-
-    it('formats for summary display', () => {
-      const state = {
-        geoField: validState
-      }
-
-      const answer = getAnswer(field, state, { format: 'summary' })
-      expect(answer).toBe('Added 4 locations')
-    })
-  })
-
-  describe('DeclarationField', () => {
-    let field: DeclarationField
-
-    beforeEach(() => {
-      const def: DeclarationFieldComponent = {
-        type: ComponentType.DeclarationField,
-        name: 'declField',
-        title: 'Declaration title',
-        content: '# markup heading',
-        options: {}
-      }
-      field = new DeclarationField(def, { model })
-    })
-
-    it('formats correctly when agreed', () => {
-      const state = {
-        declField: true
-      }
-
-      const answer = getAnswer(field, state, { format: 'email' })
-      expect(answer).toBe('I understand and agree\n')
-    })
-
-    it('formats correctly when not agreed', () => {
-      const state = {
-        declField: false
-      }
-
-      const answer = getAnswer(field, state, { format: 'email' })
-      expect(answer).toBe('Not provided\n')
-    })
-
-    it('formats for data output when agreed', () => {
-      const state = {
-        declField: true
-      }
-
-      const answer = getAnswer(field, state, { format: 'data' })
-      expect(answer).toBe('true')
-    })
-
-    it('formats for data output when not agreed', () => {
-      const state = {
-        declField: false
-      }
-
-      const answer = getAnswer(field, state, { format: 'data' })
-      expect(answer).toBe('false')
-    })
-
-    it('formats for data output when no value', () => {
-      const state = {}
-
-      const answer = getAnswer(field, state, { format: 'data' })
-      expect(answer).toBe('false')
-    })
-
-    it('formats for summary display when agreed', () => {
-      const state = {
-        declField: true
-      }
-
-      const answer = getAnswer(field, state, { format: 'summary' })
-      expect(answer).toBe('I understand and agree')
-    })
-
-    it('formats for summary display when not agreed', () => {
-      const state = {
-        declField: false
-      }
-
-      const answer = getAnswer(field, state, { format: 'summary' })
-      expect(answer).toBe('Not provided')
-    })
-
-    it('formats for summary display when no value', () => {
-      const state = {}
-
-      const answer = getAnswer(field, state, { format: 'summary' })
-      expect(answer).toBe('Not provided')
-    })
-  })
-
-  describe('getAnswerMarkdown', () => {
-    it('formats EastingNorthingField correctly', () => {
-      const def: EastingNorthingFieldComponent = {
-        type: ComponentType.EastingNorthingField,
-        name: 'locationEN',
-        title: 'Location',
-        options: {}
-      }
-      const field = new EastingNorthingField(def, { model })
-      const state = {
-        locationEN__easting: 123456,
-        locationEN__northing: 654321
-      }
-
-      const answer = getAnswerMarkdown(field, state, { format: 'email' })
-      expect(answer).toBe('Easting: 123456\nNorthing: 654321\n')
-    })
-
-    it('formats LatLongField correctly', () => {
-      const def: LatLongFieldComponent = {
-        type: ComponentType.LatLongField,
-        name: 'locationLL',
-        title: 'Coordinates',
-        options: {}
-      }
-      const field = new LatLongField(def, { model })
-      const state = {
-        locationLL__latitude: 51.51945,
-        locationLL__longitude: -0.127758
-      }
-
-      const answer = getAnswerMarkdown(field, state, { format: 'email' })
-      expect(answer).toBe('Latitude: 51.51945\nLongitude: -0.127758\n')
-    })
-
-    it('formats simple location fields correctly', () => {
-      const def: OsGridRefFieldComponent = {
-        type: ComponentType.OsGridRefField,
-        name: 'gridRef',
-        title: 'OS Grid Reference',
-        options: {}
-      }
-      const field = new OsGridRefField(def, { model })
-      const state = {
-        gridRef: 'TQ123456'
-      }
-
-      const answer = getAnswerMarkdown(field, state, { format: 'email' })
-      expect(answer).toBe('TQ123456\n')
-    })
-  })
-})

package/src/server/plugins/engine/components/helpers/geospatial.test.js

@@ -1,55 +0,0 @@
-import { validState } from '~/src/server/plugins/engine/components/helpers/__stubs__/geospatial.js'
-import { geospatialSchema } from '~/src/server/plugins/engine/components/helpers/geospatial.js'
-
-describe('Geospatial validation helpers', () => {
-  test('it should not have errors for valid geojson object', () => {
-    const result = geospatialSchema.validate(validState)
-
-    expect(result.error).toBeUndefined()
-    expect(result.value).toBeDefined()
-    expect(result.value).toHaveLength(4)
-  })
-
-  test('it should not have errors for valid geojson string', () => {
-    const result = geospatialSchema.validate(JSON.stringify(validState))
-
-    expect(result.error).toBeUndefined()
-    expect(result.value).toBeDefined()
-    expect(result.value).toHaveLength(4)
-  })
-
-  test('it should have errors for invalid json string', () => {
-    const result = geospatialSchema.validate('{')
-
-    expect(result.error).toBeDefined()
-    expect(result.value).toBe('{')
-  })
-
-  test('it should have errors for invalid geojson string', () => {
-    const result = geospatialSchema.validate('[')
-
-    expect(result.error).toBeDefined()
-    expect(result.value).toBe('[')
-  })
-
-  test('it should validate an empty array', () => {
-    const result = geospatialSchema.validate('[]')
-
-    expect(result.error).toBeUndefined()
-    expect(result.value).toEqual([])
-  })
-
-  test('it should not validate an empty object', () => {
-    const result = geospatialSchema.validate('{}')
-
-    expect(result.error).toBeDefined()
-    expect(result.value).toBeUndefined()
-  })
-
-  test('it should validate an empty string', () => {
-    const result = geospatialSchema.validate('')
-
-    expect(result.error).toBeDefined()
-    expect(result.value).toBeUndefined()
-  })
-})