@govuk-pay/pay-js-commons 3.8.4 → 3.8.5

package/.idea/codeStyles/Project.xml

@@ -0,0 +1,7 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <ScalaCodeStyleSettings>
+      <option name="MULTILINE_STRING_CLOSING_QUOTES_ON_NEW_LINE" value="true" />
+    </ScalaCodeStyleSettings>
+  </code_scheme>
+</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="PREFERRED_PROJECT_CODE_STYLE" value="Default" />
+  </state>
+</component>

package/.idea/misc.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="MavenImportPreferences">
+    <option name="generalSettings">
+      <MavenGeneralSettings>
+        <option name="mavenHome" value="$APPLICATION_HOME_DIR$/plugins/maven/lib/maven3" />
+      </MavenGeneralSettings>
+    </option>
+  </component>
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_11" project-jdk-name="11" project-jdk-type="JavaSDK">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/pay-js-commons.iml" filepath="$PROJECT_DIR$/.idea/pay-js-commons.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/pay-js-commons.iml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/lib/analytics/cookies/validate.js

@@ -1,23 +1,31 @@
 "use strict";
 
 var fs = require('fs');
+
 var Cookies = require('js-cookie');
+
 var path = require('path');
+
 var template = fs.readFileSync(path.join(__dirname, 'banner.html'), 'utf-8');
 var GOVUK_PAY_ANALYTICS_CONSENT_COOKIE_NAME = 'govuk_pay_cookie_policy';
 var ANALYTICS_CONSENT_BANNER_ID = 'pay-cookie-banner';
+
 function hasAnalyticsConsent() {
   var cookie = Cookies.get(GOVUK_PAY_ANALYTICS_CONSENT_COOKIE_NAME);
   var parsed = cookie && JSON.parse(cookie);
   return Boolean(parsed) && parsed.analytics === true;
 }
+
 function getCookieDomain() {
   var PROD_HOSTNAME = 'payments.service.gov.uk';
+
   if (window.location.hostname.includes(PROD_HOSTNAME)) {
     return PROD_HOSTNAME;
   }
+
   return undefined;
 }
