Remove messaging-types-exp (#4498)

* save

* save

* fix tsdoc

* export public types

* remove the package from changeset config

Author: Feiyang1

.changeset/config.json

@@ -24,7 +24,6 @@
     "@firebase/installations-types-exp",
     "@firebase/installations-compat",
     "@firebase/messaging-exp",
-    "@firebase/messaging-types-exp",
     "@firebase/performance-exp",
     "@firebase/performance-types-exp",
     "@firebase/remote-config-exp",

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

@@ -5,16 +5,27 @@
 ```ts
 
 import { FirebaseApp } from '@firebase/app-exp';
-import { FirebaseMessaging } from '@firebase/messaging-types-exp';
-import { MessagePayload } from '@firebase/messaging-types-exp';
 import { NextFn } from '@firebase/util';
 import { Observer } from '@firebase/util';
 import { Unsubscribe } from '@firebase/util';
 
 // @public
 export function deleteToken(messaging: FirebaseMessaging): Promise<boolean>;
 
-export { FirebaseMessaging }
+// @public (undocumented)
+export interface FcmOptions {
+    // (undocumented)
+    analyticsLabel?: string;
+    // (undocumented)
+    link?: string;
+}
+
+// @public (undocumented)
+export interface FirebaseMessaging {
+}
+
+// @internal (undocumented)
+export type _FirebaseMessagingName = 'messaging';
 
 // @public
 export function getMessaging(app: FirebaseApp): FirebaseMessaging;
@@ -25,7 +36,31 @@ export function getToken(messaging: FirebaseMessaging, options?: {
     swReg?: ServiceWorkerRegistration;
 }): Promise<string>;
 
-export { MessagePayload }
+// @public (undocumented)
+export interface MessagePayload {
+    // (undocumented)
+    collapseKey: string;
+    // (undocumented)
+    data?: {
+        [key: string]: string;
+    };
+    // (undocumented)
+    fcmOptions?: FcmOptions;
+    // (undocumented)
+    from: string;
+    // (undocumented)
+    notification?: NotificationPayload;
+}
+
+// @public
+export interface NotificationPayload {
+    // (undocumented)
+    body?: string;
+    // (undocumented)
+    image?: string;
+    // (undocumented)
+    title?: string;
+}
 
 // @public
 export function onMessage(messaging: FirebaseMessaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

packages-exp/messaging-exp/package.json

@@ -34,7 +34,6 @@
   "dependencies": {
     "@firebase/component": "0.2.0",
     "@firebase/installations-exp": "0.0.900",
-    "@firebase/messaging-types-exp": "0.0.900",
     "@firebase/util": "0.3.4",
     "idb": "3.0.2",
     "tslib": "^1.11.1"

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

@@ -15,10 +15,7 @@
  * limitations under the License.
  */
 
-import {
-  FirebaseMessaging,
-  MessagePayload
-} from '@firebase/messaging-types-exp';
+import { FirebaseMessaging, MessagePayload } from './interfaces/public-types';
 import { NextFn, Observer, Unsubscribe } from '@firebase/util';
 
 import { MessagingService } from './messaging-service';
@@ -32,7 +29,9 @@ import { onMessage as _onMessage } from './api/onMessage';
 /**
  * Retrieves a firebase messaging instance.
  *
- * @return the firebase messaging instance associated with the provided firebase app.
+ * @returns the firebase messaging instance associated with the provided firebase app.
+ *
+ * @public
  */
 export function getMessaging(app: FirebaseApp): FirebaseMessaging {
   const messagingProvider: Provider<'messaging-exp'> = _getProvider(
@@ -50,25 +49,26 @@ export function getMessaging(app: FirebaseApp): FirebaseMessaging {
  * If a 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 messaging instance.
- * @param options.vapidKey The public server key provided to push services. It is used to
+ * @param messaging - the messaging instance.
+ * @param options.vapidKey - 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 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_with_fcm | 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.}
+ * {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
+ * for details on web push services.
  *
- * @param options.serviceWorkerRegistration The service worker registration for receiving push
+ * @param options.serviceWorkerRegistration - 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#retrieve-the-current-registration-token | Retrieve the current registration token}
  * for more details.
  *
- * @return The promise resolves with an FCM registration token.
+ * @returns The promise resolves with an FCM registration token.
  *
+ * @public
  */
 export async function getToken(
   messaging: FirebaseMessaging,
@@ -81,9 +81,11 @@ export async function getToken(
  * Deletes the registration token associated with this messaging instance and unsubscribes the
  * messaging instance from the push subscription.
  *
- * @param messaging: the messaging instance.
+ * @param messaging - the messaging instance.
+ *
+ * @returns The promise resolves when the token has been successfully deleted.
  *
- * @return The promise resolves when the token has been successfully deleted.
+ * @public
  */
 export function deleteToken(messaging: FirebaseMessaging): Promise<boolean> {
   return _deleteToken(messaging as MessagingService);
@@ -95,11 +97,12 @@ export function deleteToken(messaging: FirebaseMessaging): Promise<boolean> {
  * the push message.
  *
  *
- * @param messaging: the messaging instance.
- * @param
- *     nextOrObserver This function, or observer object with `next` defined,
+ * @param messaging - the messaging instance.
+ * @param nextOrObserver - This function, or observer object with `next` defined,
  *     is called when a message is received and the user is currently viewing your page.
- * @return To stop listening for messages execute this returned function.
+ * @returns To stop listening for messages execute this returned function.
+ *
+ * @public
  */
 export function onMessage(
   messaging: FirebaseMessaging,
@@ -112,18 +115,17 @@ export function onMessage(
  * 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.
  *
- * @param messaging: the messaging instance.
- * @param
- *     nextOrObserver This function, or observer object with `next` defined,
+ * @param messaging - the messaging instance.
+ * @param nextOrObserver - This function, or observer object with `next` defined,
  *     is called when a message is received and the app is currently in the background.
  *
- * @return To stop listening for messages execute this returned function
+ * @returns To stop listening for messages execute this returned function
+ *
+ * @public
  */
 export function onBackgroundMessage(
   messaging: FirebaseMessaging,
   nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>
 ): Unsubscribe {
   return _onBackgroundMessage(messaging as MessagingService, nextOrObserver);
 }
-
-export { FirebaseMessaging, MessagePayload };

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

@@ -18,7 +18,7 @@
 import { ERROR_FACTORY, ErrorCode } from '../util/errors';
 import { NextFn, Observer, Unsubscribe } from '@firebase/util';
 
-import { MessagePayload } from '@firebase/messaging-types-exp';
+import { MessagePayload } from '../interfaces/public-types';
 import { MessagingService } from '../messaging-service';
 import { SwController } from '../listeners/sw-controller';
 

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

@@ -18,7 +18,7 @@
 import { ERROR_FACTORY, ErrorCode } from '../util/errors';
 import { NextFn, Observer, Unsubscribe } from '@firebase/util';
 
-import { MessagePayload } from '@firebase/messaging-types-exp';
+import { MessagePayload } from '../interfaces/public-types';
 import { MessagingService } from '../messaging-service';
 import { messageEventListener } from '../listeners/messageEventListener';
 

packages-exp/messaging-exp/src/helpers/externalizePayload.test.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { MessagePayload } from '@firebase/messaging-types-exp';
+import { MessagePayload } from '../interfaces/public-types';
 import { MessagePayloadInternal } from '../interfaces/internal-message-payload';
 import { expect } from 'chai';
 import { externalizePayload } from './externalizePayload';

packages-exp/messaging-exp/src/helpers/externalizePayload.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { MessagePayload } from '@firebase/messaging-types-exp';
+import { MessagePayload } from '../interfaces/public-types';
 import { MessagePayloadInternal } from '../interfaces/internal-message-payload';
 
 export function externalizePayload(

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

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { FirebaseMessaging } from '@firebase/messaging-types-exp';
+import { FirebaseMessaging } from './interfaces/public-types';
 import { registerMessaging } from './helpers/register';
 import '@firebase/installations-exp';
 

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

@@ -15,18 +15,12 @@
  * limitations under the License.
  */
 
-import { FirebaseMessaging } from '@firebase/messaging-types-exp';
+import { FirebaseMessaging } from './interfaces/public-types';
 import { registerMessaging } from './helpers/register';
 import '@firebase/installations-exp';
 
-export {
-  getToken,
-  deleteToken,
-  onMessage,
-  getMessaging,
-  FirebaseMessaging,
-  MessagePayload
-} from './api';
+export { getToken, deleteToken, onMessage, getMessaging } from './api';
+export * from './interfaces/public-types';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {

packages-exp/messaging-types-exp/index.d.ts renamed to packages-exp/messaging-exp/src/interfaces/public-types.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google LLC
+ * Copyright 2020 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -20,7 +20,7 @@ import { NextFn, Observer } from '@firebase/util';
 
 import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types';
 import { FirebaseInternalDependencies } from './interfaces/internal-dependencies';
-import { MessagePayload } from '@firebase/messaging-types-exp';
+import { MessagePayload } from './interfaces/public-types';
 import { Provider } from '@firebase/component';
 import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
 import { extractAppConfig } from './helpers/extract-app-config';