firebase-admin 9.100.0-alpha.0 → 10.0.2

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2021 Google Inc.
  *
@@ -26,12 +26,12 @@ import { DecodedIdToken as TDecodedIdToken } from './token-verifier';
 import { HashAlgorithmType as THashAlgorithmType, UserImportOptions as TUserImportOptions, UserImportRecord as TUserImportRecord, UserImportResult as TUserImportResult, UserMetadataRequest as TUserMetadataRequest, UserProviderRequest as TUserProviderRequest } from './user-import-builder';
 import { MultiFactorInfo as TMultiFactorInfo, MultiFactorSettings as TMultiFactorSettings, PhoneMultiFactorInfo as TPhoneMultiFactorInfo, UserInfo as TUserInfo, UserMetadata as TUserMetadata, UserRecord as TUserRecord } from './user-record';
 /**
- * Gets the {@link auth.Auth `Auth`} service for the default app or a
+ * Gets the {@link firebase-admin.auth#Auth} service for the default app or a
  * given app.
  *
  * `admin.auth()` can be called with no arguments to access the default app's
- * {@link auth.Auth `Auth`} service or as `admin.auth(app)` to access the
- * {@link auth.Auth `Auth`} service associated with a specific app.
+ * {@link firebase-admin.auth#Auth} service or as `admin.auth(app)` to access the
+ * {@link firebase-admin.auth#Auth} service associated with a specific app.
  *
  * @example
  * ```javascript
@@ -48,55 +48,208 @@ import { MultiFactorInfo as TMultiFactorInfo, MultiFactorSettings as TMultiFacto
  */
 export declare function auth(app?: App): auth.Auth;
 export declare namespace auth {
+    /**
+     * Type alias to {@link firebase-admin.auth#ActionCodeSettings}.
+     */
     type ActionCodeSettings = TActionCodeSettings;
+    /**
+     * Type alias to {@link firebase-admin.auth#Auth}.
+     */
     type Auth = TAuth;
+    /**
+     * Type alias to {@link firebase-admin.auth#AuthFactorType}.
+     */
     type AuthFactorType = TAuthFactorType;
+    /**
+     * Type alias to {@link firebase-admin.auth#AuthProviderConfig}.
+     */
     type AuthProviderConfig = TAuthProviderConfig;
+    /**
+     * Type alias to {@link firebase-admin.auth#AuthProviderConfigFilter}.
+     */
     type AuthProviderConfigFilter = TAuthProviderConfigFilter;
+    /**
+     * Type alias to {@link firebase-admin.auth#BaseAuth}.
+     */
     type BaseAuth = TBaseAuth;
+    /**
+     * Type alias to {@link firebase-admin.auth#CreateMultiFactorInfoRequest}.
+     */
     type CreateMultiFactorInfoRequest = TCreateMultiFactorInfoRequest;
+    /**
+     * Type alias to {@link firebase-admin.auth#CreatePhoneMultiFactorInfoRequest}.
+     */
     type CreatePhoneMultiFactorInfoRequest = TCreatePhoneMultiFactorInfoRequest;
+    /**
+     * Type alias to {@link firebase-admin.auth#CreateRequest}.
+     */
     type CreateRequest = TCreateRequest;
+    /**
+     * Type alias to {@link firebase-admin.auth#CreateTenantRequest}.
+     */
     type CreateTenantRequest = TCreateTenantRequest;
+    /**
+     * Type alias to {@link firebase-admin.auth#DecodedIdToken}.
+     */
     type DecodedIdToken = TDecodedIdToken;
+    /**
+     * Type alias to {@link firebase-admin.auth#DeleteUsersResult}.
+     */
     type DeleteUsersResult = TDeleteUsersResult;
+    /**
+     * Type alias to {@link firebase-admin.auth#EmailIdentifier}.
+     */
     type EmailIdentifier = TEmailIdentifier;
+    /**
+     * Type alias to {@link firebase-admin.auth#EmailSignInProviderConfig}.
+     */
     type EmailSignInProviderConfig = TEmailSignInProviderConfig;
+    /**
+     * Type alias to {@link firebase-admin.auth#GetUsersResult}.
+     */
     type GetUsersResult = TGetUsersResult;
+    /**
+     * Type alias to {@link firebase-admin.auth#HashAlgorithmType}.
+     */
     type HashAlgorithmType = THashAlgorithmType;
+    /**
+     * Type alias to {@link firebase-admin.auth#ListProviderConfigResults}.
+     */
     type ListProviderConfigResults = TListProviderConfigResults;
+    /**
+     * Type alias to {@link firebase-admin.auth#ListTenantsResult}.
+     */
     type ListTenantsResult = TListTenantsResult;
+    /**
+     * Type alias to {@link firebase-admin.auth#ListUsersResult}.
+     */
     type ListUsersResult = TListUsersResult;
+    /**
+     * Type alias to {@link firebase-admin.auth#MultiFactorCreateSettings}.
+     */
     type MultiFactorCreateSettings = TMultiFactorCreateSettings;
+    /**
+     * Type alias to {@link firebase-admin.auth#MultiFactorConfig}.
+     */
     type MultiFactorConfig = TMultiFactorConfig;
+    /**
+     * Type alias to {@link firebase-admin.auth#MultiFactorConfigState}.
+     */
     type MultiFactorConfigState = TMultiFactorConfigState;
+    /**
+     * Type alias to {@link firebase-admin.auth#MultiFactorInfo}.
+     */
     type MultiFactorInfo = TMultiFactorInfo;
+    /**
+     * Type alias to {@link firebase-admin.auth#MultiFactorUpdateSettings}.
+     */
     type MultiFactorUpdateSettings = TMultiFactorUpdateSettings;
+    /**
+     * Type alias to {@link firebase-admin.auth#MultiFactorSettings}.
+     */
     type MultiFactorSettings = TMultiFactorSettings;
+    /**
+     * Type alias to {@link firebase-admin.auth#OIDCAuthProviderConfig}.
+     */
     type OIDCAuthProviderConfig = TOIDCAuthProviderConfig;
+    /**
+     * Type alias to {@link firebase-admin.auth#OIDCUpdateAuthProviderRequest}.
+     */
     type OIDCUpdateAuthProviderRequest = TOIDCUpdateAuthProviderRequest;
+    /**
+     * Type alias to {@link firebase-admin.auth#PhoneIdentifier}.
+     */
     type PhoneIdentifier = TPhoneIdentifier;
+    /**
+     * Type alias to {@link firebase-admin.auth#PhoneMultiFactorInfo}.
+     */
     type PhoneMultiFactorInfo = TPhoneMultiFactorInfo;
+    /**
+     * Type alias to {@link firebase-admin.auth#ProviderIdentifier}.
+     */
     type ProviderIdentifier = TProviderIdentifier;
+    /**
+     * Type alias to {@link firebase-admin.auth#SAMLAuthProviderConfig}.
+     */
     type SAMLAuthProviderConfig = TSAMLAuthProviderConfig;
+    /**
+     * Type alias to {@link firebase-admin.auth#SAMLUpdateAuthProviderRequest}.
+     */
     type SAMLUpdateAuthProviderRequest = TSAMLUpdateAuthProviderRequest;
+    /**
+     * Type alias to {@link firebase-admin.auth#SessionCookieOptions}.
+     */
     type SessionCookieOptions = TSessionCookieOptions;
+    /**
+     * Type alias to {@link firebase-admin.auth#Tenant}.
+     */
     type Tenant = TTenant;
+    /**
+     * Type alias to {@link firebase-admin.auth#TenantAwareAuth}.
+     */
     type TenantAwareAuth = TTenantAwareAuth;
+    /**
+     * Type alias to {@link firebase-admin.auth#TenantManager}.
+     */
     type TenantManager = TTenantManager;
+    /**
+     * Type alias to {@link firebase-admin.auth#UidIdentifier}.
+     */
     type UidIdentifier = TUidIdentifier;
+    /**
+     * Type alias to {@link firebase-admin.auth#UpdateAuthProviderRequest}.
+     */
     type UpdateAuthProviderRequest = TUpdateAuthProviderRequest;
+    /**
+     * Type alias to {@link firebase-admin.auth#UpdateMultiFactorInfoRequest}.
+     */
     type UpdateMultiFactorInfoRequest = TUpdateMultiFactorInfoRequest;
+    /**
+     * Type alias to {@link firebase-admin.auth#UpdatePhoneMultiFactorInfoRequest}.
+     */
     type UpdatePhoneMultiFactorInfoRequest = TUpdatePhoneMultiFactorInfoRequest;
+    /**
+     * Type alias to {@link firebase-admin.auth#UpdateRequest}.
+     */
     type UpdateRequest = TUpdateRequest;
+    /**
+     * Type alias to {@link firebase-admin.auth#UpdateTenantRequest}.
+     */
     type UpdateTenantRequest = TUpdateTenantRequest;
+    /**
+     * Type alias to {@link firebase-admin.auth#UserIdentifier}.
+     */
     type UserIdentifier = TUserIdentifier;
+    /**
+     * Type alias to {@link firebase-admin.auth#UserImportOptions}.
+     */
     type UserImportOptions = TUserImportOptions;
+    /**
+     * Type alias to {@link firebase-admin.auth#UserImportRecord}.
+     */
     type UserImportRecord = TUserImportRecord;
+    /**
+     * Type alias to {@link firebase-admin.auth#UserImportResult}.
+     */
     type UserImportResult = TUserImportResult;
+    /**
+     * Type alias to {@link firebase-admin.auth#UserInfo}.
+     */
     type UserInfo = TUserInfo;
+    /**
+     * Type alias to {@link firebase-admin.auth#UserMetadata}.
+     */
     type UserMetadata = TUserMetadata;
+    /**
+     * Type alias to {@link firebase-admin.auth#UserMetadataRequest}.
+     */
     type UserMetadataRequest = TUserMetadataRequest;
+    /**
+     * Type alias to {@link firebase-admin.auth#UserProviderRequest}.
+     */
     type UserProviderRequest = TUserProviderRequest;
+    /**
+     * Type alias to {@link firebase-admin.auth#UserRecord}.
+     */
     type UserRecord = TUserRecord;
 }

