@defra/forms-engine-plugin 4.0.7 → 4.0.8

package/.server/server/plugins/nunjucks/filters/field.d.ts

@@ -3,5 +3,5 @@
  * @this {NunjucksContext}
  * @param {string} name - The name of the component
  */
-export function field(this: NunjucksContext, name: string): import("../../engine/components/TextField.js").TextField | import("../../engine/components/SelectField.js").SelectField | import("../../engine/components/RadiosField.js").RadiosField | import("../../engine/components/YesNoField.js").YesNoField | import("../../engine/components/CheckboxesField.js").CheckboxesField | import("../../engine/components/DatePartsField.js").DatePartsField | import("../../engine/components/EastingNorthingField.js").EastingNorthingField | import("../../engine/components/EmailAddressField.js").EmailAddressField | import("../../engine/components/LatLongField.js").LatLongField | import("../../engine/components/MonthYearField.js").MonthYearField | import("../../engine/components/MultilineTextField.js").MultilineTextField | import("../../engine/components/NationalGridFieldNumberField.js").NationalGridFieldNumberField | import("../../engine/components/NumberField.js").NumberField | import("../../engine/components/OsGridRefField.js").OsGridRefField | import("../../engine/components/TelephoneNumberField.js").TelephoneNumberField | import("../../engine/components/UkAddressField.js").UkAddressField | import("../../engine/components/FileUploadField.js").FileUploadField | import("../../engine/components/Details.js").Details | import("../../engine/components/Html.js").Html | import("../../engine/components/InsetText.js").InsetText | import("../../engine/components/List.js").List | import("../../engine/components/Markdown.js").Markdown | undefined;
+export function field(this: NunjucksContext, name: string): import("../../engine/components/TextField.js").TextField | import("../../engine/components/SelectField.js").SelectField | import("../../engine/components/RadiosField.js").RadiosField | import("../../engine/components/YesNoField.js").YesNoField | import("../../engine/components/CheckboxesField.js").CheckboxesField | import("../../engine/components/DatePartsField.js").DatePartsField | import("../../engine/components/DeclarationField.js").DeclarationField | import("../../engine/components/EastingNorthingField.js").EastingNorthingField | import("../../engine/components/EmailAddressField.js").EmailAddressField | import("../../engine/components/LatLongField.js").LatLongField | import("../../engine/components/MonthYearField.js").MonthYearField | import("../../engine/components/MultilineTextField.js").MultilineTextField | import("../../engine/components/NationalGridFieldNumberField.js").NationalGridFieldNumberField | import("../../engine/components/NumberField.js").NumberField | import("../../engine/components/OsGridRefField.js").OsGridRefField | import("../../engine/components/TelephoneNumberField.js").TelephoneNumberField | import("../../engine/components/UkAddressField.js").UkAddressField | import("../../engine/components/FileUploadField.js").FileUploadField | import("../../engine/components/Details.js").Details | import("../../engine/components/Html.js").Html | import("../../engine/components/InsetText.js").InsetText | import("../../engine/components/List.js").List | import("../../engine/components/Markdown.js").Markdown | undefined;
 import type { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js';

package/.server/server/plugins/nunjucks/filters/index.d.ts

@@ -5,3 +5,4 @@ export { answer } from "~/src/server/plugins/nunjucks/filters/answer.js";
 export { href } from "~/src/server/plugins/nunjucks/filters/href.js";
 export { field } from "~/src/server/plugins/nunjucks/filters/field.js";
 export { page } from "~/src/server/plugins/nunjucks/filters/page.js";
+export { merge } from "~/src/server/plugins/nunjucks/filters/merge.js";

package/.server/server/plugins/nunjucks/filters/index.js

@@ -5,4 +5,5 @@ export { answer } from "./answer.js";
 export { href } from "./href.js";
 export { field } from "./field.js";
 export { page } from "./page.js";
+export { merge } from "./merge.js";
 //# sourceMappingURL=index.js.map

package/.server/server/plugins/nunjucks/filters/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["highlight","inspect","evaluate","answer","href","field","page"],"sources":["../../../../../src/server/plugins/nunjucks/filters/index.js"],"sourcesContent":["export { highlight } from '~/src/server/plugins/nunjucks/filters/highlight.js'\nexport { inspect } from '~/src/server/plugins/nunjucks/filters/inspect.js'\nexport { evaluate } from '~/src/server/plugins/nunjucks/filters/evaluate.js'\nexport { answer } from '~/src/server/plugins/nunjucks/filters/answer.js'\nexport { href } from '~/src/server/plugins/nunjucks/filters/href.js'\nexport { field } from '~/src/server/plugins/nunjucks/filters/field.js'\nexport { page } from '~/src/server/plugins/nunjucks/filters/page.js'\n"],"mappings":"AAAA,SAASA,SAAS;AAClB,SAASC,OAAO;AAChB,SAASC,QAAQ;AACjB,SAASC,MAAM;AACf,SAASC,IAAI;AACb,SAASC,KAAK;AACd,SAASC,IAAI","ignoreList":[]}
+{"version":3,"file":"index.js","names":["highlight","inspect","evaluate","answer","href","field","page","merge"],"sources":["../../../../../src/server/plugins/nunjucks/filters/index.js"],"sourcesContent":["export { highlight } from '~/src/server/plugins/nunjucks/filters/highlight.js'\nexport { inspect } from '~/src/server/plugins/nunjucks/filters/inspect.js'\nexport { evaluate } from '~/src/server/plugins/nunjucks/filters/evaluate.js'\nexport { answer } from '~/src/server/plugins/nunjucks/filters/answer.js'\nexport { href } from '~/src/server/plugins/nunjucks/filters/href.js'\nexport { field } from '~/src/server/plugins/nunjucks/filters/field.js'\nexport { page } from '~/src/server/plugins/nunjucks/filters/page.js'\nexport { merge } from '~/src/server/plugins/nunjucks/filters/merge.js'\n"],"mappings":"AAAA,SAASA,SAAS;AAClB,SAASC,OAAO;AAChB,SAASC,QAAQ;AACjB,SAASC,MAAM;AACf,SAASC,IAAI;AACb,SAASC,KAAK;AACd,SAASC,IAAI;AACb,SAASC,KAAK","ignoreList":[]}

