@dwp/govuk-casa 8.2.1 → 8.2.4

package/dist/lib/validators/regex.d.ts

@@ -1,6 +1,40 @@
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} RegexConfigOptions
+ * @property {ErrorMessageConfig} errorMsg Error message config
+ * @property {RegExp} pattern Regular expression to test against
+ * @property {boolean} invert Return error on positive regex match
+ */
+/**
+ * Match a string pattern.
+ *
+ * See {@link RegexConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
+ */
 export default class Regex extends ValidatorFactory {
     name: string;
-    validate(value?: string, dataContext?: {}): object[];
+    validate(value?: string, dataContext?: {}): ValidationError[];
     sanitise(value: any): string | undefined;
 }
+export type ErrorMessageConfig = import('../../casa').ErrorMessageConfig;
+export type RegexConfigOptions = {
+    /**
+     * Error message config
+     */
+    errorMsg: ErrorMessageConfig;
+    /**
+     * Regular expression to test against
+     */
+    pattern: RegExp;
+    /**
+     * Return error on positive regex match
+     */
+    invert: boolean;
+};
 import ValidatorFactory from "../ValidatorFactory.js";
+import ValidationError from "../ValidationError.js";

package/dist/lib/validators/regex.js

@@ -4,17 +4,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable class-methods-use-this */
+const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
+const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
+const utils_js_1 = require("../utils.js");
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} RegexConfigOptions
+ * @property {ErrorMessageConfig} errorMsg Error message config
+ * @property {RegExp} pattern Regular expression to test against
+ * @property {boolean} invert Return error on positive regex match
+ */
 /**
  * Match a string pattern.
  *
- * Config options:
- *   string|object errorMsg = Error message to use on validation failure
- *   RegExp pattern = Regular expression to test against
- *   boolean invert = return reject on positive regex match
+ * See {@link RegexConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
  */
-const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
-const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
-const utils_js_1 = require("../utils.js");
 class Regex extends ValidatorFactory_js_1.default {
     constructor() {
         super(...arguments);

package/dist/lib/validators/required.d.ts

@@ -1,8 +1,35 @@
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} RequiredConfigOptions
+ * @property {ErrorMessageConfig} errorMsg Error message config
+ */
+/**
+ * Test if value is present.
+ *
+ * Value is required. The following values will fail this rule:
+ *  (all values that satisify `isEmpty()`) plus '\s'
+ *
+ * See {@link RequiredConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
+ */
 export default class Required extends ValidatorFactory {
     name: string;
-    validate(value: any, dataContext?: {}): object[];
+    validate(value: any, dataContext?: {}): ValidationError[];
     sanitise(value: any): string | (string | undefined)[] | {
         [k: string]: string | undefined;
     } | undefined;
 }
+export type ErrorMessageConfig = import('../../casa').ErrorMessageConfig;
+export type RequiredConfigOptions = {
+    /**
+     * Error message config
+     */
+    errorMsg: ErrorMessageConfig;
+};
 import ValidatorFactory from "../ValidatorFactory.js";
+import ValidationError from "../ValidationError.js";

package/dist/lib/validators/required.js

@@ -4,17 +4,30 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable class-methods-use-this */
-/**
- * Test is value is present.
- *
- * Value is required. The following values will fail this rule:
- *  (all values that satisify `isEmpty()`) plus '\s'
- */
 const lodash_1 = __importDefault(require("lodash"));
 const utils_js_1 = require("../utils.js");
 const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
 const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
 const { isPlainObject } = lodash_1.default; // CommonJS
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} RequiredConfigOptions
+ * @property {ErrorMessageConfig} errorMsg Error message config
+ */
+/**
+ * Test if value is present.
+ *
+ * Value is required. The following values will fail this rule:
+ *  (all values that satisify `isEmpty()`) plus '\s'
+ *
+ * See {@link RequiredConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
+ */
 class Required extends ValidatorFactory_js_1.default {
     constructor() {
         super(...arguments);

package/dist/lib/validators/strlen.d.ts

@@ -1,6 +1,45 @@
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} StrlenConfigOptions
+ * @property {ErrorMessageConfig} errorMsgMax Error message to use on max length failure
+ * @property {ErrorMessageConfig} errorMsgMin Error message to use on min length failure
+ * @property {number} max Maximum string length allowed
+ * @property {number} min Minimum string length required
+ */
+/**
+ * Test the length of a string.
+ *
+ * See {@link StrlenConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
+ */
 export default class Strlen extends ValidatorFactory {
     name: string;
-    validate(inputValue?: string, dataContext?: {}): object[];
+    validate(inputValue?: string, dataContext?: {}): ValidationError[];
     sanitise(value: any): string | undefined;
 }
+export type ErrorMessageConfig = import('../../casa').ErrorMessageConfig;
+export type StrlenConfigOptions = {
+    /**
+     * Error message to use on max length failure
+     */
+    errorMsgMax: ErrorMessageConfig;
+    /**
+     * Error message to use on min length failure
+     */
+    errorMsgMin: ErrorMessageConfig;
+    /**
+     * Maximum string length allowed
+     */
+    max: number;
+    /**
+     * Minimum string length required
+     */
+    min: number;
+};
 import ValidatorFactory from "../ValidatorFactory.js";
+import ValidationError from "../ValidationError.js";

package/dist/lib/validators/strlen.js

@@ -4,18 +4,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable class-methods-use-this */
+const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
+const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
+const utils_js_1 = require("../utils.js");
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} StrlenConfigOptions
+ * @property {ErrorMessageConfig} errorMsgMax Error message to use on max length failure
+ * @property {ErrorMessageConfig} errorMsgMin Error message to use on min length failure
+ * @property {number} max Maximum string length allowed
+ * @property {number} min Minimum string length required
+ */
 /**
  * Test the length of a string.
  *
- * Config options:
- *   string|object errorMsgMax = Error message to use on max length failure
- *   string|object errorMsgMin = Error message to use on min length failure
- *   int max = Maximum string length allowed
- *   int min = Minimum string length required
+ * See {@link StrlenConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
  */
