@dwp/govuk-casa 7.0.6 → 8.0.0-beta1

package/lib/Util.js

@@ -1,227 +0,0 @@
-const dot = require('dot-object');
-const fs = require('fs');
-const path = require('path');
-const nUrl = require('url');
-const logger = require('./Logger')('util');
-
-const OBJECT_TYPE = '[object Object]';
-
-/**
- * Generate an object path string that we can use to traverse an object using
- * `objectPathValue()`.
- *
- * @param {...string} paths Path components.
- * @returns {string} Constructed path.
- */
-function objectPathString(...paths) {
-  let pathString = paths.length ? paths.join('.') : '';
-  // FIX: To support unquoted objects, wrap them in quotes
-  // TASK: Contribute this back to vendor repo.
-  pathString = pathString.replace(/\[([a-zA-Z_]+[a-zA-Z0-9_]*)\]/g, '["$1"]');
-  return pathString;
-}
-
-/**
- * Find the value at the given path of an object. For example, given the
- * object ...
- *  {
- *    rooms: {
- *      lounge: {
- *        objects: [
- *          'TV'
- *        ]
- *      }
- *    }
- *  }
- * ... A call to `objectPathValue(obj, 'rooms[lounge].objects[0]')` would
- * return "TV".
- *
- * @param {object} obj Object to traverse
- * @param {string} paths Path component(s) to use
- * @returns {any} The value of the object, or `undefined` if not found
- * @throws {Error} When given an invalid path
- */
-function objectPathValue(obj, ...paths) {
-  // Using dot-object, it is only used to read from an object. It does not
-  // support quoted properties, so need to remove those, e.g. ["property"].
-  // dot-object has some quirks, such as `a[b.c]` resolving to `a.b.c`,
-  // so we remove any of these to avoid ambiguity.
-  const pathString = paths.join('.').replace(/["']/g, '');
-  if (pathString.match(/\[[^\]]+\./)) {
-    return undefined;
-  }
-
-  try {
-    return dot.pick(pathString, obj);
-  } catch (e) {
-    logger.debug('Object path is invalid: %s (%s)', pathString, e.message);
-    throw e;
-  }
-}
-
-/**
- * Given an object path string generated by `objectPathString()`, create a
- * normalized version that can be used to refer to and name HTML form fields.
- * Specifically, this notation should use plain square braces for objects, with
- * no quotations.
- *
- * @param {string} pathString Path to normalize.
- * @returns {string} Normalized path.
- */
-function normalizeHtmlObjectPath(pathString) {
-  return pathString.replace(/\[["']([^\]]+?)['"]\]/g, '[$1]').replace(/[[\]]/g, '.').replace(/\.+/g, '.').replace(/\.+/g, '][')
-    .replace(/\[+$/g, '')
-    .replace(/^([^[\]]+)]/g, '$1')
-    .replace(/\[([^\]]+)$/g, '[$1]')
-    .replace(/\]+/g, ']')
-    .replace(/\[+/g, '[');
-}
-
-/**
- * Determine if value is empty. Recurse over objects.
- *
- • Options:
- *  RegExp regexRemove = characters matching this regex are removed before test
- *
- * @param  {any} e Value to check
- * @param  {object} options Options (see above)
- * @returns {boolean} True if the object is empty
- */
-function isEmpty(e, options) {
-  let val = e;
-  if (typeof e === 'string' && options && options.regexRemove) {
-    val = e.replace(options.regexRemove, '');
-  }
-
-  if (
-    val === null
-    || typeof val === 'undefined'
-    || (typeof val === 'string' && val === '')
-  ) {
-    return true;
-  }
-  if (Array.isArray(val) || typeof val === 'object') {
-    return Object.keys(val).filter((k) => !isEmpty(val[k], options)).length === 0;
-  }
-  return false;
-}
-
-/**
- * Determine which journey is associated with the "journey" part of the given
- * url. In multiple-journey mode, URLs are formatted as so:
- *  /<journey-guid>/<waypoint-id>
- *
- * @param {Array} journeys Array of UserJourney.Map instances
- * @param {string} url URL to parse
- * @returns {UserJourney.Map|null} The associated journey
- */
-function getJourneyFromUrl(journeys, url) {
-  // Single-journeys are not reflected in URLs
-  if (journeys.length === 1) {
-    return journeys[0];
-  }
-
-  const urlParts = url.replace(/^\/+/, '').split('/');
-  return urlParts.length ? (journeys.find((j) => (j.guid === urlParts[0])) || null) : null;
-}
-
-function getPageIdFromUrl(url) {
-  return nUrl.parse(url).pathname.replace(/^\/+(.+)$/, '$1').replace(/\/+$/g, '');
-}
-
-function getPageIdFromJourneyUrl(journey, url) {
-  const guid = (journey && journey.guid) ? String(journey.guid).replace(/[^a-z0-9-]/ig, '') : undefined;
-  const strippedUrl = guid ? url.replace(new RegExp(`^/*${guid}/*`), '/') : url;
-  return getPageIdFromUrl(strippedUrl);
-}
-
-function isObjectType(obj) {
-  return Object.prototype.toString.call(obj) === OBJECT_TYPE;
-}
-
-function isObjectWithKeys(target, keys = []) {
-  const isObject = Object.prototype.toString.call(target) === OBJECT_TYPE;
-  let hasKeys = true;
-  if (isObject) {
-    keys.forEach((k) => {
-      hasKeys = hasKeys && Object.prototype.hasOwnProperty.call(target, k);
-    });
-  }
-  return isObject && hasKeys;
-}
-
-function hasProp(obj, prop) {
-  return Object.prototype.toString.call(obj) === OBJECT_TYPE
-    && Object.prototype.hasOwnProperty.call(obj, prop);
-}
-
-/**
- * Discover the root folder of the specified npm module.
- *
- * @param {string} module Name of npm module to go and find.
- * @param {Array} paths Paths to search on for module folder.
- * @returns {string} The absolute path to the named module, if found.
- * @throws Error When the module cannot be found.
- * @throws SyntaxError When the module name contains invalid characters.
- */
-function resolveModulePath(module = '', paths = []) {
-  // Strip rogue chars from module name; only valid npm package names are
-  // expected (https://docs.npmjs.com/files/package.json#name)
-  const modName = module.replace(/[^a-z0-9\-_.]/ig, '').replace(/\.+/i, '.');
-  if (modName !== module) {
-    throw new SyntaxError('Module name contains invalid characters');
-  }
-
-  // Look for the module in the same places NodeJS would
-  const resolved = paths.filter((p) => fs.existsSync(path.normalize(`${p}/${modName}`)));
-  if (resolved.length) {
-    return path.normalize(`${resolved[0]}/${modName}`);
-  }
-  throw new Error(`Cannot resolve module '${module}'`);
-}
-
-/**
- * Test is a value can be stringifed (numbers or strings)
- *
- * @param {any} value Item to test
- * @returns {boolean} Whether the value is stringable or not
- */
-function isStringable(value) {
-  return typeof value === 'string' || typeof value === 'number';
-}
-
-/**
- * Coerce an input to a string.
- *
- * @param {any} input Input to be stringified
- * @param {string} fallback Fallback to use if input can't be stringified
- * @returns {string} The stringified input
- */
-function stringifyInput(input, fallback) {
-  // Not using param defaults here as the fallback may be explicitly "undefined"
-  const fb = arguments.length === 2 && (isStringable(fallback) || fallback === undefined) ? fallback : '';
-  return isStringable(input) ? String(input) : fb;
-}
-
-module.exports = {
-  /**
-   * Convert a given URL into an ID that we can use to uniquely identify a
-   * specific page. This function will not verify the page ID is valid.
-   *
-   * @param {string} url Url to parse.
-   * @returns {string} Page ID.
-   */
-  getPageIdFromUrl,
-  getPageIdFromJourneyUrl,
-  getJourneyFromUrl,
-  objectPathValue,
-  objectPathString,
-  normalizeHtmlObjectPath,
-  isEmpty,
-  isObjectType,
-  isObjectWithKeys,
-  resolveModulePath,
-  hasProp,
-  stringifyInput,
-  isStringable,
-};

package/lib/Validation.js

@@ -1,20 +0,0 @@
-/**
- * @deprecated Do not use this file in new applications.
- *
- * Use this instead:
- * const {
- *   validationRules,
- *   validationProcessor,
- *   arrayObjectFieldValidation,
- *   objectFieldValidation,
- *   simpleFieldValidation
- * } = require('@dwp/govuk-casa');.
- */
-
-const util = require('util');
-const validation = require('./validation/index.js');
-
-module.exports = util.deprecate(
-  () => (validation),
-  '@dwp/govuk-casa/lib/Validation should be replaced with "const { validationRules, validationProcessor, arrayObjectFieldValidation, objectFieldValidation, simpleFieldValidation } = require(\'@dwp/govuk-casa\')"',
-)();

package/lib/bootstrap/end-session.js

@@ -1,44 +0,0 @@
-/**
- * End a session.
- *
- * This will destroy the contents of the session, and generate a new session
- * ID. If you need to persist certain data across sessions, be sure to
- * capture it before calling this function, and re-adding it to the new
- * session (in `req.session`) in your promise resolver function.
- *
- * Certain attributes will be persisted:
- *   language
- *
- * @param {object} req HTTP request on which to end the session
- * @returns {Promise} Promise that is resolved once session is fully ended
- */
-module.exports = function endSession(req = {}) {
-  return new Promise((resolve, reject) => {
-    let lang;
-    if (
-      typeof req.session === 'object'
-      && Object.prototype.hasOwnProperty.call(req.session, 'language')
-    ) {
-      lang = req.session.language;
-    }
-    req.session.regenerate((regenError) => {
-      if (typeof lang !== 'undefined') {
-        req.session.language = lang;
-      }
-      if (regenError) {
-        reject(regenError);
-      } else {
-        // Explicitly save the new session and wait until complete to avoid
-        // possible race conditions like this:
-        // https://github.com/expressjs/session/issues/360
-        req.session.save((saveError) => {
-          if (saveError) {
-            reject(saveError);
-          } else {
-            resolve();
-          }
-        });
-      }
-    })
-  });
-};

package/lib/bootstrap/load-definitions.js

@@ -1,64 +0,0 @@
-const PageDirectory = require('../PageDirectory.js');
-const Plan = require('../Plan.js');
-
-const mwErrors = require('../../middleware/errors/index.js');
-const mwPage = require('../../middleware/page/index.js');
-const mwSessionTimeout = require('../../middleware/session/timeout.js');
-
-/**
- * Validate pages and generate a PageDirectory from them.
- *
- * @param {object} pages Page definitions, indexed by page id (url slug).
- * @throws {TypeError} For invalid pages type.
- * @returns {PageDirectory} Pages.
- */
-function buildPageDirectory(pages = {}) {
-  if (Object.prototype.toString.call(pages) !== '[object Object]') {
-    throw new TypeError('pages must be an object');
-  }
-  return new PageDirectory(pages);
-}
-
-/**
- * Validate journey plan.
- *
- * @param {Plan} plan User journey plan.
- * @throws {TypeError} For invalid argument type.
- * @throws {Error} For invalid arguments.
- * @returns {void}
- */
-function validatePlan(plan = []) {
-  // Validate journey(s)
-  // For multiple journeys, all journeys _must_ have a guid, and those guids
-  // must be unique.
-  // For a single journey, a guid must _not_ be set
-  if (!(plan instanceof Plan)) {
-    throw new TypeError('Journey plan must be a Plan instance');
-  } else if (!plan.getOrigins().length) {
-    throw new Error('There must be at least 1 defined origin in the plan');
-  }
-}
-
-/**
- * Load page and journey definitions. The calling application should call this
- * function once all custom routes and configuration has been put in place -
- * it should be the last call made just before starting the HTTP server.
- *
- * @param  {object} pages Page definitions, indexed by page id (url slug).
- * @param  {Plan} plan Journey plan definition.
- * @returns {void}
- */
-
-module.exports = (app, router, config) => (pages, plan) => {
-  // Create PageDirectory
-  // Each page is a node in the plan data structure
-  const pageDirectory = buildPageDirectory(pages);
-
-  // Validate journey
-  validatePlan(plan);
-
-  // Mount journey-management middleware
-  router.get('/session-timeout', mwSessionTimeout(config.sessions.ttl));
-  mwPage(config.mountUrl, router, pageDirectory, plan, config.allowPageEdit, config.useStickyEdit);
-  mwErrors(app);
-};

package/lib/commonBodyParser.js

@@ -1,15 +0,0 @@
-const bodyParser = require('body-parser');
-
-const rProto = /__proto__/i;
-const rPrototype = /prototype[=[\]]/i;
-const rConstructor = /constructor[=[\]]/i;
-
-module.exports = bodyParser.urlencoded({
-  extended: true,
-  verify: (req, res, buf, encoding) => {
-    const body = decodeURI(buf.toString(encoding));
-    if (rProto.test(body) || rPrototype.test(body) || rConstructor.test(body)) {
-      throw new Error('Request body verification failed');
-    }
-  },
-});

package/lib/enums.js

@@ -1,6 +0,0 @@
-module.exports = {
-  // Default journey context id
-  DEFAULT_CONTEXT_ID: 'default',
-};
-
-Object.freeze(module.exports);

package/lib/gather-modifiers/index.js

@@ -1,7 +0,0 @@
-const trimPostalAddressObject = require('./trimPostalAddressObject.js');
-const trimWhitespace = require('./trimWhitespace.js');
-
-module.exports = {
-  trimPostalAddressObject,
-  trimWhitespace,
-};

package/lib/gather-modifiers/trimPostalAddressObject.js

@@ -1,75 +0,0 @@
-/**
- * Gets the property value and Trims white space from it
- *
- * @param {object} value Address object to mung
- * @param {string} prop file property name
- * @returns {string} munged property
- */
-function transferAndTrim(value, prop) {
-  if (typeof value === 'object' && prop in value && typeof value[prop] === 'string') {
-    return value[prop].trim();
-  }
-  return '';
-}
-
-/**
- * Reformats a postcode into the standard form, as long as this results in a valid postcode.
- *
- * It removes all the spaces from the postcode, converts it to uppercase and then
- * puts a single space back in to separate the last three characters.
- *
- * We found during user testing that some accessibility software
- * automatically adds spaces when entering letters and numbers, resulting in an invalid post code.
- * So the remedy is to remove all the spaces from the string and then to add one space back.
- *
- * If this results in a valid postcode then great it returns the new postcode
- * If not then it returns the original value.
- *
- * So if someone has made a mistake then they are not asked to correct the reformatted
- * text, but instead are asked to correct their original
- *
- * @param {object} value Address object to test
- * @returns {object} GatherModifiered version of the Address object
- */
-function reformatPostcodeIfValid(value) {
-  // convert to upper case
-  let postcode = value.toUpperCase();
-
-  // remove any double spaces
-  postcode = postcode.replace(/\s+/g, '');
-
-  // add a space in the middle if the user did not add one
-  if (postcode.length >= 4) {
-    postcode = `${postcode.slice(0, postcode.length - 3)} ${postcode.slice(postcode.length - 3)}`;
-  }
-
-  const pc = /^(?![QVX])[A-Z]((?![IJZ])[A-Z][0-9](([0-9]?)|([ABEHMNPRVWXY]?))|([0-9]([0-9]?|[ABCDEFGHJKPSTUW]?))) ?[0-9]((?![CIKMOV])[A-Z]){2}$|^(BFPO)[ ]?[0-9]{1,4}$/i;
-
-  if (pc.test(postcode)) {
-    return postcode;
-  }
-
-  return value;
-}
-
-/**
- * Works hand in hand with the core CASA `postalAddressObject` form macro.
- *
- * Trims white space from the address items and reformats the post code.
- *
- * @param {object} value Address object to test.
- * @returns {object} GatherModifiered version of the Address object.
- */
-function trimPostalAddressObject(value) {
-  // copy only the expected address properties
-
-  return {
-    address1: transferAndTrim(value.fieldValue, 'address1'),
-    address2: transferAndTrim(value.fieldValue, 'address2'),
-    address3: transferAndTrim(value.fieldValue, 'address3'),
-    address4: transferAndTrim(value.fieldValue, 'address4'),
-    postcode: reformatPostcodeIfValid(transferAndTrim(value.fieldValue, 'postcode')),
-  };
-}
-
-module.exports = trimPostalAddressObject;

package/lib/gather-modifiers/trimWhitespace.js

@@ -1,16 +0,0 @@
-/**
- * TrimWhitespace is the most basic and useful munger.
- * It removes leading and tailing white space from the value.
- *
- *
- * @param  {any} value Value to munge
- * @returns {string} munged value
- */
-function trimWhitespace(value) {
-  if (typeof value.fieldValue === 'string') {
-    return value.fieldValue.trim();
-  }
-  return value.fieldValue;
-}
-
-module.exports = trimWhitespace;

package/lib/utils/createGetRequest.d.ts

@@ -1,5 +0,0 @@
-import { CasaRequestObject } from '../../index';
-
-export = createGetRequest;
-
-declare function createGetRequest (requestObject: CasaRequestObject): string;

package/lib/utils/createGetRequest.js

@@ -1,59 +0,0 @@
-const { DEFAULT_CONTEXT_ID } = require('../enums.js');
-const { sanitiseWaypoint, sanitiseRelativeUrl, sanitiseContextId } = require('./sanitise.js');
-const { validateMountUrl, validateWaypoint } = require('./validate.js');
-
-/**
- * Create a URL for use in GET requests, or links.
- *
- * If neither a waypoint or mountUrl is provided, only the query portion of the
- * URL will be returned. This is a convenience for situation where you just want
- * to append a query to an existing URL without regenerating the query each time.
- *
- * @param {object} requestObject Request object
- * @returns {string} URL
- */
-module.exports = function createGetRequest(requestObject = {}) {
-  const {
-    waypoint,
-    editMode,
-    editOrigin,
-    contextId,
-    skipTo,
-    mountUrl,
-  } = requestObject;
-
-  // Mount URL
-  let urlPath = '';
-  if (mountUrl !== undefined) {
-    validateMountUrl(mountUrl);
-    urlPath = mountUrl;
-  }
-
-  // Waypoint
-  if (waypoint !== undefined) {
-    validateWaypoint(waypoint, { withOrigin: true });
-    urlPath = `${urlPath}${sanitiseWaypoint(waypoint)}`;
-  }
-  const url = new URL(urlPath, 'https://base.test');
-
-  // Edit mode and origin
-  if (editMode === true) {
-    url.searchParams.set('edit', '');
-    if (editOrigin) {
-      url.searchParams.set('editorigin', sanitiseRelativeUrl(editOrigin));
-    }
-  }
-
-  // Context ID
-  if (contextId && contextId !== DEFAULT_CONTEXT_ID) {
-    url.searchParams.set('contextid', sanitiseContextId(contextId));
-  }
-
-  // Skip reference
-  if (skipTo) {
-    url.searchParams.set('skipto', sanitiseWaypoint(skipTo));
-  }
-
-  // Return path / querystring
-  return !waypoint && !mountUrl ? url.search : `${url.pathname}${url.search}`;
-};

package/lib/utils/index.js

@@ -1,11 +0,0 @@
-const createGetRequest = require('./createGetRequest.js');
-const parseRequest = require('./parseRequest.js');
-const validate = require('./validate.js');
-const sanitise = require('./sanitise.js');
-
-module.exports = {
-  createGetRequest,
-  parseRequest,
-  ...sanitise,
-  ...validate,
-};

package/lib/utils/parseRequest.d.ts

@@ -1,5 +0,0 @@
-import { CasaRequestObject } from '../../index';
-
-export = parseRequest;
-
-declare function parseRequest (req: object): CasaRequestObject;

package/lib/utils/parseRequest.js

@@ -1,72 +0,0 @@
-/**
- * Extract some useful CASA-specific information from the request. The resulting
- * object can be manipulated and used to create new requests using
- * `createGetRequest()` and `createPostRequest()`.
- *
- * NOTE: The mountUrl, or proxyMountUrl will _not_ be extracted as `req.url` is
- * used to extract the details, rather than `req.originalUrl`. We could find
- * the mountUrl by comparing the two, but we would not know whether it was a
- * mountUrl or a proxyMountUrl as we have no access to global config here.
- * ref: https://expressjs.com/en/api.html#req.originalUrl
- *
- * Typical usage:
- * const casaRequestObject = parseRequest(req);
- *
- */
-
-const { URL } = require('url');
-const { sanitiseWaypoint, sanitiseRelativeUrl, sanitiseContextId } = require('./sanitise.js');
-const { isObjectWithKeys, hasProp } = require('../Util.js');
-
-function validateRequest(req) {
-  if (!isObjectWithKeys(req, ['method', 'url'])) {
-    throw new TypeError('Request object is invalid (must include a method and url)');
-  }
-  if (!['GET', 'POST'].includes(req.method)) {
-    throw new Error('Unsupported, or undefined request method');
-  }
-  if (req.method === 'GET' && !hasProp(req, 'query')) {
-    throw new Error('GET request must have a query attribute');
-  }
-  if (req.method === 'POST' && !hasProp(req, 'body')) {
-    throw new Error('POST request must have a body attribute');
-  }
-}
-
-module.exports = function parseRequest(req) {
-  // Validate
-  validateRequest(req);
-
-  // Extract URL information
-  // We use req.url which will _not_ include the mounting URL (or proxy mount)
-  const urlObject = new URL(req.url, 'https://base.test');
-  const paramsSource = (req.method === 'GET' ? req.query : req.body) || Object.create(null);
-
-  // waypoint (assume the full path is the waypoint)
-  const waypoint = sanitiseWaypoint(decodeURIComponent(urlObject.pathname));
-
-  // editMode
-  const editMode = 'edit' in paramsSource;
-
-  // editOrigin
-  const editOrigin = editMode && paramsSource.editorigin
-    ? sanitiseRelativeUrl(paramsSource.editorigin)
-    : undefined;
-
-  // contextId
-  const contextId = paramsSource.contextid ? sanitiseContextId(paramsSource.contextid) : undefined;
-
-  // Build sparse object
-  const obj = {
-    waypoint,
-    editMode,
-    editOrigin,
-    contextId,
-  };
-
-  // Sparse result
-  return Object.keys(obj).reduce(
-    (acc, key) => (obj[key] === undefined ? { ...acc } : { ...acc, [key]: obj[key] }),
-    Object.create(null),
-  );
-}