firebase-admin 9.3.0 → 9.5.0

package/lib/security-rules/index.d.ts

@@ -0,0 +1,216 @@
+/*! 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';
+/**
+ * Gets the {@link securityRules.SecurityRules
+ * `SecurityRules`} service for the default app or a given app.
+ *
+ * `admin.securityRules()` can be called with no arguments to access the
+ * default app's {@link securityRules.SecurityRules
+ * `SecurityRules`} service, or as `admin.securityRules(app)` to access
+ * the {@link securityRules.SecurityRules `SecurityRules`}
+ * service associated with a specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the SecurityRules service for the default app
+ * var defaultSecurityRules = admin.securityRules();
+ * ```
+ *
+ * @example
+ *  ```javascript
+ * // Get the SecurityRules service for a given app
+ * var otherSecurityRules = admin.securityRules(otherApp);
+ * ```
+ *
+ * @param app Optional app to return the `SecurityRules` service
+ *     for. If not provided, the default `SecurityRules` service
+ *     is returned.
+ * @return The default `SecurityRules` service if no app is provided, or the
+ *   `SecurityRules` service associated with the provided app.
+ */
+export declare function securityRules(app?: app.App): securityRules.SecurityRules;
+export declare namespace securityRules {
+    /**
+     * A source file containing some Firebase security rules. The content includes raw
+     * source code including text formatting, indentation and comments. Use the
+     * [`securityRules.createRulesFileFromSource()`](securityRules.SecurityRules#createRulesFileFromSource)
+     * method to create new instances of this type.
+     */
+    interface RulesFile {
+        readonly name: string;
+        readonly content: string;
+    }
+    /**
+     * Required metadata associated with a ruleset.
+     */
+    interface RulesetMetadata {
+        /**
+         * Name of the `Ruleset` as a short string. This can be directly passed into APIs
+         * like {@link securityRules.SecurityRules.getRuleset `securityRules.getRuleset()`}
+         * and {@link securityRules.SecurityRules.deleteRuleset `securityRules.deleteRuleset()`}.
+         */
+        readonly name: string;
+        /**
+         * Creation time of the `Ruleset` as a UTC timestamp string.
+         */
+        readonly createTime: string;
+    }
+    /**
+     * A page of ruleset metadata.
+     */
+    interface RulesetMetadataList {
+        /**
+         * A batch of ruleset metadata.
+         */
+        readonly rulesets: RulesetMetadata[];
+        /**
+         * The next page token if available. This is needed to retrieve the next batch.
+         */
+        readonly nextPageToken?: string;
+    }
+    /**
+     * A set of Firebase security rules.
+     */
+    interface Ruleset extends RulesetMetadata {
+        readonly source: RulesFile[];
+    }
+    /**
+     * The Firebase `SecurityRules` service interface.
+     */
+    interface SecurityRules {
+        app: app.App;
+        /**
+         * Creates a {@link securityRules.RulesFile `RuleFile`} with the given name
+         * and source. Throws an error if any of the arguments are invalid. This is a local
+         * operation, and does not involve any network API calls.
+         *
+         * @example
+         * ```javascript
+         * const source = '// Some rules source';
+         * const rulesFile = admin.securityRules().createRulesFileFromSource(
+         *   'firestore.rules', source);
+         * ```
+         *
+         * @param name Name to assign to the rules file. This is usually a short file name that
+         *   helps identify the file in a ruleset.
+         * @param source Contents of the rules file.
+         * @return A new rules file instance.
+         */
+        createRulesFileFromSource(name: string, source: string | Buffer): RulesFile;
+        /**
+         * Creates a new {@link securityRules.Ruleset `Ruleset`} from the given
+         * {@link securityRules.RulesFile `RuleFile`}.
+         *
+         * @param file Rules file to include in the new `Ruleset`.
+         * @returns A promise that fulfills with the newly created `Ruleset`.
+         */
+        createRuleset(file: RulesFile): Promise<Ruleset>;
+        /**
+         * Gets the {@link securityRules.Ruleset `Ruleset`} identified by the given
+         * name. The input name should be the short name string without the project ID
+         * prefix. For example, to retrieve the `projects/project-id/rulesets/my-ruleset`,
+         * pass the short name "my-ruleset". Rejects with a `not-found` error if the
+         * specified `Ruleset` cannot be found.
+         *
+         * @param name Name of the `Ruleset` to retrieve.
+         * @return A promise that fulfills with the specified `Ruleset`.
+         */
+        getRuleset(name: string): Promise<Ruleset>;
+        /**
+         * Deletes the {@link securityRules.Ruleset `Ruleset`} identified by the given
+         * name. The input name should be the short name string without the project ID
+         * prefix. For example, to delete the `projects/project-id/rulesets/my-ruleset`,
+         * pass the  short name "my-ruleset". Rejects with a `not-found` error if the
+         * specified `Ruleset` cannot be found.
+         *
+         * @param name Name of the `Ruleset` to delete.
+         * @return A promise that fulfills when the `Ruleset` is deleted.
+         */
+        deleteRuleset(name: string): Promise<void>;
+        /**
+         * Retrieves a page of ruleset metadata.
+         *
+         * @param pageSize The page size, 100 if undefined. This is also the maximum allowed
+         *   limit.
+         * @param nextPageToken The next page token. If not specified, returns rulesets
+         *   starting without any offset.
+         * @return A promise that fulfills with a page of rulesets.
+         */
+        listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
+        /**
+         * Gets the {@link securityRules.Ruleset `Ruleset`} currently applied to
+         * Cloud Firestore. Rejects with a `not-found` error if no ruleset is applied
+         * on Firestore.
+         *
+         * @return A promise that fulfills with the Firestore ruleset.
+         */
+        getFirestoreRuleset(): Promise<Ruleset>;
+        /**
+         * Creates a new {@link securityRules.Ruleset `Ruleset`} from the given
+         * source, and applies it to Cloud Firestore.
+         *
+         * @param source Rules source to apply.
+         * @return A promise that fulfills when the ruleset is created and released.
+         */
+        releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;
+        /**
+         * Applies the specified {@link securityRules.Ruleset `Ruleset`} ruleset
+         * to Cloud Firestore.
+         *
+         * @param ruleset Name of the ruleset to apply or a `RulesetMetadata` object
+         *   containing the name.
+         * @return A promise that fulfills when the ruleset is released.
+         */
+        releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
+        /**
+         * Gets the {@link securityRules.Ruleset `Ruleset`} currently applied to a
+         * Cloud Storage bucket. Rejects with a `not-found` error if no ruleset is applied
+         * on the bucket.
+         *
+         * @param bucket Optional name of the Cloud Storage bucket to be retrieved. If not
+         *   specified, retrieves the ruleset applied on the default bucket configured via
+         *   `AppOptions`.
+         * @return A promise that fulfills with the Cloud Storage ruleset.
+         */
+        getStorageRuleset(bucket?: string): Promise<Ruleset>;
+        /**
+         * Creates a new {@link securityRules.Ruleset `Ruleset`} from the given
+         * source, and applies it to a Cloud Storage bucket.
+         *
+         * @param source Rules source to apply.
+         * @param bucket Optional name of the Cloud Storage bucket to apply the rules on. If
+         *   not specified, applies the ruleset on the default bucket configured via
+         *   {@link AppOptions `AppOptions`}.
+         * @return A promise that fulfills when the ruleset is created and released.
+         */
+        releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
+        /**
+         * Applies the specified {@link securityRules.Ruleset `Ruleset`} ruleset
+         * to a Cloud Storage bucket.
+         *
+         * @param ruleset Name of the ruleset to apply or a `RulesetMetadata` object
+         *   containing the name.
+         * @param bucket Optional name of the Cloud Storage bucket to apply the rules on. If
+         *   not specified, applies the ruleset on the default bucket configured via
+         *   {@link AppOptions `AppOptions`}.
+         * @return A promise that fulfills when the ruleset is released.
+         */
+        releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
+    }
+}

