firebase-admin 9.3.0 → 9.5.0

package/lib/credential/index.d.ts

@@ -0,0 +1,169 @@
+/*! firebase-admin v9.5.0 */
+/*!
+ * Copyright 2020 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/// <reference types="node" />
+import { Agent } from 'http';
+export interface ServiceAccount {
+    projectId?: string;
+    clientEmail?: string;
+    privateKey?: string;
+}
+/**
+ * Interface for Google OAuth 2.0 access tokens.
+ */
+export interface GoogleOAuthAccessToken {
+    access_token: string;
+    expires_in: number;
+}
+export declare namespace credential {
+    /**
+     * Interface that provides Google OAuth2 access tokens used to authenticate
+     * with Firebase services.
+     *
+     * In most cases, you will not need to implement this yourself and can instead
+     * use the default implementations provided by
+     * {@link credential `admin.credential`}.
+     */
+    interface Credential {
+        /**
+         * Returns a Google OAuth2 access token object used to authenticate with
+         * Firebase services.
+         *
+         * This object contains the following properties:
+         * * `access_token` (`string`): The actual Google OAuth2 access token.
+         * * `expires_in` (`number`): The number of seconds from when the token was
+         *   issued that it expires.
+         *
+         * @return A Google OAuth2 access token object.
+         */
+        getAccessToken(): Promise<GoogleOAuthAccessToken>;
+    }
+    /**
+     * Returns a credential created from the
+     * {@link
+     *    https://developers.google.com/identity/protocols/application-default-credentials
+     *    Google Application Default Credentials}
+     * that grants admin access to Firebase services. This credential can be used
+     * in the call to
+     * {@link
+     *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
+     *  `admin.initializeApp()`}.
+     *
+     * Google Application Default Credentials are available on any Google
+     * infrastructure, such as Google App Engine and Google Compute Engine.
+     *
+     * See
+     * {@link
+     *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
+     *   Initialize the SDK}
+     * for more details.
+     *
+     * @example
+     * ```javascript
+     * admin.initializeApp({
+     *   credential: admin.credential.applicationDefault(),
+     *   databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
+     * });
+     * ```
+     *
+     * @param {!Object=} httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+     *   to be used when retrieving access tokens from Google token servers.
+     *
+     * @return {!admin.credential.Credential} A credential authenticated via Google
+     *   Application Default Credentials that can be used to initialize an app.
+     */
+    function applicationDefault(httpAgent?: Agent): Credential;
+    /**
+     * Returns a credential created from the provided service account that grants
+     * admin access to Firebase services. This credential can be used in the call
+     * to
+     * {@link
+     *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
+     *   `admin.initializeApp()`}.
+     *
+     * See
+     * {@link
+     *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
+     *   Initialize the SDK}
+     * for more details.
+     *
+     * @example
+     * ```javascript
+     * // Providing a path to a service account key JSON file
+     * var serviceAccount = require("path/to/serviceAccountKey.json");
+     * admin.initializeApp({
+     *   credential: admin.credential.cert(serviceAccount),
+     *   databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
+     * });
+     * ```
+     *
+     * @example
+     * ```javascript
+     * // Providing a service account object inline
+     * admin.initializeApp({
+     *   credential: admin.credential.cert({
+     *     projectId: "<PROJECT_ID>",
+     *     clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
+     *     privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
+     *   }),
+     *   databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
+     * });
+     * ```
+     *
+     * @param serviceAccountPathOrObject The path to a service
+     *   account key JSON file or an object representing a service account key.
+     * @param httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+     *   to be used when retrieving access tokens from Google token servers.
+     *
+     * @return A credential authenticated via the
+     *   provided service account that can be used to initialize an app.
+     */
+    function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;
+    /**
+     * Returns a credential created from the provided refresh token that grants
+     * admin access to Firebase services. This credential can be used in the call
+     * to
+     * {@link
+     *   https://firebase.google.com/docs/reference/admin/node/admin#.initializeApp
+     *   `admin.initializeApp()`}.
+     *
+     * See
+     * {@link
+     *   https://firebase.google.com/docs/admin/setup#initialize_the_sdk
+     *   Initialize the SDK}
+     * for more details.
+     *
+     * @example
+     * ```javascript
+     * // Providing a path to a refresh token JSON file
+     * var refreshToken = require("path/to/refreshToken.json");
+     * admin.initializeApp({
+     *   credential: admin.credential.refreshToken(refreshToken),
+     *   databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
+     * });
+     * ```
+     *
+     * @param refreshTokenPathOrObject The path to a Google
+     *   OAuth2 refresh token JSON file or an object representing a Google OAuth2
+     *   refresh token.
+     * @param httpAgent Optional [HTTP Agent](https://nodejs.org/api/http.html#http_class_http_agent)
+     *   to be used when retrieving access tokens from Google token servers.
+     *
+     * @return A credential authenticated via the
+     *   provided service account that can be used to initialize an app.
+     */
+    function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;
+}

