@defra/forms-model 3.0.167 → 3.0.169

package/src/components/component-types.ts

@@ -1,209 +1,210 @@
+import { ComponentSubType, ComponentType } from '~/src/components/enums.js'
 import { type ComponentDef } from '~/src/components/types.js'
 
 export const ComponentTypes: ComponentDef[] = [
   {
     name: 'TextField',
-    type: 'TextField',
+    type: ComponentType.TextField,
     title: 'Text field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'MultilineTextField',
-    type: 'MultilineTextField',
+    type: ComponentType.MultilineTextField,
     title: 'Multiline text field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'YesNoField',
-    type: 'YesNoField',
+    type: ComponentType.YesNoField,
     title: 'Yes/No field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'DateField',
-    type: 'DateField',
+    type: ComponentType.DateField,
     title: 'Date field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'TimeField',
-    type: 'TimeField',
+    type: ComponentType.TimeField,
     title: 'Time field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'DateTimeField',
-    type: 'DateTimeField',
+    type: ComponentType.DateTimeField,
     title: 'Date time field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'DatePartsField',
-    type: 'DatePartsField',
+    type: ComponentType.DatePartsField,
     title: 'Date parts field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'DateTimePartsField',
-    type: 'DateTimePartsField',
+    type: ComponentType.DateTimePartsField,
     title: 'Date time parts field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'MonthYearField',
-    type: 'MonthYearField',
+    type: ComponentType.MonthYearField,
     title: 'Month year field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'SelectField',
-    type: 'SelectField',
+    type: ComponentType.SelectField,
     title: 'Select field',
-    subType: 'listField',
+    subType: ComponentSubType.ListField,
     options: {},
     schema: {},
     list: ''
   },
   {
     name: 'AutocompleteField',
-    type: 'AutocompleteField',
+    type: ComponentType.AutocompleteField,
     title: 'Autocomplete field',
-    subType: 'listField',
+    subType: ComponentSubType.ListField,
     options: {},
     schema: {},
     list: ''
   },
   {
     name: 'RadiosField',
-    type: 'RadiosField',
+    type: ComponentType.RadiosField,
     title: 'Radios field',
-    subType: 'listField',
+    subType: ComponentSubType.ListField,
     options: {},
     schema: {},
     list: ''
   },
   {
     name: 'CheckboxesField',
-    type: 'CheckboxesField',
+    type: ComponentType.CheckboxesField,
     title: 'Checkboxes field',
-    subType: 'listField',
+    subType: ComponentSubType.ListField,
     options: {},
     schema: {},
     list: ''
   },
   {
     name: 'NumberField',
-    type: 'NumberField',
+    type: ComponentType.NumberField,
     title: 'Number field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'UkAddressField',
-    type: 'UkAddressField',
+    type: ComponentType.UkAddressField,
     title: 'UK address field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'TelephoneNumberField',
-    type: 'TelephoneNumberField',
+    type: ComponentType.TelephoneNumberField,
     title: 'Telephone number field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'EmailAddressField',
-    type: 'EmailAddressField',
+    type: ComponentType.EmailAddressField,
     title: 'Email address field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'FileUploadField',
-    type: 'FileUploadField',
+    type: ComponentType.FileUploadField,
     title: 'File upload field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}
   },
   {
     name: 'Html',
-    type: 'Html',
+    type: ComponentType.Html,
     title: 'Html',
-    subType: 'content',
+    subType: ComponentSubType.Content,
     content: '',
     options: {},
     schema: {}
   },
   {
     name: 'InsetText',
-    type: 'InsetText',
+    type: ComponentType.InsetText,
     title: 'Inset text',
-    subType: 'content',
+    subType: ComponentSubType.Content,
     content: '',
     options: {},
     schema: {}
   },
   {
     name: 'Details',
-    type: 'Details',
+    type: ComponentType.Details,
     title: 'Details',
-    subType: 'content',
+    subType: ComponentSubType.Content,
     content: '',
     options: {},
     schema: {}
   },
   {
     name: 'List',
-    type: 'List',
+    type: ComponentType.List,
     title: 'List',
-    subType: 'content',
+    subType: ComponentSubType.Content,
     options: {},
     schema: {},
     list: ''
   },
   {
     name: 'WebsiteField',
-    type: 'WebsiteField',
+    type: ComponentType.WebsiteField,
     title: 'Website field',
-    subType: 'field',
+    subType: ComponentSubType.Field,
     hint: '',
     options: {},
     schema: {}

package/src/components/enums.ts

@@ -1,4 +1,4 @@
-export enum ComponentTypeEnum {
+export enum ComponentType {
   TextField = 'TextField',
   MultilineTextField = 'MultilineTextField',
   YesNoField = 'YesNoField',
@@ -20,5 +20,12 @@ export enum ComponentTypeEnum {
   Html = 'Html',
   InsetText = 'InsetText',
   Details = 'Details',
-  List = 'List'
+  List = 'List',
+  WebsiteField = 'WebsiteField'
+}
+
+export enum ComponentSubType {
+  Content = 'content',
+  Field = 'field',
+  ListField = 'listField'
 }

package/src/components/index.ts

@@ -1,3 +1,2 @@
 export { ComponentTypes } from '~/src/components/component-types.js'
-export { ConditionalComponentTypes } from '~/src/components/conditional-component-types.js'
-export { ComponentTypeEnum } from '~/src/components/enums.js'
+export { ComponentType, ComponentSubType } from '~/src/components/enums.js'

package/src/components/types.ts

@@ -1,34 +1,12 @@
-export type ComponentType =
-  | 'TextField'
-  | 'MultilineTextField'
-  | 'YesNoField'
-  | 'DateField'
-  | 'TimeField'
-  | 'DateTimeField'
-  | 'MonthYearField'
-  | 'DatePartsField'
-  | 'DateTimePartsField'
-  | 'SelectField'
-  | 'AutocompleteField'
-  | 'RadiosField'
-  | 'CheckboxesField'
-  | 'NumberField'
-  | 'UkAddressField'
-  | 'TelephoneNumberField'
-  | 'EmailAddressField'
-  | 'FileUploadField'
-  | 'Html'
-  | 'InsetText'
-  | 'Details'
-  | 'List'
-  | 'WebsiteField'
-
-export type ComponentSubType = 'field' | 'content'
+import {
+  type ComponentSubType,
+  type ComponentType
+} from '~/src/components/enums.js'
 
 export interface ConditionalComponent {
-  name: 'TextField' | 'NumberField'
+  name: string
   title: string
-  subType: 'field'
+  subType: ComponentSubType.Field
 }
 
 export interface ContentOptions {
@@ -39,8 +17,16 @@ export interface ContentOptions {
  * Types for Components JSON structure which are expected by engine and turned into actual form input/content/lists
  */
 interface TextFieldBase {
-  subType?: 'field'
-  type: string
+  type:
+    | ComponentType.EmailAddressField
+    | ComponentType.MultilineTextField
+    | ComponentType.NumberField
+    | ComponentType.TelephoneNumberField
+    | ComponentType.TextField
+    | ComponentType.UkAddressField
+    | ComponentType.WebsiteField
+    | ComponentType.YesNoField
+  subType?: ComponentSubType.Field
   name: string
   title: string
   hint?: string
@@ -58,13 +44,13 @@ interface TextFieldBase {
     min?: number
     length?: number
     regex?: string
-    error?: any // TODO: in same cases this is a function e.g. addressLine1 in ukaddress
+    error?: unknown
   }
 }
 
 interface NumberFieldBase {
-  subType?: 'field'
-  type: string
+  type: ComponentType
+  subType?: ComponentSubType.Field
   name: string
   title: string
   hint: string
@@ -81,8 +67,13 @@ interface NumberFieldBase {
 }
 
 interface ListFieldBase {
-  subType?: 'listField' | 'content'
-  type: string
+  type:
+    | ComponentType.AutocompleteField
+    | ComponentType.CheckboxesField
+    | ComponentType.List
+    | ComponentType.RadiosField
+    | ComponentType.SelectField
+  subType?: ComponentSubType.Content | ComponentSubType.ListField
   name: string
   title: string
   options: {
@@ -96,22 +87,28 @@ interface ListFieldBase {
     allowPrePopulation?: boolean
   }
   list: string
-  schema: {}
+  schema: object
 }
 
 interface ContentFieldBase {
-  subType?: 'content'
-  type: string
+  type: ComponentType.Details | ComponentType.Html | ComponentType.InsetText
+  subType?: ComponentSubType.Content
   name: string
   title: string
   content: string
   options: ContentOptions
-  schema: {}
+  schema?: object
 }
 
 interface DateFieldBase {
-  subType?: 'field'
-  type: string
+  type:
+    | ComponentType.DateField
+    | ComponentType.DatePartsField
+    | ComponentType.DateTimeField
+    | ComponentType.DateTimePartsField
+    | ComponentType.MonthYearField
+    | ComponentType.TimeField
+  subType?: ComponentSubType.Field
   name: string
   title: string
   hint: string
@@ -123,45 +120,45 @@ interface DateFieldBase {
     maxDaysInPast?: number
     exposeToContext?: boolean
   }
-  schema: {}
+  schema: object
 }
 
 // Text Fields
 export interface TextFieldComponent extends TextFieldBase {
-  type: 'TextField'
+  type: ComponentType.TextField
   options: TextFieldBase['options'] & {
     customValidationMessage?: string
   }
 }
 
 export interface EmailAddressFieldComponent extends TextFieldBase {
-  type: 'EmailAddressField'
+  type: ComponentType.EmailAddressField
 }
 
 export interface NumberFieldComponent extends NumberFieldBase {
-  type: 'NumberField'
+  type: ComponentType.NumberField
 }
 
 export interface WebsiteFieldComponent extends TextFieldBase {
-  type: 'WebsiteField'
+  type: ComponentType.WebsiteField
   options: TextFieldBase['options'] & {
     customValidationMessage?: string
   }
 }
 
 export interface TelephoneNumberFieldComponent extends TextFieldBase {
-  type: 'TelephoneNumberField'
+  type: ComponentType.TelephoneNumberField
   options: TextFieldBase['options'] & {
     customValidationMessage?: string
   }
 }
 
 export interface YesNoFieldComponent extends TextFieldBase {
-  type: 'YesNoField'
+  type: ComponentType.YesNoField
 }
 
 export interface MultilineTextFieldComponent extends TextFieldBase {
-  type: 'MultilineTextField'
+  type: ComponentType.MultilineTextField
   options: TextFieldBase['options'] & {
     customValidationMessage?: string
     rows?: number
@@ -174,8 +171,8 @@ export interface MultilineTextFieldComponent extends TextFieldBase {
 }
 
 export interface FileUploadFieldComponent {
-  subType?: 'field'
-  type: 'FileUploadField'
+  type: ComponentType.FileUploadField
+  subType?: ComponentSubType.Field
   name: string
   title: string
   hint: string
@@ -187,75 +184,75 @@ export interface FileUploadFieldComponent {
     exposeToContext?: boolean
     imageQualityPlayback?: boolean
   }
-  schema: {}
+  schema: object
 }
 
 export interface UkAddressFieldComponent extends TextFieldBase {
-  type: 'UkAddressField'
+  type: ComponentType.UkAddressField
 }
 
 // Date Fields
 export interface DateFieldComponent extends DateFieldBase {
-  type: 'DateField'
+  type: ComponentType.DateField
 }
 
 export interface DateTimeFieldComponent extends DateFieldBase {
-  type: 'DateTimeField'
+  type: ComponentType.DateTimeField
 }
 
 export interface DatePartsFieldFieldComponent extends DateFieldBase {
-  type: 'DatePartsField'
+  type: ComponentType.DatePartsField
 }
 
 export interface MonthYearFieldComponent extends DateFieldBase {
-  type: 'MonthYearField'
+  type: ComponentType.MonthYearField
 }
 
 export interface DateTimePartsFieldComponent extends DateFieldBase {
-  type: 'DateTimePartsField'
+  type: ComponentType.DateTimePartsField
 }
 
 export interface TimeFieldComponent extends DateFieldBase {
-  type: 'TimeField'
+  type: ComponentType.TimeField
 }
 
 // Content Fields
 export interface DetailsComponent extends ContentFieldBase {
-  type: 'Details'
+  type: ComponentType.Details
 }
 
 export interface HtmlComponent extends ContentFieldBase {
-  type: 'Html'
+  type: ComponentType.Html
 }
 
 export interface InsetTextComponent extends ContentFieldBase {
-  type: 'InsetText'
+  type: ComponentType.InsetText
 }
 
 // List Fields
 export interface ListComponent extends ListFieldBase {
-  type: 'List'
+  type: ComponentType.List
 }
 
 export interface AutocompleteFieldComponent extends ListFieldBase {
-  type: 'AutocompleteField'
-  subType?: 'listField'
+  type: ComponentType.AutocompleteField
+  subType?: ComponentSubType.ListField
 }
 
 export interface CheckboxesFieldComponent extends ListFieldBase {
-  type: 'CheckboxesField'
-  subType?: 'listField'
+  type: ComponentType.CheckboxesField
+  subType?: ComponentSubType.ListField
 }
 
 export interface RadiosFieldComponent extends ListFieldBase {
-  type: 'RadiosField'
-  subType?: 'listField'
+  type: ComponentType.RadiosField
+  subType?: ComponentSubType.ListField
 }
 
 export interface SelectFieldComponent extends ListFieldBase {
-  type: 'SelectField'
+  type: ComponentType.SelectField
+  subType?: ComponentSubType.ListField
   options: ListFieldBase['options'] & { autocomplete?: string }
-  subType?: 'listField'
 }
 
 export type ComponentDef =

package/src/conditions/condition-field.ts

@@ -1,5 +1,5 @@
 import { ComponentTypes } from '~/src/components/component-types.js'
-import { type ComponentType } from '~/src/components/types.js'
+import { type ComponentType } from '~/src/components/enums.js'
 
 export class ConditionField {
   name: string

package/src/conditions/condition-operators.ts

@@ -1,7 +1,5 @@
-import {
-  type ComponentType,
-  type ComponentDef
-} from '~/src/components/types.js'
+import { ComponentType } from '~/src/components/enums.js'
+import { type ComponentDef } from '~/src/components/types.js'
 import { type ConditionValueAbstract } from '~/src/conditions/condition-value-abstract.js'
 import {
   timeUnits,
@@ -44,44 +42,46 @@ const relativeTimeOperators = (units) => ({
 })
 
 export const customOperators = {
-  CheckboxesField: {
+  [ComponentType.CheckboxesField]: {
     contains: reverseInline('in'),
     'does not contain': not(reverseInline('in'))
   },
-  NumberField: withDefaults({
+  [ComponentType.NumberField]: withDefaults({
     'is at least': inline('>='),
     'is at most': inline('<='),
     'is less than': inline('<'),
     'is more than': inline('>')
   }),
-  DateField: Object.assign(
+  [ComponentType.DateField]: Object.assign(
     {},
     absoluteDateTimeOperators,
     relativeTimeOperators(dateUnits)
   ),
-  TimeField: Object.assign(
+  [ComponentType.TimeField]: Object.assign(
     {},
     absoluteDateTimeOperators,
     relativeTimeOperators(timeUnits)
   ),
-  DatePartsField: Object.assign(
+  [ComponentType.DatePartsField]: Object.assign(
     {},
     absoluteDateTimeOperators,
     relativeTimeOperators(dateUnits)
   ),
-  DateTimeField: Object.assign(
+  [ComponentType.DateTimeField]: Object.assign(
     {},
     absoluteDateTimeOperators,
     relativeTimeOperators(dateTimeUnits)
   ),
-  DateTimePartsField: Object.assign(
+  [ComponentType.DateTimePartsField]: Object.assign(
     {},
     absoluteDateTimeOperators,
     relativeTimeOperators(dateTimeUnits)
   ),
-  TextField: withDefaults(textBasedFieldCustomisations),
-  MultilineTextField: withDefaults(textBasedFieldCustomisations),
-  EmailAddressField: withDefaults(textBasedFieldCustomisations)
+  [ComponentType.TextField]: withDefaults(textBasedFieldCustomisations),
+  [ComponentType.MultilineTextField]: withDefaults(
+    textBasedFieldCustomisations
+  ),
+  [ComponentType.EmailAddressField]: withDefaults(textBasedFieldCustomisations)
 }
 
 export function getOperatorNames(fieldType) {
@@ -137,9 +137,13 @@ function not(operatorDefinition) {
 }
 
 function formatValue(fieldType: ComponentType, value) {
-  if (fieldType === 'NumberField' || fieldType === 'YesNoField') {
+  if (
+    fieldType === ComponentType.YesNoField ||
+    fieldType === ComponentType.NumberField
+  ) {
     return value
   }
+
   return `'${value}'`
 }
 

package/src/conditions/enums.ts

@@ -1,3 +1,8 @@
+export enum ConditionType {
+  Value = 'Value',
+  RelativeTime = 'RelativeTime'
+}
+
 export enum Coordinator {
   AND = 'and',
   OR = 'or'

package/src/conditions/index.ts

@@ -24,4 +24,4 @@ export { ConditionsModel } from '~/src/conditions/condition-model.js'
 export { ConditionGroupDef } from '~/src/conditions/condition-group-def.js'
 export { toExpression, toPresentationString } from '~/src/conditions/helpers.js'
 
-export { Coordinator } from '~/src/conditions/enums.js'
+export { ConditionType, Coordinator } from '~/src/conditions/enums.js'