hof 22.8.4 → 22.9.0-beta.v1

package/package/package.json

@@ -0,0 +1,147 @@
+{
+  "name": "hof",
+  "description": "A bootstrap for HOF projects",
+  "version": "22.9.0",
+  "license": "MIT",
+  "main": "index.js",
+  "author": "HomeOffice",
+  "engines": {
+    "node": ">=10.22.1",
+    "npm": ">=6.14.0"
+  },
+  "bin": {
+    "hof-build": "./bin/hof-build",
+    "hof-transpiler": "./bin/hof-transpiler"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/UKHomeOfficeForms/hof.git"
+  },
+  "bugs": {
+    "url": "https://github.com/UKHomeOfficeForms/hof/issues"
+  },
+  "scripts": {
+    "test": "yarn run unit && yarn run test:jest && 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 \"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 --timeout 20000 --exit",
+    "test:client": "karma start test/frontend/toolkit/karma.conf.js",
+    "test:jest": "jest test/frontend/jest test/utilities/helpers/jest",
+    "test:acceptance": "TAGS=\"${TAGS:=@feature}\" yarn run test:cucumber",
+    "test:acceptance_browser": "ACCEPTANCE_WITH_BROWSER=true TAGS=\"${TAGS:=@feature}\" yarn run test:cucumber",
+    "test:cucumber": "cucumber-js -f @cucumber/pretty-formatter \"sandbox/test/_features/**/*.feature\" --require sandbox/test/_features/test.setup.js --require \"sandbox/test/_features/step_definitions/**/*.js\" --tags $TAGS",
+    "ci": "travis-conditions",
+    "postversion": "git push && git push --tags"
+  },
+  "dependencies": {
+    "aliasify": "^2.1.0",
+    "axios": "^1.11.0",
+    "bluebird": "^3.7.2",
+    "body-parser": "^1.15.1",
+    "browserify": "^17.0.0",
+    "callsite": "^1.0.0",
+    "chalk": "^2.0.0",
+    "chokidar": "^3.4.0",
+    "connect-redis": "^5.2.0",
+    "cookie-parser": "^1.4.6",
+    "cp": "^0.2.0",
+    "csrf": "^3.1.0",
+    "debug": "^4.3.1",
+    "deprecate": "^1.0.0",
+    "dialog-polyfill": "^0.5.6",
+    "dotenv": "^4.0.0",
+    "duplexify": "^3.5.0",
+    "exorcist": "^2.0.0",
+    "express": "^4.17.1",
+    "express-healthcheck": "^0.1.0",
+    "express-partial-templates": "^0.2.1",
+    "express-session": "^1.13.0",
+    "findup": "^0.1.5",
+    "glob": "^7.2.0",
+    "govuk-elements-sass": "^3.1.3",
+    "govuk-frontend": "3.15",
+    "govuk_template_mustache": "^0.26.0",
+    "helmet": "^3.22.0",
+    "hogan-express-strict": "^0.5.4",
+    "hogan.js": "^3.0.2",
+    "homeoffice-countries": "^0.1.0",
+    "i18n-future": "^2.0.0",
+    "i18n-lookup": "^0.1.0",
+    "is-pdf": "^1.0.0",
+    "jquery": "^3.6.0",
+    "libphonenumber-js": "^1.9.44",
+    "lodash": "^4.17.21",
+    "markdown-it": "^12.3.2",
+    "minimatch": "^3.0.7",
+    "minimist": "^1.2.6",
+    "mixwith": "^0.1.1",
+    "moment": "^2.29.4",
+    "morgan": "^1.10.0",
+    "mustache": "^4.2.0",
+    "nodemailer": "^6.6.3",
+    "nodemailer-ses-transport": "^1.5.1",
+    "nodemailer-stub-transport": "^1.1.0",
+    "notifications-node-client": "^8.2.1",
+    "redis": "^3.1.2",
+    "reqres": "^3.0.1",
+    "rimraf": "^3.0.2",
+    "sass": "^1.56.2",
+    "serve-static": "^1.14.1",
+    "uglify-js": "^3.14.3",
+    "underscore": "^1.13.7",
+    "urijs": "^1.19.11",
+    "uuid": "^8.3.2",
+    "winston": "^3.7.2"
+  },
+  "devDependencies": {
+    "@cucumber/cucumber": "^7.3.0",
+    "@cucumber/pretty-formatter": "^1.0.0-alpha.1",
+    "@types/jest": "^26.0.14",
+    "@xmldom/xmldom": "~0.8.4",
+    "chai": "^3.5.0",
+    "chai-as-promised": "^7.1.1",
+    "chai-subset": "^1.6.0",
+    "concat-stream": "^1.4.7",
+    "csv": "^5.3.2",
+    "eslint": "^8.57.0",
+    "eslint-config-hof": "^1.3.4",
+    "funkie": "0.0.5",
+    "funkie-phantom": "0.0.1",
+    "istanbul": "^0.4.3",
+    "jest": "^26.5.0",
+    "jquery": "^3.6.0",
+    "karma": "^6.3.4",
+    "karma-browserify": "^8.0.0",
+    "karma-chai": "^0.1.0",
+    "karma-cli": "^2.0.0",
+    "karma-mocha": "^2.0.1",
+    "karma-phantomjs-launcher": "^1.0.4",
+    "mocha": "^8.4.0",
+    "mocha-sandbox": "^1.0.0",
+    "node-mocks-http": "^1.6.2",
+    "npm-run-all": "^3.1.1",
+    "nyc": "^15.1.0",
+    "playwright": "^1.16.3",
+    "postcode": "0.2.2",
+    "proxyquire": "^1.7.11",
+    "release-it": "^16.2.1",
+    "sinon": "^11.1.1",
+    "sinon-chai": "^3.7.0",
+    "supertest": "^3.0.0",
+    "travis-conditions": "0.0.0",
+    "watchify": "^4.0.0",
+    "webdriverio": "^4.14.4"
+  },
+  "mocha": {
+    "reporter": "spec",
+    "require": "test/common.js",
+    "recursive": "true",
+    "timeout": "9000",
+    "exit": "true"
+  },
+  "resolutions": {
+    "cached-path-relative": "^1.1.0",
+    "shell-quote": "^1.7.3"
+  }
+}