package/lib/security-rules/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.3.0 */
+/*! firebase-admin v9.5.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -16,26 +16,3 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.admin = exports.securityRules = void 0;
-var firebaseAdmin = require("../index");
-function securityRules(app) {
-    if (typeof (app) === 'undefined') {
-        app = firebaseAdmin.app();
-    }
-    return app.securityRules();
-}
-exports.securityRules = securityRules;
-/**
- * We must define a namespace to make the typings work correctly. Otherwise
- * `admin.securityRules()` cannot be called like a function. Temporarily,
- * admin.securityRules is used as the namespace name because we cannot barrel
- * re-export the contents from security-rules, and we want it to
- * match the namespacing in the re-export inside src/index.d.ts
- */
-/* eslint-disable @typescript-eslint/no-namespace */
-var admin;
-(function (admin) {
-    var securityRules;
-    (function (securityRules) {
-    })(securityRules = admin.securityRules || (admin.securityRules = {}));
-})(admin = exports.admin || (exports.admin = {}));

package/lib/security-rules/security-rules-api-client-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.3.0 */
+/*! firebase-admin v9.5.0 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.

package/lib/security-rules/security-rules-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.3.0 */
+/*! firebase-admin v9.5.0 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.

package/lib/security-rules/security-rules.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.3.0 */
+/*! firebase-admin v9.5.0 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.
@@ -59,7 +59,7 @@ exports.Ruleset = Ruleset;
  * The Firebase `SecurityRules` service interface.
  *
  * Do not call this constructor directly. Instead, use
- * [`admin.securityRules()`](admin.securityRules#securityRules).
+ * [`admin.securityRules()`](securityRules#securityRules).
  */
 var SecurityRules = /** @class */ (function () {
     /**
@@ -68,7 +68,6 @@ var SecurityRules = /** @class */ (function () {
      */
     function SecurityRules(app) {
         this.app = app;
-        this.INTERNAL = new SecurityRulesInternals();
         this.client = new security_rules_api_client_internal_1.SecurityRulesApiClient(app);
     }
     /**
@@ -187,7 +186,7 @@ var SecurityRules = /** @class */ (function () {
         });
     };
     /**
-     * Creates a {@link admin.securityRules.RulesFile `RuleFile`} with the given name
+     * Creates a {@link securityRules.RulesFile `RuleFile`} with the given name
      * and source. Throws an error if any of the arguments are invalid. This is a local
      * operation, and does not involve any network API calls.
      *
@@ -223,8 +222,8 @@ var SecurityRules = /** @class */ (function () {
         };
     };
     /**
-     * Creates a new {@link admin.securityRules.Ruleset `Ruleset`} from the given
-     * {@link admin.securityRules.RulesFile `RuleFile`}.
+     * Creates a new {@link securityRules.Ruleset `Ruleset`} from the given
+     * {@link securityRules.RulesFile `RuleFile`}.
      *
      * @param file Rules file to include in the new `Ruleset`.
      * @returns A promise that fulfills with the newly created `Ruleset`.
@@ -241,7 +240,7 @@ var SecurityRules = /** @class */ (function () {
         });
     };
     /**
-     * Deletes the {@link admin.securityRules.Ruleset `Ruleset`} identified by the given
+     * Deletes the {@link securityRules.Ruleset `Ruleset`} identified by the given
      * name. The input name should be the short name string without the project ID
      * prefix. For example, to delete the `projects/project-id/rulesets/my-ruleset`,
      * pass the  short name "my-ruleset". Rejects with a `not-found` error if the
@@ -306,14 +305,6 @@ var SecurityRules = /** @class */ (function () {
     return SecurityRules;
 }());
 exports.SecurityRules = SecurityRules;
-var SecurityRulesInternals = /** @class */ (function () {
-    function SecurityRulesInternals() {
-    }
-    SecurityRulesInternals.prototype.delete = function () {
-        return Promise.resolve();
-    };
-    return SecurityRulesInternals;
-}());
 function stripProjectIdPrefix(name) {
     return name.split('/').pop();
 }

package/lib/storage/index.d.ts

@@ -0,0 +1,60 @@
+/*! 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.
+ */
+import { Bucket } from '@google-cloud/storage';
+import { app } from '../firebase-namespace-api';
+/**
+ * Gets the {@link storage.Storage `Storage`} service for the
+ * default app or a given app.
+ *
+ * `admin.storage()` can be called with no arguments to access the default
+ * app's {@link storage.Storage `Storage`} service or as
+ * `admin.storage(app)` to access the
+ * {@link storage.Storage `Storage`} service associated with a
+ * specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the Storage service for the default app
+ * var defaultStorage = admin.storage();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the Storage service for a given app
+ * var otherStorage = admin.storage(otherApp);
+ * ```
+ */
+export declare function storage(app?: app.App): storage.Storage;
+export declare namespace storage {
+    /**
+     * The default `Storage` service if no
+     * app is provided or the `Storage` service associated with the provided
+     * app.
+     */
+    interface Storage {
+        /**
+         * Optional app whose `Storage` service to
+         * return. If not provided, the default `Storage` service will be returned.
+         */
+        app: app.App;
+        /**
+         * @returns A [Bucket](https://cloud.google.com/nodejs/docs/reference/storage/latest/Bucket)
+         * instance as defined in the `@google-cloud/storage` package.
+         */
+        bucket(name?: string): Bucket;
+    }
+}

package/lib/storage/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.3.0 */
+/*! firebase-admin v9.5.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -16,12 +16,3 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.storage = void 0;
-var firebaseAdmin = require("../index");
-function storage(app) {
-    if (typeof (app) === 'undefined') {
-        app = firebaseAdmin.app();
-    }
-    return app.storage();
-}
-exports.storage = storage;

package/lib/storage/storage.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");
@@ -21,23 +22,6 @@ var error_1 = require("../utils/error");
 var credential_internal_1 = require("../credential/credential-internal");
 var utils = require("../utils/index");
 var validator = require("../utils/validator");
-/**
- * Internals of a Storage instance.
- */
-var StorageInternals = /** @class */ (function () {
-    function StorageInternals() {
-    }
-    /**
-     * Deletes the service and its associated resources.
-     *
-     * @return {Promise<()>} An empty Promise that will be fulfilled when the service is deleted.
-     */
-    StorageInternals.prototype.delete = function () {
-        // There are no resources to clean up.
-        return Promise.resolve();
-    };
-    return StorageInternals;
-}());
 /**
  * The default `Storage` service if no
  * app is provided or the `Storage` service associated with the provided
@@ -50,7 +34,6 @@ var Storage = /** @class */ (function () {
      * @internal
      */
     function Storage(app) {
-        this.INTERNAL = new StorageInternals();
         if (!validator.isNonNullObject(app) || !('options' in app)) {
             throw new error_1.FirebaseError({
                 code: 'storage/invalid-argument',

package/lib/utils/api-request.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");
@@ -663,17 +664,23 @@ var AuthorizedHttpClient = /** @class */ (function (_super) {
     }
     AuthorizedHttpClient.prototype.send = function (request) {
         var _this = this;
-        return this.app.INTERNAL.getToken().then(function (accessTokenObj) {
+        return this.getToken().then(function (token) {
             var requestCopy = Object.assign({}, request);
             requestCopy.headers = Object.assign({}, request.headers);
             var authHeader = 'Authorization';
-            requestCopy.headers[authHeader] = "Bearer " + accessTokenObj.accessToken;
+            requestCopy.headers[authHeader] = "Bearer " + token;
             if (!requestCopy.httpAgent && _this.app.options.httpAgent) {
                 requestCopy.httpAgent = _this.app.options.httpAgent;
             }
             return _super.prototype.send.call(_this, requestCopy);
         });
     };
+    AuthorizedHttpClient.prototype.getToken = function () {
+        return this.app.INTERNAL.getToken()
+            .then(function (accessTokenObj) {
+            return accessTokenObj.accessToken;
+        });
+    };
     return AuthorizedHttpClient;
 }(HttpClient));
 exports.AuthorizedHttpClient = AuthorizedHttpClient;

package/lib/utils/deep-copy.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/utils/error.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/utils/index.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");
@@ -69,9 +70,9 @@ exports.addReadonlyGetter = addReadonlyGetter;
  * specified in either the Firebase app options, credentials or the local environment.
  * Otherwise returns null.
  *
- * @param {FirebaseApp} app A Firebase app to get the project ID from.
+ * @param app A Firebase app to get the project ID from.
  *
- * @return {string} A project ID string or null.
+ * @return A project ID string or null.
  */
 function getExplicitProjectId(app) {
     var options = app.options;
@@ -96,9 +97,9 @@ exports.getExplicitProjectId = getExplicitProjectId;
  * configured, but the SDK has been initialized with ComputeEngineCredentials, this
  * method attempts to discover the project ID from the local metadata service.
  *
- * @param {FirebaseApp} app A Firebase app to get the project ID from.
+ * @param app A Firebase app to get the project ID from.
  *
- * @return {Promise<string | null>} A project ID string or null.
+ * @return A project ID string or null.
  */
 function findProjectId(app) {
     var projectId = getExplicitProjectId(app);

package/lib/utils/validator.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-admin",
-  "version": "9.3.0",
+  "version": "9.5.0",
   "description": "Firebase admin SDK for Node.js",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "license": "Apache-2.0",
@@ -20,7 +20,9 @@
     "test:coverage": "nyc npm run test:unit",
     "lint:src": "eslint src/ --ext .ts",
     "lint:test": "eslint test/ --ext .ts",
-    "apidocs": "node docgen/generate-docs.js --api node"
+    "apidocs": "node docgen/generate-docs.js --api node",
+    "api-extractor": "api-extractor run",
+    "api-extractor:local": "api-extractor run --local"
   },
   "nyc": {
     "extension": [
@@ -54,21 +56,22 @@
   ],
   "types": "./lib/index.d.ts",
   "dependencies": {
-    "@firebase/database": "^0.6.10",
-    "@firebase/database-types": "^0.5.2",
+    "@firebase/database": "^0.8.1",
+    "@firebase/database-types": "^0.6.1",
     "@types/node": "^10.10.0",
     "dicer": "^0.3.0",
     "jsonwebtoken": "^8.5.1",
     "node-forge": "^0.10.0"
   },
   "optionalDependencies": {
-    "@google-cloud/firestore": "^4.0.0",
+    "@google-cloud/firestore": "^4.5.0",
     "@google-cloud/storage": "^5.3.0"
   },
   "devDependencies": {
-    "@firebase/app": "^0.6.9",
-    "@firebase/auth": "^0.14.9",
+    "@firebase/app": "^0.6.13",
+    "@firebase/auth": "^0.16.2",
     "@firebase/auth-types": "^0.10.1",
+    "@microsoft/api-extractor": "^7.11.2",
     "@types/bcrypt": "^2.0.0",
     "@types/chai": "^4.0.0",
     "@types/chai-as-promised": "^7.1.0",
@@ -101,9 +104,9 @@
     "jsdom": "^15.0.0",
     "lodash": "^4.17.15",
     "minimist": "^1.2.0",
-    "mocha": "^5.2.0",
+    "mocha": "^8.0.0",
     "mz": "^2.7.0",
-    "nock": "^9.6.0",
+    "nock": "^13.0.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^14.1.0",
     "request": "^2.75.0",
@@ -111,9 +114,9 @@
     "run-sequence": "^1.1.5",
     "sinon": "^9.0.0",
     "sinon-chai": "^3.0.0",
-    "ts-node": "^3.3.0",
-    "typedoc": "^0.15.0",
+    "ts-node": "^9.0.0",
+    "typedoc": "^0.19.2",
     "typescript": "^3.7.3",
-    "yargs": "^13.2.2"
+    "yargs": "^16.0.0"
   }
 }