@firebase/messaging 0.13.1 → 0.13.2

package/dist/index-public.d.ts

@@ -4,9 +4,14 @@
  *
  * @packageDocumentation
  */
+
 import { FirebaseApp } from '@firebase/app';
 
-import { NextFn , Observer , Unsubscribe } from '@firebase/util';
+import { NextFn } from '@firebase/util';
+
+import { Observer } from '@firebase/util';
+
+import { Unsubscribe } from '@firebase/util';
 
 /**
  * Deletes the registration token associated with this {@link Messaging} instance and unsubscribes
@@ -27,6 +32,7 @@ import { NextFn , Observer , Unsubscribe } from '@firebase/util';
  * @public
  */
 export declare function deleteToken(messaging: Messaging): Promise<boolean>;
+
 /**
  * Options for features provided by the FCM SDK for Web. See {@link
  * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
@@ -35,16 +41,18 @@ export declare function deleteToken(messaging: Messaging): Promise<boolean>;
  * @public
  */
 export declare 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;
+  /**
+   * The link to open when the user clicks on the notification.
+   */
+  link?: string;
+  /**
+   * The label associated with the message's analytics data.
+   */
+  analyticsLabel?: string;
 }
+
 /* Excluded from this release type: _FirebaseMessagingName */
+
 /**
  * Retrieves a Firebase Cloud Messaging instance.
  *
@@ -53,6 +61,7 @@ export declare interface FcmOptions {
  * @public
  */
 export declare function getMessaging(app?: FirebaseApp): Messaging;
+
 /**
  * Subscribes the {@link Messaging} instance to push notifications. Returns a Firebase Cloud
  * Messaging registration token that can be used to send push messages to that {@link Messaging}
@@ -71,34 +80,39 @@ export declare function getMessaging(app?: FirebaseApp): Messaging;
  *
  * @public
  */
-export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
+export declare function getToken(
+  messaging: Messaging,
+  options?: GetTokenOptions
+): Promise<string>;
+
 /**
  * Options for {@link getToken}.
  *
  * @public
  */
 export declare interface GetTokenOptions {
-    /**
-     * The public server key provided to push services. The key is used to
-     * authenticate push subscribers to receive push messages only from sending servers that hold
-     * the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
-     * push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
-     * to generate and import a VAPID key for your project with
-     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
-     * See
-     * {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
-     * for details on web push services.
-     */
-    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. See
-     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
-     * for more details.
-     */
-    serviceWorkerRegistration?: ServiceWorkerRegistration;
+  /**
+   * The public server key provided to push services. The key is used to
+   * authenticate push subscribers to receive push messages only from sending servers that hold
+   * the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
+   * push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
+   * to generate and import a VAPID key for your project with
+   * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
+   * See
+   * {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
+   * for details on web push services.
+   */
+  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. See
+   * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
+   * for more details.
+   */
+  serviceWorkerRegistration?: ServiceWorkerRegistration;
 }
+
 /**
  * @license
  * Copyright 2020 Google LLC
@@ -122,6 +136,7 @@ export declare interface GetTokenOptions {
  * @public
  */
 export declare function isSupported(): Promise<boolean>;
+
 /**
  * Message payload that contains the notification payload that is represented with
  * {@link NotificationPayload} and the data payload that contains an arbitrary
@@ -131,46 +146,48 @@ export declare function isSupported(): Promise<boolean>;
  * @public
  */
 export declare interface MessagePayload {
-    /**
-     * {@inheritdoc NotificationPayload}
-     */
-    notification?: NotificationPayload;
-    /**
-     * Arbitrary key/value payload.
-     */
-    data?: {
-        [key: string]: string;
-    };
-    /**
-     * {@inheritdoc FcmOptions}
-     */
-    fcmOptions?: FcmOptions;
-    /**
-     * The sender of this message.
-     */
-    from: string;
-    /**
-     * The collapse key of the message. See
-     * {@link https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_and_non-collapsible_messages | Non-collapsible and collapsible messages}
-     */
-    collapseKey: string;
-    /**
-     * The message ID of a message.
-     */
-    messageId: string;
+  /**
+   * {@inheritdoc NotificationPayload}
+   */
+  notification?: NotificationPayload;
+  /**
+   * Arbitrary key/value payload.
+   */
+  data?: {
+    [key: string]: string;
+  };
+  /**
+   * {@inheritdoc FcmOptions}
+   */
+  fcmOptions?: FcmOptions;
+  /**
+   * The sender of this message.
+   */
+  from: string;
+  /**
+   * The collapse key of the message. See
+   * {@link https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_and_non-collapsible_messages | Non-collapsible and collapsible messages}
+   */
+  collapseKey: string;
+  /**
+   * The message ID of a message.
+   */
+  messageId: string;
 }
