@defra/forms-model 3.0.246 → 3.0.248

package/src/components/component-types.ts

@@ -29,14 +29,6 @@ export const ComponentTypes: ComponentDef[] = [
     options: {},
     schema: {}
   },
-  {
-    name: 'TimeField',
-    title: 'Time field',
-    type: ComponentType.TimeField,
-    hint: '',
-    options: {},
-    schema: {}
-  },
   {
     name: 'DatePartsField',
     title: 'Date field',

package/src/components/enums.ts

@@ -2,7 +2,6 @@ export enum ComponentType {
   TextField = 'TextField',
   MultilineTextField = 'MultilineTextField',
   YesNoField = 'YesNoField',
-  TimeField = 'TimeField',
   DatePartsField = 'DatePartsField',
   MonthYearField = 'MonthYearField',
   SelectField = 'SelectField',

package/src/components/helpers.ts

@@ -43,8 +43,8 @@ export function isConditionalType(
     ComponentType.EmailAddressField,
     ComponentType.MultilineTextField,
     ComponentType.NumberField,
+    ComponentType.SelectField,
     ComponentType.TextField,
-    ComponentType.TimeField,
     ComponentType.YesNoField
   ]
 
@@ -106,7 +106,6 @@ export function hasInputField(
     ComponentType.TelephoneNumberField,
     ComponentType.YesNoField,
     ComponentType.MonthYearField,
-    ComponentType.TimeField,
     ComponentType.DatePartsField,
     ComponentType.UkAddressField
   ]

package/src/components/types.ts

@@ -7,8 +7,8 @@ export type ConditionalComponentType =
   | ComponentType.EmailAddressField
   | ComponentType.MultilineTextField
   | ComponentType.NumberField
+  | ComponentType.SelectField
   | ComponentType.TextField
-  | ComponentType.TimeField
   | ComponentType.YesNoField
 
 /**
@@ -93,18 +93,15 @@ interface ContentFieldBase {
 }
 
 interface DateFieldBase {
-  type:
-    | ComponentType.DatePartsField
-    | ComponentType.MonthYearField
-    | ComponentType.TimeField
+  type: ComponentType.DatePartsField | ComponentType.MonthYearField
   name: string
   title: string
   hint?: string
   options: {
     required?: boolean
     optionalText?: boolean
-    maxDaysInFuture?: number
     maxDaysInPast?: number
+    maxDaysInFuture?: number
   }
   schema: object
 }
@@ -186,13 +183,6 @@ export interface MonthYearFieldComponent extends DateFieldBase {
   }
 }
 
-export interface TimeFieldComponent extends DateFieldBase {
-  type: ComponentType.TimeField
-  options: DateFieldBase['options'] & {
-    condition?: string
-  }
-}
-
 // Content Fields
 export interface DetailsComponent extends ContentFieldBase {
   type: ComponentType.Details
@@ -231,7 +221,10 @@ export interface RadiosFieldComponent extends ListFieldBase {
 
 export interface SelectFieldComponent extends ListFieldBase {
   type: ComponentType.SelectField
-  options: ListFieldBase['options'] & { autocomplete?: string }
+  options: ListFieldBase['options'] & {
+    autocomplete?: string
+    condition?: string
+  }
 }
 
 export type ComponentDef =
@@ -250,7 +243,6 @@ export type ComponentDef =
   | SelectFieldComponent
   | TelephoneNumberFieldComponent
   | TextFieldComponent
-  | TimeFieldComponent
   | UkAddressFieldComponent
   | YesNoFieldComponent
 
@@ -263,7 +255,6 @@ export type InputFieldsComponentsDef =
   | TelephoneNumberFieldComponent
   | YesNoFieldComponent
   | MonthYearFieldComponent
-  | TimeFieldComponent
   | DatePartsFieldFieldComponent
   | UkAddressFieldComponent
 
@@ -313,5 +304,4 @@ export type ConditionalComponentsDef =
   | MultilineTextFieldComponent
   | NumberFieldComponent
   | TextFieldComponent
-  | TimeFieldComponent
   | YesNoFieldComponent

package/src/conditions/condition-abstract.ts

@@ -1,9 +1,9 @@
 import { Coordinator } from '~/src/conditions/enums.js'
 
 export class ConditionAbstract {
-  coordinator: Coordinator | undefined
+  coordinator?: Coordinator
 
-  constructor(coordinator: Coordinator | undefined) {
+  constructor(coordinator?: Coordinator) {
     if (coordinator && !Object.values(Coordinator).includes(coordinator)) {
       throw Error(`coordinator ${coordinator} is not a valid coordinator`)
     }
@@ -11,15 +11,15 @@ export class ConditionAbstract {
     this.coordinator = coordinator
   }
 
-  coordinatorString() {
+  coordinatorString(): string {
     return this.coordinator ? `${this.coordinator} ` : ''
   }
 
-  getCoordinator() {
+  getCoordinator(): Coordinator | undefined {
     return this.coordinator
   }
 
-  setCoordinator(coordinator: Coordinator | undefined) {
+  setCoordinator(coordinator?: Coordinator) {
     this.coordinator = coordinator
   }
 

package/src/conditions/condition-field.ts

@@ -1,10 +1,12 @@
 import { type ComponentType } from '~/src/components/enums.js'
 import { isConditionalType } from '~/src/components/helpers.js'
+import { type ConditionalComponentType } from '~/src/components/types.js'
+import { type ConditionFieldData } from '~/src/conditions/types.js'
 
 export class ConditionField {
-  name
-  type
-  display
+  name: string
+  type: ConditionalComponentType
+  display: string
 
   constructor(name?: string, type?: ComponentType, display?: string) {
     if (!name || typeof name !== 'string') {
@@ -24,7 +26,7 @@ export class ConditionField {
     this.display = display
   }
 
-  static from(obj: { name: string; type: ComponentType; display: string }) {
+  static from(obj: ConditionField | ConditionFieldData) {
     return new ConditionField(obj.name, obj.type, obj.display)
   }
 }

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

@@ -1,10 +1,12 @@
-import { type ConditionsArray } from '~/src/conditions/types.js'
+import { type ConditionGroup } from '~/src/conditions/condition-group.js'
+import { type ConditionRef } from '~/src/conditions/condition-ref.js'
+import { type Condition } from '~/src/conditions/condition.js'
 
 export class ConditionGroupDef {
   first: number
   last: number
 
-  constructor(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) {
@@ -23,7 +25,9 @@ export class ConditionGroupDef {
     return this.first === index
   }
 
-  applyTo(conditions: ConditionsArray) {
+  applyTo(
+    conditions: (Condition | ConditionRef | ConditionGroup)[]
+  ): (Condition | ConditionRef | ConditionGroup)[] {
     return [...conditions].splice(this.first, this.last - this.first + 1)
   }
 }

package/src/conditions/condition-group.ts

@@ -1,11 +1,12 @@
+import { type ConditionRef } from '~/src/conditions/condition-ref.js'
+import { type Condition } from '~/src/conditions/condition.js'
 import { type Coordinator } from '~/src/conditions/enums.js'
 import { toPresentationString, toExpression } from '~/src/conditions/helpers.js'
-import { type ConditionsArray } from '~/src/conditions/types.js'
 
 export class ConditionGroup {
-  conditions: ConditionsArray
+  conditions: (Condition | ConditionRef | ConditionGroup)[]
 
-  constructor(conditions: ConditionsArray = []) {
+  constructor(conditions: (Condition | ConditionRef | ConditionGroup)[] = []) {
     if (!Array.isArray(conditions) || conditions.length < 2) {
       throw Error('Cannot construct a condition group from a single condition')
     }
@@ -13,11 +14,11 @@ export class ConditionGroup {
     this.conditions = conditions
   }
 
-  coordinatorString() {
+  coordinatorString(): string {
     return this.conditions[0].coordinatorString()
   }
 
-  conditionString() {
+  conditionString(): string {
     const copy = [...this.conditions]
     copy.splice(0, 1)
     return `(${this.conditions[0].conditionString()} ${copy
@@ -25,7 +26,7 @@ export class ConditionGroup {
       .join(' ')})`
   }
 
-  conditionExpression() {
+  conditionExpression(): string {
     const copy = [...this.conditions]
     copy.splice(0, 1)
     return `(${this.conditions[0].conditionExpression()} ${copy
@@ -38,11 +39,11 @@ export class ConditionGroup {
     return this
   }
 
-  getCoordinator() {
+  getCoordinator(): Coordinator | undefined {
     return this.conditions[0].getCoordinator()
   }
 
-  setCoordinator(coordinator: Coordinator | undefined) {
+  setCoordinator(coordinator?: Coordinator) {
     this.conditions[0].setCoordinator(coordinator)
   }
 
@@ -50,11 +51,11 @@ export class ConditionGroup {
     return true
   }
 
-  getGroupedConditions() {
+  getGroupedConditions(): (Condition | ConditionRef | ConditionGroup)[] {
     return this.conditions.map((condition) => condition.clone())
   }
 
-  clone() {
+  clone(): ConditionGroup {
     return new ConditionGroup(
       this.conditions.map((condition) => condition.clone())
     )

package/src/conditions/condition-model.ts

@@ -6,18 +6,16 @@ import { conditionValueFrom } from '~/src/conditions/condition-values.js'
 import { Condition } from '~/src/conditions/condition.js'
 import { Coordinator } from '~/src/conditions/enums.js'
 import { toPresentationString, toExpression } from '~/src/conditions/helpers.js'
-import { type ConditionsArray } from '~/src/conditions/types.js'
-
-type ConditionRawObject =
-  | ConditionsModel
-  | {
-      name: string
-      conditions: Condition[]
-    }
+import {
+  type ConditionData,
+  type ConditionGroupData,
+  type ConditionRefData,
+  type ConditionsModelData
+} from '~/src/conditions/types.js'
 
 export class ConditionsModel {
-  #groupedConditions: ConditionsArray = []
-  #userGroupedConditions: ConditionsArray = []
+  #groupedConditions: (Condition | ConditionRef | ConditionGroup)[] = []
+  #userGroupedConditions: (Condition | ConditionRef | ConditionGroup)[] = []
   #conditionName: string | undefined = undefined
 
   clone() {
@@ -47,7 +45,7 @@ export class ConditionsModel {
     return this.#conditionName
   }
 
-  add(condition: Condition) {
+  add(condition: Condition | ConditionRef) {
     const coordinatorExpected = this.#userGroupedConditions.length !== 0
 
     if (condition.getCoordinator() && !coordinatorExpected) {
@@ -144,7 +142,7 @@ export class ConditionsModel {
     this.#userGroupedConditions[1].setCoordinator(
       this.#userGroupedConditions[0].getCoordinator()
     )
-    this.#userGroupedConditions[0].setCoordinator(undefined)
+    this.#userGroupedConditions[0].setCoordinator()
   }
 
   get asPerUserGroupings() {
@@ -172,7 +170,7 @@ export class ConditionsModel {
   }
 
   _applyGroups(
-    userGroupedConditions: (Condition | ConditionGroup | ConditionRef)[]
+    userGroupedConditions: (Condition | ConditionRef | ConditionGroup)[]
   ) {
     const correctedUserGroups = userGroupedConditions.map((condition) =>
       condition instanceof ConditionGroup && condition.conditions.length > 2
@@ -191,8 +189,11 @@ export class ConditionsModel {
     )
   }
 
-  _group(conditions: ConditionsArray, groupDefs: ConditionGroupDef[]) {
-    return conditions.reduce<ConditionsArray>(
+  _group(
+    conditions: (Condition | ConditionRef | ConditionGroup)[],
+    groupDefs: ConditionGroupDef[]
+  ) {
+    return conditions.reduce<(Condition | ConditionRef | ConditionGroup)[]>(
       (groups, condition, index, conditions) => {
         const groupDef = groupDefs.find((groupDef) => groupDef.contains(index))
 
@@ -211,7 +212,10 @@ export class ConditionsModel {
     )
   }
 
-  _ungroup(conditions: ConditionsArray, splitIndex: number) {
+  _ungroup(
+    conditions: (Condition | ConditionRef | ConditionGroup)[],
+    splitIndex: number
+  ) {
     if (conditions[splitIndex].isGroup()) {
       const copy = [...conditions]
       copy.splice(
@@ -224,7 +228,7 @@ export class ConditionsModel {
     return conditions
   }
 
-  _autoGroupDefs(conditions: ConditionsArray) {
+  _autoGroupDefs(conditions: (Condition | ConditionRef | ConditionGroup)[]) {
     const orPositions: number[] = []
 
     conditions.forEach((condition, index) => {
@@ -258,17 +262,17 @@ export class ConditionsModel {
     return []
   }
 
-  toJSON() {
+  toJSON(): ConditionsModelData {
     const name = this.#conditionName
     const conditions = this.#userGroupedConditions
     return {
-      name,
+      name: name ?? '',
       conditions: conditions.map((it) => it.clone())
     }
   }
 
   // TODO:- why is this not a constructor?
-  static from(obj: ConditionRawObject | ConditionsModel) {
+  static from(obj: ConditionsModel | ConditionsModelData) {
     if (obj instanceof ConditionsModel) {
       return obj
     }
@@ -284,11 +288,9 @@ export class ConditionsModel {
   }
 }
 
-type ConditionFrom = (
-  it: Condition | ConditionRef | ConditionGroup
-) => Condition | ConditionRef | ConditionGroup
-
-const conditionFrom: ConditionFrom = function (it) {
+function conditionFrom(
+  it: ConditionData | ConditionRefData | ConditionGroupData
+): Condition | ConditionRef | ConditionGroup {
   if ('conditions' in it) {
     return new ConditionGroup(
       it.conditions.map((condition) => conditionFrom(condition))

package/src/conditions/condition-operators.ts

@@ -3,11 +3,8 @@ import { isConditionalType } from '../components/helpers.js'
 import { ComponentType } from '~/src/components/enums.js'
 import { type ComponentDef } from '~/src/components/types.js'
 import {
-  timeUnits,
-  dateUnits,
-  dateTimeUnits,
   ConditionValue,
-  RelativeTimeValue
+  RelativeDateValue
 } from '~/src/conditions/condition-values.js'
 import {
   DateDirections,
@@ -16,9 +13,7 @@ import {
 } from '~/src/conditions/enums.js'
 import {
   type Conditionals,
-  type DateUnits,
-  type OperatorDefinition,
-  type TimeUnits
+  type OperatorDefinition
 } from '~/src/conditions/types.js'
 
 const defaultOperators = {
@@ -36,35 +31,25 @@ const textFieldOperators = {
   [OperatorName.HasLength]: lengthIs(Operator.Is)
 }
 
-const absoluteDateTimeOperators = {
-  [OperatorName.Is]: absoluteDateTime(Operator.Is),
-  [OperatorName.IsNot]: absoluteDateTime(Operator.IsNot),
-  [OperatorName.IsBefore]: absoluteDateTime(Operator.IsLessThan),
-  [OperatorName.IsAfter]: absoluteDateTime(Operator.IsMoreThan)
+const absoluteDateOperators = {
+  [OperatorName.Is]: absoluteDate(Operator.Is),
+  [OperatorName.IsNot]: absoluteDate(Operator.IsNot),
+  [OperatorName.IsBefore]: absoluteDate(Operator.IsLessThan),
+  [OperatorName.IsAfter]: absoluteDate(Operator.IsMoreThan)
 }
 
-const relativeTimeOperators = (units: DateUnits | TimeUnits) => ({
-  [OperatorName.IsAtLeast]: relativeTime(
-    Operator.IsAtMost,
-    Operator.IsAtLeast,
-    units
-  ),
-  [OperatorName.IsAtMost]: relativeTime(
-    Operator.IsAtLeast,
-    Operator.IsAtMost,
-    units
-  ),
-  [OperatorName.IsLessThan]: relativeTime(
+const relativeDateOperators = {
+  [OperatorName.IsAtLeast]: relativeDate(Operator.IsAtMost, Operator.IsAtLeast),
+  [OperatorName.IsAtMost]: relativeDate(Operator.IsAtLeast, Operator.IsAtMost),
+  [OperatorName.IsLessThan]: relativeDate(
     Operator.IsMoreThan,
-    Operator.IsLessThan,
-    units
+    Operator.IsLessThan
   ),
-  [OperatorName.IsMoreThan]: relativeTime(
+  [OperatorName.IsMoreThan]: relativeDate(
     Operator.IsLessThan,
-    Operator.IsMoreThan,
-    units
+    Operator.IsMoreThan
   )
-})
+}
 
 export const customOperators = {
   [ComponentType.RadiosField]: defaultOperators,
@@ -78,17 +63,14 @@ export const customOperators = {
     [OperatorName.IsLessThan]: inline(Operator.IsLessThan),
     [OperatorName.IsMoreThan]: inline(Operator.IsMoreThan)
   }),
-  [ComponentType.TimeField]: {
-    ...absoluteDateTimeOperators,
-    ...relativeTimeOperators(timeUnits)
-  },
   [ComponentType.DatePartsField]: {
-    ...absoluteDateTimeOperators,
-    ...relativeTimeOperators(dateUnits)
+    ...absoluteDateOperators,
+    ...relativeDateOperators
   },
   [ComponentType.TextField]: withDefaults(textFieldOperators),
   [ComponentType.MultilineTextField]: withDefaults(textFieldOperators),
   [ComponentType.EmailAddressField]: withDefaults(textFieldOperators),
+  [ComponentType.SelectField]: defaultOperators,
   [ComponentType.YesNoField]: defaultOperators
 }
 
@@ -105,7 +87,7 @@ export function getExpression(
   fieldType: ComponentType,
   fieldName: string,
   operator: OperatorName,
-  value: ConditionValue | RelativeTimeValue
+  value: ConditionValue | RelativeDateValue
 ) {
   const conditionals = getConditionals(fieldType)
   if (!conditionals) {
@@ -171,7 +153,7 @@ function not(operatorDefinition: OperatorDefinition): OperatorDefinition {
 
 function formatValue(
   field: Pick<ComponentDef, 'type'>,
-  value: ConditionValue | RelativeTimeValue
+  value: ConditionValue | RelativeDateValue
 ) {
   if (
     'value' in value &&
@@ -184,15 +166,15 @@ function formatValue(
   return `'${value.toExpression()}'`
 }
 
-export const absoluteDateOrTimeOperatorNames = Object.keys(
-  absoluteDateTimeOperators
+export const absoluteDateOperatorNames = Object.keys(
+  absoluteDateOperators
 ) as OperatorName[]
 
-export const relativeDateOrTimeOperatorNames = Object.keys(
-  relativeTimeOperators(dateTimeUnits)
+export const relativeDateOperatorNames = Object.keys(
+  relativeDateOperators
 ) as OperatorName[]
 
-function absoluteDateTime(operator: Operator): OperatorDefinition {
+function absoluteDate(operator: Operator): OperatorDefinition {
   return {
     expression(field, value) {
       if (!(value instanceof ConditionValue)) {
@@ -206,17 +188,15 @@ function absoluteDateTime(operator: Operator): OperatorDefinition {
   }
 }
 
-function relativeTime(
+function relativeDate(
   pastOperator: Operator,
-  futureOperator: Operator,
-  units: DateUnits | TimeUnits
+  futureOperator: Operator
 ): OperatorDefinition {
   return {
-    units,
     expression(field, value) {
-      if (!(value instanceof RelativeTimeValue)) {
+      if (!(value instanceof RelativeDateValue)) {
         throw new Error(
-          "Expression param 'value' must be RelativeTimeValue instance"
+          "Expression param 'value' must be RelativeDateValue instance"
         )
       }
 

package/src/conditions/condition-ref.ts

@@ -2,13 +2,13 @@ import { ConditionAbstract } from '~/src/conditions/condition-abstract.js'
 import { type Coordinator } from '~/src/conditions/enums.js'
 
 export class ConditionRef extends ConditionAbstract {
-  conditionName
-  conditionDisplayName
+  conditionName: string
+  conditionDisplayName: string
 
   constructor(
     conditionName: string,
     conditionDisplayName: string,
-    coordinator: Coordinator | undefined
+    coordinator?: Coordinator
   ) {
     super(coordinator)