fix remote-config-compat

Author: Feiyang1

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)

packages-exp/remote-config-compat/package.json

@@ -28,7 +28,6 @@
   },
   "dependencies": {
     "@firebase/remote-config-exp": "0.0.900", 
-    "@firebase/remote-config-types-exp": "0.0.900", 
     "@firebase/util": "0.3.4",
     "@firebase/logger": "0.2.6",
     "@firebase/component": "0.1.21",

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;

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
     );

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,

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 {

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"
     }
 }

packages-exp/remote-config-exp/package.json

@@ -14,7 +14,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",
@@ -24,7 +24,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/app-exp-public.d.ts",
+    "typings:internal": "node ../../scripts/exp/use_typings.js ./dist/src/index.d.ts"
   },
   "peerDependencies": {
     "@firebase/app-exp": "0.x"
@@ -51,7 +53,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"

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();