@dwp/govuk-casa 7.0.6 → 8.0.0-alpha1

package/middleware/session/genid.js

@@ -1,18 +0,0 @@
-// If a session ID already exists, then a call here would indicate that
-// the session ID is associated with a session that no longer exists, i.e.
-// it has been removed from storage through either expiry, or error.
-// Setting `req.casaSessionExpired` flags the session for destruction by
-// the next middleware in the chain.
-// We can only check for an undefined req.session here because by the time
-// this function returns, a new session will have been created.
-
-const uid = require('uid-safe');
-
-module.exports = (logger) => (req) => {
-  if (req.sessionID && typeof req.session === 'undefined') {
-    logger.debug('Server session %s has expired. Flagging for destruction.', req.sessionID);
-    req.casaSessionExpired = req.sessionID;
-  }
-
-  return uid.sync(32);
-}

package/middleware/session/index.js

@@ -1,18 +0,0 @@
-/**
- * Prepare session.
- *
- * Enhances `req` with:
- *  object session = Current session
- *  model/claim claim = Current Claim state.
- */
-
-const logger = require('../../lib/Logger.js')('session');
-const mwInit = require('./init.js');
-const mwExpiry = require('./expiry.js');
-const mwSeed = require('./seed.js');
-
-module.exports = (app, mountUrl, sessionExpiryController, sessionConfig) => {
-  app.use(mwInit(logger, sessionConfig));
-  app.use(mwExpiry(logger, mountUrl, sessionExpiryController, sessionConfig));
-  app.use(mwSeed(logger));
-}

package/middleware/session/init.js

@@ -1,25 +0,0 @@
-/**
- * Use session middleware.
- * This will hydrate the HTTP request with a `session` object containing the
- * session data.
- */
-
-const expressSession = require('express-session');
-const genid = require('./genid.js');
-
-module.exports = (logger, config) => expressSession({
-  store: config.store,
-  secret: config.secret,
-  resave: false,
-  saveUninitialized: false,
-  cookie: {
-    secure: config.secure,
-    httpOnly: true,
-    path: config.cookiePath,
-    maxAge: null,
-    sameSite: config.cookieSameSite,
-  },
-  name: config.name,
-  unset: 'destroy',
-  genid: genid(logger),
-});

package/middleware/session/seed.js

@@ -1,50 +0,0 @@
-// Create an object in `req.casa.journeyContext` to represent the data gathered
-// during the user's journey through the defined pages.
-
-const { DEFAULT_CONTEXT_ID } = require('../../lib/enums.js');
-const commonBodyParser = require('../../lib/commonBodyParser.js');
-const JourneyContext = require('../../lib/JourneyContext.js');
-
-const extractRequestedContextId = (request) => {
-  let contextId;
-
-  switch (request.method) {
-  case 'GET':
-    contextId = request.query.contextid;
-    break;
-  case 'POST':
-    contextId = request.body.contextid;
-    break;
-  default:
-    break;
-  }
-
-  return contextId || DEFAULT_CONTEXT_ID;
-};
-
-module.exports = (logger) => ([commonBodyParser, (req, res, next) => {
-  if (!req.session) {
-    next();
-    return;
-  }
-
-  req.casa = req.casa || Object.create(null);
-
-  // Load requested journey context from session. This will remain the "active
-  // context" for the duration of the request.
-  JourneyContext.initContextStore(req.session);
-  let contextId = extractRequestedContextId(req);
-  try {
-    contextId = JourneyContext.validateContextId(contextId);
-    req.casa.journeyContext = JourneyContext.getContextById(req.session, contextId);
-  } catch (ex) {
-    logger.error(ex.message);
-  }
-  if (!req.casa.journeyContext) {
-    logger.info(`Context '${contextId}' not found. Will use 'default'`);
-    req.casa.journeyContext = JourneyContext.getContextById(req.session, DEFAULT_CONTEXT_ID);
-    // TODO: remove contextid from req.query / req.body?
-  }
-
-  next();
-}]);

