@dwp/govuk-casa 7.0.8 → 7.0.9

package/dist/middleware/steer-journey.js

@@ -1,62 +0,0 @@
-"use strict";
-// This sits in front of all other middleware and prevents the user from
-// "jumping ahead" in the Plan.
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-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.
- *
- * @param {object} obj Options
- * @param {string} obj.waypoint Current waypoint
- * @param {Plan} obj.plan CASA Plan
- * @param {string} obj.mountUrl Mount URL
- * @returns {void}
- */
-exports.default = ({ waypoint, plan, mountUrl, }) => [
-    (req, res, next) => {
-        // If the requested waypoint doesn't exist in the traversed journey, send
-        // the user back to the last good waypoint.
-        const traversed = plan.traverse(req.casa.journeyContext);
-        if (traversed.indexOf(waypoint) === -1) {
-            const redirectTo = traversed[traversed.length - 1];
-            log.trace(`Attempted to access "${waypoint}" when not in the journey; redirecting to "${redirectTo}"`);
-            return res.redirect(302, (0, waypoint_url_js_1.default)({
-                waypoint: redirectTo,
-                mountUrl,
-                journeyContext: req.casa.journeyContext,
-                edit: req.casa.editMode,
-                editOrigin: req.casa.editOrigin,
-            }));
-        }
-        // 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/');
-            if (req.casa.editOrigin === currentPathname) {
-                log.debug(`Disabling edit mode as we are on the edit origin (${req.casa.editOrigin})`);
-                req.casa.editMode = false;
-                req.casa.editOrigin = undefined;
-            }
-        }
-        // difficult: first waypoint on a Plan - how do we determine if there are
-        // other plans pointing at this one? and how do we determine if those others
-        // are part of a future plan, or a past one? Think we'll have to leave it up
-        // to the dev to add the back link for the first page in a Plan.
-        // Calculate URL for the "back" link
-        const [prevRoute] = plan.traversePrevRoutes(req.casa.journeyContext, {
-            startWaypoint: waypoint,
-            stopCondition: () => (true), // stop at the first one
-        });
-        res.locals.casa.journeyPreviousUrl = prevRoute.target ? (0, waypoint_url_js_1.default)({ mountUrl, waypoint: prevRoute.target, routeName: 'prev' }) : undefined;
-        return next();
-    },
-];

package/dist/middleware/validate-fields.d.ts

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

package/dist/middleware/validate-fields.js

@@ -1,67 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-// Validate the data captured in the journey context
-const JourneyContext_js_1 = __importDefault(require("../lib/JourneyContext.js"));
-const updateContext = ({ waypoint, errors = null, journeyContext, session, }) => {
-    // Set validation state
-    if (errors === null) {
-        journeyContext.clearValidationErrorsForPage(waypoint);
-    }
-    else {
-        journeyContext.setValidationErrorsForPage(waypoint, errors);
-    }
-    // Save to session
-    JourneyContext_js_1.default.putContext(session, journeyContext);
-};
-exports.default = ({ waypoint, fields = [], mountUrl, plan, }) => [
-    (req, res, next) => {
-        var _a, _b;
-        let errors = [];
-        for (let i = 0, l = fields.length; i < l; i++) {
-            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];
-            const context = {
-                fieldName,
-                fieldValue,
-                waypoint,
-                journeyContext: req.casa.journeyContext,
-            };
-            if (field.testConditions(context)) {
-                errors = [
-                    ...errors,
-                    ...field.runValidators(fieldValue, context),
-                ];
-            }
-        }
-        // Validation passed with no errors
-        if (!errors.length) {
-            updateContext({
-                waypoint,
-                session: req.session,
-                mountUrl,
-                plan,
-                journeyContext: req.casa.journeyContext,
-            });
-            return next();
-        }
-        // If there are any native errors in the list, we need to bail the request
-        const nativeError = errors.find((e) => e instanceof Error);
-        if (nativeError) {
-            return next(nativeError);
-        }
-        // Make the errors available to downstream middleware
-        updateContext({
-            errors,
-            waypoint,
-            session: req.session,
-            mountUrl,
-            plan,
-            journeyContext: req.casa.journeyContext,
-        });
-        return next();
-    },
-];

package/dist/mjs/esm-wrapper.js

