Remove remote-config-types-exp (#4496)

Feiyang1 · web-flow · commit 08e2aa3ccd90 · 2021-02-23T12:49:57.000-08:00
* remove remote-config-types exp

* fix remote-config-compat

* remove api report for types

* correct d.ts path
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -28,7 +28,6 @@
     "@firebase/performance-exp",
     "@firebase/performance-types-exp",
     "@firebase/remote-config-exp",
-    "@firebase/remote-config-types-exp",
     "@firebase/remote-config-compat",
     "firebase-exp",
     "@firebase/app-compat",
diff --git a/common/api-review/remote-config-exp.api.md b/common/api-review/remote-config-exp.api.md
@@ -5,9 +5,6 @@
 ```ts
 
 import { FirebaseApp } from '@firebase/app-exp';
-import { RemoteConfig } from '@firebase/remote-config-types-exp';
-import { LogLevel as RemoteConfigLogLevel } from '@firebase/remote-config-types-exp';
-import { Value as ValueType } from '@firebase/remote-config-types-exp';
 
 // @public
 export function activate(remoteConfig: RemoteConfig): Promise<boolean>;
@@ -22,7 +19,10 @@ export function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;
 export function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;
 
 // @public
-export function getAll(remoteConfig: RemoteConfig): Record<string, ValueType>;
+export type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';
+
+// @public
+export function getAll(remoteConfig: RemoteConfig): Record<string, Value>;
 
 // @public
 export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;
@@ -37,16 +37,40 @@ export function getRemoteConfig(app: FirebaseApp): RemoteConfig;
 export function getString(remoteConfig: RemoteConfig, key: string): string;
 
 // @public
-export function getValue(remoteConfig: RemoteConfig, key: string): ValueType;
+export function getValue(remoteConfig: RemoteConfig, key: string): Value;
 
-export { RemoteConfig }
+// @public
+export type LogLevel = 'debug' | 'error' | 'silent';
 
-export { RemoteConfigLogLevel }
+// @public
+export interface RemoteConfig {
+    defaultConfig: {
+        [key: string]: string | number | boolean;
+    };
+    fetchTimeMillis: number;
+    lastFetchStatus: FetchStatus;
+    settings: Settings;
+}
 
 // @public
-export function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;
+export function setLogLevel(remoteConfig: RemoteConfig, logLevel: LogLevel): void;
 
-export { ValueType }
+// @public
+export interface Settings {
+    fetchTimeoutMillis: number;
+    minimumFetchIntervalMillis: number;
+}
+
+// @public
+export interface Value {
+    asBoolean(): boolean;
+    asNumber(): number;
+    asString(): string;
+    getSource(): ValueSource;
+}
+
+// @public
+export type ValueSource = 'static' | 'default' | 'remote';
 
 
 // (No @packageDocumentation comment for this package)
diff --git a/common/api-review/remote-config-types-exp.api.md b/common/api-review/remote-config-types-exp.api.md
diff --git a/packages-exp/auth-exp/test/helpers/integration/helpers.ts b/packages-exp/auth-exp/test/helpers/integration/helpers.ts
@@ -18,7 +18,7 @@
 import { deleteApp, initializeApp } from '@firebase/app-exp';
 import { Auth, User } from '@firebase/auth-types-exp';
 
-import { getAuth } from '../../../';  // Use browser OR node dist entrypoint depending on test env.
+import { getAuth } from '../../../'; // Use browser OR node dist entrypoint depending on test env.
 import { _generateEventId } from '../../../src/core/util/event_id';
 
 // eslint-disable-next-line @typescript-eslint/no-require-imports
diff --git a/packages-exp/remote-config-compat/package.json b/packages-exp/remote-config-compat/package.json
@@ -29,8 +29,7 @@
     "@firebase/app-compat": "0.x"
   },
   "dependencies": {
-    "@firebase/remote-config-exp": "0.0.900",
-    "@firebase/remote-config-types-exp": "0.0.900",
+    "@firebase/remote-config-exp": "0.0.900", 
     "@firebase/util": "0.3.4",
     "@firebase/logger": "0.2.6",
     "@firebase/component": "0.2.0",
diff --git a/packages-exp/remote-config-compat/src/index.ts b/packages-exp/remote-config-compat/src/index.ts
@@ -25,7 +25,7 @@ import { RemoteConfigCompatImpl } from './remoteConfig';
 import { name as packageName, version } from '../package.json';
 import { RemoteConfig as RemoteConfigCompat } from '@firebase/remote-config-types';
 
-// TODO: move it to the future remote-config-compat-types package
+// TODO: move it to remote-config-types package
 declare module '@firebase/component' {
   interface NameServiceMapping {
     'remote-config-compat': RemoteConfigCompat;
diff --git a/packages-exp/remote-config-compat/src/remoteConfig.test.ts b/packages-exp/remote-config-compat/src/remoteConfig.test.ts
@@ -21,7 +21,6 @@ import { stub } from 'sinon';
 import { RemoteConfigCompatImpl } from './remoteConfig';
 import { getFakeApp, getFakeModularRemoteConfig } from '../test/util';
 import * as modularApi from '@firebase/remote-config-exp';
-import { Value } from '@firebase/remote-config-types-exp';
 
 describe('Remote Config Compat', () => {
   let remoteConfig!: RemoteConfigCompatImpl;
@@ -134,7 +133,7 @@ describe('Remote Config Compat', () => {
   });
 
   it('getValue() calls modular getValue()', () => {
-    const fakeValue = {} as Value;
+    const fakeValue = {} as modularApi.Value;
     const modularGetValue = stub(modularApi, 'getValue').callsFake(
       () => fakeValue
     );
diff --git a/packages-exp/remote-config-compat/src/remoteConfig.ts b/packages-exp/remote-config-compat/src/remoteConfig.ts
@@ -16,7 +16,6 @@
  */
 
 import { FirebaseApp, _FirebaseService } from '@firebase/app-compat';
-import { RemoteConfig } from '@firebase/remote-config-types-exp';
 import {
   Value as ValueCompat,
   FetchStatus as FetchSTatusCompat,
@@ -25,6 +24,7 @@ import {
   RemoteConfig as RemoteConfigCompat
 } from '@firebase/remote-config-types';
 import {
+  RemoteConfig,
   setLogLevel,
   activate,
   ensureInitialized,
diff --git a/packages-exp/remote-config-compat/test/util.ts b/packages-exp/remote-config-compat/test/util.ts
@@ -16,7 +16,7 @@
  */
 
 import { FirebaseApp } from '@firebase/app-compat';
-import { RemoteConfig } from '@firebase/remote-config-types-exp';
+import { RemoteConfig } from '@firebase/remote-config-exp';
 
 export function getFakeApp(): FirebaseApp {
   return {
diff --git a/packages-exp/remote-config-exp/api-extractor.json b/packages-exp/remote-config-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/remote-config-exp/package.json b/packages-exp/remote-config-exp/package.json
@@ -16,7 +16,7 @@
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "build": "rollup -c && yarn api-report",
     "build:deps": "lerna run --scope @firebase/remote-config-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": "run-p lint test:browser",
     "test:ci": "node ../../scripts/run_tests_in_ci.js -s test:browser",
@@ -26,15 +26,16 @@
     "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/remote-config-exp-public.d.ts",
+    "typings:internal": "node ../../scripts/exp/use_typings.js ./dist/src/index.d.ts"
   },
   "peerDependencies": {
     "@firebase/app-exp": "0.x"
   },
   "dependencies": {
     "@firebase/installations-exp": "0.0.900",
     "@firebase/logger": "0.2.6",
-    "@firebase/remote-config-types-exp": "0.0.900",
     "@firebase/util": "0.3.4",
     "@firebase/component": "0.2.0",
     "tslib": "^1.11.1"
@@ -54,7 +55,7 @@
   "bugs": {
     "url": "https://github.com/firebase/firebase-js-sdk/issues"
   },
-  "typings": "dist/remote-config-exp.d.ts",
+  "typings": "dist/src/index.d.ts",
   "nyc": {
     "extension": [
       ".ts"
diff --git a/packages-exp/remote-config-exp/src/api.ts b/packages-exp/remote-config-exp/src/api.ts
@@ -19,13 +19,13 @@ import { _getProvider, FirebaseApp } from '@firebase/app-exp';
 import {
   LogLevel as RemoteConfigLogLevel,
   RemoteConfig,
-  Value as ValueType
-} from '@firebase/remote-config-types-exp';
+  Value
+} from './public_types';
 import { RemoteConfigAbortSignal } from './client/remote_config_fetch_client';
 import { RC_COMPONENT_NAME } from './constants';
 import { ErrorCode, hasErrorCode } from './errors';
 import { RemoteConfig as RemoteConfigImpl } from './remote_config';
-import { Value } from './value';
+import { Value as ValueImpl } from './value';
 import { LogLevel as FirebaseLogLevel } from '@firebase/logger';
 
 /**
@@ -137,15 +137,15 @@ export async function fetchConfig(remoteConfig: RemoteConfig): Promise<void> {
  *
  * @public
  */
-export function getAll(remoteConfig: RemoteConfig): Record<string, ValueType> {
+export function getAll(remoteConfig: RemoteConfig): Record<string, Value> {
   const rc = remoteConfig as RemoteConfigImpl;
   return getAllKeys(
     rc._storageCache.getActiveConfig(),
     rc.defaultConfig
   ).reduce((allConfigs, key) => {
     allConfigs[key] = getValue(remoteConfig, key);
     return allConfigs;
-  }, {} as Record<string, ValueType>);
+  }, {} as Record<string, Value>);
 }
 
 /**
@@ -204,7 +204,7 @@ export function getString(remoteConfig: RemoteConfig, key: string): string {
  *
  * @public
  */
-export function getValue(remoteConfig: RemoteConfig, key: string): ValueType {
+export function getValue(remoteConfig: RemoteConfig, key: string): Value {
   const rc = remoteConfig as RemoteConfigImpl;
   if (!rc._isInitializationComplete) {
     rc._logger.debug(
@@ -214,15 +214,15 @@ export function getValue(remoteConfig: RemoteConfig, key: string): ValueType {
   }
   const activeConfig = rc._storageCache.getActiveConfig();
   if (activeConfig && activeConfig[key] !== undefined) {
-    return new Value('remote', activeConfig[key]);
+    return new ValueImpl('remote', activeConfig[key]);
   } else if (rc.defaultConfig && rc.defaultConfig[key] !== undefined) {
-    return new Value('default', String(rc.defaultConfig[key]));
+    return new ValueImpl('default', String(rc.defaultConfig[key]));
   }
   rc._logger.debug(
     `Returning static value for key "${key}".` +
       ' Define a default or remote value if this is unintentional.'
   );
-  return new Value('static');
+  return new ValueImpl('static');
 }
 
 /**
@@ -256,5 +256,3 @@ export function setLogLevel(
 function getAllKeys(obj1: {} = {}, obj2: {} = {}): string[] {
   return Object.keys({ ...obj1, ...obj2 });
 }
-
-export { RemoteConfig, ValueType, RemoteConfigLogLevel };
diff --git a/packages-exp/remote-config-exp/src/api2.ts b/packages-exp/remote-config-exp/src/api2.ts
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { RemoteConfig } from '@firebase/remote-config-types-exp';
+import { RemoteConfig } from './public_types';
 import { activate, fetchConfig } from './api';
 
 // This API is put in a separate file, so we can stub fetchConfig and activate in tests.
diff --git a/packages-exp/remote-config-exp/src/index.ts b/packages-exp/remote-config-exp/src/index.ts
@@ -29,6 +29,7 @@ declare global {
 
 export * from './api';
 export * from './api2';
+export * from './public_types';
 
 /** register component and version */
 registerRemoteConfig();
diff --git a/packages-exp/remote-config-exp/src/public_types.ts b/packages-exp/remote-config-exp/src/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.
diff --git a/packages-exp/remote-config-exp/src/register.ts b/packages-exp/remote-config-exp/src/register.ts
@@ -25,7 +25,7 @@ import {
   ComponentContainer
 } from '@firebase/component';
 import { Logger, LogLevel as FirebaseLogLevel } from '@firebase/logger';
-import { RemoteConfig } from '@firebase/remote-config-types-exp';
+import { RemoteConfig } from './public_types';
 import { name as packageName, version } from '../package.json';
 import { ensureInitialized } from './api';
 import { CachingClient } from './client/caching_client';
diff --git a/packages-exp/remote-config-exp/src/remote_config.ts b/packages-exp/remote-config-exp/src/remote_config.ts
@@ -20,7 +20,7 @@ import {
   RemoteConfig as RemoteConfigType,
   FetchStatus,
   Settings
-} from '@firebase/remote-config-types-exp';
+} from './public_types';
 import { StorageCache } from './storage/storage_cache';
 import { RemoteConfigFetchClient } from './client/remote_config_fetch_client';
 import { Storage } from './storage/storage';
diff --git a/packages-exp/remote-config-exp/test/remote_config.test.ts b/packages-exp/remote-config-exp/test/remote_config.test.ts
@@ -19,7 +19,7 @@ import { FirebaseApp } from '@firebase/app-exp';
 import {
   RemoteConfig as RemoteConfigType,
   LogLevel as RemoteConfigLogLevel
-} from '@firebase/remote-config-types-exp';
+} from '../src/public_types';
 import { expect } from 'chai';
 import * as sinon from 'sinon';
 import { StorageCache } from '../src/storage/storage_cache';
diff --git a/packages-exp/remote-config-types-exp/README.md b/packages-exp/remote-config-types-exp/README.md
diff --git a/packages-exp/remote-config-types-exp/api-extractor.json b/packages-exp/remote-config-types-exp/api-extractor.json
diff --git a/packages-exp/remote-config-types-exp/package.json b/packages-exp/remote-config-types-exp/package.json
diff --git a/packages-exp/remote-config-types-exp/tsconfig.json b/packages-exp/remote-config-types-exp/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@`
`3`	`3`	`// Point it to your entry point d.ts file.`
`4`	`4`	`"mainEntryPointFilePath": "<projectFolder>/dist/src/index.d.ts",`
`5`	`5`	`"dtsRollup": {`
`6`		`- "enabled": true`
	`6`	`+ "enabled": true,`
	`7`	`+ "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",`
	`8`	`+ "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts"`
`7`	`9`	`}`
`8`	`10`	`}`