@defra/forms-engine-plugin 2.1.7 → 2.1.9

package/src/server/plugins/engine/types/schema.test.ts

@@ -9,10 +9,56 @@ import {
 import {
   type FormAdapterSubmissionMessageData,
   type FormAdapterSubmissionMessageMeta,
-  type FormAdapterSubmissionMessagePayload
+  type FormAdapterSubmissionMessagePayload,
+  type RichFormValue
 } from '~/src/server/plugins/engine/types.js'
 
 describe('Schema validation', () => {
+  const main: Record<string, RichFormValue> = {
+    QMwMir: 'Roman Pizza',
+    duOEvZ: 'Small',
+    DzEODf: ['Mozzarella'],
+    juiCfC: ['Pepperoni', 'Sausage', 'Onions', 'Basil'],
+    YEpypP: 'None',
+    JumNVc: 'Joe Bloggs',
+    ALNehP: '+441234567890',
+    vAqTmg: {
+      addressLine1: '1 Anywhere Street',
+      town: 'Anywhereville',
+      postcode: 'AN1 2WH'
+    },
+    IbXVGY: {
+      day: 22,
+      month: 8,
+      year: 2025
+    },
+    HGBWLt: ['Garlic sauce']
+  }
+
+  const value1: Record<string, RichFormValue> = {
+    IEKzko: 'dsfsdfsdf'
+  }
+  const value2: Record<string, RichFormValue> = {
+    IEKzko: 'dfghfgh'
+  }
+
+  const validData: FormAdapterSubmissionMessageData = {
+    main,
+    repeaters: {
+      qLVLgb: [value1, value2]
+    },
+    files: {
+      dLzALM: [
+        {
+          fileId: '489ecc1b-a145-4618-ba5a-b4a0d5ee2dbd',
+          fileName: 'file-name.json',
+          userDownloadLink:
+            'http://localhost:3005/file-download/489ecc1b-a145-4618-ba5a-b4a0d5ee2dbd'
+        }
+      ]
+    }
+  }
+
   describe('formAdapterSubmissionMessageMetaSchema', () => {
     const validMeta: FormAdapterSubmissionMessageMeta = {
       schemaVersion: FormAdapterSubmissionSchemaVersion.V1,
@@ -49,31 +95,6 @@ describe('Schema validation', () => {
   })
 
   describe('formAdapterSubmissionMessageDataSchema', () => {
-    const validData: FormAdapterSubmissionMessageData = {
-      main: {
-        QMwMir: 'Roman Pizza',
-        duOEvZ: 'Small',
-        DzEODf: ['Mozzarella'],
-        juiCfC: ['Pepperoni', 'Sausage', 'Onions', 'Basil'],
-        YEpypP: 'None',
-        JumNVc: 'Joe Bloggs',
-        ALNehP: '+441234567890',
-        vAqTmg: {
-          addressLine1: '1 Anywhere Street',
-          town: 'Anywhereville',
-          postcode: 'AN1 2WH'
-        },
-        IbXVGY: {
-          day: 22,
-          month: 8,
-          year: 2025
-        },
-        HGBWLt: ['Garlic sauce']
-      },
-      repeaters: {},
-      files: {}
-    }
-
     it('should validate valid data object', () => {
       const { error } =
         formAdapterSubmissionMessageDataSchema.validate(validData)
@@ -89,41 +110,28 @@ describe('Schema validation', () => {
   })
 
   describe('formAdapterSubmissionMessagePayloadSchema', () => {
+    const meta: FormAdapterSubmissionMessageMeta = {
+      schemaVersion: FormAdapterSubmissionSchemaVersion.V1,
+      timestamp: new Date('2025-08-22T18:15:10.785Z'),
+      referenceNumber: '576-225-943',
+      formName: 'Order a pizza',
+      formId: '68a8b0449ab460290c28940a',
+      formSlug: 'order-a-pizza',
+      status: FormStatus.Live,
+      isPreview: false,
+      notificationEmail: 'info@example.com'
+    }
+
     const validPayload: FormAdapterSubmissionMessagePayload = {
-      meta: {
-        schemaVersion: FormAdapterSubmissionSchemaVersion.V1,
-        timestamp: new Date('2025-08-22T18:15:10.785Z'),
-        referenceNumber: '576-225-943',
-        formName: 'Order a pizza',
-        formId: '68a8b0449ab460290c28940a',
-        formSlug: 'order-a-pizza',
-        status: FormStatus.Live,
-        isPreview: false,
-        notificationEmail: 'info@example.com'
-      },
-      data: {
-        main: {
-          QMwMir: 'Roman Pizza',
-          duOEvZ: 'Small',
-          DzEODf: ['Mozzarella'],
-          juiCfC: ['Pepperoni', 'Sausage', 'Onions', 'Basil'],
-          YEpypP: 'None',
-          JumNVc: 'Joe Bloggs',
-          ALNehP: '+441234567890',
-          vAqTmg: {
-            addressLine1: '1 Anywhere Street',
-            town: 'Anywhereville',
-            postcode: 'AN1 2WH'
-          },
-          IbXVGY: {
-            day: 22,
-            month: 8,
-            year: 2025
-          },
-          HGBWLt: ['Garlic sauce']
-        },
-        repeaters: {},
-        files: {}
+      meta,
+      data: validData,
+      result: {
+        files: {
+          main: '3d289230-83a3-4852-a68a-cb3569e9b0fe',
+          repeaters: {
+            ImxIOP: 'Joe Bloggs'
+          }
+        }
       }
     }
 

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

@@ -11,7 +11,8 @@ import { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/
 import {
   type FormAdapterSubmissionMessageData,
   type FormAdapterSubmissionMessageMeta,
-  type FormAdapterSubmissionMessagePayload
+  type FormAdapterSubmissionMessagePayload,
+  type FormAdapterSubmissionMessageResult
 } from '~/src/server/plugins/engine/types.js'
 
 export const formAdapterSubmissionMessageMetaSchema =
@@ -35,11 +36,31 @@ export const formAdapterSubmissionMessageDataSchema =
   Joi.object<FormAdapterSubmissionMessageData>().keys({
     main: Joi.object(),
     repeaters: Joi.object(),
+    files: Joi.object().pattern(
+      Joi.string(),
+      Joi.array().items(
+        Joi.object().keys({
+          fileName: Joi.string().required(),
+          fileId: Joi.string().required(),
+          userDownloadLink: Joi.string().required()
+        })
+      )
+    )
+  })
+
+export const formAdapterSubmissionMessageResultSchema =
+  Joi.object<FormAdapterSubmissionMessageResult>().keys({
     files: Joi.object()
+      .keys({
+        main: Joi.string().required(),
+        repeaters: Joi.object()
+      })
+      .required()
   })
 
 export const formAdapterSubmissionMessagePayloadSchema =
   Joi.object<FormAdapterSubmissionMessagePayload>().keys({
     meta: formAdapterSubmissionMessageMetaSchema.required(),
-    data: formAdapterSubmissionMessageDataSchema.required()
+    data: formAdapterSubmissionMessageDataSchema.required(),
+    result: formAdapterSubmissionMessageResultSchema.required()
   })

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

@@ -11,14 +11,18 @@ import { type PluginProperties, type Request } from '@hapi/hapi'
 import { type JoiExpression, type ValidationErrorItem } from 'joi'
 
 import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'
+import { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'
 import { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'
+import { type FileUploadField } from '~/src/server/plugins/engine/components/index.js'
 import {
   type BackLink,
   type ComponentText,
-  type ComponentViewModel
+  type ComponentViewModel,
+  type DatePartsState,
+  type MonthYearState
 } from '~/src/server/plugins/engine/components/types.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
-import { type RichFormValue } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'
+import { type DetailItemField } from '~/src/server/plugins/engine/models/types.js'
 import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'
 import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
 import {
@@ -405,16 +409,42 @@ export type FormAdapterSubmissionMessageMetaSerialised = Omit<
   status: string
   timestamp: string
 }
+export interface FormAdapterFile {
+  fileName: string
+  fileId: string
+  userDownloadLink: string
+}
+
+export interface FormAdapterSubmissionMessageResult {
+  files: {
+    main: string
+    repeaters: Record<string, string>
+  }
+}
+
+/**
+ * A detail item specifically for files
+ */
+export type FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {
+  field: FileUploadField
+}
+export type RichFormValue =
+  | FormValue
+  | FormPayload
+  | DatePartsState
+  | MonthYearState
+  | UkAddressState
 
 export interface FormAdapterSubmissionMessageData {
   main: Record<string, RichFormValue>
   repeaters: Record<string, Record<string, RichFormValue>[]>
-  files: Record<string, Record<string, string>[]>
+  files: Record<string, FormAdapterFile[]>
 }
 
 export interface FormAdapterSubmissionMessagePayload {
   meta: FormAdapterSubmissionMessageMeta
   data: FormAdapterSubmissionMessageData
+  result: FormAdapterSubmissionMessageResult
 }
 
 export interface FormAdapterSubmissionMessage