package/package/sandbox/README.md

@@ -0,0 +1,66 @@
+# HOF Sandbox App
+
+The Home Office Forms (HOF) Sandbox app is used by developers to test out different components in the framework. 
+
+#### How to run the app locally 
+
+Install [Homebrew](https://brew.sh/), if it is not installed 
+
+Once Homebrew is installed run 
+
+```bash
+brew install nvm
+```
+```bash
+source ~/.bash_profile
+```
+
+Install the correct version of node
+
+```bash
+nvm install 14.15.0
+```
+
+Set the node version
+
+```bash
+nvm use 14.15.0
+```
+
+Clone the service locally
+
+```bash
+git clone ... 
+```
+
+Install yarn 
+
+```bash
+npm i yarn -g 
+```
+
+Install the dependencies 
+
+```bash
+yarn
+```
+
+Move into the sandbox folder 
+
+```bash
+cd sandbox
+```
+
+Install any example app specific dependencies 
+
+```bash
+yarn
+```
+
+Run in development mode 
+
+```bash
+yarn start:dev
+```
+
+go to http://localhost:8082/

package/package/sandbox/apps/sandbox/behaviours/clear-session.js

@@ -0,0 +1,8 @@
+'use strict';
+
+module.exports = SuperClass => class extends SuperClass {
+  getValues(req, res, next) {
+    req.sessionModel.reset();
+    this.successHandler(req, res, next);
+  }
+};

package/package/sandbox/apps/sandbox/behaviours/country-select.js

@@ -0,0 +1,10 @@
+module.exports = superclass => class extends superclass {
+  configure(req, res, next) {
+    const homeOfficeCountries = [''].concat(require('homeoffice-countries').allCountries);
+    req.form.options.fields.countrySelect.options = homeOfficeCountries.map(country => {
+      const labelString = country !== '' ? country : 'Please select a country';
+      return { label: labelString, value: country };
+    });
+    next();
+  }
+};

package/package/sandbox/apps/sandbox/behaviours/international-number.js

@@ -0,0 +1,22 @@
+'use strict';
+
+const validators = require('../../../../controller').validators;
+
+module.exports = SuperClass => class extends SuperClass {
+  validateField(key, req) {
+    const code = req.sessionModel.get('countryCode');
+    const number = req.form.values['int-phone-number'];
+
+    const isValid = validators.internationalPhoneNumber(number, code);
+
+    if (!isValid) {
+      return new this.ValidationError('int-phone-number', {
+        key: 'int-phone-number',
+        type: 'internationalPhoneNumber',
+        redirect: undefined
+      });
+    }
+
+    return super.validateField(key, req);
+  }
+};

package/package/sandbox/apps/sandbox/fields.js

@@ -0,0 +1,128 @@
+/* eslint-disable */
+'use strict';
+
+const dateComponent = require('../../../').components.date;
+const staticAppealStages = require('./lib/staticAppealStages');
+
+module.exports = {
+  'landing-page-radio': {
+    mixin: 'radio-group',
+    validate: ['required'],
+    isPageHeading: 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 }],
+  },
+  'dateOfBirth': dateComponent('dateOfBirth', {
+    mixin: 'input-date',
+    isPageHeading: 'true',
+    validate: [
+      'required',
+      'date',
+      { type: 'after', arguments: ['1900'] }
+    ]
+  }),
+  building: {
+    validate: ['required', 'notUrl', { type: 'maxlength', arguments: 100 }]
+  },
+  street: {
+    validate: ['notUrl', { type: 'maxlength', arguments: 50 }],
+    labelClassName: 'visuallyhidden'
+  },
+  townOrCity: {
+    validate: ['required', 'notUrl',
+      { type: 'regex', arguments: /^([^0-9]*)$/ },
+      { type: 'maxlength', arguments: 100 }
+    ]
+  },
+  postcode: {
+    validate: ['required', 'postcode'],
+    formatter: ['removespaces', 'uppercase']
+  },
+  incomeTypes: {
+    isPageHeading: 'true',
+    mixin: 'checkbox-group',
+    labelClassName: 'visuallyhidden',
+    validate: ['required'],
+    options: [
+      'salary',
+      'universal_credit',
+      'child_benefit',
+      'housing_benefit',
+      'other'
+    ]
+  },
+  countryOfHearing: {
+    isPageHeading: 'true',
+    mixin: 'radio-group',
+    validate: ['required'],
+    options: [
+      'englandAndWales',
+      'scotland',
+      'northernIreland'
+    ]
+  },
+  email: {
+    validate: ['required', 'email']
+  },
+  phone: {
+    validate: ['required', 'internationalPhoneNumber']
+  },
+  'int-phone-number': {
+    validate: ['required'],
+    labelClassName: 'visuallyhidden'
+  },
+  countrySelect: {
+    mixin: 'select',
+    isPageHeading: 'true',
+    className: ['typeahead'],
+    options:[''].concat(require('homeoffice-countries').allCountries),
+    legend: {
+      className: 'visuallyhidden'
+    },
+    validate: ['required']
+  },
+  complaintDetails: {
+    mixin: 'textarea',
+    // we want to ignore default formatters as we want
+    // to preserve white space
+    'ignore-defaults': true,
+    // apply the other default formatters
+    formatter: ['trim', 'hyphens'],
+    isPageHeading: 'true',
+    // attributes here are passed to the field element
+    validate: ['required', { type: 'maxlength', arguments: 10 }],
+    attributes: [{
+      attribute: 'rows',
+      value: 8
+    }]
+  },
+  whatHappened: {
+    mixin: 'textarea',
+    // we want to ignore default formatters as we want
+    // to preserve white space
+    'ignore-defaults': true,
+    // apply the other default formatters
+    formatter: ['trim', 'hyphens'],
+    isPageHeading: 'true',
+    // attributes here are passed to the field element
+    validate: ['required', { type: 'maxword', arguments: 10 }],
+    attributes: [{
+      attribute: 'rows',
+      value: 8
+    }]
+  },
+  appealStages: {
+    mixin: 'select',
+    isPageHeading: 'true',
+    validate: ['required'],
+    options: [{
+      value: '',
+      label: 'fields.appealStages.options.null'
+    }].concat(staticAppealStages.getstaticAppealStages())
+  }
+}

