notifications-node-client 6.0.0 → 7.0.1

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 7.0.1 - 2023-07-13
+
+* Fix a bug with default behaviour for `confirmEmailBeforeDownload`, which coalesced false to null.
+
+## 7.0.0 - 2023-01-12
+
+* Remove support for node versions below v14.17.3.
+
 ## 6.0.0 - 2022-12-22
 
 * Bump jsonwebtokens from 8.5.1 to 9.0.0 to mitigate CVE-2022-23529. We don't believe this CVE affects any use-cases of notifications-node-client; this update is out of best-practice rather than any direct concern.

package/DOCUMENTATION.md

@@ -291,15 +291,13 @@ To send a file by email, add a placeholder to the template then upload a file. T
 
 The links are unique and unguessable. GOV.UK Notify cannot access or decrypt your file.
 
-Your file will be available to download for a default period of 78 weeks (18 months). From 29 March 2023 we will reduce this to 26 weeks (6 months) for all new files. Files sent before 29 March will not be affected.
+Your file will be available to download for a default period of 26 weeks (6 months).
 
 To help protect your files you can also:
 
 * ask recipients to confirm their email address before downloading
 * choose the length of time that a file is available to download
 
-To turn these features on or off, you will need version 5.2.0 of the Node.js client library or a more recent version.
-
 #### Add contact details to the file download page
 
 1. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in).
@@ -344,7 +342,7 @@ The method returns a [promise](https://developer.mozilla.org/en-US/docs/Web/Java
 
 ##### CSV Files
 
-Uploads for CSV files should use the `isCsv` parameter on the `prepareUpload()` function.  For example:
+Uploads for CSV files should use the `isCsv` option on the `prepareUpload()` function.  For example:
 
 ```javascript
 var fs = require('fs')
@@ -355,7 +353,7 @@ fs.readFile('path/to/document.csv', function (err, csvFile) {
     personalisation: {
       first_name: 'Amala',
       application_date: '2018-01-01',
-      link_to_file: notifyClient.prepareUpload(csvFile, true)
+      link_to_file: notifyClient.prepareUpload(csvFile, { isCsv: true })
     }
   }).then(response => console.log(response)).catch(err => console.error(err))
 })
@@ -363,38 +361,13 @@ fs.readFile('path/to/document.csv', function (err, csvFile) {
 
 #### Ask recipients to confirm their email address before they can download the file
 
-This new security feature is optional. You should use it if you send files that are sensitive - for example, because they contain personal information about your users.
-
 When a recipient clicks the link in the email you’ve sent them, they have to enter their email address. Only someone who knows the recipient’s email address can download the file.
 
-From 29 March 2023, we will turn this feature on by default for every file you send. Files sent before 29 March will not be affected.
-
-##### Turn on email address check
-
-To use this feature before 29 March 2023 you will need version 5.2.0 of the Node.js client library, or a more recent version.
-
-To make the recipient confirm their email address before downloading the file, set the `confirmEmailBeforeDownload` flag to `true`.
-
-You will not need to do this after 29 March.
-
-```javascript
-var fs = require('fs')
-
-fs.readFile('path/to/document.pdf', function (err, pdfFile) {
-  console.log(err)
-  notifyClient.sendEmail(templateId, emailAddress, {
-    personalisation: {
-      first_name: 'Amala',
-      application_date: '2018-01-01',
-      link_to_file: notifyClient.prepareUpload(pdfFile, false, true, undefined)
-    }
-  }).then(response => console.log(response)).catch(err => console.error(err))
-})
-```
+This security feature is turned on by default.
 
 ##### Turn off email address check (not recommended)
 
-If you do not want to use this feature after 29 March 2023, you can turn it off on a file-by-file basis.
+If you do not want to use this feature, you can turn it off on a file-by-file basis.
 
 To do this you will need version 5.2.0 of the Node.js client library, or a more recent version.
 
@@ -404,7 +377,7 @@ You should not turn this feature off if you send files that contain:
 * commercially sensitive information
 * information classified as ‘OFFICIAL’ or ‘OFFICIAL-SENSITIVE’ under the [Government Security Classifications](https://www.gov.uk/government/publications/government-security-classifications) policy
 
-To let the recipient download the file without confirming their email address, set the `confirmEmailBeforeDownload` flag to `false`.
+To let the recipient download the file without confirming their email address, set the `confirmEmailBeforeDownload` option to `false`.
 
 ```javascript
 var fs = require('fs')
@@ -415,7 +388,7 @@ fs.readFile('path/to/document.pdf', function (err, pdfFile) {
     personalisation: {
       first_name: 'Amala',
       application_date: '2018-01-01',
-      link_to_file: notifyClient.prepareUpload(pdfFile, false, false, undefined)
+      link_to_file: notifyClient.prepareUpload(pdfFile, { confirmEmailBeforeDownload: false })
     }
   }).then(response => console.log(response)).catch(err => console.error(err))
 })
