@defra/forms-model 3.0.2

package/src/components/types.ts

@@ -0,0 +1,362 @@
+export enum ComponentTypeEnum {
+  TextField = 'TextField',
+  MultilineTextField = 'MultilineTextField',
+  YesNoField = 'YesNoField',
+  DateField = 'DateField',
+  TimeField = 'TimeField',
+  DateTimeField = 'DateTimeField',
+  DatePartsField = 'DatePartsField',
+  MonthYearField = 'MonthYearField',
+  DateTimePartsField = 'DateTimePartsField',
+  SelectField = 'SelectField',
+  AutocompleteField = 'AutocompleteField',
+  RadiosField = 'RadiosField',
+  CheckboxesField = 'CheckboxesField',
+  NumberField = 'NumberField',
+  UkAddressField = 'UkAddressField',
+  TelephoneNumberField = 'TelephoneNumberField',
+  EmailAddressField = 'EmailAddressField',
+  FileUploadField = 'FileUploadField',
+  Para = 'Para',
+  Html = 'Html',
+  InsetText = 'InsetText',
+  Details = 'Details',
+  FlashCard = 'FlashCard',
+  List = 'List'
+}
+
+export type ComponentType =
+  | 'TextField'
+  | 'MultilineTextField'
+  | 'YesNoField'
+  | 'DateField'
+  | 'TimeField'
+  | 'DateTimeField'
+  | 'MonthYearField'
+  | 'DatePartsField'
+  | 'DateTimePartsField'
+  | 'SelectField'
+  | 'AutocompleteField'
+  | 'RadiosField'
+  | 'CheckboxesField'
+  | 'NumberField'
+  | 'UkAddressField'
+  | 'TelephoneNumberField'
+  | 'EmailAddressField'
+  | 'FileUploadField'
+  | 'Para'
+  | 'Html'
+  | 'InsetText'
+  | 'Details'
+  | 'FlashCard'
+  | 'List'
+  | 'WebsiteField'
+
+export type ComponentSubType = 'field' | 'content'
+
+export type ConditionalComponent = {
+  name: 'TextField' | 'NumberField'
+  title: string
+  subType: 'field'
+}
+
+export type ContentOptions = {
+  condition?: string
+}
+
+/**
+ * Types for Components JSON structure which are expected by engine and turned into actual form input/content/lists
+ */
+interface TextFieldBase {
+  subType?: 'field'
+  type: string
+  name: string
+  title: string
+  hint?: string
+  options: {
+    hideTitle?: boolean
+    required?: boolean
+    optionalText?: boolean
+    classes?: string
+    allow?: string
+    autocomplete?: string
+    exposeToContext?: boolean
+  }
+  schema: {
+    max?: number
+    min?: number
+    length?: number
+    regex?: string
+    error?: any // TODO: in same cases this is a function e.g. addressLine1 in ukaddress
+  }
+}
+
+interface NumberFieldBase {
+  subType?: 'field'
+  type: string
+  name: string
+  title: string
+  hint: string
+  options: {
+    prefix?: string
+    suffix?: string
+    exposeToContext?: boolean
+  }
+  schema: {
+    min?: number
+    max?: number
+    precision?: number
+  }
+}
+
+interface ListFieldBase {
+  subType?: 'listField' | 'content'
+  type: string
+  name: string
+  title: string
+  options: {
+    type?: string
+    hideTitle?: boolean
+    required?: boolean
+    optionalText?: boolean
+    classes?: string
+    bold?: boolean
+    exposeToContext?: boolean
+    allowPrePopulation?: boolean
+  }
+  list: string
+  schema: {}
+}
+
+interface ContentFieldBase {
+  subType?: 'content'
+  type: string
+  name: string
+  title: string
+  content: string
+  options: ContentOptions
+  schema: {}
+}
+
+interface DateFieldBase {
+  subType?: 'field'
+  type: string
+  name: string
+  title: string
+  hint: string
+  options: {
+    hideTitle?: boolean
+    required?: boolean
+    optionalText?: boolean
+    maxDaysInFuture?: number
+    maxDaysInPast?: number
+    exposeToContext?: boolean
+  }
+  schema: {}
+}
+
+// Text Fields
+export interface TextFieldComponent extends TextFieldBase {
+  type: 'TextField'
+  options: TextFieldBase['options'] & {
+    customValidationMessage?: string
+  }
+}
+
+export interface EmailAddressFieldComponent extends TextFieldBase {
+  type: 'EmailAddressField'
+}
+
+export interface NumberFieldComponent extends NumberFieldBase {
+  type: 'NumberField'
+}
+
+export interface WebsiteFieldComponent extends TextFieldBase {
+  type: 'WebsiteField'
+  options: TextFieldBase['options'] & {
+    customValidationMessage?: string
+  }
+}
+
+export interface MultilineTextFieldComponent {
+  type: 'MultilineTextField'
+}
+
+export interface TelephoneNumberFieldComponent extends TextFieldBase {
+  type: 'TelephoneNumberField'
+  options: TextFieldBase['options'] & {
+    customValidationMessage?: string
+  }
+}
+
+export interface YesNoFieldComponent extends TextFieldBase {
+  type: 'YesNoField'
+}
+
+export interface MultilineTextFieldComponent extends TextFieldBase {
+  type: 'MultilineTextField'
+  options: TextFieldBase['options'] & {
+    customValidationMessage?: string
+    rows?: number
+    maxWords?: number
+  }
+  schema: {
+    max?: number
+    min?: number
+  }
+}
+
+export interface FileUploadFieldComponent {
+  subType?: 'field'
+  type: 'FileUploadField'
+  name: string
+  title: string
+  hint: string
+  options: {
+    required?: boolean
+    hideTitle?: boolean
+    multiple?: boolean
+    classes?: string
+    exposeToContext?: boolean
+    imageQualityPlayback?: boolean
+  }
+  schema: {}
+}
+
+export interface UkAddressFieldComponent extends TextFieldBase {
+  type: 'UkAddressField'
+}
+
+// Date Fields
+export interface DateFieldComponent extends DateFieldBase {
+  type: 'DateField'
+}
+
+export interface DateTimeFieldComponent extends DateFieldBase {
+  type: 'DateTimeField'
+}
+
+export interface DatePartsFieldFieldComponent extends DateFieldBase {
+  type: 'DatePartsField'
+}
+
+export interface MonthYearFieldComponent extends DateFieldBase {
+  type: 'MonthYearField'
+}
+
+export interface DateTimePartsFieldComponent extends DateFieldBase {
+  type: 'DateTimePartsField'
+}
+
+export interface TimeFieldComponent extends DateFieldBase {
+  type: 'TimeField'
+}
+
+// Content Fields
+export interface ParaComponent extends ContentFieldBase {
+  type: 'Para'
+}
+
+export interface DetailsComponent extends ContentFieldBase {
+  type: 'Details'
+}
+
+export interface HtmlComponent extends ContentFieldBase {
+  type: 'Html'
+}
+
+export interface InsetTextComponent extends ContentFieldBase {
+  type: 'InsetText'
+}
+
+// List Fields
+export interface ListComponent extends ListFieldBase {
+  type: 'List'
+}
+
+export interface AutocompleteFieldComponent extends ListFieldBase {
+  type: 'AutocompleteField'
+  subType?: 'listField'
+}
+
+export interface CheckboxesFieldComponent extends ListFieldBase {
+  type: 'CheckboxesField'
+  subType?: 'listField'
+}
+
+export interface FlashCardComponent extends ListFieldBase {
+  type: 'FlashCard'
+}
+
+export interface RadiosFieldComponent extends ListFieldBase {
+  type: 'RadiosField'
+  subType?: 'listField'
+}
+
+export interface SelectFieldComponent extends ListFieldBase {
+  type: 'SelectField'
+  options: ListFieldBase['options'] & { autocomplete?: string }
+  subType?: 'listField'
+}
+
+export type ComponentDef =
+  | InsetTextComponent
+  | AutocompleteFieldComponent
+  | CheckboxesFieldComponent
+  | DateFieldComponent
+  | DatePartsFieldFieldComponent
+  | MonthYearFieldComponent
+  | DateTimeFieldComponent
+  | DateTimePartsFieldComponent
+  | DetailsComponent
+  | EmailAddressFieldComponent
+  | FileUploadFieldComponent
+  | FlashCardComponent
+  | HtmlComponent
+  | ListComponent
+  | MultilineTextFieldComponent
+  | NumberFieldComponent
+  | ParaComponent
+  | RadiosFieldComponent
+  | SelectFieldComponent
+  | TelephoneNumberFieldComponent
+  | TextFieldComponent
+  | TimeFieldComponent
+  | UkAddressFieldComponent
+  | YesNoFieldComponent
+  | WebsiteFieldComponent
+
+// Components that render inputs.
+export type InputFieldsComponentsDef =
+  | TextFieldComponent
+  | EmailAddressFieldComponent
+  | NumberFieldComponent
+  | MultilineTextFieldComponent
+  | TelephoneNumberFieldComponent
+  | YesNoFieldComponent
+  | FileUploadFieldComponent
+  | DateFieldComponent
+  | DateTimeFieldComponent
+  | DateTimePartsFieldComponent
+  | MonthYearFieldComponent
+  | TimeFieldComponent
+  | UkAddressFieldComponent
+  | WebsiteFieldComponent
+
+// Components that render content.
+export type ContentComponentsDef =
+  | ParaComponent
+  | DetailsComponent
+  | HtmlComponent
+  | InsetTextComponent
+  | ListComponent
+  | FlashCardComponent
+
+// Components that render Lists
+export type ListComponentsDef =
+  | ListComponent
+  | AutocompleteFieldComponent
+  | CheckboxesFieldComponent
+  | FlashCardComponent
+  | RadiosFieldComponent
+  | SelectFieldComponent

