hof 22.0.0 → 22.0.2-ukmobilephone-validator-beta

package/.github/workflows/automate-publish.yml

@@ -8,15 +8,15 @@ on:
       - completed
 jobs:
   auto-publish:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     if: startsWith(github.ref, 'refs/heads/master')
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v2.2.0
         with:
           fetch-depth: 0
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v1
         with:
-          node-version: 20
+          node-version: 14
           registry-url: https://registry.npmjs.org/
       - name: 'Get Previous tag'
         id: previoustag

package/.github/workflows/automate-tag.yml

@@ -4,14 +4,14 @@ name: Automate_Tag
 on: [push]
 jobs:
   test:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [20.x]
+        node-version: [14.x]
         redis-version: [4, 5, 6]
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v2.2.0
+      - uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
       - name: Start Redis
@@ -25,16 +25,16 @@ jobs:
 
   auto-tag-patch:
     needs: test
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     if: |
       startsWith(github.ref, 'refs/heads/master') &&
       !contains(github.event.head_commit.message, '[MAJOR]') &&
       !contains(github.event.head_commit.message, '[MINOR]')
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v2.2.0
+      - uses: actions/setup-node@v1
         with:
-          node-version: 20
+          node-version: 14
           registry-url: https://registry.npmjs.org/
       - run: |
           git config --local user.email "$(git log --format='%ae' HEAD^!)"
@@ -43,16 +43,16 @@ jobs:
 
   auto-tag-minor:
     needs: test
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     if: |
       startsWith(github.ref, 'refs/heads/master') &&
       !contains(github.event.head_commit.message, '[MAJOR]') &&
       contains(github.event.head_commit.message, '[MINOR]')
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v2.2.0
+      - uses: actions/setup-node@v1
         with:
-          node-version: 20
+          node-version: 14
           registry-url: https://registry.npmjs.org/
       - run: |
           git config --local user.email "$(git log --format='%ae' HEAD^!)"
@@ -61,16 +61,16 @@ jobs:
 
   auto-tag-major:
     needs: test
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     if: |
       startsWith(github.ref, 'refs/heads/master') &&
       contains(github.event.head_commit.message, '[MAJOR]') &&
       !contains(github.event.head_commit.message, '[MINOR]')
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v2.2.0
+      - uses: actions/setup-node@v1
         with:
-          node-version: 20
+          node-version: 14
           registry-url: https://registry.npmjs.org/
       - run: |
           git config --local user.email "$(git log --format='%ae' HEAD^!)"

package/CHANGELOG.md

@@ -1,16 +1,3 @@
-## 2025-01-17, Version 22.0.0 (Stable), @Rhodine-orleans-lindsay
-* Adds session timeout warning
-  - user can stay on page or exit form
-  - adds exit html
-  - user can stay signed in or save and exit the form if the form is a save and exit form
-  - adds default save-and-exit html
-  - updates confirmation html to a static page
-  - allows for customisation of session timeout warning dialog content, exit and save-and-exit page content, and exit and save-and-exit steps
-  - Potential **_breaking change_**: Static pages should use the ```{{<layout}}...{{/layout}}``` tags instead of the ```{{<partials-page}}...{{/partials-page}}``` tags if the timeout warning should not be displayed.
-* Fixes accessibility issues
-* Sandbox area for testing hof changes
-* Updates patch and minor dependency versions
-
 ## 2024-07-22, Version 21.0.0 (Stable), @Rhodine-orleans-lindsay
 * Replaces deprecated request module with axios
   - refactors the hof model and apis to use axios instead of request

package/README.md

@@ -945,11 +945,11 @@ Using the translation key `fields.field-name.label` will return different values
 
 # HOF Components
 
-## Date Component
+## Date Component
 
 A component for handling the rendering and processing of 3-input date fields used in HOF Applications.
 
-### Usage
+## Usage
 
 In your fields config:
 
