firebase-admin 9.12.0 → 10.0.0

package/lib/auth/auth-api-request.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.0 */
 "use strict";
 /*!
  * @license
@@ -33,14 +33,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useEmulator = exports.TenantAwareAuthRequestHandler = exports.AuthRequestHandler = exports.AbstractAuthRequestHandler = exports.FIREBASE_AUTH_SIGN_UP_NEW_USER = exports.FIREBASE_AUTH_SET_ACCOUNT_INFO = exports.FIREBASE_AUTH_BATCH_DELETE_ACCOUNTS = exports.FIREBASE_AUTH_DELETE_ACCOUNT = exports.FIREBASE_AUTH_GET_ACCOUNTS_INFO = exports.FIREBASE_AUTH_GET_ACCOUNT_INFO = exports.FIREBASE_AUTH_DOWNLOAD_ACCOUNT = exports.FIREBASE_AUTH_UPLOAD_ACCOUNT = exports.FIREBASE_AUTH_CREATE_SESSION_COOKIE = exports.EMAIL_ACTION_REQUEST_TYPES = exports.RESERVED_CLAIMS = void 0;
 var validator = require("../utils/validator");
 var deep_copy_1 = require("../utils/deep-copy");
-var identifier_1 = require("./identifier");
 var error_1 = require("../utils/error");
 var api_request_1 = require("../utils/api-request");
-var user_import_builder_1 = require("./user-import-builder");
 var utils = require("../utils/index");
+var user_import_builder_1 = require("./user-import-builder");
 var action_code_settings_builder_1 = require("./action-code-settings-builder");
-var auth_config_1 = require("./auth-config");
 var tenant_1 = require("./tenant");
+var identifier_1 = require("./identifier");
+var auth_config_1 = require("./auth-config");
 /** Firebase Auth request header. */
 var FIREBASE_AUTH_HEADER = {
     'X-Client-Version': "Node/Admin/" + utils.getSdkVersion(),
@@ -96,8 +96,8 @@ var AuthResourceUrlBuilder = /** @class */ (function () {
     /**
      * The resource URL builder constructor.
      *
-     * @param {string} projectId The resource project ID.
-     * @param {string} version The endpoint API version.
+     * @param projectId - The resource project ID.
+     * @param version - The endpoint API version.
      * @constructor
      */
     function AuthResourceUrlBuilder(app, version) {
@@ -116,10 +116,10 @@ var AuthResourceUrlBuilder = /** @class */ (function () {
     /**
      * Returns the resource URL corresponding to the provided parameters.
      *
-     * @param {string=} api The backend API name.
-     * @param {object=} params The optional additional parameters to substitute in the
+     * @param api - The backend API name.
+     * @param params - The optional additional parameters to substitute in the
      *     URL path.
-     * @return {Promise<string>} The corresponding resource URL.
+     * @returns The corresponding resource URL.
      */
     AuthResourceUrlBuilder.prototype.getUrl = function (api, params) {
         var _this = this;
@@ -159,9 +159,9 @@ var TenantAwareAuthResourceUrlBuilder = /** @class */ (function (_super) {
     /**
      * The tenant aware resource URL builder constructor.
      *
-     * @param {string} projectId The resource project ID.
-     * @param {string} version The endpoint API version.
-     * @param {string} tenantId The tenant ID.
+     * @param projectId - The resource project ID.
+     * @param version - The endpoint API version.
+     * @param tenantId - The tenant ID.
      * @constructor
      */
     function TenantAwareAuthResourceUrlBuilder(app, version, tenantId) {
@@ -182,10 +182,10 @@ var TenantAwareAuthResourceUrlBuilder = /** @class */ (function (_super) {
     /**
      * Returns the resource URL corresponding to the provided parameters.
      *
-     * @param {string=} api The backend API name.
-     * @param {object=} params The optional additional parameters to substitute in the
+     * @param api - The backend API name.
+     * @param params - The optional additional parameters to substitute in the
      *     URL path.
-     * @return {Promise<string>} The corresponding resource URL.
+     * @returns The corresponding resource URL.
      */
     TenantAwareAuthResourceUrlBuilder.prototype.getUrl = function (api, params) {
         var _this = this;
@@ -218,7 +218,7 @@ var AuthHttpClient = /** @class */ (function (_super) {
  * are removed from the original request. If an invalid field is passed
  * an error is thrown.
  *
- * @param request The AuthFactorInfo request object.
+ * @param request - The AuthFactorInfo request object.
  */
 function validateAuthFactorInfo(request) {
     var validKeys = {
@@ -269,7 +269,7 @@ function validateAuthFactorInfo(request) {
  * are removed from the original request. If an invalid field is passed
  * an error is thrown.
  *
- * @param {any} request The providerUserInfo request object.
+ * @param request - The providerUserInfo request object.
  */
 function validateProviderUserInfo(request) {
     var validKeys = {
@@ -314,8 +314,8 @@ function validateProviderUserInfo(request) {
  * are removed from the original request. If an invalid field is passed
  * an error is thrown.
  *
- * @param request The create/edit request object.
- * @param writeOperationType The write operation type.
+ * @param request - The create/edit request object.
+ * @param writeOperationType - The write operation type.
  */
 function validateCreateEditRequest(request, writeOperationType) {
     var uploadAccountRequest = writeOperationType === WriteOperationType.Upload;
@@ -505,7 +505,11 @@ function validateCreateEditRequest(request, writeOperationType) {
         });
     }
 }
-/** Instantiates the createSessionCookie endpoint settings. */
+/**
+ * Instantiates the createSessionCookie endpoint settings.
+ *
+ * @internal
+ */
 exports.FIREBASE_AUTH_CREATE_SESSION_COOKIE = new api_request_1.ApiSettings(':createSessionCookie', 'POST')
     // Set request validator.
     .setRequestValidator(function (request) {
@@ -527,9 +531,17 @@ exports.FIREBASE_AUTH_CREATE_SESSION_COOKIE = new api_request_1.ApiSettings(':cr
         throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INTERNAL_ERROR);
     }
 });
-/** Instantiates the uploadAccount endpoint settings. */
+/**
+ * Instantiates the uploadAccount endpoint settings.
+ *
+ * @internal
+ */
 exports.FIREBASE_AUTH_UPLOAD_ACCOUNT = new api_request_1.ApiSettings('/accounts:batchCreate', 'POST');
-/** Instantiates the downloadAccount endpoint settings. */
+/**
+ * Instantiates the downloadAccount endpoint settings.
+ *
+ * @internal
+ */
 exports.FIREBASE_AUTH_DOWNLOAD_ACCOUNT = new api_request_1.ApiSettings('/accounts:batchGet', 'GET')
     // Set request validator.
     .setRequestValidator(function (request) {
@@ -546,7 +558,11 @@ exports.FIREBASE_AUTH_DOWNLOAD_ACCOUNT = new api_request_1.ApiSettings('/account
             (MAX_DOWNLOAD_ACCOUNT_PAGE_SIZE + "."));
     }
 });
-/** Instantiates the getAccountInfo endpoint settings. */
+/**
+ * Instantiates the getAccountInfo endpoint settings.
+ *
+ * @internal
+ */
 exports.FIREBASE_AUTH_GET_ACCOUNT_INFO = new api_request_1.ApiSettings('/accounts:lookup', 'POST')
     // Set request validator.
     .setRequestValidator(function (request) {
@@ -563,6 +579,8 @@ exports.FIREBASE_AUTH_GET_ACCOUNT_INFO = new api_request_1.ApiSettings('/account
 /**
  * Instantiates the getAccountInfo endpoint settings for use when fetching info
  * for multiple accounts.
+ *
+ * @internal
  */
 exports.FIREBASE_AUTH_GET_ACCOUNTS_INFO = new api_request_1.ApiSettings('/accounts:lookup', 'POST')
     // Set request validator.
@@ -571,7 +589,11 @@ exports.FIREBASE_AUTH_GET_ACCOUNTS_INFO = new api_request_1.ApiSettings('/accoun
         throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INTERNAL_ERROR, 'INTERNAL ASSERT FAILED: Server request is missing user identifier');
     }
 });
-/** Instantiates the deleteAccount endpoint settings. */
+/**
+ * Instantiates the deleteAccount endpoint settings.
+ *
+ * @internal
+ */
 exports.FIREBASE_AUTH_DELETE_ACCOUNT = new api_request_1.ApiSettings('/accounts:delete', 'POST')
     // Set request validator.
     .setRequestValidator(function (request) {
@@ -579,6 +601,9 @@ exports.FIREBASE_AUTH_DELETE_ACCOUNT = new api_request_1.ApiSettings('/accounts:
         throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INTERNAL_ERROR, 'INTERNAL ASSERT FAILED: Server request is missing user identifier');
     }
 });
+/**
+ * @internal
+ */
 exports.FIREBASE_AUTH_BATCH_DELETE_ACCOUNTS = new api_request_1.ApiSettings('/accounts:batchDelete', 'POST')
     .setRequestValidator(function (request) {
     if (!request.localIds) {
@@ -600,7 +625,11 @@ exports.FIREBASE_AUTH_BATCH_DELETE_ACCOUNTS = new api_request_1.ApiSettings('/ac
         // Allow the (error) message to be missing/undef.
     });
 });
-/** Instantiates the setAccountInfo endpoint settings for updating existing accounts. */
+/**
+ * Instantiates the setAccountInfo endpoint settings for updating existing accounts.
+ *
+ * @internal
+ */
 exports.FIREBASE_AUTH_SET_ACCOUNT_INFO = new api_request_1.ApiSettings('/accounts:update', 'POST')
     // Set request validator.
     .setRequestValidator(function (request) {
@@ -624,6 +653,8 @@ exports.FIREBASE_AUTH_SET_ACCOUNT_INFO = new api_request_1.ApiSettings('/account
 /**
  * Instantiates the signupNewUser endpoint settings for creating a new user with or without
  * uid being specified. The backend will create a new one if not provided and return it.
+ *
+ * @internal
  */
 exports.FIREBASE_AUTH_SIGN_UP_NEW_USER = new api_request_1.ApiSettings('/accounts', 'POST')
     // Set request validator.
@@ -666,7 +697,11 @@ var FIREBASE_AUTH_GET_OOB_CODE = new api_request_1.ApiSettings('/accounts:sendOo
         throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INTERNAL_ERROR, 'INTERNAL ASSERT FAILED: Unable to create the email action link');
     }
 });
-/** Instantiates the retrieve OIDC configuration endpoint settings. */
+/**
+ * Instantiates the retrieve OIDC configuration endpoint settings.
+ *
+ * @internal
+ */
 var GET_OAUTH_IDP_CONFIG = new api_request_1.ApiSettings('/oauthIdpConfigs/{providerId}', 'GET')
     // Set response validator.
     .setResponseValidator(function (response) {
@@ -675,9 +710,17 @@ var GET_OAUTH_IDP_CONFIG = new api_request_1.ApiSettings('/oauthIdpConfigs/{prov
         throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INTERNAL_ERROR, 'INTERNAL ASSERT FAILED: Unable to get OIDC configuration');
     }
 });
-/** Instantiates the delete OIDC configuration endpoint settings. */
+/**
+ * Instantiates the delete OIDC configuration endpoint settings.
+ *
+ * @internal
+ */
 var DELETE_OAUTH_IDP_CONFIG = new api_request_1.ApiSettings('/oauthIdpConfigs/{providerId}', 'DELETE');
-/** Instantiates the create OIDC configuration endpoint settings. */
+/**
+ * Instantiates the create OIDC configuration endpoint settings.
+ *
+ * @internal
+ */
 var CREATE_OAUTH_IDP_CONFIG = new api_request_1.ApiSettings('/oauthIdpConfigs?oauthIdpConfigId={providerId}', 'POST')
     // Set response validator.
     .setResponseValidator(function (response) {
@@ -686,7 +729,11 @@ var CREATE_OAUTH_IDP_CONFIG = new api_request_1.ApiSettings('/oauthIdpConfigs?oa
         throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INTERNAL_ERROR, 'INTERNAL ASSERT FAILED: Unable to create new OIDC configuration');
     }
 });
-/** Instantiates the update OIDC configuration endpoint settings. */
+/**
+ * Instantiates the update OIDC configuration endpoint settings.
+ *
+ * @internal
+ */
 var UPDATE_OAUTH_IDP_CONFIG = new api_request_1.ApiSettings('/oauthIdpConfigs/{providerId}?updateMask={updateMask}', 'PATCH')
     // Set response validator.
     .setResponseValidator(function (response) {
@@ -695,7 +742,11 @@ var UPDATE_OAUTH_IDP_CONFIG = new api_request_1.ApiSettings('/oauthIdpConfigs/{p
         throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INTERNAL_ERROR, 'INTERNAL ASSERT FAILED: Unable to update OIDC configuration');
     }
 });
-/** Instantiates the list OIDC configuration endpoint settings. */
+/**
+ * Instantiates the list OIDC configuration endpoint settings.
+ *
+ * @internal
+ */
 var LIST_OAUTH_IDP_CONFIGS = new api_request_1.ApiSettings('/oauthIdpConfigs', 'GET')
     // Set request validator.
     .setRequestValidator(function (request) {
@@ -712,7 +763,11 @@ var LIST_OAUTH_IDP_CONFIGS = new api_request_1.ApiSettings('/oauthIdpConfigs', '
             (MAX_LIST_PROVIDER_CONFIGURATION_PAGE_SIZE + "."));
     }
 });
-/** Instantiates the retrieve SAML configuration endpoint settings. */
+/**
+ * Instantiates the retrieve SAML configuration endpoint settings.
+ *
+ * @internal
+ */
 var GET_INBOUND_SAML_CONFIG = new api_request_1.ApiSettings('/inboundSamlConfigs/{providerId}', 'GET')
     // Set response validator.
     .setResponseValidator(function (response) {
@@ -721,9 +776,17 @@ var GET_INBOUND_SAML_CONFIG = new api_request_1.ApiSettings('/inboundSamlConfigs
         throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INTERNAL_ERROR, 'INTERNAL ASSERT FAILED: Unable to get SAML configuration');
     }
 });
-/** Instantiates the delete SAML configuration endpoint settings. */
+/**
+ * Instantiates the delete SAML configuration endpoint settings.
+ *
+ * @internal
+ */
 var DELETE_INBOUND_SAML_CONFIG = new api_request_1.ApiSettings('/inboundSamlConfigs/{providerId}', 'DELETE');
-/** Instantiates the create SAML configuration endpoint settings. */
+/**
+ * Instantiates the create SAML configuration endpoint settings.
+ *
+ * @internal
+ */
 var CREATE_INBOUND_SAML_CONFIG = new api_request_1.ApiSettings('/inboundSamlConfigs?inboundSamlConfigId={providerId}', 'POST')
     // Set response validator.
     .setResponseValidator(function (response) {
@@ -732,7 +795,11 @@ var CREATE_INBOUND_SAML_CONFIG = new api_request_1.ApiSettings('/inboundSamlConf
         throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INTERNAL_ERROR, 'INTERNAL ASSERT FAILED: Unable to create new SAML configuration');
     }
 });
-/** Instantiates the update SAML configuration endpoint settings. */
+/**
+ * Instantiates the update SAML configuration endpoint settings.
+ *
+ * @internal
+ */
 var UPDATE_INBOUND_SAML_CONFIG = new api_request_1.ApiSettings('/inboundSamlConfigs/{providerId}?updateMask={updateMask}', 'PATCH')
     // Set response validator.
     .setResponseValidator(function (response) {
@@ -741,7 +808,11 @@ var UPDATE_INBOUND_SAML_CONFIG = new api_request_1.ApiSettings('/inboundSamlConf
         throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INTERNAL_ERROR, 'INTERNAL ASSERT FAILED: Unable to update SAML configuration');
     }
 });
-/** Instantiates the list SAML configuration endpoint settings. */
+/**
+ * Instantiates the list SAML configuration endpoint settings.
+ *
+ * @internal
+ */
 var LIST_INBOUND_SAML_CONFIGS = new api_request_1.ApiSettings('/inboundSamlConfigs', 'GET')
     // Set request validator.
     .setRequestValidator(function (request) {
@@ -760,10 +831,12 @@ var LIST_INBOUND_SAML_CONFIGS = new api_request_1.ApiSettings('/inboundSamlConfi
 });
 /**
  * Class that provides the mechanism to send requests to the Firebase Auth backend endpoints.
+ *
+ * @internal
  */
 var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
-     * @param {FirebaseApp} app The app used to fetch access tokens to sign API requests.
+     * @param app - The app used to fetch access tokens to sign API requests.
      * @constructor
      */
     function AbstractAuthRequestHandler(app) {
@@ -774,8 +847,8 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
         this.httpClient = new AuthHttpClient(app);
     }
     /**
-     * @param {any} response The response to check for errors.
-     * @return {string|null} The error code if present; null otherwise.
+     * @param response - The response to check for errors.
+     * @returns The error code if present; null otherwise.
      */
     AbstractAuthRequestHandler.getErrorCode = function (response) {
         return (validator.isNonNullObject(response) && response.error && response.error.message) || null;
@@ -822,10 +895,10 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
      * session management (set as a server side session cookie with custom cookie policy).
      * The session cookie JWT will have the same payload claims as the provided ID token.
      *
-     * @param {string} idToken The Firebase ID token to exchange for a session cookie.
-     * @param {number} expiresIn The session cookie duration in milliseconds.
+     * @param idToken - The Firebase ID token to exchange for a session cookie.
+     * @param expiresIn - The session cookie duration in milliseconds.
      *
-     * @return {Promise<string>} A promise that resolves on success with the created session cookie.
+     * @returns A promise that resolves on success with the created session cookie.
      */
     AbstractAuthRequestHandler.prototype.createSessionCookie = function (idToken, expiresIn) {
         var request = {
@@ -839,8 +912,8 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Looks up a user by uid.
      *
-     * @param {string} uid The uid of the user to lookup.
-     * @return {Promise<object>} A promise that resolves with the user information.
+     * @param uid - The uid of the user to lookup.
+     * @returns A promise that resolves with the user information.
      */
     AbstractAuthRequestHandler.prototype.getAccountInfoByUid = function (uid) {
         if (!validator.isUid(uid)) {
@@ -854,8 +927,8 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Looks up a user by email.
      *
-     * @param {string} email The email of the user to lookup.
-     * @return {Promise<object>} A promise that resolves with the user information.
+     * @param email - The email of the user to lookup.
+     * @returns A promise that resolves with the user information.
      */
     AbstractAuthRequestHandler.prototype.getAccountInfoByEmail = function (email) {
         if (!validator.isEmail(email)) {
@@ -869,8 +942,8 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Looks up a user by phone number.
      *
-     * @param {string} phoneNumber The phone number of the user to lookup.
-     * @return {Promise<object>} A promise that resolves with the user information.
+     * @param phoneNumber - The phone number of the user to lookup.
+     * @returns A promise that resolves with the user information.
      */
     AbstractAuthRequestHandler.prototype.getAccountInfoByPhoneNumber = function (phoneNumber) {
         if (!validator.isPhoneNumber(phoneNumber)) {
@@ -896,9 +969,9 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Looks up multiple users by their identifiers (uid, email, etc).
      *
-     * @param {UserIdentifier[]} identifiers The identifiers indicating the users
+     * @param identifiers - The identifiers indicating the users
      *     to be looked up. Must have <= 100 entries.
-     * @param {Promise<object>} A promise that resolves with the set of successfully
+     * @param A - promise that resolves with the set of successfully
      *     looked up users. Possibly empty if no users were looked up.
      */
     AbstractAuthRequestHandler.prototype.getAccountInfoByIdentifiers = function (identifiers) {
@@ -933,12 +1006,12 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
      * Exports the users (single batch only) with a size of maxResults and starting from
      * the offset as specified by pageToken.
      *
-     * @param {number=} maxResults The page size, 1000 if undefined. This is also the maximum
+     * @param maxResults - The page size, 1000 if undefined. This is also the maximum
      *     allowed limit.
-     * @param {string=} pageToken The next page token. If not specified, returns users starting
+     * @param pageToken - The next page token. If not specified, returns users starting
      *     without any offset. Users are returned in the order they were created from oldest to
      *     newest, relative to the page token offset.
-     * @return {Promise<object>} A promise that resolves with the current batch of downloaded
+     * @returns A promise that resolves with the current batch of downloaded
      *     users and the next page token if available. For the last page, an empty list of users
      *     and no page token are returned.
      */
@@ -968,10 +1041,10 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
      * At most, 1000 users are allowed to be imported one at a time.
      * When importing a list of password users, UserImportOptions are required to be specified.
      *
-     * @param {UserImportRecord[]} users The list of user records to import to Firebase Auth.
-     * @param {UserImportOptions=} options The user import options, required when the users provided
+     * @param users - The list of user records to import to Firebase Auth.
+     * @param options - The user import options, required when the users provided
      *     include password credentials.
-     * @return {Promise<UserImportResult>} A promise that resolves when the operation completes
+     * @returns A promise that resolves when the operation completes
      *     with the result of the import. This includes the number of successful imports, the number
      *     of failed uploads and their corresponding errors.
      */
@@ -1005,8 +1078,8 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Deletes an account identified by a uid.
      *
-     * @param {string} uid The uid of the user to delete.
-     * @return {Promise<object>} A promise that resolves when the user is deleted.
+     * @param uid - The uid of the user to delete.
+     * @returns A promise that resolves when the user is deleted.
      */
     AbstractAuthRequestHandler.prototype.deleteAccount = function (uid) {
         if (!validator.isUid(uid)) {
@@ -1039,9 +1112,9 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Sets additional developer claims on an existing user identified by provided UID.
      *
-     * @param {string} uid The user to edit.
-     * @param {object} customUserClaims The developer claims to set.
-     * @return {Promise<string>} A promise that resolves when the operation completes
+     * @param uid - The user to edit.
+     * @param customUserClaims - The developer claims to set.
+     * @returns A promise that resolves when the operation completes
      *     with the user id that was edited.
      */
     AbstractAuthRequestHandler.prototype.setCustomUserClaims = function (uid, customUserClaims) {
@@ -1069,9 +1142,9 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Edits an existing user.
      *
-     * @param {string} uid The user to edit.
-     * @param {object} properties The properties to set on the user.
-     * @return {Promise<string>} A promise that resolves when the operation completes
+     * @param uid - The user to edit.
+     * @param properties - The properties to set on the user.
+     * @returns A promise that resolves when the operation completes
      *     with the user id that was edited.
      */
     AbstractAuthRequestHandler.prototype.updateExistingAccount = function (uid, properties) {
@@ -1196,8 +1269,8 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
      * the same second as the revocation will still be valid. If there is a chance that a token
      * was minted in the last second, delay for 1 second before revoking.
      *
-     * @param {string} uid The user whose tokens are to be revoked.
-     * @return {Promise<string>} A promise that resolves when the operation completes
+     * @param uid - The user whose tokens are to be revoked.
+     * @returns A promise that resolves when the operation completes
      *     successfully with the user id of the corresponding user.
      */
     AbstractAuthRequestHandler.prototype.revokeRefreshTokens = function (uid) {
@@ -1218,8 +1291,8 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Create a new user with the properties supplied.
      *
-     * @param {object} properties The properties to set on the user.
-     * @return {Promise<string>} A promise that resolves when the operation completes
+     * @param properties - The properties to set on the user.
+     * @returns A promise that resolves when the operation completes
      *     with the user id that was created.
      */
     AbstractAuthRequestHandler.prototype.createNewAccount = function (properties) {
@@ -1271,13 +1344,13 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
      * Generates the out of band email action link for the email specified using the action code settings provided.
      * Returns a promise that resolves with the generated link.
      *
-     * @param {string} requestType The request type. This could be either used for password reset,
+     * @param requestType - The request type. This could be either used for password reset,
      *     email verification, email link sign-in.
-     * @param {string} email The email of the user the link is being sent to.
-     * @param {ActionCodeSettings=} actionCodeSettings The optional action code setings which defines whether
+     * @param email - The email of the user the link is being sent to.
+     * @param actionCodeSettings - The optional action code setings which defines whether
      *     the link is to be handled by a mobile app and the additional state information to be passed in the
      *     deep link, etc. Required when requestType == 'EMAIL_SIGNIN'
-     * @return {Promise<string>} A promise that resolves with the email action link.
+     * @returns A promise that resolves with the email action link.
      */
     AbstractAuthRequestHandler.prototype.getEmailActionLink = function (requestType, email, actionCodeSettings) {
         var request = { requestType: requestType, email: email, returnOobLink: true };
@@ -1304,8 +1377,8 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Looks up an OIDC provider configuration by provider ID.
      *
-     * @param {string} providerId The provider identifier of the configuration to lookup.
-     * @return {Promise<OIDCConfigServerResponse>} A promise that resolves with the provider configuration information.
+     * @param providerId - The provider identifier of the configuration to lookup.
+     * @returns A promise that resolves with the provider configuration information.
      */
     AbstractAuthRequestHandler.prototype.getOAuthIdpConfig = function (providerId) {
         if (!auth_config_1.OIDCConfig.isProviderId(providerId)) {
@@ -1317,12 +1390,12 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
      * Lists the OIDC configurations (single batch only) with a size of maxResults and starting from
      * the offset as specified by pageToken.
      *
-     * @param {number=} maxResults The page size, 100 if undefined. This is also the maximum
+     * @param maxResults - The page size, 100 if undefined. This is also the maximum
      *     allowed limit.
-     * @param {string=} pageToken The next page token. If not specified, returns OIDC configurations
+     * @param pageToken - The next page token. If not specified, returns OIDC configurations
      *     without any offset. Configurations are returned in the order they were created from oldest to
      *     newest, relative to the page token offset.
-     * @return {Promise<object>} A promise that resolves with the current batch of downloaded
+     * @returns A promise that resolves with the current batch of downloaded
      *     OIDC configurations and the next page token if available. For the last page, an empty list of provider
      *     configuration and no page token are returned.
      */
@@ -1347,8 +1420,8 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Deletes an OIDC configuration identified by a providerId.
      *
-     * @param {string} providerId The identifier of the OIDC configuration to delete.
-     * @return {Promise<void>} A promise that resolves when the OIDC provider is deleted.
+     * @param providerId - The identifier of the OIDC configuration to delete.
+     * @returns A promise that resolves when the OIDC provider is deleted.
      */
     AbstractAuthRequestHandler.prototype.deleteOAuthIdpConfig = function (providerId) {
         if (!auth_config_1.OIDCConfig.isProviderId(providerId)) {
@@ -1362,8 +1435,8 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Creates a new OIDC provider configuration with the properties provided.
      *
-     * @param {AuthProviderConfig} options The properties to set on the new OIDC provider configuration to be created.
-     * @return {Promise<OIDCConfigServerResponse>} A promise that resolves with the newly created OIDC
+     * @param options - The properties to set on the new OIDC provider configuration to be created.
+     * @returns A promise that resolves with the newly created OIDC
      *     configuration.
      */
     AbstractAuthRequestHandler.prototype.createOAuthIdpConfig = function (options) {
@@ -1387,9 +1460,9 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Updates an existing OIDC provider configuration with the properties provided.
      *
-     * @param {string} providerId The provider identifier of the OIDC configuration to update.
-     * @param {OIDCUpdateAuthProviderRequest} options The properties to update on the existing configuration.
-     * @return {Promise<OIDCConfigServerResponse>} A promise that resolves with the modified provider
+     * @param providerId - The provider identifier of the OIDC configuration to update.
+     * @param options - The properties to update on the existing configuration.
+     * @returns A promise that resolves with the modified provider
      *     configuration.
      */
     AbstractAuthRequestHandler.prototype.updateOAuthIdpConfig = function (providerId, options) {
@@ -1416,8 +1489,8 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Looks up an SAML provider configuration by provider ID.
      *
-     * @param {string} providerId The provider identifier of the configuration to lookup.
-     * @return {Promise<SAMLConfigServerResponse>} A promise that resolves with the provider configuration information.
+     * @param providerId - The provider identifier of the configuration to lookup.
+     * @returns A promise that resolves with the provider configuration information.
      */
     AbstractAuthRequestHandler.prototype.getInboundSamlConfig = function (providerId) {
         if (!auth_config_1.SAMLConfig.isProviderId(providerId)) {
@@ -1429,12 +1502,12 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
      * Lists the SAML configurations (single batch only) with a size of maxResults and starting from
      * the offset as specified by pageToken.
      *
-     * @param {number=} maxResults The page size, 100 if undefined. This is also the maximum
+     * @param maxResults - The page size, 100 if undefined. This is also the maximum
      *     allowed limit.
-     * @param {string=} pageToken The next page token. If not specified, returns SAML configurations starting
+     * @param pageToken - The next page token. If not specified, returns SAML configurations starting
      *     without any offset. Configurations are returned in the order they were created from oldest to
      *     newest, relative to the page token offset.
-     * @return {Promise<object>} A promise that resolves with the current batch of downloaded
+     * @returns A promise that resolves with the current batch of downloaded
      *     SAML configurations and the next page token if available. For the last page, an empty list of provider
      *     configuration and no page token are returned.
      */
@@ -1459,8 +1532,8 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Deletes a SAML configuration identified by a providerId.
      *
-     * @param {string} providerId The identifier of the SAML configuration to delete.
-     * @return {Promise<void>} A promise that resolves when the SAML provider is deleted.
+     * @param providerId - The identifier of the SAML configuration to delete.
+     * @returns A promise that resolves when the SAML provider is deleted.
      */
     AbstractAuthRequestHandler.prototype.deleteInboundSamlConfig = function (providerId) {
         if (!auth_config_1.SAMLConfig.isProviderId(providerId)) {
@@ -1474,8 +1547,8 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Creates a new SAML provider configuration with the properties provided.
      *
-     * @param {AuthProviderConfig} options The properties to set on the new SAML provider configuration to be created.
-     * @return {Promise<SAMLConfigServerResponse>} A promise that resolves with the newly created SAML
+     * @param options - The properties to set on the new SAML provider configuration to be created.
+     * @returns A promise that resolves with the newly created SAML
      *     configuration.
      */
     AbstractAuthRequestHandler.prototype.createInboundSamlConfig = function (options) {
@@ -1499,9 +1572,9 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Updates an existing SAML provider configuration with the properties provided.
      *
-     * @param {string} providerId The provider identifier of the SAML configuration to update.
-     * @param {SAMLUpdateAuthProviderRequest} options The properties to update on the existing configuration.
-     * @return {Promise<SAMLConfigServerResponse>} A promise that resolves with the modified provider
+     * @param providerId - The provider identifier of the SAML configuration to update.
+     * @param options - The properties to update on the existing configuration.
+     * @returns A promise that resolves with the modified provider
      *     configuration.
      */
     AbstractAuthRequestHandler.prototype.updateInboundSamlConfig = function (providerId, options) {
@@ -1528,11 +1601,11 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
     /**
      * Invokes the request handler based on the API settings object passed.
      *
-     * @param {AuthResourceUrlBuilder} urlBuilder The URL builder for Auth endpoints.
-     * @param {ApiSettings} apiSettings The API endpoint settings to apply to request and response.
-     * @param {object} requestData The request data.
-     * @param {object=} additionalResourceParams Additional resource related params if needed.
-     * @return {Promise<object>} A promise that resolves with the response.
+     * @param urlBuilder - The URL builder for Auth endpoints.
+     * @param apiSettings - The API endpoint settings to apply to request and response.
+     * @param requestData - The request data.
+     * @param additionalResourceParams - Additional resource related params if needed.
+     * @returns A promise that resolves with the response.
      */
     AbstractAuthRequestHandler.prototype.invokeRequestHandler = function (urlBuilder, apiSettings, requestData, additionalResourceParams) {
         var _this = this;
@@ -1573,7 +1646,7 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
         });
     };
     /**
-     * @return {AuthResourceUrlBuilder} The current Auth user management resource URL builder.
+     * @returns The current Auth user management resource URL builder.
      */
     AbstractAuthRequestHandler.prototype.getAuthUrlBuilder = function () {
         if (!this.authUrlBuilder) {
@@ -1582,7 +1655,7 @@ var AbstractAuthRequestHandler = /** @class */ (function () {
         return this.authUrlBuilder;
     };
     /**
-     * @return {AuthResourceUrlBuilder} The current project config resource URL builder.
+     * @returns The current project config resource URL builder.
      */
     AbstractAuthRequestHandler.prototype.getProjectConfigUrlBuilder = function () {
         if (!this.projectConfigUrlBuilder) {
@@ -1651,7 +1724,7 @@ var AuthRequestHandler = /** @class */ (function (_super) {
     /**
      * The FirebaseAuthRequestHandler constructor used to initialize an instance using a FirebaseApp.
      *
-     * @param {FirebaseApp} app The app used to fetch access tokens to sign API requests.
+     * @param app - The app used to fetch access tokens to sign API requests.
      * @constructor.
      */
     function AuthRequestHandler(app) {
@@ -1660,13 +1733,13 @@ var AuthRequestHandler = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * @return {AuthResourceUrlBuilder} A new Auth user management resource URL builder instance.
+     * @returns A new Auth user management resource URL builder instance.
      */
     AuthRequestHandler.prototype.newAuthUrlBuilder = function () {
         return new AuthResourceUrlBuilder(this.app, 'v1');
     };
     /**
-     * @return {AuthResourceUrlBuilder} A new project config resource URL builder instance.
+     * @returns A new project config resource URL builder instance.
      */
     AuthRequestHandler.prototype.newProjectConfigUrlBuilder = function () {
         return new AuthResourceUrlBuilder(this.app, 'v2');
@@ -1674,8 +1747,8 @@ var AuthRequestHandler = /** @class */ (function (_super) {
     /**
      * Looks up a tenant by tenant ID.
      *
-     * @param {string} tenantId The tenant identifier of the tenant to lookup.
-     * @return {Promise<TenantServerResponse>} A promise that resolves with the tenant information.
+     * @param tenantId - The tenant identifier of the tenant to lookup.
+     * @returns A promise that resolves with the tenant information.
      */
     AuthRequestHandler.prototype.getTenant = function (tenantId) {
         if (!validator.isNonEmptyString(tenantId)) {
@@ -1690,12 +1763,12 @@ var AuthRequestHandler = /** @class */ (function (_super) {
      * Exports the tenants (single batch only) with a size of maxResults and starting from
      * the offset as specified by pageToken.
      *
-     * @param {number=} maxResults The page size, 1000 if undefined. This is also the maximum
+     * @param maxResults - The page size, 1000 if undefined. This is also the maximum
      *     allowed limit.
-     * @param {string=} pageToken The next page token. If not specified, returns tenants starting
+     * @param pageToken - The next page token. If not specified, returns tenants starting
      *     without any offset. Tenants are returned in the order they were created from oldest to
      *     newest, relative to the page token offset.
-     * @return {Promise<object>} A promise that resolves with the current batch of downloaded
+     * @returns A promise that resolves with the current batch of downloaded
      *     tenants and the next page token if available. For the last page, an empty list of tenants
      *     and no page token are returned.
      */
@@ -1721,8 +1794,8 @@ var AuthRequestHandler = /** @class */ (function (_super) {
     /**
      * Deletes a tenant identified by a tenantId.
      *
-     * @param {string} tenantId The identifier of the tenant to delete.
-     * @return {Promise<void>} A promise that resolves when the tenant is deleted.
+     * @param tenantId - The identifier of the tenant to delete.
+     * @returns A promise that resolves when the tenant is deleted.
      */
     AuthRequestHandler.prototype.deleteTenant = function (tenantId) {
         if (!validator.isNonEmptyString(tenantId)) {
@@ -1736,8 +1809,8 @@ var AuthRequestHandler = /** @class */ (function (_super) {
     /**
      * Creates a new tenant with the properties provided.
      *
-     * @param {TenantOptions} tenantOptions The properties to set on the new tenant to be created.
-     * @return {Promise<TenantServerResponse>} A promise that resolves with the newly created tenant object.
+     * @param tenantOptions - The properties to set on the new tenant to be created.
+     * @returns A promise that resolves with the newly created tenant object.
      */
     AuthRequestHandler.prototype.createTenant = function (tenantOptions) {
         try {
@@ -1755,9 +1828,9 @@ var AuthRequestHandler = /** @class */ (function (_super) {
     /**
      * Updates an existing tenant with the properties provided.
      *
-     * @param {string} tenantId The tenant identifier of the tenant to update.
-     * @param {TenantOptions} tenantOptions The properties to update on the existing tenant.
-     * @return {Promise<TenantServerResponse>} A promise that resolves with the modified tenant object.
+     * @param tenantId - The tenant identifier of the tenant to update.
+     * @param tenantOptions - The properties to update on the existing tenant.
+     * @returns A promise that resolves with the modified tenant object.
      */
     AuthRequestHandler.prototype.updateTenant = function (tenantId, tenantOptions) {
         if (!validator.isNonEmptyString(tenantId)) {
@@ -1792,8 +1865,8 @@ var TenantAwareAuthRequestHandler = /** @class */ (function (_super) {
      * The FirebaseTenantRequestHandler constructor used to initialize an instance using a
      * FirebaseApp and a tenant ID.
      *
-     * @param {FirebaseApp} app The app used to fetch access tokens to sign API requests.
-     * @param {string} tenantId The request handler's tenant ID.
+     * @param app - The app used to fetch access tokens to sign API requests.
+     * @param tenantId - The request handler's tenant ID.
      * @constructor
      */
     function TenantAwareAuthRequestHandler(app, tenantId) {
@@ -1802,13 +1875,13 @@ var TenantAwareAuthRequestHandler = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * @return {AuthResourceUrlBuilder} A new Auth user management resource URL builder instance.
+     * @returns A new Auth user management resource URL builder instance.
      */
     TenantAwareAuthRequestHandler.prototype.newAuthUrlBuilder = function () {
         return new TenantAwareAuthResourceUrlBuilder(this.app, 'v1', this.tenantId);
     };
     /**
-     * @return {AuthResourceUrlBuilder} A new project config resource URL builder instance.
+     * @returns A new project config resource URL builder instance.
      */
     TenantAwareAuthRequestHandler.prototype.newProjectConfigUrlBuilder = function () {
         return new TenantAwareAuthResourceUrlBuilder(this.app, 'v2', this.tenantId);
@@ -1822,10 +1895,10 @@ var TenantAwareAuthRequestHandler = /** @class */ (function (_super) {
      * Overrides the superclass methods by adding an additional check to match tenant IDs of
      * imported user records if present.
      *
-     * @param {UserImportRecord[]} users The list of user records to import to Firebase Auth.
-     * @param {UserImportOptions=} options The user import options, required when the users provided
+     * @param users - The list of user records to import to Firebase Auth.
+     * @param options - The user import options, required when the users provided
      *     include password credentials.
-     * @return {Promise<UserImportResult>} A promise that resolves when the operation completes
+     * @returns A promise that resolves when the operation completes
      *     with the result of the import. This includes the number of successful imports, the number
      *     of failed uploads and their corresponding errors.
      */