firebase-admin 10.1.0 → 10.2.0

package/lib/utils/error.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * @license
@@ -469,6 +469,10 @@ var AuthClientErrorCode = /** @class */ (function () {
         code: 'invalid-email',
         message: 'The email address is improperly formatted.',
     };
+    AuthClientErrorCode.INVALID_NEW_EMAIL = {
+        code: 'invalid-new-email',
+        message: 'The new email address is improperly formatted.',
+    };
     AuthClientErrorCode.INVALID_ENROLLED_FACTORS = {
         code: 'invalid-enrolled-factors',
         message: 'The enrolled factors must be a valid array of MultiFactorInfo objects.',
@@ -926,6 +930,8 @@ var AUTH_SERVER_TO_CLIENT_CODE = {
     INVALID_DURATION: 'INVALID_SESSION_COOKIE_DURATION',
     // Invalid email provided.
     INVALID_EMAIL: 'INVALID_EMAIL',
+    // Invalid new email provided.
+    INVALID_NEW_EMAIL: 'INVALID_NEW_EMAIL',
     // Invalid tenant display name. This can be thrown on CreateTenant and UpdateTenant.
     INVALID_DISPLAY_NAME: 'INVALID_DISPLAY_NAME',
     // Invalid ID token provided.

package/lib/utils/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v10.2.0 */
 /*!
  * @license
  * Copyright 2017 Google Inc.
@@ -61,6 +61,28 @@ export declare function getExplicitProjectId(app: App): string | null;
  * @returns A project ID string or null.
  */
 export declare function findProjectId(app: App): Promise<string | null>;
+/**
+ * Returns the service account email 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 service account email from.
+ *
+ * @returns A service account email string or null.
+ */
+export declare function getExplicitServiceAccountEmail(app: App): string | null;
+/**
+ * Determines the service account email associated with a Firebase app. This method first
+ * checks if a service account email is explicitly specified in either the Firebase app options,
+ * credentials or the local environment in that order. If no explicit service account email is
+ * configured, but the SDK has been initialized with ComputeEngineCredentials, this
+ * method attempts to discover the service account email from the local metadata service.
+ *
+ * @param app - A Firebase app to get the service account email from.
+ *
+ * @returns A service account email ID string or null.
+ */
+export declare function findServiceAccountEmail(app: App): Promise<string | null>;
 /**
  * Encodes data using web-safe-base64.
  *
@@ -103,3 +125,23 @@ export declare function generateUpdateMask(obj: any, terminalPaths?: string[], r
  * digits, terminated by 's'.
  */
 export declare function transformMillisecondsToSecondsString(milliseconds: number): string;
+/**
+ * Internal type to represent a resource name
+ */
+export declare type ParsedResource = {
+    projectId?: string;
+    locationId?: string;
+    resourceId: string;
+};
+/**
+ * Parses the top level resources of a given resource name.
+ * Supports both full and partial resources names, example:
+ * `locations/{location}/functions/{functionName}`,
+ * `projects/{project}/locations/{location}/functions/{functionName}`, or {functionName}
+ * Does not support deeply nested resource names.
+ *
+ * @param resourceName - The resource name string.
+ * @param resourceIdKey - The key of the resource name to be parsed.
+ * @returns A parsed resource name object.
+ */
+export declare function parseResourceName(resourceName: string, resourceIdKey: string): ParsedResource;

package/lib/utils/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * @license
@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 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;
+exports.parseResourceName = exports.transformMillisecondsToSecondsString = exports.generateUpdateMask = exports.formatString = exports.toWebSafeBase64 = exports.findServiceAccountEmail = exports.getExplicitServiceAccountEmail = exports.findProjectId = exports.getExplicitProjectId = exports.addReadonlyGetter = exports.renameProperties = exports.getSdkVersion = void 0;
 var credential_internal_1 = require("../app/credential-internal");
 var validator = require("./validator");
 var sdkVersion;
@@ -114,6 +114,50 @@ function findProjectId(app) {
     return Promise.resolve(null);
 }
 exports.findProjectId = findProjectId;
+/**
+ * Returns the service account email 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 service account email from.
+ *
+ * @returns A service account email string or null.
+ */
+function getExplicitServiceAccountEmail(app) {
+    var options = app.options;
+    if (validator.isNonEmptyString(options.serviceAccountId)) {
+        return options.serviceAccountId;
+    }
+    var credential = app.options.credential;
+    if (credential instanceof credential_internal_1.ServiceAccountCredential) {
+        return credential.clientEmail;
+    }
+    return null;
+}
+exports.getExplicitServiceAccountEmail = getExplicitServiceAccountEmail;
+/**
+ * Determines the service account email associated with a Firebase app. This method first
+ * checks if a service account email is explicitly specified in either the Firebase app options,
+ * credentials or the local environment in that order. If no explicit service account email is
+ * configured, but the SDK has been initialized with ComputeEngineCredentials, this
+ * method attempts to discover the service account email from the local metadata service.
+ *
+ * @param app - A Firebase app to get the service account email from.
+ *
+ * @returns A service account email ID string or null.
+ */
+function findServiceAccountEmail(app) {
+    var accountId = getExplicitServiceAccountEmail(app);
+    if (accountId) {
+        return Promise.resolve(accountId);
+    }
+    var credential = app.options.credential;
+    if (credential instanceof credential_internal_1.ComputeEngineCredential) {
+        return credential.getServiceAccountEmail();
+    }
+    return Promise.resolve(null);
+}
+exports.findServiceAccountEmail = findServiceAccountEmail;
 /**
  * Encodes data using web-safe-base64.
  *
@@ -216,3 +260,29 @@ function transformMillisecondsToSecondsString(milliseconds) {
     return duration;
 }
 exports.transformMillisecondsToSecondsString = transformMillisecondsToSecondsString;
+/**
+ * Parses the top level resources of a given resource name.
+ * Supports both full and partial resources names, example:
+ * `locations/{location}/functions/{functionName}`,
+ * `projects/{project}/locations/{location}/functions/{functionName}`, or {functionName}
+ * Does not support deeply nested resource names.
+ *
+ * @param resourceName - The resource name string.
+ * @param resourceIdKey - The key of the resource name to be parsed.
+ * @returns A parsed resource name object.
+ */
+function parseResourceName(resourceName, resourceIdKey) {
+    if (!resourceName.includes('/')) {
+        return { resourceId: resourceName };
+    }
+    var CHANNEL_NAME_REGEX = new RegExp("^(projects/([^/]+)/)?locations/([^/]+)/" + resourceIdKey + "/([^/]+)$");
+    var match = CHANNEL_NAME_REGEX.exec(resourceName);
+    if (match === null) {
+        throw new Error('Invalid resource name format.');
+    }
+    var projectId = match[2];
+    var locationId = match[3];
+    var resourceId = match[4];
+    return { projectId: projectId, locationId: locationId, resourceId: resourceId };
+}
+exports.parseResourceName = parseResourceName;

package/lib/utils/jwt.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/utils/jwt.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/utils/validator.d.ts

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

package/lib/utils/validator.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.1.0 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * @license

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-admin",
-  "version": "10.1.0",
+  "version": "10.2.0",
   "description": "Firebase admin SDK for Node.js",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "license": "Apache-2.0",
@@ -71,12 +71,18 @@
       "auth": [
         "lib/auth"
       ],
+      "eventarc": [
+        "lib/eventarc"
+      ],
       "database": [
         "lib/database"
       ],
       "firestore": [
         "lib/firestore"
       ],
+      "functions": [
+        "lib/functions"
+      ],
       "installations": [
         "lib/installations"
       ],
@@ -121,10 +127,18 @@
       "require": "./lib/database/index.js",
       "import": "./lib/esm/database/index.js"
     },
+    "./eventarc": {
+      "require": "./lib/eventarc/index.js",
+      "import": "./lib/esm/eventarc/index.js"
+    },
     "./firestore": {
       "require": "./lib/firestore/index.js",
       "import": "./lib/esm/firestore/index.js"
     },
+    "./functions": {
+      "require": "./lib/functions/index.js",
+      "import": "./lib/esm/functions/index.js"
+    },
     "./installations": {
       "require": "./lib/installations/index.js",
       "import": "./lib/esm/installations/index.js"
@@ -159,13 +173,14 @@
     }
   },
   "dependencies": {
-    "@firebase/database-compat": "^0.1.1",
-    "@firebase/database-types": "^0.9.3",
+    "@firebase/database-compat": "^0.1.8",
+    "@firebase/database-types": "^0.9.7",
     "@types/node": ">=12.12.47",
     "dicer": "^0.3.0",
     "jsonwebtoken": "^8.5.1",
     "jwks-rsa": "^2.0.2",
-    "node-forge": "^1.3.1"
+    "node-forge": "^1.3.1",
+    "uuid": "^8.3.2"
   },
   "optionalDependencies": {
     "@google-cloud/firestore": "^4.15.1",
@@ -190,11 +205,13 @@
     "@types/request-promise": "^4.1.41",
     "@types/sinon": "^10.0.2",
     "@types/sinon-chai": "^3.0.0",
+    "@types/uuid": "^8.3.4",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
     "bcrypt": "^5.0.0",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.0.0",
+    "chai-exclude": "^2.1.0",
     "chalk": "^4.1.1",
     "child-process-promise": "^2.2.1",
     "del": "^6.0.0",
@@ -207,7 +224,7 @@
     "http-message-parser": "^0.0.34",
     "lodash": "^4.17.15",
     "minimist": "^1.2.6",
-    "mocha": "^9.1.2",
+    "mocha": "^10.0.0",
     "mz": "^2.7.0",
     "nock": "^13.0.0",
     "npm-run-all": "^4.1.5",