@parse/push-adapter 6.9.0 → 6.10.0

package/README.md

@@ -1,6 +1,6 @@
 # Parse Server Push Adapter <!-- omit in toc -->
 
-[![Build Status](https://github.com/parse-community/parse-server-push-adapter/workflows/ci/badge.svg?branch=master)](https://github.com/parse-community/parse-server-push-adapter/actions?query=workflow%3Aci+branch%3Amaster)
+[![Build Status](https://github.com/parse-community/parse-server-push-adapter/actions/workflows/ci.yml/badge.svg)](https://github.com/parse-community/parse-server-push-adapter/actions/workflows/ci.yml)
 [![Snyk Badge](https://snyk.io/test/github/parse-community/parse-server-push-adapter/badge.svg)](https://snyk.io/test/github/parse-community/parse-server-push-adapter)
 [![Coverage](https://img.shields.io/codecov/c/github/parse-community/parse-server-push-adapter/master.svg)](https://codecov.io/github/parse-community/parse-server-push-adapter?branch=master)
 [![auto-release](https://img.shields.io/badge/%F0%9F%9A%80-auto--release-9e34eb.svg)](https://github.com/parse-community/parse-server-push-adapter/releases)
@@ -72,10 +72,11 @@ Parse Server Push Adapter currently supports these types of Apple ecosystems:
 - `ios`: iPhone, iPad, and iPod touch apps
 - `osx`: macOS, and macCatalyst apps
 - `tvos`: tvOS apps
+- `watchos`: watchOS apps
 
-Delivering push notifications to Apple devices can be done either via Apple Push Notification Service (APNS), or via Firebase Cloud Messaging (FMC). Note that each category of Apple devices require their own configuration section:
+Push notifications can be delivered to Apple devices either via Apple Push Notification Service (APNS) or Firebase Cloud Messaging (FMC). Note that each category of Apple devices requires their own configuration section:
 
-- APNS requires a private key that can be downloaded from the Apple Developer Center at https://developer.apple.com/account under _Certificates > Identifiers & Profiles._ The adapter options also require the app ID and team ID which can be found there.
+- APNS requires a private key that can be downloaded from the Apple Developer Center at https://developer.apple.com/account under _Certificates > Identifiers & Profiles._ The adapter options also require the app ID and team ID, which can be found there.
 - FCM requires a private key that can be downloaded from the Firebase Console at https://console.firebase.google.com in your project under _Settings > Cloud Messaging._
 
 Example options:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parse/push-adapter",
-  "version": "6.9.0",
+  "version": "6.10.0",
   "description": "Base parse-server-push-adapter",
   "main": "src/index.js",
   "type": "module",
@@ -33,19 +33,19 @@
     "web-push": "3.6.7"
   },
   "devDependencies": {
-    "@eslint/js": "9.17.0",
+    "@eslint/js": "9.18.0",
     "@semantic-release/changelog": "6.0.3",
-    "@semantic-release/commit-analyzer": "13.0.0",
+    "@semantic-release/commit-analyzer": "13.0.1",
     "@semantic-release/git": "10.0.1",
     "@semantic-release/github": "11.0.1",
     "@semantic-release/npm": "12.0.1",
-    "@semantic-release/release-notes-generator": "14.0.2",
+    "@semantic-release/release-notes-generator": "14.0.3",
     "c8": "10.1.3",
     "codecov": "3.8.3",
     "eslint": "9.17.0",
     "jasmine": "5.5.0",
     "jasmine-spec-reporter": "7.0.0",
-    "semantic-release": "24.2.0"
+    "semantic-release": "24.2.1"
   },
   "engines": {
     "node": "18 || 20 || 22"

package/src/APNS.js

@@ -151,7 +151,7 @@ export class APNS {
   static _createProvider(apnsArgs) {
     // if using certificate, then topic must be defined
     if (!APNS._validateAPNArgs(apnsArgs)) {
-      throw new Parse.Error(Parse.Error.PUSH_MISCONFIGURED, 'topic is mssing for %j', apnsArgs);
+      throw new Parse.Error(Parse.Error.PUSH_MISCONFIGURED, 'topic is missing for %j', apnsArgs);
     }
 
     const provider = new apn.Provider(apnsArgs);
@@ -213,6 +213,16 @@ export class APNS {
       case 'threadId':
         notification.setThreadId(coreData.threadId);
         break;
+      case 'id':
+      case 'collapseId':
+      case 'channelId':
+      case 'requestId':
+      case 'pushType':
+      case 'topic':
+      case 'expiry':
+      case 'priority':
+        // Header information is skipped and added later.
+        break;
       default:
         payload[key] = coreData[key];
         break;
@@ -221,21 +231,53 @@ export class APNS {
 
     notification.payload = payload;
 
-    notification.topic = headers.topic;
-    notification.expiry = Math.round(headers.expirationTime / 1000);
-    notification.collapseId = headers.collapseId;
+    // Update header information if necessary.
+    notification.id = coreData.id ?? headers.id;
+    notification.collapseId = coreData.collapseId ?? headers.collapseId;
+    notification.requestId = coreData.requestId ?? headers.requestId;
+    notification.channelId = coreData.channelId ?? headers.channelId;
     // set alert as default push type. If push type is not set notifications are not delivered to devices running iOS 13, watchOS 6 and later.
-    notification.pushType = 'alert';
-    if (headers.pushType) {
-      notification.pushType = headers.pushType;
-    }
-    if (headers.priority) {
-      // if headers priority is not set 'node-apn' defaults it to 5 which is min. required value for background pushes to launch the app in background.
-      notification.priority = headers.priority
+    const pushType = coreData.pushType ?? headers.pushType ?? 'alert';
+    notification.pushType = pushType;
+    const topic = coreData.topic ?? APNS._determineTopic(headers.topic, pushType);
+    notification.topic = topic;
+    let expiry = notification.expiry;
+    if (headers.expirationTime) {
+      expiry = Math.round(headers.expirationTime / 1000);
     }
+    notification.expiry = coreData.expiry ?? expiry;
+    // if headers priority is not set 'node-apn' defaults it to notification's default value. Required value for background pushes to launch the app in background.
+    notification.priority = coreData.priority ?? headers.priority ?? notification.priority;
+
     return notification;
   }
 
+  /**
+   * Updates the topic based on the pushType.
+   *
+   * @param {String} topic The current topic to append additional information to for required provider
+   * @param {any} pushType The current push type of the notification
+   * @returns {String} Returns the updated topic
+   */
+  static _determineTopic(topic, pushType) {
+    switch(pushType) {
+    case 'location':
+      return topic + '.location-query';
+    case 'voip':
+      return topic + '.voip';
+    case 'complication':
+      return topic + '.complication';
+    case 'fileprovider':
+      return topic + '.pushkit.fileprovider';
+    case 'liveactivity':
+      return topic + '.push-type.liveactivity';
+    case 'pushtotalk':
+      return topic + '.voip-ptt';
+    default:
+      return topic;
+    }
+  }
+
   /**
    * Choose appropriate providers based on device appIdentifier.
    *
@@ -243,10 +285,6 @@ export class APNS {
    * @returns {Array} Returns Array with appropriate providers
    */
   _chooseProviders(appIdentifier) {
-    // If the device we need to send to does not have appIdentifier, any provider could be a qualified provider
-    /*if (!appIdentifier || appIdentifier === '') {
-        return this.providers.map((provider) => provider.index);
-    }*/
 
     // Otherwise we try to match the appIdentifier with topic on provider
     const qualifiedProviders = this.providers.filter((provider) => appIdentifier === provider.topic);

package/src/ParsePushAdapter.js

@@ -15,7 +15,7 @@ export default class ParsePushAdapter {
   supportsPushTracking = true;
 
   constructor(pushConfig = {}) {
-    this.validPushTypes = ['ios', 'osx', 'tvos', 'android', 'fcm', 'web', 'expo'];
+    this.validPushTypes = ['ios', 'osx', 'tvos', 'watchos', 'android', 'fcm', 'web', 'expo'];
     this.senderMap = {};
     // used in PushController for Dashboard Features
     this.feature = {
@@ -32,6 +32,7 @@ export default class ParsePushAdapter {
       switch (pushType) {
       case 'ios':
       case 'tvos':
+      case 'watchos':
       case 'osx':
         if (pushConfig[pushType].hasOwnProperty('firebaseServiceAccount')) {
           this.senderMap[pushType] = new FCM(pushConfig[pushType], 'apple');