+
 /**
  * Public interface of the Firebase Cloud Messaging SDK.
  *
  * @public
  */
 export declare interface Messaging {
-    /**
-     * The {@link @firebase/app#FirebaseApp} this `Messaging` instance is associated with.
-     */
-    app: FirebaseApp;
+  /**
+   * The {@link @firebase/app#FirebaseApp} this `Messaging` instance is associated with.
+   */
+  app: FirebaseApp;
 }
 export { NextFn };
+
 /**
  * Display notification details. Details are sent through the
  * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
@@ -178,25 +195,26 @@ export { NextFn };
  * @public
  */
 export declare interface NotificationPayload {
-    /**
-     * The notification's title.
-     */
-    title?: string;
-    /**
-     * The notification's body text.
-     */
-    body?: string;
-    /**
-     * The URL of an image that is downloaded on the device and displayed in the notification.
-     */
-    image?: string;
-    /**
-     * 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;
+  /**
+   * The notification's title.
+   */
+  title?: string;
+  /**
+   * The notification's body text.
+   */
+  body?: string;
+  /**
+   * The URL of an image that is downloaded on the device and displayed in the notification.
+   */
+  image?: string;
+  /**
+   * 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;
 }
 export { Observer };
+
 /**
  * When a push message is received and the user is currently on a page for your origin, the
  * message is passed to the page and an `onMessage()` event is dispatched with the payload of
@@ -210,7 +228,11 @@ export { Observer };
  *
  * @public
  */
-export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
+export declare function onMessage(
+  messaging: Messaging,
+  nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>
+): Unsubscribe;
+
 /**
  * Subscribes to an event that the app instance is registered with FCM via Firebase Installation ID (FID).
  * Use the FID passed to the callback to upload it to your application server. When you receive an FID
@@ -222,7 +244,11 @@ export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<M
  *
  * @public
  */
-export declare function onRegistered(messaging: Messaging, nextOrObserver: NextFn<string> | Observer<string>): Unsubscribe;
+export declare function onRegistered(
+  messaging: Messaging,
+  nextOrObserver: NextFn<string> | Observer<string>
+): Unsubscribe;
+
 /**
  * Subscribes to an event that the app instance is unregistered from FCM (FID no longer active).
  * Use this to notify your backend to remove this FID to prevent 404 errors on send.
@@ -233,7 +259,11 @@ export declare function onRegistered(messaging: Messaging, nextOrObserver: NextF
  *
  * @public
  */
-export declare function onUnregistered(messaging: Messaging, nextOrObserver: NextFn<string> | Observer<string>): Unsubscribe;
+export declare function onUnregistered(
+  messaging: Messaging,
+  nextOrObserver: NextFn<string> | Observer<string>
+): Unsubscribe;
+
 /**
  * Registers the app instance with FCM using its Firebase Installation ID (FID). The FID is
  * delivered via the {@link onRegistered} callback, not as a return value. Call this to establish
@@ -247,18 +277,23 @@ export declare function onUnregistered(messaging: Messaging, nextOrObserver: Nex
  *
  * @public
  */
-export declare function register(messaging: Messaging, options?: RegisterOptions): Promise<void>;
+export declare function register(
+  messaging: Messaging,
+  options?: RegisterOptions
+): Promise<void>;
+
 /**
  * Options for {@link register}. Same shape as GetTokenOptions for SW and VAPID configuration.
  *
  * @public
  */
 export declare interface RegisterOptions {
-    /** Optional VAPID key. See {@link GetTokenOptions.vapidKey}. */
-    vapidKey?: string;
-    /** Optional service worker registration. See {@link GetTokenOptions.serviceWorkerRegistration}. */
-    serviceWorkerRegistration?: ServiceWorkerRegistration;
+  /** Optional VAPID key. See {@link GetTokenOptions.vapidKey}. */
+  vapidKey?: string;
+  /** Optional service worker registration. See {@link GetTokenOptions.serviceWorkerRegistration}. */
+  serviceWorkerRegistration?: ServiceWorkerRegistration;
 }
+
 /**
  * Unregisters the app instance from FCM by deleting its FID-based registration.
  * On success, triggers {@link onUnregistered} (if registered) with the unregistered FID.
@@ -269,4 +304,5 @@ export declare interface RegisterOptions {
  */
 export declare function unregister(messaging: Messaging): Promise<void>;
 export { Unsubscribe };
+
 export {};

package/dist/index.cjs.js

@@ -417,7 +417,7 @@ function getKey({ appConfig }) {
 }
 
 const name = "@firebase/messaging";
-const version = "0.13.1";
+const version = "0.13.2";
 
 /**
  * @license