fix FCM Push notification payload structure (#492)

* fix FCM Push notification payload structure difference from firebase recommanded way

* fix import and ts error for push payload

* update package-lock.json for basic-ftp version upgrade

* refactor the push_payload types as per review comment

* updated types for push_payload builder

* update FCM builder.toObject() for silent notification to add fields in `data` key.

* PubNub SDK v10.2.8 release.

---------

Co-authored-by: Mohit Tejani <mohit.tejani@Mohits-MacBook-Pro.local>
Co-authored-by: PubNub Release Bot <120067856+pubnub-release-bot@users.noreply.github.com>

Author: 3 people

.pubnub.yml

@@ -1,5 +1,10 @@
 ---
 changelog:
+  - date: 2026-03-10
+    version: v10.2.8
+    changes:
+      - type: bug
+        text: "Updated push notification payload builder utility method to generate fcm payload as per updated specification."
   - date: 2026-02-11
     version: v10.2.7
     changes:
@@ -1389,7 +1394,7 @@ supported-platforms:
       - 'Ubuntu 14.04 and up'
       - 'Windows 7 and up'
     version: 'Pubnub Javascript for Node'
-version: '10.2.7'
+version: '10.2.8'
 sdks:
   - full-name: PubNub Javascript SDK
     short-name: Javascript
@@ -1405,7 +1410,7 @@ sdks:
           - distribution-type: source
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/archive/refs/tags/v10.2.7.zip
+            location: https://github.com/pubnub/javascript/archive/refs/tags/v10.2.8.zip
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'
@@ -2076,7 +2081,7 @@ sdks:
           - distribution-type: library
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/releases/download/v10.2.7/pubnub.10.2.7.js
+            location: https://github.com/pubnub/javascript/releases/download/v10.2.8/pubnub.10.2.8.js
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v10.2.8
+March 10 2026
+
+#### Fixed
+- Updated push notification payload builder utility method to generate fcm payload as per updated specification.
+
 ## v10.2.7
 February 11 2026
 

README.md

@@ -27,8 +27,8 @@ Watch [Getting Started with PubNub JS SDK](https://app.dashcam.io/replay/64ee0d2
      npm install pubnub
      ```
    * or download one of our builds from our CDN: 
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.10.2.7.js
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.10.2.7.min.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.10.2.8.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.10.2.8.min.js
 
 2. Configure your keys:
 

dist/web/pubnub.js

@@ -5438,7 +5438,7 @@
 	            return base.PubNubFile;
 	        },
 	        get version() {
-	            return '10.2.7';
+	            return '10.2.8';
 	        },
 	        getVersion() {
 	            return this.version;
@@ -7555,11 +7555,6 @@
 	    }
 	}
 
-	// --------------------------------------------------------
-	// ------------------------ Types -------------------------
-	// --------------------------------------------------------
-	// region Types
-	// endregion
 	// endregion
 	/**
 	 * Base notification payload object.
@@ -7897,6 +7892,15 @@
 	    get data() {
 	        return this.payload.data;
 	    }
+	    /**
+	     * Retrieve Android notification payload and initialize required structure.
+	     *
+	     * @returns Android specific notification payload.
+	     */
+	    get androidNotification() {
+	        var _c;
+	        return (_c = this.payload.android) === null || _c === void 0 ? void 0 : _c.notification;
+	    }
 	    /**
 	     * Notification title.
 	     *
@@ -7914,6 +7918,7 @@
 	        if (!value || !value.length)
 	            return;
 	        this.payload.notification.title = value;
+	        this.androidNotification.title = value;
 	        this._title = value;
 	    }
 	    /**
@@ -7933,8 +7938,28 @@
 	        if (!value || !value.length)
 	            return;
 	        this.payload.notification.body = value;
+	        this.androidNotification.body = value;
 	        this._body = value;
 	    }
+	    /**
+	     * Retrieve unread notifications number.
+	     *
+	     * @returns Number of unread notifications which should be shown on application badge.
+	     */
+	    get badge() {
+	        return this._badge;
+	    }
+	    /**
+	     * Update application badge number.
+	     *
+	     * @param value - Number which should be shown in application badge upon receiving notification.
+	     */
+	    set badge(value) {
+	        if (value === undefined || value === null)
+	            return;
+	        this.androidNotification.notification_count = value;
+	        this._badge = value;
+	    }
 	    /**
 	     * Retrieve notification sound file.
 	     *
@@ -7951,7 +7976,7 @@
 	    set sound(value) {
 	        if (!value || !value.length)
 	            return;
-	        this.payload.notification.sound = value;
+	        this.androidNotification.sound = value;
 	        this._sound = value;
 	    }
 	    /**
@@ -7965,12 +7990,12 @@
 	    /**
 	     * Update notification icon.
 	     *
-	     * @param value - Name of the icon file which should be shown on notification.
+	     * @param value - Name of the icon file set for `android.notification.icon`.
 	     */
 	    set icon(value) {
 	        if (!value || !value.length)
 	            return;
-	        this.payload.notification.icon = value;
+	        this.androidNotification.icon = value;
 	        this._icon = value;
 	    }
 	    /**
@@ -7984,12 +8009,12 @@
 	    /**
 	     * Update notifications grouping tag.
 	     *
-	     * @param value - String which will be used to group similar notifications in notification center.
+	     * @param value - String set for `android.notification.tag` to group similar notifications.
 	     */
 	    set tag(value) {
 	        if (!value || !value.length)
 	            return;
-	        this.payload.notification.tag = value;
+	        this.androidNotification.tag = value;
 	        this._tag = value;
 	    }
 	    /**
@@ -8010,6 +8035,7 @@
 	    setDefaultPayloadStructure() {
 	        this.payload.notification = {};
 	        this.payload.data = {};
+	        this.payload.android = { notification: {} };
 	    }
 	    /**
 	     * Translate data object into PubNub push notification payload object.
@@ -8019,22 +8045,60 @@
 	     * @returns Preformatted push notification payload.
 	     */
 	    toObject() {
-	        let data = Object.assign({}, this.payload.data);
-	        let notification = null;
+	        var _c, _e;
 	        const payload = {};
-	        // Check whether additional data has been passed outside 'data' object and put it into it if required.
-	        if (Object.keys(this.payload).length > 2) {
-	            const _a = this.payload, additionalData = __rest(_a, ["notification", "data"]);
-	            data = Object.assign(Object.assign({}, data), additionalData);
+	        const notification = Object.assign({}, this.payload.notification);
+	        const android = Object.assign({}, this.payload.android);
+	        const androidNotification = Object.assign({}, ((_c = android.notification) !== null && _c !== void 0 ? _c : {}));
+	        // Strip title/body from android.notification — they belong in top-level notification (or data for silent).
+	        const androidSpecificFields = __rest(androidNotification, ["title", "body"]);
+	        if (this._isSilent) {
+	            // For silent (data-only) notifications, strip all `notification` fields
+	            // (both root and android) and move everything into the root `data` object.
+	            const data = {};
+	            if (this._title)
+	                data.title = this._title;
+	            if (this._body)
+	                data.body = this._body;
+	            // Merge android-specific notification fields (sound, icon, tag, etc.) into data.
+	            for (const [key, value] of Object.entries(androidSpecificFields)) {
+	                if (value !== undefined && value !== null)
+	                    data[key] = String(value);
+	            }
+	            // Merge any existing user-provided custom data.
+	            if (this.payload.data)
+	                Object.assign(data, this.payload.data);
+	            if (Object.keys(data).length)
+	                payload.data = data;
+	            // Exclude `notification` entirely from android — only keep non-notification android fields.
+	            delete android.notification;
+	            if (Object.keys(android).length) {
+	                payload.android = android;
+	            }
 	        }
-	        if (this._isSilent)
-	            data.notification = this.payload.notification;
-	        else
-	            notification = this.payload.notification;
-	        if (Object.keys(data).length)
-	            payload.data = data;
-	        if (notification && Object.keys(notification).length)
-	            payload.notification = notification;
+	        else {
+	            if (Object.keys(notification).length)
+	                payload.notification = notification;
+	            // Include top-level data if present.
+	            if (this.payload.data && Object.keys(this.payload.data).length)
+	                payload.data = Object.assign({}, this.payload.data);
+	            // android.notification should only contain android-specific fields (sound, icon, tag, etc.).
+	            if (Object.keys(androidSpecificFields).length) {
+	                const androidWithoutNotification = __rest(android, ["notification"]);
+	                payload.android = Object.assign(Object.assign({}, androidWithoutNotification), { notification: androidSpecificFields });
+	            }
+	            else {
+	                const androidWithoutNotification = __rest(android, ["notification"]);
+	                if (Object.keys(androidWithoutNotification).length) {
+	                    payload.android = androidWithoutNotification;
+	                }
+	            }
+	        }
+	        // Preserve other top-level FCM fields (apns, webpush, fcm_options, etc.).
+	        const _f = this.payload, otherFields = __rest(_f, ["notification", "android", "data", "pn_exceptions"]);
+	        Object.assign(payload, otherFields);
+	        if ((_e = this.payload.pn_exceptions) === null || _e === void 0 ? void 0 : _e.length)
+	            payload.pn_exceptions = this.payload.pn_exceptions;
 	        return Object.keys(payload).length ? payload : null;
 	    }
 	}

dist/web/pubnub.min.js

@@ -168,7 +168,7 @@ const makeConfiguration = (base, setupCryptoModule) => {
             return base.PubNubFile;
         },
         get version() {
-            return '10.2.7';
+            return '10.2.8';
         },
         getVersion() {
             return this.version;