-const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
-const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
-const utils_js_1 = require("../utils.js");
 class Strlen extends ValidatorFactory_js_1.default {
     constructor() {
         super(...arguments);

package/dist/lib/validators/wordCount.d.ts

@@ -1,7 +1,46 @@
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} WordcountConfigOptions
+ * @property {ErrorMessageConfig} errorMsgMax Error message to use on max length failure
+ * @property {ErrorMessageConfig} errorMsgMin Error message to use on min length failure
+ * @property {number} max Maximum string length allowed
+ * @property {number} min Minimum string length required
+ */
+/**
+ * Test the number of words in a string.
+ *
+ * See {@link WordcountConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
+ */
 export default class WordCount extends ValidatorFactory {
     name: string;
     count(input: any): any;
-    validate(inputValue?: string, dataContext?: {}): object[];
+    validate(inputValue?: string, dataContext?: {}): ValidationError[];
     sanitise(value: any): string | undefined;
 }
+export type ErrorMessageConfig = import('../../casa').ErrorMessageConfig;
+export type WordcountConfigOptions = {
+    /**
+     * Error message to use on max length failure
+     */
+    errorMsgMax: ErrorMessageConfig;
+    /**
+     * Error message to use on min length failure
+     */
+    errorMsgMin: ErrorMessageConfig;
+    /**
+     * Maximum string length allowed
+     */
+    max: number;
+    /**
+     * Minimum string length required
+     */
+    min: number;
+};
 import ValidatorFactory from "../ValidatorFactory.js";
+import ValidationError from "../ValidationError.js";

package/dist/lib/validators/wordCount.js

@@ -4,18 +4,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable class-methods-use-this */
+const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
+const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
+const utils_js_1 = require("../utils.js");
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} WordcountConfigOptions
+ * @property {ErrorMessageConfig} errorMsgMax Error message to use on max length failure
+ * @property {ErrorMessageConfig} errorMsgMin Error message to use on min length failure
+ * @property {number} max Maximum string length allowed
+ * @property {number} min Minimum string length required
+ */
 /**
  * Test the number of words in a string.
  *
- * Config options:
- *   string|object errorMsgMax = Error message to use on max length failure
- *   string|object errorMsgMin = Error message to use on min length failure
- *   int max = Maximum word count allowed
- *   int min = Minimum word count required
+ * See {@link WordcountConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
  */