@@ -965,7 +965,7 @@ module.exports = {
 
 The above example will create a new date component with the key `'date-field'` and will apply the validators `required` and `before` (before today).
 
-### Configuration
+## Configuration
 
 The following optional configuration options are supported:
 
@@ -974,7 +974,7 @@ The following optional configuration options are supported:
 - `dayOptional {Boolean}` - day defaults to `01` if omitted. Defaults to `false`
 - `monthOptional {Boolean}` - month defaults to `01` if omitted. If true then also forces `dayOptional` to be true. Defaults to `false`
 
-### Labels
+## Labels
 
 The three intermedate fields have fallback labels of Day, Month and Year, however custom labels can be used by including the translation at the following path:
 
@@ -998,13 +998,13 @@ fields.json
 }
 ```
 
-## Summary Page Component
+# Summary Page Component
 
 HOF behaviour for showing summary pages
 
 The behaviour mixin will create a set of "locals" data which is compatible with [the `confirm` view from `hof-template-partials`](https://github.com/UKHomeOfficeForms/hof-template-partials/blob/master/views/confirm.html).
 
-### Usage
+## Usage
 
 If no sections config is passed, then the mixin will create a section for each step that has fields, and a row within each section for each field on that step.
 
@@ -1043,11 +1043,11 @@ Alternatively, sections can be defined manually as follows:
 }
 ```
 
-### Configuration
+## Configuration
 
 The `sections` configuration should be a map of arrays, where the entries in the array are the fields that should be shown within that section.
 
-#### Field configuration
+### Field configuration
 
 Fields can be defined as simple strings of the field key, in which case all default configuration will be used.
 
@@ -1087,18 +1087,18 @@ The `location-addresses` field is one that the application has setup to aggregat
 
 This allows the creation of summary rows based on unknown dynamic user input, i.e. we can not predict in advance how many addresses a user wants to input, what the addresses are and how many categories the user wants to attach to each address. This allows you to easily list them this way.
 
-### Translations
+## Translations
 
 The content for section headings and field labels will be loaded from translation files based on the keys.
 
-#### Section headings
+### Section headings
 
 Translations for section headings are looked for in the following order:
 
 - `pages.confirm.sections.${key}.header`
 - `pages.${key}.header`
 
-#### Field labels
+### Field labels
 
 Translations for field labels are looked for in the following order:
 
@@ -1106,11 +1106,11 @@ Translations for field labels are looked for in the following order:
 - `fields.${key}.label`
 - `fields.${key}.legend`
 
-## Emailer Component
+# Emailer Component
 
 HOF behaviour to send emails
 
-### Usage
+## Usage
 
 ```js
 const EmailBehaviour = require('hof').components.emailer;
@@ -1140,7 +1140,7 @@ steps: {
 }
 ```
 
-### Options
+## Options
 
 In addition to the options passed to `hof-emailer`, the following options can be used:
 
@@ -1159,17 +1159,17 @@ const emailer = EmailBehaviour({
 });
 ```
 
-## HOF Emailer
+# HOF Emailer
 
 An emailer service for HOF applications.
 
-### Installation
+## Installation
 
 ```bash
 $ npm install hof-emailer --save
 ```
 
-### Usage
+## Usage
 
 ```js
 // first create an emailer instance
@@ -1192,22 +1192,22 @@ emailer.send(to, body, subject).then(() => {
 });
 ```
 
-### Options
+## Options
 
 - `from`: <String>: Address to send emails from. Required.
 - `transport`: <String>: Select what mechanism to use to send emails. Defaults: 'smtp'.
 - `transportOptions`: <Object>: Set the options for the chosen transport, as defined below. Required.
 - `layout`: <String>: Optional path to use a custom layout for email content.
 
-### Transports
+## Transports
 
 The following transport options are available:
 
-#### `smtp`
+### `smtp`
 
 [nodemailer-smtp-transport](https://github.com/andris9/nodemailer-smtp-transport)
 
-##### Options
+#### Options
 
 - `host` <String>: Address of the mailserver. Required.
 - `port` <String|Number>: Port of the mailserver. Required.
@@ -1216,11 +1216,11 @@ The following transport options are available:
 - `auth.user` <String>: Mailserver authorisation username.
 - `auth.pass` <String>: Mailserver authorisation password.
 
-#### `ses`
+### `ses`
 
 [nodemailer-ses-transport](https://github.com/andris9/nodemailer-ses-transport)
 
-##### Options
+#### Options
 
 - `accessKeyId` <String>: AWS accessKeyId. Required.
 - `secretAccessKey` <String>: AWS accessKeyId. Required.
@@ -1230,18 +1230,18 @@ The following transport options are available:
 - `rateLimit` <String>
 - `maxConnections` <String>
 
-#### `debug`
+### `debug`
 
 A development option to write the html content of the email to a file for inspection.
 
 `transport: 'debug'`
 
-##### debug options
+#### debug options
 
 - `dir` <String>: The location to save html to. Default: `./.emails`. This directory will be created if it does not exist.
 - `open` <Boolean>: If set to true, will automatically open the created html file in a browser.
 
-##### debug example
+#### debug example
 
 ```
 transport: 'debug'