+
 function setAnalyticsCookie() {
   var userConsentedToAnalytics = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
   var cookieValue = JSON.stringify({
@@ -30,15 +38,19 @@ function setAnalyticsCookie() {
   };
   Cookies.set(GOVUK_PAY_ANALYTICS_CONSENT_COOKIE_NAME, cookieValue, cookieAttributes);
 }
+
 function hideBannerIfExists(event) {
   var banner = document.querySelector("#".concat(ANALYTICS_CONSENT_BANNER_ID));
+
   if (banner) {
     banner.style.display = 'none';
   }
+
   if (event.target) {
     event.preventDefault();
   }
 }
+
 function showConfirmationMessage(analyticsConsent) {
   var messagePrefix = analyticsConsent ? 'You’ve accepted analytics cookies.' : 'You told us not to use analytics cookies.';
   var $cookieBannerMainContent = document.querySelector('.pay-cookie-banner__wrapper');
@@ -48,14 +60,17 @@ function showConfirmationMessage(analyticsConsent) {
   var $cookieBannerConfirmationWrapper = document.querySelector('.pay-cookie-banner__confirmation');
   $cookieBannerConfirmationWrapper.style.display = 'block';
 }
+
 function acceptAnalyticsCookies() {
   setAnalyticsCookie(true);
   showConfirmationMessage(true);
 }
+
 function rejectAnalyticsCookies() {
   setAnalyticsCookie(false);
   showConfirmationMessage(false);
 }
+
 function createBannerHTMLElement() {
   var consentProvidedCallback = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : function () {};
   var banner = document.createElement('div');
@@ -63,31 +78,39 @@ function createBannerHTMLElement() {
   banner.innerHTML = template.trim();
   var acceptButton = banner.querySelector('button[data-accept-cookies=true]');
   var rejectButton = banner.querySelector('button[data-accept-cookies=false]');
+
   if (acceptButton && rejectButton) {
     acceptButton.addEventListener('click', acceptAnalyticsCookies);
     acceptButton.addEventListener('click', consentProvidedCallback);
     rejectButton.addEventListener('click', rejectAnalyticsCookies);
   }
+
   var hideCookieBannerLink = banner.querySelector('button[data-hide-cookie-banner]');
+
   if (hideCookieBannerLink) {
     hideCookieBannerLink.addEventListener('click', hideBannerIfExists);
   }
+
   return banner;
 }
-
 /**
  * ConsentProvidedCallback: function - generic callback that will be called
  *                                     if and only if the user provides consent
  */
+
+
 function showBannerIfConsentNotSet() {
   var consentProvidedCallback = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : function () {};
   var consentCookieNotSet = !Cookies.get(GOVUK_PAY_ANALYTICS_CONSENT_COOKIE_NAME);
   var banner = document.querySelector("#".concat(ANALYTICS_CONSENT_BANNER_ID));
+
   if (consentCookieNotSet && !banner) {
     var _banner = createBannerHTMLElement(consentProvidedCallback);
+
     document.body.prepend(_banner);
   }
 }
+
 module.exports = {
   hasAnalyticsConsent: hasAnalyticsConsent,
   showBannerIfConsentNotSet: showBannerIfConsentNotSet

package/lib/analytics/dist/cookies.js

@@ -870,22 +870,29 @@ process.umask = function() { return 0; };
 "use strict";
 
 var Cookies = require('js-cookie');
+
 var path = require('path');
+
 var template = "<style>\n\t/* component should only be shown if JS is available, by the cookieMessage JS, so hide by default */\n\t.pay-cookie-banner {\n\t\tdisplay: block;\n\t}\n\n\t.pay-cookie-banner__wrapper {\n\t\tpadding-top: 15px;\n    \tpadding-bottom: 15px;\n\t}\n\n\t.pay-cookie-banner__buttons {\n\t\tdisplay: flex;\n\t\tflex-wrap: wrap;\n\t}\n\n\t@media (min-width: 40.0625em){\n\t\t.pay-cookie-banner__buttons {\n\t\t\tflex-wrap: nowrap;\n\t\t}\n\t}\n\n\n\t.pay-cookie-banner__button,\n\t.pay-cookie-banner__link {\n\t\tvertical-align: baseline;\n\t}\n\n\t.pay-cookie-banner__button {\n\t\tdisplay: inline-block;\n\t\tflex: 1 0;\n\t\tpadding-left: 60px;\n\t\tpadding-right: 60px;\n\t\tmargin-bottom: 10px;\n\t\tmargin-right: 20px;\n\t}\n\n\t@media (min-width: 40.0625em){\n\t\t.pay-cookie-banner__button {\n\t\t\tflex: 0 0 150px;\n\t\t\tpadding-left: 10px;\n\t\t\tpadding-right: 10px;\n\t\t\tmargin-bottom: 5px;\n\t\t}\n\t}\n\t\n\t.pay-cookie-banner__link {\n\t\tfont-family: \"GDS Transport\", Arial, sans-serif;\n\t\tfont-weight: 400;\n\t\tfont-size: 16px;\n\t\tfont-size: 1rem;\n\t\tline-height: 1.25;\n\t\tline-height: 1;\n\t\tdisplay: block;\n\t\twidth: 100%;\n\t    padding: 9px 0px 6px;\n\t}\n\t\n\t@media (min-width: 40.0625em){\n\t\t.pay-cookie-banner__link {\n\t\t\tdisplay: inline;\n\t\t\twidth: auto;\n\t\t\tmargin-left: 30px;\n\t\t}\n\t}\n\n\n\t.pay-cookie-banner__confirmation {\n\t\tdisplay: none;\n\t\tposition: relative;\n\t\tpadding: 20px 0;\n\n\t\t\n\t}\n\n\t/* This element is focused using JavaScript so that it's being read out by screen readers\n\tor this reason we don't want to show the default outline or emphasise it visually using `govuk-focused-text`*/\n\t.pay-cookie-banner__confirmation:focus {\n\t    outline: none;\n\t}\n\n\n\t.pay-cookie-banner__confirmation-message,\n\t.pay-cookie-banner__hide-button {\n\t\tdisplay: block;\n\t}\n\n\n\t@media (min-width: 48.0625em){\n\t\t.pay-cookie-banner__confirmation-message, \n\t\t.pay-cookie-banner__hide-button {\n\t\t    display: inline-block;\n\t\t}\n\t}\n\n\t.pay-cookie-banner__confirmation-message {\n\t\tmargin-right: 20px;\n\t}\n\n\t@media (min-width: 48.0625em){\n\t\t.pay-cookie-banner__confirmation-message {\n\t\t\tmax-width: 90%;\n\t\t}\n\t}\n\n\t.pay-cookie-banner__hide-button {\n\t\tfont-family: \"GDS Transport\", Arial, sans-serif;\n\t\tfont-weight: 400;\n\t\tfont-size: 16px;\n\t\tfont-size: 1rem;\n\t\tline-height: 1.25;\n\t\tcolor: #1d70b8;\n\t\toutline: 0;\n\t\tborder: 0;\n\t\tbackground: none;\n\t\ttext-decoration: underline;\n\t\tpadding: 0;\n\t\tmargin-top: 10px;\n\t\tright: 15px;\n\t\tcursor: pointer;\n\t}\n\n\t@media (min-width: 40.0625em){\n\t\t.pay-cookie-banner__hide-button {\n\t\t\tfont-size: 19px;\n\t\t\tfont-size: 1.1875rem;\n\t\t\tline-height: 1.3157894737;\n\t\t}\n\t}\n</style>\n<div id=\"pay-cookie-banner\" class=\"pay-cookie-banner govuk-width-container\" data-module=\"pay-cookie-banner\" role=\"region\" aria-label=\"cookie banner\">\n\t<div class=\"pay-cookie-banner__wrapper\">\n\t\t<h2 class=\"pay-cookie-banner__heading govuk-heading-m\" id=\"pay-cookie-banner__heading\">\n\t\t\tCan we store analytics cookies on your device?\n\t\t</h2>\n\t\t<p class=\"govuk-body\">\n\t\t\tAnalytics cookies help us understand how our website is being used.\n\t\t</p>\n\t\t<div class=\"pay-cookie-banner__buttons\">\n\t\t\t<button class=\"govuk-button pay-cookie-banner__button pay-cookie-banner__button--accept\" type=\"submit\" data-accept-cookies=\"true\" aria-describedby=\"pay-cookie-banner__heading\">\n\t\t\t\tYes<span class=\"govuk-visually-hidden\">, GOV.UK Pay can store analytics cookies on your device</span>\n\t\t\t</button>\n\t\t\t<button class=\"govuk-button pay-cookie-banner__button pay-cookie-banner__button--reject\" type=\"submit\" data-accept-cookies=\"false\" aria-describedby=\"pay-cookie-banner__heading\">\n\t\t\t\tNo<span class=\"govuk-visually-hidden\">, GOV.UK Pay cannot store analytics cookies on your device</span>\n\t\t\t</button>\n\t\t\t<a class=\"govuk-link pay-cookie-banner__link\" href=\"https://www.payments.service.gov.uk/cookies\">How GOV.UK Pay uses cookies</a>\n\t\t</div>\n\t</div>\n\n\t<div class=\"pay-cookie-banner__confirmation\" tabindex=\"-1\">\n\t\t<p class=\"pay-cookie-banner__confirmation-message govuk-body\">\n\t\t\tYou can <a class=\"govuk-link\" href=\"https://www.payments.service.gov.uk/cookies/\">change your cookie settings</a> at any time.\n\t\t</p>\n\t\t<button class=\"pay-cookie-banner__hide-button govuk-link\" data-hide-cookie-banner=\"true\" role=\"link\">Hide</button>\n\t</div>\n</div>\n";
 var GOVUK_PAY_ANALYTICS_CONSENT_COOKIE_NAME = 'govuk_pay_cookie_policy';
 var ANALYTICS_CONSENT_BANNER_ID = 'pay-cookie-banner';
+
 function hasAnalyticsConsent() {
   var cookie = Cookies.get(GOVUK_PAY_ANALYTICS_CONSENT_COOKIE_NAME);
   var parsed = cookie && JSON.parse(cookie);
   return Boolean(parsed) && parsed.analytics === true;
 }
+
 function getCookieDomain() {
   var PROD_HOSTNAME = 'payments.service.gov.uk';
+
   if (window.location.hostname.includes(PROD_HOSTNAME)) {
     return PROD_HOSTNAME;
   }
+
   return undefined;
 }
+
 function setAnalyticsCookie() {
   var userConsentedToAnalytics = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
   var cookieValue = JSON.stringify({
@@ -898,15 +905,19 @@ function setAnalyticsCookie() {
   };
   Cookies.set(GOVUK_PAY_ANALYTICS_CONSENT_COOKIE_NAME, cookieValue, cookieAttributes);
 }
+
 function hideBannerIfExists(event) {
   var banner = document.querySelector("#".concat(ANALYTICS_CONSENT_BANNER_ID));
+
   if (banner) {
     banner.style.display = 'none';
   }
+
   if (event.target) {
     event.preventDefault();
   }
 }
+
 function showConfirmationMessage(analyticsConsent) {
   var messagePrefix = analyticsConsent ? 'You’ve accepted analytics cookies.' : 'You told us not to use analytics cookies.';
   var $cookieBannerMainContent = document.querySelector('.pay-cookie-banner__wrapper');
@@ -916,14 +927,17 @@ function showConfirmationMessage(analyticsConsent) {
   var $cookieBannerConfirmationWrapper = document.querySelector('.pay-cookie-banner__confirmation');
   $cookieBannerConfirmationWrapper.style.display = 'block';
 }
+
 function acceptAnalyticsCookies() {
   setAnalyticsCookie(true);
   showConfirmationMessage(true);
 }
+
 function rejectAnalyticsCookies() {
   setAnalyticsCookie(false);
   showConfirmationMessage(false);
 }
+
 function createBannerHTMLElement() {
   var consentProvidedCallback = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : function () {};
   var banner = document.createElement('div');
@@ -931,31 +945,39 @@ function createBannerHTMLElement() {
   banner.innerHTML = template.trim();
   var acceptButton = banner.querySelector('button[data-accept-cookies=true]');
   var rejectButton = banner.querySelector('button[data-accept-cookies=false]');
+
   if (acceptButton && rejectButton) {
     acceptButton.addEventListener('click', acceptAnalyticsCookies);
     acceptButton.addEventListener('click', consentProvidedCallback);
     rejectButton.addEventListener('click', rejectAnalyticsCookies);
   }
+
   var hideCookieBannerLink = banner.querySelector('button[data-hide-cookie-banner]');
+
   if (hideCookieBannerLink) {
     hideCookieBannerLink.addEventListener('click', hideBannerIfExists);
   }
+
   return banner;
 }
-
 /**
  * ConsentProvidedCallback: function - generic callback that will be called
  *                                     if and only if the user provides consent
  */
+
+
 function showBannerIfConsentNotSet() {
   var consentProvidedCallback = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : function () {};
   var consentCookieNotSet = !Cookies.get(GOVUK_PAY_ANALYTICS_CONSENT_COOKIE_NAME);
   var banner = document.querySelector("#".concat(ANALYTICS_CONSENT_BANNER_ID));
+
   if (consentCookieNotSet && !banner) {
     var _banner = createBannerHTMLElement(consentProvidedCallback);
+
     document.body.prepend(_banner);
   }
 }
+
 module.exports = {
   hasAnalyticsConsent: hasAnalyticsConsent,
   showBannerIfConsentNotSet: showBannerIfConsentNotSet
@@ -965,6 +987,7 @@ module.exports = {
 "use strict";
 
 var cookies = require('./cookies/validate');
+
 window.GovUkPay = {
   cookies: cookies
 };

package/lib/analytics/index.js

@@ -1,6 +1,7 @@
 "use strict";
 
 var cookies = require('./cookies/validate');
+
 window.GovUkPay = {
   cookies: cookies
 };

package/lib/browsered/field-validation/field-validation.js

@@ -1,10 +1,10 @@
-'use strict';
+'use strict'; // NPM Dependencies
+
+var every = require('lodash/every'); // Local Dependencies
 
-// NPM Dependencies
-var every = require('lodash/every');
 
-// Local Dependencies
 var checks = require('../../utils/field-validation-checks');
+
 exports.enableFieldValidation = function () {
   var allForms = Array.prototype.slice.call(document.getElementsByTagName('form'));
   allForms.filter(function (form) {
@@ -13,6 +13,7 @@ exports.enableFieldValidation = function () {
     return form.addEventListener('submit', initValidation, false);
   });
 };
+
 function initValidation(e) {
   var form = e.target;
   e.preventDefault();
@@ -20,12 +21,14 @@ function initValidation(e) {
   var validatedFields = findFields(form).map(function (field) {
     return validateField(form, field);
   });
+
   if (every(validatedFields)) {
     form.submit();
   } else {
     populateErrorSummary(form);
   }
 }
+
 function clearPreviousErrors() {
   var previousErrorsMessages = Array.prototype.slice.call(document.querySelectorAll('.error-message, .error-summary'));
   var previousErrorsFields = Array.prototype.slice.call(document.querySelectorAll('.form-group.error'));
@@ -36,12 +39,14 @@ function clearPreviousErrors() {
     return errorField.classList.remove('error');
   });
 }
+
 function findFields(form) {
   var formFields = Array.prototype.slice.call(form.querySelectorAll('input, textarea, select'));
   return formFields.filter(function (field) {
     return field.hasAttribute('data-validate');
   });
 }
+
 function validateField(form, field) {
   var result;
   var validationTypes = field.getAttribute('data-validate').split(' ');
@@ -50,47 +55,60 @@ function validateField(form, field) {
       case 'required':
         result = checks.isEmpty(field.value);
         break;
+
       case 'currency':
         result = checks.isCurrency(field.value);
         break;
+
       case 'email':
         result = checks.isValidEmail(field.value);
         break;
+
       case 'phone':
         result = checks.isPhoneNumber(field.value);
         break;
+
       case 'https':
         result = checks.isHttps(field.value);
         break;
+
       case 'belowMaxAmount':
         result = checks.isAboveMaxAmount(field.value);
         break;
+
       case 'passwordLessThanTenChars':
         result = checks.isPasswordLessThanTenChars(field.value);
         break;
+
       case 'isFieldGreaterThanMaxLengthChars':
         result = checks.isFieldGreaterThanMaxLengthChars(field.value, field.getAttribute('data-validate-max-length'));
         break;
+
       case 'isNaxsiSafe':
         result = checks.isNaxsiSafe(field.value);
         break;
+
       default:
         result = false;
         break;
     }
+
     if (result) {
       applyErrorMessaging(form, field, result);
     }
   });
   return !field.closest('.form-group').classList.contains('error');
 }
+
 function applyErrorMessaging(form, field, result) {
   var formGroup = field.closest('.form-group');
+
   if (!formGroup.classList.contains('error')) {
     formGroup.classList.add('error');
     document.querySelector('label[for="' + field.id + '"]').insertAdjacentHTML('beforeend', '<span class="error-message">' + result + '</span>');
   }
 }
+
 function populateErrorSummary(form) {
   var erroringFields = Array.prototype.slice.call(form.querySelectorAll('.form-group.error label'));
   var errorMessages = erroringFields.map(function (field) {

package/lib/constants/index.js

@@ -1,9 +1,9 @@
 'use strict';
-
 /*
  Metadata Column constants match up those defined:
  https://github.com/alphagov/pay-java-commons/blob/master/model/src/main/java/uk/gov/pay/commons/model/charge/ExternalMetadata.java
  */
+
 module.exports = {
   externalMetadata: {
     MAX_KEY_VALUE_PAIRS: 10,

package/lib/index.js

@@ -1,18 +1,23 @@
 'use strict';
 
 var browsered = require('./browsered');
+
 var utils = require('./utils');
+
 var nunjucksFilters = require('./nunjucks-filters');
+
 var logging = require('./logging');
-var constants = require('./constants');
 
-// Add to window.GOVUKPAY if in browser context
+var constants = require('./constants'); // Add to window.GOVUKPAY if in browser context
+
+
 if (typeof window !== 'undefined') {
   window.GOVUKPAY = window.GOVUKPAY || {};
   window.GOVUKPAY = {
     browsered: browsered
   };
 }
+
 module.exports = {
   browsered: browsered,
   utils: utils,

package/lib/logging/format.js

@@ -1,7 +1,8 @@
 'use strict';
 
 var _require = require('winston'),
-  format = _require.format;
+    format = _require.format;
+
 var govUkPayLoggingFormat = format(function (info, opts) {
   info['@timestamp'] = new Date().toISOString();
   info['@version'] = 1;

package/lib/logging/index.js

@@ -1,9 +1,12 @@
 'use strict';
 
 var keys = require('./keys');
+
 var _require = require('./format'),
-  govUkPayLoggingFormat = _require.govUkPayLoggingFormat;
+    govUkPayLoggingFormat = _require.govUkPayLoggingFormat;
+
 var requestLogFormat = require('./request-log-format');
+
 module.exports = {
   govUkPayLoggingFormat: govUkPayLoggingFormat,
   keys: keys,

package/lib/logging/keys.js

@@ -1,108 +1,75 @@
-'use strict';
-
-// This file needs to be kept in sync with its Java consociate
+'use strict'; // This file needs to be kept in sync with its Java consociate
 // https://github.com/alphagov/pay-java-commons/blob/master/logging/src/main/java/uk/gov/pay/logging/LoggingKeys.java
-
 // "card", "Direct Debit"
-exports.PAYMENT_TYPE = 'payment_type';
 
-// "payment", "mandate", "refund"
-exports.RESOURCE_TYPE = 'resource_type';
+exports.PAYMENT_TYPE = 'payment_type'; // "payment", "mandate", "refund"
 
-// "sandbox", "Worldpay", "Smartpay", "ePDQ", "Stripe", "GoCardless"
-exports.PROVIDER = 'provider';
+exports.RESOURCE_TYPE = 'resource_type'; // "sandbox", "Worldpay", "Smartpay", "ePDQ", "Stripe", "GoCardless"
 
-// The digital wallet used for a payment
+exports.PROVIDER = 'provider'; // The digital wallet used for a payment
 // Value must be a value of the WalletType enum
 // https://github.com/alphagov/pay-connector/blob/master/src/main/java/uk/gov/pay/connector/wallets/WalletType.java
-exports.WALLET = 'wallet';
 
-// The type of a gateway account
+exports.WALLET = 'wallet'; // The type of a gateway account
 // Value must be a value of the GatewayAccountEntity.Type enum
 // https://github.com/alphagov/pay-connector/blob/master/src/main/java/uk/gov/pay/connector/gatewayaccount/model/GatewayAccountEntity.java
-exports.GATEWAY_ACCOUNT_TYPE = 'gateway_account_type';
 
-// The type of operation being performed with a gateway for a card payment
+exports.GATEWAY_ACCOUNT_TYPE = 'gateway_account_type'; // The type of operation being performed with a gateway for a card payment
 // Value must be a value of the OperationType enum
 // https://github.com/alphagov/pay-connector/blob/master/src/main/java/uk/gov/pay/connector/paymentprocessor/model/OperationType.java
-exports.GATEWAY_CARD_OPERATION = 'gateway_card_operation';
 
-// The amount of a payment in pence
-exports.AMOUNT = 'amount';
+exports.GATEWAY_CARD_OPERATION = 'gateway_card_operation'; // The amount of a payment in pence
 
-// Mandate external id
-exports.MANDATE_EXTERNAL_ID = 'mandate_external_id';
+exports.AMOUNT = 'amount'; // Mandate external id
 
-// The PSP's identifier for a payment
-exports.PROVIDER_PAYMENT_ID = 'provider_payment_id';
+exports.MANDATE_EXTERNAL_ID = 'mandate_external_id'; // The PSP's identifier for a payment
 
-// The ID a provider gives to an event (e.g. one in a notification)
-exports.PROVIDER_EVENT_ID = 'provider_event_id';
+exports.PROVIDER_PAYMENT_ID = 'provider_payment_id'; // The ID a provider gives to an event (e.g. one in a notification)
 
-// The reference a partner service assigns to a payment, mandate etc.
-exports.SERVICE_PAYMENT_REFERENCE = 'service_reference';
+exports.PROVIDER_EVENT_ID = 'provider_event_id'; // The reference a partner service assigns to a payment, mandate etc.
 
-// The ID GOV.UK Pay gives to a gateway account
-exports.GATEWAY_ACCOUNT_ID = 'gateway_account_id';
+exports.SERVICE_PAYMENT_REFERENCE = 'service_reference'; // The ID GOV.UK Pay gives to a gateway account
 
-// The ID of an event emitted to ledger
-exports.LEDGER_EVENT_ID = 'ledger_event_id';
+exports.GATEWAY_ACCOUNT_ID = 'gateway_account_id'; // The ID of an event emitted to ledger
 
-// The type of an event emitted to ledger
-exports.LEDGER_EVENT_TYPE = 'ledger_event_type';
+exports.LEDGER_EVENT_ID = 'ledger_event_id'; // The type of an event emitted to ledger
 
-// The type of an internal event recorded by Direct Debit
+exports.LEDGER_EVENT_TYPE = 'ledger_event_type'; // The type of an internal event recorded by Direct Debit
 // Value must be a value from the GovUkPayEventType enum
 // https://github.com/alphagov/pay-direct-debit-connector/blob/master/src/main/java/uk/gov/pay/directdebit/events/model/GovUkPayEventType.java
-exports.DIRECT_DEBIT_INTERNAL_EVENT_TYPE = 'direct_debit_internal_event_type';
 
-// The current (or new if transitioning) internal state of a payment, mandate etc.
-exports.CURRENT_INTERNAL_STATE = 'current_internal_state';
+exports.DIRECT_DEBIT_INTERNAL_EVENT_TYPE = 'direct_debit_internal_event_type'; // The current (or new if transitioning) internal state of a payment, mandate etc.
+
+exports.CURRENT_INTERNAL_STATE = 'current_internal_state'; // The previous internal state of a payment, mandate etc. when transitioning
 
-// The previous internal state of a payment, mandate etc. when transitioning
-exports.PREVIOUS_INTERNAL_STATUS = 'previous_internal_status';
+exports.PREVIOUS_INTERNAL_STATUS = 'previous_internal_status'; // The last event (status) that Worldpay recorded for a payment, refund etc.
 
-// The last event (status) that Worldpay recorded for a payment, refund etc.
-exports.WORLDPAY_LAST_EVENT = 'worldpay_last_event';
+exports.WORLDPAY_LAST_EVENT = 'worldpay_last_event'; // The result code (status) that Smartpay recorded for a payment, refund etc.
 
-// The result code (status) that Smartpay recorded for a payment, refund etc.
-exports.SMARTPAY_RESULT_CODE = 'smartpay_result_code';
+exports.SMARTPAY_RESULT_CODE = 'smartpay_result_code'; // The status code that ePDQ recorded for a payment, refund etc.
 
-// The status code that ePDQ recorded for a payment, refund etc.
-exports.EPDQ_STATUS = 'epdq_status';
+exports.EPDQ_STATUS = 'epdq_status'; // The status that Stripe recorded for a payment, refund etc.
 
-// The status that Stripe recorded for a payment, refund etc.
-exports.STRIPE_STATUS = 'stripe_status';
+exports.STRIPE_STATUS = 'stripe_status'; // The action that GoCardless recorded for a payment, mandate etc.
 
-// The action that GoCardless recorded for a payment, mandate etc.
-exports.GOCARDLESS_PAYMENT_ACTION = 'gocardless_action';
+exports.GOCARDLESS_PAYMENT_ACTION = 'gocardless_action'; // The HTTP status we sent to a client
 
-// The HTTP status we sent to a client
-exports.HTTP_STATUS = 'http_status';
+exports.HTTP_STATUS = 'http_status'; // The HTTP status code we received from a remote server (e.g. a payment provider)
 
-// The HTTP status code we received from a remote server (e.g. a payment provider)
-exports.REMOTE_HTTP_STATUS = 'remote_http_status';
+exports.REMOTE_HTTP_STATUS = 'remote_http_status'; // AWS error code
 
-// AWS error code
-exports.AWS_ERROR_CODE = 'aws_error_code';
+exports.AWS_ERROR_CODE = 'aws_error_code'; // The correlation id for the request
 
-// The correlation id for the request
-exports.CORRELATION_ID = 'x_request_id';
+exports.CORRELATION_ID = 'x_request_id'; // Payment External Id
 
-// Payment External Id
-exports.PAYMENT_EXTERNAL_ID = 'payment_external_id';
+exports.PAYMENT_EXTERNAL_ID = 'payment_external_id'; // Refund External Id
 
-// Refund External Id
-exports.REFUND_EXTERNAL_ID = 'refund_external_id';
+exports.REFUND_EXTERNAL_ID = 'refund_external_id'; // Secure Token
 
-// Secure Token
-exports.SECURE_TOKEN = 'secure_token';
+exports.SECURE_TOKEN = 'secure_token'; // User external id
 
-// User external id
-exports.USER_EXTERNAL_ID = 'user_external_id';
+exports.USER_EXTERNAL_ID = 'user_external_id'; // A service's external id
 
-// A service's external id
-exports.SERVICE_EXTERNAL_ID = 'service_external_id';
+exports.SERVICE_EXTERNAL_ID = 'service_external_id'; // product external id
 
-// product external id
 exports.PRODUCT_EXTERNAL_ID = 'product_external_id';

package/lib/logging/request-log-format.js

@@ -2,6 +2,7 @@
 
 module.exports = function () {
   var correlationIdHeader = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'x-request-id';
+
   var format = function format(tokens, req, res) {
     return JSON.stringify({
       /* eslint-disable camelcase */
@@ -17,6 +18,7 @@ module.exports = function () {
       response_time: "".concat(tokens['response-time'](req, res), " ms"),
       x_request_id: tokens.req(req, res, correlationIdHeader)
       /* eslint-enable camelcase */
+
     });
   };
 

package/lib/nunjucks-filters/country-iso-to-name.js

@@ -1,7 +1,8 @@
 'use strict';
 
 var _require = require('../utils/countries'),
-  translateAlpha2 = _require.translateAlpha2;
+    translateAlpha2 = _require.translateAlpha2;
+
 module.exports = function (iso) {
   return translateAlpha2(iso);
 };

package/lib/nunjucks-filters/datetime.js

@@ -1,8 +1,10 @@
 "use strict";
 
 var moment = require('moment-timezone');
+
 module.exports = function (isoTimeString, format) {
   var formatString = 'D MMMM YYYY h:mm:ssa z';
+
   if (format === 'date') {
     formatString = 'DD/MM/YYYY';
   } else if (format === 'datelong') {
@@ -10,5 +12,6 @@ module.exports = function (isoTimeString, format) {
   } else if (format === 'time') {
     formatString = 'HH:mm:ss';
   }
+
   return moment(isoTimeString).tz('Europe/London').format(formatString);
 };

package/lib/nunjucks-filters/remove-indefinite-articles.js

@@ -2,7 +2,6 @@
 
 // Removes indefinite articles (a/an)
 // Removes definite articles (the)
-
 module.exports = function (string) {
   return string.replace(/\ba\s|\ban\s|\bthe\s/gi, '');
 };

package/lib/nunjucks-filters/slugify.js

@@ -1,6 +1,7 @@
 "use strict";
 
 var slugify = require('slugify');
+
 module.exports = function (string) {
   slugify.extend({
     ŵ: 'w',

package/lib/utils/countries.js

@@ -1,17 +1,18 @@
-'use strict';
+'use strict'; // NPM Dependencies
+
+var lodash = require('lodash'); // Local Dependencies
 
-// NPM Dependencies
-var lodash = require('lodash');
 
-// Local Dependencies
 var countries = require('../data/countries.json');
-var extensions = require('../data/country-record-extension.json');
 
-// Merge the additional data into the register data
+var extensions = require('../data/country-record-extension.json'); // Merge the additional data into the register data
+
+
 countries.forEach(function (country) {
   var extension = extensions.find(function (item) {
     return item.country === country;
   });
+
   if (extension) {
     country.entry.aliases = extension.aliases;
     country.entry.weighting = extension.weighting;
@@ -20,9 +21,8 @@ countries.forEach(function (country) {
 countries = lodash.compact(countries);
 countries = lodash.sortBy(countries, function (country) {
   return country.entry.name.toLowerCase();
-});
+}); // Exports
 
-// Exports
 exports.retrieveCountries = function (selectedCountry) {
   var countriesList = lodash.clone(countries);
   countriesList.forEach(function (country) {
@@ -30,6 +30,7 @@ exports.retrieveCountries = function (selectedCountry) {
   });
   return countriesList;
 };
+
 exports.govukFrontendFormatted = function (selectedCountry) {
   var countriesList = lodash.clone(countries);
   countriesList.forEach(function (country) {
@@ -39,6 +40,7 @@ exports.govukFrontendFormatted = function (selectedCountry) {
   });
   return countriesList;
 };
+
 exports.translateAlpha2 = function (alpha2Code) {
   return countries.find(function (country) {
     return country.entry.country === alpha2Code;

package/lib/utils/currency-formatter.js

@@ -1,36 +1,44 @@
-'use strict';
+'use strict'; // Local contants
 
-// Local contants
 var AMOUNT_FORMAT = /^(\d+)(?:\.(\d{1,2}))?$/;
+
 var penceToPounds = function penceToPounds(amount) {
   return (amount / 100).toFixed(2);
 };
+
 var poundsToPence = function poundsToPence(amount) {
   return (amount * 100).toFixed(0);
 };
+
 var penceToPoundsWithCurrency = function penceToPoundsWithCurrency(amount) {
   return new Intl.NumberFormat('en-gb', {
     style: 'currency',
     currency: 'GBP'
   }).format(penceToPounds(amount));
 };
+
 var sanitisePoundsAndPenceInput = function sanitisePoundsAndPenceInput(amount) {
   if (amount) {
     var cleanedCurrencyString = amount.replace(/[^0-9.-]+/g, '');
     var result = AMOUNT_FORMAT.exec(cleanedCurrencyString);
+
     if (result) {
       var pounds = result[1];
       var pence = result[2];
+
       if (pence === undefined) {
         pence = '00';
       } else if (pence.length === 1) {
         pence += '0';
       }
+
       return parseInt(pounds + pence, 10);
     }
+
     return null;
   }
 };
+
 module.exports = {
   penceToPounds: penceToPounds,
   poundsToPence: poundsToPence,

package/lib/utils/field-validation-checks.js

@@ -1,12 +1,11 @@
-'use strict';
+'use strict'; // NPM dependencies
 
-// NPM dependencies
-var parseInt = require('lodash/parseInt');
+var parseInt = require('lodash/parseInt'); // Local dependencies
+
+
+var emailValidator = require('./is-valid-email'); // Constants
 
-// Local dependencies
-var emailValidator = require('./is-valid-email');
 
-// Constants
 var NUMBERS_ONLY = /^\d+$/;
 var MAX_AMOUNT = 100000;
 var validationErrors = {
@@ -20,53 +19,70 @@ var validationErrors = {
   isGreaterThanMaxLengthChars: 'The text is too long',
   invalidCharacters: 'You cannot use any of the following characters < > ; : ` ( ) " \' = | , ~ [ ]'
 };
+
 exports.isEmpty = function (value) {
   if (value === '') {
     return validationErrors.required;
   }
+
   return false;
 };
+
 exports.isCurrency = function (value) {
   if (!/^(\d+)(?:\.(\d{1,2}))?$/.test(value)) {
     return validationErrors.currency;
   }
+
   return false;
 };
+
 exports.isValidEmail = function (value) {
   if (!emailValidator(value)) {
     return validationErrors.validEmail;
   }
+
   return false;
 };
+
 exports.isPhoneNumber = function (value) {
   var trimmedTelephoneNumber = value.replace(/\s/g, '');
+
   if (trimmedTelephoneNumber.length < 11 || !NUMBERS_ONLY.test(trimmedTelephoneNumber)) {
     return validationErrors.phoneNumber;
   }
+
   return false;
 };
+
 exports.isHttps = function (value) {
   if (value.substr(0, 8) !== 'https://') {
     return validationErrors.isHttps;
   }
+
   return false;
 };
+
 exports.isAboveMaxAmount = function (value) {
   if (!exports.isCurrency(value) && parseFloat(value) > MAX_AMOUNT) {
     return validationErrors.isAboveMaxAmount;
   }
+
   return false;
 };
+
 exports.isFieldGreaterThanMaxLengthChars = function (value, maxLength) {
   var parsedMaxLength = parseInt(maxLength);
   return parsedMaxLength && value.length > parsedMaxLength ? validationErrors.isGreaterThanMaxLengthChars : false;
 };
+
 exports.isPasswordLessThanTenChars = function (value) {
   return !value || value.length < 10 ? validationErrors.isPasswordLessThanTenChars : false;
 };
+
 exports.isNaxsiSafe = function (value) {
   if (/[<>;:`()"'=|,~[\]]+/g.test(value)) {
     return validationErrors.invalidCharacters;
   }
+
   return false;
 };

package/lib/utils/is-valid-email.js

@@ -1,11 +1,12 @@
-'use strict';
+'use strict'; // NPM dependencies
 
-// NPM dependencies
 var rfc822Validator = require('rfc822-validate');
+
 module.exports = function (email) {
   if (rfc822Validator(email)) {
     var domain = email.split('@')[1];
     return !(domain && domain.indexOf('.') === -1);
   }
+
   return false;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@govuk-pay/pay-js-commons",
-  "version": "3.8.4",
+  "version": "3.8.5",
   "description": "Reusable js scripts for GOV.UK Pay Node.js projects",
   "engines": {
     "node": "^16.14.0"

package/sass/custom/nibsc-standards-2023-01.scss

@@ -0,0 +1,56 @@
+$govuk-font-family: -apple-system,BlinkMacSystemFont,helvetica neue,helvetica,ubuntu,roboto,noto,segoe ui,arial,sans-serif; // Override font as so not to use New Transport
+@import "application";
+
+// CUSTOM BRANDING
+// Use the variables below to control the style
+// Make sure banner colours meet minimum colour contrast levels
+
+$custom-banner-colour: #008489;
+$custom-banner-border-colour: #ffffff;
+$custom-text-colour: #ffffff;
+$logo-image-height: 2em;
+
+.custom-branding {
+  @if $logo-image-height != null {
+    .custom-branding-image {
+      height: $logo-image-height;
+      width: 100%;
+
+      @media all and (-ms-high-contrast: none), (-ms-high-contrast: active) {
+        width: 100%;
+      }
+    }
+  }
+
+  .govuk-header {
+    background-color: $custom-banner-colour;
+  }
+
+  .govuk-header__link {
+    &:link,
+    &:visited {
+      color: $custom-text-colour;
+    }
+  }
+
+  .govuk-header__link--service-name {
+    display: none;
+  }
+
+  .govuk-header__container {
+    border-bottom-color: $custom-banner-border-colour;
+  }
+
+  @include govuk-media-query($from: tablet) {
+    .govuk-header__content {
+      width: 66%;
+      vertical-align: bottom;
+      margin-bottom: 7px;
+    }
+  }
+
+  .govuk-button {
+    padding: 7px 15px 6px;
+    padding: .368421053em .842105263em .315789474em;
+  }
+}