package/src/conditions/condition-abstract.ts

@@ -0,0 +1,59 @@
+import { Coordinator } from './types'
+
+export class ConditionAbstract {
+  coordinator: Coordinator | undefined
+
+  constructor(coordinator: Coordinator | undefined) {
+    if (coordinator && !Object.values(Coordinator).includes(coordinator)) {
+      throw Error(`coordinator ${coordinator} is not a valid coordinator`)
+    }
+
+    this.coordinator = coordinator
+  }
+
+  coordinatorString() {
+    return this.coordinator ? `${this.coordinator} ` : ''
+  }
+
+  getCoordinator() {
+    return this.coordinator
+  }
+
+  setCoordinator(coordinator: Coordinator | undefined) {
+    this.coordinator = coordinator
+  }
+
+  isGroup() {
+    return false
+  }
+
+  getGroupedConditions() {
+    return [this]
+  }
+
+  _asFirstCondition() {
+    delete this.coordinator
+  }
+
+  asFirstCondition() {
+    throw Error(
+      'Unsupported Operation. Method asFirstCondition have not been implemented'
+    )
+  }
+
+  clone() {
+    throw Error('Unsupported Operation. Method clone have not been implemented')
+  }
+
+  conditionString() {
+    throw Error(
+      'Unsupported Operation. Method conditionString have not been implemented'
+    )
+  }
+
+  conditionExpression() {
+    throw Error(
+      'Unsupported Operation. Method conditionExpression have not been implemented'
+    )
+  }
+}

