firebase-admin 9.100.0-alpha.0 → 10.0.2

package/lib/app/firebase-app.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * @license
@@ -22,113 +22,78 @@ var credential_internal_1 = require("./credential-internal");
 var validator = require("../utils/validator");
 var deep_copy_1 = require("../utils/deep-copy");
 var error_1 = require("../utils/error");
+var TOKEN_EXPIRY_THRESHOLD_MILLIS = 5 * 60 * 1000;
 /**
  * Internals of a FirebaseApp instance.
  */
 var FirebaseAppInternals = /** @class */ (function () {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     function FirebaseAppInternals(credential_) {
         this.credential_ = credential_;
-        this.isDeleted_ = false;
         this.tokenListeners_ = [];
     }
-    /**
-     * Gets an auth token for the associated app.
-     *
-     * @param {boolean} forceRefresh Whether or not to force a token refresh.
-     * @return {Promise<FirebaseAccessToken>} A Promise that will be fulfilled with the current or
-     *   new token.
-     */
     FirebaseAppInternals.prototype.getToken = function (forceRefresh) {
-        var _this = this;
-        var expired = this.cachedToken_ && this.cachedToken_.expirationTime < Date.now();
-        if (this.cachedTokenPromise_ && !forceRefresh && !expired) {
-            return this.cachedTokenPromise_
-                .catch(function (error) {
-                // Update the cached token promise to avoid caching errors. Set it to resolve with the
-                // cached token if we have one (and return that promise since the token has still not
-                // expired).
-                if (_this.cachedToken_) {
-                    _this.cachedTokenPromise_ = Promise.resolve(_this.cachedToken_);
-                    return _this.cachedTokenPromise_;
-                }
-                // Otherwise, set the cached token promise to null so that it will force a refresh next
-                // time getToken() is called.
-                _this.cachedTokenPromise_ = null;
-                // And re-throw the caught error.
-                throw error;
-            });
-        }
-        else {
-            // Clear the outstanding token refresh timeout. This is a noop if the timeout is undefined.
-            clearTimeout(this.tokenRefreshTimeout_);
-            // this.credential_ may be an external class; resolving it in a promise helps us
-            // protect against exceptions and upgrades the result to a promise in all cases.
-            this.cachedTokenPromise_ = Promise.resolve(this.credential_.getAccessToken())
-                .then(function (result) {
-                // Since the developer can provide the credential implementation, we want to weakly verify
-                // the return type until the type is properly exported.
-                if (!validator.isNonNullObject(result) ||
-                    typeof result.expires_in !== 'number' ||
-                    typeof result.access_token !== 'string') {
-                    throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, "Invalid access token generated: \"" + JSON.stringify(result) + "\". Valid access " +
-                        'tokens must be an object with the "expires_in" (number) and "access_token" ' +
-                        '(string) properties.');
-                }
-                var token = {
-                    accessToken: result.access_token,
-                    expirationTime: Date.now() + (result.expires_in * 1000),
-                };
-                var hasAccessTokenChanged = (_this.cachedToken_ && _this.cachedToken_.accessToken !== token.accessToken);
-                var hasExpirationChanged = (_this.cachedToken_ && _this.cachedToken_.expirationTime !== token.expirationTime);
-                if (!_this.cachedToken_ || hasAccessTokenChanged || hasExpirationChanged) {
-                    _this.cachedToken_ = token;
-                    _this.tokenListeners_.forEach(function (listener) {
-                        listener(token.accessToken);
-                    });
-                }
-                // Establish a timeout to proactively refresh the token every minute starting at five
-                // minutes before it expires. Once a token refresh succeeds, no further retries are
-                // needed; if it fails, retry every minute until the token expires (resulting in a total
-                // of four retries: at 4, 3, 2, and 1 minutes).
-                var refreshTimeInSeconds = (result.expires_in - (5 * 60));
-                var numRetries = 4;
-                // In the rare cases the token is short-lived (that is, it expires in less than five
-                // minutes from when it was fetched), establish the timeout to refresh it after the
-                // current minute ends and update the number of retries that should be attempted before
-                // the token expires.
-                if (refreshTimeInSeconds <= 0) {
-                    refreshTimeInSeconds = result.expires_in % 60;
-                    numRetries = Math.floor(result.expires_in / 60) - 1;
-                }
-                // The token refresh timeout keeps the Node.js process alive, so only create it if this
-                // instance has not already been deleted.
-                if (numRetries && !_this.isDeleted_) {
-                    _this.setTokenRefreshTimeout(refreshTimeInSeconds * 1000, numRetries);
-                }
-                return token;
-            })
-                .catch(function (error) {
-                var errorMessage = (typeof error === 'string') ? error : error.message;
-                errorMessage = 'Credential implementation provided to initializeApp() via the ' +
-                    '"credential" property failed to fetch a valid Google OAuth2 access token with the ' +
-                    ("following error: \"" + errorMessage + "\".");
-                if (errorMessage.indexOf('invalid_grant') !== -1) {
-                    errorMessage += ' There are two likely causes: (1) your server time is not properly ' +
-                        'synced or (2) your certificate key file has been revoked. To solve (1), re-sync the ' +
-                        'time on your server. To solve (2), make sure the key ID for your key file is still ' +
-                        'present at https://console.firebase.google.com/iam-admin/serviceaccounts/project. If ' +
-                        'not, generate a new key file at ' +
-                        'https://console.firebase.google.com/project/_/settings/serviceaccounts/adminsdk.';
-                }
-                throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, errorMessage);
-            });
-            return this.cachedTokenPromise_;
+        if (forceRefresh === void 0) { forceRefresh = false; }
+        if (forceRefresh || this.shouldRefresh()) {
+            return this.refreshToken();
         }
+        return Promise.resolve(this.cachedToken_);
+    };
+    FirebaseAppInternals.prototype.getCachedToken = function () {
+        return this.cachedToken_ || null;
+    };
+    FirebaseAppInternals.prototype.refreshToken = function () {
+        var _this = this;
+        return Promise.resolve(this.credential_.getAccessToken())
+            .then(function (result) {
+            // Since the developer can provide the credential implementation, we want to weakly verify
+            // the return type until the type is properly exported.
+            if (!validator.isNonNullObject(result) ||
+                typeof result.expires_in !== 'number' ||
+                typeof result.access_token !== 'string') {
+                throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, "Invalid access token generated: \"" + JSON.stringify(result) + "\". Valid access " +
+                    'tokens must be an object with the "expires_in" (number) and "access_token" ' +
+                    '(string) properties.');
+            }
+            var token = {
+                accessToken: result.access_token,
+                expirationTime: Date.now() + (result.expires_in * 1000),
+            };
+            if (!_this.cachedToken_
+                || _this.cachedToken_.accessToken !== token.accessToken
+                || _this.cachedToken_.expirationTime !== token.expirationTime) {
+                // Update the cache before firing listeners. Listeners may directly query the
+                // cached token state.
+                _this.cachedToken_ = token;
+                _this.tokenListeners_.forEach(function (listener) {
+                    listener(token.accessToken);
+                });
+            }
+            return token;
+        })
+            .catch(function (error) {
+            var errorMessage = (typeof error === 'string') ? error : error.message;
+            errorMessage = 'Credential implementation provided to initializeApp() via the ' +
+                '"credential" property failed to fetch a valid Google OAuth2 access token with the ' +
+                ("following error: \"" + errorMessage + "\".");
+            if (errorMessage.indexOf('invalid_grant') !== -1) {
+                errorMessage += ' There are two likely causes: (1) your server time is not properly ' +
+                    'synced or (2) your certificate key file has been revoked. To solve (1), re-sync the ' +
+                    'time on your server. To solve (2), make sure the key ID for your key file is still ' +
+                    'present at https://console.firebase.google.com/iam-admin/serviceaccounts/project. If ' +
+                    'not, generate a new key file at ' +
+                    'https://console.firebase.google.com/project/_/settings/serviceaccounts/adminsdk.';
+            }
+            throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, errorMessage);
+        });
+    };
+    FirebaseAppInternals.prototype.shouldRefresh = function () {
+        return !this.cachedToken_ || (this.cachedToken_.expirationTime - Date.now()) <= TOKEN_EXPIRY_THRESHOLD_MILLIS;
     };
     /**
      * Adds a listener that is called each time a token changes.
      *
-     * @param {function(string)} listener The listener that will be called with each new token.
+     * @param listener - The listener that will be called with each new token.
      */
     FirebaseAppInternals.prototype.addAuthTokenListener = function (listener) {
         this.tokenListeners_.push(listener);
@@ -139,40 +104,11 @@ var FirebaseAppInternals = /** @class */ (function () {
     /**
      * Removes a token listener.
      *
-     * @param {function(string)} listener The listener to remove.
+     * @param listener - The listener to remove.
      */
     FirebaseAppInternals.prototype.removeAuthTokenListener = function (listener) {
         this.tokenListeners_ = this.tokenListeners_.filter(function (other) { return other !== listener; });
     };
-    /**
-     * Deletes the FirebaseAppInternals instance.
-     */
-    FirebaseAppInternals.prototype.delete = function () {
-        this.isDeleted_ = true;
-        // Clear the token refresh timeout so it doesn't keep the Node.js process alive.
-        clearTimeout(this.tokenRefreshTimeout_);
-    };
-    /**
-     * Establishes timeout to refresh the Google OAuth2 access token used by the SDK.
-     *
-     * @param {number} delayInMilliseconds The delay to use for the timeout.
-     * @param {number} numRetries The number of times to retry fetching a new token if the prior fetch
-     *   failed.
-     */
-    FirebaseAppInternals.prototype.setTokenRefreshTimeout = function (delayInMilliseconds, numRetries) {
-        var _this = this;
-        this.tokenRefreshTimeout_ = setTimeout(function () {
-            _this.getToken(/* forceRefresh */ true)
-                .catch(function () {
-                // Ignore the error since this might just be an intermittent failure. If we really cannot
-                // refresh the token, an error will be logged once the existing token expires and we try
-                // to fetch a fresh one.
-                if (numRetries > 0) {
-                    _this.setTokenRefreshTimeout(60 * 1000, numRetries - 1);
-                }
-            });
-        }, delayInMilliseconds);
-    };
     return FirebaseAppInternals;
 }());
 exports.FirebaseAppInternals = FirebaseAppInternals;
@@ -182,8 +118,8 @@ exports.FirebaseAppInternals = FirebaseAppInternals;
  * @internal
  */
 var FirebaseApp = /** @class */ (function () {
-    function FirebaseApp(options, name, firebaseInternals_) {
-        this.firebaseInternals_ = firebaseInternals_;
+    function FirebaseApp(options, name, appStore) {
+        this.appStore = appStore;
         this.services_ = {};
         this.isDeleted_ = false;
         this.name_ = name;
@@ -204,96 +140,11 @@ var FirebaseApp = /** @class */ (function () {
         }
         this.INTERNAL = new FirebaseAppInternals(credential);
     }
-    /**
-     * Returns the Auth service instance associated with this app.
-     *
-     * @return The Auth service instance of this app.
-     */
-    FirebaseApp.prototype.auth = function () {
-        var fn = require('../auth/index').getAuth;
-        return fn(this);
-    };
-    /**
-     * Returns the Database service for the specified URL, and the current app.
-     *
-     * @return The Database service instance of this app.
-     */
-    FirebaseApp.prototype.database = function (url) {
-        var fn = require('../database/index').getDatabaseWithUrl;
-        return fn(url, this);
-    };
-    /**
-     * Returns the Messaging service instance associated with this app.
-     *
-     * @return The Messaging service instance of this app.
-     */
-    FirebaseApp.prototype.messaging = function () {
-        var fn = require('../messaging/index').getMessaging;
-        return fn(this);
-    };
-    /**
-     * Returns the Storage service instance associated with this app.
-     *
-     * @return The Storage service instance of this app.
-     */
-    FirebaseApp.prototype.storage = function () {
-        var fn = require('../storage/index').getStorage;
-        return fn(this);
-    };
-    FirebaseApp.prototype.firestore = function () {
-        var fn = require('../firestore/index').getFirestore;
-        return fn(this);
-    };
-    /**
-     * Returns the InstanceId service instance associated with this app.
-     *
-     * @return The InstanceId service instance of this app.
-     */
-    FirebaseApp.prototype.instanceId = function () {
-        var fn = require('../instance-id/index').getInstanceId;
-        return fn(this);
-    };
-    /**
-     * Returns the MachineLearning service instance associated with this app.
-     *
-     * @return The Machine Learning service instance of this app
-     */
-    FirebaseApp.prototype.machineLearning = function () {
-        var fn = require('../machine-learning/index').getMachineLearning;
-        return fn(this);
-    };
-    /**
-     * Returns the ProjectManagement service instance associated with this app.
-     *
-     * @return The ProjectManagement service instance of this app.
-     */
-    FirebaseApp.prototype.projectManagement = function () {
-        var fn = require('../project-management/index').getProjectManagement;
-        return fn(this);
-    };
-    /**
-     * Returns the SecurityRules service instance associated with this app.
-     *
-     * @return The SecurityRules service instance of this app.
-     */
-    FirebaseApp.prototype.securityRules = function () {
-        var fn = require('../security-rules/index').getSecurityRules;
-        return fn(this);
-    };
-    /**
-     * Returns the RemoteConfig service instance associated with this app.
-     *
-     * @return The RemoteConfig service instance of this app.
-     */
-    FirebaseApp.prototype.remoteConfig = function () {
-        var fn = require('../remote-config/index').getRemoteConfig;
-        return fn(this);
-    };
     Object.defineProperty(FirebaseApp.prototype, "name", {
         /**
          * Returns the name of the FirebaseApp instance.
          *
-         * @return The name of the FirebaseApp instance.
+         * @returns The name of the FirebaseApp instance.
          */
         get: function () {
             this.checkDestroyed_();
@@ -306,7 +157,7 @@ var FirebaseApp = /** @class */ (function () {
         /**
          * Returns the options for the FirebaseApp instance.
          *
-         * @return The options for the FirebaseApp instance.
+         * @returns The options for the FirebaseApp instance.
          */
         get: function () {
             this.checkDestroyed_();
@@ -325,13 +176,16 @@ var FirebaseApp = /** @class */ (function () {
     /**
      * Deletes the FirebaseApp instance.
      *
-     * @return An empty Promise fulfilled once the FirebaseApp instance is deleted.
+     * @returns An empty Promise fulfilled once the FirebaseApp instance is deleted.
      */
     FirebaseApp.prototype.delete = function () {
         var _this = this;
+        var _a;
         this.checkDestroyed_();
-        this.firebaseInternals_.removeApp(this.name_);
-        this.INTERNAL.delete();
+        // Also remove the instance from the AppStore. This is needed to support the existing
+        // app.delete() use case. In the future we can remove this API, and deleteApp() will
+        // become the only way to tear down an App.
+        (_a = this.appStore) === null || _a === void 0 ? void 0 : _a.removeApp(this.name);
         return Promise.all(Object.keys(this.services_).map(function (serviceName) {
             var service = _this.services_[serviceName];
             if (isStateful(service)) {
@@ -343,6 +197,7 @@ var FirebaseApp = /** @class */ (function () {
             _this.isDeleted_ = true;
         });
     };
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     FirebaseApp.prototype.ensureService_ = function (serviceName, initializer) {
         this.checkDestroyed_();
         if (!(serviceName in this.services_)) {
@@ -353,6 +208,7 @@ var FirebaseApp = /** @class */ (function () {
     /**
      * Throws an Error if the FirebaseApp instance has already been deleted.
      */
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     FirebaseApp.prototype.checkDestroyed_ = function () {
         if (this.isDeleted_) {
             throw new error_1.FirebaseAppError(error_1.AppErrorCodes.APP_DELETED, "Firebase app named \"" + this.name_ + "\" has already been deleted.");

package/lib/app/firebase-namespace.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2017 Google Inc.
@@ -15,12 +15,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { app, auth, messaging, machineLearning, storage, firestore, database, instanceId, projectManagement, securityRules, remoteConfig, AppOptions } from '../firebase-namespace-api';
+import { AppStore } from './lifecycle';
+import { app, appCheck, auth, messaging, machineLearning, storage, firestore, database, instanceId, installations, projectManagement, securityRules, remoteConfig, AppOptions } from '../firebase-namespace-api';
 import { cert, refreshToken, applicationDefault } from './credential-factory';
 import App = app.App;
+import AppCheck = appCheck.AppCheck;
 import Auth = auth.Auth;
 import Database = database.Database;
 import Firestore = firestore.Firestore;
+import Installations = installations.Installations;
 import InstanceId = instanceId.InstanceId;
 import MachineLearning = machineLearning.MachineLearning;
 import Messaging = messaging.Messaging;
@@ -28,12 +31,6 @@ import ProjectManagement = projectManagement.ProjectManagement;
 import RemoteConfig = remoteConfig.RemoteConfig;
 import SecurityRules = securityRules.SecurityRules;
 import Storage = storage.Storage;
-/**
- * Constant holding the environment variable name with the default config.
- * 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.
- */
-export declare const FIREBASE_CONFIG_VAR = "FIREBASE_CONFIG";
 export interface FirebaseServiceNamespace<T> {
     (app?: App): T;
     [key: string]: any;
@@ -42,42 +39,29 @@ export interface FirebaseServiceNamespace<T> {
  * Internals of a FirebaseNamespace instance.
  */
 export declare class FirebaseNamespaceInternals {
-    firebase_: {
-        [key: string]: any;
-    };
-    private apps_;
-    constructor(firebase_: {
-        [key: string]: any;
-    });
+    private readonly appStore;
+    constructor(appStore: AppStore);
     /**
      * Initializes the App instance.
      *
-     * @param options Optional options for the App instance. If none present will try to initialize
+     * @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.
+     * @param appName - Optional name of the FirebaseApp instance.
      *
-     * @return A new App instance.
+     * @returns A new App instance.
      */
     initializeApp(options?: AppOptions, appName?: string): App;
     /**
      * Returns the App instance with the provided name (or the default App instance
      * if no name is provided).
      *
-     * @param appName Optional name of the FirebaseApp instance to return.
-     * @return The App instance which has the provided name.
+     * @param appName - Optional name of the FirebaseApp instance to return.
+     * @returns The App instance which has the provided name.
      */
     app(appName?: string): App;
     get apps(): App[];
-    removeApp(appName: string): void;
-    /**
-     * Parse the file pointed to by the FIREBASE_CONFIG_VAR, if it exists.
-     * Or if the FIREBASE_CONFIG_ENV contains a valid JSON object, parse it directly.
-     * 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.
-     */
-    private loadOptionsFromEnvVar;
 }
 /**
  * Global Firebase context object.
@@ -92,7 +76,7 @@ export declare class FirebaseNamespace {
     SDK_VERSION: string;
     INTERNAL: FirebaseNamespaceInternals;
     Promise: any;
-    constructor();
+    constructor(appStore?: AppStore);
     /**
      * Gets the `Auth` service namespace. The returned namespace can be used to get the
      * `Auth` service for the default app or an explicitly specified app.
@@ -124,6 +108,11 @@ export declare class FirebaseNamespace {
      * explicityly specified app.
      */
     get machineLearning(): FirebaseServiceNamespace<MachineLearning>;
+    /**
+     * Gets the `Installations` service namespace. The returned namespace can be used to get the
+     * `Installations` service for the default app or an explicitly specified app.
+     */
+    get installations(): FirebaseServiceNamespace<Installations>;
     /**
      * Gets the `InstanceId` service namespace. The returned namespace can be used to get the
      * `Instance` service for the default app or an explicitly specified app.
@@ -144,24 +133,29 @@ export declare class FirebaseNamespace {
      * `RemoteConfig` service for the default app or an explicitly specified app.
      */
     get remoteConfig(): FirebaseServiceNamespace<RemoteConfig>;
+    /**
+     * Gets the `AppCheck` service namespace. The returned namespace can be used to get the
+     * `AppCheck` service for the default app or an explicitly specified app.
+     */
+    get appCheck(): FirebaseServiceNamespace<AppCheck>;
     /**
      * Initializes the FirebaseApp instance.
      *
-     * @param options Optional options for the FirebaseApp instance.
+     * @param 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 appName Optional name of the FirebaseApp instance.
+     * @param appName - Optional name of the FirebaseApp instance.
      *
-     * @return A new FirebaseApp instance.
+     * @returns A new FirebaseApp instance.
      */
     initializeApp(options?: AppOptions, appName?: string): App;
     /**
      * Returns the FirebaseApp instance with the provided name (or the default FirebaseApp instance
      * if no name is provided).
      *
-     * @param appName Optional name of the FirebaseApp instance to return.
-     * @return The FirebaseApp instance which has the provided name.
+     * @param appName - Optional name of the FirebaseApp instance to return.
+     * @returns The FirebaseApp instance which has the provided name.
      */
     app(appName?: string): App;
     get apps(): App[];