firebase-admin 9.100.0-alpha.0 → 10.0.2

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2021 Google Inc.
  *
@@ -17,38 +17,53 @@
 import { App } from '../app';
 import { RulesFile as TRulesFile, Ruleset as TRuleset, RulesetMetadata as TRulesetMetadata, RulesetMetadataList as TRulesetMetadataList, SecurityRules as TSecurityRules } from './security-rules';
 /**
- * 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.
-  */
+ * Gets the {@link firebase-admin.security-rules#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 firebase-admin.security-rules#SecurityRules}
+ * service, or as `admin.securityRules(app)` to access
+ * the {@link firebase-admin.security-rules#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.
+ * @returns The default `SecurityRules` service if no app is provided, or the
+ *   `SecurityRules` service associated with the provided app.
+ */
 export declare function securityRules(app?: App): securityRules.SecurityRules;
 export declare namespace securityRules {
+    /**
+     * Type alias to {@link firebase-admin.security-rules#RulesFile}.
+     */
     type RulesFile = TRulesFile;
+    /**
+     * Type alias to {@link firebase-admin.security-rules#Ruleset}.
+     */
     type Ruleset = TRuleset;
+    /**
+     * Type alias to {@link firebase-admin.security-rules#RulesetMetadata}.
+     */
     type RulesetMetadata = TRulesetMetadata;
+    /**
+     * Type alias to {@link firebase-admin.security-rules#RulesetMetadataList}.
+     */
     type RulesetMetadataList = TRulesetMetadataList;
+    /**
+     * Type alias to {@link firebase-admin.security-rules#SecurityRules}.
+     */
     type SecurityRules = TSecurityRules;
 }

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2019 Google Inc.
  *
@@ -19,8 +19,7 @@ import { App } from '../app';
 /**
  * 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.
+ * {@link SecurityRules.createRulesFileFromSource} method to create new instances of this type.
  */
 export interface RulesFile {
     readonly name: string;
@@ -32,8 +31,7 @@ export interface RulesFile {
 export 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()`}.
+     * like {@link SecurityRules.getRuleset} and {@link SecurityRules.deleteRuleset}.
      */
     readonly name: string;
     /**
@@ -77,77 +75,77 @@ export declare class SecurityRules {
     private static readonly FIREBASE_STORAGE;
     private readonly client;
     /**
-     * Gets the {@link securityRules.Ruleset `Ruleset`} identified by the given
+     * Gets the {@link 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`.
+     * @param name - Name of the `Ruleset` to retrieve.
+     * @returns A promise that fulfills with the specified `Ruleset`.
      */
     getRuleset(name: string): Promise<Ruleset>;
     /**
-     * Gets the {@link securityRules.Ruleset `Ruleset`} currently applied to
+     * Gets the {@link 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.
+     * @returns A promise that fulfills with the Firestore ruleset.
      */
     getFirestoreRuleset(): Promise<Ruleset>;
     /**
-     * Creates a new {@link securityRules.Ruleset `Ruleset`} from the given
+     * Creates a new {@link 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.
+     * @param source - Rules source to apply.
+     * @returns 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
+     * Applies the specified {@link Ruleset} ruleset
      * to Cloud Firestore.
      *
-     * @param ruleset Name of the ruleset to apply or a `RulesetMetadata` object
+     * @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.
+     * @returns 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
+     * Gets the {@link 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
+     * @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.
+     * @returns A promise that fulfills with the Cloud Storage ruleset.
      */
     getStorageRuleset(bucket?: string): Promise<Ruleset>;
     /**
-     * Creates a new {@link securityRules.Ruleset `Ruleset`} from the given
+     * Creates a new {@link 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
+     * @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.
+     *   {@link firebase-admin.app#AppOptions}.
+     * @returns 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
+     * Applies the specified {@link Ruleset} ruleset
      * to a Cloud Storage bucket.
      *
-     * @param ruleset Name of the ruleset to apply or a `RulesetMetadata` object
+     * @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
+     * @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.
+     *   {@link firebase-admin.app#AppOptions}.
+     * @returns A promise that fulfills when the ruleset is released.
      */
     releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
     /**
-     * Creates a {@link securityRules.RulesFile `RuleFile`} with the given name
+     * Creates a {@link RulesFile} 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.
      *
@@ -158,39 +156,38 @@ export declare class SecurityRules {
      *   'firestore.rules', source);
      * ```
      *
-     * @param name Name to assign to the rules file. This is usually a short file name that
+     * @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.
+     * @param source - Contents of the rules file.
+     * @returns 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`}.
+     * Creates a new {@link Ruleset} from the given {@link RulesFile}.
      *
-     * @param file Rules file to include in the new `Ruleset`.
+     * @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>;
     /**
-     * Deletes the {@link securityRules.Ruleset `Ruleset`} identified by the given
+     * Deletes the {@link 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.
+     * @param name - Name of the `Ruleset` to delete.
+     * @returns 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
+     * @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
+     * @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.
+     * @returns A promise that fulfills with a page of rulesets.
      */
     listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
     private getRulesetForRelease;

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.
@@ -70,7 +70,7 @@ exports.Ruleset = Ruleset;
  */
 var SecurityRules = /** @class */ (function () {
     /**
-     * @param app The app for this SecurityRules service.
+     * @param app - The app for this SecurityRules service.
      * @constructor
      * @internal
      */
@@ -79,14 +79,14 @@ var SecurityRules = /** @class */ (function () {
         this.client = new security_rules_api_client_internal_1.SecurityRulesApiClient(app);
     }
     /**
-     * Gets the {@link securityRules.Ruleset `Ruleset`} identified by the given
+     * Gets the {@link 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`.
+     * @param name - Name of the `Ruleset` to retrieve.
+     * @returns A promise that fulfills with the specified `Ruleset`.
      */
     SecurityRules.prototype.getRuleset = function (name) {
         return this.client.getRuleset(name)
@@ -95,21 +95,21 @@ var SecurityRules = /** @class */ (function () {
         });
     };
     /**
-     * Gets the {@link securityRules.Ruleset `Ruleset`} currently applied to
+     * Gets the {@link 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.
+     * @returns A promise that fulfills with the Firestore ruleset.
      */
     SecurityRules.prototype.getFirestoreRuleset = function () {
         return this.getRulesetForRelease(SecurityRules.CLOUD_FIRESTORE);
     };
     /**
-     * Creates a new {@link securityRules.Ruleset `Ruleset`} from the given
+     * Creates a new {@link 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.
+     * @param source - Rules source to apply.
+     * @returns A promise that fulfills when the ruleset is created and released.
      */
     SecurityRules.prototype.releaseFirestoreRulesetFromSource = function (source) {
         var _this = this;
@@ -126,25 +126,25 @@ var SecurityRules = /** @class */ (function () {
         });
     };
     /**
-     * Applies the specified {@link securityRules.Ruleset `Ruleset`} ruleset
+     * Applies the specified {@link Ruleset} ruleset
      * to Cloud Firestore.
      *
-     * @param ruleset Name of the ruleset to apply or a `RulesetMetadata` object
+     * @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.
+     * @returns A promise that fulfills when the ruleset is released.
      */
     SecurityRules.prototype.releaseFirestoreRuleset = function (ruleset) {
         return this.releaseRuleset(ruleset, SecurityRules.CLOUD_FIRESTORE);
     };
     /**
-     * Gets the {@link securityRules.Ruleset `Ruleset`} currently applied to a
+     * Gets the {@link 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
+     * @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.
+     * @returns A promise that fulfills with the Cloud Storage ruleset.
      */
     SecurityRules.prototype.getStorageRuleset = function (bucket) {
         var _this = this;
@@ -157,14 +157,14 @@ var SecurityRules = /** @class */ (function () {
         });
     };
     /**
-     * Creates a new {@link securityRules.Ruleset `Ruleset`} from the given
+     * Creates a new {@link 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
+     * @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.
+     *   {@link firebase-admin.app#AppOptions}.
+     * @returns A promise that fulfills when the ruleset is created and released.
      */
     SecurityRules.prototype.releaseStorageRulesetFromSource = function (source, bucket) {
         var _this = this;
@@ -184,15 +184,15 @@ var SecurityRules = /** @class */ (function () {
         });
     };
     /**
-     * Applies the specified {@link securityRules.Ruleset `Ruleset`} ruleset
+     * Applies the specified {@link Ruleset} ruleset
      * to a Cloud Storage bucket.
      *
-     * @param ruleset Name of the ruleset to apply or a `RulesetMetadata` object
+     * @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
+     * @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.
+     *   {@link firebase-admin.app#AppOptions}.
+     * @returns A promise that fulfills when the ruleset is released.
      */
     SecurityRules.prototype.releaseStorageRuleset = function (ruleset, bucket) {
         var _this = this;
@@ -205,7 +205,7 @@ var SecurityRules = /** @class */ (function () {
         });
     };
     /**
-     * Creates a {@link securityRules.RulesFile `RuleFile`} with the given name
+     * Creates a {@link RulesFile} 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.
      *
@@ -216,10 +216,10 @@ var SecurityRules = /** @class */ (function () {
      *   'firestore.rules', source);
      * ```
      *
-     * @param name Name to assign to the rules file. This is usually a short file name that
+     * @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.
+     * @param source - Contents of the rules file.
+     * @returns A new rules file instance.
      */
     SecurityRules.prototype.createRulesFileFromSource = function (name, source) {
         if (!validator.isNonEmptyString(name)) {
@@ -241,10 +241,9 @@ var SecurityRules = /** @class */ (function () {
         };
     };
     /**
-     * Creates a new {@link securityRules.Ruleset `Ruleset`} from the given
-     * {@link securityRules.RulesFile `RuleFile`}.
+     * Creates a new {@link Ruleset} from the given {@link RulesFile}.
      *
-     * @param file Rules file to include in the new `Ruleset`.
+     * @param file - Rules file to include in the new `Ruleset`.
      * @returns A promise that fulfills with the newly created `Ruleset`.
      */
     SecurityRules.prototype.createRuleset = function (file) {
@@ -259,14 +258,14 @@ var SecurityRules = /** @class */ (function () {
         });
     };
     /**
-     * Deletes the {@link securityRules.Ruleset `Ruleset`} identified by the given
+     * Deletes the {@link 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.
+     * @param name - Name of the `Ruleset` to delete.
+     * @returns A promise that fulfills when the `Ruleset` is deleted.
      */
     SecurityRules.prototype.deleteRuleset = function (name) {
         return this.client.deleteRuleset(name);
@@ -274,11 +273,11 @@ var SecurityRules = /** @class */ (function () {
     /**
      * Retrieves a page of ruleset metadata.
      *
-     * @param pageSize The page size, 100 if undefined. This is also the maximum allowed
+     * @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
+     * @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.
+     * @returns A promise that fulfills with a page of rulesets.
      */
     SecurityRules.prototype.listRulesetMetadata = function (pageSize, nextPageToken) {
         if (pageSize === void 0) { pageSize = 100; }

package/lib/storage/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2020 Google Inc.
  *
@@ -14,18 +14,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * Cloud Storage for Firebase.
+ *
+ * @packageDocumentation
+ */
 import { App } from '../app';
 import { Storage } from './storage';
 export { Storage } from './storage';
 /**
- * Gets the {@link storage.Storage `Storage`} service for the
- * default app or a given app.
+ * Gets the {@link Storage} service for the default app or a given app.
  *
  * `getStorage()` can be called with no arguments to access the default
- * app's {@link storage.Storage `Storage`} service or as
- * `getStorage(app)` to access the
- * {@link storage.Storage `Storage`} service associated with a
- * specific app.
+ * app's `Storage` service or as `getStorage(app)` to access the
+ * `Storage` service associated with a specific app.
  *
  * @example
  * ```javascript

package/lib/storage/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.
@@ -17,19 +17,21 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getStorage = void 0;
+/**
+ * Cloud Storage for Firebase.
+ *
+ * @packageDocumentation
+ */
 var app_1 = require("../app");
 var storage_1 = require("./storage");
 var storage_2 = require("./storage");
 Object.defineProperty(exports, "Storage", { enumerable: true, get: function () { return storage_2.Storage; } });
 /**
- * Gets the {@link storage.Storage `Storage`} service for the
- * default app or a given app.
+ * Gets the {@link Storage} service for the default app or a given app.
  *
  * `getStorage()` can be called with no arguments to access the default
- * app's {@link storage.Storage `Storage`} service or as
- * `getStorage(app)` to access the
- * {@link storage.Storage `Storage`} service associated with a
- * specific app.
+ * app's `Storage` service or as `getStorage(app)` to access the
+ * `Storage` service associated with a specific app.
  *
  * @example
  * ```javascript

package/lib/storage/storage-namespace.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2021 Google Inc.
  *
@@ -17,14 +17,12 @@
 import { App } from '../app';
 import { Storage as TStorage } from './storage';
 /**
- * Gets the {@link storage.Storage `Storage`} service for the
+ * Gets the {@link firebase-admin.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.
+ * app's `Storage` service or as `admin.storage(app)` to access the
+ * `Storage` service associated with a specific app.
  *
  * @example
  * ```javascript
@@ -40,5 +38,8 @@ import { Storage as TStorage } from './storage';
  */
 export declare function storage(app?: App): storage.Storage;
 export declare namespace storage {
+    /**
+     * Type alias to {@link firebase-admin.storage#Storage}.
+     */
     type Storage = TStorage;
 }

package/lib/storage/storage-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/storage/storage.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2017 Google Inc.
@@ -28,9 +28,9 @@ export declare class Storage {
     /**
      * Gets a reference to a Cloud Storage bucket.
      *
-     * @param name Optional name of the bucket to be retrieved. If name is not specified,
+     * @param name - Optional name of the bucket to be retrieved. If name is not specified,
      * retrieves a reference to the default bucket.
-     * @returns A [Bucket](https://cloud.google.com/nodejs/docs/reference/storage/latest/Bucket)
+     * @returns A {@link https://cloud.google.com/nodejs/docs/reference/storage/latest/Bucket | Bucket}
      * instance as defined in the `@google-cloud/storage` package.
      */
     bucket(name?: string): Bucket;

package/lib/storage/storage.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * @license
@@ -29,7 +29,7 @@ var validator = require("../utils/validator");
  */
 var Storage = /** @class */ (function () {
     /**
-     * @param app The app for this Storage service.
+     * @param app - The app for this Storage service.
      * @constructor
      * @internal
      */
@@ -40,6 +40,16 @@ var Storage = /** @class */ (function () {
                 message: 'First argument passed to admin.storage() must be a valid Firebase app instance.',
             });
         }
+        if (!process.env.STORAGE_EMULATOR_HOST && process.env.FIREBASE_STORAGE_EMULATOR_HOST) {
+            var firebaseStorageEmulatorHost = process.env.FIREBASE_STORAGE_EMULATOR_HOST;
+            if (firebaseStorageEmulatorHost.match(/https?:\/\//)) {
+                throw new error_1.FirebaseError({
+                    code: 'storage/invalid-emulator-host',
+                    message: 'FIREBASE_STORAGE_EMULATOR_HOST should not contain a protocol (http or https).',
+                });
+            }
+            process.env.STORAGE_EMULATOR_HOST = "http://" + process.env.FIREBASE_STORAGE_EMULATOR_HOST;
+        }
         var storage;
         try {
             storage = require('@google-cloud/storage').Storage;
@@ -82,9 +92,9 @@ var Storage = /** @class */ (function () {
     /**
      * Gets a reference to a Cloud Storage bucket.
      *
-     * @param name Optional name of the bucket to be retrieved. If name is not specified,
+     * @param name - Optional name of the bucket to be retrieved. If name is not specified,
      * retrieves a reference to the default bucket.
-     * @returns A [Bucket](https://cloud.google.com/nodejs/docs/reference/storage/latest/Bucket)
+     * @returns A {@link https://cloud.google.com/nodejs/docs/reference/storage/latest/Bucket | Bucket}
      * instance as defined in the `@google-cloud/storage` package.
      */
     Storage.prototype.bucket = function (name) {