package/middleware/session/timeout.js

@@ -1,5 +0,0 @@
-module.exports = (sessionTtl) => (req, res) => {
-  res.render('casa/session-timeout.njk', {
-    sessionTtl: Math.floor(sessionTtl / 60),
-  });
-}

package/middleware/static/asset-versions.js

@@ -1,23 +0,0 @@
-const fs = require('fs');
-
-module.exports = (logger, packagesMeta = {}) => {
-  const casaPackageVersions = Object.create(null);
-
-  Object.keys(packagesMeta).forEach((k) => {
-    let version;
-    try {
-      // read() rather than require() to avoid accidental execution of source
-      ({ version } = JSON.parse(fs.readFileSync(packagesMeta[k], 'utf8')));
-    } catch (ex) {
-      logger.debug('Cannot parse file %s (%s) to find version', k, packagesMeta[k]);
-      logger.error(ex);
-      version = '';
-    }
-    casaPackageVersions[k] = version;
-  });
-
-  return (req, res, next) => {
-    res.locals.casa.packageVersions = casaPackageVersions;
-    next();
-  };
-}

package/middleware/static/index.js

@@ -1,104 +0,0 @@
-/**
- * Configure GOVUK templates, and CASA static resources.
- *
- * CASA resources are compiled on-the-fly, stored in the specified
- * `compiledAssetsDir` directory and served from the `/govuk/casa/(css/js)/*`
- * folders.
- *
- * The `govuk_template_jinja` module provides the main Nunjucks templates, as
- * well as some static image/css/js assets. We point the virtual `/govuk/tpl/`
- * URL prefix to these assets.
- *
- * The `govuk_frontend_toolkit` modules provides some static image
- * assets. We point the virtual `/govuk/kit/images/` URL prefix to these. It
- * also provides some static JS assets, which are concatenated on-the-fly and
- * accessed via the `/govuk/kit/js/govuk_toolkit.js` URL.
- *
- * Mounted on `app` rather than `router` otherwise all other `app`-bound
- * middleware continues to execute after router has completed, which isn't
- * what we want for static resources.
- */
-
-const path = require('path');
-const fs = require('fs');
-const logger = require('../../lib/Logger.js')('static');
-
-const mwPrepareAssets = require('./prepare-assets.js');
-const mwServeAssets = require('./serve-assets.js');
-const mwVersions = require('./asset-versions.js');
-
-const onehour = 3600000;
-
-/**
- * Arguments object:
- *  app: Express app instance <Express.App>
- *  mountUrl: CASA application mount url <string>
- *  proxyMountUrl: CASA application proxy mount url <string>
- *  compiledAssetsDir: Absolute path to diretory that will contain static
- *  npmPackages: List of paths to npm packages <object>
- *    govukFrontend: govuk-frontend npm package path <string>,
- *    govukTemplateJinja: govuk_template_jinja npm package path <string>
- *    govukCasa: @dwp/govuk-casa npm package path <string>
- *
- * @param {object} args See above
- * @returns {void}
- * @throws {ReferenceError}
- */
-module.exports = (args) => {
-  const {
-    app,
-    mountUrl = '/',
-    proxyMountUrl = mountUrl,
-    compiledAssetsDir: cAssetsDir,
-    npmPackages: {
-      govukFrontend = '',
-      govukTemplateJinja = '',
-      govukCasa = '',
-    } = Object.create(null),
-  } = args;
-
-  const compiledAssetsDir = path.resolve(cAssetsDir);
-  logger.debug('Preparing compiled assets directory, %s', compiledAssetsDir);
-  try {
-    fs.accessSync(compiledAssetsDir, fs.F_OK);
-  } catch (e) {
-    throw new ReferenceError('Compiled static assets directory does not exist');
-  }
-  logger.info('Compiled static assets dir: %s', compiledAssetsDir);
-
-  // Store GOVUK template virtual URL prefix for other places to use it. This
-  // is the URL from which all GOVUK Frontend client-side assets are served.
-  const govukFrontendVirtualUrl = `${mountUrl}/govuk/frontend`.replace(/\/+/g, '/');
-  app.set('casaGovukFrontendVirtualUrl', govukFrontendVirtualUrl);
-  const govukFrontendVirtualUrlProxy = `${proxyMountUrl}/govuk/frontend`.replace(/\/+/g, '/');
-
-  const prefixCasa = `${proxyMountUrl}/govuk/casa`.replace(/\/+/g, '/');
-
-  logger.trace('Calling prepare-assets');
-  mwPrepareAssets({
-    logger,
-    npmGovukCasa: govukCasa,
-    compiledAssetsDir,
-    mountUrl,
-  });
-
-  logger.trace('Calling serve-assets');
-  mwServeAssets({
-    logger,
-    app,
-    compiledAssetsDir,
-    prefixCasa,
-    govukFrontendVirtualUrlProxy,
-    npmGovukFrontend: govukFrontend,
-    npmGovukTemplateJinja: govukTemplateJinja,
-    maxAge: onehour,
-    proxyMountUrl,
-  });
-
-  logger.trace('Calling asset-versions');
-  app.use(mwVersions(logger, {
-    govukFrontend: path.resolve(govukFrontend, 'package.json'),
-    govukTemplateJinja: path.resolve(govukTemplateJinja, 'package.json'),
-    casaMain: path.resolve(__dirname, '../../package.json'),
-  }));
-}

