@firebase/messaging 0.12.4-canary.f3067f72d → 0.12.4-canary.f497a400a

package/dist/internal.d.ts

@@ -25,7 +25,7 @@ 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 |
- * WebpushFcmOptions}
+ * WebpushFcmOptions}.
  *
  * @public
  */
@@ -55,15 +55,15 @@ export declare type _FirebaseMessagingName = 'messaging';
 export declare function getMessaging(app?: FirebaseApp): Messaging;
 
 /**
- * Subscribes the {@link Messaging} instance to push notifications. Returns an Firebase Cloud
+ * 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}
  * instance.
  *
- * If a notification permission isn't already granted, this method asks the user for permission. The
+ * If notification permission isn't already granted, this method asks the user for permission. The
  * returned promise rejects if the user does not allow the app to show notifications.
  *
  * @param messaging - The {@link Messaging} instance.
- * @param options - Provides an optional vapid key and an optinoal service worker registration
+ * @param options - Provides an optional vapid key and an optional service worker registration.
  *
  * @returns The promise resolves with an FCM registration token.
  *
@@ -72,18 +72,18 @@ export declare function getMessaging(app?: FirebaseApp): Messaging;
 export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
 
 /**
- * Options for {@link getToken}
+ * Options for {@link getToken}.
  *
  * @public
  */
 export declare interface GetTokenOptions {
     /**
-     * The public server key provided to push services. It is used to
-     * authenticate the push subscribers to receive push messages only from sending servers that hold
+     * 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_with_fcm | Configure Web Credentials with FCM}.
+     * {@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.
@@ -93,7 +93,7 @@ export declare interface GetTokenOptions {
      * 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#retrieve-the-current-registration-token | Retrieve the current registration token}
+     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
      * for more details.
      */
     serviceWorkerRegistration?: ServiceWorkerRegistration;
@@ -127,7 +127,7 @@ 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
  * number of key-value pairs sent by developers through the
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
  *
  * @public
  */
@@ -156,7 +156,7 @@ export declare interface MessagePayload {
      */
     collapseKey: string;
     /**
-     * The message id of a message.
+     * The message ID of a message.
      */
     messageId: string;
 }
@@ -175,8 +175,8 @@ export declare interface Messaging {
 export { NextFn }
 
 /**
- * Display notification details. They are sent through the
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
+ * Display notification details. Details are sent through the
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
  *
  * @public
  */

package/dist/private.d.ts

@@ -25,7 +25,7 @@ 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 |
- * WebpushFcmOptions}
+ * WebpushFcmOptions}.
  *
  * @public
  */
