@defra/forms-engine-plugin 2.1.7 → 2.1.9

package/src/server/plugins/engine/components/CheckboxesField.ts

@@ -65,12 +65,9 @@ export class CheckboxesField extends SelectionControlField {
     return this.isValue(value) ? value : undefined
   }
 
-  getDisplayStringFromState(state: FormSubmissionState) {
+  getDisplayStringFromFormValue(selected: (string | number | boolean)[]) {
     const { items } = this
 
-    // Selected checkbox values
-    const selected = this.getFormValueFromState(state) ?? []
-
     // Map selected values to text
     return items
       .filter((item) => selected.includes(item.value))
@@ -78,9 +75,9 @@ export class CheckboxesField extends SelectionControlField {
       .join(', ')
   }
 
-  getContextValueFromState(state: FormSubmissionState) {
-    const values = this.getFormValueFromState(state)
-
+  getContextValueFromFormValue(
+    values: (string | number | boolean)[] | undefined
+  ): (string | number | boolean)[] {
     /**
      * For evaluation context purposes, optional {@link CheckboxesField}
      * with an undefined value (i.e. nothing selected) should default to [].
@@ -95,6 +92,20 @@ export class CheckboxesField extends SelectionControlField {
     return values ?? []
   }
 
+  getDisplayStringFromState(state: FormSubmissionState) {
+    // Selected checkbox values
+    const selected = this.getFormValueFromState(state) ?? []
+
+    // Map selected values to text
+    return this.getDisplayStringFromFormValue(selected)
+  }
+
+  getContextValueFromState(state: FormSubmissionState) {
+    const values = this.getFormValueFromState(state)
+
+    return this.getContextValueFromFormValue(values)
+  }
+
   isValue(value?: FormStateValue | FormState): value is Item['value'][] {
     if (!Array.isArray(value)) {
       return false

package/src/server/plugins/engine/components/DatePartsField.ts

@@ -109,19 +109,24 @@ export class DatePartsField extends FormComponent {
     return this.isState(value) ? value : undefined
   }
 
-  getDisplayStringFromState(state: FormSubmissionState) {
-    const value = this.getFormValueFromState(state)
-
-    if (!value) {
+  getDisplayStringFromFormValue(formValue: DatePartsState | undefined) {
+    if (!formValue) {
       return ''
     }
 
-    return format(`${value.year}-${value.month}-${value.day}`, 'd MMMM yyyy')
+    return format(
+      `${formValue.year}-${formValue.month}-${formValue.day}`,
+      'd MMMM yyyy'
+    )
   }
 
-  getContextValueFromState(state: FormSubmissionState) {
+  getDisplayStringFromState(state: FormSubmissionState) {
     const value = this.getFormValueFromState(state)
 
+    return this.getDisplayStringFromFormValue(value)
+  }
+
+  getContextValueFromFormValue(value: DatePartsState | undefined) {
     if (
       !value ||
       !isValid(
@@ -139,6 +144,12 @@ export class DatePartsField extends FormComponent {
     return format(`${value.year}-${value.month}-${value.day}`, 'yyyy-MM-dd')
   }
 
+  getContextValueFromState(state: FormSubmissionState) {
+    const value = this.getFormValueFromState(state)
+
+    return this.getContextValueFromFormValue(value)
+  }
+
   getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {
     const { collection, name } = this
 

package/src/server/plugins/engine/components/FileUploadField.ts

@@ -149,8 +149,7 @@ export class FileUploadField extends FormComponent {
     return this.isValue(value) ? value : undefined
   }
 
-  getDisplayStringFromState(state: FormSubmissionState) {
-    const files = this.getFormValueFromState(state)
+  getDisplayStringFromFormValue(files: FileState[] | undefined): string {
     if (!files?.length) {
       return ''
     }
@@ -159,11 +158,23 @@ export class FileUploadField extends FormComponent {
     return `Uploaded ${files.length} ${unit}`
   }
 
-  getContextValueFromState(state: FormSubmissionState) {
+  getDisplayStringFromState(state: FormSubmissionState) {
     const files = this.getFormValueFromState(state)
+
+    return this.getDisplayStringFromFormValue(files)
+  }
+
+  getContextValueFromFormValue(
+    files: UploadState | undefined
+  ): string[] | null {
     return files?.map(({ status }) => status.form.file.fileId) ?? null
   }
 
+  getContextValueFromState(state: FormSubmissionState) {
+    const files = this.getFormValueFromState(state)
+    return this.getContextValueFromFormValue(files)
+  }
+
   getViewModel(
     payload: FormPayload,
     errors?: FormSubmissionError[],

package/src/server/plugins/engine/components/FormComponent.ts

@@ -157,17 +157,21 @@ export class FormComponent extends ComponentBase {
     }
   }
 
-  getDisplayStringFromState(state: FormSubmissionState): string {
-    const value = this.getFormValueFromState(state)
+  getDisplayStringFromFormValue(value: FormValue | FormPayload): string {
+    // Map selected values to text
     // eslint-disable-next-line @typescript-eslint/no-base-to-string
     return this.isValue(value) ? value.toString() : ''
   }
 
-  getContextValueFromState(
-    state: FormSubmissionState
-  ): Item['value'] | Item['value'][] | null {
+  getDisplayStringFromState(state: FormSubmissionState): string {
     const value = this.getFormValueFromState(state)
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    return this.getDisplayStringFromFormValue(value)
+  }
 
+  getContextValueFromFormValue(
+    value: FormValue | FormPayload
+  ): Item['value'] | Item['value'][] | null {
     // Filter object field values
     if (this.isState(value)) {
       const values = Object.values(value).filter(isFormValue)
@@ -182,6 +186,14 @@ export class FormComponent extends ComponentBase {
     return this.isValue(value) ? value : null
   }
 
+  getContextValueFromState(
+    state: FormSubmissionState
+  ): Item['value'] | Item['value'][] | null {
+    const value = this.getFormValueFromState(state)
+
+    return this.getContextValueFromFormValue(value)
+  }
+
   isValue(
     value?: FormStateValue | FormState
   ): value is NonNullable<FormStateValue> {

package/src/server/plugins/engine/components/ListFormComponent.ts

@@ -99,11 +99,11 @@ export class ListFormComponent extends FormComponent {
     return selected.at(0)?.value
   }
 
-  getDisplayStringFromState(state: FormSubmissionState) {
+  getDisplayStringFromFormValue(
+    value: string | number | boolean | Item['value'][] | undefined
+  ): string {
     const { items } = this
 
-    // Allow for array values via subclass
-    const value = this.getFormValueFromState(state)
     const values = [value ?? []].flat()
 
     return items
@@ -112,6 +112,13 @@ export class ListFormComponent extends FormComponent {
       .join(', ')
   }
 
+  getDisplayStringFromState(state: FormSubmissionState) {
+    // Allow for array values via subclass
+    const value = this.getFormValueFromState(state)
+
+    return this.getDisplayStringFromFormValue(value)
+  }
+
   getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {
     const { items: listItems } = this
 

package/src/server/plugins/engine/components/MonthYearField.ts

@@ -103,9 +103,7 @@ export class MonthYearField extends FormComponent {
     return MonthYearField.isMonthYear(value) ? value : undefined
   }
 
-  getDisplayStringFromState(state: FormSubmissionState) {
-    const value = this.getFormValueFromState(state)
-
+  getDisplayStringFromFormValue(value: MonthYearState | undefined): string {
     if (!value) {
       return ''
     }
@@ -117,9 +115,15 @@ export class MonthYearField extends FormComponent {
     return `${monthString} ${value.year}`
   }
 
-  getContextValueFromState(state: FormSubmissionState) {
+  getDisplayStringFromState(state: FormSubmissionState) {
     const value = this.getFormValueFromState(state)
 
+    return this.getDisplayStringFromFormValue(value)
+  }
+
+  getContextValueFromFormValue(
+    value: MonthYearState | undefined
+  ): string | null {
     if (
       !value ||
       !isValid(
@@ -137,6 +141,12 @@ export class MonthYearField extends FormComponent {
     return format(`${value.year}-${value.month}-01`, 'yyyy-MM')
   }
 
+  getContextValueFromState(state: FormSubmissionState) {
+    const value = this.getFormValueFromState(state)
+
+    return this.getContextValueFromFormValue(value)
+  }
+
   getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {
     const { collection, name } = this
 

package/src/server/plugins/engine/components/UkAddressField.ts

@@ -110,18 +110,28 @@ export class UkAddressField extends FormComponent {
     return this.isState(value) ? value : undefined
   }
 
-  getDisplayStringFromState(state: FormSubmissionState) {
-    return this.getContextValueFromState(state)?.join(', ') ?? ''
+  getContextValueFromFormValue(value: UkAddressState | undefined) {
+    if (!value) {
+      return null
+    }
+
+    return Object.values(value).filter(Boolean)
   }
 
   getContextValueFromState(state: FormSubmissionState) {
     const value = this.getFormValueFromState(state)
 
-    if (!value) {
-      return null
-    }
+    return this.getContextValueFromFormValue(value)
+  }
 
-    return Object.values(value).filter(Boolean)
+  getDisplayStringFromFormValue(value: UkAddressState | undefined): string {
+    return this.getContextValueFromFormValue(value)?.join(', ') ?? ''
+  }
+
+  getDisplayStringFromState(state: FormSubmissionState) {
+    const value = this.getFormValueFromState(state)
+
+    return this.getDisplayStringFromFormValue(value)
   }
 
   /**

package/src/server/plugins/engine/outputFormatters/adapter/v1.test.ts

@@ -1,4 +1,7 @@
-import { type FormMetadata } from '@defra/forms-model'
+import {
+  type FormMetadata,
+  type SubmitResponsePayload
+} from '@defra/forms-model'
 
 import { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js'
 import { type Field } from '~/src/server/plugins/engine/components/helpers/components.js'
@@ -26,7 +29,7 @@ const submitResponse = {
     files: {
       main: '00000000-0000-0000-0000-000000000000',
       repeaters: {
-        pizza: '11111111-1111-1111-1111-111111111111'
+        exampleRepeat: '11111111-1111-1111-1111-111111111111'
       }
     }
   }
@@ -258,15 +261,26 @@ describe('Adapter v1 formatter', () => {
         exampleFile1: [
           {
             fileId: '123-456-789',
+            fileName: 'foobar.txt',
             userDownloadLink: 'https://forms-designer/file-download/123-456-789'
           },
           {
             fileId: '456-789-123',
+            fileName: 'bazbuzz.txt',
             userDownloadLink: 'https://forms-designer/file-download/456-789-123'
           }
         ]
       }
     })
+
+    expect(parsedBody.result).toEqual({
+      files: {
+        main: '00000000-0000-0000-0000-000000000000',
+        repeaters: {
+          exampleRepeat: '11111111-1111-1111-1111-111111111111'
+        }
+      }
+    })
   })
 
   it('should handle preview form status correctly', () => {
@@ -385,6 +399,14 @@ describe('Adapter v1 formatter', () => {
     expect(parsedBody.data.main).toEqual({})
     expect(parsedBody.data.repeaters).toEqual({})
     expect(parsedBody.data.files).toEqual({})
+    expect(parsedBody.result).toEqual({
+      files: {
+        main: '00000000-0000-0000-0000-000000000000',
+        repeaters: {
+          exampleRepeat: '11111111-1111-1111-1111-111111111111'
+        }
+      }
+    })
   })
 
   it('should handle different form statuses', () => {
@@ -503,4 +525,172 @@ describe('Adapter v1 formatter', () => {
     expect(parsedBody.meta.formSlug).toBe('')
     expect(parsedBody.meta.notificationEmail).toBe('only-email@example.com')
   })
+
+  it('should include CSV file IDs from submitResponse.result.files', () => {
+    const formStatus = {
+      isPreview: false,
+      state: FormStatus.Live
+    }
+
+    const body = format(context, items, model, submitResponse, formStatus)
+    const parsedBody = JSON.parse(body) as FormAdapterSubmissionMessagePayload
+
+    expect(parsedBody.data.main).toEqual({
+      exampleField: 'hello world',
+      exampleField2: 'hello world'
+    })
+
+    expect(parsedBody.data.repeaters.exampleRepeat).toEqual([
+      {
+        subItem1_1: 'hello world',
+        subItem1_2: 'hello world'
+      },
+      {
+        subItem2_1: 'hello world'
+      }
+    ])
+
+    expect(parsedBody.data.files.exampleFile1).toEqual([
+      {
+        fileId: '123-456-789',
+        fileName: 'foobar.txt',
+        userDownloadLink: 'https://forms-designer/file-download/123-456-789'
+      },
+      {
+        fileId: '456-789-123',
+        fileName: 'bazbuzz.txt',
+        userDownloadLink: 'https://forms-designer/file-download/456-789-123'
+      }
+    ])
+
+    expect(parsedBody.result).toEqual({
+      files: {
+        main: '00000000-0000-0000-0000-000000000000',
+        repeaters: {
+          exampleRepeat: '11111111-1111-1111-1111-111111111111'
+        }
+      }
+    })
+  })
+
+  it('should handle submitResponse without CSV file IDs gracefully', () => {
+    const submitResponseWithoutFiles = {
+      message: 'Submit completed',
+      result: {
+        files: {
+          main: '',
+          repeaters: {}
+        }
+      }
+    }
+
+    const formStatus = {
+      isPreview: false,
+      state: FormStatus.Live
+    }
+
+    const body = format(
+      context,
+      items,
+      model,
+      submitResponseWithoutFiles,
+      formStatus
+    )
+    const parsedBody = JSON.parse(body) as FormAdapterSubmissionMessagePayload
+
+    expect(parsedBody.data.main).toEqual({
+      exampleField: 'hello world',
+      exampleField2: 'hello world'
+    })
+
+    expect(parsedBody.data.repeaters.exampleRepeat).toEqual([
+      {
+        subItem1_1: 'hello world',
+        subItem1_2: 'hello world'
+      },
+      {
+        subItem2_1: 'hello world'
+      }
+    ])
+  })
+
+  it('should handle submitResponse with only main CSV file ID', () => {
+    const submitResponseWithMainOnly = {
+      message: 'Submit completed',
+      result: {
+        files: {
+          main: 'main-only-file-id',
+          repeaters: {}
+        }
+      }
+    }
+
+    const formStatus = {
+      isPreview: false,
+      state: FormStatus.Live
+    }
+
+    const body = format(
+      context,
+      items,
+      model,
+      submitResponseWithMainOnly,
+      formStatus
+    )
+    const parsedBody = JSON.parse(body) as FormAdapterSubmissionMessagePayload
+
+    expect(parsedBody.data.main).toEqual({
+      exampleField: 'hello world',
+      exampleField2: 'hello world'
+    })
+
+    expect(parsedBody.data.repeaters.exampleRepeat).toEqual([
+      {
+        subItem1_1: 'hello world',
+        subItem1_2: 'hello world'
+      },
+      {
+        subItem2_1: 'hello world'
+      }
+    ])
+
+    expect(parsedBody.result).toEqual({
+      files: {
+        main: 'main-only-file-id',
+        repeaters: {}
+      }
+    })
+  })
+
+  it('should handle submitResponse with missing repeaters property', () => {
+    const submitResponseWithoutRepeaters = {
+      message: 'Submit completed',
+      result: {
+        files: {
+          main: 'main-only-file-id'
+        }
+      }
+    }
+
+    const formStatus = {
+      isPreview: false,
+      state: FormStatus.Live
+    }
+
+    const body = format(
+      context,
+      items,
+      model,
+      submitResponseWithoutRepeaters as unknown as SubmitResponsePayload,
+      formStatus
+    )
+    const parsedBody = JSON.parse(body) as FormAdapterSubmissionMessagePayload
+
+    expect(parsedBody.result).toEqual({
+      files: {
+        main: 'main-only-file-id',
+        repeaters: {}
+      }
+    })
+  })
 })

package/src/server/plugins/engine/outputFormatters/adapter/v1.ts

@@ -10,7 +10,9 @@ import { format as machineV2 } from '~/src/server/plugins/engine/outputFormatter
 import { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'
 import {
   type FormAdapterSubmissionMessageData,
+  type FormAdapterSubmissionMessageMeta,
   type FormAdapterSubmissionMessagePayload,
+  type FormAdapterSubmissionMessageResult,
   type FormContext
 } from '~/src/server/plugins/engine/types.js'
 import { FormStatus } from '~/src/server/routes/types.js'
@@ -34,20 +36,44 @@ export function format(
     data: FormAdapterSubmissionMessageData
   }
 
+  const csvFiles = extractCsvFiles(submitResponse)
+
+  const transformedData = v2DataParsed.data
+
+  const meta: FormAdapterSubmissionMessageMeta = {
+    schemaVersion: FormAdapterSubmissionSchemaVersion.V1,
+    timestamp: new Date(),
+    referenceNumber: context.referenceNumber,
+    formName: model.name,
+    formId: formMetadata?.id ?? '',
+    formSlug: formMetadata?.slug ?? '',
+    status: formStatus.isPreview ? FormStatus.Draft : FormStatus.Live,
+    isPreview: formStatus.isPreview,
+    notificationEmail: formMetadata?.notificationEmail ?? ''
+  }
+  const data: FormAdapterSubmissionMessageData = transformedData
+
+  const result: FormAdapterSubmissionMessageResult = {
+    files: csvFiles
+  }
+
   const payload: FormAdapterSubmissionMessagePayload = {
-    meta: {
-      schemaVersion: FormAdapterSubmissionSchemaVersion.V1,
-      timestamp: new Date(),
-      referenceNumber: context.referenceNumber,
-      formName: model.name,
-      formId: formMetadata?.id ?? '',
-      formSlug: formMetadata?.slug ?? '',
-      status: formStatus.isPreview ? FormStatus.Draft : FormStatus.Live,
-      isPreview: formStatus.isPreview,
-      notificationEmail: formMetadata?.notificationEmail ?? ''
-    },
-    data: v2DataParsed.data
+    meta,
+    data,
+    result
   }
 
   return JSON.stringify(payload)
 }
+
+function extractCsvFiles(
+  submitResponse: SubmitResponsePayload
+): FormAdapterSubmissionMessageResult['files'] {
+  const result =
+    submitResponse.result as Partial<FormAdapterSubmissionMessageResult>
+
+  return {
+    main: result.files?.main ?? '',
+    repeaters: result.files?.repeaters ?? {}
+  }
+}

package/src/server/plugins/engine/outputFormatters/machine/v2.test.ts

@@ -249,10 +249,12 @@ describe('getPersonalisation', () => {
         exampleFile1: [
           {
             fileId: '123-456-789',
+            fileName: 'foobar.txt',
             userDownloadLink: 'https://forms-designer/file-download/123-456-789'
           },
           {
             fileId: '456-789-123',
+            fileName: 'bazbuzz.txt',
             userDownloadLink: 'https://forms-designer/file-download/456-789-123'
           }
         ]

package/src/server/plugins/engine/outputFormatters/machine/v2.ts

@@ -1,12 +1,7 @@
 import { type SubmitResponsePayload } from '@defra/forms-model'
 
 import { config } from '~/src/config/index.js'
-import { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'
 import { FileUploadField } from '~/src/server/plugins/engine/components/index.js'
-import {
-  type DatePartsState,
-  type MonthYearState
-} from '~/src/server/plugins/engine/components/types.js'
 import { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
 import {
@@ -15,9 +10,10 @@ import {
   type DetailItemRepeat
 } from '~/src/server/plugins/engine/models/types.js'
 import {
+  type FileUploadFieldDetailitem,
+  type FormAdapterFile,
   type FormContext,
-  type FormPayload,
-  type FormValue
+  type RichFormValue
 } from '~/src/server/plugins/engine/types.js'
 
 const designerUrl = config.get('designerUrl')
@@ -69,7 +65,8 @@ export function format(
  *      fileComponentName: [
  *        {
  *          fileId: '123-456-789',
- *          link: 'https://forms-designer/file-download/123-456-789'
+ *          fileName: 'example.pdf',
+ *          userDownloadLink: 'https://forms-designer/file-download/123-456-789'
  *        }
  *      ]
  *    }
@@ -79,7 +76,10 @@ function categoriseData(items: DetailItem[]) {
   const output: {
     main: Record<string, RichFormValue>
     repeaters: Record<string, Record<string, RichFormValue>[]>
-    files: Record<string, Record<string, string>[]>
+    files: Record<
+      string,
+      { fileId: string; fileName: string; userDownloadLink: string }[]
+    >
   } = { main: {}, repeaters: {}, files: {} }
 
   items.forEach((item) => {
@@ -126,13 +126,17 @@ function extractRepeaters(item: DetailItemRepeat) {
  * @param item - the file upload item in the form
  * @returns the file upload data
  */
-function extractFileUploads(item: FileUploadFieldDetailitem) {
-  const fileUploadState = item.field.getContextValueFromState(item.state) ?? []
+function extractFileUploads(
+  item: FileUploadFieldDetailitem
+): FormAdapterFile[] {
+  const fileUploadState = item.field.getFormValueFromState(item.state) ?? []
 
-  return fileUploadState.map((fileId) => {
+  return fileUploadState.map((fileState) => {
+    const { file } = fileState.status.form
     return {
-      fileId,
-      userDownloadLink: `${designerUrl}/file-download/${fileId}`
+      fileId: file.fileId,
+      fileName: file.filename,
+      userDownloadLink: `${designerUrl}/file-download/${file.fileId}`
     }
   })
 }
@@ -142,17 +146,3 @@ function isFileUploadFieldItem(
 ): item is FileUploadFieldDetailitem {
   return item.field instanceof FileUploadField
 }
-
-/**
- * A detail item specifically for files
- */
-type FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {
-  field: FileUploadField
-}
-
-export type RichFormValue =
-  | FormValue
-  | FormPayload
-  | DatePartsState
-  | MonthYearState
-  | UkAddressState

package/src/server/plugins/engine/types/index.ts

@@ -87,7 +87,5 @@ export type {
   Services
 } from '~/src/server/types.js'
 
-export type { RichFormValue } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'
-
 export * from '~/src/server/plugins/engine/types/schema.js'
 export { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'