add support for apns-push-type

Required when delivering notifications to devices running iOS 13 and later, or watchOS 6 and later.

Author: funkenstrahlen

spec/APNS.spec.js

@@ -172,8 +172,9 @@ describe('APNS', () => {
     };
     let expirationTime = 1454571491354;
     let collapseId = "collapseIdentifier";
+    let pushType = "alert"
 
-    let notification = APNS._generateNotification(data, { expirationTime: expirationTime, collapseId: collapseId });
+    let notification = APNS._generateNotification(data, { expirationTime: expirationTime, collapseId: collapseId, pushType: pushType });
 
     expect(notification.aps.alert).toEqual({ body: 'alert', title: 'title' });
     expect(notification.aps.badge).toEqual(data.badge);
@@ -188,6 +189,7 @@ describe('APNS', () => {
     });
     expect(notification.expiry).toEqual(Math.round(expirationTime / 1000));
     expect(notification.collapseId).toEqual(collapseId);
+    expect(notification.pushType).toEqual(pushType);
     done();
   });
 
@@ -208,11 +210,13 @@ describe('APNS', () => {
       };
       let expirationTime = 1454571491354;
       let collapseId = "collapseIdentifier";
+      let pushType = "alert"
 
-      let notification = APNS._generateNotification(data, { expirationTime: expirationTime, collapseId: collapseId });
+      let notification = APNS._generateNotification(data, { expirationTime: expirationTime, collapseId: collapseId, pushType: pushType });
 
       expect(notification.expiry).toEqual(Math.round(expirationTime / 1000));
       expect(notification.collapseId).toEqual(collapseId);
+      expect(notification.pushType).toEqual(pushType);
 
       let stringifiedJSON = notification.compile();
       let jsonObject = JSON.parse(stringifiedJSON);
@@ -280,8 +284,10 @@ describe('APNS', () => {
     // Mock data
     let expirationTime = 1454571491354;
     let collapseId = "collapseIdentifier";
+    let pushType = "alert" // or background
     let data = {
       'collapse_id': collapseId,
+      'push_type': pushType,
       'expiration_time': expirationTime,
       'data': {
         'alert': 'alert'
@@ -312,7 +318,8 @@ describe('APNS', () => {
     let notification = calledArgs[0];
     expect(notification.aps.alert).toEqual(data.data.alert);
     expect(notification.expiry).toEqual(Math.round(data['expiration_time'] / 1000));
-    expect(notification.collapseId).toEqual(data['collapse_id']);
+    expect(notification.collapseId).toEqual(collapseId);
+    expect(notification.pushType).toEqual(pushType);
     let apnDevices = calledArgs[1];
     expect(apnDevices.length).toEqual(4);
     done();
@@ -349,9 +356,11 @@ describe('APNS', () => {
     apns.providers = [provider, providerDev];
     // Mock data
     let expirationTime = 1454571491354;
+    let pushType = "alert" // or background
     let collapseId = "collapseIdentifier";
     let data = {
       'collapse_id': collapseId,
+      'push_type': pushType,
       'expiration_time': expirationTime,
       'data': {
         'alert': 'alert'
@@ -389,6 +398,7 @@ describe('APNS', () => {
     expect(notification.aps.alert).toEqual(data.data.alert);
     expect(notification.expiry).toEqual(Math.round(data['expiration_time'] / 1000));
     expect(notification.collapseId).toEqual(data['collapse_id']);
+    expect(notification.pushType).toEqual(pushType);
     let apnDevices = calledArgs[1];
     expect(apnDevices.length).toBe(3);
 
@@ -398,6 +408,7 @@ describe('APNS', () => {
     expect(notification.aps.alert).toEqual(data.data.alert);
     expect(notification.expiry).toEqual(Math.round(data['expiration_time'] / 1000));
     expect(notification.collapseId).toEqual(data['collapse_id']);
+    expect(notification.pushType).toEqual(pushType);
     apnDevices = calledArgs[1];
     expect(apnDevices.length).toBe(2);
     done();

src/APNS.js

@@ -73,6 +73,7 @@ export class APNS {
     let coreData = data.data;
     let expirationTime = data['expiration_time'];
     let collapseId = data['collapse_id'];
+    let pushType = data['push_type'];
     let allPromises = [];
 
     let devicesPerAppIdentifier = {};
@@ -96,7 +97,7 @@ export class APNS {
         continue;
       }
 
-      let headers = { expirationTime: expirationTime, topic: appIdentifier, collapseId: collapseId }
+      let headers = { expirationTime: expirationTime, topic: appIdentifier, collapseId: collapseId, pushType: pushType }
       let notification = APNS._generateNotification(coreData, headers);
       const deviceIds = devices.map(device => device.deviceToken);
       let promise = this.sendThroughProvider(notification, deviceIds, providers);
@@ -166,7 +167,7 @@ export class APNS {
   /**
    * Generate the apns Notification from the data we get from api request.
    * @param {Object} coreData The data field under api request body
-   * @param {Object} headers The header properties for the notification (topic, expirationTime, collapseId)
+   * @param {Object} headers The header properties for the notification (topic, expirationTime, collapseId, pushType)
    * @returns {Object} A apns Notification
    */
   static _generateNotification(coreData, headers) {
@@ -214,6 +215,7 @@ export class APNS {
     notification.topic = headers.topic;
     notification.expiry = Math.round(headers.expirationTime / 1000);
     notification.collapseId = headers.collapseId;
+    notification.pushType = headers.pushType
     return notification;
   }