npm - hof - Versions diffs - 22.8.4 → 22.9.0-beta - Mend

hof 22.8.4 → 22.9.0-beta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (326) hide show

package/package/components/emailer/transports/smtp.js ADDED Viewed

@@ -0,0 +1,26 @@
+'use strict';
+const smtp = require('nodemailer');
+module.exports = options => {
+  if (!options.host) {
+    throw new Error('Required option `host` not found');
+  }
+  if (!options.port) {
+    throw new Error('Required option `port` not found');
+  }
+  const opts = {
+    host: options.host,
+    port: options.port
+  };
+  opts.ignoreTLS = options.ignoreTLS === true;
+  opts.secure = options.secure !== false;
+  if (options.auth && options.auth.user && options.auth.pass) {
+    opts.auth = options.auth;
+  }
+  return smtp(opts);
+};

package/package/components/emailer/transports/stub.js ADDED Viewed

@@ -0,0 +1,5 @@
+'use strict';
+const stub = require('nodemailer-stub-transport');
+module.exports = () => stub();

package/package/components/emailer/views/layout.html ADDED Viewed

@@ -0,0 +1,63 @@
+<!doctype html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+    <meta content="utf-8" http-equiv="encoding" />
+    <!-- Use title if it's in the page YAML frontmatter -->
+    <title>{{subject}}</title>
+  </head>
+  <body style="font-family: Helvetica, Arial, sans-serif;font-size: 16px;margin: 0;color:#0b0c0c">
+    <table width="100%" cellpadding="0" cellspacing="0" border="0">
+      <tr>
+        <td width="100%" height="53px" bgcolor="#0b0c0c">
+          <table width="580" cellpadding="0" cellspacing="0" border="0" align="center">
+            <tr>
+              <td width="100%" bgcolor="#0b0c0c" valign="middle">
+                <img width="152" height="31" src="cid:govuk_logotype_email" alt="GOV.UK" border="0" />
+              </td>
+            </tr>
+          </table>
+        </td>
+      </tr>
+    </table>
+    <table width="100%" cellpadding="0" cellspacing="0" border="0" bgcolor="#FFFFFF">
+      <tr>
+        <td width="100%">
+          <table width="580" cellpadding="0" cellspacing="0" border="0" align="center">
+            <tr>
+              <td width="100%" class="header" style="padding-top: 10px;" colspan="2">
+                <table width="100%" cellpadding="0" cellspacing="0" border="0" bgcolor="#FFFFFF">
+                  <tr>
+                    <td width="6" style="border-left: 2px solid #009390;"><img src="cid:spacer_image" alt="" width="6px" height="26px" style="display: block;" /></td>
+                    <td width="27" height="50"><img src="cid:ho_crest_27px" alt="Home Office Logo" style="width: 27px; height: 50px; display:block;" /></td>
+                    <td width="7"><img src="cid:spacer_image" alt="" width="7px" height="26px" style="display: block;" /></td>
+                    <td style="font-family: Helvetica, Arial, sans-serif;">
+                      <h2 class="organisation-logo" style="font-size: 18px; line-height: 20px; font-weight: 300; margin: 0"><span>UK Home Office</span></h2>
+                    </td>
+                  </tr>
+                </table>
+              </td>
+            </tr>
+            <tr>
+              <td style="font-family: Helvetica, Arial, sans-serif;">
+                <p style="font-weight: 700;font-size: 16px;line-height: 1 ;margin: 10px 0 10px 0;">&nbsp;</p>
+              </td>
+            </tr>
+            <tr>
+              <td style="font-family: Helvetica, Arial, sans-serif;">
+                <p style="font-size: 19px; font-weight: bold; color: #000; line-height: 1.32; margin: 0 0 10px 0;">
+                  {{subject}}
+                <p>
+                <div style="margin: 0 0 20px 0;">
+                  {{{body}}}
+                </div>
+              </td>
+            </tr>
+          </table>
+        </td>
+        <td width="25%">&nbsp;</td>
+      </tr>
+    </table>
+  </body>
+</html>

package/package/components/homeoffice-countries/index.js ADDED Viewed

@@ -0,0 +1,22 @@
+const _ = require('lodash');
+const componentDefaults = require('../../config/component-defaults');
+module.exports = superclass => class extends superclass {
+  configure(req, res, next) {
+    const homeOfficeCountries = [''].concat(require('homeoffice-countries').allCountries);
+    const nationalityFields = componentDefaults.homeOfficeCountries;
+    nationalityFields.forEach(field => {
+      if (_.get(req, `form.options.fields[${field}].options`)) {
+        req.form.options.fields[field].options = homeOfficeCountries.map(country => {
+          const labelString = country !== '' ? country : 'Please select a country';
+          return { label: labelString, value: country };
+        });
+      }
+    });
+    next();
+  }
+};

