notifications-node-client 8.0.0 → 8.2.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 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.
+
 ## 8.0.0 - 2023-12-27
 
 * Remove the default `is_csv` boolean parameter from `prepareUpload`. This method now accepts a file and an options map with the following options. For more specific information please read the documentation.

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

@@ -23,10 +23,11 @@ function NotifyClient() {
  * @param {Object} personalisation
  * @param {String} reference
  * @param {String} replyToId
+ * @param {String} oneClickUnsubscribeURL
  *
  * @returns {Object}
  */
-function createNotificationPayload(type, templateId, to, personalisation, reference, replyToId) {
+function createNotificationPayload(type, templateId, to, personalisation, reference, replyToId, oneClickUnsubscribeURL) {
 
   var payload = {
     template_id: templateId
@@ -53,6 +54,10 @@ function createNotificationPayload(type, templateId, to, personalisation, refere
     payload.sms_sender_id = replyToId;
   }
 
+  if (oneClickUnsubscribeURL && type == 'email') {
+    payload.one_click_unsubscribe_url = oneClickUnsubscribeURL;
+  }
+
   return payload;
 }
 
@@ -144,16 +149,17 @@ Object.assign(NotifyClient.prototype, {
    */
   sendEmail: function (templateId, emailAddress, options) {
     options = options || {};
-    var err = checkOptionsKeys(['personalisation', 'reference', 'emailReplyToId'], options)
+    var err = checkOptionsKeys(['personalisation', 'reference', 'emailReplyToId', 'oneClickUnsubscribeURL'], options)
     if (err) {
       return Promise.reject(err);
     }
     var personalisation = options.personalisation || undefined,
       reference = options.reference || undefined,
-      emailReplyToId = options.emailReplyToId || undefined;
+      emailReplyToId = options.emailReplyToId || undefined,
+      oneClickUnsubscribeURL = options.oneClickUnsubscribeURL || undefined;
 
     return this.apiClient.post('/v2/notifications/email',
-      createNotificationPayload('email', templateId, emailAddress, personalisation, reference, emailReplyToId));
+      createNotificationPayload('email', templateId, emailAddress, personalisation, reference, emailReplyToId, oneClickUnsubscribeURL));
   },
 
   /**

package/package.json

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

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/definitions.json

@@ -25,7 +25,8 @@
     "properties": {
         "body": {"type": "string"},
         "from_email": {"type": "string", "format": "email_address"},
-        "subject": {"type": "string"}
+        "subject": {"type": "string"},
+        "one_click_unsubscribe_url": {"type": ["string", "null"], "format": "uri"}
     },
     "required": ["body", "from_email", "subject"]
   },

package/spec/integration/test.js

@@ -36,6 +36,7 @@ describer('notification api with a live service', function () {
   let letterNotificationId;
   const personalisation = { name: 'Foo' };
   const clientRef = 'client-ref';
+  const oneClickUnsubscribeURL = 'https://www.example.com';
   const email = process.env.FUNCTIONAL_TEST_EMAIL;
   const phoneNumber = process.env.FUNCTIONAL_TEST_NUMBER;
   const letterContact = {
@@ -88,6 +89,22 @@ describer('notification api with a live service', function () {
         expect(response.data).to.be.jsonSchema(postEmailNotificationResponseJson);
         response.data.content.body.should.equal('Hello Foo\r\n\r\nFunctional test help make our world a better place');
         response.data.content.subject.should.equal('Functional Tests are good');
+        should.equal(response.data.content.one_click_unsubscribe_url, null);
+        response.data.reference.should.equal(clientRef);
+        emailNotificationId = response.data.id;
+      })
+    });
+
+    it('send email notification with unsubscribe link', () => {
+      var postEmailNotificationResponseJson = require('./schemas/v2/POST_notification_email_response.json'),
+        options = {personalisation: personalisation, reference: clientRef, oneClickUnsubscribeURL: oneClickUnsubscribeURL};
+
+      return notifyClient.sendEmail(emailTemplateId, email, options).then((response) => {
+        response.status.should.equal(201);
+        expect(response.data).to.be.jsonSchema(postEmailNotificationResponseJson);
+        response.data.content.body.should.equal('Hello Foo\r\n\r\nFunctional test help make our world a better place');
+        response.data.content.subject.should.equal('Functional Tests are good');
+        response.data.content.one_click_unsubscribe_url.should.equal(oneClickUnsubscribeURL);
         response.data.reference.should.equal(clientRef);
         emailNotificationId = response.data.id;
       })

package/spec/notification.js

@@ -92,6 +92,31 @@ describe('notification api', () => {
       });
     });
 
+    it('should send an email with a one click unsubscribe URL', () => {
+
+      let email = 'me@example.com',
+        templateId = '123',
+        options = {
+          personalisation: {foo: 'bar'},
+          oneClickUnsubscribeURL: '456',
+        },
+        data = {
+          template_id: templateId,
+          email_address: email,
+          personalisation: options.personalisation,
+          one_click_unsubscribe_url: options.oneClickUnsubscribeURL
+        };
+
+      notifyAuthNock
+      .post('/v2/notifications/email', data)
+      .reply(200, {hooray: 'bkbbk'});
+
+      return notifyClient.sendEmail(templateId, email, options)
+      .then((response) => {
+        expect(response.status).to.equal(200);
+      });
+    });
+
     it('should send an email with document upload', () => {
       let email = 'dom@example.com',
         templateId = '123',