@defra/forms-engine-plugin 2.1.8 → 2.1.9

package/.server/server/plugins/engine/outputFormatters/adapter/v1.js

@@ -4,20 +4,35 @@ import { FormStatus } from "../../../../routes/types.js";
 export function format(context, items, model, submitResponse, formStatus, formMetadata) {
   const v2DataString = machineV2(context, items, model, submitResponse, formStatus);
   const v2DataParsed = JSON.parse(v2DataString);
+  const csvFiles = extractCsvFiles(submitResponse);
+  const transformedData = v2DataParsed.data;
+  const 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 ?? ''
+  };
+  const data = transformedData;
+  const result = {
+    files: csvFiles
+  };
   const payload = {
-    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) {
+  const result = submitResponse.result;
+  return {
+    main: result.files?.main ?? '',
+    repeaters: result.files?.repeaters ?? {}
+  };
+}
 //# sourceMappingURL=v1.js.map

package/.server/server/plugins/engine/outputFormatters/adapter/v1.js.map

@@ -1 +1 @@
-{"version":3,"file":"v1.js","names":["format","machineV2","FormAdapterSubmissionSchemaVersion","FormStatus","context","items","model","submitResponse","formStatus","formMetadata","v2DataString","v2DataParsed","JSON","parse","payload","meta","schemaVersion","V1","timestamp","Date","referenceNumber","formName","name","formId","id","formSlug","slug","status","isPreview","Draft","Live","notificationEmail","data","stringify"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/adapter/v1.ts"],"sourcesContent":["import {\n  type FormMetadata,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\n\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { format as machineV2 } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'\nimport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\nimport {\n  type FormAdapterSubmissionMessageData,\n  type FormAdapterSubmissionMessagePayload,\n  type FormContext\n} from '~/src/server/plugins/engine/types.js'\nimport { FormStatus } from '~/src/server/routes/types.js'\n\nexport function format(\n  context: FormContext,\n  items: DetailItem[],\n  model: FormModel,\n  submitResponse: SubmitResponsePayload,\n  formStatus: ReturnType<typeof checkFormStatus>,\n  formMetadata?: FormMetadata\n): string {\n  const v2DataString = machineV2(\n    context,\n    items,\n    model,\n    submitResponse,\n    formStatus\n  )\n  const v2DataParsed = JSON.parse(v2DataString) as {\n    data: FormAdapterSubmissionMessageData\n  }\n\n  const payload: FormAdapterSubmissionMessagePayload = {\n    meta: {\n      schemaVersion: FormAdapterSubmissionSchemaVersion.V1,\n      timestamp: new Date(),\n      referenceNumber: context.referenceNumber,\n      formName: model.name,\n      formId: formMetadata?.id ?? '',\n      formSlug: formMetadata?.slug ?? '',\n      status: formStatus.isPreview ? FormStatus.Draft : FormStatus.Live,\n      isPreview: formStatus.isPreview,\n      notificationEmail: formMetadata?.notificationEmail ?? ''\n    },\n    data: v2DataParsed.data\n  }\n\n  return JSON.stringify(payload)\n}\n"],"mappings":"AAQA,SAASA,MAAM,IAAIC,SAAS;AAC5B,SAASC,kCAAkC;AAM3C,SAASC,UAAU;AAEnB,OAAO,SAASH,MAAMA,CACpBI,OAAoB,EACpBC,KAAmB,EACnBC,KAAgB,EAChBC,cAAqC,EACrCC,UAA8C,EAC9CC,YAA2B,EACnB;EACR,MAAMC,YAAY,GAAGT,SAAS,CAC5BG,OAAO,EACPC,KAAK,EACLC,KAAK,EACLC,cAAc,EACdC,UACF,CAAC;EACD,MAAMG,YAAY,GAAGC,IAAI,CAACC,KAAK,CAACH,YAAY,CAE3C;EAED,MAAMI,OAA4C,GAAG;IACnDC,IAAI,EAAE;MACJC,aAAa,EAAEd,kCAAkC,CAACe,EAAE;MACpDC,SAAS,EAAE,IAAIC,IAAI,CAAC,CAAC;MACrBC,eAAe,EAAEhB,OAAO,CAACgB,eAAe;MACxCC,QAAQ,EAAEf,KAAK,CAACgB,IAAI;MACpBC,MAAM,EAAEd,YAAY,EAAEe,EAAE,IAAI,EAAE;MAC9BC,QAAQ,EAAEhB,YAAY,EAAEiB,IAAI,IAAI,EAAE;MAClCC,MAAM,EAAEnB,UAAU,CAACoB,SAAS,GAAGzB,UAAU,CAAC0B,KAAK,GAAG1B,UAAU,CAAC2B,IAAI;MACjEF,SAAS,EAAEpB,UAAU,CAACoB,SAAS;MAC/BG,iBAAiB,EAAEtB,YAAY,EAAEsB,iBAAiB,IAAI;IACxD,CAAC;IACDC,IAAI,EAAErB,YAAY,CAACqB;EACrB,CAAC;EAED,OAAOpB,IAAI,CAACqB,SAAS,CAACnB,OAAO,CAAC;AAChC","ignoreList":[]}
+{"version":3,"file":"v1.js","names":["format","machineV2","FormAdapterSubmissionSchemaVersion","FormStatus","context","items","model","submitResponse","formStatus","formMetadata","v2DataString","v2DataParsed","JSON","parse","csvFiles","extractCsvFiles","transformedData","data","meta","schemaVersion","V1","timestamp","Date","referenceNumber","formName","name","formId","id","formSlug","slug","status","isPreview","Draft","Live","notificationEmail","result","files","payload","stringify","main","repeaters"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/adapter/v1.ts"],"sourcesContent":["import {\n  type FormMetadata,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\n\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { format as machineV2 } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'\nimport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\nimport {\n  type FormAdapterSubmissionMessageData,\n  type FormAdapterSubmissionMessageMeta,\n  type FormAdapterSubmissionMessagePayload,\n  type FormAdapterSubmissionMessageResult,\n  type FormContext\n} from '~/src/server/plugins/engine/types.js'\nimport { FormStatus } from '~/src/server/routes/types.js'\n\nexport function format(\n  context: FormContext,\n  items: DetailItem[],\n  model: FormModel,\n  submitResponse: SubmitResponsePayload,\n  formStatus: ReturnType<typeof checkFormStatus>,\n  formMetadata?: FormMetadata\n): string {\n  const v2DataString = machineV2(\n    context,\n    items,\n    model,\n    submitResponse,\n    formStatus\n  )\n  const v2DataParsed = JSON.parse(v2DataString) as {\n    data: FormAdapterSubmissionMessageData\n  }\n\n  const csvFiles = extractCsvFiles(submitResponse)\n\n  const transformedData = v2DataParsed.data\n\n  const meta: FormAdapterSubmissionMessageMeta = {\n    schemaVersion: FormAdapterSubmissionSchemaVersion.V1,\n    timestamp: new Date(),\n    referenceNumber: context.referenceNumber,\n    formName: model.name,\n    formId: formMetadata?.id ?? '',\n    formSlug: formMetadata?.slug ?? '',\n    status: formStatus.isPreview ? FormStatus.Draft : FormStatus.Live,\n    isPreview: formStatus.isPreview,\n    notificationEmail: formMetadata?.notificationEmail ?? ''\n  }\n  const data: FormAdapterSubmissionMessageData = transformedData\n\n  const result: FormAdapterSubmissionMessageResult = {\n    files: csvFiles\n  }\n\n  const payload: FormAdapterSubmissionMessagePayload = {\n    meta,\n    data,\n    result\n  }\n\n  return JSON.stringify(payload)\n}\n\nfunction extractCsvFiles(\n  submitResponse: SubmitResponsePayload\n): FormAdapterSubmissionMessageResult['files'] {\n  const result =\n    submitResponse.result as Partial<FormAdapterSubmissionMessageResult>\n\n  return {\n    main: result.files?.main ?? '',\n    repeaters: result.files?.repeaters ?? {}\n  }\n}\n"],"mappings":"AAQA,SAASA,MAAM,IAAIC,SAAS;AAC5B,SAASC,kCAAkC;AAQ3C,SAASC,UAAU;AAEnB,OAAO,SAASH,MAAMA,CACpBI,OAAoB,EACpBC,KAAmB,EACnBC,KAAgB,EAChBC,cAAqC,EACrCC,UAA8C,EAC9CC,YAA2B,EACnB;EACR,MAAMC,YAAY,GAAGT,SAAS,CAC5BG,OAAO,EACPC,KAAK,EACLC,KAAK,EACLC,cAAc,EACdC,UACF,CAAC;EACD,MAAMG,YAAY,GAAGC,IAAI,CAACC,KAAK,CAACH,YAAY,CAE3C;EAED,MAAMI,QAAQ,GAAGC,eAAe,CAACR,cAAc,CAAC;EAEhD,MAAMS,eAAe,GAAGL,YAAY,CAACM,IAAI;EAEzC,MAAMC,IAAsC,GAAG;IAC7CC,aAAa,EAAEjB,kCAAkC,CAACkB,EAAE;IACpDC,SAAS,EAAE,IAAIC,IAAI,CAAC,CAAC;IACrBC,eAAe,EAAEnB,OAAO,CAACmB,eAAe;IACxCC,QAAQ,EAAElB,KAAK,CAACmB,IAAI;IACpBC,MAAM,EAAEjB,YAAY,EAAEkB,EAAE,IAAI,EAAE;IAC9BC,QAAQ,EAAEnB,YAAY,EAAEoB,IAAI,IAAI,EAAE;IAClCC,MAAM,EAAEtB,UAAU,CAACuB,SAAS,GAAG5B,UAAU,CAAC6B,KAAK,GAAG7B,UAAU,CAAC8B,IAAI;IACjEF,SAAS,EAAEvB,UAAU,CAACuB,SAAS;IAC/BG,iBAAiB,EAAEzB,YAAY,EAAEyB,iBAAiB,IAAI;EACxD,CAAC;EACD,MAAMjB,IAAsC,GAAGD,eAAe;EAE9D,MAAMmB,MAA0C,GAAG;IACjDC,KAAK,EAAEtB;EACT,CAAC;EAED,MAAMuB,OAA4C,GAAG;IACnDnB,IAAI;IACJD,IAAI;IACJkB;EACF,CAAC;EAED,OAAOvB,IAAI,CAAC0B,SAAS,CAACD,OAAO,CAAC;AAChC;AAEA,SAAStB,eAAeA,CACtBR,cAAqC,EACQ;EAC7C,MAAM4B,MAAM,GACV5B,cAAc,CAAC4B,MAAqD;EAEtE,OAAO;IACLI,IAAI,EAAEJ,MAAM,CAACC,KAAK,EAAEG,IAAI,IAAI,EAAE;IAC9BC,SAAS,EAAEL,MAAM,CAACC,KAAK,EAAEI,SAAS,IAAI,CAAC;EACzC,CAAC;AACH","ignoreList":[]}

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

@@ -1,9 +1,6 @@
 import { type SubmitResponsePayload } from '@defra/forms-model';
-import { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.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 { type DetailItem } from '~/src/server/plugins/engine/models/types.js';
-import { type FormContext, type FormPayload, type FormValue } from '~/src/server/plugins/engine/types.js';
+import { type FormContext } from '~/src/server/plugins/engine/types.js';
 export declare function format(context: FormContext, items: DetailItem[], model: FormModel, _submitResponse: SubmitResponsePayload, _formStatus: ReturnType<typeof checkFormStatus>): string;
-export type RichFormValue = FormValue | FormPayload | DatePartsState | MonthYearState | UkAddressState;

package/.server/server/plugins/engine/outputFormatters/machine/v2.js

@@ -38,7 +38,8 @@ export function format(context, items, model, _submitResponse, _formStatus) {
  *      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'
  *        }
  *      ]
  *    }
@@ -93,19 +94,19 @@ function extractRepeaters(item) {
  * @returns the file upload data
  */
 function extractFileUploads(item) {
-  const fileUploadState = item.field.getContextValueFromState(item.state) ?? [];
-  return fileUploadState.map(fileId => {
+  const fileUploadState = item.field.getFormValueFromState(item.state) ?? [];
+  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}`
     };
   });
 }
 function isFileUploadFieldItem(item) {
   return item.field instanceof FileUploadField;
 }
-
-/**
- * A detail item specifically for files
- */
 //# sourceMappingURL=v2.js.map

package/.server/server/plugins/engine/outputFormatters/machine/v2.js.map

@@ -1 +1 @@
-{"version":3,"file":"v2.js","names":["config","FileUploadField","designerUrl","get","format","context","items","model","_submitResponse","_formStatus","now","Date","categorisedData","categoriseData","data","meta","schemaVersion","timestamp","toISOString","definition","def","referenceNumber","body","JSON","stringify","output","main","repeaters","files","forEach","item","name","state","extractRepeaters","isFileUploadFieldItem","extractFileUploads","field","getFormValueFromState","subItems","inputRepeaterItem","outputRepeaterItem","repeaterComponent","push","fileUploadState","getContextValueFromState","map","fileId","userDownloadLink"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/machine/v2.ts"],"sourcesContent":["import { type SubmitResponsePayload } from '@defra/forms-model'\n\nimport { config } from '~/src/config/index.js'\nimport { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'\nimport { FileUploadField } from '~/src/server/plugins/engine/components/index.js'\nimport {\n  type DatePartsState,\n  type MonthYearState\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type DetailItem,\n  type DetailItemField,\n  type DetailItemRepeat\n} from '~/src/server/plugins/engine/models/types.js'\nimport {\n  type FormContext,\n  type FormPayload,\n  type FormValue\n} from '~/src/server/plugins/engine/types.js'\n\nconst designerUrl = config.get('designerUrl')\n\nexport function format(\n  context: FormContext,\n  items: DetailItem[],\n  model: FormModel,\n  _submitResponse: SubmitResponsePayload,\n  _formStatus: ReturnType<typeof checkFormStatus>\n) {\n  const now = new Date()\n\n  const categorisedData = categoriseData(items)\n\n  const data = {\n    meta: {\n      schemaVersion: '2',\n      timestamp: now.toISOString(),\n      definition: model.def,\n      referenceNumber: context.referenceNumber\n    },\n    data: categorisedData\n  }\n\n  const body = JSON.stringify(data)\n\n  return body\n}\n\n/**\n * Categories the form submission data into the \"main\" body and \"repeaters\".\n *\n * {\n *    main: {\n *       componentName: 'componentValue',\n *    },\n *    repeaters: {\n *      repeaterName: [\n *        {\n *          textComponentName: 'componentValue'\n *        },\n *        {\n *          richComponentName: { foo: 'bar', 'baz': true }\n *        }\n *      ]\n *    },\n *    files: {\n *      fileComponentName: [\n *        {\n *          fileId: '123-456-789',\n *          link: 'https://forms-designer/file-download/123-456-789'\n *        }\n *      ]\n *    }\n * }\n */\nfunction categoriseData(items: DetailItem[]) {\n  const output: {\n    main: Record<string, RichFormValue>\n    repeaters: Record<string, Record<string, RichFormValue>[]>\n    files: Record<string, Record<string, string>[]>\n  } = { main: {}, repeaters: {}, files: {} }\n\n  items.forEach((item) => {\n    const { name, state } = item\n\n    if ('subItems' in item) {\n      output.repeaters[name] = extractRepeaters(item)\n    } else if (isFileUploadFieldItem(item)) {\n      output.files[name] = extractFileUploads(item)\n    } else {\n      output.main[name] = item.field.getFormValueFromState(state)\n    }\n  })\n\n  return output\n}\n\n/**\n * Returns the \"repeaters\" section of the response body\n * @param item - the repeater item\n * @returns the repeater item\n */\nfunction extractRepeaters(item: DetailItemRepeat) {\n  const repeaters: Record<string, RichFormValue>[] = []\n\n  item.subItems.forEach((inputRepeaterItem) => {\n    const outputRepeaterItem: Record<string, RichFormValue> = {}\n\n    inputRepeaterItem.forEach((repeaterComponent) => {\n      const { field, state } = repeaterComponent\n\n      outputRepeaterItem[repeaterComponent.name] =\n        field.getFormValueFromState(state)\n    })\n\n    repeaters.push(outputRepeaterItem)\n  })\n\n  return repeaters\n}\n\n/**\n * Returns the \"files\" section of the response body\n * @param item - the file upload item in the form\n * @returns the file upload data\n */\nfunction extractFileUploads(item: FileUploadFieldDetailitem) {\n  const fileUploadState = item.field.getContextValueFromState(item.state) ?? []\n\n  return fileUploadState.map((fileId) => {\n    return {\n      fileId,\n      userDownloadLink: `${designerUrl}/file-download/${fileId}`\n    }\n  })\n}\n\nfunction isFileUploadFieldItem(\n  item: DetailItemField\n): item is FileUploadFieldDetailitem {\n  return item.field instanceof FileUploadField\n}\n\n/**\n * A detail item specifically for files\n */\ntype FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {\n  field: FileUploadField\n}\n\nexport type RichFormValue =\n  | FormValue\n  | FormPayload\n  | DatePartsState\n  | MonthYearState\n  | UkAddressState\n"],"mappings":"AAEA,SAASA,MAAM;AAEf,SAASC,eAAe;AAkBxB,MAAMC,WAAW,GAAGF,MAAM,CAACG,GAAG,CAAC,aAAa,CAAC;AAE7C,OAAO,SAASC,MAAMA,CACpBC,OAAoB,EACpBC,KAAmB,EACnBC,KAAgB,EAChBC,eAAsC,EACtCC,WAA+C,EAC/C;EACA,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;EAEtB,MAAMC,eAAe,GAAGC,cAAc,CAACP,KAAK,CAAC;EAE7C,MAAMQ,IAAI,GAAG;IACXC,IAAI,EAAE;MACJC,aAAa,EAAE,GAAG;MAClBC,SAAS,EAAEP,GAAG,CAACQ,WAAW,CAAC,CAAC;MAC5BC,UAAU,EAAEZ,KAAK,CAACa,GAAG;MACrBC,eAAe,EAAEhB,OAAO,CAACgB;IAC3B,CAAC;IACDP,IAAI,EAAEF;EACR,CAAC;EAED,MAAMU,IAAI,GAAGC,IAAI,CAACC,SAAS,CAACV,IAAI,CAAC;EAEjC,OAAOQ,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAST,cAAcA,CAACP,KAAmB,EAAE;EAC3C,MAAMmB,MAIL,GAAG;IAAEC,IAAI,EAAE,CAAC,CAAC;IAAEC,SAAS,EAAE,CAAC,CAAC;IAAEC,KAAK,EAAE,CAAC;EAAE,CAAC;EAE1CtB,KAAK,CAACuB,OAAO,CAAEC,IAAI,IAAK;IACtB,MAAM;MAAEC,IAAI;MAAEC;IAAM,CAAC,GAAGF,IAAI;IAE5B,IAAI,UAAU,IAAIA,IAAI,EAAE;MACtBL,MAAM,CAACE,SAAS,CAACI,IAAI,CAAC,GAAGE,gBAAgB,CAACH,IAAI,CAAC;IACjD,CAAC,MAAM,IAAII,qBAAqB,CAACJ,IAAI,CAAC,EAAE;MACtCL,MAAM,CAACG,KAAK,CAACG,IAAI,CAAC,GAAGI,kBAAkB,CAACL,IAAI,CAAC;IAC/C,CAAC,MAAM;MACLL,MAAM,CAACC,IAAI,CAACK,IAAI,CAAC,GAAGD,IAAI,CAACM,KAAK,CAACC,qBAAqB,CAACL,KAAK,CAAC;IAC7D;EACF,CAAC,CAAC;EAEF,OAAOP,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASQ,gBAAgBA,CAACH,IAAsB,EAAE;EAChD,MAAMH,SAA0C,GAAG,EAAE;EAErDG,IAAI,CAACQ,QAAQ,CAACT,OAAO,CAAEU,iBAAiB,IAAK;IAC3C,MAAMC,kBAAiD,GAAG,CAAC,CAAC;IAE5DD,iBAAiB,CAACV,OAAO,CAAEY,iBAAiB,IAAK;MAC/C,MAAM;QAAEL,KAAK;QAAEJ;MAAM,CAAC,GAAGS,iBAAiB;MAE1CD,kBAAkB,CAACC,iBAAiB,CAACV,IAAI,CAAC,GACxCK,KAAK,CAACC,qBAAqB,CAACL,KAAK,CAAC;IACtC,CAAC,CAAC;IAEFL,SAAS,CAACe,IAAI,CAACF,kBAAkB,CAAC;EACpC,CAAC,CAAC;EAEF,OAAOb,SAAS;AAClB;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASQ,kBAAkBA,CAACL,IAA+B,EAAE;EAC3D,MAAMa,eAAe,GAAGb,IAAI,CAACM,KAAK,CAACQ,wBAAwB,CAACd,IAAI,CAACE,KAAK,CAAC,IAAI,EAAE;EAE7E,OAAOW,eAAe,CAACE,GAAG,CAAEC,MAAM,IAAK;IACrC,OAAO;MACLA,MAAM;MACNC,gBAAgB,EAAE,GAAG7C,WAAW,kBAAkB4C,MAAM;IAC1D,CAAC;EACH,CAAC,CAAC;AACJ;AAEA,SAASZ,qBAAqBA,CAC5BJ,IAAqB,EACc;EACnC,OAAOA,IAAI,CAACM,KAAK,YAAYnC,eAAe;AAC9C;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"v2.js","names":["config","FileUploadField","designerUrl","get","format","context","items","model","_submitResponse","_formStatus","now","Date","categorisedData","categoriseData","data","meta","schemaVersion","timestamp","toISOString","definition","def","referenceNumber","body","JSON","stringify","output","main","repeaters","files","forEach","item","name","state","extractRepeaters","isFileUploadFieldItem","extractFileUploads","field","getFormValueFromState","subItems","inputRepeaterItem","outputRepeaterItem","repeaterComponent","push","fileUploadState","map","fileState","file","status","form","fileId","fileName","filename","userDownloadLink"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/machine/v2.ts"],"sourcesContent":["import { type SubmitResponsePayload } from '@defra/forms-model'\n\nimport { config } from '~/src/config/index.js'\nimport { FileUploadField } from '~/src/server/plugins/engine/components/index.js'\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type DetailItem,\n  type DetailItemField,\n  type DetailItemRepeat\n} from '~/src/server/plugins/engine/models/types.js'\nimport {\n  type FileUploadFieldDetailitem,\n  type FormAdapterFile,\n  type FormContext,\n  type RichFormValue\n} from '~/src/server/plugins/engine/types.js'\n\nconst designerUrl = config.get('designerUrl')\n\nexport function format(\n  context: FormContext,\n  items: DetailItem[],\n  model: FormModel,\n  _submitResponse: SubmitResponsePayload,\n  _formStatus: ReturnType<typeof checkFormStatus>\n) {\n  const now = new Date()\n\n  const categorisedData = categoriseData(items)\n\n  const data = {\n    meta: {\n      schemaVersion: '2',\n      timestamp: now.toISOString(),\n      definition: model.def,\n      referenceNumber: context.referenceNumber\n    },\n    data: categorisedData\n  }\n\n  const body = JSON.stringify(data)\n\n  return body\n}\n\n/**\n * Categories the form submission data into the \"main\" body and \"repeaters\".\n *\n * {\n *    main: {\n *       componentName: 'componentValue',\n *    },\n *    repeaters: {\n *      repeaterName: [\n *        {\n *          textComponentName: 'componentValue'\n *        },\n *        {\n *          richComponentName: { foo: 'bar', 'baz': true }\n *        }\n *      ]\n *    },\n *    files: {\n *      fileComponentName: [\n *        {\n *          fileId: '123-456-789',\n *          fileName: 'example.pdf',\n *          userDownloadLink: 'https://forms-designer/file-download/123-456-789'\n *        }\n *      ]\n *    }\n * }\n */\nfunction categoriseData(items: DetailItem[]) {\n  const output: {\n    main: Record<string, RichFormValue>\n    repeaters: Record<string, Record<string, RichFormValue>[]>\n    files: Record<\n      string,\n      { fileId: string; fileName: string; userDownloadLink: string }[]\n    >\n  } = { main: {}, repeaters: {}, files: {} }\n\n  items.forEach((item) => {\n    const { name, state } = item\n\n    if ('subItems' in item) {\n      output.repeaters[name] = extractRepeaters(item)\n    } else if (isFileUploadFieldItem(item)) {\n      output.files[name] = extractFileUploads(item)\n    } else {\n      output.main[name] = item.field.getFormValueFromState(state)\n    }\n  })\n\n  return output\n}\n\n/**\n * Returns the \"repeaters\" section of the response body\n * @param item - the repeater item\n * @returns the repeater item\n */\nfunction extractRepeaters(item: DetailItemRepeat) {\n  const repeaters: Record<string, RichFormValue>[] = []\n\n  item.subItems.forEach((inputRepeaterItem) => {\n    const outputRepeaterItem: Record<string, RichFormValue> = {}\n\n    inputRepeaterItem.forEach((repeaterComponent) => {\n      const { field, state } = repeaterComponent\n\n      outputRepeaterItem[repeaterComponent.name] =\n        field.getFormValueFromState(state)\n    })\n\n    repeaters.push(outputRepeaterItem)\n  })\n\n  return repeaters\n}\n\n/**\n * Returns the \"files\" section of the response body\n * @param item - the file upload item in the form\n * @returns the file upload data\n */\nfunction extractFileUploads(\n  item: FileUploadFieldDetailitem\n): FormAdapterFile[] {\n  const fileUploadState = item.field.getFormValueFromState(item.state) ?? []\n\n  return fileUploadState.map((fileState) => {\n    const { file } = fileState.status.form\n    return {\n      fileId: file.fileId,\n      fileName: file.filename,\n      userDownloadLink: `${designerUrl}/file-download/${file.fileId}`\n    }\n  })\n}\n\nfunction isFileUploadFieldItem(\n  item: DetailItemField\n): item is FileUploadFieldDetailitem {\n  return item.field instanceof FileUploadField\n}\n"],"mappings":"AAEA,SAASA,MAAM;AACf,SAASC,eAAe;AAexB,MAAMC,WAAW,GAAGF,MAAM,CAACG,GAAG,CAAC,aAAa,CAAC;AAE7C,OAAO,SAASC,MAAMA,CACpBC,OAAoB,EACpBC,KAAmB,EACnBC,KAAgB,EAChBC,eAAsC,EACtCC,WAA+C,EAC/C;EACA,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;EAEtB,MAAMC,eAAe,GAAGC,cAAc,CAACP,KAAK,CAAC;EAE7C,MAAMQ,IAAI,GAAG;IACXC,IAAI,EAAE;MACJC,aAAa,EAAE,GAAG;MAClBC,SAAS,EAAEP,GAAG,CAACQ,WAAW,CAAC,CAAC;MAC5BC,UAAU,EAAEZ,KAAK,CAACa,GAAG;MACrBC,eAAe,EAAEhB,OAAO,CAACgB;IAC3B,CAAC;IACDP,IAAI,EAAEF;EACR,CAAC;EAED,MAAMU,IAAI,GAAGC,IAAI,CAACC,SAAS,CAACV,IAAI,CAAC;EAEjC,OAAOQ,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAST,cAAcA,CAACP,KAAmB,EAAE;EAC3C,MAAMmB,MAOL,GAAG;IAAEC,IAAI,EAAE,CAAC,CAAC;IAAEC,SAAS,EAAE,CAAC,CAAC;IAAEC,KAAK,EAAE,CAAC;EAAE,CAAC;EAE1CtB,KAAK,CAACuB,OAAO,CAAEC,IAAI,IAAK;IACtB,MAAM;MAAEC,IAAI;MAAEC;IAAM,CAAC,GAAGF,IAAI;IAE5B,IAAI,UAAU,IAAIA,IAAI,EAAE;MACtBL,MAAM,CAACE,SAAS,CAACI,IAAI,CAAC,GAAGE,gBAAgB,CAACH,IAAI,CAAC;IACjD,CAAC,MAAM,IAAII,qBAAqB,CAACJ,IAAI,CAAC,EAAE;MACtCL,MAAM,CAACG,KAAK,CAACG,IAAI,CAAC,GAAGI,kBAAkB,CAACL,IAAI,CAAC;IAC/C,CAAC,MAAM;MACLL,MAAM,CAACC,IAAI,CAACK,IAAI,CAAC,GAAGD,IAAI,CAACM,KAAK,CAACC,qBAAqB,CAACL,KAAK,CAAC;IAC7D;EACF,CAAC,CAAC;EAEF,OAAOP,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASQ,gBAAgBA,CAACH,IAAsB,EAAE;EAChD,MAAMH,SAA0C,GAAG,EAAE;EAErDG,IAAI,CAACQ,QAAQ,CAACT,OAAO,CAAEU,iBAAiB,IAAK;IAC3C,MAAMC,kBAAiD,GAAG,CAAC,CAAC;IAE5DD,iBAAiB,CAACV,OAAO,CAAEY,iBAAiB,IAAK;MAC/C,MAAM;QAAEL,KAAK;QAAEJ;MAAM,CAAC,GAAGS,iBAAiB;MAE1CD,kBAAkB,CAACC,iBAAiB,CAACV,IAAI,CAAC,GACxCK,KAAK,CAACC,qBAAqB,CAACL,KAAK,CAAC;IACtC,CAAC,CAAC;IAEFL,SAAS,CAACe,IAAI,CAACF,kBAAkB,CAAC;EACpC,CAAC,CAAC;EAEF,OAAOb,SAAS;AAClB;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASQ,kBAAkBA,CACzBL,IAA+B,EACZ;EACnB,MAAMa,eAAe,GAAGb,IAAI,CAACM,KAAK,CAACC,qBAAqB,CAACP,IAAI,CAACE,KAAK,CAAC,IAAI,EAAE;EAE1E,OAAOW,eAAe,CAACC,GAAG,CAAEC,SAAS,IAAK;IACxC,MAAM;MAAEC;IAAK,CAAC,GAAGD,SAAS,CAACE,MAAM,CAACC,IAAI;IACtC,OAAO;MACLC,MAAM,EAAEH,IAAI,CAACG,MAAM;MACnBC,QAAQ,EAAEJ,IAAI,CAACK,QAAQ;MACvBC,gBAAgB,EAAE,GAAGlD,WAAW,kBAAkB4C,IAAI,CAACG,MAAM;IAC/D,CAAC;EACH,CAAC,CAAC;AACJ;AAEA,SAASf,qBAAqBA,CAC5BJ,IAAqB,EACc;EACnC,OAAOA,IAAI,CAACM,KAAK,YAAYnC,eAAe;AAC9C","ignoreList":[]}

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

@@ -6,6 +6,5 @@ export type { UkAddressState } from '~/src/server/plugins/engine/components/UkAd
 export type { FormParams, FormQuery, FormRequest, FormRequestPayload, FormRequestPayloadRefs, FormRequestRefs } from '~/src/server/routes/types.js';
 export { FormAction, FormStatus } from '~/src/server/routes/types.js';
 export type { FormSubmissionService, FormsService, OutputService, RouteConfig, 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';

package/.server/server/plugins/engine/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["FileStatus","UploadStatus","FormAction","FormStatus","FormAdapterSubmissionSchemaVersion"],"sources":["../../../../../src/server/plugins/engine/types/index.ts"],"sourcesContent":["export type {\n  CheckAnswers,\n  ErrorMessageTemplate,\n  ErrorMessageTemplateList,\n  FeaturedFormPageViewModel,\n  FileState,\n  FilterFunction,\n  FormAdapterSubmissionMessage,\n  FormAdapterSubmissionMessageData,\n  FormAdapterSubmissionMessageMeta,\n  FormAdapterSubmissionMessageMetaSerialised,\n  FormAdapterSubmissionMessagePayload,\n  FormAdapterSubmissionService,\n  FormContext,\n  FormContextRequest,\n  FormPageViewModel,\n  FormPayload,\n  FormPayloadParams,\n  FormState,\n  FormStateValue,\n  FormSubmissionError,\n  FormSubmissionState,\n  FormValidationResult,\n  FormValue,\n  GlobalFunction,\n  ItemDeletePageViewModel,\n  OnRequestCallback,\n  PageViewModel,\n  PageViewModelBase,\n  PluginOptions,\n  PreparePageEventRequestOptions,\n  RepeatItemState,\n  RepeatListState,\n  RepeaterSummaryPageViewModel,\n  SummaryList,\n  SummaryListAction,\n  SummaryListRow,\n  TempFileState,\n  UploadInitiateResponse,\n  UploadStatusFileResponse,\n  UploadStatusResponse\n} from '~/src/server/plugins/engine/types.js'\n\nexport { FileStatus, UploadStatus } from '~/src/server/plugins/engine/types.js'\n\nexport type {\n  Detail,\n  DetailItem,\n  DetailItemBase,\n  DetailItemField,\n  DetailItemRepeat,\n  ExecutableCondition\n} from '~/src/server/plugins/engine/models/types.js'\n\nexport type {\n  BackLink,\n  ComponentText,\n  ComponentViewModel,\n  Content,\n  DateInputItem,\n  DatePartsState,\n  Label,\n  ListItem,\n  ListItemLabel,\n  MonthYearState,\n  ViewModel\n} from '~/src/server/plugins/engine/components/types.js'\n\nexport type { UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'\n\nexport type {\n  FormParams,\n  FormQuery,\n  FormRequest,\n  FormRequestPayload,\n  FormRequestPayloadRefs,\n  FormRequestRefs\n} from '~/src/server/routes/types.js'\n\nexport { FormAction, FormStatus } from '~/src/server/routes/types.js'\n\nexport type {\n  FormSubmissionService,\n  FormsService,\n  OutputService,\n  RouteConfig,\n  Services\n} from '~/src/server/types.js'\n\nexport type { RichFormValue } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'\n\nexport * from '~/src/server/plugins/engine/types/schema.js'\nexport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\n"],"mappings":"AA2CA,SAASA,UAAU,EAAEC,YAAY;AAoCjC,SAASC,UAAU,EAAEC,UAAU;AAY/B;AACA,SAASC,kCAAkC","ignoreList":[]}
+{"version":3,"file":"index.js","names":["FileStatus","UploadStatus","FormAction","FormStatus","FormAdapterSubmissionSchemaVersion"],"sources":["../../../../../src/server/plugins/engine/types/index.ts"],"sourcesContent":["export type {\n  CheckAnswers,\n  ErrorMessageTemplate,\n  ErrorMessageTemplateList,\n  FeaturedFormPageViewModel,\n  FileState,\n  FilterFunction,\n  FormAdapterSubmissionMessage,\n  FormAdapterSubmissionMessageData,\n  FormAdapterSubmissionMessageMeta,\n  FormAdapterSubmissionMessageMetaSerialised,\n  FormAdapterSubmissionMessagePayload,\n  FormAdapterSubmissionService,\n  FormContext,\n  FormContextRequest,\n  FormPageViewModel,\n  FormPayload,\n  FormPayloadParams,\n  FormState,\n  FormStateValue,\n  FormSubmissionError,\n  FormSubmissionState,\n  FormValidationResult,\n  FormValue,\n  GlobalFunction,\n  ItemDeletePageViewModel,\n  OnRequestCallback,\n  PageViewModel,\n  PageViewModelBase,\n  PluginOptions,\n  PreparePageEventRequestOptions,\n  RepeatItemState,\n  RepeatListState,\n  RepeaterSummaryPageViewModel,\n  SummaryList,\n  SummaryListAction,\n  SummaryListRow,\n  TempFileState,\n  UploadInitiateResponse,\n  UploadStatusFileResponse,\n  UploadStatusResponse\n} from '~/src/server/plugins/engine/types.js'\n\nexport { FileStatus, UploadStatus } from '~/src/server/plugins/engine/types.js'\n\nexport type {\n  Detail,\n  DetailItem,\n  DetailItemBase,\n  DetailItemField,\n  DetailItemRepeat,\n  ExecutableCondition\n} from '~/src/server/plugins/engine/models/types.js'\n\nexport type {\n  BackLink,\n  ComponentText,\n  ComponentViewModel,\n  Content,\n  DateInputItem,\n  DatePartsState,\n  Label,\n  ListItem,\n  ListItemLabel,\n  MonthYearState,\n  ViewModel\n} from '~/src/server/plugins/engine/components/types.js'\n\nexport type { UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'\n\nexport type {\n  FormParams,\n  FormQuery,\n  FormRequest,\n  FormRequestPayload,\n  FormRequestPayloadRefs,\n  FormRequestRefs\n} from '~/src/server/routes/types.js'\n\nexport { FormAction, FormStatus } from '~/src/server/routes/types.js'\n\nexport type {\n  FormSubmissionService,\n  FormsService,\n  OutputService,\n  RouteConfig,\n  Services\n} from '~/src/server/types.js'\n\nexport * from '~/src/server/plugins/engine/types/schema.js'\nexport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\n"],"mappings":"AA2CA,SAASA,UAAU,EAAEC,YAAY;AAoCjC,SAASC,UAAU,EAAEC,UAAU;AAU/B;AACA,SAASC,kCAAkC","ignoreList":[]}

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

@@ -1,5 +1,6 @@
 import Joi from 'joi';
-import { type FormAdapterSubmissionMessageData, type FormAdapterSubmissionMessageMeta, type FormAdapterSubmissionMessagePayload } from '~/src/server/plugins/engine/types.js';
+import { type FormAdapterSubmissionMessageData, type FormAdapterSubmissionMessageMeta, type FormAdapterSubmissionMessagePayload, type FormAdapterSubmissionMessageResult } from '~/src/server/plugins/engine/types.js';
 export declare const formAdapterSubmissionMessageMetaSchema: Joi.ObjectSchema<FormAdapterSubmissionMessageMeta>;
 export declare const formAdapterSubmissionMessageDataSchema: Joi.ObjectSchema<FormAdapterSubmissionMessageData>;
+export declare const formAdapterSubmissionMessageResultSchema: Joi.ObjectSchema<FormAdapterSubmissionMessageResult>;
 export declare const formAdapterSubmissionMessagePayloadSchema: Joi.ObjectSchema<FormAdapterSubmissionMessagePayload>;

package/.server/server/plugins/engine/types/schema.js

@@ -15,10 +15,21 @@ export const formAdapterSubmissionMessageMetaSchema = Joi.object().keys({
 export const formAdapterSubmissionMessageDataSchema = Joi.object().keys({
   main: Joi.object(),
   repeaters: Joi.object(),
-  files: 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().keys({
+  files: Joi.object().keys({
+    main: Joi.string().required(),
+    repeaters: Joi.object()
+  }).required()
 });
 export const formAdapterSubmissionMessagePayloadSchema = Joi.object().keys({
   meta: formAdapterSubmissionMessageMetaSchema.required(),
-  data: formAdapterSubmissionMessageDataSchema.required()
+  data: formAdapterSubmissionMessageDataSchema.required(),
+  result: formAdapterSubmissionMessageResultSchema.required()
 });
 //# sourceMappingURL=schema.js.map

package/.server/server/plugins/engine/types/schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema.js","names":["FormStatus","idSchema","notificationEmailAddressSchema","slugSchema","titleSchema","Joi","FormAdapterSubmissionSchemaVersion","formAdapterSubmissionMessageMetaSchema","object","keys","schemaVersion","string","valid","Object","values","timestamp","date","required","referenceNumber","formName","formId","formSlug","status","isPreview","boolean","notificationEmail","formAdapterSubmissionMessageDataSchema","main","repeaters","files","formAdapterSubmissionMessagePayloadSchema","meta","data"],"sources":["../../../../../src/server/plugins/engine/types/schema.ts"],"sourcesContent":["import {\n  FormStatus,\n  idSchema,\n  notificationEmailAddressSchema,\n  slugSchema,\n  titleSchema\n} from '@defra/forms-model'\nimport Joi from 'joi'\n\nimport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\nimport {\n  type FormAdapterSubmissionMessageData,\n  type FormAdapterSubmissionMessageMeta,\n  type FormAdapterSubmissionMessagePayload\n} from '~/src/server/plugins/engine/types.js'\n\nexport const formAdapterSubmissionMessageMetaSchema =\n  Joi.object<FormAdapterSubmissionMessageMeta>().keys({\n    schemaVersion: Joi.string().valid(\n      ...Object.values(FormAdapterSubmissionSchemaVersion)\n    ),\n    timestamp: Joi.date().required(),\n    referenceNumber: Joi.string().required(),\n    formName: titleSchema,\n    formId: idSchema,\n    formSlug: slugSchema,\n    status: Joi.string()\n      .valid(...Object.values(FormStatus))\n      .required(),\n    isPreview: Joi.boolean().required(),\n    notificationEmail: notificationEmailAddressSchema.required()\n  })\n\nexport const formAdapterSubmissionMessageDataSchema =\n  Joi.object<FormAdapterSubmissionMessageData>().keys({\n    main: Joi.object(),\n    repeaters: Joi.object(),\n    files: Joi.object()\n  })\n\nexport const formAdapterSubmissionMessagePayloadSchema =\n  Joi.object<FormAdapterSubmissionMessagePayload>().keys({\n    meta: formAdapterSubmissionMessageMetaSchema.required(),\n    data: formAdapterSubmissionMessageDataSchema.required()\n  })\n"],"mappings":"AAAA,SACEA,UAAU,EACVC,QAAQ,EACRC,8BAA8B,EAC9BC,UAAU,EACVC,WAAW,QACN,oBAAoB;AAC3B,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,kCAAkC;AAO3C,OAAO,MAAMC,sCAAsC,GACjDF,GAAG,CAACG,MAAM,CAAmC,CAAC,CAACC,IAAI,CAAC;EAClDC,aAAa,EAAEL,GAAG,CAACM,MAAM,CAAC,CAAC,CAACC,KAAK,CAC/B,GAAGC,MAAM,CAACC,MAAM,CAACR,kCAAkC,CACrD,CAAC;EACDS,SAAS,EAAEV,GAAG,CAACW,IAAI,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAChCC,eAAe,EAAEb,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;EACxCE,QAAQ,EAAEf,WAAW;EACrBgB,MAAM,EAAEnB,QAAQ;EAChBoB,QAAQ,EAAElB,UAAU;EACpBmB,MAAM,EAAEjB,GAAG,CAACM,MAAM,CAAC,CAAC,CACjBC,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAACd,UAAU,CAAC,CAAC,CACnCiB,QAAQ,CAAC,CAAC;EACbM,SAAS,EAAElB,GAAG,CAACmB,OAAO,CAAC,CAAC,CAACP,QAAQ,CAAC,CAAC;EACnCQ,iBAAiB,EAAEvB,8BAA8B,CAACe,QAAQ,CAAC;AAC7D,CAAC,CAAC;AAEJ,OAAO,MAAMS,sCAAsC,GACjDrB,GAAG,CAACG,MAAM,CAAmC,CAAC,CAACC,IAAI,CAAC;EAClDkB,IAAI,EAAEtB,GAAG,CAACG,MAAM,CAAC,CAAC;EAClBoB,SAAS,EAAEvB,GAAG,CAACG,MAAM,CAAC,CAAC;EACvBqB,KAAK,EAAExB,GAAG,CAACG,MAAM,CAAC;AACpB,CAAC,CAAC;AAEJ,OAAO,MAAMsB,yCAAyC,GACpDzB,GAAG,CAACG,MAAM,CAAsC,CAAC,CAACC,IAAI,CAAC;EACrDsB,IAAI,EAAExB,sCAAsC,CAACU,QAAQ,CAAC,CAAC;EACvDe,IAAI,EAAEN,sCAAsC,CAACT,QAAQ,CAAC;AACxD,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"schema.js","names":["FormStatus","idSchema","notificationEmailAddressSchema","slugSchema","titleSchema","Joi","FormAdapterSubmissionSchemaVersion","formAdapterSubmissionMessageMetaSchema","object","keys","schemaVersion","string","valid","Object","values","timestamp","date","required","referenceNumber","formName","formId","formSlug","status","isPreview","boolean","notificationEmail","formAdapterSubmissionMessageDataSchema","main","repeaters","files","pattern","array","items","fileName","fileId","userDownloadLink","formAdapterSubmissionMessageResultSchema","formAdapterSubmissionMessagePayloadSchema","meta","data","result"],"sources":["../../../../../src/server/plugins/engine/types/schema.ts"],"sourcesContent":["import {\n  FormStatus,\n  idSchema,\n  notificationEmailAddressSchema,\n  slugSchema,\n  titleSchema\n} from '@defra/forms-model'\nimport Joi from 'joi'\n\nimport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\nimport {\n  type FormAdapterSubmissionMessageData,\n  type FormAdapterSubmissionMessageMeta,\n  type FormAdapterSubmissionMessagePayload,\n  type FormAdapterSubmissionMessageResult\n} from '~/src/server/plugins/engine/types.js'\n\nexport const formAdapterSubmissionMessageMetaSchema =\n  Joi.object<FormAdapterSubmissionMessageMeta>().keys({\n    schemaVersion: Joi.string().valid(\n      ...Object.values(FormAdapterSubmissionSchemaVersion)\n    ),\n    timestamp: Joi.date().required(),\n    referenceNumber: Joi.string().required(),\n    formName: titleSchema,\n    formId: idSchema,\n    formSlug: slugSchema,\n    status: Joi.string()\n      .valid(...Object.values(FormStatus))\n      .required(),\n    isPreview: Joi.boolean().required(),\n    notificationEmail: notificationEmailAddressSchema.required()\n  })\n\nexport const formAdapterSubmissionMessageDataSchema =\n  Joi.object<FormAdapterSubmissionMessageData>().keys({\n    main: Joi.object(),\n    repeaters: Joi.object(),\n    files: Joi.object().pattern(\n      Joi.string(),\n      Joi.array().items(\n        Joi.object().keys({\n          fileName: Joi.string().required(),\n          fileId: Joi.string().required(),\n          userDownloadLink: Joi.string().required()\n        })\n      )\n    )\n  })\n\nexport const formAdapterSubmissionMessageResultSchema =\n  Joi.object<FormAdapterSubmissionMessageResult>().keys({\n    files: Joi.object()\n      .keys({\n        main: Joi.string().required(),\n        repeaters: Joi.object()\n      })\n      .required()\n  })\n\nexport const formAdapterSubmissionMessagePayloadSchema =\n  Joi.object<FormAdapterSubmissionMessagePayload>().keys({\n    meta: formAdapterSubmissionMessageMetaSchema.required(),\n    data: formAdapterSubmissionMessageDataSchema.required(),\n    result: formAdapterSubmissionMessageResultSchema.required()\n  })\n"],"mappings":"AAAA,SACEA,UAAU,EACVC,QAAQ,EACRC,8BAA8B,EAC9BC,UAAU,EACVC,WAAW,QACN,oBAAoB;AAC3B,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,kCAAkC;AAQ3C,OAAO,MAAMC,sCAAsC,GACjDF,GAAG,CAACG,MAAM,CAAmC,CAAC,CAACC,IAAI,CAAC;EAClDC,aAAa,EAAEL,GAAG,CAACM,MAAM,CAAC,CAAC,CAACC,KAAK,CAC/B,GAAGC,MAAM,CAACC,MAAM,CAACR,kCAAkC,CACrD,CAAC;EACDS,SAAS,EAAEV,GAAG,CAACW,IAAI,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAChCC,eAAe,EAAEb,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;EACxCE,QAAQ,EAAEf,WAAW;EACrBgB,MAAM,EAAEnB,QAAQ;EAChBoB,QAAQ,EAAElB,UAAU;EACpBmB,MAAM,EAAEjB,GAAG,CAACM,MAAM,CAAC,CAAC,CACjBC,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAACd,UAAU,CAAC,CAAC,CACnCiB,QAAQ,CAAC,CAAC;EACbM,SAAS,EAAElB,GAAG,CAACmB,OAAO,CAAC,CAAC,CAACP,QAAQ,CAAC,CAAC;EACnCQ,iBAAiB,EAAEvB,8BAA8B,CAACe,QAAQ,CAAC;AAC7D,CAAC,CAAC;AAEJ,OAAO,MAAMS,sCAAsC,GACjDrB,GAAG,CAACG,MAAM,CAAmC,CAAC,CAACC,IAAI,CAAC;EAClDkB,IAAI,EAAEtB,GAAG,CAACG,MAAM,CAAC,CAAC;EAClBoB,SAAS,EAAEvB,GAAG,CAACG,MAAM,CAAC,CAAC;EACvBqB,KAAK,EAAExB,GAAG,CAACG,MAAM,CAAC,CAAC,CAACsB,OAAO,CACzBzB,GAAG,CAACM,MAAM,CAAC,CAAC,EACZN,GAAG,CAAC0B,KAAK,CAAC,CAAC,CAACC,KAAK,CACf3B,GAAG,CAACG,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;IAChBwB,QAAQ,EAAE5B,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IACjCiB,MAAM,EAAE7B,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IAC/BkB,gBAAgB,EAAE9B,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC;EAC1C,CAAC,CACH,CACF;AACF,CAAC,CAAC;AAEJ,OAAO,MAAMmB,wCAAwC,GACnD/B,GAAG,CAACG,MAAM,CAAqC,CAAC,CAACC,IAAI,CAAC;EACpDoB,KAAK,EAAExB,GAAG,CAACG,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;IACJkB,IAAI,EAAEtB,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IAC7BW,SAAS,EAAEvB,GAAG,CAACG,MAAM,CAAC;EACxB,CAAC,CAAC,CACDS,QAAQ,CAAC;AACd,CAAC,CAAC;AAEJ,OAAO,MAAMoB,yCAAyC,GACpDhC,GAAG,CAACG,MAAM,CAAsC,CAAC,CAACC,IAAI,CAAC;EACrD6B,IAAI,EAAE/B,sCAAsC,CAACU,QAAQ,CAAC,CAAC;EACvDsB,IAAI,EAAEb,sCAAsC,CAACT,QAAQ,CAAC,CAAC;EACvDuB,MAAM,EAAEJ,wCAAwC,CAACnB,QAAQ,CAAC;AAC5D,CAAC,CAAC","ignoreList":[]}

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

@@ -1,10 +1,12 @@
 import { type ComponentDef, type Event, type FormDefinition, type FormMetadata, type Item, type List, type Page } from '@defra/forms-model';
 import { type PluginProperties, type Request } from '@hapi/hapi';
 import { type JoiExpression, type ValidationErrorItem } from 'joi';
+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 BackLink, type ComponentText, type ComponentViewModel } from '~/src/server/plugins/engine/components/types.js';
+import { type FileUploadField } from '~/src/server/plugins/engine/components/index.js';
+import { type BackLink, type ComponentText, 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 { type FileStatus, type FormAdapterSubmissionSchemaVersion, type UploadStatus } from '~/src/server/plugins/engine/types/enums.js';
@@ -294,14 +296,33 @@ export type FormAdapterSubmissionMessageMetaSerialised = Omit<FormAdapterSubmiss
     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 extends FormAdapterSubmissionMessagePayload {
     messageId: string;

package/.server/server/plugins/engine/types.js

@@ -39,4 +39,8 @@
  */
 
 export { FileStatus, UploadStatus } from "./types/enums.js";
+
+/**
+ * A detail item specifically for files
+ */
 //# sourceMappingURL=types.js.map

package/.server/server/plugins/engine/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":["FileStatus","UploadStatus"],"sources":["../../../../src/server/plugins/engine/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Event,\n  type FormDefinition,\n  type FormMetadata,\n  type Item,\n  type List,\n  type Page\n} from '@defra/forms-model'\nimport { type PluginProperties, type Request } from '@hapi/hapi'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type RichFormValue } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport {\n  type FileStatus,\n  type FormAdapterSubmissionSchemaVersion,\n  type UploadStatus\n} from '~/src/server/plugins/engine/types/enums.js'\nimport { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'\nimport {\n  type FormAction,\n  type FormParams,\n  type FormRequest,\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type RequestOptions } from '~/src/server/services/httpService.js'\nimport { type Services } from '~/src/server/types.js'\n\ntype RequestType = Request | FormRequest | FormRequestPayload\n\n/**\n * Form submission state stores the following in Redis:\n * Props containing user's submitted values as `{ [inputId]: value }` or as `{ [sectionName]: { [inputName]: value } }`\n *   a) . e.g:\n * ```ts\n *     {\n *       _C9PRHmsgt: 'Ben',\n *       WfLk9McjzX: 'Music',\n *       IK7jkUFCBL: 'Royal Academy of Music'\n *     }\n * ```\n *\n *   b)\n * ```ts\n *   {\n *         checkBeforeYouStart: { ukPassport: true },\n *         applicantDetails: {\n *           numberOfApplicants: 1,\n *           phoneNumber: '77777777',\n *           emailAddress: 'aaa@aaa.com'\n *         },\n *         applicantOneDetails: {\n *           firstName: 'a',\n *           middleName: 'a',\n *           lastName: 'a',\n *           address: { addressLine1: 'a', addressLine2: 'a', town: 'a', postcode: 'a' }\n *         }\n *     }\n * ```\n */\n\n/**\n * Form submission state\n */\nexport type FormSubmissionState = {\n  upload?: Record<string, TempFileState>\n} & FormState\n\nexport interface FormSubmissionError\n  extends Pick<ValidationErrorItem, 'context' | 'path'> {\n  href: string // e.g: '#dateField__day'\n  name: string // e.g: 'dateField__day'\n  text: string // e.g: 'Date field must be a real date'\n}\n\nexport interface FormPayloadParams {\n  action?: FormAction\n  confirm?: true\n  crumb?: string\n  itemId?: string\n}\n\n/**\n * Form POST for question pages\n * (after Joi has converted value types)\n */\nexport type FormPayload = FormPayloadParams & Partial<Record<string, FormValue>>\n\nexport type FormValue =\n  | Item['value']\n  | Item['value'][]\n  | UploadState\n  | RepeatListState\n  | undefined\n\nexport type FormState = Partial<Record<string, FormStateValue>>\nexport type FormStateValue = Exclude<FormValue, undefined> | null\n\nexport interface FormValidationResult<\n  ValueType extends FormPayload | FormSubmissionState\n> {\n  value: ValueType\n  errors: FormSubmissionError[] | undefined\n}\n\nexport interface FormContext {\n  /**\n   * Evaluation form state only (filtered by visited paths),\n   * with values formatted for condition evaluation using\n   * {@link FormComponent.getContextValueFromState}\n   */\n  evaluationState: FormState\n\n  /**\n   * Relevant form state only (filtered by visited paths)\n   */\n  relevantState: FormState\n\n  /**\n   * Relevant pages only (filtered by visited paths)\n   */\n  relevantPages: PageControllerClass[]\n\n  /**\n   * Form submission payload (single page)\n   */\n  payload: FormPayload\n\n  /**\n   * Form submission state (entire form)\n   */\n  state: FormSubmissionState\n\n  /**\n   * Validation errors (entire form)\n   */\n  errors?: FormSubmissionError[]\n\n  /**\n   * Visited paths evaluated from form state\n   */\n  paths: string[]\n\n  /**\n   * Preview URL direct access is allowed\n   */\n  isForceAccess: boolean\n\n  /**\n   * Miscellaneous extra data from event responses\n   */\n  data: object\n\n  pageDefMap: Map<string, Page>\n  listDefMap: Map<string, List>\n  componentDefMap: Map<string, ComponentDef>\n  pageMap: Map<string, PageControllerClass>\n  componentMap: Map<string, Component>\n  referenceNumber: string\n}\n\nexport type FormContextRequest = (\n  | {\n      method: 'get'\n      payload?: undefined\n    }\n  | {\n      method: 'post'\n      payload: FormPayload\n    }\n  | {\n      method: FormRequest['method']\n      payload?: object | undefined\n    }\n) &\n  Pick<\n    FormRequest,\n    'app' | 'method' | 'params' | 'path' | 'query' | 'url' | 'server'\n  >\n\nexport interface UploadInitiateResponse {\n  uploadId: string\n  uploadUrl: string\n  statusUrl: string\n}\n\nexport {\n  FileStatus,\n  UploadStatus\n} from '~/src/server/plugins/engine/types/enums.js'\n\nexport type UploadState = FileState[]\n\nexport type FileUpload = {\n  fileId: string\n  filename: string\n  contentLength: number\n} & (\n  | {\n      fileStatus: FileStatus.complete | FileStatus.rejected | FileStatus.pending\n      errorMessage?: string\n    }\n  | {\n      fileStatus: FileStatus.complete\n      errorMessage?: undefined\n    }\n)\n\nexport interface FileUploadMetadata {\n  retrievalKey: string\n}\n\nexport type UploadStatusResponse =\n  | {\n      uploadStatus: UploadStatus.initiated\n      metadata: FileUploadMetadata\n      form: { file?: undefined }\n    }\n  | {\n      uploadStatus: UploadStatus.pending | UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles?: number\n    }\n  | {\n      uploadStatus: UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles: 0\n    }\n\nexport type UploadStatusFileResponse = Exclude<\n  UploadStatusResponse,\n  { uploadStatus: UploadStatus.initiated }\n>\n\nexport interface FileState {\n  uploadId: string\n  status: UploadStatusFileResponse\n}\n\nexport interface TempFileState {\n  upload?: UploadInitiateResponse\n  files: UploadState\n}\n\nexport interface RepeatItemState extends FormPayload {\n  itemId: string\n}\n\nexport type RepeatListState = RepeatItemState[]\n\nexport interface CheckAnswers {\n  title?: ComponentText\n  summaryList: SummaryList\n}\n\nexport interface SummaryList {\n  classes?: string\n  rows: SummaryListRow[]\n}\n\nexport interface SummaryListRow {\n  key: ComponentText\n  value: ComponentText\n  actions?: { items: SummaryListAction[] }\n}\n\nexport type SummaryListAction = ComponentText & {\n  href: string\n  visuallyHiddenText: string\n}\n\nexport interface PageViewModelBase extends Partial<ViewContext> {\n  page: PageController\n  name?: string\n  pageTitle: string\n  sectionTitle?: string\n  showTitle: boolean\n  isStartPage: boolean\n  backLink?: BackLink\n  feedbackLink?: string\n  serviceUrl: string\n  phaseTag?: string\n}\n\nexport interface ItemDeletePageViewModel extends PageViewModelBase {\n  context: FormContext\n  itemTitle: string\n  confirmation?: ComponentText\n  buttonConfirm: ComponentText\n  buttonCancel: ComponentText\n}\n\nexport interface FormPageViewModel extends PageViewModelBase {\n  components: ComponentViewModel[]\n  context: FormContext\n  errors?: FormSubmissionError[]\n  hasMissingNotificationEmail?: boolean\n  allowSaveAndReturn: boolean\n}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\n}\n\nexport interface FeaturedFormPageViewModel extends FormPageViewModel {\n  formAction?: string\n  formComponent: ComponentViewModel\n  componentsBefore: ComponentViewModel[]\n  uploadId: string | undefined\n  proxyUrl: string | null\n}\n\nexport type PageViewModel =\n  | PageViewModelBase\n  | ItemDeletePageViewModel\n  | FormPageViewModel\n  | RepeaterSummaryPageViewModel\n  | FeaturedFormPageViewModel\n\nexport type GlobalFunction = (value: unknown) => unknown\nexport type FilterFunction = (value: unknown) => unknown\nexport interface ErrorMessageTemplate {\n  type: string\n  template: JoiExpression\n}\n\nexport interface ErrorMessageTemplateList {\n  baseErrors: ErrorMessageTemplate[]\n  advancedSettingsErrors: ErrorMessageTemplate[]\n}\n\nexport type PreparePageEventRequestOptions = (\n  options: RequestOptions,\n  event: Event,\n  page: PageControllerClass,\n  context: FormContext\n) => void\n\nexport type OnRequestCallback = (\n  request: FormRequest | FormRequestPayload,\n  params: FormParams,\n  definition: FormDefinition,\n  metadata: FormMetadata\n) => void\n\nexport interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cacheName?: string\n  globals?: Record<string, GlobalFunction>\n  filters?: Record<string, FilterFunction>\n  saveAndReturn?: {\n    keyGenerator: (request: RequestType) => string\n    sessionHydrator: (request: RequestType) => Promise<FormSubmissionState>\n    sessionPersister: (\n      state: FormSubmissionState,\n      request: RequestType\n    ) => Promise<void>\n  }\n  pluginPath?: string\n  nunjucks: {\n    baseLayoutPath: string\n    paths: string[]\n  }\n  viewContext: PluginProperties['forms-engine-plugin']['viewContext']\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  baseUrl: string // base URL of the application, protocol and hostname e.g. \"https://myapp.com\"\n}\n\nexport interface FormAdapterSubmissionMessageMeta {\n  schemaVersion: FormAdapterSubmissionSchemaVersion\n  timestamp: Date\n  referenceNumber: string\n  formName: string\n  formId: string\n  formSlug: string\n  status: FormStatus\n  isPreview: boolean\n  notificationEmail: string\n}\n\nexport type FormAdapterSubmissionMessageMetaSerialised = Omit<\n  FormAdapterSubmissionMessageMeta,\n  'schemaVersion' | 'timestamp' | 'status'\n> & {\n  schemaVersion: number\n  status: string\n  timestamp: string\n}\n\nexport interface FormAdapterSubmissionMessageData {\n  main: Record<string, RichFormValue>\n  repeaters: Record<string, Record<string, RichFormValue>[]>\n  files: Record<string, Record<string, string>[]>\n}\n\nexport interface FormAdapterSubmissionMessagePayload {\n  meta: FormAdapterSubmissionMessageMeta\n  data: FormAdapterSubmissionMessageData\n}\n\nexport interface FormAdapterSubmissionMessage\n  extends FormAdapterSubmissionMessagePayload {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface FormAdapterSubmissionService {\n  handleFormSubmission: (\n    submissionMessage: FormAdapterSubmissionMessage\n  ) => unknown\n}\n"],"mappings":"AAyCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAmBA;AACA;AACA;AACA;;AAqGA,SACEA,UAAU,EACVC,YAAY","ignoreList":[]}
+{"version":3,"file":"types.js","names":["FileStatus","UploadStatus"],"sources":["../../../../src/server/plugins/engine/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Event,\n  type FormDefinition,\n  type FormMetadata,\n  type Item,\n  type List,\n  type Page\n} from '@defra/forms-model'\nimport { type PluginProperties, type Request } from '@hapi/hapi'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport { type FileUploadField } from '~/src/server/plugins/engine/components/index.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel,\n  type DatePartsState,\n  type MonthYearState\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItemField } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport {\n  type FileStatus,\n  type FormAdapterSubmissionSchemaVersion,\n  type UploadStatus\n} from '~/src/server/plugins/engine/types/enums.js'\nimport { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'\nimport {\n  type FormAction,\n  type FormParams,\n  type FormRequest,\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type RequestOptions } from '~/src/server/services/httpService.js'\nimport { type Services } from '~/src/server/types.js'\n\ntype RequestType = Request | FormRequest | FormRequestPayload\n\n/**\n * Form submission state stores the following in Redis:\n * Props containing user's submitted values as `{ [inputId]: value }` or as `{ [sectionName]: { [inputName]: value } }`\n *   a) . e.g:\n * ```ts\n *     {\n *       _C9PRHmsgt: 'Ben',\n *       WfLk9McjzX: 'Music',\n *       IK7jkUFCBL: 'Royal Academy of Music'\n *     }\n * ```\n *\n *   b)\n * ```ts\n *   {\n *         checkBeforeYouStart: { ukPassport: true },\n *         applicantDetails: {\n *           numberOfApplicants: 1,\n *           phoneNumber: '77777777',\n *           emailAddress: 'aaa@aaa.com'\n *         },\n *         applicantOneDetails: {\n *           firstName: 'a',\n *           middleName: 'a',\n *           lastName: 'a',\n *           address: { addressLine1: 'a', addressLine2: 'a', town: 'a', postcode: 'a' }\n *         }\n *     }\n * ```\n */\n\n/**\n * Form submission state\n */\nexport type FormSubmissionState = {\n  upload?: Record<string, TempFileState>\n} & FormState\n\nexport interface FormSubmissionError\n  extends Pick<ValidationErrorItem, 'context' | 'path'> {\n  href: string // e.g: '#dateField__day'\n  name: string // e.g: 'dateField__day'\n  text: string // e.g: 'Date field must be a real date'\n}\n\nexport interface FormPayloadParams {\n  action?: FormAction\n  confirm?: true\n  crumb?: string\n  itemId?: string\n}\n\n/**\n * Form POST for question pages\n * (after Joi has converted value types)\n */\nexport type FormPayload = FormPayloadParams & Partial<Record<string, FormValue>>\n\nexport type FormValue =\n  | Item['value']\n  | Item['value'][]\n  | UploadState\n  | RepeatListState\n  | undefined\n\nexport type FormState = Partial<Record<string, FormStateValue>>\nexport type FormStateValue = Exclude<FormValue, undefined> | null\n\nexport interface FormValidationResult<\n  ValueType extends FormPayload | FormSubmissionState\n> {\n  value: ValueType\n  errors: FormSubmissionError[] | undefined\n}\n\nexport interface FormContext {\n  /**\n   * Evaluation form state only (filtered by visited paths),\n   * with values formatted for condition evaluation using\n   * {@link FormComponent.getContextValueFromState}\n   */\n  evaluationState: FormState\n\n  /**\n   * Relevant form state only (filtered by visited paths)\n   */\n  relevantState: FormState\n\n  /**\n   * Relevant pages only (filtered by visited paths)\n   */\n  relevantPages: PageControllerClass[]\n\n  /**\n   * Form submission payload (single page)\n   */\n  payload: FormPayload\n\n  /**\n   * Form submission state (entire form)\n   */\n  state: FormSubmissionState\n\n  /**\n   * Validation errors (entire form)\n   */\n  errors?: FormSubmissionError[]\n\n  /**\n   * Visited paths evaluated from form state\n   */\n  paths: string[]\n\n  /**\n   * Preview URL direct access is allowed\n   */\n  isForceAccess: boolean\n\n  /**\n   * Miscellaneous extra data from event responses\n   */\n  data: object\n\n  pageDefMap: Map<string, Page>\n  listDefMap: Map<string, List>\n  componentDefMap: Map<string, ComponentDef>\n  pageMap: Map<string, PageControllerClass>\n  componentMap: Map<string, Component>\n  referenceNumber: string\n}\n\nexport type FormContextRequest = (\n  | {\n      method: 'get'\n      payload?: undefined\n    }\n  | {\n      method: 'post'\n      payload: FormPayload\n    }\n  | {\n      method: FormRequest['method']\n      payload?: object | undefined\n    }\n) &\n  Pick<\n    FormRequest,\n    'app' | 'method' | 'params' | 'path' | 'query' | 'url' | 'server'\n  >\n\nexport interface UploadInitiateResponse {\n  uploadId: string\n  uploadUrl: string\n  statusUrl: string\n}\n\nexport {\n  FileStatus,\n  UploadStatus\n} from '~/src/server/plugins/engine/types/enums.js'\n\nexport type UploadState = FileState[]\n\nexport type FileUpload = {\n  fileId: string\n  filename: string\n  contentLength: number\n} & (\n  | {\n      fileStatus: FileStatus.complete | FileStatus.rejected | FileStatus.pending\n      errorMessage?: string\n    }\n  | {\n      fileStatus: FileStatus.complete\n      errorMessage?: undefined\n    }\n)\n\nexport interface FileUploadMetadata {\n  retrievalKey: string\n}\n\nexport type UploadStatusResponse =\n  | {\n      uploadStatus: UploadStatus.initiated\n      metadata: FileUploadMetadata\n      form: { file?: undefined }\n    }\n  | {\n      uploadStatus: UploadStatus.pending | UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles?: number\n    }\n  | {\n      uploadStatus: UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles: 0\n    }\n\nexport type UploadStatusFileResponse = Exclude<\n  UploadStatusResponse,\n  { uploadStatus: UploadStatus.initiated }\n>\n\nexport interface FileState {\n  uploadId: string\n  status: UploadStatusFileResponse\n}\n\nexport interface TempFileState {\n  upload?: UploadInitiateResponse\n  files: UploadState\n}\n\nexport interface RepeatItemState extends FormPayload {\n  itemId: string\n}\n\nexport type RepeatListState = RepeatItemState[]\n\nexport interface CheckAnswers {\n  title?: ComponentText\n  summaryList: SummaryList\n}\n\nexport interface SummaryList {\n  classes?: string\n  rows: SummaryListRow[]\n}\n\nexport interface SummaryListRow {\n  key: ComponentText\n  value: ComponentText\n  actions?: { items: SummaryListAction[] }\n}\n\nexport type SummaryListAction = ComponentText & {\n  href: string\n  visuallyHiddenText: string\n}\n\nexport interface PageViewModelBase extends Partial<ViewContext> {\n  page: PageController\n  name?: string\n  pageTitle: string\n  sectionTitle?: string\n  showTitle: boolean\n  isStartPage: boolean\n  backLink?: BackLink\n  feedbackLink?: string\n  serviceUrl: string\n  phaseTag?: string\n}\n\nexport interface ItemDeletePageViewModel extends PageViewModelBase {\n  context: FormContext\n  itemTitle: string\n  confirmation?: ComponentText\n  buttonConfirm: ComponentText\n  buttonCancel: ComponentText\n}\n\nexport interface FormPageViewModel extends PageViewModelBase {\n  components: ComponentViewModel[]\n  context: FormContext\n  errors?: FormSubmissionError[]\n  hasMissingNotificationEmail?: boolean\n  allowSaveAndReturn: boolean\n}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\n}\n\nexport interface FeaturedFormPageViewModel extends FormPageViewModel {\n  formAction?: string\n  formComponent: ComponentViewModel\n  componentsBefore: ComponentViewModel[]\n  uploadId: string | undefined\n  proxyUrl: string | null\n}\n\nexport type PageViewModel =\n  | PageViewModelBase\n  | ItemDeletePageViewModel\n  | FormPageViewModel\n  | RepeaterSummaryPageViewModel\n  | FeaturedFormPageViewModel\n\nexport type GlobalFunction = (value: unknown) => unknown\nexport type FilterFunction = (value: unknown) => unknown\nexport interface ErrorMessageTemplate {\n  type: string\n  template: JoiExpression\n}\n\nexport interface ErrorMessageTemplateList {\n  baseErrors: ErrorMessageTemplate[]\n  advancedSettingsErrors: ErrorMessageTemplate[]\n}\n\nexport type PreparePageEventRequestOptions = (\n  options: RequestOptions,\n  event: Event,\n  page: PageControllerClass,\n  context: FormContext\n) => void\n\nexport type OnRequestCallback = (\n  request: FormRequest | FormRequestPayload,\n  params: FormParams,\n  definition: FormDefinition,\n  metadata: FormMetadata\n) => void\n\nexport interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cacheName?: string\n  globals?: Record<string, GlobalFunction>\n  filters?: Record<string, FilterFunction>\n  saveAndReturn?: {\n    keyGenerator: (request: RequestType) => string\n    sessionHydrator: (request: RequestType) => Promise<FormSubmissionState>\n    sessionPersister: (\n      state: FormSubmissionState,\n      request: RequestType\n    ) => Promise<void>\n  }\n  pluginPath?: string\n  nunjucks: {\n    baseLayoutPath: string\n    paths: string[]\n  }\n  viewContext: PluginProperties['forms-engine-plugin']['viewContext']\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  baseUrl: string // base URL of the application, protocol and hostname e.g. \"https://myapp.com\"\n}\n\nexport interface FormAdapterSubmissionMessageMeta {\n  schemaVersion: FormAdapterSubmissionSchemaVersion\n  timestamp: Date\n  referenceNumber: string\n  formName: string\n  formId: string\n  formSlug: string\n  status: FormStatus\n  isPreview: boolean\n  notificationEmail: string\n}\n\nexport type FormAdapterSubmissionMessageMetaSerialised = Omit<\n  FormAdapterSubmissionMessageMeta,\n  'schemaVersion' | 'timestamp' | 'status'\n> & {\n  schemaVersion: number\n  status: string\n  timestamp: string\n}\nexport interface FormAdapterFile {\n  fileName: string\n  fileId: string\n  userDownloadLink: string\n}\n\nexport interface FormAdapterSubmissionMessageResult {\n  files: {\n    main: string\n    repeaters: Record<string, string>\n  }\n}\n\n/**\n * A detail item specifically for files\n */\nexport type FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {\n  field: FileUploadField\n}\nexport type RichFormValue =\n  | FormValue\n  | FormPayload\n  | DatePartsState\n  | MonthYearState\n  | UkAddressState\n\nexport interface FormAdapterSubmissionMessageData {\n  main: Record<string, RichFormValue>\n  repeaters: Record<string, Record<string, RichFormValue>[]>\n  files: Record<string, FormAdapterFile[]>\n}\n\nexport interface FormAdapterSubmissionMessagePayload {\n  meta: FormAdapterSubmissionMessageMeta\n  data: FormAdapterSubmissionMessageData\n  result: FormAdapterSubmissionMessageResult\n}\n\nexport interface FormAdapterSubmissionMessage\n  extends FormAdapterSubmissionMessagePayload {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface FormAdapterSubmissionService {\n  handleFormSubmission: (\n    submissionMessage: FormAdapterSubmissionMessage\n  ) => unknown\n}\n"],"mappings":"AA6CA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAmBA;AACA;AACA;AACA;;AAqGA,SACEA,UAAU,EACVC,YAAY;;AA6Nd;AACA;AACA","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "2.1.8",
+  "version": "2.1.9",
   "description": "Defra forms engine",
   "type": "module",
   "files": [

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'

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