@defra/forms-engine-plugin 3.0.9 → 4.0.1

package/.server/server/plugins/engine/routes/repeaters/summary.js.map

@@ -1 +1 @@
-{"version":3,"file":"summary.js","names":["slugSchema","Boom","Joi","RepeatPageController","redirectOrMakeHandler","actionSchema","crumbSchema","pathSchema","stateSchema","getHandler","request","h","params","page","context","notFound","path","makeGetListSummaryRouteHandler","postHandler","isForceAccess","makePostListSummaryRouteHandler","getRoutes","getRouteOptions","postRouteOptions","method","handler","options","validate","object","keys","slug","state","payload","crumb","action","required"],"sources":["../../../../../../src/server/plugins/engine/routes/repeaters/summary.ts"],"sourcesContent":["// List summary GET route\nimport { slugSchema } from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type RouteOptions, type ServerRoute } from '@hapi/hapi'\nimport Joi from 'joi'\n\nimport { RepeatPageController } from '~/src/server/plugins/engine/pageControllers/RepeatPageController.js'\nimport { redirectOrMakeHandler } from '~/src/server/plugins/engine/routes/index.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs,\n  type FormRequestRefs,\n  type FormResponseToolkit\n} from '~/src/server/routes/types.js'\nimport {\n  actionSchema,\n  crumbSchema,\n  pathSchema,\n  stateSchema\n} from '~/src/server/schemas/index.js'\n\nfunction getHandler(request: FormRequest, h: FormResponseToolkit) {\n  const { params } = request\n\n  return redirectOrMakeHandler(request, h, (page, context) => {\n    if (!(page instanceof RepeatPageController)) {\n      throw Boom.notFound(`No repeater page found for /${params.path}`)\n    }\n\n    return page.makeGetListSummaryRouteHandler()(request, context, h)\n  })\n}\n\nfunction postHandler(request: FormRequestPayload, h: FormResponseToolkit) {\n  const { params } = request\n\n  return redirectOrMakeHandler(request, h, (page, context) => {\n    const { isForceAccess } = context\n\n    if (isForceAccess || !(page instanceof RepeatPageController)) {\n      throw Boom.notFound(`No repeater page found for /${params.path}`)\n    }\n\n    return page.makePostListSummaryRouteHandler()(request, context, h)\n  })\n}\n\nexport function getRoutes(\n  getRouteOptions: RouteOptions<FormRequestRefs>,\n  postRouteOptions: RouteOptions<FormRequestPayloadRefs>\n): (ServerRoute<FormRequestRefs> | ServerRoute<FormRequestPayloadRefs>)[] {\n  return [\n    {\n      method: 'get',\n      path: '/{slug}/{path}/summary',\n      handler: getHandler,\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            slug: slugSchema,\n            path: pathSchema\n          })\n        }\n      }\n    },\n\n    {\n      method: 'get',\n      path: '/preview/{state}/{slug}/{path}/summary',\n      handler: getHandler,\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            state: stateSchema,\n            slug: slugSchema,\n            path: pathSchema\n          })\n        }\n      }\n    },\n\n    {\n      method: 'post',\n      path: '/{slug}/{path}/summary',\n      handler: postHandler,\n      options: {\n        ...postRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            slug: slugSchema,\n            path: pathSchema\n          }),\n          payload: Joi.object()\n            .keys({\n              crumb: crumbSchema,\n              action: actionSchema\n            })\n            .required()\n        }\n      }\n    },\n\n    {\n      method: 'post',\n      path: '/preview/{state}/{slug}/{path}/summary',\n      handler: postHandler,\n      options: {\n        ...postRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            state: stateSchema,\n            slug: slugSchema,\n            path: pathSchema\n          }),\n          payload: Joi.object()\n            .keys({\n              crumb: crumbSchema,\n              action: actionSchema\n            })\n            .required()\n        }\n      }\n    }\n  ]\n}\n"],"mappings":"AAAA;AACA,SAASA,UAAU,QAAQ,oBAAoB;AAC/C,OAAOC,IAAI,MAAM,YAAY;AAE7B,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,oBAAoB;AAC7B,SAASC,qBAAqB;AAQ9B,SACEC,YAAY,EACZC,WAAW,EACXC,UAAU,EACVC,WAAW;AAGb,SAASC,UAAUA,CAACC,OAAoB,EAAEC,CAAsB,EAAE;EAChE,MAAM;IAAEC;EAAO,CAAC,GAAGF,OAAO;EAE1B,OAAON,qBAAqB,CAACM,OAAO,EAAEC,CAAC,EAAE,CAACE,IAAI,EAAEC,OAAO,KAAK;IAC1D,IAAI,EAAED,IAAI,YAAYV,oBAAoB,CAAC,EAAE;MAC3C,MAAMF,IAAI,CAACc,QAAQ,CAAC,+BAA+BH,MAAM,CAACI,IAAI,EAAE,CAAC;IACnE;IAEA,OAAOH,IAAI,CAACI,8BAA8B,CAAC,CAAC,CAACP,OAAO,EAAEI,OAAO,EAAEH,CAAC,CAAC;EACnE,CAAC,CAAC;AACJ;AAEA,SAASO,WAAWA,CAACR,OAA2B,EAAEC,CAAsB,EAAE;EACxE,MAAM;IAAEC;EAAO,CAAC,GAAGF,OAAO;EAE1B,OAAON,qBAAqB,CAACM,OAAO,EAAEC,CAAC,EAAE,CAACE,IAAI,EAAEC,OAAO,KAAK;IAC1D,MAAM;MAAEK;IAAc,CAAC,GAAGL,OAAO;IAEjC,IAAIK,aAAa,IAAI,EAAEN,IAAI,YAAYV,oBAAoB,CAAC,EAAE;MAC5D,MAAMF,IAAI,CAACc,QAAQ,CAAC,+BAA+BH,MAAM,CAACI,IAAI,EAAE,CAAC;IACnE;IAEA,OAAOH,IAAI,CAACO,+BAA+B,CAAC,CAAC,CAACV,OAAO,EAAEI,OAAO,EAAEH,CAAC,CAAC;EACpE,CAAC,CAAC;AACJ;AAEA,OAAO,SAASU,SAASA,CACvBC,eAA8C,EAC9CC,gBAAsD,EACkB;EACxE,OAAO,CACL;IACEC,MAAM,EAAE,KAAK;IACbR,IAAI,EAAE,wBAAwB;IAC9BS,OAAO,EAAEhB,UAAU;IACnBiB,OAAO,EAAE;MACP,GAAGJ,eAAe;MAClBK,QAAQ,EAAE;QACRf,MAAM,EAAEV,GAAG,CAAC0B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBC,IAAI,EAAE9B,UAAU;UAChBgB,IAAI,EAAET;QACR,CAAC;MACH;IACF;EACF,CAAC,EAED;IACEiB,MAAM,EAAE,KAAK;IACbR,IAAI,EAAE,wCAAwC;IAC9CS,OAAO,EAAEhB,UAAU;IACnBiB,OAAO,EAAE;MACP,GAAGJ,eAAe;MAClBK,QAAQ,EAAE;QACRf,MAAM,EAAEV,GAAG,CAAC0B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBE,KAAK,EAAEvB,WAAW;UAClBsB,IAAI,EAAE9B,UAAU;UAChBgB,IAAI,EAAET;QACR,CAAC;MACH;IACF;EACF,CAAC,EAED;IACEiB,MAAM,EAAE,MAAM;IACdR,IAAI,EAAE,wBAAwB;IAC9BS,OAAO,EAAEP,WAAW;IACpBQ,OAAO,EAAE;MACP,GAAGH,gBAAgB;MACnBI,QAAQ,EAAE;QACRf,MAAM,EAAEV,GAAG,CAAC0B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBC,IAAI,EAAE9B,UAAU;UAChBgB,IAAI,EAAET;QACR,CAAC,CAAC;QACFyB,OAAO,EAAE9B,GAAG,CAAC0B,MAAM,CAAC,CAAC,CAClBC,IAAI,CAAC;UACJI,KAAK,EAAE3B,WAAW;UAClB4B,MAAM,EAAE7B;QACV,CAAC,CAAC,CACD8B,QAAQ,CAAC;MACd;IACF;EACF,CAAC,EAED;IACEX,MAAM,EAAE,MAAM;IACdR,IAAI,EAAE,wCAAwC;IAC9CS,OAAO,EAAEP,WAAW;IACpBQ,OAAO,EAAE;MACP,GAAGH,gBAAgB;MACnBI,QAAQ,EAAE;QACRf,MAAM,EAAEV,GAAG,CAAC0B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBE,KAAK,EAAEvB,WAAW;UAClBsB,IAAI,EAAE9B,UAAU;UAChBgB,IAAI,EAAET;QACR,CAAC,CAAC;QACFyB,OAAO,EAAE9B,GAAG,CAAC0B,MAAM,CAAC,CAAC,CAClBC,IAAI,CAAC;UACJI,KAAK,EAAE3B,WAAW;UAClB4B,MAAM,EAAE7B;QACV,CAAC,CAAC,CACD8B,QAAQ,CAAC;MACd;IACF;EACF,CAAC,CACF;AACH","ignoreList":[]}
+{"version":3,"file":"summary.js","names":["slugSchema","Boom","Joi","RepeatPageController","redirectOrMakeHandler","actionSchema","crumbSchema","pathSchema","stateSchema","getHandler","onRequest","request","h","params","page","context","notFound","path","makeGetListSummaryRouteHandler","postHandler","isForceAccess","makePostListSummaryRouteHandler","getRoutes","getRouteOptions","postRouteOptions","method","handler","options","validate","object","keys","slug","state","payload","crumb","action","required"],"sources":["../../../../../../src/server/plugins/engine/routes/repeaters/summary.ts"],"sourcesContent":["// List summary GET route\nimport { slugSchema } from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type RouteOptions, type ServerRoute } from '@hapi/hapi'\nimport Joi from 'joi'\n\nimport { RepeatPageController } from '~/src/server/plugins/engine/pageControllers/RepeatPageController.js'\nimport { redirectOrMakeHandler } from '~/src/server/plugins/engine/routes/index.js'\nimport { type OnRequestCallback } from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs,\n  type FormRequestRefs,\n  type FormResponseToolkit\n} from '~/src/server/routes/types.js'\nimport {\n  actionSchema,\n  crumbSchema,\n  pathSchema,\n  stateSchema\n} from '~/src/server/schemas/index.js'\n\nfunction getHandler(onRequest?: OnRequestCallback) {\n  return async function (request: FormRequest, h: FormResponseToolkit) {\n    const { params } = request\n\n    return redirectOrMakeHandler(request, h, onRequest, (page, context) => {\n      if (!(page instanceof RepeatPageController)) {\n        throw Boom.notFound(`No repeater page found for /${params.path}`)\n      }\n\n      return page.makeGetListSummaryRouteHandler()(request, context, h)\n    })\n  }\n}\n\nfunction postHandler(onRequest?: OnRequestCallback) {\n  return async function (request: FormRequestPayload, h: FormResponseToolkit) {\n    const { params } = request\n\n    return redirectOrMakeHandler(request, h, onRequest, (page, context) => {\n      const { isForceAccess } = context\n\n      if (isForceAccess || !(page instanceof RepeatPageController)) {\n        throw Boom.notFound(`No repeater page found for /${params.path}`)\n      }\n\n      return page.makePostListSummaryRouteHandler()(request, context, h)\n    })\n  }\n}\n\nexport function getRoutes(\n  getRouteOptions: RouteOptions<FormRequestRefs>,\n  postRouteOptions: RouteOptions<FormRequestPayloadRefs>,\n  onRequest?: OnRequestCallback\n): (ServerRoute<FormRequestRefs> | ServerRoute<FormRequestPayloadRefs>)[] {\n  return [\n    {\n      method: 'get',\n      path: '/{slug}/{path}/summary',\n      handler: getHandler(onRequest),\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            slug: slugSchema,\n            path: pathSchema\n          })\n        }\n      }\n    },\n\n    {\n      method: 'get',\n      path: '/preview/{state}/{slug}/{path}/summary',\n      handler: getHandler(onRequest),\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            state: stateSchema,\n            slug: slugSchema,\n            path: pathSchema\n          })\n        }\n      }\n    },\n\n    {\n      method: 'post',\n      path: '/{slug}/{path}/summary',\n      handler: postHandler(onRequest),\n      options: {\n        ...postRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            slug: slugSchema,\n            path: pathSchema\n          }),\n          payload: Joi.object()\n            .keys({\n              crumb: crumbSchema,\n              action: actionSchema\n            })\n            .required()\n        }\n      }\n    },\n\n    {\n      method: 'post',\n      path: '/preview/{state}/{slug}/{path}/summary',\n      handler: postHandler(onRequest),\n      options: {\n        ...postRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            state: stateSchema,\n            slug: slugSchema,\n            path: pathSchema\n          }),\n          payload: Joi.object()\n            .keys({\n              crumb: crumbSchema,\n              action: actionSchema\n            })\n            .required()\n        }\n      }\n    }\n  ]\n}\n"],"mappings":"AAAA;AACA,SAASA,UAAU,QAAQ,oBAAoB;AAC/C,OAAOC,IAAI,MAAM,YAAY;AAE7B,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,oBAAoB;AAC7B,SAASC,qBAAqB;AAS9B,SACEC,YAAY,EACZC,WAAW,EACXC,UAAU,EACVC,WAAW;AAGb,SAASC,UAAUA,CAACC,SAA6B,EAAE;EACjD,OAAO,gBAAgBC,OAAoB,EAAEC,CAAsB,EAAE;IACnE,MAAM;MAAEC;IAAO,CAAC,GAAGF,OAAO;IAE1B,OAAOP,qBAAqB,CAACO,OAAO,EAAEC,CAAC,EAAEF,SAAS,EAAE,CAACI,IAAI,EAAEC,OAAO,KAAK;MACrE,IAAI,EAAED,IAAI,YAAYX,oBAAoB,CAAC,EAAE;QAC3C,MAAMF,IAAI,CAACe,QAAQ,CAAC,+BAA+BH,MAAM,CAACI,IAAI,EAAE,CAAC;MACnE;MAEA,OAAOH,IAAI,CAACI,8BAA8B,CAAC,CAAC,CAACP,OAAO,EAAEI,OAAO,EAAEH,CAAC,CAAC;IACnE,CAAC,CAAC;EACJ,CAAC;AACH;AAEA,SAASO,WAAWA,CAACT,SAA6B,EAAE;EAClD,OAAO,gBAAgBC,OAA2B,EAAEC,CAAsB,EAAE;IAC1E,MAAM;MAAEC;IAAO,CAAC,GAAGF,OAAO;IAE1B,OAAOP,qBAAqB,CAACO,OAAO,EAAEC,CAAC,EAAEF,SAAS,EAAE,CAACI,IAAI,EAAEC,OAAO,KAAK;MACrE,MAAM;QAAEK;MAAc,CAAC,GAAGL,OAAO;MAEjC,IAAIK,aAAa,IAAI,EAAEN,IAAI,YAAYX,oBAAoB,CAAC,EAAE;QAC5D,MAAMF,IAAI,CAACe,QAAQ,CAAC,+BAA+BH,MAAM,CAACI,IAAI,EAAE,CAAC;MACnE;MAEA,OAAOH,IAAI,CAACO,+BAA+B,CAAC,CAAC,CAACV,OAAO,EAAEI,OAAO,EAAEH,CAAC,CAAC;IACpE,CAAC,CAAC;EACJ,CAAC;AACH;AAEA,OAAO,SAASU,SAASA,CACvBC,eAA8C,EAC9CC,gBAAsD,EACtDd,SAA6B,EAC2C;EACxE,OAAO,CACL;IACEe,MAAM,EAAE,KAAK;IACbR,IAAI,EAAE,wBAAwB;IAC9BS,OAAO,EAAEjB,UAAU,CAACC,SAAS,CAAC;IAC9BiB,OAAO,EAAE;MACP,GAAGJ,eAAe;MAClBK,QAAQ,EAAE;QACRf,MAAM,EAAEX,GAAG,CAAC2B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBC,IAAI,EAAE/B,UAAU;UAChBiB,IAAI,EAAEV;QACR,CAAC;MACH;IACF;EACF,CAAC,EAED;IACEkB,MAAM,EAAE,KAAK;IACbR,IAAI,EAAE,wCAAwC;IAC9CS,OAAO,EAAEjB,UAAU,CAACC,SAAS,CAAC;IAC9BiB,OAAO,EAAE;MACP,GAAGJ,eAAe;MAClBK,QAAQ,EAAE;QACRf,MAAM,EAAEX,GAAG,CAAC2B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBE,KAAK,EAAExB,WAAW;UAClBuB,IAAI,EAAE/B,UAAU;UAChBiB,IAAI,EAAEV;QACR,CAAC;MACH;IACF;EACF,CAAC,EAED;IACEkB,MAAM,EAAE,MAAM;IACdR,IAAI,EAAE,wBAAwB;IAC9BS,OAAO,EAAEP,WAAW,CAACT,SAAS,CAAC;IAC/BiB,OAAO,EAAE;MACP,GAAGH,gBAAgB;MACnBI,QAAQ,EAAE;QACRf,MAAM,EAAEX,GAAG,CAAC2B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBC,IAAI,EAAE/B,UAAU;UAChBiB,IAAI,EAAEV;QACR,CAAC,CAAC;QACF0B,OAAO,EAAE/B,GAAG,CAAC2B,MAAM,CAAC,CAAC,CAClBC,IAAI,CAAC;UACJI,KAAK,EAAE5B,WAAW;UAClB6B,MAAM,EAAE9B;QACV,CAAC,CAAC,CACD+B,QAAQ,CAAC;MACd;IACF;EACF,CAAC,EAED;IACEX,MAAM,EAAE,MAAM;IACdR,IAAI,EAAE,wCAAwC;IAC9CS,OAAO,EAAEP,WAAW,CAACT,SAAS,CAAC;IAC/BiB,OAAO,EAAE;MACP,GAAGH,gBAAgB;MACnBI,QAAQ,EAAE;QACRf,MAAM,EAAEX,GAAG,CAAC2B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBE,KAAK,EAAExB,WAAW;UAClBuB,IAAI,EAAE/B,UAAU;UAChBiB,IAAI,EAAEV;QACR,CAAC,CAAC;QACF0B,OAAO,EAAE/B,GAAG,CAAC2B,MAAM,CAAC,CAAC,CAClBC,IAAI,CAAC;UACJI,KAAK,EAAE5B,WAAW;UAClB6B,MAAM,EAAE9B;QACV,CAAC,CAAC,CACD+B,QAAQ,CAAC;MACd;IACF;EACF,CAAC,CACF;AACH","ignoreList":[]}

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