-const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
-const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
-const utils_js_1 = require("../utils.js");
 class WordCount extends ValidatorFactory_js_1.default {
     constructor() {
         super(...arguments);

package/dist/lib/waypoint-url.d.ts

@@ -1,6 +1,7 @@
 /**
  * Generate a URL pointing at a particular waypoint.
  *
+ * @memberof module:@dwp/govuk-casa
  * @param {object} obj Options
  * @param {string} obj.waypoint Waypoint
  * @param {string} obj.mountUrl Mount URL

package/dist/lib/waypoint-url.js

@@ -1,13 +1,23 @@
 "use strict";
 /**
+ * @access private
  * @typedef {import('./index').JourneyContext} JourneyContext
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+/** @access private */
 const reUrlProtocolExtract = /^url:\/\/(.+)$/i;
+/**
+ * Sanitise a waypoint string.
+ *
+ * @access private
+ * @param {string} w Waypoint
+ * @returns {string} Sanitised waypoint
+ */
 const sanitiseWaypoint = (w) => w.replace(/[^/a-z0-9_-]/ig, '').replace(/\/+/g, '/');
 /**
  * Generate a URL pointing at a particular waypoint.
  *
+ * @memberof module:@dwp/govuk-casa
  * @param {object} obj Options
  * @param {string} obj.waypoint Waypoint
  * @param {string} obj.mountUrl Mount URL

package/dist/middleware/data.js

@@ -35,12 +35,28 @@ function dataMiddleware({ plan, events, }) {
             // Grab chosen language from session
             req.casa.journeyContext.nav.language = req.session.language;
             /* ------------------------------------------------- Template variables */
-            // Figure out the mount URL of the current request
+            // Capture mount URL that will be used in generating all browser URLs
             const mountUrl = (0, utils_js_1.validateUrlPath)(`${req.baseUrl}/`.replace(/\/+/g, '/'));
-            // For browser performance reasons, CASA's static assets are potentially
-            // delivered over a different route to the `mountUrl` if this CASA app has
-            // been mounted on a parameterised route.
-            const staticMountUrl = (0, utils_js_1.validateUrlPath)(`${(0, utils_js_1.stripProxyFromUrlPath)(req)}`.replace(/\/+/g, '/'));
+            // If this CASA app is mounted on a parameterised route, then all of its
+            // static assets (served by `staticRouter`) will, by default, be served
+            // from that dynamic path, for example:
+            //   markup:       <link href="{{ mountUrl }}css/static.css" />
+            //   resolved URL: /mount/<some-id-here>/css/static.css
+            //   baseUrl:      /mount/<some-id>
+            //
+            // From a performance point of view, this is very inefficient as we can't
+            // take advantage of any intermediate caches. So we instead provide am
+            // alternative URL path in the `staticMountUrl` property that excludes the
+            // parameterised element, eg:
+            //   markup:       <link href="{{ staticMountUrl }}css/static.css" />
+            //   resolved URL: /mount/css/static.css
+            //   baseUrl:      /mount
+            //
+            // As the staticRouter is mounted on both the CASA app, and its internal
+            // Router, the `baseUrl` is different in each case, so we cannot rely
+            // on it to be consistent. Hence the need for this property, which will
+            // always be the non-parameterised version of the baseUrl.
+            const staticMountUrl = (0, utils_js_1.validateUrlPath)(`${req.unparameterisedBaseUrl}/`.replace(/\/+/g, '/'));
             // CASA and userland templates
             res.locals.casa = {
                 mountUrl,

package/dist/middleware/gather-fields.js

@@ -9,6 +9,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const JourneyContext_js_1 = __importDefault(require("../lib/JourneyContext.js"));
 /**
+ * @access private
  * @typedef {import('../lib/field').PageField} PageField
  */
 /**

package/dist/middleware/pre.js

@@ -9,6 +9,7 @@ const GA_DOMAIN = '*.google-analytics.com';
 const GA_ANALYTICS_DOMAIN = '*.analytics.google.com';
 const GTM_DOMAIN = 'www.googletagmanager.com';
 /**
+ * @access private
  * @typedef {import('../casa').HelmetConfigurator} HelmetConfigurator
  */
 /**

package/dist/middleware/steer-journey.js

@@ -9,6 +9,7 @@ const waypoint_url_js_1 = __importDefault(require("../lib/waypoint-url.js"));
 const logger_js_1 = __importDefault(require("../lib/logger.js"));
 const log = (0, logger_js_1.default)('middleware:steer-journey');
 /**
+ * @access private
  * @typedef {import('../lib/Plan')} Plan
  */
 /**
@@ -40,7 +41,7 @@ exports.default = ({ waypoint, plan, }) => [
         // Edit mode
         // Cannot be in edit mode if we're already on the `editorigin` URL
         if (req.casa.editMode) {
-            const { pathname: currentPathname } = new URL(req.originalUrl, 'http://placeholder.test/');
+            const { pathname: currentPathname } = new URL(req.originalUrl, 'https://placeholder.test/');
             if (req.casa.editOrigin === currentPathname) {
                 log.debug(`Disabling edit mode as we are on the edit origin (${req.casa.editOrigin})`);
                 req.casa.editMode = false;

package/dist/middleware/strip-proxy-path.d.ts

@@ -0,0 +1,4 @@
+declare function _default({ mountUrl, }: {
+    mountUrl?: string | undefined;
+}): ((req: any, res: any, next: any) => void)[];
+export default _default;

package/dist/middleware/strip-proxy-path.js

@@ -0,0 +1,56 @@
+"use strict";
+// Strip any "proxy path" prefix present on the request URL
+//
+// The default "mountUrl" will be match whatever path that the CASA app
+// instance will be mounted onto. So if you mount on `/a/b/c` then all
+// URLs generated for the browser will be prefixed with `/a/b/c`.
+//
+// Defining a `mountUrl` will change that behaviour into a "proxy mode".
+// This mode assumes you have a forwarding proxy that will alter
+// the incoming request paths from `mountUrl` to the original path you
+// have mounted this CASA app instance onto.
+//
+// For example, if you mount the app on `/a/b/c/x`, but want the browser
+// URLs to just use the `/x` prefix, then pass a `mountUrl` of `/x`.
+//
+// See docs in `docs/guides/setup-behind-a-proxy.md`
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_js_1 = __importDefault(require("../lib/logger.js"));
+const log = (0, logger_js_1.default)('casa:middleware:strip-proxy-path');
+exports.default = ({ mountUrl = '/', }) => [
+    (req, res, next) => {
+        // TODO:
+        // We _may_ have to start tracking the various prefix in order to differentiate
+        // between a proxy prefix, and a parent app's path.
+        var _a;
+        // Assume everything before `mountUrl` is the proxy path prefix and remove it
+        req.originalBaseUrl = (_a = req.originalBaseUrl) !== null && _a !== void 0 ? _a : req.baseUrl;
+        req.baseUrl = mountUrl.replace(/\/$/, '');
+        // If the app has been mounted directly on the specific `mountUrl`, then
+        // there's nothing we need to do and can let this request pass-through.
+        if (req.baseUrl === req.originalBaseUrl) {
+            next();
+        }
+        else if (req.__CASA_BASE_URL_REWRITTEN__) {
+            delete req.__CASA_BASE_URL_REWRITTEN__;
+            next();
+        }
+        else {
+            // Strip the proxy path prefix from the original URL so that
+            // subsequnt middleware sees the URL path as though proxy wasn't there.
+            // req.url will already have the proxy prefix and mountUrl removed.
+            /* eslint-disable security/detect-non-literal-regexp */
+            log.trace(`req.originalUrl before proxy stripping: ${req.originalUrl}`);
+            req.originalUrl = req.originalUrl.replace(new RegExp(`^/.+?${mountUrl}`), mountUrl);
+            log.trace(`req.originalUrl after proxy stripping: ${req.originalUrl}`);
+            /* eslint-enable security/detect-non-literal-regexp */
+            // Issuing this call will re-run this same middleware, so we use this
+            // `__CASA_BASE_URL_REWRITTEN__` flag to prevent recursion.
+            req.__CASA_BASE_URL_REWRITTEN__ = true;
+            req.app.handle(req, res, next);
+        }
+    },
+];

