@defra/forms-engine-plugin 4.0.24 → 4.0.26

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

@@ -1 +1 @@
-{"version":3,"file":"SummaryPageController.js","names":["hasComponentsEvenIfNoNext","Boom","ComponentCollection","FileUploadField","getAnswer","checkEmailAddressForLiveFormSubmission","checkFormStatus","getCacheService","SummaryViewModel","QuestionPageController","FormAction","SummaryPageController","allowSaveAndExit","constructor","model","pageDef","viewName","collection","components","page","getSummaryViewModel","request","context","viewModel","query","payload","errors","getViewModel","backLink","getBackLink","feedbackLink","phaseTag","shouldShowSaveAndExit","server","makeGetRouteHandler","h","hasMissingNotificationEmail","view","makePostRouteHandler","action","SaveAndExit","handleSaveAndExit","handleFormSubmit","params","cacheService","formsService","services","getFormMetadata","formMetadata","slug","notificationEmail","isPreview","emailAddress","def","outputEmail","submitForm","setConfirmationState","confirmed","clearState","proceed","getStatusPath","postRouteOptions","ext","onPreHandler","method","continue","summaryViewModel","extendFileRetention","state","formStatus","logTags","logger","info","items","getFormSubmissionData","details","submitResponse","submitData","yar","id","undefined","badRequest","outputService","submit","updatedRetrievalKey","formSubmissionService","persistFiles","files","pages","forEach","fileUploadComponents","fields","filter","component","values","getFormValueFromState","length","push","map","status","fileId","form","file","initiatedRetrievalKey","metadata","retrievalKey","sessionId","main","item","name","title","label","value","field","format","repeaters","subItems","detailItems","subItem","relevantPages","href","flatMap","flat"],"sources":["../../../../../src/server/plugins/engine/pageControllers/SummaryPageController.ts"],"sourcesContent":["import {\n  hasComponentsEvenIfNoNext,\n  type FormMetadata,\n  type Page,\n  type SubmitPayload\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type RouteOptions } from '@hapi/hapi'\n\nimport { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js'\nimport { getAnswer } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport {\n  checkEmailAddressForLiveFormSubmission,\n  checkFormStatus,\n  getCacheService\n} from '~/src/server/plugins/engine/helpers.js'\nimport {\n  SummaryViewModel,\n  type FormModel\n} from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type Detail,\n  type DetailItem\n} from '~/src/server/plugins/engine/models/types.js'\nimport { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'\nimport {\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  FormAction,\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs,\n  type FormResponseToolkit\n} from '~/src/server/routes/types.js'\n\nexport class SummaryPageController extends QuestionPageController {\n  declare pageDef: Page\n  allowSaveAndExit = true\n\n  /**\n   * The controller which is used when Page[\"controller\"] is defined as \"./pages/summary.js\"\n   */\n\n  constructor(model: FormModel, pageDef: Page) {\n    super(model, pageDef)\n    this.viewName = 'summary'\n\n    // Components collection\n    this.collection = new ComponentCollection(\n      hasComponentsEvenIfNoNext(pageDef) ? pageDef.components : [],\n      { model, page: this }\n    )\n  }\n\n  getSummaryViewModel(\n    request: FormContextRequest,\n    context: FormContext\n  ): SummaryViewModel {\n    const viewModel = new SummaryViewModel(request, this, context)\n\n    const { query } = request\n    const { payload, errors } = context\n    const components = this.collection.getViewModel(payload, errors, query)\n\n    // We already figure these out in the base page controller. Take them and apply them to our page-specific model.\n    // This is a stop-gap until we can add proper inheritance in place.\n    viewModel.backLink = this.getBackLink(request, context)\n    viewModel.feedbackLink = this.feedbackLink\n    viewModel.phaseTag = this.phaseTag\n    viewModel.components = components\n    viewModel.allowSaveAndExit = this.shouldShowSaveAndExit(request.server)\n    viewModel.errors = errors\n\n    return viewModel\n  }\n\n  /**\n   * Returns an async function. This is called in plugin.ts when there is a GET request at `/{id}/{path*}`,\n   */\n  makeGetRouteHandler() {\n    return async (\n      request: FormRequest,\n      context: FormContext,\n      h: FormResponseToolkit\n    ) => {\n      const { viewName } = this\n\n      const viewModel = this.getSummaryViewModel(request, context)\n\n      viewModel.hasMissingNotificationEmail =\n        await this.hasMissingNotificationEmail(request, context)\n\n      return h.view(viewName, viewModel)\n    }\n  }\n\n  /**\n   * Returns an async function. This is called in plugin.ts when there is a POST request at `/{id}/{path*}`.\n   * If a form is incomplete, a user will be redirected to the start page.\n   */\n  makePostRouteHandler() {\n    return async (\n      request: FormRequestPayload,\n      context: FormContext,\n      h: FormResponseToolkit\n    ) => {\n      // Check if this is a save-and-exit action\n      const { action } = request.payload\n      if (action === FormAction.SaveAndExit) {\n        return this.handleSaveAndExit(request, context, h)\n      }\n\n      return this.handleFormSubmit(request, context, h)\n    }\n  }\n\n  async handleFormSubmit(\n    request: FormRequestPayload,\n    context: FormContext,\n    h: FormResponseToolkit\n  ) {\n    const { model } = this\n    const { params } = request\n\n    const cacheService = getCacheService(request.server)\n\n    const { formsService } = this.model.services\n    const { getFormMetadata } = formsService\n\n    // Get the form metadata using the `slug` param\n    const formMetadata = await getFormMetadata(params.slug)\n    const { notificationEmail } = formMetadata\n    const { isPreview } = checkFormStatus(request.params)\n    const emailAddress = notificationEmail ?? this.model.def.outputEmail\n\n    checkEmailAddressForLiveFormSubmission(emailAddress, isPreview)\n\n    // Send submission email\n    if (emailAddress) {\n      const viewModel = this.getSummaryViewModel(request, context)\n      await submitForm(\n        context,\n        request,\n        viewModel,\n        model,\n        emailAddress,\n        formMetadata\n      )\n    }\n\n    await cacheService.setConfirmationState(request, { confirmed: true })\n\n    // Clear all form data\n    await cacheService.clearState(request)\n\n    return this.proceed(request, h, this.getStatusPath())\n  }\n\n  get postRouteOptions(): RouteOptions<FormRequestPayloadRefs> {\n    return {\n      ext: {\n        onPreHandler: {\n          method(request, h) {\n            return h.continue\n          }\n        }\n      }\n    }\n  }\n}\n\nexport async function submitForm(\n  context: FormContext,\n  request: FormRequestPayload,\n  summaryViewModel: SummaryViewModel,\n  model: FormModel,\n  emailAddress: string,\n  formMetadata: FormMetadata\n) {\n  await extendFileRetention(model, context.state, emailAddress)\n\n  const formStatus = checkFormStatus(request.params)\n  const logTags = ['submit', 'submissionApi']\n\n  request.logger.info(logTags, 'Preparing email', formStatus)\n\n  // Get detail items\n  const items = getFormSubmissionData(\n    summaryViewModel.context,\n    summaryViewModel.details\n  )\n\n  // Submit data\n  request.logger.info(logTags, 'Submitting data')\n  const submitResponse = await submitData(\n    model,\n    items,\n    emailAddress,\n    request.yar.id\n  )\n\n  if (submitResponse === undefined) {\n    throw Boom.badRequest('Unexpected empty response from submit api')\n  }\n\n  return model.services.outputService.submit(\n    context,\n    request,\n    model,\n    emailAddress,\n    items,\n    submitResponse,\n    formMetadata\n  )\n}\n\nasync function extendFileRetention(\n  model: FormModel,\n  state: FormSubmissionState,\n  updatedRetrievalKey: string\n) {\n  const { formSubmissionService } = model.services\n  const { persistFiles } = formSubmissionService\n  const files: { fileId: string; initiatedRetrievalKey: string }[] = []\n\n  // For each file upload component with files in\n  // state, add the files to the batch getting persisted\n  model.pages.forEach((page) => {\n    const fileUploadComponents = page.collection.fields.filter(\n      (component) => component instanceof FileUploadField\n    )\n\n    fileUploadComponents.forEach((component) => {\n      const values = component.getFormValueFromState(state)\n      if (!values?.length) {\n        return\n      }\n\n      files.push(\n        ...values.map(({ status }) => ({\n          fileId: status.form.file.fileId,\n          initiatedRetrievalKey: status.metadata.retrievalKey\n        }))\n      )\n    })\n  })\n\n  if (files.length) {\n    return persistFiles(files, updatedRetrievalKey)\n  }\n}\n\nfunction submitData(\n  model: FormModel,\n  items: DetailItem[],\n  retrievalKey: string,\n  sessionId: string\n) {\n  const { formSubmissionService } = model.services\n  const { submit } = formSubmissionService\n\n  const payload: SubmitPayload = {\n    sessionId,\n    retrievalKey,\n\n    // Main form answers\n    main: items\n      .filter((item) => 'field' in item)\n      .map((item) => ({\n        name: item.name,\n        title: item.label,\n        value: getAnswer(item.field, item.state, { format: 'data' })\n      })),\n\n    // Repeater form answers\n    repeaters: items\n      .filter((item) => 'subItems' in item)\n      .map((item) => ({\n        name: item.name,\n        title: item.label,\n\n        // Repeater item values\n        value: item.subItems.map((detailItems) =>\n          detailItems.map((subItem) => ({\n            name: subItem.name,\n            title: subItem.label,\n            value: getAnswer(subItem.field, subItem.state, { format: 'data' })\n          }))\n        )\n      }))\n  }\n\n  return submit(payload)\n}\n\nexport function getFormSubmissionData(context: FormContext, details: Detail[]) {\n  return context.relevantPages\n    .map(({ href }) =>\n      details.flatMap(({ items }) =>\n        items.filter(({ page }) => page.href === href)\n      )\n    )\n    .flat()\n}\n"],"mappings":"AAAA,SACEA,yBAAyB,QAIpB,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAG7B,SAASC,mBAAmB;AAC5B,SAASC,eAAe;AACxB,SAASC,SAAS;AAClB,SACEC,sCAAsC,EACtCC,eAAe,EACfC,eAAe;AAEjB,SACEC,gBAAgB;AAOlB,SAASC,sBAAsB;AAM/B,SACEC,UAAU;AAOZ,OAAO,MAAMC,qBAAqB,SAASF,sBAAsB,CAAC;EAEhEG,gBAAgB,GAAG,IAAI;;EAEvB;AACF;AACA;;EAEEC,WAAWA,CAACC,KAAgB,EAAEC,OAAa,EAAE;IAC3C,KAAK,CAACD,KAAK,EAAEC,OAAO,CAAC;IACrB,IAAI,CAACC,QAAQ,GAAG,SAAS;;IAEzB;IACA,IAAI,CAACC,UAAU,GAAG,IAAIf,mBAAmB,CACvCF,yBAAyB,CAACe,OAAO,CAAC,GAAGA,OAAO,CAACG,UAAU,GAAG,EAAE,EAC5D;MAAEJ,KAAK;MAAEK,IAAI,EAAE;IAAK,CACtB,CAAC;EACH;EAEAC,mBAAmBA,CACjBC,OAA2B,EAC3BC,OAAoB,EACF;IAClB,MAAMC,SAAS,GAAG,IAAIf,gBAAgB,CAACa,OAAO,EAAE,IAAI,EAAEC,OAAO,CAAC;IAE9D,MAAM;MAAEE;IAAM,CAAC,GAAGH,OAAO;IACzB,MAAM;MAAEI,OAAO;MAAEC;IAAO,CAAC,GAAGJ,OAAO;IACnC,MAAMJ,UAAU,GAAG,IAAI,CAACD,UAAU,CAACU,YAAY,CAACF,OAAO,EAAEC,MAAM,EAAEF,KAAK,CAAC;;IAEvE;IACA;IACAD,SAAS,CAACK,QAAQ,GAAG,IAAI,CAACC,WAAW,CAACR,OAAO,EAAEC,OAAO,CAAC;IACvDC,SAAS,CAACO,YAAY,GAAG,IAAI,CAACA,YAAY;IAC1CP,SAAS,CAACQ,QAAQ,GAAG,IAAI,CAACA,QAAQ;IAClCR,SAAS,CAACL,UAAU,GAAGA,UAAU;IACjCK,SAAS,CAACX,gBAAgB,GAAG,IAAI,CAACoB,qBAAqB,CAACX,OAAO,CAACY,MAAM,CAAC;IACvEV,SAAS,CAACG,MAAM,GAAGA,MAAM;IAEzB,OAAOH,SAAS;EAClB;;EAEA;AACF;AACA;EACEW,mBAAmBA,CAAA,EAAG;IACpB,OAAO,OACLb,OAAoB,EACpBC,OAAoB,EACpBa,CAAsB,KACnB;MACH,MAAM;QAAEnB;MAAS,CAAC,GAAG,IAAI;MAEzB,MAAMO,SAAS,GAAG,IAAI,CAACH,mBAAmB,CAACC,OAAO,EAAEC,OAAO,CAAC;MAE5DC,SAAS,CAACa,2BAA2B,GACnC,MAAM,IAAI,CAACA,2BAA2B,CAACf,OAAO,EAAEC,OAAO,CAAC;MAE1D,OAAOa,CAAC,CAACE,IAAI,CAACrB,QAAQ,EAAEO,SAAS,CAAC;IACpC,CAAC;EACH;;EAEA;AACF;AACA;AACA;EACEe,oBAAoBA,CAAA,EAAG;IACrB,OAAO,OACLjB,OAA2B,EAC3BC,OAAoB,EACpBa,CAAsB,KACnB;MACH;MACA,MAAM;QAAEI;MAAO,CAAC,GAAGlB,OAAO,CAACI,OAAO;MAClC,IAAIc,MAAM,KAAK7B,UAAU,CAAC8B,WAAW,EAAE;QACrC,OAAO,IAAI,CAACC,iBAAiB,CAACpB,OAAO,EAAEC,OAAO,EAAEa,CAAC,CAAC;MACpD;MAEA,OAAO,IAAI,CAACO,gBAAgB,CAACrB,OAAO,EAAEC,OAAO,EAAEa,CAAC,CAAC;IACnD,CAAC;EACH;EAEA,MAAMO,gBAAgBA,CACpBrB,OAA2B,EAC3BC,OAAoB,EACpBa,CAAsB,EACtB;IACA,MAAM;MAAErB;IAAM,CAAC,GAAG,IAAI;IACtB,MAAM;MAAE6B;IAAO,CAAC,GAAGtB,OAAO;IAE1B,MAAMuB,YAAY,GAAGrC,eAAe,CAACc,OAAO,CAACY,MAAM,CAAC;IAEpD,MAAM;MAAEY;IAAa,CAAC,GAAG,IAAI,CAAC/B,KAAK,CAACgC,QAAQ;IAC5C,MAAM;MAAEC;IAAgB,CAAC,GAAGF,YAAY;;IAExC;IACA,MAAMG,YAAY,GAAG,MAAMD,eAAe,CAACJ,MAAM,CAACM,IAAI,CAAC;IACvD,MAAM;MAAEC;IAAkB,CAAC,GAAGF,YAAY;IAC1C,MAAM;MAAEG;IAAU,CAAC,GAAG7C,eAAe,CAACe,OAAO,CAACsB,MAAM,CAAC;IACrD,MAAMS,YAAY,GAAGF,iBAAiB,IAAI,IAAI,CAACpC,KAAK,CAACuC,GAAG,CAACC,WAAW;IAEpEjD,sCAAsC,CAAC+C,YAAY,EAAED,SAAS,CAAC;;IAE/D;IACA,IAAIC,YAAY,EAAE;MAChB,MAAM7B,SAAS,GAAG,IAAI,CAACH,mBAAmB,CAACC,OAAO,EAAEC,OAAO,CAAC;MAC5D,MAAMiC,UAAU,CACdjC,OAAO,EACPD,OAAO,EACPE,SAAS,EACTT,KAAK,EACLsC,YAAY,EACZJ,YACF,CAAC;IACH;IAEA,MAAMJ,YAAY,CAACY,oBAAoB,CAACnC,OAAO,EAAE;MAAEoC,SAAS,EAAE;IAAK,CAAC,CAAC;;IAErE;IACA,MAAMb,YAAY,CAACc,UAAU,CAACrC,OAAO,CAAC;IAEtC,OAAO,IAAI,CAACsC,OAAO,CAACtC,OAAO,EAAEc,CAAC,EAAE,IAAI,CAACyB,aAAa,CAAC,CAAC,CAAC;EACvD;EAEA,IAAIC,gBAAgBA,CAAA,EAAyC;IAC3D,OAAO;MACLC,GAAG,EAAE;QACHC,YAAY,EAAE;UACZC,MAAMA,CAAC3C,OAAO,EAAEc,CAAC,EAAE;YACjB,OAAOA,CAAC,CAAC8B,QAAQ;UACnB;QACF;MACF;IACF,CAAC;EACH;AACF;AAEA,OAAO,eAAeV,UAAUA,CAC9BjC,OAAoB,EACpBD,OAA2B,EAC3B6C,gBAAkC,EAClCpD,KAAgB,EAChBsC,YAAoB,EACpBJ,YAA0B,EAC1B;EACA,MAAMmB,mBAAmB,CAACrD,KAAK,EAAEQ,OAAO,CAAC8C,KAAK,EAAEhB,YAAY,CAAC;EAE7D,MAAMiB,UAAU,GAAG/D,eAAe,CAACe,OAAO,CAACsB,MAAM,CAAC;EAClD,MAAM2B,OAAO,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC;EAE3CjD,OAAO,CAACkD,MAAM,CAACC,IAAI,CAACF,OAAO,EAAE,iBAAiB,EAAED,UAAU,CAAC;;EAE3D;EACA,MAAMI,KAAK,GAAGC,qBAAqB,CACjCR,gBAAgB,CAAC5C,OAAO,EACxB4C,gBAAgB,CAACS,OACnB,CAAC;;EAED;EACAtD,OAAO,CAACkD,MAAM,CAACC,IAAI,CAACF,OAAO,EAAE,iBAAiB,CAAC;EAC/C,MAAMM,cAAc,GAAG,MAAMC,UAAU,CACrC/D,KAAK,EACL2D,KAAK,EACLrB,YAAY,EACZ/B,OAAO,CAACyD,GAAG,CAACC,EACd,CAAC;EAED,IAAIH,cAAc,KAAKI,SAAS,EAAE;IAChC,MAAM/E,IAAI,CAACgF,UAAU,CAAC,2CAA2C,CAAC;EACpE;EAEA,OAAOnE,KAAK,CAACgC,QAAQ,CAACoC,aAAa,CAACC,MAAM,CACxC7D,OAAO,EACPD,OAAO,EACPP,KAAK,EACLsC,YAAY,EACZqB,KAAK,EACLG,cAAc,EACd5B,YACF,CAAC;AACH;AAEA,eAAemB,mBAAmBA,CAChCrD,KAAgB,EAChBsD,KAA0B,EAC1BgB,mBAA2B,EAC3B;EACA,MAAM;IAAEC;EAAsB,CAAC,GAAGvE,KAAK,CAACgC,QAAQ;EAChD,MAAM;IAAEwC;EAAa,CAAC,GAAGD,qBAAqB;EAC9C,MAAME,KAA0D,GAAG,EAAE;;EAErE;EACA;EACAzE,KAAK,CAAC0E,KAAK,CAACC,OAAO,CAAEtE,IAAI,IAAK;IAC5B,MAAMuE,oBAAoB,GAAGvE,IAAI,CAACF,UAAU,CAAC0E,MAAM,CAACC,MAAM,CACvDC,SAAS,IAAKA,SAAS,YAAY1F,eACtC,CAAC;IAEDuF,oBAAoB,CAACD,OAAO,CAAEI,SAAS,IAAK;MAC1C,MAAMC,MAAM,GAAGD,SAAS,CAACE,qBAAqB,CAAC3B,KAAK,CAAC;MACrD,IAAI,CAAC0B,MAAM,EAAEE,MAAM,EAAE;QACnB;MACF;MAEAT,KAAK,CAACU,IAAI,CACR,GAAGH,MAAM,CAACI,GAAG,CAAC,CAAC;QAAEC;MAAO,CAAC,MAAM;QAC7BC,MAAM,EAAED,MAAM,CAACE,IAAI,CAACC,IAAI,CAACF,MAAM;QAC/BG,qBAAqB,EAAEJ,MAAM,CAACK,QAAQ,CAACC;MACzC,CAAC,CAAC,CACJ,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF,IAAIlB,KAAK,CAACS,MAAM,EAAE;IAChB,OAAOV,YAAY,CAACC,KAAK,EAAEH,mBAAmB,CAAC;EACjD;AACF;AAEA,SAASP,UAAUA,CACjB/D,KAAgB,EAChB2D,KAAmB,EACnBgC,YAAoB,EACpBC,SAAiB,EACjB;EACA,MAAM;IAAErB;EAAsB,CAAC,GAAGvE,KAAK,CAACgC,QAAQ;EAChD,MAAM;IAAEqC;EAAO,CAAC,GAAGE,qBAAqB;EAExC,MAAM5D,OAAsB,GAAG;IAC7BiF,SAAS;IACTD,YAAY;IAEZ;IACAE,IAAI,EAAElC,KAAK,CACRmB,MAAM,CAAEgB,IAAI,IAAK,OAAO,IAAIA,IAAI,CAAC,CACjCV,GAAG,CAAEU,IAAI,KAAM;MACdC,IAAI,EAAED,IAAI,CAACC,IAAI;MACfC,KAAK,EAAEF,IAAI,CAACG,KAAK;MACjBC,KAAK,EAAE5G,SAAS,CAACwG,IAAI,CAACK,KAAK,EAAEL,IAAI,CAACxC,KAAK,EAAE;QAAE8C,MAAM,EAAE;MAAO,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEL;IACAC,SAAS,EAAE1C,KAAK,CACbmB,MAAM,CAAEgB,IAAI,IAAK,UAAU,IAAIA,IAAI,CAAC,CACpCV,GAAG,CAAEU,IAAI,KAAM;MACdC,IAAI,EAAED,IAAI,CAACC,IAAI;MACfC,KAAK,EAAEF,IAAI,CAACG,KAAK;MAEjB;MACAC,KAAK,EAAEJ,IAAI,CAACQ,QAAQ,CAAClB,GAAG,CAAEmB,WAAW,IACnCA,WAAW,CAACnB,GAAG,CAAEoB,OAAO,KAAM;QAC5BT,IAAI,EAAES,OAAO,CAACT,IAAI;QAClBC,KAAK,EAAEQ,OAAO,CAACP,KAAK;QACpBC,KAAK,EAAE5G,SAAS,CAACkH,OAAO,CAACL,KAAK,EAAEK,OAAO,CAAClD,KAAK,EAAE;UAAE8C,MAAM,EAAE;QAAO,CAAC;MACnE,CAAC,CAAC,CACJ;IACF,CAAC,CAAC;EACN,CAAC;EAED,OAAO/B,MAAM,CAAC1D,OAAO,CAAC;AACxB;AAEA,OAAO,SAASiD,qBAAqBA,CAACpD,OAAoB,EAAEqD,OAAiB,EAAE;EAC7E,OAAOrD,OAAO,CAACiG,aAAa,CACzBrB,GAAG,CAAC,CAAC;IAAEsB;EAAK,CAAC,KACZ7C,OAAO,CAAC8C,OAAO,CAAC,CAAC;IAAEhD;EAAM,CAAC,KACxBA,KAAK,CAACmB,MAAM,CAAC,CAAC;IAAEzE;EAAK,CAAC,KAAKA,IAAI,CAACqG,IAAI,KAAKA,IAAI,CAC/C,CACF,CAAC,CACAE,IAAI,CAAC,CAAC;AACX","ignoreList":[]}
+{"version":3,"file":"SummaryPageController.js","names":["hasComponentsEvenIfNoNext","Boom","ComponentCollection","FileUploadField","getAnswer","checkEmailAddressForLiveFormSubmission","checkFormStatus","getCacheService","SummaryViewModel","QuestionPageController","FormAction","SummaryPageController","allowSaveAndExit","constructor","model","pageDef","viewName","collection","components","page","getSummaryViewModel","request","context","viewModel","query","payload","errors","getViewModel","backLink","getBackLink","feedbackLink","phaseTag","shouldShowSaveAndExit","server","makeGetRouteHandler","h","hasMissingNotificationEmail","view","makePostRouteHandler","action","SaveAndExit","handleSaveAndExit","handleFormSubmit","params","cacheService","formsService","services","getFormMetadata","formMetadata","slug","notificationEmail","isPreview","emailAddress","def","outputEmail","submitForm","setConfirmationState","confirmed","formId","state","clearState","proceed","getStatusPath","postRouteOptions","ext","onPreHandler","method","continue","summaryViewModel","extendFileRetention","formStatus","logTags","logger","info","items","getFormSubmissionData","details","submitResponse","submitData","yar","id","undefined","badRequest","outputService","submit","updatedRetrievalKey","formSubmissionService","persistFiles","files","pages","forEach","fileUploadComponents","fields","filter","component","values","getFormValueFromState","length","push","map","status","fileId","form","file","initiatedRetrievalKey","metadata","retrievalKey","sessionId","main","item","name","title","label","value","field","format","repeaters","subItems","detailItems","subItem","relevantPages","href","flatMap","flat"],"sources":["../../../../../src/server/plugins/engine/pageControllers/SummaryPageController.ts"],"sourcesContent":["import {\n  hasComponentsEvenIfNoNext,\n  type FormMetadata,\n  type Page,\n  type SubmitPayload\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type RouteOptions } from '@hapi/hapi'\n\nimport { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js'\nimport { getAnswer } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport {\n  checkEmailAddressForLiveFormSubmission,\n  checkFormStatus,\n  getCacheService\n} from '~/src/server/plugins/engine/helpers.js'\nimport {\n  SummaryViewModel,\n  type FormModel\n} from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type Detail,\n  type DetailItem\n} from '~/src/server/plugins/engine/models/types.js'\nimport { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'\nimport {\n  type FormConfirmationState,\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  FormAction,\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs,\n  type FormResponseToolkit\n} from '~/src/server/routes/types.js'\n\nexport class SummaryPageController extends QuestionPageController {\n  declare pageDef: Page\n  allowSaveAndExit = true\n\n  /**\n   * The controller which is used when Page[\"controller\"] is defined as \"./pages/summary.js\"\n   */\n\n  constructor(model: FormModel, pageDef: Page) {\n    super(model, pageDef)\n    this.viewName = 'summary'\n\n    // Components collection\n    this.collection = new ComponentCollection(\n      hasComponentsEvenIfNoNext(pageDef) ? pageDef.components : [],\n      { model, page: this }\n    )\n  }\n\n  getSummaryViewModel(\n    request: FormContextRequest,\n    context: FormContext\n  ): SummaryViewModel {\n    const viewModel = new SummaryViewModel(request, this, context)\n\n    const { query } = request\n    const { payload, errors } = context\n    const components = this.collection.getViewModel(payload, errors, query)\n\n    // We already figure these out in the base page controller. Take them and apply them to our page-specific model.\n    // This is a stop-gap until we can add proper inheritance in place.\n    viewModel.backLink = this.getBackLink(request, context)\n    viewModel.feedbackLink = this.feedbackLink\n    viewModel.phaseTag = this.phaseTag\n    viewModel.components = components\n    viewModel.allowSaveAndExit = this.shouldShowSaveAndExit(request.server)\n    viewModel.errors = errors\n\n    return viewModel\n  }\n\n  /**\n   * Returns an async function. This is called in plugin.ts when there is a GET request at `/{id}/{path*}`,\n   */\n  makeGetRouteHandler() {\n    return async (\n      request: FormRequest,\n      context: FormContext,\n      h: FormResponseToolkit\n    ) => {\n      const { viewName } = this\n\n      const viewModel = this.getSummaryViewModel(request, context)\n\n      viewModel.hasMissingNotificationEmail =\n        await this.hasMissingNotificationEmail(request, context)\n\n      return h.view(viewName, viewModel)\n    }\n  }\n\n  /**\n   * Returns an async function. This is called in plugin.ts when there is a POST request at `/{id}/{path*}`.\n   * If a form is incomplete, a user will be redirected to the start page.\n   */\n  makePostRouteHandler() {\n    return async (\n      request: FormRequestPayload,\n      context: FormContext,\n      h: FormResponseToolkit\n    ) => {\n      // Check if this is a save-and-exit action\n      const { action } = request.payload\n      if (action === FormAction.SaveAndExit) {\n        return this.handleSaveAndExit(request, context, h)\n      }\n\n      return this.handleFormSubmit(request, context, h)\n    }\n  }\n\n  async handleFormSubmit(\n    request: FormRequestPayload,\n    context: FormContext,\n    h: FormResponseToolkit\n  ) {\n    const { model } = this\n    const { params } = request\n\n    const cacheService = getCacheService(request.server)\n\n    const { formsService } = this.model.services\n    const { getFormMetadata } = formsService\n\n    // Get the form metadata using the `slug` param\n    const formMetadata = await getFormMetadata(params.slug)\n    const { notificationEmail } = formMetadata\n    const { isPreview } = checkFormStatus(request.params)\n    const emailAddress = notificationEmail ?? this.model.def.outputEmail\n\n    checkEmailAddressForLiveFormSubmission(emailAddress, isPreview)\n\n    // Send submission email\n    if (emailAddress) {\n      const viewModel = this.getSummaryViewModel(request, context)\n      await submitForm(\n        context,\n        request,\n        viewModel,\n        model,\n        emailAddress,\n        formMetadata\n      )\n    }\n\n    await cacheService.setConfirmationState(request, {\n      confirmed: true,\n      formId: context.state.formId\n    } as FormConfirmationState)\n\n    // Clear all form data\n    await cacheService.clearState(request)\n\n    return this.proceed(request, h, this.getStatusPath())\n  }\n\n  get postRouteOptions(): RouteOptions<FormRequestPayloadRefs> {\n    return {\n      ext: {\n        onPreHandler: {\n          method(request, h) {\n            return h.continue\n          }\n        }\n      }\n    }\n  }\n}\n\nexport async function submitForm(\n  context: FormContext,\n  request: FormRequestPayload,\n  summaryViewModel: SummaryViewModel,\n  model: FormModel,\n  emailAddress: string,\n  formMetadata: FormMetadata\n) {\n  await extendFileRetention(model, context.state, emailAddress)\n\n  const formStatus = checkFormStatus(request.params)\n  const logTags = ['submit', 'submissionApi']\n\n  request.logger.info(logTags, 'Preparing email', formStatus)\n\n  // Get detail items\n  const items = getFormSubmissionData(\n    summaryViewModel.context,\n    summaryViewModel.details\n  )\n\n  // Submit data\n  request.logger.info(logTags, 'Submitting data')\n  const submitResponse = await submitData(\n    model,\n    items,\n    emailAddress,\n    request.yar.id\n  )\n\n  if (submitResponse === undefined) {\n    throw Boom.badRequest('Unexpected empty response from submit api')\n  }\n\n  return model.services.outputService.submit(\n    context,\n    request,\n    model,\n    emailAddress,\n    items,\n    submitResponse,\n    formMetadata\n  )\n}\n\nasync function extendFileRetention(\n  model: FormModel,\n  state: FormSubmissionState,\n  updatedRetrievalKey: string\n) {\n  const { formSubmissionService } = model.services\n  const { persistFiles } = formSubmissionService\n  const files: { fileId: string; initiatedRetrievalKey: string }[] = []\n\n  // For each file upload component with files in\n  // state, add the files to the batch getting persisted\n  model.pages.forEach((page) => {\n    const fileUploadComponents = page.collection.fields.filter(\n      (component) => component instanceof FileUploadField\n    )\n\n    fileUploadComponents.forEach((component) => {\n      const values = component.getFormValueFromState(state)\n      if (!values?.length) {\n        return\n      }\n\n      files.push(\n        ...values.map(({ status }) => ({\n          fileId: status.form.file.fileId,\n          initiatedRetrievalKey: status.metadata.retrievalKey\n        }))\n      )\n    })\n  })\n\n  if (files.length) {\n    return persistFiles(files, updatedRetrievalKey)\n  }\n}\n\nfunction submitData(\n  model: FormModel,\n  items: DetailItem[],\n  retrievalKey: string,\n  sessionId: string\n) {\n  const { formSubmissionService } = model.services\n  const { submit } = formSubmissionService\n\n  const payload: SubmitPayload = {\n    sessionId,\n    retrievalKey,\n\n    // Main form answers\n    main: items\n      .filter((item) => 'field' in item)\n      .map((item) => ({\n        name: item.name,\n        title: item.label,\n        value: getAnswer(item.field, item.state, { format: 'data' })\n      })),\n\n    // Repeater form answers\n    repeaters: items\n      .filter((item) => 'subItems' in item)\n      .map((item) => ({\n        name: item.name,\n        title: item.label,\n\n        // Repeater item values\n        value: item.subItems.map((detailItems) =>\n          detailItems.map((subItem) => ({\n            name: subItem.name,\n            title: subItem.label,\n            value: getAnswer(subItem.field, subItem.state, { format: 'data' })\n          }))\n        )\n      }))\n  }\n\n  return submit(payload)\n}\n\nexport function getFormSubmissionData(context: FormContext, details: Detail[]) {\n  return context.relevantPages\n    .map(({ href }) =>\n      details.flatMap(({ items }) =>\n        items.filter(({ page }) => page.href === href)\n      )\n    )\n    .flat()\n}\n"],"mappings":"AAAA,SACEA,yBAAyB,QAIpB,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAG7B,SAASC,mBAAmB;AAC5B,SAASC,eAAe;AACxB,SAASC,SAAS;AAClB,SACEC,sCAAsC,EACtCC,eAAe,EACfC,eAAe;AAEjB,SACEC,gBAAgB;AAOlB,SAASC,sBAAsB;AAO/B,SACEC,UAAU;AAOZ,OAAO,MAAMC,qBAAqB,SAASF,sBAAsB,CAAC;EAEhEG,gBAAgB,GAAG,IAAI;;EAEvB;AACF;AACA;;EAEEC,WAAWA,CAACC,KAAgB,EAAEC,OAAa,EAAE;IAC3C,KAAK,CAACD,KAAK,EAAEC,OAAO,CAAC;IACrB,IAAI,CAACC,QAAQ,GAAG,SAAS;;IAEzB;IACA,IAAI,CAACC,UAAU,GAAG,IAAIf,mBAAmB,CACvCF,yBAAyB,CAACe,OAAO,CAAC,GAAGA,OAAO,CAACG,UAAU,GAAG,EAAE,EAC5D;MAAEJ,KAAK;MAAEK,IAAI,EAAE;IAAK,CACtB,CAAC;EACH;EAEAC,mBAAmBA,CACjBC,OAA2B,EAC3BC,OAAoB,EACF;IAClB,MAAMC,SAAS,GAAG,IAAIf,gBAAgB,CAACa,OAAO,EAAE,IAAI,EAAEC,OAAO,CAAC;IAE9D,MAAM;MAAEE;IAAM,CAAC,GAAGH,OAAO;IACzB,MAAM;MAAEI,OAAO;MAAEC;IAAO,CAAC,GAAGJ,OAAO;IACnC,MAAMJ,UAAU,GAAG,IAAI,CAACD,UAAU,CAACU,YAAY,CAACF,OAAO,EAAEC,MAAM,EAAEF,KAAK,CAAC;;IAEvE;IACA;IACAD,SAAS,CAACK,QAAQ,GAAG,IAAI,CAACC,WAAW,CAACR,OAAO,EAAEC,OAAO,CAAC;IACvDC,SAAS,CAACO,YAAY,GAAG,IAAI,CAACA,YAAY;IAC1CP,SAAS,CAACQ,QAAQ,GAAG,IAAI,CAACA,QAAQ;IAClCR,SAAS,CAACL,UAAU,GAAGA,UAAU;IACjCK,SAAS,CAACX,gBAAgB,GAAG,IAAI,CAACoB,qBAAqB,CAACX,OAAO,CAACY,MAAM,CAAC;IACvEV,SAAS,CAACG,MAAM,GAAGA,MAAM;IAEzB,OAAOH,SAAS;EAClB;;EAEA;AACF;AACA;EACEW,mBAAmBA,CAAA,EAAG;IACpB,OAAO,OACLb,OAAoB,EACpBC,OAAoB,EACpBa,CAAsB,KACnB;MACH,MAAM;QAAEnB;MAAS,CAAC,GAAG,IAAI;MAEzB,MAAMO,SAAS,GAAG,IAAI,CAACH,mBAAmB,CAACC,OAAO,EAAEC,OAAO,CAAC;MAE5DC,SAAS,CAACa,2BAA2B,GACnC,MAAM,IAAI,CAACA,2BAA2B,CAACf,OAAO,EAAEC,OAAO,CAAC;MAE1D,OAAOa,CAAC,CAACE,IAAI,CAACrB,QAAQ,EAAEO,SAAS,CAAC;IACpC,CAAC;EACH;;EAEA;AACF;AACA;AACA;EACEe,oBAAoBA,CAAA,EAAG;IACrB,OAAO,OACLjB,OAA2B,EAC3BC,OAAoB,EACpBa,CAAsB,KACnB;MACH;MACA,MAAM;QAAEI;MAAO,CAAC,GAAGlB,OAAO,CAACI,OAAO;MAClC,IAAIc,MAAM,KAAK7B,UAAU,CAAC8B,WAAW,EAAE;QACrC,OAAO,IAAI,CAACC,iBAAiB,CAACpB,OAAO,EAAEC,OAAO,EAAEa,CAAC,CAAC;MACpD;MAEA,OAAO,IAAI,CAACO,gBAAgB,CAACrB,OAAO,EAAEC,OAAO,EAAEa,CAAC,CAAC;IACnD,CAAC;EACH;EAEA,MAAMO,gBAAgBA,CACpBrB,OAA2B,EAC3BC,OAAoB,EACpBa,CAAsB,EACtB;IACA,MAAM;MAAErB;IAAM,CAAC,GAAG,IAAI;IACtB,MAAM;MAAE6B;IAAO,CAAC,GAAGtB,OAAO;IAE1B,MAAMuB,YAAY,GAAGrC,eAAe,CAACc,OAAO,CAACY,MAAM,CAAC;IAEpD,MAAM;MAAEY;IAAa,CAAC,GAAG,IAAI,CAAC/B,KAAK,CAACgC,QAAQ;IAC5C,MAAM;MAAEC;IAAgB,CAAC,GAAGF,YAAY;;IAExC;IACA,MAAMG,YAAY,GAAG,MAAMD,eAAe,CAACJ,MAAM,CAACM,IAAI,CAAC;IACvD,MAAM;MAAEC;IAAkB,CAAC,GAAGF,YAAY;IAC1C,MAAM;MAAEG;IAAU,CAAC,GAAG7C,eAAe,CAACe,OAAO,CAACsB,MAAM,CAAC;IACrD,MAAMS,YAAY,GAAGF,iBAAiB,IAAI,IAAI,CAACpC,KAAK,CAACuC,GAAG,CAACC,WAAW;IAEpEjD,sCAAsC,CAAC+C,YAAY,EAAED,SAAS,CAAC;;IAE/D;IACA,IAAIC,YAAY,EAAE;MAChB,MAAM7B,SAAS,GAAG,IAAI,CAACH,mBAAmB,CAACC,OAAO,EAAEC,OAAO,CAAC;MAC5D,MAAMiC,UAAU,CACdjC,OAAO,EACPD,OAAO,EACPE,SAAS,EACTT,KAAK,EACLsC,YAAY,EACZJ,YACF,CAAC;IACH;IAEA,MAAMJ,YAAY,CAACY,oBAAoB,CAACnC,OAAO,EAAE;MAC/CoC,SAAS,EAAE,IAAI;MACfC,MAAM,EAAEpC,OAAO,CAACqC,KAAK,CAACD;IACxB,CAA0B,CAAC;;IAE3B;IACA,MAAMd,YAAY,CAACgB,UAAU,CAACvC,OAAO,CAAC;IAEtC,OAAO,IAAI,CAACwC,OAAO,CAACxC,OAAO,EAAEc,CAAC,EAAE,IAAI,CAAC2B,aAAa,CAAC,CAAC,CAAC;EACvD;EAEA,IAAIC,gBAAgBA,CAAA,EAAyC;IAC3D,OAAO;MACLC,GAAG,EAAE;QACHC,YAAY,EAAE;UACZC,MAAMA,CAAC7C,OAAO,EAAEc,CAAC,EAAE;YACjB,OAAOA,CAAC,CAACgC,QAAQ;UACnB;QACF;MACF;IACF,CAAC;EACH;AACF;AAEA,OAAO,eAAeZ,UAAUA,CAC9BjC,OAAoB,EACpBD,OAA2B,EAC3B+C,gBAAkC,EAClCtD,KAAgB,EAChBsC,YAAoB,EACpBJ,YAA0B,EAC1B;EACA,MAAMqB,mBAAmB,CAACvD,KAAK,EAAEQ,OAAO,CAACqC,KAAK,EAAEP,YAAY,CAAC;EAE7D,MAAMkB,UAAU,GAAGhE,eAAe,CAACe,OAAO,CAACsB,MAAM,CAAC;EAClD,MAAM4B,OAAO,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC;EAE3ClD,OAAO,CAACmD,MAAM,CAACC,IAAI,CAACF,OAAO,EAAE,iBAAiB,EAAED,UAAU,CAAC;;EAE3D;EACA,MAAMI,KAAK,GAAGC,qBAAqB,CACjCP,gBAAgB,CAAC9C,OAAO,EACxB8C,gBAAgB,CAACQ,OACnB,CAAC;;EAED;EACAvD,OAAO,CAACmD,MAAM,CAACC,IAAI,CAACF,OAAO,EAAE,iBAAiB,CAAC;EAC/C,MAAMM,cAAc,GAAG,MAAMC,UAAU,CACrChE,KAAK,EACL4D,KAAK,EACLtB,YAAY,EACZ/B,OAAO,CAAC0D,GAAG,CAACC,EACd,CAAC;EAED,IAAIH,cAAc,KAAKI,SAAS,EAAE;IAChC,MAAMhF,IAAI,CAACiF,UAAU,CAAC,2CAA2C,CAAC;EACpE;EAEA,OAAOpE,KAAK,CAACgC,QAAQ,CAACqC,aAAa,CAACC,MAAM,CACxC9D,OAAO,EACPD,OAAO,EACPP,KAAK,EACLsC,YAAY,EACZsB,KAAK,EACLG,cAAc,EACd7B,YACF,CAAC;AACH;AAEA,eAAeqB,mBAAmBA,CAChCvD,KAAgB,EAChB6C,KAA0B,EAC1B0B,mBAA2B,EAC3B;EACA,MAAM;IAAEC;EAAsB,CAAC,GAAGxE,KAAK,CAACgC,QAAQ;EAChD,MAAM;IAAEyC;EAAa,CAAC,GAAGD,qBAAqB;EAC9C,MAAME,KAA0D,GAAG,EAAE;;EAErE;EACA;EACA1E,KAAK,CAAC2E,KAAK,CAACC,OAAO,CAAEvE,IAAI,IAAK;IAC5B,MAAMwE,oBAAoB,GAAGxE,IAAI,CAACF,UAAU,CAAC2E,MAAM,CAACC,MAAM,CACvDC,SAAS,IAAKA,SAAS,YAAY3F,eACtC,CAAC;IAEDwF,oBAAoB,CAACD,OAAO,CAAEI,SAAS,IAAK;MAC1C,MAAMC,MAAM,GAAGD,SAAS,CAACE,qBAAqB,CAACrC,KAAK,CAAC;MACrD,IAAI,CAACoC,MAAM,EAAEE,MAAM,EAAE;QACnB;MACF;MAEAT,KAAK,CAACU,IAAI,CACR,GAAGH,MAAM,CAACI,GAAG,CAAC,CAAC;QAAEC;MAAO,CAAC,MAAM;QAC7BC,MAAM,EAAED,MAAM,CAACE,IAAI,CAACC,IAAI,CAACF,MAAM;QAC/BG,qBAAqB,EAAEJ,MAAM,CAACK,QAAQ,CAACC;MACzC,CAAC,CAAC,CACJ,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF,IAAIlB,KAAK,CAACS,MAAM,EAAE;IAChB,OAAOV,YAAY,CAACC,KAAK,EAAEH,mBAAmB,CAAC;EACjD;AACF;AAEA,SAASP,UAAUA,CACjBhE,KAAgB,EAChB4D,KAAmB,EACnBgC,YAAoB,EACpBC,SAAiB,EACjB;EACA,MAAM;IAAErB;EAAsB,CAAC,GAAGxE,KAAK,CAACgC,QAAQ;EAChD,MAAM;IAAEsC;EAAO,CAAC,GAAGE,qBAAqB;EAExC,MAAM7D,OAAsB,GAAG;IAC7BkF,SAAS;IACTD,YAAY;IAEZ;IACAE,IAAI,EAAElC,KAAK,CACRmB,MAAM,CAAEgB,IAAI,IAAK,OAAO,IAAIA,IAAI,CAAC,CACjCV,GAAG,CAAEU,IAAI,KAAM;MACdC,IAAI,EAAED,IAAI,CAACC,IAAI;MACfC,KAAK,EAAEF,IAAI,CAACG,KAAK;MACjBC,KAAK,EAAE7G,SAAS,CAACyG,IAAI,CAACK,KAAK,EAAEL,IAAI,CAAClD,KAAK,EAAE;QAAEwD,MAAM,EAAE;MAAO,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEL;IACAC,SAAS,EAAE1C,KAAK,CACbmB,MAAM,CAAEgB,IAAI,IAAK,UAAU,IAAIA,IAAI,CAAC,CACpCV,GAAG,CAAEU,IAAI,KAAM;MACdC,IAAI,EAAED,IAAI,CAACC,IAAI;MACfC,KAAK,EAAEF,IAAI,CAACG,KAAK;MAEjB;MACAC,KAAK,EAAEJ,IAAI,CAACQ,QAAQ,CAAClB,GAAG,CAAEmB,WAAW,IACnCA,WAAW,CAACnB,GAAG,CAAEoB,OAAO,KAAM;QAC5BT,IAAI,EAAES,OAAO,CAACT,IAAI;QAClBC,KAAK,EAAEQ,OAAO,CAACP,KAAK;QACpBC,KAAK,EAAE7G,SAAS,CAACmH,OAAO,CAACL,KAAK,EAAEK,OAAO,CAAC5D,KAAK,EAAE;UAAEwD,MAAM,EAAE;QAAO,CAAC;MACnE,CAAC,CAAC,CACJ;IACF,CAAC,CAAC;EACN,CAAC;EAED,OAAO/B,MAAM,CAAC3D,OAAO,CAAC;AACxB;AAEA,OAAO,SAASkD,qBAAqBA,CAACrD,OAAoB,EAAEsD,OAAiB,EAAE;EAC7E,OAAOtD,OAAO,CAACkG,aAAa,CACzBrB,GAAG,CAAC,CAAC;IAAEsB;EAAK,CAAC,KACZ7C,OAAO,CAAC8C,OAAO,CAAC,CAAC;IAAEhD;EAAM,CAAC,KACxBA,KAAK,CAACmB,MAAM,CAAC,CAAC;IAAE1E;EAAK,CAAC,KAAKA,IAAI,CAACsG,IAAI,KAAKA,IAAI,CAC/C,CACF,CAAC,CACAE,IAAI,CAAC,CAAC;AACX","ignoreList":[]}

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