package/.server/server/plugins/nunjucks/filters/merge.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Nunjucks filter to get the page for a given path
+ * @param {Record<string, any>} targetDictionary - Object to extend
+ * @param {Record<string, any> | string} sourceDictionary - Object to merge into target
+ * @returns {Record<string, any>}
+ */
+export function merge(targetDictionary: Record<string, any>, sourceDictionary: Record<string, any> | string): Record<string, any>;

package/.server/server/plugins/nunjucks/filters/merge.js

@@ -0,0 +1,16 @@
+/**
+ * Nunjucks filter to get the page for a given path
+ * @param {Record<string, any>} targetDictionary - Object to extend
+ * @param {Record<string, any> | string} sourceDictionary - Object to merge into target
+ * @returns {Record<string, any>}
+ */
+export function merge(targetDictionary, sourceDictionary) {
+  if (typeof sourceDictionary !== 'object') {
+    return targetDictionary;
+  }
+  return {
+    ...targetDictionary,
+    ...sourceDictionary
+  };
+}
+//# sourceMappingURL=merge.js.map

package/.server/server/plugins/nunjucks/filters/merge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge.js","names":["merge","targetDictionary","sourceDictionary"],"sources":["../../../../../src/server/plugins/nunjucks/filters/merge.js"],"sourcesContent":["/**\n * Nunjucks filter to get the page for a given path\n * @param {Record<string, any>} targetDictionary - Object to extend\n * @param {Record<string, any> | string} sourceDictionary - Object to merge into target\n * @returns {Record<string, any>}\n */\nexport function merge(targetDictionary, sourceDictionary) {\n  if (typeof sourceDictionary !== 'object') {\n    return targetDictionary\n  }\n\n  return {\n    ...targetDictionary,\n    ...sourceDictionary\n  }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,KAAKA,CAACC,gBAAgB,EAAEC,gBAAgB,EAAE;EACxD,IAAI,OAAOA,gBAAgB,KAAK,QAAQ,EAAE;IACxC,OAAOD,gBAAgB;EACzB;EAEA,OAAO;IACL,GAAGA,gBAAgB;IACnB,GAAGC;EACL,CAAC;AACH","ignoreList":[]}

package/.server/server/plugins/nunjucks/filters/merge.test.js

@@ -0,0 +1,19 @@
+import { merge } from "./merge.js";
+describe('merge', () => {
+  const propertyToMerge = {
+    lorem: 'ipsum'
+  };
+  it('should return the target if source is not an object', () => {
+    expect(merge(propertyToMerge, 'dolar')).toBe(propertyToMerge);
+  });
+  it('should merge the properties if they are valid', () => {
+    expect(merge({
+      lorem: 'dolar',
+      dolar: 'sit'
+    }, propertyToMerge)).toEqual({
+      lorem: 'ipsum',
+      dolar: 'sit'
+    });
+  });
+});
+//# sourceMappingURL=merge.test.js.map

package/.server/server/plugins/nunjucks/filters/merge.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge.test.js","names":["merge","describe","propertyToMerge","lorem","it","expect","toBe","dolar","toEqual"],"sources":["../../../../../src/server/plugins/nunjucks/filters/merge.test.js"],"sourcesContent":["import { merge } from '~/src/server/plugins/nunjucks/filters/merge.js'\n\ndescribe('merge', () => {\n  const propertyToMerge = { lorem: 'ipsum' }\n  it('should return the target if source is not an object', () => {\n    expect(merge(propertyToMerge, 'dolar')).toBe(propertyToMerge)\n  })\n\n  it('should merge the properties if they are valid', () => {\n    expect(merge({ lorem: 'dolar', dolar: 'sit' }, propertyToMerge)).toEqual({\n      lorem: 'ipsum',\n      dolar: 'sit'\n    })\n  })\n})\n"],"mappings":"AAAA,SAASA,KAAK;AAEdC,QAAQ,CAAC,OAAO,EAAE,MAAM;EACtB,MAAMC,eAAe,GAAG;IAAEC,KAAK,EAAE;EAAQ,CAAC;EAC1CC,EAAE,CAAC,qDAAqD,EAAE,MAAM;IAC9DC,MAAM,CAACL,KAAK,CAACE,eAAe,EAAE,OAAO,CAAC,CAAC,CAACI,IAAI,CAACJ,eAAe,CAAC;EAC/D,CAAC,CAAC;EAEFE,EAAE,CAAC,+CAA+C,EAAE,MAAM;IACxDC,MAAM,CAACL,KAAK,CAAC;MAAEG,KAAK,EAAE,OAAO;MAAEI,KAAK,EAAE;IAAM,CAAC,EAAEL,eAAe,CAAC,CAAC,CAACM,OAAO,CAAC;MACvEL,KAAK,EAAE,OAAO;MACdI,KAAK,EAAE;IACT,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.0.7",
+  "version": "4.0.8",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -70,7 +70,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.569",
+    "@defra/forms-model": "^3.0.574",
     "@defra/hapi-tracing": "^1.26.0",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",

package/src/server/forms/components.json

@@ -120,6 +120,13 @@
           "content": "### This is a H3 in markdown\n\n[An internal link](http://localhost:3009/fictional-page)\n\n[An external link](https://defra.gov.uk/fictional-page)",
           "options": {},
           "schema": {}
+        },
+        {
+          "type": "DeclarationField",
+          "name": "declaration",
+          "title": "Declaration",
+          "content": "By submitting this form, I agree to:\n\n- Provide accurate and complete information\n- Comply with all applicable regulations\n- Accept responsibility for any false statements",
+          "hint": "Please read and confirm the following terms"
         }
       ]
     },

