notifications-node-client 7.0.3 → 7.0.4

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## 7.0.3 - 2023-07-21
 
+* Bump axios to the 1.x branch to address CVE-2023-45857. Due to underlying changes in Axios you may have to explicitly set the `protocol` property when constructing your `proxyConfig` object, if using a proxy.
+
+## 7.0.3 - 2023-07-21
+
 * Bump word-wrap from 1.2.3 to 1.2.4 to address CVE-2023-26115.
 
 ## 7.0.2 - 2023-07-13

package/DOCUMENTATION.md

@@ -316,7 +316,7 @@ Your email should also tell recipients how long the file will be available to do
 
 #### Upload your file
 
-You can upload PDF, CSV, .odt, .txt, .rtf, .xlsx and MS Word Document files. Your file must be smaller than 2MB. [Contact the GOV.UK Notify team](https://www.notifications.service.gov.uk/support/ask-question-give-feedback) if you need to send other file types.
+You can upload PDF, CSV, JSON, .odt, .txt, .rtf, .xlsx and MS Word Document files. Your file must be smaller than 2MB. [Contact the GOV.UK Notify team](https://www.notifications.service.gov.uk/support/ask-question-give-feedback) if you need to send other file types.
 
 Pass the file object as a value into the `personalisation` argument. For example:
 
@@ -398,10 +398,13 @@ fs.readFile('path/to/document.pdf', function (err, pdfFile) {
 
 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.
 
+You can choose any value between 1 week and 78 weeks. When deciding this, you should consider:
+
+* the need to protect the recipient’s personal information
+* whether the recipient will need to download the file again later
+
 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).
@@ -872,7 +875,7 @@ If the request is not successful, the promise fails with an `err`.
 |#`sending`|GOV.UK Notify has sent the message to the provider. The provider will try to deliver the message to the recipient for up to 72 hours. GOV.UK Notify is waiting for delivery information.|
 |#`pending`|GOV.UK Notify is waiting for more delivery information.<br>GOV.UK Notify received a callback from the provider but the recipient’s device has not yet responded. Another callback from the provider determines the final status of the text message.|
 |#`sent`|The message was sent to an international number. The mobile networks in some countries do not provide any more delivery information. The GOV.UK Notify website displays this status as 'Sent to an international number'.|
-|#`delivered`|The message was successfully delivered.|
+|#`delivered`|The message was successfully delivered. If a recipient blocks your sender name or mobile number, your message will still show as delivered.|
 |#`permanent-failure`|The provider could not deliver the message. This can happen if the phone number was wrong or if the network operator rejects the message. If you’re sure that these phone numbers are correct, you should [contact GOV.UK Notify support](https://www.notifications.service.gov.uk/support). If not, you should remove them from your database. You’ll still be charged for text messages that cannot be delivered.
 |#`temporary-failure`|The provider could not deliver the message. This can happen when the recipient’s phone is off, has no signal, or their text message inbox is full. You can try to send the message again. You’ll still be charged for text messages to phones that are not accepting messages.|
 |#`technical-failure`|Your message was not sent because there was a problem between Notify and the provider.<br>You’ll have to try sending your messages again. You will not be charged for text messages that are affected by a technical failure.|
@@ -1207,7 +1210,10 @@ You can also set up [callbacks](#callbacks) for received text messages.
 
 ### Enable received text messages
 
-Contact the GOV.UK Notify team using the [support page](https://www.notifications.service.gov.uk/support) or [chat to us on Slack](https://ukgovernmentdigital.slack.com/messages/C0E1ADVPC) to request a unique number for text message replies.
+To receive text messages:
+
+1. Go to the **Text message settings** section of the **Settings** page.
+1. Select **Change** on the **Receive text messages** row.
 
 ### Get a page of received text messages
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notifications-node-client",
-  "version": "7.0.3",
+  "version": "7.0.4",
   "homepage": "https://docs.notifications.service.gov.uk/node.html",
   "repository": {
     "type": "git",
@@ -21,7 +21,7 @@
   "license": "MIT",
   "dependencies": {
     "jsonwebtoken": "^9.0.0",
-    "axios": "^0.25.0"
+    "axios": "^1.2.0"
   },
   "devDependencies": {
     "chai": "4.1.2",
@@ -36,3 +36,4 @@
     "standard-markdown": "5.0.1"
   }
 }
+

package/spec/api_client.js

@@ -82,7 +82,7 @@ describe('api client', function () {
 
   it('should direct get requests through the proxy when set', function (done) {
     var urlBase = 'https://api.notifications.service.gov.uk',
-      proxyConfig = { host: 'addressofmyproxy.test'},
+      proxyConfig = { host: 'addressofmyproxy.test', protocol: 'http'},
       path = '/email',
       apiClient = new ApiClient(urlBase, 'apiKey');
 
@@ -101,7 +101,7 @@ describe('api client', function () {
 
   it('should direct post requests through the proxy when set', function (done) {
     var urlBase = 'https://api.notifications.service.gov.uk',
-      proxyConfig = { host: 'addressofmyproxy.test'},
+      proxyConfig = { host: 'addressofmyproxy.test', protocol: 'http'},
       path = '/email',
       apiClient = new ApiClient(urlBase, 'apiKey');