notifications-node-client 7.0.6 → 8.1.0

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -9,7 +9,7 @@
 - [x] I’ve used the pull request template
 - [ ] I’ve written unit tests for these changes
 - [ ] I’ve updated the documentation in
-  - `DOCUMENTATION.md`
+  - [notifications-tech-docs repository](https://github.com/alphagov/notifications-tech-docs/blob/main/source/documentation/client_docs/_node.md)
   - `CHANGELOG.md`
 - [ ] I’ve bumped the version number in
   - `package.json`

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 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.
+    * `filename` (string) - specify the document's filename upon download
+    * `confirm_email_before_download` (boolean) - require the user to enter their email address before the file can be downloaded.
+    * `retention_period` (string) - how long Notify should make the file available to the user for.
+
 ## 7.0.6 - 2023-11-13
 
 * Bump axios from 1.2.6 to 1.6.1

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));
   },
 
   /**
@@ -356,26 +362,18 @@ Object.assign(NotifyClient.prototype, {
   prepareUpload: function(fileData, options) {
     let data = {
       file: _check_and_encode_file(fileData, 2),
-      is_csv: false,
+      filename: null,
       confirm_email_before_download: null,
       retention_period: null,
     }
 
     if (options !== undefined) {
-      if (typeof(options) === 'boolean') {
-        data.is_csv = options
-      }
-      else {
-        if (options.isCsv !== undefined) {
-          data.is_csv = options.isCsv;
-        }
-
-        data.confirm_email_before_download = options.confirmEmailBeforeDownload !== undefined ? options.confirmEmailBeforeDownload : null;
-        data.retention_period = options.retentionPeriod || null
-      }
+      data.filename = options.filename || null;
+      data.confirm_email_before_download = options.confirmEmailBeforeDownload !== undefined ? options.confirmEmailBeforeDownload : null;
+      data.retention_period = options.retentionPeriod || null;
     }
 
-    return data
+    return data;
   },
 
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notifications-node-client",
-  "version": "7.0.6",
+  "version": "8.1.0",
   "homepage": "https://docs.notifications.service.gov.uk/node.html",
   "repository": {
     "type": "git",
@@ -36,4 +36,3 @@
     "standard-markdown": "5.0.1"
   }
 }
-

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,18 +92,19 @@ describe('notification api', () => {
       });
     });
 
-    it('should send an email with document upload', () => {
-      let email = 'dom@example.com',
+    it('should send an email with a one click unsubscribe URL', () => {
+
+      let email = 'me@example.com',
         templateId = '123',
         options = {
-          personalisation: {documents:
-            notifyClient.prepareUpload(Buffer.from("%PDF-1.5 testpdf"))
-          },
+          personalisation: {foo: 'bar'},
+          oneClickUnsubscribeURL: '456',
         },
         data = {
           template_id: templateId,
           email_address: email,
           personalisation: options.personalisation,
+          one_click_unsubscribe_url: options.oneClickUnsubscribeURL
         };
 
       notifyAuthNock
@@ -113,16 +114,15 @@ describe('notification api', () => {
       return notifyClient.sendEmail(templateId, email, options)
       .then((response) => {
         expect(response.status).to.equal(200);
-        expect(response.config.data).to.include('"is_csv":false');
       });
     });
 
-    it('should send an email with CSV document upload', () => {
+    it('should send an email with document upload', () => {
       let email = 'dom@example.com',
         templateId = '123',
         options = {
           personalisation: {documents:
-            notifyClient.prepareUpload(Buffer.from("a,b"), true)
+            notifyClient.prepareUpload(Buffer.from("%PDF-1.5 testpdf"))
           },
         },
         data = {
@@ -138,16 +138,15 @@ describe('notification api', () => {
       return notifyClient.sendEmail(templateId, email, options)
       .then((response) => {
         expect(response.status).to.equal(200);
-        expect(response.config.data).to.include('"is_csv":true');
       });
     });
 
-    it('should send an email with non CSV document upload', () => {
+    it('should send an email with a custom filename', () => {
       let email = 'dom@example.com',
         templateId = '123',
         options = {
           personalisation: {documents:
-            notifyClient.prepareUpload(Buffer.from("%PDF-1.5 testpdf"), false)
+            notifyClient.prepareUpload(Buffer.from("a,b"), {filename: 'report.csv'})
           },
         },
         data = {
@@ -163,7 +162,7 @@ describe('notification api', () => {
       return notifyClient.sendEmail(templateId, email, options)
       .then((response) => {
         expect(response.status).to.equal(200);
-        expect(response.config.data).to.include('"is_csv":false');
+        expect(response.config.data).to.include('"filename":"report.csv"');
       });
     });
 
@@ -194,8 +193,8 @@ describe('notification api', () => {
       expect(typeof(file)).to.equal('object')
       expect(Buffer.isBuffer(file)).to.equal(true);
       expect(
-        notifyClient.prepareUpload(file, true)
-      ).contains({file: 'MSwyLDMKYSxiLGMK', is_csv: true})
+        notifyClient.prepareUpload(file)
+      ).contains({file: 'MSwyLDMKYSxiLGMK'})
     });
     it('should accept files as strings (from fs.readFile with an encoding)', () => {
       let fs = require('fs');
@@ -203,50 +202,36 @@ describe('notification api', () => {
       expect(typeof(file)).to.equal('string')
       expect(Buffer.isBuffer(file)).to.equal(false);
       expect(
-        notifyClient.prepareUpload(file, true)
-      ).contains({file: 'MSwyLDMKYSxiLGMK', is_csv: true})
-    });
-
-    it('should allow isCsv to be set with the old method (directly into options)', () => {
-      let file = Buffer.alloc(2*1024*1024)
-      expect(
-        notifyClient.prepareUpload(file, true)
-      ).contains({is_csv: true, confirm_email_before_download: null, retention_period: null})
-    });
-
-    it('should allow isCsv to be set as part of the options object', () => {
-      let file = Buffer.alloc(2*1024*1024)
-      expect(
-        notifyClient.prepareUpload(file, {isCsv: true})
-      ).contains({is_csv: true, confirm_email_before_download: null, retention_period: null})
-    });
-
-    it('should imply isCsv=false from empty options', () => {
-      let file = Buffer.alloc(2*1024*1024)
-      expect(
-        notifyClient.prepareUpload(file, {})
-      ).contains({is_csv: false, confirm_email_before_download: null, retention_period: null})
+        notifyClient.prepareUpload(file)
+      ).contains({file: 'MSwyLDMKYSxiLGMK'})
     });
 
     it('should allow send a file email confirmation to be disabled', () => {
       let file = Buffer.alloc(2*1024*1024)
       expect(
         notifyClient.prepareUpload(file, {confirmEmailBeforeDownload: false})
-      ).contains({is_csv: false, confirm_email_before_download: false, retention_period: null})
+      ).contains({confirm_email_before_download: false, retention_period: null})
     });
 
     it('should allow send a file email confirmation to be set', () => {
       let file = Buffer.alloc(2*1024*1024)
       expect(
         notifyClient.prepareUpload(file, {confirmEmailBeforeDownload: true})
-      ).contains({is_csv: false, confirm_email_before_download: true, retention_period: null})
+      ).contains({confirm_email_before_download: true, retention_period: null})
     });
 
     it('should allow custom retention periods to be set', () => {
       let file = Buffer.alloc(2*1024*1024)
       expect(
         notifyClient.prepareUpload(file, {retentionPeriod: "52 weeks"})
-      ).contains({is_csv: false, confirm_email_before_download: null, retention_period: '52 weeks'})
+      ).contains({confirm_email_before_download: null, retention_period: '52 weeks'})
+    });
+
+    it('should allow custom filenames to be set', () => {
+      let file = Buffer.alloc(2*1024*1024)
+      expect(
+        notifyClient.prepareUpload(file, {filename: "report.csv"})
+      ).contains({confirm_email_before_download: null, filename: "report.csv"})
     });
   });