@defra/forms-model 3.0.178 → 3.0.180

package/src/components/helpers.ts

@@ -0,0 +1,138 @@
+import { ComponentType } from '~/src/components/enums.js'
+import {
+  type InputFieldsComponentsDef,
+  type ComponentDef,
+  type ConditionalComponentsDef,
+  type ContentComponentsDef,
+  type HtmlComponent,
+  type InsetTextComponent,
+  type ListComponentsDef,
+  type SelectionComponentsDef,
+  type EditorComponentsDef
+} from '~/src/components/types.js'
+
+/**
+ * Filter known components with support for conditions
+ */
+export function hasConditionSupport(
+  component?: Partial<ComponentDef>
+): component is ConditionalComponentsDef {
+  const allowedTypes = [
+    ComponentType.CheckboxesField,
+    ComponentType.DatePartsField,
+    ComponentType.EmailAddressField,
+    ComponentType.MultilineTextField,
+    ComponentType.NumberField,
+    ComponentType.TextField,
+    ComponentType.TimeField,
+    ComponentType.YesNoField
+  ]
+
+  return !!component?.type && allowedTypes.includes(component.type)
+}
+
+/**
+ * Filter known components with content fields
+ */
+export function hasContentField(
+  component?: Partial<ComponentDef>
+): component is ContentComponentsDef {
+  const allowedTypes = [
+    ComponentType.Details,
+    ComponentType.Html,
+    ComponentType.InsetText,
+    ComponentType.List
+  ]
+
+  return !!component?.type && allowedTypes.includes(component.type)
+}
+
+/**
+ * Filter known components with text editor
+ */
+export function hasEditor(
+  component?: Partial<ComponentDef>
+): component is EditorComponentsDef {
+  const allowedTypes = [
+    ComponentType.TextField,
+    ComponentType.EmailAddressField,
+    ComponentType.TelephoneNumberField,
+    ComponentType.MultilineTextField,
+    ComponentType.NumberField,
+    ComponentType.AutocompleteField,
+    ComponentType.SelectField,
+    ComponentType.RadiosField,
+    ComponentType.CheckboxesField,
+    ComponentType.List,
+    ComponentType.Details,
+    ComponentType.Html,
+    ComponentType.InsetText,
+    ComponentType.DatePartsField
+  ]
+
+  return !!component?.type && allowedTypes.includes(component.type)
+}
+
+/**
+ * Filter known components with input fields
+ */
+export function hasInputField(
+  component?: Partial<ComponentDef>
+): component is InputFieldsComponentsDef {
+  const allowedTypes = [
+    ComponentType.TextField,
+    ComponentType.EmailAddressField,
+    ComponentType.NumberField,
+    ComponentType.MultilineTextField,
+    ComponentType.TelephoneNumberField,
+    ComponentType.YesNoField,
+    ComponentType.MonthYearField,
+    ComponentType.TimeField,
+    ComponentType.UkAddressField
+  ]
+
+  return !!component?.type && allowedTypes.includes(component.type)
+}
+
+/**
+ * Filter known components with lists
+ */
+export function hasListField(
+  component?: Partial<ComponentDef>
+): component is ListComponentsDef {
+  const allowedTypes = [
+    ComponentType.AutocompleteField,
+    ComponentType.List,
+    ComponentType.RadiosField,
+    ComponentType.SelectField,
+    ComponentType.CheckboxesField
+  ]
+
+  return !!component?.type && allowedTypes.includes(component.type)
+}
+
+/**
+ * Filter known components with selection fields
+ */
+export function hasSelectionFields(
+  component?: Partial<ComponentDef>
+): component is SelectionComponentsDef {
+  const allowedTypes = [
+    ComponentType.CheckboxesField,
+    ComponentType.RadiosField,
+    ComponentType.SelectField,
+    ComponentType.YesNoField
+  ]
+
+  return !!component?.type && allowedTypes.includes(component.type)
+}
+
+/**
+ * Filter known components with titles
+ */
+export function hasTitle(
+  component?: Partial<ComponentDef>
+): component is Exclude<ComponentDef, InsetTextComponent | HtmlComponent> {
+  const deniedTypes = [ComponentType.InsetText, ComponentType.Html]
+  return !!component?.type && !deniedTypes.includes(component.type)
+}

package/src/components/index.ts