@@ -52,15 +52,15 @@ export declare interface FcmOptions {
 export declare function getMessaging(app?: FirebaseApp): Messaging;
 
 /**
- * Subscribes the {@link Messaging} instance to push notifications. Returns an Firebase Cloud
+ * 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}
  * instance.
  *
- * If a notification permission isn't already granted, this method asks the user for permission. The
+ * If notification permission isn't already granted, this method asks the user for permission. The
  * returned promise rejects if the user does not allow the app to show notifications.
  *
  * @param messaging - The {@link Messaging} instance.
- * @param options - Provides an optional vapid key and an optinoal service worker registration
+ * @param options - Provides an optional vapid key and an optional service worker registration.
  *
  * @returns The promise resolves with an FCM registration token.
  *
@@ -69,18 +69,18 @@ export declare function getMessaging(app?: FirebaseApp): Messaging;
 export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
 
 /**
- * Options for {@link getToken}
+ * Options for {@link getToken}.
  *
  * @public
  */
 export declare interface GetTokenOptions {
     /**
-     * The public server key provided to push services. It is used to
-     * authenticate the push subscribers to receive push messages only from sending servers that hold
+     * 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_with_fcm | Configure Web Credentials with FCM}.
+     * {@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.
@@ -90,7 +90,7 @@ export declare interface GetTokenOptions {
      * 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#retrieve-the-current-registration-token | Retrieve the current registration token}
+     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
      * for more details.
      */
     serviceWorkerRegistration?: ServiceWorkerRegistration;
@@ -124,7 +124,7 @@ 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
  * number of key-value pairs sent by developers through the
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
  *
  * @public
  */
@@ -153,7 +153,7 @@ export declare interface MessagePayload {
      */
     collapseKey: string;
     /**
-     * The message id of a message.
+     * The message ID of a message.
      */
     messageId: string;
 }
@@ -172,8 +172,8 @@ export declare interface Messaging {
 export { NextFn }
 
 /**
- * Display notification details. They are sent through the
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
+ * Display notification details. Details are sent through the
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
  *
  * @public
  */

package/dist/src/api.d.ts

@@ -34,15 +34,15 @@ export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;
  */
 export declare function getMessagingInSw(app?: FirebaseApp): Messaging;
 /**
- * Subscribes the {@link Messaging} instance to push notifications. Returns an Firebase Cloud
+ * 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}
  * instance.
  *
- * If a notification permission isn't already granted, this method asks the user for permission. The
+ * If notification permission isn't already granted, this method asks the user for permission. The
  * returned promise rejects if the user does not allow the app to show notifications.
  *
  * @param messaging - The {@link Messaging} instance.
- * @param options - Provides an optional vapid key and an optinoal service worker registration
+ * @param options - Provides an optional vapid key and an optional service worker registration.
  *
  * @returns The promise resolves with an FCM registration token.
  *

package/dist/src/interfaces/public-types.d.ts

@@ -16,8 +16,8 @@
  */
 import { FirebaseApp } from '@firebase/app';
 /**
- * Display notification details. They are sent through the
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
+ * Display notification details. Details are sent through the
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
  *
  * @public
  */
@@ -43,7 +43,7 @@ export interface NotificationPayload {
 /**
  * Options for features provided by the FCM SDK for Web. See {@link
  * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
- * WebpushFcmOptions}
+ * WebpushFcmOptions}.
  *
  * @public
  */
@@ -61,7 +61,7 @@ export interface FcmOptions {
  * Message payload that contains the notification payload that is represented with
  * {@link NotificationPayload} and the data payload that contains an arbitrary
  * number of key-value pairs sent by developers through the
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
  *
  * @public
  */
@@ -90,23 +90,23 @@ export interface MessagePayload {
      */
     collapseKey: string;
     /**
-     * The message id of a message.
+     * The message ID of a message.
      */
     messageId: string;
 }
 /**
- * Options for {@link getToken}
+ * Options for {@link getToken}.
  *
  * @public
  */
 export interface GetTokenOptions {
     /**
-     * The public server key provided to push services. It is used to
-     * authenticate the push subscribers to receive push messages only from sending servers that hold
+     * 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_with_fcm | Configure Web Credentials with FCM}.
+     * {@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.
@@ -116,7 +116,7 @@ export interface GetTokenOptions {
      * 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#retrieve-the-current-registration-token | Retrieve the current registration token}
+     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
      * for more details.
      */
     serviceWorkerRegistration?: ServiceWorkerRegistration;

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

@@ -17,7 +17,7 @@ export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(
 /**
  * Options for features provided by the FCM SDK for Web. See {@link
  * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
- * WebpushFcmOptions}
+ * WebpushFcmOptions}.
  *
  * @public
  */
@@ -41,18 +41,18 @@ export declare interface FcmOptions {
  */
 export declare function getMessaging(app?: FirebaseApp): Messaging;
 /**
- * Options for {@link getToken}
+ * Options for {@link getToken}.
  *
  * @public
  */
 export declare interface GetTokenOptions {
     /**
-     * The public server key provided to push services. It is used to
-     * authenticate the push subscribers to receive push messages only from sending servers that hold
+     * 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_with_fcm | Configure Web Credentials with FCM}.
+     * {@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.
@@ -62,7 +62,7 @@ export declare interface GetTokenOptions {
      * 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#retrieve-the-current-registration-token | Retrieve the current registration token}
+     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
      * for more details.
      */
     serviceWorkerRegistration?: ServiceWorkerRegistration;
@@ -78,7 +78,7 @@ 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
  * number of key-value pairs sent by developers through the
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
  *
  * @public
  */
@@ -107,7 +107,7 @@ export declare interface MessagePayload {
      */
     collapseKey: string;
     /**
-     * The message id of a message.
+     * The message ID of a message.
      */
     messageId: string;
 }
@@ -124,8 +124,8 @@ export declare interface Messaging {
 }
 export { NextFn };
 /**
- * Display notification details. They are sent through the
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
+ * Display notification details. Details are sent through the
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
  *
  * @public
  */

package/dist/sw/internal.d.ts

@@ -19,7 +19,7 @@ export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(
 /**
  * Options for features provided by the FCM SDK for Web. See {@link
  * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
- * WebpushFcmOptions}
+ * WebpushFcmOptions}.
  *
  * @public
  */
@@ -49,18 +49,18 @@ export declare type _FirebaseMessagingName = 'messaging';
 export declare function getMessaging(app?: FirebaseApp): Messaging;
 
 /**
- * Options for {@link getToken}
+ * Options for {@link getToken}.
  *
  * @public
  */
 export declare interface GetTokenOptions {
     /**
-     * The public server key provided to push services. It is used to
-     * authenticate the push subscribers to receive push messages only from sending servers that hold
+     * 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_with_fcm | Configure Web Credentials with FCM}.
+     * {@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.
@@ -70,7 +70,7 @@ export declare interface GetTokenOptions {
      * 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#retrieve-the-current-registration-token | Retrieve the current registration token}
+     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
      * for more details.
      */
     serviceWorkerRegistration?: ServiceWorkerRegistration;
@@ -88,7 +88,7 @@ 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
  * number of key-value pairs sent by developers through the
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
  *
  * @public
  */
@@ -117,7 +117,7 @@ export declare interface MessagePayload {
      */
     collapseKey: string;
     /**
-     * The message id of a message.
+     * The message ID of a message.
      */
     messageId: string;
 }
@@ -136,8 +136,8 @@ export declare interface Messaging {
 export { NextFn }
 
 /**
- * Display notification details. They are sent through the
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
+ * Display notification details. Details are sent through the
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
  *
  * @public
  */

package/dist/sw/private.d.ts

@@ -19,7 +19,7 @@ export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(
 /**
  * Options for features provided by the FCM SDK for Web. See {@link
  * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
- * WebpushFcmOptions}
+ * WebpushFcmOptions}.
  *
  * @public
  */
@@ -46,18 +46,18 @@ export declare interface FcmOptions {
 export declare function getMessaging(app?: FirebaseApp): Messaging;
 
 /**
- * Options for {@link getToken}
+ * Options for {@link getToken}.
  *
  * @public
  */
 export declare interface GetTokenOptions {
     /**
-     * The public server key provided to push services. It is used to
-     * authenticate the push subscribers to receive push messages only from sending servers that hold
+     * 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_with_fcm | Configure Web Credentials with FCM}.
+     * {@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.
@@ -67,7 +67,7 @@ export declare interface GetTokenOptions {
      * 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#retrieve-the-current-registration-token | Retrieve the current registration token}
+     * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
      * for more details.
      */
     serviceWorkerRegistration?: ServiceWorkerRegistration;
@@ -85,7 +85,7 @@ 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
  * number of key-value pairs sent by developers through the
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
  *
  * @public
  */
@@ -114,7 +114,7 @@ export declare interface MessagePayload {
      */
     collapseKey: string;
     /**
-     * The message id of a message.
+     * The message ID of a message.
      */
     messageId: string;
 }
@@ -133,8 +133,8 @@ export declare interface Messaging {
 export { NextFn }
 
 /**
- * Display notification details. They are sent through the
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
+ * Display notification details. Details are sent through the
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
  *
  * @public
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/messaging",
-  "version": "0.12.4-canary.f3067f72d",
+  "version": "0.12.4-canary.f497a400a",
   "description": "",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.cjs.js",
@@ -50,18 +50,18 @@
   },
   "license": "Apache-2.0",
   "peerDependencies": {
-    "@firebase/app": "0.9.13-canary.f3067f72d"
+    "@firebase/app": "0.9.15-canary.f497a400a"
   },
   "dependencies": {
-    "@firebase/installations": "0.6.4-canary.f3067f72d",
-    "@firebase/messaging-interop-types": "0.2.0-canary.f3067f72d",
-    "@firebase/util": "1.9.3-canary.f3067f72d",
-    "@firebase/component": "0.6.4-canary.f3067f72d",
+    "@firebase/installations": "0.6.4-canary.f497a400a",
+    "@firebase/messaging-interop-types": "0.2.0-canary.f497a400a",
+    "@firebase/util": "1.9.3-canary.f497a400a",
+    "@firebase/component": "0.6.4-canary.f497a400a",
     "idb": "7.1.1",
     "tslib": "^2.1.0"
   },
   "devDependencies": {
-    "@firebase/app": "0.9.13-canary.f3067f72d",
+    "@firebase/app": "0.9.15-canary.f497a400a",
     "rollup": "2.79.1",
     "rollup-plugin-typescript2": "0.31.2",
     "@rollup/plugin-json": "4.1.0",