@defra/forms-engine-plugin 4.0.42 → 4.0.44

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

@@ -1 +1 @@
-{"version":3,"file":"configureEnginePlugin.js","names":["join","parse","FORM_PREFIX","FormModel","plugin","defaultServices","formsService","findPackageRoot","devtoolContext","configureEnginePlugin","formFileName","formFilePath","services","controllers","preparePageEventRequestOptions","onRequest","saveAndExit","ordnanceSurveyApiKey","cache","model","definition","getForm","name","initialBasePath","basePath","options","nunjucks","baseLayoutPath","paths","viewContext","baseUrl","importPath","ext","attributes","type","formImport","with","default"],"sources":["../../../../src/server/plugins/engine/configureEnginePlugin.ts"],"sourcesContent":["import { join, parse } from 'node:path'\n\nimport { type FormDefinition } from '@defra/forms-model'\n\nimport { FORM_PREFIX } from '~/src/server/constants.js'\nimport { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { plugin } from '~/src/server/plugins/engine/plugin.js'\nimport * as defaultServices from '~/src/server/plugins/engine/services/index.js'\nimport { formsService } from '~/src/server/plugins/engine/services/localFormsService.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\nimport { findPackageRoot } from '~/src/server/plugins/engine/vision.js'\nimport { devtoolContext } from '~/src/server/plugins/nunjucks/context.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\nimport { type RouteConfig } from '~/src/server/types.js'\n\nexport const configureEnginePlugin = async (\n  {\n    formFileName,\n    formFilePath,\n    services,\n    controllers,\n    preparePageEventRequestOptions,\n    onRequest,\n    saveAndExit,\n    ordnanceSurveyApiKey\n  }: RouteConfig = {},\n  cache?: CacheService\n): Promise<{\n  plugin: typeof plugin\n  options: PluginOptions\n}> => {\n  let model: FormModel | undefined\n\n  if (formFileName && formFilePath) {\n    const definition = await getForm(join(formFilePath, formFileName))\n    const { name } = parse(formFileName)\n\n    const initialBasePath = `${FORM_PREFIX}${name}`\n\n    model = new FormModel(\n      definition,\n      { basePath: initialBasePath, ordnanceSurveyApiKey },\n      services,\n      controllers\n    )\n  }\n\n  return {\n    plugin,\n    options: {\n      model,\n      services: services ?? {\n        // services for testing, else use the disk loader option for running this service locally\n        ...defaultServices,\n        formsService: await formsService()\n      },\n      controllers,\n      cache: cache ?? 'session',\n      nunjucks: {\n        baseLayoutPath: 'dxt-devtool-baselayout.html',\n        paths: [join(findPackageRoot(), 'src/server/devserver')] // custom layout to make it really clear this is not the same as the runner\n      },\n      viewContext: devtoolContext,\n      preparePageEventRequestOptions,\n      onRequest,\n      baseUrl: 'http://localhost:3009', // always runs locally\n      saveAndExit,\n      ordnanceSurveyApiKey\n    }\n  }\n}\n\nexport async function getForm(importPath: string) {\n  const { ext } = parse(importPath)\n\n  const attributes: ImportAttributes = {\n    type: ext === '.json' ? 'json' : 'module'\n  }\n\n  const formImport = import(importPath, { with: attributes }) as Promise<{\n    default: FormDefinition\n  }>\n\n  const { default: definition } = await formImport\n  return definition\n}\n"],"mappings":"AAAA,SAASA,IAAI,EAAEC,KAAK,QAAQ,WAAW;AAIvC,SAASC,WAAW;AACpB,SAASC,SAAS;AAClB,SAASC,MAAM;AACf,OAAO,KAAKC,eAAe;AAC3B,SAASC,YAAY;AAErB,SAASC,eAAe;AACxB,SAASC,cAAc;AAIvB,OAAO,MAAMC,qBAAqB,GAAG,MAAAA,CACnC;EACEC,YAAY;EACZC,YAAY;EACZC,QAAQ;EACRC,WAAW;EACXC,8BAA8B;EAC9BC,SAAS;EACTC,WAAW;EACXC;AACW,CAAC,GAAG,CAAC,CAAC,EACnBC,KAAoB,KAIhB;EACJ,IAAIC,KAA4B;EAEhC,IAAIT,YAAY,IAAIC,YAAY,EAAE;IAChC,MAAMS,UAAU,GAAG,MAAMC,OAAO,CAACrB,IAAI,CAACW,YAAY,EAAED,YAAY,CAAC,CAAC;IAClE,MAAM;MAAEY;IAAK,CAAC,GAAGrB,KAAK,CAACS,YAAY,CAAC;IAEpC,MAAMa,eAAe,GAAG,GAAGrB,WAAW,GAAGoB,IAAI,EAAE;IAE/CH,KAAK,GAAG,IAAIhB,SAAS,CACnBiB,UAAU,EACV;MAAEI,QAAQ,EAAED,eAAe;MAAEN;IAAqB,CAAC,EACnDL,QAAQ,EACRC,WACF,CAAC;EACH;EAEA,OAAO;IACLT,MAAM;IACNqB,OAAO,EAAE;MACPN,KAAK;MACLP,QAAQ,EAAEA,QAAQ,IAAI;QACpB;QACA,GAAGP,eAAe;QAClBC,YAAY,EAAE,MAAMA,YAAY,CAAC;MACnC,CAAC;MACDO,WAAW;MACXK,KAAK,EAAEA,KAAK,IAAI,SAAS;MACzBQ,QAAQ,EAAE;QACRC,cAAc,EAAE,6BAA6B;QAC7CC,KAAK,EAAE,CAAC5B,IAAI,CAACO,eAAe,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC;MAC3D,CAAC;MACDsB,WAAW,EAAErB,cAAc;MAC3BM,8BAA8B;MAC9BC,SAAS;MACTe,OAAO,EAAE,uBAAuB;MAAE;MAClCd,WAAW;MACXC;IACF;EACF,CAAC;AACH,CAAC;AAED,OAAO,eAAeI,OAAOA,CAACU,UAAkB,EAAE;EAChD,MAAM;IAAEC;EAAI,CAAC,GAAG/B,KAAK,CAAC8B,UAAU,CAAC;EAEjC,MAAME,UAA4B,GAAG;IACnCC,IAAI,EAAEF,GAAG,KAAK,OAAO,GAAG,MAAM,GAAG;EACnC,CAAC;EAED,MAAMG,UAAU,GAAG,MAAM,CAACJ,UAAU,EAAE;IAAEK,IAAI,EAAEH;EAAW,CAAC,CAExD;EAEF,MAAM;IAAEI,OAAO,EAAEjB;EAAW,CAAC,GAAG,MAAMe,UAAU;EAChD,OAAOf,UAAU;AACnB","ignoreList":[]}
+{"version":3,"file":"configureEnginePlugin.js","names":["join","parse","FORM_PREFIX","FormModel","plugin","defaultServices","formsService","findPackageRoot","devtoolContext","configureEnginePlugin","formFileName","formFilePath","services","controllers","preparePageEventRequestOptions","onRequest","saveAndExit","ordnanceSurveyApiKey","ordnanceSurveyApiSecret","cache","model","definition","getForm","name","initialBasePath","basePath","options","nunjucks","baseLayoutPath","paths","viewContext","baseUrl","importPath","ext","attributes","type","formImport","with","default"],"sources":["../../../../src/server/plugins/engine/configureEnginePlugin.ts"],"sourcesContent":["import { join, parse } from 'node:path'\n\nimport { type FormDefinition } from '@defra/forms-model'\n\nimport { FORM_PREFIX } from '~/src/server/constants.js'\nimport { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { plugin } from '~/src/server/plugins/engine/plugin.js'\nimport * as defaultServices from '~/src/server/plugins/engine/services/index.js'\nimport { formsService } from '~/src/server/plugins/engine/services/localFormsService.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\nimport { findPackageRoot } from '~/src/server/plugins/engine/vision.js'\nimport { devtoolContext } from '~/src/server/plugins/nunjucks/context.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\nimport { type RouteConfig } from '~/src/server/types.js'\n\nexport const configureEnginePlugin = async (\n  {\n    formFileName,\n    formFilePath,\n    services,\n    controllers,\n    preparePageEventRequestOptions,\n    onRequest,\n    saveAndExit,\n    ordnanceSurveyApiKey,\n    ordnanceSurveyApiSecret\n  }: RouteConfig = {},\n  cache?: CacheService\n): Promise<{\n  plugin: typeof plugin\n  options: PluginOptions\n}> => {\n  let model: FormModel | undefined\n\n  if (formFileName && formFilePath) {\n    const definition = await getForm(join(formFilePath, formFileName))\n    const { name } = parse(formFileName)\n\n    const initialBasePath = `${FORM_PREFIX}${name}`\n\n    model = new FormModel(\n      definition,\n      { basePath: initialBasePath, ordnanceSurveyApiKey },\n      services,\n      controllers\n    )\n  }\n\n  return {\n    plugin,\n    options: {\n      model,\n      services: services ?? {\n        // services for testing, else use the disk loader option for running this service locally\n        ...defaultServices,\n        formsService: await formsService()\n      },\n      controllers,\n      cache: cache ?? 'session',\n      nunjucks: {\n        baseLayoutPath: 'dxt-devtool-baselayout.html',\n        paths: [join(findPackageRoot(), 'src/server/devserver')] // custom layout to make it really clear this is not the same as the runner\n      },\n      viewContext: devtoolContext,\n      preparePageEventRequestOptions,\n      onRequest,\n      baseUrl: 'http://localhost:3009', // always runs locally\n      saveAndExit,\n      ordnanceSurveyApiKey,\n      ordnanceSurveyApiSecret\n    }\n  }\n}\n\nexport async function getForm(importPath: string) {\n  const { ext } = parse(importPath)\n\n  const attributes: ImportAttributes = {\n    type: ext === '.json' ? 'json' : 'module'\n  }\n\n  const formImport = import(importPath, { with: attributes }) as Promise<{\n    default: FormDefinition\n  }>\n\n  const { default: definition } = await formImport\n  return definition\n}\n"],"mappings":"AAAA,SAASA,IAAI,EAAEC,KAAK,QAAQ,WAAW;AAIvC,SAASC,WAAW;AACpB,SAASC,SAAS;AAClB,SAASC,MAAM;AACf,OAAO,KAAKC,eAAe;AAC3B,SAASC,YAAY;AAErB,SAASC,eAAe;AACxB,SAASC,cAAc;AAIvB,OAAO,MAAMC,qBAAqB,GAAG,MAAAA,CACnC;EACEC,YAAY;EACZC,YAAY;EACZC,QAAQ;EACRC,WAAW;EACXC,8BAA8B;EAC9BC,SAAS;EACTC,WAAW;EACXC,oBAAoB;EACpBC;AACW,CAAC,GAAG,CAAC,CAAC,EACnBC,KAAoB,KAIhB;EACJ,IAAIC,KAA4B;EAEhC,IAAIV,YAAY,IAAIC,YAAY,EAAE;IAChC,MAAMU,UAAU,GAAG,MAAMC,OAAO,CAACtB,IAAI,CAACW,YAAY,EAAED,YAAY,CAAC,CAAC;IAClE,MAAM;MAAEa;IAAK,CAAC,GAAGtB,KAAK,CAACS,YAAY,CAAC;IAEpC,MAAMc,eAAe,GAAG,GAAGtB,WAAW,GAAGqB,IAAI,EAAE;IAE/CH,KAAK,GAAG,IAAIjB,SAAS,CACnBkB,UAAU,EACV;MAAEI,QAAQ,EAAED,eAAe;MAAEP;IAAqB,CAAC,EACnDL,QAAQ,EACRC,WACF,CAAC;EACH;EAEA,OAAO;IACLT,MAAM;IACNsB,OAAO,EAAE;MACPN,KAAK;MACLR,QAAQ,EAAEA,QAAQ,IAAI;QACpB;QACA,GAAGP,eAAe;QAClBC,YAAY,EAAE,MAAMA,YAAY,CAAC;MACnC,CAAC;MACDO,WAAW;MACXM,KAAK,EAAEA,KAAK,IAAI,SAAS;MACzBQ,QAAQ,EAAE;QACRC,cAAc,EAAE,6BAA6B;QAC7CC,KAAK,EAAE,CAAC7B,IAAI,CAACO,eAAe,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC;MAC3D,CAAC;MACDuB,WAAW,EAAEtB,cAAc;MAC3BM,8BAA8B;MAC9BC,SAAS;MACTgB,OAAO,EAAE,uBAAuB;MAAE;MAClCf,WAAW;MACXC,oBAAoB;MACpBC;IACF;EACF,CAAC;AACH,CAAC;AAED,OAAO,eAAeI,OAAOA,CAACU,UAAkB,EAAE;EAChD,MAAM;IAAEC;EAAI,CAAC,GAAGhC,KAAK,CAAC+B,UAAU,CAAC;EAEjC,MAAME,UAA4B,GAAG;IACnCC,IAAI,EAAEF,GAAG,KAAK,OAAO,GAAG,MAAM,GAAG;EACnC,CAAC;EAED,MAAMG,UAAU,GAAG,MAAM,CAACJ,UAAU,EAAE;IAAEK,IAAI,EAAEH;EAAW,CAAC,CAExD;EAEF,MAAM;IAAEI,OAAO,EAAEjB;EAAW,CAAC,GAAG,MAAMe,UAAU;EAChD,OAAOf,UAAU;AACnB","ignoreList":[]}

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

