@defra/forms-engine-plugin 1.0.1 → 1.0.3

package/.server/server/plugins/engine/routes/repeaters/item-delete.js

@@ -0,0 +1,106 @@
+import { slugSchema } from '@defra/forms-model';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+import { FileUploadPageController } from "../../pageControllers/FileUploadPageController.js";
+import { RepeatPageController } from "../../pageControllers/RepeatPageController.js";
+import { redirectOrMakeHandler } from "../index.js";
+import { actionSchema, confirmSchema, crumbSchema, itemIdSchema, pathSchema, stateSchema } from "../../../../schemas/index.js";
+
+// Item delete GET route
+function getHandler(request, h) {
+  const {
+    params
+  } = request;
+  return redirectOrMakeHandler(request, h, (page, context) => {
+    if (!(page instanceof RepeatPageController || page instanceof FileUploadPageController)) {
+      throw Boom.notFound(`No page found for /${params.path}`);
+    }
+    return page.makeGetItemDeleteRouteHandler()(request, context, h);
+  });
+}
+function postHandler(request, h) {
+  const {
+    params
+  } = request;
+  return redirectOrMakeHandler(request, h, (page, context) => {
+    const {
+      isForceAccess
+    } = context;
+    if (isForceAccess || !(page instanceof RepeatPageController || page instanceof FileUploadPageController)) {
+      throw Boom.notFound(`No page found for /${params.path}`);
+    }
+    return page.makePostItemDeleteRouteHandler()(request, context, h);
+  });
+}
+export function getRoutes(getRouteOptions, postRouteOptions) {
+  return [{
+    method: 'get',
+    path: '/{slug}/{path}/{itemId}/confirm-delete',
+    handler: getHandler,
+    options: {
+      ...getRouteOptions,
+      validate: {
+        params: Joi.object().keys({
+          slug: slugSchema,
+          path: pathSchema,
+          itemId: itemIdSchema
+        })
+      }
+    }
+  }, {
+    method: 'get',
+    path: '/preview/{state}/{slug}/{path}/{itemId}/confirm-delete',
+    handler: getHandler,
+    options: {
+      ...getRouteOptions,
+      validate: {
+        params: Joi.object().keys({
+          state: stateSchema,
+          slug: slugSchema,
+          path: pathSchema,
+          itemId: itemIdSchema
+        })
+      }
+    }
+  }, {
+    method: 'post',
+    path: '/{slug}/{path}/{itemId}/confirm-delete',
+    handler: postHandler,
+    options: {
+      ...postRouteOptions,
+      validate: {
+        params: Joi.object().keys({
+          slug: slugSchema,
+          path: pathSchema,
+          itemId: itemIdSchema
+        }),
+        payload: Joi.object().keys({
+          crumb: crumbSchema,
+          action: actionSchema,
+          confirm: confirmSchema
+        }).required()
+      }
+    }
+  }, {
+    method: 'post',
+    path: '/preview/{state}/{slug}/{path}/{itemId}/confirm-delete',
+    handler: postHandler,
+    options: {
+      ...postRouteOptions,
+      validate: {
+        params: Joi.object().keys({
+          state: stateSchema,
+          slug: slugSchema,
+          path: pathSchema,
+          itemId: itemIdSchema
+        }),
+        payload: Joi.object().keys({
+          crumb: crumbSchema,
+          action: actionSchema,
+          confirm: confirmSchema
+        }).required()
+      }
+    }
+  }];
+}
+//# sourceMappingURL=item-delete.js.map

