hof 20.0.0-beta.15 → 20.0.0-beta.18

package/components/index.js

@@ -5,5 +5,6 @@ module.exports = {
   clearSession: require('./clear-session'),
   date: require('./date'),
   emailer: require('./emailer'),
-  summary: require('./summary')
+  summary: require('./summary'),
+  notify: require('./notify')
 };

package/components/notify/index.js

@@ -0,0 +1,60 @@
+'use strict';
+
+const Notify = require('./notify');
+const Hogan = require('hogan.js');
+const fs = require('fs');
+
+module.exports = config => {
+  const notify = new Notify(config);
+  config.parse = config.parse || (data => data);
+
+  if (!config.recipient) {
+    throw new Error('Email recipient must be defined');
+  }
+  if (typeof config.template !== 'string') {
+    throw new Error('Email template must be defined');
+  }
+
+  return superclass => class NotifyBehaviour extends superclass {
+    successHandler(req, res, next) {
+      Promise.resolve()
+        .then(() => {
+          return new Promise((resolve, reject) => {
+            fs.readFile(config.template, (err, template) => err ? reject(err) : resolve(template.toString('utf8')));
+          });
+        })
+        .then(template => {
+          const data = config.parse(req.sessionModel.toJSON(), req.translate);
+          return Hogan.compile(template).render(data);
+        })
+        .then(body => {
+          const settings = { body };
+
+          if (typeof config.recipient === 'function') {
+            settings.recipient = config.recipient(req.sessionModel.toJSON());
+          } else {
+            settings.recipient = req.sessionModel.get(config.recipient) || config.recipient;
+          }
+          if (typeof settings.recipient !== 'string' || !settings.recipient.includes('@')) {
+            throw new Error('hof-behaviour-emailer: invalid recipient');
+          }
+
+          if (typeof config.subject === 'function') {
+            settings.subject = config.subject(req.sessionModel.toJSON(), req.translate);
+          } else {
+            settings.subject = config.subject;
+          }
+
+          return settings;
+        })
+        .then(settings => {
+          return notify.send(settings);
+        })
+        .then(() => {
+          super.successHandler(req, res, next);
+        }, next);
+    }
+  };
+};
+
+module.exports.Notify = Notify;

package/components/notify/notify.js

@@ -0,0 +1,25 @@
+'use strict';
+const NotifyClient = require('notifications-node-client').NotifyClient;
+const uuid = require('uuid');
+
+module.exports = class Notify {
+  constructor(opts) {
+    const options = opts || {};
+    this.options = options;
+    this.notifyClient =  new NotifyClient(options.notifyApiKey);
+    this.notifyTemplate = options.notifyTemplate;
+  }
+
+  send(email) {
+    const reference = uuid.v1();
+
+    return this.notifyClient.sendEmail(this.notifyTemplate, email.recipient, {
+      personalisation: {
+        'email-subject': email.subject,
+        'email-body': email.body
+      },
+      reference });
+  }
+};
+
+module.exports.NotifyClient = NotifyClient;

package/frontend/template-mixins/partials/forms/input-text-group.html

@@ -1,5 +1,5 @@
 <div id="{{id}}-group" class="{{#compound}} form-group-compound{{/compound}}{{#formGroupClassName}}{{formGroupClassName}}{{/formGroupClassName}}{{#error}} govuk-form-group--error{{/error}}">
