hof 20.0.4 → 20.1.0

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

@@ -0,0 +1,39 @@
+# 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',
+    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`,
+`returnTo`: the next step if you want to add another object to this group
+```

package/components/combine-and-loop-fields/combine-and-loop-fields.js

@@ -0,0 +1,153 @@
+
+const _ = require('lodash');
+const uuid = require('uuid').v1;
+const path = require('path');
+const express = require('express');
+
+module.exports = config => {
+  const { returnTo, groupName, fieldsToGroup, combineValuesToSingleField, removePrefix } = config;
+
+  if (removePrefix && typeof removePrefix !== 'string') {
+    throw new Error('removePrefix is a string and is optional for loops');
+  }
+
+  if (combineValuesToSingleField && typeof combineValuesToSingleField !== 'string') {
+    throw new Error('combineValuesToSingleField is a string and is optional for loops');
+  }
+
+  if (!returnTo || typeof returnTo !== 'string') {
+    throw new Error('returnTo is a string and is required for loops');
+  }
+
+  if (!groupName || typeof groupName !== 'string') {
+    throw new Error('groupName is a string and is required for loops');
+  }
+
+  if (!fieldsToGroup ||
+    !fieldsToGroup.length ||
+    !Array.isArray(fieldsToGroup) ||
+    _.some(fieldsToGroup, field => typeof field !== 'string')) {
+    throw new Error('fieldsToGroup is an array of strings and is required for loops');
+  }
+
+  return superclass => class extends superclass {
+    get(req, res, next) {
+      if (req.query.delete) {
+        const router = express.Router({ mergeParams: true });
+        router.use([
+          // eslint-disable-next-line no-underscore-dangle
+          this._configure.bind(this),
+          this.removeItem.bind(this),
+          this.reload.bind(this)
+        ]);
+        return router.handle(req, res, next);
+      }
+      return super.get(req, res, next);
+    }
+
+    getLoopFields(req) {
+      let loopedFields = _.pick(req.sessionModel.toJSON(), fieldsToGroup);
+
+      if (removePrefix) {
+        loopedFields = _.mapKeys(loopedFields, (value, key) => key.replace(removePrefix, ''));
+      }
+      return loopedFields;
+    }
+
+    removeItem(req, res, next) {
+      const id = req.query.delete;
+      const items = req.sessionModel.get(groupName).filter(item => item.id !== id);
+      req.sessionModel.set(groupName, items);
+      next();
+    }
+
+    // eslint-disable-next-line no-unused-vars
+    reload(req, res, next) {
+      const items = req.sessionModel.get(groupName);
+      if (!items.length) {
+        req.sessionModel.set(`${groupName}-saved`, false);
+        fieldsToGroup.forEach(field => {
+          req.sessionModel.unset(field);
+        });
+      }
+
+      const target = items.length ? req.form.options.route : returnTo;
+      const action = req.params.action || '';
+      res.redirect(path.join(req.baseUrl, target, action));
+    }
+
+    configure(req, res, next) {
+      const field = `${groupName}-add-another`;
+      // add yes/no field
+      req.form.options.fields[field] = Object.assign({
+        mixin: 'radio-group',
+        validate: ['required'],
+        options: [
+          'yes', 'no'
+        ]
+      }, req.form.options.fieldSettings);
+
+      // add conditonal fork
+      req.form.options.forks = req.form.options.forks || [];
+      req.form.options.forks.push({
+        target: returnTo,
+        continueOnEdit: true,
+        condition: {
+          field: field,
+          value: 'yes'
+        }
+      });
+      next();
+    }
+
+    getValues(req, res, next) {
+      const fieldsGroup = req.sessionModel.get(groupName) || [];
+      const added = req.sessionModel.get(`${groupName}-saved`);
+      return super.getValues(req, res, (err, values) => {
+        if (err) {
+          return next(err);
+        }
+        if (!added) {
+          const fields = this.getLoopFields(req);
+          if (!_.isEmpty(fields)) {
+            const newField = Object.assign({id: uuid()}, fields);
+
+            if (combineValuesToSingleField) {
+              const combinedValues = _.filter(fieldsToGroup.map(field => req.sessionModel.get(field))).join(', ');
+              newField[combineValuesToSingleField] = combinedValues;
+            }
+
+            fieldsGroup.push(newField);
+            values[groupName] = fieldsGroup;
+            fieldsToGroup.forEach(field => req.sessionModel.unset(field));
+
+            req.sessionModel.set(groupName, fieldsGroup);
+            req.sessionModel.set(`${groupName}-saved`, true);
+          }
+        }
+        return next(null, values);
+      });
+    }
+
+    locals(req, res) {
+      const items = req.form.values[groupName] || [];
+      return Object.assign({}, super.locals(req, res), {
+        items,
+        hasItems: items.length > 0,
+        field: groupName
+      });
+    }
+
+    saveValues(req, res, next) {
+      // remove "yes" value from session so it is no pre-populated next time around
+      super.saveValues(req, res, err => {
+        const field = `${groupName}-add-another`;
+        if (req.form.values[field] === 'yes') {
+          req.sessionModel.unset(field);
+          req.sessionModel.set(`${groupName}-saved`, false);
+        }
+        next(err);
+      });
+    }
+  };
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hof",
   "description": "A bootstrap for HOF projects",
-  "version": "20.0.4",
+  "version": "20.1.0",
   "license": "MIT",
   "main": "index.js",
   "author": "HomeOffice",