package/src/conditions/condition-field.ts

@@ -0,0 +1,29 @@
+import { ComponentTypes, ComponentType } from '../components'
+
+export class ConditionField {
+  name: string
+  type: ComponentType
+  display: string
+
+  constructor(name: string, type: ComponentType, display: string) {
+    if (!name || typeof name !== 'string') {
+      throw Error(`name ${name} is not valid`)
+    }
+
+    if (!ComponentTypes.find((componentType) => componentType.type === type)) {
+      throw Error(`type ${type} is not valid`)
+    }
+
+    if (!display || typeof display !== 'string') {
+      throw Error(`display ${display} is not valid`)
+    }
+
+    this.name = name
+    this.type = type
+    this.display = display
+  }
+
+  static from(obj: { name: string; type: ComponentType; display: string }) {
+    return new ConditionField(obj.name, obj.type, obj.display)
+  }
+}

package/src/conditions/condition-group-def.ts

@@ -0,0 +1,29 @@
+import { ConditionsArray } from './types'
+
+export class ConditionGroupDef {
+  first: number
+  last: number
+
+  constructor(first: number, last: number) {
+    if (typeof first !== 'number' || typeof last !== 'number') {
+      throw Error(`Cannot construct a group from ${first} and ${last}`)
+    } else if (first >= last) {
+      throw Error(`Last (${last}) must be greater than first (${first})`)
+    }
+
+    this.first = first
+    this.last = last
+  }
+
+  contains(index: number) {
+    return this.first <= index && this.last >= index
+  }
+
+  startsWith(index: number) {
+    return this.first === index
+  }
+
+  applyTo(conditions: ConditionsArray) {
+    return [...conditions].splice(this.first, this.last - this.first + 1)
+  }
+}

package/src/conditions/condition-group.ts

@@ -0,0 +1,61 @@
+import { toPresentationString, toExpression } from './helpers'
+import { Coordinator, ConditionsArray } from './types'
+
+export class ConditionGroup {
+  conditions: ConditionsArray
+
+  constructor(conditions: ConditionsArray = []) {
+    if (!Array.isArray(conditions) || conditions.length < 2) {
+      throw Error('Cannot construct a condition group from a single condition')
+    }
+
+    this.conditions = conditions
+  }
+
+  coordinatorString() {
+    return this.conditions[0].coordinatorString()
+  }
+
+  conditionString() {
+    const copy = [...this.conditions]
+    copy.splice(0, 1)
+    return `(${this.conditions[0].conditionString()} ${copy
+      .map((condition) => toPresentationString(condition))
+      .join(' ')})`
+  }
+
+  conditionExpression() {
+    const copy = [...this.conditions]
+    copy.splice(0, 1)
+    return `(${this.conditions[0].conditionExpression()} ${copy
+      .map((condition) => toExpression(condition))
+      .join(' ')})`
+  }
+
+  asFirstCondition() {
+    this.conditions[0].asFirstCondition()
+    return this
+  }
+
+  getCoordinator() {
+    return this.conditions[0].getCoordinator()
+  }
+
+  setCoordinator(coordinator: Coordinator | undefined) {
+    this.conditions[0].setCoordinator(coordinator)
+  }
+
+  isGroup() {
+    return true
+  }
+
+  getGroupedConditions() {
+    return this.conditions.map((condition) => condition.clone())
+  }
+
+  clone() {
+    return new ConditionGroup(
+      this.conditions.map((condition) => condition.clone())
+    )
+  }
+}