firebase-functions 7.1.1 → 7.2.0

package/lib/v2/options.d.ts

@@ -18,6 +18,32 @@ export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";
  * List of available options for `IngressSettings`.
  */
 export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";
+/**
+ * Interface for a direct VPC network connection.
+ * At least one of network or subnetwork must be specified.
+ */
+export interface NetworkInterface {
+    /**
+     * Network to use for VPC direct connect.
+     * network or subnetwork must be specified to use VPC direct connect, though
+     * both can be specified as well. "default" is an acceptable value.
+     * Mutually exclusive with vpcConnector.
+     */
+    network?: string | Expression<string> | ResetValue;
+    /**
+     * Subnetwork to use for VPC direct connect.
+     * network or subnetwork must be specified to use VPC direct connect, though
+     * both can be specified as well. "default" is an acceptable value.
+     * Mutually exclusive with vpcConnector.
+     */
+    subnetwork?: string | Expression<string> | ResetValue;
+    /**
+     * Tags for VPC traffic.
+     * An optional field for VPC direct connect
+     * mutually exclusive with vpcConnector.
+     */
+    tags?: string | string[] | Expression<string> | Expression<string[]> | ResetValue;
+}
 /**
  * `GlobalOptions` are options that can be set across an entire project.
  * These options are common to HTTPS and event handling functions.
@@ -82,12 +108,21 @@ export interface GlobalOptions {
     cpu?: number | "gcf_gen1";
     /**
      * Connect a function to a specified VPC connector.
+     * Mutually exclusive with networkInterface
      */
     vpcConnector?: string | Expression<string> | ResetValue;
     /**
      * Egress settings for VPC connector.
      */
     vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;
+    /**
+     * An alias for vpcConnectorEgressSettings.
+     */
+    vpcEgress?: VpcEgressSetting | ResetValue;
+    /**
+     * Network Interface to use with VPC Direct Connect
+     */
+    networkInterface?: NetworkInterface | ResetValue;
     /**
      * Specific service account for the function to run as.
      */

package/lib/v2/options.js

