hof 22.9.0-beta.v1 → 22.9.0-beta.v2

package/package/build/tasks/watch/index.js

@@ -1,161 +0,0 @@
-/* eslint-disable no-console */
-'use strict';
-
-const build = require('../build');
-const chokidar = require('chokidar');
-const throttle = require('lodash').throttle;
-const uniq = require('lodash').uniq;
-const cp = require('child_process');
-const path = require('path');
-const match = require('minimatch');
-const chalk = require('chalk');
-const extname = require('path').extname;
-
-const tasks = require('../');
-
-const run = require('../../lib/run');
-const env = require('../../lib/env');
-
-module.exports = config => {
-  let toBuild = [];
-  let server;
-
-  const matchers = Object.keys(tasks).reduce((map, key) => {
-    if (!config[key]) {
-      return map;
-    }
-    const matcher = config[key].match || config[key].src;
-    if (matcher) {
-      map[key] = matcher;
-    }
-    return map;
-  }, {});
-
-  function triggersTask(file) {
-    return Object.keys(matchers).filter(key => match(file, matchers[key]));
-  }
-
-  function restart() {
-    if (server) {
-      server.kill();
-      server.removeAllListeners();
-      console.log(chalk.green('Restarting due to changes'));
-    }
-    const args = config.server.cmd.split(' ');
-    const cmd = args.shift();
-    server = cp.spawn(cmd, args, { stdio: ['ignore', 'inherit', 'inherit'] });
-
-    server.on('exit', code => {
-      if (code) {
-        console.log(chalk.red('Server exited with non-zero exit code. Awaiting code changes.'));
-      }
-    });
-  }
-
-  function detectRestart(jobs, files) {
-    const restartingJobs = jobs.filter(job => config[job].restart !== false);
-    const restartingFiles = files.filter(file => config.server.extensions.indexOf(extname(file)) > -1);
-    return restartingJobs.length || restartingFiles.length;
-  }
-
-  function rebuild() {
-    let jobs = [];
-    toBuild.forEach(file => {
-      if (config.verbose) {
-        console.log(`${chalk.yellow('Changed')}: ${file}`);
-      }
-      jobs = jobs.concat(triggersTask(file));
-    });
-    jobs = uniq(jobs);
-
-    if (toBuild.indexOf('hof.settings.json') > -1) {
-      console.log(chalk.red('Build configuration modified. Manual restart required.'));
-      server.kill();
-      // eslint-disable-next-line no-process-exit
-      process.exit();
-    }
-
-    jobs.forEach(job => {
-      console.log(`Executing build task: ${chalk.green(job)}`);
-    });
-
-    const shouldRestart = detectRestart(jobs, toBuild);
-    toBuild = [];
-    return run(jobs.map(task => tasks[task]), config)
-      .then(() => {
-        if (shouldRestart) {
-          restart();
-        }
-      });
-  }
-
-  function stdin() {
-    process.stdin.resume();
-    process.stdin.setEncoding('utf8');
-    process.stdin.on('data', data => {
-      const dataType = (data + '').trim().toLowerCase();
-      if (dataType  === config.watch.restart) {
-        restart();
-      }
-    });
-  }
-
-  function watch() {
-    return new Promise(resolve => {
-      const ignored = [].concat(config.watch.ignore);
-      let watchLocation = '.';
-
-      if (!config.watchNodeModules) {
-        console.log('Ignoring node_modules directory. To watch node_modules run with --watch-node-modules flag');
-        ignored.push('node_modules');
-      }
-      if (!config.watchDotFiles) {
-        console.log('Ignoring dotfiles. To watch dotfiles run with --watch-dotfiles flag');
-        ignored.push(/(^|[\/\\])\../);
-      }
-
-      if (process.env.HOF_SANDBOX === 'true') {
-        const rootDir = require('path').resolve(__dirname, '../../../');
-        ignored.push(`${rootDir}/frontend/govuk-template/govuk_template_generated.html`);
-        watchLocation = [rootDir, '.'];
-      }
-
-      const watcher = chokidar.watch(watchLocation, { ignored });
-
-      watcher.on('ready', () => {
-        const watched = watcher.getWatched();
-        console.log(`Watching ${Object.keys(watched).length} files for changes`);
-
-        const throttledRebuild = throttle(rebuild, 1000);
-        watcher.on('all', (event, file) => {
-          toBuild.push(file);
-          throttledRebuild();
-        });
-        stdin();
-        resolve();
-      });
-    });
-  }
-
-  function loadenv() {
-    let envfile = '.env';
-    if (typeof config.env === 'string') {
-      envfile = config.env;
-    }
-    envfile = path.resolve(process.cwd(), envfile);
-    return env(envfile, !!config.env)
-      .then(dotenv => {
-        Object.keys(dotenv).forEach(key => {
-          if (process.env[key] && config.verbose) {
-            console.log(`  Overwriting environment variable ${key} with local value`);
-          }
-          process.env[key] = dotenv[key];
-        });
-      });
-  }
-
-  return build(config)
-    .then(() => watch())
-    .then(() => loadenv())
-    .then(() => restart());
-};

