@defra/forms-model 3.0.253 → 3.0.255

package/src/conditions/condition-operators.ts

@@ -6,7 +6,9 @@ import {
   ConditionValue,
   RelativeDateValue
 } from '~/src/conditions/condition-values.js'
+import { type Condition } from '~/src/conditions/condition.js'
 import {
+  ConditionType,
   DateDirections,
   Operator,
   OperatorName
@@ -21,8 +23,8 @@ const defaultOperators = {
   [OperatorName.IsNot]: inline(Operator.IsNot)
 }
 
-function withDefaults<T>(param: T) {
-  return Object.assign({}, param, defaultOperators)
+function withDefaults<T>(operators: T) {
+  return { ...defaultOperators, ...operators }
 }
 
 const textFieldOperators = {
@@ -80,14 +82,14 @@ export function getOperatorNames(fieldType?: ComponentType) {
     return []
   }
 
-  return Object.keys(conditionals).sort()
+  return Object.keys(conditionals) as OperatorName[]
 }
 
 export function getExpression(
   fieldType: ComponentType,
   fieldName: string,
   operator: OperatorName,
-  value: ConditionValue | RelativeDateValue
+  value: Condition['value']
 ) {
   const conditionals = getConditionals(fieldType)
   if (!conditionals) {
@@ -153,14 +155,15 @@ function not(operatorDefinition: OperatorDefinition): OperatorDefinition {
 
 function formatValue(
   field: Pick<ComponentDef, 'type'>,
-  value: ConditionValue | RelativeDateValue
+  value: Condition['value']
 ) {
   if (
-    'value' in value &&
-    (field.type === ComponentType.YesNoField ||
-      field.type === ComponentType.NumberField)
+    (field.type === ComponentType.DatePartsField &&
+      value.type === ConditionType.RelativeDate) ||
+    field.type === ComponentType.NumberField ||
+    field.type === ComponentType.YesNoField
   ) {
-    return value.value
+    return value.toExpression()
   }
 
   return `'${value.toExpression()}'`
@@ -183,7 +186,7 @@ function absoluteDate(operator: Operator): OperatorDefinition {
         )
       }
 
-      return `${field.name} ${operator} '${formatValue(field, value)}'`
+      return `${field.name} ${operator} ${formatValue(field, value)}`
     }
   }
 }
@@ -201,7 +204,7 @@ function relativeDate(
       }
 
       const isPast = value.direction === DateDirections.PAST
-      return `${field.name} ${isPast ? pastOperator : futureOperator} ${value.toExpression()}`
+      return `${field.name} ${isPast ? pastOperator : futureOperator} ${formatValue(field, value)}`
     }
   }
 }

package/src/conditions/condition-ref.ts

@@ -1,5 +1,6 @@
 import { ConditionAbstract } from '~/src/conditions/condition-abstract.js'
 import { type Coordinator } from '~/src/conditions/enums.js'
+import { type ConditionRefData } from '~/src/conditions/types.js'
 
 export class ConditionRef extends ConditionAbstract {
   conditionName: string
@@ -40,10 +41,18 @@ export class ConditionRef extends ConditionAbstract {
   }
 
   clone() {
+    return ConditionRef.from(this)
+  }
+
+  toJSON(): ConditionRefData {
+    return structuredClone(this.clone())
+  }
+
+  static from(obj: ConditionRefData | ConditionRef) {
     return new ConditionRef(
-      this.conditionName,
-      this.conditionDisplayName,
-      this.coordinator
+      obj.conditionName,
+      obj.conditionDisplayName,
+      obj.coordinator
     )
   }
 }

package/src/conditions/condition-values.ts

