@defra/forms-engine-plugin 2.1.10 → 3.0.1

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

@@ -1 +1 @@
-{"version":3,"file":"SummaryViewModel.js","names":["getAnswer","evaluateTemplate","getError","getPageHref","RepeatPageController","validationOptions","opts","SummaryViewModel","page","pageTitle","declaration","details","checkAnswers","context","name","backLink","feedbackLink","phaseTag","errors","serviceUrl","hasMissingNotificationEmail","components","allowSaveAndReturn","constructor","request","model","basePath","def","sections","isForceAccess","title","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","getFirstError"],"sources":["../../../../../src/server/plugins/engine/models/SummaryViewModel.ts"],"sourcesContent":["import { 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  allowSaveAndReturn = 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    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 supplied'\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    ;[undefined, ...sections].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 */\nfunction 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: 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":"AAEA,SACEA,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,kBAAkB,GAAG,KAAK;EAE1BC,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,IAAI,CAACX,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,MAAMkB,MAAM,GAAGN,KAAK,CACjBO,kBAAkB,CAAC,IAAI,CAACnB,OAAO,CAACoB,aAAa,CAAC,CAC9CC,QAAQ,CAAC,IAAI,CAACrB,OAAO,CAACsB,aAAa,EAAE;MAAE,GAAG7B,IAAI;MAAE8B,YAAY,EAAE;IAAK,CAAC,CAAC;;IAExE;IACA,IAAI,CAAClB,MAAM,GAAGa,MAAM,CAACM,KAAK,EAAE1B,OAAO,CAAC2B,GAAG,CAACpC,QAAQ,CAAC;IACjD,IAAI,CAACS,OAAO,GAAG,IAAI,CAAC4B,cAAc,CAACf,OAAO,EAAEI,QAAQ,CAAC;;IAErD;IACA,IAAI,CAAChB,YAAY,GAAG,IAAI,CAACD,OAAO,CAAC2B,GAAG,CAAEE,MAAM,IAAmB;MAC7D,MAAM;QAAEV;MAAM,CAAC,GAAGU,MAAM;MAExB,MAAMC,IAAI,GAAGD,MAAM,CAACE,KAAK,CAACJ,GAAG,CAAEK,IAAI,IAAqB;QACtD,MAAMD,KAA0B,GAAG,EAAE;;QAErC;QACA,IAAI,CAACb,aAAa,EAAE;UAClBa,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,EAAE7C,gBAAgB,CAAC0C,IAAI,CAACb,KAAK,EAAEjB,OAAO;UAC5C,CAAC;UACDsC,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;QACLZ,KAAK,EAAEA,KAAK,GAAG;UAAEgB,IAAI,EAAEhB;QAAM,CAAC,GAAGwB,SAAS;QAC1CC,WAAW,EAAE;UAAEd;QAAK;MACtB,CAAC;IACH,CAAC,CAAC;EACJ;EAEQF,cAAcA,CAACf,OAA2B,EAAEI,QAAmB,EAAE;IACvE,MAAM;MAAEf,OAAO;MAAEK;IAAO,CAAC,GAAG,IAAI;IAChC,MAAM;MAAEe,aAAa;MAAEuB;IAAM,CAAC,GAAG3C,OAAO;IAExC,MAAMF,OAAiB,GAAG,EAAE;IAE3B,CAAC2C,SAAS,EAAE,GAAG1B,QAAQ,CAAC,CAAC6B,OAAO,CAAEC,OAAO,IAAK;MAC7C,MAAMhB,KAAmB,GAAG,EAAE;MAE9B,MAAMiB,YAAY,GAAG1B,aAAa,CAAC2B,MAAM,CACtCpD,IAAI,IAAKA,IAAI,CAACkD,OAAO,KAAKA,OAC7B,CAAC;MAEDC,YAAY,CAACF,OAAO,CAAEjD,IAAI,IAAK;QAC7B,MAAM;UAAEqD,UAAU;UAAEC;QAAK,CAAC,GAAGtD,IAAI;QAEjC,IAAIA,IAAI,YAAYJ,oBAAoB,EAAE;UACxCsC,KAAK,CAACE,IAAI,CACRmB,UAAU,CAACvD,IAAI,EAAEgD,KAAK,EAAE;YACtBM,IAAI,EAAEtD,IAAI,CAACwD,cAAc,CAACxC,OAAO,CAAC;YAClCN;UACF,CAAC,CACH,CAAC;QACH,CAAC,MAAM;UACL,KAAK,MAAM+C,KAAK,IAAIJ,UAAU,CAACK,MAAM,EAAE;YACrCxB,KAAK,CAACE,IAAI,CAACuB,SAAS,CAAC3D,IAAI,EAAEgD,KAAK,EAAES,KAAK,EAAE;cAAEH,IAAI;cAAE5C;YAAO,CAAC,CAAC,CAAC;UAC7D;QACF;MACF,CAAC,CAAC;MAEF,IAAIwB,KAAK,CAAC0B,MAAM,EAAE;QAChBzD,OAAO,CAACiC,IAAI,CAAC;UACX9B,IAAI,EAAE4C,OAAO,EAAE5C,IAAI;UACnBgB,KAAK,EAAE4B,OAAO,EAAE5B,KAAK;UACrBY;QACF,CAAC,CAAC;MACJ;IACF,CAAC,CAAC;IAEF,OAAO/B,OAAO;EAChB;AACF;;AAEA;AACA;AACA;AACA;AACA,SAASoD,UAAUA,CACjBvD,IAA0B,EAC1BgD,KAAgB,EAChBa,OAGC,EACiB;EAClB,MAAM;IAAER,UAAU;IAAES;EAAO,CAAC,GAAG9D,IAAI;EACnC,MAAM;IAAEM,IAAI;IAAEgB;EAAM,CAAC,GAAGwC,MAAM,CAACD,OAAO;EAEtC,MAAME,MAAM,GAAG/D,IAAI,CAACgE,gBAAgB,CAAChB,KAAK,CAAC;EAC3C,MAAMiB,IAAI,GAAGF,MAAM,CAACH,MAAM,KAAK,CAAC,GAAGtC,KAAK,GAAG,GAAGA,KAAK,GAAG;EAEtD,OAAO;IACLhB,IAAI;IACJmC,KAAK,EAAEnB,KAAK;IACZA,KAAK,EAAEyC,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,EAAE1C,WAAW,CAACK,IAAI,EAAE6D,OAAO,CAACP,IAAI,EAAE;MACpCY,SAAS,EAAEvE,WAAW,CAACK,IAAI,EAAEA,IAAI,CAACwD,cAAc,CAAC,CAAC;IACpD,CAAC,CAAC;IACFR,KAAK;IACLhD,IAAI;IAEJ;IACAmE,QAAQ,EAAEJ,MAAM,CAACjC,GAAG,CAAEsC,WAAW,IAC/Bf,UAAU,CAACK,MAAM,CAAC5B,GAAG,CAAE2B,KAAK,IAC1BE,SAAS,CAAC3D,IAAI,EAAEoE,WAAW,EAAEX,KAAK,EAAEI,OAAO,CAC7C,CACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,SAASF,SAASA,CAChB3D,IAAyB,EACzBgD,KAAgB,EAChBS,KAAY,EACZI,OAGC,EACgB;EACjB,OAAO;IACLvD,IAAI,EAAEmD,KAAK,CAACnD,IAAI;IAChBmC,KAAK,EAAEgB,KAAK,CAACnC,KAAK;IAClBA,KAAK,EAAEmC,KAAK,CAAChB,KAAK;IAClBZ,KAAK,EAAE4B,KAAK,CAACY,aAAa,CAACR,OAAO,CAACnD,MAAM,CAAC;IAC1CiC,KAAK,EAAEnD,SAAS,CAACiE,KAAK,EAAET,KAAK,CAAC;IAC9BX,IAAI,EAAE1C,WAAW,CAACK,IAAI,EAAE6D,OAAO,CAACP,IAAI,EAAE;MACpCY,SAAS,EAAEvE,WAAW,CAACK,IAAI,EAAEA,IAAI,CAACwD,cAAc,CAAC,CAAC;IACpD,CAAC,CAAC;IACFR,KAAK;IACLhD,IAAI;IACJyD;EACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"SummaryViewModel.js","names":["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","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","getFirstError"],"sources":["../../../../../src/server/plugins/engine/models/SummaryViewModel.ts"],"sourcesContent":["import { 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    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 supplied'\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    ;[undefined, ...sections].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 */\nfunction 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: 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":"AAEA,SACEA,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,IAAI,CAACX,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,MAAMkB,MAAM,GAAGN,KAAK,CACjBO,kBAAkB,CAAC,IAAI,CAACnB,OAAO,CAACoB,aAAa,CAAC,CAC9CC,QAAQ,CAAC,IAAI,CAACrB,OAAO,CAACsB,aAAa,EAAE;MAAE,GAAG7B,IAAI;MAAE8B,YAAY,EAAE;IAAK,CAAC,CAAC;;IAExE;IACA,IAAI,CAAClB,MAAM,GAAGa,MAAM,CAACM,KAAK,EAAE1B,OAAO,CAAC2B,GAAG,CAACpC,QAAQ,CAAC;IACjD,IAAI,CAACS,OAAO,GAAG,IAAI,CAAC4B,cAAc,CAACf,OAAO,EAAEI,QAAQ,CAAC;;IAErD;IACA,IAAI,CAAChB,YAAY,GAAG,IAAI,CAACD,OAAO,CAAC2B,GAAG,CAAEE,MAAM,IAAmB;MAC7D,MAAM;QAAEV;MAAM,CAAC,GAAGU,MAAM;MAExB,MAAMC,IAAI,GAAGD,MAAM,CAACE,KAAK,CAACJ,GAAG,CAAEK,IAAI,IAAqB;QACtD,MAAMD,KAA0B,GAAG,EAAE;;QAErC;QACA,IAAI,CAACb,aAAa,EAAE;UAClBa,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,EAAE7C,gBAAgB,CAAC0C,IAAI,CAACb,KAAK,EAAEjB,OAAO;UAC5C,CAAC;UACDsC,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;QACLZ,KAAK,EAAEA,KAAK,GAAG;UAAEgB,IAAI,EAAEhB;QAAM,CAAC,GAAGwB,SAAS;QAC1CC,WAAW,EAAE;UAAEd;QAAK;MACtB,CAAC;IACH,CAAC,CAAC;EACJ;EAEQF,cAAcA,CAACf,OAA2B,EAAEI,QAAmB,EAAE;IACvE,MAAM;MAAEf,OAAO;MAAEK;IAAO,CAAC,GAAG,IAAI;IAChC,MAAM;MAAEe,aAAa;MAAEuB;IAAM,CAAC,GAAG3C,OAAO;IAExC,MAAMF,OAAiB,GAAG,EAAE;IAE3B,CAAC2C,SAAS,EAAE,GAAG1B,QAAQ,CAAC,CAAC6B,OAAO,CAAEC,OAAO,IAAK;MAC7C,MAAMhB,KAAmB,GAAG,EAAE;MAE9B,MAAMiB,YAAY,GAAG1B,aAAa,CAAC2B,MAAM,CACtCpD,IAAI,IAAKA,IAAI,CAACkD,OAAO,KAAKA,OAC7B,CAAC;MAEDC,YAAY,CAACF,OAAO,CAAEjD,IAAI,IAAK;QAC7B,MAAM;UAAEqD,UAAU;UAAEC;QAAK,CAAC,GAAGtD,IAAI;QAEjC,IAAIA,IAAI,YAAYJ,oBAAoB,EAAE;UACxCsC,KAAK,CAACE,IAAI,CACRmB,UAAU,CAACvD,IAAI,EAAEgD,KAAK,EAAE;YACtBM,IAAI,EAAEtD,IAAI,CAACwD,cAAc,CAACxC,OAAO,CAAC;YAClCN;UACF,CAAC,CACH,CAAC;QACH,CAAC,MAAM;UACL,KAAK,MAAM+C,KAAK,IAAIJ,UAAU,CAACK,MAAM,EAAE;YACrCxB,KAAK,CAACE,IAAI,CAACuB,SAAS,CAAC3D,IAAI,EAAEgD,KAAK,EAAES,KAAK,EAAE;cAAEH,IAAI;cAAE5C;YAAO,CAAC,CAAC,CAAC;UAC7D;QACF;MACF,CAAC,CAAC;MAEF,IAAIwB,KAAK,CAAC0B,MAAM,EAAE;QAChBzD,OAAO,CAACiC,IAAI,CAAC;UACX9B,IAAI,EAAE4C,OAAO,EAAE5C,IAAI;UACnBgB,KAAK,EAAE4B,OAAO,EAAE5B,KAAK;UACrBY;QACF,CAAC,CAAC;MACJ;IACF,CAAC,CAAC;IAEF,OAAO/B,OAAO;EAChB;AACF;;AAEA;AACA;AACA;AACA;AACA,SAASoD,UAAUA,CACjBvD,IAA0B,EAC1BgD,KAAgB,EAChBa,OAGC,EACiB;EAClB,MAAM;IAAER,UAAU;IAAES;EAAO,CAAC,GAAG9D,IAAI;EACnC,MAAM;IAAEM,IAAI;IAAEgB;EAAM,CAAC,GAAGwC,MAAM,CAACD,OAAO;EAEtC,MAAME,MAAM,GAAG/D,IAAI,CAACgE,gBAAgB,CAAChB,KAAK,CAAC;EAC3C,MAAMiB,IAAI,GAAGF,MAAM,CAACH,MAAM,KAAK,CAAC,GAAGtC,KAAK,GAAG,GAAGA,KAAK,GAAG;EAEtD,OAAO;IACLhB,IAAI;IACJmC,KAAK,EAAEnB,KAAK;IACZA,KAAK,EAAEyC,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,EAAE1C,WAAW,CAACK,IAAI,EAAE6D,OAAO,CAACP,IAAI,EAAE;MACpCY,SAAS,EAAEvE,WAAW,CAACK,IAAI,EAAEA,IAAI,CAACwD,cAAc,CAAC,CAAC;IACpD,CAAC,CAAC;IACFR,KAAK;IACLhD,IAAI;IAEJ;IACAmE,QAAQ,EAAEJ,MAAM,CAACjC,GAAG,CAAEsC,WAAW,IAC/Bf,UAAU,CAACK,MAAM,CAAC5B,GAAG,CAAE2B,KAAK,IAC1BE,SAAS,CAAC3D,IAAI,EAAEoE,WAAW,EAAEX,KAAK,EAAEI,OAAO,CAC7C,CACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,SAASF,SAASA,CAChB3D,IAAyB,EACzBgD,KAAgB,EAChBS,KAAY,EACZI,OAGC,EACgB;EACjB,OAAO;IACLvD,IAAI,EAAEmD,KAAK,CAACnD,IAAI;IAChBmC,KAAK,EAAEgB,KAAK,CAACnC,KAAK;IAClBA,KAAK,EAAEmC,KAAK,CAAChB,KAAK;IAClBZ,KAAK,EAAE4B,KAAK,CAACY,aAAa,CAACR,OAAO,CAACnD,MAAM,CAAC;IAC1CiC,KAAK,EAAEnD,SAAS,CAACiE,KAAK,EAAET,KAAK,CAAC;IAC9BX,IAAI,EAAE1C,WAAW,CAACK,IAAI,EAAE6D,OAAO,CAACP,IAAI,EAAE;MACpCY,SAAS,EAAEvE,WAAW,CAACK,IAAI,EAAEA,IAAI,CAACwD,cAAc,CAAC,CAAC;IACpD,CAAC,CAAC;IACFR,KAAK;IACLhD,IAAI;IACJyD;EACF,CAAC;AACH","ignoreList":[]}

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

@@ -1,11 +1,12 @@
 import Joi from 'joi';
 import { createLogger } from "../../common/helpers/logging/logger.js";
+import { CacheService } from "../../services/index.js";
 const logger = createLogger();
 const pluginRegistrationOptionsSchema = Joi.object({
   model: Joi.object().optional(),
   services: Joi.object().optional(),
   controllers: Joi.object().pattern(Joi.string(), Joi.any()).optional(),
-  cacheName: Joi.string().optional(),
+  cache: Joi.alternatives().try(Joi.object().instance(CacheService), Joi.string()),
   globals: Joi.object().pattern(Joi.string(), Joi.any()).optional(),
   filters: Joi.object().pattern(Joi.string(), Joi.any()).optional(),
   pluginPath: Joi.string().optional(),
@@ -17,11 +18,7 @@ const pluginRegistrationOptionsSchema = Joi.object({
   preparePageEventRequestOptions: Joi.function().optional(),
   onRequest: Joi.function().optional(),
   baseUrl: Joi.string().uri().required(),
-  saveAndReturn: Joi.object({
-    keyGenerator: Joi.function(),
-    sessionHydrator: Joi.function(),
-    sessionPersister: Joi.function()
-  }).optional()
+  saveAndExit: Joi.function().optional()
 });
 
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"options.js","names":["Joi","createLogger","logger","pluginRegistrationOptionsSchema","object","model","optional","services","controllers","pattern","string","any","cacheName","globals","filters","pluginPath","nunjucks","baseLayoutPath","required","paths","array","items","viewContext","function","preparePageEventRequestOptions","onRequest","baseUrl","uri","saveAndReturn","keyGenerator","sessionHydrator","sessionPersister","validatePluginOptions","options","result","validate","abortEarly","error","message","Error","value"],"sources":["../../../../src/server/plugins/engine/options.js"],"sourcesContent":["import Joi from 'joi'\n\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.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  cacheName: Joi.string().optional(),\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  saveAndReturn: Joi.object({\n    keyGenerator: Joi.function(),\n    sessionHydrator: Joi.function(),\n    sessionPersister: Joi.function()\n  }).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      `Missing required properties in plugin options: ${result.error.message}`\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,OAAOA,GAAG,MAAM,KAAK;AAErB,SAASC,YAAY;AAErB,MAAMC,MAAM,GAAGD,YAAY,CAAC,CAAC;AAE7B,MAAME,+BAA+B,GAAGH,GAAG,CAACI,MAAM,CAAC;EACjDC,KAAK,EAAEL,GAAG,CAACI,MAAM,CAAC,CAAC,CAACE,QAAQ,CAAC,CAAC;EAC9BC,QAAQ,EAAEP,GAAG,CAACI,MAAM,CAAC,CAAC,CAACE,QAAQ,CAAC,CAAC;EACjCE,WAAW,EAAER,GAAG,CAACI,MAAM,CAAC,CAAC,CAACK,OAAO,CAACT,GAAG,CAACU,MAAM,CAAC,CAAC,EAAEV,GAAG,CAACW,GAAG,CAAC,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACrEM,SAAS,EAAEZ,GAAG,CAACU,MAAM,CAAC,CAAC,CAACJ,QAAQ,CAAC,CAAC;EAClCO,OAAO,EAAEb,GAAG,CAACI,MAAM,CAAC,CAAC,CAACK,OAAO,CAACT,GAAG,CAACU,MAAM,CAAC,CAAC,EAAEV,GAAG,CAACW,GAAG,CAAC,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACjEQ,OAAO,EAAEd,GAAG,CAACI,MAAM,CAAC,CAAC,CAACK,OAAO,CAACT,GAAG,CAACU,MAAM,CAAC,CAAC,EAAEV,GAAG,CAACW,GAAG,CAAC,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACjES,UAAU,EAAEf,GAAG,CAACU,MAAM,CAAC,CAAC,CAACJ,QAAQ,CAAC,CAAC;EACnCU,QAAQ,EAAEhB,GAAG,CAACI,MAAM,CAAC;IACnBa,cAAc,EAAEjB,GAAG,CAACU,MAAM,CAAC,CAAC,CAACQ,QAAQ,CAAC,CAAC;IACvCC,KAAK,EAAEnB,GAAG,CAACoB,KAAK,CAAC,CAAC,CAACC,KAAK,CAACrB,GAAG,CAACU,MAAM,CAAC,CAAC,CAAC,CAACQ,QAAQ,CAAC;EAClD,CAAC,CAAC,CAACA,QAAQ,CAAC,CAAC;EACbI,WAAW,EAAEtB,GAAG,CAACuB,QAAQ,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACtCM,8BAA8B,EAAExB,GAAG,CAACuB,QAAQ,CAAC,CAAC,CAACjB,QAAQ,CAAC,CAAC;EACzDmB,SAAS,EAAEzB,GAAG,CAACuB,QAAQ,CAAC,CAAC,CAACjB,QAAQ,CAAC,CAAC;EACpCoB,OAAO,EAAE1B,GAAG,CAACU,MAAM,CAAC,CAAC,CAACiB,GAAG,CAAC,CAAC,CAACT,QAAQ,CAAC,CAAC;EACtCU,aAAa,EAAE5B,GAAG,CAACI,MAAM,CAAC;IACxByB,YAAY,EAAE7B,GAAG,CAACuB,QAAQ,CAAC,CAAC;IAC5BO,eAAe,EAAE9B,GAAG,CAACuB,QAAQ,CAAC,CAAC;IAC/BQ,gBAAgB,EAAE/B,GAAG,CAACuB,QAAQ,CAAC;EACjC,CAAC,CAAC,CAACjB,QAAQ,CAAC;AACd,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACA;AACA,OAAO,SAAS0B,qBAAqBA,CAACC,OAAO,EAAE;EAC7C,MAAMC,MAAM,GAAG/B,+BAA+B,CAACgC,QAAQ,CAACF,OAAO,EAAE;IAC/DG,UAAU,EAAE;EACd,CAAC,CAAC;EAEF,IAAIF,MAAM,CAACG,KAAK,EAAE;IAChBnC,MAAM,CAACmC,KAAK,CACV,kDAAkDH,MAAM,CAACG,KAAK,CAACC,OAAO,EACxE,CAAC;IACD,MAAM,IAAIC,KAAK,CAAC,wBAAwB,EAAEL,MAAM,CAACG,KAAK,CAAC;EACzD;;EAEA;EACA,OAAOH,MAAM,CAACM,KAAK;AACrB;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"options.js","names":["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","validatePluginOptions","options","result","validate","abortEarly","error","message","Error","value"],"sources":["../../../../src/server/plugins/engine/options.js"],"sourcesContent":["import 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})\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      `Missing required properties in plugin options: ${result.error.message}`\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,OAAOA,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;AACvC,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACA;AACA,OAAO,SAAS0B,qBAAqBA,CAACC,OAAO,EAAE;EAC7C,MAAMC,MAAM,GAAG/B,+BAA+B,CAACgC,QAAQ,CAACF,OAAO,EAAE;IAC/DG,UAAU,EAAE;EACd,CAAC,CAAC;EAEF,IAAIF,MAAM,CAACG,KAAK,EAAE;IAChBnC,MAAM,CAACmC,KAAK,CACV,kDAAkDH,MAAM,CAACG,KAAK,CAACC,OAAO,EACxE,CAAC;IACD,MAAM,IAAIC,KAAK,CAAC,wBAAwB,EAAEL,MAAM,CAACG,KAAK,CAAC;EACzD;;EAEA;EACA,OAAOH,MAAM,CAACM,KAAK;AACrB;;AAEA;AACA;AACA","ignoreList":[]}

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

@@ -18,7 +18,7 @@ describe('validatePluginOptions', () => {
     };
     expect(validatePluginOptions(validOptions)).toEqual(validOptions);
   });
-  it('accepts optional properties keyGenerator, sessionHydrator, and sessionPersister', () => {
+  it('accepts optional property saveAndExit', () => {
     /**
      * @type {PluginOptions}
      */
@@ -33,13 +33,7 @@ describe('validatePluginOptions', () => {
         };
       },
       baseUrl: 'http://localhost:3009',
-      saveAndReturn: {
-        keyGenerator: () => 'test-key',
-        sessionHydrator: () => Promise.resolve({
-          someState: 'value'
-        }),
-        sessionPersister: () => Promise.resolve(undefined)
-      }
+      saveAndExit: (request, h) => h.redirect('/save-and-exit')
     };
     expect(validatePluginOptions(validOptionsWithOptionals)).toEqual(validOptionsWithOptionals);
   });

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

@@ -1 +1 @@
-{"version":3,"file":"options.test.js","names":["validatePluginOptions","describe","it","validOptions","nunjucks","baseLayoutPath","paths","viewContext","hello","baseUrl","expect","toEqual","validOptionsWithOptionals","saveAndReturn","keyGenerator","sessionHydrator","Promise","resolve","someState","sessionPersister","undefined","invalidOptions","toThrow"],"sources":["../../../../src/server/plugins/engine/options.test.js"],"sourcesContent":["import { validatePluginOptions } from '~/src/server/plugins/engine/options.js'\n\ndescribe('validatePluginOptions', () => {\n  it('returns the validated value for valid options', () => {\n    /**\n     * @type {PluginOptions}\n     */\n    const validOptions = {\n      nunjucks: {\n        baseLayoutPath: 'dxt-devtool-baselayout.html',\n        paths: ['src/server/devserver'] // custom layout to make it really clear this is not the same as the runner\n      },\n      viewContext: () => {\n        return { hello: 'world' }\n      },\n      baseUrl: 'http://localhost:3009'\n    }\n\n    expect(validatePluginOptions(validOptions)).toEqual(validOptions)\n  })\n\n  it('accepts optional properties keyGenerator, sessionHydrator, and sessionPersister', () => {\n    /**\n     * @type {PluginOptions}\n     */\n    const validOptionsWithOptionals = {\n      nunjucks: {\n        baseLayoutPath: 'dxt-devtool-baselayout.html',\n        paths: ['src/server/devserver']\n      },\n      viewContext: () => {\n        return { hello: 'world' }\n      },\n      baseUrl: 'http://localhost:3009',\n      saveAndReturn: {\n        keyGenerator: () => 'test-key',\n        sessionHydrator: () => Promise.resolve({ someState: 'value' }),\n        sessionPersister: () => Promise.resolve(undefined)\n      }\n    }\n\n    expect(validatePluginOptions(validOptionsWithOptionals)).toEqual(\n      validOptionsWithOptionals\n    )\n  })\n\n  /**\n   * tsc would usually check compliance with the type, but given a user might be using plain JS we still want a test\n   */\n  it('fails if a required attribute is missing', () => {\n    const invalidOptions =\n      /** @type {PluginOptions} testing without viewContext */ ({\n        nunjucks: {\n          baseLayoutPath: 'dxt-devtool-baselayout.html',\n          paths: ['src/server/devserver'] // custom layout to make it really clear this is not the same as the runner\n        }\n      })\n\n    expect(() => validatePluginOptions(invalidOptions)).toThrow(\n      'Invalid plugin options'\n    )\n  })\n})\n\n/**\n * @import { PluginOptions } from '~/src/server/plugins/engine/types.js'\n */\n"],"mappings":"AAAA,SAASA,qBAAqB;AAE9BC,QAAQ,CAAC,uBAAuB,EAAE,MAAM;EACtCC,EAAE,CAAC,+CAA+C,EAAE,MAAM;IACxD;AACJ;AACA;IACI,MAAMC,YAAY,GAAG;MACnBC,QAAQ,EAAE;QACRC,cAAc,EAAE,6BAA6B;QAC7CC,KAAK,EAAE,CAAC,sBAAsB,CAAC,CAAC;MAClC,CAAC;MACDC,WAAW,EAAEA,CAAA,KAAM;QACjB,OAAO;UAAEC,KAAK,EAAE;QAAQ,CAAC;MAC3B,CAAC;MACDC,OAAO,EAAE;IACX,CAAC;IAEDC,MAAM,CAACV,qBAAqB,CAACG,YAAY,CAAC,CAAC,CAACQ,OAAO,CAACR,YAAY,CAAC;EACnE,CAAC,CAAC;EAEFD,EAAE,CAAC,iFAAiF,EAAE,MAAM;IAC1F;AACJ;AACA;IACI,MAAMU,yBAAyB,GAAG;MAChCR,QAAQ,EAAE;QACRC,cAAc,EAAE,6BAA6B;QAC7CC,KAAK,EAAE,CAAC,sBAAsB;MAChC,CAAC;MACDC,WAAW,EAAEA,CAAA,KAAM;QACjB,OAAO;UAAEC,KAAK,EAAE;QAAQ,CAAC;MAC3B,CAAC;MACDC,OAAO,EAAE,uBAAuB;MAChCI,aAAa,EAAE;QACbC,YAAY,EAAEA,CAAA,KAAM,UAAU;QAC9BC,eAAe,EAAEA,CAAA,KAAMC,OAAO,CAACC,OAAO,CAAC;UAAEC,SAAS,EAAE;QAAQ,CAAC,CAAC;QAC9DC,gBAAgB,EAAEA,CAAA,KAAMH,OAAO,CAACC,OAAO,CAACG,SAAS;MACnD;IACF,CAAC;IAEDV,MAAM,CAACV,qBAAqB,CAACY,yBAAyB,CAAC,CAAC,CAACD,OAAO,CAC9DC,yBACF,CAAC;EACH,CAAC,CAAC;;EAEF;AACF;AACA;EACEV,EAAE,CAAC,0CAA0C,EAAE,MAAM;IACnD,MAAMmB,cAAc,GAClB,wDAA0D;MACxDjB,QAAQ,EAAE;QACRC,cAAc,EAAE,6BAA6B;QAC7CC,KAAK,EAAE,CAAC,sBAAsB,CAAC,CAAC;MAClC;IACF,CAAE;IAEJI,MAAM,CAAC,MAAMV,qBAAqB,CAACqB,cAAc,CAAC,CAAC,CAACC,OAAO,CACzD,wBACF,CAAC;EACH,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"options.test.js","names":["validatePluginOptions","describe","it","validOptions","nunjucks","baseLayoutPath","paths","viewContext","hello","baseUrl","expect","toEqual","validOptionsWithOptionals","saveAndExit","request","h","redirect","invalidOptions","toThrow"],"sources":["../../../../src/server/plugins/engine/options.test.js"],"sourcesContent":["import { validatePluginOptions } from '~/src/server/plugins/engine/options.js'\n\ndescribe('validatePluginOptions', () => {\n  it('returns the validated value for valid options', () => {\n    /**\n     * @type {PluginOptions}\n     */\n    const validOptions = {\n      nunjucks: {\n        baseLayoutPath: 'dxt-devtool-baselayout.html',\n        paths: ['src/server/devserver'] // custom layout to make it really clear this is not the same as the runner\n      },\n      viewContext: () => {\n        return { hello: 'world' }\n      },\n      baseUrl: 'http://localhost:3009'\n    }\n\n    expect(validatePluginOptions(validOptions)).toEqual(validOptions)\n  })\n\n  it('accepts optional property saveAndExit', () => {\n    /**\n     * @type {PluginOptions}\n     */\n    const validOptionsWithOptionals = {\n      nunjucks: {\n        baseLayoutPath: 'dxt-devtool-baselayout.html',\n        paths: ['src/server/devserver']\n      },\n      viewContext: () => {\n        return { hello: 'world' }\n      },\n      baseUrl: 'http://localhost:3009',\n      saveAndExit: (request, h) => h.redirect('/save-and-exit')\n    }\n\n    expect(validatePluginOptions(validOptionsWithOptionals)).toEqual(\n      validOptionsWithOptionals\n    )\n  })\n\n  /**\n   * tsc would usually check compliance with the type, but given a user might be using plain JS we still want a test\n   */\n  it('fails if a required attribute is missing', () => {\n    const invalidOptions =\n      /** @type {PluginOptions} testing without viewContext */ ({\n        nunjucks: {\n          baseLayoutPath: 'dxt-devtool-baselayout.html',\n          paths: ['src/server/devserver'] // custom layout to make it really clear this is not the same as the runner\n        }\n      })\n\n    expect(() => validatePluginOptions(invalidOptions)).toThrow(\n      'Invalid plugin options'\n    )\n  })\n})\n\n/**\n * @import { PluginOptions } from '~/src/server/plugins/engine/types.js'\n */\n"],"mappings":"AAAA,SAASA,qBAAqB;AAE9BC,QAAQ,CAAC,uBAAuB,EAAE,MAAM;EACtCC,EAAE,CAAC,+CAA+C,EAAE,MAAM;IACxD;AACJ;AACA;IACI,MAAMC,YAAY,GAAG;MACnBC,QAAQ,EAAE;QACRC,cAAc,EAAE,6BAA6B;QAC7CC,KAAK,EAAE,CAAC,sBAAsB,CAAC,CAAC;MAClC,CAAC;MACDC,WAAW,EAAEA,CAAA,KAAM;QACjB,OAAO;UAAEC,KAAK,EAAE;QAAQ,CAAC;MAC3B,CAAC;MACDC,OAAO,EAAE;IACX,CAAC;IAEDC,MAAM,CAACV,qBAAqB,CAACG,YAAY,CAAC,CAAC,CAACQ,OAAO,CAACR,YAAY,CAAC;EACnE,CAAC,CAAC;EAEFD,EAAE,CAAC,uCAAuC,EAAE,MAAM;IAChD;AACJ;AACA;IACI,MAAMU,yBAAyB,GAAG;MAChCR,QAAQ,EAAE;QACRC,cAAc,EAAE,6BAA6B;QAC7CC,KAAK,EAAE,CAAC,sBAAsB;MAChC,CAAC;MACDC,WAAW,EAAEA,CAAA,KAAM;QACjB,OAAO;UAAEC,KAAK,EAAE;QAAQ,CAAC;MAC3B,CAAC;MACDC,OAAO,EAAE,uBAAuB;MAChCI,WAAW,EAAEA,CAACC,OAAO,EAAEC,CAAC,KAAKA,CAAC,CAACC,QAAQ,CAAC,gBAAgB;IAC1D,CAAC;IAEDN,MAAM,CAACV,qBAAqB,CAACY,yBAAyB,CAAC,CAAC,CAACD,OAAO,CAC9DC,yBACF,CAAC;EACH,CAAC,CAAC;;EAEF;AACF;AACA;EACEV,EAAE,CAAC,0CAA0C,EAAE,MAAM;IACnD,MAAMe,cAAc,GAClB,wDAA0D;MACxDb,QAAQ,EAAE;QACRC,cAAc,EAAE,6BAA6B;QAC7CC,KAAK,EAAE,CAAC,sBAAsB,CAAC,CAAC;MAClC;IACF,CAAE;IAEJI,MAAM,CAAC,MAAMV,qBAAqB,CAACiB,cAAc,CAAC,CAAC,CAACC,OAAO,CACzD,wBACF,CAAC;EACH,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}

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

@@ -4,3 +4,7 @@ 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;
+export declare function getVersionMetadata(submittedVersionNumber: number | undefined, formMetadata?: FormMetadata): {
+    versionNumber: number;
+    createdAt: Date;
+} | undefined;

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

@@ -6,6 +6,7 @@ export function format(context, items, model, submitResponse, formStatus, formMe
   const v2DataParsed = JSON.parse(v2DataString);
   const csvFiles = extractCsvFiles(submitResponse);
   const transformedData = v2DataParsed.data;
+  const versionMetadata = getVersionMetadata(context.submittedVersionNumber, formMetadata);
   const meta = {
     schemaVersion: FormAdapterSubmissionSchemaVersion.V1,
     timestamp: new Date(),
@@ -17,6 +18,9 @@ export function format(context, items, model, submitResponse, formStatus, formMe
     isPreview: formStatus.isPreview,
     notificationEmail: formMetadata?.notificationEmail ?? ''
   };
+  if (versionMetadata) {
+    meta.versionMetadata = versionMetadata;
+  }
   const data = transformedData;
   const result = {
     files: csvFiles
@@ -28,6 +32,27 @@ export function format(context, items, model, submitResponse, formStatus, formMe
   };
   return JSON.stringify(payload);
 }
+export function getVersionMetadata(submittedVersionNumber, formMetadata) {
+  if (!formMetadata?.versions?.length) {
+    return undefined;
+  }
+  if (submittedVersionNumber !== undefined) {
+    const submittedVersion = formMetadata.versions.find(v => v.versionNumber === submittedVersionNumber);
+    if (submittedVersion) {
+      return {
+        versionNumber: submittedVersion.versionNumber,
+        createdAt: submittedVersion.createdAt
+      };
+    }
+  }
+
+  // fallback to first available version
+  const firstVersion = formMetadata.versions[0];
+  return {
+    versionNumber: firstVersion.versionNumber,
+    createdAt: firstVersion.createdAt
+  };
+}
 function extractCsvFiles(submitResponse) {
   const result = submitResponse.result;
   return {

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

@@ -1 +1 @@
-{"version":3,"file":"v1.js","names":["format","machineV2","FormAdapterSubmissionSchemaVersion","FormStatus","context","items","model","submitResponse","formStatus","formMetadata","v2DataString","v2DataParsed","JSON","parse","csvFiles","extractCsvFiles","transformedData","data","meta","schemaVersion","V1","timestamp","Date","referenceNumber","formName","name","formId","id","formSlug","slug","status","isPreview","Draft","Live","notificationEmail","result","files","payload","stringify","main","repeaters"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/adapter/v1.ts"],"sourcesContent":["import {\n  type FormMetadata,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\n\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { format as machineV2 } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'\nimport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\nimport {\n  type FormAdapterSubmissionMessageData,\n  type FormAdapterSubmissionMessageMeta,\n  type FormAdapterSubmissionMessagePayload,\n  type FormAdapterSubmissionMessageResult,\n  type FormContext\n} from '~/src/server/plugins/engine/types.js'\nimport { FormStatus } from '~/src/server/routes/types.js'\n\nexport function format(\n  context: FormContext,\n  items: DetailItem[],\n  model: FormModel,\n  submitResponse: SubmitResponsePayload,\n  formStatus: ReturnType<typeof checkFormStatus>,\n  formMetadata?: FormMetadata\n): string {\n  const v2DataString = machineV2(\n    context,\n    items,\n    model,\n    submitResponse,\n    formStatus\n  )\n  const v2DataParsed = JSON.parse(v2DataString) as {\n    data: FormAdapterSubmissionMessageData\n  }\n\n  const csvFiles = extractCsvFiles(submitResponse)\n\n  const transformedData = v2DataParsed.data\n\n  const meta: FormAdapterSubmissionMessageMeta = {\n    schemaVersion: FormAdapterSubmissionSchemaVersion.V1,\n    timestamp: new Date(),\n    referenceNumber: context.referenceNumber,\n    formName: model.name,\n    formId: formMetadata?.id ?? '',\n    formSlug: formMetadata?.slug ?? '',\n    status: formStatus.isPreview ? FormStatus.Draft : FormStatus.Live,\n    isPreview: formStatus.isPreview,\n    notificationEmail: formMetadata?.notificationEmail ?? ''\n  }\n  const data: FormAdapterSubmissionMessageData = transformedData\n\n  const result: FormAdapterSubmissionMessageResult = {\n    files: csvFiles\n  }\n\n  const payload: FormAdapterSubmissionMessagePayload = {\n    meta,\n    data,\n    result\n  }\n\n  return JSON.stringify(payload)\n}\n\nfunction extractCsvFiles(\n  submitResponse: SubmitResponsePayload\n): FormAdapterSubmissionMessageResult['files'] {\n  const result =\n    submitResponse.result as Partial<FormAdapterSubmissionMessageResult>\n\n  return {\n    main: result.files?.main ?? '',\n    repeaters: result.files?.repeaters ?? {}\n  }\n}\n"],"mappings":"AAQA,SAASA,MAAM,IAAIC,SAAS;AAC5B,SAASC,kCAAkC;AAQ3C,SAASC,UAAU;AAEnB,OAAO,SAASH,MAAMA,CACpBI,OAAoB,EACpBC,KAAmB,EACnBC,KAAgB,EAChBC,cAAqC,EACrCC,UAA8C,EAC9CC,YAA2B,EACnB;EACR,MAAMC,YAAY,GAAGT,SAAS,CAC5BG,OAAO,EACPC,KAAK,EACLC,KAAK,EACLC,cAAc,EACdC,UACF,CAAC;EACD,MAAMG,YAAY,GAAGC,IAAI,CAACC,KAAK,CAACH,YAAY,CAE3C;EAED,MAAMI,QAAQ,GAAGC,eAAe,CAACR,cAAc,CAAC;EAEhD,MAAMS,eAAe,GAAGL,YAAY,CAACM,IAAI;EAEzC,MAAMC,IAAsC,GAAG;IAC7CC,aAAa,EAAEjB,kCAAkC,CAACkB,EAAE;IACpDC,SAAS,EAAE,IAAIC,IAAI,CAAC,CAAC;IACrBC,eAAe,EAAEnB,OAAO,CAACmB,eAAe;IACxCC,QAAQ,EAAElB,KAAK,CAACmB,IAAI;IACpBC,MAAM,EAAEjB,YAAY,EAAEkB,EAAE,IAAI,EAAE;IAC9BC,QAAQ,EAAEnB,YAAY,EAAEoB,IAAI,IAAI,EAAE;IAClCC,MAAM,EAAEtB,UAAU,CAACuB,SAAS,GAAG5B,UAAU,CAAC6B,KAAK,GAAG7B,UAAU,CAAC8B,IAAI;IACjEF,SAAS,EAAEvB,UAAU,CAACuB,SAAS;IAC/BG,iBAAiB,EAAEzB,YAAY,EAAEyB,iBAAiB,IAAI;EACxD,CAAC;EACD,MAAMjB,IAAsC,GAAGD,eAAe;EAE9D,MAAMmB,MAA0C,GAAG;IACjDC,KAAK,EAAEtB;EACT,CAAC;EAED,MAAMuB,OAA4C,GAAG;IACnDnB,IAAI;IACJD,IAAI;IACJkB;EACF,CAAC;EAED,OAAOvB,IAAI,CAAC0B,SAAS,CAACD,OAAO,CAAC;AAChC;AAEA,SAAStB,eAAeA,CACtBR,cAAqC,EACQ;EAC7C,MAAM4B,MAAM,GACV5B,cAAc,CAAC4B,MAAqD;EAEtE,OAAO;IACLI,IAAI,EAAEJ,MAAM,CAACC,KAAK,EAAEG,IAAI,IAAI,EAAE;IAC9BC,SAAS,EAAEL,MAAM,CAACC,KAAK,EAAEI,SAAS,IAAI,CAAC;EACzC,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"v1.js","names":["format","machineV2","FormAdapterSubmissionSchemaVersion","FormStatus","context","items","model","submitResponse","formStatus","formMetadata","v2DataString","v2DataParsed","JSON","parse","csvFiles","extractCsvFiles","transformedData","data","versionMetadata","getVersionMetadata","submittedVersionNumber","meta","schemaVersion","V1","timestamp","Date","referenceNumber","formName","name","formId","id","formSlug","slug","status","isPreview","Draft","Live","notificationEmail","result","files","payload","stringify","versions","length","undefined","submittedVersion","find","v","versionNumber","createdAt","firstVersion","main","repeaters"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/adapter/v1.ts"],"sourcesContent":["import {\n  type FormMetadata,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\n\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { format as machineV2 } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'\nimport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\nimport {\n  type FormAdapterSubmissionMessageData,\n  type FormAdapterSubmissionMessageMeta,\n  type FormAdapterSubmissionMessagePayload,\n  type FormAdapterSubmissionMessageResult,\n  type FormContext\n} from '~/src/server/plugins/engine/types.js'\nimport { FormStatus } from '~/src/server/routes/types.js'\n\nexport function format(\n  context: FormContext,\n  items: DetailItem[],\n  model: FormModel,\n  submitResponse: SubmitResponsePayload,\n  formStatus: ReturnType<typeof checkFormStatus>,\n  formMetadata?: FormMetadata\n): string {\n  const v2DataString = machineV2(\n    context,\n    items,\n    model,\n    submitResponse,\n    formStatus\n  )\n  const v2DataParsed = JSON.parse(v2DataString) as {\n    data: FormAdapterSubmissionMessageData\n  }\n\n  const csvFiles = extractCsvFiles(submitResponse)\n\n  const transformedData = v2DataParsed.data\n\n  const versionMetadata = getVersionMetadata(\n    context.submittedVersionNumber,\n    formMetadata\n  )\n\n  const meta: FormAdapterSubmissionMessageMeta = {\n    schemaVersion: FormAdapterSubmissionSchemaVersion.V1,\n    timestamp: new Date(),\n    referenceNumber: context.referenceNumber,\n    formName: model.name,\n    formId: formMetadata?.id ?? '',\n    formSlug: formMetadata?.slug ?? '',\n    status: formStatus.isPreview ? FormStatus.Draft : FormStatus.Live,\n    isPreview: formStatus.isPreview,\n    notificationEmail: formMetadata?.notificationEmail ?? ''\n  }\n\n  if (versionMetadata) {\n    meta.versionMetadata = versionMetadata\n  }\n  const data: FormAdapterSubmissionMessageData = transformedData\n\n  const result: FormAdapterSubmissionMessageResult = {\n    files: csvFiles\n  }\n\n  const payload: FormAdapterSubmissionMessagePayload = {\n    meta,\n    data,\n    result\n  }\n\n  return JSON.stringify(payload)\n}\n\nexport function getVersionMetadata(\n  submittedVersionNumber: number | undefined,\n  formMetadata?: FormMetadata\n): { versionNumber: number; createdAt: Date } | undefined {\n  if (!formMetadata?.versions?.length) {\n    return undefined\n  }\n\n  if (submittedVersionNumber !== undefined) {\n    const submittedVersion = formMetadata.versions.find(\n      (v) => v.versionNumber === submittedVersionNumber\n    )\n    if (submittedVersion) {\n      return {\n        versionNumber: submittedVersion.versionNumber,\n        createdAt: submittedVersion.createdAt\n      }\n    }\n  }\n\n  // fallback to first available version\n  const firstVersion = formMetadata.versions[0]\n  return {\n    versionNumber: firstVersion.versionNumber,\n    createdAt: firstVersion.createdAt\n  }\n}\n\nfunction extractCsvFiles(\n  submitResponse: SubmitResponsePayload\n): FormAdapterSubmissionMessageResult['files'] {\n  const result =\n    submitResponse.result as Partial<FormAdapterSubmissionMessageResult>\n\n  return {\n    main: result.files?.main ?? '',\n    repeaters: result.files?.repeaters ?? {}\n  }\n}\n"],"mappings":"AAQA,SAASA,MAAM,IAAIC,SAAS;AAC5B,SAASC,kCAAkC;AAQ3C,SAASC,UAAU;AAEnB,OAAO,SAASH,MAAMA,CACpBI,OAAoB,EACpBC,KAAmB,EACnBC,KAAgB,EAChBC,cAAqC,EACrCC,UAA8C,EAC9CC,YAA2B,EACnB;EACR,MAAMC,YAAY,GAAGT,SAAS,CAC5BG,OAAO,EACPC,KAAK,EACLC,KAAK,EACLC,cAAc,EACdC,UACF,CAAC;EACD,MAAMG,YAAY,GAAGC,IAAI,CAACC,KAAK,CAACH,YAAY,CAE3C;EAED,MAAMI,QAAQ,GAAGC,eAAe,CAACR,cAAc,CAAC;EAEhD,MAAMS,eAAe,GAAGL,YAAY,CAACM,IAAI;EAEzC,MAAMC,eAAe,GAAGC,kBAAkB,CACxCf,OAAO,CAACgB,sBAAsB,EAC9BX,YACF,CAAC;EAED,MAAMY,IAAsC,GAAG;IAC7CC,aAAa,EAAEpB,kCAAkC,CAACqB,EAAE;IACpDC,SAAS,EAAE,IAAIC,IAAI,CAAC,CAAC;IACrBC,eAAe,EAAEtB,OAAO,CAACsB,eAAe;IACxCC,QAAQ,EAAErB,KAAK,CAACsB,IAAI;IACpBC,MAAM,EAAEpB,YAAY,EAAEqB,EAAE,IAAI,EAAE;IAC9BC,QAAQ,EAAEtB,YAAY,EAAEuB,IAAI,IAAI,EAAE;IAClCC,MAAM,EAAEzB,UAAU,CAAC0B,SAAS,GAAG/B,UAAU,CAACgC,KAAK,GAAGhC,UAAU,CAACiC,IAAI;IACjEF,SAAS,EAAE1B,UAAU,CAAC0B,SAAS;IAC/BG,iBAAiB,EAAE5B,YAAY,EAAE4B,iBAAiB,IAAI;EACxD,CAAC;EAED,IAAInB,eAAe,EAAE;IACnBG,IAAI,CAACH,eAAe,GAAGA,eAAe;EACxC;EACA,MAAMD,IAAsC,GAAGD,eAAe;EAE9D,MAAMsB,MAA0C,GAAG;IACjDC,KAAK,EAAEzB;EACT,CAAC;EAED,MAAM0B,OAA4C,GAAG;IACnDnB,IAAI;IACJJ,IAAI;IACJqB;EACF,CAAC;EAED,OAAO1B,IAAI,CAAC6B,SAAS,CAACD,OAAO,CAAC;AAChC;AAEA,OAAO,SAASrB,kBAAkBA,CAChCC,sBAA0C,EAC1CX,YAA2B,EAC6B;EACxD,IAAI,CAACA,YAAY,EAAEiC,QAAQ,EAAEC,MAAM,EAAE;IACnC,OAAOC,SAAS;EAClB;EAEA,IAAIxB,sBAAsB,KAAKwB,SAAS,EAAE;IACxC,MAAMC,gBAAgB,GAAGpC,YAAY,CAACiC,QAAQ,CAACI,IAAI,CAChDC,CAAC,IAAKA,CAAC,CAACC,aAAa,KAAK5B,sBAC7B,CAAC;IACD,IAAIyB,gBAAgB,EAAE;MACpB,OAAO;QACLG,aAAa,EAAEH,gBAAgB,CAACG,aAAa;QAC7CC,SAAS,EAAEJ,gBAAgB,CAACI;MAC9B,CAAC;IACH;EACF;;EAEA;EACA,MAAMC,YAAY,GAAGzC,YAAY,CAACiC,QAAQ,CAAC,CAAC,CAAC;EAC7C,OAAO;IACLM,aAAa,EAAEE,YAAY,CAACF,aAAa;IACzCC,SAAS,EAAEC,YAAY,CAACD;EAC1B,CAAC;AACH;AAEA,SAASlC,eAAeA,CACtBR,cAAqC,EACQ;EAC7C,MAAM+B,MAAM,GACV/B,cAAc,CAAC+B,MAAqD;EAEtE,OAAO;IACLa,IAAI,EAAEb,MAAM,CAACC,KAAK,EAAEY,IAAI,IAAI,EAAE;IAC9BC,SAAS,EAAEd,MAAM,CAACC,KAAK,EAAEa,SAAS,IAAI,CAAC;EACzC,CAAC;AACH","ignoreList":[]}

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

@@ -4,13 +4,14 @@ const designerUrl = config.get('designerUrl');
 export function format(context, items, model, _submitResponse, _formStatus) {
   const now = new Date();
   const categorisedData = categoriseData(items);
+  const meta = {
+    schemaVersion: '2',
+    timestamp: now.toISOString(),
+    definition: model.def,
+    referenceNumber: context.referenceNumber
+  };
   const data = {
-    meta: {
-      schemaVersion: '2',
-      timestamp: now.toISOString(),
-      definition: model.def,
-      referenceNumber: context.referenceNumber
-    },
+    meta,
     data: categorisedData
   };
   const body = JSON.stringify(data);

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

package/.server/server/plugins/engine/pageControllers/FileUploadPageController.d.ts

@@ -1,11 +1,10 @@
 import { type PageFileUpload } from '@defra/forms-model';
-import { type ResponseToolkit } from '@hapi/hapi';
 import { type ValidationErrorItem } from 'joi';
 import { type FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js';
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
 import { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js';
-import { type FeaturedFormPageViewModel, type FormContext, type FormContextRequest, type FormSubmissionError, type FormSubmissionState, type UploadInitiateResponse, type UploadStatusFileResponse } from '~/src/server/plugins/engine/types.js';
-import { type FormRequest, type FormRequestPayload } from '~/src/server/routes/types.js';
+import { type AnyFormRequest, type FeaturedFormPageViewModel, type FormContext, type FormContextRequest, type FormSubmissionError, type FormSubmissionState, type UploadInitiateResponse, type UploadStatusFileResponse } from '~/src/server/plugins/engine/types.js';
+import { type FormRequest, type FormRequestPayload, type FormResponseToolkit } from '~/src/server/routes/types.js';
 export declare function prepareStatus(status: UploadStatusFileResponse): UploadStatusFileResponse;
 export declare class FileUploadPageController extends QuestionPageController {
     pageDef: PageFileUpload;
@@ -13,7 +12,7 @@ export declare class FileUploadPageController extends QuestionPageController {
     fileDeleteViewName: string;
     constructor(model: FormModel, pageDef: PageFileUpload);
     getFormDataFromState(request: FormContextRequest | undefined, state: FormSubmissionState): import("~/src/server/plugins/engine/types.js").FormPayload;
-    getState(request: FormRequest | FormRequestPayload): Promise<FormSubmissionState>;
+    getState(request: AnyFormRequest): Promise<FormSubmissionState>;
     /**
      * Get the uploaded files from state.
      */
@@ -22,8 +21,8 @@ export declare class FileUploadPageController extends QuestionPageController {
      * Get the initiated upload from state.
      */
     getUploadFromState(state: FormSubmissionState): UploadInitiateResponse | undefined;
-    makeGetItemDeleteRouteHandler(): (request: FormRequest, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => import("@hapi/hapi").ResponseObject;
-    makePostItemDeleteRouteHandler(): (request: FormRequestPayload, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => Promise<import("@hapi/hapi").ResponseObject>;
+    makeGetItemDeleteRouteHandler(): (request: FormRequest, context: FormContext, h: FormResponseToolkit) => import("@hapi/hapi").ResponseObject;
+    makePostItemDeleteRouteHandler(): (request: FormRequestPayload, context: FormContext, h: FormResponseToolkit) => Promise<import("@hapi/hapi").ResponseObject>;
     getErrors(details?: ValidationErrorItem[]): FormSubmissionError[] | undefined;
     getViewModel(request: FormContextRequest, context: FormContext): FeaturedFormPageViewModel;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"FileUploadPageController.js","names":["ComponentType","Boom","wait","tempItemSchema","getCacheService","getError","getExponentialBackoffDelay","QuestionPageController","getProxyUrlForLocalDevelopment","getUploadStatus","initiateUpload","FileStatus","UploadStatus","MAX_UPLOADS","CDP_UPLOAD_TIMEOUT_MS","prepareStatus","status","file","form","isPending","fileStatus","pending","errorMessage","prepareFileState","fileState","FileUploadPageController","fileUpload","fileDeleteViewName","constructor","model","pageDef","collection","fileUploads","fields","filter","field","type","FileUploadField","at","length","badImplementation","path","indexOf","name","viewName","getFormDataFromState","request","state","payload","files","getFilesFromState","undefined","getState","refreshUpload","uploadState","upload","getUploadFromState","makeGetItemDeleteRouteHandler","context","h","viewModel","params","fileToRemove","find","uploadId","itemId","notFound","filename","view","backLink","getBackLink","pageTitle","itemTitle","confirmation","text","buttonConfirm","buttonCancel","makePostItemDeleteRouteHandler","confirm","getFormParams","checkRemovedFiles","proceed","getErrors","details","errors","forEach","error","isUploadError","isUploadRootError","push","value","href","getViewModel","components","formComponent","id","index","proxyUrl","uploadUrl","formAction","componentsBefore","slice","checkUploadStatus","depth","initiateAndStoreNewUpload","statusResponse","badRequest","uploadStatus","initiated","Error","logger","gatewayTimeout","toFixed","delay","info","validationResult","validate","stripUnknown","complete","unshift","mergeState","cacheService","server","setFlash","filesUpdated","options","schema","max","Math","min","outputEmail","def","newUpload","accept"],"sources":["../../../../../src/server/plugins/engine/pageControllers/FileUploadPageController.ts"],"sourcesContent":["import { ComponentType, type PageFileUpload } from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type ResponseToolkit } from '@hapi/hapi'\nimport { wait } from '@hapi/hoek'\nimport { type ValidationErrorItem } from 'joi'\n\nimport {\n  tempItemSchema,\n  type FileUploadField\n} from '~/src/server/plugins/engine/components/FileUploadField.js'\nimport {\n  getCacheService,\n  getError,\n  getExponentialBackoffDelay\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'\nimport { getProxyUrlForLocalDevelopment } from '~/src/server/plugins/engine/pageControllers/helpers/index.js'\nimport {\n  getUploadStatus,\n  initiateUpload\n} from '~/src/server/plugins/engine/services/uploadService.js'\nimport {\n  FileStatus,\n  UploadStatus,\n  type FeaturedFormPageViewModel,\n  type FileState,\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionError,\n  type FormSubmissionState,\n  type ItemDeletePageViewModel,\n  type UploadInitiateResponse,\n  type UploadStatusFileResponse\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload\n} from '~/src/server/routes/types.js'\n\nconst MAX_UPLOADS = 25\nconst CDP_UPLOAD_TIMEOUT_MS = 60000 // 1 minute\n\nexport function prepareStatus(status: UploadStatusFileResponse) {\n  const file = status.form.file\n  const isPending = file.fileStatus === FileStatus.pending\n\n  if (!file.errorMessage && isPending) {\n    file.errorMessage = 'The selected file has not fully uploaded'\n  }\n\n  return status\n}\n\nfunction prepareFileState(fileState: FileState) {\n  prepareStatus(fileState.status)\n\n  return fileState\n}\n\nexport class FileUploadPageController extends QuestionPageController {\n  declare pageDef: PageFileUpload\n\n  fileUpload: FileUploadField\n  fileDeleteViewName = 'item-delete'\n\n  constructor(model: FormModel, pageDef: PageFileUpload) {\n    super(model, pageDef)\n\n    const { collection } = this\n\n    // Get the file upload fields from the collection\n    const fileUploads = collection.fields.filter(\n      (field): field is FileUploadField =>\n        field.type === ComponentType.FileUploadField\n    )\n\n    const fileUpload = fileUploads.at(0)\n\n    // Assert we have exactly 1 file upload component\n    if (!fileUpload || fileUploads.length > 1) {\n      throw Boom.badImplementation(\n        `Expected 1 FileUploadFieldComponent in FileUploadPageController '${pageDef.path}'`\n      )\n    }\n\n    // Assert the file upload component is the first form component\n    if (collection.fields.indexOf(fileUpload) !== 0) {\n      throw Boom.badImplementation(\n        `Expected '${fileUpload.name}' to be the first form component in FileUploadPageController '${pageDef.path}'`\n      )\n    }\n\n    // Assign the file upload component to the controller\n    this.fileUpload = fileUpload\n    this.viewName = 'file-upload'\n  }\n\n  getFormDataFromState(\n    request: FormContextRequest | undefined,\n    state: FormSubmissionState\n  ) {\n    const { fileUpload } = this\n\n    const payload = super.getFormDataFromState(request, state)\n    const files = this.getFilesFromState(state)\n\n    // Append the files to the payload\n    payload[fileUpload.name] = files.length ? files : undefined\n\n    return payload\n  }\n\n  async getState(request: FormRequest | FormRequestPayload) {\n    const { fileUpload } = this\n\n    // Get the actual state\n    const state = await super.getState(request)\n    const files = this.getFilesFromState(state)\n\n    // Overwrite the files with those in the upload state\n    state[fileUpload.name] = files\n\n    return this.refreshUpload(request, state)\n  }\n\n  /**\n   * Get the uploaded files from state.\n   */\n  getFilesFromState(state: FormSubmissionState) {\n    const { path } = this\n\n    const uploadState = state.upload?.[path]\n    return uploadState?.files ?? []\n  }\n\n  /**\n   * Get the initiated upload from state.\n   */\n  getUploadFromState(state: FormSubmissionState) {\n    const { path } = this\n\n    const uploadState = state.upload?.[path]\n    return uploadState?.upload\n  }\n\n  makeGetItemDeleteRouteHandler() {\n    return (\n      request: FormRequest,\n      context: FormContext,\n      h: Pick<ResponseToolkit, 'redirect' | 'view'>\n    ) => {\n      const { viewModel } = this\n      const { params } = request\n      const { state } = context\n\n      const files = this.getFilesFromState(state)\n\n      const fileToRemove = files.find(\n        ({ uploadId }) => uploadId === params.itemId\n      )\n\n      if (!fileToRemove) {\n        throw Boom.notFound('File to delete not found')\n      }\n\n      const { filename } = fileToRemove.status.form.file\n\n      return h.view(this.fileDeleteViewName, {\n        ...viewModel,\n        context,\n        backLink: this.getBackLink(request, context),\n        pageTitle: `Are you sure you want to remove this file?`,\n        itemTitle: filename,\n        confirmation: { text: 'You cannot recover removed files.' },\n        buttonConfirm: { text: 'Remove file' },\n        buttonCancel: { text: 'Cancel' }\n      } satisfies ItemDeletePageViewModel)\n    }\n  }\n\n  makePostItemDeleteRouteHandler() {\n    return async (\n      request: FormRequestPayload,\n      context: FormContext,\n      h: Pick<ResponseToolkit, 'redirect' | 'view'>\n    ) => {\n      const { path } = this\n      const { state } = context\n\n      const { confirm } = this.getFormParams(request)\n\n      // Check for any removed files in the POST payload\n      if (confirm) {\n        await this.checkRemovedFiles(request, state)\n        return this.proceed(request, h, path)\n      }\n\n      return this.proceed(request, h)\n    }\n  }\n\n  getErrors(details?: ValidationErrorItem[]) {\n    const { fileUpload } = this\n\n    if (details) {\n      const errors: FormSubmissionError[] = []\n\n      details.forEach((error) => {\n        const isUploadError = error.path[0] === fileUpload.name\n        const isUploadRootError = isUploadError && error.path.length === 1\n\n        if (!isUploadError || isUploadRootError) {\n          // The error is for the root of the upload or another\n          // field on the page so defer to the getError helper\n          errors.push(getError(error))\n        } else {\n          const { context, path, type } = error\n\n          if (type === 'object.unknown' && path.at(-1) === 'errorMessage') {\n            const value = context?.value as string | undefined\n\n            if (value) {\n              const name = fileUpload.name\n              const text = typeof value === 'string' ? value : 'Unknown error'\n              const href = `#${name}`\n\n              errors.push({ path, href, name, text })\n            }\n          }\n        }\n      })\n\n      return errors\n    }\n  }\n\n  getViewModel(\n    request: FormContextRequest,\n    context: FormContext\n  ): FeaturedFormPageViewModel {\n    const { fileUpload } = this\n    const { state } = context\n\n    const upload = this.getUploadFromState(state)\n\n    const viewModel = super.getViewModel(request, context)\n    const { components } = viewModel\n\n    // Featured form component\n    const [formComponent] = components.filter(\n      ({ model }) => model.id === fileUpload.name\n    )\n\n    const index = components.indexOf(formComponent)\n\n    const proxyUrl = getProxyUrlForLocalDevelopment(upload?.uploadUrl)\n\n    return {\n      ...viewModel,\n      formAction: upload?.uploadUrl,\n      uploadId: upload?.uploadId,\n      formComponent,\n\n      // Split out components before/after\n      componentsBefore: components.slice(0, index),\n      components: components.slice(index),\n      proxyUrl\n    }\n  }\n\n  /**\n   * Refreshes the CDP upload and files in the\n   * state and checks for any removed files.\n   *\n   * If an upload exists and hasn't been consumed\n   * it gets re-used, otherwise we initiate a new one.\n   * @param request - the hapi request\n   * @param state - the form state\n   */\n  private async refreshUpload(\n    request: FormRequest | FormRequestPayload,\n    state: FormSubmissionState\n  ) {\n    state = await this.checkUploadStatus(request, state)\n\n    return state\n  }\n\n  /**\n   * If an upload exists and hasn't been consumed\n   * it gets re-used, otherwise a new one is initiated.\n   * @param request - the hapi request\n   * @param state - the form state\n   * @param depth - the number of retries so far\n   */\n  private async checkUploadStatus(\n    request: FormRequest | FormRequestPayload,\n    state: FormSubmissionState,\n    depth = 1\n  ): Promise<FormSubmissionState> {\n    const upload = this.getUploadFromState(state)\n    const files = this.getFilesFromState(state)\n\n    // If no upload exists, initiate a new one.\n    if (!upload?.uploadId) {\n      return this.initiateAndStoreNewUpload(request, state)\n    }\n\n    const uploadId = upload.uploadId\n    const statusResponse = await getUploadStatus(uploadId)\n    if (!statusResponse) {\n      throw Boom.badRequest(\n        `Unexpected empty response from getUploadStatus for ${uploadId}`\n      )\n    }\n\n    // Re-use the upload if it is still in the \"initiated\" state.\n    if (statusResponse.uploadStatus === UploadStatus.initiated) {\n      return state\n    }\n\n    if (statusResponse.uploadStatus === UploadStatus.pending) {\n      // Using exponential backoff delays:\n      // Depth 1: 2000ms, Depth 2: 4000ms, Depth 3: 8000ms, Depth 4: 16000ms, Depth 5+: 30000ms (capped)\n      // A depth of 5 (or more) implies cumulative delays roughly reaching 55 seconds.\n      if (depth >= 5) {\n        const error = new Error(\n          `Exceeded cumulative retry delay for ${uploadId} (depth: ${depth}). Re-initiating a new upload.`\n        )\n        request.logger.error(\n          error,\n          `[uploadTimeout] Exceeded cumulative retry delay for uploadId: ${uploadId} at depth: ${depth} - re-initiating new upload`\n        )\n        await this.initiateAndStoreNewUpload(request, state)\n        throw Boom.gatewayTimeout(\n          `Timed out waiting for ${uploadId} after cumulative retries exceeding ${((CDP_UPLOAD_TIMEOUT_MS - 5000) / 1000).toFixed(0)} seconds`\n        )\n      }\n      const delay = getExponentialBackoffDelay(depth)\n      request.logger.info(\n        `[uploadRetry] Waiting ${delay / 1000} seconds for uploadId: ${uploadId} to complete (retry depth: ${depth})`\n      )\n      await wait(delay)\n      return this.checkUploadStatus(request, state, depth + 1)\n    }\n\n    // Only add to files state if the file validates.\n    // This secures against html tampering of the file input\n    // by adding a 'multiple' attribute or it being\n    // changed to a simple text field or similar.\n    const validationResult = tempItemSchema.validate(\n      { uploadId, status: statusResponse },\n      { stripUnknown: true }\n    )\n    const error = validationResult.error\n    const fileState = validationResult.value as FileState\n\n    if (error) {\n      return this.initiateAndStoreNewUpload(request, state)\n    }\n\n    const file = fileState.status.form.file\n    if (file.fileStatus === FileStatus.complete) {\n      files.unshift(prepareFileState(fileState))\n      await this.mergeState(request, state, {\n        upload: { [this.path]: { files, upload } }\n      })\n    } else {\n      // Flash the error message.\n      const { fileUpload } = this\n      const cacheService = getCacheService(request.server)\n      const name = fileUpload.name\n      const text = file.errorMessage ?? 'Unknown error'\n      const errors: FormSubmissionError[] = [\n        { path: [name], href: `#${name}`, name, text }\n      ]\n      cacheService.setFlash(request, { errors })\n    }\n\n    return this.initiateAndStoreNewUpload(request, state)\n  }\n\n  /**\n   * Checks the payload for a file getting removed\n   * and removes it from the upload files if found\n   * @param request - the hapi request\n   * @param state - the form state\n   * @returns updated state if any files have been removed\n   */\n  private async checkRemovedFiles(\n    request: FormRequestPayload,\n    state: FormSubmissionState\n  ) {\n    const { path } = this\n    const { params } = request\n\n    const upload = this.getUploadFromState(state)\n    const files = this.getFilesFromState(state)\n\n    const filesUpdated = files.filter(\n      ({ uploadId }) => uploadId !== params.itemId\n    )\n\n    if (filesUpdated.length === files.length) {\n      return\n    }\n\n    await this.mergeState(request, state, {\n      upload: { [path]: { files: filesUpdated, upload } }\n    })\n  }\n\n  /**\n   * Initiates a CDP file upload and stores in the upload state\n   * @param request - the hapi request\n   * @param state - the form state\n   */\n  private async initiateAndStoreNewUpload(\n    request: FormRequest | FormRequestPayload,\n    state: FormSubmissionState\n  ) {\n    const { fileUpload, href, path } = this\n    const { options, schema } = fileUpload\n\n    const files = this.getFilesFromState(state)\n\n    // Reset the upload in state\n    let upload: UploadInitiateResponse | undefined\n\n    // Don't initiate anymore after minimum of `schema.max` or MAX_UPLOADS\n    const max = Math.min(schema.max ?? MAX_UPLOADS, MAX_UPLOADS)\n\n    if (files.length < max) {\n      const outputEmail =\n        this.model.def.outputEmail ?? 'defraforms@defra.gov.uk'\n\n      const newUpload = await initiateUpload(href, outputEmail, options.accept)\n\n      if (newUpload === undefined) {\n        throw Boom.badRequest('Unexpected empty response from initiateUpload')\n      }\n\n      upload = newUpload\n    }\n\n    return this.mergeState(request, state, {\n      upload: { [path]: { files, upload } }\n    })\n  }\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAA6B,oBAAoB;AACvE,OAAOC,IAAI,MAAM,YAAY;AAE7B,SAASC,IAAI,QAAQ,YAAY;AAGjC,SACEC,cAAc;AAGhB,SACEC,eAAe,EACfC,QAAQ,EACRC,0BAA0B;AAG5B,SAASC,sBAAsB;AAC/B,SAASC,8BAA8B;AACvC,SACEC,eAAe,EACfC,cAAc;AAEhB,SACEC,UAAU,EACVC,YAAY;AAgBd,MAAMC,WAAW,GAAG,EAAE;AACtB,MAAMC,qBAAqB,GAAG,KAAK,EAAC;;AAEpC,OAAO,SAASC,aAAaA,CAACC,MAAgC,EAAE;EAC9D,MAAMC,IAAI,GAAGD,MAAM,CAACE,IAAI,CAACD,IAAI;EAC7B,MAAME,SAAS,GAAGF,IAAI,CAACG,UAAU,KAAKT,UAAU,CAACU,OAAO;EAExD,IAAI,CAACJ,IAAI,CAACK,YAAY,IAAIH,SAAS,EAAE;IACnCF,IAAI,CAACK,YAAY,GAAG,0CAA0C;EAChE;EAEA,OAAON,MAAM;AACf;AAEA,SAASO,gBAAgBA,CAACC,SAAoB,EAAE;EAC9CT,aAAa,CAACS,SAAS,CAACR,MAAM,CAAC;EAE/B,OAAOQ,SAAS;AAClB;AAEA,OAAO,MAAMC,wBAAwB,SAASlB,sBAAsB,CAAC;EAGnEmB,UAAU;EACVC,kBAAkB,GAAG,aAAa;EAElCC,WAAWA,CAACC,KAAgB,EAAEC,OAAuB,EAAE;IACrD,KAAK,CAACD,KAAK,EAAEC,OAAO,CAAC;IAErB,MAAM;MAAEC;IAAW,CAAC,GAAG,IAAI;;IAE3B;IACA,MAAMC,WAAW,GAAGD,UAAU,CAACE,MAAM,CAACC,MAAM,CACzCC,KAAK,IACJA,KAAK,CAACC,IAAI,KAAKpC,aAAa,CAACqC,eACjC,CAAC;IAED,MAAMX,UAAU,GAAGM,WAAW,CAACM,EAAE,CAAC,CAAC,CAAC;;IAEpC;IACA,IAAI,CAACZ,UAAU,IAAIM,WAAW,CAACO,MAAM,GAAG,CAAC,EAAE;MACzC,MAAMtC,IAAI,CAACuC,iBAAiB,CAC1B,oEAAoEV,OAAO,CAACW,IAAI,GAClF,CAAC;IACH;;IAEA;IACA,IAAIV,UAAU,CAACE,MAAM,CAACS,OAAO,CAAChB,UAAU,CAAC,KAAK,CAAC,EAAE;MAC/C,MAAMzB,IAAI,CAACuC,iBAAiB,CAC1B,aAAad,UAAU,CAACiB,IAAI,iEAAiEb,OAAO,CAACW,IAAI,GAC3G,CAAC;IACH;;IAEA;IACA,IAAI,CAACf,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACkB,QAAQ,GAAG,aAAa;EAC/B;EAEAC,oBAAoBA,CAClBC,OAAuC,EACvCC,KAA0B,EAC1B;IACA,MAAM;MAAErB;IAAW,CAAC,GAAG,IAAI;IAE3B,MAAMsB,OAAO,GAAG,KAAK,CAACH,oBAAoB,CAACC,OAAO,EAAEC,KAAK,CAAC;IAC1D,MAAME,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;;IAE3C;IACAC,OAAO,CAACtB,UAAU,CAACiB,IAAI,CAAC,GAAGM,KAAK,CAACV,MAAM,GAAGU,KAAK,GAAGE,SAAS;IAE3D,OAAOH,OAAO;EAChB;EAEA,MAAMI,QAAQA,CAACN,OAAyC,EAAE;IACxD,MAAM;MAAEpB;IAAW,CAAC,GAAG,IAAI;;IAE3B;IACA,MAAMqB,KAAK,GAAG,MAAM,KAAK,CAACK,QAAQ,CAACN,OAAO,CAAC;IAC3C,MAAMG,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;;IAE3C;IACAA,KAAK,CAACrB,UAAU,CAACiB,IAAI,CAAC,GAAGM,KAAK;IAE9B,OAAO,IAAI,CAACI,aAAa,CAACP,OAAO,EAAEC,KAAK,CAAC;EAC3C;;EAEA;AACF;AACA;EACEG,iBAAiBA,CAACH,KAA0B,EAAE;IAC5C,MAAM;MAAEN;IAAK,CAAC,GAAG,IAAI;IAErB,MAAMa,WAAW,GAAGP,KAAK,CAACQ,MAAM,GAAGd,IAAI,CAAC;IACxC,OAAOa,WAAW,EAAEL,KAAK,IAAI,EAAE;EACjC;;EAEA;AACF;AACA;EACEO,kBAAkBA,CAACT,KAA0B,EAAE;IAC7C,MAAM;MAAEN;IAAK,CAAC,GAAG,IAAI;IAErB,MAAMa,WAAW,GAAGP,KAAK,CAACQ,MAAM,GAAGd,IAAI,CAAC;IACxC,OAAOa,WAAW,EAAEC,MAAM;EAC5B;EAEAE,6BAA6BA,CAAA,EAAG;IAC9B,OAAO,CACLX,OAAoB,EACpBY,OAAoB,EACpBC,CAA6C,KAC1C;MACH,MAAM;QAAEC;MAAU,CAAC,GAAG,IAAI;MAC1B,MAAM;QAAEC;MAAO,CAAC,GAAGf,OAAO;MAC1B,MAAM;QAAEC;MAAM,CAAC,GAAGW,OAAO;MAEzB,MAAMT,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;MAE3C,MAAMe,YAAY,GAAGb,KAAK,CAACc,IAAI,CAC7B,CAAC;QAAEC;MAAS,CAAC,KAAKA,QAAQ,KAAKH,MAAM,CAACI,MACxC,CAAC;MAED,IAAI,CAACH,YAAY,EAAE;QACjB,MAAM7D,IAAI,CAACiE,QAAQ,CAAC,0BAA0B,CAAC;MACjD;MAEA,MAAM;QAAEC;MAAS,CAAC,GAAGL,YAAY,CAAC9C,MAAM,CAACE,IAAI,CAACD,IAAI;MAElD,OAAO0C,CAAC,CAACS,IAAI,CAAC,IAAI,CAACzC,kBAAkB,EAAE;QACrC,GAAGiC,SAAS;QACZF,OAAO;QACPW,QAAQ,EAAE,IAAI,CAACC,WAAW,CAACxB,OAAO,EAAEY,OAAO,CAAC;QAC5Ca,SAAS,EAAE,4CAA4C;QACvDC,SAAS,EAAEL,QAAQ;QACnBM,YAAY,EAAE;UAAEC,IAAI,EAAE;QAAoC,CAAC;QAC3DC,aAAa,EAAE;UAAED,IAAI,EAAE;QAAc,CAAC;QACtCE,YAAY,EAAE;UAAEF,IAAI,EAAE;QAAS;MACjC,CAAmC,CAAC;IACtC,CAAC;EACH;EAEAG,8BAA8BA,CAAA,EAAG;IAC/B,OAAO,OACL/B,OAA2B,EAC3BY,OAAoB,EACpBC,CAA6C,KAC1C;MACH,MAAM;QAAElB;MAAK,CAAC,GAAG,IAAI;MACrB,MAAM;QAAEM;MAAM,CAAC,GAAGW,OAAO;MAEzB,MAAM;QAAEoB;MAAQ,CAAC,GAAG,IAAI,CAACC,aAAa,CAACjC,OAAO,CAAC;;MAE/C;MACA,IAAIgC,OAAO,EAAE;QACX,MAAM,IAAI,CAACE,iBAAiB,CAAClC,OAAO,EAAEC,KAAK,CAAC;QAC5C,OAAO,IAAI,CAACkC,OAAO,CAACnC,OAAO,EAAEa,CAAC,EAAElB,IAAI,CAAC;MACvC;MAEA,OAAO,IAAI,CAACwC,OAAO,CAACnC,OAAO,EAAEa,CAAC,CAAC;IACjC,CAAC;EACH;EAEAuB,SAASA,CAACC,OAA+B,EAAE;IACzC,MAAM;MAAEzD;IAAW,CAAC,GAAG,IAAI;IAE3B,IAAIyD,OAAO,EAAE;MACX,MAAMC,MAA6B,GAAG,EAAE;MAExCD,OAAO,CAACE,OAAO,CAAEC,KAAK,IAAK;QACzB,MAAMC,aAAa,GAAGD,KAAK,CAAC7C,IAAI,CAAC,CAAC,CAAC,KAAKf,UAAU,CAACiB,IAAI;QACvD,MAAM6C,iBAAiB,GAAGD,aAAa,IAAID,KAAK,CAAC7C,IAAI,CAACF,MAAM,KAAK,CAAC;QAElE,IAAI,CAACgD,aAAa,IAAIC,iBAAiB,EAAE;UACvC;UACA;UACAJ,MAAM,CAACK,IAAI,CAACpF,QAAQ,CAACiF,KAAK,CAAC,CAAC;QAC9B,CAAC,MAAM;UACL,MAAM;YAAE5B,OAAO;YAAEjB,IAAI;YAAEL;UAAK,CAAC,GAAGkD,KAAK;UAErC,IAAIlD,IAAI,KAAK,gBAAgB,IAAIK,IAAI,CAACH,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,cAAc,EAAE;YAC/D,MAAMoD,KAAK,GAAGhC,OAAO,EAAEgC,KAA2B;YAElD,IAAIA,KAAK,EAAE;cACT,MAAM/C,IAAI,GAAGjB,UAAU,CAACiB,IAAI;cAC5B,MAAM+B,IAAI,GAAG,OAAOgB,KAAK,KAAK,QAAQ,GAAGA,KAAK,GAAG,eAAe;cAChE,MAAMC,IAAI,GAAG,IAAIhD,IAAI,EAAE;cAEvByC,MAAM,CAACK,IAAI,CAAC;gBAAEhD,IAAI;gBAAEkD,IAAI;gBAAEhD,IAAI;gBAAE+B;cAAK,CAAC,CAAC;YACzC;UACF;QACF;MACF,CAAC,CAAC;MAEF,OAAOU,MAAM;IACf;EACF;EAEAQ,YAAYA,CACV9C,OAA2B,EAC3BY,OAAoB,EACO;IAC3B,MAAM;MAAEhC;IAAW,CAAC,GAAG,IAAI;IAC3B,MAAM;MAAEqB;IAAM,CAAC,GAAGW,OAAO;IAEzB,MAAMH,MAAM,GAAG,IAAI,CAACC,kBAAkB,CAACT,KAAK,CAAC;IAE7C,MAAMa,SAAS,GAAG,KAAK,CAACgC,YAAY,CAAC9C,OAAO,EAAEY,OAAO,CAAC;IACtD,MAAM;MAAEmC;IAAW,CAAC,GAAGjC,SAAS;;IAEhC;IACA,MAAM,CAACkC,aAAa,CAAC,GAAGD,UAAU,CAAC3D,MAAM,CACvC,CAAC;MAAEL;IAAM,CAAC,KAAKA,KAAK,CAACkE,EAAE,KAAKrE,UAAU,CAACiB,IACzC,CAAC;IAED,MAAMqD,KAAK,GAAGH,UAAU,CAACnD,OAAO,CAACoD,aAAa,CAAC;IAE/C,MAAMG,QAAQ,GAAGzF,8BAA8B,CAAC+C,MAAM,EAAE2C,SAAS,CAAC;IAElE,OAAO;MACL,GAAGtC,SAAS;MACZuC,UAAU,EAAE5C,MAAM,EAAE2C,SAAS;MAC7BlC,QAAQ,EAAET,MAAM,EAAES,QAAQ;MAC1B8B,aAAa;MAEb;MACAM,gBAAgB,EAAEP,UAAU,CAACQ,KAAK,CAAC,CAAC,EAAEL,KAAK,CAAC;MAC5CH,UAAU,EAAEA,UAAU,CAACQ,KAAK,CAACL,KAAK,CAAC;MACnCC;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAc5C,aAAaA,CACzBP,OAAyC,EACzCC,KAA0B,EAC1B;IACAA,KAAK,GAAG,MAAM,IAAI,CAACuD,iBAAiB,CAACxD,OAAO,EAAEC,KAAK,CAAC;IAEpD,OAAOA,KAAK;EACd;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAcuD,iBAAiBA,CAC7BxD,OAAyC,EACzCC,KAA0B,EAC1BwD,KAAK,GAAG,CAAC,EACqB;IAC9B,MAAMhD,MAAM,GAAG,IAAI,CAACC,kBAAkB,CAACT,KAAK,CAAC;IAC7C,MAAME,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;;IAE3C;IACA,IAAI,CAACQ,MAAM,EAAES,QAAQ,EAAE;MACrB,OAAO,IAAI,CAACwC,yBAAyB,CAAC1D,OAAO,EAAEC,KAAK,CAAC;IACvD;IAEA,MAAMiB,QAAQ,GAAGT,MAAM,CAACS,QAAQ;IAChC,MAAMyC,cAAc,GAAG,MAAMhG,eAAe,CAACuD,QAAQ,CAAC;IACtD,IAAI,CAACyC,cAAc,EAAE;MACnB,MAAMxG,IAAI,CAACyG,UAAU,CACnB,sDAAsD1C,QAAQ,EAChE,CAAC;IACH;;IAEA;IACA,IAAIyC,cAAc,CAACE,YAAY,KAAK/F,YAAY,CAACgG,SAAS,EAAE;MAC1D,OAAO7D,KAAK;IACd;IAEA,IAAI0D,cAAc,CAACE,YAAY,KAAK/F,YAAY,CAACS,OAAO,EAAE;MACxD;MACA;MACA;MACA,IAAIkF,KAAK,IAAI,CAAC,EAAE;QACd,MAAMjB,KAAK,GAAG,IAAIuB,KAAK,CACrB,uCAAuC7C,QAAQ,YAAYuC,KAAK,gCAClE,CAAC;QACDzD,OAAO,CAACgE,MAAM,CAACxB,KAAK,CAClBA,KAAK,EACL,iEAAiEtB,QAAQ,cAAcuC,KAAK,6BAC9F,CAAC;QACD,MAAM,IAAI,CAACC,yBAAyB,CAAC1D,OAAO,EAAEC,KAAK,CAAC;QACpD,MAAM9C,IAAI,CAAC8G,cAAc,CACvB,yBAAyB/C,QAAQ,uCAAuC,CAAC,CAAClD,qBAAqB,GAAG,IAAI,IAAI,IAAI,EAAEkG,OAAO,CAAC,CAAC,CAAC,UAC5H,CAAC;MACH;MACA,MAAMC,KAAK,GAAG3G,0BAA0B,CAACiG,KAAK,CAAC;MAC/CzD,OAAO,CAACgE,MAAM,CAACI,IAAI,CACjB,yBAAyBD,KAAK,GAAG,IAAI,0BAA0BjD,QAAQ,8BAA8BuC,KAAK,GAC5G,CAAC;MACD,MAAMrG,IAAI,CAAC+G,KAAK,CAAC;MACjB,OAAO,IAAI,CAACX,iBAAiB,CAACxD,OAAO,EAAEC,KAAK,EAAEwD,KAAK,GAAG,CAAC,CAAC;IAC1D;;IAEA;IACA;IACA;IACA;IACA,MAAMY,gBAAgB,GAAGhH,cAAc,CAACiH,QAAQ,CAC9C;MAAEpD,QAAQ;MAAEhD,MAAM,EAAEyF;IAAe,CAAC,EACpC;MAAEY,YAAY,EAAE;IAAK,CACvB,CAAC;IACD,MAAM/B,KAAK,GAAG6B,gBAAgB,CAAC7B,KAAK;IACpC,MAAM9D,SAAS,GAAG2F,gBAAgB,CAACzB,KAAkB;IAErD,IAAIJ,KAAK,EAAE;MACT,OAAO,IAAI,CAACkB,yBAAyB,CAAC1D,OAAO,EAAEC,KAAK,CAAC;IACvD;IAEA,MAAM9B,IAAI,GAAGO,SAAS,CAACR,MAAM,CAACE,IAAI,CAACD,IAAI;IACvC,IAAIA,IAAI,CAACG,UAAU,KAAKT,UAAU,CAAC2G,QAAQ,EAAE;MAC3CrE,KAAK,CAACsE,OAAO,CAAChG,gBAAgB,CAACC,SAAS,CAAC,CAAC;MAC1C,MAAM,IAAI,CAACgG,UAAU,CAAC1E,OAAO,EAAEC,KAAK,EAAE;QACpCQ,MAAM,EAAE;UAAE,CAAC,IAAI,CAACd,IAAI,GAAG;YAAEQ,KAAK;YAAEM;UAAO;QAAE;MAC3C,CAAC,CAAC;IACJ,CAAC,MAAM;MACL;MACA,MAAM;QAAE7B;MAAW,CAAC,GAAG,IAAI;MAC3B,MAAM+F,YAAY,GAAGrH,eAAe,CAAC0C,OAAO,CAAC4E,MAAM,CAAC;MACpD,MAAM/E,IAAI,GAAGjB,UAAU,CAACiB,IAAI;MAC5B,MAAM+B,IAAI,GAAGzD,IAAI,CAACK,YAAY,IAAI,eAAe;MACjD,MAAM8D,MAA6B,GAAG,CACpC;QAAE3C,IAAI,EAAE,CAACE,IAAI,CAAC;QAAEgD,IAAI,EAAE,IAAIhD,IAAI,EAAE;QAAEA,IAAI;QAAE+B;MAAK,CAAC,CAC/C;MACD+C,YAAY,CAACE,QAAQ,CAAC7E,OAAO,EAAE;QAAEsC;MAAO,CAAC,CAAC;IAC5C;IAEA,OAAO,IAAI,CAACoB,yBAAyB,CAAC1D,OAAO,EAAEC,KAAK,CAAC;EACvD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAciC,iBAAiBA,CAC7BlC,OAA2B,EAC3BC,KAA0B,EAC1B;IACA,MAAM;MAAEN;IAAK,CAAC,GAAG,IAAI;IACrB,MAAM;MAAEoB;IAAO,CAAC,GAAGf,OAAO;IAE1B,MAAMS,MAAM,GAAG,IAAI,CAACC,kBAAkB,CAACT,KAAK,CAAC;IAC7C,MAAME,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;IAE3C,MAAM6E,YAAY,GAAG3E,KAAK,CAACf,MAAM,CAC/B,CAAC;MAAE8B;IAAS,CAAC,KAAKA,QAAQ,KAAKH,MAAM,CAACI,MACxC,CAAC;IAED,IAAI2D,YAAY,CAACrF,MAAM,KAAKU,KAAK,CAACV,MAAM,EAAE;MACxC;IACF;IAEA,MAAM,IAAI,CAACiF,UAAU,CAAC1E,OAAO,EAAEC,KAAK,EAAE;MACpCQ,MAAM,EAAE;QAAE,CAACd,IAAI,GAAG;UAAEQ,KAAK,EAAE2E,YAAY;UAAErE;QAAO;MAAE;IACpD,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAciD,yBAAyBA,CACrC1D,OAAyC,EACzCC,KAA0B,EAC1B;IACA,MAAM;MAAErB,UAAU;MAAEiE,IAAI;MAAElD;IAAK,CAAC,GAAG,IAAI;IACvC,MAAM;MAAEoF,OAAO;MAAEC;IAAO,CAAC,GAAGpG,UAAU;IAEtC,MAAMuB,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;;IAE3C;IACA,IAAIQ,MAA0C;;IAE9C;IACA,MAAMwE,GAAG,GAAGC,IAAI,CAACC,GAAG,CAACH,MAAM,CAACC,GAAG,IAAIlH,WAAW,EAAEA,WAAW,CAAC;IAE5D,IAAIoC,KAAK,CAACV,MAAM,GAAGwF,GAAG,EAAE;MACtB,MAAMG,WAAW,GACf,IAAI,CAACrG,KAAK,CAACsG,GAAG,CAACD,WAAW,IAAI,yBAAyB;MAEzD,MAAME,SAAS,GAAG,MAAM1H,cAAc,CAACiF,IAAI,EAAEuC,WAAW,EAAEL,OAAO,CAACQ,MAAM,CAAC;MAEzE,IAAID,SAAS,KAAKjF,SAAS,EAAE;QAC3B,MAAMlD,IAAI,CAACyG,UAAU,CAAC,+CAA+C,CAAC;MACxE;MAEAnD,MAAM,GAAG6E,SAAS;IACpB;IAEA,OAAO,IAAI,CAACZ,UAAU,CAAC1E,OAAO,EAAEC,KAAK,EAAE;MACrCQ,MAAM,EAAE;QAAE,CAACd,IAAI,GAAG;UAAEQ,KAAK;UAAEM;QAAO;MAAE;IACtC,CAAC,CAAC;EACJ;AACF","ignoreList":[]}
+{"version":3,"file":"FileUploadPageController.js","names":["ComponentType","Boom","wait","tempItemSchema","getCacheService","getError","getExponentialBackoffDelay","QuestionPageController","getProxyUrlForLocalDevelopment","getUploadStatus","initiateUpload","FileStatus","UploadStatus","MAX_UPLOADS","CDP_UPLOAD_TIMEOUT_MS","prepareStatus","status","file","form","isPending","fileStatus","pending","errorMessage","prepareFileState","fileState","FileUploadPageController","fileUpload","fileDeleteViewName","constructor","model","pageDef","collection","fileUploads","fields","filter","field","type","FileUploadField","at","length","badImplementation","path","indexOf","name","viewName","getFormDataFromState","request","state","payload","files","getFilesFromState","undefined","getState","refreshUpload","uploadState","upload","getUploadFromState","makeGetItemDeleteRouteHandler","context","h","viewModel","params","fileToRemove","find","uploadId","itemId","notFound","filename","view","backLink","getBackLink","pageTitle","itemTitle","confirmation","text","buttonConfirm","buttonCancel","makePostItemDeleteRouteHandler","confirm","getFormParams","checkRemovedFiles","proceed","getErrors","details","errors","forEach","error","isUploadError","isUploadRootError","push","value","href","getViewModel","components","formComponent","id","index","proxyUrl","uploadUrl","formAction","componentsBefore","slice","checkUploadStatus","depth","initiateAndStoreNewUpload","statusResponse","badRequest","uploadStatus","initiated","Error","logger","gatewayTimeout","toFixed","delay","info","validationResult","validate","stripUnknown","complete","unshift","mergeState","cacheService","server","setFlash","filesUpdated","options","schema","max","Math","min","outputEmail","def","newUpload","accept"],"sources":["../../../../../src/server/plugins/engine/pageControllers/FileUploadPageController.ts"],"sourcesContent":["import { ComponentType, type PageFileUpload } from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { wait } from '@hapi/hoek'\nimport { type ValidationErrorItem } from 'joi'\n\nimport {\n  tempItemSchema,\n  type FileUploadField\n} from '~/src/server/plugins/engine/components/FileUploadField.js'\nimport {\n  getCacheService,\n  getError,\n  getExponentialBackoffDelay\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'\nimport { getProxyUrlForLocalDevelopment } from '~/src/server/plugins/engine/pageControllers/helpers/index.js'\nimport {\n  getUploadStatus,\n  initiateUpload\n} from '~/src/server/plugins/engine/services/uploadService.js'\nimport {\n  FileStatus,\n  UploadStatus,\n  type AnyFormRequest,\n  type FeaturedFormPageViewModel,\n  type FileState,\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionError,\n  type FormSubmissionState,\n  type ItemDeletePageViewModel,\n  type UploadInitiateResponse,\n  type UploadStatusFileResponse\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload,\n  type FormResponseToolkit\n} from '~/src/server/routes/types.js'\n\nconst MAX_UPLOADS = 25\nconst CDP_UPLOAD_TIMEOUT_MS = 60000 // 1 minute\n\nexport function prepareStatus(status: UploadStatusFileResponse) {\n  const file = status.form.file\n  const isPending = file.fileStatus === FileStatus.pending\n\n  if (!file.errorMessage && isPending) {\n    file.errorMessage = 'The selected file has not fully uploaded'\n  }\n\n  return status\n}\n\nfunction prepareFileState(fileState: FileState) {\n  prepareStatus(fileState.status)\n\n  return fileState\n}\n\nexport class FileUploadPageController extends QuestionPageController {\n  declare pageDef: PageFileUpload\n\n  fileUpload: FileUploadField\n  fileDeleteViewName = 'item-delete'\n\n  constructor(model: FormModel, pageDef: PageFileUpload) {\n    super(model, pageDef)\n\n    const { collection } = this\n\n    // Get the file upload fields from the collection\n    const fileUploads = collection.fields.filter(\n      (field): field is FileUploadField =>\n        field.type === ComponentType.FileUploadField\n    )\n\n    const fileUpload = fileUploads.at(0)\n\n    // Assert we have exactly 1 file upload component\n    if (!fileUpload || fileUploads.length > 1) {\n      throw Boom.badImplementation(\n        `Expected 1 FileUploadFieldComponent in FileUploadPageController '${pageDef.path}'`\n      )\n    }\n\n    // Assert the file upload component is the first form component\n    if (collection.fields.indexOf(fileUpload) !== 0) {\n      throw Boom.badImplementation(\n        `Expected '${fileUpload.name}' to be the first form component in FileUploadPageController '${pageDef.path}'`\n      )\n    }\n\n    // Assign the file upload component to the controller\n    this.fileUpload = fileUpload\n    this.viewName = 'file-upload'\n  }\n\n  getFormDataFromState(\n    request: FormContextRequest | undefined,\n    state: FormSubmissionState\n  ) {\n    const { fileUpload } = this\n\n    const payload = super.getFormDataFromState(request, state)\n    const files = this.getFilesFromState(state)\n\n    // Append the files to the payload\n    payload[fileUpload.name] = files.length ? files : undefined\n\n    return payload\n  }\n\n  async getState(request: AnyFormRequest) {\n    const { fileUpload } = this\n\n    // Get the actual state\n    const state = await super.getState(request)\n    const files = this.getFilesFromState(state)\n\n    // Overwrite the files with those in the upload state\n    state[fileUpload.name] = files\n\n    return this.refreshUpload(request, state)\n  }\n\n  /**\n   * Get the uploaded files from state.\n   */\n  getFilesFromState(state: FormSubmissionState) {\n    const { path } = this\n\n    const uploadState = state.upload?.[path]\n    return uploadState?.files ?? []\n  }\n\n  /**\n   * Get the initiated upload from state.\n   */\n  getUploadFromState(state: FormSubmissionState) {\n    const { path } = this\n\n    const uploadState = state.upload?.[path]\n    return uploadState?.upload\n  }\n\n  makeGetItemDeleteRouteHandler() {\n    return (\n      request: FormRequest,\n      context: FormContext,\n      h: FormResponseToolkit\n    ) => {\n      const { viewModel } = this\n      const { params } = request\n      const { state } = context\n\n      const files = this.getFilesFromState(state)\n\n      const fileToRemove = files.find(\n        ({ uploadId }) => uploadId === params.itemId\n      )\n\n      if (!fileToRemove) {\n        throw Boom.notFound('File to delete not found')\n      }\n\n      const { filename } = fileToRemove.status.form.file\n\n      return h.view(this.fileDeleteViewName, {\n        ...viewModel,\n        context,\n        backLink: this.getBackLink(request, context),\n        pageTitle: `Are you sure you want to remove this file?`,\n        itemTitle: filename,\n        confirmation: { text: 'You cannot recover removed files.' },\n        buttonConfirm: { text: 'Remove file' },\n        buttonCancel: { text: 'Cancel' }\n      } satisfies ItemDeletePageViewModel)\n    }\n  }\n\n  makePostItemDeleteRouteHandler() {\n    return async (\n      request: FormRequestPayload,\n      context: FormContext,\n      h: FormResponseToolkit\n    ) => {\n      const { path } = this\n      const { state } = context\n\n      const { confirm } = this.getFormParams(request)\n\n      // Check for any removed files in the POST payload\n      if (confirm) {\n        await this.checkRemovedFiles(request, state)\n        return this.proceed(request, h, path)\n      }\n\n      return this.proceed(request, h)\n    }\n  }\n\n  getErrors(details?: ValidationErrorItem[]) {\n    const { fileUpload } = this\n\n    if (details) {\n      const errors: FormSubmissionError[] = []\n\n      details.forEach((error) => {\n        const isUploadError = error.path[0] === fileUpload.name\n        const isUploadRootError = isUploadError && error.path.length === 1\n\n        if (!isUploadError || isUploadRootError) {\n          // The error is for the root of the upload or another\n          // field on the page so defer to the getError helper\n          errors.push(getError(error))\n        } else {\n          const { context, path, type } = error\n\n          if (type === 'object.unknown' && path.at(-1) === 'errorMessage') {\n            const value = context?.value as string | undefined\n\n            if (value) {\n              const name = fileUpload.name\n              const text = typeof value === 'string' ? value : 'Unknown error'\n              const href = `#${name}`\n\n              errors.push({ path, href, name, text })\n            }\n          }\n        }\n      })\n\n      return errors\n    }\n  }\n\n  getViewModel(\n    request: FormContextRequest,\n    context: FormContext\n  ): FeaturedFormPageViewModel {\n    const { fileUpload } = this\n    const { state } = context\n\n    const upload = this.getUploadFromState(state)\n\n    const viewModel = super.getViewModel(request, context)\n    const { components } = viewModel\n\n    // Featured form component\n    const [formComponent] = components.filter(\n      ({ model }) => model.id === fileUpload.name\n    )\n\n    const index = components.indexOf(formComponent)\n\n    const proxyUrl = getProxyUrlForLocalDevelopment(upload?.uploadUrl)\n\n    return {\n      ...viewModel,\n      formAction: upload?.uploadUrl,\n      uploadId: upload?.uploadId,\n      formComponent,\n\n      // Split out components before/after\n      componentsBefore: components.slice(0, index),\n      components: components.slice(index),\n      proxyUrl\n    }\n  }\n\n  /**\n   * Refreshes the CDP upload and files in the\n   * state and checks for any removed files.\n   *\n   * If an upload exists and hasn't been consumed\n   * it gets re-used, otherwise we initiate a new one.\n   * @param request - the hapi request\n   * @param state - the form state\n   */\n  private async refreshUpload(\n    request: AnyFormRequest,\n    state: FormSubmissionState\n  ) {\n    state = await this.checkUploadStatus(request, state)\n\n    return state\n  }\n\n  /**\n   * If an upload exists and hasn't been consumed\n   * it gets re-used, otherwise a new one is initiated.\n   * @param request - the hapi request\n   * @param state - the form state\n   * @param depth - the number of retries so far\n   */\n  private async checkUploadStatus(\n    request: AnyFormRequest,\n    state: FormSubmissionState,\n    depth = 1\n  ): Promise<FormSubmissionState> {\n    const upload = this.getUploadFromState(state)\n    const files = this.getFilesFromState(state)\n\n    // If no upload exists, initiate a new one.\n    if (!upload?.uploadId) {\n      return this.initiateAndStoreNewUpload(request, state)\n    }\n\n    const uploadId = upload.uploadId\n    const statusResponse = await getUploadStatus(uploadId)\n    if (!statusResponse) {\n      throw Boom.badRequest(\n        `Unexpected empty response from getUploadStatus for ${uploadId}`\n      )\n    }\n\n    // Re-use the upload if it is still in the \"initiated\" state.\n    if (statusResponse.uploadStatus === UploadStatus.initiated) {\n      return state\n    }\n\n    if (statusResponse.uploadStatus === UploadStatus.pending) {\n      // Using exponential backoff delays:\n      // Depth 1: 2000ms, Depth 2: 4000ms, Depth 3: 8000ms, Depth 4: 16000ms, Depth 5+: 30000ms (capped)\n      // A depth of 5 (or more) implies cumulative delays roughly reaching 55 seconds.\n      if (depth >= 5) {\n        const error = new Error(\n          `Exceeded cumulative retry delay for ${uploadId} (depth: ${depth}). Re-initiating a new upload.`\n        )\n        request.logger.error(\n          error,\n          `[uploadTimeout] Exceeded cumulative retry delay for uploadId: ${uploadId} at depth: ${depth} - re-initiating new upload`\n        )\n        await this.initiateAndStoreNewUpload(request, state)\n        throw Boom.gatewayTimeout(\n          `Timed out waiting for ${uploadId} after cumulative retries exceeding ${((CDP_UPLOAD_TIMEOUT_MS - 5000) / 1000).toFixed(0)} seconds`\n        )\n      }\n      const delay = getExponentialBackoffDelay(depth)\n      request.logger.info(\n        `[uploadRetry] Waiting ${delay / 1000} seconds for uploadId: ${uploadId} to complete (retry depth: ${depth})`\n      )\n      await wait(delay)\n      return this.checkUploadStatus(request, state, depth + 1)\n    }\n\n    // Only add to files state if the file validates.\n    // This secures against html tampering of the file input\n    // by adding a 'multiple' attribute or it being\n    // changed to a simple text field or similar.\n    const validationResult = tempItemSchema.validate(\n      { uploadId, status: statusResponse },\n      { stripUnknown: true }\n    )\n    const error = validationResult.error\n    const fileState = validationResult.value as FileState\n\n    if (error) {\n      return this.initiateAndStoreNewUpload(request, state)\n    }\n\n    const file = fileState.status.form.file\n    if (file.fileStatus === FileStatus.complete) {\n      files.unshift(prepareFileState(fileState))\n      await this.mergeState(request, state, {\n        upload: { [this.path]: { files, upload } }\n      })\n    } else {\n      // Flash the error message.\n      const { fileUpload } = this\n      const cacheService = getCacheService(request.server)\n      const name = fileUpload.name\n      const text = file.errorMessage ?? 'Unknown error'\n      const errors: FormSubmissionError[] = [\n        { path: [name], href: `#${name}`, name, text }\n      ]\n      cacheService.setFlash(request, { errors })\n    }\n\n    return this.initiateAndStoreNewUpload(request, state)\n  }\n\n  /**\n   * Checks the payload for a file getting removed\n   * and removes it from the upload files if found\n   * @param request - the hapi request\n   * @param state - the form state\n   * @returns updated state if any files have been removed\n   */\n  private async checkRemovedFiles(\n    request: FormRequestPayload,\n    state: FormSubmissionState\n  ) {\n    const { path } = this\n    const { params } = request\n\n    const upload = this.getUploadFromState(state)\n    const files = this.getFilesFromState(state)\n\n    const filesUpdated = files.filter(\n      ({ uploadId }) => uploadId !== params.itemId\n    )\n\n    if (filesUpdated.length === files.length) {\n      return\n    }\n\n    await this.mergeState(request, state, {\n      upload: { [path]: { files: filesUpdated, upload } }\n    })\n  }\n\n  /**\n   * Initiates a CDP file upload and stores in the upload state\n   * @param request - the hapi request\n   * @param state - the form state\n   */\n  private async initiateAndStoreNewUpload(\n    request: AnyFormRequest,\n    state: FormSubmissionState\n  ) {\n    const { fileUpload, href, path } = this\n    const { options, schema } = fileUpload\n\n    const files = this.getFilesFromState(state)\n\n    // Reset the upload in state\n    let upload: UploadInitiateResponse | undefined\n\n    // Don't initiate anymore after minimum of `schema.max` or MAX_UPLOADS\n    const max = Math.min(schema.max ?? MAX_UPLOADS, MAX_UPLOADS)\n\n    if (files.length < max) {\n      const outputEmail =\n        this.model.def.outputEmail ?? 'defraforms@defra.gov.uk'\n\n      const newUpload = await initiateUpload(href, outputEmail, options.accept)\n\n      if (newUpload === undefined) {\n        throw Boom.badRequest('Unexpected empty response from initiateUpload')\n      }\n\n      upload = newUpload\n    }\n\n    return this.mergeState(request, state, {\n      upload: { [path]: { files, upload } }\n    })\n  }\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAA6B,oBAAoB;AACvE,OAAOC,IAAI,MAAM,YAAY;AAC7B,SAASC,IAAI,QAAQ,YAAY;AAGjC,SACEC,cAAc;AAGhB,SACEC,eAAe,EACfC,QAAQ,EACRC,0BAA0B;AAG5B,SAASC,sBAAsB;AAC/B,SAASC,8BAA8B;AACvC,SACEC,eAAe,EACfC,cAAc;AAEhB,SACEC,UAAU,EACVC,YAAY;AAkBd,MAAMC,WAAW,GAAG,EAAE;AACtB,MAAMC,qBAAqB,GAAG,KAAK,EAAC;;AAEpC,OAAO,SAASC,aAAaA,CAACC,MAAgC,EAAE;EAC9D,MAAMC,IAAI,GAAGD,MAAM,CAACE,IAAI,CAACD,IAAI;EAC7B,MAAME,SAAS,GAAGF,IAAI,CAACG,UAAU,KAAKT,UAAU,CAACU,OAAO;EAExD,IAAI,CAACJ,IAAI,CAACK,YAAY,IAAIH,SAAS,EAAE;IACnCF,IAAI,CAACK,YAAY,GAAG,0CAA0C;EAChE;EAEA,OAAON,MAAM;AACf;AAEA,SAASO,gBAAgBA,CAACC,SAAoB,EAAE;EAC9CT,aAAa,CAACS,SAAS,CAACR,MAAM,CAAC;EAE/B,OAAOQ,SAAS;AAClB;AAEA,OAAO,MAAMC,wBAAwB,SAASlB,sBAAsB,CAAC;EAGnEmB,UAAU;EACVC,kBAAkB,GAAG,aAAa;EAElCC,WAAWA,CAACC,KAAgB,EAAEC,OAAuB,EAAE;IACrD,KAAK,CAACD,KAAK,EAAEC,OAAO,CAAC;IAErB,MAAM;MAAEC;IAAW,CAAC,GAAG,IAAI;;IAE3B;IACA,MAAMC,WAAW,GAAGD,UAAU,CAACE,MAAM,CAACC,MAAM,CACzCC,KAAK,IACJA,KAAK,CAACC,IAAI,KAAKpC,aAAa,CAACqC,eACjC,CAAC;IAED,MAAMX,UAAU,GAAGM,WAAW,CAACM,EAAE,CAAC,CAAC,CAAC;;IAEpC;IACA,IAAI,CAACZ,UAAU,IAAIM,WAAW,CAACO,MAAM,GAAG,CAAC,EAAE;MACzC,MAAMtC,IAAI,CAACuC,iBAAiB,CAC1B,oEAAoEV,OAAO,CAACW,IAAI,GAClF,CAAC;IACH;;IAEA;IACA,IAAIV,UAAU,CAACE,MAAM,CAACS,OAAO,CAAChB,UAAU,CAAC,KAAK,CAAC,EAAE;MAC/C,MAAMzB,IAAI,CAACuC,iBAAiB,CAC1B,aAAad,UAAU,CAACiB,IAAI,iEAAiEb,OAAO,CAACW,IAAI,GAC3G,CAAC;IACH;;IAEA;IACA,IAAI,CAACf,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACkB,QAAQ,GAAG,aAAa;EAC/B;EAEAC,oBAAoBA,CAClBC,OAAuC,EACvCC,KAA0B,EAC1B;IACA,MAAM;MAAErB;IAAW,CAAC,GAAG,IAAI;IAE3B,MAAMsB,OAAO,GAAG,KAAK,CAACH,oBAAoB,CAACC,OAAO,EAAEC,KAAK,CAAC;IAC1D,MAAME,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;;IAE3C;IACAC,OAAO,CAACtB,UAAU,CAACiB,IAAI,CAAC,GAAGM,KAAK,CAACV,MAAM,GAAGU,KAAK,GAAGE,SAAS;IAE3D,OAAOH,OAAO;EAChB;EAEA,MAAMI,QAAQA,CAACN,OAAuB,EAAE;IACtC,MAAM;MAAEpB;IAAW,CAAC,GAAG,IAAI;;IAE3B;IACA,MAAMqB,KAAK,GAAG,MAAM,KAAK,CAACK,QAAQ,CAACN,OAAO,CAAC;IAC3C,MAAMG,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;;IAE3C;IACAA,KAAK,CAACrB,UAAU,CAACiB,IAAI,CAAC,GAAGM,KAAK;IAE9B,OAAO,IAAI,CAACI,aAAa,CAACP,OAAO,EAAEC,KAAK,CAAC;EAC3C;;EAEA;AACF;AACA;EACEG,iBAAiBA,CAACH,KAA0B,EAAE;IAC5C,MAAM;MAAEN;IAAK,CAAC,GAAG,IAAI;IAErB,MAAMa,WAAW,GAAGP,KAAK,CAACQ,MAAM,GAAGd,IAAI,CAAC;IACxC,OAAOa,WAAW,EAAEL,KAAK,IAAI,EAAE;EACjC;;EAEA;AACF;AACA;EACEO,kBAAkBA,CAACT,KAA0B,EAAE;IAC7C,MAAM;MAAEN;IAAK,CAAC,GAAG,IAAI;IAErB,MAAMa,WAAW,GAAGP,KAAK,CAACQ,MAAM,GAAGd,IAAI,CAAC;IACxC,OAAOa,WAAW,EAAEC,MAAM;EAC5B;EAEAE,6BAA6BA,CAAA,EAAG;IAC9B,OAAO,CACLX,OAAoB,EACpBY,OAAoB,EACpBC,CAAsB,KACnB;MACH,MAAM;QAAEC;MAAU,CAAC,GAAG,IAAI;MAC1B,MAAM;QAAEC;MAAO,CAAC,GAAGf,OAAO;MAC1B,MAAM;QAAEC;MAAM,CAAC,GAAGW,OAAO;MAEzB,MAAMT,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;MAE3C,MAAMe,YAAY,GAAGb,KAAK,CAACc,IAAI,CAC7B,CAAC;QAAEC;MAAS,CAAC,KAAKA,QAAQ,KAAKH,MAAM,CAACI,MACxC,CAAC;MAED,IAAI,CAACH,YAAY,EAAE;QACjB,MAAM7D,IAAI,CAACiE,QAAQ,CAAC,0BAA0B,CAAC;MACjD;MAEA,MAAM;QAAEC;MAAS,CAAC,GAAGL,YAAY,CAAC9C,MAAM,CAACE,IAAI,CAACD,IAAI;MAElD,OAAO0C,CAAC,CAACS,IAAI,CAAC,IAAI,CAACzC,kBAAkB,EAAE;QACrC,GAAGiC,SAAS;QACZF,OAAO;QACPW,QAAQ,EAAE,IAAI,CAACC,WAAW,CAACxB,OAAO,EAAEY,OAAO,CAAC;QAC5Ca,SAAS,EAAE,4CAA4C;QACvDC,SAAS,EAAEL,QAAQ;QACnBM,YAAY,EAAE;UAAEC,IAAI,EAAE;QAAoC,CAAC;QAC3DC,aAAa,EAAE;UAAED,IAAI,EAAE;QAAc,CAAC;QACtCE,YAAY,EAAE;UAAEF,IAAI,EAAE;QAAS;MACjC,CAAmC,CAAC;IACtC,CAAC;EACH;EAEAG,8BAA8BA,CAAA,EAAG;IAC/B,OAAO,OACL/B,OAA2B,EAC3BY,OAAoB,EACpBC,CAAsB,KACnB;MACH,MAAM;QAAElB;MAAK,CAAC,GAAG,IAAI;MACrB,MAAM;QAAEM;MAAM,CAAC,GAAGW,OAAO;MAEzB,MAAM;QAAEoB;MAAQ,CAAC,GAAG,IAAI,CAACC,aAAa,CAACjC,OAAO,CAAC;;MAE/C;MACA,IAAIgC,OAAO,EAAE;QACX,MAAM,IAAI,CAACE,iBAAiB,CAAClC,OAAO,EAAEC,KAAK,CAAC;QAC5C,OAAO,IAAI,CAACkC,OAAO,CAACnC,OAAO,EAAEa,CAAC,EAAElB,IAAI,CAAC;MACvC;MAEA,OAAO,IAAI,CAACwC,OAAO,CAACnC,OAAO,EAAEa,CAAC,CAAC;IACjC,CAAC;EACH;EAEAuB,SAASA,CAACC,OAA+B,EAAE;IACzC,MAAM;MAAEzD;IAAW,CAAC,GAAG,IAAI;IAE3B,IAAIyD,OAAO,EAAE;MACX,MAAMC,MAA6B,GAAG,EAAE;MAExCD,OAAO,CAACE,OAAO,CAAEC,KAAK,IAAK;QACzB,MAAMC,aAAa,GAAGD,KAAK,CAAC7C,IAAI,CAAC,CAAC,CAAC,KAAKf,UAAU,CAACiB,IAAI;QACvD,MAAM6C,iBAAiB,GAAGD,aAAa,IAAID,KAAK,CAAC7C,IAAI,CAACF,MAAM,KAAK,CAAC;QAElE,IAAI,CAACgD,aAAa,IAAIC,iBAAiB,EAAE;UACvC;UACA;UACAJ,MAAM,CAACK,IAAI,CAACpF,QAAQ,CAACiF,KAAK,CAAC,CAAC;QAC9B,CAAC,MAAM;UACL,MAAM;YAAE5B,OAAO;YAAEjB,IAAI;YAAEL;UAAK,CAAC,GAAGkD,KAAK;UAErC,IAAIlD,IAAI,KAAK,gBAAgB,IAAIK,IAAI,CAACH,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,cAAc,EAAE;YAC/D,MAAMoD,KAAK,GAAGhC,OAAO,EAAEgC,KAA2B;YAElD,IAAIA,KAAK,EAAE;cACT,MAAM/C,IAAI,GAAGjB,UAAU,CAACiB,IAAI;cAC5B,MAAM+B,IAAI,GAAG,OAAOgB,KAAK,KAAK,QAAQ,GAAGA,KAAK,GAAG,eAAe;cAChE,MAAMC,IAAI,GAAG,IAAIhD,IAAI,EAAE;cAEvByC,MAAM,CAACK,IAAI,CAAC;gBAAEhD,IAAI;gBAAEkD,IAAI;gBAAEhD,IAAI;gBAAE+B;cAAK,CAAC,CAAC;YACzC;UACF;QACF;MACF,CAAC,CAAC;MAEF,OAAOU,MAAM;IACf;EACF;EAEAQ,YAAYA,CACV9C,OAA2B,EAC3BY,OAAoB,EACO;IAC3B,MAAM;MAAEhC;IAAW,CAAC,GAAG,IAAI;IAC3B,MAAM;MAAEqB;IAAM,CAAC,GAAGW,OAAO;IAEzB,MAAMH,MAAM,GAAG,IAAI,CAACC,kBAAkB,CAACT,KAAK,CAAC;IAE7C,MAAMa,SAAS,GAAG,KAAK,CAACgC,YAAY,CAAC9C,OAAO,EAAEY,OAAO,CAAC;IACtD,MAAM;MAAEmC;IAAW,CAAC,GAAGjC,SAAS;;IAEhC;IACA,MAAM,CAACkC,aAAa,CAAC,GAAGD,UAAU,CAAC3D,MAAM,CACvC,CAAC;MAAEL;IAAM,CAAC,KAAKA,KAAK,CAACkE,EAAE,KAAKrE,UAAU,CAACiB,IACzC,CAAC;IAED,MAAMqD,KAAK,GAAGH,UAAU,CAACnD,OAAO,CAACoD,aAAa,CAAC;IAE/C,MAAMG,QAAQ,GAAGzF,8BAA8B,CAAC+C,MAAM,EAAE2C,SAAS,CAAC;IAElE,OAAO;MACL,GAAGtC,SAAS;MACZuC,UAAU,EAAE5C,MAAM,EAAE2C,SAAS;MAC7BlC,QAAQ,EAAET,MAAM,EAAES,QAAQ;MAC1B8B,aAAa;MAEb;MACAM,gBAAgB,EAAEP,UAAU,CAACQ,KAAK,CAAC,CAAC,EAAEL,KAAK,CAAC;MAC5CH,UAAU,EAAEA,UAAU,CAACQ,KAAK,CAACL,KAAK,CAAC;MACnCC;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAc5C,aAAaA,CACzBP,OAAuB,EACvBC,KAA0B,EAC1B;IACAA,KAAK,GAAG,MAAM,IAAI,CAACuD,iBAAiB,CAACxD,OAAO,EAAEC,KAAK,CAAC;IAEpD,OAAOA,KAAK;EACd;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAcuD,iBAAiBA,CAC7BxD,OAAuB,EACvBC,KAA0B,EAC1BwD,KAAK,GAAG,CAAC,EACqB;IAC9B,MAAMhD,MAAM,GAAG,IAAI,CAACC,kBAAkB,CAACT,KAAK,CAAC;IAC7C,MAAME,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;;IAE3C;IACA,IAAI,CAACQ,MAAM,EAAES,QAAQ,EAAE;MACrB,OAAO,IAAI,CAACwC,yBAAyB,CAAC1D,OAAO,EAAEC,KAAK,CAAC;IACvD;IAEA,MAAMiB,QAAQ,GAAGT,MAAM,CAACS,QAAQ;IAChC,MAAMyC,cAAc,GAAG,MAAMhG,eAAe,CAACuD,QAAQ,CAAC;IACtD,IAAI,CAACyC,cAAc,EAAE;MACnB,MAAMxG,IAAI,CAACyG,UAAU,CACnB,sDAAsD1C,QAAQ,EAChE,CAAC;IACH;;IAEA;IACA,IAAIyC,cAAc,CAACE,YAAY,KAAK/F,YAAY,CAACgG,SAAS,EAAE;MAC1D,OAAO7D,KAAK;IACd;IAEA,IAAI0D,cAAc,CAACE,YAAY,KAAK/F,YAAY,CAACS,OAAO,EAAE;MACxD;MACA;MACA;MACA,IAAIkF,KAAK,IAAI,CAAC,EAAE;QACd,MAAMjB,KAAK,GAAG,IAAIuB,KAAK,CACrB,uCAAuC7C,QAAQ,YAAYuC,KAAK,gCAClE,CAAC;QACDzD,OAAO,CAACgE,MAAM,CAACxB,KAAK,CAClBA,KAAK,EACL,iEAAiEtB,QAAQ,cAAcuC,KAAK,6BAC9F,CAAC;QACD,MAAM,IAAI,CAACC,yBAAyB,CAAC1D,OAAO,EAAEC,KAAK,CAAC;QACpD,MAAM9C,IAAI,CAAC8G,cAAc,CACvB,yBAAyB/C,QAAQ,uCAAuC,CAAC,CAAClD,qBAAqB,GAAG,IAAI,IAAI,IAAI,EAAEkG,OAAO,CAAC,CAAC,CAAC,UAC5H,CAAC;MACH;MACA,MAAMC,KAAK,GAAG3G,0BAA0B,CAACiG,KAAK,CAAC;MAC/CzD,OAAO,CAACgE,MAAM,CAACI,IAAI,CACjB,yBAAyBD,KAAK,GAAG,IAAI,0BAA0BjD,QAAQ,8BAA8BuC,KAAK,GAC5G,CAAC;MACD,MAAMrG,IAAI,CAAC+G,KAAK,CAAC;MACjB,OAAO,IAAI,CAACX,iBAAiB,CAACxD,OAAO,EAAEC,KAAK,EAAEwD,KAAK,GAAG,CAAC,CAAC;IAC1D;;IAEA;IACA;IACA;IACA;IACA,MAAMY,gBAAgB,GAAGhH,cAAc,CAACiH,QAAQ,CAC9C;MAAEpD,QAAQ;MAAEhD,MAAM,EAAEyF;IAAe,CAAC,EACpC;MAAEY,YAAY,EAAE;IAAK,CACvB,CAAC;IACD,MAAM/B,KAAK,GAAG6B,gBAAgB,CAAC7B,KAAK;IACpC,MAAM9D,SAAS,GAAG2F,gBAAgB,CAACzB,KAAkB;IAErD,IAAIJ,KAAK,EAAE;MACT,OAAO,IAAI,CAACkB,yBAAyB,CAAC1D,OAAO,EAAEC,KAAK,CAAC;IACvD;IAEA,MAAM9B,IAAI,GAAGO,SAAS,CAACR,MAAM,CAACE,IAAI,CAACD,IAAI;IACvC,IAAIA,IAAI,CAACG,UAAU,KAAKT,UAAU,CAAC2G,QAAQ,EAAE;MAC3CrE,KAAK,CAACsE,OAAO,CAAChG,gBAAgB,CAACC,SAAS,CAAC,CAAC;MAC1C,MAAM,IAAI,CAACgG,UAAU,CAAC1E,OAAO,EAAEC,KAAK,EAAE;QACpCQ,MAAM,EAAE;UAAE,CAAC,IAAI,CAACd,IAAI,GAAG;YAAEQ,KAAK;YAAEM;UAAO;QAAE;MAC3C,CAAC,CAAC;IACJ,CAAC,MAAM;MACL;MACA,MAAM;QAAE7B;MAAW,CAAC,GAAG,IAAI;MAC3B,MAAM+F,YAAY,GAAGrH,eAAe,CAAC0C,OAAO,CAAC4E,MAAM,CAAC;MACpD,MAAM/E,IAAI,GAAGjB,UAAU,CAACiB,IAAI;MAC5B,MAAM+B,IAAI,GAAGzD,IAAI,CAACK,YAAY,IAAI,eAAe;MACjD,MAAM8D,MAA6B,GAAG,CACpC;QAAE3C,IAAI,EAAE,CAACE,IAAI,CAAC;QAAEgD,IAAI,EAAE,IAAIhD,IAAI,EAAE;QAAEA,IAAI;QAAE+B;MAAK,CAAC,CAC/C;MACD+C,YAAY,CAACE,QAAQ,CAAC7E,OAAO,EAAE;QAAEsC;MAAO,CAAC,CAAC;IAC5C;IAEA,OAAO,IAAI,CAACoB,yBAAyB,CAAC1D,OAAO,EAAEC,KAAK,CAAC;EACvD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAciC,iBAAiBA,CAC7BlC,OAA2B,EAC3BC,KAA0B,EAC1B;IACA,MAAM;MAAEN;IAAK,CAAC,GAAG,IAAI;IACrB,MAAM;MAAEoB;IAAO,CAAC,GAAGf,OAAO;IAE1B,MAAMS,MAAM,GAAG,IAAI,CAACC,kBAAkB,CAACT,KAAK,CAAC;IAC7C,MAAME,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;IAE3C,MAAM6E,YAAY,GAAG3E,KAAK,CAACf,MAAM,CAC/B,CAAC;MAAE8B;IAAS,CAAC,KAAKA,QAAQ,KAAKH,MAAM,CAACI,MACxC,CAAC;IAED,IAAI2D,YAAY,CAACrF,MAAM,KAAKU,KAAK,CAACV,MAAM,EAAE;MACxC;IACF;IAEA,MAAM,IAAI,CAACiF,UAAU,CAAC1E,OAAO,EAAEC,KAAK,EAAE;MACpCQ,MAAM,EAAE;QAAE,CAACd,IAAI,GAAG;UAAEQ,KAAK,EAAE2E,YAAY;UAAErE;QAAO;MAAE;IACpD,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAciD,yBAAyBA,CACrC1D,OAAuB,EACvBC,KAA0B,EAC1B;IACA,MAAM;MAAErB,UAAU;MAAEiE,IAAI;MAAElD;IAAK,CAAC,GAAG,IAAI;IACvC,MAAM;MAAEoF,OAAO;MAAEC;IAAO,CAAC,GAAGpG,UAAU;IAEtC,MAAMuB,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;;IAE3C;IACA,IAAIQ,MAA0C;;IAE9C;IACA,MAAMwE,GAAG,GAAGC,IAAI,CAACC,GAAG,CAACH,MAAM,CAACC,GAAG,IAAIlH,WAAW,EAAEA,WAAW,CAAC;IAE5D,IAAIoC,KAAK,CAACV,MAAM,GAAGwF,GAAG,EAAE;MACtB,MAAMG,WAAW,GACf,IAAI,CAACrG,KAAK,CAACsG,GAAG,CAACD,WAAW,IAAI,yBAAyB;MAEzD,MAAME,SAAS,GAAG,MAAM1H,cAAc,CAACiF,IAAI,EAAEuC,WAAW,EAAEL,OAAO,CAACQ,MAAM,CAAC;MAEzE,IAAID,SAAS,KAAKjF,SAAS,EAAE;QAC3B,MAAMlD,IAAI,CAACyG,UAAU,CAAC,+CAA+C,CAAC;MACxE;MAEAnD,MAAM,GAAG6E,SAAS;IACpB;IAEA,OAAO,IAAI,CAACZ,UAAU,CAAC1E,OAAO,EAAEC,KAAK,EAAE;MACrCQ,MAAM,EAAE;QAAE,CAACd,IAAI,GAAG;UAAEQ,KAAK;UAAEM;QAAO;MAAE;IACtC,CAAC,CAAC;EACJ;AACF","ignoreList":[]}

package/.server/server/plugins/engine/pageControllers/PageController.d.ts

@@ -1,10 +1,10 @@
 import { type Events, type FormDefinition, type Page, type Section } from '@defra/forms-model';
-import { type Lifecycle, type ResponseToolkit, type RouteOptions, type Server } from '@hapi/hapi';
+import { type Lifecycle, type RouteOptions, type Server } from '@hapi/hapi';
 import { type ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js';
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
 import { type ExecutableCondition } from '~/src/server/plugins/engine/models/types.js';
 import { type FormContext, type PageViewModelBase } from '~/src/server/plugins/engine/types.js';
-import { type FormRequest, type FormRequestPayload, type FormRequestPayloadRefs, type FormRequestRefs } from '~/src/server/routes/types.js';
+import { type FormRequest, type FormRequestPayload, type FormRequestPayloadRefs, type FormRequestRefs, type FormResponseToolkit } from '~/src/server/routes/types.js';
 export declare class PageController {
     /**
      * The base class for all page controllers. Page controllers are responsible for generating the get and post route handlers when a user navigates to `/{id}/{path*}`.
@@ -19,7 +19,7 @@ export declare class PageController {
     events?: Events;
     collection?: ComponentCollection;
     viewName: string;
-    allowSaveAndReturn: boolean;
+    allowSaveAndExit: boolean;
     constructor(model: FormModel, pageDef: Page);
     get path(): string;
     get href(): string;
@@ -39,7 +39,7 @@ export declare class PageController {
     getStartPath(): string;
     getSummaryPath(): string;
     getStatusPath(): string;
-    makeGetRouteHandler(): (request: FormRequest, context: FormContext, h: Pick<ResponseToolkit, 'redirect' | 'view'>) => ReturnType<Lifecycle.Method<FormRequestRefs>>;
-    makePostRouteHandler(): (request: FormRequestPayload, context: FormContext, h: Pick<ResponseToolkit, 'redirect' | 'view'>) => ReturnType<Lifecycle.Method<FormRequestPayloadRefs>>;
-    shouldShowSaveAndReturn(server: Server): boolean;
+    makeGetRouteHandler(): (request: FormRequest, context: FormContext, h: FormResponseToolkit) => ReturnType<Lifecycle.Method<FormRequestRefs>>;
+    makePostRouteHandler(): (request: FormRequestPayload, context: FormContext, h: FormResponseToolkit) => ReturnType<Lifecycle.Method<FormRequestPayloadRefs>>;
+    shouldShowSaveAndExit(server: Server): boolean;
 }

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

@@ -1,6 +1,6 @@
 import { ControllerPath } from '@defra/forms-model';
 import Boom from '@hapi/boom';
-import { encodeUrl, getSaveAndReturnHelpers, getStartPath, normalisePath } from "../helpers.js";
+import { encodeUrl, getSaveAndExitHelpers, getStartPath, normalisePath } from "../helpers.js";
 export class PageController {
   /**
    * The base class for all page controllers. Page controllers are responsible for generating the get and post route handlers when a user navigates to `/{id}/{path*}`.
@@ -15,7 +15,7 @@ export class PageController {
   events;
   collection;
   viewName = 'index';
-  allowSaveAndReturn = false;
+  allowSaveAndExit = false;
   constructor(model, pageDef) {
     const {
       def
@@ -138,8 +138,8 @@ export class PageController {
   makePostRouteHandler() {
     throw Boom.badRequest('Unsupported POST route handler for this page');
   }
-  shouldShowSaveAndReturn(server) {
-    return getSaveAndReturnHelpers(server) !== undefined && this.allowSaveAndReturn;
+  shouldShowSaveAndExit(server) {
+    return getSaveAndExitHelpers(server) !== undefined && this.allowSaveAndExit;
   }
 }
 //# sourceMappingURL=PageController.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"PageController.js","names":["ControllerPath","Boom","encodeUrl","getSaveAndReturnHelpers","getStartPath","normalisePath","PageController","def","name","model","pageDef","title","section","condition","events","collection","viewName","allowSaveAndReturn","constructor","sections","find","conditions","view","path","href","getHref","keys","getRouteOptions","postRouteOptions","viewModel","showTitle","pageTitle","sectionTitle","hideTitle","page","isStartPage","serviceUrl","feedbackLink","phaseTag","feedback","emailAddress","url","phaseBanner","phase","basePath","relativeTargetPath","startsWith","substring","finalPath","replace","getSummaryPath","Summary","valueOf","getStatusPath","Status","makeGetRouteHandler","request","context","h","makePostRouteHandler","badRequest","shouldShowSaveAndReturn","server","undefined"],"sources":["../../../../../src/server/plugins/engine/pageControllers/PageController.ts"],"sourcesContent":["import {\n  ControllerPath,\n  type Events,\n  type FormDefinition,\n  type Page,\n  type Section\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport {\n  type Lifecycle,\n  type ResponseToolkit,\n  type RouteOptions,\n  type Server\n} from '@hapi/hapi'\n\nimport { type ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport {\n  encodeUrl,\n  getSaveAndReturnHelpers,\n  getStartPath,\n  normalisePath\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type ExecutableCondition } from '~/src/server/plugins/engine/models/types.js'\nimport {\n  type FormContext,\n  type PageViewModelBase\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs,\n  type FormRequestRefs\n} from '~/src/server/routes/types.js'\n\nexport class PageController {\n  /**\n   * The base class for all page controllers. Page controllers are responsible for generating the get and post route handlers when a user navigates to `/{id}/{path*}`.\n   */\n  def: FormDefinition\n  name?: string\n  model: FormModel\n  pageDef: Page\n  title: string\n  section?: Section\n  condition?: ExecutableCondition\n  events?: Events\n  collection?: ComponentCollection\n  viewName = 'index'\n  allowSaveAndReturn = false\n\n  constructor(model: FormModel, pageDef: Page) {\n    const { def } = model\n\n    this.def = def\n    this.name = def.name\n    this.model = model\n    this.pageDef = pageDef\n    this.title = pageDef.title\n    this.events = pageDef.events\n\n    // Resolve section\n    this.section = model.sections.find(\n      (section) => section.name === pageDef.section\n    )\n\n    // Resolve condition\n    if (pageDef.condition) {\n      this.condition = model.conditions[pageDef.condition]\n    }\n\n    // Override view name\n    if (pageDef.view) {\n      this.viewName = pageDef.view\n    }\n  }\n\n  get path() {\n    return this.pageDef.path\n  }\n\n  get href() {\n    const { path } = this\n    return this.getHref(`/${normalisePath(path)}`)\n  }\n\n  get keys() {\n    return this.collection?.keys ?? []\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get getRouteOptions(): RouteOptions<FormRequestRefs> {\n    return {}\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get postRouteOptions(): RouteOptions<FormRequestPayloadRefs> {\n    return {}\n  }\n\n  get viewModel(): PageViewModelBase {\n    const { name, section, title } = this\n\n    const showTitle = true\n    const pageTitle = title\n    const sectionTitle = section?.hideTitle !== true ? section?.title : ''\n\n    return {\n      name,\n      page: this,\n      pageTitle,\n      sectionTitle,\n      showTitle,\n      isStartPage: false,\n      serviceUrl: this.getHref('/'),\n      feedbackLink: this.feedbackLink,\n      phaseTag: this.phaseTag\n    }\n  }\n\n  get feedbackLink() {\n    const { def } = this\n\n    // setting the feedbackLink to undefined here for feedback forms prevents the feedback link from being shown\n    const feedbackLink = def.feedback?.emailAddress\n      ? `mailto:${def.feedback.emailAddress}`\n      : def.feedback?.url\n\n    return encodeUrl(feedbackLink)\n  }\n\n  get phaseTag() {\n    const { def } = this\n    return def.phaseBanner?.phase\n  }\n\n  getHref(path: string): string {\n    const basePath = this.model.basePath\n\n    if (path === '/') {\n      return `/${basePath}`\n    }\n\n    // if ever the path is not prefixed with a slash, add it\n    const relativeTargetPath = path.startsWith('/') ? path.substring(1) : path\n    let finalPath = `/${basePath}`\n    if (relativeTargetPath) {\n      finalPath += `/${relativeTargetPath}`\n    }\n    finalPath = finalPath.replace(/\\/{2,}/g, '/')\n\n    return finalPath\n  }\n\n  getStartPath() {\n    return getStartPath(this.model)\n  }\n\n  getSummaryPath() {\n    return ControllerPath.Summary.valueOf()\n  }\n\n  getStatusPath() {\n    return ControllerPath.Status.valueOf()\n  }\n\n  makeGetRouteHandler(): (\n    request: FormRequest,\n    context: FormContext,\n    h: Pick<ResponseToolkit, 'redirect' | 'view'>\n  ) => ReturnType<Lifecycle.Method<FormRequestRefs>> {\n    return (request, context, h) => {\n      const { viewModel, viewName } = this\n      return h.view(viewName, viewModel)\n    }\n  }\n\n  makePostRouteHandler(): (\n    request: FormRequestPayload,\n    context: FormContext,\n    h: Pick<ResponseToolkit, 'redirect' | 'view'>\n  ) => ReturnType<Lifecycle.Method<FormRequestPayloadRefs>> {\n    throw Boom.badRequest('Unsupported POST route handler for this page')\n  }\n\n  shouldShowSaveAndReturn(server: Server): boolean {\n    return (\n      getSaveAndReturnHelpers(server) !== undefined && this.allowSaveAndReturn\n    )\n  }\n}\n"],"mappings":"AAAA,SACEA,cAAc,QAKT,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAS7B,SACEC,SAAS,EACTC,uBAAuB,EACvBC,YAAY,EACZC,aAAa;AAef,OAAO,MAAMC,cAAc,CAAC;EAC1B;AACF;AACA;EACEC,GAAG;EACHC,IAAI;EACJC,KAAK;EACLC,OAAO;EACPC,KAAK;EACLC,OAAO;EACPC,SAAS;EACTC,MAAM;EACNC,UAAU;EACVC,QAAQ,GAAG,OAAO;EAClBC,kBAAkB,GAAG,KAAK;EAE1BC,WAAWA,CAACT,KAAgB,EAAEC,OAAa,EAAE;IAC3C,MAAM;MAAEH;IAAI,CAAC,GAAGE,KAAK;IAErB,IAAI,CAACF,GAAG,GAAGA,GAAG;IACd,IAAI,CAACC,IAAI,GAAGD,GAAG,CAACC,IAAI;IACpB,IAAI,CAACC,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,KAAK,GAAGD,OAAO,CAACC,KAAK;IAC1B,IAAI,CAACG,MAAM,GAAGJ,OAAO,CAACI,MAAM;;IAE5B;IACA,IAAI,CAACF,OAAO,GAAGH,KAAK,CAACU,QAAQ,CAACC,IAAI,CAC/BR,OAAO,IAAKA,OAAO,CAACJ,IAAI,KAAKE,OAAO,CAACE,OACxC,CAAC;;IAED;IACA,IAAIF,OAAO,CAACG,SAAS,EAAE;MACrB,IAAI,CAACA,SAAS,GAAGJ,KAAK,CAACY,UAAU,CAACX,OAAO,CAACG,SAAS,CAAC;IACtD;;IAEA;IACA,IAAIH,OAAO,CAACY,IAAI,EAAE;MAChB,IAAI,CAACN,QAAQ,GAAGN,OAAO,CAACY,IAAI;IAC9B;EACF;EAEA,IAAIC,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI,CAACb,OAAO,CAACa,IAAI;EAC1B;EAEA,IAAIC,IAAIA,CAAA,EAAG;IACT,MAAM;MAAED;IAAK,CAAC,GAAG,IAAI;IACrB,OAAO,IAAI,CAACE,OAAO,CAAC,IAAIpB,aAAa,CAACkB,IAAI,CAAC,EAAE,CAAC;EAChD;EAEA,IAAIG,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI,CAACX,UAAU,EAAEW,IAAI,IAAI,EAAE;EACpC;;EAEA;AACF;AACA;EACE,IAAIC,eAAeA,CAAA,EAAkC;IACnD,OAAO,CAAC,CAAC;EACX;;EAEA;AACF;AACA;EACE,IAAIC,gBAAgBA,CAAA,EAAyC;IAC3D,OAAO,CAAC,CAAC;EACX;EAEA,IAAIC,SAASA,CAAA,EAAsB;IACjC,MAAM;MAAErB,IAAI;MAAEI,OAAO;MAAED;IAAM,CAAC,GAAG,IAAI;IAErC,MAAMmB,SAAS,GAAG,IAAI;IACtB,MAAMC,SAAS,GAAGpB,KAAK;IACvB,MAAMqB,YAAY,GAAGpB,OAAO,EAAEqB,SAAS,KAAK,IAAI,GAAGrB,OAAO,EAAED,KAAK,GAAG,EAAE;IAEtE,OAAO;MACLH,IAAI;MACJ0B,IAAI,EAAE,IAAI;MACVH,SAAS;MACTC,YAAY;MACZF,SAAS;MACTK,WAAW,EAAE,KAAK;MAClBC,UAAU,EAAE,IAAI,CAACX,OAAO,CAAC,GAAG,CAAC;MAC7BY,YAAY,EAAE,IAAI,CAACA,YAAY;MAC/BC,QAAQ,EAAE,IAAI,CAACA;IACjB,CAAC;EACH;EAEA,IAAID,YAAYA,CAAA,EAAG;IACjB,MAAM;MAAE9B;IAAI,CAAC,GAAG,IAAI;;IAEpB;IACA,MAAM8B,YAAY,GAAG9B,GAAG,CAACgC,QAAQ,EAAEC,YAAY,GAC3C,UAAUjC,GAAG,CAACgC,QAAQ,CAACC,YAAY,EAAE,GACrCjC,GAAG,CAACgC,QAAQ,EAAEE,GAAG;IAErB,OAAOvC,SAAS,CAACmC,YAAY,CAAC;EAChC;EAEA,IAAIC,QAAQA,CAAA,EAAG;IACb,MAAM;MAAE/B;IAAI,CAAC,GAAG,IAAI;IACpB,OAAOA,GAAG,CAACmC,WAAW,EAAEC,KAAK;EAC/B;EAEAlB,OAAOA,CAACF,IAAY,EAAU;IAC5B,MAAMqB,QAAQ,GAAG,IAAI,CAACnC,KAAK,CAACmC,QAAQ;IAEpC,IAAIrB,IAAI,KAAK,GAAG,EAAE;MAChB,OAAO,IAAIqB,QAAQ,EAAE;IACvB;;IAEA;IACA,MAAMC,kBAAkB,GAAGtB,IAAI,CAACuB,UAAU,CAAC,GAAG,CAAC,GAAGvB,IAAI,CAACwB,SAAS,CAAC,CAAC,CAAC,GAAGxB,IAAI;IAC1E,IAAIyB,SAAS,GAAG,IAAIJ,QAAQ,EAAE;IAC9B,IAAIC,kBAAkB,EAAE;MACtBG,SAAS,IAAI,IAAIH,kBAAkB,EAAE;IACvC;IACAG,SAAS,GAAGA,SAAS,CAACC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;IAE7C,OAAOD,SAAS;EAClB;EAEA5C,YAAYA,CAAA,EAAG;IACb,OAAOA,YAAY,CAAC,IAAI,CAACK,KAAK,CAAC;EACjC;EAEAyC,cAAcA,CAAA,EAAG;IACf,OAAOlD,cAAc,CAACmD,OAAO,CAACC,OAAO,CAAC,CAAC;EACzC;EAEAC,aAAaA,CAAA,EAAG;IACd,OAAOrD,cAAc,CAACsD,MAAM,CAACF,OAAO,CAAC,CAAC;EACxC;EAEAG,mBAAmBA,CAAA,EAIgC;IACjD,OAAO,CAACC,OAAO,EAAEC,OAAO,EAAEC,CAAC,KAAK;MAC9B,MAAM;QAAE7B,SAAS;QAAEb;MAAS,CAAC,GAAG,IAAI;MACpC,OAAO0C,CAAC,CAACpC,IAAI,CAACN,QAAQ,EAAEa,SAAS,CAAC;IACpC,CAAC;EACH;EAEA8B,oBAAoBA,CAAA,EAIsC;IACxD,MAAM1D,IAAI,CAAC2D,UAAU,CAAC,8CAA8C,CAAC;EACvE;EAEAC,uBAAuBA,CAACC,MAAc,EAAW;IAC/C,OACE3D,uBAAuB,CAAC2D,MAAM,CAAC,KAAKC,SAAS,IAAI,IAAI,CAAC9C,kBAAkB;EAE5E;AACF","ignoreList":[]}
+{"version":3,"file":"PageController.js","names":["ControllerPath","Boom","encodeUrl","getSaveAndExitHelpers","getStartPath","normalisePath","PageController","def","name","model","pageDef","title","section","condition","events","collection","viewName","allowSaveAndExit","constructor","sections","find","conditions","view","path","href","getHref","keys","getRouteOptions","postRouteOptions","viewModel","showTitle","pageTitle","sectionTitle","hideTitle","page","isStartPage","serviceUrl","feedbackLink","phaseTag","feedback","emailAddress","url","phaseBanner","phase","basePath","relativeTargetPath","startsWith","substring","finalPath","replace","getSummaryPath","Summary","valueOf","getStatusPath","Status","makeGetRouteHandler","request","context","h","makePostRouteHandler","badRequest","shouldShowSaveAndExit","server","undefined"],"sources":["../../../../../src/server/plugins/engine/pageControllers/PageController.ts"],"sourcesContent":["import {\n  ControllerPath,\n  type Events,\n  type FormDefinition,\n  type Page,\n  type Section\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type Lifecycle, type RouteOptions, type Server } from '@hapi/hapi'\n\nimport { type ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport {\n  encodeUrl,\n  getSaveAndExitHelpers,\n  getStartPath,\n  normalisePath\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type ExecutableCondition } from '~/src/server/plugins/engine/models/types.js'\nimport {\n  type FormContext,\n  type PageViewModelBase\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs,\n  type FormRequestRefs,\n  type FormResponseToolkit\n} from '~/src/server/routes/types.js'\n\nexport class PageController {\n  /**\n   * The base class for all page controllers. Page controllers are responsible for generating the get and post route handlers when a user navigates to `/{id}/{path*}`.\n   */\n  def: FormDefinition\n  name?: string\n  model: FormModel\n  pageDef: Page\n  title: string\n  section?: Section\n  condition?: ExecutableCondition\n  events?: Events\n  collection?: ComponentCollection\n  viewName = 'index'\n  allowSaveAndExit = false\n\n  constructor(model: FormModel, pageDef: Page) {\n    const { def } = model\n\n    this.def = def\n    this.name = def.name\n    this.model = model\n    this.pageDef = pageDef\n    this.title = pageDef.title\n    this.events = pageDef.events\n\n    // Resolve section\n    this.section = model.sections.find(\n      (section) => section.name === pageDef.section\n    )\n\n    // Resolve condition\n    if (pageDef.condition) {\n      this.condition = model.conditions[pageDef.condition]\n    }\n\n    // Override view name\n    if (pageDef.view) {\n      this.viewName = pageDef.view\n    }\n  }\n\n  get path() {\n    return this.pageDef.path\n  }\n\n  get href() {\n    const { path } = this\n    return this.getHref(`/${normalisePath(path)}`)\n  }\n\n  get keys() {\n    return this.collection?.keys ?? []\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get getRouteOptions(): RouteOptions<FormRequestRefs> {\n    return {}\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get postRouteOptions(): RouteOptions<FormRequestPayloadRefs> {\n    return {}\n  }\n\n  get viewModel(): PageViewModelBase {\n    const { name, section, title } = this\n\n    const showTitle = true\n    const pageTitle = title\n    const sectionTitle = section?.hideTitle !== true ? section?.title : ''\n\n    return {\n      name,\n      page: this,\n      pageTitle,\n      sectionTitle,\n      showTitle,\n      isStartPage: false,\n      serviceUrl: this.getHref('/'),\n      feedbackLink: this.feedbackLink,\n      phaseTag: this.phaseTag\n    }\n  }\n\n  get feedbackLink() {\n    const { def } = this\n\n    // setting the feedbackLink to undefined here for feedback forms prevents the feedback link from being shown\n    const feedbackLink = def.feedback?.emailAddress\n      ? `mailto:${def.feedback.emailAddress}`\n      : def.feedback?.url\n\n    return encodeUrl(feedbackLink)\n  }\n\n  get phaseTag() {\n    const { def } = this\n    return def.phaseBanner?.phase\n  }\n\n  getHref(path: string): string {\n    const basePath = this.model.basePath\n\n    if (path === '/') {\n      return `/${basePath}`\n    }\n\n    // if ever the path is not prefixed with a slash, add it\n    const relativeTargetPath = path.startsWith('/') ? path.substring(1) : path\n    let finalPath = `/${basePath}`\n    if (relativeTargetPath) {\n      finalPath += `/${relativeTargetPath}`\n    }\n    finalPath = finalPath.replace(/\\/{2,}/g, '/')\n\n    return finalPath\n  }\n\n  getStartPath() {\n    return getStartPath(this.model)\n  }\n\n  getSummaryPath() {\n    return ControllerPath.Summary.valueOf()\n  }\n\n  getStatusPath() {\n    return ControllerPath.Status.valueOf()\n  }\n\n  makeGetRouteHandler(): (\n    request: FormRequest,\n    context: FormContext,\n    h: FormResponseToolkit\n  ) => ReturnType<Lifecycle.Method<FormRequestRefs>> {\n    return (request, context, h) => {\n      const { viewModel, viewName } = this\n      return h.view(viewName, viewModel)\n    }\n  }\n\n  makePostRouteHandler(): (\n    request: FormRequestPayload,\n    context: FormContext,\n    h: FormResponseToolkit\n  ) => ReturnType<Lifecycle.Method<FormRequestPayloadRefs>> {\n    throw Boom.badRequest('Unsupported POST route handler for this page')\n  }\n\n  shouldShowSaveAndExit(server: Server): boolean {\n    return getSaveAndExitHelpers(server) !== undefined && this.allowSaveAndExit\n  }\n}\n"],"mappings":"AAAA,SACEA,cAAc,QAKT,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAI7B,SACEC,SAAS,EACTC,qBAAqB,EACrBC,YAAY,EACZC,aAAa;AAgBf,OAAO,MAAMC,cAAc,CAAC;EAC1B;AACF;AACA;EACEC,GAAG;EACHC,IAAI;EACJC,KAAK;EACLC,OAAO;EACPC,KAAK;EACLC,OAAO;EACPC,SAAS;EACTC,MAAM;EACNC,UAAU;EACVC,QAAQ,GAAG,OAAO;EAClBC,gBAAgB,GAAG,KAAK;EAExBC,WAAWA,CAACT,KAAgB,EAAEC,OAAa,EAAE;IAC3C,MAAM;MAAEH;IAAI,CAAC,GAAGE,KAAK;IAErB,IAAI,CAACF,GAAG,GAAGA,GAAG;IACd,IAAI,CAACC,IAAI,GAAGD,GAAG,CAACC,IAAI;IACpB,IAAI,CAACC,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,KAAK,GAAGD,OAAO,CAACC,KAAK;IAC1B,IAAI,CAACG,MAAM,GAAGJ,OAAO,CAACI,MAAM;;IAE5B;IACA,IAAI,CAACF,OAAO,GAAGH,KAAK,CAACU,QAAQ,CAACC,IAAI,CAC/BR,OAAO,IAAKA,OAAO,CAACJ,IAAI,KAAKE,OAAO,CAACE,OACxC,CAAC;;IAED;IACA,IAAIF,OAAO,CAACG,SAAS,EAAE;MACrB,IAAI,CAACA,SAAS,GAAGJ,KAAK,CAACY,UAAU,CAACX,OAAO,CAACG,SAAS,CAAC;IACtD;;IAEA;IACA,IAAIH,OAAO,CAACY,IAAI,EAAE;MAChB,IAAI,CAACN,QAAQ,GAAGN,OAAO,CAACY,IAAI;IAC9B;EACF;EAEA,IAAIC,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI,CAACb,OAAO,CAACa,IAAI;EAC1B;EAEA,IAAIC,IAAIA,CAAA,EAAG;IACT,MAAM;MAAED;IAAK,CAAC,GAAG,IAAI;IACrB,OAAO,IAAI,CAACE,OAAO,CAAC,IAAIpB,aAAa,CAACkB,IAAI,CAAC,EAAE,CAAC;EAChD;EAEA,IAAIG,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI,CAACX,UAAU,EAAEW,IAAI,IAAI,EAAE;EACpC;;EAEA;AACF;AACA;EACE,IAAIC,eAAeA,CAAA,EAAkC;IACnD,OAAO,CAAC,CAAC;EACX;;EAEA;AACF;AACA;EACE,IAAIC,gBAAgBA,CAAA,EAAyC;IAC3D,OAAO,CAAC,CAAC;EACX;EAEA,IAAIC,SAASA,CAAA,EAAsB;IACjC,MAAM;MAAErB,IAAI;MAAEI,OAAO;MAAED;IAAM,CAAC,GAAG,IAAI;IAErC,MAAMmB,SAAS,GAAG,IAAI;IACtB,MAAMC,SAAS,GAAGpB,KAAK;IACvB,MAAMqB,YAAY,GAAGpB,OAAO,EAAEqB,SAAS,KAAK,IAAI,GAAGrB,OAAO,EAAED,KAAK,GAAG,EAAE;IAEtE,OAAO;MACLH,IAAI;MACJ0B,IAAI,EAAE,IAAI;MACVH,SAAS;MACTC,YAAY;MACZF,SAAS;MACTK,WAAW,EAAE,KAAK;MAClBC,UAAU,EAAE,IAAI,CAACX,OAAO,CAAC,GAAG,CAAC;MAC7BY,YAAY,EAAE,IAAI,CAACA,YAAY;MAC/BC,QAAQ,EAAE,IAAI,CAACA;IACjB,CAAC;EACH;EAEA,IAAID,YAAYA,CAAA,EAAG;IACjB,MAAM;MAAE9B;IAAI,CAAC,GAAG,IAAI;;IAEpB;IACA,MAAM8B,YAAY,GAAG9B,GAAG,CAACgC,QAAQ,EAAEC,YAAY,GAC3C,UAAUjC,GAAG,CAACgC,QAAQ,CAACC,YAAY,EAAE,GACrCjC,GAAG,CAACgC,QAAQ,EAAEE,GAAG;IAErB,OAAOvC,SAAS,CAACmC,YAAY,CAAC;EAChC;EAEA,IAAIC,QAAQA,CAAA,EAAG;IACb,MAAM;MAAE/B;IAAI,CAAC,GAAG,IAAI;IACpB,OAAOA,GAAG,CAACmC,WAAW,EAAEC,KAAK;EAC/B;EAEAlB,OAAOA,CAACF,IAAY,EAAU;IAC5B,MAAMqB,QAAQ,GAAG,IAAI,CAACnC,KAAK,CAACmC,QAAQ;IAEpC,IAAIrB,IAAI,KAAK,GAAG,EAAE;MAChB,OAAO,IAAIqB,QAAQ,EAAE;IACvB;;IAEA;IACA,MAAMC,kBAAkB,GAAGtB,IAAI,CAACuB,UAAU,CAAC,GAAG,CAAC,GAAGvB,IAAI,CAACwB,SAAS,CAAC,CAAC,CAAC,GAAGxB,IAAI;IAC1E,IAAIyB,SAAS,GAAG,IAAIJ,QAAQ,EAAE;IAC9B,IAAIC,kBAAkB,EAAE;MACtBG,SAAS,IAAI,IAAIH,kBAAkB,EAAE;IACvC;IACAG,SAAS,GAAGA,SAAS,CAACC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;IAE7C,OAAOD,SAAS;EAClB;EAEA5C,YAAYA,CAAA,EAAG;IACb,OAAOA,YAAY,CAAC,IAAI,CAACK,KAAK,CAAC;EACjC;EAEAyC,cAAcA,CAAA,EAAG;IACf,OAAOlD,cAAc,CAACmD,OAAO,CAACC,OAAO,CAAC,CAAC;EACzC;EAEAC,aAAaA,CAAA,EAAG;IACd,OAAOrD,cAAc,CAACsD,MAAM,CAACF,OAAO,CAAC,CAAC;EACxC;EAEAG,mBAAmBA,CAAA,EAIgC;IACjD,OAAO,CAACC,OAAO,EAAEC,OAAO,EAAEC,CAAC,KAAK;MAC9B,MAAM;QAAE7B,SAAS;QAAEb;MAAS,CAAC,GAAG,IAAI;MACpC,OAAO0C,CAAC,CAACpC,IAAI,CAACN,QAAQ,EAAEa,SAAS,CAAC;IACpC,CAAC;EACH;EAEA8B,oBAAoBA,CAAA,EAIsC;IACxD,MAAM1D,IAAI,CAAC2D,UAAU,CAAC,8CAA8C,CAAC;EACvE;EAEAC,qBAAqBA,CAACC,MAAc,EAAW;IAC7C,OAAO3D,qBAAqB,CAAC2D,MAAM,CAAC,KAAKC,SAAS,IAAI,IAAI,CAAC9C,gBAAgB;EAC7E;AACF","ignoreList":[]}