@@ -423,13 +396,15 @@ fs.readFile('path/to/document.pdf', function (err, pdfFile) {
 
 #### Choose the length of time that a file is available to download
 
-Set the number of weeks you want the file to be available using the `retentionPeriod` parameter.
+Set the number of weeks you want the file to be available using the `retentionPeriod` option.
 
 You can choose any value between 1 week and 78 weeks.
 
 To use this feature will need version 5.2.0 of the Node.js client library, or a more recent version.
 
-If you do not choose a value, the file will be available for the default period of 78 weeks (18 months).
+If you do not choose a value, the file will be available for the default period of 26 weeks (6 months).
+
+Files sent before 12 April 2023 had a longer default period of 78 weeks (18 months).
 
 ```javascript
 var fs = require('fs')
@@ -440,7 +415,7 @@ fs.readFile('path/to/document.pdf', function (err, pdfFile) {
     personalisation: {
       first_name: 'Amala',
       application_date: '2018-01-01',
-      link_to_file: notifyClient.prepareUpload(pdfFile, false, undefined, '52 weeks')
+      link_to_file: notifyClient.prepareUpload(pdfFile, { retentionPeriod: '52 weeks' })
     }
   }).then(response => console.log(response)).catch(err => console.error(err))
 })

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:12.16.1-slim
+FROM ghcr.io/alphagov/notify/node:18-slim
 
 ENV DEBIAN_FRONTEND=noninteractive
 

package/client/notification.js

@@ -368,7 +368,7 @@ Object.assign(NotifyClient.prototype, {
           data.is_csv = options.isCsv;
         }
 
-        data.confirm_email_before_download = options.confirmEmailBeforeDownload || null;
+        data.confirm_email_before_download = options.confirmEmailBeforeDownload !== undefined ? options.confirmEmailBeforeDownload : null;
         data.retention_period = options.retentionPeriod || null
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notifications-node-client",
-  "version": "6.0.0",
+  "version": "7.0.1",
   "homepage": "https://docs.notifications.service.gov.uk/node.html",
   "repository": {
     "type": "git",
@@ -14,8 +14,8 @@
     "integration": "mocha spec/integration/test.js"
   },
   "engines": {
-    "npm": ">=6.12.0",
-    "node": ">=12.13.0"
+    "npm": ">=6.14.13",
+    "node": ">=14.17.3"
   },
   "author": "GDS developers",
   "license": "MIT",
@@ -29,7 +29,7 @@
     "chai-json-schema": "1.5.0",
     "chai-bytes": "0.1.2",
     "jsonschema": "1.2.4",
-    "mocha": "5.2.0",
+    "mocha": "10.1.0",
     "mockdate": "2.0.2",
     "nock": "9.2.6",
     "optimist": "0.6.1",

package/spec/notification.js

@@ -228,6 +228,13 @@ describe('notification api', () => {
       ).contains({is_csv: false, confirm_email_before_download: null, retention_period: null})
     });
 
+    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})
+    });
+
     it('should allow send a file email confirmation to be set', () => {
       let file = Buffer.alloc(2*1024*1024)
       expect(