-    {{#isPageHeading}}<h1 class="govuk-label-wrapper">{{/isPageHeading}}<label for="{{id}}" class="{{labelClassName}}">
+    {{#isPageHeading}}<h1 class="govuk-label-wrapper">{{/isPageHeading}}<label for="{{id}}" class="{{labelClassName}}{{#isPageHeading}}govuk-label--l{{/isPageHeading}}">
         {{{label}}}
       </label>
     {{#isPageHeading}}</h1>{{/isPageHeading}}

package/frontend/template-mixins/partials/forms/textarea-group.html

@@ -2,7 +2,7 @@
 <div class="govuk-character-count" data-module="govuk-character-count" data-maxlength="{{maxlength}}">
 {{/maxlength}}
 <div id="{{id}}-group" class="{{#compound}}form-group-compound {{/compound}}{{#formGroupClassName}}{{formGroupClassName}}{{/formGroupClassName}}{{#error}} govuk-form-group--error{{/error}}">
-    {{#isPageHeading}}<h1 class="govuk-label-wrapper">{{/isPageHeading}}<label for="{{id}}" class="{{labelClassName}}">
+    {{#isPageHeading}}<h1 class="govuk-label-wrapper">{{/isPageHeading}}<label for="{{id}}" class="{{labelClassName}}{{#isPageHeading}}govuk-label--l{{/isPageHeading}}">
         {{{label}}}
         {{#error}} 
         <p id="{{id}}-error" class="govuk-error-message">

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hof",
   "description": "A bootstrap for HOF projects",
-  "version": "20.0.0-beta.15",
+  "version": "20.0.0-beta.18",
   "license": "MIT",
   "main": "index.js",
   "author": "HomeOffice",
@@ -79,6 +79,7 @@
     "nodemailer-ses-transport": "^1.5.0",
     "nodemailer-smtp-transport": "^2.7.4",
     "nodemailer-stub-transport": "^1.1.0",
+    "notifications-node-client": "^5.1.1",
     "redis": "^3.1.2",
     "reqres": "^3.0.1",
     "request": "^2.79.0",

package/sandbox/apps/sandbox/translations/en/default.json

@@ -0,0 +1,224 @@
+{
+  "fields": {
+    "landing-page-radio": {
+      "legend": "Which form would you like to explore?",
+      "options": {
+        "basic-form": {
+          "label": "Basic form"
+        },
+        "complex-form": {
+          "label": "Complex form"
+        },
+        "build-your-own-form": {
+          "label": "Build your own form"
+        }
+      }
+    },
+    "name": {
+      "label": "Full name"
+    },
+    "dateOfBirth": {
+      "legend": "Date of birth",
+      "hint": "For example, 31 10 1990"
+    },
+    "building": {
+      "label": "Building and street"
+    },
+    "street": {
+      "label": "Address line 2"
+    },
+    "townOrCity": {
+      "label": "Town or city"
+    },
+    "postcode": {
+      "label": "Postcode"
+    },
+    "incomeTypes": {
+      "label": "Sources of income",
+      "legend": "Select the options where you receive income from",
+      "hint": "Select all options that apply to you.",
+      "options": {
+        "salary": {
+          "label": "Salary"
+        },
+        "universal_credit": {
+          "label": "Universal Credit"
+        },
+        "child_benefit": {
+          "label": "Child Benefit"
+        },
+        "housing_benefit": {
+          "label": "Housing Benefit"
+        },
+        "other": {
+          "label": "Other"
+        }
+      }
+    },
+    "countryOfHearing": {
+      "label": "Country of hearing",
+      "options": {
+        "englandAndWales": {
+          "label": "England and Wales"
+        },
+        "scotland": {
+          "label": "Scotland"
+        },
+        "northernIreland": {
+          "label": "Northern Ireland"
+        }
+      }
+    },
+    "email": {
+      "label": "Email address"
+    },
+    "phone": {
+      "label": "Phone number",
+      "hint": "International phone numbers require the international dialling code, for example +33235066182"
+    },
+    "int-phone-number": {
+      "legend": "International phone number"
+    },
+    "complaintDetails": {
+      "label": "Complaint details"
+    },
+    "countrySelect": {
+      "label": "Select a country",
+      "hint": "Start to type the country name and options will appear"
+    },
+    "appealStages": {
+      "label": "Appeal stage",
+      "options": {
+        "null": "Select..."
+      }
+    }
+  },
+  "journey": {
+    "header": "HOF Bootstrap Sandbox Form"
+  },
+  "pages": {
+    "landing-page": {
+      "header": "Landing page",
+      "intro": "Choose one of the options below and press continue."
+    },
+    "build-your-own-form": {
+      "title": "Build your own form",
+      "subheader": "Access the build your own form guidance link"
+    },
+    "name": {
+      "header": "What is your full name?"
+    },
+    "dob": {
+      "header": "What is your date of birth?"
+    },
+    "address": {
+      "header": "What is your address in the UK?",
+      "intro": "If you have no fixed address, enter an address where we can contact you."
+    },
+    "checkboxes": {
+      "header": "Where does your money come from each month?"
+    },
+    "radio": {
+      "header": "What country was the appeal lodged?"
+    },
+    "country-select": {
+      "header": "What country is your address located?"
+    },
+    "email": {
+      "header": "Enter your email address"
+    },
+    "phone-number": {
+      "header": "Enter your phone number"
+    },
+    "text-input-area": {
+      "header": "What are the details of your complaint?",
+      "intro": "Briefly summarise your complaint. Include anything that can help our investigation."
+    },
+    "select": {
+      "header": "What is the appeal stage?",
+      "intro": "Choose an appeal stage from the drop down menu"
+    },
+    "confirm": {
+      "header": "Check your answers before submitting your application.",
+      "sections": {
+        "applicantsDetails": {
+          "header": "Applicant's details"
+        },
+        "address": {
+          "header": "Address"
+        },
+        "income": {
+          "header": "Income"
+        },
+        "appealDetails": {
+          "header": "Appeal details"
+        },
+        "countrySelect": {
+          "header": "Country of residence"
+        },
+        "contactDetails": {
+          "header": "Contact details"
+        },
+        "complaintDetails": {
+          "header": "Complaint details"
+        }
+      }
+    },
+    "confirmation": {
+      "title": "Application sent",
+      "alert": "Application sent",
+      "subheader": "What happens next",
+      "content": "We’ll contact you with the decision of your application or if we need more information from you."
+    }
+  },
+  "validation": {
+    "landing-page-radio": {
+      "required": "Select an option below and press continue"
+    },
+    "name": {
+      "default": "Enter your full name"
+    },
+    "dateOfBirth": {
+      "default": "Enter your date of birth in the correct format; for example, 31 10 1990",
+      "after": "Enter a date after 1 1 1900",
+      "before": "Enter a date that is in the past"
+    },
+    "building": {
+      "default": "Enter details of your building and street"
+    },
+    "townOrCity": {
+      "default": "Enter a town or city",
+      "regex": "Enter a town or city without including digits"
+    },
+    "postcode": {
+      "default": "Enter your postcode"
+    },
+    "incomeTypes": {
+      "default": "Select all options that apply to you."
+    },
+    "countryOfHearing": {
+      "default": "Select where the appeal hearing is to be held"
+    },
+    "countrySelect": {
+      "default": "Enter a valid country of residence",
+      "required": "Enter your country of residence"
+    },
+    "email": {
+      "default": "Enter your email address in the correct format"
+    },
+    "phone": {
+      "default": "Enter your phone number"
+    },
+    "int-phone-number": {
+      "required": "Enter an international phone number",
+      "internationalPhoneNumber": "Enter a valid international phone number"
+    },
+    "complaintDetails": {
+      "default": "Enter details about why you are making a complaint",
+      "maxlength": "Keep to the 5000 character limit"
+    },
+    "appealStages": {
+      "required": "Select an appeal stage from the list"
+    }
+  }
+}