Merge branch 'release' into feature/CCM-17830_Double_prod_rate_limits

Author: gareth-allan

.python-version

@@ -1 +1 @@
-3.10.11
+3.13.2

.tool-versions

@@ -1,4 +1,4 @@
 python 3.13.2
 poetry 2.2.1
 jq 1.6
-nodejs 20.2.0
+nodejs 22.22.3

package-lock.json

@@ -27,7 +27,7 @@
   "devDependencies": {
     "@babel/core": "^7.25.2",
     "@babel/eslint-parser": "^7.25.1",
-    "@redocly/cli": "^2.14.4",
+    "@redocly/cli": "1.34.15",
     "eslint": "^8.57.1",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^8.5.0",
@@ -40,7 +40,7 @@
     "eslint-plugin-unicorn": "^56.0.1",
     "eslint-plugin-workspaces": "^0.11.0",
     "eslint-plugin-yml": "^1.2.0",
-    "hbs-cli": "^1.4.1",
+    "handlebars": "^4.7.9",
     "license-checker": "^25.0.1",
     "minimist": "^1.2.2",
     "newman": "^6.2.2",
@@ -57,6 +57,9 @@
     "flatted": "^3.4.2",
     "postcss": "^8.5.12",
     "lodash": "^4.18.1",
-    "underscore": "^1.13.8"
+    "underscore": "^1.13.8",
+    "glob-promise": {
+      "glob": "^7.2.3"
+    }
   }
 }

package.json

