hof 19.11.24 → 19.12.2

package/README.md

@@ -5,6 +5,11 @@
 
 HOF (Home Office Forms) is a framework designed to assist developers in creating form-based workflows in a rapid, repeatable and secure way. It aims to reduce simple applications as much as possible to being configuration-only.
 
+## Server Settings
+In your `hof.settings.json` file you can add `getTerms: false` and `getCookies: false` to turn off the default cookies, and terms and conditions information provided by the HOF framework. This is if you want to provide more specific material at the service level in regards to these subject matter otherwise the defaults should suffice.
+
+Also you can set `getAccessibility: true` to get the default accessibility document for this framework if one is not provided at the service level. It is assumed there should have been an accessibility audit carried out for a service already hence why the default setting for this is set to `false`. But if a generic placeholder is needed to ensure the service is legally compliant then this can be set to `true` to provide the default one presented within the framework.
+
 ## Resources
 
 ### HOF documentation

package/config/hof-defaults.js

@@ -3,6 +3,7 @@
 
 const defaults = {
   appName: process.env.APP_NAME || 'HOF Application',
+  htmlLang: 'en',
   root: process.cwd(),
   translations: 'translations',
   start: true,
@@ -11,6 +12,7 @@ const defaults = {
   },
   getCookies: true,
   getTerms: true,
+  getAccessibility: false,
   viewEngine: 'html',
   protocol: process.env.PROTOCOL || 'http',
   noCache: process.env.NO_CACHE || false,

package/frontend/template-partials/translations/src/en/accessibility.json

@@ -0,0 +1,43 @@
+{
+  "header": "Accessibility statement for this Home Office Forms Application",
+  "intro": "This accessibility statement applies to the 'Apply for a refugee integration loan' and 'Accepting your integration loan' services.",
+  "intro-p2": "This website is run by the Home Office. We want as many people as possible to be able to use this website. For example, that means you should be able to:",
+  "intro-p2-li1": "change colours, contrast levels and fonts",
+  "intro-p2-li2": "zoom in up to 300% without the text spilling off the screen",
+  "intro-p2-li3": "navigate most of the website using just a keyboard",
+  "intro-p2-li4": "navigate most of the website using speech recognition software",
+  "intro-p2-li5": "listen to most of the website using a screen reader (including the most recent versions of JAWS, NVDA and VoiceOver)",
+  "intro-p3-pre-link": "We've also made the website text as simple as possible to understand.",
+  "intro-p3-link": "AbilityNet",
+  "intro-p3-post-link": "has advice on making your device easier to use if you have a disability.",
+  "how-accessible-header": "How accessible this website is",
+  "how-accessible-p1": "We know some parts of this website are not fully accessible",
+  "how-accessible-p1-li1": "some tables do not fit on the screen when zooming in",
+  "how-accessible-p1-li2": "session timeout cannot be changed",
+  "contact-email-operations": "integrationloan@homeoffice.gov.uk",
+  "contact-email-accessibility": "hof-accessibility@digital.homeoffice.gov.uk",
+  "reporting-header": "Reporting accessibility problems with this website",
+  "reporting-p1": "We're always looking to improve the accessibility of this website. If you find any problems not listed on this page or think we're not meeting accessibility requirements, contact:",
+  "reporting-p1-li1-pre-link": "Email:",
+  "reporting-p2-link": "Read tips on contacting organisations about inaccessible websites.",
+  "enforcement-header": "Enforcement procedure",
+  "enforcement-p1-pre-link": "The Equality and Human Rights Commission (EHRC) is responsible for enforcing the Public Sector Bodies (Websites and Mobile Applications) (No. 2) Accessibility Regulations 2018 (the 'accessibility regulations'). If you're not happy with how we respond to your complaint,",
+  "enforcement-p1-link": "contact the Equality Advisory and Support Service (EASS).",
+  "enforcement-p2": "If you are in Northern Ireland and are not happy with how we respond to your complaint you can contact the Equalities Commission for Northern Ireland who are responsible for enforcing the Public Sector Bodies (Websites and Mobile Applications) (No. 2) Accessibility Regulations 2018(the 'accessibility regulations') in Northern Ireland.",
+  "technical-info-header": "Technical information about this website's accessibility",
+  "technical-info-p1": "The Home Office is committed to making its website accessible, in accordance with the Public Sector Bodies (Websites and Mobile Applications) (No. 2) Accessibility Regulations 2018.",
+  "compliance-header": "Compliance status",
+  "compliance-p1": "This website is partially compliant with the <a href='https://www.w3.org/TR/WCAG21/'>Web Content Accessibility Guidelines version 2.1</a> AA standard, due to the non-compliances listed below.",
+  "non-accessible-header": "Non-accessible Content",
+  "non-accessible-p1": "The content listed below is non-accessible for the following reasons.",
+  "non-compliance-header": "Non-compliance with the accessibility regulations",
+  "non-compliance-li1": "The session timeout of 30 minutes cannot be changed and the user is not alerted when it is running out. This for each individual page of the form, not the form overall. This does not meet WCAG 2.2 Enough Time.",
+  "disproportionate-burden-header": "Disproportionate burden",
+  "disproportionate-burden-p1": "At this time, we have not made any disproportionate burden claims.",
+  "outside-scope-header": "Content that's not within the scope of the accessibility regulations",
+  "outside-scope-p1": "At this time, this service does not contain any content that is exempt from the regulations.",
+  "preparation-header": "Preparation of this accessibility statement",
+  "preparation-p1": "This statement was prepared on 1 June 2020. It was last reviewed on 14 January 2022.",
+  "preparation-p2": "This website was last tested on 13 August 2021. The test was carried out internally by the Home Office.",
+  "preparation-p3": "We tested the service based on a user's ability to complete key journeys. All parts of the chosen journeys were tested, including documents. Journeys were chosen on a number of factors including usage statistics, risk assessments and subject matter."
+}

package/frontend/template-partials/translations/src/en/base.json

@@ -1,4 +1,5 @@
 {
   "terms": "Terms and conditions",
-  "cookies": "Cookies"
+  "cookies": "Cookies",
+  "accessibility": "Accessibility statement"
 }

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

@@ -0,0 +1,55 @@
+{{<layout}}
+
+  {{$propositionHeader}}{{/propositionHeader}}
+
+  {{$header}}
+    {{header}}
+  {{/header}}
+
+  {{$content}}
+    <p class="govuk-body">{{#t}}accessibility.intro-p2{{/t}}</p>
+    <ul class="list list-bullet">
+        <li>{{#t}}accessibility.intro-p2-li1{{/t}}</li>
+        <li>{{#t}}accessibility.intro-p2-li2{{/t}}</li>
+        <li>{{#t}}accessibility.intro-p2-li3{{/t}}</li>
+        <li>{{#t}}accessibility.intro-p2-li4{{/t}}</li>
+        <li>{{#t}}accessibility.intro-p2-li5{{/t}}</li>
+    </ul>
+    <p class="govuk-body">{{#t}}accessibility.intro-p3-pre-link{{/t}} <a href="https://mcmw.abilitynet.org.uk/">{{#t}}accessibility.intro-p3-link{{/t}}</a> {{#t}}accessibility.intro-p3-post-link{{/t}}</p>
+    <h2 class="govuk-heading-m">{{#t}}accessibility.how-accessible-header{{/t}}</h2>
+    <p class="govuk-body">{{#t}}accessibility.how-accessible-p1{{/t}}</p>
+    <ul class="list list-bullet">
+        <li>{{#t}}accessibility.how-accessible-p1-li1{{/t}}</li>
+        <li>{{#t}}accessibility.how-accessible-p1-li2{{/t}}</li>
+    </ul>
+    <h2 class="govuk-heading-m">{{#t}}accessibility.reporting-header{{/t}}</h2>
+    <p class="govuk-body">{{#t}}accessibility.reporting-p1{{/t}}</p>
+    <ul class="list list-bullet">
+        <li>{{#t}}accessibility.reporting-p1-li1-pre-link{{/t}} <a href="mailto:{{#t}}accessibility.contact-email-accessibility{{/t}}">{{#t}}accessibility.contact-email-accessibility{{/t}}</a></li>
+    </ul>
+    <p class="govuk-body">
+        <a href="http://www.w3.org/WAI/users/inaccessible">{{#t}}accessibility.reporting-p2-link{{/t}}</a>
+    </p>
+    <h2 class="govuk-heading-m">{{#t}}accessibility.enforcement-header{{/t}}</h2>
+    <p class="govuk-body">{{#t}}accessibility.enforcement-p1-pre-link{{/t}} <a href ="https://www.equalityadvisoryservice.com/">{{#t}}accessibility.enforcement-p1-link{{/t}}</a></p>
+    <p class="govuk-body">{{#t}}accessibility.enforcement-p2{{/t}}</p>
+    <h2 class="govuk-heading-m">{{#t}}accessibility.technical-info-header{{/t}}</h2>
+    <p class="govuk-body">{{#t}}accessibility.technical-info-p1{{/t}}</p>
+    <h2 class="govuk-heading-m">{{#t}}accessibility.compliance-header{{/t}}</h2>
+    <p class="govuk-body">{{#t}}accessibility.compliance-p1{{/t}}</p>
+    <h2 class="govuk-heading-m">{{#t}}accessibility.non-accessible-header{{/t}}</h2>
+    <p class="govuk-body">{{#t}}accessibility.non-accessible-p1{{/t}}</p>
+    <h3 class="govuk-heading-m">{{#t}}accessibility.non-compliance-header{{/t}}</h3>
+    <ul class="list list-bullet">
+        <li>{{#t}}accessibility.non-compliance-li1{{/t}}</li>
+    </ul>
+    <h3 class="govuk-heading-m">{{#t}}accessibility.disproportionate-burden-header{{/t}}</h3>
+    <p class="govuk-body">{{#t}}accessibility.disproportionate-burden-p1{{/t}}</p>
+    <h3 class="govuk-heading-m">{{#t}}accessibility.outside-scope-header{{/t}}</h3>
+    <p class="govuk-body">{{#t}}accessibility.outside-scope-p1{{/t}}</p>
+    <h2 class="govuk-heading-m">{{#t}}accessibility.preparation-header{{/t}}</h2>
+    <p class="govuk-body">{{#t}}accessibility.preparation-p1{{/t}}</p>
+    <p class="govuk-body">{{#t}}accessibility.preparation-p2{{/t}}</p>
+    <p class="govuk-body">{{#t}}accessibility.preparation-p3{{/t}}</p>
+  {{/content}}
+{{/layout}}

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

@@ -44,6 +44,7 @@
       {{^footerSupportLinks}}
         <li><a href="/cookies">{{#t}}base.cookies{{/t}}</a></li>
         <li><a href="/terms-and-conditions">{{#t}}base.terms{{/t}}</a></li>
+        <li><a href="/accessibility">{{#t}}base.accessibility{{/t}}</a></li>
       {{/footerSupportLinks}}
     </ul>
   {{/footerSupportLinks}}

package/index.js

@@ -135,6 +135,7 @@ function bootstrap(options) {
   app.use((req, res, next) => {
     res.locals.nonce = crypto.randomBytes(16).toString('hex');
     res.locals.appName = config.appName;
+    res.locals.htmlLang = config.htmlLang;
     res.locals.cookieName = config.session.name;
     next();
   });
@@ -204,6 +205,16 @@ function bootstrap(options) {
   app.use(mixins());
   app.use(markdown(config.markdown));
 
+  if (config.getAccessibility === true) {
+    deprecate(
+      '`getAccessibility` option is deprecated and may be removed in future versions.',
+      'Use `pages` to define static cookies page.'
+    );
+    app.get('/accessibility', (req, res) => {
+      const locals = Object.assign({}, req.translate('accessibility'));
+      res.render('accessibility', locals);
+    });
+  }
   if (config.getCookies === true) {
     deprecate(
       '`getCookies` option is deprecated and may be removed in future versions.',

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hof",
   "description": "A bootstrap for HOF projects",
-  "version": "19.11.24",
+  "version": "19.12.2",
   "license": "MIT",
   "main": "index.js",
   "author": "HomeOffice",
@@ -55,7 +55,7 @@
     "express-partial-templates": "^0.2.0",
     "express-session": "^1.13.0",
     "findup": "^0.1.5",
-    "glob": "^7.1.7",
+    "glob": "^7.2.0",
     "govuk-elements-sass": "^3.1.3",
     "govuk_template_mustache": "^0.26.0",
     "helmet": "^3.22.0",