@firebase/messaging 0.12.4 → 0.12.5-20231120214520

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,6 @@
1
1
  /**
2
- * Firebase Cloud Messaging
2
+ * The Firebase Cloud Messaging Web SDK.
3
+ * This SDK does not work in a Node.js environment.
3
4
  *
4
5
  * @packageDocumentation
5
6
  */
@@ -24,7 +25,7 @@ export declare function deleteToken(messaging: Messaging): Promise<boolean>;
24
25
  /**
25
26
  * Options for features provided by the FCM SDK for Web. See {@link
26
27
  * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
27
- * WebpushFcmOptions}
28
+ * WebpushFcmOptions}.
28
29
  *
29
30
  * @public
30
31
  */
@@ -54,15 +55,15 @@ export declare type _FirebaseMessagingName = 'messaging';
54
55
  export declare function getMessaging(app?: FirebaseApp): Messaging;
55
56
 
56
57
  /**
57
- * Subscribes the {@link Messaging} instance to push notifications. Returns an Firebase Cloud
58
+ * Subscribes the {@link Messaging} instance to push notifications. Returns a Firebase Cloud
58
59
  * Messaging registration token that can be used to send push messages to that {@link Messaging}
59
60
  * instance.
60
61
  *
61
- * If a notification permission isn't already granted, this method asks the user for permission. The
62
+ * If notification permission isn't already granted, this method asks the user for permission. The
62
63
  * returned promise rejects if the user does not allow the app to show notifications.
63
64
  *
64
65
  * @param messaging - The {@link Messaging} instance.
65
- * @param options - Provides an optional vapid key and an optinoal service worker registration
66
+ * @param options - Provides an optional vapid key and an optional service worker registration.
66
67
  *
67
68
  * @returns The promise resolves with an FCM registration token.
68
69
  *
@@ -71,18 +72,18 @@ export declare function getMessaging(app?: FirebaseApp): Messaging;
71
72
  export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
72
73
 
73
74
  /**
74
- * Options for {@link getToken}
75
+ * Options for {@link getToken}.
75
76
  *
76
77
  * @public
77
78
  */