package/lib/credential/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.3.0 */
+/*! firebase-admin v9.5.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -16,20 +16,8 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.admin = void 0;
-var credentialApi = require("./credential");
-/**
- * Temporarily, admin.credential is used as the namespace name because we
- * cannot barrel re-export the contents from credential.ts, and we want it to
- * match the namespacing in the re-export inside src/index.d.ts
- */
+exports.credential = void 0;
 /* eslint-disable @typescript-eslint/no-namespace */
-var admin;
-(function (admin) {
-    var credential;
-    (function (credential) {
-        credential.applicationDefault = credentialApi.applicationDefault;
-        credential.cert = credentialApi.cert;
-        credential.refreshToken = credentialApi.refreshToken;
-    })(credential = admin.credential || (admin.credential = {}));
-})(admin = exports.admin || (exports.admin = {}));
+var credential;
+(function (credential) {
+})(credential = exports.credential || (exports.credential = {}));

package/lib/database/database-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.3.0 */
+/*! firebase-admin v9.5.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -23,31 +23,9 @@ var error_1 = require("../utils/error");
 var validator = require("../utils/validator");
 var api_request_1 = require("../utils/api-request");
 var index_1 = require("../utils/index");
-/**
- * Internals of a Database instance.
- */
-var DatabaseInternals = /** @class */ (function () {
-    function DatabaseInternals() {
-        this.databases = {};
-    }
-    /**
-     * Deletes the service and its associated resources.
-     *
-     * @return {Promise<()>} An empty Promise that will be fulfilled when the service is deleted.
-     */
-    DatabaseInternals.prototype.delete = function () {
-        for (var _i = 0, _a = Object.keys(this.databases); _i < _a.length; _i++) {
-            var dbUrl = _a[_i];
-            var db = this.databases[dbUrl];
-            db.INTERNAL.delete();
-        }
-        return Promise.resolve(undefined);
-    };
-    return DatabaseInternals;
-}());
 var DatabaseService = /** @class */ (function () {
     function DatabaseService(app) {
-        this.INTERNAL = new DatabaseInternals();
+        this.databases = {};
         if (!validator.isNonNullObject(app) || !('options' in app)) {
             throw new error_1.FirebaseDatabaseError({
                 code: 'invalid-argument',
@@ -56,6 +34,21 @@ var DatabaseService = /** @class */ (function () {
         }
         this.appInternal = app;
     }
+    /**
+     * @internal
+     */
+    DatabaseService.prototype.delete = function () {
+        var _this = this;
+        var promises = [];
+        for (var _i = 0, _a = Object.keys(this.databases); _i < _a.length; _i++) {
+            var dbUrl = _a[_i];
+            var db = this.databases[dbUrl];
+            promises.push(db.INTERNAL.delete());
+        }
+        return Promise.all(promises).then(function () {
+            _this.databases = {};
+        });
+    };
     Object.defineProperty(DatabaseService.prototype, "app", {
         /**
          * Returns the app associated with this DatabaseService instance.
@@ -76,7 +69,7 @@ var DatabaseService = /** @class */ (function () {
                 message: 'Database URL must be a valid, non-empty URL string.',
             });
         }
-        var db = this.INTERNAL.databases[dbUrl];
+        var db = this.databases[dbUrl];
         if (typeof db === 'undefined') {
             var rtdb = require('@firebase/database'); // eslint-disable-line @typescript-eslint/no-var-requires
             db = rtdb.initStandalone(this.appInternal, dbUrl, index_1.getSdkVersion()).instance;
@@ -90,7 +83,7 @@ var DatabaseService = /** @class */ (function () {
             db.setRules = function (source) {
                 return rulesClient_1.setRules(source);
             };
-            this.INTERNAL.databases[dbUrl] = db;
+            this.databases[dbUrl] = db;
         }
         return db;
     };

package/lib/database/index.d.ts

@@ -0,0 +1,89 @@
+/*! firebase-admin v9.5.0 */
+/*!
+ * Copyright 2020 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/// <reference types="node" />
+import { app } from '../firebase-namespace-api';
+import * as rtdb from '@firebase/database-types';
+/**
+ * Gets the {@link database.Database `Database`} service for the default
+ * app or a given app.
+ *
+ * `admin.database()` can be called with no arguments to access the default
+ * app's {@link database.Database `Database`} service or as
+ * `admin.database(app)` to access the
+ * {@link database.Database `Database`} service associated with a specific
+ * app.
+ *
+ * `admin.database` is also a namespace that can be used to access global
+ * constants and methods associated with the `Database` service.
+ *
+ * @example
+ * ```javascript
+ * // Get the Database service for the default app
+ * var defaultDatabase = admin.database();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the Database service for a specific app
+ * var otherDatabase = admin.database(app);
+ * ```
+ *
+ * @param App whose `Database` service to
+ *   return. If not provided, the default `Database` service will be returned.
+ *
+ * @return The default `Database` service if no app
+ *   is provided or the `Database` service associated with the provided app.
+ */
+export declare function database(app?: app.App): database.Database;
+export declare namespace database {
+    interface Database extends rtdb.FirebaseDatabase {
+        /**
+         * Gets the currently applied security rules as a string. The return value consists of
+         * the rules source including comments.
+         *
+         * @return A promise fulfilled with the rules as a raw string.
+         */
+        getRules(): Promise<string>;
+        /**
+         * Gets the currently applied security rules as a parsed JSON object. Any comments in
+         * the original source are stripped away.
+         *
+         * @return A promise fulfilled with the parsed rules object.
+         */
+        getRulesJSON(): Promise<object>;
+        /**
+         * Sets the specified rules on the Firebase Realtime Database instance. If the rules source is
+         * specified as a string or a Buffer, it may include comments.
+         *
+         * @param source Source of the rules to apply. Must not be `null` or empty.
+         * @return Resolves when the rules are set on the Realtime Database.
+         */
+        setRules(source: string | Buffer | object): Promise<void>;
+    }
+    export import DataSnapshot = rtdb.DataSnapshot;
+    export import EventType = rtdb.EventType;
+    export import OnDisconnect = rtdb.OnDisconnect;
+    export import Query = rtdb.Query;
+    export import Reference = rtdb.Reference;
+    export import ThenableReference = rtdb.ThenableReference;
+    export import enableLogging = rtdb.enableLogging;
+    /**
+     * [`ServerValue`](https://firebase.google.com/docs/reference/js/firebase.database.ServerValue)
+     * module from the `@firebase/database` package.
+     */
+    const ServerValue: rtdb.ServerValue;
+}

package/lib/database/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.3.0 */
+/*! firebase-admin v9.5.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -16,32 +16,16 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.admin = exports.database = void 0;
+exports.database = void 0;
 var database_1 = require("@firebase/database");
-var adminDb = require("./database");
-var firebaseDbTypesApi = require("@firebase/database-types");
-var firebaseAdmin = require("../index");
-function database(app) {
-    if (typeof (app) === 'undefined') {
-        app = firebaseAdmin.app();
-    }
-    return app.database();
-}
-exports.database = database;
-/**
- * We must define a namespace to make the typings work correctly. Otherwise
- * `admin.database()` cannot be called like a function. Temporarily,
- * admin.database is used as the namespace name because we cannot barrel
- * re-export the contents from @firebase/database-types, and we want it to
- * match the namespacing in the re-export inside src/index.d.ts
- */
+var rtdb = require("@firebase/database-types");
 /* eslint-disable @typescript-eslint/no-namespace */
-var admin;
-(function (admin) {
-    var database;
-    (function (database) {
-        database.Database = adminDb.Database;
-        database.enableLogging = firebaseDbTypesApi.enableLogging;
-        database.ServerValue = database_1.ServerValue;
-    })(database = admin.database || (admin.database = {}));
-})(admin = exports.admin || (exports.admin = {}));
+var database;
+(function (database) {
+    database.enableLogging = rtdb.enableLogging;
+    /**
+     * [`ServerValue`](https://firebase.google.com/docs/reference/js/firebase.database.ServerValue)
+     * module from the `@firebase/database` package.
+     */
+    database.ServerValue = database_1.ServerValue;
+})(database = exports.database || (exports.database = {}));

package/lib/default-namespace.js

@@ -1,6 +1,7 @@
-/*! firebase-admin v9.3.0 */
+/*! firebase-admin v9.5.0 */
 "use strict";
 /*!
+ * @license
  * Copyright 2017 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");

package/lib/firebase-app.js

@@ -1,6 +1,7 @@
-/*! firebase-admin v9.3.0 */
+/*! firebase-admin v9.5.0 */
 "use strict";
 /*!
+ * @license
  * Copyright 2017 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -180,14 +181,13 @@ exports.FirebaseAppInternals = FirebaseAppInternals;
  */
 var FirebaseApp = /** @class */ (function () {
     function FirebaseApp(options, name, firebaseInternals_) {
-        var _this = this;
         this.firebaseInternals_ = firebaseInternals_;
         this.services_ = {};
         this.isDeleted_ = false;
         this.name_ = name;
         this.options_ = deep_copy_1.deepCopy(options);
         if (!validator.isNonNullObject(this.options_)) {
-            throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_APP_OPTIONS, "Invalid Firebase app options passed as the first argument to initializeApp() for the " +
+            throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_APP_OPTIONS, 'Invalid Firebase app options passed as the first argument to initializeApp() for the ' +
                 ("app named \"" + this.name_ + "\". Options must be a non-null object."));
         }
         var hasCredential = ('credential' in this.options_);
@@ -196,20 +196,16 @@ var FirebaseApp = /** @class */ (function () {
         }
         var credential = this.options_.credential;
         if (typeof credential !== 'object' || credential === null || typeof credential.getAccessToken !== 'function') {
-            throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_APP_OPTIONS, "Invalid Firebase app options passed as the first argument to initializeApp() for the " +
+            throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_APP_OPTIONS, 'Invalid Firebase app options passed as the first argument to initializeApp() for the ' +
                 ("app named \"" + this.name_ + "\". The \"credential\" property must be an object which implements ") +
-                "the Credential interface.");
+                'the Credential interface.');
         }
-        Object.keys(firebaseInternals_.serviceFactories).forEach(function (serviceName) {
-            // Defer calling createService() until the service is accessed
-            _this[serviceName] = _this.getService_.bind(_this, serviceName);
-        });
         this.INTERNAL = new FirebaseAppInternals(credential);
     }
     /**
      * Returns the Auth service instance associated with this app.
      *
-     * @return {Auth} The Auth service instance of this app.
+     * @return The Auth service instance of this app.
      */
     FirebaseApp.prototype.auth = function () {
         var _this = this;
@@ -221,7 +217,7 @@ var FirebaseApp = /** @class */ (function () {
     /**
      * Returns the Database service for the specified URL, and the current app.
      *
-     * @return {Database} The Database service instance of this app.
+     * @return The Database service instance of this app.
      */
     FirebaseApp.prototype.database = function (url) {
         var _this = this;
@@ -234,7 +230,7 @@ var FirebaseApp = /** @class */ (function () {
     /**
      * Returns the Messaging service instance associated with this app.
      *
-     * @return {Messaging} The Messaging service instance of this app.
+     * @return The Messaging service instance of this app.
      */
     FirebaseApp.prototype.messaging = function () {
         var _this = this;
@@ -246,7 +242,7 @@ var FirebaseApp = /** @class */ (function () {
     /**
      * Returns the Storage service instance associated with this app.
      *
-     * @return {Storage} The Storage service instance of this app.
+     * @return The Storage service instance of this app.
      */
     FirebaseApp.prototype.storage = function () {
         var _this = this;
@@ -266,7 +262,7 @@ var FirebaseApp = /** @class */ (function () {
     /**
      * Returns the InstanceId service instance associated with this app.
      *
-     * @return {InstanceId} The InstanceId service instance of this app.
+     * @return The InstanceId service instance of this app.
      */
     FirebaseApp.prototype.instanceId = function () {
         var _this = this;
@@ -278,7 +274,7 @@ var FirebaseApp = /** @class */ (function () {
     /**
      * Returns the MachineLearning service instance associated with this app.
      *
-     * @return {MachineLearning} The Machine Learning service instance of this app
+     * @return The Machine Learning service instance of this app
      */
     FirebaseApp.prototype.machineLearning = function () {
         var _this = this;
@@ -290,7 +286,7 @@ var FirebaseApp = /** @class */ (function () {
     /**
      * Returns the ProjectManagement service instance associated with this app.
      *
-     * @return {ProjectManagement} The ProjectManagement service instance of this app.
+     * @return The ProjectManagement service instance of this app.
      */
     FirebaseApp.prototype.projectManagement = function () {
         var _this = this;
@@ -302,7 +298,7 @@ var FirebaseApp = /** @class */ (function () {
     /**
      * Returns the SecurityRules service instance associated with this app.
      *
-     * @return {SecurityRules} The SecurityRules service instance of this app.
+     * @return The SecurityRules service instance of this app.
      */
     FirebaseApp.prototype.securityRules = function () {
         var _this = this;
@@ -314,7 +310,7 @@ var FirebaseApp = /** @class */ (function () {
     /**
      * Returns the RemoteConfig service instance associated with this app.
      *
-     * @return {RemoteConfig} The RemoteConfig service instance of this app.
+     * @return The RemoteConfig service instance of this app.
      */
     FirebaseApp.prototype.remoteConfig = function () {
         var _this = this;
@@ -327,7 +323,7 @@ var FirebaseApp = /** @class */ (function () {
         /**
          * Returns the name of the FirebaseApp instance.
          *
-         * @return {string} The name of the FirebaseApp instance.
+         * @return The name of the FirebaseApp instance.
          */
         get: function () {
             this.checkDestroyed_();
@@ -340,7 +336,7 @@ var FirebaseApp = /** @class */ (function () {
         /**
          * Returns the options for the FirebaseApp instance.
          *
-         * @return {FirebaseAppOptions} The options for the FirebaseApp instance.
+         * @return The options for the FirebaseApp instance.
          */
         get: function () {
             this.checkDestroyed_();
@@ -352,7 +348,7 @@ var FirebaseApp = /** @class */ (function () {
     /**
      * Deletes the FirebaseApp instance.
      *
-     * @return {Promise<void>} An empty Promise fulfilled once the FirebaseApp instance is deleted.
+     * @return An empty Promise fulfilled once the FirebaseApp instance is deleted.
      */
     FirebaseApp.prototype.delete = function () {
         var _this = this;
@@ -360,44 +356,23 @@ var FirebaseApp = /** @class */ (function () {
         this.firebaseInternals_.removeApp(this.name_);
         this.INTERNAL.delete();
         return Promise.all(Object.keys(this.services_).map(function (serviceName) {
-            return _this.services_[serviceName].INTERNAL.delete();
+            var service = _this.services_[serviceName];
+            if (isStateful(service)) {
+                return service.delete();
+            }
+            return Promise.resolve();
         })).then(function () {
             _this.services_ = {};
             _this.isDeleted_ = true;
         });
     };
     FirebaseApp.prototype.ensureService_ = function (serviceName, initializer) {
-        this.checkDestroyed_();
-        var service;
-        if (serviceName in this.services_) {
-            service = this.services_[serviceName];
-        }
-        else {
-            service = initializer();
-            this.services_[serviceName] = service;
-        }
-        return service;
-    };
-    /**
-     * Returns the service instance associated with this FirebaseApp instance (creating it on demand
-     * if needed). This is used for looking up monkeypatched service instances.
-     *
-     * @param {string} serviceName The name of the service instance to return.
-     * @return {FirebaseServiceInterface} The service instance with the provided name.
-     */
-    FirebaseApp.prototype.getService_ = function (serviceName) {
         this.checkDestroyed_();
         if (!(serviceName in this.services_)) {
-            this.services_[serviceName] = this.firebaseInternals_.serviceFactories[serviceName](this, this.extendApp_.bind(this));
+            this.services_[serviceName] = initializer();
         }
         return this.services_[serviceName];
     };
-    /**
-     * Callback function used to extend an App instance at the time of service instance creation.
-     */
-    FirebaseApp.prototype.extendApp_ = function (props) {
-        deep_copy_1.deepExtend(this, props);
-    };
     /**
      * Throws an Error if the FirebaseApp instance has already been deleted.
      */
@@ -409,3 +384,6 @@ var FirebaseApp = /** @class */ (function () {
     return FirebaseApp;
 }());
 exports.FirebaseApp = FirebaseApp;
+function isStateful(service) {
+    return typeof service.delete === 'function';
+}