@defra/forms-engine-plugin 0.1.10 → 0.1.11

package/src/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,7 +33,7 @@
  */
 
 /**
- * @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'
  */

package/src/server/routes/index.ts

@@ -1,2 +1 @@
 export { default as publicRoutes } from '~/src/server/routes/public.js'
-export { default as healthRoute } from '~/src/server/routes/health.js'

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

@@ -5,6 +5,7 @@ import { type ServerYar, type Yar } from '@hapi/yar'
 import { type Logger } from 'pino'
 
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
+import { type context } from '~/src/server/plugins/engine/nunjucks.js'
 import {
   type FormRequest,
   type FormRequestPayload
@@ -19,16 +20,9 @@ declare module '@hapi/hapi' {
       generate?: (request: Request | FormRequest | FormRequestPayload) => string
     }
     'forms-engine-plugin': {
+      baseLayoutPath: string
       cacheService: CacheService
-    }
-  }
-
-  interface PluginsStates {
-    blankie?: {
-      nonces?: {
-        script?: string
-        style?: string
-      }
+      viewContext: context
     }
   }
 

package/.server/common/cookies.js

@@ -1,55 +0,0 @@
-/**
-  @type {CookieConsent}
- */
-export const defaultConsent = {
-  analytics: null,
-  dismissed: false
-};
-
-/**
- * Parses the cookie consent policy
- * @param {string} value
- */
-export function parseCookieConsent(value) {
-  /** @type {CookieConsent} */
-  let cookieConsent;
-  try {
-    const encodedValue = decodeURIComponent(value);
-
-    // eslint-disable-next-line -- Allow JSON type 'any'
-    const decodedValue = JSON.parse(encodedValue);
-    if (isValidConsent(decodedValue)) {
-      cookieConsent = decodedValue;
-    } else {
-      cookieConsent = defaultConsent;
-    }
-  } catch {
-    cookieConsent = defaultConsent;
-  }
-  return cookieConsent;
-}
-
-/**
- * Serialises the cookie consent policy
- * @param {CookieConsent} consent
- * @returns {string} cookie value
- */
-export function serialiseCookieConsent(consent) {
-  return encodeURIComponent(JSON.stringify(consent));
-}
-
-/**
- * @param {unknown} consent
- * @returns {consent is CookieConsent}
- */
-function isValidConsent(consent) {
-  if (consent === null || Array.isArray(consent)) {
-    return false;
-  }
-  return typeof consent === 'object' && 'analytics' in consent;
-}
-
-/**
- * @import {CookieConsent} from '~/src/common/types.js'
- */
-//# sourceMappingURL=cookies.js.map