package/src/server/forms/page-events.yaml

@@ -59,7 +59,7 @@ pages:
     next: []
     id: da0fbdb4-a2de-4650-be16-9ba552af135f
   - id: 449a45f6-4541-4a46-91bd-8b8931b07b50
-    title: Summary
+    title: ''
     path: '/summary'
     controller: SummaryPageController
     events:

package/src/server/forms/register-as-a-unicorn-breeder.yaml

@@ -219,7 +219,7 @@ pages:
     controller: FileUploadPageController
     section: Regnsa
     next:
-      - path: '/how-many-unicorns-do-you-expect-to-breed-each-year'
+      - path: '/declaration'
     components:
       - name: dLzALM
         title: Documents
@@ -230,6 +230,17 @@ pages:
         schema:
           min: 1
           max: 3
+  - title: Declaration
+    path: '/declaration'
+    section: section
+    components:
+      - name: diLmal
+        title: Declaration
+        type: DeclarationField
+        content: 'Fill in this field'
+        options: {}
+    next:
+      - path: '/summary'
 conditions:
   - displayName: Address is different
     name: IrVmYz

package/src/server/index.test.ts

@@ -585,6 +585,7 @@ describe('prepareEnvironment', () => {
     'href',
     'field',
     'page',
+    'merge',
     'markdown'
   ]
 

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

@@ -90,6 +90,7 @@ export type ComponentSchema =
   | ArraySchema<boolean>
   | ArraySchema<object>
   | BooleanSchema<string>
+  | BooleanSchema
   | DateSchema
   | NumberSchema<string>
   | NumberSchema

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

@@ -256,6 +256,7 @@ export class ComponentCollection {
    */
   validate(value: FormPayload = {}): FormValidationResult<FormPayload> {
     const result = this.formSchema.validate(value, opts)
+
     const details = result.error?.details
 
     return {

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

@@ -0,0 +1,426 @@
+import {
+  ComponentType,
+  type DeclarationFieldComponent
+} from '@defra/forms-model'
+
+import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
+import { DeclarationField } from '~/src/server/plugins/engine/components/DeclarationField.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 definition from '~/test/form/definitions/blank.js'
+import { getFormData, getFormState } from '~/test/helpers/component-helpers.js'
+
+describe('DeclarationField', () => {
+  let model: FormModel
+
+  beforeEach(() => {
+    model = new FormModel(definition, {
+      basePath: 'test'
+    })
+  })
+
+  describe('Defaults', () => {
+    let def: DeclarationFieldComponent
+    let collection: ComponentCollection
+    let field: Field
+
+    beforeEach(() => {
+      def = {
+        title: 'Example Declaration Component',
+        name: 'myComponent',
+        content: 'Lorem ipsum dolar sit amet',
+        shortDescription: 'Terms and conditions',
+        type: ComponentType.DeclarationField,
+        options: {}
+      } satisfies DeclarationFieldComponent
+
+      collection = new ComponentCollection([def], { model })
+      field = collection.fields[0]
+    })
+
+    describe('Schema', () => {
+      it('uses component title as label as default', () => {
+        const { formSchema } = collection
+        const { keys } = formSchema.describe()
+
+        expect(keys).toHaveProperty(
+          'myComponent',
+          expect.objectContaining({
+            flags: expect.objectContaining({
+              label: 'Terms and conditions'
+            })
+          })
+        )
+      })
+
+      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({
+            items: expect.arrayContaining([
+              expect.objectContaining({
+                allow: ['true'],
+                flags: expect.objectContaining({
+                  presence: 'required'
+                })
+              })
+            ])
+          })
+        )
+      })
+
+      it('may have unchecked value in addition to true', () => {
+        const { formSchema } = collection
+        const { keys } = formSchema.describe()
+
+        expect(keys).toHaveProperty(
+          'myComponent',
+          expect.objectContaining({
+            items: expect.arrayContaining([
+              expect.objectContaining({
+                allow: ['unchecked'],
+                flags: expect.objectContaining({
+                  result: 'strip'
+                })
+              })
+            ])
+          })
+        )
+
+        expect(keys).toHaveProperty(
+          'myComponent',
+          expect.objectContaining({
+            items: expect.arrayContaining([
+              expect.objectContaining({
+                allow: ['unchecked']
+              })
+            ])
+          })
+        )
+      })
+
+      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({
+            items: expect.arrayContaining([
+              expect.objectContaining({
+                allow: ['true'],
+                flags: expect.not.objectContaining({
+                  presence: 'required'
+                })
+              })
+            ])
+          })
+        )
+
+        const result = collectionOptional.validate(getFormData(['unchecked']))
+        expect(result.errors).toBeUndefined()
+      })
+
+      it('accepts valid values', () => {
+        const result1 = collection.validate(getFormData(['unchecked', 'true']))
+
+        expect(result1.errors).toBeUndefined()
+      })
+
+      it('adds errors for empty value', () => {
+        const result = collection.validate(getFormData(['unchecked']))
+
+        expect(result.errors).toEqual([
+          expect.objectContaining({
+            text: 'You must confirm you understand and agree with the terms and conditions to continue'
+          })
+        ])
+      })
+
+      it('adds errors for invalid values', () => {
+        const result1 = collection.validate(getFormData(['invalid']))
+        const result2 = collection.validate(
+          // @ts-expect-error - Allow invalid param for test
+          getFormData({ unknown: 'invalid' })
+        )
+        // @ts-expect-error - Allow invalid param for test
+        const result3 = collection.validate('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()
+        // context - boolean
+        // state - boolean
+        // string - I confirm that I understand and accept this declaration
+        const answer1 = getAnswer(field, state1)
+        const answer2 = getAnswer(field, state2)
+
+        expect(answer1).toBe('I understand and agree')
+        expect(answer2).toBe('')
+      })
+
+      it('returns payload from state', () => {
+        const state1 = getFormState(true)
+        const state2 = getFormState(null)
+
+        const payload1 = field.getFormDataFromState(state1)
+        const payload2 = field.getFormDataFromState(state2)
+
+        expect(payload1).toEqual(getFormData('true'))
+        expect(payload2).toEqual(getFormData())
+      })
+
+      it('returns value from state', () => {
+        const state1 = getFormState(true)
+        const state2 = getFormState(null)
+
+        const value1 = field.getFormValueFromState(state1)
+        const value2 = field.getFormValueFromState(state2)
+
+        expect(value1).toBe('true')
+        expect(value2).toBeUndefined()
+      })
+
+      it('returns context for conditions and form submission', () => {
+        const state1 = getFormState(true)
+        const state2 = getFormState(null)
+
+        const value1 = field.getContextValueFromState(state1)
+        const value2 = field.getContextValueFromState(state2)
+
+        expect(value1).toBe(true)
+        expect(value2).toBe(false)
+      })
+
+      it('returns state from payload', () => {
+        const payload1 = getFormData(['true'])
+        const payload2 = getFormData([])
+        const payload3 = getFormData(['unchecked'])
+
+        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(false))
+      })
+    })
+
+    describe('View model', () => {
+      it('sets Nunjucks component defaults', () => {
+        const viewModel = field.getViewModel(getFormData([]))
+
+        expect(viewModel).toEqual(
+          expect.objectContaining({
+            label: { text: def.title },
+            name: 'myComponent',
+            attributes: {},
+            values: [],
+            content: 'Lorem ipsum dolar sit amet',
+            id: 'myComponent',
+            fieldset: {
+              legend: {
+                text: 'Example Declaration Component'
+              }
+            },
+            items: [
+              {
+                value: 'true',
+                text: 'I understand and agree'
+              }
+            ]
+          })
+        )
+      })
+
+      it('sets Nunjucks component value when posted', () => {
+        def = {
+          ...def,
+          hint: 'Please read and confirm the following'
+        } satisfies DeclarationFieldComponent
+
+        collection = new ComponentCollection([def], { model })
+        field = collection.fields[0]
+        const viewModel = field.getViewModel(getFormData(['true']))
+
+        expect(viewModel).toEqual(
+          expect.objectContaining({
+            values: ['true'],
+            hint: {
+              text: 'Please read and confirm the following'
+            }
+          })
+        )
+      })
+
+      it('sets custom message when in def', () => {
+        def = {
+          ...def,
+          title: 'Declaration',
+          content:
+            'Declaration:\n' +
+            'By submitting this form, I consent to the collection and processing of my personal data for the purposes described.\n' +
+            'I understand that my data may be shared with authorised third parties where required by law',
+          options: {
+            declarationConfirmationLabel:
+              'I consent to the processing of my personal data'
+          }
+        } satisfies DeclarationFieldComponent
+
+        collection = new ComponentCollection([def], { model })
+        field = collection.fields[0]
+
+        const viewModel = field.getViewModel(getFormData(['unchecked', 'true']))
+
+        expect(viewModel).toEqual(
+          expect.objectContaining({
+            items: [
+              {
+                value: 'true',
+                text: 'I consent to the processing of my personal data'
+              }
+            ]
+          })
+        )
+      })
+    })
+
+    describe('AllPossibleErrors', () => {
+      it('should return errors', () => {
+        const errors = field.getAllPossibleErrors()
+        expect(errors.baseErrors).not.toBeEmpty()
+        expect(errors.advancedSettingsErrors).toBeEmpty()
+      })
+    })
+
+    describe('getFormValue', () => {
+      test('should return correct value', () => {
+        expect(field.getFormValue(undefined)).toBeUndefined()
+        expect(field.getFormValue([true])).toEqual([true])
+        expect(field.getFormValue([])).toEqual([])
+        expect(field.getFormValue({})).toBeUndefined()
+      })
+    })
+  })
+
+  describe('Validation', () => {
+    describe.each([
+      {
+        description: 'Default',
+        component: {
+          title: 'Terms and conditions',
+          shortDescription: 'The terms and conditions',
+          content: 'Lorem ipsum dolar sit amet',
+          name: 'myComponent',
+          type: ComponentType.DeclarationField,
+          options: {}
+        } satisfies DeclarationFieldComponent,
+        assertions: [
+          {
+            input: getFormData(['unchecked', 'true']),
+            output: {
+              value: {
+                myComponent: ['true']
+              },
+              errors: undefined
+            }
+          }
+        ]
+      },
+      {
+        description: 'Use short description if it exists',
+        component: {
+          title: 'Terms and conditions',
+          shortDescription: 'Terms and conditions',
+          content: 'Lorem ipsum dolar sit amet',
+          name: 'myComponent',
+          type: ComponentType.DeclarationField,
+          options: {}
+        } satisfies DeclarationFieldComponent,
+        assertions: [
+          {
+            input: getFormData(['unchecked']),
+            output: {
+              value: { myComponent: [] },
+              errors: [
+                expect.objectContaining({
+                  text: 'You must confirm you understand and agree with the terms and conditions to continue'
+                })
+              ]
+            }
+          }
+        ]
+      },
+      {
+        description: 'Optional field',
+        component: {
+          title: 'Example text field',
+          name: 'myComponent',
+          content: 'Lorem ipsum dolar sit amet',
+          type: ComponentType.DeclarationField,
+          options: {
+            required: false
+          }
+        } satisfies DeclarationFieldComponent,
+        assertions: [
+          {
+            input: getFormData(['unchecked']),
+            output: { value: { myComponent: [] } }
+          }
+        ]
+      }
+    ])('$description', ({ component: def, assertions }) => {
+      let collection: ComponentCollection
+
+      beforeEach(() => {
+        collection = new ComponentCollection([def], { model })
+      })
+
+      it.each([...assertions])(
+        'validates custom example',
+        ({ input, output }) => {
+          const result = collection.validate(input)
+          expect(result).toEqual(output)
+        }
+      )
+    })
+  })
+
+  describe('isBool', () => {
+    test('should return correct boolean', () => {
+      expect(DeclarationField.isBool('string')).toBe(false)
+      expect(DeclarationField.isBool(true)).toBe(true)
+    })
+  })
+})