@@ -8,7 +8,7 @@ sonar.qualitygate.wait=true
 sonar.sources=.
 sonar.tests=tests/, sandbox/__test__
 sonar.test.inclusions=tests/**.py, sandbox/__test__/**
-sonar.exclusions=.venv/**,proxies/utils/performance/*
+sonar.exclusions=.venv/**,proxies/utils/performance/*,scripts/render_hbs.js
 
 sonar.python.version=3.10.8
 

scripts/config/sonar-scanner.properties

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+'use strict';
+
+const fs = require('fs');
+const Handlebars = require('handlebars');
+
+const [,, dataFile, templateFile] = process.argv;
+
+if (!dataFile || !templateFile) {
+  console.error('Usage: node scripts/render_hbs.js <data.json> <template.hbs>');
+  process.exit(1);
+}
+
+const data = JSON.parse(fs.readFileSync(dataFile, 'utf8'));
+const templateSource = fs.readFileSync(templateFile, 'utf8');
+const template = Handlebars.compile(templateSource);
+
+// @generated is a data-frame variable used in the nunit template
+const output = template(data, { data: { generated: new Date().toISOString() } });
+process.stdout.write(output);

scripts/render_hbs.js

@@ -22,18 +22,21 @@ export INTEGRATION_PRIVATE_KEY_CONTENTS=$(cat $INTEGRATION_PRIVATE_KEY)
 
 docker build -t zap -f ./zap/Dockerfile .
 
+echo "running zap"
 # run zap in a container
 docker container run \
     --env INTEGRATION_PRIVATE_KEY_CONTENTS="$INTEGRATION_PRIVATE_KEY_CONTENTS" \
-    --env INTEGRATION_API_KEY="$INTEGRATION_API_KEY" \
-    -v $(pwd):/zap/wrk/:rw \
-    -v $TEMP_DIR:/zap/tmp/:rw \
-    -v $(pwd)/zap/comms-manager-json/:/home/zap/.ZAP/reports/comms-manager-json/:rw \
-    -t zap \
-    bash -c "./zap.sh -cmd -autorun /zap/wrk/zap/zap.yaml"
+   --env INTEGRATION_API_KEY="$INTEGRATION_API_KEY" \
+   -v $(pwd):/zap/wrk/:rw \
+   -v $TEMP_DIR:/zap/tmp/:rw \
+   -v $(pwd)/zap/comms-manager-json/:/home/zap/.ZAP/reports/comms-manager-json/:rw \
+   -t zap \
+   bash -c "./zap.sh -cmd -autorun /zap/wrk/zap/zap.yaml"
+
+echo "ended running zap"
 
 # generate our nunit report from the zap JSON report
-./node_modules/.bin/hbs --data $TEMP_DIR/zap-report.json zap/nunit-template.hbs -s > zap-report.xml
+node scripts/render_hbs.js $TEMP_DIR/zap-report.json zap/nunit-template.hbs > zap-report.xml
 
 # delete our zap compatible report
 rm build/communications-manager-zap.json

scripts/run_zap.sh

@@ -17,7 +17,7 @@ The NHS Notify service is intended for services involved in direct care. This AP
 
 ## API status and roadmap
 
-This API is [in production, beta](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses). We are onboarding partners to use it.
+This API is [in production](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses). We are onboarding partners to use it.
 
 We may make additive non-breaking changes to the API without notice, for example the addition of fields to a response or callback, or new optional fields to a request.
 
@@ -215,6 +215,20 @@ Every request includes an `idempotencyKey` field located in the meta collection
 
 If a request fails, our retry policy will continue to attempt to deliver the callback for a period of 2 hours.
 
+## Two-way messaging
+
+**This feature is currently under development and is not yet ready to use.**
+
+Two-way messaging lets a service send a simple question to a recipient through the NHS App and provide a fixed list of possible answers. The recipient can choose one answer from the list, and that response is sent back to the service.
+
+e.g.
+Question: Can you still attend your GP appointment on Tuesday 26th May at 14:00?
+Answer options: [Yes, No]
+
+In order to present the recipient with answers include the `answerOptions` field.
+
+This feature is currently only supported by the NHSAPP channel.
+
 ## Message character limits
 Different character limits apply to each of the communication channels as listed below. NHS Notify will validate that any personalisation fields submitted in the send message request do not exceed these limits but it is the client's responsibility to ensure that when personalisation is combined with any templated text, the channel character limit is not exceeded.
 

specification/documentation/APIDescription.md

@@ -33,6 +33,6 @@ Here is an example curl request which creates a message using one of these routi
   curl -X POST \
     --header "Accept: */*" \
     --header "Content-type: application/vnd.api+json" \
-    -d '{"data": {"type": "Message","attributes": {"routingPlanId": "b838b13c-f98c-4def-93f0-515d4e4f4ee1","messageReference": "da0b1495-c7cb-468c-9d81-07dee089d728","recipient": {"nhsNumber": "9990548609"},"originator": {"odsCode":"X123"},"personalisation": {}}}}' \
+    -d '{"data": {"type": "Message","attributes": {"routingPlanId": "b838b13c-f98c-4def-93f0-515d4e4f4ee1","messageReference": "da0b1495-c7cb-468c-9d81-07dee089d728","recipient": {"nhsNumber": "9990548609"},"originator": {"odsCode":"X123"},"personalisation": {},"answerOptions": {"NHSAPP":[{"code":"Yes"},{"code":"No"}]}}}}' \
     https://sandbox.api.service.nhs.uk/comms/v1/messages
 ```

specification/documentation/CreateMessage.md

@@ -38,6 +38,6 @@ Here is an example curl request which creates a message batch using one of these
   curl -X POST \
     --header "Accept: */*" \
     --header "Content-type: application/vnd.api+json" \
-    -d '{"data": {"type": "MessageBatch","attributes": {"routingPlanId": "b838b13c-f98c-4def-93f0-515d4e4f4ee1","messageBatchReference": "da0b1495-c7cb-468c-9d81-07dee089d728","messages": [{"messageReference": "703b8008-545d-4a04-bb90-1f2946ce1575","recipient": {"nhsNumber": "9990548609"},"originator": {"odsCode":"X123"},"personalisation": {}}]}}}' \
+    -d '{"data": {"type": "MessageBatch","attributes": {"routingPlanId": "b838b13c-f98c-4def-93f0-515d4e4f4ee1","messageBatchReference": "da0b1495-c7cb-468c-9d81-07dee089d728","messages": [{"messageReference": "703b8008-545d-4a04-bb90-1f2946ce1575","recipient": {"nhsNumber": "9990548609"},"originator": {"odsCode":"X123"},"personalisation": {},"answerOptions": {"NHSAPP":[{"code":"Yes"},{"code":"No"}]}}]}}}' \
     https://sandbox.api.service.nhs.uk/comms/v1/message-batches
 ```