@@ -0,0 +1,11 @@
+import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js';
+import { type AnyFormRequest } from '~/src/server/plugins/engine/types.js';
+import { type FormQuery } from '~/src/server/routes/types.js';
+export declare function stripParam(query: FormQuery, paramToRemove: string): FormQuery | undefined;
+/**
+ * Any hidden parameters defined in the FormDefinition may be pre-filled by URL parameter values.
+ * Other parameters are ignored for security reasons.
+ * @param request
+ * @param model
+ */
+export declare function prefillStateFromQueryParameters(request: AnyFormRequest, page: PageControllerClass): Promise<boolean>;

package/.server/server/plugins/engine/pageControllers/helpers/state.js

@@ -0,0 +1,66 @@
+import { getHiddenFields } from '@defra/forms-model';
+/**
+ * A series of functions that can transform a pre-fill input parameter e.g lookup a form title based on form id
+ */
+const paramLookupFunctions = {
+  formId: async (val, services) => {
+    let formTitle;
+    if (val) {
+      const meta = await services.formsService.getFormMetadataById(val);
+      formTitle = meta.title;
+    }
+    return {
+      key: 'formName',
+      value: formTitle
+    };
+  }
+};
+export function stripParam(query, paramToRemove) {
+  const params = {};
+  for (const [key, value = ''] of Object.entries(query)) {
+    if (key !== paramToRemove) {
+      params[key] = value;
+    }
+  }
+  return Object.keys(params).length ? params : undefined;
+}
+
+/**
+ * Any hidden parameters defined in the FormDefinition may be pre-filled by URL parameter values.
+ * Other parameters are ignored for security reasons.
+ * @param request
+ * @param model
+ */
+export async function prefillStateFromQueryParameters(request, page) {
+  const {
+    model
+  } = page;
+  const hiddenFieldNames = new Set(getHiddenFields(model.def).map(field => field.name));
+  if (!hiddenFieldNames.size) {
+    return false;
+  }
+
+  // Remove 'returnUrl' param
+  const query = stripParam(request.query, 'returnUrl');
+  if (!query) {
+    return false;
+  }
+  const params = {};
+  for (const [key, value = ''] of Object.entries(query)) {
+    if (hiddenFieldNames.has(key)) {
+      const lookupFunc = paramLookupFunctions[key];
+      if (lookupFunc) {
+        const res = await lookupFunc(value, model.services);
+        // Store original value and result
+        params[key] = value;
+        params[res.key] = res.value;
+      } else {
+        params[key] = value;
+      }
+    }
+  }
+  const formData = await page.getState(request);
+  await page.mergeState(request, formData, params);
+  return true;
+}
+//# sourceMappingURL=state.js.map