@@ -1,2 +1,15 @@
-export { ComponentTypes } from '~/src/components/component-types.js'
+export {
+  ComponentTypes,
+  ConditionalComponentTypes
+} from '~/src/components/component-types.js'
+export {
+  hasConditionSupport,
+  hasContentField,
+  hasEditor,
+  hasInputField,
+  hasListField,
+  hasSelectionFields,
+  hasTitle
+} from '~/src/components/helpers.js'
+
 export { ComponentType, ComponentSubType } from '~/src/components/enums.js'

package/src/components/types.ts

@@ -3,11 +3,17 @@ import {
   type ComponentType
 } from '~/src/components/enums.js'
 
-export interface ConditionalComponent {
-  name: string
-  title: string
-  subType: ComponentSubType.Field
-}
+export type ConditionalComponentType = Extract<
+  ComponentType,
+  | typeof ComponentType.CheckboxesField
+  | typeof ComponentType.DatePartsField
+  | typeof ComponentType.EmailAddressField
+  | typeof ComponentType.MultilineTextField
+  | typeof ComponentType.NumberField
+  | typeof ComponentType.TextField
+  | typeof ComponentType.TimeField
+  | typeof ComponentType.YesNoField
+>
 
 export interface ContentOptions {
   condition?: string
@@ -24,7 +30,6 @@ interface TextFieldBase {
     | ComponentType.TelephoneNumberField
     | ComponentType.TextField
     | ComponentType.UkAddressField
-    | ComponentType.WebsiteField
     | ComponentType.YesNoField
   subType?: ComponentSubType.Field
   name: string
@@ -102,10 +107,7 @@ interface ContentFieldBase {
 
 interface DateFieldBase {
   type:
-    | ComponentType.DateField
     | ComponentType.DatePartsField
-    | ComponentType.DateTimeField
-    | ComponentType.DateTimePartsField
     | ComponentType.MonthYearField
     | ComponentType.TimeField
   subType?: ComponentSubType.Field
@@ -139,13 +141,6 @@ export interface NumberFieldComponent extends NumberFieldBase {
   type: ComponentType.NumberField
 }
 
-export interface WebsiteFieldComponent extends TextFieldBase {
-  type: ComponentType.WebsiteField
-  options: TextFieldBase['options'] & {
-    customValidationMessage?: string
-  }
-}
-
 export interface TelephoneNumberFieldComponent extends TextFieldBase {
   type: ComponentType.TelephoneNumberField
   options: TextFieldBase['options'] & {
@@ -170,36 +165,11 @@ export interface MultilineTextFieldComponent extends TextFieldBase {
   }
 }
 
-export interface FileUploadFieldComponent {
-  type: ComponentType.FileUploadField
-  subType?: ComponentSubType.Field
-  name: string
-  title: string
-  hint: string
-  options: {
-    required?: boolean
-    hideTitle?: boolean
-    multiple?: boolean
-    classes?: string
-    exposeToContext?: boolean
-    imageQualityPlayback?: boolean
-  }
-  schema: object
-}
-
 export interface UkAddressFieldComponent extends TextFieldBase {
   type: ComponentType.UkAddressField
 }
 
 // Date Fields
-export interface DateFieldComponent extends DateFieldBase {
-  type: ComponentType.DateField
-}
-
-export interface DateTimeFieldComponent extends DateFieldBase {
-  type: ComponentType.DateTimeField
-}
-
 export interface DatePartsFieldFieldComponent extends DateFieldBase {
   type: ComponentType.DatePartsField
 }
@@ -208,10 +178,6 @@ export interface MonthYearFieldComponent extends DateFieldBase {
   type: ComponentType.MonthYearField
 }
 
-export interface DateTimePartsFieldComponent extends DateFieldBase {
-  type: ComponentType.DateTimePartsField
-}
-
 export interface TimeFieldComponent extends DateFieldBase {
   type: ComponentType.TimeField
 }
@@ -259,14 +225,10 @@ export type ComponentDef =
   | InsetTextComponent
   | AutocompleteFieldComponent
   | CheckboxesFieldComponent
-  | DateFieldComponent
   | DatePartsFieldFieldComponent
   | MonthYearFieldComponent
-  | DateTimeFieldComponent
-  | DateTimePartsFieldComponent
   | DetailsComponent
   | EmailAddressFieldComponent
-  | FileUploadFieldComponent
   | HtmlComponent
   | ListComponent
   | MultilineTextFieldComponent
@@ -278,9 +240,8 @@ export type ComponentDef =
   | TimeFieldComponent
   | UkAddressFieldComponent
   | YesNoFieldComponent
-  | WebsiteFieldComponent
 
-// Components that render inputs.
+// Components that render inputs
 export type InputFieldsComponentsDef =
   | TextFieldComponent
   | EmailAddressFieldComponent
@@ -288,26 +249,56 @@ export type InputFieldsComponentsDef =
   | MultilineTextFieldComponent
   | TelephoneNumberFieldComponent
   | YesNoFieldComponent
-  | FileUploadFieldComponent
-  | DateFieldComponent
-  | DateTimeFieldComponent
-  | DateTimePartsFieldComponent
   | MonthYearFieldComponent
   | TimeFieldComponent
   | UkAddressFieldComponent
-  | WebsiteFieldComponent
 
-// Components that render content.
+// Components that render content
 export type ContentComponentsDef =
   | DetailsComponent
   | HtmlComponent
   | InsetTextComponent
   | ListComponent
 
-// Components that render Lists
+// Components with editors
+export type EditorComponentsDef =
+  | TextFieldComponent
+  | EmailAddressFieldComponent
+  | TelephoneNumberFieldComponent
+  | MultilineTextFieldComponent
+  | NumberFieldComponent
+  | AutocompleteFieldComponent
+  | SelectFieldComponent
+  | RadiosFieldComponent
+  | CheckboxesFieldComponent
+  | ListComponent
+  | DetailsComponent
+  | HtmlComponent
+  | InsetTextComponent
+  | DatePartsFieldFieldComponent
+
+// Components that render lists
 export type ListComponentsDef =
   | ListComponent
   | AutocompleteFieldComponent
   | CheckboxesFieldComponent
   | RadiosFieldComponent
   | SelectFieldComponent
+
+// Components that have selection fields
+export type SelectionComponentsDef =
+  | CheckboxesFieldComponent
+  | RadiosFieldComponent
+  | SelectFieldComponent
+  | YesNoFieldComponent
+
+// Components that have custom condition operators
+export type ConditionalComponentsDef =
+  | CheckboxesFieldComponent
+  | DatePartsFieldFieldComponent
+  | EmailAddressFieldComponent
+  | MultilineTextFieldComponent
+  | NumberFieldComponent
+  | TextFieldComponent
+  | TimeFieldComponent
+  | YesNoFieldComponent

package/src/conditions/condition-field.ts

@@ -1,22 +1,32 @@
-import { ComponentTypes } from '~/src/components/component-types.js'
-import { type ComponentType } from '~/src/components/enums.js'
+import { ConditionalComponentTypes } from '~/src/components/component-types.js'
+import { type ConditionalComponentType } from '~/src/components/types.js'
 
 export class ConditionField {
-  name: string
-  type: ComponentType
-  display: string
+  name
+  type
+  display
 
-  constructor(name: string, type: ComponentType, display: string) {
+  constructor(
+    name?: string,
+    type?: ConditionalComponentType,
+    display?: string
+  ) {
     if (!name || typeof name !== 'string') {
-      throw Error(`name ${name} is not valid`)
+      throw new Error("ConditionField param 'name' must be a string")
     }
 
-    if (!ComponentTypes.find((componentType) => componentType.type === type)) {
-      throw Error(`type ${type} is not valid`)
+    if (
+      !ConditionalComponentTypes.find(
+        (componentType) => componentType.type === type
+      )
+    ) {
+      throw new Error(
+        "ConditionField param 'type' must be from enum ConditionalComponentTypes"
+      )
     }
 
     if (!display || typeof display !== 'string') {
-      throw Error(`display ${display} is not valid`)
+      throw new Error("ConditionField param 'display' must be a string")
     }
 
     this.name = name
@@ -24,7 +34,11 @@ export class ConditionField {
     this.display = display
   }
 
-  static from(obj: { name: string; type: ComponentType; display: string }) {
+  static from(obj: {
+    name: string
+    type: ConditionalComponentType
+    display: string
+  }) {
     return new ConditionField(obj.name, obj.type, obj.display)
   }
 }