package/package/components/address-lookup/default-model.js

@@ -1,76 +0,0 @@
-'use strict';
-
-const _ = require('lodash');
-const Model = require('../../model');
-const defaults = require('./defaults');
-
-const IS_VALIDATING = 'IS_VALIDATING';
-
-module.exports = class PostcodesModel extends Model {
-  constructor(options) {
-    super(options);
-    this.options = _.merge({}, defaults.POSTCODE_API, options);
-  }
-
-  url() {
-    const validating = this.get(IS_VALIDATING);
-    const options = {
-      url: validating ?
-        `${this.options.hostname}/${this.options.paths.validate}/${this.get('postcode')}` :
-        `${this.options.hostname}/${this.options.paths.lookup}`
-    };
-    if (!validating) {
-      options.query = {
-        postcode: this.get('postcode')
-      };
-    }
-    return super.url(options);
-  }
-
-  requestConfig(options) {
-    return _.merge(super.requestConfig(options), {
-      timeout: 5000,
-      headers: {
-        Authorization: this.options.authorization
-      }
-    });
-  }
-
-  validate() {
-    // eslint-disable-next-line consistent-return
-    return new Promise((resolve, reject) => {
-      this.set(IS_VALIDATING, true);
-      let allowedCountries = this.options.validate && this.options.validate.allowedCountries;
-      if (!allowedCountries) {
-        return resolve();
-      }
-
-      const getError = () => {
-        const err = new Error('Validation Error');
-        err.status = 418;
-        err.type = 'country';
-        return err;
-      };
-
-      if (this.get('postcode').toUpperCase().startsWith('BT')) {
-        return reject(getError());
-      }
-
-      this.fetch()
-        .then(data => {
-          this.set(IS_VALIDATING, false);
-          if (data && data.country && data.country.name) {
-            allowedCountries = _.castArray(allowedCountries).map(c => c.toLowerCase());
-            if (allowedCountries.indexOf(data.country.name.toLowerCase()) === -1) {
-              return reject(getError());
-            }
-          }
-          return resolve();
-        })
-        .catch(err => {
-          this.set(IS_VALIDATING, false);
-          return reject(err);
-        });
-    });
-  }
-};

package/package/components/address-lookup/defaults.js

@@ -1,25 +0,0 @@
-/* eslint max-len: 0, no-process-env: 0 */
-
-'use strict';
-
-module.exports = {
-  CANT_FIND: 'I can\'t find the address in the list',
-  CHANGE: 'Change',
-  POSTCODE_LABEL: 'Postcode',
-  SELECT_LABEL: 'Select the address',
-  ADDRESS_LABEL: 'Address',
-  POSTCODE_ENTERED: 'Postcode you entered: ',
-  POSTCODE_ERROR: {
-    'not-found': 'Sorry – we couldn’t find any addresses for that postcode, enter your address manually',
-    'cant-connect': 'Sorry – we couldn’t connect to the postcode lookup service at this time, enter your address manually'
-  },
-  ENTER_MANUALLY: 'Enter address manually',
-  POSTCODE_API: {
-    hostname: 'https://postcodeinfo.service.justice.gov.uk',
-    authorization: process.env.POSTCODE_AUTH || '',
-    paths: {
-      lookup: 'addresses',
-      validate: 'postcodes'
-    }
-  }
-};