@@ -71,6 +71,7 @@ export declare function getPluginOptions(server: Server): {
     cacheService: import("../../services/cacheService.js").CacheService;
     viewContext?: (request: AnyFormRequest | null) => Record<string, unknown> | Promise<Record<string, unknown>>;
     saveAndExit?: import("~/src/server/plugins/engine/types.js").PluginOptions["saveAndExit"];
+    baseUrl: string;
 };
 /**
  * Handles logging and issuing a permanent redirect for legacy routes.

package/.server/server/plugins/engine/models/SummaryViewModel.d.ts

@@ -1,3 +1,4 @@
+import { type PaymentState } from '~/src/server/plugins/engine/components/PaymentField.types.js';
 import { type Field } from '~/src/server/plugins/engine/components/helpers/components.js';
 import { type BackLink, type ComponentViewModel } from '~/src/server/plugins/engine/components/types.js';
 import { type Detail, type DetailItemField } from '~/src/server/plugins/engine/models/types.js';
@@ -22,6 +23,8 @@ export declare class SummaryViewModel {
     hasMissingNotificationEmail?: boolean;
     components?: ComponentViewModel[];
     allowSaveAndExit: boolean;
+    paymentState?: PaymentState;
+    paymentDetails?: CheckAnswers;
     constructor(request: FormContextRequest, page: PageControllerClass, context: FormContext);
     private summaryDetails;
 }

package/.server/server/plugins/engine/models/SummaryViewModel.js

@@ -1,4 +1,5 @@
 import { SchemaVersion } from '@defra/forms-model';
+import { PaymentField } from "../components/PaymentField.js";
 import { getAnswer } from "../components/helpers/components.js";
 import { evaluateTemplate, getError, getPageHref } from "../helpers.js";
 import { RepeatPageController } from "../pageControllers/RepeatPageController.js";
@@ -23,6 +24,8 @@ export class SummaryViewModel {
   hasMissingNotificationEmail;
   components;
   allowSaveAndExit = false;
+  paymentState;
+  paymentDetails;
   constructor(request, page, context) {
     const {
       model
@@ -118,6 +121,10 @@ export class SummaryViewModel {
           }));
         } else {
           for (const field of collection.fields) {
+            // PaymentField is rendered in its own section, skip it here
+            if (field instanceof PaymentField) {
+              continue;
+            }
             items.push(ItemField(page, state, field, {
               path,
               errors

package/.server/server/plugins/engine/models/SummaryViewModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"SummaryViewModel.js","names":["SchemaVersion","getAnswer","evaluateTemplate","getError","getPageHref","RepeatPageController","validationOptions","opts","SummaryViewModel","page","pageTitle","declaration","details","checkAnswers","context","name","backLink","feedbackLink","phaseTag","errors","serviceUrl","hasMissingNotificationEmail","components","allowSaveAndExit","constructor","request","model","basePath","def","sections","isForceAccess","title","schema","V2","result","makeFilteredSchema","relevantPages","validate","relevantState","stripUnknown","error","map","summaryDetails","detail","rows","items","item","push","href","text","classes","visuallyHiddenText","label","key","value","html","actions","undefined","summaryList","state","forEach","section","sectionPages","filter","collection","path","ItemRepeat","getSummaryPath","field","fields","ItemField","length","options","repeat","values","getListFromState","unit","returnUrl","subItems","repeatState","required","getFirstError"],"sources":["../../../../../src/server/plugins/engine/models/SummaryViewModel.ts"],"sourcesContent":["import { SchemaVersion, type Section } from '@defra/forms-model'\n\nimport {\n  getAnswer,\n  type Field\n} from '~/src/server/plugins/engine/components/helpers/components.js'\nimport {\n  type BackLink,\n  type ComponentViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport {\n  evaluateTemplate,\n  getError,\n  getPageHref\n} from '~/src/server/plugins/engine/helpers.js'\nimport {\n  type Detail,\n  type DetailItem,\n  type DetailItemField,\n  type DetailItemRepeat\n} from '~/src/server/plugins/engine/models/types.js'\nimport { RepeatPageController } from '~/src/server/plugins/engine/pageControllers/RepeatPageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport { validationOptions as opts } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type CheckAnswers,\n  type FormContext,\n  type FormContextRequest,\n  type FormState,\n  type FormSubmissionError,\n  type SummaryListAction,\n  type SummaryListRow\n} from '~/src/server/plugins/engine/types.js'\n\nexport class SummaryViewModel {\n  /**\n   * Responsible for parsing state values to the govuk-frontend summary list template\n   */\n\n  page: PageControllerClass\n  pageTitle: string\n  declaration?: string\n  details: Detail[]\n  checkAnswers: CheckAnswers[]\n  context: FormContext\n  name: string | undefined\n  backLink?: BackLink\n  feedbackLink?: string\n  phaseTag?: string\n  errors?: FormSubmissionError[]\n  serviceUrl: string\n  hasMissingNotificationEmail?: boolean\n  components?: ComponentViewModel[]\n  allowSaveAndExit = false\n\n  constructor(\n    request: FormContextRequest,\n    page: PageControllerClass,\n    context: FormContext\n  ) {\n    const { model } = page\n    const { basePath, def, sections } = model\n    const { isForceAccess } = context\n\n    this.page = page\n    this.pageTitle = page.title\n    if (def.schema === SchemaVersion.V2 && !page.title) {\n      this.pageTitle = 'Check your answers before sending your form'\n    }\n\n    this.serviceUrl = `/${basePath}`\n    this.name = def.name\n    this.declaration = def.declaration\n    this.context = context\n\n    const result = model\n      .makeFilteredSchema(this.context.relevantPages)\n      .validate(this.context.relevantState, { ...opts, stripUnknown: true })\n\n    // Format errors\n    this.errors = result.error?.details.map(getError)\n    this.details = this.summaryDetails(request, sections)\n\n    // Format check answers\n    this.checkAnswers = this.details.map((detail): CheckAnswers => {\n      const { title } = detail\n\n      const rows = detail.items.map((item): SummaryListRow => {\n        const items: SummaryListAction[] = []\n\n        // Remove summary list actions from previews\n        if (!isForceAccess) {\n          items.push({\n            href: item.href,\n            text: 'Change',\n            classes: 'govuk-link--no-visited-state',\n            visuallyHiddenText: item.label\n          })\n        }\n\n        return {\n          key: {\n            text: evaluateTemplate(item.title, context)\n          },\n          value: {\n            classes: 'app-prose-scope',\n            html: item.value || 'Not provided'\n          },\n          actions: {\n            items\n          }\n        }\n      })\n\n      return {\n        title: title ? { text: title } : undefined,\n        summaryList: { rows }\n      }\n    })\n  }\n\n  private summaryDetails(request: FormContextRequest, sections: Section[]) {\n    const { context, errors } = this\n    const { relevantPages, state } = context\n\n    const details: Detail[] = []\n\n    ;[...sections, undefined].forEach((section) => {\n      const items: DetailItem[] = []\n\n      const sectionPages = relevantPages.filter(\n        (page) => page.section === section\n      )\n\n      sectionPages.forEach((page) => {\n        const { collection, path } = page\n\n        if (page instanceof RepeatPageController) {\n          items.push(\n            ItemRepeat(page, state, {\n              path: page.getSummaryPath(request),\n              errors\n            })\n          )\n        } else {\n          for (const field of collection.fields) {\n            items.push(ItemField(page, state, field, { path, errors }))\n          }\n        }\n      })\n\n      if (items.length) {\n        details.push({\n          name: section?.name,\n          title: section?.title,\n          items\n        })\n      }\n    })\n\n    return details\n  }\n}\n\n/**\n * Creates a repeater detail item\n * @see {@link DetailItemField}\n */\nfunction ItemRepeat(\n  page: RepeatPageController,\n  state: FormState,\n  options: {\n    path: string\n    errors?: FormSubmissionError[]\n  }\n): DetailItemRepeat {\n  const { collection, repeat } = page\n  const { name, title } = repeat.options\n\n  const values = page.getListFromState(state)\n  const unit = values.length === 1 ? title : `${title}s`\n\n  return {\n    name,\n    label: title,\n    title: values.length ? `${unit} added` : unit,\n    value: values.length ? `You added ${values.length} ${unit}` : '',\n    href: getPageHref(page, options.path, {\n      returnUrl: getPageHref(page, page.getSummaryPath())\n    }),\n    state,\n    page,\n\n    // Repeater field detail items\n    subItems: values.map((repeatState) =>\n      collection.fields.map((field) =>\n        ItemField(page, repeatState, field, options)\n      )\n    )\n  }\n}\n\n/**\n * Creates a form field detail item\n * @see {@link DetailItemField}\n */\nexport function ItemField(\n  page: PageControllerClass,\n  state: FormState,\n  field: Field,\n  options: {\n    path: string\n    errors?: FormSubmissionError[]\n  }\n): DetailItemField {\n  return {\n    name: field.name,\n    label: field.title,\n    title:\n      field.options.required === false\n        ? `${field.label} (optional)`\n        : field.label,\n    error: field.getFirstError(options.errors),\n    value: getAnswer(field, state),\n    href: getPageHref(page, options.path, {\n      returnUrl: getPageHref(page, page.getSummaryPath())\n    }),\n    state,\n    page,\n    field\n  }\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAAsB,oBAAoB;AAEhE,SACEC,SAAS;AAOX,SACEC,gBAAgB,EAChBC,QAAQ,EACRC,WAAW;AAQb,SAASC,oBAAoB;AAE7B,SAASC,iBAAiB,IAAIC,IAAI;AAWlC,OAAO,MAAMC,gBAAgB,CAAC;EAC5B;AACF;AACA;;EAEEC,IAAI;EACJC,SAAS;EACTC,WAAW;EACXC,OAAO;EACPC,YAAY;EACZC,OAAO;EACPC,IAAI;EACJC,QAAQ;EACRC,YAAY;EACZC,QAAQ;EACRC,MAAM;EACNC,UAAU;EACVC,2BAA2B;EAC3BC,UAAU;EACVC,gBAAgB,GAAG,KAAK;EAExBC,WAAWA,CACTC,OAA2B,EAC3BhB,IAAyB,EACzBK,OAAoB,EACpB;IACA,MAAM;MAAEY;IAAM,CAAC,GAAGjB,IAAI;IACtB,MAAM;MAAEkB,QAAQ;MAAEC,GAAG;MAAEC;IAAS,CAAC,GAAGH,KAAK;IACzC,MAAM;MAAEI;IAAc,CAAC,GAAGhB,OAAO;IAEjC,IAAI,CAACL,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,SAAS,GAAGD,IAAI,CAACsB,KAAK;IAC3B,IAAIH,GAAG,CAACI,MAAM,KAAKhC,aAAa,CAACiC,EAAE,IAAI,CAACxB,IAAI,CAACsB,KAAK,EAAE;MAClD,IAAI,CAACrB,SAAS,GAAG,6CAA6C;IAChE;IAEA,IAAI,CAACU,UAAU,GAAG,IAAIO,QAAQ,EAAE;IAChC,IAAI,CAACZ,IAAI,GAAGa,GAAG,CAACb,IAAI;IACpB,IAAI,CAACJ,WAAW,GAAGiB,GAAG,CAACjB,WAAW;IAClC,IAAI,CAACG,OAAO,GAAGA,OAAO;IAEtB,MAAMoB,MAAM,GAAGR,KAAK,CACjBS,kBAAkB,CAAC,IAAI,CAACrB,OAAO,CAACsB,aAAa,CAAC,CAC9CC,QAAQ,CAAC,IAAI,CAACvB,OAAO,CAACwB,aAAa,EAAE;MAAE,GAAG/B,IAAI;MAAEgC,YAAY,EAAE;IAAK,CAAC,CAAC;;IAExE;IACA,IAAI,CAACpB,MAAM,GAAGe,MAAM,CAACM,KAAK,EAAE5B,OAAO,CAAC6B,GAAG,CAACtC,QAAQ,CAAC;IACjD,IAAI,CAACS,OAAO,GAAG,IAAI,CAAC8B,cAAc,CAACjB,OAAO,EAAEI,QAAQ,CAAC;;IAErD;IACA,IAAI,CAAChB,YAAY,GAAG,IAAI,CAACD,OAAO,CAAC6B,GAAG,CAAEE,MAAM,IAAmB;MAC7D,MAAM;QAAEZ;MAAM,CAAC,GAAGY,MAAM;MAExB,MAAMC,IAAI,GAAGD,MAAM,CAACE,KAAK,CAACJ,GAAG,CAAEK,IAAI,IAAqB;QACtD,MAAMD,KAA0B,GAAG,EAAE;;QAErC;QACA,IAAI,CAACf,aAAa,EAAE;UAClBe,KAAK,CAACE,IAAI,CAAC;YACTC,IAAI,EAAEF,IAAI,CAACE,IAAI;YACfC,IAAI,EAAE,QAAQ;YACdC,OAAO,EAAE,8BAA8B;YACvCC,kBAAkB,EAAEL,IAAI,CAACM;UAC3B,CAAC,CAAC;QACJ;QAEA,OAAO;UACLC,GAAG,EAAE;YACHJ,IAAI,EAAE/C,gBAAgB,CAAC4C,IAAI,CAACf,KAAK,EAAEjB,OAAO;UAC5C,CAAC;UACDwC,KAAK,EAAE;YACLJ,OAAO,EAAE,iBAAiB;YAC1BK,IAAI,EAAET,IAAI,CAACQ,KAAK,IAAI;UACtB,CAAC;UACDE,OAAO,EAAE;YACPX;UACF;QACF,CAAC;MACH,CAAC,CAAC;MAEF,OAAO;QACLd,KAAK,EAAEA,KAAK,GAAG;UAAEkB,IAAI,EAAElB;QAAM,CAAC,GAAG0B,SAAS;QAC1CC,WAAW,EAAE;UAAEd;QAAK;MACtB,CAAC;IACH,CAAC,CAAC;EACJ;EAEQF,cAAcA,CAACjB,OAA2B,EAAEI,QAAmB,EAAE;IACvE,MAAM;MAAEf,OAAO;MAAEK;IAAO,CAAC,GAAG,IAAI;IAChC,MAAM;MAAEiB,aAAa;MAAEuB;IAAM,CAAC,GAAG7C,OAAO;IAExC,MAAMF,OAAiB,GAAG,EAAE;IAE3B,CAAC,GAAGiB,QAAQ,EAAE4B,SAAS,CAAC,CAACG,OAAO,CAAEC,OAAO,IAAK;MAC7C,MAAMhB,KAAmB,GAAG,EAAE;MAE9B,MAAMiB,YAAY,GAAG1B,aAAa,CAAC2B,MAAM,CACtCtD,IAAI,IAAKA,IAAI,CAACoD,OAAO,KAAKA,OAC7B,CAAC;MAEDC,YAAY,CAACF,OAAO,CAAEnD,IAAI,IAAK;QAC7B,MAAM;UAAEuD,UAAU;UAAEC;QAAK,CAAC,GAAGxD,IAAI;QAEjC,IAAIA,IAAI,YAAYJ,oBAAoB,EAAE;UACxCwC,KAAK,CAACE,IAAI,CACRmB,UAAU,CAACzD,IAAI,EAAEkD,KAAK,EAAE;YACtBM,IAAI,EAAExD,IAAI,CAAC0D,cAAc,CAAC1C,OAAO,CAAC;YAClCN;UACF,CAAC,CACH,CAAC;QACH,CAAC,MAAM;UACL,KAAK,MAAMiD,KAAK,IAAIJ,UAAU,CAACK,MAAM,EAAE;YACrCxB,KAAK,CAACE,IAAI,CAACuB,SAAS,CAAC7D,IAAI,EAAEkD,KAAK,EAAES,KAAK,EAAE;cAAEH,IAAI;cAAE9C;YAAO,CAAC,CAAC,CAAC;UAC7D;QACF;MACF,CAAC,CAAC;MAEF,IAAI0B,KAAK,CAAC0B,MAAM,EAAE;QAChB3D,OAAO,CAACmC,IAAI,CAAC;UACXhC,IAAI,EAAE8C,OAAO,EAAE9C,IAAI;UACnBgB,KAAK,EAAE8B,OAAO,EAAE9B,KAAK;UACrBc;QACF,CAAC,CAAC;MACJ;IACF,CAAC,CAAC;IAEF,OAAOjC,OAAO;EAChB;AACF;;AAEA;AACA;AACA;AACA;AACA,SAASsD,UAAUA,CACjBzD,IAA0B,EAC1BkD,KAAgB,EAChBa,OAGC,EACiB;EAClB,MAAM;IAAER,UAAU;IAAES;EAAO,CAAC,GAAGhE,IAAI;EACnC,MAAM;IAAEM,IAAI;IAAEgB;EAAM,CAAC,GAAG0C,MAAM,CAACD,OAAO;EAEtC,MAAME,MAAM,GAAGjE,IAAI,CAACkE,gBAAgB,CAAChB,KAAK,CAAC;EAC3C,MAAMiB,IAAI,GAAGF,MAAM,CAACH,MAAM,KAAK,CAAC,GAAGxC,KAAK,GAAG,GAAGA,KAAK,GAAG;EAEtD,OAAO;IACLhB,IAAI;IACJqC,KAAK,EAAErB,KAAK;IACZA,KAAK,EAAE2C,MAAM,CAACH,MAAM,GAAG,GAAGK,IAAI,QAAQ,GAAGA,IAAI;IAC7CtB,KAAK,EAAEoB,MAAM,CAACH,MAAM,GAAG,aAAaG,MAAM,CAACH,MAAM,IAAIK,IAAI,EAAE,GAAG,EAAE;IAChE5B,IAAI,EAAE5C,WAAW,CAACK,IAAI,EAAE+D,OAAO,CAACP,IAAI,EAAE;MACpCY,SAAS,EAAEzE,WAAW,CAACK,IAAI,EAAEA,IAAI,CAAC0D,cAAc,CAAC,CAAC;IACpD,CAAC,CAAC;IACFR,KAAK;IACLlD,IAAI;IAEJ;IACAqE,QAAQ,EAAEJ,MAAM,CAACjC,GAAG,CAAEsC,WAAW,IAC/Bf,UAAU,CAACK,MAAM,CAAC5B,GAAG,CAAE2B,KAAK,IAC1BE,SAAS,CAAC7D,IAAI,EAAEsE,WAAW,EAAEX,KAAK,EAAEI,OAAO,CAC7C,CACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASF,SAASA,CACvB7D,IAAyB,EACzBkD,KAAgB,EAChBS,KAAY,EACZI,OAGC,EACgB;EACjB,OAAO;IACLzD,IAAI,EAAEqD,KAAK,CAACrD,IAAI;IAChBqC,KAAK,EAAEgB,KAAK,CAACrC,KAAK;IAClBA,KAAK,EACHqC,KAAK,CAACI,OAAO,CAACQ,QAAQ,KAAK,KAAK,GAC5B,GAAGZ,KAAK,CAAChB,KAAK,aAAa,GAC3BgB,KAAK,CAAChB,KAAK;IACjBZ,KAAK,EAAE4B,KAAK,CAACa,aAAa,CAACT,OAAO,CAACrD,MAAM,CAAC;IAC1CmC,KAAK,EAAErD,SAAS,CAACmE,KAAK,EAAET,KAAK,CAAC;IAC9BX,IAAI,EAAE5C,WAAW,CAACK,IAAI,EAAE+D,OAAO,CAACP,IAAI,EAAE;MACpCY,SAAS,EAAEzE,WAAW,CAACK,IAAI,EAAEA,IAAI,CAAC0D,cAAc,CAAC,CAAC;IACpD,CAAC,CAAC;IACFR,KAAK;IACLlD,IAAI;IACJ2D;EACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"SummaryViewModel.js","names":["SchemaVersion","PaymentField","getAnswer","evaluateTemplate","getError","getPageHref","RepeatPageController","validationOptions","opts","SummaryViewModel","page","pageTitle","declaration","details","checkAnswers","context","name","backLink","feedbackLink","phaseTag","errors","serviceUrl","hasMissingNotificationEmail","components","allowSaveAndExit","paymentState","paymentDetails","constructor","request","model","basePath","def","sections","isForceAccess","title","schema","V2","result","makeFilteredSchema","relevantPages","validate","relevantState","stripUnknown","error","map","summaryDetails","detail","rows","items","item","push","href","text","classes","visuallyHiddenText","label","key","value","html","actions","undefined","summaryList","state","forEach","section","sectionPages","filter","collection","path","ItemRepeat","getSummaryPath","field","fields","ItemField","length","options","repeat","values","getListFromState","unit","returnUrl","subItems","repeatState","required","getFirstError"],"sources":["../../../../../src/server/plugins/engine/models/SummaryViewModel.ts"],"sourcesContent":["import { SchemaVersion, type Section } from '@defra/forms-model'\n\nimport { PaymentField } from '~/src/server/plugins/engine/components/PaymentField.js'\nimport { type PaymentState } from '~/src/server/plugins/engine/components/PaymentField.types.js'\nimport {\n  getAnswer,\n  type Field\n} from '~/src/server/plugins/engine/components/helpers/components.js'\nimport {\n  type BackLink,\n  type ComponentViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport {\n  evaluateTemplate,\n  getError,\n  getPageHref\n} from '~/src/server/plugins/engine/helpers.js'\nimport {\n  type Detail,\n  type DetailItem,\n  type DetailItemField,\n  type DetailItemRepeat\n} from '~/src/server/plugins/engine/models/types.js'\nimport { RepeatPageController } from '~/src/server/plugins/engine/pageControllers/RepeatPageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport { validationOptions as opts } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type CheckAnswers,\n  type FormContext,\n  type FormContextRequest,\n  type FormState,\n  type FormSubmissionError,\n  type SummaryListAction,\n  type SummaryListRow\n} from '~/src/server/plugins/engine/types.js'\n\nexport class SummaryViewModel {\n  /**\n   * Responsible for parsing state values to the govuk-frontend summary list template\n   */\n\n  page: PageControllerClass\n  pageTitle: string\n  declaration?: string\n  details: Detail[]\n  checkAnswers: CheckAnswers[]\n  context: FormContext\n  name: string | undefined\n  backLink?: BackLink\n  feedbackLink?: string\n  phaseTag?: string\n  errors?: FormSubmissionError[]\n  serviceUrl: string\n  hasMissingNotificationEmail?: boolean\n  components?: ComponentViewModel[]\n  allowSaveAndExit = false\n  paymentState?: PaymentState\n  paymentDetails?: CheckAnswers\n\n  constructor(\n    request: FormContextRequest,\n    page: PageControllerClass,\n    context: FormContext\n  ) {\n    const { model } = page\n    const { basePath, def, sections } = model\n    const { isForceAccess } = context\n\n    this.page = page\n    this.pageTitle = page.title\n    if (def.schema === SchemaVersion.V2 && !page.title) {\n      this.pageTitle = 'Check your answers before sending your form'\n    }\n\n    this.serviceUrl = `/${basePath}`\n    this.name = def.name\n    this.declaration = def.declaration\n    this.context = context\n\n    const result = model\n      .makeFilteredSchema(this.context.relevantPages)\n      .validate(this.context.relevantState, { ...opts, stripUnknown: true })\n\n    // Format errors\n    this.errors = result.error?.details.map(getError)\n    this.details = this.summaryDetails(request, sections)\n\n    // Format check answers\n    this.checkAnswers = this.details.map((detail): CheckAnswers => {\n      const { title } = detail\n\n      const rows = detail.items.map((item): SummaryListRow => {\n        const items: SummaryListAction[] = []\n\n        // Remove summary list actions from previews\n        if (!isForceAccess) {\n          items.push({\n            href: item.href,\n            text: 'Change',\n            classes: 'govuk-link--no-visited-state',\n            visuallyHiddenText: item.label\n          })\n        }\n\n        return {\n          key: {\n            text: evaluateTemplate(item.title, context)\n          },\n          value: {\n            classes: 'app-prose-scope',\n            html: item.value || 'Not provided'\n          },\n          actions: {\n            items\n          }\n        }\n      })\n\n      return {\n        title: title ? { text: title } : undefined,\n        summaryList: { rows }\n      }\n    })\n  }\n\n  private summaryDetails(request: FormContextRequest, sections: Section[]) {\n    const { context, errors } = this\n    const { relevantPages, state } = context\n\n    const details: Detail[] = []\n\n    ;[...sections, undefined].forEach((section) => {\n      const items: DetailItem[] = []\n\n      const sectionPages = relevantPages.filter(\n        (page) => page.section === section\n      )\n\n      sectionPages.forEach((page) => {\n        const { collection, path } = page\n\n        if (page instanceof RepeatPageController) {\n          items.push(\n            ItemRepeat(page, state, {\n              path: page.getSummaryPath(request),\n              errors\n            })\n          )\n        } else {\n          for (const field of collection.fields) {\n            // PaymentField is rendered in its own section, skip it here\n            if (field instanceof PaymentField) {\n              continue\n            }\n            items.push(ItemField(page, state, field, { path, errors }))\n          }\n        }\n      })\n\n      if (items.length) {\n        details.push({\n          name: section?.name,\n          title: section?.title,\n          items\n        })\n      }\n    })\n\n    return details\n  }\n}\n\n/**\n * Creates a repeater detail item\n * @see {@link DetailItemField}\n */\nfunction ItemRepeat(\n  page: RepeatPageController,\n  state: FormState,\n  options: {\n    path: string\n    errors?: FormSubmissionError[]\n  }\n): DetailItemRepeat {\n  const { collection, repeat } = page\n  const { name, title } = repeat.options\n\n  const values = page.getListFromState(state)\n  const unit = values.length === 1 ? title : `${title}s`\n\n  return {\n    name,\n    label: title,\n    title: values.length ? `${unit} added` : unit,\n    value: values.length ? `You added ${values.length} ${unit}` : '',\n    href: getPageHref(page, options.path, {\n      returnUrl: getPageHref(page, page.getSummaryPath())\n    }),\n    state,\n    page,\n\n    // Repeater field detail items\n    subItems: values.map((repeatState) =>\n      collection.fields.map((field) =>\n        ItemField(page, repeatState, field, options)\n      )\n    )\n  }\n}\n\n/**\n * Creates a form field detail item\n * @see {@link DetailItemField}\n */\nexport function ItemField(\n  page: PageControllerClass,\n  state: FormState,\n  field: Field,\n  options: {\n    path: string\n    errors?: FormSubmissionError[]\n  }\n): DetailItemField {\n  return {\n    name: field.name,\n    label: field.title,\n    title:\n      field.options.required === false\n        ? `${field.label} (optional)`\n        : field.label,\n    error: field.getFirstError(options.errors),\n    value: getAnswer(field, state),\n    href: getPageHref(page, options.path, {\n      returnUrl: getPageHref(page, page.getSummaryPath())\n    }),\n    state,\n    page,\n    field\n  }\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAAsB,oBAAoB;AAEhE,SAASC,YAAY;AAErB,SACEC,SAAS;AAOX,SACEC,gBAAgB,EAChBC,QAAQ,EACRC,WAAW;AAQb,SAASC,oBAAoB;AAE7B,SAASC,iBAAiB,IAAIC,IAAI;AAWlC,OAAO,MAAMC,gBAAgB,CAAC;EAC5B;AACF;AACA;;EAEEC,IAAI;EACJC,SAAS;EACTC,WAAW;EACXC,OAAO;EACPC,YAAY;EACZC,OAAO;EACPC,IAAI;EACJC,QAAQ;EACRC,YAAY;EACZC,QAAQ;EACRC,MAAM;EACNC,UAAU;EACVC,2BAA2B;EAC3BC,UAAU;EACVC,gBAAgB,GAAG,KAAK;EACxBC,YAAY;EACZC,cAAc;EAEdC,WAAWA,CACTC,OAA2B,EAC3BlB,IAAyB,EACzBK,OAAoB,EACpB;IACA,MAAM;MAAEc;IAAM,CAAC,GAAGnB,IAAI;IACtB,MAAM;MAAEoB,QAAQ;MAAEC,GAAG;MAAEC;IAAS,CAAC,GAAGH,KAAK;IACzC,MAAM;MAAEI;IAAc,CAAC,GAAGlB,OAAO;IAEjC,IAAI,CAACL,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,SAAS,GAAGD,IAAI,CAACwB,KAAK;IAC3B,IAAIH,GAAG,CAACI,MAAM,KAAKnC,aAAa,CAACoC,EAAE,IAAI,CAAC1B,IAAI,CAACwB,KAAK,EAAE;MAClD,IAAI,CAACvB,SAAS,GAAG,6CAA6C;IAChE;IAEA,IAAI,CAACU,UAAU,GAAG,IAAIS,QAAQ,EAAE;IAChC,IAAI,CAACd,IAAI,GAAGe,GAAG,CAACf,IAAI;IACpB,IAAI,CAACJ,WAAW,GAAGmB,GAAG,CAACnB,WAAW;IAClC,IAAI,CAACG,OAAO,GAAGA,OAAO;IAEtB,MAAMsB,MAAM,GAAGR,KAAK,CACjBS,kBAAkB,CAAC,IAAI,CAACvB,OAAO,CAACwB,aAAa,CAAC,CAC9CC,QAAQ,CAAC,IAAI,CAACzB,OAAO,CAAC0B,aAAa,EAAE;MAAE,GAAGjC,IAAI;MAAEkC,YAAY,EAAE;IAAK,CAAC,CAAC;;IAExE;IACA,IAAI,CAACtB,MAAM,GAAGiB,MAAM,CAACM,KAAK,EAAE9B,OAAO,CAAC+B,GAAG,CAACxC,QAAQ,CAAC;IACjD,IAAI,CAACS,OAAO,GAAG,IAAI,CAACgC,cAAc,CAACjB,OAAO,EAAEI,QAAQ,CAAC;;IAErD;IACA,IAAI,CAAClB,YAAY,GAAG,IAAI,CAACD,OAAO,CAAC+B,GAAG,CAAEE,MAAM,IAAmB;MAC7D,MAAM;QAAEZ;MAAM,CAAC,GAAGY,MAAM;MAExB,MAAMC,IAAI,GAAGD,MAAM,CAACE,KAAK,CAACJ,GAAG,CAAEK,IAAI,IAAqB;QACtD,MAAMD,KAA0B,GAAG,EAAE;;QAErC;QACA,IAAI,CAACf,aAAa,EAAE;UAClBe,KAAK,CAACE,IAAI,CAAC;YACTC,IAAI,EAAEF,IAAI,CAACE,IAAI;YACfC,IAAI,EAAE,QAAQ;YACdC,OAAO,EAAE,8BAA8B;YACvCC,kBAAkB,EAAEL,IAAI,CAACM;UAC3B,CAAC,CAAC;QACJ;QAEA,OAAO;UACLC,GAAG,EAAE;YACHJ,IAAI,EAAEjD,gBAAgB,CAAC8C,IAAI,CAACf,KAAK,EAAEnB,OAAO;UAC5C,CAAC;UACD0C,KAAK,EAAE;YACLJ,OAAO,EAAE,iBAAiB;YAC1BK,IAAI,EAAET,IAAI,CAACQ,KAAK,IAAI;UACtB,CAAC;UACDE,OAAO,EAAE;YACPX;UACF;QACF,CAAC;MACH,CAAC,CAAC;MAEF,OAAO;QACLd,KAAK,EAAEA,KAAK,GAAG;UAAEkB,IAAI,EAAElB;QAAM,CAAC,GAAG0B,SAAS;QAC1CC,WAAW,EAAE;UAAEd;QAAK;MACtB,CAAC;IACH,CAAC,CAAC;EACJ;EAEQF,cAAcA,CAACjB,OAA2B,EAAEI,QAAmB,EAAE;IACvE,MAAM;MAAEjB,OAAO;MAAEK;IAAO,CAAC,GAAG,IAAI;IAChC,MAAM;MAAEmB,aAAa;MAAEuB;IAAM,CAAC,GAAG/C,OAAO;IAExC,MAAMF,OAAiB,GAAG,EAAE;IAE3B,CAAC,GAAGmB,QAAQ,EAAE4B,SAAS,CAAC,CAACG,OAAO,CAAEC,OAAO,IAAK;MAC7C,MAAMhB,KAAmB,GAAG,EAAE;MAE9B,MAAMiB,YAAY,GAAG1B,aAAa,CAAC2B,MAAM,CACtCxD,IAAI,IAAKA,IAAI,CAACsD,OAAO,KAAKA,OAC7B,CAAC;MAEDC,YAAY,CAACF,OAAO,CAAErD,IAAI,IAAK;QAC7B,MAAM;UAAEyD,UAAU;UAAEC;QAAK,CAAC,GAAG1D,IAAI;QAEjC,IAAIA,IAAI,YAAYJ,oBAAoB,EAAE;UACxC0C,KAAK,CAACE,IAAI,CACRmB,UAAU,CAAC3D,IAAI,EAAEoD,KAAK,EAAE;YACtBM,IAAI,EAAE1D,IAAI,CAAC4D,cAAc,CAAC1C,OAAO,CAAC;YAClCR;UACF,CAAC,CACH,CAAC;QACH,CAAC,MAAM;UACL,KAAK,MAAMmD,KAAK,IAAIJ,UAAU,CAACK,MAAM,EAAE;YACrC;YACA,IAAID,KAAK,YAAYtE,YAAY,EAAE;cACjC;YACF;YACA+C,KAAK,CAACE,IAAI,CAACuB,SAAS,CAAC/D,IAAI,EAAEoD,KAAK,EAAES,KAAK,EAAE;cAAEH,IAAI;cAAEhD;YAAO,CAAC,CAAC,CAAC;UAC7D;QACF;MACF,CAAC,CAAC;MAEF,IAAI4B,KAAK,CAAC0B,MAAM,EAAE;QAChB7D,OAAO,CAACqC,IAAI,CAAC;UACXlC,IAAI,EAAEgD,OAAO,EAAEhD,IAAI;UACnBkB,KAAK,EAAE8B,OAAO,EAAE9B,KAAK;UACrBc;QACF,CAAC,CAAC;MACJ;IACF,CAAC,CAAC;IAEF,OAAOnC,OAAO;EAChB;AACF;;AAEA;AACA;AACA;AACA;AACA,SAASwD,UAAUA,CACjB3D,IAA0B,EAC1BoD,KAAgB,EAChBa,OAGC,EACiB;EAClB,MAAM;IAAER,UAAU;IAAES;EAAO,CAAC,GAAGlE,IAAI;EACnC,MAAM;IAAEM,IAAI;IAAEkB;EAAM,CAAC,GAAG0C,MAAM,CAACD,OAAO;EAEtC,MAAME,MAAM,GAAGnE,IAAI,CAACoE,gBAAgB,CAAChB,KAAK,CAAC;EAC3C,MAAMiB,IAAI,GAAGF,MAAM,CAACH,MAAM,KAAK,CAAC,GAAGxC,KAAK,GAAG,GAAGA,KAAK,GAAG;EAEtD,OAAO;IACLlB,IAAI;IACJuC,KAAK,EAAErB,KAAK;IACZA,KAAK,EAAE2C,MAAM,CAACH,MAAM,GAAG,GAAGK,IAAI,QAAQ,GAAGA,IAAI;IAC7CtB,KAAK,EAAEoB,MAAM,CAACH,MAAM,GAAG,aAAaG,MAAM,CAACH,MAAM,IAAIK,IAAI,EAAE,GAAG,EAAE;IAChE5B,IAAI,EAAE9C,WAAW,CAACK,IAAI,EAAEiE,OAAO,CAACP,IAAI,EAAE;MACpCY,SAAS,EAAE3E,WAAW,CAACK,IAAI,EAAEA,IAAI,CAAC4D,cAAc,CAAC,CAAC;IACpD,CAAC,CAAC;IACFR,KAAK;IACLpD,IAAI;IAEJ;IACAuE,QAAQ,EAAEJ,MAAM,CAACjC,GAAG,CAAEsC,WAAW,IAC/Bf,UAAU,CAACK,MAAM,CAAC5B,GAAG,CAAE2B,KAAK,IAC1BE,SAAS,CAAC/D,IAAI,EAAEwE,WAAW,EAAEX,KAAK,EAAEI,OAAO,CAC7C,CACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASF,SAASA,CACvB/D,IAAyB,EACzBoD,KAAgB,EAChBS,KAAY,EACZI,OAGC,EACgB;EACjB,OAAO;IACL3D,IAAI,EAAEuD,KAAK,CAACvD,IAAI;IAChBuC,KAAK,EAAEgB,KAAK,CAACrC,KAAK;IAClBA,KAAK,EACHqC,KAAK,CAACI,OAAO,CAACQ,QAAQ,KAAK,KAAK,GAC5B,GAAGZ,KAAK,CAAChB,KAAK,aAAa,GAC3BgB,KAAK,CAAChB,KAAK;IACjBZ,KAAK,EAAE4B,KAAK,CAACa,aAAa,CAACT,OAAO,CAACvD,MAAM,CAAC;IAC1CqC,KAAK,EAAEvD,SAAS,CAACqE,KAAK,EAAET,KAAK,CAAC;IAC9BX,IAAI,EAAE9C,WAAW,CAACK,IAAI,EAAEiE,OAAO,CAACP,IAAI,EAAE;MACpCY,SAAS,EAAE3E,WAAW,CAACK,IAAI,EAAEA,IAAI,CAAC4D,cAAc,CAAC,CAAC;IACpD,CAAC,CAAC;IACFR,KAAK;IACLpD,IAAI;IACJ6D;EACF,CAAC;AACH","ignoreList":[]}

package/.server/server/plugins/engine/options.js

@@ -20,7 +20,8 @@ const pluginRegistrationOptionsSchema = Joi.object({
   onRequest: Joi.function().optional(),
   baseUrl: Joi.string().uri().required(),
   saveAndExit: Joi.function().optional(),
-  ordnanceSurveyApiKey: Joi.string().optional()
+  ordnanceSurveyApiKey: Joi.string().optional(),
+  ordnanceSurveyApiSecret: Joi.string().optional()
 });
 
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"options.js","names":["getErrorMessage","Joi","createLogger","CacheService","logger","pluginRegistrationOptionsSchema","object","model","optional","services","controllers","pattern","string","any","cache","alternatives","try","instance","globals","filters","pluginPath","nunjucks","baseLayoutPath","required","paths","array","items","viewContext","function","preparePageEventRequestOptions","onRequest","baseUrl","uri","saveAndExit","ordnanceSurveyApiKey","validatePluginOptions","options","result","validate","abortEarly","error","Error","value"],"sources":["../../../../src/server/plugins/engine/options.js"],"sourcesContent":["import { getErrorMessage } from '@defra/forms-model'\nimport Joi from 'joi'\n\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport { CacheService } from '~/src/server/services/index.js'\n\nconst logger = createLogger()\n\nconst pluginRegistrationOptionsSchema = Joi.object({\n  model: Joi.object().optional(),\n  services: Joi.object().optional(),\n  controllers: Joi.object().pattern(Joi.string(), Joi.any()).optional(),\n  cache: Joi.alternatives().try(\n    Joi.object().instance(CacheService),\n    Joi.string()\n  ),\n  globals: Joi.object().pattern(Joi.string(), Joi.any()).optional(),\n  filters: Joi.object().pattern(Joi.string(), Joi.any()).optional(),\n  pluginPath: Joi.string().optional(),\n  nunjucks: Joi.object({\n    baseLayoutPath: Joi.string().required(),\n    paths: Joi.array().items(Joi.string()).required()\n  }).required(),\n  viewContext: Joi.function().required(),\n  preparePageEventRequestOptions: Joi.function().optional(),\n  onRequest: Joi.function().optional(),\n  baseUrl: Joi.string().uri().required(),\n  saveAndExit: Joi.function().optional(),\n  ordnanceSurveyApiKey: Joi.string().optional()\n})\n\n/**\n * Validates the plugin options against the schema and returns the validated value.\n * @param {PluginOptions} options\n * @returns {PluginOptions}\n */\nexport function validatePluginOptions(options) {\n  const result = pluginRegistrationOptionsSchema.validate(options, {\n    abortEarly: false\n  })\n\n  if (result.error) {\n    logger.error(\n      result.error,\n      `Missing required properties in plugin options: ${getErrorMessage(result.error)}`\n    )\n    throw new Error('Invalid plugin options', result.error)\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n  return result.value\n}\n\n/**\n * @import { PluginOptions } from '~/src/server/plugins/engine/types.js'\n */\n"],"mappings":"AAAA,SAASA,eAAe,QAAQ,oBAAoB;AACpD,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,YAAY;AACrB,SAASC,YAAY;AAErB,MAAMC,MAAM,GAAGF,YAAY,CAAC,CAAC;AAE7B,MAAMG,+BAA+B,GAAGJ,GAAG,CAACK,MAAM,CAAC;EACjDC,KAAK,EAAEN,GAAG,CAACK,MAAM,CAAC,CAAC,CAACE,QAAQ,CAAC,CAAC;EAC9BC,QAAQ,EAAER,GAAG,CAACK,MAAM,CAAC,CAAC,CAACE,QAAQ,CAAC,CAAC;EACjCE,WAAW,EAAET,GAAG,CAACK,MAAM,CAAC,CAAC,CAACK,OAAO,CAACV,GAAG,CAACW,MAAM,CAAC,CAAC,EAAEX,GAAG,CAACY,GAAG,CAAC,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACrEM,KAAK,EAAEb,GAAG,CAACc,YAAY,CAAC,CAAC,CAACC,GAAG,CAC3Bf,GAAG,CAACK,MAAM,CAAC,CAAC,CAACW,QAAQ,CAACd,YAAY,CAAC,EACnCF,GAAG,CAACW,MAAM,CAAC,CACb,CAAC;EACDM,OAAO,EAAEjB,GAAG,CAACK,MAAM,CAAC,CAAC,CAACK,OAAO,CAACV,GAAG,CAACW,MAAM,CAAC,CAAC,EAAEX,GAAG,CAACY,GAAG,CAAC,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACjEW,OAAO,EAAElB,GAAG,CAACK,MAAM,CAAC,CAAC,CAACK,OAAO,CAACV,GAAG,CAACW,MAAM,CAAC,CAAC,EAAEX,GAAG,CAACY,GAAG,CAAC,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACjEY,UAAU,EAAEnB,GAAG,CAACW,MAAM,CAAC,CAAC,CAACJ,QAAQ,CAAC,CAAC;EACnCa,QAAQ,EAAEpB,GAAG,CAACK,MAAM,CAAC;IACnBgB,cAAc,EAAErB,GAAG,CAACW,MAAM,CAAC,CAAC,CAACW,QAAQ,CAAC,CAAC;IACvCC,KAAK,EAAEvB,GAAG,CAACwB,KAAK,CAAC,CAAC,CAACC,KAAK,CAACzB,GAAG,CAACW,MAAM,CAAC,CAAC,CAAC,CAACW,QAAQ,CAAC;EAClD,CAAC,CAAC,CAACA,QAAQ,CAAC,CAAC;EACbI,WAAW,EAAE1B,GAAG,CAAC2B,QAAQ,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACtCM,8BAA8B,EAAE5B,GAAG,CAAC2B,QAAQ,CAAC,CAAC,CAACpB,QAAQ,CAAC,CAAC;EACzDsB,SAAS,EAAE7B,GAAG,CAAC2B,QAAQ,CAAC,CAAC,CAACpB,QAAQ,CAAC,CAAC;EACpCuB,OAAO,EAAE9B,GAAG,CAACW,MAAM,CAAC,CAAC,CAACoB,GAAG,CAAC,CAAC,CAACT,QAAQ,CAAC,CAAC;EACtCU,WAAW,EAAEhC,GAAG,CAAC2B,QAAQ,CAAC,CAAC,CAACpB,QAAQ,CAAC,CAAC;EACtC0B,oBAAoB,EAAEjC,GAAG,CAACW,MAAM,CAAC,CAAC,CAACJ,QAAQ,CAAC;AAC9C,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACA;AACA,OAAO,SAAS2B,qBAAqBA,CAACC,OAAO,EAAE;EAC7C,MAAMC,MAAM,GAAGhC,+BAA+B,CAACiC,QAAQ,CAACF,OAAO,EAAE;IAC/DG,UAAU,EAAE;EACd,CAAC,CAAC;EAEF,IAAIF,MAAM,CAACG,KAAK,EAAE;IAChBpC,MAAM,CAACoC,KAAK,CACVH,MAAM,CAACG,KAAK,EACZ,kDAAkDxC,eAAe,CAACqC,MAAM,CAACG,KAAK,CAAC,EACjF,CAAC;IACD,MAAM,IAAIC,KAAK,CAAC,wBAAwB,EAAEJ,MAAM,CAACG,KAAK,CAAC;EACzD;;EAEA;EACA,OAAOH,MAAM,CAACK,KAAK;AACrB;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"options.js","names":["getErrorMessage","Joi","createLogger","CacheService","logger","pluginRegistrationOptionsSchema","object","model","optional","services","controllers","pattern","string","any","cache","alternatives","try","instance","globals","filters","pluginPath","nunjucks","baseLayoutPath","required","paths","array","items","viewContext","function","preparePageEventRequestOptions","onRequest","baseUrl","uri","saveAndExit","ordnanceSurveyApiKey","ordnanceSurveyApiSecret","validatePluginOptions","options","result","validate","abortEarly","error","Error","value"],"sources":["../../../../src/server/plugins/engine/options.js"],"sourcesContent":["import { getErrorMessage } from '@defra/forms-model'\nimport Joi from 'joi'\n\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport { CacheService } from '~/src/server/services/index.js'\n\nconst logger = createLogger()\n\nconst pluginRegistrationOptionsSchema = Joi.object({\n  model: Joi.object().optional(),\n  services: Joi.object().optional(),\n  controllers: Joi.object().pattern(Joi.string(), Joi.any()).optional(),\n  cache: Joi.alternatives().try(\n    Joi.object().instance(CacheService),\n    Joi.string()\n  ),\n  globals: Joi.object().pattern(Joi.string(), Joi.any()).optional(),\n  filters: Joi.object().pattern(Joi.string(), Joi.any()).optional(),\n  pluginPath: Joi.string().optional(),\n  nunjucks: Joi.object({\n    baseLayoutPath: Joi.string().required(),\n    paths: Joi.array().items(Joi.string()).required()\n  }).required(),\n  viewContext: Joi.function().required(),\n  preparePageEventRequestOptions: Joi.function().optional(),\n  onRequest: Joi.function().optional(),\n  baseUrl: Joi.string().uri().required(),\n  saveAndExit: Joi.function().optional(),\n  ordnanceSurveyApiKey: Joi.string().optional(),\n  ordnanceSurveyApiSecret: Joi.string().optional()\n})\n\n/**\n * Validates the plugin options against the schema and returns the validated value.\n * @param {PluginOptions} options\n * @returns {PluginOptions}\n */\nexport function validatePluginOptions(options) {\n  const result = pluginRegistrationOptionsSchema.validate(options, {\n    abortEarly: false\n  })\n\n  if (result.error) {\n    logger.error(\n      result.error,\n      `Missing required properties in plugin options: ${getErrorMessage(result.error)}`\n    )\n    throw new Error('Invalid plugin options', result.error)\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n  return result.value\n}\n\n/**\n * @import { PluginOptions } from '~/src/server/plugins/engine/types.js'\n */\n"],"mappings":"AAAA,SAASA,eAAe,QAAQ,oBAAoB;AACpD,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,YAAY;AACrB,SAASC,YAAY;AAErB,MAAMC,MAAM,GAAGF,YAAY,CAAC,CAAC;AAE7B,MAAMG,+BAA+B,GAAGJ,GAAG,CAACK,MAAM,CAAC;EACjDC,KAAK,EAAEN,GAAG,CAACK,MAAM,CAAC,CAAC,CAACE,QAAQ,CAAC,CAAC;EAC9BC,QAAQ,EAAER,GAAG,CAACK,MAAM,CAAC,CAAC,CAACE,QAAQ,CAAC,CAAC;EACjCE,WAAW,EAAET,GAAG,CAACK,MAAM,CAAC,CAAC,CAACK,OAAO,CAACV,GAAG,CAACW,MAAM,CAAC,CAAC,EAAEX,GAAG,CAACY,GAAG,CAAC,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACrEM,KAAK,EAAEb,GAAG,CAACc,YAAY,CAAC,CAAC,CAACC,GAAG,CAC3Bf,GAAG,CAACK,MAAM,CAAC,CAAC,CAACW,QAAQ,CAACd,YAAY,CAAC,EACnCF,GAAG,CAACW,MAAM,CAAC,CACb,CAAC;EACDM,OAAO,EAAEjB,GAAG,CAACK,MAAM,CAAC,CAAC,CAACK,OAAO,CAACV,GAAG,CAACW,MAAM,CAAC,CAAC,EAAEX,GAAG,CAACY,GAAG,CAAC,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACjEW,OAAO,EAAElB,GAAG,CAACK,MAAM,CAAC,CAAC,CAACK,OAAO,CAACV,GAAG,CAACW,MAAM,CAAC,CAAC,EAAEX,GAAG,CAACY,GAAG,CAAC,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACjEY,UAAU,EAAEnB,GAAG,CAACW,MAAM,CAAC,CAAC,CAACJ,QAAQ,CAAC,CAAC;EACnCa,QAAQ,EAAEpB,GAAG,CAACK,MAAM,CAAC;IACnBgB,cAAc,EAAErB,GAAG,CAACW,MAAM,CAAC,CAAC,CAACW,QAAQ,CAAC,CAAC;IACvCC,KAAK,EAAEvB,GAAG,CAACwB,KAAK,CAAC,CAAC,CAACC,KAAK,CAACzB,GAAG,CAACW,MAAM,CAAC,CAAC,CAAC,CAACW,QAAQ,CAAC;EAClD,CAAC,CAAC,CAACA,QAAQ,CAAC,CAAC;EACbI,WAAW,EAAE1B,GAAG,CAAC2B,QAAQ,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACtCM,8BAA8B,EAAE5B,GAAG,CAAC2B,QAAQ,CAAC,CAAC,CAACpB,QAAQ,CAAC,CAAC;EACzDsB,SAAS,EAAE7B,GAAG,CAAC2B,QAAQ,CAAC,CAAC,CAACpB,QAAQ,CAAC,CAAC;EACpCuB,OAAO,EAAE9B,GAAG,CAACW,MAAM,CAAC,CAAC,CAACoB,GAAG,CAAC,CAAC,CAACT,QAAQ,CAAC,CAAC;EACtCU,WAAW,EAAEhC,GAAG,CAAC2B,QAAQ,CAAC,CAAC,CAACpB,QAAQ,CAAC,CAAC;EACtC0B,oBAAoB,EAAEjC,GAAG,CAACW,MAAM,CAAC,CAAC,CAACJ,QAAQ,CAAC,CAAC;EAC7C2B,uBAAuB,EAAElC,GAAG,CAACW,MAAM,CAAC,CAAC,CAACJ,QAAQ,CAAC;AACjD,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACA;AACA,OAAO,SAAS4B,qBAAqBA,CAACC,OAAO,EAAE;EAC7C,MAAMC,MAAM,GAAGjC,+BAA+B,CAACkC,QAAQ,CAACF,OAAO,EAAE;IAC/DG,UAAU,EAAE;EACd,CAAC,CAAC;EAEF,IAAIF,MAAM,CAACG,KAAK,EAAE;IAChBrC,MAAM,CAACqC,KAAK,CACVH,MAAM,CAACG,KAAK,EACZ,kDAAkDzC,eAAe,CAACsC,MAAM,CAACG,KAAK,CAAC,EACjF,CAAC;IACD,MAAM,IAAIC,KAAK,CAAC,wBAAwB,EAAEJ,MAAM,CAACG,KAAK,CAAC;EACzD;;EAEA;EACA,OAAOH,MAAM,CAACK,KAAK;AACrB;;AAEA;AACA;AACA","ignoreList":[]}

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

@@ -2,6 +2,8 @@ import { addDays, format as dateFormat } from 'date-fns';
 import { config } from "../../../../../config/index.js";
 import { getAnswer } from "../../components/helpers/components.js";
 import { escapeMarkdown } from "../../components/helpers/index.js";
+import { PaymentField } from "../../components/index.js";
+import { formatPaymentAmount, formatPaymentDate } from "../../../payment/helper.js";
 const designerUrl = config.get('designerUrl');
 export function format(_context, items, model, submitResponse, formStatus, _formMetadata) {
   const {
@@ -24,7 +26,9 @@ export function format(_context, items, model, submitResponse, formStatus, _form
   }
   lines.push(`${formName} form received at ${escapeMarkdown(formattedNow)}.\n`);
   lines.push('---\n');
-  items.forEach(item => {
+  const regularItems = items.filter(item => !isPaymentItem(item));
+  const paymentItems = items.filter(item => isPaymentItem(item));
+  regularItems.forEach(item => {
     const label = escapeMarkdown(item.label);
     lines.push(`## ${label}\n`);
     if ('subItems' in item) {
@@ -40,6 +44,35 @@ export function format(_context, items, model, submitResponse, formStatus, _form
   });
   const filename = escapeMarkdown('Download main form (CSV)');
   lines.push(`[${filename}](${designerUrl}/file-download/${files.main})\n`);
+  appendPaymentSection(paymentItems, lines);
   return lines.join('\n');
 }
+
+/**
+ * Check if an item is a PaymentField
+ */
+function isPaymentItem(item) {
+  if ('subItems' in item) {
+    return false;
+  }
+  return item.field instanceof PaymentField;
+}
+
+/**
+ * Appends the payment details section to the email lines if payment exists
+ */
+function appendPaymentSection(paymentItems, lines) {
+  if (paymentItems.length === 0) {
+    return;
+  }
+  const paymentItem = paymentItems[0];
+  const paymentField = paymentItem.field;
+  const paymentState = paymentField.getPaymentStateFromState(paymentItem.state);
+  if (!paymentState) {
+    return;
+  }
+  const formattedAmount = formatPaymentAmount(paymentState.amount);
+  const dateOfPayment = paymentState.preAuth?.createdAt ? formatPaymentDate(paymentState.preAuth.createdAt) : '';
+  lines.push('---\n', `# Your payment of ${formattedAmount} was successful\n`, '## Payment for\n', `${escapeMarkdown(paymentState.description)}\n`, '---\n', '## Total amount\n', `${formattedAmount}\n`, '---\n', '## Date of payment\n', `${escapeMarkdown(dateOfPayment)}\n`, '---\n');
+}
 //# sourceMappingURL=v1.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"v1.js","names":["addDays","format","dateFormat","config","getAnswer","escapeMarkdown","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 { getAnswer } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport { escapeMarkdown } from '~/src/server/plugins/engine/components/helpers/index.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,SAASC,SAAS;AAClB,SAASC,cAAc;AAMvB,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,GAAGX,cAAc,CAACK,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,6DAA6DnB,cAAc,CAACiB,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,qBAAqBX,cAAc,CAACe,YAAY,CAAC,KAAK,CAAC;EAC7EG,KAAK,CAACC,IAAI,CAAC,OAAO,CAAC;EAEnBf,KAAK,CAACkB,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,KAAKxB,WAAW,kBAAkByB,MAAM,KAAK,CAAC;IACvE,CAAC,MAAM;MACLR,KAAK,CAACC,IAAI,CACRpB,SAAS,CAACwB,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,GAAGzB,cAAc,CAAC,0BAA0B,CAAC;EAC3DkB,KAAK,CAACC,IAAI,CAAC,IAAIM,QAAQ,KAAKxB,WAAW,kBAAkBQ,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","getAnswer","escapeMarkdown","PaymentField","formatPaymentAmount","formatPaymentDate","designerUrl","get","_context","items","model","submitResponse","formStatus","_formMetadata","files","result","formName","name","now","Date","formattedNow","fileExpiryDate","formattedExpiryDate","lines","push","isPreview","state","regularItems","filter","item","isPaymentItem","paymentItems","forEach","label","filename","fileId","repeaters","field","main","appendPaymentSection","join","length","paymentItem","paymentField","paymentState","getPaymentStateFromState","formattedAmount","amount","dateOfPayment","preAuth","createdAt","description"],"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 { getAnswer } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport { escapeMarkdown } from '~/src/server/plugins/engine/components/helpers/index.js'\nimport { PaymentField } 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} from '~/src/server/plugins/engine/models/types.js'\nimport { type FormContext } from '~/src/server/plugins/engine/types.js'\nimport {\n  formatPaymentAmount,\n  formatPaymentDate\n} from '~/src/server/plugins/payment/helper.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  const regularItems = items.filter((item) => !isPaymentItem(item))\n  const paymentItems = items.filter((item) => isPaymentItem(item))\n\n  regularItems.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  appendPaymentSection(paymentItems, lines)\n\n  return lines.join('\\n')\n}\n\n/**\n * Check if an item is a PaymentField\n */\nfunction isPaymentItem(item: DetailItem): boolean {\n  if ('subItems' in item) {\n    return false\n  }\n  return item.field instanceof PaymentField\n}\n\n/**\n * Appends the payment details section to the email lines if payment exists\n */\nfunction appendPaymentSection(paymentItems: DetailItem[], lines: string[]) {\n  if (paymentItems.length === 0) {\n    return\n  }\n\n  const paymentItem = paymentItems[0] as DetailItemField\n  const paymentField = paymentItem.field as PaymentField\n  const paymentState = paymentField.getPaymentStateFromState(paymentItem.state)\n\n  if (!paymentState) {\n    return\n  }\n\n  const formattedAmount = formatPaymentAmount(paymentState.amount)\n  const dateOfPayment = paymentState.preAuth?.createdAt\n    ? formatPaymentDate(paymentState.preAuth.createdAt)\n    : ''\n\n  lines.push(\n    '---\\n',\n    `# Your payment of ${formattedAmount} was successful\\n`,\n    '## Payment for\\n',\n    `${escapeMarkdown(paymentState.description)}\\n`,\n    '---\\n',\n    '## Total amount\\n',\n    `${formattedAmount}\\n`,\n    '---\\n',\n    '## Date of payment\\n',\n    `${escapeMarkdown(dateOfPayment)}\\n`,\n    '---\\n'\n  )\n}\n"],"mappings":"AAIA,SAASA,OAAO,EAAEC,MAAM,IAAIC,UAAU,QAAQ,UAAU;AAExD,SAASC,MAAM;AACf,SAASC,SAAS;AAClB,SAASC,cAAc;AACvB,SAASC,YAAY;AAQrB,SACEC,mBAAmB,EACnBC,iBAAiB;AAGnB,MAAMC,WAAW,GAAGN,MAAM,CAACO,GAAG,CAAC,aAAa,CAAC;AAE7C,OAAO,SAAST,MAAMA,CACpBU,QAAqB,EACrBC,KAAmB,EACnBC,KAAgB,EAChBC,cAAqC,EACrCC,UAA8C,EAC9CC,aAA4B,EAC5B;EACA,MAAM;IAAEC;EAAM,CAAC,GAAGH,cAAc,CAACI,MAAM;EAEvC,MAAMC,QAAQ,GAAGd,cAAc,CAACQ,KAAK,CAACO,IAAI,CAAC;;EAE3C;AACF;AACA;AACA;EACE,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;EACtB,MAAMC,YAAY,GAAG,GAAGrB,UAAU,CAACmB,GAAG,EAAE,SAAS,CAAC,OAAOnB,UAAU,CAACmB,GAAG,EAAE,aAAa,CAAC,EAAE;EAEzF,MAAMG,cAAc,GAAGxB,OAAO,CAACqB,GAAG,EAAE,EAAE,CAAC;EACvC,MAAMI,mBAAmB,GAAG,GAAGvB,UAAU,CAACsB,cAAc,EAAE,SAAS,CAAC,OAAOtB,UAAU,CAACsB,cAAc,EAAE,kBAAkB,CAAC,EAAE;EAE3H,MAAME,KAAe,GAAG,EAAE;EAE1BA,KAAK,CAACC,IAAI,CACR,6DAA6DtB,cAAc,CAACoB,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,qBAAqBd,cAAc,CAACkB,YAAY,CAAC,KAAK,CAAC;EAC7EG,KAAK,CAACC,IAAI,CAAC,OAAO,CAAC;EAEnB,MAAMG,YAAY,GAAGlB,KAAK,CAACmB,MAAM,CAAEC,IAAI,IAAK,CAACC,aAAa,CAACD,IAAI,CAAC,CAAC;EACjE,MAAME,YAAY,GAAGtB,KAAK,CAACmB,MAAM,CAAEC,IAAI,IAAKC,aAAa,CAACD,IAAI,CAAC,CAAC;EAEhEF,YAAY,CAACK,OAAO,CAAEH,IAAI,IAAK;IAC7B,MAAMI,KAAK,GAAG/B,cAAc,CAAC2B,IAAI,CAACI,KAAK,CAAC;IAExCV,KAAK,CAACC,IAAI,CAAC,MAAMS,KAAK,IAAI,CAAC;IAE3B,IAAI,UAAU,IAAIJ,IAAI,EAAE;MACtB,MAAMK,QAAQ,GAAGhC,cAAc,CAAC,YAAY+B,KAAK,QAAQ,CAAC;MAC1D,MAAME,MAAM,GAAGrB,KAAK,CAACsB,SAAS,CAACP,IAAI,CAACZ,IAAI,CAAC;MAEzCM,KAAK,CAACC,IAAI,CAAC,IAAIU,QAAQ,KAAK5B,WAAW,kBAAkB6B,MAAM,KAAK,CAAC;IACvE,CAAC,MAAM;MACLZ,KAAK,CAACC,IAAI,CACRvB,SAAS,CAAC4B,IAAI,CAACQ,KAAK,EAAER,IAAI,CAACH,KAAK,EAAE;QAChC5B,MAAM,EAAE;MACV,CAAC,CACH,CAAC;IACH;IAEAyB,KAAK,CAACC,IAAI,CAAC,OAAO,CAAC;EACrB,CAAC,CAAC;EAEF,MAAMU,QAAQ,GAAGhC,cAAc,CAAC,0BAA0B,CAAC;EAC3DqB,KAAK,CAACC,IAAI,CAAC,IAAIU,QAAQ,KAAK5B,WAAW,kBAAkBQ,KAAK,CAACwB,IAAI,KAAK,CAAC;EAEzEC,oBAAoB,CAACR,YAAY,EAAER,KAAK,CAAC;EAEzC,OAAOA,KAAK,CAACiB,IAAI,CAAC,IAAI,CAAC;AACzB;;AAEA;AACA;AACA;AACA,SAASV,aAAaA,CAACD,IAAgB,EAAW;EAChD,IAAI,UAAU,IAAIA,IAAI,EAAE;IACtB,OAAO,KAAK;EACd;EACA,OAAOA,IAAI,CAACQ,KAAK,YAAYlC,YAAY;AAC3C;;AAEA;AACA;AACA;AACA,SAASoC,oBAAoBA,CAACR,YAA0B,EAAER,KAAe,EAAE;EACzE,IAAIQ,YAAY,CAACU,MAAM,KAAK,CAAC,EAAE;IAC7B;EACF;EAEA,MAAMC,WAAW,GAAGX,YAAY,CAAC,CAAC,CAAoB;EACtD,MAAMY,YAAY,GAAGD,WAAW,CAACL,KAAqB;EACtD,MAAMO,YAAY,GAAGD,YAAY,CAACE,wBAAwB,CAACH,WAAW,CAAChB,KAAK,CAAC;EAE7E,IAAI,CAACkB,YAAY,EAAE;IACjB;EACF;EAEA,MAAME,eAAe,GAAG1C,mBAAmB,CAACwC,YAAY,CAACG,MAAM,CAAC;EAChE,MAAMC,aAAa,GAAGJ,YAAY,CAACK,OAAO,EAAEC,SAAS,GACjD7C,iBAAiB,CAACuC,YAAY,CAACK,OAAO,CAACC,SAAS,CAAC,GACjD,EAAE;EAEN3B,KAAK,CAACC,IAAI,CACR,OAAO,EACP,qBAAqBsB,eAAe,mBAAmB,EACvD,kBAAkB,EAClB,GAAG5C,cAAc,CAAC0C,YAAY,CAACO,WAAW,CAAC,IAAI,EAC/C,OAAO,EACP,mBAAmB,EACnB,GAAGL,eAAe,IAAI,EACtB,OAAO,EACP,sBAAsB,EACtB,GAAG5C,cAAc,CAAC8C,aAAa,CAAC,IAAI,EACpC,OACF,CAAC;AACH","ignoreList":[]}

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

@@ -3,6 +3,17 @@ import { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js';
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
 import { type DetailItem } from '~/src/server/plugins/engine/models/types.js';
 import { type FormContext, type RichFormValue } from '~/src/server/plugins/engine/types.js';
+/**
+ * Payment data for the machine output format
+ * Defined locally to avoid circular dependency with types.ts
+ */
+interface PaymentOutput {
+    paymentId: string;
+    reference: string;
+    amount: number;
+    description: string;
+    createdAt: string;
+}
 export declare function format(context: FormContext, items: DetailItem[], model: FormModel, _submitResponse: SubmitResponsePayload, _formStatus: ReturnType<typeof checkFormStatus>): string;
 /**
  * Categories the form submission data into the "main" body and "repeaters".
@@ -29,6 +40,15 @@ export declare function format(context: FormContext, items: DetailItem[], model:
  *          userDownloadLink: 'https://forms-designer/file-download/123-456-789'
  *        }
  *      ]
+ *    },
+ *    payments: {
+ *      paymentComponentName: {
+ *        paymentId: 'abc123',
+ *        reference: 'REF-123',
+ *        amount: 10.00,
+ *        description: 'Application fee',
+ *        createdAt: '2025-01-23T10:30:00.000Z'
+ *      }
  *    }
  * }
  */
@@ -40,4 +60,6 @@ export declare function categoriseData(items: DetailItem[]): {
         fileName: string;
         userDownloadLink: string;
     }[]>;
+    payment?: PaymentOutput;
 };
+export {};

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

@@ -1,5 +1,11 @@
 import { config } from "../../../../../config/index.js";
-import { FileUploadField } from "../../components/index.js";
+import { FileUploadField, PaymentField } from "../../components/index.js";
+
+/**
+ * Payment data for the machine output format
+ * Defined locally to avoid circular dependency with types.ts
+ */
+
 const designerUrl = config.get('designerUrl');
 export function format(context, items, model, _submitResponse, _formStatus) {
   const now = new Date();
@@ -43,6 +49,15 @@ export function format(context, items, model, _submitResponse, _formStatus) {
  *          userDownloadLink: 'https://forms-designer/file-download/123-456-789'
  *        }
  *      ]
+ *    },
+ *    payments: {
+ *      paymentComponentName: {
+ *        paymentId: 'abc123',
+ *        reference: 'REF-123',
+ *        amount: 10.00,
+ *        description: 'Application fee',
+ *        createdAt: '2025-01-23T10:30:00.000Z'
+ *      }
  *    }
  * }
  */
@@ -61,6 +76,11 @@ export function categoriseData(items) {
       output.repeaters[name] = extractRepeaters(item);
     } else if (isFileUploadFieldItem(item)) {
       output.files[name] = extractFileUploads(item);
+    } else if (isPaymentFieldItem(item)) {
+      const payment = extractPayment(item);
+      if (payment) {
+        output.payment = payment;
+      }
     } else {
       output.main[name] = item.field.getFormValueFromState(state);
     }
@@ -110,4 +130,26 @@ function extractFileUploads(item) {
 function isFileUploadFieldItem(item) {
   return item.field instanceof FileUploadField;
 }
+function isPaymentFieldItem(item) {
+  return item.field instanceof PaymentField;
+}
+
+/**
+ * Returns the "payments" section of the response body
+ * @param item - the payment item in the form
+ * @returns the payment data
+ */
+function extractPayment(item) {
+  const paymentState = item.field.getPaymentStateFromState(item.state);
+  if (!paymentState) {
+    return undefined;
+  }
+  return {
+    paymentId: paymentState.paymentId,
+    reference: paymentState.reference,
+    amount: paymentState.amount,
+    description: paymentState.description,
+    createdAt: paymentState.preAuth?.createdAt ?? ''
+  };
+}
 //# sourceMappingURL=v2.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"v2.js","names":["config","FileUploadField","designerUrl","get","format","context","items","model","_submitResponse","_formStatus","now","Date","categorisedData","categoriseData","meta","schemaVersion","timestamp","toISOString","definition","def","referenceNumber","data","body","JSON","stringify","output","main","repeaters","files","forEach","item","name","state","extractRepeaters","isFileUploadFieldItem","extractFileUploads","field","getFormValueFromState","subItems","inputRepeaterItem","outputRepeaterItem","repeaterComponent","push","fileUploadState","map","fileState","file","status","form","fileId","fileName","filename","userDownloadLink"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/machine/v2.ts"],"sourcesContent":["import { type SubmitResponsePayload } from '@defra/forms-model'\n\nimport { config } from '~/src/config/index.js'\nimport { FileUploadField } from '~/src/server/plugins/engine/components/index.js'\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type DetailItem,\n  type DetailItemField,\n  type DetailItemRepeat\n} from '~/src/server/plugins/engine/models/types.js'\nimport {\n  type FileUploadFieldDetailitem,\n  type FormAdapterFile,\n  type FormContext,\n  type RichFormValue\n} from '~/src/server/plugins/engine/types.js'\n\nconst designerUrl = config.get('designerUrl')\n\nexport function format(\n  context: FormContext,\n  items: DetailItem[],\n  model: FormModel,\n  _submitResponse: SubmitResponsePayload,\n  _formStatus: ReturnType<typeof checkFormStatus>\n) {\n  const now = new Date()\n\n  const categorisedData = categoriseData(items)\n\n  const meta: Record<string, unknown> = {\n    schemaVersion: '2',\n    timestamp: now.toISOString(),\n    definition: model.def,\n    referenceNumber: context.referenceNumber\n  }\n\n  const data = {\n    meta,\n    data: categorisedData\n  }\n\n  const body = JSON.stringify(data)\n\n  return body\n}\n\n/**\n * Categories the form submission data into the \"main\" body and \"repeaters\".\n *\n * {\n *    main: {\n *       componentName: 'componentValue',\n *    },\n *    repeaters: {\n *      repeaterName: [\n *        {\n *          textComponentName: 'componentValue'\n *        },\n *        {\n *          richComponentName: { foo: 'bar', 'baz': true }\n *        }\n *      ]\n *    },\n *    files: {\n *      fileComponentName: [\n *        {\n *          fileId: '123-456-789',\n *          fileName: 'example.pdf',\n *          userDownloadLink: 'https://forms-designer/file-download/123-456-789'\n *        }\n *      ]\n *    }\n * }\n */\nexport function categoriseData(items: DetailItem[]) {\n  const output: {\n    main: Record<string, RichFormValue>\n    repeaters: Record<string, Record<string, RichFormValue>[]>\n    files: Record<\n      string,\n      { fileId: string; fileName: string; userDownloadLink: string }[]\n    >\n  } = { main: {}, repeaters: {}, files: {} }\n\n  items.forEach((item) => {\n    const { name, state } = item\n\n    if ('subItems' in item) {\n      output.repeaters[name] = extractRepeaters(item)\n    } else if (isFileUploadFieldItem(item)) {\n      output.files[name] = extractFileUploads(item)\n    } else {\n      output.main[name] = item.field.getFormValueFromState(state)\n    }\n  })\n\n  return output\n}\n\n/**\n * Returns the \"repeaters\" section of the response body\n * @param item - the repeater item\n * @returns the repeater item\n */\nfunction extractRepeaters(item: DetailItemRepeat) {\n  const repeaters: Record<string, RichFormValue>[] = []\n\n  item.subItems.forEach((inputRepeaterItem) => {\n    const outputRepeaterItem: Record<string, RichFormValue> = {}\n\n    inputRepeaterItem.forEach((repeaterComponent) => {\n      const { field, state } = repeaterComponent\n\n      outputRepeaterItem[repeaterComponent.name] =\n        field.getFormValueFromState(state)\n    })\n\n    repeaters.push(outputRepeaterItem)\n  })\n\n  return repeaters\n}\n\n/**\n * Returns the \"files\" section of the response body\n * @param item - the file upload item in the form\n * @returns the file upload data\n */\nfunction extractFileUploads(\n  item: FileUploadFieldDetailitem\n): FormAdapterFile[] {\n  const fileUploadState = item.field.getFormValueFromState(item.state) ?? []\n\n  return fileUploadState.map((fileState) => {\n    const { file } = fileState.status.form\n    return {\n      fileId: file.fileId,\n      fileName: file.filename,\n      userDownloadLink: `${designerUrl}/file-download/${file.fileId}`\n    }\n  })\n}\n\nfunction isFileUploadFieldItem(\n  item: DetailItemField\n): item is FileUploadFieldDetailitem {\n  return item.field instanceof FileUploadField\n}\n"],"mappings":"AAEA,SAASA,MAAM;AACf,SAASC,eAAe;AAexB,MAAMC,WAAW,GAAGF,MAAM,CAACG,GAAG,CAAC,aAAa,CAAC;AAE7C,OAAO,SAASC,MAAMA,CACpBC,OAAoB,EACpBC,KAAmB,EACnBC,KAAgB,EAChBC,eAAsC,EACtCC,WAA+C,EAC/C;EACA,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;EAEtB,MAAMC,eAAe,GAAGC,cAAc,CAACP,KAAK,CAAC;EAE7C,MAAMQ,IAA6B,GAAG;IACpCC,aAAa,EAAE,GAAG;IAClBC,SAAS,EAAEN,GAAG,CAACO,WAAW,CAAC,CAAC;IAC5BC,UAAU,EAAEX,KAAK,CAACY,GAAG;IACrBC,eAAe,EAAEf,OAAO,CAACe;EAC3B,CAAC;EAED,MAAMC,IAAI,GAAG;IACXP,IAAI;IACJO,IAAI,EAAET;EACR,CAAC;EAED,MAAMU,IAAI,GAAGC,IAAI,CAACC,SAAS,CAACH,IAAI,CAAC;EAEjC,OAAOC,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAAST,cAAcA,CAACP,KAAmB,EAAE;EAClD,MAAMmB,MAOL,GAAG;IAAEC,IAAI,EAAE,CAAC,CAAC;IAAEC,SAAS,EAAE,CAAC,CAAC;IAAEC,KAAK,EAAE,CAAC;EAAE,CAAC;EAE1CtB,KAAK,CAACuB,OAAO,CAAEC,IAAI,IAAK;IACtB,MAAM;MAAEC,IAAI;MAAEC;IAAM,CAAC,GAAGF,IAAI;IAE5B,IAAI,UAAU,IAAIA,IAAI,EAAE;MACtBL,MAAM,CAACE,SAAS,CAACI,IAAI,CAAC,GAAGE,gBAAgB,CAACH,IAAI,CAAC;IACjD,CAAC,MAAM,IAAII,qBAAqB,CAACJ,IAAI,CAAC,EAAE;MACtCL,MAAM,CAACG,KAAK,CAACG,IAAI,CAAC,GAAGI,kBAAkB,CAACL,IAAI,CAAC;IAC/C,CAAC,MAAM;MACLL,MAAM,CAACC,IAAI,CAACK,IAAI,CAAC,GAAGD,IAAI,CAACM,KAAK,CAACC,qBAAqB,CAACL,KAAK,CAAC;IAC7D;EACF,CAAC,CAAC;EAEF,OAAOP,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASQ,gBAAgBA,CAACH,IAAsB,EAAE;EAChD,MAAMH,SAA0C,GAAG,EAAE;EAErDG,IAAI,CAACQ,QAAQ,CAACT,OAAO,CAAEU,iBAAiB,IAAK;IAC3C,MAAMC,kBAAiD,GAAG,CAAC,CAAC;IAE5DD,iBAAiB,CAACV,OAAO,CAAEY,iBAAiB,IAAK;MAC/C,MAAM;QAAEL,KAAK;QAAEJ;MAAM,CAAC,GAAGS,iBAAiB;MAE1CD,kBAAkB,CAACC,iBAAiB,CAACV,IAAI,CAAC,GACxCK,KAAK,CAACC,qBAAqB,CAACL,KAAK,CAAC;IACtC,CAAC,CAAC;IAEFL,SAAS,CAACe,IAAI,CAACF,kBAAkB,CAAC;EACpC,CAAC,CAAC;EAEF,OAAOb,SAAS;AAClB;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASQ,kBAAkBA,CACzBL,IAA+B,EACZ;EACnB,MAAMa,eAAe,GAAGb,IAAI,CAACM,KAAK,CAACC,qBAAqB,CAACP,IAAI,CAACE,KAAK,CAAC,IAAI,EAAE;EAE1E,OAAOW,eAAe,CAACC,GAAG,CAAEC,SAAS,IAAK;IACxC,MAAM;MAAEC;IAAK,CAAC,GAAGD,SAAS,CAACE,MAAM,CAACC,IAAI;IACtC,OAAO;MACLC,MAAM,EAAEH,IAAI,CAACG,MAAM;MACnBC,QAAQ,EAAEJ,IAAI,CAACK,QAAQ;MACvBC,gBAAgB,EAAE,GAAGlD,WAAW,kBAAkB4C,IAAI,CAACG,MAAM;IAC/D,CAAC;EACH,CAAC,CAAC;AACJ;AAEA,SAASf,qBAAqBA,CAC5BJ,IAAqB,EACc;EACnC,OAAOA,IAAI,CAACM,KAAK,YAAYnC,eAAe;AAC9C","ignoreList":[]}
+{"version":3,"file":"v2.js","names":["config","FileUploadField","PaymentField","designerUrl","get","format","context","items","model","_submitResponse","_formStatus","now","Date","categorisedData","categoriseData","meta","schemaVersion","timestamp","toISOString","definition","def","referenceNumber","data","body","JSON","stringify","output","main","repeaters","files","forEach","item","name","state","extractRepeaters","isFileUploadFieldItem","extractFileUploads","isPaymentFieldItem","payment","extractPayment","field","getFormValueFromState","subItems","inputRepeaterItem","outputRepeaterItem","repeaterComponent","push","fileUploadState","map","fileState","file","status","form","fileId","fileName","filename","userDownloadLink","paymentState","getPaymentStateFromState","undefined","paymentId","reference","amount","description","createdAt","preAuth"],"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 {\n  FileUploadField,\n  PaymentField\n} from '~/src/server/plugins/engine/components/index.js'\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type DetailItem,\n  type DetailItemField,\n  type DetailItemRepeat\n} from '~/src/server/plugins/engine/models/types.js'\nimport {\n  type FileUploadFieldDetailitem,\n  type FormAdapterFile,\n  type FormContext,\n  type RichFormValue\n} from '~/src/server/plugins/engine/types.js'\n\n/**\n * Payment data for the machine output format\n * Defined locally to avoid circular dependency with types.ts\n */\ninterface PaymentOutput {\n  paymentId: string\n  reference: string\n  amount: number\n  description: string\n  createdAt: string\n}\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 meta: Record<string, unknown> = {\n    schemaVersion: '2',\n    timestamp: now.toISOString(),\n    definition: model.def,\n    referenceNumber: context.referenceNumber\n  }\n\n  const data = {\n    meta,\n    data: categorisedData\n  }\n\n  const body = JSON.stringify(data)\n\n  return body\n}\n\n/**\n * Categories the form submission data into the \"main\" body and \"repeaters\".\n *\n * {\n *    main: {\n *       componentName: 'componentValue',\n *    },\n *    repeaters: {\n *      repeaterName: [\n *        {\n *          textComponentName: 'componentValue'\n *        },\n *        {\n *          richComponentName: { foo: 'bar', 'baz': true }\n *        }\n *      ]\n *    },\n *    files: {\n *      fileComponentName: [\n *        {\n *          fileId: '123-456-789',\n *          fileName: 'example.pdf',\n *          userDownloadLink: 'https://forms-designer/file-download/123-456-789'\n *        }\n *      ]\n *    },\n *    payments: {\n *      paymentComponentName: {\n *        paymentId: 'abc123',\n *        reference: 'REF-123',\n *        amount: 10.00,\n *        description: 'Application fee',\n *        createdAt: '2025-01-23T10:30:00.000Z'\n *      }\n *    }\n * }\n */\nexport function categoriseData(items: DetailItem[]) {\n  const output: {\n    main: Record<string, RichFormValue>\n    repeaters: Record<string, Record<string, RichFormValue>[]>\n    files: Record<\n      string,\n      { fileId: string; fileName: string; userDownloadLink: string }[]\n    >\n    payment?: PaymentOutput\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 if (isPaymentFieldItem(item)) {\n      const payment = extractPayment(item)\n      if (payment) {\n        output.payment = payment\n      }\n    } else {\n      output.main[name] = item.field.getFormValueFromState(state)\n    }\n  })\n\n  return output\n}\n\n/**\n * Returns the \"repeaters\" section of the response body\n * @param item - the repeater item\n * @returns the repeater item\n */\nfunction extractRepeaters(item: DetailItemRepeat) {\n  const repeaters: Record<string, RichFormValue>[] = []\n\n  item.subItems.forEach((inputRepeaterItem) => {\n    const outputRepeaterItem: Record<string, RichFormValue> = {}\n\n    inputRepeaterItem.forEach((repeaterComponent) => {\n      const { field, state } = repeaterComponent\n\n      outputRepeaterItem[repeaterComponent.name] =\n        field.getFormValueFromState(state)\n    })\n\n    repeaters.push(outputRepeaterItem)\n  })\n\n  return repeaters\n}\n\n/**\n * Returns the \"files\" section of the response body\n * @param item - the file upload item in the form\n * @returns the file upload data\n */\nfunction extractFileUploads(\n  item: FileUploadFieldDetailitem\n): FormAdapterFile[] {\n  const fileUploadState = item.field.getFormValueFromState(item.state) ?? []\n\n  return fileUploadState.map((fileState) => {\n    const { file } = fileState.status.form\n    return {\n      fileId: file.fileId,\n      fileName: file.filename,\n      userDownloadLink: `${designerUrl}/file-download/${file.fileId}`\n    }\n  })\n}\n\nfunction isFileUploadFieldItem(\n  item: DetailItemField\n): item is FileUploadFieldDetailitem {\n  return item.field instanceof FileUploadField\n}\n\nfunction isPaymentFieldItem(item: DetailItemField): item is DetailItemField & {\n  field: PaymentField\n} {\n  return item.field instanceof PaymentField\n}\n\n/**\n * Returns the \"payments\" section of the response body\n * @param item - the payment item in the form\n * @returns the payment data\n */\nfunction extractPayment(\n  item: DetailItemField & { field: PaymentField }\n): PaymentOutput | undefined {\n  const paymentState = item.field.getPaymentStateFromState(item.state)\n\n  if (!paymentState) {\n    return undefined\n  }\n\n  return {\n    paymentId: paymentState.paymentId,\n    reference: paymentState.reference,\n    amount: paymentState.amount,\n    description: paymentState.description,\n    createdAt: paymentState.preAuth?.createdAt ?? ''\n  }\n}\n"],"mappings":"AAEA,SAASA,MAAM;AACf,SACEC,eAAe,EACfC,YAAY;;AAgBd;AACA;AACA;AACA;;AASA,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,IAA6B,GAAG;IACpCC,aAAa,EAAE,GAAG;IAClBC,SAAS,EAAEN,GAAG,CAACO,WAAW,CAAC,CAAC;IAC5BC,UAAU,EAAEX,KAAK,CAACY,GAAG;IACrBC,eAAe,EAAEf,OAAO,CAACe;EAC3B,CAAC;EAED,MAAMC,IAAI,GAAG;IACXP,IAAI;IACJO,IAAI,EAAET;EACR,CAAC;EAED,MAAMU,IAAI,GAAGC,IAAI,CAACC,SAAS,CAACH,IAAI,CAAC;EAEjC,OAAOC,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAAST,cAAcA,CAACP,KAAmB,EAAE;EAClD,MAAMmB,MAQL,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,IAAIM,kBAAkB,CAACN,IAAI,CAAC,EAAE;MACnC,MAAMO,OAAO,GAAGC,cAAc,CAACR,IAAI,CAAC;MACpC,IAAIO,OAAO,EAAE;QACXZ,MAAM,CAACY,OAAO,GAAGA,OAAO;MAC1B;IACF,CAAC,MAAM;MACLZ,MAAM,CAACC,IAAI,CAACK,IAAI,CAAC,GAAGD,IAAI,CAACS,KAAK,CAACC,qBAAqB,CAACR,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,CAACW,QAAQ,CAACZ,OAAO,CAAEa,iBAAiB,IAAK;IAC3C,MAAMC,kBAAiD,GAAG,CAAC,CAAC;IAE5DD,iBAAiB,CAACb,OAAO,CAAEe,iBAAiB,IAAK;MAC/C,MAAM;QAAEL,KAAK;QAAEP;MAAM,CAAC,GAAGY,iBAAiB;MAE1CD,kBAAkB,CAACC,iBAAiB,CAACb,IAAI,CAAC,GACxCQ,KAAK,CAACC,qBAAqB,CAACR,KAAK,CAAC;IACtC,CAAC,CAAC;IAEFL,SAAS,CAACkB,IAAI,CAACF,kBAAkB,CAAC;EACpC,CAAC,CAAC;EAEF,OAAOhB,SAAS;AAClB;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASQ,kBAAkBA,CACzBL,IAA+B,EACZ;EACnB,MAAMgB,eAAe,GAAGhB,IAAI,CAACS,KAAK,CAACC,qBAAqB,CAACV,IAAI,CAACE,KAAK,CAAC,IAAI,EAAE;EAE1E,OAAOc,eAAe,CAACC,GAAG,CAAEC,SAAS,IAAK;IACxC,MAAM;MAAEC;IAAK,CAAC,GAAGD,SAAS,CAACE,MAAM,CAACC,IAAI;IACtC,OAAO;MACLC,MAAM,EAAEH,IAAI,CAACG,MAAM;MACnBC,QAAQ,EAAEJ,IAAI,CAACK,QAAQ;MACvBC,gBAAgB,EAAE,GAAGrD,WAAW,kBAAkB+C,IAAI,CAACG,MAAM;IAC/D,CAAC;EACH,CAAC,CAAC;AACJ;AAEA,SAASlB,qBAAqBA,CAC5BJ,IAAqB,EACc;EACnC,OAAOA,IAAI,CAACS,KAAK,YAAYvC,eAAe;AAC9C;AAEA,SAASoC,kBAAkBA,CAACN,IAAqB,EAE/C;EACA,OAAOA,IAAI,CAACS,KAAK,YAAYtC,YAAY;AAC3C;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASqC,cAAcA,CACrBR,IAA+C,EACpB;EAC3B,MAAM0B,YAAY,GAAG1B,IAAI,CAACS,KAAK,CAACkB,wBAAwB,CAAC3B,IAAI,CAACE,KAAK,CAAC;EAEpE,IAAI,CAACwB,YAAY,EAAE;IACjB,OAAOE,SAAS;EAClB;EAEA,OAAO;IACLC,SAAS,EAAEH,YAAY,CAACG,SAAS;IACjCC,SAAS,EAAEJ,YAAY,CAACI,SAAS;IACjCC,MAAM,EAAEL,YAAY,CAACK,MAAM;IAC3BC,WAAW,EAAEN,YAAY,CAACM,WAAW;IACrCC,SAAS,EAAEP,YAAY,CAACQ,OAAO,EAAED,SAAS,IAAI;EAChD,CAAC;AACH","ignoreList":[]}

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

@@ -1,13 +1,13 @@
 import { ComponentType, ControllerType, Engine, hasComponents, hasNext, hasRepeater } from '@defra/forms-model';
 import Boom from '@hapi/boom';
-import { COMPONENT_STATE_ERROR, EXTERNAL_STATE_APPENDAGE, EXTERNAL_STATE_PAYLOAD } from "../../../constants.js";
+import { COMPONENT_STATE_ERROR, EXTERNAL_STATE_APPENDAGE, EXTERNAL_STATE_PAYLOAD, PAYMENT_EXPIRED_NOTIFICATION } from "../../../constants.js";
 import { ComponentCollection } from "../components/ComponentCollection.js";
 import { optionalText } from "../components/constants.js";
-import { getCacheService, getErrors, getSaveAndExitHelpers, normalisePath, proceed } from "../helpers.js";
+import { checkFormStatus, getCacheService, getErrors, getSaveAndExitHelpers, normalisePath, proceed } from "../helpers.js";
 import { PageController } from "./PageController.js";
 import { clearNotYetValidatedState, prefillStateFromQueryParameters } from "./helpers/state.js";
 import { getComponentsByType } from "../validationHelpers.js";
-import { FormAction } from "../../../routes/types.js";
+import { FormAction, FormStatus } from "../../../routes/types.js";
 import { actionSchema, crumbSchema, paramsSchema } from "../../../schemas/index.js";
 import { merge } from "../../../services/cacheService.js";
 export class QuestionPageController extends PageController {
@@ -132,6 +132,15 @@ export class QuestionPageController extends PageController {
         }
       }
     }
+    const hasIncompletePayment = components.some(({
+      model
+    }) => {
+      if ('paymentState' in model) {
+        const paymentState = model.paymentState;
+        return !paymentState?.preAuth?.status;
+      }
+      return false;
+    });
     return {
       ...viewModel,
       backLink: this.getBackLink(request, context),
@@ -139,7 +148,8 @@ export class QuestionPageController extends PageController {
       showTitle,
       components,
       errors,
-      allowSaveAndExit: this.shouldShowSaveAndExit(request.server)
+      allowSaveAndExit: this.shouldShowSaveAndExit(request.server),
+      showSubmitButton: !hasIncompletePayment
     };
   }
   getRelevantPath(request, context) {
@@ -336,6 +346,8 @@ export class QuestionPageController extends PageController {
       const flashedError = request.yar.flash(COMPONENT_STATE_ERROR);
       const flashedErrors = !Array.isArray(flashedError) ? [flashedError] : [];
       viewModel.errors = (viewModel.errors ?? []).concat(flashedErrors);
+      const paymentExpiredFlash = request.yar.flash(PAYMENT_EXPIRED_NOTIFICATION);
+      viewModel.showPaymentExpiredNotification = !Array.isArray(paymentExpiredFlash);
 
       /**
        * Content components can be hidden based on a condition. If the condition evaluates to true, it is safe to be kept, otherwise discard it
@@ -432,7 +444,7 @@ export class QuestionPageController extends PageController {
       } = context;
       const action = request.payload.action;
       if (action?.startsWith(FormAction.External)) {
-        return this.dispatchExternal(request, h, context);
+        return await this.dispatchExternal(request, h, context);
       }
 
       /**
@@ -460,7 +472,7 @@ export class QuestionPageController extends PageController {
       return this.proceed(request, h, this.getNextPath(context));
     };
   }
-  dispatchExternal(request, h, context) {
+  async dispatchExternal(request, h, context) {
     const {
       externalComponents
     } = getComponentsByType();
@@ -493,11 +505,20 @@ export class QuestionPageController extends PageController {
 
     // Clear any previous state appendage
     request.yar.clear(EXTERNAL_STATE_APPENDAGE);
-    return selectedComponent.dispatcher(request, h, {
+
+    // Determine if this is a live form (not preview/draft)
+    const {
+      state,
+      isPreview
+    } = checkFormStatus(request.params);
+    const isLive = state === FormStatus.Live;
+    return await selectedComponent.dispatcher(request, h, {
       component,
       controller: this,
       sourceUrl: request.url.toString(),
-      actionArgs: args
+      actionArgs: args,
+      isLive,
+      isPreview
     });
   }
   proceed(request, h, nextPath) {