@dwp/govuk-casa 7.0.6 → 8.0.0-beta1

package/lib/validation/processor/queue.js

@@ -1,214 +0,0 @@
-const util = require('../../Util.js');
-const ValidationError = require('../ValidationError.js');
-const rules = require('../rules/index.js');
-const flattenErrorArray = require('./flattenErrorArray.js');
-
-const T_SIMPLE = 'simple';
-const T_OBJECT = 'object';
-const T_ARRAY_OBJECT = 'array_object';
-
-/**
- * Add a validator object to the processing queue.
- *
- * @param  {Array} queue Queue to which validators will be added
- * @param  {string} waypointId Waypoint under validation
- * @param  {PageMeta} pageMeta Meta object representing the page being validated
- * @param  {object} journeyContext Full JourneyContext
- * @param  {string} field Field to validate (in square-brace notation)
- * @param  {import('../SimpleField')} validatorObj Validation attributes to apply
- * @returns {void}
- */
-/* eslint-disable-next-line consistent-return,require-jsdoc */
-function queueValidator(queue, waypointId, pageMeta, journeyContext, field, validatorObj) {
-  // Do not queue if condition is not met
-  if (validatorObj.condition({
-    fieldName: util.normalizeHtmlObjectPath(field),
-    journeyContext,
-    waypointId,
-  })) {
-    switch (validatorObj.type) {
-    case T_SIMPLE:
-      /* eslint-disable-next-line no-use-before-define */
-      return queueSimpleValidator(
-        queue, waypointId, pageMeta, journeyContext, field, validatorObj,
-      );
-    case T_OBJECT:
-      /* eslint-disable-next-line no-use-before-define */
-      return queueObjectValidator(
-        queue, waypointId, pageMeta, journeyContext, field, validatorObj,
-      );
-    case T_ARRAY_OBJECT:
-      /* eslint-disable-next-line no-use-before-define */
-      return queueArrayObjectValidator(
-        queue, waypointId, pageMeta, journeyContext, field, validatorObj,
-      );
-    default:
-      throw new Error('Unknown or unspecified validator type');
-    }
-  }
-}
-
-/**
- * Add a Validation.SimpleField object to the processing queue.
- *
- * @param  {Array} queue Queue to which validators will be added.
- * @param  {string} waypointId Waypoint under validation.
- * @param  {PageMeta} pageMeta Meta object representing the page being validated.
- * @param  {object} journeyContext Full JourneyContext.
- * @param  {string} field Field to validate (in square-brace notation).
- * @param  {object} validatorObj Validation attributes to apply.
- * @returns {void}
- */
-function queueSimpleValidator(queue, waypointId, pageMeta, journeyContext, field, validatorObj) {
-  // Ensure pageMeta.id is defined when extracting data for the waypoint
-  let pageData;
-  if (!Object.prototype.hasOwnProperty.call(pageMeta, 'id')) {
-    pageData = journeyContext.getDataForPage({
-      id: waypointId,
-      ...pageMeta,
-    });
-  } else {
-    pageData = journeyContext.getDataForPage(pageMeta);
-  }
-
-  // For optional fields (i.e. one whose validation rules contains the
-  // `optional` rule), first check if the field value is present before
-  // queuing all other rules.
-  const fieldValue = util.objectPathValue(pageData, field);
-  if (
-    validatorObj.validators.some((v) => (v.validate === rules.optional))
-    && rules.optional(fieldValue)
-  ) {
-    return;
-  }
-
-  validatorObj.validators.forEach((validator) => {
-    // A more useful exception with reference to field name
-    if (typeof validator.validate !== 'function') {
-      throw new Error(`Validator defined on '${field}'' is not a function`);
-    }
-
-    // Skip `optional` rule as it does not return a Promise, and has already
-    // been evaluated above.
-    if (validator.validate === rules.optional) {
-      return;
-    }
-
-    // Create context object which allows a validator to optionally looks at
-    // other data within the page being validated
-    const dataContext = {
-      fieldName: field,
-      journeyContext,
-      waypointId,
-    };
-
-    // Determine the name of the validator function so that we can pass it
-    // back to the template for Anayltics purposes.
-    const validatorName = (validator.name || validator.validate.name).replace(/^.*?([a-z0-9_]+)$/i, '$1');
-
-    // As well as the validator, we add an immediate `catch()` handler after
-    // it in order to collect _all_ errors thrown by all validators. Otherise
-    // `Promise.all()` would reject at the first failure and miss all other
-    // errors.
-    queue.push(validator.validate(fieldValue, dataContext).catch((validationError) => {
-      let err = validationError;
-      if (err instanceof Error) {
-        err = ValidationError.make({ errorMsg: err });
-      } else if (err === undefined) {
-        err = ValidationError.make({ errorMsg: 'Unknown error' });
-      }
-
-      let errors;
-      try {
-        errors = flattenErrorArray(err);
-      } catch (ex) {
-        errors = [ValidationError.make({ errorMsg: ex })];
-      }
-
-      // Apply current context to each error
-      errors.forEach((error) => error.withContext({ ...dataContext, validator: validatorName }));
-
-      return Promise.resolve(errors);
-    }));
-  });
-}
-
-/**
- * Add a Validation.ObjectField object to the queue.
- *
- * @param  {Array} queue Queue to which validators will be added.
- * @param  {string} waypointId Waypoint under validation.
- * @param  {PageMeta} pageMeta Meta object representing the page being validated.
- * @param  {object} journeyContext Full JourneyContext.
- * @param  {string} field Field to validate (in square-brace notation).
- * @param  {object} validatorObj Validation attributes to apply.
- * @returns {void}
- */
-function queueObjectValidator(queue, waypointId, pageMeta, journeyContext, field, validatorObj) {
-  // Add this validator's rules to the queue (if any)
-  queueSimpleValidator(queue, waypointId, pageMeta, journeyContext, field, validatorObj);
-
-  // Queue the child validator objects
-  Object.keys(validatorObj.children).forEach((childField) => {
-    const child = validatorObj.children[childField];
-    queueValidator(
-      queue,
-      waypointId,
-      pageMeta,
-      journeyContext,
-      util.objectPathString(field, childField),
-      child,
-    );
-  });
-}
-
-/**
- * Add a Validation.ArrayObjectField object to the queue.
- *
- * @param  {Array} queue Queue to which validators will be added.
- * @param  {string} waypointId Waypoint under validation.
- * @param  {PageMeta} pageMeta Meta object representing the page being validated.
- * @param  {object} journeyContext Full JourneyContext.
- * @param  {string} field Field to validate (in square-brace notation).
- * @param  {object} validatorObj Validation attributes to apply.
- * @returns {void}
- */
-function queueArrayObjectValidator(
-  queue, waypointId, pageMeta, journeyContext, field, validatorObj,
-) {
-  // Add this validator's rules to the queue (if any)
-  queueSimpleValidator(queue, waypointId, pageMeta, journeyContext, field, validatorObj);
-
-  // The object at `pageData[field]` should be an array, indexed from 0. If it
-  // is anything else, it is ignored.
-  // Some caution is needed here because a non-/empty array will not trigger
-  // any validations on the fields that _should_ be in objects in that array.
-  const pageData = journeyContext.getDataForPage(pageMeta);
-  let arrayObj = util.objectPathValue(pageData, util.objectPathString(field));
-  if (!Array.isArray(arrayObj)) {
-    arrayObj = [];
-  }
-
-  // Cycle through each element in the array and add all validators for each
-  // one.
-  arrayObj.forEach((obj, index) => {
-    Object.keys(validatorObj.children).forEach((childField) => {
-      const child = validatorObj.children[childField];
-      queueValidator(
-        queue,
-        waypointId,
-        pageMeta,
-        journeyContext,
-        util.objectPathString(`${field}[${index}]`, childField),
-        child,
-      );
-    });
-  });
-}
-
-module.exports = {
-  queueValidator,
-  queueSimpleValidator,
-  queueObjectValidator,
-  queueArrayObjectValidator,
-};

