feat: Add support for Live Activity with ActivityKit push notifications (#130)

Author: dplewis

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
             NODE_VERSION: 14
           - name: Node.js 16
             NODE_VERSION: 16
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
       - uses: actions/checkout@v2

README.md

@@ -148,6 +148,40 @@ This will result in the the following notification payload being sent to the dev
 {"messageFrom":"John Appelseed","aps":{"badge":3,"sound":"ping.aiff","alert":"\uD83D\uDCE7 \u2709 You have a new message"}}
 ```
 
+Create a Live Activity notification object, configuring it with the relevant parameters (See the [notification documentation](doc/notification.markdown) for more details.)
+
+```javascript
+var note = new apn.Notification();
+
+note.expiry = Math.floor(Date.now() / 1000) + 3600; // Expires 1 hour from now.
+note.badge = 3;
+note.sound = "ping.aiff";
+note.alert = "\uD83D\uDCE7 \u2709 You have a new message";
+note.payload = {'messageFrom': 'John Appleseed'};
+note.topic = "<your-app-bundle-id>";
+note.pushType = "liveactivity",
+note.relevanceScore = 75,
+note.timestamp = Math.floor(Date.now() / 1000); // Current time
+note.staleDate = Math.floor(Date.now() / 1000) + (8 * 3600); // Expires 8 hour from now.
+note.event = "update"
+note.contentState = {}
+```
+
+Send the notification to the API with `send`, which returns a promise.
+
+```javascript
+apnProvider.send(note, deviceToken).then( (result) => {
+  // see documentation for an explanation of result
+});
+```
+
+This will result in the the following notification payload being sent to the device
+
+
+```json
+{"messageFrom":"John Appleseed","aps":{"badge":3,"sound":"ping.aiff","alert":"\uD83D\uDCE7 \u2709 You have a new message", "relevance-score":75,"timestamp":1683129662,"stale-date":1683216062,"event":"update","content-state":{}}}
+```
+
 You should only create one `Provider` per-process for each certificate/key pair you have. You do not need to create a new `Provider` for each notification. If you are only sending notifications to one app then there is no need for more than one `Provider`.
 
 If you are constantly creating `Provider` instances in your app, make sure to call `Provider.shutdown()` when you are done with each provider to release its resources and memory.

doc/notification.markdown

@@ -107,6 +107,11 @@ This table shows the name of the setter, with the key-path of the underlying pro
 | `targetContentIdentifier`  | `aps.target-content-id`     | `String`            |
 | `threadId`                 | `aps.thread-id`             | `String`            |
 | `interruptionLevel`        | `aps.interruption-level`    | `String`            |
+| `relevanceScore`           | `aps.relevance-score`       | `Number`            |
+| `timestamp`                | `aps.timestamp`             | `Number`            |
+| `staleDate`                | `aps.staleDate`             | `Number`            |
+| `event`                    | `aps.event`                 | `String`            |
+| `contentState`             | `aps.content-state`         | `Object`            |
 | `mdm`                      | `mdm`                       | `String`            |
 
 When the notification is transmitted these properties will be added to the output before encoding.

lib/notification/apsProperties.js

@@ -83,6 +83,36 @@ module.exports = {
     }
   },
 
+  set relevanceScore(value) {
+    if (typeof value === 'number' || value === undefined) {
+      this.aps['relevance-score'] = value;
+    }
+  },
+
+  set timestamp(value) {
+    if (typeof value === 'number' || value === undefined) {
+      this.aps.timestamp = value;
+    }
+  },
+
+  set staleDate(value) {
+    if (typeof value === 'number' || value === undefined) {
+      this.aps['stale-date'] = value;
+    }
+  },
+
+  set event(value) {
+    if (typeof value === 'string' || value === undefined) {
+      this.aps.event = value;
+    }
+  },
+
+  set contentState(value) {
+    if (typeof value === 'object' || value === undefined) {
+      this.aps['content-state'] = value;
+    }
+  },
+
   set contentAvailable(value) {
     if (value === true || value === 1) {
       this.aps['content-available'] = 1;

lib/notification/index.js

@@ -49,6 +49,11 @@ Notification.prototype = require('./apsProperties');
   'threadId',
   'interruptionLevel',
   'targetContentIdentifier',
+  'relevanceScore',
+  'timestamp',
+  'staleDate',
+  'event',
+  'contentState',
 ].forEach(propName => {
   const methodName = 'set' + propName[0].toUpperCase() + propName.slice(1);
   Notification.prototype[methodName] = function (value) {

test/client.js

@@ -521,6 +521,7 @@ describe('Client', () => {
           }, 1);
         });
       });
+      clientSocket.on('error', () => {});
     });
     await new Promise(resolve => proxy.listen(3128, resolve));
 

test/notification/apsProperties.js

@@ -832,6 +832,142 @@ describe('Notification', function () {
       });
     });
 
+    describe('event', function () {
+      it('defaults to undefined', function () {
+        expect(compiledOutput()).to.not.have.nested.property('aps.event');
+      });
+
+      it('can be set to a string', function () {
+        note.event = 'the-event';
+
+        expect(compiledOutput()).to.have.nested.property('aps.event', 'the-event');
+      });
+
+      it('can be set to undefined', function () {
+        note.event = 'the-event';
+        note.event = undefined;
+
+        expect(compiledOutput()).to.not.have.nested.property('aps.event');
+      });
+
+      describe('setEvent', function () {
+        it('is chainable', function () {
+          expect(note.setEvent('the-event')).to.equal(note);
+          expect(compiledOutput()).to.have.nested.property('aps.event', 'the-event');
+        });
+      });
+    });
+
+    describe('timestamp', function () {
+      it('defaults to undefined', function () {
+        expect(compiledOutput()).to.not.have.nested.property('aps.timestamp');
+      });
+
+      it('can be set to a number', function () {
+        note.timestamp = 1234;
+
+        expect(compiledOutput()).to.have.nested.property('aps.timestamp', 1234);
+      });
+
+      it('can be set to undefined', function () {
+        note.timestamp = 1234;
+        note.timestamp = undefined;
+
+        expect(compiledOutput()).to.not.have.nested.property('aps.timestamp');
+      });
+
+      describe('setTimestamp', function () {
+        it('is chainable', function () {
+          expect(note.setTimestamp(1234)).to.equal(note);
+          expect(compiledOutput()).to.have.nested.property('aps.timestamp', 1234);
+        });
+      });
+    });
+
+    describe('relevance-score', function () {
+      it('defaults to undefined', function () {
+        expect(compiledOutput()).to.not.have.nested.property('aps.relevance-score');
+      });
+
+      it('can be set to a number', function () {
+        note.relevanceScore = 1234;
+
+        expect(compiledOutput()).to.have.nested.property('aps.relevance-score', 1234);
+      });
+
+      it('can be set to undefined', function () {
+        note.relevanceScore = 1234;
+        note.relevanceScore = undefined;
+
+        expect(compiledOutput()).to.not.have.nested.property('aps.relevance-score');
+      });
+
+      describe('setRelevanceScore', function () {
+        it('is chainable', function () {
+          expect(note.setRelevanceScore(1234)).to.equal(note);
+          expect(compiledOutput()).to.have.nested.property('aps.relevance-score', 1234);
+        });
+      });
+    });
+
+    describe('stale-date', function () {
+      it('defaults to undefined', function () {
+        expect(compiledOutput()).to.not.have.nested.property('aps.stale-date');
+      });
+
+      it('can be set to a number', function () {
+        note.staleDate = 1234;
+
+        expect(compiledOutput()).to.have.nested.property('aps.stale-date', 1234);
+      });
+
+      it('can be set to undefined', function () {
+        note.staleDate = 1234;
+        note.staleDate = undefined;
+
+        expect(compiledOutput()).to.not.have.nested.property('aps.stale-date');
+      });
+
+      describe('setStaleDate', function () {
+        it('is chainable', function () {
+          expect(note.setStaleDate(1234)).to.equal(note);
+          expect(compiledOutput()).to.have.nested.property('aps.stale-date', 1234);
+        });
+      });
+    });
+
+    describe('content-state', function () {
+      const payload = { foo: 'bar' };
+      it('defaults to undefined', function () {
+        expect(compiledOutput()).to.not.have.nested.property('aps.content-state');
+      });
+
+      it('can be set to a object', function () {
+        note.contentState = payload;
+
+        expect(compiledOutput())
+          .to.have.nested.property('aps.content-state')
+          .that.deep.equals(payload);
+      });
+
+      it('can be set to undefined', function () {
+        note.contentState = payload;
+        note.contentState = undefined;
+
+        expect(compiledOutput()).to.not.have.nested.property('aps.content-state');
+      });
+
+      describe('setContentState', function () {
+        it('is chainable', function () {
+          expect(note.setContentState(payload)).to.equal(note);
+          console.log(compiledOutput());
+          expect(compiledOutput())
+            .to.have.nested.property('aps.content-state')
+            .that.deep.equals(payload);
+        });
+      });
+    });
+
     context('when no aps properties are set', function () {
       it('is not present', function () {
         expect(compiledOutput().aps).to.be.undefined;