@defra/forms-engine-plugin 2.1.4 → 2.1.5

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

@@ -0,0 +1,6 @@
+import { type FormMetadata, type SubmitResponsePayload } from '@defra/forms-model';
+import { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js';
+import { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js';
+import { type DetailItem } from '~/src/server/plugins/engine/models/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>, formMetadata?: FormMetadata): string;

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

@@ -0,0 +1,23 @@
+import { format as machineV2 } from "../machine/v2.js";
+import { FormAdapterSubmissionSchemaVersion } from "../../types.js";
+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 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
+  };
+  return JSON.stringify(payload);
+}
+//# sourceMappingURL=v1.js.map

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

@@ -0,0 +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 {\n  FormAdapterSubmissionSchemaVersion,\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,SACEC,kCAAkC;AAKpC,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":[]}

package/.server/server/plugins/engine/outputFormatters/human/v1.d.ts

@@ -1,6 +1,6 @@
-import { type SubmitResponsePayload } from '@defra/forms-model';
+import { type FormMetadata, type SubmitResponsePayload } from '@defra/forms-model';
 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 } 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 declare function format(_context: FormContext, items: DetailItem[], model: FormModel, submitResponse: SubmitResponsePayload, formStatus: ReturnType<typeof checkFormStatus>, _formMetadata?: FormMetadata): string;

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

@@ -2,7 +2,7 @@ import { addDays, format as dateFormat } from 'date-fns';
 import { config } from "../../../../../config/index.js";
 import { escapeMarkdown, getAnswer } from "../../components/helpers.js";
 const designerUrl = config.get('designerUrl');
