firebase-admin 11.4.1 → 11.5.0

package/lib/app/core.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

package/lib/app/core.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/app/credential-factory.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

package/lib/app/credential-factory.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/app/credential-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2020 Google Inc.
@@ -86,6 +86,28 @@ export declare class RefreshTokenCredential implements Credential {
     constructor(refreshTokenPathOrObject: string | object, httpAgent?: Agent | undefined, implicit?: boolean);
     getAccessToken(): Promise<GoogleOAuthAccessToken>;
 }
+/**
+ * Implementation of Credential that uses impersonated service account.
+ */
+export declare class ImpersonatedServiceAccountCredential implements Credential {
+    private readonly httpAgent?;
+    readonly implicit: boolean;
+    private readonly impersonatedServiceAccount;
+    private readonly httpClient;
+    /**
+     * Creates a new ImpersonatedServiceAccountCredential from the given parameters.
+     *
+     * @param impersonatedServiceAccountPathOrObject - Impersonated Service account json object or
+     * path to a service account json file.
+     * @param httpAgent - Optional http.Agent to use when calling the remote token server.
+     * @param implicit - An optional boolean indicating whether this credential was implicitly
+     *   discovered from the environment, as opposed to being explicitly specified by the developer.
+     *
+     * @constructor
+     */
+    constructor(impersonatedServiceAccountPathOrObject: string | object, httpAgent?: Agent | undefined, implicit?: boolean);
+    getAccessToken(): Promise<GoogleOAuthAccessToken>;
+}
 /**
  * Checks if the given credential was loaded via the application default credentials mechanism. This
  * includes all ComputeEngineCredential instances, and the ServiceAccountCredential and RefreshTokenCredential

package/lib/app/credential-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license
@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getApplicationDefault = exports.isApplicationDefault = exports.RefreshTokenCredential = exports.ComputeEngineCredential = exports.ServiceAccountCredential = void 0;
+exports.getApplicationDefault = exports.isApplicationDefault = exports.ImpersonatedServiceAccountCredential = exports.RefreshTokenCredential = exports.ComputeEngineCredential = exports.ServiceAccountCredential = void 0;
 const fs = require("fs");
 const os = require("os");
 const path = require("path");
@@ -297,6 +297,90 @@ class RefreshToken {
         }
     }
 }
+/**
+ * Implementation of Credential that uses impersonated service account.
+ */
+class ImpersonatedServiceAccountCredential {
+    /**
+     * Creates a new ImpersonatedServiceAccountCredential from the given parameters.
+     *
+     * @param impersonatedServiceAccountPathOrObject - Impersonated Service account json object or
+     * path to a service account json file.
+     * @param httpAgent - Optional http.Agent to use when calling the remote token server.
+     * @param implicit - An optional boolean indicating whether this credential was implicitly
+     *   discovered from the environment, as opposed to being explicitly specified by the developer.
+     *
+     * @constructor
+     */
+    constructor(impersonatedServiceAccountPathOrObject, httpAgent, implicit = false) {
+        this.httpAgent = httpAgent;
+        this.implicit = implicit;
+        this.impersonatedServiceAccount = (typeof impersonatedServiceAccountPathOrObject === 'string') ?
+            ImpersonatedServiceAccount.fromPath(impersonatedServiceAccountPathOrObject)
+            : new ImpersonatedServiceAccount(impersonatedServiceAccountPathOrObject);
+        this.httpClient = new api_request_1.HttpClient();
+    }
+    getAccessToken() {
+        const postData = 'client_id=' + this.impersonatedServiceAccount.clientId + '&' +
+            'client_secret=' + this.impersonatedServiceAccount.clientSecret + '&' +
+            'refresh_token=' + this.impersonatedServiceAccount.refreshToken + '&' +
+            'grant_type=refresh_token';
+        const request = {
+            method: 'POST',
+            url: `https://${REFRESH_TOKEN_HOST}${REFRESH_TOKEN_PATH}`,
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded',
+            },
+            data: postData,
+            httpAgent: this.httpAgent,
+        };
+        return requestAccessToken(this.httpClient, request);
+    }
+}
+exports.ImpersonatedServiceAccountCredential = ImpersonatedServiceAccountCredential;
+/**
+ * A struct containing the properties necessary to use impersonated service account JSON credentials.
+ */
+class ImpersonatedServiceAccount {
+    constructor(json) {
+        const sourceCredentials = json['source_credentials'];
+        if (sourceCredentials) {
+            copyAttr(this, sourceCredentials, 'clientId', 'client_id');
+            copyAttr(this, sourceCredentials, 'clientSecret', 'client_secret');
+            copyAttr(this, sourceCredentials, 'refreshToken', 'refresh_token');
+            copyAttr(this, sourceCredentials, 'type', 'type');
+        }
+        let errorMessage;
+        if (!util.isNonEmptyString(this.clientId)) {
+            errorMessage = 'Impersonated Service Account must contain a "source_credentials.client_id" property.';
+        }
+        else if (!util.isNonEmptyString(this.clientSecret)) {
+            errorMessage = 'Impersonated Service Account must contain a "source_credentials.client_secret" property.';
+        }
+        else if (!util.isNonEmptyString(this.refreshToken)) {
+            errorMessage = 'Impersonated Service Account must contain a "source_credentials.refresh_token" property.';
+        }
+        else if (!util.isNonEmptyString(this.type)) {
+            errorMessage = 'Impersonated Service Account must contain a "source_credentials.type" property.';
+        }
+        if (typeof errorMessage !== 'undefined') {
+            throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, errorMessage);
+        }
+    }
+    /*
+     * Tries to load a ImpersonatedServiceAccount from a path. Throws if the path doesn't exist or the
+     * data at the path is invalid.
+     */
+    static fromPath(filePath) {
+        try {
+            return new ImpersonatedServiceAccount(JSON.parse(fs.readFileSync(filePath, 'utf8')));
+        }
+        catch (error) {
+            // Throw a nicely formed error message if the file contents cannot be parsed
+            throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, 'Failed to parse impersonated service account file: ' + error);
+        }
+    }
+}
 /**
  * Checks if the given credential was loaded via the application default credentials mechanism. This
  * includes all ComputeEngineCredential instances, and the ServiceAccountCredential and RefreshTokenCredential
@@ -308,19 +392,19 @@ class RefreshToken {
 function isApplicationDefault(credential) {
     return credential instanceof ComputeEngineCredential ||
         (credential instanceof ServiceAccountCredential && credential.implicit) ||
-        (credential instanceof RefreshTokenCredential && credential.implicit);
+        (credential instanceof RefreshTokenCredential && credential.implicit) ||
+        (credential instanceof ImpersonatedServiceAccountCredential && credential.implicit);
 }
 exports.isApplicationDefault = isApplicationDefault;
 function getApplicationDefault(httpAgent) {
     if (process.env.GOOGLE_APPLICATION_CREDENTIALS) {
-        return credentialFromFile(process.env.GOOGLE_APPLICATION_CREDENTIALS, httpAgent);
+        return credentialFromFile(process.env.GOOGLE_APPLICATION_CREDENTIALS, httpAgent, false);
     }
     // It is OK to not have this file. If it is present, it must be valid.
     if (GCLOUD_CREDENTIAL_PATH) {
-        const refreshToken = readCredentialFile(GCLOUD_CREDENTIAL_PATH, true);
-        if (refreshToken) {
-            return new RefreshTokenCredential(refreshToken, httpAgent, true);
-        }
+        const credential = credentialFromFile(GCLOUD_CREDENTIAL_PATH, httpAgent, true);
+        if (credential)
+            return credential;
     }
     return new ComputeEngineCredential(httpAgent);
 }
@@ -392,9 +476,12 @@ function getDetailFromResponse(response) {
     }
     return response.text || 'Missing error payload';
 }
-function credentialFromFile(filePath, httpAgent) {
-    const credentialsFile = readCredentialFile(filePath);
+function credentialFromFile(filePath, httpAgent, ignoreMissing) {
+    const credentialsFile = readCredentialFile(filePath, ignoreMissing);
     if (typeof credentialsFile !== 'object' || credentialsFile === null) {
+        if (ignoreMissing) {
+            return null;
+        }
         throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, 'Failed to parse contents of the credentials file as an object');
     }
     if (credentialsFile.type === 'service_account') {
@@ -403,6 +490,9 @@ function credentialFromFile(filePath, httpAgent) {
     if (credentialsFile.type === 'authorized_user') {
         return new RefreshTokenCredential(credentialsFile, httpAgent, true);
     }
+    if (credentialsFile.type === 'impersonated_service_account') {
+        return new ImpersonatedServiceAccountCredential(credentialsFile, httpAgent, true);
+    }
     throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, 'Invalid contents in the credentials file');
 }
 function readCredentialFile(filePath, ignoreMissing) {

package/lib/app/credential.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

package/lib/app/credential.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/app/firebase-app.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2017 Google Inc.

package/lib/app/firebase-app.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/app/firebase-namespace.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2017 Google Inc.

package/lib/app/firebase-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/app/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

package/lib/app/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/app/lifecycle.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

package/lib/app/lifecycle.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/app-check/app-check-api-client-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

package/lib/app-check/app-check-api-client-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/app-check/app-check-api.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

package/lib/app-check/app-check-api.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/app-check/app-check-namespace.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/app-check/app-check-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/app-check/app-check.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

package/lib/app-check/app-check.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/app-check/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

package/lib/app-check/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/app-check/token-generator.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

package/lib/app-check/token-generator.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/app-check/token-verifier.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/app-check/token-verifier.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/auth/action-code-settings-builder.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * Copyright 2018 Google Inc.
  *

package/lib/auth/action-code-settings-builder.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.

package/lib/auth/auth-api-request.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2017 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * Copyright 2018 Google Inc.
  *

package/lib/auth/auth-config.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/auth/auth-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/auth/auth.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2017 Google Inc.

package/lib/auth/auth.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/auth/base-auth.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/auth/identifier.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/auth/identifier.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

package/lib/auth/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/auth/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

package/lib/auth/project-config-manager.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 import { ProjectConfig, UpdateProjectConfigRequest } from './project-config';
 /**
  * Defines the project config manager used to help manage project config related operations.

package/lib/auth/project-config-manager.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProjectConfigManager = void 0;

package/lib/auth/project-config.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 import { SmsRegionConfig } from './auth-config';
 /**
  * Interface representing the properties to update on the provided project config.

package/lib/auth/project-config.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProjectConfig = void 0;

package/lib/auth/tenant-manager.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * Copyright 2019 Google Inc.
  *

package/lib/auth/tenant-manager.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.

package/lib/auth/tenant.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * Copyright 2019 Google Inc.
  *

package/lib/auth/tenant.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.

package/lib/auth/token-generator.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2017 Google Inc.

package/lib/auth/token-generator.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/auth/token-verifier.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * Copyright 2018 Google Inc.
  *

package/lib/auth/token-verifier.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.

package/lib/auth/user-import-builder.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * Copyright 2018 Google Inc.
  *

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * @license
  * Copyright 2017 Google Inc.

package/lib/auth/user-record.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 "use strict";
 /*!
  * @license

package/lib/credential/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.4.1 */
+/*! firebase-admin v11.5.0 */
 /*!
  * Copyright 2020 Google Inc.
  *