@dwp/govuk-casa 8.0.0-alpha2 → 8.0.1

package/dist/middleware/steer-journey.js

@@ -8,6 +8,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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');
+/**
+ * @typedef {import('../lib/Plan')} Plan
+ */
 /**
  * This sits in front of all other journey middleware and prevents the user from
  * "jumping ahead" in the Plan.

package/dist/middleware/validate-fields.js

@@ -21,6 +21,8 @@ exports.default = ({ waypoint, fields = [], mountUrl, plan, }) => [
         var _a, _b;
         let errors = [];
         for (let i = 0, l = fields.length; i < l; i++) {
+            /* eslint-disable security/detect-object-injection */
+            // Dynamic object keys are only used on known entities (fields, waypoint)
             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];
@@ -30,12 +32,11 @@ exports.default = ({ waypoint, fields = [], mountUrl, plan, }) => [
                 waypoint,
                 journeyContext: req.casa.journeyContext,
             };
-            if (field.testConditions(context)) {
-                errors = [
-                    ...errors,
-                    ...field.runValidators(fieldValue, context),
-                ];
-            }
+            /* eslint-enable security/detect-object-injection */
+            errors = [
+                ...errors,
+                ...field.runValidators(fieldValue, context),
+            ];
         }
         // Validation passed with no errors
         if (!errors.length) {

package/dist/mjs/esm-wrapper.js

@@ -1,5 +1,8 @@
 // Basic wrapper to act as the package entrypoint for ESM applications
 // ref: https://redfin.engineering/node-modules-at-war-why-commonjs-and-es-modules-cant-get-along-9617135eeca1
+// The `../casa.js` reference here is correct. This file will be copied into
+// `dist/` in the right location at build time, which will resolve that file
+// path correctly.
 import casa from '../casa.js';
 
 export const { configure } = casa;
@@ -7,5 +10,12 @@ export const { validators } = casa;
 export const { field } = casa;
 export const { Plan } = casa;
 export const { JourneyContext } = casa;
+export const { ValidatorFactory } = casa;
 export const { ValidationError } = casa;
+
+// Utilities
 export const { waypointUrl } = casa;
+export const { endSession } = casa;
+
+// Nunjucks filters
+export const { nunjucksFilters } = casa;

package/dist/routes/ancillary.d.ts

@@ -1,4 +1,11 @@
+/**
+ * Create an instance of the ancillary router.
+ *
+ * @param {Object} options = Optiona
+ * @param {number} options.sessionTtl Session timeout (seconds)
+ * @returns {MutableRouter} Mutable router
+ */
 export default function ancillaryRouter({ sessionTtl, }: {
-    sessionTtl: any;
+    sessionTtl: number;
 }): MutableRouter;
 import MutableRouter from "../lib/MutableRouter.js";

package/dist/routes/ancillary.js

@@ -4,12 +4,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const MutableRouter_js_1 = __importDefault(require("../lib/MutableRouter.js"));
+/**
+ * Create an instance of the ancillary router.
+ *
+ * @param {Object} options = Optiona
+ * @param {number} options.sessionTtl Session timeout (seconds)
+ * @returns {MutableRouter} Mutable router
+ */
 function ancillaryRouter({ sessionTtl, }) {
     // Router
     const router = new MutableRouter_js_1.default();
     // Session timeout
-    // TODO: add a `ancillary.presessiontimeout` hook here? Might be useful for
-    // those who way to enhance the timeout route, rather than replacing it completely
     router.all('/session-timeout', (req, res) => {
         res.render('casa/session-timeout.njk', {
             sessionTtl: Math.floor(sessionTtl / 60),

package/dist/routes/dirname.cjs

@@ -1 +1 @@
-module.exports = __dirname;
+module.exports = __dirname;

package/dist/routes/dirname.d.cts

@@ -0,0 +1,2 @@
+declare const _exports: string;
+export = _exports;

package/dist/routes/journey.js

@@ -14,16 +14,13 @@ const progress_journey_js_1 = __importDefault(require("../middleware/progress-jo
 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)('router:journey');
+const log = (0, logger_js_1.default)('routes:journey');
 const renderMiddlewareFactory = (view, contextFactory) => [
     (req, res, next) => {
         res.render(view, Object.assign({ 
             // Common template variables for both GET and POST requests
-            inEditMode: req.casa.editMode, editOriginUrl: req.casa.editOrigin, 
-            // editSearchParams: req.editSearchParams,
-            activeContextId: req.casa.journeyContext.identity.id }, contextFactory(req)), (err, templateString) => {
+            inEditMode: req.casa.editMode, editOriginUrl: req.casa.editOrigin, activeContextId: req.casa.journeyContext.identity.id }, contextFactory(req)), (err, templateString) => {
             if (err) {
-                // logger.error(err);
                 next(err);
             }
             else {
@@ -80,13 +77,20 @@ function journeyRouter({ globalHooks, pages, plan, csrfMiddleware, mountUrl, })
         const { waypoint, view, hooks: pageHooks = [], fields } = page;
         const formUrl = (0, waypoint_url_js_1.default)({ mountUrl, waypoint });
         const waypointPath = `/${waypoint}`;
-        const commonWaypointMiddleware = [
+        let commonWaypointMiddleware = [
             (req, res, next) => {
                 req.casa.waypoint = waypoint;
+                res.locals.casa.waypoint = waypoint;
                 next();
             },
-            ...(0, skip_waypoint_js_1.default)({ mountUrl, waypoint }),
         ];
+        if (plan.isSkippable(waypoint)) {
+            log.info(`Configuring "${waypoint}" as a skippable waypoint`);
+            commonWaypointMiddleware = [
+                ...commonWaypointMiddleware,
+                ...(0, skip_waypoint_js_1.default)({ mountUrl, waypoint }),
+            ];
+        }
         router.get(waypointPath, ...commonMiddleware, ...commonWaypointMiddleware, ...(0, utils_js_1.resolveMiddlewareHooks)('journey.presteer', waypointPath, [...globalHooks, ...pageHooks]), ...(0, steer_journey_js_1.default)({ waypoint, mountUrl, plan }), ...(0, utils_js_1.resolveMiddlewareHooks)('journey.poststeer', waypointPath, [...globalHooks, ...pageHooks]), ...(0, utils_js_1.resolveMiddlewareHooks)('journey.prerender', waypointPath, [...globalHooks, ...pageHooks]), renderMiddlewareFactory(view, (req) => ({
             formUrl,
             formData: req.casa.journeyContext.getDataForPage(waypoint),
@@ -103,9 +107,11 @@ function journeyRouter({ globalHooks, pages, plan, csrfMiddleware, mountUrl, })
             // errors in that format.
             // Where there are multiple errors against a particular field, only the
             // first one is shown.
+            // Disabling security/detect-object-injection rule because both `errors`
+            // and the `k` property are known entities
             const govukErrors = Object.keys(errors).map((k) => ({
                 text: req.t(errors[k][0].summary, errors[k][0].variables),
-                href: errors[k][0].fieldHref,
+                href: errors[k][0].fieldHref, /* eslint-disable-line security/detect-object-injection */
             }));
             return {
                 formUrl,

package/dist/routes/static.js

@@ -3,13 +3,14 @@ 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_1 = __importDefault(require("express"));
 const fs_1 = require("fs");
 const url_1 = require("url");
 const path_1 = require("path");
 const module_1 = require("module");
 const dirname_cjs_1 = __importDefault(require("./dirname.cjs"));
 const MutableRouter_js_1 = __importDefault(require("../lib/MutableRouter.js"));
+const { static: ExpressStatic } = express_1.default; // CommonJS
 const oneDay = 86400000;
 /**
  * @typedef {object} StaticOptions Options to configure static router
@@ -56,8 +57,8 @@ function staticRouter({ mountUrl = '/', maxAge = 3600000, }) {
     // The static middleware will only server GET/HEAD requests, so we can mount
     // the middleware using `use()` rather than resorting to `get()`
     const govukFrontendDirectory = (0, path_1.resolve)((0, module_1.createRequire)(dirname_cjs_1.default).resolve('govuk-frontend'), '../../');
-    router.use('/govuk/assets/js/all.js', (0, express_1.static)(`${govukFrontendDirectory}/govuk/all.js`, staticConfig));
-    router.use('/govuk/assets', (0, express_1.static)(`${govukFrontendDirectory}/govuk/assets`, staticConfig));
+    router.use('/govuk/assets/js/all.js', ExpressStatic(`${govukFrontendDirectory}/govuk/all.js`, staticConfig));
+    router.use('/govuk/assets', ExpressStatic(`${govukFrontendDirectory}/govuk/assets`, staticConfig));
     router.use('/govuk/assets', notFoundHandler);
     router.use('/casa/assets/css/casa.css', setHeaders, (req, res) => res.send(casaCss));
     router.use('/casa/assets/css/casa-ie8.css', setHeaders, (req, res) => res.send(casaCssIe8));

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "8.0.0-alpha2",
+  "version": "8.0.1",
   "description": "A framework for building GOVUK Collect-And-Submit-Applications",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:dwp/govuk-casa.git"
+  },
   "main": "dist/casa.js",
   "module": "dist/mjs/casa.js",
   "exports": {
@@ -18,58 +22,71 @@
     "node": ">=14.17.2"
   },
   "scripts": {
-    "test": "mocha './tests/**/*.test.js'",
+    "pipeline": "npm run coverage && npm run lint",
+    "test:unit": "mocha './tests/**/*.test.js'",
     "test:e2e": "spiderplan --worker-init ./tests/e2e/worker-init.js --language en ./tests/e2e/personas/**/*.yaml",
+    "test": "npm run test:unit && npm run test:e2e",
+    "lint": "eslint .",
+    "coverage": "c8 npm test",
     "build": "npm run build:prepare && npm run build:sources && npm run build:css-assets",
     "build:prepare": "rm -rf dist/* && mkdir -p dist/assets/js/ && mkdir -p dist/assets/css/",
     "build:sources": "tsc -p tsconfig-cjs.json && ./scripts/fixup.sh",
     "build:css-assets": "node scripts/compile-sass.js",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "upgrade-deps": "OD=$(npm outdated --long --parseable); echo \"$OD\" | grep ':devDependencies:' | awk -F: '{ print $4 }' | xargs npm i -DE; echo \"$OD\" | grep ':dependencies:' | awk -F: '{ print $4 }' | xargs npm i -E",
+    "standard-version": "node scripts/standard-version.js"
   },
   "keywords": [],
   "author": "DWP Digital",
   "license": "ISC",
   "type": "module",
   "dependencies": {
-    "cookie-parser": "1.4.5",
+    "cookie-parser": "1.4.6",
     "csurf": "1.11.0",
-    "debug": "4.3.2",
+    "debug": "4.3.3",
     "deepmerge": "4.2.2",
-    "express": "4.17.1",
+    "express": "4.17.2",
     "express-session": "1.17.2",
-    "govuk-frontend": "3.14.0",
+    "govuk-frontend": "4.0.0",
     "graphlib": "2.1.8",
-    "helmet": "4.6.0",
-    "i18next": "21.3.2",
-    "i18next-http-middleware": "3.1.4",
+    "helmet": "5.0.1",
+    "i18next": "21.6.6",
+    "i18next-http-middleware": "3.1.5",
     "js-yaml": "4.1.0",
     "lodash": "4.17.21",
-    "luxon": "2.0.2",
+    "luxon": "2.3.0",
     "nunjucks": "3.2.3",
     "uuid": "8.3.2",
-    "validator": "^13.6.0"
+    "validator": "^13.7.0"
   },
   "devDependencies": {
-    "@babel/core": "7.15.8",
-    "@babel/eslint-parser": "7.15.8",
-    "@babel/preset-env": "7.15.8",
+    "@babel/core": "7.16.7",
+    "@babel/eslint-parser": "7.16.5",
+    "@babel/preset-env": "7.16.8",
+    "@commitlint/config-conventional": "16.0.0",
     "@dwp/casa-spiderplan": "2.0.0",
     "@dwp/casa-spiderplan-a11y-plugin": "0.1.3",
     "@dwp/casa-spiderplan-zap-plugin": "0.1.1",
-    "@dwp/commitlint-config-base": "1.2.0",
-    "@dwp/eslint-config-base": "5.0.1",
+    "@dwp/eslint-config-base": "6.0.0",
     "@types/express": "4.17.13",
-    "@types/node": "16.11.1",
-    "@types/nunjucks": "3.2.0",
+    "@types/node": "17.0.8",
+    "@types/nunjucks": "3.2.1",
     "babel-eslint": "10.1.0",
+    "c8": "7.11.0",
     "chai": "4.3.4",
-    "commitlint": "13.2.1",
-    "eslint": "7.32.0",
+    "commitlint": "16.0.2",
+    "eslint": "8.6.0",
     "eslint-plugin-no-unsafe-regex": "1.0.0",
-    "eslint-plugin-sonarjs": "0.10.0",
-    "husky": "7.0.2",
+    "eslint-plugin-security": "1.4.0",
+    "eslint-plugin-sonarjs": "0.11.0",
+    "fast-check": "2.21.0",
+    "husky": "7.0.4",
     "mocha": "9.1.3",
-    "sass": "1.43.2",
-    "typescript": "4.4.4"
+    "sass": "1.47.0",
+    "sinon": "12.0.1",
+    "sinon-chai": "3.7.0",
+    "standard-version": "9.3.2",
+    "supertest": "6.2.1",
+    "typescript": "4.5.4"
   }
 }

package/views/casa/layouts/main.njk

@@ -10,7 +10,7 @@
   {# Harcoding content for the skip link as t() may not be availble on some error pages #}
   {{ govukSkipLink({
     href: '#main-content',
-    text: 'Neidio i\'r prif gynnwys' if locale === 'cy' else 'Skip to main content'
+    text: "Neidio i'r prif gynnwys" if locale === 'cy' else 'Skip to main content'
   }) }}
 {% endblock %}
 
@@ -18,7 +18,7 @@
 {% block header %}
   {{ govukHeader({
     assetsPath: assetPath + "/images",
-    serviceName: t(casa.serviceName) if t else '',
+    serviceName: t('common:serviceName') if t else '',
     serviceUrl: casa.mountUrl,
     homepageUrl: "https://www.gov.uk/"
   }) }}