package/.server/server/plugins/engine/routes/repeaters/item-delete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"item-delete.js","names":["slugSchema","Boom","Joi","FileUploadPageController","RepeatPageController","redirectOrMakeHandler","actionSchema","confirmSchema","crumbSchema","itemIdSchema","pathSchema","stateSchema","getHandler","request","h","params","page","context","notFound","path","makeGetItemDeleteRouteHandler","postHandler","isForceAccess","makePostItemDeleteRouteHandler","getRoutes","getRouteOptions","postRouteOptions","method","handler","options","validate","object","keys","slug","itemId","state","payload","crumb","action","confirm","required"],"sources":["../../../../../../src/server/plugins/engine/routes/repeaters/item-delete.ts"],"sourcesContent":["import { slugSchema } from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport {\n  type ResponseToolkit,\n  type RouteOptions,\n  type ServerRoute\n} from '@hapi/hapi'\nimport Joi from 'joi'\n\nimport { FileUploadPageController } from '~/src/server/plugins/engine/pageControllers/FileUploadPageController.js'\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} from '~/src/server/routes/types.js'\nimport {\n  actionSchema,\n  confirmSchema,\n  crumbSchema,\n  itemIdSchema,\n  pathSchema,\n  stateSchema\n} from '~/src/server/schemas/index.js'\n\n// Item delete GET route\nfunction getHandler(\n  request: FormRequest,\n  h: Pick<ResponseToolkit, 'redirect' | 'view'>\n) {\n  const { params } = request\n\n  return redirectOrMakeHandler(request, h, (page, context) => {\n    if (\n      !(\n        page instanceof RepeatPageController ||\n        page instanceof FileUploadPageController\n      )\n    ) {\n      throw Boom.notFound(`No page found for /${params.path}`)\n    }\n\n    return page.makeGetItemDeleteRouteHandler()(request, context, h)\n  })\n}\n\nfunction postHandler(\n  request: FormRequestPayload,\n  h: Pick<ResponseToolkit, 'redirect' | 'view'>\n) {\n  const { params } = request\n\n  return redirectOrMakeHandler(request, h, (page, context) => {\n    const { isForceAccess } = context\n\n    if (\n      isForceAccess ||\n      !(\n        page instanceof RepeatPageController ||\n        page instanceof FileUploadPageController\n      )\n    ) {\n      throw Boom.notFound(`No page found for /${params.path}`)\n    }\n\n    return page.makePostItemDeleteRouteHandler()(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}/{itemId}/confirm-delete',\n      handler: getHandler,\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            slug: slugSchema,\n            path: pathSchema,\n            itemId: itemIdSchema\n          })\n        }\n      }\n    },\n\n    {\n      method: 'get',\n      path: '/preview/{state}/{slug}/{path}/{itemId}/confirm-delete',\n      handler: getHandler,\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            state: stateSchema,\n            slug: slugSchema,\n            path: pathSchema,\n            itemId: itemIdSchema\n          })\n        }\n      }\n    },\n\n    {\n      method: 'post',\n      path: '/{slug}/{path}/{itemId}/confirm-delete',\n      handler: postHandler,\n      options: {\n        ...postRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            slug: slugSchema,\n            path: pathSchema,\n            itemId: itemIdSchema\n          }),\n          payload: Joi.object()\n            .keys({\n              crumb: crumbSchema,\n              action: actionSchema,\n              confirm: confirmSchema\n            })\n            .required()\n        }\n      }\n    },\n\n    {\n      method: 'post',\n      path: '/preview/{state}/{slug}/{path}/{itemId}/confirm-delete',\n      handler: postHandler,\n      options: {\n        ...postRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            state: stateSchema,\n            slug: slugSchema,\n            path: pathSchema,\n            itemId: itemIdSchema\n          }),\n          payload: Joi.object()\n            .keys({\n              crumb: crumbSchema,\n              action: actionSchema,\n              confirm: confirmSchema\n            })\n            .required()\n        }\n      }\n    }\n  ]\n}\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,oBAAoB;AAC/C,OAAOC,IAAI,MAAM,YAAY;AAM7B,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,wBAAwB;AACjC,SAASC,oBAAoB;AAC7B,SAASC,qBAAqB;AAO9B,SACEC,YAAY,EACZC,aAAa,EACbC,WAAW,EACXC,YAAY,EACZC,UAAU,EACVC,WAAW;;AAGb;AACA,SAASC,UAAUA,CACjBC,OAAoB,EACpBC,CAA6C,EAC7C;EACA,MAAM;IAAEC;EAAO,CAAC,GAAGF,OAAO;EAE1B,OAAOR,qBAAqB,CAACQ,OAAO,EAAEC,CAAC,EAAE,CAACE,IAAI,EAAEC,OAAO,KAAK;IAC1D,IACE,EACED,IAAI,YAAYZ,oBAAoB,IACpCY,IAAI,YAAYb,wBAAwB,CACzC,EACD;MACA,MAAMF,IAAI,CAACiB,QAAQ,CAAC,sBAAsBH,MAAM,CAACI,IAAI,EAAE,CAAC;IAC1D;IAEA,OAAOH,IAAI,CAACI,6BAA6B,CAAC,CAAC,CAACP,OAAO,EAAEI,OAAO,EAAEH,CAAC,CAAC;EAClE,CAAC,CAAC;AACJ;AAEA,SAASO,WAAWA,CAClBR,OAA2B,EAC3BC,CAA6C,EAC7C;EACA,MAAM;IAAEC;EAAO,CAAC,GAAGF,OAAO;EAE1B,OAAOR,qBAAqB,CAACQ,OAAO,EAAEC,CAAC,EAAE,CAACE,IAAI,EAAEC,OAAO,KAAK;IAC1D,MAAM;MAAEK;IAAc,CAAC,GAAGL,OAAO;IAEjC,IACEK,aAAa,IACb,EACEN,IAAI,YAAYZ,oBAAoB,IACpCY,IAAI,YAAYb,wBAAwB,CACzC,EACD;MACA,MAAMF,IAAI,CAACiB,QAAQ,CAAC,sBAAsBH,MAAM,CAACI,IAAI,EAAE,CAAC;IAC1D;IAEA,OAAOH,IAAI,CAACO,8BAA8B,CAAC,CAAC,CAACV,OAAO,EAAEI,OAAO,EAAEH,CAAC,CAAC;EACnE,CAAC,CAAC;AACJ;AAEA,OAAO,SAASU,SAASA,CACvBC,eAA8C,EAC9CC,gBAAsD,EACkB;EACxE,OAAO,CACL;IACEC,MAAM,EAAE,KAAK;IACbR,IAAI,EAAE,wCAAwC;IAC9CS,OAAO,EAAEhB,UAAU;IACnBiB,OAAO,EAAE;MACP,GAAGJ,eAAe;MAClBK,QAAQ,EAAE;QACRf,MAAM,EAAEb,GAAG,CAAC6B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBC,IAAI,EAAEjC,UAAU;UAChBmB,IAAI,EAAET,UAAU;UAChBwB,MAAM,EAAEzB;QACV,CAAC;MACH;IACF;EACF,CAAC,EAED;IACEkB,MAAM,EAAE,KAAK;IACbR,IAAI,EAAE,wDAAwD;IAC9DS,OAAO,EAAEhB,UAAU;IACnBiB,OAAO,EAAE;MACP,GAAGJ,eAAe;MAClBK,QAAQ,EAAE;QACRf,MAAM,EAAEb,GAAG,CAAC6B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBG,KAAK,EAAExB,WAAW;UAClBsB,IAAI,EAAEjC,UAAU;UAChBmB,IAAI,EAAET,UAAU;UAChBwB,MAAM,EAAEzB;QACV,CAAC;MACH;IACF;EACF,CAAC,EAED;IACEkB,MAAM,EAAE,MAAM;IACdR,IAAI,EAAE,wCAAwC;IAC9CS,OAAO,EAAEP,WAAW;IACpBQ,OAAO,EAAE;MACP,GAAGH,gBAAgB;MACnBI,QAAQ,EAAE;QACRf,MAAM,EAAEb,GAAG,CAAC6B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBC,IAAI,EAAEjC,UAAU;UAChBmB,IAAI,EAAET,UAAU;UAChBwB,MAAM,EAAEzB;QACV,CAAC,CAAC;QACF2B,OAAO,EAAElC,GAAG,CAAC6B,MAAM,CAAC,CAAC,CAClBC,IAAI,CAAC;UACJK,KAAK,EAAE7B,WAAW;UAClB8B,MAAM,EAAEhC,YAAY;UACpBiC,OAAO,EAAEhC;QACX,CAAC,CAAC,CACDiC,QAAQ,CAAC;MACd;IACF;EACF,CAAC,EAED;IACEb,MAAM,EAAE,MAAM;IACdR,IAAI,EAAE,wDAAwD;IAC9DS,OAAO,EAAEP,WAAW;IACpBQ,OAAO,EAAE;MACP,GAAGH,gBAAgB;MACnBI,QAAQ,EAAE;QACRf,MAAM,EAAEb,GAAG,CAAC6B,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBG,KAAK,EAAExB,WAAW;UAClBsB,IAAI,EAAEjC,UAAU;UAChBmB,IAAI,EAAET,UAAU;UAChBwB,MAAM,EAAEzB;QACV,CAAC,CAAC;QACF2B,OAAO,EAAElC,GAAG,CAAC6B,MAAM,CAAC,CAAC,CAClBC,IAAI,CAAC;UACJK,KAAK,EAAE7B,WAAW;UAClB8B,MAAM,EAAEhC,YAAY;UACpBiC,OAAO,EAAEhC;QACX,CAAC,CAAC,CACDiC,QAAQ,CAAC;MACd;IACF;EACF,CAAC,CACF;AACH","ignoreList":[]}