package/middleware/static/prepare-assets.js

@@ -1,51 +0,0 @@
-/**
- * Inject the configured `mountUrl` into the pre-compiled CSS sources, and copy
- * all CSS and JS to the `compiledAssetsDir` directory.
- *
- * @param {string} npmGovukCasa Path to root of `govuk-casa` module.
- * @param {string} compiledAssetsDir Directory where compiled assets are saved.
- * @param {string} mountUrl Mount point.
- * @returns {void}
- * @throws {Error} For any IO errors.
- */
-
-const path = require('path');
-const klaw = require('klaw-sync');
-const {
-  readFileSync,
-  ensureDirSync,
-  writeFileSync,
-  copyFile,
-} = require('fs-extra');
-
-module.exports = (args) => {
-  const {
-    logger,
-    npmGovukCasa,
-    compiledAssetsDir,
-    mountUrl,
-  } = args;
-
-  const srcDir = path.resolve(npmGovukCasa, 'dist', 'casa');
-  const dstDir = path.resolve(compiledAssetsDir, 'casa');
-  const MOUNT_URL_PLACEHOLDER = /~~~CASA_MOUNT_URL~~~/g;
-
-  // Inject mountUrl into CSS sources and copy across
-  klaw(`${srcDir}/css`).map((f) => (f.path)).forEach((file) => {
-    const css = readFileSync(file, { encoding: 'utf8' }).replace(MOUNT_URL_PLACEHOLDER, mountUrl);
-    const dstPath = path.resolve(`${dstDir}/css`, path.relative(`${srcDir}/css`, file));
-    logger.debug('Copying CSS asset from %s to %s', file, dstPath);
-    ensureDirSync(path.dirname(dstPath));
-    writeFileSync(dstPath, css, {
-      encoding: 'utf8',
-    });
-  });
-
-  // Copy JS sources
-  klaw(`${srcDir}/js`).map((f) => (f.path)).forEach((file) => {
-    const dstPath = path.resolve(`${dstDir}/js`, path.relative(`${srcDir}/js`, file));
-    logger.debug('Copying JS asset from %s to %s', file, dstPath);
-    ensureDirSync(path.dirname(dstPath));
-    copyFile(file, dstPath);
-  });
-}

package/middleware/static/serve-assets.js

