@dwp/govuk-casa 8.2.4 → 8.2.7

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [8.2.7](https://github.com/dwp/govuk-casa/compare/8.2.6...8.2.7) (2022-06-15)
+
+### [8.2.6](https://github.com/dwp/govuk-casa/compare/8.2.5...8.2.6) (2022-06-06)
+
+### [8.2.5](https://github.com/dwp/govuk-casa/compare/8.2.3...8.2.5) (2022-06-01)
+
+
+### Bug Fixes
+
+* serve statics correctly from deeply nested apps ([0fd00a5](https://github.com/dwp/govuk-casa/commit/0fd00a5f10de28706afe87a993072d3184e3c7aa))
+
 ### [8.2.3](https://github.com/dwp/govuk-casa/compare/8.2.2...8.2.3) (2022-05-23)
 
 ### [8.2.2](https://github.com/dwp/govuk-casa/compare/8.2.1...8.2.2) (2022-05-23)

package/dist/casa.d.ts

@@ -1,5 +1,5 @@
 export type PageField = import('./lib/field').PageField;
-export type ContextEventHandler = (journeyContext: JourneyContext, previousContext: JourneyContext) => void;
+export type ContextEventHandler = (opts: object, journeyContext: JourneyContext, previousContext: JourneyContext, session: object) => void;
 export type ContextEvent = {
     /**
      * Waypoint to watch for changes
@@ -108,14 +108,24 @@ export type IPlugin = {
     /**
      * Modify the app config
      */
-    configure?: Function | undefined;
+    configure?: PluginConfigureFunction | undefined;
     /**
      * Modify post-configuration artifacts
      */
-    bootstrap?: Function | undefined;
+    bootstrap?: PluginBootstrapFunction | undefined;
 };
-export type PluginConfigureFunction = (config: object) => any;
+export type PluginConfigureFunction = (config: ConfigurationOptions) => any;
+export type PluginBootstrapFunction = (config: ConfigureResult) => any;
 export type HelmetConfigurator = (config: object) => object;
+/**
+ * Mounting function.
+ *
+ * This will mount all of the routes and middleware in the correct order on
+ * the given ExpressJS app.
+ *
+ * Once this is called, you will not be able to modify any of the routers as
+ * they will be "sealed".
+ */
 export type Mounter = (app: import('express').Express, opts: object, route?: string | undefined) => import('express').Express;
 export type MutableRouter = import('./lib/index').MutableRouter;
 /**
@@ -153,11 +163,15 @@ export type ConfigurationOptions = {
     /**
      * CASA Plan
      */
-    plan: Plan;
+    plan?: Plan | undefined;
     /**
      * Handlers for JourneyContext events
      */
     events?: ContextEvent[] | undefined;
+    /**
+     * Helmet configuration manipulator function
+     */
+    helmetConfigurator?: HelmetConfigurator | undefined;
 };
 /**
  * Result of a call to configure() function
@@ -211,6 +225,10 @@ export type ConfigureResult = {
      * Function used to mount all CASA artifacts onto an ExpressJS app
      */
     mount: Mounter;
+    /**
+     * Ingested config supplied to `configure()`
+     */
+    config: ConfigurationOptions;
 };
 /**
  * Configuration for generating a ValidationError.

package/dist/casa.js

@@ -55,8 +55,10 @@ exports.nunjucksFilters = nunjucksFilters;
  */
 /**
  * @callback ContextEventHandler
- * @param {JourneyContext} journeyContext Context including changes
- * @param {JourneyContext} previousContext Context prior to changes
+ * @param {object} opts Options
+ * @param {JourneyContext} opts.journeyContext Context including changes
+ * @param {JourneyContext} opts.previousContext Context prior to changes
+ * @param {object} opts.session Request session object
  * @returns {void}
  */
 /**
@@ -99,12 +101,16 @@ exports.nunjucksFilters = nunjucksFilters;
  */
 /**
  * @typedef {object} IPlugin Plugin interface
- * @property {Function} [configure] Modify the app config
- * @property {Function} [bootstrap] Modify post-configuration artifacts
+ * @property {PluginConfigureFunction} [configure] Modify the app config
+ * @property {PluginBootstrapFunction} [bootstrap] Modify post-configuration artifacts
  */
 /**
  * @callback PluginConfigureFunction
- * @param {object} config Options
+ * @param {ConfigurationOptions} config Options
+ */
+/**
+ * @callback PluginBootstrapFunction
+ * @param {ConfigureResult} config Options
  */
 /**
  * @callback HelmetConfigurator
@@ -112,10 +118,18 @@ exports.nunjucksFilters = nunjucksFilters;
  * @returns {object} The modified configuration object
  */
 /**
+ * Mounting function.
+ *
+ * This will mount all of the routes and middleware in the correct order on
+ * the given ExpressJS app.
+ *
+ * Once this is called, you will not be able to modify any of the routers as
+ * they will be "sealed".
+ *
  * @callback Mounter
  * @param {import('express').Express} app Express application
  * @param {object} opts Mounting options
- * @param {string} [opts.route=/] Optional route to attach all middleware/routers too
+ * @param {string} [opts.route='/'] Optional route to attach all middleware/routers too
  * @returns {import('express').Express} The prepared ExpressJS app instance
  */
 /**
@@ -132,8 +146,9 @@ exports.nunjucksFilters = nunjucksFilters;
  * @property {GlobalHook[]} [hooks=[]] Hooks to apply
  * @property {IPlugin[]} [plugins=[]] Plugins
  * @property {I18nOptions[]} [i18n] I18n configuration
- * @property {Plan} plan CASA Plan
+ * @property {Plan} [plan] CASA Plan
  * @property {ContextEvent[]} [events=[]] Handlers for JourneyContext events
+ * @property {HelmetConfigurator} [helmetConfigurator] Helmet configuration manipulator function
  */
 /**
  * @typedef {object} ConfigureResult Result of a call to configure() function
@@ -149,6 +164,7 @@ exports.nunjucksFilters = nunjucksFilters;
  * @property {import('express').RequestHandler[]} i18nMiddleware I18n preparation middleware
  * @property {import('express').RequestHandler} bodyParserMiddleware Body parsing middleware
  * @property {Mounter} mount Function used to mount all CASA artifacts onto an ExpressJS app
+ * @property {ConfigurationOptions} config Ingested config supplied to `configure()`
  */
 /**
  * Configuration for generating a ValidationError.

package/dist/lib/JourneyContext.js

@@ -466,10 +466,19 @@ class JourneyContext {
      * @returns {void}
      */
     static initContextStore(session) {
+        // For existing sessions that were created prior to `journeyContextList`
+        // being remodelled as an array, we need to convert the "legacy" structure
+        // into an equivalent array.
+        if (isPlainObject(session === null || session === void 0 ? void 0 : session.journeyContextList)) {
+            log.trace('Session context list already initialised as an object (legacy structure). Will convert from object to array.');
+            /* eslint-disable-next-line no-param-reassign */
+            session.journeyContextList = Object.entries(session.journeyContextList);
+        }
+        // Initialise new context list in the 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);
+            session.journeyContextList = [];
             const defaultContext = new JourneyContext();
             defaultContext.identity.id = JourneyContext.DEFAULT_CONTEXT_ID;
             JourneyContext.putContext(session, defaultContext);
@@ -515,10 +524,11 @@ class JourneyContext {
      * @returns {JourneyContext} The discovered JourneyContext instance
      */
     static getContextById(session, id) {
-        if (has(session === null || session === void 0 ? void 0 : session.journeyContextList, id)) {
+        const list = new Map(session === null || session === void 0 ? void 0 : session.journeyContextList);
+        if (list.has(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 JourneyContext.fromObject(list.get(id));
         }
         return undefined;
     }
@@ -531,7 +541,8 @@ class JourneyContext {
      */
     static getContextByName(session, name) {
         if (session) {
-            const context = Object.values(session.journeyContextList).find((c) => (c.identity.name === name));
+            const list = new Map(session === null || session === void 0 ? void 0 : session.journeyContextList);
+            const context = [...list.values()].find((c) => (c.identity.name === name));
             if (context) {
                 return JourneyContext.fromObject(context);
             }
@@ -547,7 +558,8 @@ class JourneyContext {
      */
     static getContextsByTag(session, tag) {
         if (session) {
-            return Object.values(session.journeyContextList).filter((c) => { var _a; return ((_a = c.identity.tags) === null || _a === void 0 ? void 0 : _a.includes(tag)); }).map((c) => (JourneyContext.fromObject(c)));
+            const list = new Map(session === null || session === void 0 ? void 0 : session.journeyContextList);
+            return [...list.values()].filter((c) => { var _a; return ((_a = c.identity.tags) === null || _a === void 0 ? void 0 : _a.includes(tag)); }).map((c) => (JourneyContext.fromObject(c)));
         }
         return undefined;
     }
@@ -559,7 +571,7 @@ class JourneyContext {
      */
     static getContexts(session) {
         if (has(session, 'journeyContextList')) {
-            return Object.values(session.journeyContextList).map((contextObj) => (JourneyContext.fromObject(contextObj)));
+            return session.journeyContextList.map(([, contextObj]) => (JourneyContext.fromObject(contextObj)));
         }
         return [];
     }
@@ -594,8 +606,10 @@ class JourneyContext {
             event: 'context-change',
             session,
         });
+        const list = new Map(session.journeyContextList);
+        list.set(context.identity.id, context.toObject());
         /* eslint-disable-next-line no-param-reassign */
-        session.journeyContextList[context.identity.id] = context.toObject();
+        session.journeyContextList = [...list.entries()];
     }
     /**
      * Remove a context from the session store.
@@ -617,10 +631,10 @@ class JourneyContext {
      * @returns {void}
      */
     static removeContextById(session, id) {
-        if (session && has(session.journeyContextList, id)) {
-            // 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];
+        var _a;
+        const index = ((_a = session === null || session === void 0 ? void 0 : session.journeyContextList) !== null && _a !== void 0 ? _a : []).findIndex(([contextId]) => contextId === id);
+        if (index > -1) {
+            session.journeyContextList.splice(index, 1);
         }
     }
     /**

package/dist/lib/configure.d.ts

@@ -4,7 +4,7 @@
  */
 /**
  * @access private
- * @typedef {import('../casa').ConfigurationOptions} ConfigureResult
+ * @typedef {import('../casa').ConfigureResult} ConfigureResult
  */
 /**
  * @access private
@@ -19,5 +19,5 @@
  */
 export default function configure(config?: ConfigurationOptions): ConfigureResult;
 export type ConfigurationOptions = import('../casa').ConfigurationOptions;
-export type ConfigureResult = import('../casa').ConfigurationOptions;
+export type ConfigureResult = import('../casa').ConfigureResult;
 export type Mounter = import('../casa').Mounter;

package/dist/lib/configure.js

@@ -3,20 +3,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const express_1 = require("express");
 const express_session_1 = require("express-session");
 const path_1 = require("path");
 const module_1 = require("module");
 const cookie_parser_1 = __importDefault(require("cookie-parser"));
-const path_to_regexp_1 = require("path-to-regexp");
 const dirname_cjs_1 = __importDefault(require("./dirname.cjs"));
-const utils_js_1 = require("./utils.js");
 const configuration_ingestor_js_1 = __importDefault(require("./configuration-ingestor.js"));
 const nunjucks_js_1 = __importDefault(require("./nunjucks.js"));
+const mount_js_1 = __importDefault(require("./mount.js"));
 const static_js_1 = __importDefault(require("../routes/static.js"));
 const ancillary_js_1 = __importDefault(require("../routes/ancillary.js"));
 const journey_js_1 = __importDefault(require("../routes/journey.js"));
-const strip_proxy_path_js_1 = __importDefault(require("../middleware/strip-proxy-path.js"));
 const pre_js_1 = __importDefault(require("../middleware/pre.js"));
 const post_js_1 = __importDefault(require("../middleware/post.js"));
 const session_js_1 = __importDefault(require("../middleware/session.js"));
@@ -30,7 +27,7 @@ const csrf_js_1 = __importDefault(require("../middleware/csrf.js"));
  */
 /**
  * @access private
- * @typedef {import('../casa').ConfigurationOptions} ConfigureResult
+ * @typedef {import('../casa').ConfigureResult} ConfigureResult
  */
 /**
  * @access private
@@ -51,6 +48,7 @@ function configure(config = {}) {
         plugin.configure(config);
     });
     // Extract config
+    const ingestedConfig = (0, configuration_ingestor_js_1.default)(config);
     const { mountUrl, views = [], session = {
         secret: 'secret',
         name: 'casasession',
@@ -62,7 +60,7 @@ function configure(config = {}) {
     }, pages = [], plan = null, hooks = [], plugins = [], events = [], i18n = {
         dirs: [],
         locales: ['en', 'cy'],
-    }, helmetConfigurator = undefined, } = (0, configuration_ingestor_js_1.default)(config);
+    }, helmetConfigurator = undefined, } = ingestedConfig;
     // Prepare all page hooks so they are prefixed with the `journey.` scope.
     pages.forEach((page) => {
         var _a;
@@ -124,73 +122,21 @@ function configure(config = {}) {
         plan,
         csrfMiddleware,
     });
-    // Mount function
-    // This will mount all of these routes and middleware in the correct order on
-    // the given ExpressJS app.
-    // Once this is called, you will not be able to modify any of the routers as
-    // they will be "sealed".
-    /**
-     * Mounting function.
-     *
-     * @type {Mounter} mount
-     */
-    const mount = (app, { route = '/' } = {}) => {
-        nunjucksEnv.express(app);
-        app.set('view engine', 'njk');
-        // If a `mountUrl` has been defined, then we're potentially in "proxy mode",
-        // in which we strip the proxy path prefix from the incoming request URLs.
-        if (mountUrl) {
-            app.use((0, strip_proxy_path_js_1.default)({ mountUrl }));
-        }
-        // Attach a handler to redirect requests for `/` to the first waypoint in
-        // the plan
-        if (plan) {
-            const re = (0, path_to_regexp_1.pathToRegexp)(`${route}`.replace(/\/+/g, '/'));
-            app.use(re, (req, res) => {
-                const reqUrl = new URL(req.url, 'https://placeholder.test/');
-                const reqPath = (0, utils_js_1.validateUrlPath)(`${req.baseUrl}${reqUrl.pathname}${plan.getWaypoints()[0]}`);
-                let reqParams = reqUrl.searchParams.toString();
-                reqParams = reqParams ? `?${reqParams}` : '';
-                res.redirect(302, `${reqPath}${reqParams}`);
-            });
-        }
-        // Capture the mount path of this CASA app, before any parameterised path
-        // segments exert influence over `req.baseUrl` in the `router` further below.
-        // This can later be used by middleware that wants to use the
-        // "unparameterised" version of the request's `baseUrl`, such as the static
-        // router's middleware.
-        app.use((req, res, next) => {
-            req.unparameterisedBaseUrl = req.baseUrl;
-            next();
-        });
-        // Serve static assets from the `app` rather than the `router`. The router
-        // may contain paramaterised path segments which would mean serving static
-        // assets over a dynamic URL each time, thus causing lots of cache misses on
-        // the browser.
-        const sealedStaticRouter = staticRouter.seal();
-        app.use(preMiddleware);
-        app.use(sealedStaticRouter);
-        const router = (0, express_1.Router)({
-            // Required so that any parameters in the URL are propagated to middleware
-            mergeParams: true,
-        });
-        router.use(preMiddleware);
-        // !!! DEPRECATE in v9 !!! For performance reasons, static assets will
-        // always be handled via the `app` middleware rather than `router`.
-        // Anywhere `mountUrl` is used in templates to service static assets must be
-        // changed to use `staticMountUrl`.
-        // TASK: remove this line below
-        router.use(sealedStaticRouter);
-        router.use(sessionMiddleware);
-        router.use(i18nMiddleware);
-        router.use(bodyParserMiddleware);
-        router.use(dataMiddleware);
-        router.use(ancillaryRouter.seal());
-        router.use(journeyRouter.seal());
-        router.use(postMiddleware);
-        app.use(route, router);
-        return app;
-    };
+    // Create the mounting function
+    const mount = (0, mount_js_1.default)({
+        nunjucksEnv,
+        mountUrl,
+        plan,
+        staticRouter,
+        ancillaryRouter,
+        journeyRouter,
+        preMiddleware,
+        sessionMiddleware,
+        i18nMiddleware,
+        bodyParserMiddleware,
+        dataMiddleware,
+        postMiddleware,
+    });
     // Prepare configuration result
     const configOutput = {
         // Nunjucks environment, so it can be attached to other ExpressJS instances
@@ -214,6 +160,8 @@ function configure(config = {}) {
         dataMiddleware,
         // Mount function
         mount,
+        // Ingested config
+        config: ingestedConfig,
     };
     // Bootstrap all plugins
     plugins.filter((p) => p.bootstrap).forEach((plugin) => plugin === null || plugin === void 0 ? void 0 : plugin.bootstrap(configOutput));

package/dist/lib/mount.d.ts

@@ -0,0 +1,20 @@
+declare function _default({ nunjucksEnv, mountUrl, plan, staticRouter, ancillaryRouter, journeyRouter, preMiddleware, sessionMiddleware, i18nMiddleware, bodyParserMiddleware, dataMiddleware, postMiddleware, }: {
+    nunjucksEnv: NunjucksEnvironment;
+    mountUrl?: string | undefined;
+    plan?: import("./Plan.js").default | undefined;
+    staticRouter: MutableRouter;
+    ancillaryRouter: MutableRouter;
+    journeyRouter: MutableRouter;
+    preMiddleware: ExpressRequestHandler[];
+    sessionMiddleware: ExpressRequestHandler[];
+    i18nMiddleware: ExpressRequestHandler[];
+    bodyParserMiddleware: ExpressRequestHandler[];
+    dataMiddleware: ExpressRequestHandler[];
+    postMiddleware: ExpressRequestHandler[];
+}): Mounter;
+export default _default;
+export type NunjucksEnvironment = import('nunjucks').Environment;
+export type ExpressRequestHandler = import('express').RequestHandler;
+export type Mounter = import('../casa').Mounter;
+export type Plan = import('../casa').Plan;
+export type MutableRouter = import('../casa').MutableRouter;

package/dist/lib/mount.js

@@ -0,0 +1,98 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const express_1 = require("express");
+const path_to_regexp_1 = require("path-to-regexp");
+const strip_proxy_path_js_1 = __importDefault(require("../middleware/strip-proxy-path.js"));
+const serve_first_waypoint_js_1 = __importDefault(require("../middleware/serve-first-waypoint.js"));
+/**
+ * @access private
+ * @typedef {import('nunjucks').Environment} NunjucksEnvironment
+ */
+/**
+ * @access private
+ * @typedef {import('express').RequestHandler} ExpressRequestHandler
+ */
+/**
+ * @access private
+ * @typedef {import('../casa').Mounter} Mounter
+ */
+/**
+ * @access private
+ * @typedef {import('../casa').Plan} Plan
+ */
+/**
+ * @access private
+ * @typedef {import('../casa').MutableRouter} MutableRouter
+ */
+/**
+ * Mounting function factory.
+ *
+ * @param {Object} args Arguments
+ * @param {NunjucksEnvironment} args.nunjucksEnv Pre-configured Nunmjucks environment
+ * @param {string} [args.mountUrl] Mount URL
+ * @param {Plan} [args.plan] CASA Plan
+ * @param {MutableRouter} args.staticRouter Router for all static assets
+ * @param {MutableRouter} args.ancillaryRouter Router for all ancillary routes
+ * @param {MutableRouter} args.journeyRouter Router for all waypoints
+ * @param {ExpressRequestHandler[]} args.preMiddleware Middleware
+ * @param {ExpressRequestHandler[]} args.sessionMiddleware Middleware
+ * @param {ExpressRequestHandler[]} args.i18nMiddleware Middleware
+ * @param {ExpressRequestHandler[]} args.bodyParserMiddleware Middleware
+ * @param {ExpressRequestHandler[]} args.dataMiddleware Middleware
+ * @param {ExpressRequestHandler[]} args.postMiddleware Middleware
+ * @returns {Mounter} mount
+ */
+exports.default = ({ nunjucksEnv, mountUrl, plan, staticRouter, ancillaryRouter, journeyRouter, preMiddleware, sessionMiddleware, i18nMiddleware, bodyParserMiddleware, dataMiddleware, postMiddleware, }) => (app, { route = '/', serveFirstWaypoint = false, } = {}) => {
+    nunjucksEnv.express(app);
+    app.set('view engine', 'njk');
+    // If a `mountUrl` has been defined, then we're potentially in "proxy mode",
+    // in which we strip the proxy path prefix from the incoming request URLs.
+    if (mountUrl) {
+        app.use((0, strip_proxy_path_js_1.default)({ mountUrl }));
+    }
+    // Attach a handler to redirect requests for `/` to the first waypoint in
+    // the plan
+    if (serveFirstWaypoint && plan) {
+        const re = (0, path_to_regexp_1.pathToRegexp)(`${route}`.replace(/\/+/g, '/'));
+        app.use(re, (0, serve_first_waypoint_js_1.default)({ plan }));
+    }
+    // Capture the mount path of this CASA app, before any parameterised path
+    // segments exert influence over `req.baseUrl` in the `router` further below.
+    // This can later be used by middleware that wants to use the
+    // "unparameterised" version of the request's `baseUrl`, such as the static
+    // router's middleware.
+    app.use((req, res, next) => {
+        req.unparameterisedBaseUrl = req.baseUrl;
+        next();
+    });
+    // Serve static assets from the `app` rather than the `router`. The router
+    // may contain paramaterised path segments which would mean serving static
+    // assets over a dynamic URL each time, thus causing lots of cache misses on
+    // the browser.
+    const sealedStaticRouter = staticRouter.seal();
+    app.use(preMiddleware);
+    app.use(sealedStaticRouter);
+    const router = (0, express_1.Router)({
+        // Required so that any parameters in the URL are propagated to middleware
+        mergeParams: true,
+    });
+    router.use(preMiddleware);
+    // !!! DEPRECATE in v9 !!! For performance reasons, static assets will
+    // always be handled via the `app` middleware rather than `router`.
+    // Anywhere `mountUrl` is used in templates to service static assets must be
+    // changed to use `staticMountUrl`.
+    // TASK: remove this line below
+    router.use(sealedStaticRouter);
+    router.use(sessionMiddleware);
+    router.use(i18nMiddleware);
+    router.use(bodyParserMiddleware);
+    router.use(dataMiddleware);
+    router.use(ancillaryRouter.seal());
+    router.use(journeyRouter.seal());
+    router.use(postMiddleware);
+    app.use(route, router);
+    return app;
+};

package/dist/lib/utils.js

@@ -148,7 +148,7 @@ function validateHookName(hookName) {
     if (!hookName.length) {
         throw new SyntaxError('Hook name must not be empty');
     }
-    if (!hookName.match(/^([a-z]+\.|)[a-z]+$/i)) {
+    if (!hookName.match(/^([a-z_]+\.|)[a-z_]+$/i)) {
         throw new SyntaxError('Hook name must match either <scope>.<hookname> or <hookname> formats');
     }
 }

package/dist/middleware/serve-first-waypoint.d.ts

@@ -0,0 +1,4 @@
+declare function _default({ plan, }: Plan): ExpressRequestHandler[];
+export default _default;
+export type ExpressRequestHandler = import('express').RequestHandler;
+export type Plan = import('../casa').Plan;

package/dist/middleware/serve-first-waypoint.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_js_1 = require("../lib/utils.js");
+/**
+ * @access private
+ * @typedef {import('express').RequestHandler} ExpressRequestHandler
+ */
+/**
+ * @access private
+ * @typedef {import('../casa').Plan} Plan
+ */
+/**
+ * Redirect the user to the first Plan waypoint when they request the root /
+ * path.
+ *
+ * @param {Plan} plan CASA Plan
+ * @returns {ExpressRequestHandler[]} Array of middleware
+ */
+exports.default = ({ plan, }) => [(req, res) => {
+        const reqUrl = new URL(req.url, 'https://placeholder.test/');
+        const reqPath = (0, utils_js_1.validateUrlPath)(`${req.baseUrl}${reqUrl.pathname}${plan.getWaypoints()[0]}`);
+        let reqParams = reqUrl.searchParams.toString();
+        reqParams = reqParams ? `?${reqParams}` : '';
+        res.redirect(302, `${reqPath}${reqParams}`);
+    }];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "8.2.4",
+  "version": "8.2.7",
   "description": "A framework for building GOVUK Collect-And-Submit-Applications",
   "repository": {
     "type": "git",
@@ -51,8 +51,8 @@
     "govuk-frontend": "4.0.1",
     "graphlib": "2.1.8",
     "helmet": "5.1.0",
-    "i18next": "21.8.4",
-    "i18next-http-middleware": "3.2.0",
+    "i18next": "21.8.8",
+    "i18next-http-middleware": "3.2.1",
     "js-yaml": "4.1.0",
     "lodash": "4.17.21",
     "luxon": "2.4.0",
@@ -62,38 +62,38 @@
     "validator": "13.7.0"
   },
   "devDependencies": {
-    "@babel/core": "7.18.0",
-    "@babel/eslint-parser": "7.17.0",
-    "@babel/preset-env": "7.18.0",
-    "@commitlint/config-conventional": "17.0.0",
-    "@ckeditor/jsdoc-plugins": "30.1.0",
+    "@babel/core": "7.18.2",
+    "@babel/eslint-parser": "7.18.2",
+    "@babel/preset-env": "7.18.2",
+    "@ckeditor/jsdoc-plugins": "30.2.0",
+    "@commitlint/config-conventional": "17.0.2",
     "@dwp/casa-spiderplan": "2.4.0",
     "@dwp/casa-spiderplan-a11y-plugin": "0.1.4",
     "@dwp/casa-spiderplan-zap-plugin": "0.1.1",
     "@dwp/eslint-config-base": "6.0.0",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.35",
+    "@types/node": "17.0.40",
     "@types/nunjucks": "3.2.1",
     "babel-eslint": "10.1.0",
     "c8": "7.11.3",
     "chai": "4.3.6",
     "cheerio": "1.0.0-rc.11",
-    "commitlint": "17.0.0",
-    "eslint": "8.16.0",
+    "commitlint": "17.0.2",
     "docdash": "1.2.0",
-    "eslint-plugin-security": "1.5.0",
-    "fast-check": "2.25.0",
-    "husky": "8.0.1",
-    "mocha": "10.0.0",
-    "sass": "1.52.1",
+    "eslint": "8.17.0",
     "eslint-plugin-no-unsafe-regex": "1.0.0",
+    "eslint-plugin-security": "1.5.0",
     "eslint-plugin-sonarjs": "0.13.0",
+    "fast-check": "3.0.0",
+    "husky": "8.0.1",
     "jsdoc": "3.6.10",
     "jsdoc-tsimport-plugin": "1.0.5",
+    "mocha": "10.0.0",
+    "sass": "1.52.2",
     "sinon": "14.0.0",
     "sinon-chai": "3.7.0",
     "standard-version": "9.5.0",
     "supertest": "6.2.3",
-    "typescript": "4.6.4"
+    "typescript": "4.7.3"
   }
 }