@react-native-firebase/messaging 16.5.2 → 16.6.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [16.6.0](https://github.com/invertase/react-native-firebase/compare/v16.5.2...v16.6.0) (2023-01-27)
+
+### Features
+
+- **messaging:** Expose modular API that matches the Firebase web JS SDK v9 API ([#6806](https://github.com/invertase/react-native-firebase/issues/6806)) ([da82c10](https://github.com/invertase/react-native-firebase/commit/da82c1036051f0518da0401de24cef24c7ac091f))
+
 ### [16.5.2](https://github.com/invertase/react-native-firebase/compare/v16.5.1...v16.5.2) (2023-01-23)
 
 **Note:** Version bump only for package @react-native-firebase/messaging

package/lib/index.d.ts

@@ -111,9 +111,9 @@ export namespace FirebaseMessagingTypes {
     data?: { [key: string]: string };
 
     /**
-     * Additional Notification data sent with the message
+     * Additional NotificationPayload data sent with the message
      */
-    notification?: Notification;
+    notification?: NotificationPayload;
 
     /**
      * Whether the iOS APNs message was configured as a background update notification.
@@ -139,14 +139,35 @@ export namespace FirebaseMessagingTypes {
 
     /**
      * An iOS app specific identifier used for notification grouping.
-     */
     threadId?: string;
+    */
+    threadId?: string;
+
+    /**
+     * Options for features provided by the FCM SDK for Web.
+     */
+    fcmOptions: FcmOptions;
   }
 
   /**
-   * Options for `getToken()`, `deleteToken()`
+   * Options for features provided by the FCM SDK for Web.
    */
-  export interface TokenOptions {
+  export interface FcmOptions {
+    /**
+     * The link to open when the user clicks on the notification.
+     */
+    link?: string;
+
+    /**
+     * The label associated with the message's analytics data.
+     */
+    analyticsLabel?: string;
+  }
+
+  /**
+   * Options for `getToken()` and `deleteToken()`
+   */
+  export interface NativeTokenOptions {
     /**
      * The app name of the FirebaseApp instance.
      *
@@ -162,6 +183,35 @@ export namespace FirebaseMessagingTypes {
     senderId?: string;
   }
 
+  /**
+   * Options for `getToken()`
+   */
+  export interface GetTokenOptions {
+    /**
+     * The VAPID key used to authenticate the push subscribers
+     *  to receive push messages only from sending servers
+     * that hold the corresponding private key.
+     *
+     * @platform web
+     */
+    vapidKey?: string;
+
+    /**
+     * The service worker registration for receiving push messaging.
+     * If the registration is not provided explicitly, you need to
+     * have a firebase-messaging-sw.js at your root location.
+     *
+     * @platform web
+     */
+    serviceWorkerRegistration?: ServiceWorkerRegistration;
+  }
+
+  /**
+   * NotificationPayload is an alias for Notification. This is to keep it the same as
+   * Firebase Web JS SDK v9 and to make it backwards compatible.
+   */
+  type NotificationPayload = Notification;
+
   export interface Notification {
     /**
      * The notification title.
@@ -183,6 +233,22 @@ export namespace FirebaseMessagingTypes {
      */
     body?: string;
 
+    /**
+     * Web only. The URL to use for the notification's icon. If you don't send this key in the request,
+     * FCM displays the launcher icon specified in your app manifest.
+     */
+    icon?: string;
+
+    /**
+     * Web only. The URL of an image that is downloaded on the device and displayed in the notification.
+     */
+    image?: string;
+
+    /**
+     * Web only. The notification's title.
+     */
+    title?: string;
+
     /**
      * The native localization key for the notification body content.
      */
@@ -627,10 +693,9 @@ export namespace FirebaseMessagingTypes {
      *     fcmTokens: firebase.firestore.FieldValues.arrayUnion(fcmToken),
      *   });
      * ```
-     *
-     * @param options Options to override senderId (iOS) and projectId (Android).
+     * @param options Options composite type with all members of `GetTokenOptions` and `NativeTokenOptions`
      */
-    getToken(options?: TokenOptions): Promise<string>;
+    getToken(options?: GetTokenOptions & NativeTokenOptions): Promise<string>;
 
     /**
      * Returns whether the root view is headless or not
@@ -651,9 +716,9 @@ export namespace FirebaseMessagingTypes {
      * await firebase.messaging().deleteToken();
      * ```
      *
-     * @param options Options to override senderId (iOS) and projectId (Android).
+     * @param options Options to override senderId (iOS) and appName (android)
      */
-    deleteToken(options?: TokenOptions): Promise<void>;
+    deleteToken(options?: NativeTokenOptions): Promise<void>;
 
     /**
      * When any FCM payload is received, the listener callback is called with a `RemoteMessage`.
@@ -1012,6 +1077,21 @@ export namespace FirebaseMessagingTypes {
      * @param enabled A boolean value to enable or disable exporting of message delivery metrics to BigQuery.
      */
     setDeliveryMetricsExportToBigQuery(enabled: boolean): Promise<void>;
+    /**
+     * Checks if all required APIs exist in the browser.
+     *
+     * @web
+     */
+    isSupported(): Promise<boolean>;
+
+    /**
+     * Enables or disables Firebase Cloud Messaging message delivery metrics export to BigQuery. By
+     * default, message delivery metrics are not exported to BigQuery. Use this method to enable or
+     * disable the export at runtime.
+     *
+     * @web
+     */
+    experimentalSetDeliveryMetricsExportedToBigQueryEnabled(): void;
   }
 }
 

package/lib/index.js

@@ -30,10 +30,41 @@ import {
   FirebaseModule,
   getFirebaseRoot,
 } from '@react-native-firebase/app/lib/internal';
-import { AppRegistry } from 'react-native';
+import { AppRegistry, Platform } from 'react-native';
 import remoteMessageOptions from './remoteMessageOptions';
 import version from './version';
 
+export {
+  getMessaging,
+  deleteToken,
+  getToken,
+  onMessage,
+  onNotificationOpenedApp,
+  onTokenRefresh,
+  requestPermission,
+  isAutoInitEnabled,
+  setAutoInitEnabled,
+  getInitialNotification,
+  getDidOpenSettingsForNotification,
+  getIsHeadless,
+  registerDeviceForRemoteMessages,
+  isDeviceRegisteredForRemoteMessages,
+  unregisterDeviceForRemoteMessages,
+  getAPNSToken,
+  hasPermission,
+  onDeletedMessages,
+  onMessageSent,
+  onSendError,
+  setBackgroundMessageHandler,
+  setOpenSettingsForNotificationsHandler,
+  sendMessage,
+  subscribeToTopic,
+  unsubscribeFromTopic,
+  experimentalSetDeliveryMetricsExportedToBigQueryEnabled,
+  isDeliveryMetricsExportToBigQueryEnabled,
+  isSupported,
+} from '../modular/index';
+
 const statics = {
   AuthorizationStatus: {
     NOT_DETERMINED: -1,
@@ -166,7 +197,7 @@ class FirebaseMessagingModule extends FirebaseModule {
 
   getToken({ appName, senderId } = {}) {
     if (!isUndefined(appName) && !isString(appName)) {
-      throw new Error("firebase.messaging().getToken(*) 'projectId' expected a string.");
+      throw new Error("firebase.messaging().getToken(*) 'appName' expected a string.");
     }
 
     if (!isUndefined(senderId) && !isString(senderId)) {
@@ -181,7 +212,7 @@ class FirebaseMessagingModule extends FirebaseModule {
 
   deleteToken({ appName, senderId } = {}) {
     if (!isUndefined(appName) && !isString(appName)) {
-      throw new Error("firebase.messaging().deleteToken(*) 'projectId' expected a string.");
+      throw new Error("firebase.messaging().deleteToken(*) 'appName' expected a string.");
     }
 
     if (!isUndefined(senderId) && !isString(senderId)) {
@@ -448,6 +479,15 @@ class FirebaseMessagingModule extends FirebaseModule {
     this._isDeliveryMetricsExportToBigQueryEnabled = enabled;
     return this.native.setDeliveryMetricsExportToBigQuery(enabled);
   }
+
+  async isSupported() {
+    if (Platform.isAndroid) {
+      playServicesAvailability = firebase.utils().playServicesAvailability;
+      return playServicesAvailability.isAvailable;
+    }
+    // Always return "true" for iOS. Web will be implemented when it is supported
+    return true;
+  }
 }
 
 // import { SDK_VERSION } from '@react-native-firebase/messaging';

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '16.5.2';
+module.exports = '16.6.0';

package/modular/index.js

@@ -0,0 +1,299 @@
+import { firebase } from '..';
+
+/**
+ * Returns a Messaging instance for the given app.
+ * @param app - FirebaseApp. Optional.
+ * @returns {Messaging}
+ */
+export function getMessaging(app) {
+  if (app) {
+    return firebase.app(app.name).messaging();
+  }
+
+  return firebase.app().messaging();
+}
+
+/**
+ * Removes access to an FCM token previously authorized by it's scope.
+ * Messages sent by the server to this token will fail.
+ * @param messaging Messaging instance.
+ * @param tokenOptions Options to override senderId (iOS) and projectId (Android).
+ * @returns {Promise<void>}
+ */
+export function deleteToken(messaging, tokenOptions) {
+  if (tokenOptions != null) {
+    return messaging.deleteToken();
+  }
+
+  return messaging.deleteToken(tokenOptions);
+}
+
+/**
+ * Returns an FCM token for this device. Optionally you can specify a custom options to your own use-case.
+ * @param messaging Messaging instance.
+ * @param options Options to override senderId (iOS) and appName
+ * @returns {Promise<string>}
+ */
+export function getToken(messaging, options) {
+  if (options != null) {
+    return messaging.getToken();
+  }
+
+  return messaging.getToken(options);
+}
+
+/**
+ * When any FCM payload is received, the listener callback is called with a `RemoteMessage`.
+ * > This subscriber method is only called when the app is active (in the foreground).
+ * @param messaging Messaging instance.
+ * @param listener Called with a `RemoteMessage` when a new FCM payload is received from the server.
+ * @returns {Function}
+ */
+export function onMessage(messaging, nextOrObserver) {
+  return messaging.onMessage(nextOrObserver);
+}
+
+/**
+ * When the user presses a notification displayed via FCM, this listener will be called if the app
+ * has opened from a background state.
+ * @param messaging Messaging instance.
+ * @param listener Called with a `RemoteMessage` when a notification press opens the application.
+ * @returns {Function}
+ */
+export function onNotificationOpenedApp(messaging, listener) {
+  return messaging.onNotificationOpenedApp(listener);
+}
+
+/**
+ * Called when a new registration token is generated for the device. For example, this event can happen when a
+ * token expires or when the server invalidates the token.
+ * > This subscriber method is only called when the app is active (in the foreground).
+ * @param messaging Messaging instance.
+ * @param listener Called with a FCM token when the token is refreshed.
+ * @returns {Function}
+ */
+export function onTokenRefresh(messaging, listener) {
+  return messaging.onTokenRefresh(listener);
+}
+
+/**
+ * On iOS, messaging permission must be requested by the current application before messages can
+ * be received or sent.
+ * @param messaging Messaging instance.
+ * @param iosPermissions All the available permissions for iOS that can be requested
+ * @returns {Promise<AuthorizationStatus>}
+ */
+export function requestPermission(messaging, iosPermissions) {
+  return messaging.requestPermission(iosPermissions);
+}
+
+/**
+ * Returns whether messaging auto initialization is enabled or disabled for the device.
+ * @param messaging Messaging instance.
+ * @returns {boolean}
+ */
+export function isAutoInitEnabled(messaging) {
+  return messaging.isAutoInitEnabled;
+}
+
+/**
+ * Returns whether messaging auto initialization is enabled or disabled for the device.
+ * @param messaging Messaging instance.
+ * @param enabled A boolean value to enable or disable auto initialization.
+ * @returns {Promise<boolean>}
+ */
+export function setAutoInitEnabled(messaging, enabled) {
+  return messaging.setAutoInitEnabled(enabled);
+}
+
+/**
+ * When a notification from FCM has triggered the application to open from a quit state,
+ * this method will return a `RemoteMessage` containing the notification data, or `null` if
+ * the app was opened via another method.
+ * @param messaging Messaging instance.
+ * @returns {Promise<RemoteMessage | null>}
+ */
+export function getInitialNotification(messaging) {
+  return messaging.getInitialNotification();
+}
+
+/**
+ * When the app is opened from iOS notifications settings from a quit state,
+ * this method will return `true` or `false` if the app was opened via another method.
+ * @param messaging Messaging instance.
+ * @returns {Promise<boolean>}
+ */
+export function getDidOpenSettingsForNotification(messaging) {
+  return messaging.getDidOpenSettingsForNotification();
+}
+
+/**
+ * Returns whether the root view is headless or not
+ * i.e true if the app was launched in the background (for example, by data-only cloud message)
+ * @param messaging Messaging instance.
+ * @returns {Promise<boolean>}
+ */
+export function getIsHeadless(messaging) {
+  return messaging.getIsHeadless();
+}
+
+/**
+ * On iOS, if your app wants to receive remote messages from FCM (via APNs), you must explicitly register
+ * with APNs if auto-registration has been disabled.
+ * @param messaging Messaging instance.
+ * @returns {Promise<void>}
+ */
+export function registerDeviceForRemoteMessages(messaging) {
+  return messaging.registerDeviceForRemoteMessages();
+}
+
+/**
+ * Returns a boolean value whether the user has registered for remote notifications via
+ * `registerDeviceForRemoteMessages()`. For iOS. Android always returns `true`
+ * @param messaging Messaging instance.
+ * @returns {boolean}
+ */
+export function isDeviceRegisteredForRemoteMessages(messaging) {
+  return messaging.isDeviceRegisteredForRemoteMessages;
+}
+
+/**
+ * Unregisters the app from receiving remote notifications.
+ * @param messaging Messaging instance.
+ * @returns {Promise<void>}
+ */
+export function unregisterDeviceForRemoteMessages(messaging) {
+  return messaging.unregisterDeviceForRemoteMessages();
+}
+
+/**
+ * On iOS, it is possible to get the users APNs token. This may be required if you want to send messages to your
+ * iOS devices without using the FCM service.
+ * @param messaging Messaging instance.
+ * @returns {Promise<string | null>}
+ */
+export function getAPNSToken(messaging) {
+  return messaging.getAPNSToken();
+}
+
+/**
+ * Returns a `AuthorizationStatus` as to whether the user has messaging permission for this app.
+ * @param messaging Messaging instance.
+ * @returns {Promise<AuthorizationStatus>}
+ */
+export function hasPermission(messaging) {
+  return messaging.hasPermission();
+}
+
+/**
+ * Called when the FCM server deletes pending messages.
+ * @param messaging Messaging instance.
+ * @param listener Called when the FCM deletes pending messages.
+ * @returns {Function}
+ */
+export function onDeletedMessages(messaging, listener) {
+  return messaging.onDeletedMessages(listener);
+}
+
+/**
+ * When sending a `RemoteMessage`, this listener is called when the message has been sent to FCM.
+ * @param messaging Messaging instance.
+ * @param listener Called when the FCM sends the remote message to FCM.
+ * @returns {Function}
+ */
+export function onMessageSent(messaging, listener) {
+  return messaging.onMessageSent(listener);
+}
+
+/**
+ * When sending a `RemoteMessage`, this listener is called when the message has been sent to FCM.
+ * @param messaging Messaging instance.
+ * @param listener Called when the FCM sends the remote message to FCM.
+ * @returns {Function}
+ */
+export function onSendError(messaging, listener) {
+  return messaging.onSendError(listener);
+}
+
+/**
+ * Set a message handler function which is called when the app is in the background
+ * or terminated. In Android, a headless task is created, allowing you to access the React Native environment
+ * to perform tasks such as updating local storage, or sending a network request.
+ * @param messaging Messaging instance.
+ * @param handler Called when a message is sent and the application is in a background or terminated state.
+ * @returns {void}
+ */
+export function setBackgroundMessageHandler(messaging, handler) {
+  return messaging.setBackgroundMessageHandler(handler);
+}
+
+/**
+ * Set a handler function which is called when the `${App Name} notifications settings`
+ * link in iOS settings is clicked.
+ * @param messaging Messaging instance.
+ * @param handler Called when link in iOS settings is clicked
+ * @returns {void}
+ */
+export function setOpenSettingsForNotificationsHandler(messaging, handler) {
+  return messaging.setOpenSettingsForNotificationsHandler(handler);
+}
+
+/**
+ * Send a new `RemoteMessage` to the FCM server.
+ * @param messaging Messaging instance.
+ * @param message A `RemoteMessage` interface.
+ * @returns {Promise<void>}
+ */
+export function sendMessage(messaging, message) {
+  return messaging.sendMessage(message);
+}
+
+/**
+ * Apps can subscribe to a topic, which allows the FCM server to send targeted messages to only those
+ * devices subscribed to that topic.
+ * @param messaging Messaging instance.
+ * @param topic The topic name.
+ * @returns {Promise<void>}
+ */
+export function subscribeToTopic(messaging, topic) {
+  return messaging.subscribeToTopic(topic);
+}
+
+/**
+ * Unsubscribe the device from a topic.
+ * @param messaging Messaging instance.
+ * @param topic The topic name.
+ * @returns {Promise<void>}
+ */
+export function unsubscribeFromTopic(messaging, topic) {
+  return messaging.unsubscribeFromTopic(topic);
+}
+
+/**
+ * Returns a boolean whether message delivery metrics are exported to BigQuery.
+ * @param messaging Messaging instance.
+ * @returns {boolean}
+ */
+export function isDeliveryMetricsExportToBigQueryEnabled(messaging) {
+  return messaging.isDeliveryMetricsExportToBigQueryEnabled;
+}
+
+/**
+ * Checks if all required APIs exist in the browser.
+ * @param messaging Messaging instance.
+ * @returns {boolean}
+ */
+export function isSupported(messaging) {
+  return messaging.isSupported();
+}
+
+/**
+ * Sets whether message delivery metrics are exported to BigQuery is enabled or disabled.
+ * The value is false by default. Set this to true to allow exporting of message delivery metrics to BigQuery.
+ * @param messaging Messaging instance.
+ * @param enabled A boolean value to enable or disable exporting of message delivery metrics to BigQuery.
+ * @returns {Promise<void>}
+ */
+export function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging, enable) {
+  return messaging.setDeliveryMetricsExportToBigQuery(enable);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/messaging",
-  "version": "16.5.2",
+  "version": "16.6.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - React Native Firebase provides native integration of Firebase Cloud Messaging (FCM) for both Android & iOS. FCM is a cost free service, allowing for server-device and device-device communication. The React Native Firebase Messaging module provides a simple JavaScript API to interact with FCM.",
   "main": "lib/index.js",
@@ -22,10 +22,10 @@
     "messaging"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "16.5.2"
+    "@react-native-firebase/app": "16.6.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "97a5523bac4570ba7b47fbfdbb22348f38246d11"
+  "gitHead": "6663dc24dc5697190b930aa510085a681fe81203"
 }