@defra/forms-model 3.0.161 → 3.0.162

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.161",
+  "version": "3.0.162",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "repository": {

package/src/conditions/inline-condition-model.ts

@@ -1,553 +0,0 @@
-import { ComponentTypes } from '~/src/components/component-types.js'
-import { getExpression } from '~/src/conditions/inline-condition-operators.js'
-import {
-  AbstractConditionValue,
-  valueFrom
-} from '~/src/conditions/inline-condition-values.js'
-
-export const coordinators = {
-  AND: 'and',
-  OR: 'or'
-}
-
-export class ConditionsModel {
-  #groupedConditions
-  #userGroupedConditions
-  #conditionName
-
-  constructor() {
-    this.#groupedConditions = []
-    this.#userGroupedConditions = []
-  }
-
-  clone() {
-    const toReturn = new ConditionsModel()
-    toReturn.#groupedConditions = this.#groupedConditions.map((it) =>
-      it.clone()
-    )
-    toReturn.#userGroupedConditions = this.#userGroupedConditions.map((it) =>
-      it.clone()
-    )
-    toReturn.#conditionName = this.#conditionName
-    return toReturn
-  }
-
-  clear() {
-    this.#userGroupedConditions = []
-    this.#groupedConditions = []
-    this.#conditionName = undefined
-    return this
-  }
-
-  set name(name) {
-    this.#conditionName = name
-  }
-
-  get name() {
-    return this.#conditionName
-  }
-
-  add(condition) {
-    const coordinatorExpected = this.#userGroupedConditions.length !== 0
-    if (condition.getCoordinator() && !coordinatorExpected) {
-      throw Error('No coordinator allowed on the first condition')
-    } else if (!condition.getCoordinator() && coordinatorExpected) {
-      throw Error('Coordinator must be present on subsequent conditions')
-    }
-    this.#userGroupedConditions.push(condition)
-    this.#groupedConditions = this._applyGroups(this.#userGroupedConditions)
-    return this
-  }
-
-  replace(index, condition) {
-    const coordinatorExpected = index !== 0
-    if (condition.getCoordinator() && !coordinatorExpected) {
-      throw Error('No coordinator allowed on the first condition')
-    } else if (!condition.getCoordinator() && coordinatorExpected) {
-      throw Error('Coordinator must be present on subsequent conditions')
-    } else if (index >= this.#userGroupedConditions.length) {
-      throw Error(
-        `Cannot replace condition ${index} as no such condition exists`
-      )
-    }
-    this.#userGroupedConditions.splice(index, 1, condition)
-    this.#groupedConditions = this._applyGroups(this.#userGroupedConditions)
-    return this
-  }
-
-  remove(indexes) {
-    this.#userGroupedConditions = this.#userGroupedConditions
-      .filter((_condition, index) => !indexes.includes(index))
-      .map((condition, index) =>
-        index === 0 ? condition.asFirstCondition() : condition
-      )
-
-    this.#groupedConditions = this._applyGroups(this.#userGroupedConditions)
-    return this
-  }
-
-  addGroups(groupDefs) {
-    this.#userGroupedConditions = this._group(
-      this.#userGroupedConditions,
-      groupDefs
-    )
-    this.#groupedConditions = this._applyGroups(this.#userGroupedConditions)
-    return this
-  }
-
-  splitGroup(index) {
-    this.#userGroupedConditions = this._ungroup(
-      this.#userGroupedConditions,
-      index
-    )
-    this.#groupedConditions = this._applyGroups(this.#userGroupedConditions)
-    return this
-  }
-
-  moveEarlier(index) {
-    if (index > 0 && index < this.#userGroupedConditions.length) {
-      this.#userGroupedConditions.splice(
-        index - 1,
-        0,
-        this.#userGroupedConditions.splice(index, 1)[0]
-      )
-      if (index === 1) {
-        this.switchCoordinators()
-      }
-      this.#groupedConditions = this._applyGroups(this.#userGroupedConditions)
-    }
-    return this
-  }
-
-  moveLater(index) {
-    if (index >= 0 && index < this.#userGroupedConditions.length - 1) {
-      this.#userGroupedConditions.splice(
-        index + 1,
-        0,
-        this.#userGroupedConditions.splice(index, 1)[0]
-      )
-      if (index === 0) {
-        this.switchCoordinators()
-      }
-      this.#groupedConditions = this._applyGroups(this.#userGroupedConditions)
-    }
-    return this
-  }
-
-  switchCoordinators() {
-    this.#userGroupedConditions[1].setCoordinator(
-      this.#userGroupedConditions[0].getCoordinator()
-    )
-    this.#userGroupedConditions[0].setCoordinator(undefined)
-  }
-
-  get asPerUserGroupings() {
-    return [...this.#userGroupedConditions]
-  }
-
-  get hasConditions() {
-    return this.#userGroupedConditions.length > 0
-  }
-
-  get lastIndex() {
-    return this.#userGroupedConditions.length - 1
-  }
-
-  toPresentationString() {
-    return this.#groupedConditions
-      .map((condition) => toPresentationString(condition))
-      .join(' ')
-  }
-
-  toExpression() {
-    return this.#groupedConditions
-      .map((condition) => toExpression(condition))
-      .join(' ')
-  }
-
-  _applyGroups(userGroupedConditions) {
-    const correctedUserGroups = userGroupedConditions.map((condition) =>
-      condition instanceof ConditionGroup && condition.conditions.length > 2
-        ? new ConditionGroup(
-            this._group(
-              condition.conditions,
-              this._autoGroupDefs(condition.conditions)
-            )
-          )
-        : condition
-    )
-    return this._group(
-      correctedUserGroups,
-      this._autoGroupDefs(correctedUserGroups)
-    )
-  }
-
-  _group(conditions, groupDefs) {
-    return conditions.reduce((groups, condition, index, conditions) => {
-      const groupDef = groupDefs.find((groupDef) => groupDef.contains(index))
-      if (groupDef) {
-        if (groupDef.startsWith(index)) {
-          const groupConditions = groupDef.applyTo(conditions)
-          groups.push(new ConditionGroup(groupConditions))
-        }
-      } else {
-        groups.push(condition)
-      }
-      return groups
-    }, [])
-  }
-
-  _ungroup(conditions, splitIndex) {
-    if (conditions[splitIndex].isGroup()) {
-      const copy = [...conditions]
-      copy.splice(
-        splitIndex,
-        1,
-        ...conditions[splitIndex].getGroupedConditions()
-      )
-      return copy
-    }
-    return conditions
-  }
-
-  _autoGroupDefs(conditions) {
-    const orPositions: number[] = []
-    conditions.forEach((condition, index) => {
-      if (condition.getCoordinator() === coordinators.OR) {
-        orPositions.push(index)
-      }
-    })
-    const hasAnd = !!conditions.find(
-      (condition) => condition.getCoordinator() === coordinators.AND
-    )
-    const hasOr = orPositions.length > 0
-    if (hasAnd && hasOr) {
-      let start = 0
-      const groupDefs: GroupDef[] = []
-      orPositions.forEach((position, index) => {
-        if (start < position - 1) {
-          groupDefs.push(new GroupDef(start, position - 1))
-        }
-        const thisIsTheLastOr = orPositions.length === index + 1
-        const thereAreMoreConditions = conditions.length - 1 > position
-        if (thisIsTheLastOr && thereAreMoreConditions) {
-          groupDefs.push(new GroupDef(position, conditions.length - 1))
-        }
-        start = position
-      })
-      return groupDefs
-    }
-    return []
-  }
-
-  toJSON() {
-    const name = this.#conditionName
-    const conditions = this.#userGroupedConditions
-    return {
-      name,
-      conditions: conditions.map((it) => it.clone())
-    }
-  }
-
-  static from(obj) {
-    if (obj instanceof ConditionsModel) {
-      return obj
-    }
-    const toReturn = new ConditionsModel()
-    toReturn.#conditionName = obj.name
-    toReturn.#userGroupedConditions = obj.conditions.map((it) =>
-      conditionFrom(it)
-    )
-    toReturn.#groupedConditions = toReturn._applyGroups(
-      toReturn.#userGroupedConditions
-    )
-    return toReturn
-  }
-}
-
-function conditionFrom(it) {
-  if (it.conditions) {
-    return new ConditionGroup(
-      it.conditions.map((condition) => conditionFrom(condition))
-    )
-  }
-  if (it.conditionName) {
-    return new ConditionRef(
-      it.conditionName,
-      it.conditionDisplayName,
-      it.coordinator
-    )
-  }
-  return new Condition(
-    Field.from(it.field),
-    it.operator,
-    valueFrom(it.value),
-    it.coordinator
-  )
-}
-
-export class GroupDef {
-  first
-  last
-
-  constructor(first, last) {
-    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) {
-    return this.first <= index && this.last >= index
-  }
-
-  startsWith(index) {
-    return this.first === index
-  }
-
-  applyTo(conditions) {
-    return [...conditions].splice(this.first, this.last - this.first + 1)
-  }
-}
-
-class ConditionGroup {
-  conditions
-
-  constructor(conditions) {
-    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) {
-    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())
-    )
-  }
-}
-
-export function toPresentationString(condition) {
-  return `${condition.coordinatorString()}${condition.conditionString()}`
-}
-
-export function toExpression(condition) {
-  return `${condition.coordinatorString()}${condition.conditionExpression()}`
-}
-
-export class Field {
-  name
-  type
-  display
-
-  constructor(name, type, display) {
-    if (!name || typeof name !== 'string') {
-      throw Error(`name ${name} is not valid`)
-    }
-    if (!ComponentTypes.find((componentType) => componentType.name === 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) {
-    return new Field(obj.name, obj.type, obj.display)
-  }
-}
-
-class AbstractCondition {
-  coordinator
-
-  constructor(coordinator) {
-    if (coordinator && !Object.values(coordinators).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) {
-    this.coordinator = coordinator
-  }
-
-  isGroup() {
-    return false
-  }
-
-  getGroupedConditions() {
-    return [this]
-  }
-
-  _asFirstCondition() {
-    delete this.coordinator
-  }
-
-  asFirstCondition() {
-    throw Error(
-      'Implement on the subclass (Why do we have to have this method here at all?!)'
-    )
-  }
-
-  clone() {
-    throw Error(
-      'Implement on the subclass (Why do we have to have this method here at all?!)'
-    )
-  }
-
-  conditionString() {
-    throw Error(
-      'Implement on the subclass (Why do we have to have this method here at all?!)'
-    )
-  }
-
-  conditionExpression() {
-    throw Error(
-      'Implement on the subclass (Why do we have to have this method here at all?!)'
-    )
-  }
-}
-
-export class Condition extends AbstractCondition {
-  field
-  operator
-  value
-
-  constructor(field, operator, value, coordinator) {
-    super(coordinator)
-    if (!(field instanceof Field)) {
-      throw Error(`field ${field} is not a valid Field object`)
-    }
-    if (typeof operator !== 'string') {
-      throw Error(`operator ${operator} is not a valid operator`)
-    }
-    if (!(value instanceof AbstractConditionValue)) {
-      throw Error(`value ${value} is not a valid value type`)
-    }
-    this.field = field
-    this.operator = operator
-    this.value = value
-  }
-
-  asFirstCondition() {
-    this._asFirstCondition()
-    return this
-  }
-
-  conditionString() {
-    return `'${this.field.display}' ${
-      this.operator
-    } '${this.value.toPresentationString()}'`
-  }
-
-  conditionExpression() {
-    return getExpression(
-      this.field.type,
-      this.field.name,
-      this.operator,
-      this.value
-    )
-  }
-
-  clone() {
-    return new Condition(
-      Field.from(this.field),
-      this.operator,
-      this.value.clone(),
-      this.coordinator
-    )
-  }
-}
-
-export class ConditionRef extends AbstractCondition {
-  conditionName
-  conditionDisplayName
-
-  constructor(conditionName, conditionDisplayName, coordinator) {
-    super(coordinator)
-    if (typeof conditionName !== 'string') {
-      throw Error(`condition name ${conditionName} is not valid`)
-    }
-    if (typeof conditionDisplayName !== 'string') {
-      throw Error(`condition display name ${conditionDisplayName} is not valid`)
-    }
-    this.conditionName = conditionName
-    this.conditionDisplayName = conditionDisplayName
-  }
-
-  asFirstCondition() {
-    this._asFirstCondition()
-    return this
-  }
-
-  conditionString() {
-    return `'${this.conditionDisplayName}'`
-  }
-
-  conditionExpression() {
-    return this.conditionName
-  }
-
-  clone() {
-    return new ConditionRef(
-      this.conditionName,
-      this.conditionDisplayName,
-      this.coordinator
-    )
-  }
-}

package/src/conditions/inline-condition-operators.ts

@@ -1,166 +0,0 @@
-import {
-  ConditionValue,
-  dateDirections,
-  dateTimeUnits,
-  dateUnits,
-  RelativeTimeValue,
-  timeUnits
-} from '~/src/conditions/inline-condition-values.js'
-
-const defaultOperators = {
-  is: inline('=='),
-  'is not': inline('!=')
-}
-
-function withDefaults(param) {
-  return Object.assign({}, param, defaultOperators)
-}
-
-const textBasedFieldCustomisations = {
-  'is longer than': lengthIs('>'),
-  'is shorter than': lengthIs('<'),
-  'has length': lengthIs('==')
-}
-
-const absoluteDateTimeOperators = {
-  is: absoluteDateTime('=='),
-  'is not': absoluteDateTime('!='),
-  'is before': absoluteDateTime('<'),
-  'is after': absoluteDateTime('>')
-}
-
-const relativeTimeOperators = (units) => ({
-  'is at least': relativeTime('<=', '>=', units),
-  'is at most': relativeTime('>=', '<=', units),
-  'is less than': relativeTime('>', '<', units),
-  'is more than': relativeTime('<', '>', units)
-})
-
-export const customOperators = {
-  CheckboxesField: {
-    contains: reverseInline('in'),
-    'does not contain': not(reverseInline('in'))
-  },
-  NumberField: withDefaults({
-    'is at least': inline('>='),
-    'is at most': inline('<='),
-    'is less than': inline('<'),
-    'is more than': inline('>')
-  }),
-  DateField: Object.assign(
-    {},
-    absoluteDateTimeOperators,
-    relativeTimeOperators(dateUnits)
-  ),
-  TimeField: Object.assign(
-    {},
-    absoluteDateTimeOperators,
-    relativeTimeOperators(timeUnits)
-  ),
-  DatePartsField: Object.assign(
-    {},
-    absoluteDateTimeOperators,
-    relativeTimeOperators(dateUnits)
-  ),
-  DateTimeField: Object.assign(
-    {},
-    absoluteDateTimeOperators,
-    relativeTimeOperators(dateTimeUnits)
-  ),
-  DateTimePartsField: Object.assign(
-    {},
-    absoluteDateTimeOperators,
-    relativeTimeOperators(dateTimeUnits)
-  ),
-  TextField: withDefaults(textBasedFieldCustomisations),
-  MultilineTextField: withDefaults(textBasedFieldCustomisations),
-  EmailAddressField: withDefaults(textBasedFieldCustomisations)
-}
-
-export function getOperatorNames(fieldType) {
-  return Object.keys(getConditionals(fieldType)).sort()
-}
-
-export function getExpression(fieldType, fieldName, operator, value) {
-  return getConditionals(fieldType)[operator].expression(
-    { type: fieldType, name: fieldName },
-    value
-  )
-}
-
-export function getOperatorConfig(fieldType, operator) {
-  return getConditionals(fieldType)[operator]
-}
-
-function getConditionals(fieldType) {
-  return customOperators[fieldType] || defaultOperators
-}
-
-function inline(operator) {
-  return {
-    expression: (field, value) =>
-      `${field.name} ${operator} ${formatValue(field.type, value.value)}`
-  }
-}
-
-function lengthIs(operator) {
-  return {
-    expression: (field, value) =>
-      `length(${field.name}) ${operator} ${value.value}`
-  }
-}
-
-function reverseInline(operator) {
-  return {
-    expression: (field, value) =>
-      `${formatValue(field.type, value.value)} ${operator} ${field.name}`
-  }
-}
-
-function not(operatorDefinition) {
-  return {
-    expression: (field, value) =>
-      `not (${operatorDefinition.expression(field, value)})`
-  }
-}
-
-function formatValue(fieldType, value) {
-  if (fieldType === 'NumberField' || fieldType === 'YesNoField') {
-    return value
-  }
-  return `'${value}'`
-}
-
-export const absoluteDateOrTimeOperatorNames = Object.keys(
-  absoluteDateTimeOperators
-)
-export const relativeDateOrTimeOperatorNames = Object.keys(
-  relativeTimeOperators(dateTimeUnits)
-)
-
-function absoluteDateTime(operator) {
-  return {
-    expression: (field, value) => {
-      if (value instanceof ConditionValue) {
-        return `${field.name} ${operator} '${value.toExpression()}'`
-      }
-      throw Error('only Value types are supported')
-    }
-  }
-}
-
-function relativeTime(pastOperator, futureOperator, units) {
-  return {
-    units,
-    expression: (field, value) => {
-      if (value instanceof RelativeTimeValue) {
-        const operator =
-          value.direction === dateDirections.PAST
-            ? pastOperator
-            : futureOperator
-        return `${field.name} ${operator} ${value.toExpression()}`
-      }
-      throw Error('time shift requires a TimeShiftValue')
-    }
-  }
-}

package/src/conditions/inline-condition-values.ts

@@ -1,153 +0,0 @@
-const conditionValueFactories = {}
-
-class Registration {
-  type
-
-  constructor(type, factory) {
-    conditionValueFactories[type] = factory
-    this.type = type
-  }
-}
-
-export class AbstractConditionValue {
-  type
-
-  constructor(registration) {
-    if (new.target === AbstractConditionValue) {
-      throw new TypeError('Cannot construct ConditionValue instances directly')
-    }
-    if (!(registration instanceof Registration)) {
-      throw new TypeError(
-        'You must register your value type! Call registerValueType!'
-      )
-    }
-    this.type = registration.type
-  }
-
-  toPresentationString() {}
-  toExpression() {}
-}
-
-const valueType = registerValueType('Value', (obj) => ConditionValue.from(obj))
-export class ConditionValue extends AbstractConditionValue {
-  value
-  display
-
-  constructor(value, display) {
-    super(valueType)
-    if (!value || typeof value !== 'string') {
-      throw Error(`value ${value} is not valid`)
-    }
-    if (display && typeof display !== 'string') {
-      throw Error(`display ${display} is not valid`)
-    }
-    this.value = value
-    this.display = display || value
-  }
-
-  toPresentationString() {
-    return this.display
-  }
-
-  toExpression() {
-    return this.value
-  }
-
-  static from(obj) {
-    return new ConditionValue(obj.value, obj.display)
-  }
-
-  clone() {
-    return ConditionValue.from(this)
-  }
-}
-
-export const dateDirections = {
-  FUTURE: 'in the future',
-  PAST: 'in the past'
-}
-
-export const dateUnits = {
-  YEARS: { display: 'year(s)', value: 'years' },
-  MONTHS: { display: 'month(s)', value: 'months' },
-  DAYS: { display: 'day(s)', value: 'days' }
-}
-export const timeUnits = {
-  HOURS: { display: 'hour(s)', value: 'hours' },
-  MINUTES: { display: 'minute(s)', value: 'minutes' },
-  SECONDS: { display: 'second(s)', value: 'seconds' }
-}
-export const dateTimeUnits = Object.assign({}, dateUnits, timeUnits)
-
-export const relativeTimeValueType = registerValueType('RelativeTime', (obj) =>
-  RelativeTimeValue.from(obj)
-)
-export class RelativeTimeValue extends AbstractConditionValue {
-  timePeriod
-  timeUnit
-  direction
-  timeOnly
-
-  constructor(timePeriod, timeUnit, direction, timeOnly = false) {
-    super(relativeTimeValueType)
-    if (typeof timePeriod !== 'string') {
-      throw Error(`time period ${timePeriod} is not valid`)
-    }
-    if (
-      !Object.values(dateTimeUnits)
-        .map((it) => it.value)
-        .includes(timeUnit)
-    ) {
-      throw Error(`time unit ${timeUnit} is not valid`)
-    }
-    if (!Object.values(dateDirections).includes(direction)) {
-      throw Error(`direction ${direction} is not valid`)
-    }
-    this.timePeriod = timePeriod
-    this.timeUnit = timeUnit
-    this.direction = direction
-    this.timeOnly = timeOnly
-  }
-
-  toPresentationString() {
-    return `${this.timePeriod} ${this.timeUnit} ${this.direction}`
-  }
-
-  toExpression() {
-    const timePeriod =
-      this.direction === dateDirections.PAST
-        ? 0 - Number(this.timePeriod)
-        : this.timePeriod
-    return this.timeOnly
-      ? `timeForComparison(${timePeriod}, '${this.timeUnit}')`
-      : `dateForComparison(${timePeriod}, '${this.timeUnit}')`
-  }
-
-  static from(obj) {
-    return new RelativeTimeValue(
-      obj.timePeriod,
-      obj.timeUnit,
-      obj.direction,
-      obj.timeOnly
-    )
-  }
-
-  clone() {
-    return RelativeTimeValue.from(this)
-  }
-}
-
-/**
- * All value types should call this, and should be located in this file.
- * Furthermore the types should be registered without the classes needing to be instantiated.
- *
- * Otherwise we can't guarantee they've been registered for deserialization before
- * valueFrom is called
- */
-function registerValueType(type, factory) {
-  return new Registration(type, factory)
-}
-
-export function valueFrom(obj) {
-  return conditionValueFactories[obj.type](obj)
-}