@@ -1251,94 +1251,10 @@ transportOptions: {
 }
 ```
 
-#### `stub`
+### `stub`
 
 Disables sending email. No options are required.
 
-## Session Timeout Warning Component
-HOF component for customising session timeout related pages
-This feature allows you to customise the content related to the session timeout warning, including the messages displayed in the session timeout warning dialog and on the exit page after a user exits the form due to a session timeout.
-
-### Usage
-
-To enable and customise the session timeout behavior, you need to set the component in your project's `hof.settings.json` file:
-```js
- "behaviours": [
-    "hof/components/session-timeout-warning"
-  ]
-```
-
-By default, the framework uses the standard content provided by HOF. If you wish to override this with custom content at the project level, you must set the following variables to `true` in `hof.settings.json`:
-
-```js
- behaviours: [
-    require('../').components.sessionTimeoutWarning
-  ],
-  sessionTimeoutWarningContent: true, // allows you to customise the content in the session timeout dialog box
-  exitFormContent: true // allows you to customise the content on the exit page
-  saveExitFormContent: true // allows you to customise the content on the save-and-exit page
-```
-
-### Customising content in `pages.json`
-Once the variables are set, you can customise the session timeout warning and exit messages in your project's pages.json:
-
-```json
-"exit": {
-  "message": "We have cleared your information to keep it secure. Your information has not been saved."
-},
-"session-timeout-warning": {
-   "dialog-title": "Your application will close soon",
-   "dialog-text": "If that happens, your progress will not be saved.",
-   "timeout-continue-button": "Stay on this page",
-   "dialog-exit-link": "Exit this form"
-}
-"save-and-exit": {
-  "message": "Any answers you saved have not been affected. You can sign back in to your application at any time by returning to the start page."
-},
-```
-
-### Editing content on the Exit and Save-and-exit Page Header and Title
-To edit the exit or save-and-exit pages' header and title, create an `exit.json` or `save-and-exit.json` file in your project and set the desired content:
-```json
-{
-  "header": "You have left this form",
-  "title": "You have left this form"
-}
-```
-
-### Customising exit and save-and-exit steps
-You can customise the `exit` and `save-and-exit` steps by setting the `exitStep` or `saveAndExitStep` properties in the `apps/<app_name>/index.js` to the desired path name:
-
-```js
-// customising exit step name
-module.exports = {
-  name: 'sandbox',
-  exitStep: '/leave',
-  steps: {
-    ...
-    '/leave': {
-      template: 'exit'
-    }
-  }
-  ...
-}
-```
-
-```js
-// customising save-and-exit step name
-module.exports = {
-  name: 'sandbox',
-  saveAndExitStep: '/sign-out',
-  steps: {
-    ...
-    '/sign-out': {
-      template: 'save-and-exit'
-    }
-  }
-  ...
-}
-```
-
 # UTILITIES
 
 # Autofill Utility

package/components/index.js

@@ -8,6 +8,5 @@ module.exports = {
   emailer: require('./emailer'),
   homeOfficeCountries: require('./homeoffice-countries'),
   notify: require('./notify'),
-  summary: require('./summary'),
-  sessionTimeoutWarning: require('./session-timeout-warning')
+  summary: require('./summary')
 };

package/config/hof-defaults.js

@@ -14,9 +14,6 @@ const defaults = {
   getCookies: true,
   getTerms: true,
   getAccessibility: false,
-  sessionTimeoutWarningContent: false,
-  exitFormContent: false,
-  saveExitFormContent: false,
   viewEngine: 'html',
   protocol: process.env.PROTOCOL || 'http',
   noCache: process.env.NO_CACHE || false,
@@ -50,8 +47,7 @@ const defaults = {
   apis: {
     pdfConverter: process.env.PDF_CONVERTER_URL
   },
-  serveStatic: process.env.SERVE_STATIC_FILES !== 'false',
-  sessionTimeOutWarning: process.env.SESSION_TIMEOUT_WARNING || 300
+  serveStatic: process.env.SERVE_STATIC_FILES !== 'false'
 };
 
 module.exports = Object.assign({}, defaults, rateLimits);

package/controller/controller.js

@@ -109,14 +109,10 @@ module.exports = class Controller extends BaseController {
     // only include fields that aren't dependents to mitigate duplicate fields on the page
     fields = fields.filter(field => !req.form.options.fields[field.key].dependent);
 
-    const exitStep = req.form.options.exitStep || '/exit';
-    const saveAndExitStep = req.form.options.saveAndExitStep || '/save-and-exit';
     return _.extend({}, locals, {
       fields,
       route,
       baseUrl: req.baseUrl,
-      exitStep,
-      saveAndExitStep,
       skipToMain: this.getFirstFormItem(req.form.options.fields),
       title: this.getTitle(route, lookup, req.form.options.fields, res.locals),
       journeyHeaderURL: this.getJourneyHeaderURL(req.baseUrl),

package/controller/validation/validators.js

@@ -109,7 +109,7 @@ module.exports = Validators = {
   },
 
   ukmobilephone(value) {
-    return value === '' || Validators.regex(value, /^(07)\d{9}$/);
+    return value === '' || Validators.regex(value, /^(?:\+447|07)\d{9}$/);
   },
 
   date(value) {

package/frontend/template-partials/views/confirmation.html

@@ -1,19 +1,6 @@
-{{<layout}}
-  {{$journeyHeader}}
-  {{#t}}journey.header{{/t}}
-  {{/journeyHeader}}
-
-  {{$propositionHeader}}
-  {{> partials-navigation}}
-  {{/propositionHeader}}
-
-  {{$header}}
-    {{header}}
-  {{/header}}
-
-  {{$content}}
+{{<partials-page}}
+  {{$page-content}}
     {{>partials-confirmation-alert}}
     {{#markdown}}what-happens-next{{/markdown}}
-  {{/content}}
-{{/layout}}
-
+  {{/page-content}}
+{{/partials-page}}

package/frontend/template-partials/views/partials/head.html

@@ -25,7 +25,4 @@
   <meta name="robots" content="noindex">
 {{/deIndex}}
 <meta name="format-detection" content="telephone=no">
-<noscript>
-  <meta http-equiv="refresh" content="{{sessionTimeOut}};url='{{baseUrl}}/session-timeout'"/>
-</noscript>
 <link rel="stylesheet" href="{{assetPath}}/css/app.css">

package/frontend/template-partials/views/partials/page.html

@@ -16,7 +16,6 @@
     {{<partials-form}}
       {{$form}}
         {{$page-content}}{{/page-content}}
-        {{> partials-session-timeout-warning}}
       {{/form}}
     {{/partials-form}}
   {{/content}}

package/frontend/themes/gov-uk/client-js/index.js

@@ -14,7 +14,6 @@ window.GOVUK = GOVUK;
 var skipToMain = require('./skip-to-main');
 var cookie = require('./govuk-cookies');
 var cookieSettings = require('./cookieSettings');
-var sessionDialog = require('./session-timeout-dialog');
 
 toolkit.detailsSummary();
 

package/frontend/themes/gov-uk/styles/govuk.scss

@@ -26,7 +26,6 @@ $path: "/public/images/" !default;
 @import "cookie-settings";
 @import "check_your_answers";
 @import "pdf";
-@import "session-timeout-dialog";
 
 // Modules
 @import "modules/validation";

package/index.js

@@ -85,7 +85,6 @@ const getContentSecurityPolicy = (config, res) => {
       'www.google.co.uk/ads/ga-audiences'
     ],
     connectSrc: [
-      "'self'",
       'https://www.google-analytics.com',
       'https://region1.google-analytics.com',
       'https://region1.analytics.google.com'
@@ -149,12 +148,6 @@ function bootstrap(options) {
     res.locals.appName = config.appName;
     res.locals.htmlLang = config.htmlLang;
     res.locals.cookieName = config.session.name;
-    // session timeout warning configs
-    res.locals.sessionTimeOut = config.session.ttl;
-    res.locals.sessionTimeOutWarning = config.sessionTimeOutWarning;
-    res.locals.sessionTimeoutWarningContent = config.sessionTimeoutWarningContent;
-    res.locals.exitFormContent = config.exitFormContent;
-    res.locals.saveExitFormContent = config.saveExitFormContent;
     next();
   });
 
@@ -197,10 +190,10 @@ function bootstrap(options) {
   app.use(morgan('sessionId=:id ' + morgan.combined, {
     stream: config.logger.stream,
     skip: (req, res) => config.loglevel !== 'debug' &&
-      (
-        res.statusCode >= 300 || !_.get(req, 'session.id') ||
-        config.ignoreMiddlewareLogs.some(v => req.originalUrl.includes(v))
-      )
+        (
+          res.statusCode >= 300 || !_.get(req, 'session.id') ||
+          config.ignoreMiddlewareLogs.some(v => req.originalUrl.includes(v))
+        )
   }));
 
   serveStatic(app, config);

package/lib/router.js

@@ -30,8 +30,6 @@ function getWizardConfig(config) {
   // whitelist properties from the route's config that should be passed into the form wizard
   const props = [
     'confirmStep',
-    'exitStep',
-    'saveAndExitStep',
     'params'
   ];
   Object.assign(wizardConfig, _.pick(config.route, props));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hof",
   "description": "A bootstrap for HOF projects",
-  "version": "22.0.0",
+  "version": "22.0.2-ukmobilephone-validator-beta",
   "license": "MIT",
   "main": "index.js",
   "author": "HomeOffice",
@@ -21,13 +21,13 @@
     "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",
+    "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 \"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:cookie-banner": "jest test/frontend/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",
@@ -49,7 +49,6 @@
     "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",
     "express": "^4.17.1",

package/{pull_request_template.md → pull_request.md}

@@ -12,5 +12,5 @@
 - [ ] I have created a JIRA number for my commit
 - [ ] I have followed the chris beams method for my commit https://cbea.ms/git-commit/
 here is an [example commit](https://github.com/UKHomeOfficeForms/hof/commit/810959f391187c7c4af6db262bcd143b50093a6e)
-- [ ] Ensure workflow jobs are passing especially tests
+- [ ] Ensure drone builds are green especially tests
 - [ ] I will squash the commits before merging

package/sandbox/apps/sandbox/index.js

@@ -30,7 +30,6 @@ module.exports = {
     },
     '/dob': {
       fields: ['dateOfBirth'],
-      locals: { showSaveAndExit: true },
       next: '/address'
     },
     '/address': {
@@ -92,8 +91,5 @@ module.exports = {
       ],
       next: '/confirm'
     },
-    '/session-timeout': {},
-    '/exit': {},
-    '/save-and-exit': {}
   }
 };

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

@@ -50,23 +50,8 @@
   },
   "confirmation": {
     "title": "Application sent",
-    "alert": "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."
-  },
-  "exit": {
-    "message": "We have cleared your information to keep it secure. Your information has not been saved."
-  },
-  "session-timeout-warning": {
-    "dialog-title": "{{^showSaveAndExit}}Your application will close soon{{/showSaveAndExit}}{{#showSaveAndExit}}You will be signed out soon{{/showSaveAndExit}}",
-    "dialog-text": "{{^showSaveAndExit}}If that happens, your progress will not be saved.{{/showSaveAndExit}}{{#showSaveAndExit}}Any answers you have saved will not be affected, but your progress on this page will not be saved.{{/showSaveAndExit}}",
-    "timeout-continue-button": "{{^showSaveAndExit}}Stay on this page{{/showSaveAndExit}}{{#showSaveAndExit}}Stay signed in{{/showSaveAndExit}}",
-    "dialog-exit-link": "{{^showSaveAndExit}}Exit this form{{/showSaveAndExit}}{{#showSaveAndExit}}Sign out{{/showSaveAndExit}}"
-  },
-  "save-and-exit": {
-    "header": "You have been signed out",
-    "paragraph-1": "Your form doesn't appear to have been worked on for 30 minutes so we closed it for security.",
-    "paragraph-2": "Any answers you saved have not been affected.",
-    "paragraph-3": "You can sign back in to your application at any time by returning to the <a href='/' class='govuk-link'>start page</a>."
   }
 }

package/sandbox/server.js

@@ -8,16 +8,11 @@ bootstrap({
   routes: [
     require('./apps/sandbox')
   ],
-  behaviours: [
-    require('../').components.sessionTimeoutWarning
-  ],
   rateLimits: {
     requests: {
       active: true
     }
   },
   getAccessibility: true,
-  sessionTimeoutWarningContent: true,
-  exitFormContent: true,
   "port": 8082
 });