@quatrain/messaging-firebase 1.0.13 → 1.1.1

package/dist/FirebaseMessagingAdapter.d.ts

@@ -1,4 +1,7 @@
 import { AbstractMessagingAdapter, MessagingParameters, MessagingRecipient, NotificationCapableAdapter, NotificationMessage } from '@quatrain/messaging';
+/**
+ * Implementation to send Firebase Cloud Messaging (FCM) notifications using `firebase-admin`.
+ */
 export declare class FirebaseMessagingAdapter extends AbstractMessagingAdapter implements NotificationCapableAdapter {
     protected _messaging: any;
     constructor(params?: MessagingParameters);
@@ -12,6 +15,13 @@ export declare class FirebaseMessagingAdapter extends AbstractMessagingAdapter i
      * @throws Error if recipient has no message token or Firebase send fails
      */
     sendNotification(recipient: MessagingRecipient, message: NotificationMessage): Promise<string>;
+    /**
+     * Dispatches a batch push notification payload to multiple devices simultaneously.
+     *
+     * @param recipients - Array of target contacts containing their FCM tokens.
+     * @param message - The Notification schema.
+     * @returns Response summarizing successful and failed deliveries.
+     */
     sendNotifications(recipients: MessagingRecipient[], message: NotificationMessage): Promise<{
         successCount: number;
         failureCount: number;

package/dist/FirebaseMessagingAdapter.js

@@ -14,6 +14,9 @@ const messaging_1 = require("@quatrain/messaging");
 const firebase_admin_1 = require("firebase-admin");
 const app_1 = require("firebase-admin/app");
 const messaging_2 = require("firebase-admin/messaging");
+/**
+ * Implementation to send Firebase Cloud Messaging (FCM) notifications using `firebase-admin`.
+ */
 class FirebaseMessagingAdapter extends messaging_1.AbstractMessagingAdapter {
     constructor(params = {}) {
         super(params);
@@ -71,6 +74,13 @@ class FirebaseMessagingAdapter extends messaging_1.AbstractMessagingAdapter {
             }
         });
     }
+    /**
+     * Dispatches a batch push notification payload to multiple devices simultaneously.
+     *
+     * @param recipients - Array of target contacts containing their FCM tokens.
+     * @param message - The Notification schema.
+     * @returns Response summarizing successful and failed deliveries.
+     */
     sendNotifications(recipients, message) {
         return __awaiter(this, void 0, void 0, function* () {
             try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/messaging-firebase",
-  "version": "1.0.13",
+  "version": "1.1.1",
   "license": "AGPL-3.0-only",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,11 +19,11 @@
   },
   "author": "Quatrain Développement SAS <developers@quatrain.com>",
   "peerDependencies": {
-    "@quatrain/core": "^1.1.52"
+    "@quatrain/core": "^1.2.6"
   },
   "dependencies": {
-    "@quatrain/core": "^1.1.52",
-    "@quatrain/messaging": "^1.0.14",
+    "@quatrain/core": "^1.2.6",
+    "@quatrain/messaging": "^1.1.3",
     "firebase-admin": "^13.0.1"
   },
   "devDependencies": {
@@ -42,5 +42,8 @@
     "wbuild": "tsc --watch",
     "test": "jest",
     "bump-to": "yarn version"
+  },
+  "typedoc": {
+    "entryPoint": "src/index.ts"
   }
 }

package/src/FirebaseMessagingAdapter.ts

@@ -10,6 +10,9 @@ import { credential } from 'firebase-admin'
 import { getApps, initializeApp, ServiceAccount } from 'firebase-admin/app'
 import { getMessaging, Message } from 'firebase-admin/messaging'
 
+/**
+ * Implementation to send Firebase Cloud Messaging (FCM) notifications using `firebase-admin`.
+ */
 export class FirebaseMessagingAdapter
    extends AbstractMessagingAdapter
    implements NotificationCapableAdapter
@@ -84,6 +87,13 @@ export class FirebaseMessagingAdapter
       }
    }
 
+   /**
+    * Dispatches a batch push notification payload to multiple devices simultaneously.
+    * 
+    * @param recipients - Array of target contacts containing their FCM tokens.
+    * @param message - The Notification schema.
+    * @returns Response summarizing successful and failed deliveries.
+    */
    async sendNotifications(
       recipients: MessagingRecipient[],
       message: NotificationMessage