@defra/forms-engine-plugin 0.1.9 → 0.1.11

package/.server/server/plugins/nunjucks/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","names":["readFileSync","basename","join","Boom","StatusCodes","pkg","type","parseCookieConsent","config","createLogger","PREVIEW_PATH_PREFIX","encodeUrl","safeGenerateCrumb","logger","webpackManifest","context","request","manifestPath","get","JSON","parse","error","params","path","query","response","state","isForceAccess","isPreviewMode","startsWith","isResponseOK","isBoom","statusCode","OK","ctx","appVersion","version","assetPath","cdpEnvironment","designerUrl","feedbackLink","phaseTag","serviceBannerText","serviceName","serviceVersion","crumb","cspNonce","plugins","blankie","nonces","script","currentPath","url","search","undefined","previewMode","slug","getAssetPath","asset","googleAnalyticsTrackingId","cookieConsent"],"sources":["../../../../src/server/plugins/nunjucks/context.js"],"sourcesContent":["import { readFileSync } from 'node:fs'\nimport { basename, join } from 'node:path'\n\nimport Boom from '@hapi/boom'\nimport { StatusCodes } from 'http-status-codes'\n\nimport pkg from '~/package.json' with { type: 'json' }\nimport { parseCookieConsent } from '~/src/common/cookies.js'\nimport { config } from '~/src/config/index.js'\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'\nimport {\n  encodeUrl,\n  safeGenerateCrumb\n} from '~/src/server/plugins/engine/helpers.js'\n\nconst logger = createLogger()\n\n/** @type {Record<string, string> | undefined} */\nlet webpackManifest\n\n/**\n * @param {FormRequest | FormRequestPayload | null} request\n */\nexport function context(request) {\n  const manifestPath = join(config.get('publicDir'), 'assets-manifest.json')\n\n  if (!webpackManifest) {\n    try {\n      // eslint-disable-next-line -- Allow JSON type 'any'\n      webpackManifest = JSON.parse(readFileSync(manifestPath, 'utf-8'))\n    } catch {\n      logger.error(`Webpack ${basename(manifestPath)} not found`)\n    }\n  }\n\n  const { params, path, query = {}, response, state } = request ?? {}\n\n  const isForceAccess = 'force' in query\n  const isPreviewMode = path?.startsWith(PREVIEW_PATH_PREFIX)\n\n  // Only add the slug in to the context if the response is OK.\n  // Footer meta links are not rendered when the slug is missing.\n  const isResponseOK =\n    !Boom.isBoom(response) && response?.statusCode === StatusCodes.OK\n\n  /** @type {ViewContext} */\n  const ctx = {\n    appVersion: pkg.version,\n    assetPath: '/assets',\n    config: {\n      cdpEnvironment: config.get('cdpEnvironment'),\n      designerUrl: config.get('designerUrl'),\n      feedbackLink: encodeUrl(config.get('feedbackLink')),\n      phaseTag: config.get('phaseTag'),\n      serviceBannerText: config.get('serviceBannerText'),\n      serviceName: config.get('serviceName'),\n      serviceVersion: config.get('serviceVersion')\n    },\n    crumb: safeGenerateCrumb(request),\n    cspNonce: request?.plugins.blankie?.nonces?.script,\n    currentPath: request ? `${request.path}${request.url.search}` : undefined,\n    previewMode: isPreviewMode ? params?.state : undefined,\n    slug: isResponseOK ? params?.slug : undefined,\n\n    getAssetPath: (asset = '') => {\n      return `/${webpackManifest?.[asset] ?? asset}`\n    }\n  }\n\n  if (!isForceAccess) {\n    ctx.config.googleAnalyticsTrackingId = config.get(\n      'googleAnalyticsTrackingId'\n    )\n\n    if (typeof state?.cookieConsent === 'string') {\n      ctx.cookieConsent = parseCookieConsent(state.cookieConsent)\n    }\n  }\n\n  return ctx\n}\n\n/**\n * @import { CookieConsent } from '~/src/common/types.js'\n * @import { ViewContext } from '~/src/server/plugins/nunjucks/types.js'\n * @import { FormRequest, FormRequestPayload } from '~/src/server/routes/types.js'\n */\n"],"mappings":"AAAA,SAASA,YAAY,QAAQ,SAAS;AACtC,SAASC,QAAQ,EAAEC,IAAI,QAAQ,WAAW;AAE1C,OAAOC,IAAI,MAAM,YAAY;AAC7B,SAASC,WAAW,QAAQ,mBAAmB;AAE/C,OAAOC,GAAG,wCAA8BC,IAAI,EAAE,MAAM;AACpD,SAASC,kBAAkB;AAC3B,SAASC,MAAM;AACf,SAASC,YAAY;AACrB,SAASC,mBAAmB;AAC5B,SACEC,SAAS,EACTC,iBAAiB;AAGnB,MAAMC,MAAM,GAAGJ,YAAY,CAAC,CAAC;;AAE7B;AACA,IAAIK,eAAe;;AAEnB;AACA;AACA;AACA,OAAO,SAASC,OAAOA,CAACC,OAAO,EAAE;EAC/B,MAAMC,YAAY,GAAGf,IAAI,CAACM,MAAM,CAACU,GAAG,CAAC,WAAW,CAAC,EAAE,sBAAsB,CAAC;EAE1E,IAAI,CAACJ,eAAe,EAAE;IACpB,IAAI;MACF;MACAA,eAAe,GAAGK,IAAI,CAACC,KAAK,CAACpB,YAAY,CAACiB,YAAY,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC,CAAC,MAAM;MACNJ,MAAM,CAACQ,KAAK,CAAC,WAAWpB,QAAQ,CAACgB,YAAY,CAAC,YAAY,CAAC;IAC7D;EACF;EAEA,MAAM;IAAEK,MAAM;IAAEC,IAAI;IAAEC,KAAK,GAAG,CAAC,CAAC;IAAEC,QAAQ;IAAEC;EAAM,CAAC,GAAGV,OAAO,IAAI,CAAC,CAAC;EAEnE,MAAMW,aAAa,GAAG,OAAO,IAAIH,KAAK;EACtC,MAAMI,aAAa,GAAGL,IAAI,EAAEM,UAAU,CAACnB,mBAAmB,CAAC;;EAE3D;EACA;EACA,MAAMoB,YAAY,GAChB,CAAC3B,IAAI,CAAC4B,MAAM,CAACN,QAAQ,CAAC,IAAIA,QAAQ,EAAEO,UAAU,KAAK5B,WAAW,CAAC6B,EAAE;;EAEnE;EACA,MAAMC,GAAG,GAAG;IACVC,UAAU,EAAE9B,GAAG,CAAC+B,OAAO;IACvBC,SAAS,EAAE,SAAS;IACpB7B,MAAM,EAAE;MACN8B,cAAc,EAAE9B,MAAM,CAACU,GAAG,CAAC,gBAAgB,CAAC;MAC5CqB,WAAW,EAAE/B,MAAM,CAACU,GAAG,CAAC,aAAa,CAAC;MACtCsB,YAAY,EAAE7B,SAAS,CAACH,MAAM,CAACU,GAAG,CAAC,cAAc,CAAC,CAAC;MACnDuB,QAAQ,EAAEjC,MAAM,CAACU,GAAG,CAAC,UAAU,CAAC;MAChCwB,iBAAiB,EAAElC,MAAM,CAACU,GAAG,CAAC,mBAAmB,CAAC;MAClDyB,WAAW,EAAEnC,MAAM,CAACU,GAAG,CAAC,aAAa,CAAC;MACtC0B,cAAc,EAAEpC,MAAM,CAACU,GAAG,CAAC,gBAAgB;IAC7C,CAAC;IACD2B,KAAK,EAAEjC,iBAAiB,CAACI,OAAO,CAAC;IACjC8B,QAAQ,EAAE9B,OAAO,EAAE+B,OAAO,CAACC,OAAO,EAAEC,MAAM,EAAEC,MAAM;IAClDC,WAAW,EAAEnC,OAAO,GAAG,GAAGA,OAAO,CAACO,IAAI,GAAGP,OAAO,CAACoC,GAAG,CAACC,MAAM,EAAE,GAAGC,SAAS;IACzEC,WAAW,EAAE3B,aAAa,GAAGN,MAAM,EAAEI,KAAK,GAAG4B,SAAS;IACtDE,IAAI,EAAE1B,YAAY,GAAGR,MAAM,EAAEkC,IAAI,GAAGF,SAAS;IAE7CG,YAAY,EAAEA,CAACC,KAAK,GAAG,EAAE,KAAK;MAC5B,OAAO,IAAI5C,eAAe,GAAG4C,KAAK,CAAC,IAAIA,KAAK,EAAE;IAChD;EACF,CAAC;EAED,IAAI,CAAC/B,aAAa,EAAE;IAClBO,GAAG,CAAC1B,MAAM,CAACmD,yBAAyB,GAAGnD,MAAM,CAACU,GAAG,CAC/C,2BACF,CAAC;IAED,IAAI,OAAOQ,KAAK,EAAEkC,aAAa,KAAK,QAAQ,EAAE;MAC5C1B,GAAG,CAAC0B,aAAa,GAAGrD,kBAAkB,CAACmB,KAAK,CAACkC,aAAa,CAAC;IAC7D;EACF;EAEA,OAAO1B,GAAG;AACZ;;AAEA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"context.js","names":["readFileSync","basename","join","Boom","StatusCodes","pkg","type","config","createLogger","PREVIEW_PATH_PREFIX","encodeUrl","safeGenerateCrumb","logger","webpackManifest","context","request","params","path","response","isPreviewMode","startsWith","isResponseOK","isBoom","statusCode","OK","pluginStorage","server","plugins","consumerViewContext","Error","baseLayoutPath","viewContext","ctx","appVersion","version","cdpEnvironment","get","designerUrl","feedbackLink","phaseTag","serviceName","serviceVersion","crumb","currentPath","url","search","previewMode","state","undefined","slug","devtoolContext","manifestPath","JSON","parse","error","assetPath","getDxtAssetPath","asset"],"sources":["../../../../src/server/plugins/nunjucks/context.js"],"sourcesContent":["import { readFileSync } from 'node:fs'\nimport { basename, join } from 'node:path'\n\nimport Boom from '@hapi/boom'\nimport { StatusCodes } from 'http-status-codes'\n\nimport pkg from '~/package.json' with { type: 'json' }\nimport { config } from '~/src/config/index.js'\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'\nimport {\n  encodeUrl,\n  safeGenerateCrumb\n} from '~/src/server/plugins/engine/helpers.js'\n\nconst logger = createLogger()\n\n/** @type {Record<string, string> | undefined} */\nlet webpackManifest\n\n/**\n * @param {FormRequest | FormRequestPayload | null} request\n */\nexport function context(request) {\n  const { params, path, response } = request ?? {}\n\n  const isPreviewMode = path?.startsWith(PREVIEW_PATH_PREFIX)\n\n  // Only add the slug in to the context if the response is OK.\n  // Footer meta links are not rendered when the slug is missing.\n  const isResponseOK =\n    !Boom.isBoom(response) && response?.statusCode === StatusCodes.OK\n\n  const pluginStorage = request?.server.plugins['forms-engine-plugin']\n  let consumerViewContext = {}\n\n  if (!pluginStorage) {\n    throw Error('context called before plugin registered')\n  }\n\n  if (!pluginStorage.baseLayoutPath) {\n    throw Error('Missing baseLayoutPath in plugin.options.nunjucks')\n  }\n\n  if ('viewContext' in pluginStorage) {\n    consumerViewContext = pluginStorage.viewContext(request)\n  }\n\n  /** @type {ViewContext} */\n  const ctx = {\n    // take consumers props first so we can override it\n    ...consumerViewContext,\n    baseLayoutPath: pluginStorage.baseLayoutPath,\n    appVersion: pkg.version,\n    config: {\n      cdpEnvironment: config.get('cdpEnvironment'),\n      designerUrl: config.get('designerUrl'),\n      feedbackLink: encodeUrl(config.get('feedbackLink')),\n      phaseTag: config.get('phaseTag'),\n      serviceName: config.get('serviceName'),\n      serviceVersion: config.get('serviceVersion')\n    },\n    crumb: safeGenerateCrumb(request),\n    currentPath: `${request.path}${request.url.search}`,\n    previewMode: isPreviewMode ? params?.state : undefined,\n    slug: isResponseOK ? params?.slug : undefined\n  }\n\n  return ctx\n}\n\n/**\n * Returns the context for the devtool. Consumers won't have access to this.\n */\nexport function devtoolContext() {\n  const manifestPath = join(config.get('publicDir'), 'assets-manifest.json')\n\n  if (!webpackManifest) {\n    try {\n      // eslint-disable-next-line -- Allow JSON type 'any'\n      webpackManifest = JSON.parse(readFileSync(manifestPath, 'utf-8'))\n    } catch {\n      logger.error(`Webpack ${basename(manifestPath)} not found`)\n    }\n  }\n\n  return {\n    assetPath: '/assets',\n    getDxtAssetPath: (asset = '') => {\n      return `/${webpackManifest?.[asset] ?? asset}`\n    }\n  }\n}\n\n/**\n * @import { ViewContext } from '~/src/server/plugins/nunjucks/types.js'\n * @import { FormRequest, FormRequestPayload } from '~/src/server/routes/types.js'\n */\n"],"mappings":"AAAA,SAASA,YAAY,QAAQ,SAAS;AACtC,SAASC,QAAQ,EAAEC,IAAI,QAAQ,WAAW;AAE1C,OAAOC,IAAI,MAAM,YAAY;AAC7B,SAASC,WAAW,QAAQ,mBAAmB;AAE/C,OAAOC,GAAG,wCAA8BC,IAAI,EAAE,MAAM;AACpD,SAASC,MAAM;AACf,SAASC,YAAY;AACrB,SAASC,mBAAmB;AAC5B,SACEC,SAAS,EACTC,iBAAiB;AAGnB,MAAMC,MAAM,GAAGJ,YAAY,CAAC,CAAC;;AAE7B;AACA,IAAIK,eAAe;;AAEnB;AACA;AACA;AACA,OAAO,SAASC,OAAOA,CAACC,OAAO,EAAE;EAC/B,MAAM;IAAEC,MAAM;IAAEC,IAAI;IAAEC;EAAS,CAAC,GAAGH,OAAO,IAAI,CAAC,CAAC;EAEhD,MAAMI,aAAa,GAAGF,IAAI,EAAEG,UAAU,CAACX,mBAAmB,CAAC;;EAE3D;EACA;EACA,MAAMY,YAAY,GAChB,CAAClB,IAAI,CAACmB,MAAM,CAACJ,QAAQ,CAAC,IAAIA,QAAQ,EAAEK,UAAU,KAAKnB,WAAW,CAACoB,EAAE;EAEnE,MAAMC,aAAa,GAAGV,OAAO,EAAEW,MAAM,CAACC,OAAO,CAAC,qBAAqB,CAAC;EACpE,IAAIC,mBAAmB,GAAG,CAAC,CAAC;EAE5B,IAAI,CAACH,aAAa,EAAE;IAClB,MAAMI,KAAK,CAAC,yCAAyC,CAAC;EACxD;EAEA,IAAI,CAACJ,aAAa,CAACK,cAAc,EAAE;IACjC,MAAMD,KAAK,CAAC,mDAAmD,CAAC;EAClE;EAEA,IAAI,aAAa,IAAIJ,aAAa,EAAE;IAClCG,mBAAmB,GAAGH,aAAa,CAACM,WAAW,CAAChB,OAAO,CAAC;EAC1D;;EAEA;EACA,MAAMiB,GAAG,GAAG;IACV;IACA,GAAGJ,mBAAmB;IACtBE,cAAc,EAAEL,aAAa,CAACK,cAAc;IAC5CG,UAAU,EAAE5B,GAAG,CAAC6B,OAAO;IACvB3B,MAAM,EAAE;MACN4B,cAAc,EAAE5B,MAAM,CAAC6B,GAAG,CAAC,gBAAgB,CAAC;MAC5CC,WAAW,EAAE9B,MAAM,CAAC6B,GAAG,CAAC,aAAa,CAAC;MACtCE,YAAY,EAAE5B,SAAS,CAACH,MAAM,CAAC6B,GAAG,CAAC,cAAc,CAAC,CAAC;MACnDG,QAAQ,EAAEhC,MAAM,CAAC6B,GAAG,CAAC,UAAU,CAAC;MAChCI,WAAW,EAAEjC,MAAM,CAAC6B,GAAG,CAAC,aAAa,CAAC;MACtCK,cAAc,EAAElC,MAAM,CAAC6B,GAAG,CAAC,gBAAgB;IAC7C,CAAC;IACDM,KAAK,EAAE/B,iBAAiB,CAACI,OAAO,CAAC;IACjC4B,WAAW,EAAE,GAAG5B,OAAO,CAACE,IAAI,GAAGF,OAAO,CAAC6B,GAAG,CAACC,MAAM,EAAE;IACnDC,WAAW,EAAE3B,aAAa,GAAGH,MAAM,EAAE+B,KAAK,GAAGC,SAAS;IACtDC,IAAI,EAAE5B,YAAY,GAAGL,MAAM,EAAEiC,IAAI,GAAGD;EACtC,CAAC;EAED,OAAOhB,GAAG;AACZ;;AAEA;AACA;AACA;AACA,OAAO,SAASkB,cAAcA,CAAA,EAAG;EAC/B,MAAMC,YAAY,GAAGjD,IAAI,CAACK,MAAM,CAAC6B,GAAG,CAAC,WAAW,CAAC,EAAE,sBAAsB,CAAC;EAE1E,IAAI,CAACvB,eAAe,EAAE;IACpB,IAAI;MACF;MACAA,eAAe,GAAGuC,IAAI,CAACC,KAAK,CAACrD,YAAY,CAACmD,YAAY,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC,CAAC,MAAM;MACNvC,MAAM,CAAC0C,KAAK,CAAC,WAAWrD,QAAQ,CAACkD,YAAY,CAAC,YAAY,CAAC;IAC7D;EACF;EAEA,OAAO;IACLI,SAAS,EAAE,SAAS;IACpBC,eAAe,EAAEA,CAACC,KAAK,GAAG,EAAE,KAAK;MAC/B,OAAO,IAAI5C,eAAe,GAAG4C,KAAK,CAAC,IAAIA,KAAK,EAAE;IAChD;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/nunjucks/context.test.js

@@ -1,24 +1,22 @@
 import { tmpdir } from 'node:os';
-import { config } from "../../../config/index.js";
-import { encodeUrl } from "../engine/helpers.js";
-import { context } from "./context.js";
+import { context, devtoolContext } from "./context.js";
 describe('Nunjucks context', () => {
   beforeEach(() => jest.resetModules());
   describe('Asset path', () => {
     it("should include 'assetPath' for GOV.UK Frontend icons", () => {
       const {
         assetPath
-      } = context(null);
+      } = devtoolContext();
       expect(assetPath).toBe('/assets');
     });
   });
   describe('Asset helper', () => {
     it("should locate 'assets-manifest.json' assets", () => {
       const {
-        getAssetPath
-      } = context(null);
-      expect(getAssetPath('example.scss')).toBe('/stylesheets/example.xxxxxxx.min.css');
-      expect(getAssetPath('example.mjs')).toBe('/javascripts/example.xxxxxxx.min.js');
+        getDxtAssetPath
+      } = devtoolContext();
+      expect(getDxtAssetPath('example.scss')).toBe('/stylesheets/example.xxxxxxx.min.css');
+      expect(getDxtAssetPath('example.mjs')).toBe('/javascripts/example.xxxxxxx.min.js');
     });
     it("should return path when 'assets-manifest.json' is missing", async () => {
       await jest.isolateModulesAsync(async () => {
@@ -28,41 +26,32 @@ describe('Nunjucks context', () => {
 
         // Import when isolated to avoid cache
         const {
-          context
+          devtoolContext
         } = await import("./context.js");
 
         // Update config for missing manifest
         config.set('publicDir', tmpdir());
         const {
-          getAssetPath
-        } = context(null);
+          getDxtAssetPath
+        } = devtoolContext();
 
         // Uses original paths when missing
-        expect(getAssetPath('example.scss')).toBe('/example.scss');
-        expect(getAssetPath('example.mjs')).toBe('/example.mjs');
+        expect(getDxtAssetPath('example.scss')).toBe('/example.scss');
+        expect(getDxtAssetPath('example.mjs')).toBe('/example.mjs');
       });
     });
     it('should return path to unknown assets', () => {
       const {
-        getAssetPath
-      } = context(null);
-      expect(getAssetPath()).toBe('/');
-      expect(getAssetPath('example.jpg')).toBe('/example.jpg');
-      expect(getAssetPath('example.gif')).toBe('/example.gif');
+        getDxtAssetPath
+      } = devtoolContext();
+      expect(getDxtAssetPath()).toBe('/');
+      expect(getDxtAssetPath('example.jpg')).toBe('/example.jpg');
+      expect(getDxtAssetPath('example.gif')).toBe('/example.gif');
     });
   });
   describe('Config', () => {
     it('should include environment, phase tag and service info', () => {
-      const ctx = context(null);
-      expect(ctx.config).toEqual(expect.objectContaining({
-        cdpEnvironment: config.get('cdpEnvironment'),
-        feedbackLink: encodeUrl(config.get('feedbackLink')),
-        googleAnalyticsTrackingId: config.get('googleAnalyticsTrackingId'),
-        phaseTag: config.get('phaseTag'),
-        serviceBannerText: config.get('serviceBannerText'),
-        serviceName: config.get('serviceName'),
-        serviceVersion: config.get('serviceVersion')
-      }));
+      expect(() => context(null)).toThrow('context called before plugin registered');
     });
   });
   describe('Crumb', () => {
@@ -75,6 +64,9 @@ describe('Nunjucks context', () => {
           plugins: {
             crumb: {
               generate: jest.fn()
+            },
+            'forms-engine-plugin': {
+              baseLayoutPath: 'randomValue'
             }
           }
         },
@@ -104,6 +96,9 @@ describe('Nunjucks context', () => {
           plugins: {
             crumb: {
               generate: jest.fn().mockReturnValue(mockCrumb)
+            },
+            'forms-engine-plugin': {
+              baseLayoutPath: 'randomValue'
             }
           }
         },

package/.server/server/plugins/nunjucks/context.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.test.js","names":["tmpdir","config","encodeUrl","context","describe","beforeEach","jest","resetModules","it","assetPath","expect","toBe","getAssetPath","isolateModulesAsync","set","ctx","toEqual","objectContaining","cdpEnvironment","get","feedbackLink","googleAnalyticsTrackingId","phaseTag","serviceBannerText","serviceName","serviceVersion","malformedRequest","server","plugins","crumb","generate","fn","route","settings","path","url","search","toBeUndefined","not","toHaveBeenCalled","mockCrumb","validRequest","mockReturnValue","state","toHaveBeenCalledWith"],"sources":["../../../../src/server/plugins/nunjucks/context.test.js"],"sourcesContent":["import { tmpdir } from 'node:os'\n\nimport { config } from '~/src/config/index.js'\nimport { encodeUrl } from '~/src/server/plugins/engine/helpers.js'\nimport { context } from '~/src/server/plugins/nunjucks/context.js'\n\ndescribe('Nunjucks context', () => {\n  beforeEach(() => jest.resetModules())\n\n  describe('Asset path', () => {\n    it(\"should include 'assetPath' for GOV.UK Frontend icons\", () => {\n      const { assetPath } = context(null)\n      expect(assetPath).toBe('/assets')\n    })\n  })\n\n  describe('Asset helper', () => {\n    it(\"should locate 'assets-manifest.json' assets\", () => {\n      const { getAssetPath } = context(null)\n\n      expect(getAssetPath('example.scss')).toBe(\n        '/stylesheets/example.xxxxxxx.min.css'\n      )\n\n      expect(getAssetPath('example.mjs')).toBe(\n        '/javascripts/example.xxxxxxx.min.js'\n      )\n    })\n\n    it(\"should return path when 'assets-manifest.json' is missing\", async () => {\n      await jest.isolateModulesAsync(async () => {\n        const { config } = await import('~/src/config/index.js')\n\n        // Import when isolated to avoid cache\n        const { context } = await import(\n          '~/src/server/plugins/nunjucks/context.js'\n        )\n\n        // Update config for missing manifest\n        config.set('publicDir', tmpdir())\n        const { getAssetPath } = context(null)\n\n        // Uses original paths when missing\n        expect(getAssetPath('example.scss')).toBe('/example.scss')\n        expect(getAssetPath('example.mjs')).toBe('/example.mjs')\n      })\n    })\n\n    it('should return path to unknown assets', () => {\n      const { getAssetPath } = context(null)\n\n      expect(getAssetPath()).toBe('/')\n      expect(getAssetPath('example.jpg')).toBe('/example.jpg')\n      expect(getAssetPath('example.gif')).toBe('/example.gif')\n    })\n  })\n\n  describe('Config', () => {\n    it('should include environment, phase tag and service info', () => {\n      const ctx = context(null)\n\n      expect(ctx.config).toEqual(\n        expect.objectContaining({\n          cdpEnvironment: config.get('cdpEnvironment'),\n          feedbackLink: encodeUrl(config.get('feedbackLink')),\n          googleAnalyticsTrackingId: config.get('googleAnalyticsTrackingId'),\n          phaseTag: config.get('phaseTag'),\n          serviceBannerText: config.get('serviceBannerText'),\n          serviceName: config.get('serviceName'),\n          serviceVersion: config.get('serviceVersion')\n        })\n      )\n    })\n  })\n\n  describe('Crumb', () => {\n    it('should handle malformed requests with missing state', () => {\n      // While state should always exist in a valid Hapi request (it holds cookies),\n      // we've seen malformed requests in production where it's missing\n      const malformedRequest = /** @type {FormRequest} */ (\n        /** @type {unknown} */ ({\n          server: {\n            plugins: {\n              crumb: {\n                generate: jest.fn()\n              }\n            }\n          },\n          plugins: {},\n          route: {\n            settings: {\n              plugins: {}\n            }\n          },\n          path: '/test',\n          url: { search: '' }\n          // state intentionally omitted to test real malformed requests\n        })\n      )\n\n      const { crumb } = context(malformedRequest)\n      expect(crumb).toBeUndefined()\n      expect(\n        malformedRequest.server.plugins.crumb.generate\n      ).not.toHaveBeenCalled()\n    })\n\n    it('should generate crumb when state exists', () => {\n      const mockCrumb = 'generated-crumb-value'\n      const validRequest = /** @type {FormRequest} */ (\n        /** @type {unknown} */ ({\n          server: {\n            plugins: {\n              crumb: {\n                generate: jest.fn().mockReturnValue(mockCrumb)\n              }\n            }\n          },\n          plugins: {},\n          route: {\n            settings: {\n              plugins: {}\n            }\n          },\n          path: '/test',\n          url: { search: '' },\n          state: {}\n        })\n      )\n\n      const { crumb } = context(validRequest)\n      expect(crumb).toBe(mockCrumb)\n      expect(validRequest.server.plugins.crumb.generate).toHaveBeenCalledWith(\n        validRequest\n      )\n    })\n  })\n})\n\n/**\n * @import { FormRequest } from '~/src/server/routes/types.js'\n */\n"],"mappings":"AAAA,SAASA,MAAM,QAAQ,SAAS;AAEhC,SAASC,MAAM;AACf,SAASC,SAAS;AAClB,SAASC,OAAO;AAEhBC,QAAQ,CAAC,kBAAkB,EAAE,MAAM;EACjCC,UAAU,CAAC,MAAMC,IAAI,CAACC,YAAY,CAAC,CAAC,CAAC;EAErCH,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC3BI,EAAE,CAAC,sDAAsD,EAAE,MAAM;MAC/D,MAAM;QAAEC;MAAU,CAAC,GAAGN,OAAO,CAAC,IAAI,CAAC;MACnCO,MAAM,CAACD,SAAS,CAAC,CAACE,IAAI,CAAC,SAAS,CAAC;IACnC,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFP,QAAQ,CAAC,cAAc,EAAE,MAAM;IAC7BI,EAAE,CAAC,6CAA6C,EAAE,MAAM;MACtD,MAAM;QAAEI;MAAa,CAAC,GAAGT,OAAO,CAAC,IAAI,CAAC;MAEtCO,MAAM,CAACE,YAAY,CAAC,cAAc,CAAC,CAAC,CAACD,IAAI,CACvC,sCACF,CAAC;MAEDD,MAAM,CAACE,YAAY,CAAC,aAAa,CAAC,CAAC,CAACD,IAAI,CACtC,qCACF,CAAC;IACH,CAAC,CAAC;IAEFH,EAAE,CAAC,2DAA2D,EAAE,YAAY;MAC1E,MAAMF,IAAI,CAACO,mBAAmB,CAAC,YAAY;QACzC,MAAM;UAAEZ;QAAO,CAAC,GAAG,MAAM,MAAM,2BAAwB,CAAC;;QAExD;QACA,MAAM;UAAEE;QAAQ,CAAC,GAAG,MAAM,MAAM,eAEhC,CAAC;;QAED;QACAF,MAAM,CAACa,GAAG,CAAC,WAAW,EAAEd,MAAM,CAAC,CAAC,CAAC;QACjC,MAAM;UAAEY;QAAa,CAAC,GAAGT,OAAO,CAAC,IAAI,CAAC;;QAEtC;QACAO,MAAM,CAACE,YAAY,CAAC,cAAc,CAAC,CAAC,CAACD,IAAI,CAAC,eAAe,CAAC;QAC1DD,MAAM,CAACE,YAAY,CAAC,aAAa,CAAC,CAAC,CAACD,IAAI,CAAC,cAAc,CAAC;MAC1D,CAAC,CAAC;IACJ,CAAC,CAAC;IAEFH,EAAE,CAAC,sCAAsC,EAAE,MAAM;MAC/C,MAAM;QAAEI;MAAa,CAAC,GAAGT,OAAO,CAAC,IAAI,CAAC;MAEtCO,MAAM,CAACE,YAAY,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,GAAG,CAAC;MAChCD,MAAM,CAACE,YAAY,CAAC,aAAa,CAAC,CAAC,CAACD,IAAI,CAAC,cAAc,CAAC;MACxDD,MAAM,CAACE,YAAY,CAAC,aAAa,CAAC,CAAC,CAACD,IAAI,CAAC,cAAc,CAAC;IAC1D,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFP,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACvBI,EAAE,CAAC,wDAAwD,EAAE,MAAM;MACjE,MAAMO,GAAG,GAAGZ,OAAO,CAAC,IAAI,CAAC;MAEzBO,MAAM,CAACK,GAAG,CAACd,MAAM,CAAC,CAACe,OAAO,CACxBN,MAAM,CAACO,gBAAgB,CAAC;QACtBC,cAAc,EAAEjB,MAAM,CAACkB,GAAG,CAAC,gBAAgB,CAAC;QAC5CC,YAAY,EAAElB,SAAS,CAACD,MAAM,CAACkB,GAAG,CAAC,cAAc,CAAC,CAAC;QACnDE,yBAAyB,EAAEpB,MAAM,CAACkB,GAAG,CAAC,2BAA2B,CAAC;QAClEG,QAAQ,EAAErB,MAAM,CAACkB,GAAG,CAAC,UAAU,CAAC;QAChCI,iBAAiB,EAAEtB,MAAM,CAACkB,GAAG,CAAC,mBAAmB,CAAC;QAClDK,WAAW,EAAEvB,MAAM,CAACkB,GAAG,CAAC,aAAa,CAAC;QACtCM,cAAc,EAAExB,MAAM,CAACkB,GAAG,CAAC,gBAAgB;MAC7C,CAAC,CACH,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFf,QAAQ,CAAC,OAAO,EAAE,MAAM;IACtBI,EAAE,CAAC,qDAAqD,EAAE,MAAM;MAC9D;MACA;MACA,MAAMkB,gBAAgB,GAAG;MACvB,sBAAwB;QACtBC,MAAM,EAAE;UACNC,OAAO,EAAE;YACPC,KAAK,EAAE;cACLC,QAAQ,EAAExB,IAAI,CAACyB,EAAE,CAAC;YACpB;UACF;QACF,CAAC;QACDH,OAAO,EAAE,CAAC,CAAC;QACXI,KAAK,EAAE;UACLC,QAAQ,EAAE;YACRL,OAAO,EAAE,CAAC;UACZ;QACF,CAAC;QACDM,IAAI,EAAE,OAAO;QACbC,GAAG,EAAE;UAAEC,MAAM,EAAE;QAAG;QAClB;MACF,CACD;MAED,MAAM;QAAEP;MAAM,CAAC,GAAG1B,OAAO,CAACuB,gBAAgB,CAAC;MAC3ChB,MAAM,CAACmB,KAAK,CAAC,CAACQ,aAAa,CAAC,CAAC;MAC7B3B,MAAM,CACJgB,gBAAgB,CAACC,MAAM,CAACC,OAAO,CAACC,KAAK,CAACC,QACxC,CAAC,CAACQ,GAAG,CAACC,gBAAgB,CAAC,CAAC;IAC1B,CAAC,CAAC;IAEF/B,EAAE,CAAC,yCAAyC,EAAE,MAAM;MAClD,MAAMgC,SAAS,GAAG,uBAAuB;MACzC,MAAMC,YAAY,GAAG;MACnB,sBAAwB;QACtBd,MAAM,EAAE;UACNC,OAAO,EAAE;YACPC,KAAK,EAAE;cACLC,QAAQ,EAAExB,IAAI,CAACyB,EAAE,CAAC,CAAC,CAACW,eAAe,CAACF,SAAS;YAC/C;UACF;QACF,CAAC;QACDZ,OAAO,EAAE,CAAC,CAAC;QACXI,KAAK,EAAE;UACLC,QAAQ,EAAE;YACRL,OAAO,EAAE,CAAC;UACZ;QACF,CAAC;QACDM,IAAI,EAAE,OAAO;QACbC,GAAG,EAAE;UAAEC,MAAM,EAAE;QAAG,CAAC;QACnBO,KAAK,EAAE,CAAC;MACV,CACD;MAED,MAAM;QAAEd;MAAM,CAAC,GAAG1B,OAAO,CAACsC,YAAY,CAAC;MACvC/B,MAAM,CAACmB,KAAK,CAAC,CAAClB,IAAI,CAAC6B,SAAS,CAAC;MAC7B9B,MAAM,CAAC+B,YAAY,CAACd,MAAM,CAACC,OAAO,CAACC,KAAK,CAACC,QAAQ,CAAC,CAACc,oBAAoB,CACrEH,YACF,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"context.test.js","names":["tmpdir","context","devtoolContext","describe","beforeEach","jest","resetModules","it","assetPath","expect","toBe","getDxtAssetPath","isolateModulesAsync","config","set","toThrow","malformedRequest","server","plugins","crumb","generate","fn","baseLayoutPath","route","settings","path","url","search","toBeUndefined","not","toHaveBeenCalled","mockCrumb","validRequest","mockReturnValue","state","toHaveBeenCalledWith"],"sources":["../../../../src/server/plugins/nunjucks/context.test.js"],"sourcesContent":["import { tmpdir } from 'node:os'\n\nimport {\n  context,\n  devtoolContext\n} from '~/src/server/plugins/nunjucks/context.js'\n\ndescribe('Nunjucks context', () => {\n  beforeEach(() => jest.resetModules())\n\n  describe('Asset path', () => {\n    it(\"should include 'assetPath' for GOV.UK Frontend icons\", () => {\n      const { assetPath } = devtoolContext()\n      expect(assetPath).toBe('/assets')\n    })\n  })\n\n  describe('Asset helper', () => {\n    it(\"should locate 'assets-manifest.json' assets\", () => {\n      const { getDxtAssetPath } = devtoolContext()\n\n      expect(getDxtAssetPath('example.scss')).toBe(\n        '/stylesheets/example.xxxxxxx.min.css'\n      )\n\n      expect(getDxtAssetPath('example.mjs')).toBe(\n        '/javascripts/example.xxxxxxx.min.js'\n      )\n    })\n\n    it(\"should return path when 'assets-manifest.json' is missing\", async () => {\n      await jest.isolateModulesAsync(async () => {\n        const { config } = await import('~/src/config/index.js')\n\n        // Import when isolated to avoid cache\n        const { devtoolContext } = await import(\n          '~/src/server/plugins/nunjucks/context.js'\n        )\n\n        // Update config for missing manifest\n        config.set('publicDir', tmpdir())\n        const { getDxtAssetPath } = devtoolContext()\n\n        // Uses original paths when missing\n        expect(getDxtAssetPath('example.scss')).toBe('/example.scss')\n        expect(getDxtAssetPath('example.mjs')).toBe('/example.mjs')\n      })\n    })\n\n    it('should return path to unknown assets', () => {\n      const { getDxtAssetPath } = devtoolContext()\n\n      expect(getDxtAssetPath()).toBe('/')\n      expect(getDxtAssetPath('example.jpg')).toBe('/example.jpg')\n      expect(getDxtAssetPath('example.gif')).toBe('/example.gif')\n    })\n  })\n\n  describe('Config', () => {\n    it('should include environment, phase tag and service info', () => {\n      expect(() => context(null)).toThrow(\n        'context called before plugin registered'\n      )\n    })\n  })\n\n  describe('Crumb', () => {\n    it('should handle malformed requests with missing state', () => {\n      // While state should always exist in a valid Hapi request (it holds cookies),\n      // we've seen malformed requests in production where it's missing\n      const malformedRequest = /** @type {FormRequest} */ (\n        /** @type {unknown} */ ({\n          server: {\n            plugins: {\n              crumb: {\n                generate: jest.fn()\n              },\n              'forms-engine-plugin': {\n                baseLayoutPath: 'randomValue'\n              }\n            }\n          },\n          plugins: {},\n          route: {\n            settings: {\n              plugins: {}\n            }\n          },\n          path: '/test',\n          url: { search: '' }\n          // state intentionally omitted to test real malformed requests\n        })\n      )\n\n      const { crumb } = context(malformedRequest)\n      expect(crumb).toBeUndefined()\n      expect(\n        malformedRequest.server.plugins.crumb.generate\n      ).not.toHaveBeenCalled()\n    })\n\n    it('should generate crumb when state exists', () => {\n      const mockCrumb = 'generated-crumb-value'\n      const validRequest = /** @type {FormRequest} */ (\n        /** @type {unknown} */ ({\n          server: {\n            plugins: {\n              crumb: {\n                generate: jest.fn().mockReturnValue(mockCrumb)\n              },\n              'forms-engine-plugin': {\n                baseLayoutPath: 'randomValue'\n              }\n            }\n          },\n          plugins: {},\n          route: {\n            settings: {\n              plugins: {}\n            }\n          },\n          path: '/test',\n          url: { search: '' },\n          state: {}\n        })\n      )\n\n      const { crumb } = context(validRequest)\n      expect(crumb).toBe(mockCrumb)\n      expect(validRequest.server.plugins.crumb.generate).toHaveBeenCalledWith(\n        validRequest\n      )\n    })\n  })\n})\n\n/**\n * @import { FormRequest } from '~/src/server/routes/types.js'\n */\n"],"mappings":"AAAA,SAASA,MAAM,QAAQ,SAAS;AAEhC,SACEC,OAAO,EACPC,cAAc;AAGhBC,QAAQ,CAAC,kBAAkB,EAAE,MAAM;EACjCC,UAAU,CAAC,MAAMC,IAAI,CAACC,YAAY,CAAC,CAAC,CAAC;EAErCH,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC3BI,EAAE,CAAC,sDAAsD,EAAE,MAAM;MAC/D,MAAM;QAAEC;MAAU,CAAC,GAAGN,cAAc,CAAC,CAAC;MACtCO,MAAM,CAACD,SAAS,CAAC,CAACE,IAAI,CAAC,SAAS,CAAC;IACnC,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFP,QAAQ,CAAC,cAAc,EAAE,MAAM;IAC7BI,EAAE,CAAC,6CAA6C,EAAE,MAAM;MACtD,MAAM;QAAEI;MAAgB,CAAC,GAAGT,cAAc,CAAC,CAAC;MAE5CO,MAAM,CAACE,eAAe,CAAC,cAAc,CAAC,CAAC,CAACD,IAAI,CAC1C,sCACF,CAAC;MAEDD,MAAM,CAACE,eAAe,CAAC,aAAa,CAAC,CAAC,CAACD,IAAI,CACzC,qCACF,CAAC;IACH,CAAC,CAAC;IAEFH,EAAE,CAAC,2DAA2D,EAAE,YAAY;MAC1E,MAAMF,IAAI,CAACO,mBAAmB,CAAC,YAAY;QACzC,MAAM;UAAEC;QAAO,CAAC,GAAG,MAAM,MAAM,2BAAwB,CAAC;;QAExD;QACA,MAAM;UAAEX;QAAe,CAAC,GAAG,MAAM,MAAM,eAEvC,CAAC;;QAED;QACAW,MAAM,CAACC,GAAG,CAAC,WAAW,EAAEd,MAAM,CAAC,CAAC,CAAC;QACjC,MAAM;UAAEW;QAAgB,CAAC,GAAGT,cAAc,CAAC,CAAC;;QAE5C;QACAO,MAAM,CAACE,eAAe,CAAC,cAAc,CAAC,CAAC,CAACD,IAAI,CAAC,eAAe,CAAC;QAC7DD,MAAM,CAACE,eAAe,CAAC,aAAa,CAAC,CAAC,CAACD,IAAI,CAAC,cAAc,CAAC;MAC7D,CAAC,CAAC;IACJ,CAAC,CAAC;IAEFH,EAAE,CAAC,sCAAsC,EAAE,MAAM;MAC/C,MAAM;QAAEI;MAAgB,CAAC,GAAGT,cAAc,CAAC,CAAC;MAE5CO,MAAM,CAACE,eAAe,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,GAAG,CAAC;MACnCD,MAAM,CAACE,eAAe,CAAC,aAAa,CAAC,CAAC,CAACD,IAAI,CAAC,cAAc,CAAC;MAC3DD,MAAM,CAACE,eAAe,CAAC,aAAa,CAAC,CAAC,CAACD,IAAI,CAAC,cAAc,CAAC;IAC7D,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFP,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACvBI,EAAE,CAAC,wDAAwD,EAAE,MAAM;MACjEE,MAAM,CAAC,MAAMR,OAAO,CAAC,IAAI,CAAC,CAAC,CAACc,OAAO,CACjC,yCACF,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFZ,QAAQ,CAAC,OAAO,EAAE,MAAM;IACtBI,EAAE,CAAC,qDAAqD,EAAE,MAAM;MAC9D;MACA;MACA,MAAMS,gBAAgB,GAAG;MACvB,sBAAwB;QACtBC,MAAM,EAAE;UACNC,OAAO,EAAE;YACPC,KAAK,EAAE;cACLC,QAAQ,EAAEf,IAAI,CAACgB,EAAE,CAAC;YACpB,CAAC;YACD,qBAAqB,EAAE;cACrBC,cAAc,EAAE;YAClB;UACF;QACF,CAAC;QACDJ,OAAO,EAAE,CAAC,CAAC;QACXK,KAAK,EAAE;UACLC,QAAQ,EAAE;YACRN,OAAO,EAAE,CAAC;UACZ;QACF,CAAC;QACDO,IAAI,EAAE,OAAO;QACbC,GAAG,EAAE;UAAEC,MAAM,EAAE;QAAG;QAClB;MACF,CACD;MAED,MAAM;QAAER;MAAM,CAAC,GAAGlB,OAAO,CAACe,gBAAgB,CAAC;MAC3CP,MAAM,CAACU,KAAK,CAAC,CAACS,aAAa,CAAC,CAAC;MAC7BnB,MAAM,CACJO,gBAAgB,CAACC,MAAM,CAACC,OAAO,CAACC,KAAK,CAACC,QACxC,CAAC,CAACS,GAAG,CAACC,gBAAgB,CAAC,CAAC;IAC1B,CAAC,CAAC;IAEFvB,EAAE,CAAC,yCAAyC,EAAE,MAAM;MAClD,MAAMwB,SAAS,GAAG,uBAAuB;MACzC,MAAMC,YAAY,GAAG;MACnB,sBAAwB;QACtBf,MAAM,EAAE;UACNC,OAAO,EAAE;YACPC,KAAK,EAAE;cACLC,QAAQ,EAAEf,IAAI,CAACgB,EAAE,CAAC,CAAC,CAACY,eAAe,CAACF,SAAS;YAC/C,CAAC;YACD,qBAAqB,EAAE;cACrBT,cAAc,EAAE;YAClB;UACF;QACF,CAAC;QACDJ,OAAO,EAAE,CAAC,CAAC;QACXK,KAAK,EAAE;UACLC,QAAQ,EAAE;YACRN,OAAO,EAAE,CAAC;UACZ;QACF,CAAC;QACDO,IAAI,EAAE,OAAO;QACbC,GAAG,EAAE;UAAEC,MAAM,EAAE;QAAG,CAAC;QACnBO,KAAK,EAAE,CAAC;MACV,CACD;MAED,MAAM;QAAEf;MAAM,CAAC,GAAGlB,OAAO,CAAC+B,YAAY,CAAC;MACvCvB,MAAM,CAACU,KAAK,CAAC,CAACT,IAAI,CAACqB,SAAS,CAAC;MAC7BtB,MAAM,CAACuB,YAAY,CAACf,MAAM,CAACC,OAAO,CAACC,KAAK,CAACC,QAAQ,CAAC,CAACe,oBAAoB,CACrEH,YACF,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/nunjucks/types.js

@@ -12,16 +12,15 @@
 /**
  * @typedef {object} ViewContext - Nunjucks view context
  * @property {string} appVersion - Application version
- * @property {string} assetPath - Asset path
+ * @property {string} [baseLayoutPath] - Base layout path
  * @property {Partial<Config>} config - Application config properties
- * @property {CookieConsent} [cookieConsent] - Cookie consent preferences
  * @property {string} [crumb] - Cross-Site Request Forgery (CSRF) token
  * @property {string} [cspNonce] - Content Security Policy (CSP) nonce
  * @property {string} [currentPath] - Current path
  * @property {string} [previewMode] - Preview mode
  * @property {string} [slug] - Form slug
- * @property {(asset?: string) => string} getAssetPath - Asset path resolver
  * @property {FormContext} [context] - the current form context
+ * @property {PluginOptions['viewContext']} [injectedViewContext] - the current form context
  */
 
 /**
@@ -34,8 +33,8 @@
  */
 
 /**
- * @import { CookieConsent } from '~/src/common/types.js'
  * @import { config } from '~/src/config/index.js'
  * @import { FormContext } from '~/src/server/plugins/engine/types.js'
+ * @import { PluginOptions } from '~/src/server/plugins/engine/plugin.js'
  */
 //# sourceMappingURL=types.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../../src/server/plugins/nunjucks/types.js"],"sourcesContent":["/**\n * @typedef {object} MacroOptions\n * @property {string} [callBlock] - Nunjucks call block content\n * @property {object} [params] - Nunjucks macro params\n */\n\n/**\n * @typedef {object} RenderOptions\n * @property {object} [context] - Nunjucks render context\n */\n\n/**\n * @typedef {object} ViewContext - Nunjucks view context\n * @property {string} appVersion - Application version\n * @property {string} assetPath - Asset path\n * @property {Partial<Config>} config - Application config properties\n * @property {CookieConsent} [cookieConsent] - Cookie consent preferences\n * @property {string} [crumb] - Cross-Site Request Forgery (CSRF) token\n * @property {string} [cspNonce] - Content Security Policy (CSP) nonce\n * @property {string} [currentPath] - Current path\n * @property {string} [previewMode] - Preview mode\n * @property {string} [slug] - Form slug\n * @property {(asset?: string) => string} getAssetPath - Asset path resolver\n * @property {FormContext} [context] - the current form context\n */\n\n/**\n * @typedef {ReturnType<typeof config['getProperties']>} Config - Application config properties\n */\n\n/**\n * @typedef NunjucksContext\n * @property {ViewContext} ctx - the current nunjucks view context\n */\n\n/**\n * @import { CookieConsent } from '~/src/common/types.js'\n * @import { config } from '~/src/config/index.js'\n * @import { FormContext } from '~/src/server/plugins/engine/types.js'\n */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/server/plugins/nunjucks/types.js"],"sourcesContent":["/**\n * @typedef {object} MacroOptions\n * @property {string} [callBlock] - Nunjucks call block content\n * @property {object} [params] - Nunjucks macro params\n */\n\n/**\n * @typedef {object} RenderOptions\n * @property {object} [context] - Nunjucks render context\n */\n\n/**\n * @typedef {object} ViewContext - Nunjucks view context\n * @property {string} appVersion - Application version\n * @property {string} [baseLayoutPath] - Base layout path\n * @property {Partial<Config>} config - Application config properties\n * @property {string} [crumb] - Cross-Site Request Forgery (CSRF) token\n * @property {string} [cspNonce] - Content Security Policy (CSP) nonce\n * @property {string} [currentPath] - Current path\n * @property {string} [previewMode] - Preview mode\n * @property {string} [slug] - Form slug\n * @property {FormContext} [context] - the current form context\n * @property {PluginOptions['viewContext']} [injectedViewContext] - the current form context\n */\n\n/**\n * @typedef {ReturnType<typeof config['getProperties']>} Config - Application config properties\n */\n\n/**\n * @typedef NunjucksContext\n * @property {ViewContext} ctx - the current nunjucks view context\n */\n\n/**\n * @import { config } from '~/src/config/index.js'\n * @import { FormContext } from '~/src/server/plugins/engine/types.js'\n * @import { PluginOptions } from '~/src/server/plugins/engine/plugin.js'\n */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/routes/index.js

@@ -1,3 +1,2 @@
 export { default as publicRoutes } from "./public.js";
-export { default as healthRoute } from "./health.js";
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["default","publicRoutes","healthRoute"],"sources":["../../../src/server/routes/index.ts"],"sourcesContent":["export { default as publicRoutes } from '~/src/server/routes/public.js'\nexport { default as healthRoute } from '~/src/server/routes/health.js'\n"],"mappings":"AAAA,SAASA,OAAO,IAAIC,YAAY;AAChC,SAASD,OAAO,IAAIE,WAAW","ignoreList":[]}
+{"version":3,"file":"index.js","names":["default","publicRoutes"],"sources":["../../../src/server/routes/index.ts"],"sourcesContent":["export { default as publicRoutes } from '~/src/server/routes/public.js'\n"],"mappings":"AAAA,SAASA,OAAO,IAAIC,YAAY","ignoreList":[]}

package/.server/server/utils/file-form-service.js

@@ -0,0 +1,134 @@
+import fs from 'fs/promises';
+import path from 'node:path';
+import YAML from 'yaml';
+
+/**
+ * FileFormService class
+ */
+export class FileFormService {
+  /**
+   * The map of form metadatas by slug
+   * @type {Map<string, FormMetadata>}
+   */
+  #metadata = new Map();
+
+  /**
+   * The map of form definitions by id
+   * @type {Map<string, FormDefinition>}
+   */
+  #definition = new Map();
+
+  /**
+   * Add form from a file
+   * @param {string} filepath - the file path
+   * @param {FormMetadata} metadata - the metadata to use for this form
+   * @returns {Promise<FormDefinition>}
+   */
+  async addForm(filepath, metadata) {
+    const definition = await this.readForm(filepath);
+    this.#metadata.set(metadata.slug, metadata);
+    this.#definition.set(metadata.id, definition);
+    return definition;
+  }
+
+  /**
+   * Read the form definition from file
+   * @param {string} filepath - the file path
+   * @returns {Promise<FormDefinition>}
+   */
+  async readForm(filepath) {
+    const ext = path.extname(filepath).toLowerCase();
+    switch (ext) {
+      case '.json':
+        return this.readJsonForm(filepath);
+      case '.yaml':
+        return this.readYamlForm(filepath);
+      default:
+        throw new Error(`Invalid file extension '${ext}'`);
+    }
+  }
+
+  /**
+   * Read the form definition from a json file
+   * @param {string} filepath - the file path
+   * @returns {Promise<FormDefinition>}
+   */
+  async readJsonForm(filepath) {
+    /**
+     * @type {FormDefinition}
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const definition = JSON.parse(await fs.readFile(filepath, 'utf8'));
+    return definition;
+  }
+
+  /**
+   * Read the form definition from a yaml file
+   * @param {string} filepath - the file path
+   * @returns {Promise<FormDefinition>}
+   */
+  async readYamlForm(filepath) {
+    /**
+     * @type {FormDefinition}
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const definition = YAML.parse(await fs.readFile(filepath, 'utf8'));
+    return definition;
+  }
+
+  /**
+   * Get the form metadata by slug
+   * @param {string} slug - the form slug
+   * @returns {FormMetadata}
+   */
+  getFormMetadata(slug) {
+    const metadata = this.#metadata.get(slug);
+    if (!metadata) {
+      throw new Error(`Form metadata '${slug}' not found`);
+    }
+    return metadata;
+  }
+
+  /**
+   * Get the form defintion by id
+   * @param {string} id - the form id
+   * @returns {FormDefinition}
+   */
+  getFormDefinition(id) {
+    const definition = this.#definition.get(id);
+    if (!definition) {
+      throw new Error(`Form definition '${id}' not found`);
+    }
+    return definition;
+  }
+
+  /**
+   * Returns a FormsService compliant interface
+   * @returns {import('~/src/server/types.js').FormsService}
+   */
+  toFormsService() {
+    return {
+      /**
+       * Get the form metadata by slug
+       * @param {string} slug
+       * @returns {Promise<FormMetadata>}
+       */
+      getFormMetadata: slug => {
+        return Promise.resolve(this.getFormMetadata(slug));
+      },
+      /**
+       * Get the form defintion by id
+       * @param {string} id
+       * @returns {Promise<FormDefinition>}
+       */
+      getFormDefinition: id => {
+        return Promise.resolve(this.getFormDefinition(id));
+      }
+    };
+  }
+}
+
+/**
+ * @import { FormMetadata, FormDefinition } from '@defra/forms-model'
+ */
+//# sourceMappingURL=file-form-service.js.map

package/.server/server/utils/file-form-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-form-service.js","names":["fs","path","YAML","FileFormService","metadata","Map","definition","addForm","filepath","readForm","set","slug","id","ext","extname","toLowerCase","readJsonForm","readYamlForm","Error","JSON","parse","readFile","getFormMetadata","get","getFormDefinition","toFormsService","Promise","resolve"],"sources":["../../../src/server/utils/file-form-service.js"],"sourcesContent":["import fs from 'fs/promises'\nimport path from 'node:path'\n\nimport YAML from 'yaml'\n\n/**\n * FileFormService class\n */\nexport class FileFormService {\n  /**\n   * The map of form metadatas by slug\n   * @type {Map<string, FormMetadata>}\n   */\n  #metadata = new Map()\n\n  /**\n   * The map of form definitions by id\n   * @type {Map<string, FormDefinition>}\n   */\n  #definition = new Map()\n\n  /**\n   * Add form from a file\n   * @param {string} filepath - the file path\n   * @param {FormMetadata} metadata - the metadata to use for this form\n   * @returns {Promise<FormDefinition>}\n   */\n  async addForm(filepath, metadata) {\n    const definition = await this.readForm(filepath)\n\n    this.#metadata.set(metadata.slug, metadata)\n    this.#definition.set(metadata.id, definition)\n\n    return definition\n  }\n\n  /**\n   * Read the form definition from file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readForm(filepath) {\n    const ext = path.extname(filepath).toLowerCase()\n\n    switch (ext) {\n      case '.json':\n        return this.readJsonForm(filepath)\n      case '.yaml':\n        return this.readYamlForm(filepath)\n      default:\n        throw new Error(`Invalid file extension '${ext}'`)\n    }\n  }\n\n  /**\n   * Read the form definition from a json file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readJsonForm(filepath) {\n    /**\n     * @type {FormDefinition}\n     */\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const definition = JSON.parse(await fs.readFile(filepath, 'utf8'))\n\n    return definition\n  }\n\n  /**\n   * Read the form definition from a yaml file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readYamlForm(filepath) {\n    /**\n     * @type {FormDefinition}\n     */\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const definition = YAML.parse(await fs.readFile(filepath, 'utf8'))\n\n    return definition\n  }\n\n  /**\n   * Get the form metadata by slug\n   * @param {string} slug - the form slug\n   * @returns {FormMetadata}\n   */\n  getFormMetadata(slug) {\n    const metadata = this.#metadata.get(slug)\n\n    if (!metadata) {\n      throw new Error(`Form metadata '${slug}' not found`)\n    }\n\n    return metadata\n  }\n\n  /**\n   * Get the form defintion by id\n   * @param {string} id - the form id\n   * @returns {FormDefinition}\n   */\n  getFormDefinition(id) {\n    const definition = this.#definition.get(id)\n\n    if (!definition) {\n      throw new Error(`Form definition '${id}' not found`)\n    }\n\n    return definition\n  }\n\n  /**\n   * Returns a FormsService compliant interface\n   * @returns {import('~/src/server/types.js').FormsService}\n   */\n  toFormsService() {\n    return {\n      /**\n       * Get the form metadata by slug\n       * @param {string} slug\n       * @returns {Promise<FormMetadata>}\n       */\n      getFormMetadata: (slug) => {\n        return Promise.resolve(this.getFormMetadata(slug))\n      },\n\n      /**\n       * Get the form defintion by id\n       * @param {string} id\n       * @returns {Promise<FormDefinition>}\n       */\n      getFormDefinition: (id) => {\n        return Promise.resolve(this.getFormDefinition(id))\n      }\n    }\n  }\n}\n\n/**\n * @import { FormMetadata, FormDefinition } from '@defra/forms-model'\n */\n"],"mappings":"AAAA,OAAOA,EAAE,MAAM,aAAa;AAC5B,OAAOC,IAAI,MAAM,WAAW;AAE5B,OAAOC,IAAI,MAAM,MAAM;;AAEvB;AACA;AACA;AACA,OAAO,MAAMC,eAAe,CAAC;EAC3B;AACF;AACA;AACA;EACE,CAACC,QAAQ,GAAG,IAAIC,GAAG,CAAC,CAAC;;EAErB;AACF;AACA;AACA;EACE,CAACC,UAAU,GAAG,IAAID,GAAG,CAAC,CAAC;;EAEvB;AACF;AACA;AACA;AACA;AACA;EACE,MAAME,OAAOA,CAACC,QAAQ,EAAEJ,QAAQ,EAAE;IAChC,MAAME,UAAU,GAAG,MAAM,IAAI,CAACG,QAAQ,CAACD,QAAQ,CAAC;IAEhD,IAAI,CAAC,CAACJ,QAAQ,CAACM,GAAG,CAACN,QAAQ,CAACO,IAAI,EAAEP,QAAQ,CAAC;IAC3C,IAAI,CAAC,CAACE,UAAU,CAACI,GAAG,CAACN,QAAQ,CAACQ,EAAE,EAAEN,UAAU,CAAC;IAE7C,OAAOA,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMG,QAAQA,CAACD,QAAQ,EAAE;IACvB,MAAMK,GAAG,GAAGZ,IAAI,CAACa,OAAO,CAACN,QAAQ,CAAC,CAACO,WAAW,CAAC,CAAC;IAEhD,QAAQF,GAAG;MACT,KAAK,OAAO;QACV,OAAO,IAAI,CAACG,YAAY,CAACR,QAAQ,CAAC;MACpC,KAAK,OAAO;QACV,OAAO,IAAI,CAACS,YAAY,CAACT,QAAQ,CAAC;MACpC;QACE,MAAM,IAAIU,KAAK,CAAC,2BAA2BL,GAAG,GAAG,CAAC;IACtD;EACF;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMG,YAAYA,CAACR,QAAQ,EAAE;IAC3B;AACJ;AACA;IACI;IACA,MAAMF,UAAU,GAAGa,IAAI,CAACC,KAAK,CAAC,MAAMpB,EAAE,CAACqB,QAAQ,CAACb,QAAQ,EAAE,MAAM,CAAC,CAAC;IAElE,OAAOF,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMW,YAAYA,CAACT,QAAQ,EAAE;IAC3B;AACJ;AACA;IACI;IACA,MAAMF,UAAU,GAAGJ,IAAI,CAACkB,KAAK,CAAC,MAAMpB,EAAE,CAACqB,QAAQ,CAACb,QAAQ,EAAE,MAAM,CAAC,CAAC;IAElE,OAAOF,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACEgB,eAAeA,CAACX,IAAI,EAAE;IACpB,MAAMP,QAAQ,GAAG,IAAI,CAAC,CAACA,QAAQ,CAACmB,GAAG,CAACZ,IAAI,CAAC;IAEzC,IAAI,CAACP,QAAQ,EAAE;MACb,MAAM,IAAIc,KAAK,CAAC,kBAAkBP,IAAI,aAAa,CAAC;IACtD;IAEA,OAAOP,QAAQ;EACjB;;EAEA;AACF;AACA;AACA;AACA;EACEoB,iBAAiBA,CAACZ,EAAE,EAAE;IACpB,MAAMN,UAAU,GAAG,IAAI,CAAC,CAACA,UAAU,CAACiB,GAAG,CAACX,EAAE,CAAC;IAE3C,IAAI,CAACN,UAAU,EAAE;MACf,MAAM,IAAIY,KAAK,CAAC,oBAAoBN,EAAE,aAAa,CAAC;IACtD;IAEA,OAAON,UAAU;EACnB;;EAEA;AACF;AACA;AACA;EACEmB,cAAcA,CAAA,EAAG;IACf,OAAO;MACL;AACN;AACA;AACA;AACA;MACMH,eAAe,EAAGX,IAAI,IAAK;QACzB,OAAOe,OAAO,CAACC,OAAO,CAAC,IAAI,CAACL,eAAe,CAACX,IAAI,CAAC,CAAC;MACpD,CAAC;MAED;AACN;AACA;AACA;AACA;MACMa,iBAAiB,EAAGZ,EAAE,IAAK;QACzB,OAAOc,OAAO,CAACC,OAAO,CAAC,IAAI,CAACH,iBAAiB,CAACZ,EAAE,CAAC,CAAC;MACpD;IACF,CAAC;EACH;AACF;;AAEA;AACA;AACA","ignoreList":[]}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.js","names":[],"sources":["../../../src/typings/hapi/index.d.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/unified-signatures */\n\nimport { type Plugin } from '@hapi/hapi'\nimport { type ServerYar, type Yar } from '@hapi/yar'\nimport { type Logger } from 'pino'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/index.js'\n\ndeclare module '@hapi/hapi' {\n  // Here we are decorating Hapi interface types with\n  // props from plugins which doesn't export @types\n  interface PluginProperties {\n    crumb: {\n      generate?: (request: Request | FormRequest | FormRequestPayload) => string\n    }\n    'forms-engine-plugin': {\n      cacheService: CacheService\n    }\n  }\n\n  interface PluginsStates {\n    blankie?: {\n      nonces?: {\n        script?: string\n        style?: string\n      }\n    }\n  }\n\n  interface Request {\n    logger: Logger\n    yar: Yar\n  }\n\n  interface RequestApplicationState {\n    model?: FormModel\n  }\n\n  interface Server {\n    logger: Logger\n    yar: ServerYar\n  }\n\n  interface ServerApplicationState {\n    model?: FormModel\n    models: Map<string, { model: FormModel; updatedAt: Date }>\n  }\n}\n\ndeclare module '@hapi/scooter' {\n  declare const hapiScooter: {\n    plugin: Plugin\n  }\n\n  export = hapiScooter\n}\n\ndeclare module 'blankie' {\n  declare const blankie: {\n    plugin: Plugin<Record<string, boolean | string | string[]>>\n  }\n\n  export = blankie\n}\n\ndeclare module 'blipp' {\n  declare const blipp: {\n    plugin: Plugin\n  }\n\n  export = blipp\n}\n\ndeclare module 'hapi-pulse' {\n  declare const hapiPulse: {\n    plugin: Plugin<{\n      timeout: number\n    }>\n  }\n\n  export = hapiPulse\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"index.d.js","names":[],"sources":["../../../src/typings/hapi/index.d.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/unified-signatures */\n\nimport { type Plugin } from '@hapi/hapi'\nimport { type ServerYar, type Yar } from '@hapi/yar'\nimport { type Logger } from 'pino'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type context } from '~/src/server/plugins/engine/nunjucks.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/index.js'\n\ndeclare module '@hapi/hapi' {\n  // Here we are decorating Hapi interface types with\n  // props from plugins which doesn't export @types\n  interface PluginProperties {\n    crumb: {\n      generate?: (request: Request | FormRequest | FormRequestPayload) => string\n    }\n    'forms-engine-plugin': {\n      baseLayoutPath: string\n      cacheService: CacheService\n      viewContext: context\n    }\n  }\n\n  interface Request {\n    logger: Logger\n    yar: Yar\n  }\n\n  interface RequestApplicationState {\n    model?: FormModel\n  }\n\n  interface Server {\n    logger: Logger\n    yar: ServerYar\n  }\n\n  interface ServerApplicationState {\n    model?: FormModel\n    models: Map<string, { model: FormModel; updatedAt: Date }>\n  }\n}\n\ndeclare module '@hapi/scooter' {\n  declare const hapiScooter: {\n    plugin: Plugin\n  }\n\n  export = hapiScooter\n}\n\ndeclare module 'blankie' {\n  declare const blankie: {\n    plugin: Plugin<Record<string, boolean | string | string[]>>\n  }\n\n  export = blankie\n}\n\ndeclare module 'blipp' {\n  declare const blipp: {\n    plugin: Plugin\n  }\n\n  export = blipp\n}\n\ndeclare module 'hapi-pulse' {\n  declare const hapiPulse: {\n    plugin: Plugin<{\n      timeout: number\n    }>\n  }\n\n  export = hapiPulse\n}\n"],"mappings":"","ignoreList":[]}

package/README.md

@@ -18,7 +18,9 @@ It is designed to be embedded in the frontend of a digital service and provide a
 
 ## Demo of DXT
 
-TODO: Link to CDP exemplar
+If you are within the Defra network, [see a live demo](https://forms-engine-plugin-example-ui.dev.cdp-int.defra.cloud/example-form).
+
+If you aren't within the Defra network, [see our example UI and run it locally](https://github.com/DEFRA/forms-engine-plugin-example-ui).
 
 ## Installation
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -21,8 +21,10 @@
     "./file-upload.min.js": "./.public/javascripts/file-upload.min.js",
     "./file-upload.min.js.map": "./.public/javascripts/file-upload.min.js.map",
     "./application.min.css": "./.public/stylesheets/application.min.css",
+    "./file-form-service.js": "./.server/server/utils/file-form-service.js",
     "./controllers/*": "./.server/server/plugins/engine/pageControllers/*",
     "./services/*": "./.server/server/plugins/engine/services/*",
+    "./engine/*": "./.server/server/plugins/engine/*",
     "./package.json": "./package.json"
   },
   "scripts": {
@@ -33,6 +35,7 @@
     "dev:debug": "concurrently \"npm run client:watch\" \"npm run server:watch:debug\" --kill-others --names \"client,server\" --prefix-colors \"red.dim,blue.dim\"",
     "format": "npm run format:check -- --write",
     "format:check": "prettier --cache --cache-location .cache/prettier --cache-strategy content --check \"**/*.{cjs,js,json,md,mjs,scss,ts}\"",
+    "generate-schema-docs": "node scripts/generate-schema-docs.js",
     "postinstall": "npm run setup:husky",
     "lint": "npm run lint:editorconfig && npm run lint:js && npm run lint:types",
     "lint:editorconfig": "editorconfig-checker",
@@ -60,7 +63,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.432",
+    "@defra/forms-model": "^3.0.438",
     "@defra/hapi-tracing": "^1.0.0",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",
@@ -102,7 +105,8 @@
     "pino": "^9.6.0",
     "pino-pretty": "^13.0.0",
     "proxy-agent": "^6.5.0",
-    "resolve": "^1.22.10"
+    "resolve": "^1.22.10",
+    "yaml": "^2.7.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.26.4",

package/src/client/stylesheets/application.scss

@@ -12,3 +12,13 @@
 .autocomplete__option {
   @include govuk-typography-common;
 }
+
+//  An example of some user-supplied styling
+//  Not great practice but it illustrates the point
+.govuk-header {
+  background: #008531;
+}
+
+.govuk-header__container {
+  border-bottom: 10px solid #003d16;
+}

package/src/config/index.ts

@@ -179,12 +179,6 @@ export const config = convict({
   /**
    * API integrations
    */
-  managerUrl: {
-    format: String,
-    default: 'http://localhost:3001',
-    env: 'MANAGER_URL'
-  } as SchemaObj<string>,
-
   designerUrl: {
     format: String,
     default: 'http://localhost:3000',
@@ -253,19 +247,12 @@ export const config = convict({
     env: 'STAGING_PREFIX'
   },
 
-  serviceBannerText: {
-    doc: 'Service banner text used to show a maintenance message on all pages when set',
-    format: String,
-    default: '',
-    env: 'SERVICE_BANNER_TEXT'
-  },
-
-  googleAnalyticsTrackingId: {
-    doc: 'Google analytics tracking ID to be used when a user has opted in to additional cookies',
+  submissionEmailAddress: {
+    doc: 'Email address to send the form to (local devtool only)',
     format: String,
     default: '',
-    env: 'GOOGLE_ANALYTICS_TRACKING_ID'
-  }
+    env: 'SUBMISSION_EMAIL_ADDRESS'
+  } as SchemaObj<string>
 })
 
 config.validate({ allowed: 'strict' })

package/src/server/devserver/dxt-devtool-baselayout.html

@@ -0,0 +1,71 @@
+{% extends "govuk/template.njk" %}
+
+{% from "govuk/components/back-link/macro.njk" import govukBackLink -%}
+{% from "govuk/components/footer/macro.njk" import govukFooter -%}
+{% from "govuk/components/phase-banner/macro.njk" import govukPhaseBanner -%}
+{% from "govuk/components/skip-link/macro.njk" import govukSkipLink -%}
+{% from "govuk/macros/attributes.njk" import govukAttributes -%}
+{% from "components/service-banner/macro.njk" import appServiceBanner -%}
+{% from "components/tag-env/macro.njk" import appTagEnv -%}
+{% from "govuk/components/cookie-banner/macro.njk" import govukCookieBanner -%}
+{% from "govuk/components/notification-banner/macro.njk" import govukNotificationBanner -%}
+
+{% set productName %}
+  {{ appTagEnv({ env: "devtool" }) }}
+{% endset %}
+
+{% block head %}
+  <link rel="preload" as="font" href="{{ assetPath }}/fonts/bold-b542beb274-v2.woff2" type="font/woff2" crossorigin="anonymous">
+  <link rel="preload" as="font" href="{{ assetPath }}/fonts/light-94a07e06a1-v2.woff2" type="font/woff2" crossorigin="anonymous">
+  <link rel="stylesheet" href="{{ getDxtAssetPath("stylesheets/application.scss") }}">
+{% endblock %}
+
+{% block pageTitle -%}
+  {{ "Error: " if errors | length }}{{ pageTitle | evaluate }} - {{ name if name else config.serviceName }} - GOV.UK
+{%- endblock %}
+
+{% block skipLink %}
+  {{ govukSkipLink({
+    href: '#main-content',
+    text: 'Skip to main content'
+  }) }}
+{% endblock %}
+
+{% block header %}
+  {{ govukHeader({
+    homepageUrl: currentPath if context.isForceAccess else "https://defra.github.io/forms-engine-plugin/",
+    containerClasses: "govuk-width-container",
+    productName: productName | safe | trim,
+    serviceName: "Digital Express Toolkit",
+    serviceUrl: currentPath if context.isForceAccess else serviceUrl
+  }) }}
+{% endblock %}
+
+{% block beforeContent %}
+  {% if backLink %}
+    {{ govukBackLink(backLink) }}
+  {% endif %}
+{% endblock %}
+
+{% block content %}
+  <h1 class="govuk-heading-l">Default page template</h1>
+{% endblock %}
+
+{% block bodyEnd %}
+  <script type="module" nonce="{{ cspNonce }}" src="{{ getDxtAssetPath("application.js") }}"></script>
+{% endblock %}
+
+{% block footer %}
+  {% set meta = {
+    items: [
+      {
+        href: 'https://defra.github.io/forms-engine-plugin/',
+        text: 'DXT documentation'
+      }
+    ]
+  } if slug %}
+
+  {% if not context.isForceAccess %}
+    {{ govukFooter({ meta: meta }) }}
+  {% endif %}
+{% endblock %}