@govuk-pay/pay-js-commons 4.0.17 → 5.0.1

package/README.md

@@ -4,6 +4,7 @@ Reusable js scripts for GOV.UK Pay Node.js projects
 - [Browsered scripts](#browsered-scripts)
 - [Utilities](#utilities)
 - [Nunjucks filters](#nunjucks-filters)
+- [HTTPS base client](#https-base-client)
 - [Releasing a new version](#releasing-a-new-version)
 
 ## Browsered scripts
@@ -144,10 +145,10 @@ i.e. ``< > ; : ` ( ) " \' = | , ~ [ ]``
 
 ## Utilities
 
-These are small functions that power the nunjucks filters but can also be used for server side stuff too.
-
 ### Nunjucks filters
 
+These are small functions that power the nunjucks filters but can also be used for server side stuff too.
+
 These get loaded in to the Nunjucks environment and then can apply changes to variables in templates.
 
 For example if a country comes in as ISO code `EN` it can be converted to it’s name like so
@@ -165,6 +166,12 @@ Or a pence value can be converted to GBP
   </dl>
 ```
 
+### Https base client
+
+Used in our Node.js apps to call internal APIs such as connector or ledger.
+
+Uses the NPM Axios library.
+
 ## Releasing
 
 After a pull request is merged, Concourse will automatically create a new release pull request that increments the package version.

package/lib/index.js

@@ -5,6 +5,7 @@ var utils = require('./utils');
 var nunjucksFilters = require('./nunjucks-filters');
 var logging = require('./logging');
 var constants = require('./constants');
+var HttpsBaseClient = require('./utils/https-base-client/https-base-client');
 
 // Add to window.GOVUKPAY if in browser context
 if (typeof window !== 'undefined') {
@@ -18,5 +19,6 @@ module.exports = {
   utils: utils,
   nunjucksFilters: nunjucksFilters,
   logging: logging,
-  constants: constants
+  constants: constants,
+  HttpsBaseClient: HttpsBaseClient
 };

package/lib/utils/{axios-base-client/axios-base-client.js → https-base-client/https-base-client.js}

@@ -23,16 +23,16 @@ var https = require('https');
 var axios = require('axios');
 var _require = require('./errors'),
   RESTClientError = _require.RESTClientError;
-var Client = /*#__PURE__*/function () {
-  function Client(app) {
-    _classCallCheck(this, Client);
+var HttpsBaseClient = /*#__PURE__*/function () {
+  function HttpsBaseClient(app) {
+    _classCallCheck(this, HttpsBaseClient);
     this._app = app;
   }
 
   /**
    * Configure the client. Should only be called once.
    */
-  _createClass(Client, [{
+  _createClass(HttpsBaseClient, [{
     key: "configure",
     value: function configure(baseURL, options) {
       var _this = this;
@@ -49,7 +49,7 @@ var Client = /*#__PURE__*/function () {
         }),
         headers: {
           'Content-Type': 'application/json',
-          'Accept': 'application/json'
+          Accept: 'application/json'
         }
       });
       this._axios.interceptors.request.use(function (config) {
@@ -190,8 +190,6 @@ var Client = /*#__PURE__*/function () {
       return this._axios.delete(url, this._getConfigWithDescription(config, description));
     }
   }]);
-  return Client;
+  return HttpsBaseClient;
 }();
-module.exports = {
-  Client: Client
-};
+module.exports = HttpsBaseClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@govuk-pay/pay-js-commons",
-  "version": "4.0.17",
+  "version": "5.0.1",
   "description": "Reusable js scripts for GOV.UK Pay Node.js projects",
   "engines": {
     "node": "^18.17.1"
@@ -20,7 +20,7 @@
     "prepare": "npm run transpile && npm run browserify-analytics",
     "test": "npm run jest-tests npm && npm run karma-tests",
     "karma-tests": "karma start",
-    "jest-tests": "jest src/analytics src/utils/axios-base-client/axios-base-client.test.js",
+    "jest-tests": "jest src/analytics src/utils/https-base-client/https-base-client.test.js",
     "lint": "standard --fix"
   },
   "repository": {