@firebase/messaging 0.12.4 → 0.12.5-20231120214520

package/dist/esm/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/index-public.d.ts

@@ -1,5 +1,6 @@
 /**
- * Firebase Cloud Messaging
+ * The Firebase Cloud Messaging Web SDK.
+ * This SDK does not work in a Node.js environment.
  *
  * @packageDocumentation
  */
@@ -21,7 +22,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
  */
@@ -45,15 +46,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.
  *
@@ -61,18 +62,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.
@@ -82,7 +83,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;
@@ -114,7 +115,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
  */
@@ -143,7 +144,7 @@ export declare interface MessagePayload {
      */
     collapseKey: string;
     /**
-     * The message id of a message.
+     * The message ID of a message.
      */
     messageId: string;
 }
@@ -160,8 +161,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/index.cjs.js

@@ -1271,7 +1271,7 @@ function messageEventListener(messaging, event) {
 }
 
 var name = "@firebase/messaging";
-var version = "0.12.4";
+var version = "0.12.5-20231120214520";
 
 /**
  * @license
@@ -1472,15 +1472,15 @@ function getMessagingInWindow(app$1) {
     return app._getProvider(util.getModularInstance(app$1), 'messaging').getImmediate();
 }
 /**
- * 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.
  *
@@ -1527,7 +1527,8 @@ function onMessage(messaging, nextOrObserver) {
 }
 
 /**
- * Firebase Cloud Messaging
+ * The Firebase Cloud Messaging Web SDK.
+ * This SDK does not work in a Node.js environment.
  *
  * @packageDocumentation
  */