firebase-admin 9.100.0-alpha.0 → 10.0.2

package/lib/utils/error.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2017 Google Inc.
@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { FirebaseError as FireabseErrorInterface } from '../app';
+import { FirebaseError as FirebaseErrorInterface } from '../app';
 /**
  * Defines error info type. This includes a code and message string.
  */
@@ -26,25 +26,25 @@ export interface ErrorInfo {
 /**
  * Firebase error code structure. This extends Error.
  *
- * @param {ErrorInfo} errorInfo The error information (code and message).
+ * @param errorInfo - The error information (code and message).
  * @constructor
  */
-export declare class FirebaseError extends Error implements FireabseErrorInterface {
+export declare class FirebaseError extends Error implements FirebaseErrorInterface {
     private errorInfo;
     constructor(errorInfo: ErrorInfo);
-    /** @return {string} The error code. */
+    /** @returns The error code. */
     get code(): string;
-    /** @return {string} The error message. */
+    /** @returns The error message. */
     get message(): string;
-    /** @return {object} The object representation of the error. */
+    /** @returns The object representation of the error. */
     toJSON(): object;
 }
 /**
  * A FirebaseError with a prefix in front of the error code.
  *
- * @param {string} codePrefix The prefix to apply to the error code.
- * @param {string} code The error code.
- * @param {string} message The error message.
+ * @param codePrefix - The prefix to apply to the error code.
+ * @param code - The error code.
+ * @param message - The error message.
  * @constructor
  */
 export declare class PrefixedFirebaseError extends FirebaseError {
@@ -54,16 +54,16 @@ export declare class PrefixedFirebaseError extends FirebaseError {
      * Allows the error type to be checked without needing to know implementation details
      * of the code prefixing.
      *
-     * @param {string} code The non-prefixed error code to test against.
-     * @return {boolean} True if the code matches, false otherwise.
+     * @param code - The non-prefixed error code to test against.
+     * @returns True if the code matches, false otherwise.
      */
     hasCode(code: string): boolean;
 }
 /**
  * Firebase App error code structure. This extends PrefixedFirebaseError.
  *
- * @param {string} code The error code.
- * @param {string} message The error message.
+ * @param code - The error code.
+ * @param message - The error message.
  * @constructor
  */
 export declare class FirebaseAppError extends PrefixedFirebaseError {
@@ -72,8 +72,8 @@ export declare class FirebaseAppError extends PrefixedFirebaseError {
 /**
  * Firebase Auth error code structure. This extends PrefixedFirebaseError.
  *
- * @param {ErrorInfo} info The error code info.
- * @param {string} [message] The error message. This will override the default
+ * @param info - The error code info.
+ * @param [message] The error message. This will override the default
  *     message if provided.
  * @constructor
  */
@@ -81,11 +81,11 @@ export declare class FirebaseAuthError extends PrefixedFirebaseError {
     /**
      * Creates the developer-facing error corresponding to the backend error code.
      *
-     * @param {string} serverErrorCode The server error code.
-     * @param {string} [message] The error message. The default message is used
+     * @param serverErrorCode - The server error code.
+     * @param [message] The error message. The default message is used
      *     if not provided.
-     * @param {object} [rawServerResponse] The error's raw server response.
-     * @return {FirebaseAuthError} The corresponding developer-facing error.
+     * @param [rawServerResponse] The error's raw server response.
+     * @returns The corresponding developer-facing error.
      */
     static fromServerError(serverErrorCode: string, message?: string, rawServerResponse?: object): FirebaseAuthError;
     constructor(info: ErrorInfo, message?: string);
@@ -93,8 +93,8 @@ export declare class FirebaseAuthError extends PrefixedFirebaseError {
 /**
  * Firebase Database error code structure. This extends FirebaseError.
  *
- * @param {ErrorInfo} info The error code info.
- * @param {string} [message] The error message. This will override the default
+ * @param info - The error code info.
+ * @param [message] The error message. This will override the default
  *     message if provided.
  * @constructor
  */
@@ -104,8 +104,8 @@ export declare class FirebaseDatabaseError extends FirebaseError {
 /**
  * Firebase Firestore error code structure. This extends FirebaseError.
  *
- * @param {ErrorInfo} info The error code info.
- * @param {string} [message] The error message. This will override the default
+ * @param info - The error code info.
+ * @param [message] The error message. This will override the default
  *     message if provided.
  * @constructor
  */
@@ -115,30 +115,41 @@ export declare class FirebaseFirestoreError extends FirebaseError {
 /**
  * Firebase instance ID error code structure. This extends FirebaseError.
  *
- * @param {ErrorInfo} info The error code info.
- * @param {string} [message] The error message. This will override the default
+ * @param info - The error code info.
+ * @param [message] The error message. This will override the default
  *     message if provided.
  * @constructor
  */
 export declare class FirebaseInstanceIdError extends FirebaseError {
     constructor(info: ErrorInfo, message?: string);
 }
+/**
+ * Firebase Installations service error code structure. This extends `FirebaseError`.
+ *
+ * @param info - The error code info.
+ * @param message - The error message. This will override the default
+ *     message if provided.
+ * @constructor
+ */
+export declare class FirebaseInstallationsError extends FirebaseError {
+    constructor(info: ErrorInfo, message?: string);
+}
 /**
  * Firebase Messaging error code structure. This extends PrefixedFirebaseError.
  *
- * @param {ErrorInfo} info The error code info.
- * @param {string} [message] The error message. This will override the default message if provided.
+ * @param info - The error code info.
+ * @param [message] The error message. This will override the default message if provided.
  * @constructor
  */
 export declare class FirebaseMessagingError extends PrefixedFirebaseError {
     /**
      * Creates the developer-facing error corresponding to the backend error code.
      *
-     * @param {string} serverErrorCode The server error code.
-     * @param {string} [message] The error message. The default message is used
+     * @param serverErrorCode - The server error code.
+     * @param [message] The error message. The default message is used
      *     if not provided.
-     * @param {object} [rawServerResponse] The error's raw server response.
-     * @return {FirebaseMessagingError} The corresponding developer-facing error.
+     * @param [rawServerResponse] The error's raw server response.
+     * @returns The corresponding developer-facing error.
      */
     static fromServerError(serverErrorCode: string | null, message?: string | null, rawServerResponse?: object): FirebaseMessagingError;
     static fromTopicManagementServerError(serverErrorCode: string, message?: string, rawServerResponse?: object): FirebaseMessagingError;
@@ -147,8 +158,8 @@ export declare class FirebaseMessagingError extends PrefixedFirebaseError {
 /**
  * Firebase project management error code structure. This extends PrefixedFirebaseError.
  *
- * @param {ProjectManagementErrorCode} code The error code.
- * @param {string} message The error message.
+ * @param code - The error code.
+ * @param message - The error message.
  * @constructor
  */
 export declare class FirebaseProjectManagementError extends PrefixedFirebaseError {
@@ -206,6 +217,10 @@ export declare class AuthClientErrorCode {
         code: string;
         message: string;
     };
+    static EMAIL_NOT_FOUND: {
+        code: string;
+        message: string;
+    };
     static FORBIDDEN_CLAIM: {
         code: string;
         message: string;
@@ -350,6 +365,10 @@ export declare class AuthClientErrorCode {
         code: string;
         message: string;
     };
+    static INVALID_OAUTH_RESPONSETYPE: {
+        code: string;
+        message: string;
+    };
     static INVALID_SESSION_COOKIE_DURATION: {
         code: string;
         message: string;
@@ -418,6 +437,10 @@ export declare class AuthClientErrorCode {
         code: string;
         message: string;
     };
+    static MISSING_OAUTH_CLIENT_SECRET: {
+        code: string;
+        message: string;
+    };
     static MISSING_PROVIDER_ID: {
         code: string;
         message: string;
@@ -510,6 +533,10 @@ export declare class AuthClientErrorCode {
         code: string;
         message: string;
     };
+    static USER_DISABLED: {
+        code: string;
+        message: string;
+    };
     static USER_NOT_DISABLED: {
         code: string;
         message: string;
@@ -596,7 +623,7 @@ export declare class MessagingClientErrorCode {
         message: string;
     };
 }
-export declare class InstanceIdClientErrorCode {
+export declare class InstallationsClientErrorCode {
     static INVALID_ARGUMENT: {
         code: string;
         message: string;
@@ -605,7 +632,7 @@ export declare class InstanceIdClientErrorCode {
         code: string;
         message: string;
     };
-    static INVALID_INSTANCE_ID: {
+    static INVALID_INSTALLATION_ID: {
         code: string;
         message: string;
     };
@@ -614,4 +641,10 @@ export declare class InstanceIdClientErrorCode {
         message: string;
     };
 }
+export declare class InstanceIdClientErrorCode extends InstallationsClientErrorCode {
+    static INVALID_INSTANCE_ID: {
+        code: string;
+        message: string;
+    };
+}
 export declare type ProjectManagementErrorCode = 'already-exists' | 'authentication-error' | 'internal-error' | 'invalid-argument' | 'invalid-project-id' | 'invalid-server-response' | 'not-found' | 'service-unavailable' | 'unknown-error';

package/lib/utils/error.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 "use strict";
 /*!
  * @license
@@ -30,12 +30,12 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InstanceIdClientErrorCode = exports.MessagingClientErrorCode = exports.AuthClientErrorCode = exports.AppErrorCodes = exports.FirebaseProjectManagementError = exports.FirebaseMessagingError = exports.FirebaseInstanceIdError = exports.FirebaseFirestoreError = exports.FirebaseDatabaseError = exports.FirebaseAuthError = exports.FirebaseAppError = exports.PrefixedFirebaseError = exports.FirebaseError = void 0;
+exports.InstanceIdClientErrorCode = exports.InstallationsClientErrorCode = exports.MessagingClientErrorCode = exports.AuthClientErrorCode = exports.AppErrorCodes = exports.FirebaseProjectManagementError = exports.FirebaseMessagingError = exports.FirebaseInstallationsError = exports.FirebaseInstanceIdError = exports.FirebaseFirestoreError = exports.FirebaseDatabaseError = exports.FirebaseAuthError = exports.FirebaseAppError = exports.PrefixedFirebaseError = exports.FirebaseError = void 0;
 var deep_copy_1 = require("../utils/deep-copy");
 /**
  * Firebase error code structure. This extends Error.
  *
- * @param {ErrorInfo} errorInfo The error information (code and message).
+ * @param errorInfo - The error information (code and message).
  * @constructor
  */
 var FirebaseError = /** @class */ (function (_super) {
@@ -51,7 +51,7 @@ var FirebaseError = /** @class */ (function (_super) {
         return _this;
     }
     Object.defineProperty(FirebaseError.prototype, "code", {
-        /** @return {string} The error code. */
+        /** @returns The error code. */
         get: function () {
             return this.errorInfo.code;
         },
@@ -59,14 +59,14 @@ var FirebaseError = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(FirebaseError.prototype, "message", {
-        /** @return {string} The error message. */
+        /** @returns The error message. */
         get: function () {
             return this.errorInfo.message;
         },
         enumerable: false,
         configurable: true
     });
-    /** @return {object} The object representation of the error. */
+    /** @returns The object representation of the error. */
     FirebaseError.prototype.toJSON = function () {
         return {
             code: this.code,
@@ -79,9 +79,9 @@ exports.FirebaseError = FirebaseError;
 /**
  * A FirebaseError with a prefix in front of the error code.
  *
- * @param {string} codePrefix The prefix to apply to the error code.
- * @param {string} code The error code.
- * @param {string} message The error message.
+ * @param codePrefix - The prefix to apply to the error code.
+ * @param code - The error code.
+ * @param message - The error message.
  * @constructor
  */
 var PrefixedFirebaseError = /** @class */ (function (_super) {
@@ -103,8 +103,8 @@ var PrefixedFirebaseError = /** @class */ (function (_super) {
      * Allows the error type to be checked without needing to know implementation details
      * of the code prefixing.
      *
-     * @param {string} code The non-prefixed error code to test against.
-     * @return {boolean} True if the code matches, false otherwise.
+     * @param code - The non-prefixed error code to test against.
+     * @returns True if the code matches, false otherwise.
      */
     PrefixedFirebaseError.prototype.hasCode = function (code) {
         return this.codePrefix + "/" + code === this.code;
@@ -115,8 +115,8 @@ exports.PrefixedFirebaseError = PrefixedFirebaseError;
 /**
  * Firebase App error code structure. This extends PrefixedFirebaseError.
  *
- * @param {string} code The error code.
- * @param {string} message The error message.
+ * @param code - The error code.
+ * @param message - The error message.
  * @constructor
  */
 var FirebaseAppError = /** @class */ (function (_super) {
@@ -136,8 +136,8 @@ exports.FirebaseAppError = FirebaseAppError;
 /**
  * Firebase Auth error code structure. This extends PrefixedFirebaseError.
  *
- * @param {ErrorInfo} info The error code info.
- * @param {string} [message] The error message. This will override the default
+ * @param info - The error code info.
+ * @param [message] The error message. This will override the default
  *     message if provided.
  * @constructor
  */
@@ -157,11 +157,11 @@ var FirebaseAuthError = /** @class */ (function (_super) {
     /**
      * Creates the developer-facing error corresponding to the backend error code.
      *
-     * @param {string} serverErrorCode The server error code.
-     * @param {string} [message] The error message. The default message is used
+     * @param serverErrorCode - The server error code.
+     * @param [message] The error message. The default message is used
      *     if not provided.
-     * @param {object} [rawServerResponse] The error's raw server response.
-     * @return {FirebaseAuthError} The corresponding developer-facing error.
+     * @param [rawServerResponse] The error's raw server response.
+     * @returns The corresponding developer-facing error.
      */
     FirebaseAuthError.fromServerError = function (serverErrorCode, message, rawServerResponse) {
         // serverErrorCode could contain additional details:
@@ -193,8 +193,8 @@ exports.FirebaseAuthError = FirebaseAuthError;
 /**
  * Firebase Database error code structure. This extends FirebaseError.
  *
- * @param {ErrorInfo} info The error code info.
- * @param {string} [message] The error message. This will override the default
+ * @param info - The error code info.
+ * @param [message] The error message. This will override the default
  *     message if provided.
  * @constructor
  */
@@ -210,8 +210,8 @@ exports.FirebaseDatabaseError = FirebaseDatabaseError;
 /**
  * Firebase Firestore error code structure. This extends FirebaseError.
  *
- * @param {ErrorInfo} info The error code info.
- * @param {string} [message] The error message. This will override the default
+ * @param info - The error code info.
+ * @param [message] The error message. This will override the default
  *     message if provided.
  * @constructor
  */
@@ -227,25 +227,48 @@ exports.FirebaseFirestoreError = FirebaseFirestoreError;
 /**
  * Firebase instance ID error code structure. This extends FirebaseError.
  *
- * @param {ErrorInfo} info The error code info.
- * @param {string} [message] The error message. This will override the default
+ * @param info - The error code info.
+ * @param [message] The error message. This will override the default
  *     message if provided.
  * @constructor
  */
 var FirebaseInstanceIdError = /** @class */ (function (_super) {
     __extends(FirebaseInstanceIdError, _super);
     function FirebaseInstanceIdError(info, message) {
+        var _this = 
         // Override default message if custom message provided.
-        return _super.call(this, { code: 'instance-id/' + info.code, message: message || info.message }) || this;
+        _super.call(this, { code: 'instance-id/' + info.code, message: message || info.message }) || this;
+        _this.__proto__ = FirebaseInstanceIdError.prototype;
+        return _this;
     }
     return FirebaseInstanceIdError;
 }(FirebaseError));
 exports.FirebaseInstanceIdError = FirebaseInstanceIdError;
+/**
+ * Firebase Installations service error code structure. This extends `FirebaseError`.
+ *
+ * @param info - The error code info.
+ * @param message - The error message. This will override the default
+ *     message if provided.
+ * @constructor
+ */
+var FirebaseInstallationsError = /** @class */ (function (_super) {
+    __extends(FirebaseInstallationsError, _super);
+    function FirebaseInstallationsError(info, message) {
+        var _this = 
+        // Override default message if custom message provided.
+        _super.call(this, { code: 'installations/' + info.code, message: message || info.message }) || this;
+        _this.__proto__ = FirebaseInstallationsError.prototype;
+        return _this;
+    }
+    return FirebaseInstallationsError;
+}(FirebaseError));
+exports.FirebaseInstallationsError = FirebaseInstallationsError;
 /**
  * Firebase Messaging error code structure. This extends PrefixedFirebaseError.
  *
- * @param {ErrorInfo} info The error code info.
- * @param {string} [message] The error message. This will override the default message if provided.
+ * @param info - The error code info.
+ * @param [message] The error message. This will override the default message if provided.
  * @constructor
  */
 var FirebaseMessagingError = /** @class */ (function (_super) {
@@ -264,11 +287,11 @@ var FirebaseMessagingError = /** @class */ (function (_super) {
     /**
      * Creates the developer-facing error corresponding to the backend error code.
      *
-     * @param {string} serverErrorCode The server error code.
-     * @param {string} [message] The error message. The default message is used
+     * @param serverErrorCode - The server error code.
+     * @param [message] The error message. The default message is used
      *     if not provided.
-     * @param {object} [rawServerResponse] The error's raw server response.
-     * @return {FirebaseMessagingError} The corresponding developer-facing error.
+     * @param [rawServerResponse] The error's raw server response.
+     * @returns The corresponding developer-facing error.
      */
     FirebaseMessagingError.fromServerError = function (serverErrorCode, message, rawServerResponse) {
         // If not found, default to unknown error.
@@ -309,8 +332,8 @@ exports.FirebaseMessagingError = FirebaseMessagingError;
 /**
  * Firebase project management error code structure. This extends PrefixedFirebaseError.
  *
- * @param {ProjectManagementErrorCode} code The error code.
- * @param {string} message The error message.
+ * @param code - The error code.
+ * @param message - The error message.
  * @constructor
  */
 var FirebaseProjectManagementError = /** @class */ (function (_super) {
@@ -385,6 +408,10 @@ var AuthClientErrorCode = /** @class */ (function () {
         code: 'email-already-exists',
         message: 'The email address is already in use by another account.',
     };
+    AuthClientErrorCode.EMAIL_NOT_FOUND = {
+        code: 'email-not-found',
+        message: 'There is no user record corresponding to the provided email.',
+    };
     AuthClientErrorCode.FORBIDDEN_CLAIM = {
         code: 'reserved-claim',
         message: 'The specified developer claim is reserved and cannot be specified.',
@@ -532,6 +559,10 @@ var AuthClientErrorCode = /** @class */ (function () {
         code: 'invalid-provider-uid',
         message: 'The providerUid must be a valid provider uid string.',
     };
+    AuthClientErrorCode.INVALID_OAUTH_RESPONSETYPE = {
+        code: 'invalid-oauth-responsetype',
+        message: 'Only exactly one OAuth responseType should be set to true.',
+    };
     AuthClientErrorCode.INVALID_SESSION_COOKIE_DURATION = {
         code: 'invalid-session-cookie-duration',
         message: 'The session cookie duration must be a valid number in milliseconds ' +
@@ -604,6 +635,10 @@ var AuthClientErrorCode = /** @class */ (function () {
         code: 'missing-oauth-client-id',
         message: 'The OAuth/OIDC configuration client ID must not be empty.',
     };
+    AuthClientErrorCode.MISSING_OAUTH_CLIENT_SECRET = {
+        code: 'missing-oauth-client-secret',
+        message: 'The OAuth configuration client secret is required to enable OIDC code flow.',
+    };
     AuthClientErrorCode.MISSING_PROVIDER_ID = {
         code: 'missing-provider-id',
         message: 'A valid provider ID must be provided in the request.',
@@ -703,6 +738,10 @@ var AuthClientErrorCode = /** @class */ (function () {
         code: 'not-found',
         message: 'The requested resource was not found.',
     };
+    AuthClientErrorCode.USER_DISABLED = {
+        code: 'user-disabled',
+        message: 'The user record is disabled.',
+    };
     AuthClientErrorCode.USER_NOT_DISABLED = {
         code: 'user-not-disabled',
         message: 'The user must be disabled in order to bulk delete it (or you must pass force=true).',
@@ -811,27 +850,39 @@ var MessagingClientErrorCode = /** @class */ (function () {
     return MessagingClientErrorCode;
 }());
 exports.MessagingClientErrorCode = MessagingClientErrorCode;
-var InstanceIdClientErrorCode = /** @class */ (function () {
-    function InstanceIdClientErrorCode() {
+var InstallationsClientErrorCode = /** @class */ (function () {
+    function InstallationsClientErrorCode() {
     }
-    InstanceIdClientErrorCode.INVALID_ARGUMENT = {
+    InstallationsClientErrorCode.INVALID_ARGUMENT = {
         code: 'invalid-argument',
         message: 'Invalid argument provided.',
     };
-    InstanceIdClientErrorCode.INVALID_PROJECT_ID = {
+    InstallationsClientErrorCode.INVALID_PROJECT_ID = {
         code: 'invalid-project-id',
         message: 'Invalid project ID provided.',
     };
+    InstallationsClientErrorCode.INVALID_INSTALLATION_ID = {
+        code: 'invalid-installation-id',
+        message: 'Invalid installation ID provided.',
+    };
+    InstallationsClientErrorCode.API_ERROR = {
+        code: 'api-error',
+        message: 'Installation ID API call failed.',
+    };
+    return InstallationsClientErrorCode;
+}());
+exports.InstallationsClientErrorCode = InstallationsClientErrorCode;
+var InstanceIdClientErrorCode = /** @class */ (function (_super) {
+    __extends(InstanceIdClientErrorCode, _super);
+    function InstanceIdClientErrorCode() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
     InstanceIdClientErrorCode.INVALID_INSTANCE_ID = {
         code: 'invalid-instance-id',
         message: 'Invalid instance ID provided.',
     };
-    InstanceIdClientErrorCode.API_ERROR = {
-        code: 'api-error',
-        message: 'Instance ID API call failed.',
-    };
     return InstanceIdClientErrorCode;
-}());
+}(InstallationsClientErrorCode));
 exports.InstanceIdClientErrorCode = InstanceIdClientErrorCode;
 /** @const {ServerToClientCode} Auth server to client enum error codes. */
 var AUTH_SERVER_TO_CLIENT_CODE = {
@@ -861,6 +912,8 @@ var AUTH_SERVER_TO_CLIENT_CODE = {
     DUPLICATE_MFA_ENROLLMENT_ID: 'SECOND_FACTOR_UID_ALREADY_EXISTS',
     // setAccountInfo email already exists.
     EMAIL_EXISTS: 'EMAIL_ALREADY_EXISTS',
+    // /accounts:sendOobCode for password reset when user is not found.
+    EMAIL_NOT_FOUND: 'EMAIL_NOT_FOUND',
     // Reserved claim name.
     FORBIDDEN_CLAIM: 'FORBIDDEN_CLAIM',
     // Invalid claims provided.
@@ -947,6 +1000,8 @@ var AUTH_SERVER_TO_CLIENT_CODE = {
     UNVERIFIED_EMAIL: 'UNVERIFIED_EMAIL',
     // User on which action is to be performed is not found.
     USER_NOT_FOUND: 'USER_NOT_FOUND',
+    // User record is disabled.
+    USER_DISABLED: 'USER_DISABLED',
     // Password provided is too weak.
     WEAK_PASSWORD: 'INVALID_PASSWORD',
 };

package/lib/utils/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * @license
  * Copyright 2017 Google Inc.
@@ -23,8 +23,8 @@ export declare function getSdkVersion(): string;
  *
  * For example, this can be used to map underscore_cased properties to camelCase.
  *
- * @param {object} obj The object whose properties to rename.
- * @param {object} keyMap The mapping from old to new property names.
+ * @param obj - The object whose properties to rename.
+ * @param keyMap - The mapping from old to new property names.
  */
 export declare function renameProperties(obj: {
     [key: string]: any;
@@ -34,9 +34,9 @@ export declare function renameProperties(obj: {
 /**
  * Defines a new read-only property directly on an object and returns the object.
  *
- * @param {object} obj The object on which to define the property.
- * @param {string} prop The name of the property to be defined or modified.
- * @param {any} value The value associated with the property.
+ * @param obj - The object on which to define the property.
+ * @param prop - The name of the property to be defined or modified.
+ * @param value - The value associated with the property.
  */
 export declare function addReadonlyGetter(obj: object, prop: string, value: any): void;
 /**
@@ -44,9 +44,9 @@ export declare function addReadonlyGetter(obj: object, prop: string, value: any)
  * specified in either the Firebase app options, credentials or the local environment.
  * Otherwise returns null.
  *
- * @param app A Firebase app to get the project ID from.
+ * @param app - A Firebase app to get the project ID from.
  *
- * @return A project ID string or null.
+ * @returns A project ID string or null.
  */
 export declare function getExplicitProjectId(app: App): string | null;
 /**
@@ -56,16 +56,16 @@ export declare function getExplicitProjectId(app: App): string | null;
  * configured, but the SDK has been initialized with ComputeEngineCredentials, this
  * method attempts to discover the project ID from the local metadata service.
  *
- * @param app A Firebase app to get the project ID from.
+ * @param app - A Firebase app to get the project ID from.
  *
- * @return A project ID string or null.
+ * @returns A project ID string or null.
  */
 export declare function findProjectId(app: App): Promise<string | null>;
 /**
  * Encodes data using web-safe-base64.
  *
- * @param {Buffer} data The raw data byte input.
- * @return {string} The base64-encoded result.
+ * @param data - The raw data byte input.
+ * @returns The base64-encoded result.
  */
 export declare function toWebSafeBase64(data: Buffer): string;
 /**
@@ -73,22 +73,33 @@ export declare function toWebSafeBase64(data: Buffer): string;
  * with corresponding arguments {projectId: '1234', api: 'resource'}
  * and returns output: 'project/1234/resource'.
  *
- * @param {string} str The original string where the param need to be
+ * @param str - The original string where the param need to be
  *     replaced.
- * @param {object=} params The optional parameters to replace in the
+ * @param params - The optional parameters to replace in the
  *     string.
- * @return {string} The resulting formatted string.
+ * @returns The resulting formatted string.
  */
 export declare function formatString(str: string, params?: object): string;
 /**
  * Generates the update mask for the provided object.
  * Note this will ignore the last key with value undefined.
  *
- * @param obj The object to generate the update mask for.
- * @param terminalPaths The optional map of keys for maximum paths to traverse.
+ * @param obj - The object to generate the update mask for.
+ * @param terminalPaths - The optional map of keys for maximum paths to traverse.
  *      Nested objects beyond that path will be ignored. This is useful for
  *      keys with variable object values.
- * @param root The path so far.
- * @return The computed update mask list.
+ * @param root - The path so far.
+ * @returns The computed update mask list.
  */
 export declare function generateUpdateMask(obj: any, terminalPaths?: string[], root?: string): string[];
+/**
+ * Transforms milliseconds to a protobuf Duration type string.
+ * Returns the duration in seconds with up to nine fractional
+ * digits, terminated by 's'. Example: "3 seconds 0 nano seconds as 3s,
+ * 3 seconds 1 nano seconds as 3.000000001s".
+ *
+ * @param milliseconds - The duration in milliseconds.
+ * @returns The resulting formatted string in seconds with up to nine fractional
+ * digits, terminated by 's'.
+ */
+export declare function transformMillisecondsToSecondsString(milliseconds: number): string;