package/lib/validation/processor.js

@@ -1,84 +0,0 @@
-const { queueValidator } = require('./processor/queue.js');
-
-/**
- * This is the core function that carries out validation on a page's data.
- *
- * For objects/array fields, use square-braces syntax.
- *
- * Parameters:
- *   string waypointId = The waypoint being validated
- *   object pageMeta = The meta object representing the page being processed
- *   JourneyContext journeyContext = The full JourneyContext
- *   bool reduceErrors = Reduces each field to a single error (default false)
- *
- * @param {object} params Parameters object as above
- * @param {string} params.waypointId Waypoint ID
- * @param {object} params.pageMeta Page meta
- * @param {Function} params.journeyContext Journey context
- * @param {boolean} params.reduceErrors True is errors should be reduced to a single error
- * @returns {Promise} Promise
- */
-// module.exports = (fieldValidators = {}, userData = {}, options = {}) => {
-module.exports = ({
-  waypointId, pageMeta = { fieldValidators: {} }, journeyContext = {}, reduceErrors = false,
-} = {}) => {
-  // Build up a queue of Promises that will be executed on each field
-  const validatorQueue = [];
-  Object.keys(pageMeta.fieldValidators).forEach((field) => {
-    queueValidator(
-      validatorQueue, waypointId, pageMeta, journeyContext, field, pageMeta.fieldValidators[field],
-    );
-  });
-
-  /**
-   * Reduce the errors to include only the first error per field. Some fields
-   * have multiple validation rules that may each be violated and thus result
-   * in their own error messages, which can quickly stack up on larger pages.
-   *
-   * @param {object} errors All errors.
-   * @returns {object} Reduced error list, indexed by field name.
-   */
-  function reduceGroupedErrors(errors) {
-    const reduced = Object.create(null);
-    Object.keys(errors).forEach((field) => {
-      reduced[field] = [errors[field][0]];
-    });
-    return reduced;
-  }
-
-  /**
-   * Gather the array of errors generated by the validation process, into a flat
-   * object indexed by the field names. This makes it easier to reference errors
-   * in the front-end template.
-   *
-   * @param  {Array} errorsList Array of errors.
-   * @returns {Promise} Promise.
-   */
-  function gatherErrors(errorsList) {
-    let grouped = Object.create(null);
-    errorsList.forEach((errors) => {
-      if (Array.isArray(errors)) {
-        errors.forEach((e) => {
-          if (!grouped[e.field]) {
-            grouped[e.field] = [];
-          }
-          grouped[e.field].push(e);
-        });
-      }
-    });
-
-    if (reduceErrors) {
-      grouped = reduceGroupedErrors(grouped);
-    }
-
-    return Object.keys(grouped).length
-      ? Promise.reject(grouped)
-      : Promise.resolve();
-  }
-
-  // Resulting Promise
-  if (validatorQueue.length) {
-    return Promise.all(validatorQueue).then(gatherErrors);
-  }
-  return Promise.resolve();
-}