@@ -1,11 +0,0 @@
-// 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
-import casa from '../casa.js';
-
-export const { configure } = casa;
-export const { validators } = casa;
-export const { field } = casa;
-export const { Plan } = casa;
-export const { JourneyContext } = casa;
-export const { ValidationError } = casa;
-export const { waypointUrl } = casa;

package/dist/mjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/dist/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/dist/routes/ancillary.d.ts

@@ -1,11 +0,0 @@
-/**
- * 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: number;
-}): MutableRouter;
-import MutableRouter from "../lib/MutableRouter.js";

package/dist/routes/ancillary.js

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": 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),
-        });
-    });
-    return router;
-}
-exports.default = ancillaryRouter;

package/dist/routes/dirname.cjs

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

package/dist/routes/dirname.d.cts

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

package/dist/routes/journey.d.ts

@@ -1,8 +0,0 @@
-export default function journeyRouter({ globalHooks, pages, plan, csrfMiddleware, mountUrl, }: {
-    globalHooks: any;
-    pages: any;
-    plan: any;
-    csrfMiddleware: any;
-    mountUrl: any;
-}): MutableRouter;
-import MutableRouter from "../lib/MutableRouter.js";

package/dist/routes/journey.js

@@ -1,127 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable object-curly-newline,max-len */
-const MutableRouter_js_1 = __importDefault(require("../lib/MutableRouter.js"));
-const skip_waypoint_js_1 = __importDefault(require("../middleware/skip-waypoint.js"));
-const steer_journey_js_1 = __importDefault(require("../middleware/steer-journey.js"));
-const sanitise_fields_js_1 = __importDefault(require("../middleware/sanitise-fields.js"));
-const gather_fields_js_1 = __importDefault(require("../middleware/gather-fields.js"));
-const validate_fields_js_1 = __importDefault(require("../middleware/validate-fields.js"));
-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 utils_js_1 = require("../lib/utils.js");
-const log = (0, logger_js_1.default)('router: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) => {
-            if (err) {
-                // logger.error(err);
-                next(err);
-            }
-            else {
-                res.send(templateString);
-            }
-        });
-    },
-];
-function journeyRouter({ globalHooks, pages, plan, csrfMiddleware, mountUrl, }) {
-    // Router
-    const router = new MutableRouter_js_1.default();
-    // Special "_" route which handles redirecting the user between sub-apps
-    // /app1/_/?refmount=app2&route=prev
-    router.all('/_', (req, res) => {
-        var _a, _b;
-        const refmount = (_a = req.query) === null || _a === void 0 ? void 0 : _a.refmount;
-        const route = (_b = req.query) === null || _b === void 0 ? void 0 : _b.route;
-        log.trace(`App root ${mountUrl}: refmount = ${refmount}, route = ${route}`);
-        let redirectTo;
-        const fallback = (0, waypoint_url_js_1.default)({
-            mountUrl,
-            waypoint: plan.traverse(req.casa.journeyContext, {
-                stopCondition: () => (true), // we only need one; stop at the first
-            })[0],
-        });
-        if (route === 'prev') {
-            const routes = plan.traversePrevRoutes(req.casa.journeyContext, { startWaypoint: refmount });
-            redirectTo = routes.length ? (0, waypoint_url_js_1.default)({ mountUrl, waypoint: routes[0].target }) : fallback;
-        }
-        else {
-            const routes = plan.traverseNextRoutes(req.casa.journeyContext, { startWaypoint: refmount });
-            if (routes[0].target !== null) {
-                redirectTo = routes.length ? (0, waypoint_url_js_1.default)({ mountUrl, waypoint: routes[0].target }) : fallback;
-            }
-            else {
-                redirectTo = fallback;
-            }
-        }
-        // Carry over any params
-        const url = new URL(redirectTo, 'https://placeholder.test/');
-        const searchParams = new URLSearchParams(req.query);
-        searchParams.delete('refmount');
-        searchParams.delete('route');
-        url.search = searchParams.toString();
-        redirectTo = `${url.pathname.replace(/\/+/g, '/')}${url.search}`;
-        log.trace(`Redirect to ${redirectTo}`);
-        return res.redirect(redirectTo);
-    });
-    // Create GET / POST routes for each page
-    const commonMiddleware = [
-        ...csrfMiddleware,
-    ];
-    pages.forEach((page) => {
-        const { waypoint, view, hooks: pageHooks = [], fields } = page;
-        const formUrl = (0, waypoint_url_js_1.default)({ mountUrl, waypoint });
-        const waypointPath = `/${waypoint}`;
-        let commonWaypointMiddleware = [
-            (req, res, next) => {
-                req.casa.waypoint = waypoint;
-                res.locals.casa.waypoint = waypoint;
-                next();
-            },
-        ];
-        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, ...(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()), ...(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
-            // requires the errors be in a particular format, so here we provide our
-            // errors in that format.
-            // Where there are multiple errors against a particular field, only the
-            // first one is shown.
-            const govukErrors = Object.keys(errors).map((k) => ({
-                text: req.t(errors[k][0].summary, errors[k][0].variables),
-                href: errors[k][0].fieldHref,
-            }));
-            return {
-                formUrl,
-                formData: req.body,
-                formErrors: Object.keys(errors).length ? errors : null,
-                formErrorsGovukArray: govukErrors.length ? govukErrors : null,
-            };
-        }));
-    });
-    return router;
-}
-exports.default = journeyRouter;