@@ -40,7 +40,15 @@ function getGlobalOptions() {
 */
 function optionsToTriggerAnnotations(opts) {
 	const annotation = {};
-	require_common_encoding.copyIfPresent(annotation, opts, "concurrency", "minInstances", "maxInstances", "ingressSettings", "labels", "vpcConnector", "vpcConnectorEgressSettings", "secrets");
+	require_common_encoding.copyIfPresent(annotation, opts, "concurrency", "minInstances", "maxInstances", "ingressSettings", "labels", "vpcConnector", "secrets");
+	const vpcEgress = opts.vpcEgress ?? opts.vpcConnectorEgressSettings;
+	if (vpcEgress !== undefined) {
+		if (vpcEgress === null || vpcEgress instanceof require_common_options.ResetValue) {
+			annotation.vpcConnectorEgressSettings = null;
+		} else {
+			annotation.vpcConnectorEgressSettings = vpcEgress;
+		}
+	}
 	require_common_encoding.convertIfPresent(annotation, opts, "availableMemoryMb", "memory", (mem) => {
 		return MemoryOptionToMB[mem];
 	});
@@ -65,12 +73,33 @@ function optionsToEndpoint(opts) {
 	const endpoint = {};
 	require_common_encoding.copyIfPresent(endpoint, opts, "omit", "concurrency", "minInstances", "maxInstances", "ingressSettings", "labels", "timeoutSeconds", "cpu");
 	require_common_encoding.convertIfPresent(endpoint, opts, "serviceAccountEmail", "serviceAccount");
-	if (opts.vpcConnector !== undefined) {
-		if (opts.vpcConnector === null || opts.vpcConnector instanceof require_common_options.ResetValue) {
+	if (opts.vpcEgress && opts.vpcConnectorEgressSettings) {
+		require_logger_index.warn("vpcEgress and vpcConnectorEgressSettings are both set. Using vpcEgress");
+	}
+	const vpcEgress = opts.vpcEgress ?? opts.vpcConnectorEgressSettings;
+	const connector = opts.vpcConnector;
+	const networkInterface = opts.networkInterface;
+	if (connector !== undefined || vpcEgress !== undefined || networkInterface !== undefined) {
+		const resetConnector = connector === null || connector instanceof require_common_options.ResetValue;
+		const hasConnector = !!connector;
+		const resetNetwork = networkInterface === null || networkInterface instanceof require_common_options.ResetValue;
+		const hasNetwork = !!networkInterface && !resetNetwork;
+		if (hasNetwork) {
+			if (!networkInterface.network && !networkInterface.subnetwork) {
+				throw new Error("At least one of network or subnetwork must be specified in networkInterface.");
+			}
+		}
+		if (hasNetwork && hasConnector) {
+			throw new Error("Cannot set both vpcConnector and networkInterface");
+		} else if (resetConnector && !hasNetwork || resetNetwork && !hasConnector) {
 			endpoint.vpc = require_common_options.RESET_VALUE;
 		} else {
-			const vpc = { connector: opts.vpcConnector };
-			require_common_encoding.convertIfPresent(vpc, opts, "egressSettings", "vpcConnectorEgressSettings");
+			const vpc = {};
+			require_common_encoding.convertIfPresent(vpc, opts, "connector", "vpcConnector");
+			if (vpcEgress !== undefined) {
+				vpc.egressSettings = vpcEgress;
+			}
+			require_common_encoding.convertIfPresent(vpc, opts, "networkInterfaces", "networkInterface", (a) => [a]);
 			endpoint.vpc = vpc;
 		}
 	}

package/lib/v2/providers/database.d.ts

@@ -19,7 +19,17 @@ export interface RawRTDBCloudEvent extends CloudEvent<RawRTDBCloudEventData> {
     instance: string;
     ref: string;
     location: string;
+    authtype: AuthType;
+    authid?: string;
 }
+/**
+ * AuthType defines the possible values for the authType field in a Realtime Database event.
+ * - app_user: an end user of an application..
+ * - admin: an admin user of an application. In the context of impersonate endpoints used by the admin SDK, the impersonator.
+ * - unauthenticated: no credentials were used to authenticate the change that triggered the occurrence.
+ * - unknown: a general type to capture all other principals not captured in the other auth types.
+ */
+export type AuthType = "app_user" | "admin" | "unauthenticated" | "unknown";
 /** A CloudEvent that contains a DataSnapshot or a Change<DataSnapshot> */
 export interface DatabaseEvent<T, Params = Record<string, string>> extends CloudEvent<T> {
     /** The domain of the database instance */
@@ -35,6 +45,14 @@ export interface DatabaseEvent<T, Params = Record<string, string>> extends Cloud
      * Only named capture groups will be populated - {key}, {key=*}, {key=**}
      */
     params: Params;
+    /**
+     * The type of principal that triggered the event.
+     */
+    authType: AuthType;
+    /**
+     * The unique identifier of the principal.
+     */
+    authId?: string;
 }
 /** ReferenceOptions extend EventHandlerOptions with provided ref and optional instance  */
 export interface ReferenceOptions<Ref extends string = string> extends options.EventHandlerOptions {

package/lib/v2/providers/database.js

@@ -106,9 +106,13 @@ function makeDatabaseEvent(event, data, instance, params) {
 		...event,
 		firebaseDatabaseHost: event.firebasedatabasehost,
 		data: snapshot,
-		params
+		params,
+		authType: event.authtype || "unknown",
+		authId: event.authid
 	};
 	delete databaseEvent.firebasedatabasehost;
+	delete databaseEvent.authtype;
+	delete databaseEvent.authid;
 	return databaseEvent;
 }
 /** @hidden */
@@ -122,9 +126,13 @@ function makeChangedDatabaseEvent(event, instance, params) {
 			before,
 			after
 		},
-		params
+		params,
+		authType: event.authtype || "unknown",
+		authId: event.authid
 	};
 	delete databaseEvent.firebasedatabasehost;
+	delete databaseEvent.authtype;
+	delete databaseEvent.authid;
 	return databaseEvent;
 }
 /** @internal */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "7.1.1",
+  "version": "7.2.0",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",