notifications-node-client 8.3.0 → 8.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notifications-node-client",
-  "version": "8.3.0",
+  "version": "8.3.1",
   "homepage": "https://docs.notifications.service.gov.uk/node.html",
   "repository": {
     "type": "git",
@@ -9,12 +9,17 @@
   "description": "GOV.UK Notify Node.js client ",
   "main": "index.js",
   "types": "types/index.d.ts",
+  "files": [
+    "client",
+    "types",
+    "tsconfig.json"
+  ],
   "scripts": {
     "test": "mocha \"spec/**/*.js\" && npm run test:markdown:standard",
     "test:markdown:standard": "standard-markdown DOCUMENTATION.md",
     "integration": "mocha spec/integration/test.js",
     "build:types": "tsc",
-    "check:types": "tsc --noEmit"
+    "check:types": "tsc --noEmit ./spec/types-test.ts"
   },
   "engines": {
     "npm": ">=6.14.13",

package/.dockerignore

@@ -1 +0,0 @@
-**/.git/*

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,18 +0,0 @@
-<!--Thanks for contributing to GOV.UK Notify. Using this template to write your pull request message will help get it merged as soon as possible. -->
-
-## What problem does the pull request solve?
-<!--- Describe why you’re making this change -->
-
-## Checklist
-
-<!--- All of the following are normally needed. Don’t worry if you haven’t done them or don’t know how – someone from the Notify team will be able to help. -->
-- [x] I’ve used the pull request template
-- [ ] I’ve written unit tests for these changes
-- [ ] I’ve updated the documentation in
-  - [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`
-- [ ] I've added new environment variables in
-  - `CONTRIBUTING.md`
-  - `notifications-node-client/scripts/generate_docker_env.sh`

package/CHANGELOG.md

@@ -1,297 +0,0 @@
-## 8.3.0 - 2026-02-19
-
-* Adds Typescript hints (run `npm build:types` to generate type files in `types/`)
-* Bump axios from 1.7.2 to 1.13.5
-
-## 8.2.1 - 2024-07-03
-
-* Fix a bug where an internal API client function isn't being exposed in the library.
-
-## 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.
-    * `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
-
-## 7.0.5 - 2023-11-13
-
-* Fix a few cases of assignment to undeclared (global) variables
-
-## 7.0.4 - 2023-11-10
-
-* 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
-
-* Bump semver from 5.7.1 to 5.7.2
-
-## 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.
-* Remove support for node versions below v12.
-
-## 5.2.3 - 2022-11-22
-
-* Bump follow-redirects from 1.14.7 to 1.15.2
-
-## 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:
-  * `confirmEmailBeforeDownload` can be set to `true` to require the user to enter their email address before accessing the file.
-  * `retentionPeriod` can be set to `<1-78> weeks` to set how long the file should be made available.
-
-* The `isCsv` parameter to `prepareUpload` has now been replaced by an `options` parameter. The implementation has been done in a backwards-compatible way, so if you are just sending `true/false` values as the seecond parameter, that will continue to work. Though we still recommend updating to use the new options format.
-
-
-## 5.1.2 - 2022-09-23
-
-Remove underscore.js dependencyr new send a file features)
-
-## 5.1.1 - 2022-01-18
-
-Upgrade axios version from ^0.21.1 to ^0.25.0
-
-## 5.1.0 - 2020-12-30
-
-### Changed
-
-* Upgrade axios version from 0.19.2 to 0.21.1
-* Allow any compatible version of axios to be used (0.21.1 to <1.0.0)
-* Allow any compatible version of jsonwebtoken to be used (8.2.1 to <9.0.0)
-
-## 5.0.2 - 2020-11-20
-
-### Changed
-
-Correct incorrect description of parameter to be used by `NotifyClient.setProxy`
-
-## 5.0.1 - 2020-11-18
-
-### Changed
-
-Remove unintentional global nature of variable `version`
-
-## 5.0.0 - 2020-09-02
-
-### Changed
-
-We have replaced the use of the npm [request-promise](https://www.npmjs.com/package/request-promise) package with [axios](https://www.npmjs.com/package/axios) as the npm [request](https://www.npmjs.com/package/request) package has been deprecated. This makes the following breaking changes:
-
-1. The `response` `object` returned by a successful API call is now in the form of an [axios response](https://www.npmjs.com/package/axios#response-schema). This has a different interface to a [request response](https://nodejs.org/api/http.html#http_class_http_incomingmessage). For example:
-
-    * `response.body` becomes `response.data`
-    * `response.statusCode` becomes `response.status`
-
-2. The `err` `object` returned by an unsuccessful API call has a different interface. For example, `err.error` becomes `err.response.data`. See the axios documentation for further details on [error handling](https://www.npmjs.com/package/axios#handling-errors).
-
-3. To configure the use of a proxy you should pass the proxy configuration as an `object` rather than a URL. For details, see the [axios client](https://github.com/axios/axios).
-
-4. We now return native [promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises) rather than [bluebird promises](http://bluebirdjs.com). You will not need to make any changes unless you are using some of the additional methods found on bluebird promises that do not exist on native promises.
-
-
-## 4.9.0 - 2020-08-19
-
-### Changed
-
-* Added `letter_contact_block` to the responses for `getTemplateById`, `getTemplateByIdAndVersion` and `getAllTemplates`.
-
-## 4.8.0 - 2020-06-18
-
-### Changed
-
-* Add support for an optional `isCsv` parameter in the `prepareUpload` function. This fixes a bug when sending a CSV file by email. This ensures that the file is downloaded as a CSV rather than a TXT file.
-
-## [4.7.3] - 2020-04-03
-
-### Changed
-
-* Remove `__dirname` global call from api client
-
-## [4.7.2] - 2020-01-31
-
-### Changed
-
-* Add homepage to package.json
-
-## [4.7.1] - 2020-01-27
-
-### Changed
-
-* Refer to files, not documents, in error messages
-
-## [4.7.0] - 2019-11-01
-
-### Changed
-
-* Add `notifyClient.getPdfForLetterNotification(notificationId)`
-    * Returns a Buffer with pdf data
-    * Will raise a BadRequestError if the PDF is not available
-
-## [4.6.0] - 2019-02-01
-
-### Changed
-
-* Added an optional postage argument to `sendPrecompiledLetter`
-
-## [4.5.2] - 2018-11-05
-
-### Changed
-
-* Moved documentation to https://docs.notifications.service.gov.uk/node.html (generated from DOCUMENTATION.md)
-
-## [4.5.1] - 2018-09-14
-
-### Changed
-
-* Made formatting consistent across documentation.
-
-## [4.5.0] - 2018-09-13
-
-### Changed
-
-* Added a function to send precompiled letter through the client.
-    * the new function uses a helper function to check if the file size is within the 5MB limit and to encode the file using base64. Then a POST request to our API is made with the file data and user reference.
-    * instructions for the new functionality added to the documentation.
-
-## [4.4.0] - 2018-09-05
-
-### Changed
-
-* Added instructions for uploading a document to be linked to from an email notification.
-    * Created a helper function `prepareUpload` as a part of this development. This function encodes the document that is to be uploaded with base64 and returns a dictionary with prepared document as a value (the way our API is prepared to receive it). It also checks if the provided file is not larger than 2MB. The function throws an error if the file is too big.
-
-## [4.3.0] - 2018-09-04
-
-* Added `name` to the response for `getTemplateById()` and `getTemplateByIdAndVersion()`
-    * These functions now return the name of the template as set in Notify
-
-## [4.2.0] - 2018-07-24
-
-### Changed
-
-* Added `created_by_name` to the response for `.getNotificationById()` and `.getNotifications()`:
-    * If the notification was sent manually this will be the name of the sender. If the notification was sent through the API this will be `null`.
-
-## [4.1.0] - 2017-11-23
-
-### Changed
-
-* Added new method:
-    * `getReceivedTexts` - get one page of text messages (250) per call
-
-## [4.0.0] - 2017-11-07
-
-### Changed
-
-* Updated `sendSms`, `sendEmail` and `sendLetter` to take an `options` object as a parameter.
-    * `personalisation`, `reference`, `smsSenderId` and `emailReplyToId` now need to be passed to these functions inside `options`.
-* Removed the unused `Crypto` dependency
-
-## [3.5.0] - 2017-11-01
-
-### Changed
-
-* Updated `sendSms` method with optional argument:
-    * `smsSenderId` - specify the identifier of the sms sender (optional)
-
-## [3.4.0] - 2017-10-19
-
-### Changed
-
-* Added new method:
-    * `sendLetter` - send a letter
-
-## [3.3.0] - 2017-10-13
-
-### Changed
-
-* Updated `sendEmail` method with optional argument:
-    * `emailReplyToId` - specify the identifier of the email reply-to address (optional)
-
-## [3.2.0] - 2017-09-22
-
-### Changed
-
-* Added new method:
-    * `setProxy(proxyUrl)` - specify the URL of a proxy for the client to use (optional)
-
-## [3.1.0] - 2017-05-10
-
-### Changed
-
-* Added new methods for managing templates:
-    * `getTemplateById` - retrieve a single template
-    * `getTemplateByIdAndVersion` - retrieve a specific version for a desired template
-    * `getAllTemplates` - retrieve all templates (can filter by type)
-    * `previewTemplateById` - preview a template with personalisation applied
-
-* Update README to describe how to catch errors
-
-## [3.0.0] - 2016-12-16
-
-### Changed
-
-* Using v2 of the notification-api.
-
-* Update to `notifyClient.sendSms()`:
-    * Added `reference`: an optional identifier you generate if you don’t want to use Notify’s `id`. It can be used to identify a single notification or a batch of notifications.
-    * Updated method signature:
-
- ```javascript
- notifyClient.sendSms(templateId, phoneNumber, personalisation, reference);
-```
-     * Where `personalisation` and `reference` can be `undefined`.
-
-* Update to `notifyClient.sendEmail()`:
-    * Added `reference`: an optional identifier you generate if you don’t want to use Notify’s `id`. It can be used to identify a single notification or a batch of notifications.
-    * Updated method signature:
-
- ```javascript
- notifyClient.sendEmail(templateId, emailAddress, personalisation, reference);
-```
-     * Where `personalisation` and `reference` can be `undefined`.
-* `NotificationClient.getAllNotifications()`
-    * Notifications can now be filtered by `reference` and `olderThanId`, see the README for details.
-    * Updated method signature:
-
- ```javascript
- notifyClient.getNotifications(templateType, status, reference, olderThanId);
-```
-     * Each one of these parameters can be `undefined`
-
-# Prior versions
-
-Changelog not recorded - please see pull requests on github.

package/CONTRIBUTING.md

@@ -1,59 +0,0 @@
-# Contributing
-
-Pull requests welcome.
-
-## Setting Up
-
-### Docker container
-
-This app uses dependencies that are difficult to install locally. In order to make local development easy, we run app commands through a Docker container. Run the following to set this up:
-
-```shell
-make bootstrap-with-docker
-```
-
-### `environment.sh`
-
-In the root directory of the repo, run:
-
-```
-notify-pass credentials/client-integration-tests > environment.sh
-```
-
-Unless you're part of the GOV.UK Notify team, you won't be able to run this command or the Integration Tests. However, the file still needs to exist - run `touch environment.sh` instead.
-
-## Tests
-
-There are unit and integration tests that can be run to test functionality of the client.
-
-### Unit tests
-
-To run the unit tests:
-
-```
-make test-with-docker
-```
-
-### Integration Tests
-
-To run the integration tests:
-
-```
-make integration-test-with-docker
-```
-
-## Working on the client locally
-
-```
-npm install --save notifications-node-client
-```
-
-## Testing JavaScript examples in Markdown
-
-We automatically test that the JavaScript in the documentation examples matches [our linting standards](https://gds-way.cloudapps.digital/manuals/programming-languages/nodejs/#source-formatting-and-linting). This also catches some issues that could stop an example from running when copied.
-
-You can fix issues automatically by running:
-
-```
-npm run test:markdown:standard -- --fix
-```

package/Dockerfile

@@ -1,17 +0,0 @@
-FROM ghcr.io/alphagov/notify/node:18-slim
-
-ENV DEBIAN_FRONTEND=noninteractive
-
-RUN \
-	echo "Install base packages" \
-	&& apt-get update \
-	&& apt-get install -y --no-install-recommends \
-		awscli \
-		make \
-		gnupg \
-		jq \
-	&& echo "Clean up" \
-	&& rm -rf /var/lib/apt/lists/* /tmp/*
-
-WORKDIR /var/project
-COPY . .

package/Makefile

@@ -1,42 +0,0 @@
-.DEFAULT_GOAL := help
-SHELL := /bin/bash
-
-.PHONY: help
-help:
-	@cat $(MAKEFILE_LIST) | grep -E '^[a-zA-Z_-]+:.*?## .*$$' | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
-
-.PHONY: bootstrap
-bootstrap:  ## Install build dependencies
-	npm ci
-
-.PHONY: build
-build: bootstrap ## Build project (dummy task for CI)
-
-.PHONY: test
-test: ## Run tests
-	npm run check:types
-	npm test
-
-.PHONY: integration-test
-integration-test: ## Run integration tests
-	npm test --integration
-
-.PHONY: bootstrap-with-docker
-bootstrap-with-docker: ## Prepare the Docker builder image
-	docker build -t notifications-node-client .
-	./scripts/run_with_docker.sh make bootstrap
-
-.PHONY: test-with-docker
-test-with-docker: ## Run tests inside a Docker container
-	./scripts/run_with_docker.sh make test
-
-.PHONY: integration-test-with-docker
-integration-test-with-docker: ## Run integration tests inside a Docker container
-	./scripts/run_with_docker.sh make integration-test
-
-.PHONY: get-client-version
-get-client-version: ## Retrieve client version number from source code
-	@node -p "require('./package.json').version"
-
-clean:
-	rm -rf .cache venv

package/scripts/run_with_docker.sh

@@ -1,21 +0,0 @@
-DOCKER_IMAGE_NAME=notifications-node-client
-
-source environment.sh
-
-docker run \
-  --rm \
-  -v "`pwd`:/var/project" \
-  -e NOTIFY_API_URL=${NOTIFY_API_URL} \
-  -e API_KEY=${API_KEY} \
-  -e FUNCTIONAL_TEST_NUMBER=${FUNCTIONAL_TEST_NUMBER} \
-  -e FUNCTIONAL_TEST_EMAIL=${FUNCTIONAL_TEST_EMAIL} \
-  -e EMAIL_TEMPLATE_ID=${EMAIL_TEMPLATE_ID} \
-  -e SMS_TEMPLATE_ID=${SMS_TEMPLATE_ID} \
-  -e LETTER_TEMPLATE_ID=${LETTER_TEMPLATE_ID} \
-  -e EMAIL_REPLY_TO_ID=${EMAIL_REPLY_TO_ID} \
-  -e SMS_SENDER_ID=${SMS_SENDER_ID} \
-  -e API_SENDING_KEY=${API_SENDING_KEY} \
-  -e INBOUND_SMS_QUERY_KEY=${INBOUND_SMS_QUERY_KEY} \
-  -it \
-  ${DOCKER_IMAGE_NAME} \
-  ${@}

package/scripts/test_send.js

@@ -1,57 +0,0 @@
-var argv = require('optimist')
-    .usage('Usage: $0' +
-      ' -b [baseUrl]' +
-      ' -s [notify secret]' +
-      ' -t [templateId]' +
-      ' -d [destination (email address or phone number, not needed for letters]' +
-      ' -p [personalisation (required for letter {"address_line_1": "mrs test", "address_line_2": "1 test street", "postcode": "SW1 1AA"})]' +
-      ' -m [type (email, sms or letter, default email)]')
-    .demand(['s', 't'])
-    .argv,
-  NotifyClient = require('../client/notification').NotifyClient,
-  notifyClient,
-
-  baseUrl = argv.b || 'https://api.notifications.service.gov.uk',
-  secret = argv.s,
-  templateId = argv.t,
-  destination = argv.d,
-  personalisation = argv.p ? JSON.parse(argv.p) : null,
-  type = argv.m || 'email';
-
-notifyClient = new NotifyClient(baseUrl, secret);
-
-switch(type) {
-
-  case 'email':
-    notifyClient.sendEmail(templateId, destination, personalisation)
-      .then(function(response) {
-        console.log('Notify response: ' + JSON.stringify(response));
-      })
-      .catch(function(error) {
-        console.log('Error ' + error);
-      });
-    break;
-
-  case 'sms':
-    notifyClient.sendSms(templateId, String(destination), personalisation)
-      .then(function(response) {
-        console.log('Notify response: ' + JSON.stringify(response));
-      })
-      .catch(function(error) {
-        console.log('Error ' + error);
-      });
-    break;
-
-  case 'letter':
-    notifyClient.sendLetter(templateId, personalisation)
-      .then(function(response) {
-        console.log('Notify response: ' + JSON.stringify(response));
-      })
-      .catch(function(error) {
-        console.log('Error ' + error);
-      });
-    break;
-
-  default:
-    console.log('Unrecognised notification type');
-}