@defra/forms-engine-plugin 0.1.10 → 0.1.11

package/.server/server/forms/register-as-a-unicorn-breeder.yaml

@@ -0,0 +1,251 @@
+---
+name: Register as a unicorn breeder
+pages:
+  - path: '/whats-your-name'
+    title: What's your name?
+    components:
+      - type: TextField
+        name: textField
+        title: Name
+        hint:
+          This is a single line text box. We use it to ask for information that's
+          likely to be 1 sentence
+        options:
+          required: true
+        schema: {}
+    next:
+      - path: '/whats-your-email-address'
+    section: section
+  - title: Summary
+    path: '/summary'
+    controller: './pages/summary.js'
+    components: []
+    next: []
+  - path: '/whats-your-email-address'
+    title: What's your email address?
+    components:
+      - name: MaTzaT
+        options:
+          required: true
+        type: EmailAddressField
+        title: Email adress
+        schema: {}
+        hint: This is an email address. An email address must contain an at sign @
+    next:
+      - path: '/whats-your-phone-number'
+    section: section
+  - path: '/whats-your-phone-number'
+    title: What's your phone number?
+    components:
+      - name: BdKgCe
+        options:
+          required: true
+        type: TelephoneNumberField
+        title: Phone number
+        schema: {}
+        hint:
+          This is a telephone number. This field can only contain numbers and the
+          + symbol
+    next:
+      - path: '/whats-your-address'
+    section: section
+  - path: '/whats-your-address'
+    title: What's your address?
+    components:
+      - name: wZLWPy
+        options:
+          required: true
+        type: UkAddressField
+        title: Address
+        schema: {}
+        hint: This is a UK address. Users must enter address line 1, town and a postcode
+    next:
+      - path: '/do-you-want-your-unicorn-breeder-certificate-sent-to-this-address'
+    section: section
+  - path: '/do-you-want-your-unicorn-breeder-certificate-sent-to-this-address'
+    title: Do you want your unicorn breeder certificate sent to this address?
+    components:
+      - name: dBfuID
+        options: {}
+        type: YesNoField
+        title: Send certificate to same address
+        schema: {}
+        hint:
+          This is a yes or no question. We can branch to different questions based
+          on the answer
+        values:
+          type: listRef
+    next:
+      - path: '/what-address-do-you-want-the-certificate-sent-to'
+        condition: oyGPwP
+      - path: '/when-does-your-unicorn-insurance-policy-start'
+        condition: ''
+    section: section
+  - path: '/what-address-do-you-want-the-certificate-sent-to'
+    title: What address do you want the certificate sent to?
+    components:
+      - name: AegFro
+        options: {}
+        type: UkAddressField
+        title: Address to send certificate
+        schema: {}
+        hint:
+          This is a simple branch to an extra question - it's shown to users who select
+          'no' when asked if this is the address where the certificate should be sent
+    next:
+      - path: '/when-does-your-unicorn-insurance-policy-start'
+    section: section
+  - title: When does your unicorn insurance policy start?
+    path: '/when-does-your-unicorn-insurance-policy-start'
+    section: Regnsa
+    next:
+      - path: '/upload-your-insurance-certificate'
+    components:
+      - name: mjAccr
+        options: {}
+        type: DatePartsField
+        title: Unicorn insurance policy start date
+        schema: {}
+        hint:
+          This is a date. We can add custom validation to the field based on your
+          requirements. For example, the date entered must be before or after a certain
+          date
+  - title: How many unicorns do you expect to breed each year?
+    path: '/how-many-unicorns-do-you-expect-to-breed-each-year'
+    section: susaYr
+    next:
+      - path: '/what-type-of-unicorns-will-you-breed'
+    components:
+      - name: aitzzV
+        options: {}
+        type: RadiosField
+        list: IeFOkf
+        title: Number of unicorns
+        schema: {}
+        hint: This is a radio button. Users can only select one option from the list
+        values:
+          type: listRef
+  - title: What type of unicorns will you breed?
+    path: '/what-type-of-unicorns-will-you-breed'
+    section: susaYr
+    next:
+      - path: '/where-will-you-keep-the-unicorns'
+    components:
+      - name: DyfjJC
+        options: {}
+        type: CheckboxesField
+        list: fXiZrL
+        title: Type of unicorn
+        schema: {}
+        hint: This is a check box. Users can select more than one option
+        values:
+          type: listRef
+  - title: Where will you keep the unicorns?
+    path: '/where-will-you-keep-the-unicorns'
+    section: susaYr
+    next:
+      - path: '/how-many-members-of-staff-will-look-after-the-unicorns'
+    components:
+      - name: bClCvo
+        options: {}
+        schema: {}
+        type: MultilineTextField
+        title: Where you keep the unicorn
+        hint:
+          This is a multi-line text box. We use it when you expect the response to
+          be more than 1 sentence long
+  - title: How many members of staff will look after the unicorns?
+    path: '/how-many-members-of-staff-will-look-after-the-unicorns'
+    section: susaYr
+    next:
+      - path: '/summary'
+    components:
+      - name: zhJMaM
+        options:
+          classes: govuk-!-width-one-quarter
+        type: NumberField
+        title: Number of staff
+        schema: {}
+        hint:
+          This is a number field. The answer must be a number. We can use custom validation
+          to set decimal places, minimum and maximum values
+  - title: Upload your insurance certificate
+    path: '/upload-your-insurance-certificate'
+    controller: FileUploadPageController
+    section: Regnsa
+    next:
+      - path: '/how-many-unicorns-do-you-expect-to-breed-each-year'
+    components:
+      - name: dLzALM
+        title: Documents
+        type: FileUploadField
+        hint: We can specify the format and number of uploaded files
+        options:
+          required: false
+        schema:
+          min: 1
+          max: 3
+conditions:
+  - displayName: Address is different
+    name: IrVmYz
+    value:
+      name: Address is different
+      conditions:
+        - field:
+            name: dBfuID
+            type: YesNoField
+            display: 'Contact details: Send certificate to same address'
+          operator: is
+          value:
+            type: Value
+            value: 'false'
+            display: 'false'
+  - displayName: Address is not the same
+    name: oyGPwP
+    value:
+      name: Address is not the same
+      conditions:
+        - field:
+            name: dBfuID
+            type: YesNoField
+            display: 'Contact details: Send certificate to same address'
+          operator: is
+          value:
+            type: Value
+            value: 'false'
+            display: 'No'
+sections:
+  - name: section
+    title: Contact details
+    hideTitle: false
+  - title: Unicorn details
+    name: susaYr
+    hideTitle: false
+  - title: Insurance details
+    name: Regnsa
+    hideTitle: false
+lists:
+  - title: number of unicorns
+    name: IeFOkf
+    type: string
+    items:
+      - text: 1 to 5
+        value: 1 to 5
+      - text: 6 to 10
+        value: 6 to 10
+      - text: 11 or more
+        value: 11 or more
+  - title: Type of unicorn
+    name: fXiZrL
+    type: string
+    items:
+      - text: Flying
+        value: Flying
+      - text: Fire breathing
+        value: Fire breathing
+      - text: Aquatic
+        value: Aquatic
+      - text: Rainbow
+        value: Rainbow
+outputEmail: defraforms@defra.gov.uk
+startPage: '/whats-your-name'