package/.server/server/plugins/engine/pageControllers/helpers/state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.js","names":["getHiddenFields","paramLookupFunctions","formId","val","services","formTitle","meta","formsService","getFormMetadataById","title","key","value","stripParam","query","paramToRemove","params","Object","entries","keys","length","undefined","prefillStateFromQueryParameters","request","page","model","hiddenFieldNames","Set","def","map","field","name","size","has","lookupFunc","res","formData","getState","mergeState"],"sources":["../../../../../../src/server/plugins/engine/pageControllers/helpers/state.ts"],"sourcesContent":["import { getHiddenFields } from '@defra/forms-model'\n\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport {\n  type AnyFormRequest,\n  type FormStateValue\n} from '~/src/server/plugins/engine/types.js'\nimport { type FormQuery } from '~/src/server/routes/types.js'\nimport { type Services } from '~/src/server/types.js'\n\n/**\n * A series of functions that can transform a pre-fill input parameter e.g lookup a form title based on form id\n */\nconst paramLookupFunctions = {\n  formId: async (val: string, services: Services) => {\n    let formTitle\n    if (val) {\n      const meta = await services.formsService.getFormMetadataById(val)\n      formTitle = meta.title\n    }\n    return {\n      key: 'formName',\n      value: formTitle\n    }\n  }\n} as Partial<\n  Record<\n    string,\n    (\n      val: string,\n      services: Services\n    ) => Promise<{ key: string; value: string | undefined }>\n  >\n>\n\nexport function stripParam(query: FormQuery, paramToRemove: string) {\n  const params = {} as Record<string, FormStateValue | undefined>\n  for (const [key, value = ''] of Object.entries(query)) {\n    if (key !== paramToRemove) {\n      params[key] = value\n    }\n  }\n  return Object.keys(params).length ? (params as FormQuery) : undefined\n}\n\n/**\n * Any hidden parameters defined in the FormDefinition may be pre-filled by URL parameter values.\n * Other parameters are ignored for security reasons.\n * @param request\n * @param model\n */\nexport async function prefillStateFromQueryParameters(\n  request: AnyFormRequest,\n  page: PageControllerClass\n): Promise<boolean> {\n  const { model } = page\n\n  const hiddenFieldNames = new Set(\n    getHiddenFields(model.def).map((field) => field.name)\n  )\n\n  if (!hiddenFieldNames.size) {\n    return false\n  }\n\n  // Remove 'returnUrl' param\n  const query = stripParam(request.query, 'returnUrl')\n\n  if (!query) {\n    return false\n  }\n\n  const params = {} as Record<string, FormStateValue | undefined>\n\n  for (const [key, value = ''] of Object.entries(query)) {\n    if (hiddenFieldNames.has(key)) {\n      const lookupFunc = paramLookupFunctions[key]\n      if (lookupFunc) {\n        const res = await lookupFunc(value, model.services)\n        // Store original value and result\n        params[key] = value\n        params[res.key] = res.value\n      } else {\n        params[key] = value\n      }\n    }\n  }\n\n  const formData = await page.getState(request)\n  await page.mergeState(request, formData, params)\n\n  return true\n}\n"],"mappings":"AAAA,SAASA,eAAe,QAAQ,oBAAoB;AAUpD;AACA;AACA;AACA,MAAMC,oBAAoB,GAAG;EAC3BC,MAAM,EAAE,MAAAA,CAAOC,GAAW,EAAEC,QAAkB,KAAK;IACjD,IAAIC,SAAS;IACb,IAAIF,GAAG,EAAE;MACP,MAAMG,IAAI,GAAG,MAAMF,QAAQ,CAACG,YAAY,CAACC,mBAAmB,CAACL,GAAG,CAAC;MACjEE,SAAS,GAAGC,IAAI,CAACG,KAAK;IACxB;IACA,OAAO;MACLC,GAAG,EAAE,UAAU;MACfC,KAAK,EAAEN;IACT,CAAC;EACH;AACF,CAQC;AAED,OAAO,SAASO,UAAUA,CAACC,KAAgB,EAAEC,aAAqB,EAAE;EAClE,MAAMC,MAAM,GAAG,CAAC,CAA+C;EAC/D,KAAK,MAAM,CAACL,GAAG,EAAEC,KAAK,GAAG,EAAE,CAAC,IAAIK,MAAM,CAACC,OAAO,CAACJ,KAAK,CAAC,EAAE;IACrD,IAAIH,GAAG,KAAKI,aAAa,EAAE;MACzBC,MAAM,CAACL,GAAG,CAAC,GAAGC,KAAK;IACrB;EACF;EACA,OAAOK,MAAM,CAACE,IAAI,CAACH,MAAM,CAAC,CAACI,MAAM,GAAIJ,MAAM,GAAiBK,SAAS;AACvE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,+BAA+BA,CACnDC,OAAuB,EACvBC,IAAyB,EACP;EAClB,MAAM;IAAEC;EAAM,CAAC,GAAGD,IAAI;EAEtB,MAAME,gBAAgB,GAAG,IAAIC,GAAG,CAC9B1B,eAAe,CAACwB,KAAK,CAACG,GAAG,CAAC,CAACC,GAAG,CAAEC,KAAK,IAAKA,KAAK,CAACC,IAAI,CACtD,CAAC;EAED,IAAI,CAACL,gBAAgB,CAACM,IAAI,EAAE;IAC1B,OAAO,KAAK;EACd;;EAEA;EACA,MAAMlB,KAAK,GAAGD,UAAU,CAACU,OAAO,CAACT,KAAK,EAAE,WAAW,CAAC;EAEpD,IAAI,CAACA,KAAK,EAAE;IACV,OAAO,KAAK;EACd;EAEA,MAAME,MAAM,GAAG,CAAC,CAA+C;EAE/D,KAAK,MAAM,CAACL,GAAG,EAAEC,KAAK,GAAG,EAAE,CAAC,IAAIK,MAAM,CAACC,OAAO,CAACJ,KAAK,CAAC,EAAE;IACrD,IAAIY,gBAAgB,CAACO,GAAG,CAACtB,GAAG,CAAC,EAAE;MAC7B,MAAMuB,UAAU,GAAGhC,oBAAoB,CAACS,GAAG,CAAC;MAC5C,IAAIuB,UAAU,EAAE;QACd,MAAMC,GAAG,GAAG,MAAMD,UAAU,CAACtB,KAAK,EAAEa,KAAK,CAACpB,QAAQ,CAAC;QACnD;QACAW,MAAM,CAACL,GAAG,CAAC,GAAGC,KAAK;QACnBI,MAAM,CAACmB,GAAG,CAACxB,GAAG,CAAC,GAAGwB,GAAG,CAACvB,KAAK;MAC7B,CAAC,MAAM;QACLI,MAAM,CAACL,GAAG,CAAC,GAAGC,KAAK;MACrB;IACF;EACF;EAEA,MAAMwB,QAAQ,GAAG,MAAMZ,IAAI,CAACa,QAAQ,CAACd,OAAO,CAAC;EAC7C,MAAMC,IAAI,CAACc,UAAU,CAACf,OAAO,EAAEa,QAAQ,EAAEpB,MAAM,CAAC;EAEhD,OAAO,IAAI;AACb","ignoreList":[]}

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

@@ -166,7 +166,8 @@ export function makeLoadFormPreHandler(server, options) {
       const model = new FormModel(definition, {
         basePath,
         versionNumber,
-        ordnanceSurveyApiKey
+        ordnanceSurveyApiKey,
+        formId: id
       }, services, controllers);
 
       // Create new item and add it to the item cache

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Boom","isEqual","EXTERNAL_STATE_APPENDAGE","EXTERNAL_STATE_PAYLOAD","PREVIEW_PATH_PREFIX","FormComponent","isFormState","checkEmailAddressForLiveFormSubmission","checkFormStatus","findPage","getCacheService","getPage","getStartPath","proceed","FormModel","generateUniqueReference","defaultServices","redirectOrMakeHandler","request","h","onRequest","makeHandler","app","params","model","notFound","path","cacheService","server","page","state","getState","$$__referenceNumber","prefix","def","metadata","referenceNumberPrefix","badImplementation","referenceNumber","mergeState","importExternalComponentState","flash","getFlash","context","getFormContext","errors","relevantPath","getRelevantPath","summaryPath","getSummaryPath","result","continue","startsWith","isForceAccess","redirectTo","next","length","query","returnUrl","getHref","externalComponentData","yar","Array","isArray","typedStateAppendage","componentName","component","stateAppendage","data","componentMap","get","Error","TypeError","isStateValid","isState","componentState","Object","fromEntries","entries","map","key","value","pageState","getStateFromValidForm","savedState","payload","stashedPayload","localState","makeLoadFormPreHandler","options","realm","modifiers","route","services","controllers","ordnanceSurveyApiKey","formsService","handler","slug","isPreview","formState","getFormMetadata","id","item","models","updatedAt","logger","info","definition","getFormDefinition","emailAddress","notificationEmail","outputEmail","basePath","substring","versionNumber","versions","set","dispatchHandler","servicePath"],"sources":["../../../../../src/server/plugins/engine/routes/index.ts"],"sourcesContent":["import Boom from '@hapi/boom'\nimport {\n  type ResponseObject,\n  type ResponseToolkit,\n  type Server\n} from '@hapi/hapi'\nimport { isEqual } from 'date-fns'\n\nimport {\n  EXTERNAL_STATE_APPENDAGE,\n  EXTERNAL_STATE_PAYLOAD,\n  PREVIEW_PATH_PREFIX\n} from '~/src/server/constants.js'\nimport {\n  FormComponent,\n  isFormState\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport {\n  checkEmailAddressForLiveFormSubmission,\n  checkFormStatus,\n  findPage,\n  getCacheService,\n  getPage,\n  getStartPath,\n  proceed\n} from '~/src/server/plugins/engine/helpers.js'\nimport { FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport { generateUniqueReference } from '~/src/server/plugins/engine/referenceNumbers.js'\nimport * as defaultServices from '~/src/server/plugins/engine/services/index.js'\nimport {\n  type AnyFormRequest,\n  type ExternalStateAppendage,\n  type FormContext,\n  type FormPayload,\n  type FormSubmissionState,\n  type OnRequestCallback,\n  type PluginOptions\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormResponseToolkit\n} from '~/src/server/routes/types.js'\n\nexport async function redirectOrMakeHandler(\n  request: AnyFormRequest,\n  h: FormResponseToolkit,\n  onRequest: OnRequestCallback | undefined,\n  makeHandler: (\n    page: PageControllerClass,\n    context: FormContext\n  ) => ResponseObject | Promise<ResponseObject>\n) {\n  const { app, params } = request\n  const { model } = app\n\n  if (!model) {\n    throw Boom.notFound(`No model found for /${params.path}`)\n  }\n\n  const cacheService = getCacheService(request.server)\n  const page = getPage(model, request)\n  let state = await page.getState(request)\n\n  if (!state.$$__referenceNumber) {\n    const prefix = model.def.metadata?.referenceNumberPrefix ?? ''\n\n    if (typeof prefix !== 'string') {\n      throw Boom.badImplementation(\n        'Reference number prefix must be a string or undefined'\n      )\n    }\n\n    const referenceNumber = generateUniqueReference(prefix)\n    state = await page.mergeState(request, state, {\n      $$__referenceNumber: referenceNumber\n    })\n  }\n\n  state = await importExternalComponentState(request, page, state)\n\n  const flash = cacheService.getFlash(request)\n  const context = model.getFormContext(request, state, flash?.errors)\n  const relevantPath = page.getRelevantPath(request, context)\n  const summaryPath = page.getSummaryPath()\n\n  // Call the onRequest callback if it has been supplied\n  if (onRequest) {\n    const result = await onRequest(request, h, context)\n    if (result !== h.continue) {\n      return result\n    }\n  }\n\n  // Return handler for relevant pages or preview URL direct access\n  if (relevantPath.startsWith(page.path) || context.isForceAccess) {\n    return makeHandler(page, context)\n  }\n\n  // Redirect back to last relevant page\n  const redirectTo = findPage(model, relevantPath)\n\n  // Set the return URL unless an exit page\n  if (redirectTo?.next.length) {\n    request.query.returnUrl = page.getHref(summaryPath)\n  }\n\n  return proceed(request, h, page.getHref(relevantPath))\n}\n\nasync function importExternalComponentState(\n  request: AnyFormRequest,\n  page: PageControllerClass,\n  state: FormSubmissionState\n): Promise<FormSubmissionState> {\n  const externalComponentData = request.yar.flash(EXTERNAL_STATE_APPENDAGE)\n\n  if (Array.isArray(externalComponentData)) {\n    return state\n  }\n\n  const typedStateAppendage = externalComponentData as ExternalStateAppendage\n  const componentName = typedStateAppendage.component\n  const stateAppendage = typedStateAppendage.data\n  const component = request.app.model?.componentMap.get(componentName)\n\n  if (!component) {\n    throw new Error(`Component ${componentName} not found in form`)\n  }\n\n  if (!(component instanceof FormComponent)) {\n    throw new TypeError(\n      `Component ${componentName} is not a FormComponent and does not support isState`\n    )\n  }\n\n  const isStateValid = component.isState(stateAppendage)\n\n  if (!isStateValid) {\n    throw new Error(`State for component ${componentName} is invalid`)\n  }\n\n  const componentState = isFormState(stateAppendage)\n    ? Object.fromEntries(\n        Object.entries(stateAppendage).map(([key, value]) => [\n          `${componentName}__${key}`,\n          value\n        ])\n      )\n    : { [componentName]: stateAppendage }\n\n  // Save the external component state immediately\n  const pageState = page.getStateFromValidForm(\n    request,\n    state,\n    componentState as FormPayload\n  )\n  const savedState = await page.mergeState(request, state, pageState)\n\n  // Merge any stashed payload into the local state\n  const payload = request.yar.flash(EXTERNAL_STATE_PAYLOAD)\n  const stashedPayload = Array.isArray(payload) ? {} : (payload as FormPayload)\n\n  const localState = page.getStateFromValidForm(request, savedState, {\n    ...stashedPayload,\n    ...componentState\n  } as FormPayload)\n\n  return { ...savedState, ...localState }\n}\n\nexport function makeLoadFormPreHandler(server: Server, options: PluginOptions) {\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- hapi types are wrong\n  const prefix = server.realm.modifiers.route.prefix ?? ''\n\n  const {\n    services = defaultServices,\n    controllers,\n    ordnanceSurveyApiKey\n  } = options\n\n  const { formsService } = services\n\n  async function handler(request: AnyFormRequest, h: ResponseToolkit) {\n    if (server.app.model) {\n      request.app.model = server.app.model\n\n      return h.continue\n    }\n\n    const { params } = request\n    const { slug } = params\n    const { isPreview, state: formState } = checkFormStatus(params)\n\n    // Get the form metadata using the `slug` param\n    const metadata = await formsService.getFormMetadata(slug)\n\n    const { id, [formState]: state } = metadata\n\n    // Check the metadata supports the requested state\n    if (!state) {\n      throw Boom.notFound(`No '${formState}' state for form metadata ${id}`)\n    }\n\n    // Cache the models based on id, state and whether\n    // it's a preview or not. There could be up to 3 models\n    // cached for a single form:\n    // \"{id}_live_false\" (live/live)\n    // \"{id}_live_true\" (live/preview)\n    // \"{id}_draft_true\" (draft/preview)\n    const key = `${id}_${formState}_${isPreview}`\n    let item = server.app.models.get(key)\n\n    if (!item || !isEqual(item.updatedAt, state.updatedAt)) {\n      server.logger.info(`Getting form definition ${id} (${slug}) ${formState}`)\n\n      // Get the form definition using the `id` from the metadata\n      const definition = await formsService.getFormDefinition(id, formState)\n\n      if (!definition) {\n        throw Boom.notFound(\n          `No definition found for form metadata ${id} (${slug}) ${formState}`\n        )\n      }\n\n      const emailAddress = metadata.notificationEmail ?? definition.outputEmail\n\n      checkEmailAddressForLiveFormSubmission(emailAddress, isPreview)\n\n      // Build the form model\n      server.logger.info(\n        `Building model for form definition ${id} (${slug}) ${formState}`\n      )\n\n      // Set up the basePath for the model\n      const basePath = (\n        isPreview\n          ? `${prefix}${PREVIEW_PATH_PREFIX}/${formState}/${slug}`\n          : `${prefix}/${slug}`\n      ).substring(1)\n\n      const versionNumber = metadata.versions?.[0]?.versionNumber\n\n      // Construct the form model\n      const model = new FormModel(\n        definition,\n        { basePath, versionNumber, ordnanceSurveyApiKey },\n        services,\n        controllers\n      )\n\n      // Create new item and add it to the item cache\n      item = { model, updatedAt: state.updatedAt }\n      server.app.models.set(key, item)\n    }\n\n    // Assign the model to the request data\n    // for use in the downstream handler\n    request.app.model = item.model\n\n    return h.continue\n  }\n\n  return handler\n}\n\nexport function dispatchHandler(request: FormRequest, h: FormResponseToolkit) {\n  const { model } = request.app\n\n  const servicePath = model ? `/${model.basePath}` : ''\n  return proceed(request, h, `${servicePath}${getStartPath(model)}`)\n}\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAM7B,SAASC,OAAO,QAAQ,UAAU;AAElC,SACEC,wBAAwB,EACxBC,sBAAsB,EACtBC,mBAAmB;AAErB,SACEC,aAAa,EACbC,WAAW;AAEb,SACEC,sCAAsC,EACtCC,eAAe,EACfC,QAAQ,EACRC,eAAe,EACfC,OAAO,EACPC,YAAY,EACZC,OAAO;AAET,SAASC,SAAS;AAElB,SAASC,uBAAuB;AAChC,OAAO,KAAKC,eAAe;AAe3B,OAAO,eAAeC,qBAAqBA,CACzCC,OAAuB,EACvBC,CAAsB,EACtBC,SAAwC,EACxCC,WAG6C,EAC7C;EACA,MAAM;IAAEC,GAAG;IAAEC;EAAO,CAAC,GAAGL,OAAO;EAC/B,MAAM;IAAEM;EAAM,CAAC,GAAGF,GAAG;EAErB,IAAI,CAACE,KAAK,EAAE;IACV,MAAMxB,IAAI,CAACyB,QAAQ,CAAC,uBAAuBF,MAAM,CAACG,IAAI,EAAE,CAAC;EAC3D;EAEA,MAAMC,YAAY,GAAGjB,eAAe,CAACQ,OAAO,CAACU,MAAM,CAAC;EACpD,MAAMC,IAAI,GAAGlB,OAAO,CAACa,KAAK,EAAEN,OAAO,CAAC;EACpC,IAAIY,KAAK,GAAG,MAAMD,IAAI,CAACE,QAAQ,CAACb,OAAO,CAAC;EAExC,IAAI,CAACY,KAAK,CAACE,mBAAmB,EAAE;IAC9B,MAAMC,MAAM,GAAGT,KAAK,CAACU,GAAG,CAACC,QAAQ,EAAEC,qBAAqB,IAAI,EAAE;IAE9D,IAAI,OAAOH,MAAM,KAAK,QAAQ,EAAE;MAC9B,MAAMjC,IAAI,CAACqC,iBAAiB,CAC1B,uDACF,CAAC;IACH;IAEA,MAAMC,eAAe,GAAGvB,uBAAuB,CAACkB,MAAM,CAAC;IACvDH,KAAK,GAAG,MAAMD,IAAI,CAACU,UAAU,CAACrB,OAAO,EAAEY,KAAK,EAAE;MAC5CE,mBAAmB,EAAEM;IACvB,CAAC,CAAC;EACJ;EAEAR,KAAK,GAAG,MAAMU,4BAA4B,CAACtB,OAAO,EAAEW,IAAI,EAAEC,KAAK,CAAC;EAEhE,MAAMW,KAAK,GAAGd,YAAY,CAACe,QAAQ,CAACxB,OAAO,CAAC;EAC5C,MAAMyB,OAAO,GAAGnB,KAAK,CAACoB,cAAc,CAAC1B,OAAO,EAAEY,KAAK,EAAEW,KAAK,EAAEI,MAAM,CAAC;EACnE,MAAMC,YAAY,GAAGjB,IAAI,CAACkB,eAAe,CAAC7B,OAAO,EAAEyB,OAAO,CAAC;EAC3D,MAAMK,WAAW,GAAGnB,IAAI,CAACoB,cAAc,CAAC,CAAC;;EAEzC;EACA,IAAI7B,SAAS,EAAE;IACb,MAAM8B,MAAM,GAAG,MAAM9B,SAAS,CAACF,OAAO,EAAEC,CAAC,EAAEwB,OAAO,CAAC;IACnD,IAAIO,MAAM,KAAK/B,CAAC,CAACgC,QAAQ,EAAE;MACzB,OAAOD,MAAM;IACf;EACF;;EAEA;EACA,IAAIJ,YAAY,CAACM,UAAU,CAACvB,IAAI,CAACH,IAAI,CAAC,IAAIiB,OAAO,CAACU,aAAa,EAAE;IAC/D,OAAOhC,WAAW,CAACQ,IAAI,EAAEc,OAAO,CAAC;EACnC;;EAEA;EACA,MAAMW,UAAU,GAAG7C,QAAQ,CAACe,KAAK,EAAEsB,YAAY,CAAC;;EAEhD;EACA,IAAIQ,UAAU,EAAEC,IAAI,CAACC,MAAM,EAAE;IAC3BtC,OAAO,CAACuC,KAAK,CAACC,SAAS,GAAG7B,IAAI,CAAC8B,OAAO,CAACX,WAAW,CAAC;EACrD;EAEA,OAAOnC,OAAO,CAACK,OAAO,EAAEC,CAAC,EAAEU,IAAI,CAAC8B,OAAO,CAACb,YAAY,CAAC,CAAC;AACxD;AAEA,eAAeN,4BAA4BA,CACzCtB,OAAuB,EACvBW,IAAyB,EACzBC,KAA0B,EACI;EAC9B,MAAM8B,qBAAqB,GAAG1C,OAAO,CAAC2C,GAAG,CAACpB,KAAK,CAACvC,wBAAwB,CAAC;EAEzE,IAAI4D,KAAK,CAACC,OAAO,CAACH,qBAAqB,CAAC,EAAE;IACxC,OAAO9B,KAAK;EACd;EAEA,MAAMkC,mBAAmB,GAAGJ,qBAA+C;EAC3E,MAAMK,aAAa,GAAGD,mBAAmB,CAACE,SAAS;EACnD,MAAMC,cAAc,GAAGH,mBAAmB,CAACI,IAAI;EAC/C,MAAMF,SAAS,GAAGhD,OAAO,CAACI,GAAG,CAACE,KAAK,EAAE6C,YAAY,CAACC,GAAG,CAACL,aAAa,CAAC;EAEpE,IAAI,CAACC,SAAS,EAAE;IACd,MAAM,IAAIK,KAAK,CAAC,aAAaN,aAAa,oBAAoB,CAAC;EACjE;EAEA,IAAI,EAAEC,SAAS,YAAY7D,aAAa,CAAC,EAAE;IACzC,MAAM,IAAImE,SAAS,CACjB,aAAaP,aAAa,sDAC5B,CAAC;EACH;EAEA,MAAMQ,YAAY,GAAGP,SAAS,CAACQ,OAAO,CAACP,cAAc,CAAC;EAEtD,IAAI,CAACM,YAAY,EAAE;IACjB,MAAM,IAAIF,KAAK,CAAC,uBAAuBN,aAAa,aAAa,CAAC;EACpE;EAEA,MAAMU,cAAc,GAAGrE,WAAW,CAAC6D,cAAc,CAAC,GAC9CS,MAAM,CAACC,WAAW,CAChBD,MAAM,CAACE,OAAO,CAACX,cAAc,CAAC,CAACY,GAAG,CAAC,CAAC,CAACC,GAAG,EAAEC,KAAK,CAAC,KAAK,CACnD,GAAGhB,aAAa,KAAKe,GAAG,EAAE,EAC1BC,KAAK,CACN,CACH,CAAC,GACD;IAAE,CAAChB,aAAa,GAAGE;EAAe,CAAC;;EAEvC;EACA,MAAMe,SAAS,GAAGrD,IAAI,CAACsD,qBAAqB,CAC1CjE,OAAO,EACPY,KAAK,EACL6C,cACF,CAAC;EACD,MAAMS,UAAU,GAAG,MAAMvD,IAAI,CAACU,UAAU,CAACrB,OAAO,EAAEY,KAAK,EAAEoD,SAAS,CAAC;;EAEnE;EACA,MAAMG,OAAO,GAAGnE,OAAO,CAAC2C,GAAG,CAACpB,KAAK,CAACtC,sBAAsB,CAAC;EACzD,MAAMmF,cAAc,GAAGxB,KAAK,CAACC,OAAO,CAACsB,OAAO,CAAC,GAAG,CAAC,CAAC,GAAIA,OAAuB;EAE7E,MAAME,UAAU,GAAG1D,IAAI,CAACsD,qBAAqB,CAACjE,OAAO,EAAEkE,UAAU,EAAE;IACjE,GAAGE,cAAc;IACjB,GAAGX;EACL,CAAgB,CAAC;EAEjB,OAAO;IAAE,GAAGS,UAAU;IAAE,GAAGG;EAAW,CAAC;AACzC;AAEA,OAAO,SAASC,sBAAsBA,CAAC5D,MAAc,EAAE6D,OAAsB,EAAE;EAC7E;EACA,MAAMxD,MAAM,GAAGL,MAAM,CAAC8D,KAAK,CAACC,SAAS,CAACC,KAAK,CAAC3D,MAAM,IAAI,EAAE;EAExD,MAAM;IACJ4D,QAAQ,GAAG7E,eAAe;IAC1B8E,WAAW;IACXC;EACF,CAAC,GAAGN,OAAO;EAEX,MAAM;IAAEO;EAAa,CAAC,GAAGH,QAAQ;EAEjC,eAAeI,OAAOA,CAAC/E,OAAuB,EAAEC,CAAkB,EAAE;IAClE,IAAIS,MAAM,CAACN,GAAG,CAACE,KAAK,EAAE;MACpBN,OAAO,CAACI,GAAG,CAACE,KAAK,GAAGI,MAAM,CAACN,GAAG,CAACE,KAAK;MAEpC,OAAOL,CAAC,CAACgC,QAAQ;IACnB;IAEA,MAAM;MAAE5B;IAAO,CAAC,GAAGL,OAAO;IAC1B,MAAM;MAAEgF;IAAK,CAAC,GAAG3E,MAAM;IACvB,MAAM;MAAE4E,SAAS;MAAErE,KAAK,EAAEsE;IAAU,CAAC,GAAG5F,eAAe,CAACe,MAAM,CAAC;;IAE/D;IACA,MAAMY,QAAQ,GAAG,MAAM6D,YAAY,CAACK,eAAe,CAACH,IAAI,CAAC;IAEzD,MAAM;MAAEI,EAAE;MAAE,CAACF,SAAS,GAAGtE;IAAM,CAAC,GAAGK,QAAQ;;IAE3C;IACA,IAAI,CAACL,KAAK,EAAE;MACV,MAAM9B,IAAI,CAACyB,QAAQ,CAAC,OAAO2E,SAAS,6BAA6BE,EAAE,EAAE,CAAC;IACxE;;IAEA;IACA;IACA;IACA;IACA;IACA;IACA,MAAMtB,GAAG,GAAG,GAAGsB,EAAE,IAAIF,SAAS,IAAID,SAAS,EAAE;IAC7C,IAAII,IAAI,GAAG3E,MAAM,CAACN,GAAG,CAACkF,MAAM,CAAClC,GAAG,CAACU,GAAG,CAAC;IAErC,IAAI,CAACuB,IAAI,IAAI,CAACtG,OAAO,CAACsG,IAAI,CAACE,SAAS,EAAE3E,KAAK,CAAC2E,SAAS,CAAC,EAAE;MACtD7E,MAAM,CAAC8E,MAAM,CAACC,IAAI,CAAC,2BAA2BL,EAAE,KAAKJ,IAAI,KAAKE,SAAS,EAAE,CAAC;;MAE1E;MACA,MAAMQ,UAAU,GAAG,MAAMZ,YAAY,CAACa,iBAAiB,CAACP,EAAE,EAAEF,SAAS,CAAC;MAEtE,IAAI,CAACQ,UAAU,EAAE;QACf,MAAM5G,IAAI,CAACyB,QAAQ,CACjB,yCAAyC6E,EAAE,KAAKJ,IAAI,KAAKE,SAAS,EACpE,CAAC;MACH;MAEA,MAAMU,YAAY,GAAG3E,QAAQ,CAAC4E,iBAAiB,IAAIH,UAAU,CAACI,WAAW;MAEzEzG,sCAAsC,CAACuG,YAAY,EAAEX,SAAS,CAAC;;MAE/D;MACAvE,MAAM,CAAC8E,MAAM,CAACC,IAAI,CAChB,sCAAsCL,EAAE,KAAKJ,IAAI,KAAKE,SAAS,EACjE,CAAC;;MAED;MACA,MAAMa,QAAQ,GAAG,CACfd,SAAS,GACL,GAAGlE,MAAM,GAAG7B,mBAAmB,IAAIgG,SAAS,IAAIF,IAAI,EAAE,GACtD,GAAGjE,MAAM,IAAIiE,IAAI,EAAE,EACvBgB,SAAS,CAAC,CAAC,CAAC;MAEd,MAAMC,aAAa,GAAGhF,QAAQ,CAACiF,QAAQ,GAAG,CAAC,CAAC,EAAED,aAAa;;MAE3D;MACA,MAAM3F,KAAK,GAAG,IAAIV,SAAS,CACzB8F,UAAU,EACV;QAAEK,QAAQ;QAAEE,aAAa;QAAEpB;MAAqB,CAAC,EACjDF,QAAQ,EACRC,WACF,CAAC;;MAED;MACAS,IAAI,GAAG;QAAE/E,KAAK;QAAEiF,SAAS,EAAE3E,KAAK,CAAC2E;MAAU,CAAC;MAC5C7E,MAAM,CAACN,GAAG,CAACkF,MAAM,CAACa,GAAG,CAACrC,GAAG,EAAEuB,IAAI,CAAC;IAClC;;IAEA;IACA;IACArF,OAAO,CAACI,GAAG,CAACE,KAAK,GAAG+E,IAAI,CAAC/E,KAAK;IAE9B,OAAOL,CAAC,CAACgC,QAAQ;EACnB;EAEA,OAAO8C,OAAO;AAChB;AAEA,OAAO,SAASqB,eAAeA,CAACpG,OAAoB,EAAEC,CAAsB,EAAE;EAC5E,MAAM;IAAEK;EAAM,CAAC,GAAGN,OAAO,CAACI,GAAG;EAE7B,MAAMiG,WAAW,GAAG/F,KAAK,GAAG,IAAIA,KAAK,CAACyF,QAAQ,EAAE,GAAG,EAAE;EACrD,OAAOpG,OAAO,CAACK,OAAO,EAAEC,CAAC,EAAE,GAAGoG,WAAW,GAAG3G,YAAY,CAACY,KAAK,CAAC,EAAE,CAAC;AACpE","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Boom","isEqual","EXTERNAL_STATE_APPENDAGE","EXTERNAL_STATE_PAYLOAD","PREVIEW_PATH_PREFIX","FormComponent","isFormState","checkEmailAddressForLiveFormSubmission","checkFormStatus","findPage","getCacheService","getPage","getStartPath","proceed","FormModel","generateUniqueReference","defaultServices","redirectOrMakeHandler","request","h","onRequest","makeHandler","app","params","model","notFound","path","cacheService","server","page","state","getState","$$__referenceNumber","prefix","def","metadata","referenceNumberPrefix","badImplementation","referenceNumber","mergeState","importExternalComponentState","flash","getFlash","context","getFormContext","errors","relevantPath","getRelevantPath","summaryPath","getSummaryPath","result","continue","startsWith","isForceAccess","redirectTo","next","length","query","returnUrl","getHref","externalComponentData","yar","Array","isArray","typedStateAppendage","componentName","component","stateAppendage","data","componentMap","get","Error","TypeError","isStateValid","isState","componentState","Object","fromEntries","entries","map","key","value","pageState","getStateFromValidForm","savedState","payload","stashedPayload","localState","makeLoadFormPreHandler","options","realm","modifiers","route","services","controllers","ordnanceSurveyApiKey","formsService","handler","slug","isPreview","formState","getFormMetadata","id","item","models","updatedAt","logger","info","definition","getFormDefinition","emailAddress","notificationEmail","outputEmail","basePath","substring","versionNumber","versions","formId","set","dispatchHandler","servicePath"],"sources":["../../../../../src/server/plugins/engine/routes/index.ts"],"sourcesContent":["import Boom from '@hapi/boom'\nimport {\n  type ResponseObject,\n  type ResponseToolkit,\n  type Server\n} from '@hapi/hapi'\nimport { isEqual } from 'date-fns'\n\nimport {\n  EXTERNAL_STATE_APPENDAGE,\n  EXTERNAL_STATE_PAYLOAD,\n  PREVIEW_PATH_PREFIX\n} from '~/src/server/constants.js'\nimport {\n  FormComponent,\n  isFormState\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport {\n  checkEmailAddressForLiveFormSubmission,\n  checkFormStatus,\n  findPage,\n  getCacheService,\n  getPage,\n  getStartPath,\n  proceed\n} from '~/src/server/plugins/engine/helpers.js'\nimport { FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport { generateUniqueReference } from '~/src/server/plugins/engine/referenceNumbers.js'\nimport * as defaultServices from '~/src/server/plugins/engine/services/index.js'\nimport {\n  type AnyFormRequest,\n  type ExternalStateAppendage,\n  type FormContext,\n  type FormPayload,\n  type FormSubmissionState,\n  type OnRequestCallback,\n  type PluginOptions\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormResponseToolkit\n} from '~/src/server/routes/types.js'\n\nexport async function redirectOrMakeHandler(\n  request: AnyFormRequest,\n  h: FormResponseToolkit,\n  onRequest: OnRequestCallback | undefined,\n  makeHandler: (\n    page: PageControllerClass,\n    context: FormContext\n  ) => ResponseObject | Promise<ResponseObject>\n) {\n  const { app, params } = request\n  const { model } = app\n\n  if (!model) {\n    throw Boom.notFound(`No model found for /${params.path}`)\n  }\n\n  const cacheService = getCacheService(request.server)\n  const page = getPage(model, request)\n  let state = await page.getState(request)\n\n  if (!state.$$__referenceNumber) {\n    const prefix = model.def.metadata?.referenceNumberPrefix ?? ''\n\n    if (typeof prefix !== 'string') {\n      throw Boom.badImplementation(\n        'Reference number prefix must be a string or undefined'\n      )\n    }\n\n    const referenceNumber = generateUniqueReference(prefix)\n    state = await page.mergeState(request, state, {\n      $$__referenceNumber: referenceNumber\n    })\n  }\n\n  state = await importExternalComponentState(request, page, state)\n\n  const flash = cacheService.getFlash(request)\n  const context = model.getFormContext(request, state, flash?.errors)\n  const relevantPath = page.getRelevantPath(request, context)\n  const summaryPath = page.getSummaryPath()\n\n  // Call the onRequest callback if it has been supplied\n  if (onRequest) {\n    const result = await onRequest(request, h, context)\n    if (result !== h.continue) {\n      return result\n    }\n  }\n\n  // Return handler for relevant pages or preview URL direct access\n  if (relevantPath.startsWith(page.path) || context.isForceAccess) {\n    return makeHandler(page, context)\n  }\n\n  // Redirect back to last relevant page\n  const redirectTo = findPage(model, relevantPath)\n\n  // Set the return URL unless an exit page\n  if (redirectTo?.next.length) {\n    request.query.returnUrl = page.getHref(summaryPath)\n  }\n\n  return proceed(request, h, page.getHref(relevantPath))\n}\n\nasync function importExternalComponentState(\n  request: AnyFormRequest,\n  page: PageControllerClass,\n  state: FormSubmissionState\n): Promise<FormSubmissionState> {\n  const externalComponentData = request.yar.flash(EXTERNAL_STATE_APPENDAGE)\n\n  if (Array.isArray(externalComponentData)) {\n    return state\n  }\n\n  const typedStateAppendage = externalComponentData as ExternalStateAppendage\n  const componentName = typedStateAppendage.component\n  const stateAppendage = typedStateAppendage.data\n  const component = request.app.model?.componentMap.get(componentName)\n\n  if (!component) {\n    throw new Error(`Component ${componentName} not found in form`)\n  }\n\n  if (!(component instanceof FormComponent)) {\n    throw new TypeError(\n      `Component ${componentName} is not a FormComponent and does not support isState`\n    )\n  }\n\n  const isStateValid = component.isState(stateAppendage)\n\n  if (!isStateValid) {\n    throw new Error(`State for component ${componentName} is invalid`)\n  }\n\n  const componentState = isFormState(stateAppendage)\n    ? Object.fromEntries(\n        Object.entries(stateAppendage).map(([key, value]) => [\n          `${componentName}__${key}`,\n          value\n        ])\n      )\n    : { [componentName]: stateAppendage }\n\n  // Save the external component state immediately\n  const pageState = page.getStateFromValidForm(\n    request,\n    state,\n    componentState as FormPayload\n  )\n  const savedState = await page.mergeState(request, state, pageState)\n\n  // Merge any stashed payload into the local state\n  const payload = request.yar.flash(EXTERNAL_STATE_PAYLOAD)\n  const stashedPayload = Array.isArray(payload) ? {} : (payload as FormPayload)\n\n  const localState = page.getStateFromValidForm(request, savedState, {\n    ...stashedPayload,\n    ...componentState\n  } as FormPayload)\n\n  return { ...savedState, ...localState }\n}\n\nexport function makeLoadFormPreHandler(server: Server, options: PluginOptions) {\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- hapi types are wrong\n  const prefix = server.realm.modifiers.route.prefix ?? ''\n\n  const {\n    services = defaultServices,\n    controllers,\n    ordnanceSurveyApiKey\n  } = options\n\n  const { formsService } = services\n\n  async function handler(request: AnyFormRequest, h: ResponseToolkit) {\n    if (server.app.model) {\n      request.app.model = server.app.model\n\n      return h.continue\n    }\n\n    const { params } = request\n    const { slug } = params\n    const { isPreview, state: formState } = checkFormStatus(params)\n\n    // Get the form metadata using the `slug` param\n    const metadata = await formsService.getFormMetadata(slug)\n\n    const { id, [formState]: state } = metadata\n\n    // Check the metadata supports the requested state\n    if (!state) {\n      throw Boom.notFound(`No '${formState}' state for form metadata ${id}`)\n    }\n\n    // Cache the models based on id, state and whether\n    // it's a preview or not. There could be up to 3 models\n    // cached for a single form:\n    // \"{id}_live_false\" (live/live)\n    // \"{id}_live_true\" (live/preview)\n    // \"{id}_draft_true\" (draft/preview)\n    const key = `${id}_${formState}_${isPreview}`\n    let item = server.app.models.get(key)\n\n    if (!item || !isEqual(item.updatedAt, state.updatedAt)) {\n      server.logger.info(`Getting form definition ${id} (${slug}) ${formState}`)\n\n      // Get the form definition using the `id` from the metadata\n      const definition = await formsService.getFormDefinition(id, formState)\n\n      if (!definition) {\n        throw Boom.notFound(\n          `No definition found for form metadata ${id} (${slug}) ${formState}`\n        )\n      }\n\n      const emailAddress = metadata.notificationEmail ?? definition.outputEmail\n\n      checkEmailAddressForLiveFormSubmission(emailAddress, isPreview)\n\n      // Build the form model\n      server.logger.info(\n        `Building model for form definition ${id} (${slug}) ${formState}`\n      )\n\n      // Set up the basePath for the model\n      const basePath = (\n        isPreview\n          ? `${prefix}${PREVIEW_PATH_PREFIX}/${formState}/${slug}`\n          : `${prefix}/${slug}`\n      ).substring(1)\n\n      const versionNumber = metadata.versions?.[0]?.versionNumber\n\n      // Construct the form model\n      const model = new FormModel(\n        definition,\n        { basePath, versionNumber, ordnanceSurveyApiKey, formId: id },\n        services,\n        controllers\n      )\n\n      // Create new item and add it to the item cache\n      item = { model, updatedAt: state.updatedAt }\n      server.app.models.set(key, item)\n    }\n\n    // Assign the model to the request data\n    // for use in the downstream handler\n    request.app.model = item.model\n\n    return h.continue\n  }\n\n  return handler\n}\n\nexport function dispatchHandler(request: FormRequest, h: FormResponseToolkit) {\n  const { model } = request.app\n\n  const servicePath = model ? `/${model.basePath}` : ''\n  return proceed(request, h, `${servicePath}${getStartPath(model)}`)\n}\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAM7B,SAASC,OAAO,QAAQ,UAAU;AAElC,SACEC,wBAAwB,EACxBC,sBAAsB,EACtBC,mBAAmB;AAErB,SACEC,aAAa,EACbC,WAAW;AAEb,SACEC,sCAAsC,EACtCC,eAAe,EACfC,QAAQ,EACRC,eAAe,EACfC,OAAO,EACPC,YAAY,EACZC,OAAO;AAET,SAASC,SAAS;AAElB,SAASC,uBAAuB;AAChC,OAAO,KAAKC,eAAe;AAe3B,OAAO,eAAeC,qBAAqBA,CACzCC,OAAuB,EACvBC,CAAsB,EACtBC,SAAwC,EACxCC,WAG6C,EAC7C;EACA,MAAM;IAAEC,GAAG;IAAEC;EAAO,CAAC,GAAGL,OAAO;EAC/B,MAAM;IAAEM;EAAM,CAAC,GAAGF,GAAG;EAErB,IAAI,CAACE,KAAK,EAAE;IACV,MAAMxB,IAAI,CAACyB,QAAQ,CAAC,uBAAuBF,MAAM,CAACG,IAAI,EAAE,CAAC;EAC3D;EAEA,MAAMC,YAAY,GAAGjB,eAAe,CAACQ,OAAO,CAACU,MAAM,CAAC;EACpD,MAAMC,IAAI,GAAGlB,OAAO,CAACa,KAAK,EAAEN,OAAO,CAAC;EACpC,IAAIY,KAAK,GAAG,MAAMD,IAAI,CAACE,QAAQ,CAACb,OAAO,CAAC;EAExC,IAAI,CAACY,KAAK,CAACE,mBAAmB,EAAE;IAC9B,MAAMC,MAAM,GAAGT,KAAK,CAACU,GAAG,CAACC,QAAQ,EAAEC,qBAAqB,IAAI,EAAE;IAE9D,IAAI,OAAOH,MAAM,KAAK,QAAQ,EAAE;MAC9B,MAAMjC,IAAI,CAACqC,iBAAiB,CAC1B,uDACF,CAAC;IACH;IAEA,MAAMC,eAAe,GAAGvB,uBAAuB,CAACkB,MAAM,CAAC;IACvDH,KAAK,GAAG,MAAMD,IAAI,CAACU,UAAU,CAACrB,OAAO,EAAEY,KAAK,EAAE;MAC5CE,mBAAmB,EAAEM;IACvB,CAAC,CAAC;EACJ;EAEAR,KAAK,GAAG,MAAMU,4BAA4B,CAACtB,OAAO,EAAEW,IAAI,EAAEC,KAAK,CAAC;EAEhE,MAAMW,KAAK,GAAGd,YAAY,CAACe,QAAQ,CAACxB,OAAO,CAAC;EAC5C,MAAMyB,OAAO,GAAGnB,KAAK,CAACoB,cAAc,CAAC1B,OAAO,EAAEY,KAAK,EAAEW,KAAK,EAAEI,MAAM,CAAC;EACnE,MAAMC,YAAY,GAAGjB,IAAI,CAACkB,eAAe,CAAC7B,OAAO,EAAEyB,OAAO,CAAC;EAC3D,MAAMK,WAAW,GAAGnB,IAAI,CAACoB,cAAc,CAAC,CAAC;;EAEzC;EACA,IAAI7B,SAAS,EAAE;IACb,MAAM8B,MAAM,GAAG,MAAM9B,SAAS,CAACF,OAAO,EAAEC,CAAC,EAAEwB,OAAO,CAAC;IACnD,IAAIO,MAAM,KAAK/B,CAAC,CAACgC,QAAQ,EAAE;MACzB,OAAOD,MAAM;IACf;EACF;;EAEA;EACA,IAAIJ,YAAY,CAACM,UAAU,CAACvB,IAAI,CAACH,IAAI,CAAC,IAAIiB,OAAO,CAACU,aAAa,EAAE;IAC/D,OAAOhC,WAAW,CAACQ,IAAI,EAAEc,OAAO,CAAC;EACnC;;EAEA;EACA,MAAMW,UAAU,GAAG7C,QAAQ,CAACe,KAAK,EAAEsB,YAAY,CAAC;;EAEhD;EACA,IAAIQ,UAAU,EAAEC,IAAI,CAACC,MAAM,EAAE;IAC3BtC,OAAO,CAACuC,KAAK,CAACC,SAAS,GAAG7B,IAAI,CAAC8B,OAAO,CAACX,WAAW,CAAC;EACrD;EAEA,OAAOnC,OAAO,CAACK,OAAO,EAAEC,CAAC,EAAEU,IAAI,CAAC8B,OAAO,CAACb,YAAY,CAAC,CAAC;AACxD;AAEA,eAAeN,4BAA4BA,CACzCtB,OAAuB,EACvBW,IAAyB,EACzBC,KAA0B,EACI;EAC9B,MAAM8B,qBAAqB,GAAG1C,OAAO,CAAC2C,GAAG,CAACpB,KAAK,CAACvC,wBAAwB,CAAC;EAEzE,IAAI4D,KAAK,CAACC,OAAO,CAACH,qBAAqB,CAAC,EAAE;IACxC,OAAO9B,KAAK;EACd;EAEA,MAAMkC,mBAAmB,GAAGJ,qBAA+C;EAC3E,MAAMK,aAAa,GAAGD,mBAAmB,CAACE,SAAS;EACnD,MAAMC,cAAc,GAAGH,mBAAmB,CAACI,IAAI;EAC/C,MAAMF,SAAS,GAAGhD,OAAO,CAACI,GAAG,CAACE,KAAK,EAAE6C,YAAY,CAACC,GAAG,CAACL,aAAa,CAAC;EAEpE,IAAI,CAACC,SAAS,EAAE;IACd,MAAM,IAAIK,KAAK,CAAC,aAAaN,aAAa,oBAAoB,CAAC;EACjE;EAEA,IAAI,EAAEC,SAAS,YAAY7D,aAAa,CAAC,EAAE;IACzC,MAAM,IAAImE,SAAS,CACjB,aAAaP,aAAa,sDAC5B,CAAC;EACH;EAEA,MAAMQ,YAAY,GAAGP,SAAS,CAACQ,OAAO,CAACP,cAAc,CAAC;EAEtD,IAAI,CAACM,YAAY,EAAE;IACjB,MAAM,IAAIF,KAAK,CAAC,uBAAuBN,aAAa,aAAa,CAAC;EACpE;EAEA,MAAMU,cAAc,GAAGrE,WAAW,CAAC6D,cAAc,CAAC,GAC9CS,MAAM,CAACC,WAAW,CAChBD,MAAM,CAACE,OAAO,CAACX,cAAc,CAAC,CAACY,GAAG,CAAC,CAAC,CAACC,GAAG,EAAEC,KAAK,CAAC,KAAK,CACnD,GAAGhB,aAAa,KAAKe,GAAG,EAAE,EAC1BC,KAAK,CACN,CACH,CAAC,GACD;IAAE,CAAChB,aAAa,GAAGE;EAAe,CAAC;;EAEvC;EACA,MAAMe,SAAS,GAAGrD,IAAI,CAACsD,qBAAqB,CAC1CjE,OAAO,EACPY,KAAK,EACL6C,cACF,CAAC;EACD,MAAMS,UAAU,GAAG,MAAMvD,IAAI,CAACU,UAAU,CAACrB,OAAO,EAAEY,KAAK,EAAEoD,SAAS,CAAC;;EAEnE;EACA,MAAMG,OAAO,GAAGnE,OAAO,CAAC2C,GAAG,CAACpB,KAAK,CAACtC,sBAAsB,CAAC;EACzD,MAAMmF,cAAc,GAAGxB,KAAK,CAACC,OAAO,CAACsB,OAAO,CAAC,GAAG,CAAC,CAAC,GAAIA,OAAuB;EAE7E,MAAME,UAAU,GAAG1D,IAAI,CAACsD,qBAAqB,CAACjE,OAAO,EAAEkE,UAAU,EAAE;IACjE,GAAGE,cAAc;IACjB,GAAGX;EACL,CAAgB,CAAC;EAEjB,OAAO;IAAE,GAAGS,UAAU;IAAE,GAAGG;EAAW,CAAC;AACzC;AAEA,OAAO,SAASC,sBAAsBA,CAAC5D,MAAc,EAAE6D,OAAsB,EAAE;EAC7E;EACA,MAAMxD,MAAM,GAAGL,MAAM,CAAC8D,KAAK,CAACC,SAAS,CAACC,KAAK,CAAC3D,MAAM,IAAI,EAAE;EAExD,MAAM;IACJ4D,QAAQ,GAAG7E,eAAe;IAC1B8E,WAAW;IACXC;EACF,CAAC,GAAGN,OAAO;EAEX,MAAM;IAAEO;EAAa,CAAC,GAAGH,QAAQ;EAEjC,eAAeI,OAAOA,CAAC/E,OAAuB,EAAEC,CAAkB,EAAE;IAClE,IAAIS,MAAM,CAACN,GAAG,CAACE,KAAK,EAAE;MACpBN,OAAO,CAACI,GAAG,CAACE,KAAK,GAAGI,MAAM,CAACN,GAAG,CAACE,KAAK;MAEpC,OAAOL,CAAC,CAACgC,QAAQ;IACnB;IAEA,MAAM;MAAE5B;IAAO,CAAC,GAAGL,OAAO;IAC1B,MAAM;MAAEgF;IAAK,CAAC,GAAG3E,MAAM;IACvB,MAAM;MAAE4E,SAAS;MAAErE,KAAK,EAAEsE;IAAU,CAAC,GAAG5F,eAAe,CAACe,MAAM,CAAC;;IAE/D;IACA,MAAMY,QAAQ,GAAG,MAAM6D,YAAY,CAACK,eAAe,CAACH,IAAI,CAAC;IAEzD,MAAM;MAAEI,EAAE;MAAE,CAACF,SAAS,GAAGtE;IAAM,CAAC,GAAGK,QAAQ;;IAE3C;IACA,IAAI,CAACL,KAAK,EAAE;MACV,MAAM9B,IAAI,CAACyB,QAAQ,CAAC,OAAO2E,SAAS,6BAA6BE,EAAE,EAAE,CAAC;IACxE;;IAEA;IACA;IACA;IACA;IACA;IACA;IACA,MAAMtB,GAAG,GAAG,GAAGsB,EAAE,IAAIF,SAAS,IAAID,SAAS,EAAE;IAC7C,IAAII,IAAI,GAAG3E,MAAM,CAACN,GAAG,CAACkF,MAAM,CAAClC,GAAG,CAACU,GAAG,CAAC;IAErC,IAAI,CAACuB,IAAI,IAAI,CAACtG,OAAO,CAACsG,IAAI,CAACE,SAAS,EAAE3E,KAAK,CAAC2E,SAAS,CAAC,EAAE;MACtD7E,MAAM,CAAC8E,MAAM,CAACC,IAAI,CAAC,2BAA2BL,EAAE,KAAKJ,IAAI,KAAKE,SAAS,EAAE,CAAC;;MAE1E;MACA,MAAMQ,UAAU,GAAG,MAAMZ,YAAY,CAACa,iBAAiB,CAACP,EAAE,EAAEF,SAAS,CAAC;MAEtE,IAAI,CAACQ,UAAU,EAAE;QACf,MAAM5G,IAAI,CAACyB,QAAQ,CACjB,yCAAyC6E,EAAE,KAAKJ,IAAI,KAAKE,SAAS,EACpE,CAAC;MACH;MAEA,MAAMU,YAAY,GAAG3E,QAAQ,CAAC4E,iBAAiB,IAAIH,UAAU,CAACI,WAAW;MAEzEzG,sCAAsC,CAACuG,YAAY,EAAEX,SAAS,CAAC;;MAE/D;MACAvE,MAAM,CAAC8E,MAAM,CAACC,IAAI,CAChB,sCAAsCL,EAAE,KAAKJ,IAAI,KAAKE,SAAS,EACjE,CAAC;;MAED;MACA,MAAMa,QAAQ,GAAG,CACfd,SAAS,GACL,GAAGlE,MAAM,GAAG7B,mBAAmB,IAAIgG,SAAS,IAAIF,IAAI,EAAE,GACtD,GAAGjE,MAAM,IAAIiE,IAAI,EAAE,EACvBgB,SAAS,CAAC,CAAC,CAAC;MAEd,MAAMC,aAAa,GAAGhF,QAAQ,CAACiF,QAAQ,GAAG,CAAC,CAAC,EAAED,aAAa;;MAE3D;MACA,MAAM3F,KAAK,GAAG,IAAIV,SAAS,CACzB8F,UAAU,EACV;QAAEK,QAAQ;QAAEE,aAAa;QAAEpB,oBAAoB;QAAEsB,MAAM,EAAEf;MAAG,CAAC,EAC7DT,QAAQ,EACRC,WACF,CAAC;;MAED;MACAS,IAAI,GAAG;QAAE/E,KAAK;QAAEiF,SAAS,EAAE3E,KAAK,CAAC2E;MAAU,CAAC;MAC5C7E,MAAM,CAACN,GAAG,CAACkF,MAAM,CAACc,GAAG,CAACtC,GAAG,EAAEuB,IAAI,CAAC;IAClC;;IAEA;IACA;IACArF,OAAO,CAACI,GAAG,CAACE,KAAK,GAAG+E,IAAI,CAAC/E,KAAK;IAE9B,OAAOL,CAAC,CAACgC,QAAQ;EACnB;EAEA,OAAO8C,OAAO;AAChB;AAEA,OAAO,SAASsB,eAAeA,CAACrG,OAAoB,EAAEC,CAAsB,EAAE;EAC5E,MAAM;IAAEK;EAAM,CAAC,GAAGN,OAAO,CAACI,GAAG;EAE7B,MAAMkG,WAAW,GAAGhG,KAAK,GAAG,IAAIA,KAAK,CAACyF,QAAQ,EAAE,GAAG,EAAE;EACrD,OAAOpG,OAAO,CAACK,OAAO,EAAEC,CAAC,EAAE,GAAGqG,WAAW,GAAG5G,YAAY,CAACY,KAAK,CAAC,EAAE,CAAC;AACpE","ignoreList":[]}

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

@@ -4,6 +4,12 @@
  * @returns {Promise<FormMetadata>}
  */
 export function getFormMetadata(_slug: string): Promise<FormMetadata>;
+/**
+ * Dummy function to get form metadata.
+ * @param {string} _id - the id of the form
+ * @returns {Promise<FormMetadata>}
+ */
+export function getFormMetadataById(_id: string): Promise<FormMetadata>;
 /**
  * Dummy function to get form metadata.
  * @param {string} _id - the id of the form

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

@@ -10,6 +10,16 @@ export function getFormMetadata(_slug) {
   throw error;
 }
 
+// eslint-disable-next-line jsdoc/require-returns-check
+/**
+ * Dummy function to get form metadata.
+ * @param {string} _id - the id of the form
+ * @returns {Promise<FormMetadata>}
+ */
+export function getFormMetadataById(_id) {
+  throw error;
+}
+
 // eslint-disable-next-line jsdoc/require-returns-check
 /**
  * Dummy function to get form metadata.

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

@@ -1 +1 @@
-{"version":3,"file":"formsService.js","names":["error","Error","getFormMetadata","_slug","getFormDefinition","_id","_state"],"sources":["../../../../../src/server/plugins/engine/services/formsService.js"],"sourcesContent":["const error = Error(\n  'Not implemented. Consider setting up a form loader or providing a service implementation.'\n)\n\n// eslint-disable-next-line jsdoc/require-returns-check\n/**\n * Dummy function to get form metadata.\n * @param {string} _slug - the slug of the form\n * @returns {Promise<FormMetadata>}\n */\nexport function getFormMetadata(_slug) {\n  throw error\n}\n\n// eslint-disable-next-line jsdoc/require-returns-check\n/**\n * Dummy function to get form metadata.\n * @param {string} _id - the id of the form\n * @param {FormStatus} _state - the state of the form\n * @returns {Promise<FormDefinition | undefined>}\n */\nexport function getFormDefinition(_id, _state) {\n  throw error\n}\n\n/**\n * @import { FormStatus, FormDefinition, FormMetadata } from '@defra/forms-model'\n */\n"],"mappings":"AAAA,MAAMA,KAAK,GAAGC,KAAK,CACjB,2FACF,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACC,KAAK,EAAE;EACrC,MAAMH,KAAK;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,iBAAiBA,CAACC,GAAG,EAAEC,MAAM,EAAE;EAC7C,MAAMN,KAAK;AACb;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"formsService.js","names":["error","Error","getFormMetadata","_slug","getFormMetadataById","_id","getFormDefinition","_state"],"sources":["../../../../../src/server/plugins/engine/services/formsService.js"],"sourcesContent":["const error = Error(\n  'Not implemented. Consider setting up a form loader or providing a service implementation.'\n)\n\n// eslint-disable-next-line jsdoc/require-returns-check\n/**\n * Dummy function to get form metadata.\n * @param {string} _slug - the slug of the form\n * @returns {Promise<FormMetadata>}\n */\nexport function getFormMetadata(_slug) {\n  throw error\n}\n\n// eslint-disable-next-line jsdoc/require-returns-check\n/**\n * Dummy function to get form metadata.\n * @param {string} _id - the id of the form\n * @returns {Promise<FormMetadata>}\n */\nexport function getFormMetadataById(_id) {\n  throw error\n}\n\n// eslint-disable-next-line jsdoc/require-returns-check\n/**\n * Dummy function to get form metadata.\n * @param {string} _id - the id of the form\n * @param {FormStatus} _state - the state of the form\n * @returns {Promise<FormDefinition | undefined>}\n */\nexport function getFormDefinition(_id, _state) {\n  throw error\n}\n\n/**\n * @import { FormStatus, FormDefinition, FormMetadata } from '@defra/forms-model'\n */\n"],"mappings":"AAAA,MAAMA,KAAK,GAAGC,KAAK,CACjB,2FACF,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACC,KAAK,EAAE;EACrC,MAAMH,KAAK;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,mBAAmBA,CAACC,GAAG,EAAE;EACvC,MAAML,KAAK;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASM,iBAAiBA,CAACD,GAAG,EAAEE,MAAM,EAAE;EAC7C,MAAMP,KAAK;AACb;;AAEA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/engine/services/formsService.test.js

@@ -0,0 +1,14 @@
+import { FormStatus } from '@defra/forms-model';
+import { getFormDefinition, getFormMetadata, getFormMetadataById } from "./formsService.js";
+describe('formsService', () => {
+  it('getFormMetadata should throw error', () => {
+    expect(() => getFormMetadata('slug')).toThrow();
+  });
+  it('getFormMetadataById should throw error', () => {
+    expect(() => getFormMetadataById('id')).toThrow();
+  });
+  it('getFormDefinition should throw error', () => {
+    expect(() => getFormDefinition('id', FormStatus.Draft)).toThrow();
+  });
+});
+//# sourceMappingURL=formsService.test.js.map

package/.server/server/plugins/engine/services/formsService.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formsService.test.js","names":["FormStatus","getFormDefinition","getFormMetadata","getFormMetadataById","describe","it","expect","toThrow","Draft"],"sources":["../../../../../src/server/plugins/engine/services/formsService.test.js"],"sourcesContent":["import { FormStatus } from '@defra/forms-model'\n\nimport {\n  getFormDefinition,\n  getFormMetadata,\n  getFormMetadataById\n} from '~/src/server/plugins/engine/services/formsService.js'\n\ndescribe('formsService', () => {\n  it('getFormMetadata should throw error', () => {\n    expect(() => getFormMetadata('slug')).toThrow()\n  })\n\n  it('getFormMetadataById should throw error', () => {\n    expect(() => getFormMetadataById('id')).toThrow()\n  })\n\n  it('getFormDefinition should throw error', () => {\n    expect(() => getFormDefinition('id', FormStatus.Draft)).toThrow()\n  })\n})\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,oBAAoB;AAE/C,SACEC,iBAAiB,EACjBC,eAAe,EACfC,mBAAmB;AAGrBC,QAAQ,CAAC,cAAc,EAAE,MAAM;EAC7BC,EAAE,CAAC,oCAAoC,EAAE,MAAM;IAC7CC,MAAM,CAAC,MAAMJ,eAAe,CAAC,MAAM,CAAC,CAAC,CAACK,OAAO,CAAC,CAAC;EACjD,CAAC,CAAC;EAEFF,EAAE,CAAC,wCAAwC,EAAE,MAAM;IACjDC,MAAM,CAAC,MAAMH,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAACI,OAAO,CAAC,CAAC;EACnD,CAAC,CAAC;EAEFF,EAAE,CAAC,sCAAsC,EAAE,MAAM;IAC/CC,MAAM,CAAC,MAAML,iBAAiB,CAAC,IAAI,EAAED,UAAU,CAACQ,KAAK,CAAC,CAAC,CAACD,OAAO,CAAC,CAAC;EACnE,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

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

@@ -59,6 +59,10 @@ export interface FormSubmissionError extends Pick<ValidationErrorItem, 'context'
     name: string;
     text: string;
 }
+export interface FormConfirmationState {
+    confirmed?: true;
+    formId?: string;
+}
 export interface FormPayloadParams {
     action?: FormAction;
     confirm?: true;

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

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

package/.server/server/plugins/engine/views/components/declarationfield.html

@@ -5,7 +5,7 @@
 {% macro DeclarationField(component) %}
   {% set content %}
     <div class="app-prose-scope">
-      {{ component.model.content | markdown | safe }}
+      {{ component.model.content | markdown(component.model.headerStartLevel)  | safe }}
     </div>
   {% endset %}
   {% set checkboxes = component.model | merge({ formGroup: { beforeInputs: { html: content } } }) %}

package/.server/server/plugins/engine/views/components/hiddenfield.html

@@ -0,0 +1,3 @@
+{% macro HiddenField(component) %}
+  <input type="hidden" id="{{ component.model.name }}" name="{{ component.model.name }}" value="{{ component.model.value }}" />
+{% endmacro %}

package/.server/server/plugins/engine/views/components/markdown.html

@@ -1,5 +1,5 @@
 {% macro Markdown(component) %}
   <div class="app-prose-scope">
-    {{ component.model.content | markdown | safe }}
+    {{ component.model.content | markdown(component.model.headerStartLevel) | safe }}
   </div>
 {% endmacro %}

package/.server/server/plugins/engine/views/confirmation.html

@@ -12,8 +12,13 @@
       }) }}
       <h2 class="govuk-heading-m">What happens next</h2>
       <div class="app-prose-scope">
-        {{ submissionGuidance | markdown | safe }}
+        {{ submissionGuidance | markdown(3) | safe }}
       </div>
+      {% if feedbackLink %}
+        <p class="govuk-body">
+          <a href="{{ feedbackLink }}" class="govuk-link govuk-link--no-visited-state">What do you think of this service?</a> (takes 30 seconds)
+        </p>
+      {% endif %}
     </div>
   </div>
 {% endblock %}

package/.server/server/plugins/engine/views/partials/form.html

@@ -6,9 +6,17 @@
 
   {{ componentList(components) }}
 
+  {% if isStartPage %}
+    {% set buttonText = "Start now" %}
+  {% elif submitButtonText %}
+    {% set buttonText = submitButtonText %}
+  {% else %}
+    {% set buttonText = "Continue" %}
+  {% endif %}
+
   <div class="govuk-button-group">
     {{ govukButton({
-      text: "Start now" if isStartPage else "Continue",
+      text: buttonText,
       isStartButton: isStartPage,
       preventDoubleClick: true
     }) }}

package/.server/server/plugins/nunjucks/filters/field.d.ts

@@ -3,5 +3,5 @@
  * @this {NunjucksContext}
  * @param {string} name - The name of the component
  */
-export function field(this: NunjucksContext, name: string): import("../../engine/components/TextField.js").TextField | import("../../engine/components/SelectField.js").SelectField | import("../../engine/components/RadiosField.js").RadiosField | import("../../engine/components/YesNoField.js").YesNoField | import("../../engine/components/CheckboxesField.js").CheckboxesField | import("../../engine/components/DatePartsField.js").DatePartsField | import("../../engine/components/DeclarationField.js").DeclarationField | import("../../engine/components/EastingNorthingField.js").EastingNorthingField | import("../../engine/components/EmailAddressField.js").EmailAddressField | import("../../engine/components/LatLongField.js").LatLongField | import("../../engine/components/MonthYearField.js").MonthYearField | import("../../engine/components/MultilineTextField.js").MultilineTextField | import("../../engine/components/NationalGridFieldNumberField.js").NationalGridFieldNumberField | import("../../engine/components/NumberField.js").NumberField | import("../../engine/components/OsGridRefField.js").OsGridRefField | import("../../engine/components/TelephoneNumberField.js").TelephoneNumberField | import("../../engine/components/UkAddressField.js").UkAddressField | import("../../engine/components/FileUploadField.js").FileUploadField | import("../../engine/components/Details.js").Details | import("../../engine/components/Html.js").Html | import("../../engine/components/InsetText.js").InsetText | import("../../engine/components/List.js").List | import("../../engine/components/Markdown.js").Markdown | undefined;
+export function field(this: NunjucksContext, name: string): import("../../engine/components/TextField.js").TextField | import("../../engine/components/SelectField.js").SelectField | import("../../engine/components/RadiosField.js").RadiosField | import("../../engine/components/YesNoField.js").YesNoField | import("../../engine/components/CheckboxesField.js").CheckboxesField | import("../../engine/components/DatePartsField.js").DatePartsField | import("../../engine/components/DeclarationField.js").DeclarationField | import("../../engine/components/EastingNorthingField.js").EastingNorthingField | import("../../engine/components/EmailAddressField.js").EmailAddressField | import("../../engine/components/LatLongField.js").LatLongField | import("../../engine/components/MonthYearField.js").MonthYearField | import("../../engine/components/MultilineTextField.js").MultilineTextField | import("../../engine/components/NationalGridFieldNumberField.js").NationalGridFieldNumberField | import("../../engine/components/NumberField.js").NumberField | import("../../engine/components/OsGridRefField.js").OsGridRefField | import("../../engine/components/TelephoneNumberField.js").TelephoneNumberField | import("../../engine/components/UkAddressField.js").UkAddressField | import("../../engine/components/FileUploadField.js").FileUploadField | import("../../engine/components/HiddenField.js").HiddenField | import("../../engine/components/Details.js").Details | import("../../engine/components/Html.js").Html | import("../../engine/components/InsetText.js").InsetText | import("../../engine/components/List.js").List | import("../../engine/components/Markdown.js").Markdown | undefined;
 import type { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js';

package/.server/server/services/cacheService.d.ts

@@ -1,5 +1,5 @@
 import { type Server } from '@hapi/hapi';
-import { type AnyFormRequest, type AnyRequest, type FormPayload, type FormState, type FormSubmissionError, type FormSubmissionState } from '~/src/server/plugins/engine/types.js';
+import { type AnyFormRequest, type AnyRequest, type FormConfirmationState, type FormPayload, type FormState, type FormSubmissionError, type FormSubmissionState } from '~/src/server/plugins/engine/types.js';
 export declare enum ADDITIONAL_IDENTIFIER {
     Confirmation = ":confirmation"
 }
@@ -18,12 +18,8 @@ export declare class CacheService {
     });
     getState(request: AnyRequest): Promise<FormSubmissionState>;
     setState(request: AnyFormRequest, state: FormSubmissionState): Promise<FormSubmissionState>;
-    getConfirmationState(request: AnyFormRequest): Promise<{
-        confirmed?: true;
-    }>;
-    setConfirmationState(request: AnyFormRequest, confirmationState: {
-        confirmed?: true;
-    }): Promise<void>;
+    getConfirmationState(request: AnyFormRequest): Promise<FormConfirmationState>;
+    setConfirmationState(request: AnyFormRequest, confirmationState: FormConfirmationState): Promise<void>;
     clearState(request: AnyFormRequest): Promise<void>;
     getFlash(request: AnyFormRequest): {
         errors: FormSubmissionError[];

package/.server/server/services/cacheService.js.map

@@ -1 +1 @@
-{"version":3,"file":"cacheService.js","names":["Hoek","config","partition","ADDITIONAL_IDENTIFIER","CacheService","cache","logger","constructor","server","cacheName","log","segment","getState","request","key","Key","cached","get","setState","state","ttl","set","getConfirmationState","Confirmation","value","setConfirmationState","confirmationState","clearState","yar","id","drop","getFlash","messages","flash","Array","isArray","length","at","setFlash","message","additionalIdentifier","Error","params","slug","merge","update","mergeArrays"],"sources":["../../../src/server/services/cacheService.ts"],"sourcesContent":["import { type Server } from '@hapi/hapi'\nimport * as Hoek from '@hapi/hoek'\n\nimport { config } from '~/src/config/index.js'\nimport { type createServer } from '~/src/server/index.js'\nimport {\n  type AnyFormRequest,\n  type AnyRequest,\n  type FormPayload,\n  type FormState,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nconst partition = 'cache'\n\nexport enum ADDITIONAL_IDENTIFIER {\n  Confirmation = ':confirmation'\n}\n\nexport class CacheService {\n  /**\n   * This service is responsible for getting, storing or deleting a user's session data in the cache. This service has been registered by {@link createServer}\n   */\n  cache\n  logger: Server['logger']\n\n  constructor({ server, cacheName }: { server: Server; cacheName?: string }) {\n    if (!cacheName) {\n      server.log(\n        'warn',\n        'You are using the default hapi cache. Please provide a cache name in plugin registration options.'\n      )\n    }\n\n    this.cache = server.cache({ cache: cacheName, segment: 'formSubmission' })\n    this.logger = server.logger\n  }\n\n  async getState(request: AnyRequest): Promise<FormSubmissionState> {\n    const key = this.Key(request)\n    const cached = await this.cache.get(key)\n\n    return cached ?? {}\n  }\n\n  async setState(request: AnyFormRequest, state: FormSubmissionState) {\n    const key = this.Key(request)\n    const ttl = config.get('sessionTimeout')\n\n    await this.cache.set(key, state, ttl)\n\n    return this.getState(request)\n  }\n\n  async getConfirmationState(\n    request: AnyFormRequest\n  ): Promise<{ confirmed?: true }> {\n    const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)\n    const value = await this.cache.get(key)\n\n    return value ?? {}\n  }\n\n  async setConfirmationState(\n    request: AnyFormRequest,\n    confirmationState: { confirmed?: true }\n  ) {\n    const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)\n    const ttl = config.get('confirmationSessionTimeout')\n\n    return this.cache.set(key, confirmationState, ttl)\n  }\n\n  async clearState(request: AnyFormRequest) {\n    if (request.yar.id) {\n      await this.cache.drop(this.Key(request))\n    }\n  }\n\n  getFlash(\n    request: AnyFormRequest\n  ): { errors: FormSubmissionError[] } | undefined {\n    const key = this.Key(request)\n    const messages = request.yar.flash(key.id)\n\n    if (Array.isArray(messages) && messages.length) {\n      return messages.at(0)\n    }\n  }\n\n  setFlash(\n    request: AnyFormRequest,\n    message: { errors: FormSubmissionError[] }\n  ) {\n    const key = this.Key(request)\n\n    request.yar.flash(key.id, message)\n  }\n\n  /**\n   * The key used to store user session data against.\n   * If there are multiple forms on the same runner instance, for example `form-a` and `form-a-feedback` this will prevent CacheService from clearing data from `form-a` if a user gave feedback before they finished `form-a`\n   * @param request - hapi request object\n   * @param additionalIdentifier - appended to the id\n   */\n  Key(request: AnyRequest, additionalIdentifier?: ADDITIONAL_IDENTIFIER) {\n    if (!request.yar.id) {\n      throw new Error('No session ID found')\n    }\n\n    const state = (request.params.state as string) || ''\n    const slug = (request.params.slug as string) || ''\n    const key = `${request.yar.id}:${state}:${slug}:`\n\n    return {\n      segment: partition,\n      id: `${key}${additionalIdentifier ?? ''}`\n    }\n  }\n}\n\n/**\n * State merge helper\n * 1. Merges objects (form fields)\n * 2. Overwrites arrays\n */\nexport function merge<StateType extends FormState | FormPayload>(\n  state: StateType,\n  update: object\n): StateType {\n  return Hoek.merge(state, update, {\n    mergeArrays: false\n  })\n}\n"],"mappings":"AACA,OAAO,KAAKA,IAAI,MAAM,YAAY;AAElC,SAASC,MAAM;AAWf,MAAMC,SAAS,GAAG,OAAO;AAEzB,WAAYC,qBAAqB,0BAArBA,qBAAqB;EAArBA,qBAAqB;EAAA,OAArBA,qBAAqB;AAAA;AAIjC,OAAO,MAAMC,YAAY,CAAC;EACxB;AACF;AACA;EACEC,KAAK;EACLC,MAAM;EAENC,WAAWA,CAAC;IAAEC,MAAM;IAAEC;EAAkD,CAAC,EAAE;IACzE,IAAI,CAACA,SAAS,EAAE;MACdD,MAAM,CAACE,GAAG,CACR,MAAM,EACN,mGACF,CAAC;IACH;IAEA,IAAI,CAACL,KAAK,GAAGG,MAAM,CAACH,KAAK,CAAC;MAAEA,KAAK,EAAEI,SAAS;MAAEE,OAAO,EAAE;IAAiB,CAAC,CAAC;IAC1E,IAAI,CAACL,MAAM,GAAGE,MAAM,CAACF,MAAM;EAC7B;EAEA,MAAMM,QAAQA,CAACC,OAAmB,EAAgC;IAChE,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMG,MAAM,GAAG,MAAM,IAAI,CAACX,KAAK,CAACY,GAAG,CAACH,GAAG,CAAC;IAExC,OAAOE,MAAM,IAAI,CAAC,CAAC;EACrB;EAEA,MAAME,QAAQA,CAACL,OAAuB,EAAEM,KAA0B,EAAE;IAClE,MAAML,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMO,GAAG,GAAGnB,MAAM,CAACgB,GAAG,CAAC,gBAAgB,CAAC;IAExC,MAAM,IAAI,CAACZ,KAAK,CAACgB,GAAG,CAACP,GAAG,EAAEK,KAAK,EAAEC,GAAG,CAAC;IAErC,OAAO,IAAI,CAACR,QAAQ,CAACC,OAAO,CAAC;EAC/B;EAEA,MAAMS,oBAAoBA,CACxBT,OAAuB,EACQ;IAC/B,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAEV,qBAAqB,CAACoB,YAAY,CAAC;IACjE,MAAMC,KAAK,GAAG,MAAM,IAAI,CAACnB,KAAK,CAACY,GAAG,CAACH,GAAG,CAAC;IAEvC,OAAOU,KAAK,IAAI,CAAC,CAAC;EACpB;EAEA,MAAMC,oBAAoBA,CACxBZ,OAAuB,EACvBa,iBAAuC,EACvC;IACA,MAAMZ,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAEV,qBAAqB,CAACoB,YAAY,CAAC;IACjE,MAAMH,GAAG,GAAGnB,MAAM,CAACgB,GAAG,CAAC,4BAA4B,CAAC;IAEpD,OAAO,IAAI,CAACZ,KAAK,CAACgB,GAAG,CAACP,GAAG,EAAEY,iBAAiB,EAAEN,GAAG,CAAC;EACpD;EAEA,MAAMO,UAAUA,CAACd,OAAuB,EAAE;IACxC,IAAIA,OAAO,CAACe,GAAG,CAACC,EAAE,EAAE;MAClB,MAAM,IAAI,CAACxB,KAAK,CAACyB,IAAI,CAAC,IAAI,CAACf,GAAG,CAACF,OAAO,CAAC,CAAC;IAC1C;EACF;EAEAkB,QAAQA,CACNlB,OAAuB,EACwB;IAC/C,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMmB,QAAQ,GAAGnB,OAAO,CAACe,GAAG,CAACK,KAAK,CAACnB,GAAG,CAACe,EAAE,CAAC;IAE1C,IAAIK,KAAK,CAACC,OAAO,CAACH,QAAQ,CAAC,IAAIA,QAAQ,CAACI,MAAM,EAAE;MAC9C,OAAOJ,QAAQ,CAACK,EAAE,CAAC,CAAC,CAAC;IACvB;EACF;EAEAC,QAAQA,CACNzB,OAAuB,EACvB0B,OAA0C,EAC1C;IACA,MAAMzB,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAE7BA,OAAO,CAACe,GAAG,CAACK,KAAK,CAACnB,GAAG,CAACe,EAAE,EAAEU,OAAO,CAAC;EACpC;;EAEA;AACF;AACA;AACA;AACA;AACA;EACExB,GAAGA,CAACF,OAAmB,EAAE2B,oBAA4C,EAAE;IACrE,IAAI,CAAC3B,OAAO,CAACe,GAAG,CAACC,EAAE,EAAE;MACnB,MAAM,IAAIY,KAAK,CAAC,qBAAqB,CAAC;IACxC;IAEA,MAAMtB,KAAK,GAAIN,OAAO,CAAC6B,MAAM,CAACvB,KAAK,IAAe,EAAE;IACpD,MAAMwB,IAAI,GAAI9B,OAAO,CAAC6B,MAAM,CAACC,IAAI,IAAe,EAAE;IAClD,MAAM7B,GAAG,GAAG,GAAGD,OAAO,CAACe,GAAG,CAACC,EAAE,IAAIV,KAAK,IAAIwB,IAAI,GAAG;IAEjD,OAAO;MACLhC,OAAO,EAAET,SAAS;MAClB2B,EAAE,EAAE,GAAGf,GAAG,GAAG0B,oBAAoB,IAAI,EAAE;IACzC,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,KAAKA,CACnBzB,KAAgB,EAChB0B,MAAc,EACH;EACX,OAAO7C,IAAI,CAAC4C,KAAK,CAACzB,KAAK,EAAE0B,MAAM,EAAE;IAC/BC,WAAW,EAAE;EACf,CAAC,CAAC;AACJ","ignoreList":[]}
+{"version":3,"file":"cacheService.js","names":["Hoek","config","partition","ADDITIONAL_IDENTIFIER","CacheService","cache","logger","constructor","server","cacheName","log","segment","getState","request","key","Key","cached","get","setState","state","ttl","set","getConfirmationState","Confirmation","value","setConfirmationState","confirmationState","clearState","yar","id","drop","getFlash","messages","flash","Array","isArray","length","at","setFlash","message","additionalIdentifier","Error","params","slug","merge","update","mergeArrays"],"sources":["../../../src/server/services/cacheService.ts"],"sourcesContent":["import { type Server } from '@hapi/hapi'\nimport * as Hoek from '@hapi/hoek'\n\nimport { config } from '~/src/config/index.js'\nimport { type createServer } from '~/src/server/index.js'\nimport {\n  type AnyFormRequest,\n  type AnyRequest,\n  type FormConfirmationState,\n  type FormPayload,\n  type FormState,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nconst partition = 'cache'\n\nexport enum ADDITIONAL_IDENTIFIER {\n  Confirmation = ':confirmation'\n}\n\nexport class CacheService {\n  /**\n   * This service is responsible for getting, storing or deleting a user's session data in the cache. This service has been registered by {@link createServer}\n   */\n  cache\n  logger: Server['logger']\n\n  constructor({ server, cacheName }: { server: Server; cacheName?: string }) {\n    if (!cacheName) {\n      server.log(\n        'warn',\n        'You are using the default hapi cache. Please provide a cache name in plugin registration options.'\n      )\n    }\n\n    this.cache = server.cache({ cache: cacheName, segment: 'formSubmission' })\n    this.logger = server.logger\n  }\n\n  async getState(request: AnyRequest): Promise<FormSubmissionState> {\n    const key = this.Key(request)\n    const cached = await this.cache.get(key)\n\n    return cached ?? {}\n  }\n\n  async setState(request: AnyFormRequest, state: FormSubmissionState) {\n    const key = this.Key(request)\n    const ttl = config.get('sessionTimeout')\n\n    await this.cache.set(key, state, ttl)\n\n    return this.getState(request)\n  }\n\n  async getConfirmationState(\n    request: AnyFormRequest\n  ): Promise<FormConfirmationState> {\n    const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)\n    const value = await this.cache.get(key)\n\n    return value ?? {}\n  }\n\n  async setConfirmationState(\n    request: AnyFormRequest,\n    confirmationState: FormConfirmationState\n  ) {\n    const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)\n    const ttl = config.get('confirmationSessionTimeout')\n\n    return this.cache.set(key, confirmationState, ttl)\n  }\n\n  async clearState(request: AnyFormRequest) {\n    if (request.yar.id) {\n      await this.cache.drop(this.Key(request))\n    }\n  }\n\n  getFlash(\n    request: AnyFormRequest\n  ): { errors: FormSubmissionError[] } | undefined {\n    const key = this.Key(request)\n    const messages = request.yar.flash(key.id)\n\n    if (Array.isArray(messages) && messages.length) {\n      return messages.at(0)\n    }\n  }\n\n  setFlash(\n    request: AnyFormRequest,\n    message: { errors: FormSubmissionError[] }\n  ) {\n    const key = this.Key(request)\n\n    request.yar.flash(key.id, message)\n  }\n\n  /**\n   * The key used to store user session data against.\n   * If there are multiple forms on the same runner instance, for example `form-a` and `form-a-feedback` this will prevent CacheService from clearing data from `form-a` if a user gave feedback before they finished `form-a`\n   * @param request - hapi request object\n   * @param additionalIdentifier - appended to the id\n   */\n  Key(request: AnyRequest, additionalIdentifier?: ADDITIONAL_IDENTIFIER) {\n    if (!request.yar.id) {\n      throw new Error('No session ID found')\n    }\n\n    const state = (request.params.state as string) || ''\n    const slug = (request.params.slug as string) || ''\n    const key = `${request.yar.id}:${state}:${slug}:`\n\n    return {\n      segment: partition,\n      id: `${key}${additionalIdentifier ?? ''}`\n    }\n  }\n}\n\n/**\n * State merge helper\n * 1. Merges objects (form fields)\n * 2. Overwrites arrays\n */\nexport function merge<StateType extends FormState | FormPayload>(\n  state: StateType,\n  update: object\n): StateType {\n  return Hoek.merge(state, update, {\n    mergeArrays: false\n  })\n}\n"],"mappings":"AACA,OAAO,KAAKA,IAAI,MAAM,YAAY;AAElC,SAASC,MAAM;AAYf,MAAMC,SAAS,GAAG,OAAO;AAEzB,WAAYC,qBAAqB,0BAArBA,qBAAqB;EAArBA,qBAAqB;EAAA,OAArBA,qBAAqB;AAAA;AAIjC,OAAO,MAAMC,YAAY,CAAC;EACxB;AACF;AACA;EACEC,KAAK;EACLC,MAAM;EAENC,WAAWA,CAAC;IAAEC,MAAM;IAAEC;EAAkD,CAAC,EAAE;IACzE,IAAI,CAACA,SAAS,EAAE;MACdD,MAAM,CAACE,GAAG,CACR,MAAM,EACN,mGACF,CAAC;IACH;IAEA,IAAI,CAACL,KAAK,GAAGG,MAAM,CAACH,KAAK,CAAC;MAAEA,KAAK,EAAEI,SAAS;MAAEE,OAAO,EAAE;IAAiB,CAAC,CAAC;IAC1E,IAAI,CAACL,MAAM,GAAGE,MAAM,CAACF,MAAM;EAC7B;EAEA,MAAMM,QAAQA,CAACC,OAAmB,EAAgC;IAChE,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMG,MAAM,GAAG,MAAM,IAAI,CAACX,KAAK,CAACY,GAAG,CAACH,GAAG,CAAC;IAExC,OAAOE,MAAM,IAAI,CAAC,CAAC;EACrB;EAEA,MAAME,QAAQA,CAACL,OAAuB,EAAEM,KAA0B,EAAE;IAClE,MAAML,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMO,GAAG,GAAGnB,MAAM,CAACgB,GAAG,CAAC,gBAAgB,CAAC;IAExC,MAAM,IAAI,CAACZ,KAAK,CAACgB,GAAG,CAACP,GAAG,EAAEK,KAAK,EAAEC,GAAG,CAAC;IAErC,OAAO,IAAI,CAACR,QAAQ,CAACC,OAAO,CAAC;EAC/B;EAEA,MAAMS,oBAAoBA,CACxBT,OAAuB,EACS;IAChC,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAEV,qBAAqB,CAACoB,YAAY,CAAC;IACjE,MAAMC,KAAK,GAAG,MAAM,IAAI,CAACnB,KAAK,CAACY,GAAG,CAACH,GAAG,CAAC;IAEvC,OAAOU,KAAK,IAAI,CAAC,CAAC;EACpB;EAEA,MAAMC,oBAAoBA,CACxBZ,OAAuB,EACvBa,iBAAwC,EACxC;IACA,MAAMZ,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAEV,qBAAqB,CAACoB,YAAY,CAAC;IACjE,MAAMH,GAAG,GAAGnB,MAAM,CAACgB,GAAG,CAAC,4BAA4B,CAAC;IAEpD,OAAO,IAAI,CAACZ,KAAK,CAACgB,GAAG,CAACP,GAAG,EAAEY,iBAAiB,EAAEN,GAAG,CAAC;EACpD;EAEA,MAAMO,UAAUA,CAACd,OAAuB,EAAE;IACxC,IAAIA,OAAO,CAACe,GAAG,CAACC,EAAE,EAAE;MAClB,MAAM,IAAI,CAACxB,KAAK,CAACyB,IAAI,CAAC,IAAI,CAACf,GAAG,CAACF,OAAO,CAAC,CAAC;IAC1C;EACF;EAEAkB,QAAQA,CACNlB,OAAuB,EACwB;IAC/C,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMmB,QAAQ,GAAGnB,OAAO,CAACe,GAAG,CAACK,KAAK,CAACnB,GAAG,CAACe,EAAE,CAAC;IAE1C,IAAIK,KAAK,CAACC,OAAO,CAACH,QAAQ,CAAC,IAAIA,QAAQ,CAACI,MAAM,EAAE;MAC9C,OAAOJ,QAAQ,CAACK,EAAE,CAAC,CAAC,CAAC;IACvB;EACF;EAEAC,QAAQA,CACNzB,OAAuB,EACvB0B,OAA0C,EAC1C;IACA,MAAMzB,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAE7BA,OAAO,CAACe,GAAG,CAACK,KAAK,CAACnB,GAAG,CAACe,EAAE,EAAEU,OAAO,CAAC;EACpC;;EAEA;AACF;AACA;AACA;AACA;AACA;EACExB,GAAGA,CAACF,OAAmB,EAAE2B,oBAA4C,EAAE;IACrE,IAAI,CAAC3B,OAAO,CAACe,GAAG,CAACC,EAAE,EAAE;MACnB,MAAM,IAAIY,KAAK,CAAC,qBAAqB,CAAC;IACxC;IAEA,MAAMtB,KAAK,GAAIN,OAAO,CAAC6B,MAAM,CAACvB,KAAK,IAAe,EAAE;IACpD,MAAMwB,IAAI,GAAI9B,OAAO,CAAC6B,MAAM,CAACC,IAAI,IAAe,EAAE;IAClD,MAAM7B,GAAG,GAAG,GAAGD,OAAO,CAACe,GAAG,CAACC,EAAE,IAAIV,KAAK,IAAIwB,IAAI,GAAG;IAEjD,OAAO;MACLhC,OAAO,EAAET,SAAS;MAClB2B,EAAE,EAAE,GAAGf,GAAG,GAAG0B,oBAAoB,IAAI,EAAE;IACzC,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,KAAKA,CACnBzB,KAAgB,EAChB0B,MAAc,EACH;EACX,OAAO7C,IAAI,CAAC4C,KAAK,CAACzB,KAAK,EAAE0B,MAAM,EAAE;IAC/BC,WAAW,EAAE;EACf,CAAC,CAAC;AACJ","ignoreList":[]}

package/.server/server/types.d.ts

@@ -8,6 +8,7 @@ import { type FormRequestPayload, type FormStatus } from '~/src/server/routes/ty
 import { type CacheService } from '~/src/server/services/cacheService.js';
 export interface FormsService {
     getFormMetadata: (slug: string) => Promise<FormMetadata>;
+    getFormMetadataById: (id: string) => Promise<FormMetadata>;
     getFormDefinition: (id: string, state: FormStatus) => Promise<FormDefinition | undefined>;
 }
 export interface FormSubmissionService {

package/.server/server/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\nimport { type Server } from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type OnRequestCallback,\n  type PluginOptions,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  saveAndExit?: PluginOptions['saveAndExit']\n  cacheServiceCreator?: (server: Server) => CacheService\n  ordnanceSurveyApiKey?: string\n}\n\nexport interface OutputService {\n  submit: (\n    context: FormContext,\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload,\n    formMetadata?: FormMetadata\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\nimport { type Server } from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type OnRequestCallback,\n  type PluginOptions,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormMetadataById: (id: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  saveAndExit?: PluginOptions['saveAndExit']\n  cacheServiceCreator?: (server: Server) => CacheService\n  ordnanceSurveyApiKey?: string\n}\n\nexport interface OutputService {\n  submit: (\n    context: FormContext,\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload,\n    formMetadata?: FormMetadata\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}