package/dist/middleware/validate-fields.js

@@ -20,6 +20,8 @@ exports.default = ({ waypoint, fields = [], plan, }) => [
     (req, res, next) => {
         var _a, _b;
         const mountUrl = `${req.baseUrl}/`;
+        // Run validators for every field to build up a compelte list of errors
+        // currently associated with this waypoint.
         let errors = [];
         for (let i = 0, l = fields.length; i < l; i++) {
             /* eslint-disable security/detect-object-injection */
@@ -27,6 +29,7 @@ exports.default = ({ waypoint, fields = [], plan, }) => [
             const field = fields[i];
             const fieldName = field.name;
             const fieldValue = (_b = (_a = req.casa.journeyContext.data) === null || _a === void 0 ? void 0 : _a[waypoint]) === null || _b === void 0 ? void 0 : _b[fieldName];
+            // (type = ValidateContext)
             const context = {
                 fieldName,
                 fieldValue,

package/dist/routes/ancillary.d.ts

@@ -1,11 +1,22 @@
+/**
+ * @typedef {object} AncillaryRouterOptions Options to configure static router
+ * @property {number} sessionTtl Session timeout (seconds)
+ */
 /**
  * Create an instance of the ancillary router.
  *
- * @param {Object} options = Optiona
- * @param {number} options.sessionTtl Session timeout (seconds)
- * @returns {MutableRouter} Mutable router
+ * @access private
+ * @param {AncillaryRouterOptions} options Options
+ * @returns {MutableRouter} ExpressJS Router instance
+ */
+export default function ancillaryRouter({ sessionTtl, }: AncillaryRouterOptions): MutableRouter;
+/**
+ * Options to configure static router
  */
-export default function ancillaryRouter({ sessionTtl, }: {
+export type AncillaryRouterOptions = {
+    /**
+     * Session timeout (seconds)
+     */
     sessionTtl: number;
-}): MutableRouter;
+};
 import MutableRouter from "../lib/MutableRouter.js";

package/dist/routes/ancillary.js

@@ -4,12 +4,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const MutableRouter_js_1 = __importDefault(require("../lib/MutableRouter.js"));
+/**
+ * @typedef {object} AncillaryRouterOptions Options to configure static router
+ * @property {number} sessionTtl Session timeout (seconds)
+ */
 /**
  * Create an instance of the ancillary router.
  *
- * @param {Object} options = Optiona
- * @param {number} options.sessionTtl Session timeout (seconds)
- * @returns {MutableRouter} Mutable router
+ * @access private
+ * @param {AncillaryRouterOptions} options Options
+ * @returns {MutableRouter} ExpressJS Router instance
  */
 function ancillaryRouter({ sessionTtl, }) {
     // Router

package/dist/routes/journey.d.ts

@@ -1,7 +1,31 @@
-export default function journeyRouter({ globalHooks, pages, plan, csrfMiddleware, }: {
-    globalHooks: any;
-    pages: any;
-    plan: any;
-    csrfMiddleware: any;
-}): MutableRouter;
+/**
+ * Create an instance of the router for all waypoints visited during a Journey
+ * through the Plan.
+ *
+ * @access private
+ * @param {JourneyRouterOptions} opts Options
+ * @returns {MutableRouter} Router
+ */
+export default function journeyRouter({ globalHooks, pages, plan, csrfMiddleware, }: JourneyRouterOptions): MutableRouter;
+/**
+ * Options to configure static router
+ */
+export type JourneyRouterOptions = {
+    /**
+     * Global hooks
+     */
+    globalHooks: GlobalHook[];
+    /**
+     * Page definitions
+     */
+    pages: Page[];
+    /**
+     * Plan
+     */
+    plan: Plan;
+    /**
+     * Middleware for providing CSRF controls
+     */
+    csrfMiddleware: Function[];
+};
 import MutableRouter from "../lib/MutableRouter.js";

package/dist/routes/journey.js

@@ -15,6 +15,25 @@ const waypoint_url_js_1 = __importDefault(require("../lib/waypoint-url.js"));
 const logger_js_1 = __importDefault(require("../lib/logger.js"));
 const utils_js_1 = require("../lib/utils.js");
 const log = (0, logger_js_1.default)('routes:journey');
+/**
+ * @access private
+ * @param {import('../casa.js').GlobalHook} GlobalHook
+ */
+/**
+ * @access private
+ * @param {import('../casa.js').Page} Page
+ */
+/**
+ * @access private
+ * @param {import('../casa.js').Plan} Plan
+ */
+/**
+ * @typedef {object} JourneyRouterOptions Options to configure static router
+ * @property {GlobalHook[]} globalHooks Global hooks
+ * @property {Page[]} pages Page definitions
+ * @property {Plan} plan Plan
+ * @property {Function[]} csrfMiddleware Middleware for providing CSRF controls
+ */
 const renderMiddlewareFactory = (view, contextFactory) => [
     (req, res, next) => {
         res.render(view, Object.assign({ 
@@ -29,6 +48,14 @@ const renderMiddlewareFactory = (view, contextFactory) => [
         });
     },
 ];
+/**
+ * Create an instance of the router for all waypoints visited during a Journey
+ * through the Plan.
+ *
+ * @access private
+ * @param {JourneyRouterOptions} opts Options
+ * @returns {MutableRouter} Router
+ */
 function journeyRouter({ globalHooks, pages, plan, csrfMiddleware, }) {
     // Router
     const router = new MutableRouter_js_1.default();

package/dist/routes/static.d.ts

@@ -5,6 +5,7 @@
 /**
  * Create a router for serving CASA's static assets.
  *
+ * @access private
  * @param {StaticOptions} options Options
  * @returns {MutableRouter} ExpressJS Router instance
  */