package/.server/server/plugins/engine/routes/repeaters/summary.d.ts

@@ -0,0 +1,3 @@
+import { type RouteOptions, type ServerRoute } from '@hapi/hapi';
+import { type FormRequestPayloadRefs, type FormRequestRefs } from '~/src/server/routes/types.js';
+export declare function getRoutes(getRouteOptions: RouteOptions<FormRequestRefs>, postRouteOptions: RouteOptions<FormRequestPayloadRefs>): (ServerRoute<FormRequestRefs> | ServerRoute<FormRequestPayloadRefs>)[];

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

@@ -0,0 +1,98 @@
+// List summary GET route
+import { slugSchema } from '@defra/forms-model';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+import { RepeatPageController } from "../../pageControllers/RepeatPageController.js";
+import { redirectOrMakeHandler } from "../index.js";
+import { actionSchema, crumbSchema, pathSchema, stateSchema } from "../../../../schemas/index.js";
+function getHandler(request, h) {
+  const {
+    params
+  } = request;
+  return redirectOrMakeHandler(request, h, (page, context) => {
+    if (!(page instanceof RepeatPageController)) {
+      throw Boom.notFound(`No repeater page found for /${params.path}`);
+    }
+    return page.makeGetListSummaryRouteHandler()(request, context, h);
+  });
+}
+function postHandler(request, h) {
+  const {
+    params
+  } = request;
+  return redirectOrMakeHandler(request, h, (page, context) => {
+    const {
+      isForceAccess
+    } = context;
+    if (isForceAccess || !(page instanceof RepeatPageController)) {
+      throw Boom.notFound(`No repeater page found for /${params.path}`);
+    }
+    return page.makePostListSummaryRouteHandler()(request, context, h);
+  });
+}
+export function getRoutes(getRouteOptions, postRouteOptions) {
+  return [{
+    method: 'get',
+    path: '/{slug}/{path}/summary',
+    handler: getHandler,
+    options: {
+      ...getRouteOptions,
+      validate: {
+        params: Joi.object().keys({
+          slug: slugSchema,
+          path: pathSchema
+        })
+      }
+    }
+  }, {
+    method: 'get',
+    path: '/preview/{state}/{slug}/{path}/summary',
+    handler: getHandler,
+    options: {
+      ...getRouteOptions,
+      validate: {
+        params: Joi.object().keys({
+          state: stateSchema,
+          slug: slugSchema,
+          path: pathSchema
+        })
+      }
+    }
+  }, {
+    method: 'post',
+    path: '/{slug}/{path}/summary',
+    handler: postHandler,
+    options: {
+      ...postRouteOptions,
+      validate: {
+        params: Joi.object().keys({
+          slug: slugSchema,
+          path: pathSchema
+        }),
+        payload: Joi.object().keys({
+          crumb: crumbSchema,
+          action: actionSchema
+        }).required()
+      }
+    }
+  }, {
+    method: 'post',
+    path: '/preview/{state}/{slug}/{path}/summary',
+    handler: postHandler,
+    options: {
+      ...postRouteOptions,
+      validate: {
+        params: Joi.object().keys({
+          state: stateSchema,
+          slug: slugSchema,
+          path: pathSchema
+        }),
+        payload: Joi.object().keys({
+          crumb: crumbSchema,
+          action: actionSchema
+        }).required()
+      }
+    }
+  }];
+}
+//# sourceMappingURL=summary.js.map

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