package/lib/validation/rules/README.md

@@ -1,3 +0,0 @@
-# Validation Rules
-
-All core **CASA** rules are provided here.

package/lib/validation/rules/ValidationRules.d.ts

@@ -1,22 +0,0 @@
-import DateObject from './dateObject';
-import Email from './email';
-import InArray from './inArray';
-import Nino from './nino';
-import PostalAddressObject from './postalAddressObject';
-import Regex from './dateObject';
-import Required from './required';
-import Strlen from './strlen';
-import WordCount from './wordCount';
-
-export namespace ValidationRules {
-  export type dateObject = DateObject;
-  export type email = Email;
-  export type inArray = InArray;
-  export type nino = Nino;
-  export function optional(value: any):boolean;
-  export type postalAddressObject = PostalAddressObject;
-  export type regex = Regex;
-  export type required = Required;
-  export type strlen = Strlen;
-  export type wordCount = WordCount;
-}

package/lib/validation/rules/dateObject.js

@@ -1,156 +0,0 @@
-/* eslint-disable class-methods-use-this */
-/**
- * Date object format:
- *  {
- *    dd: <string>,
- *    mm: <string>,
- *    yyyy: <string>
- *  }.
- *
- * Note that the time part of any injected "DateTime" objects will be zero'ed, as
- * we are only interested in the date component (minimum day resolution).
- *
- * Config options:
- *   string|object errorMsg = Error message to use on validation failure
- *   object|luxon.Duration afterOffsetFromNow = Date must be after offset from now
- *   string|object errorMsgAfterOffset = Error for afterOffsetFromNow failure
- *   object|luxon.Duration beforeOffsetFromNow = Date must be before offset from now
- *   string|object errorMsgBeforeOffset = Error for beforeOffsetFromNow failure
- *   bool allowMonthNames = Allow "Jan", "January", etc (default = false)
- *   bool allowSingleDigitDay = Allow "1" rather than "01" (default = false)
- *   bool allowSingleDigitMonth = Allow "1" rather than "01" (default = false)
- *   luxon.DateTime now = Override the notion of "now" (useful for testing)
- */
-const { DateTime } = require('luxon');
-const ValidationError = require('../ValidationError.js');
-const ValidatorFactory = require('../ValidatorFactory.js');
-const { isObjectType, stringifyInput } = require('../../Util.js');
-
-class DateObject extends ValidatorFactory {
-  validate(value, dataContext = {}) {
-    const config = {
-      errorMsg: {
-        inline: 'validation:rule.dateObject.inline',
-        summary: 'validation:rule.dateObject.summary',
-      },
-      errorMsgAfterOffset: {
-        inline: 'validation:rule.dateObject.afterOffset.inline',
-        summary: 'validation:rule.dateObject.afterOffset.summary',
-      },
-      errorMsgBeforeOffset: {
-        inline: 'validation:rule.dateObject.beforeOffset.inline',
-        summary: 'validation:rule.dateObject.beforeOffset.summary',
-      },
-      now: DateTime.local(),
-      allowSingleDigitDay: false,
-      allowSingleDigitMonth: false,
-      allowMonthNames: false,
-      afterOffsetFromNow: undefined,
-      beforeOffsetFromNow: undefined,
-      ...this.config,
-    };
-
-    let valid = false;
-    let { errorMsg } = config;
-    let luxonDate;
-    const NOW = config.now.startOf('day');
-
-    // Accepted formats
-    let formats = ['dd-MM-yyyy'];
-    const formatTests = [{
-      flags: [config.allowSingleDigitDay],
-      formats: ['d-MM-yyyy'],
-    }, {
-      flags: [config.allowSingleDigitDay, config.allowSingleDigitMonth],
-      formats: ['d-M-yyyy'],
-    }, {
-      flags: [config.allowSingleDigitDay, config.allowMonthNames],
-      formats: ['d-MMM-yyyy', 'd-MMMM-yyyy'],
-    }, {
-      flags: [config.allowSingleDigitMonth],
-      formats: ['dd-M-yyyy'],
-    }, {
-      flags: [config.allowMonthNames],
-      formats: ['dd-MMM-yyyy', 'dd-MMMM-yyyy'],
-    }];
-    formatTests.forEach((test) => {
-      if (test.flags.every((v) => v === true)) {
-        formats = [...formats, ...test.formats]
-      }
-    });
-
-    if (typeof value === 'object') {
-      formats.find((format) => {
-        luxonDate = DateTime.fromFormat(
-          [value.dd, value.mm, value.yyyy].join('-'),
-          format,
-        ).startOf('day');
-
-        valid = luxonDate.isValid;
-
-        return valid;
-      });
-
-      if (luxonDate) {
-        // Check date is after the specified duration from now.
-        // Need to use UTC() otherwise DST shifts can affect the calculated offset
-        if (config.afterOffsetFromNow) {
-          const offsetDate = NOW.plus(config.afterOffsetFromNow).startOf('day');
-
-          if (luxonDate <= offsetDate) {
-            valid = false;
-            errorMsg = config.errorMsgAfterOffset;
-          }
-        }
-
-        // Check date is before the specified duration from now
-        // Need to use UTC() otherwise DST shifts can affect the calculated offset
-        if (config.beforeOffsetFromNow) {
-          const offsetDate = NOW.plus(config.beforeOffsetFromNow).startOf('day');
-
-          if (luxonDate >= offsetDate) {
-            valid = false;
-            errorMsg = config.errorMsgBeforeOffset;
-          }
-        }
-      }
-
-      // Check presence of each object component (dd, mm, yyyy) in order to log
-      // which specific parts are in error
-      errorMsg.focusSuffix = [];
-      if (!Object.prototype.hasOwnProperty.call(value, 'dd') || !value.dd) {
-        errorMsg.focusSuffix.push('[dd]');
-      }
-      if (!Object.prototype.hasOwnProperty.call(value, 'mm') || !value.mm) {
-        errorMsg.focusSuffix.push('[mm]');
-      }
-      if (!Object.prototype.hasOwnProperty.call(value, 'yyyy') || !value.yyyy) {
-        errorMsg.focusSuffix.push('[yyyy]');
-      }
-
-      // If the date is invalid, but not specific parts have been highighted in
-      // error, then highlight all inputs, focusing on the [dd] first
-      if (!valid && !errorMsg.focusSuffix.length) {
-        errorMsg.focusSuffix = ['[dd]', '[mm]', '[yyyy]'];
-      }
-    }
-
-    return valid ? Promise.resolve() : Promise.reject(ValidationError.make({
-      errorMsg,
-      dataContext,
-    }));
-  }
-
-  sanitise(value) {
-    if (value !== undefined) {
-      return isObjectType(value) ? {
-        dd: stringifyInput(value.dd),
-        mm: stringifyInput(value.mm),
-        yyyy: stringifyInput(value.yyyy),
-      } : Object.create(null);
-    }
-    return undefined;
-  }
-}
-
-module.exports = DateObject;