package/package/sandbox/apps/sandbox/index.js

@@ -0,0 +1,99 @@
+/* eslint-disable */
+'use strict';
+
+const CountrySelect = require('./behaviours/country-select')
+const SummaryPageBehaviour = require('../../../').components.summary;
+const InternationalPhoneNumber = require('./behaviours/international-number');
+
+module.exports = {
+  name: 'sandbox',
+  steps: {
+    '/landing-page': {
+      fields: [
+        'landing-page-radio'
+      ],
+      next: '/name',
+      forks: [{
+        target: '/build-your-own-form',
+        condition: {
+          field: 'landing-page-radio',
+          value: 'build-your-own-form'
+        }
+      }],
+    },
+    '/build-your-own-form': {
+      template: 'form-guidance-link'
+    },
+    '/name': {
+      fields: ['name'],
+      next: '/dob'
+    },
+    '/dob': {
+      fields: ['dateOfBirth'],
+      locals: { showSaveAndExit: true },
+      next: '/address'
+    },
+    '/address': {
+      fields: ['building', 'street', 'townOrCity', 'postcode'],
+      next: '/checkboxes'
+    },
+    '/checkboxes': {
+      fields: ['incomeTypes'],
+      next: '/radio'
+    },
+    '/radio':{
+      fields: ['countryOfHearing'],
+      forks: [{
+        target: '/country-select',
+        condition: {
+          field: 'landing-page-radio',
+          value: 'complex-form'
+        }
+      }],
+      next: '/email'
+    },
+    '/email': {
+      fields: ['email'],
+      next: '/phone-number'
+    },
+    '/phone-number': {
+      fields: ['phone'],
+      next: '/confirm'
+    },
+    '/country-select': {
+      behaviours: CountrySelect,
+      fields: ['countrySelect'],
+      next: '/text-input-area'
+    },
+    '/text-input-area': {
+      fields: ['complaintDetails'],
+      next: '/word-count'
+    },
+    '/word-count': {
+      fields: ['whatHappened'],
+      next: '/select'
+    },
+    '/select':{ 
+      fields: ['appealStages'], 
+      next: '/confirm'
+    },
+    '/confirm': {
+      behaviours: [SummaryPageBehaviour, 'complete'],
+      sections: require('./sections/summary-data-sections'),
+      next: '/confirmation'
+    },
+    '/confirmation': {
+      backLink: false
+    },
+    '/international-phone-number': {
+      behaviours: InternationalPhoneNumber,
+      fields: [
+        'int-phone-number'
+      ],
+      next: '/confirm'
+    },
+    '/session-timeout': {},
+    '/exit': {},
+    '/save-and-exit': {}
+  }
+};

package/package/sandbox/apps/sandbox/lib/staticAppealStages.js

@@ -0,0 +1,189 @@
+/* eslint max-len: 0 */
+
+'use strict';
+
+module.exports = {
+  getstaticAppealStages: function () {
+    return [
+      { value: 'FT_IC',
+        label: '01. First Tier IAC Appeal - In Country Appeals',
+        timeLimit: {value: 14, type: 'calendar days'},
+        startDateLabel: 'Date refusal letter sent by HO',
+        rules: 'The Tribunal Procedure (First-tier tribunal) (Immigration and Asylum Chamber) Rules 2014',
+        ruleNumber: '19(2)',
+        adminAllowance: {value: 1, type: 'working day'},
+        country: 'All',
+        trigger: 'Refusal Notice',
+        sortCode: 10
+      },
+
+      { value: 'FT_OOC_1',
+        label: '02. First Tier IAC Appeal - Out of Country Appeals where the appellant must leave the UK before appealing',
+        timeLimit: {value: 28, type: 'calendar days'},
+        startDateLabel: 'Appellant\'s date of departure',
+        rules: 'The Tribunal Procedure (First-tier tribunal) (Immigration and Asylum Chamber) Rules 2014',
+        ruleNumber: '19(3)(a)',
+        adminAllowance: {value: 0, type: 'working days'},
+        country: 'All',
+        trigger: 'Refusal Notice',
+        sortCode: 20
+      },
+
+      { value: 'FT_OOC_2',
+        label: '03. First Tier IAC Appeal - Other out of Country Appeals (e.g Voluntary Departure)',
+        timeLimit: {value: 28, type: 'calendar days'},
+        startDateLabel: 'Date of receipt of the refusal letter',
+        rules: 'The Tribunal Procedure (First-tier tribunal) (Immigration and Asylum Chamber) Rules 2014',
+        ruleNumber: '19(3)(b)',
+        adminAllowance: {value: 1, type: 'working days'},
+        country: 'All',
+        trigger: 'Refusal Notice',
+        sortCode: 30
+      },
+
+      { value: 'FT_IC_FAST',
+        label: '04. First Tier IAC Appeal - In Country Detained Fast Track',
+        timeLimit: {value: 2, type: 'working days'},
+        startDateLabel: 'Date when appellant was provided notice of decision',
+        rules: 'The Tribunal Procedure (First-tier tribunal) (Immigration and Asylum Chamber) Rules 2014 Schedule The Fast Track Rules',
+        ruleNumber: '5(1)',
+        adminAllowance: {value: 1, type: 'working day'},
+        country: 'All',
+        trigger: 'Refusal Notice',
+        sortCode: 40
+      },
+
+      { value: 'FT_UT_IC',
+        label: '05. First Tier IAC PTA to the UT - In Country',
+        timeLimit: {value: 14, type: 'calendar days'},
+        startDateLabel: 'Date written reasons for the decision sent',
+        rules: 'The Tribunal Procedure (First-tier tribunal) (Immigration and Asylum Chamber) Rules 2014',
+        ruleNumber: '33(2)',
+        adminAllowance: {value: 1, type: 'working day'},
+        country: 'All',
+        trigger: 'IA60 first tier dismissed',
+        sortCode: 50
+      },
+
+      { value: 'FT_UT_OOC',
+        label: '06. First Tier IAC PTA to the UT - Out of Country',
+        timeLimit: {value: 28, type: 'calendar days'},
+        startDateLabel: 'Date written reasons for the decision sent',
+        rules: 'The Tribunal Procedure (First-tier tribunal) (Immigration and Asylum Chamber) Rules 2014',
+        ruleNumber: '33(3)',
+        adminAllowance: {value: 1, type: 'working day'},
+        country: 'All',
+        trigger: 'IA60 first tier dismissed',
+        sortCode: 60
+      },
+
+      { value: 'FT_UT_FAST',
+        label: '07. First Tier IAC PTA to the UT - Detained Fast Track',
+        timeLimit: {value: 3, type: 'working days'},
+        startDateLabel: 'Date when appellant was provided notice of decision',
+        rules: 'The Tribunal Procedure (First-tier tribunal) (Immigration and Asylum Chamber) Rules 2014 Schedule The Fast Track Rules',
+        ruleNumber: '11',
+        adminAllowance: {value: 1, type: 'working day'},
+        country: 'All',
+        trigger: 'IA60 first tier dismissed',
+        sortCode: 70
+      },
+
+      { value: 'UT_IC',
+        label: '08. Upper Tribunal IAC PTA - In Country',
+        timeLimit: {value: 14, type: 'calendar days'},
+        startDateLabel: 'Date when the FtT refused FTPA',
+        rules: 'The Tribunal Procedure (Upper Tribunal) Rules 2008',
+        ruleNumber: '21(3)(a)(aa)(i)',
+        adminAllowance: {value: 1, type: 'working day'},
+        country: 'All',
+        trigger: 'IA67 first tier permission to appeal refused',
+        sortCode: 80
+      },
+
+      { value: 'UT_OOC',
+        label: '09. Upper Tribunal IAC PTA - Out of Country',
+        timeLimit: {value: 1, type: 'calendar month'},
+        startDateLabel: 'Date when the FtT refused FTPA',
+        rules: 'The Tribunal Procedure (Upper Tribunal) Rules 2008',
+        ruleNumber: '21(3)(b)',
+        adminAllowance: {value: 1, type: 'working day'},
+        country: 'All',
+        trigger: 'IA67 first tier permission to appeal refused',
+        sortCode: 90
+      },
+
+      { value: 'UT_IAC_JR',
+        label: '10. Upper Tribunal IAC - Judicial Review',
+        timeLimit: {value: 3, type: 'calendar months'},
+        startDateLabel: 'Date of decision of the First Tier Tribunal or Home Office',
+        rules: 'The Tribunal Procedure (Upper Tribunal) Rules 2008',
+        ruleNumber: '28(2)',
+        adminAllowance: {value: 0, type: 'working days'},
+        country: 'All',
+        trigger: 'n/a',
+        sortCode: 100
+      },
+
+      { value: 'UT_IAC_IC',
+        label: '11. Upper Tribunal IAC - In Country PTA to review UT determination',
+        timeLimit: {value: 12, type: 'calendar days'},
+        startDateLabel: 'Date when appellant was sent notice of decision',
+        rules: 'The Tribunal Procedure (Upper Tribunal) Rules 2008',
+        ruleNumber: '44(3B)(a)(i)',
+        adminAllowance: {value: 1, type: 'working day'},
+        country: 'All',
+        trigger: 'IA150 - Upper Tier determination (dismissed)',
+        sortCode: 110
+      },
+
+      { value: 'UT_IAC_OOC',
+        label: '12. Upper Tribunal IAC - Out of Country PTA to review UT determination',
+        timeLimit: {value: 38, type: 'calendar days'},
+        startDateLabel: 'Date when appellant was sent notice of decision',
+        rules: 'The Tribunal Procedure (Upper Tribunal) Rules 2008',
+        ruleNumber: '44(3B)(b)',
+        adminAllowance: {value: 1, type: 'working day'},
+        country: 'All',
+        trigger: 'IA150 - Upper Tier determination (dismissed)',
+        sortCode: 120
+      },
+
+      { value: 'COA_IAC',
+        label: '13. Court of Appeal via IAC',
+        timeLimit: {value: 28 + 2, type: 'calendar days'},
+        startDateLabel: 'Date when appellant was sent notice of decision',
+        rules: 'Civil Procedure Rules',
+        ruleNumber: '52.4',
+        adminAllowance: {value: 1, type: 'working days'},
+        country: ['England & Wales'],
+        trigger: 'IA157 PTA to the CoA refused',
+        sortCode: 130
+      },
+
+      { value: 'COS_IAC',
+        label: '14. Court of Sessions via IAC',
+        timeLimit: {value: 42 + 1, type: 'calendar days'},
+        startDateLabel: 'Date when appellant was sent notice of decision',
+        rules: 'Civil Procedure Rules',
+        ruleNumber: 'Rule 41.20',
+        adminAllowance: {value: 1, type: 'working days'},
+        country: ['Scotland', 'Northern Ireland'],
+        trigger: 'IA157 PTA to the CoA refused',
+        sortCode: 140
+      },
+
+      { value: 'COA_DIRECT',
+        label: '15. Court of Appeal Direct',
+        timeLimit: {value: 7 + 2, type: 'calendar days'},
+        startDateLabel: 'Date when appellant was sent notice of decision',
+        rules: 'Civil Procedure Rules',
+        ruleNumber: '52.3',
+        adminAllowance: {value: 1, type: 'working days'},
+        country: 'All',
+        trigger: 'IA157 PTA to the CoA refused',
+        sortCode: 150
+      }
+    ];
+  }
+};