package/dist/routes/static.d.ts

@@ -1,26 +0,0 @@
-/**
- * @typedef {object} StaticOptions Options to configure static router
- * @property {string} [mountUrl=/] URL prefix for govuk-frontend static assets (optional, default /)
- * @property {number} [maxAge=3600000] Cache TTL for all assets (optional, default 1 hour)
- */
-/**
- * Create a router for serving CASA's static assets.
- *
- * @param {StaticOptions} options Options
- * @returns {MutableRouter} ExpressJS Router instance
- */
-export default function staticRouter({ mountUrl, maxAge, }: StaticOptions): MutableRouter;
-/**
- * Options to configure static router
- */
-export type StaticOptions = {
-    /**
-     * )
-     */
-    mountUrl?: string | undefined;
-    /**
-     * Cache TTL for all assets (optional, default 1 hour)
-     */
-    maxAge?: number | undefined;
-};
-import MutableRouter from "../lib/MutableRouter.js";

package/dist/routes/static.js

@@ -1,68 +0,0 @@
-"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 = __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
- * @property {string} [mountUrl=/] URL prefix for govuk-frontend static assets (optional, default /)
- * @property {number} [maxAge=3600000] Cache TTL for all assets (optional, default 1 hour)
- */
-/**
- * Create a router for serving CASA's static assets.
- *
- * @param {StaticOptions} options Options
- * @returns {MutableRouter} ExpressJS Router instance
- */
-function staticRouter({ mountUrl = '/', maxAge = 3600000, }) {
-    const router = new MutableRouter_js_1.default();
-    const notFoundHandler = (req, res, next) => {
-        // Fall through to a general purpose error handler
-        next(new Error('404'));
-    };
-    const setHeaders = (req, res, next) => {
-        var _a;
-        res.set('cache-control', 'public');
-        res.set('pragma', 'cache');
-        res.set('expires', new Date(Date.now() + oneDay).toUTCString());
-        const { pathname } = new url_1.URL((_a = req === null || req === void 0 ? void 0 : req.originalUrl) !== null && _a !== void 0 ? _a : '', 'http://placeholder.test/');
-        if (pathname.substr(-4) === '.css') {
-            // Just needed for our in-memory CSS assets
-            res.set('content-type', 'text/css');
-        }
-        next();
-    };
-    const staticConfig = {
-        etag: true,
-        lastModified: false,
-        maxAge,
-        setHeaders: (res) => {
-            setHeaders(null, res, () => { });
-        },
-    };
-    // The CASA CSS source contains the placeholder `~~~CASA_MOUNT_URL~~~` which
-    // must be replaced with the dynamic `mountUrl` to ensure govuk-frontend
-    // assets are served from the correct location.
-    const casaCss = (0, fs_1.readFileSync)((0, path_1.resolve)(dirname_cjs_1.default, '../../dist/assets/css/casa.css'), { encoding: 'utf8' }).replace(/~~~CASA_MOUNT_URL~~~/g, mountUrl);
-    const casaCssIe8 = (0, fs_1.readFileSync)((0, path_1.resolve)(dirname_cjs_1.default, '../../dist/assets/css/casa-ie8.css'), { encoding: 'utf8' }).replace(/~~~CASA_MOUNT_URL~~~/g, mountUrl);
-    // 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', 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;