package/lib/validation/rules/email.js

@@ -1,44 +0,0 @@
-/* eslint-disable class-methods-use-this */
-/**
- * Email address.
- *
- * This is not an exhaustive validation, and is permissive.
- *
- * Config options:
- *   string|object errorMsg = Error message to use on validation failure
- */
-
-const { isEmail } = require('validator');
-const ValidationError = require('../ValidationError.js');
-const ValidatorFactory = require('../ValidatorFactory.js');
-const { stringifyInput } = require('../../Util.js');
-
-class Email extends ValidatorFactory {
-  validate(value, dataContext = {}) {
-    let isValid;
-    try {
-      isValid = isEmail(value);
-    } catch (e) {
-      isValid = false;
-    }
-
-    const errorMsg = this.config.errorMsg || {
-      summary: 'validation:rule.email.summary',
-      inline: 'validation:rule.email.inline',
-    };
-
-    return isValid ? Promise.resolve() : Promise.reject(ValidationError.make({
-      errorMsg,
-      dataContext,
-    }));
-  }
-
-  sanitise(value) {
-    if (value !== undefined) {
-      return stringifyInput(value);
-    }
-    return undefined;
-  }
-}
-
-module.exports = Email;

package/lib/validation/rules/inArray.js

@@ -1,61 +0,0 @@
-/* eslint-disable class-methods-use-this */
-/**
- * Test if a value is present in an array.
- *
- * Config options:
- *   Array source = Array of values to test against
- *
- * If the value itself is an array, all values within that array must be present
- * in the `source` array in order to pass validation.
- */
-const ValidationError = require('../ValidationError.js');
-const ValidatorFactory = require('../ValidatorFactory.js');
-const { stringifyInput, isStringable } = require('../../Util.js');
-
-class InArray extends ValidatorFactory {
-  validate(value, dataContext = {}) {
-    let valid = false;
-    const source = this.config.source || [];
-    const errorMsg = this.config.errorMsg || {
-      inline: 'validation:rule.inArray.inline',
-      summary: 'validation:rule.inArray.summary',
-    };
-
-    if (value !== null && typeof value !== 'undefined') {
-      const search = Array.isArray(value) ? value : [value];
-      for (let i = 0, l = search.length; i < l; i += 1) {
-        if (source.indexOf(search[i]) > -1) {
-          valid = true;
-        } else {
-          valid = false;
-          break;
-        }
-      }
-    }
-
-    return valid ? Promise.resolve() : Promise.reject(ValidationError.make({
-      errorMsg,
-      dataContext,
-    }));
-  }
-
-  sanitise(value) {
-    const coerce = (val) => (stringifyInput(val, undefined));
-
-    // Basic stringable
-    if (isStringable(value)) {
-      return stringifyInput(value);
-    }
-
-    // Coerce all elements to Strings.
-    // This only supports one dimensional array, with stringable element.
-    if (Array.isArray(value)) {
-      return value.map(coerce);
-    }
-
-    // Unsupported value
-    return undefined;
-  }
-}
-
-module.exports = InArray;

