@defra/forms-engine-plugin 0.0.3 → 0.0.4

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

@@ -1,163 +0,0 @@
-import { type NumberFieldComponent } from '@defra/forms-model'
-import joi, { type CustomValidator, type NumberSchema } from 'joi'
-
-import {
-  FormComponent,
-  isFormValue
-} from '~/src/server/plugins/engine/components/FormComponent.js'
-import { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
-import {
-  type FormPayload,
-  type FormState,
-  type FormStateValue,
-  type FormSubmissionError,
-  type FormSubmissionState
-} from '~/src/server/plugins/engine/types.js'
-
-export class NumberField extends FormComponent {
-  declare options: NumberFieldComponent['options']
-  declare schema: NumberFieldComponent['schema']
-  declare formSchema: NumberSchema
-  declare stateSchema: NumberSchema
-
-  constructor(
-    def: NumberFieldComponent,
-    props: ConstructorParameters<typeof FormComponent>[1]
-  ) {
-    super(def, props)
-
-    const { options, schema, title } = def
-
-    let formSchema = joi
-      .number()
-      .custom(getValidatorPrecision(this))
-      .label(title)
-      .required()
-
-    if (options.required === false) {
-      formSchema = formSchema.allow('')
-    } else {
-      const messages = options.customValidationMessages
-
-      formSchema = formSchema.empty('').messages({
-        'any.required': messages?.['any.required'] ?? messageTemplate.required
-      })
-    }
-
-    if (typeof schema.min === 'number') {
-      formSchema = formSchema.min(schema.min)
-    }
-
-    if (typeof schema.max === 'number') {
-      formSchema = formSchema.max(schema.max)
-    }
-
-    if (typeof schema.precision === 'number' && schema.precision <= 0) {
-      formSchema = formSchema.integer()
-    }
-
-    if (options.customValidationMessage) {
-      const message = options.customValidationMessage
-
-      formSchema = formSchema.messages({
-        'any.required': message,
-        'number.base': message,
-        'number.precision': message,
-        'number.integer': message,
-        'number.min': message,
-        'number.max': message
-      })
-    } else if (options.customValidationMessages) {
-      formSchema = formSchema.messages(options.customValidationMessages)
-    }
-
-    this.formSchema = formSchema.default('')
-    this.stateSchema = formSchema.default(null).allow(null)
-    this.options = options
-    this.schema = schema
-  }
-
-  getFormValueFromState(state: FormSubmissionState) {
-    const { name } = this
-    return this.getFormValue(state[name])
-  }
-
-  getFormValue(value?: FormStateValue | FormState) {
-    return this.isValue(value) ? value : undefined
-  }
-
-  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {
-    const { options, schema } = this
-
-    const viewModel = super.getViewModel(payload, errors)
-    let { attributes, prefix, suffix, value } = viewModel
-
-    if (typeof schema.precision === 'undefined' || schema.precision <= 0) {
-      // If precision isn't provided or provided and
-      // less than or equal to 0, use numeric inputmode
-      attributes.inputmode = 'numeric'
-    }
-
-    if (options.prefix) {
-      prefix = {
-        text: options.prefix
-      }
-    }
-
-    if (options.suffix) {
-      suffix = {
-        text: options.suffix
-      }
-    }
-
-    // Allow any `toString()`-able value so non-numeric
-    // values are shown alongside their error messages
-    if (!isFormValue(value)) {
-      value = undefined
-    }
-
-    return {
-      ...viewModel,
-      attributes,
-      prefix,
-      suffix,
-      value
-    }
-  }
-
-  isValue(value?: FormStateValue | FormState) {
-    return NumberField.isNumber(value)
-  }
-
-  static isNumber(value?: FormStateValue | FormState): value is number {
-    return typeof value === 'number'
-  }
-}
-
-export function getValidatorPrecision(component: NumberField) {
-  const validator: CustomValidator = (value: number, helpers) => {
-    const { options, schema } = component
-
-    const { customValidationMessage: custom } = options
-    const { precision: limit } = schema
-
-    if (!limit || limit <= 0) {
-      return value
-    }
-
-    const validationSchema = joi
-      .number()
-      .precision(limit)
-      .prefs({ convert: false })
-
-    try {
-      return joi.attempt(value, validationSchema)
-    } catch {
-      return custom
-        ? helpers.message({ custom }, { limit })
-        : helpers.error('number.precision', { limit })
-    }
-  }
-
-  return validator
-}

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

@@ -1,288 +0,0 @@
-import { ComponentType, type RadiosFieldComponent } from '@defra/forms-model'
-
-import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
-import { RadiosField } from '~/src/server/plugins/engine/components/RadiosField.js'
-import {
-  getAnswer,
-  type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
-import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import {
-  listNumber,
-  listNumberExamples,
-  listString,
-  listStringExamples
-} from '~/test/fixtures/list.js'
-import definition from '~/test/form/definitions/blank.js'
-import { getFormData, getFormState } from '~/test/helpers/component-helpers.js'
-
-describe.each([
-  {
-    component: {
-      title: 'String list',
-      name: 'myComponent',
-      type: ComponentType.RadiosField,
-      list: 'listString',
-      options: {}
-    } satisfies RadiosFieldComponent,
-
-    options: {
-      list: listString,
-      examples: listStringExamples,
-      allow: ['1', '2', '3', '4']
-    }
-  },
-  {
-    component: {
-      title: 'Number list',
-      name: 'myComponent',
-      type: ComponentType.RadiosField,
-      list: 'listNumber',
-      options: {}
-    } satisfies RadiosFieldComponent,
-
-    options: {
-      list: listNumber,
-      examples: listNumberExamples,
-      allow: [1, 2, 3, 4]
-    }
-  }
-])('RadiosField: $component.title', ({ component: def, options }) => {
-  const updated = structuredClone(definition)
-  updated.lists = [options.list]
-
-  let model: FormModel
-  let collection: ComponentCollection
-  let field: Field
-
-  beforeEach(() => {
-    model = new FormModel(updated, {
-      basePath: 'test'
-    })
-
-    collection = new ComponentCollection([def], { model })
-    field = collection.fields[0]
-  })
-
-  describe('Defaults', () => {
-    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: def.title
-            })
-          })
-        )
-      })
-
-      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: options.allow,
-            type: options.list.type
-          })
-        )
-      })
-
-      it.each([...options.allow])('accepts valid radio item', (value) => {
-        const result = collection.validate(getFormData(value))
-        expect(result.errors).toBeUndefined()
-      })
-
-      it('adds errors for empty value', () => {
-        const result = collection.validate(getFormData())
-
-        expect(result.errors).toEqual([
-          expect.objectContaining({
-            text: `Select ${def.title.toLowerCase()}`
-          })
-        ])
-      })
-
-      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' })
-        )
-
-        expect(result1.errors).toBeTruthy()
-        expect(result2.errors).toBeTruthy()
-      })
-    })
-
-    describe('State', () => {
-      it.each([...options.examples])('returns text from state', (item) => {
-        const state1 = getFormState(item.state)
-        const state2 = getFormState(null)
-
-        const answer1 = getAnswer(field, state1)
-        const answer2 = getAnswer(field, state2)
-
-        expect(answer1).toBe(item.text)
-        expect(answer2).toBe('')
-      })
-
-      it.each([...options.examples])('returns payload from state', (item) => {
-        const state1 = getFormState(item.state)
-        const state2 = getFormState(null)
-
-        const payload1 = field.getFormDataFromState(state1)
-        const payload2 = field.getFormDataFromState(state2)
-
-        expect(payload1).toEqual(getFormData(item.value))
-        expect(payload2).toEqual(getFormData())
-      })
-
-      it.each([...options.examples])('returns value from state', (item) => {
-        const state1 = getFormState(item.state)
-        const state2 = getFormState(null)
-
-        const value1 = field.getFormValueFromState(state1)
-        const value2 = field.getFormValueFromState(state2)
-
-        expect(value1).toEqual(item.value)
-        expect(value2).toBeUndefined()
-      })
-
-      it.each([...options.examples])(
-        'returns context for conditions and form submission',
-        (item) => {
-          const state1 = getFormState(item.state)
-          const state2 = getFormState(null)
-
-          const value1 = field.getContextValueFromState(state1)
-          const value2 = field.getContextValueFromState(state2)
-
-          expect(value1).toEqual(item.value)
-          expect(value2).toBeNull()
-        }
-      )
-
-      it.each([...options.examples])('returns state from payload', (item) => {
-        const payload1 = getFormData(item.value)
-        const payload2 = getFormData()
-
-        const value1 = field.getStateFromValidForm(payload1)
-        const value2 = field.getStateFromValidForm(payload2)
-
-        expect(value1).toEqual(getFormState(item.state))
-        expect(value2).toEqual(getFormState(null))
-      })
-    })
-
-    describe('View model', () => {
-      it('sets Nunjucks component defaults', () => {
-        const item = options.examples[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([...options.examples])(
-        '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('Radio items', () => {
-      it('returns radio items', () => {
-        expect(field).toHaveProperty('items', options.list.items)
-      })
-
-      it('returns radio items matching type', () => {
-        expect(field).toHaveProperty('values', expect.arrayContaining([]))
-      })
-
-      it('returns empty items when missing', () => {
-        const model = new FormModel(definition, {
-          basePath: 'test'
-        })
-
-        const { items } = new RadiosField(def, { model })
-        expect(items).toEqual([])
-      })
-    })
-  })
-})

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

@@ -1,24 +0,0 @@
-import { type RadiosFieldComponent } from '@defra/forms-model'
-
-import { SelectionControlField } from '~/src/server/plugins/engine/components/SelectionControlField.js'
-
-export class RadiosField extends SelectionControlField {
-  declare options: RadiosFieldComponent['options']
-
-  constructor(
-    def: RadiosFieldComponent,
-    props: ConstructorParameters<typeof SelectionControlField>[1]
-  ) {
-    super(def, props)
-
-    const { options } = def
-    let { formSchema } = this
-
-    if (options.required === false) {
-      formSchema = formSchema.optional()
-    }
-
-    this.formSchema = formSchema
-    this.options = options
-  }
-}