@dwp/govuk-casa 9.7.0 → 10.1.0

package/dist/lib/Plan.js

@@ -1,12 +1,8 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const graphlib_1 = require("@dagrejs/graphlib");
-const JourneyContext_js_1 = __importDefault(require("./JourneyContext.js"));
-const logger_js_1 = __importDefault(require("./logger.js"));
-const log = (0, logger_js_1.default)("lib:plan");
+import { Graph } from "@dagrejs/graphlib";
+import JourneyContext from "./JourneyContext.js";
+import NullObject from "./NullObject.js";
+import logger from "./logger.js";
+const log = logger("lib:plan");
 /**
  * @typedef {import("../casa").PlanRoute} PlanRoute
  * @access private
@@ -124,17 +120,23 @@ const makeRouteObject = (dgraph, edge) => {
  * @access private
  */
 const reExitNodeProtocol = /^[a-z]+:\/\//i;
-/**
- * For storing private properties for each instance
- *
- * @access private
- * @todo Use property private class properties.
- */
-const priv = new WeakMap();
-/** @memberof module:@dwp/govuk-casa */
-class Plan {
+/** @memberof module:"@dwp/govuk-casa" */
+export default class Plan {
+    /** @type {graphlib.Graph} - This is our directed, multigraph representation */
+    #dgraph = new Graph({
+        directed: true,
+        multigraph: true,
+        compound: false,
+    });
     /** @type {string[]} These Waypoints can be skipped */