package/.server/server/index.js

@@ -10,14 +10,13 @@ import { config } from "../config/index.js";
 import { requestLogger } from "./common/helpers/logging/request-logger.js";
 import { requestTracing } from "./common/helpers/logging/request-tracing.js";
 import { buildRedisClient } from "./common/helpers/redis-client.js";
-import { configureBlankiePlugin } from "./plugins/blankie.js";
 import { configureCrumbPlugin } from "./plugins/crumb.js";
-import { configureEnginePlugin } from "./plugins/engine/index.js";
+import { configureEnginePlugin } from "./plugins/engine/configureEnginePlugin.js";
 import pluginErrorPages from "./plugins/errorPages.js";
 import { plugin as pluginViews } from "./plugins/nunjucks/index.js";
 import pluginPulse from "./plugins/pulse.js";
-import pluginRouter from "./plugins/router.js";
 import pluginSession from "./plugins/session.js";
+import { publicRoutes } from "./routes/index.js";
 import { prepareSecureContext } from "./secure-context.js";
 const proxyAgent = new ProxyAgent();
 Wreck.agents = {
@@ -66,14 +65,12 @@ export async function createServer(routeConfig) {
   if (config.get('isProduction')) {
     prepareSecureContext(server);
   }
-  const pluginEngine = await configureEnginePlugin(routeConfig);
   const pluginCrumb = configureCrumbPlugin(routeConfig);
-  const pluginBlankie = configureBlankiePlugin();
+  const pluginEngine = await configureEnginePlugin(routeConfig);
   await server.register(pluginSession);
   await server.register(pluginPulse);
   await server.register(inert);
   await server.register(Scooter);
-  await server.register(pluginBlankie);
   await server.register(pluginCrumb);
   server.ext('onPreResponse', (request, h) => {
     const {
@@ -94,19 +91,17 @@ export async function createServer(routeConfig) {
   });
   await server.register(pluginViews);
   await server.register(pluginEngine);
-  await server.register(pluginRouter);
+  await server.register({
+    plugin: {
+      name: 'router',
+      register: server => {
+        server.route(publicRoutes);
+      }
+    }
+  });
   await server.register(pluginErrorPages);
   await server.register(blipp);
   await server.register(requestTracing);
-  server.state('cookieConsent', {
-    ttl: 365 * 24 * 60 * 60 * 1000,
-    // 1 year in ms
-    clearInvalid: true,
-    isHttpOnly: false,
-    isSecure: config.get('isProduction'),
-    path: '/',
-    encoding: 'none' // handle this inside the application so we can share frontend/backend cookie modification
-  });
   return server;
 }
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Engine","CatboxMemory","CatboxRedis","hapi","inert","Scooter","Wreck","blipp","ProxyAgent","config","requestLogger","requestTracing","buildRedisClient","configureBlankiePlugin","configureCrumbPlugin","configureEnginePlugin","pluginErrorPages","plugin","pluginViews","pluginPulse","pluginRouter","pluginSession","prepareSecureContext","proxyAgent","agents","https","http","httpsAllowUnauthorized","serverOptions","debug","request","get","port","router","stripTrailingSlash","routes","validate","options","abortEarly","security","hsts","maxAge","includeSubDomains","preload","xss","noSniff","xframe","cache","name","engine","client","createServer","routeConfig","server","register","pluginEngine","pluginCrumb","pluginBlankie","ext","h","response","continue","header","path","startsWith","state","ttl","clearInvalid","isHttpOnly","isSecure","encoding"],"sources":["../../src/server/index.ts"],"sourcesContent":["import { Engine as CatboxMemory } from '@hapi/catbox-memory'\nimport { Engine as CatboxRedis } from '@hapi/catbox-redis'\nimport hapi, {\n  type Request,\n  type ResponseToolkit,\n  type ServerOptions\n} from '@hapi/hapi'\nimport inert from '@hapi/inert'\nimport Scooter from '@hapi/scooter'\nimport Wreck from '@hapi/wreck'\nimport blipp from 'blipp'\nimport { ProxyAgent } from 'proxy-agent'\n\nimport { config } from '~/src/config/index.js'\nimport { requestLogger } from '~/src/server/common/helpers/logging/request-logger.js'\nimport { requestTracing } from '~/src/server/common/helpers/logging/request-tracing.js'\nimport { buildRedisClient } from '~/src/server/common/helpers/redis-client.js'\nimport { configureBlankiePlugin } from '~/src/server/plugins/blankie.js'\nimport { configureCrumbPlugin } from '~/src/server/plugins/crumb.js'\nimport { configureEnginePlugin } from '~/src/server/plugins/engine/index.js'\nimport pluginErrorPages from '~/src/server/plugins/errorPages.js'\nimport { plugin as pluginViews } from '~/src/server/plugins/nunjucks/index.js'\nimport pluginPulse from '~/src/server/plugins/pulse.js'\nimport pluginRouter from '~/src/server/plugins/router.js'\nimport pluginSession from '~/src/server/plugins/session.js'\nimport { prepareSecureContext } from '~/src/server/secure-context.js'\nimport { type RouteConfig } from '~/src/server/types.js'\n\nconst proxyAgent = new ProxyAgent()\n\nWreck.agents = {\n  https: proxyAgent,\n  http: proxyAgent,\n  httpsAllowUnauthorized: proxyAgent\n}\n\nconst serverOptions = (): ServerOptions => {\n  const serverOptions: ServerOptions = {\n    debug: { request: [`${config.get('isDevelopment')}`] },\n    port: config.get('port'),\n    router: {\n      stripTrailingSlash: true\n    },\n    routes: {\n      validate: {\n        options: {\n          abortEarly: false\n        }\n      },\n      security: {\n        hsts: {\n          maxAge: 31536000,\n          includeSubDomains: true,\n          preload: false\n        },\n        xss: 'enabled',\n        noSniff: true,\n        xframe: true\n      }\n    },\n    cache: [\n      {\n        name: 'session',\n        engine: config.get('isTest')\n          ? new CatboxMemory()\n          : new CatboxRedis({\n              client: buildRedisClient()\n            })\n      }\n    ]\n  }\n\n  return serverOptions\n}\n\nexport async function createServer(routeConfig?: RouteConfig) {\n  const server = hapi.server(serverOptions())\n\n  await server.register(requestLogger)\n\n  if (config.get('isProduction')) {\n    prepareSecureContext(server)\n  }\n\n  const pluginEngine = await configureEnginePlugin(routeConfig)\n  const pluginCrumb = configureCrumbPlugin(routeConfig)\n  const pluginBlankie = configureBlankiePlugin()\n\n  await server.register(pluginSession)\n  await server.register(pluginPulse)\n  await server.register(inert)\n  await server.register(Scooter)\n  await server.register(pluginBlankie)\n  await server.register(pluginCrumb)\n\n  server.ext('onPreResponse', (request: Request, h: ResponseToolkit) => {\n    const { response } = request\n\n    if ('isBoom' in response) {\n      return h.continue\n    }\n\n    // Prevent search engine indexing\n    response.header('x-robots-tag', 'noindex, nofollow')\n\n    // Disable cache to ensure back/foward navigation updates progress\n    if (\n      !request.path.startsWith('/javascripts/') &&\n      !request.path.startsWith('/stylesheets/') &&\n      !request.path.startsWith('/assets/')\n    ) {\n      response.header('cache-control', 'no-store')\n    }\n\n    return h.continue\n  })\n\n  await server.register(pluginViews)\n  await server.register(pluginEngine)\n  await server.register(pluginRouter)\n  await server.register(pluginErrorPages)\n  await server.register(blipp)\n  await server.register(requestTracing)\n\n  server.state('cookieConsent', {\n    ttl: 365 * 24 * 60 * 60 * 1000, // 1 year in ms\n    clearInvalid: true,\n    isHttpOnly: false,\n    isSecure: config.get('isProduction'),\n    path: '/',\n    encoding: 'none' // handle this inside the application so we can share frontend/backend cookie modification\n  })\n\n  return server\n}\n"],"mappings":"AAAA,SAASA,MAAM,IAAIC,YAAY,QAAQ,qBAAqB;AAC5D,SAASD,MAAM,IAAIE,WAAW,QAAQ,oBAAoB;AAC1D,OAAOC,IAAI,MAIJ,YAAY;AACnB,OAAOC,KAAK,MAAM,aAAa;AAC/B,OAAOC,OAAO,MAAM,eAAe;AACnC,OAAOC,KAAK,MAAM,aAAa;AAC/B,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,UAAU,QAAQ,aAAa;AAExC,SAASC,MAAM;AACf,SAASC,aAAa;AACtB,SAASC,cAAc;AACvB,SAASC,gBAAgB;AACzB,SAASC,sBAAsB;AAC/B,SAASC,oBAAoB;AAC7B,SAASC,qBAAqB;AAC9B,OAAOC,gBAAgB;AACvB,SAASC,MAAM,IAAIC,WAAW;AAC9B,OAAOC,WAAW;AAClB,OAAOC,YAAY;AACnB,OAAOC,aAAa;AACpB,SAASC,oBAAoB;AAG7B,MAAMC,UAAU,GAAG,IAAIf,UAAU,CAAC,CAAC;AAEnCF,KAAK,CAACkB,MAAM,GAAG;EACbC,KAAK,EAAEF,UAAU;EACjBG,IAAI,EAAEH,UAAU;EAChBI,sBAAsB,EAAEJ;AAC1B,CAAC;AAED,MAAMK,aAAa,GAAGA,CAAA,KAAqB;EACzC,MAAMA,aAA4B,GAAG;IACnCC,KAAK,EAAE;MAAEC,OAAO,EAAE,CAAC,GAAGrB,MAAM,CAACsB,GAAG,CAAC,eAAe,CAAC,EAAE;IAAE,CAAC;IACtDC,IAAI,EAAEvB,MAAM,CAACsB,GAAG,CAAC,MAAM,CAAC;IACxBE,MAAM,EAAE;MACNC,kBAAkB,EAAE;IACtB,CAAC;IACDC,MAAM,EAAE;MACNC,QAAQ,EAAE;QACRC,OAAO,EAAE;UACPC,UAAU,EAAE;QACd;MACF,CAAC;MACDC,QAAQ,EAAE;QACRC,IAAI,EAAE;UACJC,MAAM,EAAE,QAAQ;UAChBC,iBAAiB,EAAE,IAAI;UACvBC,OAAO,EAAE;QACX,CAAC;QACDC,GAAG,EAAE,SAAS;QACdC,OAAO,EAAE,IAAI;QACbC,MAAM,EAAE;MACV;IACF,CAAC;IACDC,KAAK,EAAE,CACL;MACEC,IAAI,EAAE,SAAS;MACfC,MAAM,EAAExC,MAAM,CAACsB,GAAG,CAAC,QAAQ,CAAC,GACxB,IAAI9B,YAAY,CAAC,CAAC,GAClB,IAAIC,WAAW,CAAC;QACdgD,MAAM,EAAEtC,gBAAgB,CAAC;MAC3B,CAAC;IACP,CAAC;EAEL,CAAC;EAED,OAAOgB,aAAa;AACtB,CAAC;AAED,OAAO,eAAeuB,YAAYA,CAACC,WAAyB,EAAE;EAC5D,MAAMC,MAAM,GAAGlD,IAAI,CAACkD,MAAM,CAACzB,aAAa,CAAC,CAAC,CAAC;EAE3C,MAAMyB,MAAM,CAACC,QAAQ,CAAC5C,aAAa,CAAC;EAEpC,IAAID,MAAM,CAACsB,GAAG,CAAC,cAAc,CAAC,EAAE;IAC9BT,oBAAoB,CAAC+B,MAAM,CAAC;EAC9B;EAEA,MAAME,YAAY,GAAG,MAAMxC,qBAAqB,CAACqC,WAAW,CAAC;EAC7D,MAAMI,WAAW,GAAG1C,oBAAoB,CAACsC,WAAW,CAAC;EACrD,MAAMK,aAAa,GAAG5C,sBAAsB,CAAC,CAAC;EAE9C,MAAMwC,MAAM,CAACC,QAAQ,CAACjC,aAAa,CAAC;EACpC,MAAMgC,MAAM,CAACC,QAAQ,CAACnC,WAAW,CAAC;EAClC,MAAMkC,MAAM,CAACC,QAAQ,CAAClD,KAAK,CAAC;EAC5B,MAAMiD,MAAM,CAACC,QAAQ,CAACjD,OAAO,CAAC;EAC9B,MAAMgD,MAAM,CAACC,QAAQ,CAACG,aAAa,CAAC;EACpC,MAAMJ,MAAM,CAACC,QAAQ,CAACE,WAAW,CAAC;EAElCH,MAAM,CAACK,GAAG,CAAC,eAAe,EAAE,CAAC5B,OAAgB,EAAE6B,CAAkB,KAAK;IACpE,MAAM;MAAEC;IAAS,CAAC,GAAG9B,OAAO;IAE5B,IAAI,QAAQ,IAAI8B,QAAQ,EAAE;MACxB,OAAOD,CAAC,CAACE,QAAQ;IACnB;;IAEA;IACAD,QAAQ,CAACE,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC;;IAEpD;IACA,IACE,CAAChC,OAAO,CAACiC,IAAI,CAACC,UAAU,CAAC,eAAe,CAAC,IACzC,CAAClC,OAAO,CAACiC,IAAI,CAACC,UAAU,CAAC,eAAe,CAAC,IACzC,CAAClC,OAAO,CAACiC,IAAI,CAACC,UAAU,CAAC,UAAU,CAAC,EACpC;MACAJ,QAAQ,CAACE,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC;IAC9C;IAEA,OAAOH,CAAC,CAACE,QAAQ;EACnB,CAAC,CAAC;EAEF,MAAMR,MAAM,CAACC,QAAQ,CAACpC,WAAW,CAAC;EAClC,MAAMmC,MAAM,CAACC,QAAQ,CAACC,YAAY,CAAC;EACnC,MAAMF,MAAM,CAACC,QAAQ,CAAClC,YAAY,CAAC;EACnC,MAAMiC,MAAM,CAACC,QAAQ,CAACtC,gBAAgB,CAAC;EACvC,MAAMqC,MAAM,CAACC,QAAQ,CAAC/C,KAAK,CAAC;EAC5B,MAAM8C,MAAM,CAACC,QAAQ,CAAC3C,cAAc,CAAC;EAErC0C,MAAM,CAACY,KAAK,CAAC,eAAe,EAAE;IAC5BC,GAAG,EAAE,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;IAAE;IAChCC,YAAY,EAAE,IAAI;IAClBC,UAAU,EAAE,KAAK;IACjBC,QAAQ,EAAE5D,MAAM,CAACsB,GAAG,CAAC,cAAc,CAAC;IACpCgC,IAAI,EAAE,GAAG;IACTO,QAAQ,EAAE,MAAM,CAAC;EACnB,CAAC,CAAC;EAEF,OAAOjB,MAAM;AACf","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Engine","CatboxMemory","CatboxRedis","hapi","inert","Scooter","Wreck","blipp","ProxyAgent","config","requestLogger","requestTracing","buildRedisClient","configureCrumbPlugin","configureEnginePlugin","pluginErrorPages","plugin","pluginViews","pluginPulse","pluginSession","publicRoutes","prepareSecureContext","proxyAgent","agents","https","http","httpsAllowUnauthorized","serverOptions","debug","request","get","port","router","stripTrailingSlash","routes","validate","options","abortEarly","security","hsts","maxAge","includeSubDomains","preload","xss","noSniff","xframe","cache","name","engine","client","createServer","routeConfig","server","register","pluginCrumb","pluginEngine","ext","h","response","continue","header","path","startsWith","route"],"sources":["../../src/server/index.ts"],"sourcesContent":["import { Engine as CatboxMemory } from '@hapi/catbox-memory'\nimport { Engine as CatboxRedis } from '@hapi/catbox-redis'\nimport hapi, {\n  type Request,\n  type ResponseToolkit,\n  type ServerOptions\n} from '@hapi/hapi'\nimport inert from '@hapi/inert'\nimport Scooter from '@hapi/scooter'\nimport Wreck from '@hapi/wreck'\nimport blipp from 'blipp'\nimport { ProxyAgent } from 'proxy-agent'\n\nimport { config } from '~/src/config/index.js'\nimport { requestLogger } from '~/src/server/common/helpers/logging/request-logger.js'\nimport { requestTracing } from '~/src/server/common/helpers/logging/request-tracing.js'\nimport { buildRedisClient } from '~/src/server/common/helpers/redis-client.js'\nimport { configureCrumbPlugin } from '~/src/server/plugins/crumb.js'\nimport { configureEnginePlugin } from '~/src/server/plugins/engine/configureEnginePlugin.js'\nimport pluginErrorPages from '~/src/server/plugins/errorPages.js'\nimport { plugin as pluginViews } from '~/src/server/plugins/nunjucks/index.js'\nimport pluginPulse from '~/src/server/plugins/pulse.js'\nimport pluginSession from '~/src/server/plugins/session.js'\nimport { publicRoutes } from '~/src/server/routes/index.js'\nimport { prepareSecureContext } from '~/src/server/secure-context.js'\nimport { type RouteConfig } from '~/src/server/types.js'\n\nconst proxyAgent = new ProxyAgent()\n\nWreck.agents = {\n  https: proxyAgent,\n  http: proxyAgent,\n  httpsAllowUnauthorized: proxyAgent\n}\n\nconst serverOptions = (): ServerOptions => {\n  const serverOptions: ServerOptions = {\n    debug: { request: [`${config.get('isDevelopment')}`] },\n    port: config.get('port'),\n    router: {\n      stripTrailingSlash: true\n    },\n    routes: {\n      validate: {\n        options: {\n          abortEarly: false\n        }\n      },\n      security: {\n        hsts: {\n          maxAge: 31536000,\n          includeSubDomains: true,\n          preload: false\n        },\n        xss: 'enabled',\n        noSniff: true,\n        xframe: true\n      }\n    },\n    cache: [\n      {\n        name: 'session',\n        engine: config.get('isTest')\n          ? new CatboxMemory()\n          : new CatboxRedis({\n              client: buildRedisClient()\n            })\n      }\n    ]\n  }\n\n  return serverOptions\n}\n\nexport async function createServer(routeConfig?: RouteConfig) {\n  const server = hapi.server(serverOptions())\n\n  await server.register(requestLogger)\n\n  if (config.get('isProduction')) {\n    prepareSecureContext(server)\n  }\n\n  const pluginCrumb = configureCrumbPlugin(routeConfig)\n  const pluginEngine = await configureEnginePlugin(routeConfig)\n\n  await server.register(pluginSession)\n  await server.register(pluginPulse)\n  await server.register(inert)\n  await server.register(Scooter)\n  await server.register(pluginCrumb)\n\n  server.ext('onPreResponse', (request: Request, h: ResponseToolkit) => {\n    const { response } = request\n\n    if ('isBoom' in response) {\n      return h.continue\n    }\n\n    // Prevent search engine indexing\n    response.header('x-robots-tag', 'noindex, nofollow')\n\n    // Disable cache to ensure back/foward navigation updates progress\n    if (\n      !request.path.startsWith('/javascripts/') &&\n      !request.path.startsWith('/stylesheets/') &&\n      !request.path.startsWith('/assets/')\n    ) {\n      response.header('cache-control', 'no-store')\n    }\n\n    return h.continue\n  })\n\n  await server.register(pluginViews)\n  await server.register(pluginEngine)\n\n  await server.register({\n    plugin: {\n      name: 'router',\n      register: (server) => {\n        server.route(publicRoutes)\n      }\n    }\n  })\n\n  await server.register(pluginErrorPages)\n  await server.register(blipp)\n  await server.register(requestTracing)\n\n  return server\n}\n"],"mappings":"AAAA,SAASA,MAAM,IAAIC,YAAY,QAAQ,qBAAqB;AAC5D,SAASD,MAAM,IAAIE,WAAW,QAAQ,oBAAoB;AAC1D,OAAOC,IAAI,MAIJ,YAAY;AACnB,OAAOC,KAAK,MAAM,aAAa;AAC/B,OAAOC,OAAO,MAAM,eAAe;AACnC,OAAOC,KAAK,MAAM,aAAa;AAC/B,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,UAAU,QAAQ,aAAa;AAExC,SAASC,MAAM;AACf,SAASC,aAAa;AACtB,SAASC,cAAc;AACvB,SAASC,gBAAgB;AACzB,SAASC,oBAAoB;AAC7B,SAASC,qBAAqB;AAC9B,OAAOC,gBAAgB;AACvB,SAASC,MAAM,IAAIC,WAAW;AAC9B,OAAOC,WAAW;AAClB,OAAOC,aAAa;AACpB,SAASC,YAAY;AACrB,SAASC,oBAAoB;AAG7B,MAAMC,UAAU,GAAG,IAAId,UAAU,CAAC,CAAC;AAEnCF,KAAK,CAACiB,MAAM,GAAG;EACbC,KAAK,EAAEF,UAAU;EACjBG,IAAI,EAAEH,UAAU;EAChBI,sBAAsB,EAAEJ;AAC1B,CAAC;AAED,MAAMK,aAAa,GAAGA,CAAA,KAAqB;EACzC,MAAMA,aAA4B,GAAG;IACnCC,KAAK,EAAE;MAAEC,OAAO,EAAE,CAAC,GAAGpB,MAAM,CAACqB,GAAG,CAAC,eAAe,CAAC,EAAE;IAAE,CAAC;IACtDC,IAAI,EAAEtB,MAAM,CAACqB,GAAG,CAAC,MAAM,CAAC;IACxBE,MAAM,EAAE;MACNC,kBAAkB,EAAE;IACtB,CAAC;IACDC,MAAM,EAAE;MACNC,QAAQ,EAAE;QACRC,OAAO,EAAE;UACPC,UAAU,EAAE;QACd;MACF,CAAC;MACDC,QAAQ,EAAE;QACRC,IAAI,EAAE;UACJC,MAAM,EAAE,QAAQ;UAChBC,iBAAiB,EAAE,IAAI;UACvBC,OAAO,EAAE;QACX,CAAC;QACDC,GAAG,EAAE,SAAS;QACdC,OAAO,EAAE,IAAI;QACbC,MAAM,EAAE;MACV;IACF,CAAC;IACDC,KAAK,EAAE,CACL;MACEC,IAAI,EAAE,SAAS;MACfC,MAAM,EAAEvC,MAAM,CAACqB,GAAG,CAAC,QAAQ,CAAC,GACxB,IAAI7B,YAAY,CAAC,CAAC,GAClB,IAAIC,WAAW,CAAC;QACd+C,MAAM,EAAErC,gBAAgB,CAAC;MAC3B,CAAC;IACP,CAAC;EAEL,CAAC;EAED,OAAOe,aAAa;AACtB,CAAC;AAED,OAAO,eAAeuB,YAAYA,CAACC,WAAyB,EAAE;EAC5D,MAAMC,MAAM,GAAGjD,IAAI,CAACiD,MAAM,CAACzB,aAAa,CAAC,CAAC,CAAC;EAE3C,MAAMyB,MAAM,CAACC,QAAQ,CAAC3C,aAAa,CAAC;EAEpC,IAAID,MAAM,CAACqB,GAAG,CAAC,cAAc,CAAC,EAAE;IAC9BT,oBAAoB,CAAC+B,MAAM,CAAC;EAC9B;EAEA,MAAME,WAAW,GAAGzC,oBAAoB,CAACsC,WAAW,CAAC;EACrD,MAAMI,YAAY,GAAG,MAAMzC,qBAAqB,CAACqC,WAAW,CAAC;EAE7D,MAAMC,MAAM,CAACC,QAAQ,CAAClC,aAAa,CAAC;EACpC,MAAMiC,MAAM,CAACC,QAAQ,CAACnC,WAAW,CAAC;EAClC,MAAMkC,MAAM,CAACC,QAAQ,CAACjD,KAAK,CAAC;EAC5B,MAAMgD,MAAM,CAACC,QAAQ,CAAChD,OAAO,CAAC;EAC9B,MAAM+C,MAAM,CAACC,QAAQ,CAACC,WAAW,CAAC;EAElCF,MAAM,CAACI,GAAG,CAAC,eAAe,EAAE,CAAC3B,OAAgB,EAAE4B,CAAkB,KAAK;IACpE,MAAM;MAAEC;IAAS,CAAC,GAAG7B,OAAO;IAE5B,IAAI,QAAQ,IAAI6B,QAAQ,EAAE;MACxB,OAAOD,CAAC,CAACE,QAAQ;IACnB;;IAEA;IACAD,QAAQ,CAACE,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC;;IAEpD;IACA,IACE,CAAC/B,OAAO,CAACgC,IAAI,CAACC,UAAU,CAAC,eAAe,CAAC,IACzC,CAACjC,OAAO,CAACgC,IAAI,CAACC,UAAU,CAAC,eAAe,CAAC,IACzC,CAACjC,OAAO,CAACgC,IAAI,CAACC,UAAU,CAAC,UAAU,CAAC,EACpC;MACAJ,QAAQ,CAACE,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC;IAC9C;IAEA,OAAOH,CAAC,CAACE,QAAQ;EACnB,CAAC,CAAC;EAEF,MAAMP,MAAM,CAACC,QAAQ,CAACpC,WAAW,CAAC;EAClC,MAAMmC,MAAM,CAACC,QAAQ,CAACE,YAAY,CAAC;EAEnC,MAAMH,MAAM,CAACC,QAAQ,CAAC;IACpBrC,MAAM,EAAE;MACN+B,IAAI,EAAE,QAAQ;MACdM,QAAQ,EAAGD,MAAM,IAAK;QACpBA,MAAM,CAACW,KAAK,CAAC3C,YAAY,CAAC;MAC5B;IACF;EACF,CAAC,CAAC;EAEF,MAAMgC,MAAM,CAACC,QAAQ,CAACtC,gBAAgB,CAAC;EACvC,MAAMqC,MAAM,CAACC,QAAQ,CAAC9C,KAAK,CAAC;EAC5B,MAAM6C,MAAM,CAACC,QAAQ,CAAC1C,cAAc,CAAC;EAErC,OAAOyC,MAAM;AACf","ignoreList":[]}

package/.server/server/plugins/engine/configureEnginePlugin.js

@@ -1,6 +1,10 @@
 import { join, parse } from 'node:path';
 import { FormModel } from "./models/FormModel.js";
 import { plugin } from "./plugin.js";
+import { findPackageRoot } from "./plugin.js";
+import * as defaultServices from "./services/index.js";
+import { formsService } from "./services/localFormsService.js";
+import { devtoolContext } from "../nunjucks/context.js";
 export const configureEnginePlugin = async ({
   formFileName,
   formFilePath,
@@ -21,8 +25,18 @@ export const configureEnginePlugin = async ({
     plugin,
     options: {
       model,
-      services,
-      controllers
+      services: services ?? {
+        // services for testing, else use the disk loader option for running this service locally
+        ...defaultServices,
+        formsService: await formsService()
+      },
+      controllers,
+      cacheName: 'session',
+      nunjucks: {
+        baseLayoutPath: 'dxt-devtool-baselayout.html',
+        paths: [join(findPackageRoot(), 'src/server/devserver')] // custom layout to make it really clear this is not the same as the runner
+      },
+      viewContext: devtoolContext
     }
   };
 };

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

@@ -1 +1 @@
-{"version":3,"file":"configureEnginePlugin.js","names":["join","parse","FormModel","plugin","configureEnginePlugin","formFileName","formFilePath","services","controllers","model","definition","getForm","name","basePath","options","importPath","ext","attributes","type","formImport","with","default"],"sources":["../../../../src/server/plugins/engine/configureEnginePlugin.ts"],"sourcesContent":["import { join, parse } from 'node:path'\n\nimport { type FormDefinition } from '@defra/forms-model'\nimport { type ServerRegisterPluginObject } from '@hapi/hapi'\n\nimport { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport {\n  plugin,\n  type PluginOptions\n} from '~/src/server/plugins/engine/plugin.js'\nimport { type RouteConfig } from '~/src/server/types.js'\n\nexport const configureEnginePlugin = async ({\n  formFileName,\n  formFilePath,\n  services,\n  controllers\n}: RouteConfig = {}): Promise<ServerRegisterPluginObject<PluginOptions>> => {\n  let model: FormModel | undefined\n\n  if (formFileName && formFilePath) {\n    const definition = await getForm(join(formFilePath, formFileName))\n    const { name } = parse(formFileName)\n\n    model = new FormModel(definition, { basePath: name }, services, controllers)\n  }\n\n  return {\n    plugin,\n    options: { model, services, controllers }\n  }\n}\n\nexport async function getForm(importPath: string) {\n  const { ext } = parse(importPath)\n\n  const attributes: ImportAttributes = {\n    type: ext === '.json' ? 'json' : 'module'\n  }\n\n  const formImport = import(importPath, { with: attributes }) as Promise<{\n    default: FormDefinition\n  }>\n\n  const { default: definition } = await formImport\n  return definition\n}\n"],"mappings":"AAAA,SAASA,IAAI,EAAEC,KAAK,QAAQ,WAAW;AAKvC,SAASC,SAAS;AAClB,SACEC,MAAM;AAKR,OAAO,MAAMC,qBAAqB,GAAG,MAAAA,CAAO;EAC1CC,YAAY;EACZC,YAAY;EACZC,QAAQ;EACRC;AACW,CAAC,GAAG,CAAC,CAAC,KAAyD;EAC1E,IAAIC,KAA4B;EAEhC,IAAIJ,YAAY,IAAIC,YAAY,EAAE;IAChC,MAAMI,UAAU,GAAG,MAAMC,OAAO,CAACX,IAAI,CAACM,YAAY,EAAED,YAAY,CAAC,CAAC;IAClE,MAAM;MAAEO;IAAK,CAAC,GAAGX,KAAK,CAACI,YAAY,CAAC;IAEpCI,KAAK,GAAG,IAAIP,SAAS,CAACQ,UAAU,EAAE;MAAEG,QAAQ,EAAED;IAAK,CAAC,EAAEL,QAAQ,EAAEC,WAAW,CAAC;EAC9E;EAEA,OAAO;IACLL,MAAM;IACNW,OAAO,EAAE;MAAEL,KAAK;MAAEF,QAAQ;MAAEC;IAAY;EAC1C,CAAC;AACH,CAAC;AAED,OAAO,eAAeG,OAAOA,CAACI,UAAkB,EAAE;EAChD,MAAM;IAAEC;EAAI,CAAC,GAAGf,KAAK,CAACc,UAAU,CAAC;EAEjC,MAAME,UAA4B,GAAG;IACnCC,IAAI,EAAEF,GAAG,KAAK,OAAO,GAAG,MAAM,GAAG;EACnC,CAAC;EAED,MAAMG,UAAU,GAAG,MAAM,CAACJ,UAAU,EAAE;IAAEK,IAAI,EAAEH;EAAW,CAAC,CAExD;EAEF,MAAM;IAAEI,OAAO,EAAEX;EAAW,CAAC,GAAG,MAAMS,UAAU;EAChD,OAAOT,UAAU;AACnB","ignoreList":[]}
+{"version":3,"file":"configureEnginePlugin.js","names":["join","parse","FormModel","plugin","findPackageRoot","defaultServices","formsService","devtoolContext","configureEnginePlugin","formFileName","formFilePath","services","controllers","model","definition","getForm","name","basePath","options","cacheName","nunjucks","baseLayoutPath","paths","viewContext","importPath","ext","attributes","type","formImport","with","default"],"sources":["../../../../src/server/plugins/engine/configureEnginePlugin.ts"],"sourcesContent":["import { join, parse } from 'node:path'\n\nimport { type FormDefinition } from '@defra/forms-model'\nimport { type ServerRegisterPluginObject } from '@hapi/hapi'\n\nimport { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport {\n  plugin,\n  type PluginOptions\n} from '~/src/server/plugins/engine/plugin.js'\nimport { findPackageRoot } from '~/src/server/plugins/engine/plugin.js'\nimport * as defaultServices from '~/src/server/plugins/engine/services/index.js'\nimport { formsService } from '~/src/server/plugins/engine/services/localFormsService.js'\nimport { devtoolContext } from '~/src/server/plugins/nunjucks/context.js'\nimport { type RouteConfig } from '~/src/server/types.js'\n\nexport const configureEnginePlugin = async ({\n  formFileName,\n  formFilePath,\n  services,\n  controllers\n}: RouteConfig = {}): Promise<ServerRegisterPluginObject<PluginOptions>> => {\n  let model: FormModel | undefined\n\n  if (formFileName && formFilePath) {\n    const definition = await getForm(join(formFilePath, formFileName))\n    const { name } = parse(formFileName)\n\n    model = new FormModel(definition, { basePath: name }, services, controllers)\n  }\n\n  return {\n    plugin,\n    options: {\n      model,\n      services: services ?? {\n        // services for testing, else use the disk loader option for running this service locally\n        ...defaultServices,\n        formsService: await formsService()\n      },\n      controllers,\n      cacheName: 'session',\n      nunjucks: {\n        baseLayoutPath: 'dxt-devtool-baselayout.html',\n        paths: [join(findPackageRoot(), 'src/server/devserver')] // custom layout to make it really clear this is not the same as the runner\n      },\n      viewContext: devtoolContext\n    }\n  }\n}\n\nexport async function getForm(importPath: string) {\n  const { ext } = parse(importPath)\n\n  const attributes: ImportAttributes = {\n    type: ext === '.json' ? 'json' : 'module'\n  }\n\n  const formImport = import(importPath, { with: attributes }) as Promise<{\n    default: FormDefinition\n  }>\n\n  const { default: definition } = await formImport\n  return definition\n}\n"],"mappings":"AAAA,SAASA,IAAI,EAAEC,KAAK,QAAQ,WAAW;AAKvC,SAASC,SAAS;AAClB,SACEC,MAAM;AAGR,SAASC,eAAe;AACxB,OAAO,KAAKC,eAAe;AAC3B,SAASC,YAAY;AACrB,SAASC,cAAc;AAGvB,OAAO,MAAMC,qBAAqB,GAAG,MAAAA,CAAO;EAC1CC,YAAY;EACZC,YAAY;EACZC,QAAQ;EACRC;AACW,CAAC,GAAG,CAAC,CAAC,KAAyD;EAC1E,IAAIC,KAA4B;EAEhC,IAAIJ,YAAY,IAAIC,YAAY,EAAE;IAChC,MAAMI,UAAU,GAAG,MAAMC,OAAO,CAACf,IAAI,CAACU,YAAY,EAAED,YAAY,CAAC,CAAC;IAClE,MAAM;MAAEO;IAAK,CAAC,GAAGf,KAAK,CAACQ,YAAY,CAAC;IAEpCI,KAAK,GAAG,IAAIX,SAAS,CAACY,UAAU,EAAE;MAAEG,QAAQ,EAAED;IAAK,CAAC,EAAEL,QAAQ,EAAEC,WAAW,CAAC;EAC9E;EAEA,OAAO;IACLT,MAAM;IACNe,OAAO,EAAE;MACPL,KAAK;MACLF,QAAQ,EAAEA,QAAQ,IAAI;QACpB;QACA,GAAGN,eAAe;QAClBC,YAAY,EAAE,MAAMA,YAAY,CAAC;MACnC,CAAC;MACDM,WAAW;MACXO,SAAS,EAAE,SAAS;MACpBC,QAAQ,EAAE;QACRC,cAAc,EAAE,6BAA6B;QAC7CC,KAAK,EAAE,CAACtB,IAAI,CAACI,eAAe,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC;MAC3D,CAAC;MACDmB,WAAW,EAAEhB;IACf;EACF,CAAC;AACH,CAAC;AAED,OAAO,eAAeQ,OAAOA,CAACS,UAAkB,EAAE;EAChD,MAAM;IAAEC;EAAI,CAAC,GAAGxB,KAAK,CAACuB,UAAU,CAAC;EAEjC,MAAME,UAA4B,GAAG;IACnCC,IAAI,EAAEF,GAAG,KAAK,OAAO,GAAG,MAAM,GAAG;EACnC,CAAC;EAED,MAAMG,UAAU,GAAG,MAAM,CAACJ,UAAU,EAAE;IAAEK,IAAI,EAAEH;EAAW,CAAC,CAExD;EAEF,MAAM;IAAEI,OAAO,EAAEhB;EAAW,CAAC,GAAG,MAAMc,UAAU;EAChD,OAAOd,UAAU;AACnB","ignoreList":[]}

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

@@ -1,12 +1,16 @@
+import { existsSync } from 'fs';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
 import { hasFormComponents, slugSchema } from '@defra/forms-model';
 import Boom from '@hapi/boom';
 import vision from '@hapi/vision';
 import { isEqual } from 'date-fns';
 import Joi from 'joi';
 import nunjucks from 'nunjucks';
+import resolvePkg from 'resolve';
 import { PREVIEW_PATH_PREFIX } from "../../constants.js";
 import { checkEmailAddressForLiveFormSubmission, checkFormStatus, findPage, getCacheService, getPage, getStartPath, normalisePath, proceed, redirectPath } from "./helpers.js";
-import { PLUGIN_PATH, VIEW_PATH, context, prepareNunjucksEnvironment } from "./index.js";
+import { VIEW_PATH, context, prepareNunjucksEnvironment } from "./index.js";
 import { FormModel, SummaryViewModel } from "./models/index.js";
 import { format } from "./outputFormatters/machine/v1.js";
 import { FileUploadPageController } from "./pageControllers/FileUploadPageController.js";
@@ -18,6 +22,18 @@ import { getUploadStatus } from "./services/uploadService.js";
 import { actionSchema, confirmSchema, crumbSchema, itemIdSchema, pathSchema, stateSchema } from "../../schemas/index.js";
 import * as httpService from "../../services/httpService.js";
 import { CacheService } from "../../services/index.js";
+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');
+}
 export const plugin = {
   name: '@defra/forms-engine-plugin',
   dependencies: ['@hapi/crumb', '@hapi/yar', 'hapi-pino'],
@@ -28,25 +44,18 @@ export const plugin = {
       services = defaultServices,
       controllers,
       cacheName,
-      viewPaths,
       filters,
-      pluginPath = PLUGIN_PATH
+      nunjucks: nunjucksOptions,
+      viewContext
     } = options;
     const {
       formsService
     } = services;
     const cacheService = new CacheService(server, cacheName);
-
-    // Paths array to tell `vision` and `nunjucks` where template files are stored.
-    // We need to include `VIEW_PATH` in addition the runtime path (node_modules)
-    // to keep the local tests working
-    const path = [`${pluginPath}/${VIEW_PATH}`, VIEW_PATH];
-
-    // Include any additional user provided view paths so our internal views engine
-    // can find any files they provide from the consumer side if using custom `page.view`s
-    if (Array.isArray(viewPaths) && viewPaths.length) {
-      path.push(...viewPaths);
-    }
+    const packageRoot = findPackageRoot();
+    const govukFrontendPath = dirname(resolvePkg.sync('govuk-frontend/package.json'));
+    const viewPathResolved = join(packageRoot, VIEW_PATH);
+    const paths = [...nunjucksOptions.paths, viewPathResolved, join(govukFrontendPath, 'dist')];
     await server.register({
       plugin: vision,
       options: {
@@ -61,7 +70,7 @@ export const plugin = {
             prepare: (options, next) => {
               // Nunjucks also needs an additional path configuration
               // to use the templates and macros from `govuk-frontend`
-              const environment = nunjucks.configure([...path, 'node_modules/govuk-frontend/dist']);
+              const environment = nunjucks.configure(paths);
 
               // Applies custom filters and globals for nunjucks
               // that are required by the `forms-engine-plugin`
@@ -71,11 +80,13 @@ export const plugin = {
             }
           }
         },
-        path,
+        path: paths,
         // Provides global context used with all templates
         context
       }
     });
+    server.expose('baseLayoutPath', nunjucksOptions.baseLayoutPath);
+    server.expose('viewContext', viewContext);
     server.expose('cacheService', cacheService);
     server.app.model = model;