package/package/components/index.js ADDED Viewed

@@ -0,0 +1,13 @@
+'use strict';
+module.exports = {
+  addressLookup: require('./address-lookup'),
+  clearSession: require('./clear-session'),
+  combineAndLoopFields: require('./combine-and-loop-fields'),
+  date: require('./date'),
+  emailer: require('./emailer'),
+  homeOfficeCountries: require('./homeoffice-countries'),
+  notify: require('./notify'),
+  summary: require('./summary'),
+  sessionTimeoutWarning: require('./session-timeout-warning')
+};

package/package/components/notify/index.js ADDED Viewed

@@ -0,0 +1,62 @@
+'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;
+          }
+          if (config.attachment && config.attachment !== undefined) {
+            settings.attachment = config.attachment(req.sessionModel.toJSON(), req.translate);
+          }
+          return settings;
+        })
+        .then(settings => {
+          return notify.send(settings);
+        })
+        .then(() => {
+          super.successHandler(req, res, next);
+        }, next);
+    }
+  };
+};
+module.exports.Notify = Notify;

package/package/components/notify/notify.js ADDED Viewed

@@ -0,0 +1,51 @@
+'use strict';
+const NotifyClient = require('notifications-node-client').NotifyClient;
+const { v4: uuidv4 } = require('uuid');
+const config = require('../../config/hof-defaults');
+const logger = require('../../lib/logger');
+module.exports = class Notify {
+  constructor(opts) {
+    const options = opts || {};
+    this.options = options;
+    this.logger = logger(config);
+    this.notifyClient =  new NotifyClient(options.notifyApiKey);
+    this.notifyTemplate = options.notifyTemplate;
+  }
+  async sendEmail(templateId, recipient, personalisation) {
+    const reference = uuidv4();
+    try {
+      await this.notifyClient.sendEmail(templateId, recipient, {
+        personalisation: personalisation,
+        reference });
+      this.logger.log('info', 'Email sent');
+    } catch (error) {
+      this.logger.log('error', error.response ? error.response.data : error.message);
+      throw new Error(error.response ? error.response.data : error.message);
+    }
+  }
+  async send(email) {
+    let personalisation = {
+      'email-subject': email.subject,
+      'email-body': email.body
+    };
+    if (email.attachment && email.attachment !== undefined) {
+      personalisation = Object.assign({'email-attachment':
+        this.notifyClient.prepareUpload(email.attachment)}, personalisation);
+    }
+    try {
+      await this.sendEmail(this.notifyTemplate, email.recipient, personalisation);
+    } catch (error) {
+      this.logger.log('error', error.response ? error.response.data : error.message);
+      throw new Error(error.response ? error.response.data : error.message);
+    }
+  }
+};
+module.exports.NotifyClient = NotifyClient;

package/package/components/session-timeout-warning/index.js ADDED Viewed

@@ -0,0 +1,67 @@
+/**
+ *
+ * @fileOverview
+ * Provides custom behavior for handling session timeout warnings and exit actions. This includes
+ * - Resetting the session if the user exits due to a session timeout.
+ * - Customizing the session timeout warning dialog content.
+ * - Setting custom content and titles on the exit page.
+ *
+ * @module SessionTimeoutWarningBehavior
+ * @requires ../../config/hof-defaults
+ * @param {Class} superclass - The class to be extended.
+ * @returns {Class} - The extended class with session timeout handling functionality.
+ */
+'use strict';
+const config = require('../../config/hof-defaults');
+const logger = require('../../lib/logger')(config);
+module.exports = superclass => class extends superclass {
+  configure(req, res, next) {
+    try {
+      // Reset the session if the user chooses to exit on session timeout warning
+      if (req.form.options.route === '/exit') {
+        req.sessionModel.reset();
+        logger.log('info', 'Session has been reset on exit');
+      }
+      return super.configure(req, res, next);
+    } catch (error) {
+      logger.error('Error during session reset:', error);
+      return next(error); // Pass the error to the next middleware for centralised handling
+    }
+  }
+  locals(req, res) {
+    // set the custom session dialog message
+    const superLocals = super.locals(req, res);
+    if (res.locals.sessionTimeoutWarningContent === true) {
+      superLocals.dialogTitle = true;
+      superLocals.dialogText = true;
+      superLocals.timeoutContinueButton = true;
+      superLocals.dialogExitLink = true;
+    }
+    // set the content on /exit page
+    if (req.form.options.route === '/exit' && config.exitFormContent === true) {
+      superLocals.exitFormContent = true;
+      return superLocals;
+    } else if (req.form.options.route === '/exit' && config.exitFormContent === false) {
+      superLocals.header = req.translate('exit.header');
+      superLocals.title = req.translate('exit.title');
+      superLocals.message = req.translate('exit.message');
+      return superLocals;
+    }
+    // set the content on /save-and-exit page
+    if (req.form.options.route === '/save-and-exit' && config.saveExitFormContent === true) {
+      superLocals.saveExitFormContent = true;
+      return superLocals;
+    } else if (req.form.options.route === '/save-and-exit' && config.saveExitFormContent === false) {
+      superLocals.header = req.translate('save-and-exit.header');
+      superLocals.title = req.translate('save-and-exit.title');
+      superLocals.message = req.translate('save-and-exit.message');
+      return superLocals;
+    }
+    return superLocals;
+  }
+};

