@dwp/govuk-casa 8.2.6 → 8.2.7

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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)

package/dist/casa.d.ts

@@ -117,6 +117,15 @@ export type IPlugin = {
 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;
 /**

package/dist/casa.js

@@ -118,6 +118,14 @@ 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

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"));
@@ -125,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

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/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.6",
+  "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"
   }
 }