@@ -0,0 +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 {\n  type ResponseToolkit,\n  type RouteOptions,\n  type ServerRoute\n} 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} 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(\n  request: FormRequest,\n  h: Pick<ResponseToolkit, 'redirect' | 'view'>\n) {\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(\n  request: FormRequestPayload,\n  h: Pick<ResponseToolkit, 'redirect' | 'view'>\n) {\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;AAM7B,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,oBAAoB;AAC7B,SAASC,qBAAqB;AAO9B,SACEC,YAAY,EACZC,WAAW,EACXC,UAAU,EACVC,WAAW;AAGb,SAASC,UAAUA,CACjBC,OAAoB,EACpBC,CAA6C,EAC7C;EACA,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,CAClBR,OAA2B,EAC3BC,CAA6C,EAC7C;EACA,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":[]}

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

@@ -1,11 +1,14 @@
 import { type ComponentDef, type Item, type List, type Page } from '@defra/forms-model';
+import { type PluginProperties, type Request } from '@hapi/hapi';
 import { type JoiExpression, type ValidationErrorItem } from 'joi';
 import { type Component } from '~/src/server/plugins/engine/components/helpers.js';
 import { type BackLink, type ComponentText, type ComponentViewModel } from '~/src/server/plugins/engine/components/types.js';
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
 import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js';
 import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js';
 import { type ViewContext } from '~/src/server/plugins/nunjucks/types.js';
-import { type FormAction, type FormRequest } from '~/src/server/routes/types.js';
+import { type FormAction, type FormRequest, type FormRequestPayload } from '~/src/server/routes/types.js';
+import { type Services } from '~/src/server/types.js';
 /**
  * Form submission state stores the following in Redis:
  * Props containing user's submitted values as `{ [inputId]: value }` or as `{ [sectionName]: { [inputName]: value } }`
@@ -254,3 +257,18 @@ export interface ErrorMessageTemplateList {
     baseErrors: ErrorMessageTemplate[];
     advancedSettingsErrors: ErrorMessageTemplate[];
 }
+export interface PluginOptions {
+    model?: FormModel;
+    services?: Services;
+    controllers?: Record<string, typeof PageController>;
+    cacheName?: string;
+    filters?: Record<string, FilterFunction>;
+    keyGenerator?: (request: Request | FormRequest | FormRequestPayload) => string;
+    sessionHydrator?: (request: Request | FormRequest | FormRequestPayload) => Promise<FormSubmissionState>;
+    pluginPath?: string;
+    nunjucks: {
+        baseLayoutPath: string;
+        paths: string[];
+    };
+    viewContext: PluginProperties['forms-engine-plugin']['viewContext'];
+}

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":["UploadStatus","FileStatus"],"sources":["../../../../src/server/plugins/engine/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Item,\n  type List,\n  type Page\n} from '@defra/forms-model'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'\nimport { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'\nimport { type FormAction, type FormRequest } from '~/src/server/routes/types.js'\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 FormParams {\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 = FormParams & 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}\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<FormRequest, 'app' | 'method' | 'params' | 'path' | 'query' | 'url'>\n\nexport interface UploadInitiateResponse {\n  uploadId: string\n  uploadUrl: string\n  statusUrl: string\n}\n\nexport enum UploadStatus {\n  initiated = 'initiated',\n  pending = 'pending',\n  ready = 'ready'\n}\n\nexport enum FileStatus {\n  complete = 'complete',\n  rejected = 'rejected',\n  pending = 'pending'\n}\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}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\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 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"],"mappings":"AAoBA;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;;AAkGA,WAAYA,YAAY,0BAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAA,OAAZA,YAAY;AAAA;AAMxB,WAAYC,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA","ignoreList":[]}
+{"version":3,"file":"types.js","names":["UploadStatus","FileStatus"],"sources":["../../../../src/server/plugins/engine/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Item,\n  type List,\n  type Page\n} from '@defra/forms-model'\nimport { type PluginProperties, type Request } from '@hapi/hapi'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'\nimport { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'\nimport {\n  type FormAction,\n  type FormRequest,\n  type FormRequestPayload\n} from '~/src/server/routes/types.js'\nimport { type Services } from '~/src/server/types.js'\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 FormParams {\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 = FormParams & 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}\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<FormRequest, 'app' | 'method' | 'params' | 'path' | 'query' | 'url'>\n\nexport interface UploadInitiateResponse {\n  uploadId: string\n  uploadUrl: string\n  statusUrl: string\n}\n\nexport enum UploadStatus {\n  initiated = 'initiated',\n  pending = 'pending',\n  ready = 'ready'\n}\n\nexport enum FileStatus {\n  complete = 'complete',\n  rejected = 'rejected',\n  pending = 'pending'\n}\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}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\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 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 interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cacheName?: string\n  filters?: Record<string, FilterFunction>\n  keyGenerator?: (request: Request | FormRequest | FormRequestPayload) => string\n  sessionHydrator?: (\n    request: Request | FormRequest | FormRequestPayload\n  ) => Promise<FormSubmissionState>\n  pluginPath?: string\n  nunjucks: {\n    baseLayoutPath: string\n    paths: string[]\n  }\n  viewContext: PluginProperties['forms-engine-plugin']['viewContext']\n}\n"],"mappings":"AA2BA;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;;AAkGA,WAAYA,YAAY,0BAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAA,OAAZA,YAAY;AAAA;AAMxB,WAAYC,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA","ignoreList":[]}

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

@@ -0,0 +1,12 @@
+import { type Server } from '@hapi/hapi';
+import { type Environment } from 'nunjucks';
+import { type PluginOptions } from '~/src/server/plugins/engine/types.js';
+export declare function registerVision(server: Server, pluginOptions: PluginOptions): Promise<void>;
+interface CompileOptions {
+    environment: Environment;
+}
+export interface EngineConfigurationObject {
+    compileOptions: CompileOptions;
+}
+export declare function findPackageRoot(): string;
+export {};

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

@@ -0,0 +1,55 @@
+import { existsSync } from 'fs';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import vision from '@hapi/vision';
+import nunjucks from 'nunjucks';
+import resolvePkg from 'resolve';
+import { VIEW_PATH, context, prepareNunjucksEnvironment } from "./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')];
+  await server.register({
+    plugin: vision,
+    options: {
+      engines: {
+        html: {
+          compile: (path, compileOptions) => {
+            const template = nunjucks.compile(path, compileOptions.environment);
+            return context => {
+              return template.render(context);
+            };
+          },
+          prepare: (options, next) => {
+            // Nunjucks also needs an additional path configuration
+            // to use the templates and macros from `govuk-frontend`
+            const environment = nunjucks.configure(paths);
+
+            // Applies custom filters and globals for nunjucks
+            // that are required by the `forms-engine-plugin`
+            prepareNunjucksEnvironment(environment, pluginOptions.filters);
+            options.compileOptions.environment = environment;
+            next();
+          }
+        }
+      },
+      path: paths,
+      // Provides global context used with all templates
+      context
+    }
+  });
+}
+export function findPackageRoot() {
+  const currentFileName = fileURLToPath(import.meta.url);
+  const currentDirectoryName = dirname(currentFileName);
+  let dir = currentDirectoryName;
+  while (dir !== '/') {
+    if (existsSync(join(dir, 'package.json'))) {
+      return dir;
+    }
+    dir = dirname(dir);
+  }
+  throw new Error('package.json not found in parent directories');
+}
+//# sourceMappingURL=vision.js.map

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

@@ -0,0 +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","filters","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.filters)\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,CAACqB,OAAO,CAAC;YAE9DZ,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,MAAMoB,eAAe,GAAG/B,aAAa,CAACgC,MAAM,CAACC,IAAI,CAACC,GAAG,CAAC;EACtD,MAAMC,oBAAoB,GAAGrC,OAAO,CAACiC,eAAe,CAAC;EAErD,IAAIK,GAAG,GAAGD,oBAAoB;EAC9B,OAAOC,GAAG,KAAK,GAAG,EAAE;IAClB,IAAIvC,UAAU,CAACE,IAAI,CAACqC,GAAG,EAAE,cAAc,CAAC,CAAC,EAAE;MACzC,OAAOA,GAAG;IACZ;IACAA,GAAG,GAAGtC,OAAO,CAACsC,GAAG,CAAC;EACpB;EAEA,MAAM,IAAIC,KAAK,CAAC,8CAA8C,CAAC;AACjE","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Defra forms engine",
   "type": "module",
   "files": [

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

@@ -4,13 +4,11 @@ import { type FormDefinition } from '@defra/forms-model'
 
 import { FORM_PREFIX } from '~/src/server/constants.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import {
-  plugin,
-  type PluginOptions
-} from '~/src/server/plugins/engine/plugin.js'
-import { findPackageRoot } from '~/src/server/plugins/engine/plugin.js'
+import { plugin } from '~/src/server/plugins/engine/plugin.js'
 import * as defaultServices from '~/src/server/plugins/engine/services/index.js'
 import { formsService } from '~/src/server/plugins/engine/services/localFormsService.js'
+import { type PluginOptions } from '~/src/server/plugins/engine/types.js'
+import { findPackageRoot } from '~/src/server/plugins/engine/vision.js'
 import { devtoolContext } from '~/src/server/plugins/nunjucks/context.js'
 import { type RouteConfig } from '~/src/server/types.js'
 

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

@@ -0,0 +1,37 @@
+import Joi from 'joi'
+
+const pluginRegistrationOptionsSchema = Joi.object({
+  model: Joi.object().optional(),
+  services: Joi.object().optional(),
+  controllers: Joi.object().pattern(Joi.string(), Joi.any()).optional(),
+  cacheName: Joi.string().optional(),
+  filters: Joi.object().pattern(Joi.string(), Joi.any()).optional(),
+  pluginPath: Joi.string().optional(),
+  nunjucks: Joi.object({
+    baseLayoutPath: Joi.string().required(),
+    paths: Joi.array().items(Joi.string()).required()
+  }).required(),
+  viewContext: Joi.function().required()
+})
+
+/**
+ * Validates the plugin options against the schema and returns the validated value.
+ * @param {PluginOptions} options
+ * @returns {PluginOptions}
+ */
+export function validatePluginOptions(options) {
+  const result = pluginRegistrationOptionsSchema.validate(options, {
+    abortEarly: false
+  })
+
+  if (result.error) {
+    throw new Error('Invalid plugin options', result.error)
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+  return result.value
+}
+
+/**
+ * @import { PluginOptions } from '~/src/server/plugins/engine/types.js'
+ */

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

@@ -0,0 +1,34 @@
+import { validatePluginOptions } from '~/src/server/plugins/engine/options.js'
+
+describe('validatePluginOptions', () => {
+  it('returns the validated value for valid options', () => {
+    const validOptions = {
+      nunjucks: {
+        baseLayoutPath: 'dxt-devtool-baselayout.html',
+        paths: ['src/server/devserver'] // custom layout to make it really clear this is not the same as the runner
+      },
+      viewContext: () => {
+        return { hello: 'world' }
+      }
+    }
+
+    expect(validatePluginOptions(validOptions)).toEqual(validOptions)
+  })
+
+  /**
+   * tsc would usually check compliance with the type, but given a user might be using plain JS we still want a test
+   */
+  it('fails if a required attribute is missing', () => {
+    const invalidOptions = {
+      nunjucks: {
+        baseLayoutPath: 'dxt-devtool-baselayout.html',
+        paths: ['src/server/devserver'] // custom layout to make it really clear this is not the same as the runner
+      }
+    }
+
+    // @ts-expect-error -- add a test for JS users
+    expect(() => validatePluginOptions(invalidOptions)).toThrow(
+      'Invalid plugin options'
+    )
+  })
+})