@dwp/govuk-casa 8.0.0-alpha1 → 8.0.0

package/dist/routes/journey.js

@@ -13,26 +13,14 @@ const validate_fields_js_1 = __importDefault(require("../middleware/validate-fie
 const progress_journey_js_1 = __importDefault(require("../middleware/progress-journey.js"));
 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)('router:journey');
-const resolveHooks = (hookName, waypoint, pageHooks, globalHooks = []) => {
-    const waypointPath = `/${waypoint}`;
-    const pathMatch = (h) => h.path === undefined || (h.path instanceof RegExp && h.path.test(waypointPath)) || h.path === waypointPath;
-    const matchedPageHooks = (pageHooks || []).filter((h) => `journey.${h.hook}` === hookName).map((h) => h.middleware);
-    const matchedGlobalHooks = globalHooks.filter((h) => h.hook === hookName).filter(pathMatch).map((h) => h.middleware);
-    return [
-        ...matchedGlobalHooks,
-        ...matchedPageHooks,
-    ];
-};
+const utils_js_1 = require("../lib/utils.js");
+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 {
@@ -46,7 +34,6 @@ function journeyRouter({ globalHooks, pages, plan, csrfMiddleware, mountUrl, })
     const router = new MutableRouter_js_1.default();
     // Special "_" route which handles redirecting the user between sub-apps
     // /app1/_/?refmount=app2&route=prev
-    //   - will redirect to the 
     router.all('/_', (req, res) => {
         var _a, _b;
         const refmount = (_a = req.query) === null || _a === void 0 ? void 0 : _a.refmount;
@@ -87,25 +74,32 @@ function journeyRouter({ globalHooks, pages, plan, csrfMiddleware, mountUrl, })
         ...csrfMiddleware,
     ];
     pages.forEach((page) => {
-        const { waypoint, view, hooks: pageHooks, fields } = page;
+        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 }),
         ];
-        router.get(waypointPath, ...commonMiddleware, ...commonWaypointMiddleware, ...resolveHooks('journey.presteer', waypoint, pageHooks, globalHooks), ...(0, steer_journey_js_1.default)({ waypoint, mountUrl, plan }), ...resolveHooks('journey.poststeer', waypoint, pageHooks, globalHooks), ...resolveHooks('journey.prerender', waypoint, pageHooks, globalHooks), renderMiddlewareFactory(view, (req) => ({
+        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),
         })));
-        router.post(waypointPath, ...commonMiddleware, ...commonWaypointMiddleware, ...resolveHooks('journey.presteer', waypoint, pageHooks, globalHooks), ...(0, steer_journey_js_1.default)({ waypoint, mountUrl, plan }), ...resolveHooks('journey.poststeer', waypoint, pageHooks, globalHooks), ...resolveHooks('journey.presanitise', waypoint, pageHooks, globalHooks), ...(0, sanitise_fields_js_1.default)({ waypoint, fields }), ...resolveHooks('journey.postsanitise', waypoint, pageHooks, globalHooks), ...resolveHooks('journey.pregather', waypoint, pageHooks, globalHooks), ...(0, gather_fields_js_1.default)({ waypoint, fields }), ...resolveHooks('journey.postgather', waypoint, pageHooks, globalHooks), ...resolveHooks('journey.prevalidate', waypoint, pageHooks, globalHooks), ...(0, validate_fields_js_1.default)({ waypoint, fields, mountUrl, plan }), ...resolveHooks('journey.postvalidate', waypoint, pageHooks, globalHooks), 
+        router.post(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.presanitise', waypointPath, [...globalHooks, ...pageHooks]), ...(0, sanitise_fields_js_1.default)({ waypoint, fields }), ...(0, utils_js_1.resolveMiddlewareHooks)('journey.postsanitise', waypointPath, [...globalHooks, ...pageHooks]), ...(0, utils_js_1.resolveMiddlewareHooks)('journey.pregather', waypointPath, [...globalHooks, ...pageHooks]), ...(0, gather_fields_js_1.default)({ waypoint, fields }), ...(0, utils_js_1.resolveMiddlewareHooks)('journey.postgather', waypointPath, [...globalHooks, ...pageHooks]), ...(0, utils_js_1.resolveMiddlewareHooks)('journey.prevalidate', waypointPath, [...globalHooks, ...pageHooks]), ...(0, validate_fields_js_1.default)({ waypoint, fields, mountUrl, plan }), ...(0, utils_js_1.resolveMiddlewareHooks)('journey.postvalidate', waypointPath, [...globalHooks, ...pageHooks]), 
         // If there were validation errors, jump out of this route and into the
         // next, where the errors will be rendered
-        (req, res, next) => (req.casa.journeyContext.hasValidationErrorsForPage(waypoint) ? next('route') : next()), ...resolveHooks('journey.preredirect', waypoint, pageHooks, globalHooks), ...(0, progress_journey_js_1.default)({ waypoint, plan, mountUrl }));
-        router.post(waypointPath, ...resolveHooks('journey.prerender', waypoint, pageHooks, globalHooks), renderMiddlewareFactory(view, (req) => {
+        (req, res, next) => (req.casa.journeyContext.hasValidationErrorsForPage(waypoint) ? next('route') : next()), ...(0, utils_js_1.resolveMiddlewareHooks)('journey.preredirect', waypointPath, [...globalHooks, ...pageHooks]), ...(0, progress_journey_js_1.default)({ waypoint, plan, mountUrl }));
+        router.post(waypointPath, ...(0, utils_js_1.resolveMiddlewareHooks)('journey.prerender', waypointPath, [...globalHooks, ...pageHooks]), renderMiddlewareFactory(view, (req) => {
             var _a;
             const errors = (_a = req.casa.journeyContext.getValidationErrorsForPageByField(waypoint)) !== null && _a !== void 0 ? _a : Object.create(null);
             // This is a convenience for the template. The `govukErrorSummary` macro
@@ -113,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
@@ -23,7 +24,7 @@ const oneDay = 86400000;
  * @returns {MutableRouter} ExpressJS Router instance
  */
 function staticRouter({ mountUrl = '/', maxAge = 3600000, }) {
-    const staticRouter = new MutableRouter_js_1.default();
+    const router = new MutableRouter_js_1.default();
     const notFoundHandler = (req, res, next) => {
         // Fall through to a general purpose error handler
         next(new Error('404'));
@@ -56,12 +57,12 @@ 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'), '../../');
-    staticRouter.use('/govuk/assets/js/all.js', (0, express_1.static)(`${govukFrontendDirectory}/govuk/all.js`, staticConfig));
-    staticRouter.use('/govuk/assets', (0, express_1.static)(`${govukFrontendDirectory}/govuk/assets`, staticConfig));
-    staticRouter.use('/govuk/assets', notFoundHandler);
-    staticRouter.use('/casa/assets/css/casa.css', setHeaders, (req, res) => res.send(casaCss));
-    staticRouter.use('/casa/assets/css/casa-ie8.css', setHeaders, (req, res) => res.send(casaCssIe8));
-    staticRouter.use('/casa/assets', notFoundHandler);
-    return staticRouter;
+    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));
+    router.use('/casa/assets', notFoundHandler);
+    return router;
 }
 exports.default = staticRouter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "8.0.0-alpha1",
+  "version": "8.0.0",
   "description": "A framework for building GOVUK Collect-And-Submit-Applications",
   "main": "dist/casa.js",
   "module": "dist/mjs/casa.js",
@@ -14,56 +14,75 @@
     "locales/**/*",
     "views/**/*"
   ],
+  "engines": {
+    "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.2.4",
+    "i18next": "21.6.3",
     "i18next-http-middleware": "3.1.4",
     "js-yaml": "4.1.0",
     "lodash": "4.17.21",
-    "luxon": "2.0.2",
+    "luxon": "2.2.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",
-    "@dwp/casa-spiderplan": "1.0.0",
-    "@dwp/commitlint-config-base": "1.2.0",
+    "@babel/core": "7.16.5",
+    "@babel/eslint-parser": "7.16.5",
+    "@babel/preset-env": "7.16.5",
+    "@commitlint/config-conventional": "15.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/eslint-config-base": "5.0.1",
     "@types/express": "4.17.13",
-    "@types/node": "16.10.2",
+    "@types/node": "17.0.1",
+    "@types/nunjucks": "3.2.0",
     "babel-eslint": "10.1.0",
+    "c8": "7.10.0",
     "chai": "4.3.4",
-    "commitlint": "13.2.0",
+    "commitlint": "15.0.0",
     "eslint": "7.32.0",
     "eslint-plugin-no-unsafe-regex": "1.0.0",
-    "eslint-plugin-sonarjs": "0.10.0",
-    "husky": "7.0.2",
-    "mocha": "9.1.2",
-    "sass": "1.42.1",
-    "typescript": "4.4.3"
+    "eslint-plugin-security": "1.4.0",
+    "eslint-plugin-sonarjs": "0.11.0",
+    "fast-check": "2.20.0",
+    "husky": "7.0.4",
+    "mocha": "9.1.3",
+    "sass": "1.45.0",
+    "sinon": "12.0.1",
+    "sinon-chai": "3.7.0",
+    "standard-version": "9.3.2",
+    "supertest": "6.1.6",
+    "typescript": "4.5.4"
   }
 }

package/views/casa/errors/static.njk

@@ -0,0 +1,11 @@
+{% extends "casa/layouts/main.njk" %}
+
+{% block pageTitle %}
+  Sorry, there is a problem with the service
+{% endblock %}
+
+{% block content %}
+  <h1 class="govuk-heading-xl">Sorry, there is a problem with the service</h1>
+
+  <p class="govuk-body">Try again in a few moments.</p>
+{% endblock %}

package/views/casa/layouts/main.njk

@@ -10,15 +10,15 @@
   {# 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 %}
 
 
 {% block header %}
   {{ govukHeader({
-    assetsPath: casa.mountUrl + "govuk/assets/images",
-    serviceName: t(casa.serviceName),
+    assetsPath: assetPath + "/images",
+    serviceName: t('common:serviceName') if t else '',
     serviceUrl: casa.mountUrl,
     homepageUrl: "https://www.gov.uk/"
   }) }}