Merge

Author: schmidt-sebastian

.changeset/polite-readers-wait.md

@@ -7,22 +7,22 @@
 import { FirebaseApp } from '@firebase/app-types-exp';
 import { FirebaseInstallations } from '@firebase/installations-types-exp';
 
-// @public (undocumented)
+// @public
 export function deleteInstallations(installations: FirebaseInstallations): Promise<void>;
 
-// @public (undocumented)
+// @public
 export function getId(installations: FirebaseInstallations): Promise<string>;
 
-// @public (undocumented)
+// @public
 export function getInstallations(app: FirebaseApp): FirebaseInstallations;
 
-// @public (undocumented)
+// @public
 export function getToken(installations: FirebaseInstallations, forceRefresh?: boolean): Promise<string>;
 
-// @public (undocumented)
+// @public
 export type IdChangeCallbackFn = (installationId: string) => void;
 
-// @public (undocumented)
+// @public
 export type IdChangeUnsubscribeFn = () => void;
 
 // @public

.changeset/shiny-forks-pull.md

@@ -7,7 +7,7 @@
     "test:ci": "node ../../scripts/run_tests_in_ci.js -s test"
   },
   "devDependencies": {
-    "firebase": "7.20.0",
+    "firebase": "7.21.0",
     "@babel/core": "7.11.4",
     "@babel/preset-env": "7.11.0",
     "@types/chai": "4.2.12",

.changeset/tame-donuts-relate.md

@@ -15,7 +15,7 @@
   },
   "devDependencies": {
     "@firebase/app": "0.6.11",
-    "@firebase/firestore": "1.16.7",
+    "@firebase/firestore": "1.17.0",
     "@types/mocha": "7.0.2",
     "gulp": "4.0.2",
     "gulp-filter": "6.0.0",

.changeset/thin-buses-fail.md

@@ -9,7 +9,7 @@
     "test:manual": "mocha --exit"
   },
   "devDependencies": {
-    "firebase": "7.20.0",
+    "firebase": "7.21.0",
     "chai": "4.2.0",
     "chromedriver": "84.0.1",
     "express": "4.17.1",

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

@@ -40,7 +40,7 @@
     "@firebase/app-exp": "0.0.800",
     "@firebase/app-compat": "0.0.800",
     "@firebase/functions-exp": "0.0.800",
-    "@firebase/firestore": "1.16.7"
+    "@firebase/firestore": "1.17.0"
   },
   "devDependencies": {
     "rollup": "2.26.7",

integration/firebase/package.json

@@ -23,6 +23,8 @@ import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 import { FirebaseInstallations } from '@firebase/installations-types-exp';
 
 /**
+ * Deletes the Firebase Installation and all associated data.
+ *
  * @public
  */
 export async function deleteInstallations(

integration/firestore/package.json

@@ -21,6 +21,9 @@ import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 import { FirebaseInstallations } from '@firebase/installations-types-exp';
 
 /**
+ * Creates a Firebase Installation if there isn't one for the app and
+ * returns the Installation ID.
+ *
  * @public
  */
 export async function getId(

integration/messaging/package.json

@@ -20,6 +20,8 @@ import { FirebaseInstallations } from '@firebase/installations-types-exp';
 import { _getProvider } from '@firebase/app-exp';
 
 /**
+ * Returns an instance of FirebaseInstallations associated with the given FirebaseApp instance.
+ *
  * @public
  */
 export function getInstallations(app: FirebaseApp): FirebaseInstallations {

packages-exp/firebase-exp/package.json

@@ -24,6 +24,8 @@ import {
 import { FirebaseInstallations } from '@firebase/installations-types-exp';
 
 /**
+ * Returns an Installation auth token, identifying the current Firebase Installation.
+ *
  * @public
  */
 export async function getToken(

packages-exp/installations-exp/src/api/delete-installations.ts

@@ -20,10 +20,14 @@ import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 import { FirebaseInstallations } from '@firebase/installations-types-exp';
 
 /**
+ * An user defined callback function that gets called when Installations ID changes.
+ *
  * @public
  */
 export type IdChangeCallbackFn = (installationId: string) => void;
 /**
+ * Unsubscribe a callback function previously added via {@link #IdChangeCallbackFn}.
+ *
  * @public
  */
 export type IdChangeUnsubscribeFn = () => void;

packages-exp/installations-exp/src/api/get-id.ts

@@ -16,6 +16,8 @@
  */
 
 /**
+ * Public interface of the FirebaseInstallations SDK.
+ *
  * @public
  */
 export interface FirebaseInstallations {}

packages-exp/installations-exp/src/api/get-installations.ts

@@ -30,4 +30,4 @@
   "devDependencies": {
     "typescript": "4.0.2"
   }
-}
+}

packages-exp/installations-exp/src/api/get-token.ts

@@ -22,20 +22,20 @@
     "prettier": "prettier --write '{src,test}/**/*.{js,ts}'"
   },
   "peerDependencies": {
-    "@firebase/app": "0.x",
-    "@firebase/app-types": "0.x"
+    "@firebase/app-exp": "0.x",
+    "@firebase/app-types-exp": "0.x"
   },
   "dependencies": {
     "@firebase/logger": "0.2.6",
-    "@firebase/installations": "0.4.17",
+    "@firebase/installations-exp": "0.0.800",
     "@firebase/util": "0.3.2",
     "@firebase/performance-types-exp": "0.0.800",
     "@firebase/component": "0.1.19",
     "tslib": "^1.11.1"
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@firebase/app": "0.6.11",
+    "@firebase/app-exp": "0.0.800",
     "rollup": "2.26.7",
     "rollup-plugin-json": "4.0.0",
     "rollup-plugin-typescript2": "0.27.2",

packages-exp/installations-exp/src/api/on-id-change.ts

@@ -31,7 +31,7 @@ const es5BuildPlugins = [typescriptPlugin({ typescript }), json()];
 
 const es5Builds = [
   {
-    input: 'index.ts',
+    input: 'src/index.ts',
     output: [
       { file: pkg.main, format: 'cjs', sourcemap: true },
       { file: pkg.module, format: 'es', sourcemap: true }
@@ -59,7 +59,7 @@ const es2017BuildPlugins = [
 
 const es2017Builds = [
   {
-    input: 'index.ts',
+    input: 'src/index.ts',
     output: [{ file: pkg.esm2017, format: 'es', sourcemap: true }],
     plugins: es2017BuildPlugins,
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))

packages-exp/installations-types-exp/index.d.ts

@@ -20,7 +20,7 @@ import { stub } from 'sinon';
 import { PerformanceController } from '../controllers/perf';
 import { Trace } from '../resources/trace';
 import { Api, setupApi } from '../services/api_service';
-import { FirebaseApp } from '@firebase/app-types';
+import { FirebaseApp } from '@firebase/app-types-exp';
 import * as initializationService from '../services/initialization_service';
 import * as FirebaseUtil from '@firebase/util';
 import { consoleLogger } from '../utils/console_logger';

packages-exp/installations-types-exp/package.json

@@ -19,11 +19,12 @@ import { setupOobResources } from '../services/oob_resources_service';
 import { SettingsService } from '../services/settings_service';
 import { getInitializationPromise } from '../services/initialization_service';
 import { Api } from '../services/api_service';
-import { FirebaseApp } from '@firebase/app-types';
-import { FirebasePerformance } from '@firebase/performance-types';
+import { FirebaseApp } from '@firebase/app-types-exp';
+import { FirebasePerformance } from '@firebase/performance-types-exp';
 import { setupTransportService } from '../services/transport_service';
 import { validateIndexedDBOpenable } from '@firebase/util';
 import { consoleLogger } from '../utils/console_logger';
+
 export class PerformanceController implements FirebasePerformance {
   constructor(readonly app: FirebaseApp) {
     if (Api.getInstance().requiredApisAvailable()) {

packages-exp/performance-exp/index.ts

@@ -0,0 +1,73 @@
+/**
+ * @license
+ * 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.
+ * 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.
+ */
+
+import { FirebaseApp } from '@firebase/app-types-exp';
+import { FirebasePerformance } from '@firebase/performance-types-exp';
+import { ERROR_FACTORY, ErrorCode } from './utils/errors';
+import { setupApi } from './services/api_service';
+import { PerformanceController } from './controllers/perf';
+import {
+  _registerComponent,
+  _getProvider,
+  registerVersion
+} from '@firebase/app-exp';
+import {
+  InstanceFactory,
+  ComponentContainer,
+  Component,
+  ComponentType
+} from '@firebase/component';
+import { SettingsService } from './services/settings_service';
+import { name, version } from '../package.json';
+
+const DEFAULT_ENTRY_NAME = '[DEFAULT]';
+
+export function getPerformance(app: FirebaseApp): FirebasePerformance {
+  const provider = _getProvider(app, 'performance-exp');
+  const perfInstance = provider.getImmediate() as PerformanceController;
+  return perfInstance;
+}
+
+const factory: InstanceFactory<'performance-exp'> = (
+  container: ComponentContainer
+) => {
+  // Dependencies
+  const app = container.getProvider('app-exp').getImmediate();
+  const installations = container
+    .getProvider('installations-exp-internal')
+    .getImmediate();
+
+  if (app.name !== DEFAULT_ENTRY_NAME) {
+    throw ERROR_FACTORY.create(ErrorCode.FB_NOT_DEFAULT);
+  }
+  if (typeof window === 'undefined') {
+    throw ERROR_FACTORY.create(ErrorCode.NO_WINDOW);
+  }
+  setupApi(window);
+  SettingsService.getInstance().firebaseAppInstance = app;
+  SettingsService.getInstance().installationsService = installations;
+  return new PerformanceController(app);
+};
+
+export function registerPerformance(): void {
+  _registerComponent(
+    new Component('performance-exp', factory, ComponentType.PUBLIC)
+  );
+}
+
+registerPerformance();
+registerVersion(name, version);

packages-exp/performance-exp/package.json

@@ -35,7 +35,7 @@ import {
   isValidMetricName,
   convertMetricValueToInteger
 } from '../utils/metric_utils';
-import { PerformanceTrace } from '@firebase/performance-types';
+import { PerformanceTrace } from '@firebase/performance-types-exp';
 
 const enum TraceState {
   UNINITIALIZED = 1,