-export function format(_context, items, model, submitResponse, formStatus) {
+export function format(_context, items, model, submitResponse, formStatus, _formMetadata) {
   const {
     files
   } = submitResponse.result;

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

@@ -1 +1 @@
-{"version":3,"file":"v1.js","names":["addDays","format","dateFormat","config","escapeMarkdown","getAnswer","designerUrl","get","_context","items","model","submitResponse","formStatus","files","result","formName","name","now","Date","formattedNow","fileExpiryDate","formattedExpiryDate","lines","push","isPreview","state","forEach","item","label","filename","fileId","repeaters","field","main","join"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/human/v1.ts"],"sourcesContent":["import { type SubmitResponsePayload } from '@defra/forms-model'\nimport { addDays, format as dateFormat } from 'date-fns'\n\nimport { config } from '~/src/config/index.js'\nimport {\n  escapeMarkdown,\n  getAnswer\n} from '~/src/server/plugins/engine/components/helpers.js'\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type FormContext } 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 { files } = submitResponse.result\n\n  const formName = escapeMarkdown(model.name)\n\n  /**\n   * @todo Refactor this below but the code to\n   * generate the question and answers works for now\n   */\n  const now = new Date()\n  const formattedNow = `${dateFormat(now, 'h:mmaaa')} on ${dateFormat(now, 'd MMMM yyyy')}`\n\n  const fileExpiryDate = addDays(now, 90)\n  const formattedExpiryDate = `${dateFormat(fileExpiryDate, 'h:mmaaa')} on ${dateFormat(fileExpiryDate, 'eeee d MMMM yyyy')}`\n\n  const lines: string[] = []\n\n  lines.push(\n    `^ For security reasons, the links in this email expire at ${escapeMarkdown(formattedExpiryDate)}\\n`\n  )\n\n  if (formStatus.isPreview) {\n    lines.push(`This is a test of the ${formName} ${formStatus.state} form.\\n`)\n  }\n\n  lines.push(`${formName} form received at ${escapeMarkdown(formattedNow)}.\\n`)\n  lines.push('---\\n')\n\n  items.forEach((item) => {\n    const label = escapeMarkdown(item.label)\n\n    lines.push(`## ${label}\\n`)\n\n    if ('subItems' in item) {\n      const filename = escapeMarkdown(`Download ${label} (CSV)`)\n      const fileId = files.repeaters[item.name]\n\n      lines.push(`[${filename}](${designerUrl}/file-download/${fileId})\\n`)\n    } else {\n      lines.push(\n        getAnswer(item.field, item.state, {\n          format: 'email'\n        })\n      )\n    }\n\n    lines.push('---\\n')\n  })\n\n  const filename = escapeMarkdown('Download main form (CSV)')\n  lines.push(`[${filename}](${designerUrl}/file-download/${files.main})\\n`)\n\n  return lines.join('\\n')\n}\n"],"mappings":"AACA,SAASA,OAAO,EAAEC,MAAM,IAAIC,UAAU,QAAQ,UAAU;AAExD,SAASC,MAAM;AACf,SACEC,cAAc,EACdC,SAAS;AAOX,MAAMC,WAAW,GAAGH,MAAM,CAACI,GAAG,CAAC,aAAa,CAAC;AAE7C,OAAO,SAASN,MAAMA,CACpBO,QAAqB,EACrBC,KAAmB,EACnBC,KAAgB,EAChBC,cAAqC,EACrCC,UAA8C,EAC9C;EACA,MAAM;IAAEC;EAAM,CAAC,GAAGF,cAAc,CAACG,MAAM;EAEvC,MAAMC,QAAQ,GAAGX,cAAc,CAACM,KAAK,CAACM,IAAI,CAAC;;EAE3C;AACF;AACA;AACA;EACE,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;EACtB,MAAMC,YAAY,GAAG,GAAGjB,UAAU,CAACe,GAAG,EAAE,SAAS,CAAC,OAAOf,UAAU,CAACe,GAAG,EAAE,aAAa,CAAC,EAAE;EAEzF,MAAMG,cAAc,GAAGpB,OAAO,CAACiB,GAAG,EAAE,EAAE,CAAC;EACvC,MAAMI,mBAAmB,GAAG,GAAGnB,UAAU,CAACkB,cAAc,EAAE,SAAS,CAAC,OAAOlB,UAAU,CAACkB,cAAc,EAAE,kBAAkB,CAAC,EAAE;EAE3H,MAAME,KAAe,GAAG,EAAE;EAE1BA,KAAK,CAACC,IAAI,CACR,6DAA6DnB,cAAc,CAACiB,mBAAmB,CAAC,IAClG,CAAC;EAED,IAAIT,UAAU,CAACY,SAAS,EAAE;IACxBF,KAAK,CAACC,IAAI,CAAC,yBAAyBR,QAAQ,IAAIH,UAAU,CAACa,KAAK,UAAU,CAAC;EAC7E;EAEAH,KAAK,CAACC,IAAI,CAAC,GAAGR,QAAQ,qBAAqBX,cAAc,CAACe,YAAY,CAAC,KAAK,CAAC;EAC7EG,KAAK,CAACC,IAAI,CAAC,OAAO,CAAC;EAEnBd,KAAK,CAACiB,OAAO,CAAEC,IAAI,IAAK;IACtB,MAAMC,KAAK,GAAGxB,cAAc,CAACuB,IAAI,CAACC,KAAK,CAAC;IAExCN,KAAK,CAACC,IAAI,CAAC,MAAMK,KAAK,IAAI,CAAC;IAE3B,IAAI,UAAU,IAAID,IAAI,EAAE;MACtB,MAAME,QAAQ,GAAGzB,cAAc,CAAC,YAAYwB,KAAK,QAAQ,CAAC;MAC1D,MAAME,MAAM,GAAGjB,KAAK,CAACkB,SAAS,CAACJ,IAAI,CAACX,IAAI,CAAC;MAEzCM,KAAK,CAACC,IAAI,CAAC,IAAIM,QAAQ,KAAKvB,WAAW,kBAAkBwB,MAAM,KAAK,CAAC;IACvE,CAAC,MAAM;MACLR,KAAK,CAACC,IAAI,CACRlB,SAAS,CAACsB,IAAI,CAACK,KAAK,EAAEL,IAAI,CAACF,KAAK,EAAE;QAChCxB,MAAM,EAAE;MACV,CAAC,CACH,CAAC;IACH;IAEAqB,KAAK,CAACC,IAAI,CAAC,OAAO,CAAC;EACrB,CAAC,CAAC;EAEF,MAAMM,QAAQ,GAAGzB,cAAc,CAAC,0BAA0B,CAAC;EAC3DkB,KAAK,CAACC,IAAI,CAAC,IAAIM,QAAQ,KAAKvB,WAAW,kBAAkBO,KAAK,CAACoB,IAAI,KAAK,CAAC;EAEzE,OAAOX,KAAK,CAACY,IAAI,CAAC,IAAI,CAAC;AACzB","ignoreList":[]}
+{"version":3,"file":"v1.js","names":["addDays","format","dateFormat","config","escapeMarkdown","getAnswer","designerUrl","get","_context","items","model","submitResponse","formStatus","_formMetadata","files","result","formName","name","now","Date","formattedNow","fileExpiryDate","formattedExpiryDate","lines","push","isPreview","state","forEach","item","label","filename","fileId","repeaters","field","main","join"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/human/v1.ts"],"sourcesContent":["import {\n  type FormMetadata,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\nimport { addDays, format as dateFormat } from 'date-fns'\n\nimport { config } from '~/src/config/index.js'\nimport {\n  escapeMarkdown,\n  getAnswer\n} from '~/src/server/plugins/engine/components/helpers.js'\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type FormContext } 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  _formMetadata?: FormMetadata\n) {\n  const { files } = submitResponse.result\n\n  const formName = escapeMarkdown(model.name)\n\n  /**\n   * @todo Refactor this below but the code to\n   * generate the question and answers works for now\n   */\n  const now = new Date()\n  const formattedNow = `${dateFormat(now, 'h:mmaaa')} on ${dateFormat(now, 'd MMMM yyyy')}`\n\n  const fileExpiryDate = addDays(now, 90)\n  const formattedExpiryDate = `${dateFormat(fileExpiryDate, 'h:mmaaa')} on ${dateFormat(fileExpiryDate, 'eeee d MMMM yyyy')}`\n\n  const lines: string[] = []\n\n  lines.push(\n    `^ For security reasons, the links in this email expire at ${escapeMarkdown(formattedExpiryDate)}\\n`\n  )\n\n  if (formStatus.isPreview) {\n    lines.push(`This is a test of the ${formName} ${formStatus.state} form.\\n`)\n  }\n\n  lines.push(`${formName} form received at ${escapeMarkdown(formattedNow)}.\\n`)\n  lines.push('---\\n')\n\n  items.forEach((item) => {\n    const label = escapeMarkdown(item.label)\n\n    lines.push(`## ${label}\\n`)\n\n    if ('subItems' in item) {\n      const filename = escapeMarkdown(`Download ${label} (CSV)`)\n      const fileId = files.repeaters[item.name]\n\n      lines.push(`[${filename}](${designerUrl}/file-download/${fileId})\\n`)\n    } else {\n      lines.push(\n        getAnswer(item.field, item.state, {\n          format: 'email'\n        })\n      )\n    }\n\n    lines.push('---\\n')\n  })\n\n  const filename = escapeMarkdown('Download main form (CSV)')\n  lines.push(`[${filename}](${designerUrl}/file-download/${files.main})\\n`)\n\n  return lines.join('\\n')\n}\n"],"mappings":"AAIA,SAASA,OAAO,EAAEC,MAAM,IAAIC,UAAU,QAAQ,UAAU;AAExD,SAASC,MAAM;AACf,SACEC,cAAc,EACdC,SAAS;AAOX,MAAMC,WAAW,GAAGH,MAAM,CAACI,GAAG,CAAC,aAAa,CAAC;AAE7C,OAAO,SAASN,MAAMA,CACpBO,QAAqB,EACrBC,KAAmB,EACnBC,KAAgB,EAChBC,cAAqC,EACrCC,UAA8C,EAC9CC,aAA4B,EAC5B;EACA,MAAM;IAAEC;EAAM,CAAC,GAAGH,cAAc,CAACI,MAAM;EAEvC,MAAMC,QAAQ,GAAGZ,cAAc,CAACM,KAAK,CAACO,IAAI,CAAC;;EAE3C;AACF;AACA;AACA;EACE,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;EACtB,MAAMC,YAAY,GAAG,GAAGlB,UAAU,CAACgB,GAAG,EAAE,SAAS,CAAC,OAAOhB,UAAU,CAACgB,GAAG,EAAE,aAAa,CAAC,EAAE;EAEzF,MAAMG,cAAc,GAAGrB,OAAO,CAACkB,GAAG,EAAE,EAAE,CAAC;EACvC,MAAMI,mBAAmB,GAAG,GAAGpB,UAAU,CAACmB,cAAc,EAAE,SAAS,CAAC,OAAOnB,UAAU,CAACmB,cAAc,EAAE,kBAAkB,CAAC,EAAE;EAE3H,MAAME,KAAe,GAAG,EAAE;EAE1BA,KAAK,CAACC,IAAI,CACR,6DAA6DpB,cAAc,CAACkB,mBAAmB,CAAC,IAClG,CAAC;EAED,IAAIV,UAAU,CAACa,SAAS,EAAE;IACxBF,KAAK,CAACC,IAAI,CAAC,yBAAyBR,QAAQ,IAAIJ,UAAU,CAACc,KAAK,UAAU,CAAC;EAC7E;EAEAH,KAAK,CAACC,IAAI,CAAC,GAAGR,QAAQ,qBAAqBZ,cAAc,CAACgB,YAAY,CAAC,KAAK,CAAC;EAC7EG,KAAK,CAACC,IAAI,CAAC,OAAO,CAAC;EAEnBf,KAAK,CAACkB,OAAO,CAAEC,IAAI,IAAK;IACtB,MAAMC,KAAK,GAAGzB,cAAc,CAACwB,IAAI,CAACC,KAAK,CAAC;IAExCN,KAAK,CAACC,IAAI,CAAC,MAAMK,KAAK,IAAI,CAAC;IAE3B,IAAI,UAAU,IAAID,IAAI,EAAE;MACtB,MAAME,QAAQ,GAAG1B,cAAc,CAAC,YAAYyB,KAAK,QAAQ,CAAC;MAC1D,MAAME,MAAM,GAAGjB,KAAK,CAACkB,SAAS,CAACJ,IAAI,CAACX,IAAI,CAAC;MAEzCM,KAAK,CAACC,IAAI,CAAC,IAAIM,QAAQ,KAAKxB,WAAW,kBAAkByB,MAAM,KAAK,CAAC;IACvE,CAAC,MAAM;MACLR,KAAK,CAACC,IAAI,CACRnB,SAAS,CAACuB,IAAI,CAACK,KAAK,EAAEL,IAAI,CAACF,KAAK,EAAE;QAChCzB,MAAM,EAAE;MACV,CAAC,CACH,CAAC;IACH;IAEAsB,KAAK,CAACC,IAAI,CAAC,OAAO,CAAC;EACrB,CAAC,CAAC;EAEF,MAAMM,QAAQ,GAAG1B,cAAc,CAAC,0BAA0B,CAAC;EAC3DmB,KAAK,CAACC,IAAI,CAAC,IAAIM,QAAQ,KAAKxB,WAAW,kBAAkBQ,KAAK,CAACoB,IAAI,KAAK,CAAC;EAEzE,OAAOX,KAAK,CAACY,IAAI,CAAC,IAAI,CAAC;AACzB","ignoreList":[]}

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

@@ -1,8 +1,9 @@
-import { type SubmitResponsePayload } from '@defra/forms-model';
+import { type FormMetadata, type SubmitResponsePayload } from '@defra/forms-model';
 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 { format as formatAdapterV1 } from '~/src/server/plugins/engine/outputFormatters/adapter/v1.js';
 import { type FormContext } from '~/src/server/plugins/engine/types.js';
-type Formatter = (context: FormContext, items: DetailItem[], model: FormModel, submitResponse: SubmitResponsePayload, formStatus: ReturnType<typeof checkFormStatus>) => string;
-export declare function getFormatter(audience: string, version: string): Formatter;
+type Formatter = (context: FormContext, items: DetailItem[], model: FormModel, submitResponse: SubmitResponsePayload, formStatus: ReturnType<typeof checkFormStatus>, formMetadata?: FormMetadata) => string;
+export declare function getFormatter(audience: string, version: string): Formatter | typeof formatAdapterV1;
 export {};

package/.server/server/plugins/engine/outputFormatters/index.js

@@ -1,3 +1,4 @@
+import { format as formatAdapterV1 } from "./adapter/v1.js";
 import { format as formatHumanV1 } from "./human/v1.js";
 import { format as formatMachineV1 } from "./machine/v1.js";
 import { format as formatMachineV2 } from "./machine/v2.js";
@@ -8,6 +9,9 @@ const formatters = {
   machine: {
     '1': formatMachineV1,
     '2': formatMachineV2
+  },
+  adapter: {
+    '1': formatAdapterV1
   }
 };
 export function getFormatter(audience, version) {

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["format","formatHumanV1","formatMachineV1","formatMachineV2","formatters","human","machine","getFormatter","audience","version","versions","Error","formatter"],"sources":["../../../../../src/server/plugins/engine/outputFormatters/index.ts"],"sourcesContent":["import { type SubmitResponsePayload } from '@defra/forms-model'\n\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { format as formatHumanV1 } from '~/src/server/plugins/engine/outputFormatters/human/v1.js'\nimport { format as formatMachineV1 } from '~/src/server/plugins/engine/outputFormatters/machine/v1.js'\nimport { format as formatMachineV2 } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'\nimport { type FormContext } from '~/src/server/plugins/engine/types.js'\n\ntype Formatter = (\n  context: FormContext,\n  items: DetailItem[],\n  model: FormModel,\n  submitResponse: SubmitResponsePayload,\n  formStatus: ReturnType<typeof checkFormStatus>\n) => string\n\nconst formatters: Record<\n  string,\n  Record<string, Formatter | undefined> | undefined\n> = {\n  human: {\n    '1': formatHumanV1\n  },\n  machine: {\n    '1': formatMachineV1,\n    '2': formatMachineV2\n  }\n}\n\nexport function getFormatter(audience: string, version: string) {\n  const versions = formatters[audience]\n\n  if (!versions) {\n    throw new Error('Unknown audience')\n  }\n\n  const formatter = versions[version]\n\n  if (!formatter) {\n    throw new Error('Unknown version')\n  }\n\n  return formatter\n}\n"],"mappings":"AAKA,SAASA,MAAM,IAAIC,aAAa;AAChC,SAASD,MAAM,IAAIE,eAAe;AAClC,SAASF,MAAM,IAAIG,eAAe;AAWlC,MAAMC,UAGL,GAAG;EACFC,KAAK,EAAE;IACL,GAAG,EAAEJ;EACP,CAAC;EACDK,OAAO,EAAE;IACP,GAAG,EAAEJ,eAAe;IACpB,GAAG,EAAEC;EACP;AACF,CAAC;AAED,OAAO,SAASI,YAAYA,CAACC,QAAgB,EAAEC,OAAe,EAAE;EAC9D,MAAMC,QAAQ,GAAGN,UAAU,CAACI,QAAQ,CAAC;EAErC,IAAI,CAACE,QAAQ,EAAE;IACb,MAAM,IAAIC,KAAK,CAAC,kBAAkB,CAAC;EACrC;EAEA,MAAMC,SAAS,GAAGF,QAAQ,CAACD,OAAO,CAAC;EAEnC,IAAI,CAACG,SAAS,EAAE;IACd,MAAM,IAAID,KAAK,CAAC,iBAAiB,CAAC;EACpC;EAEA,OAAOC,SAAS;AAClB","ignoreList":[]}
+{"version":3,"file":"index.js","names":["format","formatAdapterV1","formatHumanV1","formatMachineV1","formatMachineV2","formatters","human","machine","adapter","getFormatter","audience","version","versions","Error","formatter"],"sources":["../../../../../src/server/plugins/engine/outputFormatters/index.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/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { format as formatAdapterV1 } from '~/src/server/plugins/engine/outputFormatters/adapter/v1.js'\nimport { format as formatHumanV1 } from '~/src/server/plugins/engine/outputFormatters/human/v1.js'\nimport { format as formatMachineV1 } from '~/src/server/plugins/engine/outputFormatters/machine/v1.js'\nimport { format as formatMachineV2 } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'\nimport { type FormContext } from '~/src/server/plugins/engine/types.js'\n\ntype Formatter = (\n  context: FormContext,\n  items: DetailItem[],\n  model: FormModel,\n  submitResponse: SubmitResponsePayload,\n  formStatus: ReturnType<typeof checkFormStatus>,\n  formMetadata?: FormMetadata\n) => string\n\nconst formatters: Record<\n  string,\n  Record<string, Formatter | typeof formatAdapterV1 | undefined> | undefined\n> = {\n  human: {\n    '1': formatHumanV1\n  },\n  machine: {\n    '1': formatMachineV1,\n    '2': formatMachineV2\n  },\n  adapter: {\n    '1': formatAdapterV1\n  }\n}\n\nexport function getFormatter(audience: string, version: string) {\n  const versions = formatters[audience]\n\n  if (!versions) {\n    throw new Error('Unknown audience')\n  }\n\n  const formatter = versions[version]\n\n  if (!formatter) {\n    throw new Error('Unknown version')\n  }\n\n  return formatter\n}\n"],"mappings":"AAQA,SAASA,MAAM,IAAIC,eAAe;AAClC,SAASD,MAAM,IAAIE,aAAa;AAChC,SAASF,MAAM,IAAIG,eAAe;AAClC,SAASH,MAAM,IAAII,eAAe;AAYlC,MAAMC,UAGL,GAAG;EACFC,KAAK,EAAE;IACL,GAAG,EAAEJ;EACP,CAAC;EACDK,OAAO,EAAE;IACP,GAAG,EAAEJ,eAAe;IACpB,GAAG,EAAEC;EACP,CAAC;EACDI,OAAO,EAAE;IACP,GAAG,EAAEP;EACP;AACF,CAAC;AAED,OAAO,SAASQ,YAAYA,CAACC,QAAgB,EAAEC,OAAe,EAAE;EAC9D,MAAMC,QAAQ,GAAGP,UAAU,CAACK,QAAQ,CAAC;EAErC,IAAI,CAACE,QAAQ,EAAE;IACb,MAAM,IAAIC,KAAK,CAAC,kBAAkB,CAAC;EACrC;EAEA,MAAMC,SAAS,GAAGF,QAAQ,CAACD,OAAO,CAAC;EAEnC,IAAI,CAACG,SAAS,EAAE;IACd,MAAM,IAAID,KAAK,CAAC,iBAAiB,CAAC;EACpC;EAEA,OAAOC,SAAS;AAClB","ignoreList":[]}

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

@@ -1,6 +1,6 @@
-import { type SubmitResponsePayload } from '@defra/forms-model';
+import { type FormMetadata, type SubmitResponsePayload } from '@defra/forms-model';
 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 } 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 declare function format(context: FormContext, items: DetailItem[], model: FormModel, _submitResponse: SubmitResponsePayload, _formStatus: ReturnType<typeof checkFormStatus>, _formMetadata?: FormMetadata): string;

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

@@ -2,7 +2,7 @@ import { config } from "../../../../../config/index.js";
 import { getAnswer } from "../../components/helpers.js";
 import { FileUploadField } from "../../components/index.js";
 const designerUrl = config.get('designerUrl');
-export function format(context, items, model, _submitResponse, _formStatus) {
+export function format(context, items, model, _submitResponse, _formStatus, _formMetadata) {
   const now = new Date();
   const categorisedData = categoriseData(items);
   const data = {

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

@@ -1 +1 @@
-{"version":3,"file":"v1.js","names":["config","getAnswer","FileUploadField","designerUrl","get","format","context","items","model","_submitResponse","_formStatus","now","Date","categorisedData","categoriseData","data","meta","schemaVersion","timestamp","toISOString","referenceNumber","definition","def","body","JSON","stringify","output","main","repeaters","files","forEach","item","name","extractRepeaters","isFileUploadFieldItem","extractFileUploads","field","state","subItems","inputRepeaterItem","outputRepeaterItem","repeaterComponent","push","fileUploadState","getContextValueFromState","map","fileId","userDownloadLink"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/machine/v1.ts"],"sourcesContent":["import { type SubmitResponsePayload } from '@defra/forms-model'\n\nimport { config } from '~/src/config/index.js'\nimport { getAnswer } from '~/src/server/plugins/engine/components/helpers.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 { type FormContext } 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: '1',\n      timestamp: now.toISOString(),\n      referenceNumber: context.referenceNumber,\n      definition: model.def\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 *          componentName: 'componentValue'\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, string>\n    repeaters: Record<string, Record<string, string>[]>\n    files: Record<string, Record<string, string>[]>\n  } = { main: {}, repeaters: {}, files: {} }\n\n  items.forEach((item) => {\n    if ('subItems' in item) {\n      output.repeaters[item.name] = extractRepeaters(item)\n    } else if (isFileUploadFieldItem(item)) {\n      output.files[item.name] = extractFileUploads(item)\n    } else {\n      output.main[item.name] = getAnswer(item.field, item.state, {\n        format: 'data'\n      })\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, string>[] = []\n\n  item.subItems.forEach((inputRepeaterItem) => {\n    const outputRepeaterItem: Record<string, string> = {}\n\n    inputRepeaterItem.forEach((repeaterComponent) => {\n      outputRepeaterItem[repeaterComponent.name] = getAnswer(\n        repeaterComponent.field,\n        repeaterComponent.state,\n        {\n          format: 'data'\n        }\n      )\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"],"mappings":"AAEA,SAASA,MAAM;AACf,SAASC,SAAS;AAClB,SAASC,eAAe;AAUxB,MAAMC,WAAW,GAAGH,MAAM,CAACI,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,eAAe,EAAEd,OAAO,CAACc,eAAe;MACxCC,UAAU,EAAEb,KAAK,CAACc;IACpB,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,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,IAAI,UAAU,IAAIA,IAAI,EAAE;MACtBL,MAAM,CAACE,SAAS,CAACG,IAAI,CAACC,IAAI,CAAC,GAAGC,gBAAgB,CAACF,IAAI,CAAC;IACtD,CAAC,MAAM,IAAIG,qBAAqB,CAACH,IAAI,CAAC,EAAE;MACtCL,MAAM,CAACG,KAAK,CAACE,IAAI,CAACC,IAAI,CAAC,GAAGG,kBAAkB,CAACJ,IAAI,CAAC;IACpD,CAAC,MAAM;MACLL,MAAM,CAACC,IAAI,CAACI,IAAI,CAACC,IAAI,CAAC,GAAG/B,SAAS,CAAC8B,IAAI,CAACK,KAAK,EAAEL,IAAI,CAACM,KAAK,EAAE;QACzDhC,MAAM,EAAE;MACV,CAAC,CAAC;IACJ;EACF,CAAC,CAAC;EAEF,OAAOqB,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASO,gBAAgBA,CAACF,IAAsB,EAAE;EAChD,MAAMH,SAAmC,GAAG,EAAE;EAE9CG,IAAI,CAACO,QAAQ,CAACR,OAAO,CAAES,iBAAiB,IAAK;IAC3C,MAAMC,kBAA0C,GAAG,CAAC,CAAC;IAErDD,iBAAiB,CAACT,OAAO,CAAEW,iBAAiB,IAAK;MAC/CD,kBAAkB,CAACC,iBAAiB,CAACT,IAAI,CAAC,GAAG/B,SAAS,CACpDwC,iBAAiB,CAACL,KAAK,EACvBK,iBAAiB,CAACJ,KAAK,EACvB;QACEhC,MAAM,EAAE;MACV,CACF,CAAC;IACH,CAAC,CAAC;IAEFuB,SAAS,CAACc,IAAI,CAACF,kBAAkB,CAAC;EACpC,CAAC,CAAC;EAEF,OAAOZ,SAAS;AAClB;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASO,kBAAkBA,CAACJ,IAA+B,EAAE;EAC3D,MAAMY,eAAe,GAAGZ,IAAI,CAACK,KAAK,CAACQ,wBAAwB,CAACb,IAAI,CAACM,KAAK,CAAC,IAAI,EAAE;EAE7E,OAAOM,eAAe,CAACE,GAAG,CAAEC,MAAM,IAAK;IACrC,OAAO;MACLA,MAAM;MACNC,gBAAgB,EAAE,GAAG5C,WAAW,kBAAkB2C,MAAM;IAC1D,CAAC;EACH,CAAC,CAAC;AACJ;AAEA,SAASZ,qBAAqBA,CAC5BH,IAAqB,EACc;EACnC,OAAOA,IAAI,CAACK,KAAK,YAAYlC,eAAe;AAC9C;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"v1.js","names":["config","getAnswer","FileUploadField","designerUrl","get","format","context","items","model","_submitResponse","_formStatus","_formMetadata","now","Date","categorisedData","categoriseData","data","meta","schemaVersion","timestamp","toISOString","referenceNumber","definition","def","body","JSON","stringify","output","main","repeaters","files","forEach","item","name","extractRepeaters","isFileUploadFieldItem","extractFileUploads","field","state","subItems","inputRepeaterItem","outputRepeaterItem","repeaterComponent","push","fileUploadState","getContextValueFromState","map","fileId","userDownloadLink"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/machine/v1.ts"],"sourcesContent":["import {\n  type FormMetadata,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\n\nimport { config } from '~/src/config/index.js'\nimport { getAnswer } from '~/src/server/plugins/engine/components/helpers.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 { type FormContext } 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  _formMetadata?: FormMetadata\n) {\n  const now = new Date()\n\n  const categorisedData = categoriseData(items)\n\n  const data = {\n    meta: {\n      schemaVersion: '1',\n      timestamp: now.toISOString(),\n      referenceNumber: context.referenceNumber,\n      definition: model.def\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 *          componentName: 'componentValue'\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, string>\n    repeaters: Record<string, Record<string, string>[]>\n    files: Record<string, Record<string, string>[]>\n  } = { main: {}, repeaters: {}, files: {} }\n\n  items.forEach((item) => {\n    if ('subItems' in item) {\n      output.repeaters[item.name] = extractRepeaters(item)\n    } else if (isFileUploadFieldItem(item)) {\n      output.files[item.name] = extractFileUploads(item)\n    } else {\n      output.main[item.name] = getAnswer(item.field, item.state, {\n        format: 'data'\n      })\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, string>[] = []\n\n  item.subItems.forEach((inputRepeaterItem) => {\n    const outputRepeaterItem: Record<string, string> = {}\n\n    inputRepeaterItem.forEach((repeaterComponent) => {\n      outputRepeaterItem[repeaterComponent.name] = getAnswer(\n        repeaterComponent.field,\n        repeaterComponent.state,\n        {\n          format: 'data'\n        }\n      )\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"],"mappings":"AAKA,SAASA,MAAM;AACf,SAASC,SAAS;AAClB,SAASC,eAAe;AAUxB,MAAMC,WAAW,GAAGH,MAAM,CAACI,GAAG,CAAC,aAAa,CAAC;AAE7C,OAAO,SAASC,MAAMA,CACpBC,OAAoB,EACpBC,KAAmB,EACnBC,KAAgB,EAChBC,eAAsC,EACtCC,WAA+C,EAC/CC,aAA4B,EAC5B;EACA,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;EAEtB,MAAMC,eAAe,GAAGC,cAAc,CAACR,KAAK,CAAC;EAE7C,MAAMS,IAAI,GAAG;IACXC,IAAI,EAAE;MACJC,aAAa,EAAE,GAAG;MAClBC,SAAS,EAAEP,GAAG,CAACQ,WAAW,CAAC,CAAC;MAC5BC,eAAe,EAAEf,OAAO,CAACe,eAAe;MACxCC,UAAU,EAAEd,KAAK,CAACe;IACpB,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,SAAST,cAAcA,CAACR,KAAmB,EAAE;EAC3C,MAAMoB,MAIL,GAAG;IAAEC,IAAI,EAAE,CAAC,CAAC;IAAEC,SAAS,EAAE,CAAC,CAAC;IAAEC,KAAK,EAAE,CAAC;EAAE,CAAC;EAE1CvB,KAAK,CAACwB,OAAO,CAAEC,IAAI,IAAK;IACtB,IAAI,UAAU,IAAIA,IAAI,EAAE;MACtBL,MAAM,CAACE,SAAS,CAACG,IAAI,CAACC,IAAI,CAAC,GAAGC,gBAAgB,CAACF,IAAI,CAAC;IACtD,CAAC,MAAM,IAAIG,qBAAqB,CAACH,IAAI,CAAC,EAAE;MACtCL,MAAM,CAACG,KAAK,CAACE,IAAI,CAACC,IAAI,CAAC,GAAGG,kBAAkB,CAACJ,IAAI,CAAC;IACpD,CAAC,MAAM;MACLL,MAAM,CAACC,IAAI,CAACI,IAAI,CAACC,IAAI,CAAC,GAAGhC,SAAS,CAAC+B,IAAI,CAACK,KAAK,EAAEL,IAAI,CAACM,KAAK,EAAE;QACzDjC,MAAM,EAAE;MACV,CAAC,CAAC;IACJ;EACF,CAAC,CAAC;EAEF,OAAOsB,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASO,gBAAgBA,CAACF,IAAsB,EAAE;EAChD,MAAMH,SAAmC,GAAG,EAAE;EAE9CG,IAAI,CAACO,QAAQ,CAACR,OAAO,CAAES,iBAAiB,IAAK;IAC3C,MAAMC,kBAA0C,GAAG,CAAC,CAAC;IAErDD,iBAAiB,CAACT,OAAO,CAAEW,iBAAiB,IAAK;MAC/CD,kBAAkB,CAACC,iBAAiB,CAACT,IAAI,CAAC,GAAGhC,SAAS,CACpDyC,iBAAiB,CAACL,KAAK,EACvBK,iBAAiB,CAACJ,KAAK,EACvB;QACEjC,MAAM,EAAE;MACV,CACF,CAAC;IACH,CAAC,CAAC;IAEFwB,SAAS,CAACc,IAAI,CAACF,kBAAkB,CAAC;EACpC,CAAC,CAAC;EAEF,OAAOZ,SAAS;AAClB;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASO,kBAAkBA,CAACJ,IAA+B,EAAE;EAC3D,MAAMY,eAAe,GAAGZ,IAAI,CAACK,KAAK,CAACQ,wBAAwB,CAACb,IAAI,CAACM,KAAK,CAAC,IAAI,EAAE;EAE7E,OAAOM,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,CAC5BH,IAAqB,EACc;EACnC,OAAOA,IAAI,CAACK,KAAK,YAAYnC,eAAe;AAC9C;;AAEA;AACA;AACA","ignoreList":[]}

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

@@ -1,6 +1,9 @@
 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 } from '~/src/server/plugins/engine/types.js';
+import { type FormContext, type FormPayload, type FormValue } 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.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\ntype 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","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":[]}

package/.server/server/plugins/engine/pageControllers/SummaryPageController.js

@@ -77,9 +77,10 @@ export class SummaryPageController extends QuestionPageController {
       } = formsService;
 
       // Get the form metadata using the `slug` param
+      const formMetadata = await getFormMetadata(params.slug);
       const {
         notificationEmail
-      } = await getFormMetadata(params.slug);
+      } = formMetadata;
       const {
         isPreview
       } = checkFormStatus(request.params);
@@ -89,7 +90,7 @@ export class SummaryPageController extends QuestionPageController {
       // Send submission email
       if (emailAddress) {
         const viewModel = this.getSummaryViewModel(request, context);
-        await submitForm(context, request, viewModel, model, emailAddress);
+        await submitForm(context, request, viewModel, model, emailAddress, formMetadata);
       }
       await cacheService.setConfirmationState(request, {
         confirmed: true
@@ -112,7 +113,7 @@ export class SummaryPageController extends QuestionPageController {
     };
   }
 }
-async function submitForm(context, request, summaryViewModel, model, emailAddress) {
+async function submitForm(context, request, summaryViewModel, model, emailAddress, formMetadata) {
   await extendFileRetention(model, context.state, emailAddress);
   const formStatus = checkFormStatus(request.params);
   const logTags = ['submit', 'submissionApi'];
@@ -127,7 +128,7 @@ async function submitForm(context, request, summaryViewModel, model, emailAddres
   if (submitResponse === undefined) {
     throw Boom.badRequest('Unexpected empty response from submit api');
   }
-  return model.services.outputService.submit(context, request, model, emailAddress, items, submitResponse);
+  return model.services.outputService.submit(context, request, model, emailAddress, items, submitResponse, formMetadata);
 }
 async function extendFileRetention(model, state, updatedRetrievalKey) {
   const {

package/.server/server/plugins/engine/pageControllers/SummaryPageController.js.map

@@ -1 +1 @@
-{"version":3,"file":"SummaryPageController.js","names":["hasComponentsEvenIfNoNext","Boom","ComponentCollection","FileUploadField","getAnswer","checkEmailAddressForLiveFormSubmission","checkFormStatus","getCacheService","SummaryViewModel","QuestionPageController","SummaryPageController","constructor","model","pageDef","viewName","collection","components","page","getSummaryViewModel","request","context","viewModel","query","payload","errors","getViewModel","backLink","getBackLink","feedbackLink","phaseTag","allowSaveAndReturn","shouldShowSaveAndReturn","server","makeGetRouteHandler","h","hasMissingNotificationEmail","view","makePostRouteHandler","params","cacheService","formsService","services","getFormMetadata","notificationEmail","slug","isPreview","emailAddress","def","outputEmail","submitForm","setConfirmationState","confirmed","clearState","proceed","getStatusPath","postRouteOptions","ext","onPreHandler","method","continue","summaryViewModel","extendFileRetention","state","formStatus","logTags","logger","info","items","getFormSubmissionData","details","submitResponse","submitData","yar","id","undefined","badRequest","outputService","submit","updatedRetrievalKey","formSubmissionService","persistFiles","files","pages","forEach","fileUploadComponents","fields","filter","component","values","getFormValueFromState","length","push","map","status","fileId","form","file","initiatedRetrievalKey","metadata","retrievalKey","sessionId","main","item","name","title","label","value","field","format","repeaters","subItems","detailItems","subItem","relevantPages","href","flatMap","flat"],"sources":["../../../../../src/server/plugins/engine/pageControllers/SummaryPageController.ts"],"sourcesContent":["import {\n  hasComponentsEvenIfNoNext,\n  type Page,\n  type SubmitPayload\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type ResponseToolkit, type RouteOptions } from '@hapi/hapi'\n\nimport { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js'\nimport { getAnswer } from '~/src/server/plugins/engine/components/helpers.js'\nimport {\n  checkEmailAddressForLiveFormSubmission,\n  checkFormStatus,\n  getCacheService\n} from '~/src/server/plugins/engine/helpers.js'\nimport {\n  SummaryViewModel,\n  type FormModel\n} from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type Detail,\n  type DetailItem\n} from '~/src/server/plugins/engine/models/types.js'\nimport { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'\nimport {\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs\n} from '~/src/server/routes/types.js'\n\nexport class SummaryPageController extends QuestionPageController {\n  declare pageDef: Page\n\n  /**\n   * The controller which is used when Page[\"controller\"] is defined as \"./pages/summary.js\"\n   */\n\n  constructor(model: FormModel, pageDef: Page) {\n    super(model, pageDef)\n    this.viewName = 'summary'\n\n    // Components collection\n    this.collection = new ComponentCollection(\n      hasComponentsEvenIfNoNext(pageDef) ? pageDef.components : [],\n      { model, page: this }\n    )\n  }\n\n  getSummaryViewModel(\n    request: FormContextRequest,\n    context: FormContext\n  ): SummaryViewModel {\n    const viewModel = new SummaryViewModel(request, this, context)\n\n    const { query } = request\n    const { payload, errors } = context\n    const components = this.collection.getViewModel(payload, errors, query)\n\n    // We already figure these out in the base page controller. Take them and apply them to our page-specific model.\n    // This is a stop-gap until we can add proper inheritance in place.\n    viewModel.backLink = this.getBackLink(request, context)\n    viewModel.feedbackLink = this.feedbackLink\n    viewModel.phaseTag = this.phaseTag\n    viewModel.components = components\n    viewModel.allowSaveAndReturn = this.shouldShowSaveAndReturn(request.server)\n\n    return viewModel\n  }\n\n  /**\n   * Returns an async function. This is called in plugin.ts when there is a GET request at `/{id}/{path*}`,\n   */\n  makeGetRouteHandler() {\n    return async (\n      request: FormRequest,\n      context: FormContext,\n      h: Pick<ResponseToolkit, 'redirect' | 'view'>\n    ) => {\n      const { viewName } = this\n\n      const viewModel = this.getSummaryViewModel(request, context)\n\n      viewModel.hasMissingNotificationEmail =\n        await this.hasMissingNotificationEmail(request, context)\n\n      return h.view(viewName, viewModel)\n    }\n  }\n\n  /**\n   * Returns an async function. This is called in plugin.ts when there is a POST request at `/{id}/{path*}`.\n   * If a form is incomplete, a user will be redirected to the start page.\n   */\n  makePostRouteHandler() {\n    return async (\n      request: FormRequestPayload,\n      context: FormContext,\n      h: Pick<ResponseToolkit, 'redirect' | 'view'>\n    ) => {\n      const { model } = this\n      const { params } = request\n      const cacheService = getCacheService(request.server)\n\n      const { formsService } = this.model.services\n      const { getFormMetadata } = formsService\n\n      // Get the form metadata using the `slug` param\n      const { notificationEmail } = await getFormMetadata(params.slug)\n      const { isPreview } = checkFormStatus(request.params)\n      const emailAddress = notificationEmail ?? this.model.def.outputEmail\n\n      checkEmailAddressForLiveFormSubmission(emailAddress, isPreview)\n\n      // Send submission email\n      if (emailAddress) {\n        const viewModel = this.getSummaryViewModel(request, context)\n        await submitForm(context, request, viewModel, model, emailAddress)\n      }\n\n      await cacheService.setConfirmationState(request, { confirmed: true })\n\n      // Clear all form data\n      await cacheService.clearState(request)\n\n      return this.proceed(request, h, this.getStatusPath())\n    }\n  }\n\n  get postRouteOptions(): RouteOptions<FormRequestPayloadRefs> {\n    return {\n      ext: {\n        onPreHandler: {\n          method(request, h) {\n            return h.continue\n          }\n        }\n      }\n    }\n  }\n}\n\nasync function submitForm(\n  context: FormContext,\n  request: FormRequestPayload,\n  summaryViewModel: SummaryViewModel,\n  model: FormModel,\n  emailAddress: string\n) {\n  await extendFileRetention(model, context.state, emailAddress)\n\n  const formStatus = checkFormStatus(request.params)\n  const logTags = ['submit', 'submissionApi']\n\n  request.logger.info(logTags, 'Preparing email', formStatus)\n\n  // Get detail items\n  const items = getFormSubmissionData(\n    summaryViewModel.context,\n    summaryViewModel.details\n  )\n\n  // Submit data\n  request.logger.info(logTags, 'Submitting data')\n  const submitResponse = await submitData(\n    model,\n    items,\n    emailAddress,\n    request.yar.id\n  )\n\n  if (submitResponse === undefined) {\n    throw Boom.badRequest('Unexpected empty response from submit api')\n  }\n\n  return model.services.outputService.submit(\n    context,\n    request,\n    model,\n    emailAddress,\n    items,\n    submitResponse\n  )\n}\n\nasync function extendFileRetention(\n  model: FormModel,\n  state: FormSubmissionState,\n  updatedRetrievalKey: string\n) {\n  const { formSubmissionService } = model.services\n  const { persistFiles } = formSubmissionService\n  const files: { fileId: string; initiatedRetrievalKey: string }[] = []\n\n  // For each file upload component with files in\n  // state, add the files to the batch getting persisted\n  model.pages.forEach((page) => {\n    const fileUploadComponents = page.collection.fields.filter(\n      (component) => component instanceof FileUploadField\n    )\n\n    fileUploadComponents.forEach((component) => {\n      const values = component.getFormValueFromState(state)\n      if (!values?.length) {\n        return\n      }\n\n      files.push(\n        ...values.map(({ status }) => ({\n          fileId: status.form.file.fileId,\n          initiatedRetrievalKey: status.metadata.retrievalKey\n        }))\n      )\n    })\n  })\n\n  if (files.length) {\n    return persistFiles(files, updatedRetrievalKey)\n  }\n}\n\nfunction submitData(\n  model: FormModel,\n  items: DetailItem[],\n  retrievalKey: string,\n  sessionId: string\n) {\n  const { formSubmissionService } = model.services\n  const { submit } = formSubmissionService\n\n  const payload: SubmitPayload = {\n    sessionId,\n    retrievalKey,\n\n    // Main form answers\n    main: items\n      .filter((item) => 'field' in item)\n      .map((item) => ({\n        name: item.name,\n        title: item.label,\n        value: getAnswer(item.field, item.state, { format: 'data' })\n      })),\n\n    // Repeater form answers\n    repeaters: items\n      .filter((item) => 'subItems' in item)\n      .map((item) => ({\n        name: item.name,\n        title: item.label,\n\n        // Repeater item values\n        value: item.subItems.map((detailItems) =>\n          detailItems.map((subItem) => ({\n            name: subItem.name,\n            title: subItem.label,\n            value: getAnswer(subItem.field, subItem.state, { format: 'data' })\n          }))\n        )\n      }))\n  }\n\n  return submit(payload)\n}\n\nexport function getFormSubmissionData(context: FormContext, details: Detail[]) {\n  return context.relevantPages\n    .map(({ href }) =>\n      details.flatMap(({ items }) =>\n        items.filter(({ page }) => page.href === href)\n      )\n    )\n    .flat()\n}\n"],"mappings":"AAAA,SACEA,yBAAyB,QAGpB,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAG7B,SAASC,mBAAmB;AAC5B,SAASC,eAAe;AACxB,SAASC,SAAS;AAClB,SACEC,sCAAsC,EACtCC,eAAe,EACfC,eAAe;AAEjB,SACEC,gBAAgB;AAOlB,SAASC,sBAAsB;AAY/B,OAAO,MAAMC,qBAAqB,SAASD,sBAAsB,CAAC;EAGhE;AACF;AACA;;EAEEE,WAAWA,CAACC,KAAgB,EAAEC,OAAa,EAAE;IAC3C,KAAK,CAACD,KAAK,EAAEC,OAAO,CAAC;IACrB,IAAI,CAACC,QAAQ,GAAG,SAAS;;IAEzB;IACA,IAAI,CAACC,UAAU,GAAG,IAAIb,mBAAmB,CACvCF,yBAAyB,CAACa,OAAO,CAAC,GAAGA,OAAO,CAACG,UAAU,GAAG,EAAE,EAC5D;MAAEJ,KAAK;MAAEK,IAAI,EAAE;IAAK,CACtB,CAAC;EACH;EAEAC,mBAAmBA,CACjBC,OAA2B,EAC3BC,OAAoB,EACF;IAClB,MAAMC,SAAS,GAAG,IAAIb,gBAAgB,CAACW,OAAO,EAAE,IAAI,EAAEC,OAAO,CAAC;IAE9D,MAAM;MAAEE;IAAM,CAAC,GAAGH,OAAO;IACzB,MAAM;MAAEI,OAAO;MAAEC;IAAO,CAAC,GAAGJ,OAAO;IACnC,MAAMJ,UAAU,GAAG,IAAI,CAACD,UAAU,CAACU,YAAY,CAACF,OAAO,EAAEC,MAAM,EAAEF,KAAK,CAAC;;IAEvE;IACA;IACAD,SAAS,CAACK,QAAQ,GAAG,IAAI,CAACC,WAAW,CAACR,OAAO,EAAEC,OAAO,CAAC;IACvDC,SAAS,CAACO,YAAY,GAAG,IAAI,CAACA,YAAY;IAC1CP,SAAS,CAACQ,QAAQ,GAAG,IAAI,CAACA,QAAQ;IAClCR,SAAS,CAACL,UAAU,GAAGA,UAAU;IACjCK,SAAS,CAACS,kBAAkB,GAAG,IAAI,CAACC,uBAAuB,CAACZ,OAAO,CAACa,MAAM,CAAC;IAE3E,OAAOX,SAAS;EAClB;;EAEA;AACF;AACA;EACEY,mBAAmBA,CAAA,EAAG;IACpB,OAAO,OACLd,OAAoB,EACpBC,OAAoB,EACpBc,CAA6C,KAC1C;MACH,MAAM;QAAEpB;MAAS,CAAC,GAAG,IAAI;MAEzB,MAAMO,SAAS,GAAG,IAAI,CAACH,mBAAmB,CAACC,OAAO,EAAEC,OAAO,CAAC;MAE5DC,SAAS,CAACc,2BAA2B,GACnC,MAAM,IAAI,CAACA,2BAA2B,CAAChB,OAAO,EAAEC,OAAO,CAAC;MAE1D,OAAOc,CAAC,CAACE,IAAI,CAACtB,QAAQ,EAAEO,SAAS,CAAC;IACpC,CAAC;EACH;;EAEA;AACF;AACA;AACA;EACEgB,oBAAoBA,CAAA,EAAG;IACrB,OAAO,OACLlB,OAA2B,EAC3BC,OAAoB,EACpBc,CAA6C,KAC1C;MACH,MAAM;QAAEtB;MAAM,CAAC,GAAG,IAAI;MACtB,MAAM;QAAE0B;MAAO,CAAC,GAAGnB,OAAO;MAC1B,MAAMoB,YAAY,GAAGhC,eAAe,CAACY,OAAO,CAACa,MAAM,CAAC;MAEpD,MAAM;QAAEQ;MAAa,CAAC,GAAG,IAAI,CAAC5B,KAAK,CAAC6B,QAAQ;MAC5C,MAAM;QAAEC;MAAgB,CAAC,GAAGF,YAAY;;MAExC;MACA,MAAM;QAAEG;MAAkB,CAAC,GAAG,MAAMD,eAAe,CAACJ,MAAM,CAACM,IAAI,CAAC;MAChE,MAAM;QAAEC;MAAU,CAAC,GAAGvC,eAAe,CAACa,OAAO,CAACmB,MAAM,CAAC;MACrD,MAAMQ,YAAY,GAAGH,iBAAiB,IAAI,IAAI,CAAC/B,KAAK,CAACmC,GAAG,CAACC,WAAW;MAEpE3C,sCAAsC,CAACyC,YAAY,EAAED,SAAS,CAAC;;MAE/D;MACA,IAAIC,YAAY,EAAE;QAChB,MAAMzB,SAAS,GAAG,IAAI,CAACH,mBAAmB,CAACC,OAAO,EAAEC,OAAO,CAAC;QAC5D,MAAM6B,UAAU,CAAC7B,OAAO,EAAED,OAAO,EAAEE,SAAS,EAAET,KAAK,EAAEkC,YAAY,CAAC;MACpE;MAEA,MAAMP,YAAY,CAACW,oBAAoB,CAAC/B,OAAO,EAAE;QAAEgC,SAAS,EAAE;MAAK,CAAC,CAAC;;MAErE;MACA,MAAMZ,YAAY,CAACa,UAAU,CAACjC,OAAO,CAAC;MAEtC,OAAO,IAAI,CAACkC,OAAO,CAAClC,OAAO,EAAEe,CAAC,EAAE,IAAI,CAACoB,aAAa,CAAC,CAAC,CAAC;IACvD,CAAC;EACH;EAEA,IAAIC,gBAAgBA,CAAA,EAAyC;IAC3D,OAAO;MACLC,GAAG,EAAE;QACHC,YAAY,EAAE;UACZC,MAAMA,CAACvC,OAAO,EAAEe,CAAC,EAAE;YACjB,OAAOA,CAAC,CAACyB,QAAQ;UACnB;QACF;MACF;IACF,CAAC;EACH;AACF;AAEA,eAAeV,UAAUA,CACvB7B,OAAoB,EACpBD,OAA2B,EAC3ByC,gBAAkC,EAClChD,KAAgB,EAChBkC,YAAoB,EACpB;EACA,MAAMe,mBAAmB,CAACjD,KAAK,EAAEQ,OAAO,CAAC0C,KAAK,EAAEhB,YAAY,CAAC;EAE7D,MAAMiB,UAAU,GAAGzD,eAAe,CAACa,OAAO,CAACmB,MAAM,CAAC;EAClD,MAAM0B,OAAO,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC;EAE3C7C,OAAO,CAAC8C,MAAM,CAACC,IAAI,CAACF,OAAO,EAAE,iBAAiB,EAAED,UAAU,CAAC;;EAE3D;EACA,MAAMI,KAAK,GAAGC,qBAAqB,CACjCR,gBAAgB,CAACxC,OAAO,EACxBwC,gBAAgB,CAACS,OACnB,CAAC;;EAED;EACAlD,OAAO,CAAC8C,MAAM,CAACC,IAAI,CAACF,OAAO,EAAE,iBAAiB,CAAC;EAC/C,MAAMM,cAAc,GAAG,MAAMC,UAAU,CACrC3D,KAAK,EACLuD,KAAK,EACLrB,YAAY,EACZ3B,OAAO,CAACqD,GAAG,CAACC,EACd,CAAC;EAED,IAAIH,cAAc,KAAKI,SAAS,EAAE;IAChC,MAAMzE,IAAI,CAAC0E,UAAU,CAAC,2CAA2C,CAAC;EACpE;EAEA,OAAO/D,KAAK,CAAC6B,QAAQ,CAACmC,aAAa,CAACC,MAAM,CACxCzD,OAAO,EACPD,OAAO,EACPP,KAAK,EACLkC,YAAY,EACZqB,KAAK,EACLG,cACF,CAAC;AACH;AAEA,eAAeT,mBAAmBA,CAChCjD,KAAgB,EAChBkD,KAA0B,EAC1BgB,mBAA2B,EAC3B;EACA,MAAM;IAAEC;EAAsB,CAAC,GAAGnE,KAAK,CAAC6B,QAAQ;EAChD,MAAM;IAAEuC;EAAa,CAAC,GAAGD,qBAAqB;EAC9C,MAAME,KAA0D,GAAG,EAAE;;EAErE;EACA;EACArE,KAAK,CAACsE,KAAK,CAACC,OAAO,CAAElE,IAAI,IAAK;IAC5B,MAAMmE,oBAAoB,GAAGnE,IAAI,CAACF,UAAU,CAACsE,MAAM,CAACC,MAAM,CACvDC,SAAS,IAAKA,SAAS,YAAYpF,eACtC,CAAC;IAEDiF,oBAAoB,CAACD,OAAO,CAAEI,SAAS,IAAK;MAC1C,MAAMC,MAAM,GAAGD,SAAS,CAACE,qBAAqB,CAAC3B,KAAK,CAAC;MACrD,IAAI,CAAC0B,MAAM,EAAEE,MAAM,EAAE;QACnB;MACF;MAEAT,KAAK,CAACU,IAAI,CACR,GAAGH,MAAM,CAACI,GAAG,CAAC,CAAC;QAAEC;MAAO,CAAC,MAAM;QAC7BC,MAAM,EAAED,MAAM,CAACE,IAAI,CAACC,IAAI,CAACF,MAAM;QAC/BG,qBAAqB,EAAEJ,MAAM,CAACK,QAAQ,CAACC;MACzC,CAAC,CAAC,CACJ,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF,IAAIlB,KAAK,CAACS,MAAM,EAAE;IAChB,OAAOV,YAAY,CAACC,KAAK,EAAEH,mBAAmB,CAAC;EACjD;AACF;AAEA,SAASP,UAAUA,CACjB3D,KAAgB,EAChBuD,KAAmB,EACnBgC,YAAoB,EACpBC,SAAiB,EACjB;EACA,MAAM;IAAErB;EAAsB,CAAC,GAAGnE,KAAK,CAAC6B,QAAQ;EAChD,MAAM;IAAEoC;EAAO,CAAC,GAAGE,qBAAqB;EAExC,MAAMxD,OAAsB,GAAG;IAC7B6E,SAAS;IACTD,YAAY;IAEZ;IACAE,IAAI,EAAElC,KAAK,CACRmB,MAAM,CAAEgB,IAAI,IAAK,OAAO,IAAIA,IAAI,CAAC,CACjCV,GAAG,CAAEU,IAAI,KAAM;MACdC,IAAI,EAAED,IAAI,CAACC,IAAI;MACfC,KAAK,EAAEF,IAAI,CAACG,KAAK;MACjBC,KAAK,EAAEtG,SAAS,CAACkG,IAAI,CAACK,KAAK,EAAEL,IAAI,CAACxC,KAAK,EAAE;QAAE8C,MAAM,EAAE;MAAO,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEL;IACAC,SAAS,EAAE1C,KAAK,CACbmB,MAAM,CAAEgB,IAAI,IAAK,UAAU,IAAIA,IAAI,CAAC,CACpCV,GAAG,CAAEU,IAAI,KAAM;MACdC,IAAI,EAAED,IAAI,CAACC,IAAI;MACfC,KAAK,EAAEF,IAAI,CAACG,KAAK;MAEjB;MACAC,KAAK,EAAEJ,IAAI,CAACQ,QAAQ,CAAClB,GAAG,CAAEmB,WAAW,IACnCA,WAAW,CAACnB,GAAG,CAAEoB,OAAO,KAAM;QAC5BT,IAAI,EAAES,OAAO,CAACT,IAAI;QAClBC,KAAK,EAAEQ,OAAO,CAACP,KAAK;QACpBC,KAAK,EAAEtG,SAAS,CAAC4G,OAAO,CAACL,KAAK,EAAEK,OAAO,CAAClD,KAAK,EAAE;UAAE8C,MAAM,EAAE;QAAO,CAAC;MACnE,CAAC,CAAC,CACJ;IACF,CAAC,CAAC;EACN,CAAC;EAED,OAAO/B,MAAM,CAACtD,OAAO,CAAC;AACxB;AAEA,OAAO,SAAS6C,qBAAqBA,CAAChD,OAAoB,EAAEiD,OAAiB,EAAE;EAC7E,OAAOjD,OAAO,CAAC6F,aAAa,CACzBrB,GAAG,CAAC,CAAC;IAAEsB;EAAK,CAAC,KACZ7C,OAAO,CAAC8C,OAAO,CAAC,CAAC;IAAEhD;EAAM,CAAC,KACxBA,KAAK,CAACmB,MAAM,CAAC,CAAC;IAAErE;EAAK,CAAC,KAAKA,IAAI,CAACiG,IAAI,KAAKA,IAAI,CAC/C,CACF,CAAC,CACAE,IAAI,CAAC,CAAC;AACX","ignoreList":[]}
+{"version":3,"file":"SummaryPageController.js","names":["hasComponentsEvenIfNoNext","Boom","ComponentCollection","FileUploadField","getAnswer","checkEmailAddressForLiveFormSubmission","checkFormStatus","getCacheService","SummaryViewModel","QuestionPageController","SummaryPageController","constructor","model","pageDef","viewName","collection","components","page","getSummaryViewModel","request","context","viewModel","query","payload","errors","getViewModel","backLink","getBackLink","feedbackLink","phaseTag","allowSaveAndReturn","shouldShowSaveAndReturn","server","makeGetRouteHandler","h","hasMissingNotificationEmail","view","makePostRouteHandler","params","cacheService","formsService","services","getFormMetadata","formMetadata","slug","notificationEmail","isPreview","emailAddress","def","outputEmail","submitForm","setConfirmationState","confirmed","clearState","proceed","getStatusPath","postRouteOptions","ext","onPreHandler","method","continue","summaryViewModel","extendFileRetention","state","formStatus","logTags","logger","info","items","getFormSubmissionData","details","submitResponse","submitData","yar","id","undefined","badRequest","outputService","submit","updatedRetrievalKey","formSubmissionService","persistFiles","files","pages","forEach","fileUploadComponents","fields","filter","component","values","getFormValueFromState","length","push","map","status","fileId","form","file","initiatedRetrievalKey","metadata","retrievalKey","sessionId","main","item","name","title","label","value","field","format","repeaters","subItems","detailItems","subItem","relevantPages","href","flatMap","flat"],"sources":["../../../../../src/server/plugins/engine/pageControllers/SummaryPageController.ts"],"sourcesContent":["import {\n  hasComponentsEvenIfNoNext,\n  type FormMetadata,\n  type Page,\n  type SubmitPayload\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type ResponseToolkit, type RouteOptions } from '@hapi/hapi'\n\nimport { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js'\nimport { getAnswer } from '~/src/server/plugins/engine/components/helpers.js'\nimport {\n  checkEmailAddressForLiveFormSubmission,\n  checkFormStatus,\n  getCacheService\n} from '~/src/server/plugins/engine/helpers.js'\nimport {\n  SummaryViewModel,\n  type FormModel\n} from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type Detail,\n  type DetailItem\n} from '~/src/server/plugins/engine/models/types.js'\nimport { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'\nimport {\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs\n} from '~/src/server/routes/types.js'\n\nexport class SummaryPageController extends QuestionPageController {\n  declare pageDef: Page\n\n  /**\n   * The controller which is used when Page[\"controller\"] is defined as \"./pages/summary.js\"\n   */\n\n  constructor(model: FormModel, pageDef: Page) {\n    super(model, pageDef)\n    this.viewName = 'summary'\n\n    // Components collection\n    this.collection = new ComponentCollection(\n      hasComponentsEvenIfNoNext(pageDef) ? pageDef.components : [],\n      { model, page: this }\n    )\n  }\n\n  getSummaryViewModel(\n    request: FormContextRequest,\n    context: FormContext\n  ): SummaryViewModel {\n    const viewModel = new SummaryViewModel(request, this, context)\n\n    const { query } = request\n    const { payload, errors } = context\n    const components = this.collection.getViewModel(payload, errors, query)\n\n    // We already figure these out in the base page controller. Take them and apply them to our page-specific model.\n    // This is a stop-gap until we can add proper inheritance in place.\n    viewModel.backLink = this.getBackLink(request, context)\n    viewModel.feedbackLink = this.feedbackLink\n    viewModel.phaseTag = this.phaseTag\n    viewModel.components = components\n    viewModel.allowSaveAndReturn = this.shouldShowSaveAndReturn(request.server)\n\n    return viewModel\n  }\n\n  /**\n   * Returns an async function. This is called in plugin.ts when there is a GET request at `/{id}/{path*}`,\n   */\n  makeGetRouteHandler() {\n    return async (\n      request: FormRequest,\n      context: FormContext,\n      h: Pick<ResponseToolkit, 'redirect' | 'view'>\n    ) => {\n      const { viewName } = this\n\n      const viewModel = this.getSummaryViewModel(request, context)\n\n      viewModel.hasMissingNotificationEmail =\n        await this.hasMissingNotificationEmail(request, context)\n\n      return h.view(viewName, viewModel)\n    }\n  }\n\n  /**\n   * Returns an async function. This is called in plugin.ts when there is a POST request at `/{id}/{path*}`.\n   * If a form is incomplete, a user will be redirected to the start page.\n   */\n  makePostRouteHandler() {\n    return async (\n      request: FormRequestPayload,\n      context: FormContext,\n      h: Pick<ResponseToolkit, 'redirect' | 'view'>\n    ) => {\n      const { model } = this\n      const { params } = request\n      const cacheService = getCacheService(request.server)\n\n      const { formsService } = this.model.services\n      const { getFormMetadata } = formsService\n\n      // Get the form metadata using the `slug` param\n      const formMetadata = await getFormMetadata(params.slug)\n      const { notificationEmail } = formMetadata\n      const { isPreview } = checkFormStatus(request.params)\n      const emailAddress = notificationEmail ?? this.model.def.outputEmail\n\n      checkEmailAddressForLiveFormSubmission(emailAddress, isPreview)\n\n      // Send submission email\n      if (emailAddress) {\n        const viewModel = this.getSummaryViewModel(request, context)\n        await submitForm(\n          context,\n          request,\n          viewModel,\n          model,\n          emailAddress,\n          formMetadata\n        )\n      }\n\n      await cacheService.setConfirmationState(request, { confirmed: true })\n\n      // Clear all form data\n      await cacheService.clearState(request)\n\n      return this.proceed(request, h, this.getStatusPath())\n    }\n  }\n\n  get postRouteOptions(): RouteOptions<FormRequestPayloadRefs> {\n    return {\n      ext: {\n        onPreHandler: {\n          method(request, h) {\n            return h.continue\n          }\n        }\n      }\n    }\n  }\n}\n\nasync function submitForm(\n  context: FormContext,\n  request: FormRequestPayload,\n  summaryViewModel: SummaryViewModel,\n  model: FormModel,\n  emailAddress: string,\n  formMetadata: FormMetadata\n) {\n  await extendFileRetention(model, context.state, emailAddress)\n\n  const formStatus = checkFormStatus(request.params)\n  const logTags = ['submit', 'submissionApi']\n\n  request.logger.info(logTags, 'Preparing email', formStatus)\n\n  // Get detail items\n  const items = getFormSubmissionData(\n    summaryViewModel.context,\n    summaryViewModel.details\n  )\n\n  // Submit data\n  request.logger.info(logTags, 'Submitting data')\n  const submitResponse = await submitData(\n    model,\n    items,\n    emailAddress,\n    request.yar.id\n  )\n\n  if (submitResponse === undefined) {\n    throw Boom.badRequest('Unexpected empty response from submit api')\n  }\n\n  return model.services.outputService.submit(\n    context,\n    request,\n    model,\n    emailAddress,\n    items,\n    submitResponse,\n    formMetadata\n  )\n}\n\nasync function extendFileRetention(\n  model: FormModel,\n  state: FormSubmissionState,\n  updatedRetrievalKey: string\n) {\n  const { formSubmissionService } = model.services\n  const { persistFiles } = formSubmissionService\n  const files: { fileId: string; initiatedRetrievalKey: string }[] = []\n\n  // For each file upload component with files in\n  // state, add the files to the batch getting persisted\n  model.pages.forEach((page) => {\n    const fileUploadComponents = page.collection.fields.filter(\n      (component) => component instanceof FileUploadField\n    )\n\n    fileUploadComponents.forEach((component) => {\n      const values = component.getFormValueFromState(state)\n      if (!values?.length) {\n        return\n      }\n\n      files.push(\n        ...values.map(({ status }) => ({\n          fileId: status.form.file.fileId,\n          initiatedRetrievalKey: status.metadata.retrievalKey\n        }))\n      )\n    })\n  })\n\n  if (files.length) {\n    return persistFiles(files, updatedRetrievalKey)\n  }\n}\n\nfunction submitData(\n  model: FormModel,\n  items: DetailItem[],\n  retrievalKey: string,\n  sessionId: string\n) {\n  const { formSubmissionService } = model.services\n  const { submit } = formSubmissionService\n\n  const payload: SubmitPayload = {\n    sessionId,\n    retrievalKey,\n\n    // Main form answers\n    main: items\n      .filter((item) => 'field' in item)\n      .map((item) => ({\n        name: item.name,\n        title: item.label,\n        value: getAnswer(item.field, item.state, { format: 'data' })\n      })),\n\n    // Repeater form answers\n    repeaters: items\n      .filter((item) => 'subItems' in item)\n      .map((item) => ({\n        name: item.name,\n        title: item.label,\n\n        // Repeater item values\n        value: item.subItems.map((detailItems) =>\n          detailItems.map((subItem) => ({\n            name: subItem.name,\n            title: subItem.label,\n            value: getAnswer(subItem.field, subItem.state, { format: 'data' })\n          }))\n        )\n      }))\n  }\n\n  return submit(payload)\n}\n\nexport function getFormSubmissionData(context: FormContext, details: Detail[]) {\n  return context.relevantPages\n    .map(({ href }) =>\n      details.flatMap(({ items }) =>\n        items.filter(({ page }) => page.href === href)\n      )\n    )\n    .flat()\n}\n"],"mappings":"AAAA,SACEA,yBAAyB,QAIpB,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAG7B,SAASC,mBAAmB;AAC5B,SAASC,eAAe;AACxB,SAASC,SAAS;AAClB,SACEC,sCAAsC,EACtCC,eAAe,EACfC,eAAe;AAEjB,SACEC,gBAAgB;AAOlB,SAASC,sBAAsB;AAY/B,OAAO,MAAMC,qBAAqB,SAASD,sBAAsB,CAAC;EAGhE;AACF;AACA;;EAEEE,WAAWA,CAACC,KAAgB,EAAEC,OAAa,EAAE;IAC3C,KAAK,CAACD,KAAK,EAAEC,OAAO,CAAC;IACrB,IAAI,CAACC,QAAQ,GAAG,SAAS;;IAEzB;IACA,IAAI,CAACC,UAAU,GAAG,IAAIb,mBAAmB,CACvCF,yBAAyB,CAACa,OAAO,CAAC,GAAGA,OAAO,CAACG,UAAU,GAAG,EAAE,EAC5D;MAAEJ,KAAK;MAAEK,IAAI,EAAE;IAAK,CACtB,CAAC;EACH;EAEAC,mBAAmBA,CACjBC,OAA2B,EAC3BC,OAAoB,EACF;IAClB,MAAMC,SAAS,GAAG,IAAIb,gBAAgB,CAACW,OAAO,EAAE,IAAI,EAAEC,OAAO,CAAC;IAE9D,MAAM;MAAEE;IAAM,CAAC,GAAGH,OAAO;IACzB,MAAM;MAAEI,OAAO;MAAEC;IAAO,CAAC,GAAGJ,OAAO;IACnC,MAAMJ,UAAU,GAAG,IAAI,CAACD,UAAU,CAACU,YAAY,CAACF,OAAO,EAAEC,MAAM,EAAEF,KAAK,CAAC;;IAEvE;IACA;IACAD,SAAS,CAACK,QAAQ,GAAG,IAAI,CAACC,WAAW,CAACR,OAAO,EAAEC,OAAO,CAAC;IACvDC,SAAS,CAACO,YAAY,GAAG,IAAI,CAACA,YAAY;IAC1CP,SAAS,CAACQ,QAAQ,GAAG,IAAI,CAACA,QAAQ;IAClCR,SAAS,CAACL,UAAU,GAAGA,UAAU;IACjCK,SAAS,CAACS,kBAAkB,GAAG,IAAI,CAACC,uBAAuB,CAACZ,OAAO,CAACa,MAAM,CAAC;IAE3E,OAAOX,SAAS;EAClB;;EAEA;AACF;AACA;EACEY,mBAAmBA,CAAA,EAAG;IACpB,OAAO,OACLd,OAAoB,EACpBC,OAAoB,EACpBc,CAA6C,KAC1C;MACH,MAAM;QAAEpB;MAAS,CAAC,GAAG,IAAI;MAEzB,MAAMO,SAAS,GAAG,IAAI,CAACH,mBAAmB,CAACC,OAAO,EAAEC,OAAO,CAAC;MAE5DC,SAAS,CAACc,2BAA2B,GACnC,MAAM,IAAI,CAACA,2BAA2B,CAAChB,OAAO,EAAEC,OAAO,CAAC;MAE1D,OAAOc,CAAC,CAACE,IAAI,CAACtB,QAAQ,EAAEO,SAAS,CAAC;IACpC,CAAC;EACH;;EAEA;AACF;AACA;AACA;EACEgB,oBAAoBA,CAAA,EAAG;IACrB,OAAO,OACLlB,OAA2B,EAC3BC,OAAoB,EACpBc,CAA6C,KAC1C;MACH,MAAM;QAAEtB;MAAM,CAAC,GAAG,IAAI;MACtB,MAAM;QAAE0B;MAAO,CAAC,GAAGnB,OAAO;MAC1B,MAAMoB,YAAY,GAAGhC,eAAe,CAACY,OAAO,CAACa,MAAM,CAAC;MAEpD,MAAM;QAAEQ;MAAa,CAAC,GAAG,IAAI,CAAC5B,KAAK,CAAC6B,QAAQ;MAC5C,MAAM;QAAEC;MAAgB,CAAC,GAAGF,YAAY;;MAExC;MACA,MAAMG,YAAY,GAAG,MAAMD,eAAe,CAACJ,MAAM,CAACM,IAAI,CAAC;MACvD,MAAM;QAAEC;MAAkB,CAAC,GAAGF,YAAY;MAC1C,MAAM;QAAEG;MAAU,CAAC,GAAGxC,eAAe,CAACa,OAAO,CAACmB,MAAM,CAAC;MACrD,MAAMS,YAAY,GAAGF,iBAAiB,IAAI,IAAI,CAACjC,KAAK,CAACoC,GAAG,CAACC,WAAW;MAEpE5C,sCAAsC,CAAC0C,YAAY,EAAED,SAAS,CAAC;;MAE/D;MACA,IAAIC,YAAY,EAAE;QAChB,MAAM1B,SAAS,GAAG,IAAI,CAACH,mBAAmB,CAACC,OAAO,EAAEC,OAAO,CAAC;QAC5D,MAAM8B,UAAU,CACd9B,OAAO,EACPD,OAAO,EACPE,SAAS,EACTT,KAAK,EACLmC,YAAY,EACZJ,YACF,CAAC;MACH;MAEA,MAAMJ,YAAY,CAACY,oBAAoB,CAAChC,OAAO,EAAE;QAAEiC,SAAS,EAAE;MAAK,CAAC,CAAC;;MAErE;MACA,MAAMb,YAAY,CAACc,UAAU,CAAClC,OAAO,CAAC;MAEtC,OAAO,IAAI,CAACmC,OAAO,CAACnC,OAAO,EAAEe,CAAC,EAAE,IAAI,CAACqB,aAAa,CAAC,CAAC,CAAC;IACvD,CAAC;EACH;EAEA,IAAIC,gBAAgBA,CAAA,EAAyC;IAC3D,OAAO;MACLC,GAAG,EAAE;QACHC,YAAY,EAAE;UACZC,MAAMA,CAACxC,OAAO,EAAEe,CAAC,EAAE;YACjB,OAAOA,CAAC,CAAC0B,QAAQ;UACnB;QACF;MACF;IACF,CAAC;EACH;AACF;AAEA,eAAeV,UAAUA,CACvB9B,OAAoB,EACpBD,OAA2B,EAC3B0C,gBAAkC,EAClCjD,KAAgB,EAChBmC,YAAoB,EACpBJ,YAA0B,EAC1B;EACA,MAAMmB,mBAAmB,CAAClD,KAAK,EAAEQ,OAAO,CAAC2C,KAAK,EAAEhB,YAAY,CAAC;EAE7D,MAAMiB,UAAU,GAAG1D,eAAe,CAACa,OAAO,CAACmB,MAAM,CAAC;EAClD,MAAM2B,OAAO,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC;EAE3C9C,OAAO,CAAC+C,MAAM,CAACC,IAAI,CAACF,OAAO,EAAE,iBAAiB,EAAED,UAAU,CAAC;;EAE3D;EACA,MAAMI,KAAK,GAAGC,qBAAqB,CACjCR,gBAAgB,CAACzC,OAAO,EACxByC,gBAAgB,CAACS,OACnB,CAAC;;EAED;EACAnD,OAAO,CAAC+C,MAAM,CAACC,IAAI,CAACF,OAAO,EAAE,iBAAiB,CAAC;EAC/C,MAAMM,cAAc,GAAG,MAAMC,UAAU,CACrC5D,KAAK,EACLwD,KAAK,EACLrB,YAAY,EACZ5B,OAAO,CAACsD,GAAG,CAACC,EACd,CAAC;EAED,IAAIH,cAAc,KAAKI,SAAS,EAAE;IAChC,MAAM1E,IAAI,CAAC2E,UAAU,CAAC,2CAA2C,CAAC;EACpE;EAEA,OAAOhE,KAAK,CAAC6B,QAAQ,CAACoC,aAAa,CAACC,MAAM,CACxC1D,OAAO,EACPD,OAAO,EACPP,KAAK,EACLmC,YAAY,EACZqB,KAAK,EACLG,cAAc,EACd5B,YACF,CAAC;AACH;AAEA,eAAemB,mBAAmBA,CAChClD,KAAgB,EAChBmD,KAA0B,EAC1BgB,mBAA2B,EAC3B;EACA,MAAM;IAAEC;EAAsB,CAAC,GAAGpE,KAAK,CAAC6B,QAAQ;EAChD,MAAM;IAAEwC;EAAa,CAAC,GAAGD,qBAAqB;EAC9C,MAAME,KAA0D,GAAG,EAAE;;EAErE;EACA;EACAtE,KAAK,CAACuE,KAAK,CAACC,OAAO,CAAEnE,IAAI,IAAK;IAC5B,MAAMoE,oBAAoB,GAAGpE,IAAI,CAACF,UAAU,CAACuE,MAAM,CAACC,MAAM,CACvDC,SAAS,IAAKA,SAAS,YAAYrF,eACtC,CAAC;IAEDkF,oBAAoB,CAACD,OAAO,CAAEI,SAAS,IAAK;MAC1C,MAAMC,MAAM,GAAGD,SAAS,CAACE,qBAAqB,CAAC3B,KAAK,CAAC;MACrD,IAAI,CAAC0B,MAAM,EAAEE,MAAM,EAAE;QACnB;MACF;MAEAT,KAAK,CAACU,IAAI,CACR,GAAGH,MAAM,CAACI,GAAG,CAAC,CAAC;QAAEC;MAAO,CAAC,MAAM;QAC7BC,MAAM,EAAED,MAAM,CAACE,IAAI,CAACC,IAAI,CAACF,MAAM;QAC/BG,qBAAqB,EAAEJ,MAAM,CAACK,QAAQ,CAACC;MACzC,CAAC,CAAC,CACJ,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF,IAAIlB,KAAK,CAACS,MAAM,EAAE;IAChB,OAAOV,YAAY,CAACC,KAAK,EAAEH,mBAAmB,CAAC;EACjD;AACF;AAEA,SAASP,UAAUA,CACjB5D,KAAgB,EAChBwD,KAAmB,EACnBgC,YAAoB,EACpBC,SAAiB,EACjB;EACA,MAAM;IAAErB;EAAsB,CAAC,GAAGpE,KAAK,CAAC6B,QAAQ;EAChD,MAAM;IAAEqC;EAAO,CAAC,GAAGE,qBAAqB;EAExC,MAAMzD,OAAsB,GAAG;IAC7B8E,SAAS;IACTD,YAAY;IAEZ;IACAE,IAAI,EAAElC,KAAK,CACRmB,MAAM,CAAEgB,IAAI,IAAK,OAAO,IAAIA,IAAI,CAAC,CACjCV,GAAG,CAAEU,IAAI,KAAM;MACdC,IAAI,EAAED,IAAI,CAACC,IAAI;MACfC,KAAK,EAAEF,IAAI,CAACG,KAAK;MACjBC,KAAK,EAAEvG,SAAS,CAACmG,IAAI,CAACK,KAAK,EAAEL,IAAI,CAACxC,KAAK,EAAE;QAAE8C,MAAM,EAAE;MAAO,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEL;IACAC,SAAS,EAAE1C,KAAK,CACbmB,MAAM,CAAEgB,IAAI,IAAK,UAAU,IAAIA,IAAI,CAAC,CACpCV,GAAG,CAAEU,IAAI,KAAM;MACdC,IAAI,EAAED,IAAI,CAACC,IAAI;MACfC,KAAK,EAAEF,IAAI,CAACG,KAAK;MAEjB;MACAC,KAAK,EAAEJ,IAAI,CAACQ,QAAQ,CAAClB,GAAG,CAAEmB,WAAW,IACnCA,WAAW,CAACnB,GAAG,CAAEoB,OAAO,KAAM;QAC5BT,IAAI,EAAES,OAAO,CAACT,IAAI;QAClBC,KAAK,EAAEQ,OAAO,CAACP,KAAK;QACpBC,KAAK,EAAEvG,SAAS,CAAC6G,OAAO,CAACL,KAAK,EAAEK,OAAO,CAAClD,KAAK,EAAE;UAAE8C,MAAM,EAAE;QAAO,CAAC;MACnE,CAAC,CAAC,CACJ;IACF,CAAC,CAAC;EACN,CAAC;EAED,OAAO/B,MAAM,CAACvD,OAAO,CAAC;AACxB;AAEA,OAAO,SAAS8C,qBAAqBA,CAACjD,OAAoB,EAAEkD,OAAiB,EAAE;EAC7E,OAAOlD,OAAO,CAAC8F,aAAa,CACzBrB,GAAG,CAAC,CAAC;IAAEsB;EAAK,CAAC,KACZ7C,OAAO,CAAC8C,OAAO,CAAC,CAAC;IAAEhD;EAAM,CAAC,KACxBA,KAAK,CAACmB,MAAM,CAAC,CAAC;IAAEtE;EAAK,CAAC,KAAKA,IAAI,CAACkG,IAAI,KAAKA,IAAI,CAC/C,CACF,CAAC,CACAE,IAAI,CAAC,CAAC;AACX","ignoreList":[]}

package/.server/server/plugins/engine/services/localFormsService.d.ts

@@ -1 +1 @@
-export function formsService(): Promise<import("../../../types.js").FormsService>;
+export function formsService(): Promise<import("../types/index.js").FormsService>;

package/.server/server/plugins/engine/services/notifyService.d.ts

@@ -1,6 +1,11 @@
-import { type SubmitResponsePayload } from '@defra/forms-model';
+import { type FormMetadata, type SubmitResponsePayload } from '@defra/forms-model';
 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 } from '~/src/server/plugins/engine/types.js';
 import { type FormRequestPayload } from '~/src/server/routes/types.js';
-export declare function submit(context: FormContext, request: FormRequestPayload, model: FormModel, emailAddress: string, items: DetailItem[], submitResponse: SubmitResponsePayload): Promise<void>;
+/**
+ * Optional GOV.UK Notify service for consumers who want email notifications
+ * Can be disabled by not providing notifyTemplateId in config
+ * Can be overridden by providing a custom outputService in the services config
+ */
+export declare function submit(context: FormContext, request: FormRequestPayload, model: FormModel, emailAddress: string, items: DetailItem[], submitResponse: SubmitResponsePayload, formMetadata?: FormMetadata): Promise<void>;

package/.server/server/plugins/engine/services/notifyService.js

@@ -5,7 +5,16 @@ import { checkFormStatus } from "../helpers.js";
 import { getFormatter } from "../outputFormatters/index.js";
 import { sendNotification } from "../../../utils/notify.js";
 const templateId = config.get('notifyTemplateId');
-export async function submit(context, request, model, emailAddress, items, submitResponse) {
+
+/**
+ * Optional GOV.UK Notify service for consumers who want email notifications
+ * Can be disabled by not providing notifyTemplateId in config
+ * Can be overridden by providing a custom outputService in the services config
+ */
+export async function submit(context, request, model, emailAddress, items, submitResponse, formMetadata) {
+  if (!templateId) {
+    return Promise.resolve();
+  }
   const logTags = ['submit', 'email'];
   const formStatus = checkFormStatus(request.params);
 
@@ -16,7 +25,7 @@ export async function submit(context, request, model, emailAddress, items, submi
   const outputAudience = model.def.output?.audience ?? 'human';
   const outputVersion = model.def.output?.version ?? '1';
   const outputFormatter = getFormatter(outputAudience, outputVersion);
-  let body = outputFormatter(context, items, model, submitResponse, formStatus);
+  let body = outputFormatter(context, items, model, submitResponse, formStatus, formMetadata);
 
   // GOV.UK Notify transforms quotes into curly quotes, so we can't just send the raw payload
   // This is logic specific to Notify, so we include the logic here rather than in the formatter

package/.server/server/plugins/engine/services/notifyService.js.map

@@ -1 +1 @@
-{"version":3,"file":"notifyService.js","names":["getErrorMessage","config","escapeMarkdown","checkFormStatus","getFormatter","sendNotification","templateId","get","submit","context","request","model","emailAddress","items","submitResponse","logTags","formStatus","params","logger","info","formName","name","subject","isPreview","outputAudience","def","output","audience","outputVersion","version","outputFormatter","body","Buffer","from","toString","personalisation","err","errMsg","error"],"sources":["../../../../../src/server/plugins/engine/services/notifyService.ts"],"sourcesContent":["import { getErrorMessage, type SubmitResponsePayload } from '@defra/forms-model'\n\nimport { config } from '~/src/config/index.js'\nimport { escapeMarkdown } from '~/src/server/plugins/engine/components/helpers.js'\nimport { checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { getFormatter } from '~/src/server/plugins/engine/outputFormatters/index.js'\nimport { type FormContext } from '~/src/server/plugins/engine/types.js'\nimport { type FormRequestPayload } from '~/src/server/routes/types.js'\nimport { sendNotification } from '~/src/server/utils/notify.js'\n\nconst templateId = config.get('notifyTemplateId')\n\nexport async function submit(\n  context: FormContext,\n  request: FormRequestPayload,\n  model: FormModel,\n  emailAddress: string,\n  items: DetailItem[],\n  submitResponse: SubmitResponsePayload\n) {\n  const logTags = ['submit', 'email']\n  const formStatus = checkFormStatus(request.params)\n\n  // Get submission email personalisation\n  request.logger.info(logTags, 'Getting personalisation data')\n\n  const formName = escapeMarkdown(model.name)\n  const subject = formStatus.isPreview\n    ? `TEST FORM SUBMISSION: ${formName}`\n    : `Form submission: ${formName}`\n\n  const outputAudience = model.def.output?.audience ?? 'human'\n  const outputVersion = model.def.output?.version ?? '1'\n\n  const outputFormatter = getFormatter(outputAudience, outputVersion)\n  let body = outputFormatter(context, items, model, submitResponse, formStatus)\n\n  // GOV.UK Notify transforms quotes into curly quotes, so we can't just send the raw payload\n  // This is logic specific to Notify, so we include the logic here rather than in the formatter\n  if (outputAudience === 'machine') {\n    body = Buffer.from(body).toString('base64')\n  }\n\n  request.logger.info(logTags, 'Sending email')\n\n  try {\n    // Send submission email\n    await sendNotification({\n      templateId,\n      emailAddress,\n      personalisation: {\n        subject,\n        body\n      }\n    })\n\n    request.logger.info(logTags, 'Email sent successfully')\n  } catch (err) {\n    const errMsg = getErrorMessage(err)\n    request.logger.error(\n      errMsg,\n      `[emailSendFailed] Error sending notification email - templateId: ${templateId} - recipient: ${emailAddress} - ${errMsg}`\n    )\n\n    throw err\n  }\n}\n"],"mappings":"AAAA,SAASA,eAAe,QAAoC,oBAAoB;AAEhF,SAASC,MAAM;AACf,SAASC,cAAc;AACvB,SAASC,eAAe;AAGxB,SAASC,YAAY;AAGrB,SAASC,gBAAgB;AAEzB,MAAMC,UAAU,GAAGL,MAAM,CAACM,GAAG,CAAC,kBAAkB,CAAC;AAEjD,OAAO,eAAeC,MAAMA,CAC1BC,OAAoB,EACpBC,OAA2B,EAC3BC,KAAgB,EAChBC,YAAoB,EACpBC,KAAmB,EACnBC,cAAqC,EACrC;EACA,MAAMC,OAAO,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC;EACnC,MAAMC,UAAU,GAAGb,eAAe,CAACO,OAAO,CAACO,MAAM,CAAC;;EAElD;EACAP,OAAO,CAACQ,MAAM,CAACC,IAAI,CAACJ,OAAO,EAAE,8BAA8B,CAAC;EAE5D,MAAMK,QAAQ,GAAGlB,cAAc,CAACS,KAAK,CAACU,IAAI,CAAC;EAC3C,MAAMC,OAAO,GAAGN,UAAU,CAACO,SAAS,GAChC,yBAAyBH,QAAQ,EAAE,GACnC,oBAAoBA,QAAQ,EAAE;EAElC,MAAMI,cAAc,GAAGb,KAAK,CAACc,GAAG,CAACC,MAAM,EAAEC,QAAQ,IAAI,OAAO;EAC5D,MAAMC,aAAa,GAAGjB,KAAK,CAACc,GAAG,CAACC,MAAM,EAAEG,OAAO,IAAI,GAAG;EAEtD,MAAMC,eAAe,GAAG1B,YAAY,CAACoB,cAAc,EAAEI,aAAa,CAAC;EACnE,IAAIG,IAAI,GAAGD,eAAe,CAACrB,OAAO,EAAEI,KAAK,EAAEF,KAAK,EAAEG,cAAc,EAAEE,UAAU,CAAC;;EAE7E;EACA;EACA,IAAIQ,cAAc,KAAK,SAAS,EAAE;IAChCO,IAAI,GAAGC,MAAM,CAACC,IAAI,CAACF,IAAI,CAAC,CAACG,QAAQ,CAAC,QAAQ,CAAC;EAC7C;EAEAxB,OAAO,CAACQ,MAAM,CAACC,IAAI,CAACJ,OAAO,EAAE,eAAe,CAAC;EAE7C,IAAI;IACF;IACA,MAAMV,gBAAgB,CAAC;MACrBC,UAAU;MACVM,YAAY;MACZuB,eAAe,EAAE;QACfb,OAAO;QACPS;MACF;IACF,CAAC,CAAC;IAEFrB,OAAO,CAACQ,MAAM,CAACC,IAAI,CAACJ,OAAO,EAAE,yBAAyB,CAAC;EACzD,CAAC,CAAC,OAAOqB,GAAG,EAAE;IACZ,MAAMC,MAAM,GAAGrC,eAAe,CAACoC,GAAG,CAAC;IACnC1B,OAAO,CAACQ,MAAM,CAACoB,KAAK,CAClBD,MAAM,EACN,oEAAoE/B,UAAU,iBAAiBM,YAAY,MAAMyB,MAAM,EACzH,CAAC;IAED,MAAMD,GAAG;EACX;AACF","ignoreList":[]}
+{"version":3,"file":"notifyService.js","names":["getErrorMessage","config","escapeMarkdown","checkFormStatus","getFormatter","sendNotification","templateId","get","submit","context","request","model","emailAddress","items","submitResponse","formMetadata","Promise","resolve","logTags","formStatus","params","logger","info","formName","name","subject","isPreview","outputAudience","def","output","audience","outputVersion","version","outputFormatter","body","Buffer","from","toString","personalisation","err","errMsg","error"],"sources":["../../../../../src/server/plugins/engine/services/notifyService.ts"],"sourcesContent":["import {\n  getErrorMessage,\n  type FormMetadata,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\n\nimport { config } from '~/src/config/index.js'\nimport { escapeMarkdown } from '~/src/server/plugins/engine/components/helpers.js'\nimport { checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { getFormatter } from '~/src/server/plugins/engine/outputFormatters/index.js'\nimport { type FormContext } from '~/src/server/plugins/engine/types.js'\nimport { type FormRequestPayload } from '~/src/server/routes/types.js'\nimport { sendNotification } from '~/src/server/utils/notify.js'\n\nconst templateId = config.get('notifyTemplateId')\n\n/**\n * Optional GOV.UK Notify service for consumers who want email notifications\n * Can be disabled by not providing notifyTemplateId in config\n * Can be overridden by providing a custom outputService in the services config\n */\nexport async function submit(\n  context: FormContext,\n  request: FormRequestPayload,\n  model: FormModel,\n  emailAddress: string,\n  items: DetailItem[],\n  submitResponse: SubmitResponsePayload,\n  formMetadata?: FormMetadata\n) {\n  if (!templateId) {\n    return Promise.resolve()\n  }\n\n  const logTags = ['submit', 'email']\n  const formStatus = checkFormStatus(request.params)\n\n  // Get submission email personalisation\n  request.logger.info(logTags, 'Getting personalisation data')\n\n  const formName = escapeMarkdown(model.name)\n  const subject = formStatus.isPreview\n    ? `TEST FORM SUBMISSION: ${formName}`\n    : `Form submission: ${formName}`\n\n  const outputAudience = model.def.output?.audience ?? 'human'\n  const outputVersion = model.def.output?.version ?? '1'\n\n  const outputFormatter = getFormatter(outputAudience, outputVersion)\n  let body = outputFormatter(\n    context,\n    items,\n    model,\n    submitResponse,\n    formStatus,\n    formMetadata\n  )\n\n  // GOV.UK Notify transforms quotes into curly quotes, so we can't just send the raw payload\n  // This is logic specific to Notify, so we include the logic here rather than in the formatter\n  if (outputAudience === 'machine') {\n    body = Buffer.from(body).toString('base64')\n  }\n\n  request.logger.info(logTags, 'Sending email')\n\n  try {\n    // Send submission email\n    await sendNotification({\n      templateId,\n      emailAddress,\n      personalisation: {\n        subject,\n        body\n      }\n    })\n\n    request.logger.info(logTags, 'Email sent successfully')\n  } catch (err) {\n    const errMsg = getErrorMessage(err)\n    request.logger.error(\n      errMsg,\n      `[emailSendFailed] Error sending notification email - templateId: ${templateId} - recipient: ${emailAddress} - ${errMsg}`\n    )\n\n    throw err\n  }\n}\n"],"mappings":"AAAA,SACEA,eAAe,QAGV,oBAAoB;AAE3B,SAASC,MAAM;AACf,SAASC,cAAc;AACvB,SAASC,eAAe;AAGxB,SAASC,YAAY;AAGrB,SAASC,gBAAgB;AAEzB,MAAMC,UAAU,GAAGL,MAAM,CAACM,GAAG,CAAC,kBAAkB,CAAC;;AAEjD;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,MAAMA,CAC1BC,OAAoB,EACpBC,OAA2B,EAC3BC,KAAgB,EAChBC,YAAoB,EACpBC,KAAmB,EACnBC,cAAqC,EACrCC,YAA2B,EAC3B;EACA,IAAI,CAACT,UAAU,EAAE;IACf,OAAOU,OAAO,CAACC,OAAO,CAAC,CAAC;EAC1B;EAEA,MAAMC,OAAO,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC;EACnC,MAAMC,UAAU,GAAGhB,eAAe,CAACO,OAAO,CAACU,MAAM,CAAC;;EAElD;EACAV,OAAO,CAACW,MAAM,CAACC,IAAI,CAACJ,OAAO,EAAE,8BAA8B,CAAC;EAE5D,MAAMK,QAAQ,GAAGrB,cAAc,CAACS,KAAK,CAACa,IAAI,CAAC;EAC3C,MAAMC,OAAO,GAAGN,UAAU,CAACO,SAAS,GAChC,yBAAyBH,QAAQ,EAAE,GACnC,oBAAoBA,QAAQ,EAAE;EAElC,MAAMI,cAAc,GAAGhB,KAAK,CAACiB,GAAG,CAACC,MAAM,EAAEC,QAAQ,IAAI,OAAO;EAC5D,MAAMC,aAAa,GAAGpB,KAAK,CAACiB,GAAG,CAACC,MAAM,EAAEG,OAAO,IAAI,GAAG;EAEtD,MAAMC,eAAe,GAAG7B,YAAY,CAACuB,cAAc,EAAEI,aAAa,CAAC;EACnE,IAAIG,IAAI,GAAGD,eAAe,CACxBxB,OAAO,EACPI,KAAK,EACLF,KAAK,EACLG,cAAc,EACdK,UAAU,EACVJ,YACF,CAAC;;EAED;EACA;EACA,IAAIY,cAAc,KAAK,SAAS,EAAE;IAChCO,IAAI,GAAGC,MAAM,CAACC,IAAI,CAACF,IAAI,CAAC,CAACG,QAAQ,CAAC,QAAQ,CAAC;EAC7C;EAEA3B,OAAO,CAACW,MAAM,CAACC,IAAI,CAACJ,OAAO,EAAE,eAAe,CAAC;EAE7C,IAAI;IACF;IACA,MAAMb,gBAAgB,CAAC;MACrBC,UAAU;MACVM,YAAY;MACZ0B,eAAe,EAAE;QACfb,OAAO;QACPS;MACF;IACF,CAAC,CAAC;IAEFxB,OAAO,CAACW,MAAM,CAACC,IAAI,CAACJ,OAAO,EAAE,yBAAyB,CAAC;EACzD,CAAC,CAAC,OAAOqB,GAAG,EAAE;IACZ,MAAMC,MAAM,GAAGxC,eAAe,CAACuC,GAAG,CAAC;IACnC7B,OAAO,CAACW,MAAM,CAACoB,KAAK,CAClBD,MAAM,EACN,oEAAoElC,UAAU,iBAAiBM,YAAY,MAAM4B,MAAM,EACzH,CAAC;IAED,MAAMD,GAAG;EACX;AACF","ignoreList":[]}

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

@@ -0,0 +1,10 @@
+export type { CheckAnswers, ErrorMessageTemplate, ErrorMessageTemplateList, FeaturedFormPageViewModel, FileState, FilterFunction, FormAdapterSubmissionMessage, FormAdapterSubmissionMessageData, FormAdapterSubmissionMessageMeta, FormAdapterSubmissionMessageMetaSerialised, FormAdapterSubmissionMessagePayload, FormAdapterSubmissionService, FormContext, FormContextRequest, FormPageViewModel, FormPayload, FormPayloadParams, FormState, FormStateValue, FormSubmissionError, FormSubmissionState, FormValidationResult, FormValue, GlobalFunction, ItemDeletePageViewModel, OnRequestCallback, PageViewModel, PageViewModelBase, PluginOptions, PreparePageEventRequestOptions, RepeatItemState, RepeatListState, RepeaterSummaryPageViewModel, SummaryList, SummaryListAction, SummaryListRow, TempFileState, UploadInitiateResponse, UploadStatusFileResponse, UploadStatusResponse } from '~/src/server/plugins/engine/types.js';
+export { FileStatus, FormAdapterSubmissionSchemaVersion, UploadStatus } from '~/src/server/plugins/engine/types.js';
+export type { Detail, DetailItem, DetailItemBase, DetailItemField, DetailItemRepeat, ExecutableCondition } from '~/src/server/plugins/engine/models/types.js';
+export type { BackLink, ComponentText, ComponentViewModel, Content, DateInputItem, DatePartsState, Label, ListItem, ListItemLabel, MonthYearState, ViewModel } from '~/src/server/plugins/engine/components/types.js';
+export type { UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js';
+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';

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

@@ -0,0 +1,4 @@
+export { FileStatus, FormAdapterSubmissionSchemaVersion, UploadStatus } from "../types.js";
+export { FormAction, FormStatus } from "../../../routes/types.js";
+export * from "./schema.js";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["FileStatus","FormAdapterSubmissionSchemaVersion","UploadStatus","FormAction","FormStatus"],"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 {\n  FileStatus,\n  FormAdapterSubmissionSchemaVersion,\n  UploadStatus\n} 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'\n"],"mappings":"AA2CA,SACEA,UAAU,EACVC,kCAAkC,EAClCC,YAAY;AAqCd,SAASC,UAAU,EAAEC,UAAU;AAY/B","ignoreList":[]}

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

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

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

@@ -0,0 +1,24 @@
+import { FormStatus, idSchema, notificationEmailAddressSchema, slugSchema, titleSchema } from '@defra/forms-model';
+import Joi from 'joi';
+import { FormAdapterSubmissionSchemaVersion } from "../types.js";
+export const formAdapterSubmissionMessageMetaSchema = Joi.object().keys({
+  schemaVersion: Joi.string().valid(...Object.values(FormAdapterSubmissionSchemaVersion)),
+  timestamp: Joi.date().required(),
+  referenceNumber: Joi.string().required(),
+  formName: titleSchema,
+  formId: idSchema,
+  formSlug: slugSchema,
+  status: Joi.string().valid(...Object.values(FormStatus)).required(),
+  isPreview: Joi.boolean().required(),
+  notificationEmail: notificationEmailAddressSchema.required()
+});
+export const formAdapterSubmissionMessageDataSchema = Joi.object().keys({
+  main: Joi.object(),
+  repeaters: Joi.object(),
+  files: Joi.object()
+});
+export const formAdapterSubmissionMessagePayloadSchema = Joi.object().keys({
+  meta: formAdapterSubmissionMessageMetaSchema.required(),
+  data: formAdapterSubmissionMessageDataSchema.required()
+});
+//# sourceMappingURL=schema.js.map

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

@@ -0,0 +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 {\n  FormAdapterSubmissionSchemaVersion,\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,SACEC,kCAAkC;AAMpC,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":[]}

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

@@ -4,10 +4,11 @@ import { type JoiExpression, type ValidationErrorItem } from 'joi';
 import { type Component } from '~/src/server/plugins/engine/components/helpers.js';
 import { type BackLink, type ComponentText, type ComponentViewModel } 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 PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js';
 import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js';
 import { type ViewContext } from '~/src/server/plugins/nunjucks/types.js';
-import { type FormAction, type FormParams, type FormRequest, type FormRequestPayload } from '~/src/server/routes/types.js';
+import { type FormAction, type FormParams, type FormRequest, type FormRequestPayload, type FormStatus } from '~/src/server/routes/types.js';
 import { type RequestOptions } from '~/src/server/services/httpService.js';
 import { type Services } from '~/src/server/types.js';
 type RequestType = Request | FormRequest | FormRequestPayload;
@@ -285,4 +286,39 @@ export interface PluginOptions {
     onRequest?: OnRequestCallback;
     baseUrl: string;
 }
+export interface FormAdapterSubmissionMessageMeta {
+    schemaVersion: FormAdapterSubmissionSchemaVersion;
+    timestamp: Date;
+    referenceNumber: string;
+    formName: string;
+    formId: string;
+    formSlug: string;
+    status: FormStatus;
+    isPreview: boolean;
+    notificationEmail: string;
+}
+export type FormAdapterSubmissionMessageMetaSerialised = Omit<FormAdapterSubmissionMessageMeta, 'schemaVersion' | 'timestamp' | 'status'> & {
+    schemaVersion: string;
+    status: string;
+    timestamp: string;
+};
+export interface FormAdapterSubmissionMessageData {
+    main: Record<string, RichFormValue>;
+    repeaters: Record<string, Record<string, RichFormValue>[]>;
+    files: Record<string, Record<string, string>[]>;
+}
+export declare enum FormAdapterSubmissionSchemaVersion {
+    V1 = 1
+}
+export interface FormAdapterSubmissionMessagePayload {
+    meta: FormAdapterSubmissionMessageMeta;
+    data: FormAdapterSubmissionMessageData;
+}
+export interface FormAdapterSubmissionMessage extends FormAdapterSubmissionMessagePayload {
+    messageId: string;
+    recordCreatedAt: Date;
+}
+export interface FormAdapterSubmissionService {
+    handleFormSubmission: (submissionMessage: FormAdapterSubmissionMessage) => unknown;
+}
 export {};