@dwp/govuk-casa 7.0.6 → 8.0.0-beta1

package/dist/lib/MutableRouter.d.ts

@@ -0,0 +1,155 @@
+export default class MutableRouter {
+    /**
+     * Seals this router to make it immutable. Returns the ExpressJS router.
+     *
+     * @returns {Router} ExpressJS Router
+     */
+    seal(): Router;
+    /**
+     * Prepend middleware function(s) using the `all()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    prependAll(path: string, ...callbacks: Function[]): void;
+    /**
+     * Prepend middleware function(s) using the `get()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    prependGet(path: string, ...callbacks: Function[]): void;
+    /**
+     * Prepend middleware function(s) using the `post()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    prependPost(path: string, ...callbacks: Function[]): void;
+    /**
+     * Prepend middleware function(s) using the `delete()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    prependDelete(path: string, ...callbacks: Function[]): void;
+    /**
+     * Prepend middleware function(s) using the `put()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    prependPut(path: string, ...callbacks: Function[]): void;
+    /**
+     * Prepend middleware function(s) using the `use()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    prependUse(path: string, ...callbacks: Function[]): void;
+    /**
+     * Replace middleware function(s) that were mounted using the `all()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    replaceAll(path: string, ...callbacks: Function[]): void;
+    /**
+     * Replace middleware function(s) that were mounted using the `get()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    replaceGet(path: string, ...callbacks: Function[]): void;
+    /**
+     * Replace middleware function(s) that were mounted using the `post()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    replacePost(path: string, ...callbacks: Function[]): void;
+    /**
+     * Replace middleware function(s) that were mounted using the `delete()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    replaceDelete(path: string, ...callbacks: Function[]): void;
+    /**
+     * Replace middleware function(s) that were mounted using the `put()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    replacePut(path: string, ...callbacks: Function[]): void;
+    /**
+     * Replace middleware function(s) that were mounted using the `use()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    replaceUse(path: string, ...callbacks: Function[]): void;
+    /**
+     * Append middleware function(s) using the `all()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    all(path: string, ...callbacks: Function[]): void;
+    /**
+     * Append middleware function(s) using the `get()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    get(path: string, ...callbacks: Function[]): void;
+    /**
+     * Append middleware function(s) using the `post()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    post(path: string, ...callbacks: Function[]): void;
+    /**
+     * Append middleware function(s) using the `delete()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    delete(path: string, ...callbacks: Function[]): void;
+    /**
+     * Append middleware function(s) using the `put()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    put(path: string, ...callbacks: Function[]): void;
+    /**
+     * Append middleware function(s) using the `use()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    use(path: string, ...callbacks: Function[]): void;
+    route(): void;
+    #private;
+}
+import { Router } from "express";

package/dist/lib/MutableRouter.js

@@ -0,0 +1,277 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _MutableRouter_instances, _MutableRouter_stack, _MutableRouter_router, _MutableRouter_sealed, _MutableRouter_append, _MutableRouter_prepend, _MutableRouter_replace;
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable sonarjs/no-duplicate-string,class-methods-use-this */
+const express_1 = require("express");
+class MutableRouter {
+    /**
+     * Mutable router.
+     *
+     * @class
+     */
+    constructor() {
+        _MutableRouter_instances.add(this);
+        /**
+         * @type {Array}
+         */
+        _MutableRouter_stack.set(this, void 0);
+        /**
+         * @type {Router}
+         */
+        _MutableRouter_router.set(this, void 0);
+        /**
+         * @type {boolean}
+         */
+        _MutableRouter_sealed.set(this, void 0);
+        __classPrivateFieldSet(this, _MutableRouter_router, new express_1.Router(), "f");
+        __classPrivateFieldSet(this, _MutableRouter_stack, [], "f");
+        __classPrivateFieldSet(this, _MutableRouter_sealed, false, "f");
+    }
+    /**
+     * Seals this router to make it immutable. Returns the ExpressJS router.
+     *
+     * @returns {Router} ExpressJS Router
+     */
+    seal() {
+        if (__classPrivateFieldGet(this, _MutableRouter_sealed, "f")) {
+            return __classPrivateFieldGet(this, _MutableRouter_router, "f");
+        }
+        __classPrivateFieldGet(this, _MutableRouter_stack, "f").forEach(({ method, args }) => {
+            __classPrivateFieldGet(this, _MutableRouter_router, "f")[method].call(__classPrivateFieldGet(this, _MutableRouter_router, "f"), ...args);
+        });
+        __classPrivateFieldSet(this, _MutableRouter_sealed, true, "f");
+        return __classPrivateFieldGet(this, _MutableRouter_router, "f");
+    }
+    /* ------------------------------------------------------------- prependers */
+    /**
+     * Prepend middleware function(s) using the `all()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    prependAll(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_prepend).call(this, 'all', path, ...callbacks);
+    }
+    /**
+     * Prepend middleware function(s) using the `get()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    prependGet(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_prepend).call(this, 'get', path, ...callbacks);
+    }
+    /**
+     * Prepend middleware function(s) using the `post()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    prependPost(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_prepend).call(this, 'post', path, ...callbacks);
+    }
+    /**
+     * Prepend middleware function(s) using the `delete()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    prependDelete(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_prepend).call(this, 'delete', path, ...callbacks);
+    }
+    /**
+     * Prepend middleware function(s) using the `put()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    prependPut(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_prepend).call(this, 'put', path, ...callbacks);
+    }
+    /**
+     * Prepend middleware function(s) using the `use()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    prependUse(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_prepend).call(this, 'use', path, ...callbacks);
+    }
+    /* -------------------------------------------------------------- replacers */
+    // TODO: How do we handle multiple routes on the same path?
+    /**
+     * Replace middleware function(s) that were mounted using the `all()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    replaceAll(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_replace).call(this, 'all', path, ...callbacks);
+    }
+    /**
+     * Replace middleware function(s) that were mounted using the `get()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    replaceGet(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_replace).call(this, 'get', path, ...callbacks);
+    }
+    /**
+     * Replace middleware function(s) that were mounted using the `post()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    replacePost(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_replace).call(this, 'post', path, ...callbacks);
+    }
+    /**
+     * Replace middleware function(s) that were mounted using the `delete()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    replaceDelete(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_replace).call(this, 'delete', path, ...callbacks);
+    }
+    /**
+     * Replace middleware function(s) that were mounted using the `put()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    replacePut(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_replace).call(this, 'put', path, ...callbacks);
+    }
+    /**
+     * Replace middleware function(s) that were mounted using the `use()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    replaceUse(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_replace).call(this, 'use', path, ...callbacks);
+    }
+    /* ---------------------------------------------- express.Router() wrappers */
+    /**
+     * Append middleware function(s) using the `all()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    all(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_append).call(this, 'all', path, ...callbacks);
+    }
+    /**
+     * Append middleware function(s) using the `get()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    get(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_append).call(this, 'get', path, ...callbacks);
+    }
+    /**
+     * Append middleware function(s) using the `post()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    post(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_append).call(this, 'post', path, ...callbacks);
+    }
+    /**
+     * Append middleware function(s) using the `delete()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    delete(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_append).call(this, 'delete', path, ...callbacks);
+    }
+    /**
+     * Append middleware function(s) using the `put()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    put(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_append).call(this, 'put', path, ...callbacks);
+    }
+    /**
+     * Append middleware function(s) using the `use()` method.
+     *
+     * @param {string} path route path
+     * @param  {...Function} callbacks Middleware functions
+     * @returns {void}
+     */
+    use(path, ...callbacks) {
+        __classPrivateFieldGet(this, _MutableRouter_instances, "m", _MutableRouter_append).call(this, 'use', path, ...callbacks);
+    }
+    route() {
+        throw new Error('route() method is not supported on MutableRouter. Use verb methods for now.');
+    }
+}
+exports.default = MutableRouter;
+_MutableRouter_stack = new WeakMap(), _MutableRouter_router = new WeakMap(), _MutableRouter_sealed = new WeakMap(), _MutableRouter_instances = new WeakSet(), _MutableRouter_append = function _MutableRouter_append(method, path, ...callbacks) {
+    if (__classPrivateFieldGet(this, _MutableRouter_sealed, "f")) {
+        throw new Error('Cannot alter middleware in a sealed mutable router');
+    }
+    __classPrivateFieldGet(this, _MutableRouter_stack, "f").push({
+        method,
+        path,
+        args: [path, ...callbacks],
+    });
+}, _MutableRouter_prepend = function _MutableRouter_prepend(method, path, ...callbacks) {
+    if (__classPrivateFieldGet(this, _MutableRouter_sealed, "f")) {
+        throw new Error('Cannot alter middleware in a sealed mutable router');
+    }
+    __classPrivateFieldGet(this, _MutableRouter_stack, "f").splice(0, 0, {
+        method,
+        path,
+        args: [path, ...callbacks],
+    });
+}, _MutableRouter_replace = function _MutableRouter_replace(method, path, ...callbacks) {
+    if (__classPrivateFieldGet(this, _MutableRouter_sealed, "f")) {
+        throw new Error('Cannot alter middleware in a sealed mutable router');
+    }
+    const finder = (command) => `${command.method}|${command.path}` === `${method}|${path}`;
+    const index = __classPrivateFieldGet(this, _MutableRouter_stack, "f").findIndex(finder);
+    if (index > -1) {
+        __classPrivateFieldGet(this, _MutableRouter_stack, "f").splice(index, 1, {
+            method,
+            path,
+            args: [path, ...callbacks],
+        });
+        __classPrivateFieldSet(this, _MutableRouter_stack, __classPrivateFieldGet(this, _MutableRouter_stack, "f").filter((command, idx) => idx <= index || !finder(command)), "f");
+    }
+};

package/dist/lib/Plan.d.ts

@@ -0,0 +1,154 @@
+export default class Plan {
+    /**
+     * Waypoints using the url:// protocol are known as "exit nodes" as they
+     * indicate an exit point to another Plan.
+     *
+     * @param {string} name Waypoint name
+     * @returns {boolean} True if the waypoint is a url:// type
+     */
+    static isExitNode(name: string): boolean;
+    /**
+     * Create a Plan.
+     *
+     * @param {object} opts Options
+     * @param {boolean} [opts.validateBeforeRouteCondition=true] Check page validity before conditions
+     * @param {Function|string} [opts.arbiter=undefined] Arbitration mechanism
+     */
+    constructor(opts?: {
+        validateBeforeRouteCondition?: boolean | undefined;
+        arbiter?: string | Function | undefined;
+    });
+    getOptions(): any;
+    /**
+     * Retrieve the list of skippable waypoints.
+     *
+     * @returns {string[]} List of skippable waypoints
+     */
+    getSkippables(): string[];
+    /**
+     * Add one or more skippable waypoints.
+     *
+     * @param  {...string} waypoints Waypoints
+     * @returns {Plan}{ Chain}
+     */
+    addSkippables(...waypoints: string[]): Plan;
+    /**
+     * Check if the user can skip the named waypoint.
+     *
+     * @param {string} waypoint Waypoint
+     * @returns {boolean} True if waypoint can be skipped
+     */
+    isSkippable(waypoint: string): boolean;
+    getWaypoints(): any;
+    containsWaypoint(waypoint: any): any;
+    getRoutes(): any;
+    getRouteCondition(src: any, tgt: any, name: any): any;
+    /**
+     * Return all outward routes (out-edges) from the given waypoint, to the
+     * optional target waypoint.
+     *
+     * @param {string} src Source waypoint.
+     * @param {string} tgt Target waypoint (optional).
+     * @returns {Array<object>} Route objects found.
+     */
+    getOutwardRoutes(src: string, tgt?: string): Array<object>;
+    /**
+     * Return all outward routes (out-edges) from the given waypoint, to the
+     * optional target waypoint, matching the "prev" name.
+     *
+     * @param {string} src Source waypoint.
+     * @param {string} tgt Target waypoint (optional).
+     * @returns {Array<object>} Route objects found.
+     */
+    getPrevOutwardRoutes(src: string, tgt?: string): Array<object>;
+    addSequence(...waypoints: any[]): void;
+    setNextRoute(src: any, tgt: any, follow: any): Plan;
+    setPrevRoute(src: any, tgt: any, follow: any): Plan;
+    /**
+     * Adds both a "next" and "prev" route between the two waypoints.
+     *
+     * By default, the "prev" route will use the same "follow" test as the "next"
+     * route. This makes sense in that in order to get the target, the test must
+     * have been true, and so to reverse the direction we also need that same test
+     * to be true.
+     *
+     * However, if the condition function uses the `source`/`target`
+     * of the route in some way, then we must reverse these before passing to the
+     * condition on the "prev" route because `source` in the condition will almost
+     * certainly be referring to the source of the "next" route.
+     *
+     * If `tgt` is an egress node, do not create a `prev` route for it, because
+     * there's no way back from that point to this Plan.
+     *
+     * @param {string} src Source waypoint.
+     * @param {string} tgt Target waypoint.
+     * @param {Function} followNext Follow test function.
+     * @param {Function} followPrev Follow test function.
+     * @returns {Plan} Self.
+     */
+    setRoute(src: string, tgt: string, followNext?: Function, followPrev?: Function): Plan;
+    /**
+     * Create a named route between two waypoints, and give that route a function
+     * that determine whether it should be followed during traversal operations.
+     * Note that the source waypoint must be in a successful validation state
+     * to be considered for traversal, regardless of what the custom function
+     * determines.
+     *
+     * You may also define routes that take the user to any generic URL within the
+     * same domain by using the `url://` protocol. These are considered
+     * "exit nodes".
+     *
+     * setNamedRoute("my-waypoint", "url:///some/absolute/url");
+     *
+     * @param {string} src Source waypoint.
+     * @param {string} tgt Target waypoint.
+     * @param {string} name Name of the route (must be unique for this waypoint pairing).
+     * @param {Function} follow Test function to determine if route can be followed.
+     * @returns {Plan} Chain
+     * @throws {Error} If attempting to create a "next" route from an exit node
+     */
+    setNamedRoute(src: string, tgt: string, name: string, follow: Function): Plan;
+    /**
+     * This is a convenience method for traversing all "next" routes, and returning
+     * the IDs of all waypoints visited along the way.
+     *
+     * @param {JourneyContext} context Journey Context.
+     * @param {object} options Options.
+     * @returns {Array<string>} List of traversed waypoints.
+     */
+    traverse(context: JourneyContext, options?: object): Array<string>;
+    traverseNextRoutes(context: any, options?: {}): object[];
+    traversePrevRoutes(context: any, options?: {}): object[];
+    /**
+     * Traverse through the plan from a particular starting waypoint. This is a
+     * non-exhaustive Graph Exploration.
+     *
+     * The last route in the list will contain the source of the last waypoint that
+     * can be reached, i.e. The waypoint that has no further satisfiable out-edges.
+     *
+     * If a cyclical set of routes are encountered, traversal will stop after
+     * reaching the first repeated waypoint.
+     *
+     * Options:
+     * string startWaypoint = Waypoint from which to start traversal
+     * string routeName = Follow routes matching this name (next | prev)
+     * Map history = Used to detect loops in traversal (internal use)
+     * function stopCondition = Condition that, if true, will stop traversal (useful for performance)
+     * function|string arbiter = If mutliple target routes found, this decides which to use (if any)
+     *
+     * @param {JourneyContext} context Journey context
+     * @param {object} options Options
+     * @returns {Array<object>} Routes that were traversed
+     * @throws {TypeError} When context is not a JourneyContext
+     */
+    traverseRoutes(context: JourneyContext, options?: object): Array<object>;
+    /**
+     * Get raw graph data structure. This can be used with other libraries to
+     * generate graph visualisations, for example.
+     *
+     * @returns {Graph} Graph data structure.
+     */
+    getGraphStructure(): Graph;
+    #private;
+}
+import JourneyContext from "./JourneyContext.js";