package/.server/common/cookies.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"cookies.js","names":["defaultConsent","analytics","dismissed","parseCookieConsent","value","cookieConsent","encodedValue","decodeURIComponent","decodedValue","JSON","parse","isValidConsent","serialiseCookieConsent","consent","encodeURIComponent","stringify","Array","isArray"],"sources":["../../src/common/cookies.js"],"sourcesContent":["/**\n  @type {CookieConsent}\n */\nexport const defaultConsent = {\n  analytics: null,\n  dismissed: false\n}\n\n/**\n * Parses the cookie consent policy\n * @param {string} value\n */\nexport function parseCookieConsent(value) {\n  /** @type {CookieConsent} */\n  let cookieConsent\n\n  try {\n    const encodedValue = decodeURIComponent(value)\n\n    // eslint-disable-next-line -- Allow JSON type 'any'\n    const decodedValue = JSON.parse(encodedValue)\n\n    if (isValidConsent(decodedValue)) {\n      cookieConsent = decodedValue\n    } else {\n      cookieConsent = defaultConsent\n    }\n  } catch {\n    cookieConsent = defaultConsent\n  }\n\n  return cookieConsent\n}\n\n/**\n * Serialises the cookie consent policy\n * @param {CookieConsent} consent\n * @returns {string} cookie value\n */\nexport function serialiseCookieConsent(consent) {\n  return encodeURIComponent(JSON.stringify(consent))\n}\n\n/**\n * @param {unknown} consent\n * @returns {consent is CookieConsent}\n */\nfunction isValidConsent(consent) {\n  if (consent === null || Array.isArray(consent)) {\n    return false\n  }\n\n  return typeof consent === 'object' && 'analytics' in consent\n}\n\n/**\n * @import {CookieConsent} from '~/src/common/types.js'\n */\n"],"mappings":"AAAA;AACA;AACA;AACA,OAAO,MAAMA,cAAc,GAAG;EAC5BC,SAAS,EAAE,IAAI;EACfC,SAAS,EAAE;AACb,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,SAASC,kBAAkBA,CAACC,KAAK,EAAE;EACxC;EACA,IAAIC,aAAa;EAEjB,IAAI;IACF,MAAMC,YAAY,GAAGC,kBAAkB,CAACH,KAAK,CAAC;;IAE9C;IACA,MAAMI,YAAY,GAAGC,IAAI,CAACC,KAAK,CAACJ,YAAY,CAAC;IAE7C,IAAIK,cAAc,CAACH,YAAY,CAAC,EAAE;MAChCH,aAAa,GAAGG,YAAY;IAC9B,CAAC,MAAM;MACLH,aAAa,GAAGL,cAAc;IAChC;EACF,CAAC,CAAC,MAAM;IACNK,aAAa,GAAGL,cAAc;EAChC;EAEA,OAAOK,aAAa;AACtB;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASO,sBAAsBA,CAACC,OAAO,EAAE;EAC9C,OAAOC,kBAAkB,CAACL,IAAI,CAACM,SAAS,CAACF,OAAO,CAAC,CAAC;AACpD;;AAEA;AACA;AACA;AACA;AACA,SAASF,cAAcA,CAACE,OAAO,EAAE;EAC/B,IAAIA,OAAO,KAAK,IAAI,IAAIG,KAAK,CAACC,OAAO,CAACJ,OAAO,CAAC,EAAE;IAC9C,OAAO,KAAK;EACd;EAEA,OAAO,OAAOA,OAAO,KAAK,QAAQ,IAAI,WAAW,IAAIA,OAAO;AAC9D;;AAEA;AACA;AACA","ignoreList":[]}

package/.server/common/cookies.test.js

@@ -1,15 +0,0 @@
-import { parseCookieConsent } from "./cookies.js";
-describe('cookies', () => {
-  it('parses a valid policy', () => {
-    expect(parseCookieConsent('{"analytics":true}')).toEqual({
-      analytics: true
-    });
-  });
-  it.each(["['not', 'an', 'object']", '{{ not: "an object" }}', '{ additional: AAA }', '{ marketing: 100 }', '', 'null'])('converts a malformed policy to the default', value => {
-    expect(parseCookieConsent(value)).toEqual({
-      analytics: null,
-      dismissed: false
-    });
-  });
-});
-//# sourceMappingURL=cookies.test.js.map

package/.server/common/cookies.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"cookies.test.js","names":["parseCookieConsent","describe","it","expect","toEqual","analytics","each","value","dismissed"],"sources":["../../src/common/cookies.test.js"],"sourcesContent":["import { parseCookieConsent } from '~/src/common/cookies.js'\n\ndescribe('cookies', () => {\n  it('parses a valid policy', () => {\n    expect(parseCookieConsent('{\"analytics\":true}')).toEqual({\n      analytics: true\n    })\n  })\n\n  it.each([\n    \"['not', 'an', 'object']\",\n    '{{ not: \"an object\" }}',\n    '{ additional: AAA }',\n    '{ marketing: 100 }',\n    '',\n    'null'\n  ])('converts a malformed policy to the default', (value) => {\n    expect(parseCookieConsent(value)).toEqual({\n      analytics: null,\n      dismissed: false\n    })\n  })\n})\n"],"mappings":"AAAA,SAASA,kBAAkB;AAE3BC,QAAQ,CAAC,SAAS,EAAE,MAAM;EACxBC,EAAE,CAAC,uBAAuB,EAAE,MAAM;IAChCC,MAAM,CAACH,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAACI,OAAO,CAAC;MACvDC,SAAS,EAAE;IACb,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFH,EAAE,CAACI,IAAI,CAAC,CACN,yBAAyB,EACzB,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,EAAE,EACF,MAAM,CACP,CAAC,CAAC,4CAA4C,EAAGC,KAAK,IAAK;IAC1DJ,MAAM,CAACH,kBAAkB,CAACO,KAAK,CAAC,CAAC,CAACH,OAAO,CAAC;MACxCC,SAAS,EAAE,IAAI;MACfG,SAAS,EAAE;IACb,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/.server/common/types.js