package/package/components/address-lookup/index.js

@@ -1,251 +0,0 @@
-/* eslint-disable func-names */
-'use strict';
-
-const path = require('path');
-const querystring = require('querystring');
-const _ = require('lodash');
-
-const DefaultModel = require('./default-model');
-const defaults = require('./defaults');
-
-const conditionalTranslate = (key, t) => {
-  let result = t(key);
-  if (result === key) {
-    result = null;
-  }
-  return result;
-};
-
-const getFields = (key, t, requiredValidate) => ({
-
-  [`${key}-postcode`]: {
-    label: conditionalTranslate(`fields.${key}-postcode.label`, t) || defaults.POSTCODE_LABEL,
-    mixin: 'input-text-code',
-    validate: requiredValidate ? ['required', 'postcode'] : ['postcode'],
-    formatter: 'uppercase'
-  },
-  [`${key}-select`]: {
-    label: conditionalTranslate(`fields.${key}-select.label`, t) || defaults.SELECT_LABEL,
-    mixin: 'select',
-    validate: [function required(val) {
-      return val !== '-1';
-    }]
-  },
-  [key]: {
-    label: conditionalTranslate(`fields.${key}.label`, t) || defaults.ADDRESS_LABEL,
-    mixin: 'textarea',
-    validate: 'required',
-    'ignore-defaults': true,
-    formatter: ['trim', 'hyphens'],
-    attributes: [{
-      attribute: 'rows',
-      value: 6
-    }]
-  }
-});
-
-const getConfig = key => ({
-  postcode: {
-    fields: [`${key}-postcode`],
-    template: 'postcode'
-  },
-  lookup: {
-    fields: [`${key}-select`],
-    template: 'address-lookup'
-  },
-  address: {
-    fields: [key],
-    template: 'address'
-  },
-  manual: {
-    fields: [key],
-    template: 'address'
-  }
-});
-
-module.exports = config => {
-  const addressKey = config.addressKey;
-  const required = config.required;
-  if (!addressKey) {
-    throw new Error('addressKey must be provided');
-  }
-
-  const Model = config.Model || DefaultModel;
-  const apiSettings = config.apiSettings || {};
-  const validate = config.validate;
-
-  return superclass => class extends superclass {
-    configure(req, res, callback) {
-      this.model = new Model(_.merge({}, apiSettings, { validate }));
-      req.query.step = req.query.step || 'postcode';
-      const subSteps = getConfig(addressKey);
-      const step = subSteps[req.query.step];
-      _.merge(req.form.options, {
-        subSteps,
-        addressKey,
-        fields: _.pick(getFields(addressKey, req.translate, required), step.fields),
-        apiError: null
-      });
-      if (step.template) {
-        req.form.options.template = path.resolve(__dirname, `./templates/${step.template}.html`);
-      }
-      super.configure(req, res, callback);
-    }
-
-    getNextStep(req, res, callback) {
-      const step = super.getNextStep(req, res, callback);
-
-      if (req.query.step === 'postcode' && req.form.values[`${addressKey}-postcode`]) {
-        const nextSubStep = req.sessionModel.get(`${addressKey}-addresses`) ? 'lookup' : 'address';
-        const qs = querystring.stringify(_.merge({}, req.query, {
-          step: nextSubStep
-        }));
-        return `?${qs}`;
-      }
-      return step;
-    }
-
-    getValues(req, res, callback) {
-      if (req.query.step === 'manual') {
-        req.sessionModel.unset([
-          `${addressKey}-postcodeApiMeta`
-        ]);
-      } else if (req.query.step === 'lookup') {
-        const addresses = req.sessionModel.get(`${addressKey}-addresses`);
-        const formattedlist = _.map(_.map(addresses, 'formatted_address'), ads => {
-          const address = ads.split('\n').join(', ');
-          return {
-            value: address,
-            label: address
-          };
-        });
-
-        const count = `${formattedlist.length} address${formattedlist.length > 1 ? 'es' : ''}`;
-        // eslint-disable-next-line max-len
-        req.form.options.fields[`${addressKey}-select`].options = [{value: '-1', label: count}].concat(formattedlist);
-      }
-      super.getValues(req, res, callback);
-    }
-
-    locals(req, res, callback) {
-      const isManual = req.query.step === 'manual';
-      const locals = super.locals(req, res, callback);
-      const postcode = req.sessionModel.get(`${addressKey}-postcode`);
-      const section = this.options.route.replace(/^\//, '');
-      const editLink = conditionalTranslate('pages.address-lookup.edit', req.translate) || defaults.CHANGE;
-      const cantFind = conditionalTranslate('pages.address-lookup.cantfind', req.translate) || defaults.CANT_FIND;
-
-      let postcodeApiMessageKey;
-      let postcodeError;
-
-      if (!isManual) {
-        postcodeApiMessageKey = (req.sessionModel.get(`${addressKey}-postcodeApiMeta`) || {}).messageKey;
-      }
-
-      if (postcodeApiMessageKey) {
-        const key = `pages.address-lookup.postcode-api.${postcodeApiMessageKey}`;
-        postcodeError = conditionalTranslate(key, req.translate) ||
-          defaults.POSTCODE_ERROR[postcodeApiMessageKey];
-      }
-
-      return _.merge({}, locals, {
-        postcodeEntered: conditionalTranslate('pages.address-lookup.postcode-entered', req.translate) ||
-          defaults.POSTCODE_ENTERED,
-        enterManually: conditionalTranslate('pages.address.lookup.enter-manually', req.translate) ||
-          defaults.ENTER_MANUALLY,
-        route: this.options.route,
-        editLink,
-        cantFind,
-        postcodeError,
-        postcode,
-        section
-      });
-    }
-
-    process(req, res, callback) {
-      if (req.query.step === 'postcode') {
-        const postcode = req.form.values[`${addressKey}-postcode`];
-        this.model.set({ postcode });
-      }
-      super.process(req, res, callback);
-    }
-
-    // eslint-disable-next-line consistent-return
-    lookupPostcode(req, res, callback) {
-      this.model.fetch()
-        .then(data => {
-          if (data.length) {
-            req.sessionModel.set(`${addressKey}-addresses`, data);
-          } else {
-            req.sessionModel.unset(`${addressKey}-addresses`);
-            req.sessionModel.set(`${addressKey}-postcodeApiMeta`, {
-              messageKey: 'not-found'
-            });
-          }
-          return callback();
-        })
-        .catch(err => {
-          req.sessionModel.set(`${addressKey}-postcodeApiMeta`, {
-            messageKey: 'cant-connect'
-          });
-          // eslint-disable-next-line no-console
-          console.error('Postcode lookup error: ',
-            `Code: ${err.status}; Detail: ${err.detail}`);
-          return callback();
-        });
-    }
-
-    saveValues(req, res, callback) {
-      const step = req.query.step;
-      if (step === 'postcode') {
-        return this.lookupPostcode(req, res, err => {
-          if (err) {
-            return callback(err);
-          }
-          return super.saveValues(req, res, callback);
-        });
-      } else if (step === 'lookup') {
-        const addressLines = req.form.values[`${addressKey}-select`].split(', ').join('\n');
-        req.sessionModel.set(addressKey, addressLines);
-      }
-      return super.saveValues(req, res, callback);
-    }
-
-    // eslint-disable-next-line consistent-return
-    validate(req, res, callback) {
-      if (req.query.step === 'postcode' && this.model.get('validate')) {
-        const key = `${addressKey}-postcode`;
-        const postcode = encodeURIComponent(req.form.values[key]);
-        this.model.validate(postcode)
-          .then(() => super.validate(req, res, callback))
-          .catch(e => {
-            let err = e;
-            // this code is set by the model for a validation error
-            if (err.status === 418) {
-              err = {
-                [key]: new this.ValidationError(key, {
-                  key,
-                  type: err.type,
-                  redirect: undefined
-                }, req, res)
-              };
-            // cannot connect to validation service, skip api validation
-            } else if (err.status === 403 || err.status === 404) {
-              return super.validate(req, res, callback);
-            }
-            return callback(err);
-          });
-      } else {
-        return super.validate(req, res, callback);
-      }
-    }
-
-    getBackLink(req, res) {
-      let backLink = super.getBackLink(req, res);
-      if (_.includes(['manual', 'address', 'lookup'], req.query.step)) {
-        backLink = req.path;
-      }
-      return backLink;
-    }
-  };
-};

package/package/components/address-lookup/templates/address-lookup.html

@@ -1,14 +0,0 @@
-{{<partials-page}}
-  {{$page-content}}
-    <p>
-      <label>{{postcodeEntered}}</label>
-      <strong><span class="postcode">{{postcode}}</span></strong>
-      <strong><span class="link"><a class="change-postcode" href="{{#qs}}step=postcode{{/qs}}">{{editLink}}</a></span></strong>
-    </p>
-    {{#fields}}
-      {{#renderField}}{{/renderField}}
-    {{/fields}}
-    <p><span class="link"><a class="cant-find" href="{{#qs}}step=manual{{/qs}}">{{cantFind}}</a></span></p>
-    {{#input-submit}}continue{{/input-submit}}
-  {{/page-content}}
-{{/partials-page}}

package/package/components/address-lookup/templates/address.html

@@ -1,22 +0,0 @@
-{{<partials-page}}
-  {{$page-content}}
-    {{#postcode}}
-      <p>
-        <label>{{postcodeEntered}}</label>
-        <strong><span class="postcode">{{postcode}}</span></strong>
-        <strong><span class="link"><a class="change-postcode" href="{{#qs}}step=postcode{{/qs}}">{{editLink}}</a></span></strong>
-      </p>
-    {{/postcode}}
-    {{#postcodeError}}
-      <div class="alert-info">
-        <span class="info-message">
-          {{postcodeError}}
-        </span>
-      </div>
-    {{/postcodeError}}
-    {{#fields}}
-      {{#renderField}}{{/renderField}}
-    {{/fields}}
-    {{#input-submit}}continue{{/input-submit}}
-  {{/page-content}}
-{{/partials-page}}

package/package/components/address-lookup/templates/postcode.html

@@ -1,9 +0,0 @@
-{{<partials-page}}
-  {{$page-content}}
-    {{#fields}}
-      {{#renderField}}{{/renderField}}
-    {{/fields}}
-    <p><span class="link"><a href="{{#qs}}step=manual{{/qs}}">{{enterManually}}</a></span></p>
-    {{#input-submit}}find-address{{/input-submit}}
-  {{/page-content}}
-{{/partials-page}}

package/package/components/clear-session/Readme.md

@@ -1,46 +0,0 @@
-# Clear Session Behaviour
-
-## What this does
-Resets the HOF session model `req.sessionModel.reset()` and clears anything stored by Redis when a user has submitted their information. This behaviour can be used on the final/penultimate step in a flow to ensure proper session clearing.
-
-Clear session happens automatically for the step that uses it if it has no next step. However, if it does, then set the following on the step:
-```
-'/confirm': {
-  behaviour: require('hof').components.clearSession,
-  clearSession: true,
-  next: '/confirmation'
-}
-```
-However if you want to prevent clear session where there is no next step then set 'clearSession' to false:
-```
-'/confirm': {
-  behaviour: require('hof').components.clearSession,
-  clearSession: false
-}
-```
-
-## Additional information
-
-In your fields file the clear session behaviour can be brought in like this.
-
-```
-'/confirm': {
-  behaviour: require('hof').components.clearSession
-}
-```
-On your server.js file if you set res.locals to have a confirm step set:
-```
-app.use((req, res, next) => {
-  res.locals.confirmStep = '/confirm';
-  next();
-});
-```
-Then the confirm behaviour will also ensure to reset options on your confirm step for 'uploadPdfShared' and 'submitted' back to false if using these options to keep track of the generation and submission of pdf files. The default configuration for your confirm step might looks like this:
-```
-'/confirm': {
-  behaviour: [SubmitPDFBehaviour, require('hof').components.clearSession],
-  uploadPdfShared: false,
-  submitted: false
-}
-```
-where a SubmitPDFBehaviour is run first which updates the 'uploadPdfShared' and 'submitted' options on the confirm step to true. This clear session behaviour will ensure those are reset along with clearing the session model.

package/package/components/clear-session/index.js

@@ -1,26 +0,0 @@
-
-const _ = require('lodash');
-
-module.exports = superclass => class extends superclass {
-  getValues(req, res, callback) {
-    return super.getValues(req, res, (err, values) => {
-      if (err) {
-        return callback(err, values);
-      }
-
-      const confirmStep = res.locals.confirmStep;
-
-      if (req.path !== confirmStep && _.get(this, `options.steps[${confirmStep}]`)) {
-        this.options.steps[confirmStep].uploadPdfShared = false;
-        this.options.steps[confirmStep].submitted = false;
-      }
-      const noNext = _.isUndefined(this.options.next);
-      const clearSession = this.options.clearSession;
-      // clear the session if there's no next step or we request to clear the session
-      if ((noNext && clearSession !== false) || clearSession === true) {
-        req.sessionModel.reset();
-      }
-      return callback(null, values);
-    });
-  }
-};

package/package/components/combine-and-loop-fields/Readme.md

@@ -1,42 +0,0 @@
-# Combine & Loop Fields Behaviour
-
-## What this does
-This allows you to specify fields to loop over and add as objects to a parent array. You can use this for adding multiple addresses, criminal offences, names etc. You can see here in this example, we ask for a set of details prefixed with the word `storage-` for getting address details for multiple storage addresses (see the Home Office's firearms repository). We then can aggregate these addresses as objects into an array called `all-storage-addresses` and get redirected back to `/add-address` whenever we selected `yes` to adding another address,
-```
-'/add-address': {
-  fields: [
-    'storage-building',
-    'storage-street',
-    'storage-townOrCity',
-    'storage-postcodeOrZIPCode'
-  ],
-  next: '/add-another-address-with-list',
-  continueOnEdit: true
-},
-'/add-another-address-with-list': {
-  template: 'add-another-address-loop.html',
-  behaviours: CombineAndLoopFields({
-    groupName: 'all-storage-addresses',
-    fieldsToGroup: [
-      'storage-building',
-      'storage-street',
-      'storage-townOrCity',
-      'storage-postcodeOrZIPCode'
-    ],
-    removePrefix: 'storage-',
-    combineValuesToSingleField: 'address',
-    groupOptional: true,
-    returnTo: '/add-address'
-  }),
-  next: '/confirm'
-```
-Here are the fields you call this behaviour first to set config for it:
-```
-`groupName`: (Required) a parent array for storing details for each object you are collecting information for,
-`fieldsToGroup`: (Required) the fields being specified for an object, e.g. house number, street, postcode, that are grouped together,
-`removePrefix`: (Optional) a string which is used to remove consistent prefixes from a collection of fields that are grouped together,
-`combineValuesToSingleField`: (Optional) a new field that is created with its value being the concatenation of values of the fields specified in `fieldsToGroup`,
-`groupOptional`: (Optional) set this to true if you want to land on the radio button question if all records in the group are deleted after creation,
-`returnTo`: (Required) the next step if you want to add another object to this group
-```
-N.B. in the above example we use `continueOnEdit: true` on the individual record step (i.e. `/add-address`) to ensure we revisit the grouped fields page otherwise it will not be added to the group and the user will be returned to the 'Check Your Answers' page upon a field edit.