@@ -1,58 +0,0 @@
-/**
- * Serve up all CASA assets from the `compiledAssetsDir` directory, and all
- * third party assets from their respective npm package directories.
- *
- * @param {Function} app Express app.
- * @param {Function} static Static module from ExpressJS.
- * @param {string} compiledAssetsDir Directory where static assets are saved.
- * @param {string} prefixCasa Virtual URL prefix.
- * @returns {void}
- */
-
-const path = require('path');
-const expStatic = require('express').static;
-
-module.exports = (args) => {
-  const {
-    logger,
-    app,
-    compiledAssetsDir,
-    prefixCasa,
-    govukFrontendVirtualUrlProxy,
-    npmGovukFrontend,
-    npmGovukTemplateJinja,
-    maxAge = 3600000,
-    proxyMountUrl = '/',
-  } = args;
-
-  const mounts = [{
-    url: prefixCasa,
-    path: path.resolve(compiledAssetsDir, 'casa'),
-  }, {
-    url: `${govukFrontendVirtualUrlProxy}/js/all.js`,
-    path: `${npmGovukFrontend}/govuk/all.js`,
-  }, {
-    url: `${govukFrontendVirtualUrlProxy}/assets`,
-    path: `${npmGovukFrontend}/govuk/assets`,
-  }, {
-    url: `${govukFrontendVirtualUrlProxy}/js/govuk-template.js`,
-    path: `${npmGovukTemplateJinja}/assets/javascripts/govuk-template.js`,
-  }, {
-    url: `${proxyMountUrl}browserconfig.xml`,
-    path: path.resolve(__dirname, '../../src/browserconfig.xml'),
-  }];
-
-  mounts.forEach((m) => {
-    logger.debug('Mounting %s to serve from %s', m.url, m.path);
-    app.use(m.url, expStatic(m.path, {
-      etag: true,
-      lastModified: false,
-      maxAge,
-    }));
-  });
-
-  // Catch-all 404s
-  [prefixCasa, govukFrontendVirtualUrlProxy].forEach((root) => {
-    app.use(root, (req, res) => res.status(404).send('Not found'));
-  });
-}

package/middleware/variables/index.js

@@ -1,12 +0,0 @@
-const logger = require('../../lib/Logger.js')('variables');
-const mwVariables = require('./variables.js');
-
-module.exports = (app, mountUrl, phase, serviceName) => {
-  app.use(mwVariables({
-    logger,
-    serviceName,
-    govukFrontendVirtualUrl: app.get('casaGovukFrontendVirtualUrl'),
-    mountUrl,
-    phase,
-  }));
-};

package/middleware/variables/variables.js

@@ -1,35 +0,0 @@
-module.exports = (args) => (req, res, next) => {
-  const {
-    logger,
-    serviceName,
-    govukFrontendVirtualUrl,
-    mountUrl,
-    phase,
-  } = args;
-
-  logger.trace(
-    'Setting template variables (govukFrontendVirtualUrl: %s, serviceName: %s, mountUrl: %s, phase: %s)',
-    govukFrontendVirtualUrl,
-    serviceName,
-    mountUrl,
-    phase,
-  );
-
-  // Required by GOVUK Frontend
-  res.locals.govuk = {
-    assetPath: `${govukFrontendVirtualUrl}/assets`,
-    components: {
-      header: {
-        assetsPath: `${govukFrontendVirtualUrl}/assets/images`,
-        serviceName: req.i18nTranslator.t(serviceName),
-        serviceUrl: mountUrl,
-        homepageUrl: 'https://www.gov.uk/',
-      },
-    },
-  };
-
-  // CASA-specific vars
-  res.locals.casa.mountUrl = mountUrl;
-  res.locals.casa.phase = phase;
-  next();
-}

package/src/browserconfig.xml

@@ -1,5 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<browserconfig>
-  <msapplication>
-  </msapplication>
-</browserconfig>

package/src/js/casa.js

