@govuk-pay/pay-js-commons 3.7.0 → 3.8.2

package/lib/analytics/index.js

@@ -1,7 +1,6 @@
 "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'; // NPM Dependencies
-
-var every = require('lodash/every'); // Local Dependencies
+'use strict';
 
+// 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,7 +13,6 @@ exports.enableFieldValidation = function () {
     return form.addEventListener('submit', initValidation, false);
   });
 };
-
 function initValidation(e) {
   var form = e.target;
   e.preventDefault();
@@ -21,14 +20,12 @@ 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'));
@@ -39,14 +36,12 @@ 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(' ');
@@ -55,60 +50,47 @@ 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,23 +1,18 @@
 'use strict';
 
 var browsered = require('./browsered');
-
 var utils = require('./utils');
-
 var nunjucksFilters = require('./nunjucks-filters');
-
 var logging = require('./logging');
+var constants = require('./constants');
 
-var constants = require('./constants'); // Add to window.GOVUKPAY if in browser context
-
-
+// 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,8 +1,7 @@
 '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,12 +1,9 @@
 '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,73 +1,108 @@
-'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';
 
-exports.PAYMENT_TYPE = 'payment_type'; // "payment", "mandate", "refund"
+// "payment", "mandate", "refund"
+exports.RESOURCE_TYPE = 'resource_type';
 
-exports.RESOURCE_TYPE = 'resource_type'; // "sandbox", "Worldpay", "Smartpay", "ePDQ", "Stripe", "GoCardless"
+// "sandbox", "Worldpay", "Smartpay", "ePDQ", "Stripe", "GoCardless"
+exports.PROVIDER = 'provider';
 
-exports.PROVIDER = 'provider'; // The digital wallet used for a payment
+// 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';
 
-exports.WALLET = 'wallet'; // The type of a gateway account
+// 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';
 
-exports.GATEWAY_ACCOUNT_TYPE = 'gateway_account_type'; // The type of operation being performed with a gateway for a card payment
+// 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';
 
-exports.GATEWAY_CARD_OPERATION = 'gateway_card_operation'; // The amount of a payment in pence
+// The amount of a payment in pence
+exports.AMOUNT = 'amount';
 
-exports.AMOUNT = 'amount'; // Mandate external id
+// Mandate external id
+exports.MANDATE_EXTERNAL_ID = 'mandate_external_id';
 
-exports.MANDATE_EXTERNAL_ID = 'mandate_external_id'; // The PSP's identifier for a payment
+// The PSP's identifier for a payment
+exports.PROVIDER_PAYMENT_ID = 'provider_payment_id';
 
-exports.PROVIDER_PAYMENT_ID = 'provider_payment_id'; // The ID a provider gives to an event (e.g. one in a notification)
+// The ID a provider gives to an event (e.g. one in a notification)
+exports.PROVIDER_EVENT_ID = 'provider_event_id';
 
-exports.PROVIDER_EVENT_ID = 'provider_event_id'; // The reference a partner service assigns to a payment, mandate etc.
+// The reference a partner service assigns to a payment, mandate etc.
+exports.SERVICE_PAYMENT_REFERENCE = 'service_reference';
 
-exports.SERVICE_PAYMENT_REFERENCE = 'service_reference'; // The ID GOV.UK Pay gives to a gateway account
+// The ID GOV.UK Pay gives to a gateway account
+exports.GATEWAY_ACCOUNT_ID = 'gateway_account_id';
 
-exports.GATEWAY_ACCOUNT_ID = 'gateway_account_id'; // The ID of an event emitted to ledger
+// The ID of an event emitted to ledger
+exports.LEDGER_EVENT_ID = 'ledger_event_id';
 
-exports.LEDGER_EVENT_ID = 'ledger_event_id'; // The type of an event emitted to ledger
+// The type of an event emitted to ledger
+exports.LEDGER_EVENT_TYPE = 'ledger_event_type';
 
-exports.LEDGER_EVENT_TYPE = 'ledger_event_type'; // The type of an internal event recorded by Direct Debit
+// 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';
 
-exports.DIRECT_DEBIT_INTERNAL_EVENT_TYPE = 'direct_debit_internal_event_type'; // The current (or new if transitioning) internal state of a payment, mandate etc.
+// The current (or new if transitioning) internal state of a payment, mandate etc.
+exports.CURRENT_INTERNAL_STATE = 'current_internal_state';
 
-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
+exports.PRODUCT_EXTERNAL_ID = 'product_external_id';

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

@@ -2,7 +2,6 @@
 
 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 */
@@ -18,7 +17,6 @@ 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,8 +1,7 @@
 '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,10 +1,8 @@
 "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') {
@@ -12,6 +10,5 @@ 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,6 +2,7 @@
 
 // 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,7 +1,6 @@
 "use strict";
 
 var slugify = require('slugify');
-
 module.exports = function (string) {
   slugify.extend({
     ŵ: 'w',

package/lib/utils/countries.js

@@ -1,18 +1,17 @@
-'use strict'; // NPM Dependencies
-
-var lodash = require('lodash'); // Local Dependencies
+'use strict';
 
+// NPM Dependencies
+var lodash = require('lodash');
 
+// Local Dependencies
 var countries = require('../data/countries.json');
+var extensions = require('../data/country-record-extension.json');
 
-var extensions = require('../data/country-record-extension.json'); // Merge the additional data into the register data
-
-
+// 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;
@@ -21,8 +20,9 @@ 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,7 +30,6 @@ exports.retrieveCountries = function (selectedCountry) {
   });
   return countriesList;
 };
-
 exports.govukFrontendFormatted = function (selectedCountry) {
   var countriesList = lodash.clone(countries);
   countriesList.forEach(function (country) {
@@ -40,7 +39,6 @@ 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,44 +1,36 @@
-'use strict'; // Local contants
+'use strict';
 
+// 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,11 +1,12 @@
-'use strict'; // NPM dependencies
+'use strict';
 
-var parseInt = require('lodash/parseInt'); // Local dependencies
-
-
-var emailValidator = require('./is-valid-email'); // Constants
+// NPM dependencies
+var parseInt = require('lodash/parseInt');
 
+// Local dependencies
+var emailValidator = require('./is-valid-email');
 
+// Constants
 var NUMBERS_ONLY = /^\d+$/;
 var MAX_AMOUNT = 100000;
 var validationErrors = {
@@ -19,70 +20,53 @@ 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,12 +1,11 @@
-'use strict'; // NPM dependencies
+'use strict';
 
+// 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.7.0",
+  "version": "3.8.2",
   "description": "Reusable js scripts for GOV.UK Pay Node.js projects",
   "engines": {
     "node": "^16.14.0"
@@ -114,7 +114,7 @@
     "jest": "^27.0.1",
     "jest-environment-jsdom": "^27.0.1",
     "js-cookie": "^3.0.0",
-    "jsdom": "^19.0.0",
+    "jsdom": "^20.0.1",
     "jsdom-global": "^3.0.2",
     "karma": "^6.0.0",
     "karma-browserify": "^8.0.0",
@@ -123,21 +123,21 @@
     "karma-mocha-reporter": "^2.2.5",
     "karma-source-map-support": "^1.2.0",
     "lint-staged": "^13.0.1",
-    "mocha": "^9.1.0",
+    "mocha": "^10.0.0",
     "sinon": "^14.0.0",
-    "standard": "^16.0.3",
+    "standard": "^17.0.0",
     "uglify-js": "^3.6.0",
     "watchify": "^4.0.0",
-    "xo": "^0.51.0"
+    "xo": "^0.52.1"
   },
   "directories": {
     "lib": "lib"
   },
   "dependencies": {
     "lodash": "4.17.21",
-    "moment-timezone": "0.5.34",
+    "moment-timezone": "0.5.38",
     "rfc822-validate": "1.0.0",
     "slugify": "1.6.5",
-    "winston": "3.8.1"
+    "winston": "3.8.2"
   }
 }