package/lib/validation/rules/index.js

@@ -1,23 +0,0 @@
-const dateObject = require('./dateObject.js');
-const email = require('./email.js');
-const inArray = require('./inArray.js');
-const nino = require('./nino.js');
-const optional = require('./optional.js');
-const postalAddressObject = require('./postalAddressObject.js');
-const regex = require('./regex.js');
-const required = require('./required.js');
-const strlen = require('./strlen.js');
-const wordCount = require('./wordCount.js');
-
-module.exports = {
-  dateObject,
-  email,
-  inArray,
-  nino,
-  optional,
-  postalAddressObject,
-  regex,
-  required,
-  strlen,
-  wordCount,
-};

package/lib/validation/rules/nino.js

@@ -1,48 +0,0 @@
-/* eslint-disable class-methods-use-this */
-/**
- * UK National Insurance number.
- *
- * Config options:
- *   string|object errorMsg = Error message to use on validation failure
- *   boolean allowWhitespace = will permit input values that contain spaces.
- *
- * Ref:
- * https://en.wikipedia.org/wiki/National_Insurance_number#Format
- * https://design-system.service.gov.uk/patterns/national-insurance-numbers/
- */
-const ValidationError = require('../ValidationError.js');
-const ValidatorFactory = require('../ValidatorFactory.js');
-const { stringifyInput } = require('../../Util.js');
-
-class Nino extends ValidatorFactory {
-  validate(value, dataContext = {}) {
-    const {
-      allowWhitespace,
-      errorMsg = {
-        inline: 'validation:rule.nino.inline',
-        summary: 'validation:rule.nino.summary',
-      },
-    } = this.config;
-
-    if (typeof allowWhitespace !== 'undefined' && typeof allowWhitespace !== 'boolean') {
-      throw new TypeError(`NINO validation rule option "allowWhitespace" must been a boolean. received ${typeof allowWhitespace}`);
-    }
-    const valid = typeof value === 'string'
-      && value.replace((typeof allowWhitespace !== 'undefined' && allowWhitespace) ? /\u0020/g : '', '')
-        .match(/^(?!BG|GB|NK|KN|TN|NT|ZZ)[ABCEGHJ-PRSTW-Z][ABCEGHJ-NPRSTW-Z]\d{6}[A-D]$/i);
-
-    return valid ? Promise.resolve() : Promise.reject(ValidationError.make({
-      errorMsg,
-      dataContext,
-    }));
-  }
-
-  sanitise(value) {
-    if (value !== undefined) {
-      return stringifyInput(value);
-    }
-    return undefined;
-  }
-}
-
-module.exports = Nino;

package/lib/validation/rules/optional.js

@@ -1,14 +0,0 @@
-const Util = require('../../Util.js');
-
-/**
- * This is different to all other rules in that it _must_ return a value
- * synchronously. You must not `bind()` this function to create a new one.
- *
- * @param  {any} value Value
- * @returns {boolean} Return true if the value is not present
- */
-function optional(value) {
-  return Util.isEmpty(value);
-}
-
-module.exports = optional;