update fcm types

Author: Feiyang1

common/api-review/messaging-exp.api.md

@@ -10,7 +10,7 @@ import { Observer } from '@firebase/util';
 import { Unsubscribe } from '@firebase/util';
 
 // @public
-export function deleteToken(messaging: FirebaseMessaging): Promise<boolean>;
+export function deleteToken(messaging: Messaging): Promise<boolean>;
 
 // @public
 export interface FcmOptions {
@@ -19,21 +19,14 @@ export interface FcmOptions {
 }
 
 // @public
-export interface FirebaseMessaging {
-}
-
-// @internal (undocumented)
-export type _FirebaseMessagingName = 'messaging';
-
-// @public
-export function getMessaging(app?: FirebaseApp): FirebaseMessaging;
+export function getMessaging(app?: FirebaseApp): Messaging;
 
 // @public
-export function getToken(messaging: FirebaseMessaging, options?: GetTokenOptions): Promise<string>;
+export function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
 
 // @public
 export interface GetTokenOptions {
-    swReg?: ServiceWorkerRegistration;
+    serviceWorkerRegistration?: ServiceWorkerRegistration;
     vapidKey?: string;
 }
 
@@ -51,6 +44,10 @@ export interface MessagePayload {
     notification?: NotificationPayload;
 }
 
+// @public
+export interface Messaging {
+}
+
 export { NextFn }
 
 // @public
@@ -63,7 +60,7 @@ export interface NotificationPayload {
 export { Observer }
 
 // @public
-export function onMessage(messaging: FirebaseMessaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
+export function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
 
 export { Unsubscribe }
 

packages-exp/messaging-exp/src/api.ts

@@ -17,7 +17,7 @@
 
 import { FirebaseApp, _getProvider, getApp } from '@firebase/app-exp';
 import {
-  FirebaseMessaging,
+  Messaging,
   GetTokenOptions,
   MessagePayload
 } from './interfaces/public-types';
@@ -41,9 +41,7 @@ import { onMessage as _onMessage } from './api/onMessage';
  *
  * @public
  */
-export function getMessagingInWindow(
-  app: FirebaseApp = getApp()
-): FirebaseMessaging {
+export function getMessagingInWindow(app: FirebaseApp = getApp()): Messaging {
   return _getProvider(getModularInstance(app), 'messaging-exp').getImmediate();
 }
 
@@ -54,9 +52,7 @@ export function getMessagingInWindow(
  *
  * @public
  */
-export function getMessagingInSw(
-  app: FirebaseApp = getApp()
-): FirebaseMessaging {
+export function getMessagingInSw(app: FirebaseApp = getApp()): Messaging {
   return _getProvider(
     getModularInstance(app),
     'messaging-sw-exp'
@@ -79,7 +75,7 @@ export function getMessagingInSw(
  * @public
  */
 export async function getToken(
-  messaging: FirebaseMessaging,
+  messaging: Messaging,
   options?: GetTokenOptions
 ): Promise<string> {
   messaging = getModularInstance(messaging);
@@ -96,7 +92,7 @@ export async function getToken(
  *
  * @public
  */
-export function deleteToken(messaging: FirebaseMessaging): Promise<boolean> {
+export function deleteToken(messaging: Messaging): Promise<boolean> {
   messaging = getModularInstance(messaging);
   return _deleteToken(messaging as MessagingService);
 }
@@ -115,7 +111,7 @@ export function deleteToken(messaging: FirebaseMessaging): Promise<boolean> {
  * @public
  */
 export function onMessage(
-  messaging: FirebaseMessaging,
+  messaging: Messaging,
   nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>
 ): Unsubscribe {
   messaging = getModularInstance(messaging);
@@ -135,7 +131,7 @@ export function onMessage(
  * @public
  */
 export function onBackgroundMessage(
-  messaging: FirebaseMessaging,
+  messaging: Messaging,
   nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>
 ): Unsubscribe {
   messaging = getModularInstance(messaging);

packages-exp/messaging-exp/src/index.sw.ts

@@ -17,15 +17,15 @@
 
 import '@firebase/installations-exp';
 
-import { FirebaseMessaging } from './interfaces/public-types';
+import { Messaging } from './interfaces/public-types';
 import { registerMessagingInSw } from './helpers/register';
 
 export { onBackgroundMessage, getMessagingInSw as getMessaging } from './api';
 export { isSwSupported as isSupported } from './api/isSupported';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
-    'messaging-sw-exp': FirebaseMessaging;
+    'messaging-sw-exp': Messaging;
   }
 }
 

packages-exp/messaging-exp/src/index.ts

@@ -23,7 +23,7 @@
 
 import '@firebase/installations-exp';
 
-import { FirebaseMessaging } from './interfaces/public-types';
+import { Messaging } from './interfaces/public-types';
 import { registerMessagingInWindow } from './helpers/register';
 
 export {
@@ -37,7 +37,7 @@ export * from './interfaces/public-types';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
-    'messaging-exp': FirebaseMessaging;
+    'messaging-exp': Messaging;
   }
 }
 

packages-exp/messaging-exp/src/interfaces/public-types.ts

@@ -126,7 +126,7 @@ export interface GetTokenOptions {
  *
  * @public
  */
-export interface FirebaseMessaging {}
+export interface Messaging {}
 
 /**
  * @internal
@@ -137,6 +137,6 @@ export { NextFn, Observer, Unsubscribe } from '@firebase/util';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
-    'messaging-exp': FirebaseMessaging;
+    'messaging-exp': Messaging;
   }
 }