firebase-admin 9.12.0 → 10.0.1

package/lib/utils/error.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.1 */
 "use strict";
 /*!
  * @license
@@ -35,7 +35,7 @@ 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,8 +227,8 @@ 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
  */
@@ -247,8 +247,8 @@ 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
+ * @param info - The error code info.
+ * @param message - The error message. This will override the default
  *     message if provided.
  * @constructor
  */
@@ -267,8 +267,8 @@ 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) {
@@ -287,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.
@@ -332,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) {
@@ -1000,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

@@ -0,0 +1,105 @@
+/*! firebase-admin v10.0.1 */
+/*!
+ * @license
+ * Copyright 2017 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/// <reference types="node" />
+import { App } from '../app/index';
+export declare function getSdkVersion(): string;
+/**
+ * Renames properties on an object given a mapping from old to new property names.
+ *
+ * For example, this can be used to map underscore_cased properties to camelCase.
+ *
+ * @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;
+}, keyMap: {
+    [key: string]: string;
+}): void;
+/**
+ * Defines a new read-only property directly on an object and returns the object.
+ *
+ * @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;
+/**
+ * Returns the Google Cloud project ID associated with a Firebase app, if it's explicitly
+ * 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.
+ *
+ * @returns A project ID string or null.
+ */
+export declare function getExplicitProjectId(app: App): string | null;
+/**
+ * Determines the Google Cloud project ID associated with a Firebase app. This method
+ * first checks if a project ID is explicitly specified in either the Firebase app options,
+ * credentials or the local environment in that order. If no explicit project ID is
+ * 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.
+ *
+ * @returns A project ID string or null.
+ */
+export declare function findProjectId(app: App): Promise<string | null>;
+/**
+ * Encodes data using web-safe-base64.
+ *
+ * @param data - The raw data byte input.
+ * @returns The base64-encoded result.
+ */
+export declare function toWebSafeBase64(data: Buffer): string;
+/**
+ * Formats a string of form 'project/{projectId}/{api}' and replaces
+ * with corresponding arguments {projectId: '1234', api: 'resource'}
+ * and returns output: 'project/1234/resource'.
+ *
+ * @param str - The original string where the param need to be
+ *     replaced.
+ * @param params - The optional parameters to replace in the
+ *     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.
+ *      Nested objects beyond that path will be ignored. This is useful for
+ *      keys with variable object values.
+ * @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;

package/lib/utils/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.1 */
 "use strict";
 /*!
  * @license
@@ -18,9 +18,10 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformMillisecondsToSecondsString = exports.generateUpdateMask = exports.formatString = exports.toWebSafeBase64 = exports.findProjectId = exports.getExplicitProjectId = exports.addReadonlyGetter = exports.renameProperties = exports.getSdkVersion = void 0;
-var credential_internal_1 = require("../credential/credential-internal");
+var credential_internal_1 = require("../app/credential-internal");
 var validator = require("./validator");
 var sdkVersion;
+// TODO: Move to firebase-admin/app as an internal member.
 function getSdkVersion() {
     if (!sdkVersion) {
         var version = require('../../package.json').version; // eslint-disable-line @typescript-eslint/no-var-requires
@@ -34,8 +35,8 @@ exports.getSdkVersion = getSdkVersion;
  *
  * 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.
  */
 function renameProperties(obj, keyMap) {
     Object.keys(keyMap).forEach(function (oldKey) {
@@ -51,9 +52,9 @@ exports.renameProperties = renameProperties;
 /**
  * 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.
  */
 function addReadonlyGetter(obj, prop, value) {
     Object.defineProperty(obj, prop, {
@@ -70,9 +71,9 @@ exports.addReadonlyGetter = addReadonlyGetter;
  * 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.
  */
 function getExplicitProjectId(app) {
     var options = app.options;
@@ -97,9 +98,9 @@ exports.getExplicitProjectId = getExplicitProjectId;
  * 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.
  */
 function findProjectId(app) {
     var projectId = getExplicitProjectId(app);
@@ -116,8 +117,8 @@ exports.findProjectId = findProjectId;
 /**
  * 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.
  */
 function toWebSafeBase64(data) {
     return data.toString('base64').replace(/\//g, '_').replace(/\+/g, '-');
@@ -128,11 +129,11 @@ exports.toWebSafeBase64 = toWebSafeBase64;
  * 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.
  */
 function formatString(str, params) {
     var formatted = str;
@@ -146,12 +147,12 @@ exports.formatString = formatString;
  * 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.
  */
 function generateUpdateMask(obj, terminalPaths, root) {
     if (terminalPaths === void 0) { terminalPaths = []; }
@@ -194,7 +195,7 @@ exports.generateUpdateMask = generateUpdateMask;
  * 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.
+ * @param milliseconds - The duration in milliseconds.
  * @returns The resulting formatted string in seconds with up to nine fractional
  * digits, terminated by 's'.
  */

package/lib/utils/jwt.d.ts

@@ -0,0 +1,131 @@
+/*! firebase-admin v10.0.1 */
+/*!
+ * Copyright 2021 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/// <reference types="node" />
+import * as jwt from 'jsonwebtoken';
+import { Agent } from 'http';
+export declare const ALGORITHM_RS256: jwt.Algorithm;
+export declare type Dictionary = {
+    [key: string]: any;
+};
+export declare type DecodedToken = {
+    header: Dictionary;
+    payload: Dictionary;
+};
+export interface SignatureVerifier {
+    verify(token: string): Promise<void>;
+}
+interface KeyFetcher {
+    fetchPublicKeys(): Promise<{
+        [key: string]: string;
+    }>;
+}
+export declare class JwksFetcher implements KeyFetcher {
+    private publicKeys;
+    private publicKeysExpireAt;
+    private client;
+    constructor(jwksUrl: string);
+    fetchPublicKeys(): Promise<{
+        [key: string]: string;
+    }>;
+    private shouldRefresh;
+    private refresh;
+}
+/**
+ * Class to fetch public keys from a client certificates URL.
+ */
+export declare class UrlKeyFetcher implements KeyFetcher {
+    private clientCertUrl;
+    private readonly httpAgent?;
+    private publicKeys;
+    private publicKeysExpireAt;
+    constructor(clientCertUrl: string, httpAgent?: Agent | undefined);
+    /**
+     * Fetches the public keys for the Google certs.
+     *
+     * @returns A promise fulfilled with public keys for the Google certs.
+     */
+    fetchPublicKeys(): Promise<{
+        [key: string]: string;
+    }>;
+    /**
+     * Checks if the cached public keys need to be refreshed.
+     *
+     * @returns Whether the keys should be fetched from the client certs url or not.
+     */
+    private shouldRefresh;
+    private refresh;
+}
+/**
+ * Class for verifying JWT signature with a public key.
+ */
+export declare class PublicKeySignatureVerifier implements SignatureVerifier {
+    private keyFetcher;
+    constructor(keyFetcher: KeyFetcher);
+    static withCertificateUrl(clientCertUrl: string, httpAgent?: Agent): PublicKeySignatureVerifier;
+    static withJwksUrl(jwksUrl: string): PublicKeySignatureVerifier;
+    verify(token: string): Promise<void>;
+    private verifyWithoutKid;
+    private verifyWithAllKeys;
+}
+/**
+ * Class for verifying unsigned (emulator) JWTs.
+ */
+export declare class EmulatorSignatureVerifier implements SignatureVerifier {
+    verify(token: string): Promise<void>;
+}
+/**
+ * Verifies the signature of a JWT using the provided secret or a function to fetch
+ * the secret or public key.
+ *
+ * @param token - The JWT to be verified.
+ * @param secretOrPublicKey - The secret or a function to fetch the secret or public key.
+ * @param options - JWT verification options.
+ * @returns A Promise resolving for a token with a valid signature.
+ */
+export declare function verifyJwtSignature(token: string, secretOrPublicKey: jwt.Secret | jwt.GetPublicKeyOrSecret, options?: jwt.VerifyOptions): Promise<void>;
+/**
+ * Decodes general purpose Firebase JWTs.
+ *
+ * @param jwtToken - JWT token to be decoded.
+ * @returns Decoded token containing the header and payload.
+ */
+export declare function decodeJwt(jwtToken: string): Promise<DecodedToken>;
+/**
+ * Jwt error code structure.
+ *
+ * @param code - The error code.
+ * @param message - The error message.
+ * @constructor
+ */
+export declare class JwtError extends Error {
+    readonly code: JwtErrorCode;
+    readonly message: string;
+    constructor(code: JwtErrorCode, message: string);
+}
+/**
+ * JWT error codes.
+ */
+export declare enum JwtErrorCode {
+    INVALID_ARGUMENT = "invalid-argument",
+    INVALID_CREDENTIAL = "invalid-credential",
+    TOKEN_EXPIRED = "token-expired",
+    INVALID_SIGNATURE = "invalid-token",
+    NO_MATCHING_KID = "no-matching-kid-error",
+    NO_KID_IN_HEADER = "no-kid-error",
+    KEY_FETCH_ERROR = "key-fetch-error"
+}
+export {};

package/lib/utils/jwt.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.1 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.
@@ -98,7 +98,7 @@ var UrlKeyFetcher = /** @class */ (function () {
     /**
      * Fetches the public keys for the Google certs.
      *
-     * @return A promise fulfilled with public keys for the Google certs.
+     * @returns A promise fulfilled with public keys for the Google certs.
      */
     UrlKeyFetcher.prototype.fetchPublicKeys = function () {
         if (this.shouldRefresh()) {
@@ -165,7 +165,7 @@ var UrlKeyFetcher = /** @class */ (function () {
 }());
 exports.UrlKeyFetcher = UrlKeyFetcher;
 /**
- * Class for verifing JWT signature with a public key.
+ * Class for verifying JWT signature with a public key.
  */
 var PublicKeySignatureVerifier = /** @class */ (function () {
     function PublicKeySignatureVerifier(keyFetcher) {
@@ -223,7 +223,7 @@ var PublicKeySignatureVerifier = /** @class */ (function () {
 }());
 exports.PublicKeySignatureVerifier = PublicKeySignatureVerifier;
 /**
- * Class for verifing unsigned (emulator) JWTs.
+ * Class for verifying unsigned (emulator) JWTs.
  */
 var EmulatorSignatureVerifier = /** @class */ (function () {
     function EmulatorSignatureVerifier() {
@@ -238,7 +238,7 @@ exports.EmulatorSignatureVerifier = EmulatorSignatureVerifier;
 /**
  * Provides a callback to fetch public keys.
  *
- * @param fetcher KeyFetcher to fetch the keys from.
+ * @param fetcher - KeyFetcher to fetch the keys from.
  * @returns A callback function that can be used to get keys in `jsonwebtoken`.
  */
 function getKeyCallback(fetcher) {
@@ -264,9 +264,9 @@ function getKeyCallback(fetcher) {
  * Verifies the signature of a JWT using the provided secret or a function to fetch
  * the secret or public key.
  *
- * @param token The JWT to be verfied.
- * @param secretOrPublicKey The secret or a function to fetch the secret or public key.
- * @param options JWT verification options.
+ * @param token - The JWT to be verified.
+ * @param secretOrPublicKey - The secret or a function to fetch the secret or public key.
+ * @param options - JWT verification options.
  * @returns A Promise resolving for a token with a valid signature.
  */
 function verifyJwtSignature(token, secretOrPublicKey, options) {
@@ -303,7 +303,7 @@ exports.verifyJwtSignature = verifyJwtSignature;
 /**
  * Decodes general purpose Firebase JWTs.
  *
- * @param jwtToken JWT token to be decoded.
+ * @param jwtToken - JWT token to be decoded.
  * @returns Decoded token containing the header and payload.
  */
 function decodeJwt(jwtToken) {
@@ -324,8 +324,8 @@ exports.decodeJwt = decodeJwt;
 /**
  * Jwt error code structure.
  *
- * @param code The error code.
- * @param message The error message.
+ * @param code - The error code.
+ * @param message - The error message.
  * @constructor
  */
 var JwtError = /** @class */ (function (_super) {