Remove installations-types-exp (#4497)

Feiyang1 · web-flow · commit 04e532239316 · 2021-02-25T21:15:59.000-08:00
* remove installations-types-exp

* fix installation compat

* fix import paths

* fix lint error

* remove api report

* remove unused scripts
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -21,7 +21,6 @@
     "@firebase/functions-compat",
     "@firebase/functions-exp",
     "@firebase/installations-exp",
-    "@firebase/installations-types-exp",
     "@firebase/installations-compat",
     "@firebase/messaging-exp",
     "@firebase/performance-exp",
diff --git a/common/api-review/installations-exp.api.md b/common/api-review/installations-exp.api.md
@@ -5,12 +5,19 @@
 ```ts
 
 import { FirebaseApp } from '@firebase/app-exp';
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
 
 // @public
 export function deleteInstallations(installations: FirebaseInstallations): Promise<void>;
 
-export { FirebaseInstallations }
+// @public
+export interface FirebaseInstallations {
+}
+
+// @internal
+export interface _FirebaseInstallationsInternal {
+    getId(): Promise<string>;
+    getToken(forceRefresh?: boolean): Promise<string>;
+}
 
 // @public
 export function getId(installations: FirebaseInstallations): Promise<string>;
diff --git a/common/api-review/installations-types-exp.api.md b/common/api-review/installations-types-exp.api.md
diff --git a/packages-exp/analytics-exp/src/factory.ts b/packages-exp/analytics-exp/src/factory.ts
@@ -19,7 +19,7 @@ import { SettingsOptions, Analytics } from './public-types';
 import { Gtag, DynamicConfig, MinimalDynamicConfig } from './types';
 import { getOrCreateDataLayer, wrapOrCreateGtag } from './helpers';
 import { AnalyticsError, ERROR_FACTORY } from './errors';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
 import { areCookiesEnabled, isBrowserExtension } from '@firebase/util';
 import { initializeAnalytics } from './initialize-analytics';
 import { logger } from './logger';
diff --git a/packages-exp/analytics-exp/src/index.test.ts b/packages-exp/analytics-exp/src/index.test.ts
@@ -36,7 +36,7 @@ import {
   resetGlobalVars,
   factory as analyticsFactory
 } from './factory';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
 
 let analyticsInstance: AnalyticsService = {} as AnalyticsService;
 const fakeMeasurementId = 'abcd-efgh';
diff --git a/packages-exp/analytics-exp/src/initialize-analytics.test.ts b/packages-exp/analytics-exp/src/initialize-analytics.test.ts
@@ -27,7 +27,7 @@ import { GtagCommand } from './constants';
 import { DynamicConfig } from './types';
 import { FirebaseApp } from '@firebase/app-exp';
 import { Deferred } from '@firebase/util';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
 import { removeGtagScript } from '../testing/gtag-script-util';
 
 const fakeMeasurementId = 'abcd-efgh-ijkl';
diff --git a/packages-exp/analytics-exp/src/initialize-analytics.ts b/packages-exp/analytics-exp/src/initialize-analytics.ts
@@ -17,7 +17,7 @@
 
 import { DynamicConfig, Gtag, MinimalDynamicConfig } from './types';
 import { GtagCommand, GA_FID_KEY, ORIGIN_KEY } from './constants';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
 import { fetchDynamicConfigWithRetry } from './get-config';
 import { logger } from './logger';
 import { FirebaseApp } from '@firebase/app-exp';
diff --git a/packages-exp/analytics-exp/testing/get-fake-firebase-services.ts b/packages-exp/analytics-exp/testing/get-fake-firebase-services.ts
@@ -16,7 +16,7 @@
  */
 
 import { FirebaseApp } from '@firebase/app-exp';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
 
 export function getFakeApp(fakeAppParams?: {
   appId?: string;
diff --git a/packages-exp/installations-compat/package.json b/packages-exp/installations-compat/package.json
@@ -26,11 +26,7 @@
     "type-check": "tsc -p . --noEmit",
     "serve": "yarn serve:build && yarn serve:host",
     "serve:build": "rollup -c test-app/rollup.config.js",
-    "serve:host": "http-server -c-1 test-app",
-    "api-report": "api-extractor run --local --verbose",
-    "predoc": "node ../../scripts/exp/remove-exp.js temp",
-    "doc": "api-documenter markdown --input temp --output docs",
-    "build:doc": "yarn build && yarn doc"
+    "serve:host": "http-server -c-1 test-app"
   },
   "repository": {
     "directory": "packages-exp/installations-compat",
@@ -55,7 +51,6 @@
   },
   "dependencies": {
     "@firebase/installations-exp": "0.0.900",
-    "@firebase/installations-types-exp": "0.0.900",
     "@firebase/util": "0.3.4",
     "@firebase/component": "0.2.0",
     "idb": "3.0.2",
diff --git a/packages-exp/installations-compat/src/installationsCompat.ts b/packages-exp/installations-compat/src/installationsCompat.ts
@@ -15,10 +15,10 @@
  * limitations under the License.
  */
 
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
 import { FirebaseInstallations as FirebaseInstallationsCompat } from '@firebase/installations-types';
 import { FirebaseApp, _FirebaseService } from '@firebase/app-compat';
 import {
+  FirebaseInstallations,
   deleteInstallations,
   getId,
   getToken,
diff --git a/packages-exp/installations-compat/src/testing/util.ts b/packages-exp/installations-compat/src/testing/util.ts
@@ -16,7 +16,7 @@
  */
 
 import { FirebaseApp } from '@firebase/app-compat';
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
+import { FirebaseInstallations } from '@firebase/installations-exp';
 
 const appName = 'testApp';
 const apiKey = 'AIzaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaA';
diff --git a/packages-exp/installations-exp/api-extractor.json b/packages-exp/installations-exp/api-extractor.json
@@ -3,6 +3,8 @@
     // Point it to your entry point d.ts file. 
     "mainEntryPointFilePath": "<projectFolder>/dist/src/index.d.ts",
     "dtsRollup": {
-        "enabled": true
+        "enabled": true,
+        "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
+        "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts"
     }
 }
diff --git a/packages-exp/installations-exp/package.json b/packages-exp/installations-exp/package.json
@@ -7,7 +7,7 @@
   "module": "dist/index.esm.js",
   "browser": "dist/index.esm.js",
   "esm2017": "dist/index.esm2017.js",
-  "typings": "dist/installations-exp.d.ts",
+  "typings": "dist/src/index.d.ts",
   "license": "Apache-2.0",
   "files": [
     "dist"
@@ -17,7 +17,7 @@
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "build": "rollup -c && yarn api-report",
     "build:deps": "lerna run --scope @firebase/installations-exp --include-dependencies build",
-    "build:release": "rollup -c rollup.config.release.js && yarn api-report",
+    "build:release": "rollup -c rollup.config.release.js && yarn api-report && yarn typings:public",
     "dev": "rollup -c -w",
     "test": "yarn type-check && yarn test:karma && yarn lint",
     "test:ci": "node ../../scripts/run_tests_in_ci.js",
@@ -30,7 +30,9 @@
     "api-report": "api-extractor run --local --verbose",
     "predoc": "node ../../scripts/exp/remove-exp.js temp",
     "doc": "api-documenter markdown --input temp --output docs",
-    "build:doc": "yarn build && yarn doc"
+    "build:doc": "yarn build && yarn doc",
+    "typings:public": "node ../../scripts/exp/use_typings.js ./dist/installations-exp-public.d.ts",
+    "typings:internal": "node ../../scripts/exp/use_typings.js ./dist/src/index.d.ts"
   },
   "repository": {
     "directory": "packages-exp/installations-exp",
@@ -54,7 +56,6 @@
     "@firebase/app-exp": "0.x"
   },
   "dependencies": {
-    "@firebase/installations-types-exp": "0.0.900",
     "@firebase/util": "0.3.4",
     "@firebase/component": "0.2.0",
     "idb": "3.0.2",
diff --git a/packages-exp/installations-exp/src/api/delete-installations.ts b/packages-exp/installations-exp/src/api/delete-installations.ts
@@ -20,7 +20,7 @@ import { remove, update } from '../helpers/idb-manager';
 import { RequestStatus } from '../interfaces/installation-entry';
 import { ERROR_FACTORY, ErrorCode } from '../util/errors';
 import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
+import { FirebaseInstallations } from '../interfaces/public-types';
 
 /**
  * Deletes the Firebase Installation and all associated data.
@@ -54,5 +54,3 @@ export async function deleteInstallations(
     }
   }
 }
-
-export { FirebaseInstallations };
diff --git a/packages-exp/installations-exp/src/api/get-id.ts b/packages-exp/installations-exp/src/api/get-id.ts
@@ -18,7 +18,7 @@
 import { getInstallationEntry } from '../helpers/get-installation-entry';
 import { refreshAuthToken } from '../helpers/refresh-auth-token';
 import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
+import { FirebaseInstallations } from '../interfaces/public-types';
 
 /**
  * Creates a Firebase Installation if there isn't one for the app and
diff --git a/packages-exp/installations-exp/src/api/get-installations.ts b/packages-exp/installations-exp/src/api/get-installations.ts
@@ -16,7 +16,7 @@
  */
 
 import { FirebaseApp, _getProvider } from '@firebase/app-exp';
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
+import { FirebaseInstallations } from '../interfaces/public-types';
 
 /**
  * Returns an instance of FirebaseInstallations associated with the given FirebaseApp instance.
diff --git a/packages-exp/installations-exp/src/api/get-token.ts b/packages-exp/installations-exp/src/api/get-token.ts
@@ -21,7 +21,7 @@ import {
   FirebaseInstallationsImpl,
   AppConfig
 } from '../interfaces/installation-impl';
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
+import { FirebaseInstallations } from '../interfaces/public-types';
 
 /**
  * Returns an Installation auth token, identifying the current Firebase Installation.
diff --git a/packages-exp/installations-exp/src/api/on-id-change.ts b/packages-exp/installations-exp/src/api/on-id-change.ts
@@ -17,7 +17,7 @@
 
 import { addCallback, removeCallback } from '../helpers/fid-changed';
 import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
+import { FirebaseInstallations } from '../interfaces/public-types';
 
 /**
  * An user defined callback function that gets called when Installations ID changes.
diff --git a/packages-exp/installations-exp/src/functions/config.ts b/packages-exp/installations-exp/src/functions/config.ts
@@ -23,7 +23,7 @@ import {
   ComponentContainer
 } from '@firebase/component';
 import { getId, getToken } from '../api/index';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '../interfaces/public-types';
 import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 import { extractAppConfig } from '../helpers/extract-app-config';
 
diff --git a/packages-exp/installations-exp/src/index.ts b/packages-exp/installations-exp/src/index.ts
@@ -20,6 +20,7 @@ import { registerVersion } from '@firebase/app-exp';
 import { name, version } from '../package.json';
 
 export * from './api';
+export * from './interfaces/public-types';
 
 registerInstallations();
 registerVersion(name, version);
diff --git a/packages-exp/installations-exp/src/interfaces/installation-impl.ts b/packages-exp/installations-exp/src/interfaces/installation-impl.ts
@@ -17,7 +17,7 @@
 
 import { Provider } from '@firebase/component';
 import { _FirebaseService } from '@firebase/app-exp';
-import { FirebaseInstallations } from '@firebase/installations-types-exp';
+import { FirebaseInstallations } from '../interfaces/public-types';
 
 export interface FirebaseInstallationsImpl
   extends FirebaseInstallations,
diff --git a/packages-exp/installations-exp/src/interfaces/public-types.ts b/packages-exp/installations-exp/src/interfaces/public-types.ts
@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2019 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.
@@ -27,6 +27,7 @@ export interface FirebaseInstallations {}
  *
  * @internal
  */
+// eslint-disable-next-line @typescript-eslint/naming-convention
 export interface _FirebaseInstallationsInternal {
   /**
    * Creates a Firebase Installation if there isn't one for the app and
diff --git a/packages-exp/installations-types-exp/api-extractor.json b/packages-exp/installations-types-exp/api-extractor.json
diff --git a/packages-exp/installations-types-exp/package.json b/packages-exp/installations-types-exp/package.json
diff --git a/packages-exp/installations-types-exp/tsconfig.json b/packages-exp/installations-types-exp/tsconfig.json
diff --git a/packages-exp/messaging-exp/src/interfaces/internal-dependencies.ts b/packages-exp/messaging-exp/src/interfaces/internal-dependencies.ts
@@ -19,7 +19,7 @@ import { AppConfig } from './app-config';
 import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types';
 import { FirebaseApp } from '@firebase/app-exp';
 import { Provider } from '@firebase/component';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
 
 export interface FirebaseInternalDependencies {
   app: FirebaseApp;
diff --git a/packages-exp/messaging-exp/src/messaging-service.ts b/packages-exp/messaging-exp/src/messaging-service.ts
@@ -22,7 +22,7 @@ import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types
 import { FirebaseInternalDependencies } from './interfaces/internal-dependencies';
 import { MessagePayload } from './interfaces/public-types';
 import { Provider } from '@firebase/component';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
 import { extractAppConfig } from './helpers/extract-app-config';
 
 export class MessagingService implements _FirebaseService {
diff --git a/packages-exp/messaging-exp/src/testing/fakes/firebase-dependencies.ts b/packages-exp/messaging-exp/src/testing/fakes/firebase-dependencies.ts
@@ -23,7 +23,7 @@ import {
 import { FirebaseInternalDependencies } from '../../interfaces/internal-dependencies';
 import { FirebaseOptions } from '@firebase/app-exp';
 import { Provider } from '@firebase/component';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
 import { extractAppConfig } from '../../helpers/extract-app-config';
 
 export function getFakeFirebaseDependencies(
diff --git a/packages-exp/performance-exp/src/controllers/perf.test.ts b/packages-exp/performance-exp/src/controllers/perf.test.ts
@@ -23,7 +23,7 @@ import * as initializationService from '../services/initialization_service';
 import { SettingsService } from '../services/settings_service';
 import { consoleLogger } from '../utils/console_logger';
 import { FirebaseApp } from '@firebase/app-exp';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
 import '../../test/setup';
 
 describe('Firebase Performance Test', () => {
diff --git a/packages-exp/performance-exp/src/controllers/perf.ts b/packages-exp/performance-exp/src/controllers/perf.ts
@@ -20,7 +20,7 @@ import { SettingsService } from '../services/settings_service';
 import { getInitializationPromise } from '../services/initialization_service';
 import { Api } from '../services/api_service';
 import { FirebaseApp } from '@firebase/app-exp';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
 import { PerformanceSettings, FirebasePerformance } from '../public_types';
 import { validateIndexedDBOpenable } from '@firebase/util';
 import { setupTransportService } from '../services/transport_service';
diff --git a/packages-exp/performance-exp/src/services/iid_service.test.ts b/packages-exp/performance-exp/src/services/iid_service.test.ts
@@ -24,7 +24,7 @@ import {
   getAuthTokenPromise
 } from './iid_service';
 import '../../test/setup';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
 
 describe('Firebase Perofmrance > iid_service', () => {
   const IID = 'fid';
diff --git a/packages-exp/performance-exp/src/services/iid_service.ts b/packages-exp/performance-exp/src/services/iid_service.ts
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
 
 let iid: string | undefined;
 let authToken: string | undefined;
diff --git a/packages-exp/remote-config-exp/src/client/rest_client.ts b/packages-exp/remote-config-exp/src/client/rest_client.ts
@@ -23,7 +23,7 @@ import {
 } from './remote_config_fetch_client';
 import { ERROR_FACTORY, ErrorCode } from '../errors';
 import { getUserLanguage } from '../language';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
 
 /**
  * Defines request body parameters required to call the fetch API:
