@defra/forms-model 3.0.462 → 3.0.464

package/src/__stubs__/form-definition.ts

@@ -0,0 +1,64 @@
+import { type FormDefinition } from '~/src/form/form-definition/types.js'
+import { type FormMetadata } from '~/src/form/form-metadata/types.js'
+
+/**
+ * Builder to create a Form Definition
+ * @param {Partial<FormDefinition>} definitionPartial
+ * @returns {FormDefinition}
+ */
+export function buildDefinition(
+  definitionPartial: Partial<FormDefinition> = {}
+): FormDefinition {
+  const formDefinition: FormDefinition = {
+    name: 'Test form',
+    pages: [],
+    conditions: [],
+    sections: [],
+    lists: []
+  }
+  return {
+    ...formDefinition,
+    ...definitionPartial
+  }
+}
+
+/**
+ *
+ * @param {Partial<FormMetadata>} partialMetaData
+ * @returns {FormMetadata}
+ */
+export function buildMetaData(
+  partialMetaData: Partial<FormMetadata> = {}
+): FormMetadata {
+  return {
+    id: '681b184463c68bf6b99e2c62',
+    slug: 'chemistry',
+    title: 'Chemistry',
+    organisation: 'Defra',
+    teamName: 'Forms Team',
+    teamEmail: 'name@example.gov.uk',
+    draft: {
+      createdAt: new Date('2025-05-07T08:22:28.035Z'),
+      createdBy: {
+        id: '84305e4e-1f52-43d0-a123-9c873b0abb35',
+        displayName: 'Internal User'
+      },
+      updatedAt: new Date('2025-05-20T13:00:54.794Z'),
+      updatedBy: {
+        id: '84305e4e-1f52-43d0-a123-9c873b0abb35',
+        displayName: 'Internal User'
+      }
+    },
+    createdBy: {
+      id: '84305e4e-1f52-43d0-a123-9c873b0abb35',
+      displayName: 'Internal User'
+    },
+    createdAt: new Date('2025-05-07T08:22:28.035Z'),
+    updatedBy: {
+      id: '84305e4e-1f52-43d0-a123-9c873b0abb35',
+      displayName: 'Internal User'
+    },
+    updatedAt: new Date('2025-05-20T13:00:54.794Z'),
+    ...partialMetaData
+  }
+}

package/src/__stubs__/pages.ts

@@ -0,0 +1,118 @@
+import { buildFileUploadComponent } from '~/src/__stubs__/components.js'
+import { ComponentType } from '~/src/components/enums.js'
+import {
+  type PageFileUpload,
+  type PageQuestion,
+  type PageRepeat,
+  type PageSummary
+} from '~/src/form/form-definition/types.js'
+import { ControllerPath, ControllerType } from '~/src/pages/enums.js'
+
+/**
+ * Stub builder for a question page
+ * @param {Partial<PageQuestion>} [partialPage]
+ * @returns {PageQuestion}
+ */
+export function buildQuestionPage(
+  partialPage: Partial<PageQuestion>
+): PageQuestion {
+  return {
+    id: 'ffefd409-f3f4-49fe-882e-6e89f44631b1',
+    title: 'Page One',
+    path: '/page-one',
+    next: [],
+    components: [],
+    ...partialPage
+  }
+}
+
+/**
+ * Stub builder for a Summary page
+ * @param {Partial<PageSummary>} [partialSummaryPage]
+ */
+export function buildSummaryPage(
+  partialSummaryPage: Partial<PageSummary> = {}
+): PageSummary {
+  const pageSummary: PageSummary = {
+    id: '449a45f6-4541-4a46-91bd-8b8931b07b50',
+    title: 'Summary page',
+    path: ControllerPath.Summary,
+    controller: ControllerType.Summary
+  }
+  return { ...pageSummary, ...partialSummaryPage }
+}
+
+/**
+ *
+ * @param {Partial<PageFileUpload>} partialFileUploadPage
+ * @returns {PageFileUpload}
+ */
+export function buildFileUploadPage(
+  partialFileUploadPage: Partial<PageFileUpload> = {}
+): PageFileUpload {
+  const fileUploadPage: PageFileUpload = {
+    id: '85e5c8da-88f5-4009-a821-7d7de1364318',
+    title: '',
+    path: '/supporting-evidence',
+    components: [
+      buildFileUploadComponent({
+        type: ComponentType.FileUploadField,
+        title: 'Supporting Evidence',
+        name: 'yBpZQO',
+        shortDescription: 'Supporting evidence',
+        hint: '',
+        options: {
+          required: true,
+          accept:
+            'application/pdf,application/msword,image/jpeg,application/vnd.ms-excel,text/csv'
+        },
+        id: '4189b8a1-1a04-4f74-a7a0-dd23012a0ee0'
+      })
+    ],
+    controller: ControllerType.FileUpload,
+    next: []
+  }
+
+  return {
+    ...fileUploadPage,
+    ...partialFileUploadPage
+  }
+}
+
+/**
+ *
+ * @param {Partial<PageRepeat>} partialRepeaterPage
+ * @returns {PageRepeat}
+ */
+export function buildRepeaterPage(
+  partialRepeaterPage: Partial<PageRepeat> = {}
+): PageRepeat {
+  const repeaterPage: PageRepeat = {
+    title: 'Repeater Page',
+    path: '/repeater-page',
+    components: [
+      {
+        type: ComponentType.TextField,
+        title: 'Simple text field',
+        name: 'IHAIzC',
+        shortDescription: 'Your simple text field',
+        hint: '',
+        options: {},
+        schema: {},
+        id: 'ee83413e-31b6-4158-98e0-4611479582ce'
+      }
+    ],
+    next: [],
+    id: '32888028-61db-40fc-b255-80bc67829d31',
+    controller: ControllerType.Repeat,
+    repeat: {
+      options: { name: 'fawfed', title: 'Simple question responses' },
+      schema: { min: 1, max: 3 }
+    }
+  }
+
+  return {
+    ...repeaterPage,
+    ...partialRepeaterPage
+  }
+}

package/src/conditions/condition-abstract.ts

@@ -15,6 +15,12 @@ export class ConditionAbstract {
     return this.coordinator ? `${this.coordinator} ` : ''
   }
 
+  coordinatorHtml(): string {
+    return this.coordinator
+      ? `<span class="govuk-!-font-weight-bold">${this.coordinator.toUpperCase()}</span> `
+      : ''
+  }
+
   getCoordinator(): Coordinator | undefined {
     return this.coordinator
   }

package/src/conditions/condition-group.ts

@@ -20,6 +20,10 @@ export class ConditionGroup {
     return this.conditions[0].coordinatorString()
   }
 
+  coordinatorHtml(): string {
+    return this.conditions[0].coordinatorHtml()
+  }
+
   conditionString(): string {
     const copy = [...this.conditions]
     copy.splice(0, 1)

package/src/conditions/condition-model.ts

@@ -7,6 +7,7 @@ import {
   hasConditionGroup,
   hasConditionName,
   toExpression,
+  toPresentationHtml,
   toPresentationString
 } from '~/src/conditions/helpers.js'
 import {
@@ -166,6 +167,12 @@ export class ConditionsModel {
       .join(' ')
   }
 
+  toPresentationHtml() {
+    return this.#groupedConditions
+      .map((condition) => toPresentationHtml(condition))
+      .join(' ')
+  }
+
   toExpression() {
     return this.#groupedConditions
       .map((condition) => toExpression(condition))

package/src/conditions/helpers.ts

@@ -8,32 +8,35 @@ import {
 } from '~/src/conditions/types.js'
 import { type ConditionWrapper } from '~/src/form/form-definition/types.js'
 
-export function toPresentationString(
-  condition: Condition | ConditionRef | ConditionGroup
-) {
+type ConditionType = Condition | ConditionRef | ConditionGroup
+type ConditionDataType = ConditionGroupData | ConditionData | ConditionRefData
+
+export function toPresentationString(condition: ConditionType) {
   return `${condition.coordinatorString()}${condition.conditionString()}`
 }
 
-export function toExpression(
-  condition: Condition | ConditionRef | ConditionGroup
-) {
+export function toPresentationHtml(condition: ConditionType) {
+  return `${condition.coordinatorHtml()}${condition.conditionString()}`
+}
+
+export function toExpression(condition: ConditionType) {
   return `${condition.coordinatorString()}${condition.conditionExpression()}`
 }
 
 export const hasConditionField = (
-  condition?: ConditionGroupData | ConditionData | ConditionRefData
+  condition?: ConditionDataType
 ): condition is ConditionData => {
   return !!condition && 'field' in condition
 }
 
 export const hasConditionGroup = (
-  condition?: ConditionGroupData | ConditionData | ConditionRefData
+  condition?: ConditionDataType
 ): condition is ConditionGroupData => {
   return !!condition && 'conditions' in condition
 }
 
 export const hasConditionName = (
-  condition?: ConditionGroupData | ConditionData | ConditionRefData
+  condition?: ConditionDataType
 ): condition is ConditionRefData => {
   return !!condition && 'conditionName' in condition
 }

package/src/conditions/index.ts

@@ -27,7 +27,12 @@ export {
   toPresentationString
 } from '~/src/conditions/helpers.js'
 
-export { convertConditionWrapperFromV2 } from '~/src/conditions/migration.js'
+export {
+  convertConditionWrapperFromV2,
+  isConditionWrapper,
+  isConditionWrapperV2,
+  type RuntimeFormModel
+} from '~/src/conditions/migration.js'
 
 export {
   ConditionType,

package/src/conditions/migration.ts

@@ -72,7 +72,7 @@ function createConditionValueDataFromStringValueDataV2(
   return {
     type: ConditionType.Value,
     value: value.value,
-    display: `Condition value: ${value.value}`
+    display: value.value
   }
 }
 
@@ -119,19 +119,31 @@ function convertConditionRefDataFromV2(
   condition: ConditionRefDataV2,
   coordinator: Coordinator | undefined
 ): ConditionRefData {
-  const component = model.getComponentById(condition.conditionId)
+  const refCondition = model.getConditionById(condition.conditionId)
 
-  if (!component) {
+  if (!refCondition) {
     throw Error('Component not found')
   }
 
   return {
-    conditionName: component.name,
-    conditionDisplayName: component.title,
+    conditionName: refCondition.name,
+    conditionDisplayName: refCondition.displayName,
     coordinator
   }
 }
 
+export function isConditionWrapperV2(
+  wrapper: ConditionWrapper | ConditionWrapperV2
+): wrapper is ConditionWrapperV2 {
+  return Array.isArray((wrapper as ConditionWrapperV2).conditions)
+}
+
+export function isConditionWrapper(
+  wrapper: ConditionWrapper | ConditionWrapperV2
+): wrapper is ConditionWrapper {
+  return !isConditionWrapperV2(wrapper)
+}
+
 export function convertConditionWrapperFromV2(
   conditionWrapper: ConditionWrapperV2,
   model: RuntimeFormModel
@@ -149,7 +161,7 @@ export function convertConditionWrapperFromV2(
     displayName: conditionWrapper.displayName,
     value: {
       name: conditionWrapper.name,
-      conditions: conditionWrapper.conditions.map((condition) => {
+      conditions: conditionWrapper.conditions.map((condition, index) => {
         let newCondition: ConditionData | ConditionRefData
 
         if (isConditionDataV2(condition)) {
@@ -158,7 +170,7 @@ export function convertConditionWrapperFromV2(
           newCondition = convertConditionRefDataFromV2(
             model,
             condition,
-            coordinator
+            index > 0 ? coordinator : undefined
           )
         }
 
@@ -173,4 +185,5 @@ export function convertConditionWrapperFromV2(
 export interface RuntimeFormModel {
   getListById: (listId: string) => List | undefined
   getComponentById: (componentId: string) => ComponentDef | undefined
+  getConditionById: (conditionId: string) => ConditionWrapperV2 | undefined
 }

package/src/stubs.ts

@@ -0,0 +1,12 @@
+export * from '~/src/__stubs__/form-definition.js'
+export { buildList } from '~/src/__stubs__/components.js'
+export { buildListItem } from '~/src/__stubs__/components.js'
+export { buildCheckboxComponent } from '~/src/__stubs__/components.js'
+export { buildRadioComponent } from '~/src/__stubs__/components.js'
+export { buildAutoCompleteComponent } from '~/src/__stubs__/components.js'
+export { buildFileUploadComponent } from '~/src/__stubs__/components.js'
+export { buildTextFieldComponent } from '~/src/__stubs__/components.js'
+export { buildRepeaterPage } from '~/src/__stubs__/pages.js'
+export { buildFileUploadPage } from '~/src/__stubs__/pages.js'
+export { buildSummaryPage } from '~/src/__stubs__/pages.js'
+export { buildQuestionPage } from '~/src/__stubs__/pages.js'