@@ -12,7 +12,7 @@ export class ConditionValue extends ConditionValueAbstract {
   display: string
 
   constructor(value: string, display?: string) {
-    if (!value || typeof value !== 'string') {
+    if (typeof value !== 'string') {
       throw new Error("ConditionValue param 'value' must be a string")
     }
 
@@ -35,13 +35,17 @@ export class ConditionValue extends ConditionValueAbstract {
     return this.value
   }
 
-  static from(obj: ConditionValue | ConditionValueData) {
-    return new ConditionValue(obj.value, obj.display)
-  }
-
   clone() {
     return ConditionValue.from(this)
   }
+
+  toJSON(): ConditionValueData {
+    return structuredClone(this.clone())
+  }
+
+  static from(obj: ConditionValue | ConditionValueData) {
+    return new ConditionValue(obj.value, obj.display)
+  }
 }
 
 export class RelativeDateValue extends ConditionValueAbstract {
@@ -82,13 +86,17 @@ export class RelativeDateValue extends ConditionValueAbstract {
     return `dateForComparison(${period}, '${this.unit}')`
   }
 
-  static from(obj: RelativeDateValue | RelativeDateValueData) {
-    return new RelativeDateValue(obj.period, obj.unit, obj.direction)
-  }
-
   clone() {
     return RelativeDateValue.from(this)
   }
+
+  toJSON(): RelativeDateValueData {
+    return structuredClone(this.clone())
+  }
+
+  static from(obj: RelativeDateValue | RelativeDateValueData) {
+    return new RelativeDateValue(obj.period, obj.unit, obj.direction)
+  }
 }
 
 export function conditionValueFrom(
@@ -98,6 +106,10 @@ export function conditionValueFrom(
     | RelativeDateValue
     | RelativeDateValueData
 ) {
+  if ('clone' in obj) {
+    return obj.clone()
+  }
+
   switch (obj.type) {
     case ConditionType.Value:
       return ConditionValue.from(obj)

package/src/conditions/condition.ts

@@ -3,10 +3,12 @@ import { ConditionField } from '~/src/conditions/condition-field.js'
 import { getExpression } from '~/src/conditions/condition-operators.js'
 import { ConditionValueAbstract } from '~/src/conditions/condition-value-abstract.js'
 import {
+  conditionValueFrom,
   type ConditionValue,
   type RelativeDateValue
 } from '~/src/conditions/condition-values.js'
 import { type Coordinator, type OperatorName } from '~/src/conditions/enums.js'
+import { type ConditionData } from '~/src/conditions/types.js'
 
 export class Condition extends ConditionAbstract {
   field: ConditionField
@@ -59,11 +61,19 @@ export class Condition extends ConditionAbstract {
   }
 
   clone() {
+    return Condition.from(this)
+  }
+
+  toJSON(): ConditionData {
+    return structuredClone(this.clone())
+  }
+
+  static from(obj: ConditionData | Condition) {
     return new Condition(
-      ConditionField.from(this.field),
-      this.operator,
-      this.value.clone(),
-      this.coordinator
+      ConditionField.from(obj.field),
+      obj.operator,
+      conditionValueFrom(obj.value),
+      obj.coordinator
     )
   }
 }

package/src/conditions/helpers.ts

@@ -1,6 +1,12 @@
 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'
+import {
+  type ConditionData,
+  type ConditionGroupData,
+  type ConditionRefData
+} from '~/src/conditions/types.js'
+import { type ConditionWrapper } from '~/src/form/form-definition/types.js'
 
 export function toPresentationString(
   condition: Condition | ConditionRef | ConditionGroup
@@ -13,3 +19,32 @@ export function toExpression(
 ) {
   return `${condition.coordinatorString()}${condition.conditionExpression()}`
 }
+
+export const hasConditionField = (
+  condition?: ConditionGroupData | ConditionData | ConditionRefData
+): condition is ConditionData => {
+  return !!condition && 'field' in condition
+}
+
+export const hasConditionGroup = (
+  condition?: ConditionGroupData | ConditionData | ConditionRefData
+): condition is ConditionGroupData => {
+  return !!condition && 'conditions' in condition
+}
+
+export const hasConditionName = (
+  condition?: ConditionGroupData | ConditionData | ConditionRefData
+): condition is ConditionRefData => {
+  return !!condition && 'conditionName' in condition
+}
+
+export const hasNestedCondition = (condition?: ConditionWrapper) => {
+  return !!condition?.value.conditions.some(hasConditionName)
+}
+
+export const isDuplicateCondition = (
+  conditions: ConditionWrapper[],
+  conditionName: string
+) => {
+  return conditions.some((condition) => condition.name === conditionName)
+}

package/src/conditions/index.ts

@@ -1,6 +1,5 @@
 export {
   getExpression,
-  getOperatorConfig,
   getOperatorNames,
   absoluteDateOperatorNames,
   relativeDateOperatorNames
@@ -18,7 +17,15 @@ export { ConditionRef } from '~/src/conditions/condition-ref.js'
 export { ConditionGroup } from '~/src/conditions/condition-group.js'
 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 {
+  hasConditionField,
+  hasConditionGroup,
+  hasConditionName,
+  hasNestedCondition,
+  isDuplicateCondition,
+  toExpression,
+  toPresentationString
+} from '~/src/conditions/helpers.js'
 
 export {
   ConditionType,

package/src/conditions/types.ts

@@ -2,10 +2,7 @@ import {
   type ComponentDef,
   type ConditionalComponentType
 } from '~/src/components/types.js'
-import {
-  type ConditionValue,
-  type RelativeDateValue
-} from '~/src/conditions/condition-values.js'
+import { type Condition } from '~/src/conditions/condition.js'
 import {
   type ConditionType,
   type Coordinator,
@@ -57,7 +54,7 @@ export interface ConditionsModelData extends ConditionGroupData {
 export interface OperatorDefinition {
   expression: (
     component: Pick<ComponentDef, 'type' | 'name'>,
-    conditionValue: ConditionValue | RelativeDateValue
+    conditionValue: Condition['value']
   ) => string
 }