package/lib/auth/auth-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/auth/auth.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2017 Google Inc.
@@ -28,11 +28,13 @@ export declare class Auth extends BaseAuth {
     /**
      * Returns the app associated with this Auth instance.
      *
-     * @return The app associated with this Auth instance.
+     * @returns The app associated with this Auth instance.
      */
     get app(): App;
     /**
-     * @return The tenant manager instance associated with the current project.
+     * Returns the tenant manager instance associated with the current project.
+     *
+     * @returns The tenant manager instance associated with the current project.
      */
     tenantManager(): TenantManager;
 }

package/lib/auth/auth.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * @license
@@ -41,7 +41,7 @@ var base_auth_1 = require("./base-auth");
 var Auth = /** @class */ (function (_super) {
     __extends(Auth, _super);
     /**
-     * @param app The app for this Auth service.
+     * @param app - The app for this Auth service.
      * @constructor
      * @internal
      */
@@ -55,7 +55,7 @@ var Auth = /** @class */ (function (_super) {
         /**
          * Returns the app associated with this Auth instance.
          *
-         * @return The app associated with this Auth instance.
+         * @returns The app associated with this Auth instance.
          */
         get: function () {
             return this.app_;
@@ -64,7 +64,9 @@ var Auth = /** @class */ (function (_super) {
         configurable: true
     });
     /**
-     * @return The tenant manager instance associated with the current project.
+     * Returns the tenant manager instance associated with the current project.
+     *
+     * @returns The tenant manager instance associated with the current project.
      */
     Auth.prototype.tenantManager = function () {
         return this.tenantManager_;