firebase-admin 10.2.0 → 11.0.1

package/lib/auth/user-import-builder.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.2.0 */
+/*! firebase-admin v11.0.1 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.
@@ -17,38 +17,38 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserImportBuilder = exports.convertMultiFactorInfoToServerFormat = void 0;
-var deep_copy_1 = require("../utils/deep-copy");
-var utils = require("../utils");
-var validator = require("../utils/validator");
-var error_1 = require("../utils/error");
+const deep_copy_1 = require("../utils/deep-copy");
+const utils = require("../utils");
+const validator = require("../utils/validator");
+const error_1 = require("../utils/error");
 /**
  * Converts a client format second factor object to server format.
  * @param multiFactorInfo - The client format second factor.
  * @returns The corresponding AuthFactorInfo server request format.
  */
 function convertMultiFactorInfoToServerFormat(multiFactorInfo) {
-    var enrolledAt;
+    let enrolledAt;
     if (typeof multiFactorInfo.enrollmentTime !== 'undefined') {
         if (validator.isUTCDateString(multiFactorInfo.enrollmentTime)) {
             // Convert from UTC date string (client side format) to ISO date string (server side format).
             enrolledAt = new Date(multiFactorInfo.enrollmentTime).toISOString();
         }
         else {
-            throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_ENROLLMENT_TIME, "The second factor \"enrollmentTime\" for \"" + multiFactorInfo.uid + "\" must be a valid " +
+            throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_ENROLLMENT_TIME, `The second factor "enrollmentTime" for "${multiFactorInfo.uid}" must be a valid ` +
                 'UTC date string.');
         }
     }
     // Currently only phone second factors are supported.
     if (isPhoneFactor(multiFactorInfo)) {
         // If any required field is missing or invalid, validation will still fail later.
-        var authFactorInfo = {
+        const authFactorInfo = {
             mfaEnrollmentId: multiFactorInfo.uid,
             displayName: multiFactorInfo.displayName,
             // Required for all phone second factors.
             phoneInfo: multiFactorInfo.phoneNumber,
-            enrolledAt: enrolledAt,
+            enrolledAt,
         };
-        for (var objKey in authFactorInfo) {
+        for (const objKey in authFactorInfo) {
             if (typeof authFactorInfo[objKey] === 'undefined') {
                 delete authFactorInfo[objKey];
             }
@@ -57,7 +57,7 @@ function convertMultiFactorInfoToServerFormat(multiFactorInfo) {
     }
     else {
         // Unsupported second factor.
-        throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.UNSUPPORTED_SECOND_FACTOR, "Unsupported second factor \"" + JSON.stringify(multiFactorInfo) + "\" provided.");
+        throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.UNSUPPORTED_SECOND_FACTOR, `Unsupported second factor "${JSON.stringify(multiFactorInfo)}" provided.`);
     }
 }
 exports.convertMultiFactorInfoToServerFormat = convertMultiFactorInfoToServerFormat;
@@ -83,7 +83,7 @@ function getNumberField(obj, key) {
  * @returns {UploadAccountUser} The corresponding UploadAccountUser to return.
  */
 function populateUploadAccountUser(user, userValidator) {
-    var result = {
+    const result = {
         localId: user.uid,
         email: user.email,
         emailVerified: user.emailVerified,
@@ -117,7 +117,7 @@ function populateUploadAccountUser(user, userValidator) {
         }
     }
     if (validator.isArray(user.providerData)) {
-        user.providerData.forEach(function (providerData) {
+        user.providerData.forEach((providerData) => {
             result.providerUserInfo.push({
                 providerId: providerData.providerId,
                 rawId: providerData.uid,
@@ -130,12 +130,12 @@ function populateUploadAccountUser(user, userValidator) {
     // Convert user.multiFactor.enrolledFactors to server format.
     if (validator.isNonNullObject(user.multiFactor) &&
         validator.isNonEmptyArray(user.multiFactor.enrolledFactors)) {
-        user.multiFactor.enrolledFactors.forEach(function (multiFactorInfo) {
+        user.multiFactor.enrolledFactors.forEach((multiFactorInfo) => {
             result.mfaInfo.push(convertMultiFactorInfoToServerFormat(multiFactorInfo));
         });
     }
     // Remove blank fields.
-    var key;
+    let key;
     for (key in result) {
         if (typeof result[key] === 'undefined') {
             delete result[key];
@@ -158,7 +158,7 @@ function populateUploadAccountUser(user, userValidator) {
  * Class that provides a helper for building/validating uploadAccount requests and
  * UserImportResult responses.
  */
-var UserImportBuilder = /** @class */ (function () {
+class UserImportBuilder {
     /**
      * @param {UserImportRecord[]} users The list of user records to import.
      * @param {UserImportOptions=} options The import options which includes hashing
@@ -166,7 +166,7 @@ var UserImportBuilder = /** @class */ (function () {
      * @param {ValidatorFunction=} userRequestValidator The user request validator function.
      * @constructor
      */
-    function UserImportBuilder(users, options, userRequestValidator) {
+    constructor(users, options, userRequestValidator) {
         this.requiresHashOptions = false;
         this.validatedUsers = [];
         this.userImportResultErrors = [];
@@ -178,42 +178,41 @@ var UserImportBuilder = /** @class */ (function () {
      * Returns the corresponding constructed uploadAccount request.
      * @returns {UploadAccountRequest} The constructed uploadAccount request.
      */
-    UserImportBuilder.prototype.buildRequest = function () {
-        var users = this.validatedUsers.map(function (user) {
-            return deep_copy_1.deepCopy(user);
+    buildRequest() {
+        const users = this.validatedUsers.map((user) => {
+            return (0, deep_copy_1.deepCopy)(user);
         });
-        return deep_copy_1.deepExtend({ users: users }, deep_copy_1.deepCopy(this.validatedOptions));
-    };
+        return (0, deep_copy_1.deepExtend)({ users }, (0, deep_copy_1.deepCopy)(this.validatedOptions));
+    }
     /**
      * Populates the UserImportResult using the client side detected errors and the server
      * side returned errors.
      * @returns {UserImportResult} The user import result based on the returned failed
      *     uploadAccount response.
      */
-    UserImportBuilder.prototype.buildResponse = function (failedUploads) {
-        var _this = this;
+    buildResponse(failedUploads) {
         // Initialize user import result.
-        var importResult = {
+        const importResult = {
             successCount: this.validatedUsers.length,
             failureCount: this.userImportResultErrors.length,
-            errors: deep_copy_1.deepCopy(this.userImportResultErrors),
+            errors: (0, deep_copy_1.deepCopy)(this.userImportResultErrors),
         };
         importResult.failureCount += failedUploads.length;
         importResult.successCount -= failedUploads.length;
-        failedUploads.forEach(function (failedUpload) {
+        failedUploads.forEach((failedUpload) => {
             importResult.errors.push({
                 // Map backend request index to original developer provided array index.
-                index: _this.indexMap[failedUpload.index],
+                index: this.indexMap[failedUpload.index],
                 error: new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_USER_IMPORT, failedUpload.message),
             });
         });
         // Sort errors by index.
-        importResult.errors.sort(function (a, b) {
+        importResult.errors.sort((a, b) => {
             return a.index - b.index;
         });
         // Return sorted result.
         return importResult;
-    };
+    }
     /**
      * Validates and returns the hashing options of the uploadAccount request.
      * Throws an error whenever an invalid or missing options is detected.
@@ -221,8 +220,8 @@ var UserImportBuilder = /** @class */ (function () {
      * @param {boolean} requiresHashOptions Whether to require hash options.
      * @returns {UploadAccountOptions} The populated UploadAccount options.
      */
-    UserImportBuilder.prototype.populateOptions = function (options, requiresHashOptions) {
-        var populatedOptions;
+    populateOptions(options, requiresHashOptions) {
+        let populatedOptions;
         if (!requiresHashOptions) {
             return {};
         }
@@ -236,7 +235,7 @@ var UserImportBuilder = /** @class */ (function () {
             !validator.isNonEmptyString(options.hash.algorithm)) {
             throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_ALGORITHM, '"hash.algorithm" must be a string matching the list of supported algorithms.');
         }
-        var rounds;
+        let rounds;
         switch (options.hash.algorithm) {
             case 'HMAC_SHA512':
             case 'HMAC_SHA256':
@@ -244,7 +243,7 @@ var UserImportBuilder = /** @class */ (function () {
             case 'HMAC_MD5':
                 if (!validator.isBuffer(options.hash.key)) {
                     throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_KEY, 'A non-empty "hash.key" byte buffer must be provided for ' +
-                        ("hash algorithm " + options.hash.algorithm + "."));
+                        `hash algorithm ${options.hash.algorithm}.`);
                 }
                 populatedOptions = {
                     hashAlgorithm: options.hash.algorithm,
@@ -257,14 +256,14 @@ var UserImportBuilder = /** @class */ (function () {
             case 'SHA512': {
                 // MD5 is [0,8192] but SHA1, SHA256, and SHA512 are [1,8192]
                 rounds = getNumberField(options.hash, 'rounds');
-                var minRounds = options.hash.algorithm === 'MD5' ? 0 : 1;
+                const minRounds = options.hash.algorithm === 'MD5' ? 0 : 1;
                 if (isNaN(rounds) || rounds < minRounds || rounds > 8192) {
-                    throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_ROUNDS, "A valid \"hash.rounds\" number between " + minRounds + " and 8192 must be provided for " +
-                        ("hash algorithm " + options.hash.algorithm + "."));
+                    throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_ROUNDS, `A valid "hash.rounds" number between ${minRounds} and 8192 must be provided for ` +
+                        `hash algorithm ${options.hash.algorithm}.`);
                 }
                 populatedOptions = {
                     hashAlgorithm: options.hash.algorithm,
-                    rounds: rounds,
+                    rounds,
                 };
                 break;
             }
@@ -273,27 +272,27 @@ var UserImportBuilder = /** @class */ (function () {
                 rounds = getNumberField(options.hash, 'rounds');
                 if (isNaN(rounds) || rounds < 0 || rounds > 120000) {
                     throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_ROUNDS, 'A valid "hash.rounds" number between 0 and 120000 must be provided for ' +
-                        ("hash algorithm " + options.hash.algorithm + "."));
+                        `hash algorithm ${options.hash.algorithm}.`);
                 }
                 populatedOptions = {
                     hashAlgorithm: options.hash.algorithm,
-                    rounds: rounds,
+                    rounds,
                 };
                 break;
             case 'SCRYPT': {
                 if (!validator.isBuffer(options.hash.key)) {
                     throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_KEY, 'A "hash.key" byte buffer must be provided for ' +
-                        ("hash algorithm " + options.hash.algorithm + "."));
+                        `hash algorithm ${options.hash.algorithm}.`);
                 }
                 rounds = getNumberField(options.hash, 'rounds');
                 if (isNaN(rounds) || rounds <= 0 || rounds > 8) {
                     throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_ROUNDS, 'A valid "hash.rounds" number between 1 and 8 must be provided for ' +
-                        ("hash algorithm " + options.hash.algorithm + "."));
+                        `hash algorithm ${options.hash.algorithm}.`);
                 }
-                var memoryCost = getNumberField(options.hash, 'memoryCost');
+                const memoryCost = getNumberField(options.hash, 'memoryCost');
                 if (isNaN(memoryCost) || memoryCost <= 0 || memoryCost > 14) {
                     throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_MEMORY_COST, 'A valid "hash.memoryCost" number between 1 and 14 must be provided for ' +
-                        ("hash algorithm " + options.hash.algorithm + "."));
+                        `hash algorithm ${options.hash.algorithm}.`);
                 }
                 if (typeof options.hash.saltSeparator !== 'undefined' &&
                     !validator.isBuffer(options.hash.saltSeparator)) {
@@ -302,8 +301,8 @@ var UserImportBuilder = /** @class */ (function () {
                 populatedOptions = {
                     hashAlgorithm: options.hash.algorithm,
                     signerKey: utils.toWebSafeBase64(options.hash.key),
-                    rounds: rounds,
-                    memoryCost: memoryCost,
+                    rounds,
+                    memoryCost,
                     saltSeparator: utils.toWebSafeBase64(options.hash.saltSeparator || Buffer.from('')),
                 };
                 break;
@@ -314,40 +313,40 @@ var UserImportBuilder = /** @class */ (function () {
                 };
                 break;
             case 'STANDARD_SCRYPT': {
-                var cpuMemCost = getNumberField(options.hash, 'memoryCost');
+                const cpuMemCost = getNumberField(options.hash, 'memoryCost');
                 if (isNaN(cpuMemCost)) {
                     throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_MEMORY_COST, 'A valid "hash.memoryCost" number must be provided for ' +
-                        ("hash algorithm " + options.hash.algorithm + "."));
+                        `hash algorithm ${options.hash.algorithm}.`);
                 }
-                var parallelization = getNumberField(options.hash, 'parallelization');
+                const parallelization = getNumberField(options.hash, 'parallelization');
                 if (isNaN(parallelization)) {
                     throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_PARALLELIZATION, 'A valid "hash.parallelization" number must be provided for ' +
-                        ("hash algorithm " + options.hash.algorithm + "."));
+                        `hash algorithm ${options.hash.algorithm}.`);
                 }
-                var blockSize = getNumberField(options.hash, 'blockSize');
+                const blockSize = getNumberField(options.hash, 'blockSize');
                 if (isNaN(blockSize)) {
                     throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_BLOCK_SIZE, 'A valid "hash.blockSize" number must be provided for ' +
-                        ("hash algorithm " + options.hash.algorithm + "."));
+                        `hash algorithm ${options.hash.algorithm}.`);
                 }
-                var dkLen = getNumberField(options.hash, 'derivedKeyLength');
+                const dkLen = getNumberField(options.hash, 'derivedKeyLength');
                 if (isNaN(dkLen)) {
                     throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_DERIVED_KEY_LENGTH, 'A valid "hash.derivedKeyLength" number must be provided for ' +
-                        ("hash algorithm " + options.hash.algorithm + "."));
+                        `hash algorithm ${options.hash.algorithm}.`);
                 }
                 populatedOptions = {
                     hashAlgorithm: options.hash.algorithm,
-                    cpuMemCost: cpuMemCost,
-                    parallelization: parallelization,
-                    blockSize: blockSize,
-                    dkLen: dkLen,
+                    cpuMemCost,
+                    parallelization,
+                    blockSize,
+                    dkLen,
                 };
                 break;
             }
             default:
-                throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_ALGORITHM, "Unsupported hash algorithm provider \"" + options.hash.algorithm + "\".");
+                throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_HASH_ALGORITHM, `Unsupported hash algorithm provider "${options.hash.algorithm}".`);
         }
         return populatedOptions;
-    };
+    }
     /**
      * Validates and returns the users list of the uploadAccount request.
      * Whenever a user with an error is detected, the error is cached and will later be
@@ -358,30 +357,28 @@ var UserImportBuilder = /** @class */ (function () {
      * @param {ValidatorFunction=} userValidator The user validator function.
      * @returns {UploadAccountUser[]} The populated uploadAccount users.
      */
-    UserImportBuilder.prototype.populateUsers = function (users, userValidator) {
-        var _this = this;
-        var populatedUsers = [];
-        users.forEach(function (user, index) {
+    populateUsers(users, userValidator) {
+        const populatedUsers = [];
+        users.forEach((user, index) => {
             try {
-                var result = populateUploadAccountUser(user, userValidator);
+                const result = populateUploadAccountUser(user, userValidator);
                 if (typeof result.passwordHash !== 'undefined') {
-                    _this.requiresHashOptions = true;
+                    this.requiresHashOptions = true;
                 }
                 // Only users that pass client screening will be passed to backend for processing.
                 populatedUsers.push(result);
                 // Map user's index (the one to be sent to backend) to original developer provided array.
-                _this.indexMap[populatedUsers.length - 1] = index;
+                this.indexMap[populatedUsers.length - 1] = index;
             }
             catch (error) {
                 // Save the client side error with respect to the developer provided array.
-                _this.userImportResultErrors.push({
-                    index: index,
-                    error: error,
+                this.userImportResultErrors.push({
+                    index,
+                    error,
                 });
             }
         });
         return populatedUsers;
-    };
-    return UserImportBuilder;
-}());
+    }
+}
 exports.UserImportBuilder = UserImportBuilder;

package/lib/auth/user-record.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.2.0 */
+/*! firebase-admin v11.0.1 */
 /*!
  * @license
  * Copyright 2017 Google Inc.