Create FCM Interop for v9 Function (#5336)

Author: zwu52

packages-exp/messaging-exp/package.json

@@ -38,6 +38,7 @@
   "dependencies": {
     "@firebase/component": "0.5.6",
     "@firebase/installations-exp": "0.0.900",
+    "@firebase/messaging-interop-types": "0.0.1",
     "@firebase/util": "1.3.0",
     "idb": "3.0.2",
     "tslib": "^2.1.0"

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

@@ -29,27 +29,18 @@ import {
   onSubChange
 } from '../listeners/sw-listeners';
 
+import { GetTokenOptions } from '../interfaces/public-types';
+import { MessagingInternal } from '@firebase/messaging-interop-types';
 import { MessagingService } from '../messaging-service';
 import { ServiceWorkerGlobalScope } from '../util/sw-types';
 import { _registerComponent } from '@firebase/app-exp';
+import { getToken } from '../api/getToken';
 import { messageEventListener } from '../listeners/window-listener';
 
 const WindowMessagingFactory: InstanceFactory<'messaging-exp'> = (
   container: ComponentContainer
 ) => {
-  // Conscious decision to make this async check non-blocking during the messaging instance
-  // initialization phase for performance consideration. An error would be thrown latter for
-  // developer's information. Developers can then choose to import and call `isSupported` for
-  // special handling.
-  isWindowSupported()
-    .then(isSupported => {
-      if (!isSupported) {
-        throw ERROR_FACTORY.create(ErrorCode.UNSUPPORTED_BROWSER);
-      }
-    })
-    .catch(_ => {
-      throw ERROR_FACTORY.create(ErrorCode.INDEXED_DB_UNSUPPORTED);
-    });
+  maybeThrowWindowError();
 
   const messaging = new MessagingService(
     container.getProvider('app-exp').getImmediate(),
@@ -64,6 +55,38 @@ const WindowMessagingFactory: InstanceFactory<'messaging-exp'> = (
   return messaging;
 };
 
+const WindowMessagingInternalFactory: InstanceFactory<'messaging-internal'> = (
+  container: ComponentContainer
+) => {
+  maybeThrowWindowError();
+
+  const messaging = container
+    .getProvider('messaging-exp')
+    .getImmediate() as MessagingService;
+
+  const messagingInternal: MessagingInternal = {
+    getToken: (options?: GetTokenOptions) => getToken(messaging, options)
+  };
+
+  return messagingInternal;
+};
+
+function maybeThrowWindowError(): void {
+  // Conscious decision to make this async check non-blocking during the messaging instance
+  // initialization phase for performance consideration. An error would be thrown latter for
+  // developer's information. Developers can then choose to import and call `isSupported` for
+  // special handling.
+  isWindowSupported()
+    .then(isSupported => {
+      if (!isSupported) {
+        throw ERROR_FACTORY.create(ErrorCode.UNSUPPORTED_BROWSER);
+      }
+    })
+    .catch(_ => {
+      throw ERROR_FACTORY.create(ErrorCode.INDEXED_DB_UNSUPPORTED);
+    });
+}
+
 declare const self: ServiceWorkerGlobalScope;
 const SwMessagingFactory: InstanceFactory<'messaging-exp'> = (
   container: ComponentContainer
@@ -105,6 +128,14 @@ export function registerMessagingInWindow(): void {
   _registerComponent(
     new Component('messaging-exp', WindowMessagingFactory, ComponentType.PUBLIC)
   );
+
+  _registerComponent(
+    new Component(
+      'messaging-internal',
+      WindowMessagingInternalFactory,
+      ComponentType.PRIVATE
+    )
+  );
 }
 
 /**

packages/messaging-interop-types/CHANGELOG.md

@@ -0,0 +1 @@
+# @firebase/messaging-interop-types

packages/messaging-interop-types/README.md

@@ -0,0 +1,4 @@
+# @firebase/messaging-interop-types
+
+**This package is not intended for direct usage, and should only be used via the officially
+supported [firebase](https://www.npmjs.com/package/firebase) package.**

packages/messaging-interop-types/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface MessagingInternal {
+  getToken(options?: GetTokenOptions): Promise<string>;
+}
+
+interface GetTokenOptions {
+  vapidKey?: string;
+  serviceWorkerRegistration?: ServiceWorkerRegistration;
+}
+
+export type MessagingInternalComponentName = 'messaging-internal';
+
+declare module '@firebase/component' {
+  interface NameServiceMapping {
+    'messaging-internal': MessagingInternal;
+  }
+}

packages/messaging-interop-types/package.json

@@ -0,0 +1,25 @@
+{
+    "name": "@firebase/messaging-interop-types",
+    "version": "0.0.1",
+    "description": "@firebase/messaging-interop-types Types",
+    "author": "Firebase <[email protected]> (https://firebase.google.com/)",
+    "license": "Apache-2.0",
+    "scripts": {
+      "test": "tsc",
+      "test:ci": "node ../../scripts/run_tests_in_ci.js"
+    },
+    "files": [
+      "index.d.ts"
+    ],
+    "repository": {
+      "directory": "packages/messaging-interop-types",
+      "type": "git",
+      "url": "https://github.com/firebase/firebase-js-sdk.git"
+    },
+    "bugs": {
+      "url": "https://github.com/firebase/firebase-js-sdk/issues"
+    },
+    "devDependencies": {
+      "typescript": "4.2.2"
+    }
+  }

packages/messaging-interop-types/tsconfig.json

@@ -0,0 +1,9 @@
+{
+    "extends": "../../config/tsconfig.base.json",
+    "compilerOptions": {
+      "noEmit": true
+    },
+    "exclude": [
+      "dist/**/*"
+    ]
+  }