notifications-node-client 5.2.0 → 5.2.2

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 5.2.2 - 2022-11-16
+
+* Upgrade ansi-regex dependencies to mitigate CVE-2021-3807.
+
+## 5.2.1 - 2022-10-19
+
+* Support strings in calls to `prepareUpload`. `fs.readFile` can return strings if an encoding is provided, and the client didn't handle these correctly.
+
 ## 5.2.0 - 2022-09-27
 
 * Add support for new security features when sending a file by email:

package/README.md

@@ -6,5 +6,5 @@ Useful links:
 
 - [Documentation](https://docs.notifications.service.gov.uk/node.html)
 - [NPM package](https://www.npmjs.com/package/notifications-node-client)
-- [Changelog](https://github.com/alphagov/notifications-node-client/blob/master/CHANGELOG.md)
-- [Contributing to this client](https://github.com/alphagov/notifications-node-client/blob/master/CONTRIBUTING.md)
+- [Changelog](https://github.com/alphagov/notifications-node-client/blob/main/CHANGELOG.md)
+- [Contributing to this client](https://github.com/alphagov/notifications-node-client/blob/main/CONTRIBUTING.md)

package/client/notification.js

@@ -115,6 +115,9 @@ function _check_and_encode_file(file, size_limit) {
   if (file.length > size_limit * 1024 * 1024) {
     throw "File is larger than " + String(size_limit) + "MB.";
   }
+  if (typeof(file) === 'string') {
+    file = Buffer.from(file);
+  }
   return file.toString('base64')
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notifications-node-client",
-  "version": "5.2.0",
+  "version": "5.2.2",
   "homepage": "https://docs.notifications.service.gov.uk/node.html",
   "repository": {
     "type": "git",

package/spec/notification.js

@@ -188,6 +188,24 @@ describe('notification api', () => {
         notifyClient.prepareUpload(file);
       }).to.throw("File is larger than 2MB.")
     });
+    it('should accept files as buffers (from fs.readFile with no encoding)', () => {
+      let fs = require('fs');
+      let file = fs.readFileSync('./spec/test_files/simple.csv');
+      expect(typeof(file)).to.equal('object')
+      expect(Buffer.isBuffer(file)).to.equal(true);
+      expect(
+        notifyClient.prepareUpload(file, true)
+      ).contains({file: 'MSwyLDMKYSxiLGMK', is_csv: true})
+    });
+    it('should accept files as strings (from fs.readFile with an encoding)', () => {
+      let fs = require('fs');
+      let file = fs.readFileSync('./spec/test_files/simple.csv', 'binary');
+      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)

package/spec/test_files/simple.csv

@@ -0,0 +1,2 @@
+1,2,3
+a,b,c