notifications-node-client 8.1.0 → 8.2.1

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 8.2.1 - 2024-07-03
+
+* Fix a bug where an internal API client function isn't being exposed in the library.
+
+## 8.2.0 - 2024-05-17
+
+* Add support for providing a custom underlying Axios client via `setClient`.
+
 ## 8.1.0 - 2024-05-09
 
 * The `sendEmail` function can now be passed `oneClickUnsubscribeURL` as an optional argument.

package/client/api_client.js

@@ -1,4 +1,4 @@
-var restClient = require('axios').default,
+var defaultRestClient = require('axios').default,
     createGovukNotifyToken = require('../client/authentication.js'),
     notifyProductionAPI = 'https://api.notifications.service.gov.uk',
     version = require('../package.json').version;
@@ -13,6 +13,7 @@ var restClient = require('axios').default,
 function ApiClient() {
 
   this.proxy = null;
+  this.restClient = defaultRestClient;
 
   if (arguments.length === 1) {
     this.urlBase = notifyProductionAPI;
@@ -75,7 +76,7 @@ Object.assign(ApiClient.prototype, {
     Object.assign(options, additionalOptions)
     if(this.proxy !== null) options.proxy = this.proxy;
 
-    return restClient(options);
+    return this.restClient(options);
   },
 
   /**
@@ -98,7 +99,7 @@ Object.assign(ApiClient.prototype, {
 
     if(this.proxy !== null) options.proxy = this.proxy;
 
-    return restClient(options);
+    return this.restClient(options);
   },
 
   /**
@@ -107,6 +108,14 @@ Object.assign(ApiClient.prototype, {
    */
   setProxy: function(proxyConfig){
     this.proxy = proxyConfig
+  },
+
+  /**
+   *
+   * @param {object} an axios instance
+   */
+  setClient: function(restClient){
+    this.restClient = restClient;
   }
 });
 

package/client/notification.js

@@ -352,6 +352,14 @@ Object.assign(NotifyClient.prototype, {
     this.apiClient.setProxy(proxyConfig);
   },
 
+  /**
+   *
+   * @param {object} an axios instance
+   */
+  setClient: function(client) {
+    this.apiClient.setClient(client);
+  },
+
   /**
   *
   * @param {Buffer} fileData

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notifications-node-client",
-  "version": "8.1.0",
+  "version": "8.2.1",
   "homepage": "https://docs.notifications.service.gov.uk/node.html",
   "repository": {
     "type": "git",
@@ -20,19 +20,20 @@
   "author": "GDS developers",
   "license": "MIT",
   "dependencies": {
-    "jsonwebtoken": "^9.0.0",
-    "axios": "^1.6.1"
+    "axios": "^1.7.2",
+    "jsonwebtoken": "^9.0.2"
   },
   "devDependencies": {
-    "chai": "4.1.2",
+    "chai": "4.3.4",
     "chai-as-promised": "7.1.1",
-    "chai-json-schema": "1.5.0",
     "chai-bytes": "0.1.2",
-    "jsonschema": "1.2.4",
-    "mocha": "10.1.0",
-    "mockdate": "2.0.2",
+    "chai-json-schema": "1.5.1",
+    "jsonschema": "1.4.1",
+    "mocha": "10.6.0",
+    "mockdate": "3.0.5",
     "nock": "9.2.6",
     "optimist": "0.6.1",
-    "standard-markdown": "5.0.1"
+    "sinon": "^18.0.0",
+    "standard-markdown": "7.1.0"
   }
 }

package/spec/api_client.js

@@ -3,8 +3,9 @@ var expect = require('chai').expect,
   ApiClient = require('../client/api_client.js'),
   nock = require('nock'),
   createGovukNotifyToken = require('../client/authentication.js'),
-  version = require('../package.json').version;
-
+  version = require('../package.json').version,
+  axios = require('axios'),
+  sinon = require('sinon');
 
 describe('api client', function () {
 
@@ -117,4 +118,39 @@ describe('api client', function () {
         done();
     });
   });
+
+  it('should use the custom Axios client when set', function (done) {
+    var urlBase = 'https://api.notifications.service.gov.uk',
+      path = '/email',
+      body = {
+        'body': 'body text'
+      },
+      serviceId = 'c745a8d8-b48a-4b0d-96e5-dbea0165ebd1',
+      apiKeyId = '8b3aa916-ec82-434e-b0c5-d5d9b371d6a3';
+
+    var customClientStub = sinon.stub().resolves({ data: body });
+
+    var apiClient = new ApiClient(serviceId, apiKeyId);
+    apiClient.setClient(customClientStub);
+
+    nock(urlBase, {
+      reqheaders: {
+        'Authorization': 'Bearer ' + createGovukNotifyToken('GET', path, apiKeyId, serviceId),
+        'User-Agent': 'NOTIFY-API-NODE-CLIENT/' + version
+      }
+    })
+      .get(path)
+      .reply(200, body);
+
+    apiClient.get(path)
+      .then(function (response) {
+        expect(response.data).to.deep.equal(body);
+        expect(customClientStub.calledOnce).to.be.true;
+        expect(customClientStub.args[0][0].url).to.equal(urlBase + path);
+        expect(customClientStub.args[0][0].headers['Authorization']).to.equal('Bearer ' + createGovukNotifyToken('GET', path, apiKeyId, serviceId));
+        expect(customClientStub.args[0][0].headers['User-Agent']).to.equal('NOTIFY-API-NODE-CLIENT/' + version);
+        done();
+      })
+      .catch(done);
+  });
 });

package/spec/integration/schemas/v2/GET_notification_response.json

@@ -28,7 +28,19 @@
         "scheduled_for": {"oneOf":[
           {"$ref": "definitions.json#/datetime"},
           {"type": "null"}
-        ]}
+        ]},
+        "cost_in_pounds": {"type": ["number", "null"]},
+        "is_cost_data_ready": {"type": "boolean"},
+        "cost_details": {
+            "type": "object",
+            "properties": {
+                "billable_sms_fragments": {"type": ["integer", "null"]},
+                "international_rate_multiplier": {"type": ["number", "null"]},
+                "sms_rate": {"type": ["number", "null"]},
+                "billable_sheets_of_paper": {"type": ["integer", "null"]},
+                "postage": {"type": ["string", "null"]}
+            }
+        }
     },
     "required": [
         "id", "reference", "email_address", "phone_number",