@@ -1,132 +0,0 @@
-/* eslint sonarjs/cognitive-complexity: 0 */
-/**
- * Common setup of a CASA page.
- */
-
-(function casaJs() {
-  /**
-   * Polyfill for attaching event listeners to elements.
-   *
-   * @param {HTMLElement} obj Element to which event is attached.
-   * @param {string} ev Event name.
-   * @param {Function} func Listener.
-   * @returns {void}
-   * @throws {Error}
-   */
-  function attachEventPolyfill(obj, ev, func) {
-    if (obj.addEventListener) {
-      obj.addEventListener(ev, func, false);
-    } else if (obj.attachEvent) {
-      obj.attachEvent('on' + ev, func);
-    } else {
-      throw new Error('This browser does not support modern event listeners');
-    }
-  }
-
-  // Remove the trailing "#" after a redirect
-  if ('pushState' in window.history && window.location.hash === '') {
-    window.history.replaceState(
-      '',
-      document.title,
-      window.location.pathname + window.location.search
-    );
-  }
-
-  // Focus on error summary, if present. This will allow screen readers to
-  // immediately focus on the errors in the form.
-  var errorSummary = document.getElementById('error-summary-title');
-  if (errorSummary) {
-    errorSummary.focus();
-  }
-
-  // Workaround unwanted bfcache (back-forward cache) behaviour in Safari (until
-  // we can investigate more into issue #2)
-  // Problem:
-  // - Pressing back button after submitted a completed form presents a
-  //   pre-modified version of the form showing stale data.
-  // Fix:
-  // - When a page is retrieved from the bfcache, force a page reload to show the
-  //   updated form data
-  attachEventPolyfill(window, 'pageshow', function hPageShow(ev) {
-    if (ev.persisted) {
-      window.location.reload();
-    }
-  });
-
-  // Initialise all js-controlled GOVUK Frontend UI components
-  GOVUKFrontend.initAll();
-
-  /* ------------------------------------------------ Show/Hide functionality */
-
-  /**
-   * Attach show/hide functionalty.
-   *
-   * @param {HTMLElement} node Element to init.
-   * @returns {void}
-   */
-  function casaV1InitShowHide(node) {
-    var fieldName = node.getAttribute('name');
-    var initNodes = document.querySelectorAll('[name="' + fieldName + '"]:not([data-target-init-done])');
-    var nodeGroup = document.querySelectorAll('[name="' + fieldName + '"]');
-
-    /**
-     * Show target.
-     *
-     * @param {HTMLElement} targetEl Target.
-     * @returns {void}
-     */
-    function showTarget(targetEl) {
-      /* eslint-disable-next-line no-param-reassign */
-      targetEl.className = targetEl.className.replace(/ *js-hidden/, '');
-    }
-
-    /**
-     * Hide target.
-     *
-     * @param {HTMLElement} targetEl Target.
-     * @returns {void}
-     */
-    function hideTarget(targetEl) {
-      /* eslint-disable-next-line no-param-reassign */
-      targetEl.className = targetEl.className.replace(/ *js-hidden/, '') + ' js-hidden';
-    }
-
-    /**
-     * Click node.
-     *
-     * @returns {void}
-     */
-    function clickNode() {
-      for (var i = 0, l = nodeGroup.length; i < l; i += 1) {
-        if (nodeGroup[i].getAttribute('data-target')) {
-          var targetEl = document.getElementById(nodeGroup[i].getAttribute('data-target'));
-          if (nodeGroup[i].checked) {
-            showTarget(targetEl);
-          } else {
-            hideTarget(targetEl);
-          }
-        }
-      }
-    }
-
-    for (var i = 0, l = initNodes.length; i < l; i += 1) {
-      attachEventPolyfill(initNodes[i], 'click', clickNode);
-      initNodes[i].setAttribute('data-target-init-done', true);
-    }
-
-    // Initialise state based on pre-populated inputs
-    clickNode();
-  }
-
-  document.onreadystatechange = function hReayStateChange() {
-    var nodeList;
-    var i;
-    var l;
-    if (document.readyState === 'complete') {
-      nodeList = document.querySelectorAll('[data-target]');
-      for (i = 0, l = nodeList.length; i < l; i += 1) {
-        casaV1InitShowHide(nodeList[i]);
-      }
-    }
-  };
-}());

