Create typings for the interop API (#4696)

* use hande made index.d.ts in compat for backward compatibility

* auto-generate overloads

* handle type parameters

* preserve type parameters

* overloads for auth-exp

* add overloads to firestore compat

* export all public types from auth-exp

* add overloads to storage compat

* add overloads to analytics compat

* add overloads to functions compat

* add overloads to messaging compat

* add overloads to perf compat

* add overloads to rc compat

* revert firebase/compat typings

* address comments

Author: Feiyang1

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

@@ -86,7 +86,6 @@ export interface Auth {
     readonly emulatorConfig: EmulatorConfig | null;
     languageCode: string | null;
     readonly name: string;
-    // Warning: (ae-forgotten-export) The symbol "NextOrObserver" needs to be exported by the entry point index.d.ts
     onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
     onIdTokenChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
     setPersistence(persistence: Persistence): Promise<void>;
@@ -153,6 +152,8 @@ export const browserSessionPersistence: Persistence;
 // @public
 export function checkActionCode(auth: Auth, oobCode: string): Promise<ActionCodeInfo>;
 
+export { CompleteFn }
+
 // @public
 export interface Config {
     apiHost: string;
@@ -184,6 +185,16 @@ export const debugErrorMap: AuthErrorMap;
 // @public
 export function deleteUser(user: User): Promise<void>;
 
+// @public (undocumented)
+export interface Dependencies {
+    // (undocumented)
+    errorMap?: AuthErrorMap;
+    // (undocumented)
+    persistence?: Persistence | Persistence[];
+    // (undocumented)
+    popupRedirectResolver?: PopupRedirectResolver;
+}
+
 // @public
 export class EmailAuthCredential extends AuthCredential {
     // (undocumented)
@@ -216,6 +227,8 @@ export class EmailAuthProvider implements AuthProvider {
     readonly providerId = ProviderId.PASSWORD;
 }
 
+export { ErrorFn }
+
 // Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.d.ts
 //
 // @public
@@ -248,10 +261,8 @@ export function getIdToken(user: User, forceRefresh?: boolean): Promise<string>;
 // @public
 export function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<IdTokenResult>;
 
-// Warning: (ae-forgotten-export) The symbol "MultiFactorError" needs to be exported by the entry point index.d.ts
-//
 // @public
-export function getMultiFactorResolver(auth: Auth, error: MultiFactorError_2): MultiFactorResolver;
+export function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;
 
 // @public
 export function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;
@@ -290,8 +301,6 @@ export interface IdTokenResult {
 // @public
 export const indexedDBLocalPersistence: Persistence;
 
-// Warning: (ae-forgotten-export) The symbol "Dependencies" needs to be exported by the entry point index.d.ts
-//
 // @public (undocumented)
 export function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth;
 
@@ -353,6 +362,9 @@ export interface MultiFactorUser {
     unenroll(option: MultiFactorInfo | string): Promise<void>;
 }
 
+// @public
+export type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
+
 // @public
 export class OAuthCredential extends AuthCredential {
     accessToken?: string;
@@ -645,6 +657,8 @@ export class TwitterAuthProvider extends BaseOAuthProvider {
 // @public
 export function unlink(user: User, providerId: ProviderId): Promise<User>;
 
+export { Unsubscribe }
+
 // @public
 export function updateCurrentUser(auth: Auth, user: User | null): Promise<void>;
 

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

@@ -4,7 +4,7 @@
 
 ```ts
 
-import { FirebaseApp } from '@firebase/app-exp';
+import { FirebaseApp } from '@firebase/app';
 import { NextFn } from '@firebase/util';
 import { Observer } from '@firebase/util';
 import { Unsubscribe } from '@firebase/util';
@@ -52,6 +52,8 @@ export interface MessagePayload {
     notification?: NotificationPayload;
 }
 
+export { NextFn }
+
 // @public
 export interface NotificationPayload {
     // (undocumented)
@@ -62,6 +64,8 @@ export interface NotificationPayload {
     title?: string;
 }
 
+export { Observer }
+
 // Warning: (ae-internal-missing-underscore) The name "onBackgroundMessage" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal
@@ -70,6 +74,8 @@ export function onBackgroundMessage(messaging: FirebaseMessaging, nextOrObserver
 // @public
 export function onMessage(messaging: FirebaseMessaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
 
+export { Unsubscribe }
+
 
 // (No @packageDocumentation comment for this package)
 

packages-exp/analytics-compat/package.json

@@ -35,12 +35,13 @@
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "build": "rollup -c",
     "build:deps": "lerna run --scope @firebase/analytics-compat --include-dependencies build",
-    "build:release": "rollup -c rollup.config.release.js",
+    "build:release": "rollup -c rollup.config.release.js && yarn add-compat-overloads",
     "dev": "rollup -c -w",
     "test": "run-p lint test:browser",
     "test:ci": "node ../../scripts/run_tests_in_ci.js -s test:browser",
     "test:browser": "karma start --single-run",
-    "test:browser:debug": "karma start --browsers=Chrome --auto-watch"
+    "test:browser:debug": "karma start --browsers=Chrome --auto-watch",
+    "add-compat-overloads": "ts-node-script ../../scripts/exp/create-overloads.ts -i ../analytics-exp/dist/analytics-exp-public.d.ts -o dist/src/index.d.ts -a -r Analytics:FirebaseAnalytics -r FirebaseApp:FirebaseAppCompat --moduleToEnhance @firebase/analytics"
   },
   "typings": "dist/src/index.d.ts",
   "dependencies": {

packages-exp/auth-compat-exp/index.ts

@@ -31,7 +31,7 @@ import {
   EmailAuthProvider_Instance,
   FacebookAuthProvider,
   FacebookAuthProvider_Instance,
-  FirebaseAuth,
+  FirebaseAuth as AuthCompat,
   GithubAuthProvider,
   GithubAuthProvider_Instance,
   GoogleAuthProvider,
@@ -56,15 +56,15 @@ const AUTH_TYPE = 'auth-compat';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
-    'auth-compat': FirebaseAuth;
+    'auth-compat': AuthCompat;
   }
 }
 
 declare module '@firebase/app-compat' {
   interface FirebaseNamespace {
     auth: {
-      (app?: FirebaseApp): FirebaseAuth;
-      Auth: typeof FirebaseAuth;
+      (app?: FirebaseApp): AuthCompat;
+      Auth: typeof AuthCompat;
       EmailAuthProvider: typeof EmailAuthProvider;
       EmailAuthProvider_Instance: typeof EmailAuthProvider_Instance;
       FacebookAuthProvider: typeof FacebookAuthProvider;
@@ -85,7 +85,7 @@ declare module '@firebase/app-compat' {
     };
   }
   interface FirebaseApp {
-    auth?(): FirebaseAuth;
+    auth?(): AuthCompat;
   }
 }
 

packages-exp/auth-compat-exp/package.json

@@ -16,7 +16,7 @@
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "build": "rollup -c",
     "build:deps": "lerna run --scope @firebase/auth-compat --include-dependencies build",
-    "build:release": "rollup -c rollup.config.release.js",
+    "build:release": "rollup -c rollup.config.release.js && yarn add-compat-overloads",
     "dev": "rollup -c -w",
     "test": "run-p lint test:all",
     "test:all": "run-p test:browser test:node",
@@ -26,7 +26,8 @@
     "test:node": "ts-node -O '{\"module\": \"commonjs\", \"target\": \"es6\"}' scripts/run_node_tests.ts",
     "test:node:integration": "ts-node -O '{\"module\": \"commonjs\", \"target\": \"es6\"}' scripts/run_node_tests.ts --integration",
     "test:webdriver": "rollup -c test/integration/webdriver/static/rollup.config.js && ts-node -O '{\"module\": \"commonjs\", \"target\": \"es6\"}' scripts/run_node_tests.ts --webdriver",
-    "test:integration": "run-s test:browser:integration test:node:integration test:webdriver"
+    "test:integration": "run-s test:browser:integration test:node:integration test:webdriver",
+    "add-compat-overloads": "ts-node-script ../../scripts/exp/create-overloads.ts -i ../auth-exp/dist/auth-exp-public.d.ts -o dist/auth-compat-exp/index.d.ts -a -r Auth:AuthCompat -r FirebaseApp:FirebaseAppCompat --moduleToEnhance @firebase/auth"
   },
   "peerDependencies": {
     "@firebase/app-compat": "0.x"

packages-exp/auth-exp/index.ts

@@ -65,7 +65,12 @@ export {
   UserInfo,
   UserMetadata,
   UserProfile,
-  PhoneInfoOptions
+  PhoneInfoOptions,
+  Dependencies,
+  NextOrObserver,
+  ErrorFn,
+  CompleteFn,
+  Unsubscribe
 } from './src/model/public_types';
 
 // Core functionality shared by all clients

packages-exp/auth-exp/src/core/auth/auth_impl.ts

@@ -25,17 +25,17 @@ import {
   Persistence,
   PopupRedirectResolver,
   User,
-  UserCredential
+  UserCredential,
+  CompleteFn,
+  ErrorFn,
+  NextFn,
+  Unsubscribe
 } from '../../model/public_types';
 import {
-  CompleteFn,
   createSubscribe,
   ErrorFactory,
-  ErrorFn,
-  NextFn,
   Observer,
-  Subscribe,
-  Unsubscribe
+  Subscribe
 } from '@firebase/util';
 
 import { AuthInternal, ConfigInternal } from '../../model/auth';

packages-exp/auth-exp/src/core/auth/initialize.ts

@@ -16,9 +16,8 @@
  */
 
 import { _getProvider, FirebaseApp } from '@firebase/app-exp';
-import { Auth } from '../../model/public_types';
+import { Auth, Dependencies } from '../../model/public_types';
 
-import { Dependencies } from '../../model/auth';
 import { AuthErrorCode } from '../errors';
 import { PersistenceInternal } from '../persistence';
 import { _fail } from '../util/assert';

packages-exp/auth-exp/src/core/auth/register.ts

@@ -16,7 +16,7 @@
  */
 
 import { _registerComponent, registerVersion } from '@firebase/app-exp';
-import { Config } from '../../model/public_types';
+import { Config, Dependencies } from '../../model/public_types';
 import { Component, ComponentType } from '@firebase/component';
 
 import { version } from '../../../package.json';
@@ -25,7 +25,6 @@ import { _assert } from '../util/assert';
 import { _getClientVersion, ClientPlatform } from '../util/version';
 import { _castAuth, AuthImpl, DefaultConfig } from './auth_impl';
 import { AuthInterop } from './firebase_internal';
-import { Dependencies } from '../../model/auth';
 import { _initializeAuthInstance } from './initialize';
 
 export const enum _ComponentName {

packages-exp/auth-exp/src/core/index.ts

@@ -15,8 +15,15 @@
  * limitations under the License.
  */
 
-import { Auth, NextOrObserver, Persistence, User } from '../model/public_types';
-import { CompleteFn, ErrorFn, Unsubscribe } from '@firebase/util';
+import {
+  Auth,
+  NextOrObserver,
+  Persistence,
+  User,
+  CompleteFn,
+  ErrorFn,
+  Unsubscribe
+} from '../model/public_types';
 
 export { debugErrorMap, prodErrorMap } from './errors';
 

packages-exp/auth-exp/src/model/auth.ts

@@ -17,11 +17,9 @@
 
 import {
   Auth,
-  AuthErrorMap,
   AuthSettings,
   Config,
   EmulatorConfig,
-  Persistence,
   PopupRedirectResolver,
   User
 } from './public_types';
@@ -77,9 +75,3 @@ export interface AuthInternal extends Auth {
   useDeviceLanguage(): void;
   signOut(): Promise<void>;
 }
-
-export interface Dependencies {
-  persistence?: Persistence | Persistence[];
-  popupRedirectResolver?: PopupRedirectResolver;
-  errorMap?: AuthErrorMap;
-}

packages-exp/auth-exp/src/model/public_types.ts

@@ -24,6 +24,7 @@ import {
   Unsubscribe
 } from '@firebase/util';
 
+export { CompleteFn, ErrorFn, NextFn, Unsubscribe };
 /**
  * Enumeration of supported providers.
  *
@@ -1170,3 +1171,12 @@ export interface EmulatorConfig {
  * @public
  */
 export interface AuthErrorMap {}
+
+/**
+ * @public
+ */
+export interface Dependencies {
+  persistence?: Persistence | Persistence[];
+  popupRedirectResolver?: PopupRedirectResolver;
+  errorMap?: AuthErrorMap;
+}

packages-exp/functions-compat/package.json

@@ -35,15 +35,16 @@
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "build": "rollup -c",
     "build:deps": "lerna run --scope @firebase/functions-compat --include-dependencies build",
-    "build:release": "rollup -c rollup.config.release.js",
+    "build:release": "rollup -c rollup.config.release.js && yarn add-compat-overloads",
     "dev": "rollup -c -w",
     "test": "run-p lint test:all",
     "test:ci": "node ../../scripts/run_tests_in_ci.js -s test:all",
     "test:all": "run-p test:browser test:node",
     "test:browser": "karma start --single-run",
     "test:browser:debug": "karma start --browsers=Chrome --auto-watch",
     "test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'src/{,!(browser)/**/}*.test.ts' --file src/index.node.ts --config ../../config/mocharc.node.js",
-    "test:emulator": "env FIREBASE_FUNCTIONS_HOST=http://localhost FIREBASE_FUNCTIONS_PORT=5005 run-p test:node"
+    "test:emulator": "env FIREBASE_FUNCTIONS_HOST=http://localhost FIREBASE_FUNCTIONS_PORT=5005 run-p test:node",
+    "add-compat-overloads": "ts-node-script ../../scripts/exp/create-overloads.ts -i ../functions-exp/dist/functions-exp-public.d.ts -o dist/src/index.d.ts -a -r Functions:types.FirebaseFunctions -r FirebaseApp:FirebaseAppCompat --moduleToEnhance @firebase/functions"
   },
   "typings": "dist/src/index.d.ts",
   "dependencies": {

packages-exp/messaging-compat/package.json

@@ -18,13 +18,14 @@
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "build": "rollup -c",
     "build:deps": "lerna run --scope @firebase/'messaging-compat' --include-dependencies build",
-    "build:release": "rollup -c rollup.config.release.js",
+    "build:release": "rollup -c rollup.config.release.js && yarn add-compat-overloads",
     "dev": "rollup -c -w",
     "test": "run-p test:karma",
     "test:ci": "node ../../scripts/run_tests_in_ci.js",
     "test:karma": "karma start --single-run",
     "test:debug": "karma start --browsers=Chrome --auto-watch",
-    "type-check": "tsc --noEmit"
+    "type-check": "tsc --noEmit",
+    "add-compat-overloads": "ts-node-script ../../scripts/exp/create-overloads.ts -i ../messaging-exp/dist/messaging-exp-public.d.ts -o dist/src/index.d.ts -a -r FirebaseMessaging:MessagingCompat -r FirebaseApp:FirebaseAppCompat --moduleToEnhance @firebase/messaging"
   },
   "peerDependencies": {
     "@firebase/app-compat": "0.x"

packages-exp/messaging-exp/src/api.ts

@@ -15,8 +15,13 @@
  * limitations under the License.
  */
 
-import { FirebaseMessaging, MessagePayload } from './interfaces/public-types';
-import { NextFn, Observer, Unsubscribe } from '@firebase/util';
+import {
+  FirebaseMessaging,
+  MessagePayload,
+  NextFn,
+  Observer,
+  Unsubscribe
+} from './interfaces/public-types';
 
 import { MessagingService } from './messaging-service';
 import { Provider } from '@firebase/component';

packages-exp/messaging-exp/src/api/onBackgroundMessage.ts

@@ -16,9 +16,13 @@
  */
 
 import { ERROR_FACTORY, ErrorCode } from '../util/errors';
-import { NextFn, Observer, Unsubscribe } from '@firebase/util';
 
-import { MessagePayload } from '../interfaces/public-types';
+import {
+  MessagePayload,
+  NextFn,
+  Observer,
+  Unsubscribe
+} from '../interfaces/public-types';
 import { MessagingService } from '../messaging-service';
 import { SwController } from '../listeners/sw-controller';