78
79
  export declare interface GetTokenOptions {
79
80
  /**
80
- * The public server key provided to push services. It is used to
81
- * authenticate the push subscribers to receive push messages only from sending servers that hold
81
+ * The public server key provided to push services. The key is used to
82
+ * authenticate push subscribers to receive push messages only from sending servers that hold
82
83
  * the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
83
84
  * push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
84
85
  * to generate and import a VAPID key for your project with
85
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_with_fcm | Configure Web Credentials with FCM}.
86
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
86
87
  * See
87
88
  * {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
88
89
  * for details on web push services.
@@ -92,7 +93,7 @@ export declare interface GetTokenOptions {
92
93
  * The service worker registration for receiving push
93
94
  * messaging. If the registration is not provided explicitly, you need to have a
94
95
  * `firebase-messaging-sw.js` at your root location. See
95
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#retrieve-the-current-registration-token | Retrieve the current registration token}
96
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
96
97
  * for more details.
97
98
  */
98
99
  serviceWorkerRegistration?: ServiceWorkerRegistration;
@@ -126,7 +127,7 @@ export declare function isSupported(): Promise<boolean>;
126
127
  * Message payload that contains the notification payload that is represented with
127
128
  * {@link NotificationPayload} and the data payload that contains an arbitrary
128
129
  * number of key-value pairs sent by developers through the
129
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
130
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
130
131
  *
131
132
  * @public
132
133
  */
@@ -155,7 +156,7 @@ export declare interface MessagePayload {
155
156
  */
156
157
  collapseKey: string;
157
158
  /**
158
- * The message id of a message.
159
+ * The message ID of a message.
159
160
  */
160
161
  messageId: string;
161
162
  }
@@ -174,8 +175,8 @@ export declare interface Messaging {
174
175
  export { NextFn }
175
176
 
176
177
  /**
177
- * Display notification details. They are sent through the
178
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
178
+ * Display notification details. Details are sent through the
179
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
179
180
  *
180
181
  * @public
181
182
  */
package/dist/private.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  /**
2
- * Firebase Cloud Messaging
2
+ * The Firebase Cloud Messaging Web SDK.
3
+ * This SDK does not work in a Node.js environment.
3
4
  *
4
5
  * @packageDocumentation
5
6
  */
@@ -24,7 +25,7 @@ export declare function deleteToken(messaging: Messaging): Promise<boolean>;
24
25
  /**
25
26
  * Options for features provided by the FCM SDK for Web. See {@link
26
27
  * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
27
- * WebpushFcmOptions}
28
+ * WebpushFcmOptions}.
28
29
  *
29
30
  * @public
30
31
  */
@@ -51,15 +52,15 @@ export declare interface FcmOptions {
51
52
  export declare function getMessaging(app?: FirebaseApp): Messaging;
52
53
 
53
54
  /**
54
- * Subscribes the {@link Messaging} instance to push notifications. Returns an Firebase Cloud
55
+ * Subscribes the {@link Messaging} instance to push notifications. Returns a Firebase Cloud
55
56
  * Messaging registration token that can be used to send push messages to that {@link Messaging}
56
57
  * instance.
57
58
  *
58
- * If a notification permission isn't already granted, this method asks the user for permission. The
59
+ * If notification permission isn't already granted, this method asks the user for permission. The
59
60
  * returned promise rejects if the user does not allow the app to show notifications.
60
61
  *
61
62
  * @param messaging - The {@link Messaging} instance.
62
- * @param options - Provides an optional vapid key and an optinoal service worker registration
63
+ * @param options - Provides an optional vapid key and an optional service worker registration.
63
64
  *
64
65
  * @returns The promise resolves with an FCM registration token.
65
66
  *
@@ -68,18 +69,18 @@ export declare function getMessaging(app?: FirebaseApp): Messaging;
68
69
  export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
69
70
 
70
71
  /**
71
- * Options for {@link getToken}
72
+ * Options for {@link getToken}.
72
73
  *
73
74
  * @public
74
75
  */
75
76
  export declare interface GetTokenOptions {
76
77
  /**
77
- * The public server key provided to push services. It is used to
78
- * authenticate the push subscribers to receive push messages only from sending servers that hold
78
+ * The public server key provided to push services. The key is used to
79
+ * authenticate push subscribers to receive push messages only from sending servers that hold
79
80
  * the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
80
81
  * push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
81
82
  * to generate and import a VAPID key for your project with
82
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_with_fcm | Configure Web Credentials with FCM}.
83
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
83
84
  * See
84
85
  * {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
85
86
  * for details on web push services.
@@ -89,7 +90,7 @@ export declare interface GetTokenOptions {
89
90
  * The service worker registration for receiving push
90
91
  * messaging. If the registration is not provided explicitly, you need to have a
91
92
  * `firebase-messaging-sw.js` at your root location. See
92
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#retrieve-the-current-registration-token | Retrieve the current registration token}
93
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
93
94
  * for more details.
94
95
  */
95
96
  serviceWorkerRegistration?: ServiceWorkerRegistration;
@@ -123,7 +124,7 @@ export declare function isSupported(): Promise<boolean>;
123
124
  * Message payload that contains the notification payload that is represented with
124
125
  * {@link NotificationPayload} and the data payload that contains an arbitrary
125
126
  * number of key-value pairs sent by developers through the
126
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
127
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
127
128
  *
128
129
  * @public
129
130
  */
@@ -152,7 +153,7 @@ export declare interface MessagePayload {
152
153
  */
153
154
  collapseKey: string;
154
155
  /**
155
- * The message id of a message.
156
+ * The message ID of a message.
156
157
  */
157
158
  messageId: string;
158
159
  }
@@ -171,8 +172,8 @@ export declare interface Messaging {
171
172
  export { NextFn }
172
173
 
173
174
  /**
174
- * Display notification details. They are sent through the
175
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
175
+ * Display notification details. Details are sent through the
176
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
176
177
  *
177
178
  * @public
178
179
  */
package/dist/src/api.d.ts CHANGED
@@ -34,15 +34,15 @@ export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;
34
34
  */
35
35
  export declare function getMessagingInSw(app?: FirebaseApp): Messaging;
36
36
  /**
37
- * Subscribes the {@link Messaging} instance to push notifications. Returns an Firebase Cloud
37
+ * Subscribes the {@link Messaging} instance to push notifications. Returns a Firebase Cloud
38
38
  * Messaging registration token that can be used to send push messages to that {@link Messaging}
39
39
  * instance.
40
40
  *
41
- * If a notification permission isn't already granted, this method asks the user for permission. The
41
+ * If notification permission isn't already granted, this method asks the user for permission. The
42
42
  * returned promise rejects if the user does not allow the app to show notifications.
43
43
  *
44
44
  * @param messaging - The {@link Messaging} instance.
45
- * @param options - Provides an optional vapid key and an optinoal service worker registration
45
+ * @param options - Provides an optional vapid key and an optional service worker registration.
46
46
  *
47
47
  * @returns The promise resolves with an FCM registration token.
48
48
  *
@@ -1,5 +1,6 @@
1
1
  /**
2
- * Firebase Cloud Messaging
2
+ * The Firebase Cloud Messaging Web SDK.
3
+ * This SDK does not work in a Node.js environment.
3
4
  *
4
5
  * @packageDocumentation
5
6
  */
@@ -21,6 +21,7 @@ export interface MessagePayloadInternal {
21
21
  isFirebaseMessaging?: boolean;
22
22
  from: string;
23
23
  fcmMessageId: string;
24
+ productId: number;
24
25
  collapse_key: string;
25
26
  }
26
27
  export interface NotificationPayloadInternal extends NotificationOptions {
@@ -34,6 +34,16 @@ export interface LogRequest {
34
34
  export interface LogEvent {
35
35
  event_time_ms: string;
36
36
  source_extension_json_proto3: string;
37
+ compliance_data: ComplianceData;
38
+ }
39
+ export interface ComplianceData {
40
+ privacy_context: ExternalPrivacyContext;
41
+ }
42
+ export interface ExternalPrivacyContext {
43
+ prequest: ExternalPRequestContext;
44
+ }
45
+ export interface ExternalPRequestContext {
46
+ origin_associated_product_id: number;
37
47
  }
38
48
  export interface LogResponse {
39
49
  nextRequestWaitMillis: number;
@@ -16,8 +16,8 @@
16
16
  */
17
17
  import { FirebaseApp } from '@firebase/app';
18
18
  /**
19
- * Display notification details. They are sent through the
20
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
19
+ * Display notification details. Details are sent through the
20
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
21
21
  *
22
22
  * @public
23
23
  */
@@ -43,7 +43,7 @@ export interface NotificationPayload {
43
43
  /**
44
44
  * Options for features provided by the FCM SDK for Web. See {@link
45
45
  * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
46
- * WebpushFcmOptions}
46
+ * WebpushFcmOptions}.
47
47
  *
48
48
  * @public
49
49
  */
@@ -61,7 +61,7 @@ export interface FcmOptions {
61
61
  * Message payload that contains the notification payload that is represented with
62
62
  * {@link NotificationPayload} and the data payload that contains an arbitrary
63
63
  * number of key-value pairs sent by developers through the
64
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
64
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
65
65
  *
66
66
  * @public
67
67
  */
@@ -90,23 +90,23 @@ export interface MessagePayload {
90
90
  */
91
91
  collapseKey: string;
92
92
  /**
93
- * The message id of a message.
93
+ * The message ID of a message.
94
94
  */
95
95
  messageId: string;
96
96
  }
97
97
  /**
98
- * Options for {@link getToken}
98
+ * Options for {@link getToken}.
99
99
  *
100
100
  * @public
101
101
  */
102
102
  export interface GetTokenOptions {
103
103
  /**
104
- * The public server key provided to push services. It is used to
105
- * authenticate the push subscribers to receive push messages only from sending servers that hold
104
+ * The public server key provided to push services. The key is used to
105
+ * authenticate push subscribers to receive push messages only from sending servers that hold
106
106
  * the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
107
107
  * push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
108
108
  * to generate and import a VAPID key for your project with
109
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_with_fcm | Configure Web Credentials with FCM}.
109
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
110
110
  * See
111
111
  * {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
112
112
  * for details on web push services.
@@ -116,7 +116,7 @@ export interface GetTokenOptions {
116
116
  * The service worker registration for receiving push
117
117
  * messaging. If the registration is not provided explicitly, you need to have a
118
118
  * `firebase-messaging-sw.js` at your root location. See
119
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#retrieve-the-current-registration-token | Retrieve the current registration token}
119
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
120
120
  * for more details.
121
121
  */
122
122
  serviceWorkerRegistration?: ServiceWorkerRegistration;
@@ -17,7 +17,7 @@ export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(
17
17
  /**
18
18
  * Options for features provided by the FCM SDK for Web. See {@link
19
19
  * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
20
- * WebpushFcmOptions}
20
+ * WebpushFcmOptions}.
21
21
  *
22
22
  * @public
23
23
  */
@@ -41,18 +41,18 @@ export declare interface FcmOptions {
41
41
  */
42
42
  export declare function getMessaging(app?: FirebaseApp): Messaging;
43
43
  /**
44
- * Options for {@link getToken}
44
+ * Options for {@link getToken}.
45
45
  *
46
46
  * @public
47
47
  */
48
48
  export declare interface GetTokenOptions {
49
49
  /**
50
- * The public server key provided to push services. It is used to
51
- * authenticate the push subscribers to receive push messages only from sending servers that hold
50
+ * The public server key provided to push services. The key is used to
51
+ * authenticate push subscribers to receive push messages only from sending servers that hold
52
52
  * the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
53
53
  * push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
54
54
  * to generate and import a VAPID key for your project with
55
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_with_fcm | Configure Web Credentials with FCM}.
55
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
56
56
  * See
57
57
  * {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
58
58
  * for details on web push services.
@@ -62,7 +62,7 @@ export declare interface GetTokenOptions {
62
62
  * The service worker registration for receiving push
63
63
  * messaging. If the registration is not provided explicitly, you need to have a
64
64
  * `firebase-messaging-sw.js` at your root location. See
65
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#retrieve-the-current-registration-token | Retrieve the current registration token}
65
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
66
66
  * for more details.
67
67
  */
68
68
  serviceWorkerRegistration?: ServiceWorkerRegistration;
@@ -78,7 +78,7 @@ export declare function isSupported(): Promise<boolean>;
78
78
  * Message payload that contains the notification payload that is represented with
79
79
  * {@link NotificationPayload} and the data payload that contains an arbitrary
80
80
  * number of key-value pairs sent by developers through the
81
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
81
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
82
82
  *
83
83
  * @public
84
84
  */
@@ -107,7 +107,7 @@ export declare interface MessagePayload {
107
107
  */
108
108
  collapseKey: string;
109
109
  /**
110
- * The message id of a message.
110
+ * The message ID of a message.
111
111
  */
112
112
  messageId: string;
113
113
  }
@@ -124,8 +124,8 @@ export declare interface Messaging {
124
124
  }
125
125
  export { NextFn };
126
126
  /**
127
- * Display notification details. They are sent through the
128
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
127
+ * Display notification details. Details are sent through the
128
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
129
129
  *
130
130
  * @public
131
131
  */
@@ -19,7 +19,7 @@ export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(
19
19
  /**
20
20
  * Options for features provided by the FCM SDK for Web. See {@link
21
21
  * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
22
- * WebpushFcmOptions}
22
+ * WebpushFcmOptions}.
23
23
  *
24
24
  * @public
25
25
  */
@@ -49,18 +49,18 @@ export declare type _FirebaseMessagingName = 'messaging';
49
49
  export declare function getMessaging(app?: FirebaseApp): Messaging;
50
50
 
51
51
  /**
52
- * Options for {@link getToken}
52
+ * Options for {@link getToken}.
53
53
  *
54
54
  * @public
55
55
  */
56
56
  export declare interface GetTokenOptions {
57
57
  /**
58
- * The public server key provided to push services. It is used to
59
- * authenticate the push subscribers to receive push messages only from sending servers that hold
58
+ * The public server key provided to push services. The key is used to
59
+ * authenticate push subscribers to receive push messages only from sending servers that hold
60
60
  * the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
61
61
  * push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
62
62
  * to generate and import a VAPID key for your project with
63
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_with_fcm | Configure Web Credentials with FCM}.
63
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
64
64
  * See
65
65
  * {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
66
66
  * for details on web push services.
@@ -70,7 +70,7 @@ export declare interface GetTokenOptions {
70
70
  * The service worker registration for receiving push
71
71
  * messaging. If the registration is not provided explicitly, you need to have a
72
72
  * `firebase-messaging-sw.js` at your root location. See
73
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#retrieve-the-current-registration-token | Retrieve the current registration token}
73
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
74
74
  * for more details.
75
75
  */
76
76
  serviceWorkerRegistration?: ServiceWorkerRegistration;
@@ -88,7 +88,7 @@ export declare function isSupported(): Promise<boolean>;
88
88
  * Message payload that contains the notification payload that is represented with
89
89
  * {@link NotificationPayload} and the data payload that contains an arbitrary
90
90
  * number of key-value pairs sent by developers through the
91
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
91
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
92
92
  *
93
93
  * @public
94
94
  */
@@ -117,7 +117,7 @@ export declare interface MessagePayload {
117
117
  */
118
118
  collapseKey: string;
119
119
  /**
120
- * The message id of a message.
120
+ * The message ID of a message.
121
121
  */
122
122
  messageId: string;
123
123
  }
@@ -136,8 +136,8 @@ export declare interface Messaging {
136
136
  export { NextFn }
137
137
 
138
138
  /**
139
- * Display notification details. They are sent through the
140
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
139
+ * Display notification details. Details are sent through the
140
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
141
141
  *
142
142
  * @public
143
143
  */
@@ -19,7 +19,7 @@ export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(
19
19
  /**
20
20
  * Options for features provided by the FCM SDK for Web. See {@link
21
21
  * https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
22
- * WebpushFcmOptions}
22
+ * WebpushFcmOptions}.
23
23
  *
24
24
  * @public
25
25
  */
@@ -46,18 +46,18 @@ export declare interface FcmOptions {
46
46
  export declare function getMessaging(app?: FirebaseApp): Messaging;
47
47
 
48
48
  /**
49
- * Options for {@link getToken}
49
+ * Options for {@link getToken}.
50
50
  *
51
51
  * @public
52
52
  */
53
53
  export declare interface GetTokenOptions {
54
54
  /**
55
- * The public server key provided to push services. It is used to
56
- * authenticate the push subscribers to receive push messages only from sending servers that hold
55
+ * The public server key provided to push services. The key is used to
56
+ * authenticate push subscribers to receive push messages only from sending servers that hold
57
57
  * the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
58
58
  * push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
59
59
  * to generate and import a VAPID key for your project with
60
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_with_fcm | Configure Web Credentials with FCM}.
60
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
61
61
  * See
62
62
  * {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
63
63
  * for details on web push services.
@@ -67,7 +67,7 @@ export declare interface GetTokenOptions {
67
67
  * The service worker registration for receiving push
68
68
  * messaging. If the registration is not provided explicitly, you need to have a
69
69
  * `firebase-messaging-sw.js` at your root location. See
70
- * {@link https://firebase.google.com/docs/cloud-messaging/js/client#retrieve-the-current-registration-token | Retrieve the current registration token}
70
+ * {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
71
71
  * for more details.
72
72
  */
73
73
  serviceWorkerRegistration?: ServiceWorkerRegistration;
@@ -85,7 +85,7 @@ export declare function isSupported(): Promise<boolean>;
85
85
  * Message payload that contains the notification payload that is represented with
86
86
  * {@link NotificationPayload} and the data payload that contains an arbitrary
87
87
  * number of key-value pairs sent by developers through the
88
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
88
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
89
89
  *
90
90
  * @public
91
91
  */
@@ -114,7 +114,7 @@ export declare interface MessagePayload {
114
114
  */
115
115
  collapseKey: string;
116
116
  /**
117
- * The message id of a message.
117
+ * The message ID of a message.
118
118
  */
119
119
  messageId: string;
120
120
  }
@@ -133,8 +133,8 @@ export declare interface Messaging {
133
133
  export { NextFn }
134
134
 
135
135
  /**
136
- * Display notification details. They are sent through the
137
- * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
136
+ * Display notification details. Details are sent through the
137
+ * {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
138
138
  *
139
139
  * @public
140
140
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@firebase/messaging",
3
- "version": "0.12.4",
3
+ "version": "0.12.5-20231120214520",
4
4
  "description": "",
5
5
  "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
6
6
  "main": "dist/index.cjs.js",
@@ -36,8 +36,8 @@
36
36
  "build:deps": "lerna run --scope @firebase/'{app,messaging}' --include-dependencies build",
37
37
  "build:release": "yarn build && yarn typings:public",
38
38
  "dev": "rollup -c -w",
39
- "test": "run-p test:karma type-check lint ",
40
- "test:integration": "run-p test:karma type-check lint && cd ../../integration/messaging && npm run-script test",
39
+ "test": "run-p --npm-path npm test:karma type-check lint ",
40
+ "test:integration": "run-p --npm-path npm test:karma type-check lint && cd ../../integration/messaging && npm run-script test",
41
41
  "test:ci": "node ../../scripts/run_tests_in_ci.js",
42
42
  "test:karma": "karma start --single-run",
43
43
  "test:debug": "karma start --browsers=Chrome --auto-watch",
@@ -57,11 +57,11 @@
57
57
  "@firebase/messaging-interop-types": "0.2.0",
58
58
  "@firebase/util": "1.9.3",
59
59
  "@firebase/component": "0.6.4",
60
- "idb": "7.0.1",
60
+ "idb": "7.1.1",
61
61
  "tslib": "^2.1.0"
62
62
  },
63
63
  "devDependencies": {
64
- "@firebase/app": "0.9.4",
64
+ "@firebase/app": "0.9.23",
65
65
  "rollup": "2.79.1",
66
66
  "rollup-plugin-typescript2": "0.31.2",
67
67
  "@rollup/plugin-json": "4.1.0",