@@ -1,6 +0,0 @@
-/**
- * @typedef CookieConsent
- * @property {boolean | null} analytics - whether analytics cookies are allowed
- * @property {boolean} dismissed - whether cookie banner has been dismissed
- */
-//# sourceMappingURL=types.js.map

package/.server/common/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../src/common/types.js"],"sourcesContent":["/**\n * @typedef CookieConsent\n * @property {boolean | null} analytics - whether analytics cookies are allowed\n * @property {boolean} dismissed - whether cookie banner has been dismissed\n */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/forms/README.md

@@ -1,10 +0,0 @@
-# Pre-configured Forms
-
-This folder holds pre-configured form definitions that can be loaded by the runner:
-
-```js
-const server = await createServer({
-  formFileName: 'example.js',
-  formFilePath: join(cwd(), 'server/forms'),
-})
-```

package/.server/server/forms/report-a-terrorist.json

@@ -1,270 +0,0 @@
-{
-  "startPage": "/do-you-have-a-link-to-the-evidence",
-  "pages": [
-    {
-      "title": "Do you have a link to the evidence?",
-      "path": "/do-you-have-a-link-to-the-evidence",
-      "components": [
-        {
-          "name": "UjidZI",
-          "title": "Html",
-          "options": {},
-          "type": "Html",
-          "content": "<p class=\"govuk-body\">It’s helpful if you can send us links to the relevant pages, or posts if it was posted on social media.</p>",
-          "schema": {}
-        },
-        {
-          "name": "rfUYC",
-          "options": {},
-          "type": "Details",
-          "title": "Help me find the link",
-          "content": "If you’re on a website, the link appears in the bar at the top of the page. An example of a link is, www.gov.uk/page/1234/content#.",
-          "schema": {}
-        },
-        {
-          "type": "RadiosField",
-          "title": "Do you have a link to the material?",
-          "options": {},
-          "name": "doyouhavealink",
-          "schema": {},
-          "list": "HTbt4V"
-        }
-      ],
-      "next": [
-        {
-          "path": "/do-you-have-any-evidence"
-        },
-        {
-          "path": "/yes-i-have-a-link-to-the-material",
-          "condition": "b-NGgWvGISkJJLuzsJIjv"
-        }
-      ],
-      "section": "PMXq1s"
-    },
-    {
-      "path": "/do-you-have-any-evidence",
-      "title": "Do you have any evidence?",
-      "components": [
-        {
-          "name": "OQrrkG",
-          "title": "Html",
-          "options": {},
-          "type": "Html",
-          "content": "<p class=\"govuk-body\">This could be an image or video, for example. Evidence is helpful should the material be deleted before we can find it.It’s safe to save evidence to your device for the purpose of reporting it to us. We recommend deleting it afterwards.</p>",
-          "schema": {}
-        },
-        {
-          "name": "ajdOpV",
-          "options": {},
-          "type": "Details",
-          "title": "Help me take a screenshot",
-          "content": "Try this:Press the Shift key (⇧), command (or Cmd), and 3The screenshot will be saved to your DesktopYou can now upload it to the formTry this:Press the Ctrl key and the switch window keyThe screenshot will be saved to your DownloadsYou can now upload it to the formIf that doesn’t work, try pressing Ctrl and F5.When viewing the material:Press the Prt Scr key (or similar) to take a copy of your screenPaste the image into Microsoft Paint or a similar applicationSave the file to your computerUpload the file to the formIf that doesn’t work, you may need to search for how to take screenshots on your particular computer model.",
-          "schema": {}
-        },
-        {
-          "name": "LUBRMD",
-          "options": {},
-          "type": "RadiosField",
-          "title": "Do you have any evidence?",
-          "schema": {},
-          "list": "mdmRq9"
-        }
-      ],
-      "next": [
-        {
-          "path": "/is-there-anything-else-you-can-tell-us"
-        },
-        {
-          "path": "/yes-i-have-evidence",
-          "condition": "On5IOaSRDSyLs1G7-Dmdy"
-        }
-      ],
-      "section": "PMXq1s"
-    },
-    {
-      "title": "summary",
-      "path": "/summary",
-      "controller": "SummaryPageController",
-      "components": []
-    },
-    {
-      "path": "/is-there-anything-else-you-can-tell-us",
-      "title": "Is there anything else you can tell us?",
-      "components": [
-        {
-          "name": "HETMBo",
-          "title": "Html",
-          "options": {},
-          "type": "Html",
-          "content": "<p class=\"govuk-body\">Details may include:who shared the materialwhen it was shareda description, if you haven’t provided a link or evidence</p>",
-          "schema": {}
-        },
-        {
-          "name": "evZxIJ",
-          "options": {
-            "required": false
-          },
-          "type": "MultilineTextField",
-          "title": "Additional Info",
-          "schema": {}
-        }
-      ],
-      "next": [
-        {
-          "path": "/summary"
-        }
-      ],
-      "section": "PMXq1s"
-    },
-    {
-      "path": "/yes-i-have-a-link-to-the-material",
-      "title": "Yes I have a link to the material",
-      "components": [
-        {
-          "type": "MultilineTextField",
-          "title": "Link to the material",
-          "hint": "Please put in the link to the material here",
-          "name": "blarGGH",
-          "options": {},
-          "schema": {}
-        }
-      ],
-      "next": [
-        {
-          "path": "/do-you-have-any-evidence"
-        }
-      ],
-      "section": "PMXq1s"
-    },
-    {
-      "path": "/yes-i-have-evidence",
-      "title": "Yes I have evidence",
-      "components": [
-        {
-          "name": "koExae",
-          "options": {
-            "required": false
-          },
-          "type": "MultilineTextField",
-          "title": "Evidence",
-          "hint": "Please enter your evidence here",
-          "schema": {}
-        }
-      ],
-      "next": [
-        {
-          "path": "/is-there-anything-else-you-can-tell-us"
-        }
-      ],
-      "section": "PMXq1s"
-    }
-  ],
-  "lists": [
-    {
-      "title": "linktomateriallist",
-      "name": "HTbt4V",
-      "type": "string",
-      "items": [
-        {
-          "text": "Yes, I do have a link",
-          "value": "yes"
-        },
-        {
-          "text": "No, I don't have a link",
-          "value": "no"
-        }
-      ]
-    },
-    {
-      "title": "evidencelist",
-      "name": "mdmRq9",
-      "type": "string",
-      "items": [
-        {
-          "text": "Yes, I have evidence",
-          "value": "yes"
-        },
-        {
-          "text": "No, I don't have evidence",
-          "value": "no"
-        }
-      ]
-    }
-  ],
-  "sections": [
-    {
-      "name": "PMXq1s",
-      "title": "Evidence"
-    }
-  ],
-  "phaseBanner": {},
-  "metadata": {},
-  "conditions": [
-    {
-      "name": "b-NGgWvGISkJJLuzsJIjv",
-      "displayName": "hasLink",
-      "value": {
-        "name": "hasLink",
-        "conditions": [
-          {
-            "field": {
-              "name": "PMXq1s.doyouhavealink",
-              "type": "RadiosField",
-              "display": "Do you have a link to the material? in PMXq1s"
-            },
-            "operator": "is",
-            "value": {
-              "type": "Value",
-              "value": "yes",
-              "display": "Yes, I do have a link"
-            }
-          }
-        ]
-      }
-    },
-    {
-      "name": "xY51EDbc4lPr6kHZl1umG",
-      "displayName": "noEvidence",
-      "value": {
-        "name": "noEvidence",
-        "conditions": [
-          {
-            "field": {
-              "name": "PMXq1s.LUBRMD",
-              "type": "RadiosField",
-              "display": "Do you have any evidence? in PMXq1s"
-            },
-            "operator": "is",
-            "value": {
-              "type": "Value",
-              "value": "no",
-              "display": "No, I don't have evidence"
-            }
-          }
-        ]
-      }
-    },
-    {
-      "name": "On5IOaSRDSyLs1G7-Dmdy",
-      "displayName": "hasEvidence",
-      "value": {
-        "name": "hasEvidence",
-        "conditions": [
-          {
-            "field": {
-              "name": "PMXq1s.LUBRMD",
-              "type": "RadiosField",
-              "display": "Do you have any evidence? in PMXq1s"
-            },
-            "operator": "is",
-            "value": {
-              "type": "Value",
-              "value": "yes",
-              "display": "Yes, I have evidence"
-            }
-          }
-        ]
-      }
-    }
-  ]
-}