package/package/components/summary/index.js ADDED Viewed

@@ -0,0 +1,237 @@
+'use strict';
+const config = require('../../config/rate-limits');
+const rateLimiter = require('../../middleware/rate-limiter');
+const concat = (x, y) => x.concat(y);
+const flatMap = (f, xs) => xs.map(f).reduce(concat, []);
+module.exports = SuperClass => class extends SuperClass {
+  getSectionSettings(settings) {
+    if (settings.sections) {
+      return settings.sections;
+    }
+    return Object.keys(settings.steps).reduce((map, key) => {
+      const fields = settings.steps[key].fields;
+      if (fields) {
+        map[key.replace(/^\//, '')] = fields;
+      }
+      return map;
+    }, {});
+  }
+  getRowsForSummarySections(req) {
+    const settings = req.form.options;
+    const sections = this.getSectionSettings(settings);
+    return Object.keys(sections)
+      .map(section => {
+        const fieldsInSection = sections[section].steps || sections[section];
+        const omitFromPdf = sections[section].omitFromPdf || false;
+        return {
+          section: req.translate([
+            `pages.confirm.sections.${section}.header`,
+            `pages.${section}.header`
+          ]),
+          fields: this.getFieldsForRow(fieldsInSection, req),
+          omitFromPdf
+        };
+      })
+      .filter(section => section.fields.length);
+  }
+  getFieldsForRow(section, req) {
+    const fieldsSpecifications = section || [];
+    let populatedFields =
+      fieldsSpecifications.map(fieldSpec => {
+        let fieldData = {};
+        const multipleRows = fieldSpec.multipleRowsFromAggregate;
+        const useOriginalValue = fieldSpec.useOriginalValue;
+        if (typeof fieldSpec === 'string' || multipleRows) {
+          fieldData = this.getFieldData(fieldSpec, req, useOriginalValue);
+        } else if (this.dependencySatisfied(fieldSpec, req)) {
+          fieldData = Object.assign(this.getFieldData(fieldSpec.field, req, useOriginalValue), fieldSpec);
+        }
+        if (!multipleRows) {
+          fieldData.value = fieldSpec.derivation ?
+            this.runCombinerForDerivedField(fieldSpec, req) : fieldData.value;
+          fieldData.value = (typeof fieldSpec.parse === 'function') ?
+            fieldSpec.parse(fieldData.value, req) : fieldData.value;
+        }
+        return fieldData;
+      }).filter(f => f.value || Array.isArray(f));
+    populatedFields = flatMap(populatedField => {
+      if (populatedField.value && populatedField.value.aggregatedValues) {
+        return this.expandAggregatedFields(populatedField, req);
+      }
+      return populatedField;
+    }, populatedFields);
+    return populatedFields;
+  }
+  runCombinerForDerivedField(fieldSpec, req) {
+    const obj = Object.assign(this.getFieldData(fieldSpec.field, req), fieldSpec);
+    const values = fieldSpec.derivation.fromFields
+      .map(field => req.sessionModel.get(field)).filter(field => field && field.length > 0);
+    if (values.length > 0) {
+      obj.value = fieldSpec.derivation.combiner(values);
+    }
+    return obj.value;
+  }
+  dependencySatisfied(fieldSpec, req) {
+    if (fieldSpec.dependsOn) {
+      const dependencyValue = req.sessionModel.get(fieldSpec.dependsOn);
+      if (!dependencyValue || dependencyValue === 'no') {
+        return false;
+      }
+    }
+    return true;
+  }
+  expandAggregatedFields(obj, req) {
+    return flatMap((element, index) => {
+      const fields = flatMap(inner => {
+        const changeField = inner.changeField || inner.field;
+        const changeLink = `${req.baseUrl}${obj.step}/edit/${index}/${changeField}?returnToSummary=true`;
+        return Object.assign({}, inner, {
+          changeLinkDescription: this.translateChangeLink(inner.field, req),
+          value: inner.parsed || inner.value,
+          label: this.translateLabel(inner.field, req),
+          changeLink,
+          index
+        });
+      }, element.fields);
+      if (obj.addElementSeparators && index < obj.value.aggregatedValues.length - 1) {
+        fields.push({ label: '', value: 'separator', changeLink: '', isSeparator: true });
+      }
+      return fields;
+    }, obj.value.aggregatedValues);
+  }
+  getStepForField(key, steps) {
+    const keyName = Array.isArray(key) ? key[0] : key;
+    return Object.keys(steps).filter(step => steps[step].fields && steps[step].fields.indexOf(keyName) > -1)[0];
+  }
+  translateLabel(key, req) {
+    return req.translate([
+      `pages.confirm.fields.${key}.label`,
+      `fields.${key}.label`,
+      `fields.${key}.legend`
+    ]);
+  }
+  translateChangeLink(key, req) {
+    return req.translate([`fields.${key}.changeLinkDescription`,
+      `pages.confirm.fields.${key}.label`,
+      `fields.${key}.summary`,
+      `fields.${key}.label`,
+      `fields.${key}.legend`]);
+  }
+  translateCheckBoxOptions(key, value, req) {
+    if (Array.isArray(value)) {
+      return value.map(val => this.translateCheckBoxOptions(key, val, req));
+    }
+    return req.translate(`fields[${key}].options.[${value}]`);
+  }
+  getFieldData(key, req, useOriginalValue) {
+    if (this.isCheckbox(key, req)) {
+      return this.parseCheckBoxField(key, req, useOriginalValue);
+    }
+    return key.multipleRowsFromAggregate ?
+      this.parseMultipleFields(key, req) :
+      this.parseSingleField(key, req);
+  }
+  isCheckbox(key, req) {
+    return req.sessionModel.get(key) && req.form.options.fieldsConfig[key] &&
+      (req.form.options.fieldsConfig[key].mixin === 'checkbox-group' ||
+        req.form.options.fieldsConfig[key].mixin === 'radio-group');
+  }
+  parseCheckBoxField(key, req, useOriginalValue) {
+    let value = req.sessionModel.get(key);
+    const step = this.getStepForField(key, req.form.options.steps);
+    const changeLink = `${req.baseUrl}${step}/edit#${key}-${value}`;
+    value = useOriginalValue ? value : this.translateCheckBoxOptions(key, value, req);
+    return {
+      changeLinkDescription: this.translateChangeLink(key, req),
+      label: this.translateLabel(key, req),
+      value,
+      step,
+      field: key,
+      changeLink
+    };
+  }
+  parseMultipleFields(key, req) {
+    const multipleRows = key.multipleRowsFromAggregate;
+    const labelCategory = multipleRows.labelCategory;
+    const valueCategory = multipleRows.valueCategory;
+    const translationValue = multipleRows.valueTranslation || multipleRows.valueCategory;
+    return req.sessionModel.get(key.field).map(input => {
+      return {
+        field: key.field,
+        step: key.step,
+        changeLinkDescription: this.translateChangeLink(key.field, req),
+        label: input[labelCategory],
+        value: [].concat(input[valueCategory])
+          .map(category => req.translate(`fields.${translationValue}.options.${category}.label`))
+          .join('\n')
+      };
+    }).filter(f => f.value);
+  }
+  parseSingleField(key, req) {
+    return {
+      changeLinkDescription: this.translateChangeLink(key, req),
+      label: this.translateLabel(key, req),
+      value: req.sessionModel.get(key),
+      step: this.getStepForField(key, req.form.options.steps),
+      field: key
+    };
+  }
+  locals(req, res) {
+    req.sessionModel.unset('returnToSummary');
+    const rows = this.getRowsForSummarySections(req);
+    return Object.assign({}, super.locals(req, res), {
+      rows
+    });
+  }
+  validate(req, res, next) {
+    if (!config.rateLimits.submissions.active) {
+      return super.validate(req, res, next);
+    }
+    // how do we stop this ballsing up our tests??????
+    const options = Object.assign({}, config, { logger: req });
+    return rateLimiter(options, 'submissions')(req, res, err => {
+      if (err) {
+        return next(err);
+      }
+      return super.validate(req, res, next);
+    });
+  }
+};

package/package/config/builder-defaults.js ADDED Viewed

@@ -0,0 +1,45 @@
+'use strict';
+module.exports = {
+  browserify: {
+    src: 'assets/js/index.js',
+    out: 'public/js/bundle.js',
+    match: 'assets/js/**/*.js',
+    restart: false,
+    compress: false,
+    debug: false
+  },
+  sass: {
+    src: 'assets/scss/app.scss',
+    out: 'public/css/app.css',
+    match: 'assets/scss/**/*.scss',
+    restart: false,
+    quietDeps: false,
+    outputStyle: 'expanded',
+    sourceMaps: false
+  },
+  translate: {
+    src: 'apps/**/translations/src',
+    match: 'apps/**/translations/src/**/*.json',
+    shared: 'apps/common/translations/src'
+  },
+  images: {
+    src: 'assets/images',
+    out: 'public',
+    match: 'assets/images/**/*',
+    restart: false
+  },
+  server: {
+    cmd: 'npm start',
+    extensions: ['.js', '.json', '.html', '.md']
+  },
+  watch: {
+    restart: 'rs',
+    ignore: [
+      '*.log',
+      '.git',
+      'coverage',
+      'public'
+    ]
+  }
+};

package/package/config/component-defaults.js ADDED Viewed

@@ -0,0 +1,13 @@
+module.exports = {
+  homeOfficeCountries: [
+    'nationality',
+    'former-nationality',
+    'dual-nationality',
+    'nominated-nationality',
+    'nationality-error',
+    'country',
+    'country-of-birth',
+    'someone-else-nationality'
+  ]
+};

package/package/config/hof-defaults.js ADDED Viewed

@@ -0,0 +1,65 @@
+'use strict';
+/* eslint no-process-env: "off" */
+const rateLimits = require('./rate-limits');
+const Helper = require('../utilities/helpers');
+const parseBoolean = Helper.getEnvBoolean;
+const defaults = {
+  appName: process.env.APP_NAME || 'HOF Application',
+  htmlLang: 'en',
+  root: process.cwd(),
+  translations: 'translations',
+  start: true,
+  csp: {
+    disabled: parseBoolean(process.env.DISABLE_CSP, false, 'DISABLE_CSP')
+  },
+  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,
+  host: process.env.HOST || '0.0.0.0',
+  port: process.env.PORT || '8080',
+  env: process.env.NODE_ENV || 'development',
+  gaTagId: process.env.GA_TAG,
+  ga4TagId: process.env.GA_4_TAG,
+  showCookiesBanner: parseBoolean(
+    process.env.SHOW_COOKIES_BANNER,
+    Boolean(process.env.GA_TAG || process.env.GA_4_TAG),
+    'SHOW_COOKIES_BANNER'
+  ),
+  // added to allow support for multiple HOF forms using GTM to customize how they track page views
+  gtm: {
+    tagId: process.env.GTM_TAG || false,
+    config: {},
+    composePageName: function (page, convertPage) {
+      return convertPage(page);
+    }
+  },
+  deIndexForm: process.env.DEINDEX_FORM || 'false',
+  gaCrossDomainTrackingTagId: process.env.GDS_CROSS_DOMAIN_GA_TAG,
+  loglevel: process.env.LOG_LEVEL || 'info',
+  ignoreMiddlewareLogs: ['/healthz'],
+  redis: {
+    port: process.env.REDIS_PORT || '6379',
+    host: process.env.REDIS_HOST || '127.0.0.1'
+  },
+  session: {
+    ttl: process.env.SESSION_TTL || 1800,
+    secret: process.env.SESSION_SECRET || 'changethis',
+    name: process.env.SESSION_NAME || 'hod.sid',
+    sanitiseInputs: false
+  },
+  apis: {
+    pdfConverter: process.env.PDF_CONVERTER_URL
+  },
+  serveStatic: process.env.SERVE_STATIC_FILES !== 'false',
+  sessionTimeOutWarning: process.env.SESSION_TIMEOUT_WARNING || 300,
+  serviceUnavailable: parseBoolean(process.env.SERVICE_UNAVAILABLE, false, 'SERVICE_UNAVAILABLE')
+};
+module.exports = Object.assign({}, defaults, rateLimits);