@defra/forms-engine-plugin 4.11.3 → 4.12.0

package/.server/server/plugins/engine/beta/form-context.js

@@ -1,6 +1,7 @@
 import Boom from '@hapi/boom';
 import { isEqual } from 'date-fns';
 import { PREVIEW_PATH_PREFIX } from "../../../constants.js";
+import { assertFormAvailable } from "../form-availability.js";
 import { checkEmailAddressForLiveFormSubmission, getCacheService } from "../helpers.js";
 import { FormModel } from "../models/index.js";
 import { TerminalPageController } from "../pageControllers/index.js";
@@ -14,6 +15,7 @@ export async function getFormModel(slug, state, options = {}) {
   const isPreview = isPreviewState(state, options);
   const formState = resolveState(state);
   const metadata = await formsService.getFormMetadata(slug);
+  assertFormAvailable(metadata);
   const definition = await formsService.getFormDefinition(metadata.id, formState);
   if (!definition) {
     throw Boom.notFound(`No definition found for form metadata ${metadata.id} (${slug}) ${state}`);
@@ -59,6 +61,7 @@ export async function resolveFormModel(server, slug, state, options = {}) {
     formsService
   } = services;
   const metadata = await formsService.getFormMetadata(slug);
+  assertFormAvailable(metadata);
   const formState = resolveState(state);
   const isPreview = options.isPreview ?? isPreviewState(state, options);
   const stateMetadata = metadata[formState];
@@ -67,10 +70,8 @@ export async function resolveFormModel(server, slug, state, options = {}) {
   }
 
   // The models cache is created lazily per server instance
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  if (!server.app.models) {
-    server.app.models = new Map();
-  }
+
+  server.app.models ??= new Map();
   const cache = server.app.models;
   const cacheKey = `${metadata.id}_${formState}_${isPreview}`;
   let entry = cache.get(cacheKey);

package/.server/server/plugins/engine/beta/form-context.js.map

@@ -1 +1 @@
-{"version":3,"file":"form-context.js","names":["Boom","isEqual","PREVIEW_PATH_PREFIX","checkEmailAddressForLiveFormSubmission","getCacheService","FormModel","TerminalPageController","defaultServices","FormStatus","getFormModel","slug","state","options","services","formsService","isPreview","isPreviewState","formState","resolveState","metadata","getFormMetadata","definition","getFormDefinition","id","notFound","basePath","buildBasePath","routePrefix","ordnanceSurveyApiKey","formId","controllers","getFormContext","server","yar","Live","formModel","resolveFormModel","cacheService","summaryRequest","app","method","params","path","query","url","URL","cachedState","getState","$$__referenceNumber","errors","stateMetadata","models","Map","cache","cacheKey","entry","get","updatedAt","notificationEmail","realm","modifiers","route","prefix","model","set","base","replace","startsWith","slice","getFirstJourneyPage","context","relevantPages","undefined","lastPageReached","at","penultimatePageReached"],"sources":["../../../../../src/server/plugins/engine/beta/form-context.ts"],"sourcesContent":["import Boom from '@hapi/boom'\nimport { type Request, type Server } from '@hapi/hapi'\nimport { isEqual } from 'date-fns'\n\nimport { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'\nimport {\n  checkEmailAddressForLiveFormSubmission,\n  getCacheService\n} from '~/src/server/plugins/engine/helpers.js'\nimport { FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { TerminalPageController } from '~/src/server/plugins/engine/pageControllers/index.js'\nimport * as defaultServices from '~/src/server/plugins/engine/services/index.js'\nimport {\n  type AnyRequest,\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport { FormStatus } from '~/src/server/routes/types.js'\nimport { type Services } from '~/src/server/types.js'\n\ntype JourneyState = FormStatus | 'preview'\n\nexport interface FormModelOptions {\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  basePath?: string\n  ordnanceSurveyApiKey?: string\n  formId?: string\n  routePrefix?: string\n  isPreview?: boolean\n}\n\nexport interface FormContextOptions extends FormModelOptions {\n  errors?: FormSubmissionError[]\n}\n\ntype SummaryRequest = FormContextRequest & {\n  yar: Request['yar']\n}\n\nexport async function getFormModel(\n  slug: string,\n  state: JourneyState,\n  options: FormModelOptions = {}\n) {\n  const services = options.services ?? defaultServices\n  const { formsService } = services\n  const isPreview = isPreviewState(state, options)\n  const formState = resolveState(state)\n\n  const metadata = await formsService.getFormMetadata(slug)\n\n  const definition = await formsService.getFormDefinition(\n    metadata.id,\n    formState\n  )\n\n  if (!definition) {\n    throw Boom.notFound(\n      `No definition found for form metadata ${metadata.id} (${slug}) ${state}`\n    )\n  }\n\n  return new FormModel(\n    definition,\n    {\n      basePath:\n        options.basePath ??\n        buildBasePath(options.routePrefix ?? '', slug, formState, isPreview),\n      ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,\n      formId: options.formId ?? metadata.id\n    },\n    services,\n    options.controllers\n  )\n}\n\nexport async function getFormContext(\n  { server, yar }: Pick<Request, 'server' | 'yar'>,\n  slug: string,\n  state: JourneyState = FormStatus.Live,\n  options: FormContextOptions = {}\n): Promise<FormContext> {\n  const formModel = await resolveFormModel(server, slug, state, options)\n\n  const cacheService = getCacheService(server)\n\n  const summaryRequest: SummaryRequest = {\n    app: {},\n    method: 'get',\n    params: {\n      path: 'summary',\n      slug,\n      ...(isPreviewState(state, options) && {\n        state: resolveState(state)\n      })\n    },\n    path: `/${formModel.basePath}/summary`,\n    query: {},\n    url: new URL(\n      `/${formModel.basePath}/summary`,\n      'https://form-context.local'\n    ),\n    server,\n    yar\n  }\n\n  const cachedState = await cacheService.getState(\n    summaryRequest as unknown as AnyRequest\n  )\n\n  const formState = {\n    ...cachedState,\n    $$__referenceNumber: cachedState.$$__referenceNumber\n  } as unknown as FormSubmissionState\n\n  return formModel.getFormContext(\n    summaryRequest,\n    formState,\n    options.errors ?? []\n  )\n}\n\nexport async function resolveFormModel(\n  server: Server,\n  slug: string,\n  state: JourneyState,\n  options: FormModelOptions = {}\n) {\n  const services = options.services ?? defaultServices\n  const { formsService } = services\n\n  const metadata = await formsService.getFormMetadata(slug)\n  const formState = resolveState(state)\n  const isPreview = options.isPreview ?? isPreviewState(state, options)\n  const stateMetadata = metadata[formState]\n\n  if (!stateMetadata) {\n    throw Boom.notFound(\n      `No '${formState}' state for form metadata ${metadata.id}`\n    )\n  }\n\n  // The models cache is created lazily per server instance\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n  if (!server.app.models) {\n    server.app.models = new Map<string, { model: FormModel; updatedAt: Date }>()\n  }\n\n  const cache = server.app.models as Map<\n    string,\n    { model: FormModel; updatedAt: Date }\n  >\n\n  const cacheKey = `${metadata.id}_${formState}_${isPreview}`\n  let entry = cache.get(cacheKey)\n\n  if (!entry || !isEqual(entry.updatedAt, stateMetadata.updatedAt)) {\n    const definition = await formsService.getFormDefinition(\n      metadata.id,\n      formState\n    )\n\n    if (!definition) {\n      throw Boom.notFound(\n        `No definition found for form metadata ${metadata.id} (${slug}) ${state}`\n      )\n    }\n\n    checkEmailAddressForLiveFormSubmission(\n      metadata.notificationEmail,\n      isPreview\n    )\n\n    const routePrefix =\n      options.routePrefix ?? server.realm.modifiers.route.prefix\n\n    const model = new FormModel(\n      definition,\n      {\n        basePath:\n          options.basePath ??\n          buildBasePath(routePrefix, slug, formState, isPreview),\n        ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,\n        formId: options.formId ?? metadata.id\n      },\n      services,\n      options.controllers\n    )\n\n    entry = { model, updatedAt: stateMetadata.updatedAt }\n    cache.set(cacheKey, entry)\n  }\n\n  return entry.model\n}\n\nfunction buildBasePath(\n  routePrefix: string,\n  slug: string,\n  state: FormStatus,\n  isPreview: boolean\n) {\n  const base = (\n    isPreview\n      ? `${routePrefix}${PREVIEW_PATH_PREFIX}/${state}/${slug}`\n      : `${routePrefix}/${slug}`\n  ).replace(/\\/{2,}/g, '/')\n\n  return base.startsWith('/') ? base.slice(1) : base\n}\n\nexport function getFirstJourneyPage(\n  context?: Pick<FormContext, 'relevantPages'>\n) {\n  if (!context?.relevantPages) {\n    return undefined\n  }\n\n  const lastPageReached = context.relevantPages.at(-1)\n  const penultimatePageReached = context.relevantPages.at(-2)\n\n  if (\n    lastPageReached instanceof TerminalPageController &&\n    penultimatePageReached\n  ) {\n    return penultimatePageReached\n  }\n\n  return lastPageReached\n}\n\nfunction resolveState(state: JourneyState): FormStatus {\n  return state === 'preview' ? FormStatus.Live : state\n}\n\nfunction isPreviewState(\n  state: JourneyState,\n  options: FormModelOptions = {}\n): boolean {\n  return options.isPreview ?? state === 'preview'\n}\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAE7B,SAASC,OAAO,QAAQ,UAAU;AAElC,SAASC,mBAAmB;AAC5B,SACEC,sCAAsC,EACtCC,eAAe;AAEjB,SAASC,SAAS;AAElB,SAASC,sBAAsB;AAC/B,OAAO,KAAKC,eAAe;AAQ3B,SAASC,UAAU;AAuBnB,OAAO,eAAeC,YAAYA,CAChCC,IAAY,EACZC,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EAC9B;EACA,MAAMC,QAAQ,GAAGD,OAAO,CAACC,QAAQ,IAAIN,eAAe;EACpD,MAAM;IAAEO;EAAa,CAAC,GAAGD,QAAQ;EACjC,MAAME,SAAS,GAAGC,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC;EAChD,MAAMK,SAAS,GAAGC,YAAY,CAACP,KAAK,CAAC;EAErC,MAAMQ,QAAQ,GAAG,MAAML,YAAY,CAACM,eAAe,CAACV,IAAI,CAAC;EAEzD,MAAMW,UAAU,GAAG,MAAMP,YAAY,CAACQ,iBAAiB,CACrDH,QAAQ,CAACI,EAAE,EACXN,SACF,CAAC;EAED,IAAI,CAACI,UAAU,EAAE;IACf,MAAMrB,IAAI,CAACwB,QAAQ,CACjB,yCAAyCL,QAAQ,CAACI,EAAE,KAAKb,IAAI,KAAKC,KAAK,EACzE,CAAC;EACH;EAEA,OAAO,IAAIN,SAAS,CAClBgB,UAAU,EACV;IACEI,QAAQ,EACNb,OAAO,CAACa,QAAQ,IAChBC,aAAa,CAACd,OAAO,CAACe,WAAW,IAAI,EAAE,EAAEjB,IAAI,EAAEO,SAAS,EAAEF,SAAS,CAAC;IACtEa,oBAAoB,EAAEhB,OAAO,CAACgB,oBAAoB;IAClDC,MAAM,EAAEjB,OAAO,CAACiB,MAAM,IAAIV,QAAQ,CAACI;EACrC,CAAC,EACDV,QAAQ,EACRD,OAAO,CAACkB,WACV,CAAC;AACH;AAEA,OAAO,eAAeC,cAAcA,CAClC;EAAEC,MAAM;EAAEC;AAAqC,CAAC,EAChDvB,IAAY,EACZC,KAAmB,GAAGH,UAAU,CAAC0B,IAAI,EACrCtB,OAA2B,GAAG,CAAC,CAAC,EACV;EACtB,MAAMuB,SAAS,GAAG,MAAMC,gBAAgB,CAACJ,MAAM,EAAEtB,IAAI,EAAEC,KAAK,EAAEC,OAAO,CAAC;EAEtE,MAAMyB,YAAY,GAAGjC,eAAe,CAAC4B,MAAM,CAAC;EAE5C,MAAMM,cAA8B,GAAG;IACrCC,GAAG,EAAE,CAAC,CAAC;IACPC,MAAM,EAAE,KAAK;IACbC,MAAM,EAAE;MACNC,IAAI,EAAE,SAAS;MACfhC,IAAI;MACJ,IAAIM,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC,IAAI;QACpCD,KAAK,EAAEO,YAAY,CAACP,KAAK;MAC3B,CAAC;IACH,CAAC;IACD+B,IAAI,EAAE,IAAIP,SAAS,CAACV,QAAQ,UAAU;IACtCkB,KAAK,EAAE,CAAC,CAAC;IACTC,GAAG,EAAE,IAAIC,GAAG,CACV,IAAIV,SAAS,CAACV,QAAQ,UAAU,EAChC,4BACF,CAAC;IACDO,MAAM;IACNC;EACF,CAAC;EAED,MAAMa,WAAW,GAAG,MAAMT,YAAY,CAACU,QAAQ,CAC7CT,cACF,CAAC;EAED,MAAMrB,SAAS,GAAG;IAChB,GAAG6B,WAAW;IACdE,mBAAmB,EAAEF,WAAW,CAACE;EACnC,CAAmC;EAEnC,OAAOb,SAAS,CAACJ,cAAc,CAC7BO,cAAc,EACdrB,SAAS,EACTL,OAAO,CAACqC,MAAM,IAAI,EACpB,CAAC;AACH;AAEA,OAAO,eAAeb,gBAAgBA,CACpCJ,MAAc,EACdtB,IAAY,EACZC,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EAC9B;EACA,MAAMC,QAAQ,GAAGD,OAAO,CAACC,QAAQ,IAAIN,eAAe;EACpD,MAAM;IAAEO;EAAa,CAAC,GAAGD,QAAQ;EAEjC,MAAMM,QAAQ,GAAG,MAAML,YAAY,CAACM,eAAe,CAACV,IAAI,CAAC;EACzD,MAAMO,SAAS,GAAGC,YAAY,CAACP,KAAK,CAAC;EACrC,MAAMI,SAAS,GAAGH,OAAO,CAACG,SAAS,IAAIC,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC;EACrE,MAAMsC,aAAa,GAAG/B,QAAQ,CAACF,SAAS,CAAC;EAEzC,IAAI,CAACiC,aAAa,EAAE;IAClB,MAAMlD,IAAI,CAACwB,QAAQ,CACjB,OAAOP,SAAS,6BAA6BE,QAAQ,CAACI,EAAE,EAC1D,CAAC;EACH;;EAEA;EACA;EACA,IAAI,CAACS,MAAM,CAACO,GAAG,CAACY,MAAM,EAAE;IACtBnB,MAAM,CAACO,GAAG,CAACY,MAAM,GAAG,IAAIC,GAAG,CAAgD,CAAC;EAC9E;EAEA,MAAMC,KAAK,GAAGrB,MAAM,CAACO,GAAG,CAACY,MAGxB;EAED,MAAMG,QAAQ,GAAG,GAAGnC,QAAQ,CAACI,EAAE,IAAIN,SAAS,IAAIF,SAAS,EAAE;EAC3D,IAAIwC,KAAK,GAAGF,KAAK,CAACG,GAAG,CAACF,QAAQ,CAAC;EAE/B,IAAI,CAACC,KAAK,IAAI,CAACtD,OAAO,CAACsD,KAAK,CAACE,SAAS,EAAEP,aAAa,CAACO,SAAS,CAAC,EAAE;IAChE,MAAMpC,UAAU,GAAG,MAAMP,YAAY,CAACQ,iBAAiB,CACrDH,QAAQ,CAACI,EAAE,EACXN,SACF,CAAC;IAED,IAAI,CAACI,UAAU,EAAE;MACf,MAAMrB,IAAI,CAACwB,QAAQ,CACjB,yCAAyCL,QAAQ,CAACI,EAAE,KAAKb,IAAI,KAAKC,KAAK,EACzE,CAAC;IACH;IAEAR,sCAAsC,CACpCgB,QAAQ,CAACuC,iBAAiB,EAC1B3C,SACF,CAAC;IAED,MAAMY,WAAW,GACff,OAAO,CAACe,WAAW,IAAIK,MAAM,CAAC2B,KAAK,CAACC,SAAS,CAACC,KAAK,CAACC,MAAM;IAE5D,MAAMC,KAAK,GAAG,IAAI1D,SAAS,CACzBgB,UAAU,EACV;MACEI,QAAQ,EACNb,OAAO,CAACa,QAAQ,IAChBC,aAAa,CAACC,WAAW,EAAEjB,IAAI,EAAEO,SAAS,EAAEF,SAAS,CAAC;MACxDa,oBAAoB,EAAEhB,OAAO,CAACgB,oBAAoB;MAClDC,MAAM,EAAEjB,OAAO,CAACiB,MAAM,IAAIV,QAAQ,CAACI;IACrC,CAAC,EACDV,QAAQ,EACRD,OAAO,CAACkB,WACV,CAAC;IAEDyB,KAAK,GAAG;MAAEQ,KAAK;MAAEN,SAAS,EAAEP,aAAa,CAACO;IAAU,CAAC;IACrDJ,KAAK,CAACW,GAAG,CAACV,QAAQ,EAAEC,KAAK,CAAC;EAC5B;EAEA,OAAOA,KAAK,CAACQ,KAAK;AACpB;AAEA,SAASrC,aAAaA,CACpBC,WAAmB,EACnBjB,IAAY,EACZC,KAAiB,EACjBI,SAAkB,EAClB;EACA,MAAMkD,IAAI,GAAG,CACXlD,SAAS,GACL,GAAGY,WAAW,GAAGzB,mBAAmB,IAAIS,KAAK,IAAID,IAAI,EAAE,GACvD,GAAGiB,WAAW,IAAIjB,IAAI,EAAE,EAC5BwD,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;EAEzB,OAAOD,IAAI,CAACE,UAAU,CAAC,GAAG,CAAC,GAAGF,IAAI,CAACG,KAAK,CAAC,CAAC,CAAC,GAAGH,IAAI;AACpD;AAEA,OAAO,SAASI,mBAAmBA,CACjCC,OAA4C,EAC5C;EACA,IAAI,CAACA,OAAO,EAAEC,aAAa,EAAE;IAC3B,OAAOC,SAAS;EAClB;EAEA,MAAMC,eAAe,GAAGH,OAAO,CAACC,aAAa,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC;EACpD,MAAMC,sBAAsB,GAAGL,OAAO,CAACC,aAAa,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC;EAE3D,IACED,eAAe,YAAYnE,sBAAsB,IACjDqE,sBAAsB,EACtB;IACA,OAAOA,sBAAsB;EAC/B;EAEA,OAAOF,eAAe;AACxB;AAEA,SAASvD,YAAYA,CAACP,KAAmB,EAAc;EACrD,OAAOA,KAAK,KAAK,SAAS,GAAGH,UAAU,CAAC0B,IAAI,GAAGvB,KAAK;AACtD;AAEA,SAASK,cAAcA,CACrBL,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EACrB;EACT,OAAOA,OAAO,CAACG,SAAS,IAAIJ,KAAK,KAAK,SAAS;AACjD","ignoreList":[]}
+{"version":3,"file":"form-context.js","names":["Boom","isEqual","PREVIEW_PATH_PREFIX","assertFormAvailable","checkEmailAddressForLiveFormSubmission","getCacheService","FormModel","TerminalPageController","defaultServices","FormStatus","getFormModel","slug","state","options","services","formsService","isPreview","isPreviewState","formState","resolveState","metadata","getFormMetadata","definition","getFormDefinition","id","notFound","basePath","buildBasePath","routePrefix","ordnanceSurveyApiKey","formId","controllers","getFormContext","server","yar","Live","formModel","resolveFormModel","cacheService","summaryRequest","app","method","params","path","query","url","URL","cachedState","getState","$$__referenceNumber","errors","stateMetadata","models","Map","cache","cacheKey","entry","get","updatedAt","notificationEmail","realm","modifiers","route","prefix","model","set","base","replace","startsWith","slice","getFirstJourneyPage","context","relevantPages","undefined","lastPageReached","at","penultimatePageReached"],"sources":["../../../../../src/server/plugins/engine/beta/form-context.ts"],"sourcesContent":["import Boom from '@hapi/boom'\nimport { type Request, type Server } from '@hapi/hapi'\nimport { isEqual } from 'date-fns'\n\nimport { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'\nimport { assertFormAvailable } from '~/src/server/plugins/engine/form-availability.js'\nimport {\n  checkEmailAddressForLiveFormSubmission,\n  getCacheService\n} from '~/src/server/plugins/engine/helpers.js'\nimport { FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { TerminalPageController } from '~/src/server/plugins/engine/pageControllers/index.js'\nimport * as defaultServices from '~/src/server/plugins/engine/services/index.js'\nimport {\n  type AnyRequest,\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport { FormStatus } from '~/src/server/routes/types.js'\nimport { type Services } from '~/src/server/types.js'\n\ntype JourneyState = FormStatus | 'preview'\n\nexport interface FormModelOptions {\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  basePath?: string\n  ordnanceSurveyApiKey?: string\n  formId?: string\n  routePrefix?: string\n  isPreview?: boolean\n}\n\nexport interface FormContextOptions extends FormModelOptions {\n  errors?: FormSubmissionError[]\n}\n\ntype SummaryRequest = FormContextRequest & {\n  yar: Request['yar']\n}\n\nexport async function getFormModel(\n  slug: string,\n  state: JourneyState,\n  options: FormModelOptions = {}\n) {\n  const services = options.services ?? defaultServices\n  const { formsService } = services\n  const isPreview = isPreviewState(state, options)\n  const formState = resolveState(state)\n\n  const metadata = await formsService.getFormMetadata(slug)\n  assertFormAvailable(metadata)\n\n  const definition = await formsService.getFormDefinition(\n    metadata.id,\n    formState\n  )\n\n  if (!definition) {\n    throw Boom.notFound(\n      `No definition found for form metadata ${metadata.id} (${slug}) ${state}`\n    )\n  }\n\n  return new FormModel(\n    definition,\n    {\n      basePath:\n        options.basePath ??\n        buildBasePath(options.routePrefix ?? '', slug, formState, isPreview),\n      ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,\n      formId: options.formId ?? metadata.id\n    },\n    services,\n    options.controllers\n  )\n}\n\nexport async function getFormContext(\n  { server, yar }: Pick<Request, 'server' | 'yar'>,\n  slug: string,\n  state: JourneyState = FormStatus.Live,\n  options: FormContextOptions = {}\n): Promise<FormContext> {\n  const formModel = await resolveFormModel(server, slug, state, options)\n\n  const cacheService = getCacheService(server)\n\n  const summaryRequest: SummaryRequest = {\n    app: {},\n    method: 'get',\n    params: {\n      path: 'summary',\n      slug,\n      ...(isPreviewState(state, options) && {\n        state: resolveState(state)\n      })\n    },\n    path: `/${formModel.basePath}/summary`,\n    query: {},\n    url: new URL(\n      `/${formModel.basePath}/summary`,\n      'https://form-context.local'\n    ),\n    server,\n    yar\n  }\n\n  const cachedState = await cacheService.getState(\n    summaryRequest as unknown as AnyRequest\n  )\n\n  const formState = {\n    ...cachedState,\n    $$__referenceNumber: cachedState.$$__referenceNumber\n  } as unknown as FormSubmissionState\n\n  return formModel.getFormContext(\n    summaryRequest,\n    formState,\n    options.errors ?? []\n  )\n}\n\nexport async function resolveFormModel(\n  server: Server,\n  slug: string,\n  state: JourneyState,\n  options: FormModelOptions = {}\n) {\n  const services = options.services ?? defaultServices\n  const { formsService } = services\n\n  const metadata = await formsService.getFormMetadata(slug)\n  assertFormAvailable(metadata)\n  const formState = resolveState(state)\n  const isPreview = options.isPreview ?? isPreviewState(state, options)\n  const stateMetadata = metadata[formState]\n\n  if (!stateMetadata) {\n    throw Boom.notFound(\n      `No '${formState}' state for form metadata ${metadata.id}`\n    )\n  }\n\n  // The models cache is created lazily per server instance\n\n  server.app.models ??= new Map<string, { model: FormModel; updatedAt: Date }>()\n\n  const cache = server.app.models\n\n  const cacheKey = `${metadata.id}_${formState}_${isPreview}`\n  let entry = cache.get(cacheKey)\n\n  if (!entry || !isEqual(entry.updatedAt, stateMetadata.updatedAt)) {\n    const definition = await formsService.getFormDefinition(\n      metadata.id,\n      formState\n    )\n\n    if (!definition) {\n      throw Boom.notFound(\n        `No definition found for form metadata ${metadata.id} (${slug}) ${state}`\n      )\n    }\n\n    checkEmailAddressForLiveFormSubmission(\n      metadata.notificationEmail,\n      isPreview\n    )\n\n    const routePrefix =\n      options.routePrefix ?? server.realm.modifiers.route.prefix\n\n    const model = new FormModel(\n      definition,\n      {\n        basePath:\n          options.basePath ??\n          buildBasePath(routePrefix, slug, formState, isPreview),\n        ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,\n        formId: options.formId ?? metadata.id\n      },\n      services,\n      options.controllers\n    )\n\n    entry = { model, updatedAt: stateMetadata.updatedAt }\n    cache.set(cacheKey, entry)\n  }\n\n  return entry.model\n}\n\nfunction buildBasePath(\n  routePrefix: string,\n  slug: string,\n  state: FormStatus,\n  isPreview: boolean\n) {\n  const base = (\n    isPreview\n      ? `${routePrefix}${PREVIEW_PATH_PREFIX}/${state}/${slug}`\n      : `${routePrefix}/${slug}`\n  ).replace(/\\/{2,}/g, '/')\n\n  return base.startsWith('/') ? base.slice(1) : base\n}\n\nexport function getFirstJourneyPage(\n  context?: Pick<FormContext, 'relevantPages'>\n) {\n  if (!context?.relevantPages) {\n    return undefined\n  }\n\n  const lastPageReached = context.relevantPages.at(-1)\n  const penultimatePageReached = context.relevantPages.at(-2)\n\n  if (\n    lastPageReached instanceof TerminalPageController &&\n    penultimatePageReached\n  ) {\n    return penultimatePageReached\n  }\n\n  return lastPageReached\n}\n\nfunction resolveState(state: JourneyState): FormStatus {\n  return state === 'preview' ? FormStatus.Live : state\n}\n\nfunction isPreviewState(\n  state: JourneyState,\n  options: FormModelOptions = {}\n): boolean {\n  return options.isPreview ?? state === 'preview'\n}\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAE7B,SAASC,OAAO,QAAQ,UAAU;AAElC,SAASC,mBAAmB;AAC5B,SAASC,mBAAmB;AAC5B,SACEC,sCAAsC,EACtCC,eAAe;AAEjB,SAASC,SAAS;AAElB,SAASC,sBAAsB;AAC/B,OAAO,KAAKC,eAAe;AAQ3B,SAASC,UAAU;AAuBnB,OAAO,eAAeC,YAAYA,CAChCC,IAAY,EACZC,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EAC9B;EACA,MAAMC,QAAQ,GAAGD,OAAO,CAACC,QAAQ,IAAIN,eAAe;EACpD,MAAM;IAAEO;EAAa,CAAC,GAAGD,QAAQ;EACjC,MAAME,SAAS,GAAGC,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC;EAChD,MAAMK,SAAS,GAAGC,YAAY,CAACP,KAAK,CAAC;EAErC,MAAMQ,QAAQ,GAAG,MAAML,YAAY,CAACM,eAAe,CAACV,IAAI,CAAC;EACzDR,mBAAmB,CAACiB,QAAQ,CAAC;EAE7B,MAAME,UAAU,GAAG,MAAMP,YAAY,CAACQ,iBAAiB,CACrDH,QAAQ,CAACI,EAAE,EACXN,SACF,CAAC;EAED,IAAI,CAACI,UAAU,EAAE;IACf,MAAMtB,IAAI,CAACyB,QAAQ,CACjB,yCAAyCL,QAAQ,CAACI,EAAE,KAAKb,IAAI,KAAKC,KAAK,EACzE,CAAC;EACH;EAEA,OAAO,IAAIN,SAAS,CAClBgB,UAAU,EACV;IACEI,QAAQ,EACNb,OAAO,CAACa,QAAQ,IAChBC,aAAa,CAACd,OAAO,CAACe,WAAW,IAAI,EAAE,EAAEjB,IAAI,EAAEO,SAAS,EAAEF,SAAS,CAAC;IACtEa,oBAAoB,EAAEhB,OAAO,CAACgB,oBAAoB;IAClDC,MAAM,EAAEjB,OAAO,CAACiB,MAAM,IAAIV,QAAQ,CAACI;EACrC,CAAC,EACDV,QAAQ,EACRD,OAAO,CAACkB,WACV,CAAC;AACH;AAEA,OAAO,eAAeC,cAAcA,CAClC;EAAEC,MAAM;EAAEC;AAAqC,CAAC,EAChDvB,IAAY,EACZC,KAAmB,GAAGH,UAAU,CAAC0B,IAAI,EACrCtB,OAA2B,GAAG,CAAC,CAAC,EACV;EACtB,MAAMuB,SAAS,GAAG,MAAMC,gBAAgB,CAACJ,MAAM,EAAEtB,IAAI,EAAEC,KAAK,EAAEC,OAAO,CAAC;EAEtE,MAAMyB,YAAY,GAAGjC,eAAe,CAAC4B,MAAM,CAAC;EAE5C,MAAMM,cAA8B,GAAG;IACrCC,GAAG,EAAE,CAAC,CAAC;IACPC,MAAM,EAAE,KAAK;IACbC,MAAM,EAAE;MACNC,IAAI,EAAE,SAAS;MACfhC,IAAI;MACJ,IAAIM,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC,IAAI;QACpCD,KAAK,EAAEO,YAAY,CAACP,KAAK;MAC3B,CAAC;IACH,CAAC;IACD+B,IAAI,EAAE,IAAIP,SAAS,CAACV,QAAQ,UAAU;IACtCkB,KAAK,EAAE,CAAC,CAAC;IACTC,GAAG,EAAE,IAAIC,GAAG,CACV,IAAIV,SAAS,CAACV,QAAQ,UAAU,EAChC,4BACF,CAAC;IACDO,MAAM;IACNC;EACF,CAAC;EAED,MAAMa,WAAW,GAAG,MAAMT,YAAY,CAACU,QAAQ,CAC7CT,cACF,CAAC;EAED,MAAMrB,SAAS,GAAG;IAChB,GAAG6B,WAAW;IACdE,mBAAmB,EAAEF,WAAW,CAACE;EACnC,CAAmC;EAEnC,OAAOb,SAAS,CAACJ,cAAc,CAC7BO,cAAc,EACdrB,SAAS,EACTL,OAAO,CAACqC,MAAM,IAAI,EACpB,CAAC;AACH;AAEA,OAAO,eAAeb,gBAAgBA,CACpCJ,MAAc,EACdtB,IAAY,EACZC,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EAC9B;EACA,MAAMC,QAAQ,GAAGD,OAAO,CAACC,QAAQ,IAAIN,eAAe;EACpD,MAAM;IAAEO;EAAa,CAAC,GAAGD,QAAQ;EAEjC,MAAMM,QAAQ,GAAG,MAAML,YAAY,CAACM,eAAe,CAACV,IAAI,CAAC;EACzDR,mBAAmB,CAACiB,QAAQ,CAAC;EAC7B,MAAMF,SAAS,GAAGC,YAAY,CAACP,KAAK,CAAC;EACrC,MAAMI,SAAS,GAAGH,OAAO,CAACG,SAAS,IAAIC,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC;EACrE,MAAMsC,aAAa,GAAG/B,QAAQ,CAACF,SAAS,CAAC;EAEzC,IAAI,CAACiC,aAAa,EAAE;IAClB,MAAMnD,IAAI,CAACyB,QAAQ,CACjB,OAAOP,SAAS,6BAA6BE,QAAQ,CAACI,EAAE,EAC1D,CAAC;EACH;;EAEA;;EAEAS,MAAM,CAACO,GAAG,CAACY,MAAM,KAAK,IAAIC,GAAG,CAAgD,CAAC;EAE9E,MAAMC,KAAK,GAAGrB,MAAM,CAACO,GAAG,CAACY,MAAM;EAE/B,MAAMG,QAAQ,GAAG,GAAGnC,QAAQ,CAACI,EAAE,IAAIN,SAAS,IAAIF,SAAS,EAAE;EAC3D,IAAIwC,KAAK,GAAGF,KAAK,CAACG,GAAG,CAACF,QAAQ,CAAC;EAE/B,IAAI,CAACC,KAAK,IAAI,CAACvD,OAAO,CAACuD,KAAK,CAACE,SAAS,EAAEP,aAAa,CAACO,SAAS,CAAC,EAAE;IAChE,MAAMpC,UAAU,GAAG,MAAMP,YAAY,CAACQ,iBAAiB,CACrDH,QAAQ,CAACI,EAAE,EACXN,SACF,CAAC;IAED,IAAI,CAACI,UAAU,EAAE;MACf,MAAMtB,IAAI,CAACyB,QAAQ,CACjB,yCAAyCL,QAAQ,CAACI,EAAE,KAAKb,IAAI,KAAKC,KAAK,EACzE,CAAC;IACH;IAEAR,sCAAsC,CACpCgB,QAAQ,CAACuC,iBAAiB,EAC1B3C,SACF,CAAC;IAED,MAAMY,WAAW,GACff,OAAO,CAACe,WAAW,IAAIK,MAAM,CAAC2B,KAAK,CAACC,SAAS,CAACC,KAAK,CAACC,MAAM;IAE5D,MAAMC,KAAK,GAAG,IAAI1D,SAAS,CACzBgB,UAAU,EACV;MACEI,QAAQ,EACNb,OAAO,CAACa,QAAQ,IAChBC,aAAa,CAACC,WAAW,EAAEjB,IAAI,EAAEO,SAAS,EAAEF,SAAS,CAAC;MACxDa,oBAAoB,EAAEhB,OAAO,CAACgB,oBAAoB;MAClDC,MAAM,EAAEjB,OAAO,CAACiB,MAAM,IAAIV,QAAQ,CAACI;IACrC,CAAC,EACDV,QAAQ,EACRD,OAAO,CAACkB,WACV,CAAC;IAEDyB,KAAK,GAAG;MAAEQ,KAAK;MAAEN,SAAS,EAAEP,aAAa,CAACO;IAAU,CAAC;IACrDJ,KAAK,CAACW,GAAG,CAACV,QAAQ,EAAEC,KAAK,CAAC;EAC5B;EAEA,OAAOA,KAAK,CAACQ,KAAK;AACpB;AAEA,SAASrC,aAAaA,CACpBC,WAAmB,EACnBjB,IAAY,EACZC,KAAiB,EACjBI,SAAkB,EAClB;EACA,MAAMkD,IAAI,GAAG,CACXlD,SAAS,GACL,GAAGY,WAAW,GAAG1B,mBAAmB,IAAIU,KAAK,IAAID,IAAI,EAAE,GACvD,GAAGiB,WAAW,IAAIjB,IAAI,EAAE,EAC5BwD,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;EAEzB,OAAOD,IAAI,CAACE,UAAU,CAAC,GAAG,CAAC,GAAGF,IAAI,CAACG,KAAK,CAAC,CAAC,CAAC,GAAGH,IAAI;AACpD;AAEA,OAAO,SAASI,mBAAmBA,CACjCC,OAA4C,EAC5C;EACA,IAAI,CAACA,OAAO,EAAEC,aAAa,EAAE;IAC3B,OAAOC,SAAS;EAClB;EAEA,MAAMC,eAAe,GAAGH,OAAO,CAACC,aAAa,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC;EACpD,MAAMC,sBAAsB,GAAGL,OAAO,CAACC,aAAa,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC;EAE3D,IACED,eAAe,YAAYnE,sBAAsB,IACjDqE,sBAAsB,EACtB;IACA,OAAOA,sBAAsB;EAC/B;EAEA,OAAOF,eAAe;AACxB;AAEA,SAASvD,YAAYA,CAACP,KAAmB,EAAc;EACrD,OAAOA,KAAK,KAAK,SAAS,GAAGH,UAAU,CAAC0B,IAAI,GAAGvB,KAAK;AACtD;AAEA,SAASK,cAAcA,CACrBL,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EACrB;EACT,OAAOA,OAAO,CAACG,SAAS,IAAIJ,KAAK,KAAK,SAAS;AACjD","ignoreList":[]}

package/.server/server/plugins/engine/components/helpers/geospatial.js.map

@@ -1 +1 @@
-{"version":3,"file":"geospatial.js","names":["GeospatialFieldOptionsCountryEnum","Bourne","booleanWithin","JoiBase","countries","countriesDesc","England","NorthernIreland","Scotland","Wales","Joi","extend","type","base","array","messages","coerce","from","method","value","helpers","trim","undefined","parse","result","errors","error","coordinatesSchema","items","number","required","featurePropertiesSchema","object","keys","description","string","coordinateGridReference","centroidGridReference","featureGeometrySchema","valid","coordinates","when","switch","is","then","min","featureSchema","id","properties","geometry","geospatialSchema","unique","getGeospatialSchema","country","validateCountryBounds","countryFeature","features","find","feature","custom"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/geospatial.ts"],"sourcesContent":["import {\n  GeospatialFieldOptionsCountryEnum,\n  type GeospatialFieldOptionsCountry\n} from '@defra/forms-model'\nimport Bourne from '@hapi/bourne'\nimport { booleanWithin } from '@turf/boolean-within'\nimport JoiBase, { type CustomValidator } from 'joi'\n\nimport {\n  type Coordinates,\n  type Feature,\n  type FeatureProperties,\n  type Geometry\n} from '~/src/server/plugins/engine/types.js'\nimport { countries } from '~/src/server/plugins/map/routes/index.js'\n\nconst countriesDesc: Record<GeospatialFieldOptionsCountryEnum, string> = {\n  [GeospatialFieldOptionsCountryEnum.England]: 'England',\n  [GeospatialFieldOptionsCountryEnum.NorthernIreland]: 'Northern Ireland',\n  [GeospatialFieldOptionsCountryEnum.Scotland]: 'Scotland',\n  [GeospatialFieldOptionsCountryEnum.Wales]: 'Wales'\n}\n\nconst Joi = JoiBase.extend({\n  type: 'array',\n  base: JoiBase.array(),\n  messages: {\n    'object.invalidjson': '{{#label}} must be a valid json array string'\n  },\n  coerce: {\n    from: 'string',\n    method(value, helpers) {\n      if (typeof value === 'string') {\n        if (value.trim() === '') {\n          return {\n            value: undefined\n          }\n        }\n\n        try {\n          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n          return { value: Bourne.parse(value) }\n        } catch {\n          const result = {\n            value,\n            errors: [helpers.error('object.invalidjson')]\n          }\n\n          return result\n        }\n      } else {\n        return {\n          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n          value\n        }\n      }\n    }\n  }\n}) as JoiBase.Root\n\nconst coordinatesSchema = Joi.array<Coordinates[]>()\n  .items(Joi.number().required(), Joi.number().required())\n  .required()\n\nconst featurePropertiesSchema = Joi.object<FeatureProperties>()\n  .keys({\n    description: Joi.string().required(),\n    coordinateGridReference: Joi.string().required(),\n    centroidGridReference: Joi.string().required()\n  })\n  .required()\n\nconst featureGeometrySchema = Joi.object<Geometry>().keys({\n  type: Joi.string().valid('Point', 'LineString', 'Polygon').required(),\n  coordinates: Joi.array()\n    .when('type', {\n      switch: [\n        { is: 'Point', then: coordinatesSchema },\n        {\n          is: 'LineString',\n          then: Joi.array().items(coordinatesSchema).min(2)\n        },\n        {\n          is: 'Polygon',\n          then: Joi.array().items(Joi.array().items(coordinatesSchema).min(3))\n        }\n      ]\n    })\n    .required()\n})\n\nconst featureSchema = Joi.object<Feature>().keys({\n  id: Joi.string().required(),\n  type: Joi.string().valid('Feature').required(),\n  properties: featurePropertiesSchema,\n  geometry: featureGeometrySchema\n})\n\nconst geospatialSchema = Joi.array<Feature[]>()\n  .items(featureSchema)\n  .unique('id')\n  .required()\n\nexport function getGeospatialSchema(country?: GeospatialFieldOptionsCountry) {\n  if (!country) {\n    return geospatialSchema\n  }\n\n  const validateCountryBounds: CustomValidator = (value, helpers) => {\n    const countryFeature = countries.features.find(\n      (feature) => feature.id === country\n    )\n\n    if (!countryFeature) {\n      // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n      return value\n    }\n\n    const result = booleanWithin(value, countryFeature)\n\n    if (!result) {\n      return helpers.error('any.custom', {\n        country: countriesDesc[country as GeospatialFieldOptionsCountryEnum]\n      })\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return value\n  }\n\n  return Joi.array<Feature[]>()\n    .items(featureSchema.custom(validateCountryBounds))\n    .unique('id')\n    .required()\n}\n\n/**\n * @import { CustomHelpers } from 'joi'\n */\n"],"mappings":"AAAA,SACEA,iCAAiC,QAE5B,oBAAoB;AAC3B,OAAOC,MAAM,MAAM,cAAc;AACjC,SAASC,aAAa,QAAQ,sBAAsB;AACpD,OAAOC,OAAO,MAAgC,KAAK;AAQnD,SAASC,SAAS;AAElB,MAAMC,aAAgE,GAAG;EACvE,CAACL,iCAAiC,CAACM,OAAO,GAAG,SAAS;EACtD,CAACN,iCAAiC,CAACO,eAAe,GAAG,kBAAkB;EACvE,CAACP,iCAAiC,CAACQ,QAAQ,GAAG,UAAU;EACxD,CAACR,iCAAiC,CAACS,KAAK,GAAG;AAC7C,CAAC;AAED,MAAMC,GAAG,GAAGP,OAAO,CAACQ,MAAM,CAAC;EACzBC,IAAI,EAAE,OAAO;EACbC,IAAI,EAAEV,OAAO,CAACW,KAAK,CAAC,CAAC;EACrBC,QAAQ,EAAE;IACR,oBAAoB,EAAE;EACxB,CAAC;EACDC,MAAM,EAAE;IACNC,IAAI,EAAE,QAAQ;IACdC,MAAMA,CAACC,KAAK,EAAEC,OAAO,EAAE;MACrB,IAAI,OAAOD,KAAK,KAAK,QAAQ,EAAE;QAC7B,IAAIA,KAAK,CAACE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;UACvB,OAAO;YACLF,KAAK,EAAEG;UACT,CAAC;QACH;QAEA,IAAI;UACF;UACA,OAAO;YAAEH,KAAK,EAAElB,MAAM,CAACsB,KAAK,CAACJ,KAAK;UAAE,CAAC;QACvC,CAAC,CAAC,MAAM;UACN,MAAMK,MAAM,GAAG;YACbL,KAAK;YACLM,MAAM,EAAE,CAACL,OAAO,CAACM,KAAK,CAAC,oBAAoB,CAAC;UAC9C,CAAC;UAED,OAAOF,MAAM;QACf;MACF,CAAC,MAAM;QACL,OAAO;UACL;UACAL;QACF,CAAC;MACH;IACF;EACF;AACF,CAAC,CAAiB;AAElB,MAAMQ,iBAAiB,GAAGjB,GAAG,CAACI,KAAK,CAAgB,CAAC,CACjDc,KAAK,CAAClB,GAAG,CAACmB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC,EAAEpB,GAAG,CAACmB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC,CAAC,CACvDA,QAAQ,CAAC,CAAC;AAEb,MAAMC,uBAAuB,GAAGrB,GAAG,CAACsB,MAAM,CAAoB,CAAC,CAC5DC,IAAI,CAAC;EACJC,WAAW,EAAExB,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACpCM,uBAAuB,EAAE1B,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EAChDO,qBAAqB,EAAE3B,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC;AAC/C,CAAC,CAAC,CACDA,QAAQ,CAAC,CAAC;AAEb,MAAMQ,qBAAqB,GAAG5B,GAAG,CAACsB,MAAM,CAAW,CAAC,CAACC,IAAI,CAAC;EACxDrB,IAAI,EAAEF,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACI,KAAK,CAAC,OAAO,EAAE,YAAY,EAAE,SAAS,CAAC,CAACT,QAAQ,CAAC,CAAC;EACrEU,WAAW,EAAE9B,GAAG,CAACI,KAAK,CAAC,CAAC,CACrB2B,IAAI,CAAC,MAAM,EAAE;IACZC,MAAM,EAAE,CACN;MAAEC,EAAE,EAAE,OAAO;MAAEC,IAAI,EAAEjB;IAAkB,CAAC,EACxC;MACEgB,EAAE,EAAE,YAAY;MAChBC,IAAI,EAAElC,GAAG,CAACI,KAAK,CAAC,CAAC,CAACc,KAAK,CAACD,iBAAiB,CAAC,CAACkB,GAAG,CAAC,CAAC;IAClD,CAAC,EACD;MACEF,EAAE,EAAE,SAAS;MACbC,IAAI,EAAElC,GAAG,CAACI,KAAK,CAAC,CAAC,CAACc,KAAK,CAAClB,GAAG,CAACI,KAAK,CAAC,CAAC,CAACc,KAAK,CAACD,iBAAiB,CAAC,CAACkB,GAAG,CAAC,CAAC,CAAC;IACrE,CAAC;EAEL,CAAC,CAAC,CACDf,QAAQ,CAAC;AACd,CAAC,CAAC;AAEF,MAAMgB,aAAa,GAAGpC,GAAG,CAACsB,MAAM,CAAU,CAAC,CAACC,IAAI,CAAC;EAC/Cc,EAAE,EAAErC,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EAC3BlB,IAAI,EAAEF,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACI,KAAK,CAAC,SAAS,CAAC,CAACT,QAAQ,CAAC,CAAC;EAC9CkB,UAAU,EAAEjB,uBAAuB;EACnCkB,QAAQ,EAAEX;AACZ,CAAC,CAAC;AAEF,MAAMY,gBAAgB,GAAGxC,GAAG,CAACI,KAAK,CAAY,CAAC,CAC5Cc,KAAK,CAACkB,aAAa,CAAC,CACpBK,MAAM,CAAC,IAAI,CAAC,CACZrB,QAAQ,CAAC,CAAC;AAEb,OAAO,SAASsB,mBAAmBA,CAACC,OAAuC,EAAE;EAC3E,IAAI,CAACA,OAAO,EAAE;IACZ,OAAOH,gBAAgB;EACzB;EAEA,MAAMI,qBAAsC,GAAGA,CAACnC,KAAK,EAAEC,OAAO,KAAK;IACjE,MAAMmC,cAAc,GAAGnD,SAAS,CAACoD,QAAQ,CAACC,IAAI,CAC3CC,OAAO,IAAKA,OAAO,CAACX,EAAE,KAAKM,OAC9B,CAAC;IAED,IAAI,CAACE,cAAc,EAAE;MACnB;MACA,OAAOpC,KAAK;IACd;IAEA,MAAMK,MAAM,GAAGtB,aAAa,CAACiB,KAAK,EAAEoC,cAAc,CAAC;IAEnD,IAAI,CAAC/B,MAAM,EAAE;MACX,OAAOJ,OAAO,CAACM,KAAK,CAAC,YAAY,EAAE;QACjC2B,OAAO,EAAEhD,aAAa,CAACgD,OAAO;MAChC,CAAC,CAAC;IACJ;;IAEA;IACA,OAAOlC,KAAK;EACd,CAAC;EAED,OAAOT,GAAG,CAACI,KAAK,CAAY,CAAC,CAC1Bc,KAAK,CAACkB,aAAa,CAACa,MAAM,CAACL,qBAAqB,CAAC,CAAC,CAClDH,MAAM,CAAC,IAAI,CAAC,CACZrB,QAAQ,CAAC,CAAC;AACf;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"geospatial.js","names":["GeospatialFieldOptionsCountryEnum","Bourne","booleanWithin","JoiBase","countries","countriesDesc","England","NorthernIreland","Scotland","Wales","Joi","extend","type","base","array","messages","coerce","from","method","value","helpers","trim","undefined","parse","result","errors","error","coordinatesSchema","items","number","required","featurePropertiesSchema","object","keys","description","string","coordinateGridReference","centroidGridReference","featureGeometrySchema","valid","coordinates","when","switch","is","then","min","featureSchema","id","properties","geometry","geospatialSchema","unique","getGeospatialSchema","country","validateCountryBounds","countryFeature","features","find","feature","custom"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/geospatial.ts"],"sourcesContent":["import {\n  GeospatialFieldOptionsCountryEnum,\n  type GeospatialFieldOptionsCountry\n} from '@defra/forms-model'\nimport Bourne from '@hapi/bourne'\nimport { booleanWithin } from '@turf/boolean-within'\nimport JoiBase, { type CustomValidator } from 'joi'\n\nimport {\n  type Coordinates,\n  type Feature,\n  type FeatureProperties,\n  type Geometry\n} from '~/src/server/plugins/engine/types.js'\nimport { countries } from '~/src/server/plugins/map/routes/index.js'\n\nconst countriesDesc: Record<GeospatialFieldOptionsCountryEnum, string> = {\n  [GeospatialFieldOptionsCountryEnum.England]: 'England',\n  [GeospatialFieldOptionsCountryEnum.NorthernIreland]: 'Northern Ireland',\n  [GeospatialFieldOptionsCountryEnum.Scotland]: 'Scotland',\n  [GeospatialFieldOptionsCountryEnum.Wales]: 'Wales'\n}\n\nconst Joi = JoiBase.extend({\n  type: 'array',\n  base: JoiBase.array(),\n  messages: {\n    'object.invalidjson': '{{#label}} must be a valid json array string'\n  },\n  coerce: {\n    from: 'string',\n    method(value, helpers) {\n      if (typeof value === 'string') {\n        if (value.trim() === '') {\n          return {\n            value: undefined\n          }\n        }\n\n        try {\n          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n          return { value: Bourne.parse(value) }\n        } catch {\n          const result = {\n            value,\n            errors: [helpers.error('object.invalidjson')]\n          }\n\n          return result\n        }\n      } else {\n        return {\n          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n          value\n        }\n      }\n    }\n  }\n}) as JoiBase.Root\n\nconst coordinatesSchema = Joi.array<Coordinates[]>()\n  .items(Joi.number().required(), Joi.number().required())\n  .required()\n\nconst featurePropertiesSchema = Joi.object<FeatureProperties>()\n  .keys({\n    description: Joi.string().required(),\n    coordinateGridReference: Joi.string().required(),\n    centroidGridReference: Joi.string().required()\n  })\n  .required()\n\nconst featureGeometrySchema = Joi.object<Geometry>().keys({\n  type: Joi.string().valid('Point', 'LineString', 'Polygon').required(),\n  coordinates: Joi.array()\n    .when('type', {\n      switch: [\n        { is: 'Point', then: coordinatesSchema },\n        {\n          is: 'LineString',\n          then: Joi.array().items(coordinatesSchema).min(2)\n        },\n        {\n          is: 'Polygon',\n          then: Joi.array().items(Joi.array().items(coordinatesSchema).min(3))\n        }\n      ]\n    })\n    .required()\n})\n\nconst featureSchema = Joi.object<Feature>().keys({\n  id: Joi.string().required(),\n  type: Joi.string().valid('Feature').required(),\n  properties: featurePropertiesSchema,\n  geometry: featureGeometrySchema\n})\n\nconst geospatialSchema = Joi.array<Feature[]>()\n  .items(featureSchema)\n  .unique('id')\n  .required()\n\nexport function getGeospatialSchema(country?: GeospatialFieldOptionsCountry) {\n  if (!country) {\n    return geospatialSchema\n  }\n\n  const validateCountryBounds: CustomValidator = (value, helpers) => {\n    const countryFeature = countries.features.find(\n      (feature) => feature.id === country\n    )\n\n    if (!countryFeature) {\n      // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n      return value\n    }\n\n    const result = booleanWithin(value as Geometry | Feature, countryFeature)\n\n    if (!result) {\n      return helpers.error('any.custom', {\n        country: countriesDesc[country as GeospatialFieldOptionsCountryEnum]\n      })\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return value\n  }\n\n  return Joi.array<Feature[]>()\n    .items(featureSchema.custom(validateCountryBounds))\n    .unique('id')\n    .required()\n}\n\n/**\n * @import { CustomHelpers } from 'joi'\n */\n"],"mappings":"AAAA,SACEA,iCAAiC,QAE5B,oBAAoB;AAC3B,OAAOC,MAAM,MAAM,cAAc;AACjC,SAASC,aAAa,QAAQ,sBAAsB;AACpD,OAAOC,OAAO,MAAgC,KAAK;AAQnD,SAASC,SAAS;AAElB,MAAMC,aAAgE,GAAG;EACvE,CAACL,iCAAiC,CAACM,OAAO,GAAG,SAAS;EACtD,CAACN,iCAAiC,CAACO,eAAe,GAAG,kBAAkB;EACvE,CAACP,iCAAiC,CAACQ,QAAQ,GAAG,UAAU;EACxD,CAACR,iCAAiC,CAACS,KAAK,GAAG;AAC7C,CAAC;AAED,MAAMC,GAAG,GAAGP,OAAO,CAACQ,MAAM,CAAC;EACzBC,IAAI,EAAE,OAAO;EACbC,IAAI,EAAEV,OAAO,CAACW,KAAK,CAAC,CAAC;EACrBC,QAAQ,EAAE;IACR,oBAAoB,EAAE;EACxB,CAAC;EACDC,MAAM,EAAE;IACNC,IAAI,EAAE,QAAQ;IACdC,MAAMA,CAACC,KAAK,EAAEC,OAAO,EAAE;MACrB,IAAI,OAAOD,KAAK,KAAK,QAAQ,EAAE;QAC7B,IAAIA,KAAK,CAACE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;UACvB,OAAO;YACLF,KAAK,EAAEG;UACT,CAAC;QACH;QAEA,IAAI;UACF;UACA,OAAO;YAAEH,KAAK,EAAElB,MAAM,CAACsB,KAAK,CAACJ,KAAK;UAAE,CAAC;QACvC,CAAC,CAAC,MAAM;UACN,MAAMK,MAAM,GAAG;YACbL,KAAK;YACLM,MAAM,EAAE,CAACL,OAAO,CAACM,KAAK,CAAC,oBAAoB,CAAC;UAC9C,CAAC;UAED,OAAOF,MAAM;QACf;MACF,CAAC,MAAM;QACL,OAAO;UACL;UACAL;QACF,CAAC;MACH;IACF;EACF;AACF,CAAC,CAAiB;AAElB,MAAMQ,iBAAiB,GAAGjB,GAAG,CAACI,KAAK,CAAgB,CAAC,CACjDc,KAAK,CAAClB,GAAG,CAACmB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC,EAAEpB,GAAG,CAACmB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC,CAAC,CACvDA,QAAQ,CAAC,CAAC;AAEb,MAAMC,uBAAuB,GAAGrB,GAAG,CAACsB,MAAM,CAAoB,CAAC,CAC5DC,IAAI,CAAC;EACJC,WAAW,EAAExB,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACpCM,uBAAuB,EAAE1B,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EAChDO,qBAAqB,EAAE3B,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC;AAC/C,CAAC,CAAC,CACDA,QAAQ,CAAC,CAAC;AAEb,MAAMQ,qBAAqB,GAAG5B,GAAG,CAACsB,MAAM,CAAW,CAAC,CAACC,IAAI,CAAC;EACxDrB,IAAI,EAAEF,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACI,KAAK,CAAC,OAAO,EAAE,YAAY,EAAE,SAAS,CAAC,CAACT,QAAQ,CAAC,CAAC;EACrEU,WAAW,EAAE9B,GAAG,CAACI,KAAK,CAAC,CAAC,CACrB2B,IAAI,CAAC,MAAM,EAAE;IACZC,MAAM,EAAE,CACN;MAAEC,EAAE,EAAE,OAAO;MAAEC,IAAI,EAAEjB;IAAkB,CAAC,EACxC;MACEgB,EAAE,EAAE,YAAY;MAChBC,IAAI,EAAElC,GAAG,CAACI,KAAK,CAAC,CAAC,CAACc,KAAK,CAACD,iBAAiB,CAAC,CAACkB,GAAG,CAAC,CAAC;IAClD,CAAC,EACD;MACEF,EAAE,EAAE,SAAS;MACbC,IAAI,EAAElC,GAAG,CAACI,KAAK,CAAC,CAAC,CAACc,KAAK,CAAClB,GAAG,CAACI,KAAK,CAAC,CAAC,CAACc,KAAK,CAACD,iBAAiB,CAAC,CAACkB,GAAG,CAAC,CAAC,CAAC;IACrE,CAAC;EAEL,CAAC,CAAC,CACDf,QAAQ,CAAC;AACd,CAAC,CAAC;AAEF,MAAMgB,aAAa,GAAGpC,GAAG,CAACsB,MAAM,CAAU,CAAC,CAACC,IAAI,CAAC;EAC/Cc,EAAE,EAAErC,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EAC3BlB,IAAI,EAAEF,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACI,KAAK,CAAC,SAAS,CAAC,CAACT,QAAQ,CAAC,CAAC;EAC9CkB,UAAU,EAAEjB,uBAAuB;EACnCkB,QAAQ,EAAEX;AACZ,CAAC,CAAC;AAEF,MAAMY,gBAAgB,GAAGxC,GAAG,CAACI,KAAK,CAAY,CAAC,CAC5Cc,KAAK,CAACkB,aAAa,CAAC,CACpBK,MAAM,CAAC,IAAI,CAAC,CACZrB,QAAQ,CAAC,CAAC;AAEb,OAAO,SAASsB,mBAAmBA,CAACC,OAAuC,EAAE;EAC3E,IAAI,CAACA,OAAO,EAAE;IACZ,OAAOH,gBAAgB;EACzB;EAEA,MAAMI,qBAAsC,GAAGA,CAACnC,KAAK,EAAEC,OAAO,KAAK;IACjE,MAAMmC,cAAc,GAAGnD,SAAS,CAACoD,QAAQ,CAACC,IAAI,CAC3CC,OAAO,IAAKA,OAAO,CAACX,EAAE,KAAKM,OAC9B,CAAC;IAED,IAAI,CAACE,cAAc,EAAE;MACnB;MACA,OAAOpC,KAAK;IACd;IAEA,MAAMK,MAAM,GAAGtB,aAAa,CAACiB,KAAK,EAAwBoC,cAAc,CAAC;IAEzE,IAAI,CAAC/B,MAAM,EAAE;MACX,OAAOJ,OAAO,CAACM,KAAK,CAAC,YAAY,EAAE;QACjC2B,OAAO,EAAEhD,aAAa,CAACgD,OAAO;MAChC,CAAC,CAAC;IACJ;;IAEA;IACA,OAAOlC,KAAK;EACd,CAAC;EAED,OAAOT,GAAG,CAACI,KAAK,CAAY,CAAC,CAC1Bc,KAAK,CAACkB,aAAa,CAACa,MAAM,CAACL,qBAAqB,CAAC,CAAC,CAClDH,MAAM,CAAC,IAAI,CAAC,CACZrB,QAAQ,CAAC,CAAC;AACf;;AAEA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/engine/form-availability.d.ts

@@ -0,0 +1,16 @@
+import { type FormMetadata } from '@defra/forms-model';
+import Boom from '@hapi/boom';
+export interface OfflineBoomData {
+    offline: true;
+    metadata: FormMetadata;
+}
+/**
+ * Throws when the form has been taken offline. The plugin's
+ * unavailable-response extension catches the marker and renders the
+ * "Sorry, this form is unavailable" view at HTTP 200.
+ */
+export declare function assertFormAvailable(metadata: FormMetadata): void;
+/** Type guard for the offline Boom marker. */
+export declare function isOfflineBoom(err: unknown): err is Boom.Boom<OfflineBoomData> & {
+    data: OfflineBoomData;
+};

package/.server/server/plugins/engine/form-availability.js

@@ -0,0 +1,26 @@
+import Boom from '@hapi/boom';
+/**
+ * Throws when the form has been taken offline. The plugin's
+ * unavailable-response extension catches the marker and renders the
+ * "Sorry, this form is unavailable" view at HTTP 200.
+ */
+export function assertFormAvailable(metadata) {
+  if (metadata.offline === true) {
+    const data = {
+      offline: true,
+      metadata
+    };
+    throw Boom.boomify(new Error(`Form ${metadata.slug} is offline`), {
+      statusCode: 503,
+      data
+    });
+  }
+}
+
+/** Type guard for the offline Boom marker. */
+export function isOfflineBoom(err) {
+  if (!Boom.isBoom(err)) return false;
+  const data = err.data;
+  return data?.offline === true && !!data.metadata;
+}
+//# sourceMappingURL=form-availability.js.map

package/.server/server/plugins/engine/form-availability.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-availability.js","names":["Boom","assertFormAvailable","metadata","offline","data","boomify","Error","slug","statusCode","isOfflineBoom","err","isBoom"],"sources":["../../../../src/server/plugins/engine/form-availability.ts"],"sourcesContent":["import { type FormMetadata } from '@defra/forms-model'\nimport Boom from '@hapi/boom'\n\nexport interface OfflineBoomData {\n  offline: true\n  metadata: FormMetadata\n}\n\n/**\n * Throws when the form has been taken offline. The plugin's\n * unavailable-response extension catches the marker and renders the\n * \"Sorry, this form is unavailable\" view at HTTP 200.\n */\nexport function assertFormAvailable(metadata: FormMetadata): void {\n  if (metadata.offline === true) {\n    const data: OfflineBoomData = { offline: true, metadata }\n    throw Boom.boomify(new Error(`Form ${metadata.slug} is offline`), {\n      statusCode: 503,\n      data\n    })\n  }\n}\n\n/** Type guard for the offline Boom marker. */\nexport function isOfflineBoom(\n  err: unknown\n): err is Boom.Boom<OfflineBoomData> & { data: OfflineBoomData } {\n  if (!Boom.isBoom(err)) return false\n  const data = err.data as Partial<OfflineBoomData> | null | undefined\n  return data?.offline === true && !!data.metadata\n}\n"],"mappings":"AACA,OAAOA,IAAI,MAAM,YAAY;AAO7B;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAACC,QAAsB,EAAQ;EAChE,IAAIA,QAAQ,CAACC,OAAO,KAAK,IAAI,EAAE;IAC7B,MAAMC,IAAqB,GAAG;MAAED,OAAO,EAAE,IAAI;MAAED;IAAS,CAAC;IACzD,MAAMF,IAAI,CAACK,OAAO,CAAC,IAAIC,KAAK,CAAC,QAAQJ,QAAQ,CAACK,IAAI,aAAa,CAAC,EAAE;MAChEC,UAAU,EAAE,GAAG;MACfJ;IACF,CAAC,CAAC;EACJ;AACF;;AAEA;AACA,OAAO,SAASK,aAAaA,CAC3BC,GAAY,EACmD;EAC/D,IAAI,CAACV,IAAI,CAACW,MAAM,CAACD,GAAG,CAAC,EAAE,OAAO,KAAK;EACnC,MAAMN,IAAI,GAAGM,GAAG,CAACN,IAAmD;EACpE,OAAOA,IAAI,EAAED,OAAO,KAAK,IAAI,IAAI,CAAC,CAACC,IAAI,CAACF,QAAQ;AAClD","ignoreList":[]}

package/.server/server/plugins/engine/models/unavailable-view-model.d.ts

@@ -0,0 +1,8 @@
+import { type FormMetadata } from '@defra/forms-model';
+export interface UnavailableViewModel {
+    pageTitle: string;
+    formTitle: string;
+    organisationName: string;
+    phoneLines?: string[];
+}
+export declare function unavailableViewModel(metadata: FormMetadata): UnavailableViewModel;

package/.server/server/plugins/engine/models/unavailable-view-model.js

@@ -0,0 +1,21 @@
+/**
+ * Defra organisations carry an abbreviation suffix on the enum value, e.g.
+ * "Rural Payments Agency – RPA". The unavailable page reads cleanly without it.
+ */
+function stripOrgSuffix(organisation) {
+  return organisation.split(' – ')[0];
+}
+function splitPhoneLines(phone) {
+  if (!phone) return undefined;
+  const lines = phone.split('\n').map(line => line.trim()).filter(line => line.length > 0);
+  return lines.length > 0 ? lines : undefined;
+}
+export function unavailableViewModel(metadata) {
+  return {
+    pageTitle: 'Sorry, this form is unavailable',
+    formTitle: metadata.title,
+    organisationName: stripOrgSuffix(metadata.organisation),
+    phoneLines: splitPhoneLines(metadata.contact?.phone)
+  };
+}
+//# sourceMappingURL=unavailable-view-model.js.map

package/.server/server/plugins/engine/models/unavailable-view-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unavailable-view-model.js","names":["stripOrgSuffix","organisation","split","splitPhoneLines","phone","undefined","lines","map","line","trim","filter","length","unavailableViewModel","metadata","pageTitle","formTitle","title","organisationName","phoneLines","contact"],"sources":["../../../../../src/server/plugins/engine/models/unavailable-view-model.ts"],"sourcesContent":["import { type FormMetadata } from '@defra/forms-model'\n\nexport interface UnavailableViewModel {\n  pageTitle: string\n  formTitle: string\n  organisationName: string\n  phoneLines?: string[]\n}\n\n/**\n * Defra organisations carry an abbreviation suffix on the enum value, e.g.\n * \"Rural Payments Agency – RPA\". The unavailable page reads cleanly without it.\n */\nfunction stripOrgSuffix(organisation: string) {\n  return organisation.split(' – ')[0]\n}\n\nfunction splitPhoneLines(phone: string | undefined) {\n  if (!phone) return undefined\n  const lines = phone\n    .split('\\n')\n    .map((line) => line.trim())\n    .filter((line) => line.length > 0)\n  return lines.length > 0 ? lines : undefined\n}\n\nexport function unavailableViewModel(\n  metadata: FormMetadata\n): UnavailableViewModel {\n  return {\n    pageTitle: 'Sorry, this form is unavailable',\n    formTitle: metadata.title,\n    organisationName: stripOrgSuffix(metadata.organisation),\n    phoneLines: splitPhoneLines(metadata.contact?.phone)\n  }\n}\n"],"mappings":"AASA;AACA;AACA;AACA;AACA,SAASA,cAAcA,CAACC,YAAoB,EAAE;EAC5C,OAAOA,YAAY,CAACC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACrC;AAEA,SAASC,eAAeA,CAACC,KAAyB,EAAE;EAClD,IAAI,CAACA,KAAK,EAAE,OAAOC,SAAS;EAC5B,MAAMC,KAAK,GAAGF,KAAK,CAChBF,KAAK,CAAC,IAAI,CAAC,CACXK,GAAG,CAAEC,IAAI,IAAKA,IAAI,CAACC,IAAI,CAAC,CAAC,CAAC,CAC1BC,MAAM,CAAEF,IAAI,IAAKA,IAAI,CAACG,MAAM,GAAG,CAAC,CAAC;EACpC,OAAOL,KAAK,CAACK,MAAM,GAAG,CAAC,GAAGL,KAAK,GAAGD,SAAS;AAC7C;AAEA,OAAO,SAASO,oBAAoBA,CAClCC,QAAsB,EACA;EACtB,OAAO;IACLC,SAAS,EAAE,iCAAiC;IAC5CC,SAAS,EAAEF,QAAQ,CAACG,KAAK;IACzBC,gBAAgB,EAAEjB,cAAc,CAACa,QAAQ,CAACZ,YAAY,CAAC;IACvDiB,UAAU,EAAEf,eAAe,CAACU,QAAQ,CAACM,OAAO,EAAEf,KAAK;EACrD,CAAC;AACH","ignoreList":[]}

package/.server/server/plugins/engine/plugin.js

@@ -5,6 +5,7 @@ import { getRoutes as getPaymentRoutes } from "./routes/payment.js";
 import { getRoutes as getQuestionRoutes } from "./routes/questions.js";
 import { getRoutes as getRepeaterItemDeleteRoutes } from "./routes/repeaters/item-delete.js";
 import { getRoutes as getRepeaterSummaryRoutes } from "./routes/repeaters/summary.js";
+import { registerUnavailableResponse } from "./unavailable-response.js";
 import { registerVision } from "./vision.js";
 import { mapPlugin } from "../map/index.js";
 import { postcodeLookupPlugin } from "../postcode-lookup/index.js";
@@ -82,6 +83,11 @@ export const plugin = {
     };
     const routes = [...getPaymentRoutes(), ...getFileUploadStatusRoutes(), ...getRepeaterSummaryRoutes(getRouteOptions, postRouteOptions, onRequest), ...getRepeaterItemDeleteRoutes(getRouteOptions, postRouteOptions, onRequest), ...getQuestionRoutes(getRouteOptions, postRouteOptions, preparePageEventRequestOptions, onRequest)];
     server.route(routes); // TODO
+
+    // Registration order is important: must be registered after the engine's
+    // routes so it sees their responses, but before any global error-page
+    // handler that would re-shape Boom errors.
+    registerUnavailableResponse(server);
   }
 };
 //# sourceMappingURL=plugin.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","names":["validatePluginOptions","getRoutes","getFileUploadStatusRoutes","makeLoadFormPreHandler","getPaymentRoutes","getQuestionRoutes","getRepeaterItemDeleteRoutes","getRepeaterSummaryRoutes","registerVision","mapPlugin","postcodeLookupPlugin","CacheService","plugin","name","dependencies","multiple","register","server","options","model","cache","saveAndExit","nunjucks","nunjucksOptions","viewContext","preparePageEventRequestOptions","onRequest","ordnanceSurveyApiKey","baseUrl","ordnanceSurveyApiSecret","services","cacheService","cacheName","expose","baseLayoutPath","app","itemCache","Map","models","loadFormPreHandler","getRouteOptions","pre","method","postRouteOptions","payload","parse","routes","route"],"sources":["../../../../src/server/plugins/engine/plugin.ts"],"sourcesContent":["import {\n  type Lifecycle,\n  type Plugin,\n  type RouteOptions,\n  type Server,\n  type ServerRoute\n} from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { validatePluginOptions } from '~/src/server/plugins/engine/options.js'\nimport { getRoutes as getFileUploadStatusRoutes } from '~/src/server/plugins/engine/routes/file-upload.js'\nimport { makeLoadFormPreHandler } from '~/src/server/plugins/engine/routes/index.js'\nimport { getRoutes as getPaymentRoutes } from '~/src/server/plugins/engine/routes/payment.js'\nimport { getRoutes as getQuestionRoutes } from '~/src/server/plugins/engine/routes/questions.js'\nimport { getRoutes as getRepeaterItemDeleteRoutes } from '~/src/server/plugins/engine/routes/repeaters/item-delete.js'\nimport { getRoutes as getRepeaterSummaryRoutes } from '~/src/server/plugins/engine/routes/repeaters/summary.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\nimport { registerVision } from '~/src/server/plugins/engine/vision.js'\nimport { mapPlugin } from '~/src/server/plugins/map/index.js'\nimport { postcodeLookupPlugin } from '~/src/server/plugins/postcode-lookup/index.js'\nimport {\n  type FormRequestPayloadRefs,\n  type FormRequestRefs\n} from '~/src/server/routes/types.js'\nimport { CacheService } from '~/src/server/services/index.js'\n\nexport const plugin = {\n  name: '@defra/forms-engine-plugin',\n  dependencies: ['@hapi/crumb', '@hapi/yar', 'hapi-pino'],\n  multiple: true,\n  async register(server: Server, options: PluginOptions) {\n    options = validatePluginOptions(options)\n\n    const {\n      model,\n      cache,\n      saveAndExit,\n      nunjucks: nunjucksOptions,\n      viewContext,\n      preparePageEventRequestOptions,\n      onRequest,\n      ordnanceSurveyApiKey,\n      baseUrl,\n      ordnanceSurveyApiSecret,\n      services\n    } = options\n\n    const cacheService =\n      typeof cache === 'string'\n        ? new CacheService({ server, cacheName: cache })\n        : cache\n\n    await registerVision(server, options)\n\n    // Register the postcode lookup plugin only if we have an OS api key\n    if (ordnanceSurveyApiKey) {\n      await server.register({\n        plugin: postcodeLookupPlugin,\n        options: {\n          ordnanceSurveyApiKey\n        }\n      })\n    }\n\n    // Register the maps plugin only if we have an OS api key & secret\n    if (ordnanceSurveyApiKey && ordnanceSurveyApiSecret) {\n      await server.register({\n        plugin: mapPlugin,\n        options: {\n          ordnanceSurveyApiKey,\n          ordnanceSurveyApiSecret\n        }\n      })\n    }\n\n    server.expose('baseLayoutPath', nunjucksOptions.baseLayoutPath)\n    server.expose('viewContext', viewContext)\n    server.expose('cacheService', cacheService)\n    server.expose('saveAndExit', saveAndExit)\n    server.expose('baseUrl', baseUrl)\n    server.expose('services', services)\n\n    server.app.model = model\n\n    // In-memory cache of FormModel items, exposed\n    // (for testing purposes) through `server.app.models`\n    const itemCache = new Map<string, { model: FormModel; updatedAt: Date }>()\n    server.app.models = itemCache\n\n    const loadFormPreHandler = makeLoadFormPreHandler(server, options)\n\n    const getRouteOptions: RouteOptions<FormRequestRefs> = {\n      pre: [\n        {\n          method:\n            loadFormPreHandler as unknown as Lifecycle.Method<FormRequestRefs>\n        }\n      ]\n    }\n\n    const postRouteOptions: RouteOptions<FormRequestPayloadRefs> = {\n      payload: {\n        parse: true\n      },\n      pre: [\n        {\n          method:\n            loadFormPreHandler as unknown as Lifecycle.Method<FormRequestPayloadRefs>\n        }\n      ]\n    }\n\n    const routes = [\n      ...getPaymentRoutes(),\n      ...getFileUploadStatusRoutes(),\n      ...getRepeaterSummaryRoutes(getRouteOptions, postRouteOptions, onRequest),\n      ...getRepeaterItemDeleteRoutes(\n        getRouteOptions,\n        postRouteOptions,\n        onRequest\n      ),\n\n      ...getQuestionRoutes(\n        getRouteOptions,\n        postRouteOptions,\n        preparePageEventRequestOptions,\n        onRequest\n      )\n    ]\n\n    server.route(routes as unknown as ServerRoute[]) // TODO\n  }\n} satisfies Plugin<PluginOptions>\n"],"mappings":"AASA,SAASA,qBAAqB;AAC9B,SAASC,SAAS,IAAIC,yBAAyB;AAC/C,SAASC,sBAAsB;AAC/B,SAASF,SAAS,IAAIG,gBAAgB;AACtC,SAASH,SAAS,IAAII,iBAAiB;AACvC,SAASJ,SAAS,IAAIK,2BAA2B;AACjD,SAASL,SAAS,IAAIM,wBAAwB;AAE9C,SAASC,cAAc;AACvB,SAASC,SAAS;AAClB,SAASC,oBAAoB;AAK7B,SAASC,YAAY;AAErB,OAAO,MAAMC,MAAM,GAAG;EACpBC,IAAI,EAAE,4BAA4B;EAClCC,YAAY,EAAE,CAAC,aAAa,EAAE,WAAW,EAAE,WAAW,CAAC;EACvDC,QAAQ,EAAE,IAAI;EACd,MAAMC,QAAQA,CAACC,MAAc,EAAEC,OAAsB,EAAE;IACrDA,OAAO,GAAGlB,qBAAqB,CAACkB,OAAO,CAAC;IAExC,MAAM;MACJC,KAAK;MACLC,KAAK;MACLC,WAAW;MACXC,QAAQ,EAAEC,eAAe;MACzBC,WAAW;MACXC,8BAA8B;MAC9BC,SAAS;MACTC,oBAAoB;MACpBC,OAAO;MACPC,uBAAuB;MACvBC;IACF,CAAC,GAAGZ,OAAO;IAEX,MAAMa,YAAY,GAChB,OAAOX,KAAK,KAAK,QAAQ,GACrB,IAAIT,YAAY,CAAC;MAAEM,MAAM;MAAEe,SAAS,EAAEZ;IAAM,CAAC,CAAC,GAC9CA,KAAK;IAEX,MAAMZ,cAAc,CAACS,MAAM,EAAEC,OAAO,CAAC;;IAErC;IACA,IAAIS,oBAAoB,EAAE;MACxB,MAAMV,MAAM,CAACD,QAAQ,CAAC;QACpBJ,MAAM,EAAEF,oBAAoB;QAC5BQ,OAAO,EAAE;UACPS;QACF;MACF,CAAC,CAAC;IACJ;;IAEA;IACA,IAAIA,oBAAoB,IAAIE,uBAAuB,EAAE;MACnD,MAAMZ,MAAM,CAACD,QAAQ,CAAC;QACpBJ,MAAM,EAAEH,SAAS;QACjBS,OAAO,EAAE;UACPS,oBAAoB;UACpBE;QACF;MACF,CAAC,CAAC;IACJ;IAEAZ,MAAM,CAACgB,MAAM,CAAC,gBAAgB,EAAEV,eAAe,CAACW,cAAc,CAAC;IAC/DjB,MAAM,CAACgB,MAAM,CAAC,aAAa,EAAET,WAAW,CAAC;IACzCP,MAAM,CAACgB,MAAM,CAAC,cAAc,EAAEF,YAAY,CAAC;IAC3Cd,MAAM,CAACgB,MAAM,CAAC,aAAa,EAAEZ,WAAW,CAAC;IACzCJ,MAAM,CAACgB,MAAM,CAAC,SAAS,EAAEL,OAAO,CAAC;IACjCX,MAAM,CAACgB,MAAM,CAAC,UAAU,EAAEH,QAAQ,CAAC;IAEnCb,MAAM,CAACkB,GAAG,CAAChB,KAAK,GAAGA,KAAK;;IAExB;IACA;IACA,MAAMiB,SAAS,GAAG,IAAIC,GAAG,CAAgD,CAAC;IAC1EpB,MAAM,CAACkB,GAAG,CAACG,MAAM,GAAGF,SAAS;IAE7B,MAAMG,kBAAkB,GAAGpC,sBAAsB,CAACc,MAAM,EAAEC,OAAO,CAAC;IAElE,MAAMsB,eAA8C,GAAG;MACrDC,GAAG,EAAE,CACH;QACEC,MAAM,EACJH;MACJ,CAAC;IAEL,CAAC;IAED,MAAMI,gBAAsD,GAAG;MAC7DC,OAAO,EAAE;QACPC,KAAK,EAAE;MACT,CAAC;MACDJ,GAAG,EAAE,CACH;QACEC,MAAM,EACJH;MACJ,CAAC;IAEL,CAAC;IAED,MAAMO,MAAM,GAAG,CACb,GAAG1C,gBAAgB,CAAC,CAAC,EACrB,GAAGF,yBAAyB,CAAC,CAAC,EAC9B,GAAGK,wBAAwB,CAACiC,eAAe,EAAEG,gBAAgB,EAAEjB,SAAS,CAAC,EACzE,GAAGpB,2BAA2B,CAC5BkC,eAAe,EACfG,gBAAgB,EAChBjB,SACF,CAAC,EAED,GAAGrB,iBAAiB,CAClBmC,eAAe,EACfG,gBAAgB,EAChBlB,8BAA8B,EAC9BC,SACF,CAAC,CACF;IAEDT,MAAM,CAAC8B,KAAK,CAACD,MAAkC,CAAC,EAAC;EACnD;AACF,CAAiC","ignoreList":[]}
+{"version":3,"file":"plugin.js","names":["validatePluginOptions","getRoutes","getFileUploadStatusRoutes","makeLoadFormPreHandler","getPaymentRoutes","getQuestionRoutes","getRepeaterItemDeleteRoutes","getRepeaterSummaryRoutes","registerUnavailableResponse","registerVision","mapPlugin","postcodeLookupPlugin","CacheService","plugin","name","dependencies","multiple","register","server","options","model","cache","saveAndExit","nunjucks","nunjucksOptions","viewContext","preparePageEventRequestOptions","onRequest","ordnanceSurveyApiKey","baseUrl","ordnanceSurveyApiSecret","services","cacheService","cacheName","expose","baseLayoutPath","app","itemCache","Map","models","loadFormPreHandler","getRouteOptions","pre","method","postRouteOptions","payload","parse","routes","route"],"sources":["../../../../src/server/plugins/engine/plugin.ts"],"sourcesContent":["import {\n  type Lifecycle,\n  type Plugin,\n  type RouteOptions,\n  type Server,\n  type ServerRoute\n} from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { validatePluginOptions } from '~/src/server/plugins/engine/options.js'\nimport { getRoutes as getFileUploadStatusRoutes } from '~/src/server/plugins/engine/routes/file-upload.js'\nimport { makeLoadFormPreHandler } from '~/src/server/plugins/engine/routes/index.js'\nimport { getRoutes as getPaymentRoutes } from '~/src/server/plugins/engine/routes/payment.js'\nimport { getRoutes as getQuestionRoutes } from '~/src/server/plugins/engine/routes/questions.js'\nimport { getRoutes as getRepeaterItemDeleteRoutes } from '~/src/server/plugins/engine/routes/repeaters/item-delete.js'\nimport { getRoutes as getRepeaterSummaryRoutes } from '~/src/server/plugins/engine/routes/repeaters/summary.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\nimport { registerUnavailableResponse } from '~/src/server/plugins/engine/unavailable-response.js'\nimport { registerVision } from '~/src/server/plugins/engine/vision.js'\nimport { mapPlugin } from '~/src/server/plugins/map/index.js'\nimport { postcodeLookupPlugin } from '~/src/server/plugins/postcode-lookup/index.js'\nimport {\n  type FormRequestPayloadRefs,\n  type FormRequestRefs\n} from '~/src/server/routes/types.js'\nimport { CacheService } from '~/src/server/services/index.js'\n\nexport const plugin = {\n  name: '@defra/forms-engine-plugin',\n  dependencies: ['@hapi/crumb', '@hapi/yar', 'hapi-pino'],\n  multiple: true,\n  async register(server: Server, options: PluginOptions) {\n    options = validatePluginOptions(options)\n\n    const {\n      model,\n      cache,\n      saveAndExit,\n      nunjucks: nunjucksOptions,\n      viewContext,\n      preparePageEventRequestOptions,\n      onRequest,\n      ordnanceSurveyApiKey,\n      baseUrl,\n      ordnanceSurveyApiSecret,\n      services\n    } = options\n\n    const cacheService =\n      typeof cache === 'string'\n        ? new CacheService({ server, cacheName: cache })\n        : cache\n\n    await registerVision(server, options)\n\n    // Register the postcode lookup plugin only if we have an OS api key\n    if (ordnanceSurveyApiKey) {\n      await server.register({\n        plugin: postcodeLookupPlugin,\n        options: {\n          ordnanceSurveyApiKey\n        }\n      })\n    }\n\n    // Register the maps plugin only if we have an OS api key & secret\n    if (ordnanceSurveyApiKey && ordnanceSurveyApiSecret) {\n      await server.register({\n        plugin: mapPlugin,\n        options: {\n          ordnanceSurveyApiKey,\n          ordnanceSurveyApiSecret\n        }\n      })\n    }\n\n    server.expose('baseLayoutPath', nunjucksOptions.baseLayoutPath)\n    server.expose('viewContext', viewContext)\n    server.expose('cacheService', cacheService)\n    server.expose('saveAndExit', saveAndExit)\n    server.expose('baseUrl', baseUrl)\n    server.expose('services', services)\n\n    server.app.model = model\n\n    // In-memory cache of FormModel items, exposed\n    // (for testing purposes) through `server.app.models`\n    const itemCache = new Map<string, { model: FormModel; updatedAt: Date }>()\n    server.app.models = itemCache\n\n    const loadFormPreHandler = makeLoadFormPreHandler(server, options)\n\n    const getRouteOptions: RouteOptions<FormRequestRefs> = {\n      pre: [\n        {\n          method:\n            loadFormPreHandler as unknown as Lifecycle.Method<FormRequestRefs>\n        }\n      ]\n    }\n\n    const postRouteOptions: RouteOptions<FormRequestPayloadRefs> = {\n      payload: {\n        parse: true\n      },\n      pre: [\n        {\n          method:\n            loadFormPreHandler as unknown as Lifecycle.Method<FormRequestPayloadRefs>\n        }\n      ]\n    }\n\n    const routes = [\n      ...getPaymentRoutes(),\n      ...getFileUploadStatusRoutes(),\n      ...getRepeaterSummaryRoutes(getRouteOptions, postRouteOptions, onRequest),\n      ...getRepeaterItemDeleteRoutes(\n        getRouteOptions,\n        postRouteOptions,\n        onRequest\n      ),\n\n      ...getQuestionRoutes(\n        getRouteOptions,\n        postRouteOptions,\n        preparePageEventRequestOptions,\n        onRequest\n      )\n    ]\n\n    server.route(routes as unknown as ServerRoute[]) // TODO\n\n    // Registration order is important: must be registered after the engine's\n    // routes so it sees their responses, but before any global error-page\n    // handler that would re-shape Boom errors.\n    registerUnavailableResponse(server)\n  }\n} satisfies Plugin<PluginOptions>\n"],"mappings":"AASA,SAASA,qBAAqB;AAC9B,SAASC,SAAS,IAAIC,yBAAyB;AAC/C,SAASC,sBAAsB;AAC/B,SAASF,SAAS,IAAIG,gBAAgB;AACtC,SAASH,SAAS,IAAII,iBAAiB;AACvC,SAASJ,SAAS,IAAIK,2BAA2B;AACjD,SAASL,SAAS,IAAIM,wBAAwB;AAE9C,SAASC,2BAA2B;AACpC,SAASC,cAAc;AACvB,SAASC,SAAS;AAClB,SAASC,oBAAoB;AAK7B,SAASC,YAAY;AAErB,OAAO,MAAMC,MAAM,GAAG;EACpBC,IAAI,EAAE,4BAA4B;EAClCC,YAAY,EAAE,CAAC,aAAa,EAAE,WAAW,EAAE,WAAW,CAAC;EACvDC,QAAQ,EAAE,IAAI;EACd,MAAMC,QAAQA,CAACC,MAAc,EAAEC,OAAsB,EAAE;IACrDA,OAAO,GAAGnB,qBAAqB,CAACmB,OAAO,CAAC;IAExC,MAAM;MACJC,KAAK;MACLC,KAAK;MACLC,WAAW;MACXC,QAAQ,EAAEC,eAAe;MACzBC,WAAW;MACXC,8BAA8B;MAC9BC,SAAS;MACTC,oBAAoB;MACpBC,OAAO;MACPC,uBAAuB;MACvBC;IACF,CAAC,GAAGZ,OAAO;IAEX,MAAMa,YAAY,GAChB,OAAOX,KAAK,KAAK,QAAQ,GACrB,IAAIT,YAAY,CAAC;MAAEM,MAAM;MAAEe,SAAS,EAAEZ;IAAM,CAAC,CAAC,GAC9CA,KAAK;IAEX,MAAMZ,cAAc,CAACS,MAAM,EAAEC,OAAO,CAAC;;IAErC;IACA,IAAIS,oBAAoB,EAAE;MACxB,MAAMV,MAAM,CAACD,QAAQ,CAAC;QACpBJ,MAAM,EAAEF,oBAAoB;QAC5BQ,OAAO,EAAE;UACPS;QACF;MACF,CAAC,CAAC;IACJ;;IAEA;IACA,IAAIA,oBAAoB,IAAIE,uBAAuB,EAAE;MACnD,MAAMZ,MAAM,CAACD,QAAQ,CAAC;QACpBJ,MAAM,EAAEH,SAAS;QACjBS,OAAO,EAAE;UACPS,oBAAoB;UACpBE;QACF;MACF,CAAC,CAAC;IACJ;IAEAZ,MAAM,CAACgB,MAAM,CAAC,gBAAgB,EAAEV,eAAe,CAACW,cAAc,CAAC;IAC/DjB,MAAM,CAACgB,MAAM,CAAC,aAAa,EAAET,WAAW,CAAC;IACzCP,MAAM,CAACgB,MAAM,CAAC,cAAc,EAAEF,YAAY,CAAC;IAC3Cd,MAAM,CAACgB,MAAM,CAAC,aAAa,EAAEZ,WAAW,CAAC;IACzCJ,MAAM,CAACgB,MAAM,CAAC,SAAS,EAAEL,OAAO,CAAC;IACjCX,MAAM,CAACgB,MAAM,CAAC,UAAU,EAAEH,QAAQ,CAAC;IAEnCb,MAAM,CAACkB,GAAG,CAAChB,KAAK,GAAGA,KAAK;;IAExB;IACA;IACA,MAAMiB,SAAS,GAAG,IAAIC,GAAG,CAAgD,CAAC;IAC1EpB,MAAM,CAACkB,GAAG,CAACG,MAAM,GAAGF,SAAS;IAE7B,MAAMG,kBAAkB,GAAGrC,sBAAsB,CAACe,MAAM,EAAEC,OAAO,CAAC;IAElE,MAAMsB,eAA8C,GAAG;MACrDC,GAAG,EAAE,CACH;QACEC,MAAM,EACJH;MACJ,CAAC;IAEL,CAAC;IAED,MAAMI,gBAAsD,GAAG;MAC7DC,OAAO,EAAE;QACPC,KAAK,EAAE;MACT,CAAC;MACDJ,GAAG,EAAE,CACH;QACEC,MAAM,EACJH;MACJ,CAAC;IAEL,CAAC;IAED,MAAMO,MAAM,GAAG,CACb,GAAG3C,gBAAgB,CAAC,CAAC,EACrB,GAAGF,yBAAyB,CAAC,CAAC,EAC9B,GAAGK,wBAAwB,CAACkC,eAAe,EAAEG,gBAAgB,EAAEjB,SAAS,CAAC,EACzE,GAAGrB,2BAA2B,CAC5BmC,eAAe,EACfG,gBAAgB,EAChBjB,SACF,CAAC,EAED,GAAGtB,iBAAiB,CAClBoC,eAAe,EACfG,gBAAgB,EAChBlB,8BAA8B,EAC9BC,SACF,CAAC,CACF;IAEDT,MAAM,CAAC8B,KAAK,CAACD,MAAkC,CAAC,EAAC;;IAEjD;IACA;IACA;IACAvC,2BAA2B,CAACU,MAAM,CAAC;EACrC;AACF,CAAiC","ignoreList":[]}

package/.server/server/plugins/engine/unavailable-response.d.ts

@@ -0,0 +1,9 @@
+import { type Server } from '@hapi/hapi';
+/**
+ * Registers a server-wide onPreResponse extension that intercepts the offline
+ * Boom thrown and renders the unavailable view.
+ *
+ * Must be registered after the engine's routes so it sees their responses,
+ * but before any global error-page handler that would re-shape Boom errors.
+ */
+export declare function registerUnavailableResponse(server: Server): void;

package/.server/server/plugins/engine/unavailable-response.js

@@ -0,0 +1,23 @@
+import { isOfflineBoom } from "./form-availability.js";
+import { unavailableViewModel } from "./models/unavailable-view-model.js";
+
+/**
+ * Registers a server-wide onPreResponse extension that intercepts the offline
+ * Boom thrown and renders the unavailable view.
+ *
+ * Must be registered after the engine's routes so it sees their responses,
+ * but before any global error-page handler that would re-shape Boom errors.
+ */
+export function registerUnavailableResponse(server) {
+  server.ext('onPreResponse', (request, h) => {
+    const response = request.response;
+    if (!isOfflineBoom(response)) {
+      return h.continue;
+    }
+    const {
+      metadata
+    } = response.data;
+    return h.view('unavailable', unavailableViewModel(metadata)).header('Cache-Control', 'no-store, no-cache, must-revalidate').header('X-Robots-Tag', 'noindex, nofollow').code(200).takeover();
+  });
+}
+//# sourceMappingURL=unavailable-response.js.map

package/.server/server/plugins/engine/unavailable-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unavailable-response.js","names":["isOfflineBoom","unavailableViewModel","registerUnavailableResponse","server","ext","request","h","response","continue","metadata","data","view","header","code","takeover"],"sources":["../../../../src/server/plugins/engine/unavailable-response.ts"],"sourcesContent":["import { type Request, type ResponseToolkit, type Server } from '@hapi/hapi'\n\nimport { isOfflineBoom } from '~/src/server/plugins/engine/form-availability.js'\nimport { unavailableViewModel } from '~/src/server/plugins/engine/models/unavailable-view-model.js'\n\n/**\n * Registers a server-wide onPreResponse extension that intercepts the offline\n * Boom thrown and renders the unavailable view.\n *\n * Must be registered after the engine's routes so it sees their responses,\n * but before any global error-page handler that would re-shape Boom errors.\n */\nexport function registerUnavailableResponse(server: Server) {\n  server.ext('onPreResponse', (request: Request, h: ResponseToolkit) => {\n    const response = request.response\n    if (!isOfflineBoom(response)) {\n      return h.continue\n    }\n\n    const { metadata } = response.data\n\n    return h\n      .view('unavailable', unavailableViewModel(metadata))\n      .header('Cache-Control', 'no-store, no-cache, must-revalidate')\n      .header('X-Robots-Tag', 'noindex, nofollow')\n      .code(200)\n      .takeover()\n  })\n}\n"],"mappings":"AAEA,SAASA,aAAa;AACtB,SAASC,oBAAoB;;AAE7B;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,2BAA2BA,CAACC,MAAc,EAAE;EAC1DA,MAAM,CAACC,GAAG,CAAC,eAAe,EAAE,CAACC,OAAgB,EAAEC,CAAkB,KAAK;IACpE,MAAMC,QAAQ,GAAGF,OAAO,CAACE,QAAQ;IACjC,IAAI,CAACP,aAAa,CAACO,QAAQ,CAAC,EAAE;MAC5B,OAAOD,CAAC,CAACE,QAAQ;IACnB;IAEA,MAAM;MAAEC;IAAS,CAAC,GAAGF,QAAQ,CAACG,IAAI;IAElC,OAAOJ,CAAC,CACLK,IAAI,CAAC,aAAa,EAAEV,oBAAoB,CAACQ,QAAQ,CAAC,CAAC,CACnDG,MAAM,CAAC,eAAe,EAAE,qCAAqC,CAAC,CAC9DA,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC,CAC3CC,IAAI,CAAC,GAAG,CAAC,CACTC,QAAQ,CAAC,CAAC;EACf,CAAC,CAAC;AACJ","ignoreList":[]}

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

@@ -0,0 +1,20 @@
+{% extends baseLayoutPath %}
+
+{% block content %}
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+      <h1 class="govuk-heading-l">Sorry, this form is unavailable</h1>
+      <p class="govuk-body">'{{ formTitle }}' has been archived and is no longer available.</p>
+      <p class="govuk-body">Contact the {{ organisationName }}.</p>
+
+      {% if phoneLines %}
+        <ul class="govuk-list govuk-list--bullet">
+          {% for line in phoneLines %}
+            <li>{{ line }}</li>
+          {% endfor %}
+        </ul>
+        <p class="govuk-body"><a href="https://www.gov.uk/call-charges" class="govuk-link govuk-link--no-visited-state">Find out about call charges</a></p>
+      {% endif %}
+    </div>
+  </div>
+{% endblock %}

package/.server/typings/hapi/index.d.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.js","names":[],"sources":["../../../src/typings/hapi/index.d.ts"],"sourcesContent":["import { type Plugin } from '@hapi/hapi'\nimport { type ServerYar, type Yar } from '@hapi/yar'\nimport { type Logger } from 'pino'\n\nimport {\n  type COMPONENT_STATE_ERROR,\n  type EXTERNAL_STATE_APPENDAGE,\n  type EXTERNAL_STATE_PAYLOAD\n} from '~/src/server/constants.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type AnyFormRequest,\n  type FormSubmissionError,\n  type PluginOptions\n} from '~/src/server/plugins/engine/types.ts'\nimport { type CacheService } from '~/src/server/services/index.js'\n\ndeclare module '@hapi/yar' {\n  interface YarFlashes {\n    [EXTERNAL_STATE_APPENDAGE]: object\n    [EXTERNAL_STATE_PAYLOAD]: object\n    [COMPONENT_STATE_ERROR]: string\n    [key: string]: { errors: FormSubmissionError[] }\n  }\n}\n\ndeclare module '@hapi/hapi' {\n  // Here we are decorating Hapi interface types with\n  // props from plugins which doesn't export @types\n  interface PluginProperties {\n    crumb: {\n      generate?: (request: AnyRequest) => string\n    }\n    'forms-engine-plugin': {\n      baseLayoutPath: string\n      cacheService: CacheService\n      viewContext?: (\n        request: AnyFormRequest | null\n      ) => Record<string, unknown> | Promise<Record<string, unknown>>\n      saveAndExit?: PluginOptions['saveAndExit']\n      baseUrl: string\n      services: PluginOptions['services']\n    }\n  }\n\n  interface Request {\n    logger: Logger\n    yar: Yar\n  }\n\n  interface RequestApplicationState {\n    model?: FormModel\n  }\n\n  interface Server {\n    logger: Logger\n    yar: ServerYar\n  }\n\n  interface ServerApplicationState {\n    model?: FormModel\n    models: Map<string, { model: FormModel; updatedAt: Date }>\n  }\n}\n\ndeclare module 'blankie' {\n  declare const blankie: {\n    plugin: Plugin<Record<string, boolean | string | string[]>>\n  }\n\n  export = blankie\n}\n\ndeclare module 'blipp' {\n  declare const blipp: {\n    plugin: Plugin\n  }\n\n  export = blipp\n}\n\ndeclare module 'hapi-pulse' {\n  declare const hapiPulse: {\n    plugin: Plugin<{\n      timeout: number\n    }>\n  }\n\n  export = hapiPulse\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"index.d.js","names":[],"sources":["../../../src/typings/hapi/index.d.ts"],"sourcesContent":["import { type Plugin } from '@hapi/hapi'\nimport { type ServerYar, type Yar } from '@hapi/yar'\nimport { type Logger } from 'pino'\n\nimport {\n  type COMPONENT_STATE_ERROR,\n  type EXTERNAL_STATE_APPENDAGE,\n  type EXTERNAL_STATE_PAYLOAD\n} from '~/src/server/constants.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type AnyFormRequest,\n  type FormSubmissionError,\n  type PluginOptions\n} from '~/src/server/plugins/engine/types.ts'\nimport { type CacheService } from '~/src/server/services/index.js'\n\ndeclare module '@hapi/yar' {\n  interface YarFlashes {\n    [EXTERNAL_STATE_APPENDAGE]: object\n    [EXTERNAL_STATE_PAYLOAD]: object\n    [COMPONENT_STATE_ERROR]: string\n    [key: string]: { errors: FormSubmissionError[] }\n  }\n}\n\ndeclare module '@hapi/hapi' {\n  // Here we are decorating Hapi interface types with\n  // props from plugins which doesn't export @types\n  interface PluginProperties {\n    crumb: {\n      generate?: (request: AnyRequest) => string\n    }\n    'forms-engine-plugin': {\n      baseLayoutPath: string\n      cacheService: CacheService\n      viewContext?: (\n        request: AnyFormRequest | null\n      ) => Record<string, unknown> | Promise<Record<string, unknown>>\n      saveAndExit?: PluginOptions['saveAndExit']\n      baseUrl: string\n      services: PluginOptions['services']\n    }\n  }\n\n  interface Request {\n    logger: Logger\n    yar: Yar\n  }\n\n  interface RequestApplicationState {\n    model?: FormModel\n  }\n\n  interface Server {\n    logger: Logger\n    yar: ServerYar\n  }\n\n  interface ServerApplicationState {\n    model?: FormModel\n    models?: Map<string, { model: FormModel; updatedAt: Date }>\n  }\n}\n\ndeclare module 'blankie' {\n  declare const blankie: {\n    plugin: Plugin<Record<string, boolean | string | string[]>>\n  }\n\n  export = blankie\n}\n\ndeclare module 'blipp' {\n  declare const blipp: {\n    plugin: Plugin\n  }\n\n  export = blipp\n}\n\ndeclare module 'hapi-pulse' {\n  declare const hapiPulse: {\n    plugin: Plugin<{\n      timeout: number\n    }>\n  }\n\n  export = hapiPulse\n}\n"],"mappings":"","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.11.3",
+  "version": "4.12.0",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -44,10 +44,10 @@
     "dev:debug": "concurrently \"npm run client:watch\" \"npm run server:watch:debug\" --kill-others --names \"client,server\" --prefix-colors \"red.dim,blue.dim\"",
     "format": "npm run format:check -- --write",
     "format:check": "prettier --cache --cache-location .cache/prettier --cache-strategy content --check \"**/*.{cjs,js,json,md,mjs,scss,ts}\"",
-    "predocs:dev": "node scripts/generate-schema-docs.js && node scripts/generate-component-docs.js",
+    "predocs:dev": "node scripts/generate-schema-docs.js && tsx scripts/generate-component-docs.js",
     "docs:dev": "BROWSERSLIST_ENV=javascripts docusaurus start --host 0.0.0.0",
     "docs:build": "BROWSERSLIST_ENV=javascripts docusaurus build",
-    "docs:build:all": "node scripts/generate-schema-docs.js && node scripts/generate-component-docs.js && npm run docs:build",
+    "docs:build:all": "node scripts/generate-schema-docs.js && tsx scripts/generate-component-docs.js && npm run docs:build",
     "docs:serve": "docusaurus serve --host 0.0.0.0",
     "docs:clear": "docusaurus clear",
     "generate-schema-docs": "node scripts/generate-schema-docs.js",
@@ -87,7 +87,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.655",
+    "@defra/forms-model": "^3.0.663",
     "@defra/hapi-tracing": "^1.29.0",
     "@defra/interactive-map": "^0.0.22-alpha",
     "@elastic/ecs-pino-format": "^1.5.0",

package/src/server/plugins/engine/beta/form-context.ts

@@ -3,6 +3,7 @@ import { type Request, type Server } from '@hapi/hapi'
 import { isEqual } from 'date-fns'
 
 import { PREVIEW_PATH_PREFIX } from '../../../constants.js'
+import { assertFormAvailable } from '../form-availability.js'
 import {
   checkEmailAddressForLiveFormSubmission,
   getCacheService
@@ -52,6 +53,7 @@ export async function getFormModel(
   const formState = resolveState(state)
 
   const metadata = await formsService.getFormMetadata(slug)
+  assertFormAvailable(metadata)
 
   const definition = await formsService.getFormDefinition(
     metadata.id,
@@ -134,6 +136,7 @@ export async function resolveFormModel(
   const { formsService } = services
 
   const metadata = await formsService.getFormMetadata(slug)
+  assertFormAvailable(metadata)
   const formState = resolveState(state)
   const isPreview = options.isPreview ?? isPreviewState(state, options)
   const stateMetadata = metadata[formState]
@@ -145,15 +148,10 @@ export async function resolveFormModel(
   }
 
   // The models cache is created lazily per server instance
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  if (!server.app.models) {
-    server.app.models = new Map<string, { model: FormModel; updatedAt: Date }>()
-  }
 
-  const cache = server.app.models as Map<
-    string,
-    { model: FormModel; updatedAt: Date }
-  >
+  server.app.models ??= new Map<string, { model: FormModel; updatedAt: Date }>()
+
+  const cache = server.app.models
 
   const cacheKey = `${metadata.id}_${formState}_${isPreview}`
   let entry = cache.get(cacheKey)

package/src/server/plugins/engine/components/helpers/geospatial.ts

@@ -116,7 +116,7 @@ export function getGeospatialSchema(country?: GeospatialFieldOptionsCountry) {
       return value
     }
 
-    const result = booleanWithin(value, countryFeature)
+    const result = booleanWithin(value as Geometry | Feature, countryFeature)
 
     if (!result) {
       return helpers.error('any.custom', {

package/src/server/plugins/engine/form-availability.ts

@@ -0,0 +1,31 @@
+import { type FormMetadata } from '@defra/forms-model'
+import Boom from '@hapi/boom'
+
+export interface OfflineBoomData {
+  offline: true
+  metadata: FormMetadata
+}
+
+/**
+ * Throws when the form has been taken offline. The plugin's
+ * unavailable-response extension catches the marker and renders the
+ * "Sorry, this form is unavailable" view at HTTP 200.
+ */
+export function assertFormAvailable(metadata: FormMetadata): void {
+  if (metadata.offline === true) {
+    const data: OfflineBoomData = { offline: true, metadata }
+    throw Boom.boomify(new Error(`Form ${metadata.slug} is offline`), {
+      statusCode: 503,
+      data
+    })
+  }
+}
+
+/** Type guard for the offline Boom marker. */
+export function isOfflineBoom(
+  err: unknown
+): err is Boom.Boom<OfflineBoomData> & { data: OfflineBoomData } {
+  if (!Boom.isBoom(err)) return false
+  const data = err.data as Partial<OfflineBoomData> | null | undefined
+  return data?.offline === true && !!data.metadata
+}

package/src/server/plugins/engine/models/unavailable-view-model.ts

@@ -0,0 +1,36 @@
+import { type FormMetadata } from '@defra/forms-model'
+
+export interface UnavailableViewModel {
+  pageTitle: string
+  formTitle: string
+  organisationName: string
+  phoneLines?: string[]
+}
+
+/**
+ * Defra organisations carry an abbreviation suffix on the enum value, e.g.
+ * "Rural Payments Agency – RPA". The unavailable page reads cleanly without it.
+ */
+function stripOrgSuffix(organisation: string) {
+  return organisation.split(' – ')[0]
+}
+
+function splitPhoneLines(phone: string | undefined) {
+  if (!phone) return undefined
+  const lines = phone
+    .split('\n')
+    .map((line) => line.trim())
+    .filter((line) => line.length > 0)
+  return lines.length > 0 ? lines : undefined
+}
+
+export function unavailableViewModel(
+  metadata: FormMetadata
+): UnavailableViewModel {
+  return {
+    pageTitle: 'Sorry, this form is unavailable',
+    formTitle: metadata.title,
+    organisationName: stripOrgSuffix(metadata.organisation),
+    phoneLines: splitPhoneLines(metadata.contact?.phone)
+  }
+}

package/src/server/plugins/engine/plugin.ts

@@ -15,6 +15,7 @@ import { getRoutes as getQuestionRoutes } from './routes/questions.js'
 import { getRoutes as getRepeaterItemDeleteRoutes } from './routes/repeaters/item-delete.js'
 import { getRoutes as getRepeaterSummaryRoutes } from './routes/repeaters/summary.js'
 import { type PluginOptions } from './types.js'
+import { registerUnavailableResponse } from './unavailable-response.js'
 import { registerVision } from './vision.js'
 import { mapPlugin } from '../map/index.js'
 import { postcodeLookupPlugin } from '../postcode-lookup/index.js'
@@ -129,5 +130,10 @@ export const plugin = {
     ]
 
     server.route(routes as unknown as ServerRoute[]) // TODO
+
+    // Registration order is important: must be registered after the engine's
+    // routes so it sees their responses, but before any global error-page
+    // handler that would re-shape Boom errors.
+    registerUnavailableResponse(server)
   }
 } satisfies Plugin<PluginOptions>

package/src/server/plugins/engine/unavailable-response.ts

@@ -0,0 +1,29 @@
+import { type Request, type ResponseToolkit, type Server } from '@hapi/hapi'
+
+import { isOfflineBoom } from './form-availability.js'
+import { unavailableViewModel } from './models/unavailable-view-model.js'
+
+/**
+ * Registers a server-wide onPreResponse extension that intercepts the offline
+ * Boom thrown and renders the unavailable view.
+ *
+ * Must be registered after the engine's routes so it sees their responses,
+ * but before any global error-page handler that would re-shape Boom errors.
+ */
+export function registerUnavailableResponse(server: Server) {
+  server.ext('onPreResponse', (request: Request, h: ResponseToolkit) => {
+    const response = request.response
+    if (!isOfflineBoom(response)) {
+      return h.continue
+    }
+
+    const { metadata } = response.data
+
+    return h
+      .view('unavailable', unavailableViewModel(metadata))
+      .header('Cache-Control', 'no-store, no-cache, must-revalidate')
+      .header('X-Robots-Tag', 'noindex, nofollow')
+      .code(200)
+      .takeover()
+  })
+}

package/src/server/plugins/engine/views/unavailable.html

@@ -0,0 +1,20 @@
+{% extends baseLayoutPath %}
+
+{% block content %}
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+      <h1 class="govuk-heading-l">Sorry, this form is unavailable</h1>
+      <p class="govuk-body">'{{ formTitle }}' has been archived and is no longer available.</p>
+      <p class="govuk-body">Contact the {{ organisationName }}.</p>
+
+      {% if phoneLines %}
+        <ul class="govuk-list govuk-list--bullet">
+          {% for line in phoneLines %}
+            <li>{{ line }}</li>
+          {% endfor %}
+        </ul>
+        <p class="govuk-body"><a href="https://www.gov.uk/call-charges" class="govuk-link govuk-link--no-visited-state">Find out about call charges</a></p>
+      {% endif %}
+    </div>
+  </div>
+{% endblock %}

package/src/typings/hapi/index.d.ts

@@ -59,7 +59,7 @@ declare module '@hapi/hapi' {
 
   interface ServerApplicationState {
     model?: FormModel
-    models: Map<string, { model: FormModel; updatedAt: Date }>
+    models?: Map<string, { model: FormModel; updatedAt: Date }>
   }
 }