package/src/scss/_casaElements.scss

@@ -1,11 +0,0 @@
-// JavaScript-managed hidden elements
-// govuk_template_jinja uses its js-hidden class slightly differently to CASA;
-// it adds the class using JavaScript vs CASA's method of showing it and only
-// hiding if the `.js-enabled` root class is set.
-.js-hidden {
-  display: block;
-}
-
-.js-enabled .js-hidden {
-  display: none;
-}

package/src/scss/_casaGovukTemplateJinjaPolyfill.scss

@@ -1,39 +0,0 @@
-/**
- * This contains a few styles taken directly from the govuk_template_jinja
- * module, which saves us having to import the whole
- * `assets/stylesheets/govuk-template.css` file and running into possible
- * conflicts with the `govuk-frontend` styles.
- */
-
-/* ---------------------------------------------------- Global cookie message */
-#global-header-bar, #global-cookie-message p, #footer .footer-wrapper {
-  max-width: 960px;
-  margin: 0 15px; }
-  @media (min-width: 641px) {
-    #global-header-bar, #global-cookie-message p, #footer .footer-wrapper {
-      margin: 0 30px; } }
-  @media (min-width: 1020px) {
-    #global-header-bar, #global-cookie-message p, #footer .footer-wrapper {
-      margin: 0 auto; } }
-
-.js-enabled #global-cookie-message {
-  display: none;
-  /* shown with JS, always on for non-JS */ }
-
-#global-cookie-message {
-  width: 100%;
-  background-color: #d5e8f3;
-  padding-top: 10px;
-  padding-bottom: 10px; }
-  #global-cookie-message p {
-    font-family: "nta", Arial, sans-serif;
-    font-weight: 400;
-    text-transform: none;
-    font-size: 14px;
-    line-height: 1.14286;
-    margin-top: 0;
-    margin-bottom: 0; }
-    @media (min-width: 641px) {
-      #global-cookie-message p {
-        font-size: 16px;
-        line-height: 1.25; } }

package/src/scss/_casaMountUrl.scss

@@ -1,8 +0,0 @@
-// URL prefix that will be used to serve up static assets from the
-// `govuk_frontend_toolkit` images directory.
-// Usage in your own sass source:
-//  $casaMountUrl: "/path/to/your/defined/mount/url";
-//  @import 'node_modules/govuk-casa/src/css/casaMountUrl';
-
-$casaMountUrl: "~~~CASA_MOUNT_URL~~~" !default;
-$govuk-assets-path: $casaMountUrl + "govuk/frontend/assets/";

package/src/scss/casa-ie8.scss

@@ -1,3 +0,0 @@
-$govuk-is-ie8: true;
-
-@import "casa.scss";

package/src/scss/casa.scss

@@ -1,14 +0,0 @@
-// Sets the mount url
-// In the CASA middleware, this will be import the configured mount url
-// dynamically.
-@import 'casaMountUrl.scss';
-
-// Import GOV.UK elements, this will import from govuk-frontend.
-@import 'all.scss';
-
-// Some polyfilled CSS taken from the govuk_template_jinja module, because
-// we don't want to inherit all its CSS
-@import 'casaGovukTemplateJinjaPolyfill.scss';
-
-// Some CASA-specific styles
-@import 'casaElements.scss';

package/test/unit/templates/README.md

@@ -1,5 +0,0 @@
-# Template tests
-
-## Component macros
-
-These are mostly wrappers around the GOVUK Design System's macros, which are thoroughly tested, so our tests are relatively lightweight to ensure that the CASA customisations are applied.