-    #skippableWaypoints;
+    #skippableWaypoints = [];
+    /** @type {{ next: object; previous: object }} */
+    #follows = {
+        next: {},
+        prev: {},
+    };
+    /** @type {PlanConstructorOptions} */
+    #options;
     /**
      * Waypoints using the url:// protocol are known as "exit nodes" as they
      * indicate an exit point to another Plan.
@@ -151,14 +153,8 @@ class Plan {
      * @param {PlanConstructorOptions} opts Options
      */
     constructor(opts = {}) {
-        // This is our directed, multigraph representation
-        const dgraph = new graphlib_1.Graph({
-            directed: true,
-            multigraph: true,
-            compound: false,
-        });
         // Gather options
-        const options = Object.assign(Object.create(null), {
+        const options = Object.assign(new NullObject(), {
             // When true, the validation state of the source node must be `null` (i.e.
             // no validation errors) before any custom route conditions are evaluated.
             validateBeforeRouteCondition: true,
@@ -166,15 +162,7 @@ class Plan {
             arbiter: undefined,
         }, opts);
         Object.freeze(options);
-        priv.set(this, {
-            dgraph,
-            follows: {
-                next: {},
-                prev: {},
-            },
-            options,
-        });
-        this.#skippableWaypoints = [];
+        this.#options = options;
     }
     /**
      * Retrieve the options set on this Plan.
@@ -182,7 +170,7 @@ class Plan {
      * @returns {PlanConstructorOptions} Options map
      */
     getOptions() {
-        return priv.get(this).options;
+        return this.#options;
     }
     /**
      * Retrieve the list of skippable waypoints.
@@ -217,7 +205,7 @@ class Plan {
      * @returns {string[]} List of waypoints
      */
     getWaypoints() {
-        return priv.get(this).dgraph.nodes();
+        return this.#dgraph.nodes();
     }
     /**
      * Determine if the given waypoint exists in this Plan.
@@ -234,10 +222,9 @@ class Plan {
      * @returns {PlanRoute[]} Routes
      */
     getRoutes() {
-        const self = priv.get(this);
-        return self.dgraph
+        return this.#dgraph
             .edges()
-            .map((edge) => makeRouteObject(self.dgraph, edge));
+            .map((edge) => makeRouteObject(this.#dgraph, edge));
     }
     /**
      * Get the condition function for the given parameters.
@@ -248,7 +235,7 @@ class Plan {
      * @returns {PlanRouteCondition} Route condition function
      */
     getRouteCondition(src, tgt, name) {
-        return priv.get(this).follows[validateRouteName(name)][`${src}/${tgt}`];
+        return this.#follows[validateRouteName(name)][`${src}/${tgt}`];
     }
     /**
      * Return all outward routes (out-edges) from the given waypoint, to the
@@ -259,10 +246,9 @@ class Plan {
      * @returns {PlanRoute[]} Route objects found.
      */
     getOutwardRoutes(src, tgt = null) {
-        const self = priv.get(this);
-        return self.dgraph
+        return this.#dgraph
             .outEdges(src, tgt)
-            .map((e) => makeRouteObject(self.dgraph, e));
+            .map((e) => makeRouteObject(this.#dgraph, e));
     }
     /**
      * Return all outward routes (out-edges) from the given waypoint, to the
@@ -376,7 +362,6 @@ class Plan {
      * @throws {Error} If attempting to create a "next" route from an exit node
      */
     setNamedRoute(src, tgt, name, follow) {
-        const self = priv.get(this);
         // Validate
         validateWaypointId(src);
         validateWaypointId(tgt);
@@ -387,14 +372,14 @@ class Plan {
         // Get routing function name to label edge
         const conditionName = follow && follow.name;
         // Warn if we're overwriting an existing edge on the same name
-        if (self.dgraph.hasEdge(src, tgt, name)) {
+        if (this.#dgraph.hasEdge(src, tgt, name)) {
             log.warn("Setting a route that already exists (%s, %s, %s). Will be overridden", src, tgt, name);
         }
-        self.dgraph.setEdge(src, tgt, { conditionName }, name);
+        this.#dgraph.setEdge(src, tgt, { conditionName }, name);
         // Determine which follow function to use
         let followFunc;
         if (follow) {
-            if (!self.options.validateBeforeRouteCondition) {
+            if (!this.#options.validateBeforeRouteCondition) {
                 followFunc = follow;
             }
             else if (name === "next") {
@@ -418,7 +403,7 @@ class Plan {
         }
         // ESLint disabled as `name` has been validated further above
         /* eslint-disable-next-line security/detect-object-injection */
-        self.follows[name][`${src}/${tgt}`] = followFunc;
+        this.#follows[name][`${src}/${tgt}`] = followFunc;
         return this;
     }
     /**
@@ -471,27 +456,26 @@ class Plan {
      * @throws {TypeError} When context is not a JourneyContext
      */
     traverseRoutes(context, options = {}) {
-        if (!(context instanceof JourneyContext_js_1.default)) {
+        if (!(context instanceof JourneyContext)) {
             throw new TypeError(`Expected context to be an instance of JourneyContext, got ${typeof context}`);
         }
-        const self = priv.get(this);
         /** @type {PlanTraverseOptions} */
-        const { startWaypoint = this.getWaypoints()[0], stopCondition = () => false, arbiter = self.options.arbiter, routeName, } = options;
-        if (!self.dgraph.hasNode(startWaypoint)) {
+        const { startWaypoint = this.getWaypoints()[0], stopCondition = () => false, arbiter = this.#options.arbiter, routeName, } = options;
+        if (!this.#dgraph.hasNode(startWaypoint)) {
             throw new ReferenceError(`Plan does not contain waypoint '${startWaypoint}'`);
         }
         validateRouteName(routeName);
         const history = new Map();
         const traverse = (startWP) => {
-            let target = self.dgraph.outEdges(startWP).filter((e) => {
+            let target = this.#dgraph.outEdges(startWP).filter((e) => {
                 if (e.name !== routeName) {
                     return false;
                 }
-                const route = makeRouteObject(self.dgraph, e);
+                const route = makeRouteObject(this.#dgraph, e);
                 try {
                     // ESLint disabled as `routeName` has been validated further above
                     /* eslint-disable-next-line security/detect-object-injection */
-                    return self.follows[routeName][`${e.v}/${e.w}`](route, context);
+                    return this.#follows[routeName][`${e.v}/${e.w}`](route, context);
                 }
                 catch (ex) {
                     log.warn('Route follow function threw an exception, "%s" (%s)', ex.message, `${e.v} -> ${e.w}`);
@@ -516,7 +500,7 @@ class Plan {
                     // Convert to routeObject and back to edge object so that only the
                     // routeObject is used in the public API
                     target = arbiter({
-                        targets: target.map((t) => makeRouteObject(self.dgraph, t)),
+                        targets: target.map((t) => makeRouteObject(this.#dgraph, t)),
                         journeyContext: context,
                         travereOptions: options,
                     });
@@ -532,7 +516,7 @@ class Plan {
                 }
             }
             if (target.length === 1) {
-                const route = makeRouteObject(self.dgraph, target[0]);
+                const route = makeRouteObject(this.#dgraph, target[0]);
                 const routeHash = `${route.name}/${route.source}/${route.target}`;
                 if (stopCondition(route)) {
                     return [route];
@@ -553,7 +537,7 @@ class Plan {
                 log.debug("Encountered loop (%s). Stopping traversal.", `${route.source} -> ${route.target}`);
             }
             return [
-                makeRouteObject(self.dgraph, {
+                makeRouteObject(this.#dgraph, {
                     v: startWP,
                     w: null,
                     name: routeName,
@@ -570,8 +554,6 @@ class Plan {
      * @returns {Graph} Graph data structure.
      */
     getGraphStructure() {
-        return priv.get(this).dgraph;
+        return this.#dgraph;
     }
 }
-exports.default = Plan;
-//# sourceMappingURL=Plan.js.map

package/dist/lib/ValidationError.d.ts

@@ -11,7 +11,7 @@
  * @access private
  */
 /**
- * @memberof module:@dwp/govuk-casa
+ * @memberof module:"@dwp/govuk-casa"
  * @class
  */
 export default class ValidationError {
@@ -63,3 +63,4 @@ export default class ValidationError {
 export type ValidateContext = import("../casa").ValidateContext;
 export type ErrorMessageConfig = import("../casa").ErrorMessageConfig;
 export type ErrorMessageConfigObject = import("../casa").ErrorMessageConfigObject;
+//# sourceMappingURL=ValidationError.d.ts.map

package/dist/lib/ValidationError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationError.d.ts","sourceRoot":"","sources":["../../src/lib/ValidationError.js"],"names":[],"mappings":"AAIA;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AACH;IACE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,uCAPG;QAAiC,QAAQ,EAAjC,kBAAkB;QAEK,WAAW;KAE1C,GAAU,eAAe,CAsC3B;IAED;;;;OAIG;IACH,yBAFW,MAAM,GAAG,wBAAwB,EAsC3C;IAED;;;;;OAKG;IACH,qBAHW,eAAe,GACb,eAAe,CAiC3B;IAzBG,eAAwD;IAgBxD,0BAAiE;IACjE,8BAA0B;IAC1B,iBAAoC;IAItC,8BAA+C;CAIlD;8BA/JY,OAAO,SAAS,EAAE,eAAe;iCAKjC,OAAO,SAAS,EAAE,kBAAkB;uCAKpC,OAAO,SAAS,EAAE,wBAAwB"}

package/dist/lib/ValidationError.js

@@ -1,10 +1,4 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const lodash_1 = __importDefault(require("lodash"));
-const { isPlainObject } = lodash_1.default; // CommonJS
+import isPlainObject from "is-plain-obj";
 const params = new WeakMap();
 /**
  * @typedef {import("../casa").ValidateContext} ValidateContext
@@ -19,10 +13,10 @@ const params = new WeakMap();
  * @access private
  */
 /**
- * @memberof module:@dwp/govuk-casa
+ * @memberof module:"@dwp/govuk-casa"
  * @class
  */
-class ValidationError {
+export default class ValidationError {
     /**
      * Make a ValidationError instance from a primitive object (or a function that
      * returns a primitive object) that is specific to the given journey context.
@@ -149,5 +143,3 @@ class ValidationError {
         return this;
     }
 }
-exports.default = ValidationError;
-//# sourceMappingURL=ValidationError.js.map

package/dist/lib/ValidatorFactory.d.ts

@@ -19,11 +19,11 @@
  * @access private
  */
 /**
- * @typedef {Object<string, unknown>} ValidatorFactoryOptions
+ * @typedef {{ [key: string]: unknown }} ValidatorFactoryOptions
  * @property {ErrorMessageConfig} errorMsg Error message
  */
 /**
- * @memberof module:@dwp/govuk-casa
+ * @memberof module:"@dwp/govuk-casa"
  * @class
  */
 export default class ValidatorFactory {
@@ -44,9 +44,7 @@ export default class ValidatorFactory {
      *   validator)
      */
     constructor(config?: ValidatorFactoryOptions);
-    config: {
-        [x: string]: unknown;
-    };
+    config: ValidatorFactoryOptions;
     /**
      * Validate the given value.
      *
@@ -70,5 +68,6 @@ export type ValidationError = import("./index").ValidationError;
 export type ValidateContext = import("../casa").ValidateContext;
 export type Validator = import("../casa").Validator;
 export type ValidatorFactoryOptions = {
-    [x: string]: unknown;
+    [key: string]: unknown;
 };
+//# sourceMappingURL=ValidatorFactory.d.ts.map

package/dist/lib/ValidatorFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidatorFactory.d.ts","sourceRoot":"","sources":["../../src/lib/ValidatorFactory.js"],"names":[],"mappings":"AAEA;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AACH;IACE;;;;;;;;OAQG;IACH,qBALW,uBAAuB,GAErB,SAAS,CAmBrB;IAED;;;;;OAKG;IACH,qBAHW,uBAAuB,EAUjC;IADC,gCAAoB;IAMtB;;;;;;;OAOG;IACH,qBALW,GAAG,WACH,eAAe,GACb,eAAe,EAAE,CAK7B;IAED;;;;;OAKG;IACH,qBAHW,GAAG,GACD,GAAG,CAIf;CACF;iCApGY,OAAO,SAAS,EAAE,kBAAkB;6BAKpC,OAAO,SAAS,EAAE,cAAc;8BAKhC,OAAO,SAAS,EAAE,eAAe;8BAKjC,OAAO,SAAS,EAAE,eAAe;wBAKjC,OAAO,SAAS,EAAE,SAAS;sCAK3B;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE"}

package/dist/lib/ValidatorFactory.js

@@ -1,10 +1,4 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const lodash_1 = __importDefault(require("lodash"));
-const { isPlainObject } = lodash_1.default; // CommonJS
+import isPlainObject from "is-plain-obj";
 /**
  * @typedef {import("../casa").ErrorMessageConfig} ErrorMessageConfig
  * @access private
@@ -26,14 +20,14 @@ const { isPlainObject } = lodash_1.default; // CommonJS
  * @access private
  */
 /**
- * @typedef {Object<string, unknown>} ValidatorFactoryOptions
+ * @typedef {{ [key: string]: unknown }} ValidatorFactoryOptions
  * @property {ErrorMessageConfig} errorMsg Error message
  */
 /**
- * @memberof module:@dwp/govuk-casa
+ * @memberof module:"@dwp/govuk-casa"
  * @class
  */
-class ValidatorFactory {
+export default class ValidatorFactory {
     /**
      * This is a convenience method that will return a consistently object
      * structure containing validation and sanitisation methods.
@@ -91,5 +85,3 @@ class ValidatorFactory {
         return fieldValue;
     }
 }
-exports.default = ValidatorFactory;
-//# sourceMappingURL=ValidatorFactory.js.map

package/dist/lib/configuration-ingestor.d.ts

@@ -125,16 +125,6 @@ export function validateSessionStore(store: Function): Function;
  * @access private
  */
 export function validateSessionCookiePath(cookiePath: string, defaultPath?: string): string;
-/**
- * Validates and sanitises sessions cookie "sameSite" flag. One of: true
- * (Strict) false (will not set the flag at all) Strict Lax None
- *
- * @param {any} cookieSameSite Session cookie "sameSite" flag
- * @param {any} defaultFlag Default path if none specified
- * @returns {boolean} Cookie path
- * @throws {TypeError} When invalid arguments are provided
- * @access private
- */
 /**
  * Validates errorVisibility.
  *
@@ -146,11 +136,16 @@ export function validateSessionCookiePath(cookiePath: string, defaultPath?: stri
  */
 export function validateErrorVisibility(errorVisibility?: string): symbol | Function;
 /**
- * @param {boolean | string} cookieSameSite Cookie SameSite value
- * @param {boolean | string} defaultFlag Default value
+ * Validates and sanitises sessions cookie "sameSite" flag. One of: true
+ * (Strict) false (will not set the flag at all) Strict Lax None
+ *
+ * @param {CookieSameSite} cookieSameSite Session cookie "sameSite" flag
+ * @param {CookieSameSite} defaultFlag Default value
  * @returns {boolean | string} Validated value
+ * @throws {TypeError} When invalid arguments are provided
+ * @access private
  */
-export function validateSessionCookieSameSite(cookieSameSite: boolean | string, defaultFlag: boolean | string): boolean | string;
+export function validateSessionCookieSameSite(cookieSameSite: CookieSameSite, defaultFlag: CookieSameSite): boolean | string;
 /**
  * @param {PageHook[]} hooks Page hook functions
  * @returns {PageHook[]} Validated page hooks
@@ -217,15 +212,6 @@ export function validateFormMaxBytes(value: number, defaultValue?: number): numb
  * @throws {TypeError} If not a function
  */
 export function validateContextIdGenerator(generator: ContextIdGenerator): ContextIdGenerator;
-/**
- * Validates the govuk rebrand feature flag.
- *
- * @param {boolean} [govukRebrand] Govuk rebrand feature flag
- * @returns {boolean | true} Boolean.
- * @throws {TypeError} For invalid feagure flag is set.
- * @access private
- */
-export function validateGovukRebrand(govukRebrand?: boolean): boolean | true;
 /**
  * Ingest, validate, sanitise and manipulate configuration parameters.
  *
@@ -243,5 +229,7 @@ export type GlobalHook = import("../casa").GlobalHook;
 export type IPlugin = import("../casa").IPlugin;
 export type ContextEventHandler = import("../casa").ContextEventHandler;
 export type ContextIdGenerator = import("../casa").ContextIdGenerator;
+export type CookieSameSite = true | false | "Lax" | "None" | "Strict" | "auto";
 import { PageField } from "./field.js";
 import Plan from "./Plan.js";
+//# sourceMappingURL=configuration-ingestor.d.ts.map

package/dist/lib/configuration-ingestor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configuration-ingestor.d.ts","sourceRoot":"","sources":["../../src/lib/configuration-ingestor.js"],"names":[],"mappings":"AAkEA;;;;;;;;GAQG;AACH,0CANW,MAAM,kBAEJ,MAAM,CASlB;AAED;;;;;;;;GAQG;AACH,sDAeC;AAED;;;;;;;;GAQG;AACH,4DAeC;AAED;;;;;;;;;GASG;AACH,mDAPW,MAAM,oBAEJ,MAAM,CAqBlB;AAED;;;;;;;GAOG;AACH,2CALW,MAAM,GACJ,MAAM,GAAG,SAAS,CAY9B;AAED;;;;;;;;GAQG;AACH,gDANW,MAAM,kBAEJ,MAAM,CAclB;AAED;;;;;;;;GAQG;AACH,mDAeC;AAED;;;;;;;;GAQG;AACH,8CANW,MAAM,GACJ,MAAM,CAYlB;AAED;;;;;;;;GAQG;AACH,yCANW,MAAM,GACJ,MAAM,CAUlB;AAED;;;;;;;;GAQG;AACH,2CANW,MAAM,GACJ,MAAM,CAUlB;AAED;;;;;;;;GAQG;AACH,+CANW,OAAO,GACL,MAAM,CAelB;AAED;;;;;;GAMG;AACH,gEAQC;AAED;;;;;;;GAOG;AACH,sDALW,MAAM,gBACN,MAAM,GACJ,MAAM,CAQlB;AAED;;;;;;;;GAQG;AACH,0DANW,MAAM,GAEJ,MAAM,WAAW,CAoB7B;AAED;;;;;;;;;GASG;AACH,8DANW,cAAc,eACd,cAAc,GACZ,OAAO,GAAG,MAAM,CAyB5B;AAcD;;;GAGG;AACH,yCAHW,QAAQ,EAAE,GACR,QAAQ,EAAE,CAYtB;AAeD;;;GAGG;AACH,uCAHW,SAAS,EAAE,GACT,SAAS,EAAE,CAYvB;AAqBD;;;GAGG;AACH,sCAHW,IAAI,EAAE,GACJ,IAAI,EAAE,CAYlB;AAED;;;GAGG;AACH,mCAHW,IAAI,GACF,IAAI,CAYhB;AAiBD;;;GAGG;AACH,2CAHW,UAAU,EAAE,GACV,UAAU,EAAE,CAexB;AAED;;;GAGG;AACH,yCAHW,OAAO,EAAE,GACP,OAAO,EAAE,CAIrB;AAED;;;GAGG;AACH,uCAHW,mBAAmB,EAAE,GACnB,mBAAmB,EAAE,CAIjC;AAED;;;;;;;GAOG;AACH,+DALW,kBAAkB,GAChB,kBAAkB,CAa9B;AAED;;;;;;GAMG;AACH,6CANW,MAAM,iBACN,MAAM,GACJ,MAAM,CAoBlB;AAED;;;;;;GAMG;AACH,4CANW,MAAM,iBACN,MAAM,GACJ,MAAM,CAsBlB;AAED;;;;GAIG;AACH,sDAJW,kBAAkB,GAChB,kBAAkB,CAa9B;AAED;;;;;;;GAOG;AACH,wCALW,oBAAoB,GAClB,MAAM,CAiElB;mCA/qBY,OAAO,SAAS,EAAE,oBAAoB;iCAKtC,OAAO,SAAS,EAAE,kBAAkB;mBAKpC,OAAO,SAAS,EAAE,IAAI;uBAKtB,OAAO,SAAS,EAAE,QAAQ;yBAK1B,OAAO,SAAS,EAAE,UAAU;sBAK5B,OAAO,SAAS,EAAE,OAAO;kCAKzB,OAAO,SAAS,EAAE,mBAAmB;iCAKrC,OAAO,SAAS,EAAE,kBAAkB;6BAKpC,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM;0BAzDpC,YAAY;iBAErB,WAAW"}