hof 19.14.2 → 20.0.0-beta.2

package/index.js

@@ -120,7 +120,8 @@ const getContentSecurityPolicy = (config, res) => {
  * @param options.getTerms {boolean} Optional boolean - whether to mount the /terms endpoint
  * @param options.getCookies {boolean} Optional boolean - whether to mount the /cookies endpoint
  * @param options.noCache {boolean} Optional boolean - whether to disable caching
- *
+ * @param options.getAccessibilityStatement {boolean} Optional boolean - whether to mount the /accessibility-statement endpoint
+ * 
  * @returns {object} A new HOF application using the configuration supplied in options
  */
 function bootstrap(options) {
@@ -204,10 +205,9 @@ function bootstrap(options) {
   }));
   app.use(mixins());
   app.use(markdown(config.markdown));
-  // rate limits have to be loaded before all routes so it is applied to them
-  if (config.rateLimits.requests.active) {
-    app.use(hofMiddleware.rateLimiter(config, 'requests'));
-  }
+  
+  // Set up routing so <YOUR-SITE-URL>/assets are served from /node_modules/govuk-frontend/govuk/assets
+  app.use('/assets', express.static(path.join(__dirname, '/node_modules/govuk-frontend/govuk/assets')))
 
   if (config.getAccessibility === true) {
     deprecate(

package/lib/router.js

@@ -19,8 +19,7 @@ function getWizardConfig(config) {
   const wizardConfig = {
     name: config.route.name || (config.route.baseUrl || '').replace('/', ''),
     protocol: config.protocol,
-    env: config.env,
-    sanitiseInputs: config.sanitiseInputs
+    env: config.env
   };
 
   if (config.appConfig) {

package/lib/settings.js

@@ -7,7 +7,21 @@ const hoganExpressStrict = require('hogan-express-strict');
 const expressPartialTemplates = require('express-partial-templates');
 const bodyParser = require('body-parser');
 
-module.exports = (app, config) => {
+const filterEmptyViews = (views) => {
+  return views.filter(view => dirExists(view))
+}
+
+const dirExists = (dir) => {
+  try {
+    if (fs.existsSync(dir)) {
+      return true;
+    }
+  } catch(err) {
+    throw new Error(`${err}: Cannot check if the directory path exists`)
+  }
+}
+
+module.exports = async (app, config) => {
   const viewEngine = config.viewEngine || 'html';
 
   app.use((req, res, next) => {
@@ -17,7 +31,8 @@ module.exports = (app, config) => {
 
   app.use(config.theme());
 
-  const viewPaths = [].concat(config.theme.views);
+  const filteredViews = filterEmptyViews(config.theme.views)
+  const viewPaths = [].concat(filteredViews);
   app.set('view engine', viewEngine);
   app.enable('view cache');
 

package/middleware/errors.js

@@ -1,8 +1,6 @@
 /* eslint-disable no-unused-vars */
 'use strict';
 
-const rateLimitsConfig = require('../config/rate-limits');
-
 const errorTitle = code => `${code}_ERROR`;
 const errorMsg = code => `There is a ${code}_ERROR`;
 // eslint-disable-next-line complexity
@@ -23,36 +21,6 @@ const getContent = (err, translate) => {
     content.message = (translate && translate('errors.cookies-required.message'));
   }
 
-  if (err.code === 'DDOS_RATE_LIMIT') {
-    err.status = 429;
-    err.template = 'rate-limit-error';
-    err.title = (translate && translate('errors.ddos-rate-limit.title'));
-    err.message = (translate && translate('errors.ddos-rate-limit.message'));
-    err.preTimeToWait = (translate && translate('errors.ddos-rate-limit.pre-time-to-wait'));
-    err.timeToWait = rateLimitsConfig.rateLimits.requests.windowSizeInMinutes;
-    err.postTimeToWait = (translate && translate('errors.ddos-rate-limit.post-time-to-wait'));
-    content.title = (translate && translate('errors.ddos-rate-limit.title'));
-    content.message = (translate && translate('errors.ddos-rate-limit.message'));
-    content.preTimeToWait = (translate && translate('errors.ddos-rate-limit.pre-time-to-wait'));
-    content.timeToWait = rateLimitsConfig.rateLimits.requests.windowSizeInMinutes;
-    content.postTimeToWait = (translate && translate('errors.ddos-rate-limit.post-time-to-wait'));
-  }
-
-  if (err.code === 'SUBMISSION_RATE_LIMIT') {
-    err.status = 429;
-    err.template = 'rate-limit-error';
-    err.title = (translate && translate('errors.submission-rate-limit.title'));
-    err.message = (translate && translate('errors.submission-rate-limit.message'));
-    err.preTimeToWait = (translate && translate('errors.submission-rate-limit.pre-time-to-wait'));
-    err.timeToWait = rateLimitsConfig.rateLimits.submissions.windowSizeInMinutes;
-    err.postTimeToWait = (translate && translate('errors.submission-rate-limit.post-time-to-wait'));
-    content.title = (translate && translate('errors.submission-rate-limit.title'));
-    content.message = (translate && translate('errors.submission-rate-limit.message'));
-    content.preTimeToWait = (translate && translate('errors.submission-rate-limit.pre-time-to-wait'));
-    content.timeToWait = rateLimitsConfig.rateLimits.submissions.windowSizeInMinutes;
-    content.postTimeToWait = (translate && translate('errors.submission-rate-limit.post-time-to-wait'));
-  }
-
   err.code = err.code || 'UNKNOWN';
   err.status = err.status || 500;
 

package/middleware/index.js

@@ -4,6 +4,5 @@ module.exports = {
   cookies: require('./cookies'),
   errors: require('./errors'),
   notFound: require('./not-found'),
-  deepTranslate: require('./deep-translate'),
-  rateLimiter: require('./rate-limiter')
+  deepTranslate: require('./deep-translate')
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hof",
   "description": "A bootstrap for HOF projects",
-  "version": "19.14.2",
+  "version": "20.0.0-beta.2",
   "license": "MIT",
   "main": "index.js",
   "author": "HomeOffice",
@@ -23,7 +23,7 @@
   "scripts": {
     "test": "yarn run unit && yarn run test:cookie-banner && yarn run test:functional && yarn run test:client && yarn run test:lint",
     "unit": "LOG_LEVEL=error nyc _mocha \"test/**/*.spec.js\" \"sandbox/test/**/*.spec.js\"",
-    "unit:nocov": "LOG_LEVEL=error mocha",
+    "unit:nocov": "LOG_LEVEL=error mocha \"test/**/*.spec.js\" \"sandbox/test/**/*.spec.js\"",
     "test:lint": "eslint . --config ./node_modules/eslint-config-hof/default.js",
     "test:functional": "funkie mocha ./test/functional-tests --exit",
     "test:client": "karma start test/frontend/toolkit/karma.conf.js",
@@ -57,6 +57,7 @@
     "findup": "^0.1.5",
     "glob": "^7.2.0",
     "govuk-elements-sass": "^3.1.3",
+    "govuk-frontend": "3.14",
     "govuk_template_mustache": "^0.26.0",
     "helmet": "^3.22.0",
     "hogan-express-strict": "^0.5.4",
@@ -69,10 +70,10 @@
     "lodash": "^4.17.21",
     "markdown-it": "^12.3.2",
     "minimatch": "^3.0.3",
-    "minimist": "^1.2.6",
+    "minimist": "^1.2.0",
     "mixwith": "^0.1.1",
     "mkdirp": "^0.5.1",
-    "moment": "^2.29.2",
+    "moment": "^2.24.0",
     "morgan": "^1.10.0",
     "mustache": "^2.3.0",
     "nodemailer": "^6.6.3",
@@ -87,8 +88,8 @@
     "serve-static": "^1.14.1",
     "uglify-js": "^3.14.3",
     "underscore": "^1.12.1",
-    "urijs": "^1.19.11",
-    "winston": "^3.7.2"
+    "urijs": "^1.19.10",
+    "winston": "^3.3.3"
   },
   "devDependencies": {
     "@cucumber/cucumber": "^7.3.0",

package/sandbox/.env

@@ -0,0 +1 @@
+// GA_TAG=UA-215558609-1

package/sandbox/apps/sandbox/fields.js

@@ -8,35 +8,49 @@ module.exports = {
   'landing-page-radio': {
     mixin: 'radio-group',
     validate: ['required'],
-    legend: {
-      className: 'visuallyhidden'
-    },
+    noHeading: true,
+    // Design system says to avoid in-line unless it's two options,
+    // so just added as an example below but by default it isn't
+    className: ['govuk-radios--inline'],
     options: ['basic-form', 'complex-form', 'build-your-own-form']
   },
   name: {
     validate: ['required', 'notUrl', { type: 'maxlength', arguments: 200 }],
+    labelClassName: ['govuk-label--l'],
+    // noHeading: 'true'
   },
-  dateOfBirth: dateComponent('dateOfBirth', {
-    validate: ['required', 'before', { type: 'after', arguments: ['1900'] }]
+  'dateOfBirth': dateComponent('dateOfBirth', {
+    // noHeading: 'true',
+    controlType: 'date-input',
+    validate: [
+      'required',
+      'date',
+      { type: 'after', arguments: ['1900'] }
+    ]
   }),
   building: {
+    noHeading: 'true',
     validate: ['required', 'notUrl', { type: 'maxlength', arguments: 100 }]
   },
   street: {
+    noHeading: 'true',
     validate: ['notUrl', { type: 'maxlength', arguments: 50 }],
     labelClassName: 'visuallyhidden'
   },
   townOrCity: {
+    noHeading: 'true',
     validate: ['required', 'notUrl',
       { type: 'regex', arguments: /^([^0-9]*)$/ },
       { type: 'maxlength', arguments: 100 }
     ]
   },
   postcode: {
+    noHeading: 'true',
     validate: ['required', 'postcode'],
     formatter: ['removespaces', 'uppercase']
   },
   incomeTypes: {
+    // noHeading: 'true',
     mixin: 'checkbox-group',
     labelClassName: 'visuallyhidden',
     validate: ['required'],
@@ -49,11 +63,9 @@ module.exports = {
     ]
   },
   countryOfHearing: {
+    // noHeading: 'true',
     mixin: 'radio-group',
     validate: ['required'],
-    legend: {
-      className: 'visuallyhidden'
-    },
     options: [
       'englandAndWales',
       'scotland',
@@ -61,6 +73,8 @@ module.exports = {
     ]
   },
   email: {
+    // noHeading: 'true',
+    labelClassName: ['govuk-label--l'],
     validate: ['required', 'email']
   },
   phone: {
@@ -81,14 +95,14 @@ module.exports = {
   },
   complaintDetails: {
     mixin: 'textarea',
-    labelClassName: 'visuallyhidden',
     // we want to ignore default formatters as we want
     // to preserve white space
     'ignore-defaults': true,
     // apply the other default formatters
     formatter: ['trim', 'hyphens'],
+    labelClassName: ['govuk-label--l'],
     // attributes here are passed to the field element
-    validate: ['required', { type: 'maxlength', arguments: 5000 }],
+    validate: ['required', { type: 'maxlength', arguments: 100 }],
     attributes: [{
       attribute: 'rows',
       value: 8
@@ -96,7 +110,6 @@ module.exports = {
   },
   appealStages: {
     mixin: 'select',
-    labelClassName: 'visuallyhidden',
     validate: ['required'],
     options: [{
       value: '',

package/sandbox/apps/sandbox/index.js

@@ -30,7 +30,11 @@ module.exports = {
     },
     '/dob': {
       fields: ['dateOfBirth'],
-      next: '/address'
+      next: '/address',
+      locals: {
+        step: 'dob',
+        labelClassName: 'govuk-input'
+      }
     },
     '/address': {
       fields: ['building', 'street', 'townOrCity', 'postcode'],

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

@@ -0,0 +1,203 @@
+{
+  "fields": {
+    "landing-page-radio": {
+      "legend": "Which form would you like to explore?",
+      "hint": "Choose one of the options below and press continue.",
+      "options": {
+        "basic-form": {
+          "label": "Basic form"
+        },
+        "complex-form": {
+          "label": "Complex form"
+        },
+        "build-your-own-form": {
+          "label": "Build your own form"
+        }
+      }
+    },
+    "name": {
+      "label": "What is your full name?"
+    },
+    "dateOfBirth": {
+      "legend": "What is your 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": {
+      "legend": "What country was the appeal lodged?",
+      "options": {
+        "englandAndWales": {
+          "label": "England and Wales"
+        },
+        "scotland": {
+          "label": "Scotland"
+        },
+        "northernIreland": {
+          "label": "Northern Ireland"
+        }
+      }
+    },
+    "email": {
+      "label": "Enter your 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",
+      "hint": "Briefly summarise your complaint. Include anything that can help our investigation."
+    },
+    "countrySelect": {
+      "label": "Which country are you based in?",
+      "hint": "Start to type the country name and options will appear"
+    },
+    "appealStages": {
+      "label": "Appeal stage",
+      "hint": "Choose an appeal stage from the drop down menu",
+      "options": {
+        "null": "Select..."
+      }
+    }
+  },
+  "journey": {
+    "header": "HOF Bootstrap Sandbox Form",
+    "confirmation": {
+      "details": "Your reference number <br><strong>HDJ2123F</strong>"
+    }
+  },
+  "pages": {
+    "landing-page": {
+      "header": "Landing page"
+    },
+    "build-your-own-form": {
+      "title": "Build your own form",
+      "subheader": "Access the build your own form guidance link"
+    },
+    "address": {
+      "header": "What is your address in the UK?",
+      "intro": "If you have no fixed address, enter an address where we can contact you."
+    },
+    "phone-number": {
+      "header": "Enter your phone number"
+    },
+    "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 {{maxlength}} character limit"
+    },
+    "appealStages": {
+      "required": "Select an appeal stage from the list"
+    }
+  }
+}

package/sandbox/apps/sandbox/translations/src/en/fields.json

@@ -1,6 +1,7 @@
 {
   "landing-page-radio": {
     "legend": "Which form would you like to explore?",
+    "hint": "Choose one of the options below and press continue.",
     "options": {
       "basic-form": {
         "label": "Basic form"
@@ -14,10 +15,10 @@
     }
   },
   "name": {
-    "label": "Full name"
+    "label": "What is your full name?"
   },
   "dateOfBirth": {
-    "legend": "Date of birth",
+    "legend": "What is your date of birth?",
     "hint": "For example, 31 10 1990"
   },
   "building": {
@@ -55,7 +56,7 @@
     }
   },
   "countryOfHearing": {
-    "label": "Country of hearing",
+    "legend": "What country was the appeal lodged?",
     "options": {
       "englandAndWales": {
         "label": "England and Wales"
@@ -69,7 +70,7 @@
     } 
   },
   "email" : {
-    "label": "Email address"
+    "label": "Enter your email address"
   },
   "phone": {
     "label": "Phone number",
@@ -79,14 +80,16 @@
     "legend": "International phone number"
   },
   "complaintDetails": {
-    "label": "Complaint details"
+    "label": "Complaint details",
+    "hint": "Briefly summarise your complaint. Include anything that can help our investigation."
   },
   "countrySelect": {
-    "label": "Select a country",
+    "label": "Which country are you based in?",
     "hint": "Start to type the country name and options will appear"
   },
   "appealStages": {
     "label": "Appeal stage",
+    "hint": "Choose an appeal stage from the drop down menu",
     "options": {
       "null": "Select..."
     }

package/sandbox/apps/sandbox/translations/src/en/journey.json

@@ -1,3 +1,6 @@
 {
-  "header": "HOF Bootstrap Sandbox Form"
+  "header": "HOF Bootstrap Sandbox Form",
+  "confirmation": {
+    "details": "Your reference number <br><strong>HDJ2123F</strong>"
+  }
 }

package/sandbox/apps/sandbox/translations/src/en/pages.json

@@ -1,45 +1,18 @@
 {
   "landing-page": {
-    "header": "Landing page",
-    "intro": "Choose one of the options below and press continue."
+    "header": "Landing page"
   },
   "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": {
@@ -72,4 +45,4 @@
     "subheader": "What happens next",
     "content": "We’ll contact you with the decision of your application or if we need more information from you."
   }
-}
+}

package/sandbox/apps/sandbox/translations/src/en/validation.json

@@ -42,7 +42,7 @@
   },
   "complaintDetails": {
     "default": "Enter details about why you are making a complaint",
-    "maxlength": "Keep to the 5000 character limit"
+    "maxlength": "Keep to the {{maxlength}} character limit"
   },
   "appealStages": {
     "required": "Select an appeal stage from the list"

package/sandbox/assets/js/index.js

@@ -67,4 +67,4 @@ $('.typeahead').each(function applyTypeahead() {
     }),
     limit: 100
   });
-});
+});