@firebase/messaging 0.13.1 → 0.13.2

package/dist/sw/index-public.d.ts

@@ -1,6 +1,10 @@
 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';
 
 /**
  * Enables or disables Firebase Cloud Messaging message delivery metrics export to BigQuery. By
@@ -13,7 +17,11 @@ import { NextFn , Observer , Unsubscribe } from '@firebase/util';
  *
  * @public
  */
-export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;
+export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(
+  messaging: Messaging,
+  enable: boolean
+): void;
+
 /**
  * Options for features provided by the FCM SDK for Web. See {@link
  * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
@@ -22,16 +30,18 @@ export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(
  * @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.
  *
@@ -40,33 +50,35 @@ export declare interface FcmOptions {
  * @public
  */
 export declare function getMessaging(app?: FirebaseApp): Messaging;
+
 /**
  * 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;
 }
+
 /**
  * Checks whether all required APIs exist within SW Context
  * @returns a Promise that resolves to a boolean.
@@ -74,6 +86,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
@@ -83,46 +96,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}.
@@ -130,25 +145,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 };
+
 /**
  * Called when a message is received while the app is in the background. An app is considered to be
  * in the background if no active window is displayed.
@@ -161,7 +177,11 @@ export { Observer };
  *
  * @public
  */
-export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
+export declare function onBackgroundMessage(
+  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
@@ -173,7 +193,11 @@ export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver
  *
  * @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.
@@ -184,17 +208,22 @@ 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;
+
 /**
  * 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;
 }
 export { Unsubscribe };
+
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/messaging",
-  "version": "0.13.1",
+  "version": "0.13.2",
   "description": "",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.cjs.js",
@@ -52,15 +52,15 @@
     "@firebase/app": "0.x"
   },
   "dependencies": {
-    "@firebase/installations": "0.6.23",
-    "@firebase/messaging-interop-types": "0.2.5",
-    "@firebase/util": "1.15.2",
-    "@firebase/component": "0.7.4",
+    "@firebase/installations": "0.6.24",
+    "@firebase/messaging-interop-types": "0.2.6",
+    "@firebase/util": "1.15.3",
+    "@firebase/component": "0.7.5",
     "idb": "7.1.1",
     "tslib": "^2.1.0"
   },
   "devDependencies": {
-    "@firebase/app": "0.16.0",
+    "@firebase/app": "0.16.1",
     "rollup": "4.62.2",
     "rollup-plugin-typescript2": "0.37.0",
     "@rollup/plugin-json": "6.1.0",