@dwp/govuk-casa 8.0.0-alpha1 → 8.0.0

package/dist/lib/CasaTemplateLoader.js

@@ -13,18 +13,48 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _CasaTemplateLoader_instances, _CasaTemplateLoader_blockModifiers, _CasaTemplateLoader_applyBlockModifiers;
 Object.defineProperty(exports, "__esModule", { value: true });
 const nunjucks_1 = require("nunjucks");
+/**
+ * @typedef {import('nunjucks').FileSystemLoaderOptions} FileSystemLoaderOptions
+ */
+const VALID_BLOCKS = [
+    'beforeContent',
+    'bodyEnd',
+    'bodyStart',
+    'casaPageTitle',
+    'content',
+    'footer',
+    'head',
+    'header',
+    'headIcons',
+    'journey_form',
+    'main',
+    'pageTitle',
+    'skipLink',
+];
 /**
  * @callback BlockModifier
  * @param {string} templateName Path to the template being modified
  * @returns {string} The modified template source
  */
 class CasaTemplateLoader extends nunjucks_1.FileSystemLoader {
+    /**
+     * Constructor.
+     *
+     * @param {string[]} searchPaths Template directories
+     * @param {FileSystemLoaderOptions} opts Loader options
+     */
     constructor(searchPaths, opts) {
         super(searchPaths, opts);
         _CasaTemplateLoader_instances.add(this);
         _CasaTemplateLoader_blockModifiers.set(this, void 0);
         __classPrivateFieldSet(this, _CasaTemplateLoader_blockModifiers, [], "f");
     }
+    /**
+     * Extract the source from the given template file.
+     *
+     * @param {string} name Source file path
+     * @returns {string} Source contents of template
+     */
     getSource(name) {
         const source = super.getSource(name);
         return source ? __classPrivateFieldGet(this, _CasaTemplateLoader_instances, "m", _CasaTemplateLoader_applyBlockModifiers).call(this, name, source) : source;
@@ -35,9 +65,13 @@ class CasaTemplateLoader extends nunjucks_1.FileSystemLoader {
      * @param {string} block Block name, e.g. `bodyStart`
      * @param {BlockModifier} modifier Modifier function
      * @returns {void}
+     * @throws {Error} If provided with an unrecognised block
      */
     modifyBlock(block, modifier) {
-        // TODO: Limit to only known block so the user can't do general string replacements
+        // Limit to only known block so the user can't do general string replacements
+        if (!VALID_BLOCKS.includes(block)) {
+            throw new Error(`Block "${String(block)}" is not a recognised template block.`);
+        }
         __classPrivateFieldGet(this, _CasaTemplateLoader_blockModifiers, "f").push({
             block,
             modifier,
@@ -46,10 +80,12 @@ class CasaTemplateLoader extends nunjucks_1.FileSystemLoader {
 }
 exports.default = CasaTemplateLoader;
 _CasaTemplateLoader_blockModifiers = new WeakMap(), _CasaTemplateLoader_instances = new WeakSet(), _CasaTemplateLoader_applyBlockModifiers = function _CasaTemplateLoader_applyBlockModifiers(name, source) {
-    // TODO: This is open to abuse by plugin authors, e,g `{% block bodyStart %}{% endblock %} <script src="evil.js"></script>`. Problem, or no?
     for (let i = 0, l = __classPrivateFieldGet(this, _CasaTemplateLoader_blockModifiers, "f").length; i < l; i++) {
+        // ESLint disabled as `i` is an integer
+        /* eslint-disable-next-line security/detect-object-injection */
         const { block, modifier } = __classPrivateFieldGet(this, _CasaTemplateLoader_blockModifiers, "f")[i];
         if (source.src.indexOf(`block ${block}`) > -1) {
+            /* eslint-disable-next-line no-param-reassign */
             source.src = source.src.replace(`block ${block} %}`, `block ${block} %}${modifier(name)}`);
         }
     }

package/dist/lib/JourneyContext.d.ts

@@ -1,12 +1,37 @@
+/**
+ * @typedef {import('./configuration-ingestor').Page} Page
+ */
+/**
+ * @callback ContextEventHandler
+ * @param {JourneyContext} journeyContext Context including changes
+ * @param {JourneyContext} previousContext Context prior to changes
+ * @returns {void}
+ */
+/**
+ * @typedef {object} ContextEvent
+ * @property {string} waypoint Waypoint to watch for changes
+ * @property {string} [field] Field to watch for changes
+ * @property {ContextEventHandler} handler Handler to invoke when change happens
+ */
+export function validateObjectKey(key?: string): string;
 export default class JourneyContext {
     static DEFAULT_CONTEXT_ID: string;
     /**
      * Create a new JourneyContext using the plain object.
      *
      * @param {object} obj Object.
+     * @param {object} obj.data Data
+     * @param {object} obj.validation Validation state
+     * @param {object} obj.nav Navigation meta
+     * @param {object} obj.identity Identity meta
      * @returns {JourneyContext} Instance.
      */
-    static fromObject({ data, validation, nav, identity, }?: object): JourneyContext;
+    static fromObject({ data, validation, nav, identity, }?: {
+        data: object;
+        validation: object;
+        nav: object;
+        identity: object;
+    }): JourneyContext;
     /**
      * Construct a new JourneyContext instance frmo another instance.
      *
@@ -124,11 +149,11 @@ export default class JourneyContext {
     /**
      * Get data context for a specific a specific page.
      *
-     * @param  {string | PageMeta} page Page waypoint ID, or Page object.
+     * @param  {string | Page} page Page waypoint ID, or Page object.
      * @returns {object} Page data.
      * @throws {TypeError} When page is invalid.
      */
-    getDataForPage(page: string | any): object;
+    getDataForPage(page: string | Page): object;
     getData(): object;
     /**
      * Overwrite the data context with a new object.
@@ -141,16 +166,16 @@ export default class JourneyContext {
      * Write field form data from a page HTML form, into the `data` model.
      *
      * By default this will store the data as-is, keyed against the page's
-     * waypoint ID. However, when passing a `PageMeta` instance, its
+     * waypoint ID. However, when passing a `Page` instance, its
      * `fieldWriter()` method will be called to transform the provided formData
      * before storing in `data`
      *
-     * @param {string | PageMeta} page Page waypoint ID, or PageMeta object
+     * @param {string | Page} page Page waypoint ID, or Page object
      * @param {object} webFormData Data to overwrite with
      * @returns {JourneyContext} Chain
      * @throws {TypeError} When page is invalid.
      */
-    setDataForPage(page: string | any, webFormData: object): JourneyContext;
+    setDataForPage(page: string | Page, webFormData: object): JourneyContext;
     /**
      * Return validation errors for all pages.
      *
@@ -227,6 +252,7 @@ export default class JourneyContext {
      * force the user to revisit some waypoints.
      *
      * @param {string[]} waypoints Waypoints to be invalidated
+     * @returns {void}
      */
     invalidate(waypoints?: string[]): void;
     /**
@@ -239,11 +265,12 @@ export default class JourneyContext {
      * times during a request, so the context will be constantly changing.
      *
      * @param {ContextEvent[]} events Event listeners
+     * @returns {JourneyContext} Chain
      */
-    addEventListeners(events: any[]): JourneyContext;
+    addEventListeners(events: ContextEvent[]): JourneyContext;
     applyEventListeners({ event }: {
         event: any;
-    }): JourneyContext | undefined;
+    }): JourneyContext;
     /**
      * Convenience method to determine if this is the default context.
      *
@@ -252,4 +279,20 @@ export default class JourneyContext {
     isDefault(): boolean;
     #private;
 }
+export type Page = import('./configuration-ingestor').Page;
+export type ContextEventHandler = (journeyContext: JourneyContext, previousContext: JourneyContext) => void;
+export type ContextEvent = {
+    /**
+     * Waypoint to watch for changes
+     */
+    waypoint: string;
+    /**
+     * Field to watch for changes
+     */
+    field?: string | undefined;
+    /**
+     * Handler to invoke when change happens
+     */
+    handler: ContextEventHandler;
+};
 import ValidationError from "./ValidationError.js";

package/dist/lib/JourneyContext.js

@@ -26,6 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _JourneyContext_data, _JourneyContext_validation, _JourneyContext_nav, _JourneyContext_identity, _JourneyContext_eventListeners, _JourneyContext_eventListenerPreState;
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateObjectKey = void 0;
 /**
  * Represents the state of a user's journey through the Plan. It contains
  * information about:
@@ -35,37 +36,34 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * - Navigation information about how the user got where they are.
  */
 const uuid_1 = require("uuid");
+const lodash_1 = __importDefault(require("lodash"));
 const ValidationError_js_1 = __importDefault(require("./ValidationError.js"));
 const logger_js_1 = __importDefault(require("./logger.js"));
-const lodash_1 = __importDefault(require("lodash"));
-const { cloneDeep, isPlainObject, isObject, has, isEqual } = lodash_1.default; // CommonJS
-const log = (0, logger_js_1.default)('class:journey-context');
-// const buildBreadcrumb = (mountUrl, done = Object.create(null)) => {
-//   console.log('buildnav', mountUrl, waypoint, source, navUrls, done);
-//   // 1. there are url:// waypoint in the mount list - [a, b, url://other/, d] and [x, y, z] -> [a, b, x, y z, d]
-//   // 2. there are no url:// in there - [a, b, c, d]
-//   // 3. other mount lists have url:///mountUrl/ in them - [a, b, c, d] and [x, y, url://abcd/, z] -> [x, y, a, b, c, d, z]
-//   // 4. in and out - [a, b, url://c/, d] and [x, z, url://a/] -> [a, b, x, z, d] <-- need recursion protection here
-//   //    [x, z, a, b, x, z, d] ... changes depend on order called ://///
-//   if (done[mountUrl]) {
-//     return done[mountUrl];
-//   }
-//   done[mountUrl] = [];
-//   const mountCrumbs = [];
-//   for (let mount in navUrls) {
-//     mountCrumbs = 
-//   }
-//   const breadcrumb = source.map(wp => {
-//     if (Plan.isExitNode(wp)) {
-//     } else {
-//       return waypointUrl({ mountUrl, waypoint: wp });
-//     }
-//   });
-//   const waypointIndex = source?.mountUrl?.indexOf(waypoint);
-//   if (waypointIndex == -1) {
-//     return [];
-//   }
-// };
+const { cloneDeep, isPlainObject, isObject, has, isEqual, } = lodash_1.default; // CommonJS
+const log = (0, logger_js_1.default)('lib:journey-context');
+/**
+ * @typedef {import('./configuration-ingestor').Page} Page
+ */
+/**
+ * @callback ContextEventHandler
+ * @param {JourneyContext} journeyContext Context including changes
+ * @param {JourneyContext} previousContext Context prior to changes
+ * @returns {void}
+ */
+/**
+ * @typedef {object} ContextEvent
+ * @property {string} waypoint Waypoint to watch for changes
+ * @property {string} [field] Field to watch for changes
+ * @property {ContextEventHandler} handler Handler to invoke when change happens
+ */
+function validateObjectKey(key = '') {
+    const keyLower = String.prototype.toLowerCase.call(key);
+    if (keyLower === 'prototype' || keyLower === '__proto__' || keyLower === 'constructor') {
+        throw new SyntaxError(`Invalid object key used, ${key}`);
+    }
+    return String(key);
+}
+exports.validateObjectKey = validateObjectKey;
 class JourneyContext {
     /**
      * Constructor.
@@ -122,6 +120,10 @@ class JourneyContext {
      * Create a new JourneyContext using the plain object.
      *
      * @param {object} obj Object.
+     * @param {object} obj.data Data
+     * @param {object} obj.validation Validation state
+     * @param {object} obj.nav Navigation meta
+     * @param {object} obj.identity Identity meta
      * @returns {JourneyContext} Instance.
      */
     static fromObject({ data = Object.create(null), validation = Object.create(null), nav = Object.create(null), identity = Object.create(null), } = {}) {
@@ -145,20 +147,18 @@ class JourneyContext {
     /**
      * Get data context for a specific a specific page.
      *
-     * @param  {string | PageMeta} page Page waypoint ID, or Page object.
+     * @param  {string | Page} page Page waypoint ID, or Page object.
      * @returns {object} Page data.
      * @throws {TypeError} When page is invalid.
      */
     getDataForPage(page) {
         if (typeof page === 'string') {
-            return __classPrivateFieldGet(this, _JourneyContext_data, "f")[page];
+            return __classPrivateFieldGet(this, _JourneyContext_data, "f")[validateObjectKey(page)];
         }
-        else if (isPlainObject(page)) {
-            return __classPrivateFieldGet(this, _JourneyContext_data, "f")[page.waypoint];
-        }
-        else {
-            throw new TypeError(`Page must be a string or Page object. Got ${typeof page}`);
+        if (isPlainObject(page)) {
+            return __classPrivateFieldGet(this, _JourneyContext_data, "f")[validateObjectKey(page.waypoint)];
         }
+        throw new TypeError(`Page must be a string or Page object. Got ${typeof page}`);
     }
     getData() {
         return __classPrivateFieldGet(this, _JourneyContext_data, "f");
@@ -177,21 +177,21 @@ class JourneyContext {
      * Write field form data from a page HTML form, into the `data` model.
      *
      * By default this will store the data as-is, keyed against the page's
-     * waypoint ID. However, when passing a `PageMeta` instance, its
+     * waypoint ID. However, when passing a `Page` instance, its
      * `fieldWriter()` method will be called to transform the provided formData
      * before storing in `data`
      *
-     * @param {string | PageMeta} page Page waypoint ID, or PageMeta object
+     * @param {string | Page} page Page waypoint ID, or Page object
      * @param {object} webFormData Data to overwrite with
      * @returns {JourneyContext} Chain
      * @throws {TypeError} When page is invalid.
      */
     setDataForPage(page, webFormData) {
         if (typeof page === 'string') {
-            __classPrivateFieldGet(this, _JourneyContext_data, "f")[page] = webFormData;
+            __classPrivateFieldGet(this, _JourneyContext_data, "f")[validateObjectKey(page)] = webFormData;
         }
         else if (isPlainObject(page)) {
-            __classPrivateFieldGet(this, _JourneyContext_data, "f")[page.waypoint] = webFormData;
+            __classPrivateFieldGet(this, _JourneyContext_data, "f")[validateObjectKey(page.waypoint)] = webFormData;
         }
         else {
             throw new TypeError(`Page must be a string or Page object. Got ${typeof page}`);
@@ -229,7 +229,7 @@ class JourneyContext {
      * @returns {JourneyContext} Chain.
      */
     clearValidationErrorsForPage(pageId) {
-        __classPrivateFieldGet(this, _JourneyContext_validation, "f")[pageId] = null;
+        __classPrivateFieldGet(this, _JourneyContext_validation, "f")[validateObjectKey(pageId)] = null;
         return this;
     }
     /**
@@ -249,7 +249,7 @@ class JourneyContext {
                 throw new SyntaxError('Field errors must be a ValidationError');
             }
         });
-        __classPrivateFieldGet(this, _JourneyContext_validation, "f")[pageId] = errors;
+        __classPrivateFieldGet(this, _JourneyContext_validation, "f")[validateObjectKey(pageId)] = errors;
         return this;
     }
     /**
@@ -260,17 +260,21 @@ class JourneyContext {
      * @returns {ValidationError[]} An array of errors
      */
     getValidationErrorsForPage(pageId) {
-        return __classPrivateFieldGet(this, _JourneyContext_validation, "f")[pageId] || [];
+        var _a;
+        return (_a = __classPrivateFieldGet(this, _JourneyContext_validation, "f")[validateObjectKey(pageId)]) !== null && _a !== void 0 ? _a : [];
     }
     getValidationErrorsForPageByField(pageId) {
         const errors = this.getValidationErrorsForPage(pageId);
         const obj = Object.create(null);
+        // ESLint disabled as `i` is an integer
+        /* eslint-disable security/detect-object-injection */
         for (let i = 0, l = errors.length; i < l; i++) {
             if (!obj[errors[i].field]) {
                 obj[errors[i].field] = [];
             }
             obj[errors[i].field].push(errors[i]);
         }
+        /* eslint-enable security/detect-object-injection */
         return obj;
     }
     /**
@@ -282,7 +286,7 @@ class JourneyContext {
      */
     hasValidationErrorsForPage(pageId) {
         var _a, _b;
-        return ((_b = (_a = __classPrivateFieldGet(this, _JourneyContext_validation, "f")) === null || _a === void 0 ? void 0 : _a[pageId]) === null || _b === void 0 ? void 0 : _b.length) > 0;
+        return ((_b = (_a = __classPrivateFieldGet(this, _JourneyContext_validation, "f")) === null || _a === void 0 ? void 0 : _a[validateObjectKey(pageId)]) === null || _b === void 0 ? void 0 : _b.length) > 0;
     }
     /**
      * Set language of the context.
@@ -294,101 +298,6 @@ class JourneyContext {
         __classPrivateFieldGet(this, _JourneyContext_nav, "f").language = language;
         return this;
     }
-    // /**
-    //  * Store the list of visited waypoints against the given mountUrl. This will
-    //  * help build a picture of the user's navigation across multiple sub-apps.
-    //  *
-    //  * @param {string} mountUrl Mount URL prefixing all given waypoints
-    //  * @param {string[]} waypoints Waypoints visited (in this order)
-    //  * @param {string} [routeName=next] Name of the route followed to get this list of waypoints
-    //  * @returns 
-    //  */
-    // setNavigationUrls(mountUrl, waypoints = [], routeName = 'next') {
-    //   this.#nav.urls = this.#nav?.urls ?? Object.create(null);
-    //   this.#nav.urls[mountUrl] = this.#nav.urls[mountUrl] ?? Object.create(null);
-    //   this.#nav.urls[mountUrl][routeName] = waypoints;
-    //   return this;
-    // }
-    // /**
-    //  * Combines all nav information to build a linear list of URLs that the
-    //  * user has visited from the point specificed.
-    //  *
-    //  * @param {string} mountUrl Mount URL
-    //  * @param {string} [routeName=next] Route name (optional, default next)
-    //  * @returns {string[]} List of URL, all prefixed with mountUrl
-    //  */
-    //  buildNavigationBreadcrumb(mountUrl, routeName = 'next') {
-    //   // THIS IS WHERE I'M AT. Need to properly sort this so it injects waypoints into other mount points correctly.
-    //   // There is a big dependency on when this is called - the mountUrl will be different every time,, which changes the point from which we begin trying to build this.
-    //   let toUrl = (mntUrl) => (u) => {
-    //     if (routeName === 'prev' && Plan.isExitNode(u)) {
-    //       return waypointUrl({ mountUrl: u.substr(6), waypoint: `url://${mntUrl}`, routeName });
-    //     } else {
-    //       return waypointUrl({ mountUrl: mntUrl, waypoint: u, routeName });
-    //     }
-    //   };
-    //   let nav = (this.#nav?.urls?.[mountUrl]?.[routeName] ?? []).map(toUrl(mountUrl));
-    //   // No URLs? There might be some references to this mountUrl in the other
-    //   // mount points
-    //   const mountUrls = Object.keys(this.#nav?.urls ?? Object.create(null));
-    //   for (let i = 0, l = mountUrls.length; i < l; i ++) {
-    //     const murl = mountUrls[i];
-    //     const index = this.#nav.urls[murl][routeName].indexOf(`url://${mountUrl}`);
-    //     if (index > -1) {
-    //       console.log('before', nav)
-    //       console.log('insert', this.#nav.urls[murl][routeName].slice(index).map(toUrl(murl)))
-    //       // nav = [
-    //       //   ...nav,
-    //       //   ...this.#nav.urls[murl][routeName].slice(index).map(toUrl(murl)),
-    //       // ];
-    //       nav = [
-    //         ...this.#nav.urls[murl][routeName].slice(index).map(toUrl(murl)),
-    //         ...nav,
-    //       ];
-    //     }
-    //   }
-    //   return nav;
-    //   // return this.#nav.urls[mountUrl].map(wp => waypointUrl({ mountUrl, waypoint: wp, routeName }));
-    //   // // const breadcrumb = buildBreadcrumb({ mountUrl, waypoint }, this.#nav.urls[mountUrl] ?? [], this.#nav.urls);
-    //   // let nav = [];
-    //   // // First, build URLs for the specified mount path
-    //   // nav = this.#nav.urls[mountUrl].map(wp => waypointUrl({ mountUrl, waypoint: wp, routeName }));
-    //   // // Second, find any refs to mountUrl in the other mount paths
-    //   // for (let mp in this.#nav.urls) {
-    //   //   if (mp === mountUrl) continue;
-    //   //   this.buildNavigationBreadcrumb(mp, routeName);
-    //   // }
-    //   // return breadcrum;
-    //   // // TODO: The solution below does not take account plans that have multiple references to sub-apps, such as:
-    //   // // a -> b -> url:///c/ -> d -> e -> url:///f/
-    //   // // We'll need a recursive function to explode all url references and inject waypoints
-    //   // //
-    //   // // Also, once we've added the waypoint for a mountUrl, we want to check elsewhere for url://// to _that_ mountUrl, and so on. At some point we need to know where to stop. Be careful of recursion
-    //   // let nav = [];
-    //   // // First, get all the waypoints listed up to the requested one under the given mountUrl
-    //   // let mountUrls = Object.keys(this.#nav?.urls ?? Object.create(null));
-    //   // if (mountUrls.indexOf(mountUrl) > -1 && this.#nav.urls[mountUrl].indexOf(waypoint) > -1) {
-    //   //   nav = [
-    //   //     ...nav,
-    //   //     ...this.#nav.urls[mountUrl].slice(0, this.#nav.urls[mountUrl].indexOf(waypoint) + 1).map(w => waypointUrl({ mountUrl, waypoint: w })),
-    //   //   ];
-    //   // }
-    //   // // Next, look for any sub-app references to the requested mountUrl elsewhere
-    //   // // in the nav context, and add all the waypoints listed there.
-    //   // const url = `url://${mountUrl}`;
-    //   // for (let i = 0, l = mountUrls.length; i < l; i ++) {
-    //   //   const index = this.#nav.urls[mountUrls[i]].indexOf(url);
-    //   //   if (index > -1) {
-    //   //     nav = [
-    //   //       ...this.#nav.urls[mountUrls[i]].slice(0, index).map(w => waypointUrl({ mountUrl: mountUrls[i], waypoint: w })),
-    //   //       ...nav,
-    //   //       ...this.#nav.urls[mountUrls[i]].slice(index).map(w => waypointUrl({ mountUrl: mountUrls[i], waypoint: w })),  // TODO this will fail if url:// waypoints are there - need that recurive function building
-    //   //     ];
-    //   //     break;
-    //   //   }
-    //   // }
-    //   // return nav;
-    // }
     /**
      * Convenience function to test if page is valid.
      *
@@ -396,7 +305,7 @@ class JourneyContext {
      * @returns {boolean} True if the page is valid.
      */
     isPageValid(pageId) {
-        return __classPrivateFieldGet(this, _JourneyContext_validation, "f")[pageId] === null;
+        return __classPrivateFieldGet(this, _JourneyContext_validation, "f")[validateObjectKey(pageId)] === null;
     }
     /**
      * Remove information about these waypoints.
@@ -406,11 +315,14 @@ class JourneyContext {
     purge(waypoints = []) {
         const newData = Object.create(null);
         const newValidation = Object.create(null);
-        const toKeep = Object.keys(this.data).filter(w => !waypoints.includes(w));
+        const toKeep = Object.keys(this.data).filter((w) => !waypoints.includes(w));
+        // ESLint disabled as `i` is an integer
+        /* eslint-disable security/detect-object-injection */
         for (let i = 0, l = toKeep.length; i < l; i++) {
             newData[toKeep[i]] = __classPrivateFieldGet(this, _JourneyContext_data, "f")[toKeep[i]];
             newValidation[toKeep[i]] = __classPrivateFieldGet(this, _JourneyContext_validation, "f")[toKeep[i]];
         }
+        /* eslint-enable security/detect-object-injection */
         __classPrivateFieldSet(this, _JourneyContext_data, Object.assign({}, newData), "f");
         __classPrivateFieldSet(this, _JourneyContext_validation, Object.assign({}, newValidation), "f");
     }
@@ -419,9 +331,12 @@ class JourneyContext {
      * force the user to revisit some waypoints.
      *
      * @param {string[]} waypoints Waypoints to be invalidated
+     * @returns {void}
      */
     invalidate(waypoints = []) {
         for (let i = 0, l = waypoints.length; i < l; i++) {
+            // ESLint disabled as `i` is an integer
+            /* eslint-disable-next-line security/detect-object-injection */
             this.removeValidationStateForPage(waypoints[i]);
         }
     }
@@ -435,6 +350,7 @@ class JourneyContext {
      * times during a request, so the context will be constantly changing.
      *
      * @param {ContextEvent[]} events Event listeners
+     * @returns {JourneyContext} Chain
      */
     addEventListeners(events) {
         __classPrivateFieldSet(this, _JourneyContext_eventListeners, events, "f");
@@ -442,33 +358,39 @@ class JourneyContext {
         return this;
     }
     applyEventListeners({ event }) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         if (!__classPrivateFieldGet(this, _JourneyContext_eventListeners, "f").length) {
             return this;
         }
         const previousContext = JourneyContext.fromObject(__classPrivateFieldGet(this, _JourneyContext_eventListenerPreState, "f"));
-        const listeners = __classPrivateFieldGet(this, _JourneyContext_eventListeners, "f").filter(l => l.event === event);
+        const listeners = __classPrivateFieldGet(this, _JourneyContext_eventListeners, "f").filter((l) => l.event === event);
+        // ESLint disabled as `listeners[i]` uses an integer key, and the other keys
+        // are derived from the list of `listeners`, which are not manipulated at
+        // runtime (only set by dev in code).
+        /* eslint-disable security/detect-object-injection */
         for (let i = 0, l = listeners.length; i < l; i++) {
             const { waypoint, field, handler } = listeners[i];
             let logMessage;
             let runHandler = false;
             if (!waypoint && !field) {
-                logMessage = `Calling generic event handler`;
+                logMessage = 'Calling generic event handler';
                 runHandler = true;
             }
             else if (waypoint && !field) {
                 logMessage = `Calling waypoint-specific event handler on "${waypoint}"`;
-                runHandler = !isEqual((_a = this.data) === null || _a === void 0 ? void 0 : _a[waypoint], (_b = previousContext.data) === null || _b === void 0 ? void 0 : _b[waypoint]);
+                runHandler = ((_a = previousContext.data) === null || _a === void 0 ? void 0 : _a[waypoint]) !== undefined && !isEqual((_b = this.data) === null || _b === void 0 ? void 0 : _b[waypoint], (_c = previousContext.data) === null || _c === void 0 ? void 0 : _c[waypoint]);
             }
             else if (waypoint && field) {
                 logMessage = `Calling field-specific event handler on "${waypoint} : ${field}"`;
-                runHandler = !isEqual((_d = (_c = this.data) === null || _c === void 0 ? void 0 : _c[waypoint]) === null || _d === void 0 ? void 0 : _d[field], (_f = (_e = previousContext.data) === null || _e === void 0 ? void 0 : _e[waypoint]) === null || _f === void 0 ? void 0 : _f[field]);
+                runHandler = ((_e = (_d = previousContext.data) === null || _d === void 0 ? void 0 : _d[waypoint]) === null || _e === void 0 ? void 0 : _e[field]) !== undefined && !isEqual((_g = (_f = this.data) === null || _f === void 0 ? void 0 : _f[waypoint]) === null || _g === void 0 ? void 0 : _g[field], (_j = (_h = previousContext.data) === null || _h === void 0 ? void 0 : _h[waypoint]) === null || _j === void 0 ? void 0 : _j[field]);
             }
             if (runHandler) {
                 log.trace(logMessage);
                 handler({ journeyContext: this, previousContext });
             }
         }
+        /* eslint-enable security/detect-object-injection */
+        return this;
     }
     /* ----------------------------------------------- session context handling */
     /**
@@ -503,6 +425,7 @@ class JourneyContext {
     static initContextStore(session) {
         if (!has(session, 'journeyContextList')) {
             log.trace('Initialising session with a default journey context list');
+            /* eslint-disable-next-line no-param-reassign */
             session.journeyContextList = Object.create(null);
             const defaultContext = new JourneyContext();
             defaultContext.identity.id = JourneyContext.DEFAULT_CONTEXT_ID;
@@ -540,6 +463,8 @@ class JourneyContext {
      */
     static getContextById(session, id) {
         if (has(session === null || session === void 0 ? void 0 : session.journeyContextList, id)) {
+            // ESLint disabled as `id` has been verified as an "own" property
+            /* eslint-disable-next-line security/detect-object-injection */
             return JourneyContext.fromObject(session.journeyContextList[id]);
         }
         return undefined;
@@ -633,7 +558,8 @@ class JourneyContext {
     }
     static removeContextById(session, id) {
         if (session && has(session.journeyContextList, id)) {
-            /* eslint-disable-next-line no-param-reassign */
+            // ESLint disabled as `id` has been verified as an "own" property
+            /* eslint-disable-next-line security/detect-object-injection, no-param-reassign */
             delete session.journeyContextList[id];
         }
     }