Add support for Urgency and Topic optional parameters (#764)

Co-authored-by: Marco Castelluccio <[email protected]>

Author: HGdawy

README.md

@@ -133,6 +133,9 @@ const options = {
     '< header name >': '< header value >'
   },
   contentEncoding: '< Encoding type, e.g.: aesgcm or aes128gcm >',
+  urgency:'< Default is "normal" >',
+  topic:'< Use a maximum of 32 characters from the URL or filename-safe Base64 characters sets. >',
+
   proxy: '< proxy server options >',
   agent: '< https.Agent instance >'
 }
@@ -183,6 +186,8 @@ request only. This overrides any API key set via `setGCMAPIKey()`.
 retained by the push service (by default, four weeks).
 - **headers** is an object with all the extra headers you want to add to the request.
 - **contentEncoding** is the type of push encoding to use (e.g. 'aes128gcm', by default, or 'aesgcm').
+- **urgency** is to indicate to the push service whether to send the notification immediately or prioritize the recipient’s device power considerations for delivery. Provide one of the following values: very-low, low, normal, or high. To attempt to deliver the notification immediately, specify high.
+- **topic** optionally provide an identifier that the push service uses to coalesce notifications. Use a maximum of 32 characters from the URL or filename-safe Base64 characters sets.
 - **proxy** is the [HttpsProxyAgent's constructor argument](https://github.com/TooTallNate/node-https-proxy-agent#new-httpsproxyagentobject-options)
 that may either be a string URI of the proxy server (eg. http://< hostname >:< port >)
 or an "options" object with more specific properties.
@@ -357,6 +362,8 @@ const options = {
     '< header name >': '< header value >'
   },
   contentEncoding: '< Encoding type, e.g.: aesgcm or aes128gcm >',
+  urgency:'< Default is normal "Defult" >',
+  topic:'< Use a maximum of 32 characters from the URL or filename-safe Base64 characters sets. >',
   proxy: '< proxy server options >'
 }
 
@@ -411,6 +418,8 @@ request only. This overrides any API key set via `setGCMAPIKey()`.
 retained by the push service (by default, four weeks).
 - **headers** is an object with all the extra headers you want to add to the request.
 - **contentEncoding** is the type of push encoding to use (e.g. 'aesgcm', by default, or 'aes128gcm').
+- **urgency** is to indicate to the push service whether to send the notification immediately or prioritize the recipient’s device power considerations for delivery. Provide one of the following values: very-low, low, normal, or high. To attempt to deliver the notification immediately, specify high.
+- **topic** optionally provide an identifier that the push service uses to coalesce notifications. Use a maximum of 32 characters from the URL or filename-safe Base64 characters sets.
 - **proxy** is the [HttpsProxyAgent's constructor argument](https://github.com/TooTallNate/node-https-proxy-agent#new-httpsproxyagentobject-options)
 that may either be a string URI of the proxy server (eg. http://< hostname >:< port >)
 or an "options" object with more specific properties.
@@ -509,15 +518,15 @@ object will contain:
 <td>Safari</td>
 
 <!-- Push without payloads support-->
-<td>✗</td>
+<td>✓ v16+ </td>
 
 <!-- Push with payload support -->
-<td>✗</td>
+<td>✓ v16+</td>
 
 <!-- VAPID Support -->
-<td>✗</td>
+<td>✓ v16+</td>
 
-<td></td>
+<td>Safari 16 in macOS 13 or later</td>
 </tr>
 
 <tr>

src/web-push-constants.js

@@ -7,4 +7,11 @@ WebPushConstants.supportedContentEncodings = {
   AES_128_GCM: 'aes128gcm'
 };
 
+WebPushConstants.supportedUrgency = {
+  VERY_LOW: 'very-low',
+  LOW: 'low',
+  NORMAL: 'normal',
+  HIGH: 'high'
+};
+
 module.exports = WebPushConstants;

src/web-push-lib.js

@@ -109,6 +109,8 @@ WebPushLib.prototype.generateRequestDetails = function(subscription, payload, op
     let timeToLive = DEFAULT_TTL;
     let extraHeaders = {};
     let contentEncoding = webPushConstants.supportedContentEncodings.AES_128_GCM;
+    let urgency = webPushConstants.supportedUrgency.NORMAL;
+    let topic;
     let proxy;
     let agent;
     let timeout;
@@ -120,6 +122,8 @@ WebPushLib.prototype.generateRequestDetails = function(subscription, payload, op
         'vapidDetails',
         'TTL',
         'contentEncoding',
+        'urgency',
+        'topic',
         'proxy',
         'agent',
         'timeout'
@@ -173,6 +177,27 @@ WebPushLib.prototype.generateRequestDetails = function(subscription, payload, op
         }
       }
 
+      if (options.urgency) {
+        if ((options.urgency === webPushConstants.supportedUrgency.VERY_LOW
+          || options.urgency === webPushConstants.supportedUrgency.LOW
+          || options.urgency === webPushConstants.supportedUrgency.NORMAL
+          || options.urgency === webPushConstants.supportedUrgency.HIGH)) {
+          urgency = options.urgency;
+        } else {
+          throw new Error('Unsupported urgency specified.');
+        }
+      }
+
+      if (options.Topic) {
+        if (!urlBase64.validate(options.topic)) {
+          throw new Error('Unsupported characters set use the URL or filename-safe Base64 characters set');
+        }
+        if (options.topic.length > 32) {
+          throw new Error('use maximum of 32 characters from the URL or filename-safe Base64 characters set');
+        }
+        topic = options.Topic;
+      }
+
       if (options.proxy) {
         if (typeof options.proxy === 'string'
           || typeof options.proxy.host === 'string') {
@@ -272,6 +297,12 @@ WebPushLib.prototype.generateRequestDetails = function(subscription, payload, op
       requestDetails.headers.Authorization = 'key=' + currentGCMAPIKey;
     }
 
+    requestDetails.headers.Urgency = urgency;
+
+    if (topic) {
+      requestDetails.headers.Topic = topic;
+    }
+
     requestDetails.body = requestPayload;
     requestDetails.endpoint = subscription.endpoint;
 

test/test-generate-request-details.js

@@ -258,7 +258,7 @@ suite('Test Generate Request Details', function() {
       TTL: 100,
       headers: {
         'Topic': 'topic',
-        'Urgency': 'urgency'
+        'Urgency': 'normal'
       }
     };
     let details = webPush.generateRequestDetails(