@@ -1,4 +1,4 @@
-import { type ComponentDef, type Event, type FormDefinition, type FormMetadata, type FormVersionMetadata, type Item, type List, type Page } from '@defra/forms-model';
+import { type ComponentDef, type Event, type FormVersionMetadata, type Item, type List, type Page, type UkAddressFieldComponent } from '@defra/forms-model';
 import { type PluginProperties, type Request, type ResponseObject } from '@hapi/hapi';
 import { type JoiExpression, type ValidationErrorItem } from 'joi';
 import { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js';
@@ -9,9 +9,10 @@ import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
 import { type DetailItemField } from '~/src/server/plugins/engine/models/types.js';
 import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js';
 import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js';
+import { type QuestionPageController } from '~/src/server/plugins/engine/pageControllers/index.js';
 import { type FileStatus, type FormAdapterSubmissionSchemaVersion, type UploadStatus } from '~/src/server/plugins/engine/types/enums.js';
 import { type ViewContext } from '~/src/server/plugins/nunjucks/types.js';
-import { type FormAction, type FormParams, type FormRequest, type FormRequestPayload, type FormResponseToolkit, type FormStatus } from '~/src/server/routes/types.js';
+import { type FormAction, type FormRequest, type FormRequestPayload, type FormResponseToolkit, type FormStatus } from '~/src/server/routes/types.js';
 import { type CacheService } from '~/src/server/services/cacheService.js';
 import { type RequestOptions } from '~/src/server/services/httpService.js';
 import { type Services } from '~/src/server/types.js';
@@ -261,8 +262,24 @@ export interface ErrorMessageTemplateList {
     advancedSettingsErrors: ErrorMessageTemplate[];
 }
 export type PreparePageEventRequestOptions = (options: RequestOptions, event: Event, page: PageControllerClass, context: FormContext) => void;
-export type OnRequestCallback = (request: AnyFormRequest, params: FormParams, definition: FormDefinition, metadata: FormMetadata) => void;
+export type OnRequestCallback = (request: AnyFormRequest, h: FormResponseToolkit, context: FormContext) => ResponseObject | FormResponseToolkit['continue'] | Promise<ResponseObject | FormResponseToolkit['continue']>;
 export type SaveAndExitHandler = (request: FormRequestPayload, h: FormResponseToolkit, context: FormContext) => ResponseObject;
+export interface ExternalArgs {
+    component: ComponentDef;
+    controller: QuestionPageController;
+    sourceUrl: string;
+    actionArgs: Record<string, string>;
+}
+export interface PostcodeLookupExternalArgs extends ExternalArgs {
+    component: UkAddressFieldComponent;
+    actionArgs: {
+        step: string;
+    };
+}
+export interface ExternalStateAppendage {
+    component: string;
+    data: FormStateValue | FormState;
+}
 export interface PluginOptions {
     model?: FormModel;
     services?: Services;
@@ -280,6 +297,7 @@ export interface PluginOptions {
     preparePageEventRequestOptions?: PreparePageEventRequestOptions;
     onRequest?: OnRequestCallback;
     baseUrl: string;
+    ordnanceSurveyApiKey?: string;
 }
 export interface FormAdapterSubmissionMessageMeta {
     schemaVersion: FormAdapterSubmissionSchemaVersion;

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 FormDefinition,\n  type FormMetadata,\n  type FormVersionMetadata,\n  type Item,\n  type List,\n  type Page\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 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 {\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 FormParams,\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  params: FormParams,\n  definition: FormDefinition,\n  metadata: FormMetadata\n) => void\n\nexport type SaveAndExitHandler = (\n  request: FormRequestPayload,\n  h: FormResponseToolkit,\n  context: FormContext\n) => ResponseObject\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}\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\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":"AAqDA;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;;AA+Nd;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 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\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":"AAoDA;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":[]}

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

@@ -0,0 +1,15 @@
+import { type ResponseObject } from '@hapi/hapi';
+import { type FormRequestPayload, type FormResponseToolkit } from '~/src/server/plugins/engine/types/index.js';
+import { type ExternalArgs } from '~/src/server/plugins/engine/types.js';
+export declare function isExternalComponent(component: unknown): component is ExternalComponent;
+export interface ExternalComponent {
+    dispatcher(request: FormRequestPayload, h: FormResponseToolkit, args: ExternalArgs): ResponseObject;
+}
+/**
+ * Returns internal and external components from a componentMap, regardless of error state.
+ * @returns An object containing internalComponents and externalComponents arrays
+ */
+export declare function getComponentsByType(): {
+    internalComponents: Map<string, unknown>;
+    externalComponents: Map<string, ExternalComponent>;
+};

package/.server/server/plugins/engine/validationHelpers.js

@@ -0,0 +1,29 @@
+import * as Components from "./components/index.js";
+// Type guard for ExternalComponent
+export function isExternalComponent(component) {
+  return typeof component.dispatcher === 'function';
+}
+
+// External components are guaranteed to have a dispatcher method
+
+/**
+ * Returns internal and external components from a componentMap, regardless of error state.
+ * @returns An object containing internalComponents and externalComponents arrays
+ */
+export function getComponentsByType() {
+  const internalComponents = new Map();
+  const externalComponents = new Map();
+  const componentMap = new Map(Object.entries(Components));
+  for (const [name, component] of componentMap.entries()) {
+    if (isExternalComponent(component)) {
+      externalComponents.set(name, component);
+    } else {
+      internalComponents.set(name, component);
+    }
+  }
+  return {
+    internalComponents,
+    externalComponents
+  };
+}
+//# sourceMappingURL=validationHelpers.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validationHelpers.js","names":["Components","isExternalComponent","component","dispatcher","getComponentsByType","internalComponents","Map","externalComponents","componentMap","Object","entries","name","set"],"sources":["../../../../src/server/plugins/engine/validationHelpers.ts"],"sourcesContent":["import { type ResponseObject } from '@hapi/hapi'\n\nimport * as Components from '~/src/server/plugins/engine/components/index.js'\nimport {\n  type FormRequestPayload,\n  type FormResponseToolkit\n} from '~/src/server/plugins/engine/types/index.js'\nimport { type ExternalArgs } from '~/src/server/plugins/engine/types.js'\n\n// Type guard for ExternalComponent\nexport function isExternalComponent(\n  component: unknown\n): component is ExternalComponent {\n  return typeof (component as ExternalComponent).dispatcher === 'function'\n}\n\n// External components are guaranteed to have a dispatcher method\nexport interface ExternalComponent {\n  dispatcher(\n    request: FormRequestPayload,\n    h: FormResponseToolkit,\n    args: ExternalArgs\n  ): ResponseObject\n}\n\n/**\n * Returns internal and external components from a componentMap, regardless of error state.\n * @returns An object containing internalComponents and externalComponents arrays\n */\nexport function getComponentsByType(): {\n  internalComponents: Map<string, unknown>\n  externalComponents: Map<string, ExternalComponent>\n} {\n  const internalComponents = new Map<string, unknown>()\n  const externalComponents = new Map<string, ExternalComponent>()\n\n  const componentMap = new Map<string, unknown>(Object.entries(Components))\n\n  for (const [name, component] of componentMap.entries()) {\n    if (isExternalComponent(component)) {\n      externalComponents.set(name, component)\n    } else {\n      internalComponents.set(name, component)\n    }\n  }\n\n  return { internalComponents, externalComponents }\n}\n"],"mappings":"AAEA,OAAO,KAAKA,UAAU;AAOtB;AACA,OAAO,SAASC,mBAAmBA,CACjCC,SAAkB,EACc;EAChC,OAAO,OAAQA,SAAS,CAAuBC,UAAU,KAAK,UAAU;AAC1E;;AAEA;;AASA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAAA,EAGjC;EACA,MAAMC,kBAAkB,GAAG,IAAIC,GAAG,CAAkB,CAAC;EACrD,MAAMC,kBAAkB,GAAG,IAAID,GAAG,CAA4B,CAAC;EAE/D,MAAME,YAAY,GAAG,IAAIF,GAAG,CAAkBG,MAAM,CAACC,OAAO,CAACV,UAAU,CAAC,CAAC;EAEzE,KAAK,MAAM,CAACW,IAAI,EAAET,SAAS,CAAC,IAAIM,YAAY,CAACE,OAAO,CAAC,CAAC,EAAE;IACtD,IAAIT,mBAAmB,CAACC,SAAS,CAAC,EAAE;MAClCK,kBAAkB,CAACK,GAAG,CAACD,IAAI,EAAET,SAAS,CAAC;IACzC,CAAC,MAAM;MACLG,kBAAkB,CAACO,GAAG,CAACD,IAAI,EAAET,SAAS,CAAC;IACzC;EACF;EAEA,OAAO;IAAEG,kBAAkB;IAAEE;EAAmB,CAAC;AACnD","ignoreList":[]}

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

@@ -1,10 +1,18 @@
 {% from "partials/components.html" import componentList %}
 {% from "govuk/components/fieldset/macro.njk" import govukFieldset %}
 {% from "govuk/components/hint/macro.njk" import govukHint %}
+{% from "govuk/components/button/macro.njk" import govukButton %}
+{% from "govuk/components/inset-text/macro.njk" import govukInsetText %}
 
 {% macro UkAddressField(component) %}
   {% set fieldset = component.model.fieldset %}
-  {% set addressFieldHtml = componentList(component.model.components) %}
+  {% set usePostcodeLookup = component.model.usePostcodeLookup %}
+
+  {% set addressFieldHtml %}
+    <div {{"hidden" if usePostcodeLookup }}>
+      {{ componentList(component.model.components) }}
+    </div>
+  {% endset %}
 
   {% if component.model.hint %}
     {% set addressHintHtml %}
@@ -17,9 +25,45 @@
     {% set addressFieldHtml = addressHintHtml + addressFieldHtml %}
   {% endif %}
 
-  {{ govukFieldset({
-    legend: fieldset.legend,
-    attributes: fieldset.attributes,
-    html: addressFieldHtml
-  }) if fieldset else addressFieldHtml }}
+  <div id="{{component.model.name}}" class="govuk-form-group{{ ' govuk-form-group--error' if usePostcodeLookup and component.model.errors | length }}">
+    {{ govukFieldset({
+      legend: fieldset.legend,
+      attributes: fieldset.attributes,
+      html: addressFieldHtml
+    }) if fieldset else addressFieldHtml }}
+
+    {% if usePostcodeLookup %}
+      {% set value = component.model.value %}
+
+        {% if value %}
+          {% set insetHtml %}
+            <strong>Selected address:</strong>
+            <br><br>
+            {{ value }}
+            <br><br>
+            <p class="govuk-body">
+              <button class="govuk-link govuk-button--link govuk-!-margin-right-1" name="action"
+                value="external-{{component.model.name}}">Use a different address</button>
+            </p>
+          {% endset %}
+
+          {{ govukInsetText({
+            html: insetHtml,
+            classes: "govuk-!-margin-top-2"
+          }) }}
+        {% else %}
+          <div class="govuk-button-group govuk-!-margin-bottom-0">
+            {{ govukButton({
+              text: "Find an address",
+              attributes: {
+                name: "action",
+                value: "external-" + component.model.name
+              },
+              classes: "govuk-button--secondary govuk-!-margin-right-1 govuk-!-margin-bottom-0"
+            }) }}
+            <p class="govuk-body govuk-!-margin-bottom-0">or <button class="govuk-link govuk-button--link govuk-!-margin-right-1 govuk-!-margin-bottom-0" name="action" value="external-{{component.model.name}}--step:manual">enter address manually</button></p>
+          </div>
+        {% endif %}
+    {% endif %}
+  </div>
 {% endmacro %}

package/.server/server/plugins/engine/vision.js

@@ -5,11 +5,13 @@ import vision from '@hapi/vision';
 import nunjucks from 'nunjucks';
 import resolvePkg from 'resolve';
 import { VIEW_PATH, context, prepareNunjucksEnvironment } from "./index.js";
+import { VIEW_PATH as POSTCODE_LOOKUP_VIEW_PATH } from "../postcode-lookup/index.js";
 export async function registerVision(server, pluginOptions) {
   const packageRoot = findPackageRoot();
   const govukFrontendPath = dirname(resolvePkg.sync('govuk-frontend/package.json'));
   const viewPathResolved = join(packageRoot, VIEW_PATH);
-  const paths = [...pluginOptions.nunjucks.paths, viewPathResolved, join(govukFrontendPath, 'dist')];
+  const postcodeLookupPathResolved = join(packageRoot, POSTCODE_LOOKUP_VIEW_PATH);
+  const paths = [...pluginOptions.nunjucks.paths, viewPathResolved, postcodeLookupPathResolved, join(govukFrontendPath, 'dist')];
   await server.register({
     plugin: vision,
     options: {

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

@@ -1 +1 @@
-{"version":3,"file":"vision.js","names":["existsSync","dirname","join","fileURLToPath","vision","nunjucks","resolvePkg","VIEW_PATH","context","prepareNunjucksEnvironment","registerVision","server","pluginOptions","packageRoot","findPackageRoot","govukFrontendPath","sync","viewPathResolved","paths","register","plugin","options","engines","html","compile","path","compileOptions","template","environment","render","prepare","next","configure","currentFileName","import","meta","url","currentDirectoryName","dir","Error"],"sources":["../../../../src/server/plugins/engine/vision.ts"],"sourcesContent":["import { existsSync } from 'fs'\nimport { dirname, join } from 'path'\nimport { fileURLToPath } from 'url'\n\nimport { type Server } from '@hapi/hapi'\nimport vision from '@hapi/vision'\nimport nunjucks, { type Environment } from 'nunjucks'\nimport resolvePkg from 'resolve'\n\nimport {\n  VIEW_PATH,\n  context,\n  prepareNunjucksEnvironment\n} from '~/src/server/plugins/engine/index.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\n\nexport async function registerVision(\n  server: Server,\n  pluginOptions: PluginOptions\n) {\n  const packageRoot = findPackageRoot()\n  const govukFrontendPath = dirname(\n    resolvePkg.sync('govuk-frontend/package.json')\n  )\n\n  const viewPathResolved = join(packageRoot, VIEW_PATH)\n\n  const paths = [\n    ...pluginOptions.nunjucks.paths,\n    viewPathResolved,\n    join(govukFrontendPath, 'dist')\n  ]\n\n  await server.register({\n    plugin: vision,\n    options: {\n      engines: {\n        html: {\n          compile: (\n            path: string,\n            compileOptions: { environment: Environment }\n          ) => {\n            const template = nunjucks.compile(path, compileOptions.environment)\n\n            return (context: object | undefined) => {\n              return template.render(context)\n            }\n          },\n          prepare: (\n            options: EngineConfigurationObject,\n            next: (err?: Error) => void\n          ) => {\n            // Nunjucks also needs an additional path configuration\n            // to use the templates and macros from `govuk-frontend`\n            const environment = nunjucks.configure(paths)\n\n            // Applies custom filters and globals for nunjucks\n            // that are required by the `forms-engine-plugin`\n            prepareNunjucksEnvironment(environment, pluginOptions)\n\n            options.compileOptions.environment = environment\n\n            next()\n          }\n        }\n      },\n      path: paths,\n      // Provides global context used with all templates\n      context\n    }\n  })\n}\n\ninterface CompileOptions {\n  environment: Environment\n}\n\nexport interface EngineConfigurationObject {\n  compileOptions: CompileOptions\n}\n\nexport function findPackageRoot() {\n  const currentFileName = fileURLToPath(import.meta.url)\n  const currentDirectoryName = dirname(currentFileName)\n\n  let dir = currentDirectoryName\n  while (dir !== '/') {\n    if (existsSync(join(dir, 'package.json'))) {\n      return dir\n    }\n    dir = dirname(dir)\n  }\n\n  throw new Error('package.json not found in parent directories')\n}\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,IAAI;AAC/B,SAASC,OAAO,EAAEC,IAAI,QAAQ,MAAM;AACpC,SAASC,aAAa,QAAQ,KAAK;AAGnC,OAAOC,MAAM,MAAM,cAAc;AACjC,OAAOC,QAAQ,MAA4B,UAAU;AACrD,OAAOC,UAAU,MAAM,SAAS;AAEhC,SACEC,SAAS,EACTC,OAAO,EACPC,0BAA0B;AAI5B,OAAO,eAAeC,cAAcA,CAClCC,MAAc,EACdC,aAA4B,EAC5B;EACA,MAAMC,WAAW,GAAGC,eAAe,CAAC,CAAC;EACrC,MAAMC,iBAAiB,GAAGd,OAAO,CAC/BK,UAAU,CAACU,IAAI,CAAC,6BAA6B,CAC/C,CAAC;EAED,MAAMC,gBAAgB,GAAGf,IAAI,CAACW,WAAW,EAAEN,SAAS,CAAC;EAErD,MAAMW,KAAK,GAAG,CACZ,GAAGN,aAAa,CAACP,QAAQ,CAACa,KAAK,EAC/BD,gBAAgB,EAChBf,IAAI,CAACa,iBAAiB,EAAE,MAAM,CAAC,CAChC;EAED,MAAMJ,MAAM,CAACQ,QAAQ,CAAC;IACpBC,MAAM,EAAEhB,MAAM;IACdiB,OAAO,EAAE;MACPC,OAAO,EAAE;QACPC,IAAI,EAAE;UACJC,OAAO,EAAEA,CACPC,IAAY,EACZC,cAA4C,KACzC;YACH,MAAMC,QAAQ,GAAGtB,QAAQ,CAACmB,OAAO,CAACC,IAAI,EAAEC,cAAc,CAACE,WAAW,CAAC;YAEnE,OAAQpB,OAA2B,IAAK;cACtC,OAAOmB,QAAQ,CAACE,MAAM,CAACrB,OAAO,CAAC;YACjC,CAAC;UACH,CAAC;UACDsB,OAAO,EAAEA,CACPT,OAAkC,EAClCU,IAA2B,KACxB;YACH;YACA;YACA,MAAMH,WAAW,GAAGvB,QAAQ,CAAC2B,SAAS,CAACd,KAAK,CAAC;;YAE7C;YACA;YACAT,0BAA0B,CAACmB,WAAW,EAAEhB,aAAa,CAAC;YAEtDS,OAAO,CAACK,cAAc,CAACE,WAAW,GAAGA,WAAW;YAEhDG,IAAI,CAAC,CAAC;UACR;QACF;MACF,CAAC;MACDN,IAAI,EAAEP,KAAK;MACX;MACAV;IACF;EACF,CAAC,CAAC;AACJ;AAUA,OAAO,SAASM,eAAeA,CAAA,EAAG;EAChC,MAAMmB,eAAe,GAAG9B,aAAa,CAAC+B,MAAM,CAACC,IAAI,CAACC,GAAG,CAAC;EACtD,MAAMC,oBAAoB,GAAGpC,OAAO,CAACgC,eAAe,CAAC;EAErD,IAAIK,GAAG,GAAGD,oBAAoB;EAC9B,OAAOC,GAAG,KAAK,GAAG,EAAE;IAClB,IAAItC,UAAU,CAACE,IAAI,CAACoC,GAAG,EAAE,cAAc,CAAC,CAAC,EAAE;MACzC,OAAOA,GAAG;IACZ;IACAA,GAAG,GAAGrC,OAAO,CAACqC,GAAG,CAAC;EACpB;EAEA,MAAM,IAAIC,KAAK,CAAC,8CAA8C,CAAC;AACjE","ignoreList":[]}
+{"version":3,"file":"vision.js","names":["existsSync","dirname","join","fileURLToPath","vision","nunjucks","resolvePkg","VIEW_PATH","context","prepareNunjucksEnvironment","POSTCODE_LOOKUP_VIEW_PATH","registerVision","server","pluginOptions","packageRoot","findPackageRoot","govukFrontendPath","sync","viewPathResolved","postcodeLookupPathResolved","paths","register","plugin","options","engines","html","compile","path","compileOptions","template","environment","render","prepare","next","configure","currentFileName","import","meta","url","currentDirectoryName","dir","Error"],"sources":["../../../../src/server/plugins/engine/vision.ts"],"sourcesContent":["import { existsSync } from 'fs'\nimport { dirname, join } from 'path'\nimport { fileURLToPath } from 'url'\n\nimport { type Server } from '@hapi/hapi'\nimport vision from '@hapi/vision'\nimport nunjucks, { type Environment } from 'nunjucks'\nimport resolvePkg from 'resolve'\n\nimport {\n  VIEW_PATH,\n  context,\n  prepareNunjucksEnvironment\n} from '~/src/server/plugins/engine/index.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\nimport { VIEW_PATH as POSTCODE_LOOKUP_VIEW_PATH } from '~/src/server/plugins/postcode-lookup/index.js'\n\nexport async function registerVision(\n  server: Server,\n  pluginOptions: PluginOptions\n) {\n  const packageRoot = findPackageRoot()\n  const govukFrontendPath = dirname(\n    resolvePkg.sync('govuk-frontend/package.json')\n  )\n\n  const viewPathResolved = join(packageRoot, VIEW_PATH)\n  const postcodeLookupPathResolved = join(\n    packageRoot,\n    POSTCODE_LOOKUP_VIEW_PATH\n  )\n\n  const paths = [\n    ...pluginOptions.nunjucks.paths,\n    viewPathResolved,\n    postcodeLookupPathResolved,\n    join(govukFrontendPath, 'dist')\n  ]\n\n  await server.register({\n    plugin: vision,\n    options: {\n      engines: {\n        html: {\n          compile: (\n            path: string,\n            compileOptions: { environment: Environment }\n          ) => {\n            const template = nunjucks.compile(path, compileOptions.environment)\n\n            return (context: object | undefined) => {\n              return template.render(context)\n            }\n          },\n          prepare: (\n            options: EngineConfigurationObject,\n            next: (err?: Error) => void\n          ) => {\n            // Nunjucks also needs an additional path configuration\n            // to use the templates and macros from `govuk-frontend`\n            const environment = nunjucks.configure(paths)\n\n            // Applies custom filters and globals for nunjucks\n            // that are required by the `forms-engine-plugin`\n            prepareNunjucksEnvironment(environment, pluginOptions)\n\n            options.compileOptions.environment = environment\n\n            next()\n          }\n        }\n      },\n      path: paths,\n      // Provides global context used with all templates\n      context\n    }\n  })\n}\n\ninterface CompileOptions {\n  environment: Environment\n}\n\nexport interface EngineConfigurationObject {\n  compileOptions: CompileOptions\n}\n\nexport function findPackageRoot() {\n  const currentFileName = fileURLToPath(import.meta.url)\n  const currentDirectoryName = dirname(currentFileName)\n\n  let dir = currentDirectoryName\n  while (dir !== '/') {\n    if (existsSync(join(dir, 'package.json'))) {\n      return dir\n    }\n    dir = dirname(dir)\n  }\n\n  throw new Error('package.json not found in parent directories')\n}\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,IAAI;AAC/B,SAASC,OAAO,EAAEC,IAAI,QAAQ,MAAM;AACpC,SAASC,aAAa,QAAQ,KAAK;AAGnC,OAAOC,MAAM,MAAM,cAAc;AACjC,OAAOC,QAAQ,MAA4B,UAAU;AACrD,OAAOC,UAAU,MAAM,SAAS;AAEhC,SACEC,SAAS,EACTC,OAAO,EACPC,0BAA0B;AAG5B,SAASF,SAAS,IAAIG,yBAAyB;AAE/C,OAAO,eAAeC,cAAcA,CAClCC,MAAc,EACdC,aAA4B,EAC5B;EACA,MAAMC,WAAW,GAAGC,eAAe,CAAC,CAAC;EACrC,MAAMC,iBAAiB,GAAGf,OAAO,CAC/BK,UAAU,CAACW,IAAI,CAAC,6BAA6B,CAC/C,CAAC;EAED,MAAMC,gBAAgB,GAAGhB,IAAI,CAACY,WAAW,EAAEP,SAAS,CAAC;EACrD,MAAMY,0BAA0B,GAAGjB,IAAI,CACrCY,WAAW,EACXJ,yBACF,CAAC;EAED,MAAMU,KAAK,GAAG,CACZ,GAAGP,aAAa,CAACR,QAAQ,CAACe,KAAK,EAC/BF,gBAAgB,EAChBC,0BAA0B,EAC1BjB,IAAI,CAACc,iBAAiB,EAAE,MAAM,CAAC,CAChC;EAED,MAAMJ,MAAM,CAACS,QAAQ,CAAC;IACpBC,MAAM,EAAElB,MAAM;IACdmB,OAAO,EAAE;MACPC,OAAO,EAAE;QACPC,IAAI,EAAE;UACJC,OAAO,EAAEA,CACPC,IAAY,EACZC,cAA4C,KACzC;YACH,MAAMC,QAAQ,GAAGxB,QAAQ,CAACqB,OAAO,CAACC,IAAI,EAAEC,cAAc,CAACE,WAAW,CAAC;YAEnE,OAAQtB,OAA2B,IAAK;cACtC,OAAOqB,QAAQ,CAACE,MAAM,CAACvB,OAAO,CAAC;YACjC,CAAC;UACH,CAAC;UACDwB,OAAO,EAAEA,CACPT,OAAkC,EAClCU,IAA2B,KACxB;YACH;YACA;YACA,MAAMH,WAAW,GAAGzB,QAAQ,CAAC6B,SAAS,CAACd,KAAK,CAAC;;YAE7C;YACA;YACAX,0BAA0B,CAACqB,WAAW,EAAEjB,aAAa,CAAC;YAEtDU,OAAO,CAACK,cAAc,CAACE,WAAW,GAAGA,WAAW;YAEhDG,IAAI,CAAC,CAAC;UACR;QACF;MACF,CAAC;MACDN,IAAI,EAAEP,KAAK;MACX;MACAZ;IACF;EACF,CAAC,CAAC;AACJ;AAUA,OAAO,SAASO,eAAeA,CAAA,EAAG;EAChC,MAAMoB,eAAe,GAAGhC,aAAa,CAACiC,MAAM,CAACC,IAAI,CAACC,GAAG,CAAC;EACtD,MAAMC,oBAAoB,GAAGtC,OAAO,CAACkC,eAAe,CAAC;EAErD,IAAIK,GAAG,GAAGD,oBAAoB;EAC9B,OAAOC,GAAG,KAAK,GAAG,EAAE;IAClB,IAAIxC,UAAU,CAACE,IAAI,CAACsC,GAAG,EAAE,cAAc,CAAC,CAAC,EAAE;MACzC,OAAOA,GAAG;IACZ;IACAA,GAAG,GAAGvC,OAAO,CAACuC,GAAG,CAAC;EACpB;EAEA,MAAM,IAAIC,KAAK,CAAC,8CAA8C,CAAC;AACjE","ignoreList":[]}

package/.server/server/plugins/postcode-lookup/index.d.ts

@@ -0,0 +1,8 @@
+export const VIEW_PATH: "src/server/plugins/postcode-lookup/views";
+export namespace postcodeLookupPlugin {
+    let name: string;
+    let dependencies: string[];
+    let multiple: false;
+    function register(server: import("@hapi/hapi").Server<import("@hapi/hapi").ServerApplicationState>, options: PostcodeLookupConfiguration): void;
+}
+import type { PostcodeLookupConfiguration } from '~/src/server/plugins/postcode-lookup/types.js';

package/.server/server/plugins/postcode-lookup/index.js

@@ -0,0 +1,21 @@
+import { getRoutes } from "./routes/index.js";
+export const VIEW_PATH = 'src/server/plugins/postcode-lookup/views';
+
+/**
+ * @satisfies {NamedPlugin<PostcodeLookupConfiguration>}
+ */
+export const postcodeLookupPlugin = {
+  name: '@defra/forms-engine-plugin/postcode-lookup',
+  dependencies: ['@hapi/vision'],
+  multiple: false,
+  register(server, options) {
+    // @ts-expect-error - Request typing
+    server.route(getRoutes(options));
+  }
+};
+
+/**
+ * @import { NamedPlugin } from '@hapi/hapi'
+ * @import { PostcodeLookupConfiguration } from '~/src/server/plugins/postcode-lookup/types.js'
+ */
+//# sourceMappingURL=index.js.map

package/.server/server/plugins/postcode-lookup/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["getRoutes","VIEW_PATH","postcodeLookupPlugin","name","dependencies","multiple","register","server","options","route"],"sources":["../../../../src/server/plugins/postcode-lookup/index.js"],"sourcesContent":["import { getRoutes } from '~/src/server/plugins/postcode-lookup/routes/index.js'\n\nexport const VIEW_PATH = 'src/server/plugins/postcode-lookup/views'\n\n/**\n * @satisfies {NamedPlugin<PostcodeLookupConfiguration>}\n */\nexport const postcodeLookupPlugin = {\n  name: '@defra/forms-engine-plugin/postcode-lookup',\n  dependencies: ['@hapi/vision'],\n  multiple: false,\n  register(server, options) {\n    // @ts-expect-error - Request typing\n    server.route(getRoutes(options))\n  }\n}\n\n/**\n * @import { NamedPlugin } from '@hapi/hapi'\n * @import { PostcodeLookupConfiguration } from '~/src/server/plugins/postcode-lookup/types.js'\n */\n"],"mappings":"AAAA,SAASA,SAAS;AAElB,OAAO,MAAMC,SAAS,GAAG,0CAA0C;;AAEnE;AACA;AACA;AACA,OAAO,MAAMC,oBAAoB,GAAG;EAClCC,IAAI,EAAE,4CAA4C;EAClDC,YAAY,EAAE,CAAC,cAAc,CAAC;EAC9BC,QAAQ,EAAE,KAAK;EACfC,QAAQA,CAACC,MAAM,EAAEC,OAAO,EAAE;IACxB;IACAD,MAAM,CAACE,KAAK,CAACT,SAAS,CAACQ,OAAO,CAAC,CAAC;EAClC;AACF,CAAC;;AAED;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/postcode-lookup/models/index.d.ts

@@ -0,0 +1,255 @@
+/**
+ * The postcode lookup details form view model
+ * @param {PostcodeLookupSessionData} data
+ * @param {PostcodeLookupDetailsData} [payload]
+ * @param {Error} [err]
+ */
+export function detailsViewModel(data: PostcodeLookupSessionData, payload?: PostcodeLookupDetailsData, err?: Error): {
+    step: string;
+    showTitle: boolean;
+    name: string;
+    serviceUrl: string;
+    pageTitle: string;
+    backLink: {
+        href: string;
+    };
+    errors: {
+        text: string;
+        href: string;
+    }[] | undefined;
+    fields: {
+        postcodeQuery: {
+            id: string;
+            name: string;
+            label: {
+                text: string;
+            };
+            hint: {
+                text: string;
+            };
+            value: string | undefined;
+            errorMessage: {
+                text: string;
+            } | undefined;
+        };
+        buildingNameQuery: {
+            id: string;
+            name: string;
+            label: {
+                text: string;
+            };
+            hint: {
+                text: string;
+            };
+            value: string | undefined;
+            errorMessage: {
+                text: string;
+            } | undefined;
+        };
+    };
+    buttons: {
+        continueButton: {
+            text: string;
+            classes: string;
+        };
+        manualLink: {
+            text: string;
+            href: string;
+        };
+    };
+};
+/**
+ * The postcode lookup select form view model
+ * @param {{ session: PostcodeLookupSessionData, apiKey: string }} data
+ * @param {PostcodeLookupSelectPayload} [payload]
+ * @param {Error} [err]
+ */
+export function selectViewModel(data: {
+    session: PostcodeLookupSessionData;
+    apiKey: string;
+}, payload?: PostcodeLookupSelectPayload, err?: Error): Promise<{
+    step: string;
+    showTitle: boolean;
+    name: string;
+    serviceUrl: string;
+    pageTitle: string;
+    backLink: {
+        href: string;
+    };
+    errors: {
+        text: string;
+        href: string;
+    }[] | undefined;
+    searchAgainLink: {
+        text: string;
+        href: string;
+    };
+    fields: {
+        postcodeQuery: {
+            id: string;
+            name: string;
+            type: string;
+            value: string;
+        };
+        buildingNameQuery: {
+            id: string;
+            name: string;
+            type: string;
+            value: string;
+        };
+        uprn: {
+            id: string;
+            name: string;
+            label: {
+                text: string;
+            } | undefined;
+            value: string | undefined;
+            errorMessage: {
+                text: string;
+            } | undefined;
+            items: {
+                text: string;
+                value: string;
+            }[] | undefined;
+            type: string | undefined;
+        };
+    };
+    details: PostcodeLookupDetailsData;
+    addressCount: number;
+    singleAddress: Address | undefined;
+    hasAddresses: boolean;
+    hasMultipleAddresses: boolean;
+    buttons: {
+        continueButton: {
+            href: string | undefined;
+            text: string;
+            classes: string;
+        };
+        manualLink: {
+            text: string;
+            href: string;
+        };
+    };
+}>;
+/**
+ * The postcode lookup manual form view model
+ * @param {PostcodeLookupSessionData} data
+ * @param {PostcodeLookupManualPayload} [payload]
+ * @param {Error} [err]
+ */
+export function manualViewModel(data: PostcodeLookupSessionData, payload?: PostcodeLookupManualPayload, err?: Error): {
+    step: string;
+    showTitle: boolean;
+    name: string;
+    serviceUrl: string;
+    pageTitle: string;
+    backLink: {
+        href: string;
+    };
+    errors: {
+        text: string;
+        href: string;
+    }[] | undefined;
+    hint: "" | {
+        text: string;
+    } | undefined;
+    fields: {
+        addressLine1: {
+            id: string;
+            name: string;
+            label: {
+                text: string;
+            };
+            value: string | undefined;
+            errorMessage: {
+                text: string;
+            } | undefined;
+        };
+        addressLine2: {
+            id: string;
+            name: string;
+            label: {
+                text: string;
+            };
+            value: string | undefined;
+            errorMessage: {
+                text: string;
+            } | undefined;
+        };
+        town: {
+            id: string;
+            name: string;
+            label: {
+                text: string;
+            };
+            classes: string;
+            value: string | undefined;
+            errorMessage: {
+                text: string;
+            } | undefined;
+        };
+        county: {
+            id: string;
+            name: string;
+            label: {
+                text: string;
+            };
+            value: string | undefined;
+            errorMessage: {
+                text: string;
+            } | undefined;
+        };
+        postcode: {
+            id: string;
+            name: string;
+            label: {
+                text: string;
+            };
+            classes: string;
+            value: string | undefined;
+            errorMessage: {
+                text: string;
+            } | undefined;
+        };
+    };
+    buttons: {
+        continueButton: {
+            text: string;
+            classes: string;
+        };
+        detailsLink: {
+            text: string;
+            href: string;
+        };
+    };
+};
+export namespace steps {
+    let details: string;
+    let select: string;
+    let manual: string;
+}
+export const JOURNEY_BASE_URL: "/postcode-lookup";
+export const stepSchema: Joi.StringSchema<string>;
+/**
+ * Postcode lookup details form payload schema
+ * @type {ObjectSchema<PostcodeLookupDetailsPayload>}
+ */
+export const detailsPayloadSchema: Joi.ObjectSchema<PostcodeLookupDetailsPayload>;
+/**
+ * Postcode lookup select form payload schema
+ * @type {ObjectSchema<PostcodeLookupSelectPayload>}
+ */
+export const selectPayloadSchema: Joi.ObjectSchema<PostcodeLookupSelectPayload>;
+/**
+ * Postcode lookup manual form payload schema
+ * @type {ObjectSchema<PostcodeLookupManualPayload>}
+ */
+export const manualPayloadSchema: Joi.ObjectSchema<PostcodeLookupManualPayload>;
+export type OptionalValidationErrorItem = Joi.ValidationErrorItem | undefined;
+import type { PostcodeLookupSessionData } from '~/src/server/plugins/postcode-lookup/types.js';
+import type { PostcodeLookupDetailsData } from '~/src/server/plugins/postcode-lookup/types.js';
+import type { PostcodeLookupSelectPayload } from '~/src/server/plugins/postcode-lookup/types.js';
+import type { Address } from '~/src/server/plugins/postcode-lookup/types.js';
+import type { PostcodeLookupManualPayload } from '~/src/server/plugins/postcode-lookup/types.js';
+import Joi from 'joi';
+import type { PostcodeLookupDetailsPayload } from '~/src/server/plugins/postcode-lookup/types.js';