chore: Using public API types in FirebaseNamespace impl (#1057)

Author: hiranya911

README.md

@@ -1,10 +1,5 @@
 [![Build Status](https://github.com/firebase/firebase-admin-node/workflows/Continuous%20Integration/badge.svg)](https://github.com/firebase/firebase-admin-node/actions)
 
-# TODO
-
-* Copy generated d.ts files to the build directory.
-* Update return types in the methods of `FirebaseNamespace` class.
-
 # Firebase Admin Node.js SDK
 
 

gulpfile.js

@@ -83,18 +83,9 @@ gulp.task('compile', function() {
 
   const configuration = [
     'lib/**/*.js',
-    'lib/auth/index.d.ts',
-    'lib/credential/index.d.ts',
+    'lib/**/index.d.ts',
     'lib/firebase-namespace-api.d.ts',
-    'lib/database/index.d.ts',
-    'lib/firestore/index.d.ts',
-    'lib/instance-id/index.d.ts',
-    'lib/machine-learning/index.d.ts',
-    'lib/messaging/index.d.ts',
-    'lib/project-management/index.d.ts',
-    'lib/remote-config/index.d.ts',
-    'lib/security-rules/index.d.ts',
-    'lib/storage/index.d.ts',
+    '!lib/utils/index.d.ts',
   ];
 
   workflow = workflow.pipe(filter(configuration));

src/firebase-app.ts

@@ -42,7 +42,7 @@ import Database = database.Database;
 /**
  * Type representing a callback which is called every time an app lifecycle event occurs.
  */
-export type AppHook = (event: string, app: FirebaseApp) => void;
+export type AppHook = (event: string, app: app.App) => void;
 
 /**
  * Type representing a Firebase OAuth access token (derived from a Google OAuth2 access token) which

src/firebase-namespace.ts

@@ -15,31 +15,40 @@
  */
 
 import fs = require('fs');
+
 import { deepExtend } from './utils/deep-copy';
 import { AppErrorCodes, FirebaseAppError } from './utils/error';
-import { AppOptions } from './firebase-namespace-api';
+import { AppOptions, app } from './firebase-namespace-api';
 import { AppHook, FirebaseApp } from './firebase-app';
 import { FirebaseServiceFactory, FirebaseServiceInterface } from './firebase-service';
-import {
-  cert, refreshToken, applicationDefault
-} from './credential/credential';
+import { cert, refreshToken, applicationDefault } from './credential/credential';
 import { getApplicationDefault } from './credential/credential-internal';
 
-import { Auth } from './auth/auth';
-import { MachineLearning } from './machine-learning/machine-learning';
-import { Messaging } from './messaging/messaging';
-import { Storage } from './storage/storage';
+import { auth } from './auth/index';
 import { database } from './database/index';
-import { Firestore } from '@google-cloud/firestore';
-import { InstanceId } from './instance-id/instance-id';
-import { ProjectManagement } from './project-management/project-management';
-import { SecurityRules } from './security-rules/security-rules';
-import { RemoteConfig } from './remote-config/remote-config';
+import { firestore } from './firestore/index';
+import { instanceId } from './instance-id/index';
+import { machineLearning } from './machine-learning/index';
+import { messaging } from './messaging/index';
+import { projectManagement } from './project-management/index';
+import { remoteConfig } from './remote-config/index';
+import { securityRules } from './security-rules/index';
+import { storage } from './storage/index';
 
 import * as validator from './utils/validator';
 import { getSdkVersion } from './utils/index';
 
+import App = app.App;
+import Auth = auth.Auth;
 import Database = database.Database;
+import Firestore = firestore.Firestore;
+import InstanceId = instanceId.InstanceId;
+import MachineLearning = machineLearning.MachineLearning;
+import Messaging = messaging.Messaging;
+import ProjectManagement = projectManagement.ProjectManagement;
+import RemoteConfig = remoteConfig.RemoteConfig;
+import SecurityRules = securityRules.SecurityRules;
+import Storage = storage.Storage;
 
 const DEFAULT_APP_NAME = '[DEFAULT]';
 
@@ -51,7 +60,7 @@ const DEFAULT_APP_NAME = '[DEFAULT]';
 export const FIREBASE_CONFIG_VAR = 'FIREBASE_CONFIG';
 
 export interface FirebaseServiceNamespace <T> {
-  (app?: FirebaseApp): T;
+  (app?: App): T;
   [key: string]: any;
 }
 
@@ -61,24 +70,23 @@ export interface FirebaseServiceNamespace <T> {
 export class FirebaseNamespaceInternals {
   public serviceFactories: {[serviceName: string]: FirebaseServiceFactory} = {};
 
-  private apps_: {[appName: string]: FirebaseApp} = {};
+  private apps_: {[appName: string]: App} = {};
   private appHooks_: {[service: string]: AppHook} = {};
 
   constructor(public firebase_: {[key: string]: any}) {}
 
   /**
-   * Initializes the FirebaseApp instance.
+   * Initializes the App instance.
    *
-   * @param {FirebaseAppOptions} options Optional options for the FirebaseApp instance. If none present
-   *                             will try to initialize from the FIREBASE_CONFIG environment variable.
-   *                             If the environment variable contains a string that starts with '{'
-   *                             it will be parsed as JSON,
-   *                             otherwise it will be assumed to be pointing to a file.
-   * @param {string} [appName] Optional name of the FirebaseApp instance.
+   * @param options Optional options for the App instance. If none present will try to initialize
+   *   from the FIREBASE_CONFIG environment variable. If the environment variable contains a string
+   *   that starts with '{' it will be parsed as JSON, otherwise it will be assumed to be pointing
+   *   to a file.
+   * @param appName Optional name of the FirebaseApp instance.
    *
-   * @return {FirebaseApp} A new FirebaseApp instance.
+   * @return A new App instance.
    */
-  public initializeApp(options?: AppOptions, appName = DEFAULT_APP_NAME): FirebaseApp {
+  public initializeApp(options?: AppOptions, appName = DEFAULT_APP_NAME): App {
     if (typeof options === 'undefined') {
       options = this.loadOptionsFromEnvVar();
       options.credential = getApplicationDefault();
@@ -118,13 +126,13 @@ export class FirebaseNamespaceInternals {
   }
 
   /**
-   * Returns the FirebaseApp instance with the provided name (or the default FirebaseApp instance
+   * Returns the App instance with the provided name (or the default App instance
    * if no name is provided).
    *
-   * @param {string} [appName=DEFAULT_APP_NAME] Optional name of the FirebaseApp instance to return.
-   * @return {FirebaseApp} The FirebaseApp instance which has the provided name.
+   * @param appName Optional name of the FirebaseApp instance to return.
+   * @return The App instance which has the provided name.
    */
-  public app(appName = DEFAULT_APP_NAME): FirebaseApp {
+  public app(appName = DEFAULT_APP_NAME): App {
     if (typeof appName !== 'string' || appName === '') {
       throw new FirebaseAppError(
         AppErrorCodes.INVALID_APP_NAME,
@@ -142,19 +150,15 @@ export class FirebaseNamespaceInternals {
   }
 
   /*
-   * Returns an array of all the non-deleted FirebaseApp instances.
-   *
-   * @return {Array<FirebaseApp>} An array of all the non-deleted FirebaseApp instances
+   * Returns an array of all the non-deleted App instances.
    */
-  public get apps(): FirebaseApp[] {
+  public get apps(): App[] {
     // Return a copy so the caller cannot mutate the array
     return Object.keys(this.apps_).map((appName) => this.apps_[appName]);
   }
 
   /*
-   * Removes the specified FirebaseApp instance.
-   *
-   * @param {string} appName The name of the FirebaseApp instance to remove.
+   * Removes the specified App instance.
    */
   public removeApp(appName: string): void {
     if (typeof appName === 'undefined') {
@@ -169,14 +173,14 @@ export class FirebaseNamespaceInternals {
     delete this.apps_[appName];
   }
 
-  /*
+  /**
    * Registers a new service on this Firebase namespace.
    *
-   * @param {string} serviceName The name of the Firebase service to register.
-   * @param {FirebaseServiceFactory} createService A factory method to generate an instance of the Firebase service.
-   * @param {object} [serviceProperties] Optional properties to extend this Firebase namespace with.
-   * @param {AppHook} [appHook] Optional callback that handles app-related events like app creation and deletion.
-   * @return {FirebaseServiceNamespace<FirebaseServiceInterface>} The Firebase service's namespace.
+   * @param serviceName The name of the Firebase service to register.
+   * @param createService A factory method to generate an instance of the Firebase service.
+   * @param serviceProperties Optional properties to extend this Firebase namespace with.
+   * @param appHook Optional callback that handles app-related events like app creation and deletion.
+   * @return The Firebase service's namespace.
    */
   public registerService(
     serviceName: string,
@@ -206,7 +210,7 @@ export class FirebaseNamespaceInternals {
 
     // The service namespace is an accessor function which takes a FirebaseApp instance
     // or uses the default app if no FirebaseApp instance is provided
-    const serviceNamespace: FirebaseServiceNamespace<FirebaseServiceInterface> = (appArg?: FirebaseApp) => {
+    const serviceNamespace: FirebaseServiceNamespace<FirebaseServiceInterface> = (appArg?: App) => {
       if (typeof appArg === 'undefined') {
         appArg = this.app();
       }
@@ -228,12 +232,12 @@ export class FirebaseNamespaceInternals {
 
   /**
    * Calls the app hooks corresponding to the provided event name for each service within the
-   * provided FirebaseApp instance.
+   * provided App instance.
    *
-   * @param {FirebaseApp} app The FirebaseApp instance whose app hooks to call.
-   * @param {string} eventName The event name representing which app hooks to call.
+   * @param app The App instance whose app hooks to call.
+   * @param eventName The event name representing which app hooks to call.
    */
-  private callAppHooks_(app: FirebaseApp, eventName: string): void {
+  private callAppHooks_(app: App, eventName: string): void {
     Object.keys(this.serviceFactories).forEach((serviceName) => {
       if (this.appHooks_[serviceName]) {
         this.appHooks_[serviceName](eventName, app);
@@ -297,7 +301,7 @@ export class FirebaseNamespace {
    * `Auth` service for the default app or an explicitly specified app.
    */
   get auth(): FirebaseServiceNamespace<Auth> {
-    const fn: FirebaseServiceNamespace<Auth> = (app?: FirebaseApp) => {
+    const fn: FirebaseServiceNamespace<Auth> = (app?: App) => {
       return this.ensureApp(app).auth();
     };
     const auth = require('./auth/auth').Auth;
@@ -309,7 +313,7 @@ export class FirebaseNamespace {
    * `Database` service for the default app or an explicitly specified app.
    */
   get database(): FirebaseServiceNamespace<Database> {
-    const fn: FirebaseServiceNamespace<Database> = (app?: FirebaseApp) => {
+    const fn: FirebaseServiceNamespace<Database> = (app?: App) => {
       return this.ensureApp(app).database();
     };
 
@@ -322,7 +326,7 @@ export class FirebaseNamespace {
    * `Messaging` service for the default app or an explicitly specified app.
    */
   get messaging(): FirebaseServiceNamespace<Messaging> {
-    const fn: FirebaseServiceNamespace<Messaging> = (app?: FirebaseApp) => {
+    const fn: FirebaseServiceNamespace<Messaging> = (app?: App) => {
       return this.ensureApp(app).messaging();
     };
     const messaging = require('./messaging/messaging').Messaging;
@@ -334,7 +338,7 @@ export class FirebaseNamespace {
    * `Storage` service for the default app or an explicitly specified app.
    */
   get storage(): FirebaseServiceNamespace<Storage> {
-    const fn: FirebaseServiceNamespace<Storage> = (app?: FirebaseApp) => {
+    const fn: FirebaseServiceNamespace<Storage> = (app?: App) => {
       return this.ensureApp(app).storage();
     };
     const storage = require('./storage/storage').Storage;
@@ -346,7 +350,7 @@ export class FirebaseNamespace {
    * `Firestore` service for the default app or an explicitly specified app.
    */
   get firestore(): FirebaseServiceNamespace<Firestore> {
-    let fn: FirebaseServiceNamespace<Firestore> = (app?: FirebaseApp) => {
+    let fn: FirebaseServiceNamespace<Firestore> = (app?: App) => {
       return this.ensureApp(app).firestore();
     };
 
@@ -378,7 +382,7 @@ export class FirebaseNamespace {
    */
   get machineLearning(): FirebaseServiceNamespace<MachineLearning> {
     const fn: FirebaseServiceNamespace<MachineLearning> =
-        (app?: FirebaseApp) => {
+        (app?: App) => {
           return this.ensureApp(app).machineLearning();
         };
     const machineLearning =
@@ -391,7 +395,7 @@ export class FirebaseNamespace {
    * `Instance` service for the default app or an explicitly specified app.
    */
   get instanceId(): FirebaseServiceNamespace<InstanceId> {
-    const fn: FirebaseServiceNamespace<InstanceId> = (app?: FirebaseApp) => {
+    const fn: FirebaseServiceNamespace<InstanceId> = (app?: App) => {
       return this.ensureApp(app).instanceId();
     };
     const instanceId = require('./instance-id/instance-id').InstanceId;
@@ -403,7 +407,7 @@ export class FirebaseNamespace {
    * `ProjectManagement` service for the default app or an explicitly specified app.
    */
   get projectManagement(): FirebaseServiceNamespace<ProjectManagement> {
-    const fn: FirebaseServiceNamespace<ProjectManagement> = (app?: FirebaseApp) => {
+    const fn: FirebaseServiceNamespace<ProjectManagement> = (app?: App) => {
       return this.ensureApp(app).projectManagement();
     };
     const projectManagement = require('./project-management/project-management').ProjectManagement;
@@ -415,7 +419,7 @@ export class FirebaseNamespace {
    * `SecurityRules` service for the default app or an explicitly specified app.
    */
   get securityRules(): FirebaseServiceNamespace<SecurityRules> {
-    const fn: FirebaseServiceNamespace<SecurityRules> = (app?: FirebaseApp) => {
+    const fn: FirebaseServiceNamespace<SecurityRules> = (app?: App) => {
       return this.ensureApp(app).securityRules();
     };
     const securityRules = require('./security-rules/security-rules').SecurityRules;
@@ -427,7 +431,7 @@ export class FirebaseNamespace {
    * `RemoteConfig` service for the default app or an explicitly specified app.
    */
   get remoteConfig(): FirebaseServiceNamespace<RemoteConfig> {
-    const fn: FirebaseServiceNamespace<RemoteConfig> = (app?: FirebaseApp) => {
+    const fn: FirebaseServiceNamespace<RemoteConfig> = (app?: App) => {
       return this.ensureApp(app).remoteConfig();
     };
     const remoteConfig = require('./remote-config/remote-config').RemoteConfig;
@@ -447,7 +451,7 @@ export class FirebaseNamespace {
    *
    * @return A new FirebaseApp instance.
    */
-  public initializeApp(options?: AppOptions, appName?: string): FirebaseApp {
+  public initializeApp(options?: AppOptions, appName?: string): App {
     return this.INTERNAL.initializeApp(options, appName);
   }
 
@@ -458,20 +462,20 @@ export class FirebaseNamespace {
    * @param appName Optional name of the FirebaseApp instance to return.
    * @return The FirebaseApp instance which has the provided name.
    */
-  public app(appName?: string): FirebaseApp {
+  public app(appName?: string): App {
     return this.INTERNAL.app(appName);
   }
 
   /*
    * Returns an array of all the non-deleted FirebaseApp instances.
    */
-  public get apps(): FirebaseApp[] {
+  public get apps(): App[] {
     return this.INTERNAL.apps;
   }
 
-  private ensureApp(app?: FirebaseApp): FirebaseApp {
+  private ensureApp(app?: App): App {
     if (typeof app === 'undefined') {
-      app = this.app() as FirebaseApp;
+      app = this.app();
     }
     return app;
   }

src/firebase-service.ts

@@ -14,8 +14,11 @@
  * limitations under the License.
  */
 
+import { app } from './firebase-namespace-api';
 import { FirebaseApp } from './firebase-app';
 
+import App = app.App;
+
 /**
  * Internals of a FirebaseService instance.
  */
@@ -27,7 +30,7 @@ export interface FirebaseServiceInternalsInterface {
  * Services are exposed through instances, each of which is associated with a FirebaseApp.
  */
 export interface FirebaseServiceInterface {
-  app: FirebaseApp;
+  app: App;
   INTERNAL: FirebaseServiceInternalsInterface;
 }
 

test/resources/mocks.ts

@@ -28,6 +28,7 @@ import { AppOptions } from '../../src/firebase-namespace-api';
 import { FirebaseNamespace } from '../../src/firebase-namespace';
 import { FirebaseServiceInterface } from '../../src/firebase-service';
 import { FirebaseApp } from '../../src/firebase-app';
+import { app as _app } from '../../src/firebase-namespace-api';
 import { credential as _credential, GoogleOAuthAccessToken } from '../../src/credential/index';
 import { ServiceAccountCredential } from '../../src/credential/credential-internal';
 
@@ -223,7 +224,7 @@ export function generateSessionCookie(overrides?: object, expiresIn?: number): s
 
 /* eslint-disable @typescript-eslint/no-unused-vars */
 export function firebaseServiceFactory(
-  firebaseApp: FirebaseApp,
+  firebaseApp: _app.App,
   _extendApp?: (props: object) => void,
 ): FirebaseServiceInterface {
   const result = {