firebase-functions 4.2.0 → 4.3.0

package/lib/v1/providers/testLab.d.ts

@@ -121,7 +121,7 @@ export declare class ResultStorage {
  * - `USE_DESTINATION_ARTIFACTS`: One or more of the test targets defined in the
  *   .xctestrun file specifies "UseDestinationArtifacts", which is disallowed.
  *
- * - `TEST_NON_APP_HOSTED`: XC tests which run on physical devices must have
+ * - `TEST_NOT_APP_HOSTED`: XC tests which run on physical devices must have
  *   "IsAppHostedTestBundle" == "true" in the xctestrun file.
  *
  * - `PLIST_CANNOT_BE_PARSED`: An Info.plist file in the XCTest zip could not be
@@ -136,7 +136,7 @@ export declare class ResultStorage {
  * - `INVALID_APK_PREVIEW_SDK`: APK is built for a preview SDK which is
  *   unsupported.
  */
-export declare type InvalidMatrixDetails = "DETAILS_UNAVAILABLE" | "MALFORMED_APK" | "MALFORMED_TEST_APK" | "NO_MANIFEST" | "NO_PACKAGE_NAME" | "INVALID_PACKAGE_NAME" | "TEST_SAME_AS_APP" | "NO_INSTRUMENTATION" | "NO_SIGNATURE" | "INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE" | "NO_TEST_RUNNER_CLASS" | "NO_LAUNCHER_ACTIVITY" | "FORBIDDEN_PERMISSIONS" | "INVALID_ROBO_DIRECTIVES" | "INVALID_RESOURCE_NAME" | "INVALID_DIRECTIVE_ACTION" | "TEST_LOOP_INTENT_FILTER_NOT_FOUND" | "SCENARIO_LABEL_NOT_DECLARED" | "SCENARIO_LABEL_MALFORMED" | "SCENARIO_NOT_DECLARED" | "DEVICE_ADMIN_RECEIVER" | "MALFORMED_XC_TEST_ZIP" | "BUILT_FOR_IOS_SIMULATOR" | "NO_TESTS_IN_XC_TEST_ZIP" | "USE_DESTINATION_ARTIFACTS" | "TEST_NOT_APP_HOSTED" | "PLIST_CANNOT_BE_PARSED" | "NO_CODE_APK" | "INVALID_INPUT_APK" | "INVALID_APK_PREVIEW_SDK";
+export type InvalidMatrixDetails = "DETAILS_UNAVAILABLE" | "MALFORMED_APK" | "MALFORMED_TEST_APK" | "NO_MANIFEST" | "NO_PACKAGE_NAME" | "INVALID_PACKAGE_NAME" | "TEST_SAME_AS_APP" | "NO_INSTRUMENTATION" | "NO_SIGNATURE" | "INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE" | "NO_TEST_RUNNER_CLASS" | "NO_LAUNCHER_ACTIVITY" | "FORBIDDEN_PERMISSIONS" | "INVALID_ROBO_DIRECTIVES" | "INVALID_RESOURCE_NAME" | "INVALID_DIRECTIVE_ACTION" | "TEST_LOOP_INTENT_FILTER_NOT_FOUND" | "SCENARIO_LABEL_NOT_DECLARED" | "SCENARIO_LABEL_MALFORMED" | "SCENARIO_NOT_DECLARED" | "DEVICE_ADMIN_RECEIVER" | "MALFORMED_XC_TEST_ZIP" | "BUILT_FOR_IOS_SIMULATOR" | "NO_TESTS_IN_XC_TEST_ZIP" | "USE_DESTINATION_ARTIFACTS" | "TEST_NOT_APP_HOSTED" | "PLIST_CANNOT_BE_PARSED" | "NO_CODE_APK" | "INVALID_INPUT_APK" | "INVALID_APK_PREVIEW_SDK";
 /**
  * The state (i.e. progress) of a TestMatrix.
  *
@@ -158,7 +158,7 @@ export declare type InvalidMatrixDetails = "DETAILS_UNAVAILABLE" | "MALFORMED_AP
  *   valid. E.g. the input file is not of the expected type, or is
  *   malformed/corrupt.
  */
-export declare type TestState = "VALIDATING" | "PENDING" | "FINISHED" | "ERROR" | "INVALID";
+export type TestState = "VALIDATING" | "PENDING" | "FINISHED" | "ERROR" | "INVALID";
 /**
  * Outcome summary for a finished TestMatrix.
  *
@@ -181,4 +181,4 @@ export declare type TestState = "VALIDATING" | "PENDING" | "FINISHED" | "ERROR"
  * - `SKIPPED`: All tests were skipped, for instance:
  *   - All device configurations were incompatible.
  */
-export declare type OutcomeSummary = "SUCCESS" | "FAILURE" | "INCONCLUSIVE" | "SKIPPED";
+export type OutcomeSummary = "SUCCESS" | "FAILURE" | "INCONCLUSIVE" | "SKIPPED";

package/lib/v2/index.d.ts

@@ -17,7 +17,8 @@ import * as storage from "./providers/storage";
 import * as tasks from "./providers/tasks";
 import * as remoteConfig from "./providers/remoteConfig";
 import * as testLab from "./providers/testLab";
-export { alerts, database, storage, https, identity, pubsub, logger, tasks, eventarc, scheduler, remoteConfig, testLab, };
+import * as firestore from "./providers/firestore";
+export { alerts, database, storage, https, identity, pubsub, logger, tasks, eventarc, scheduler, remoteConfig, testLab, firestore, };
 export { setGlobalOptions, GlobalOptions, SupportedRegion, MemoryOption, VpcEgressSetting, IngressSetting, EventHandlerOptions, } from "./options";
 export { CloudFunction, CloudEvent, ParamsOf } from "./core";
 export { Change } from "../common/change";

package/lib/v2/index.js

@@ -21,7 +21,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Change = exports.setGlobalOptions = exports.testLab = exports.remoteConfig = exports.scheduler = exports.eventarc = exports.tasks = exports.logger = exports.pubsub = exports.identity = exports.https = exports.storage = exports.database = exports.alerts = void 0;
+exports.Change = exports.setGlobalOptions = exports.firestore = exports.testLab = exports.remoteConfig = exports.scheduler = exports.eventarc = exports.tasks = exports.logger = exports.pubsub = exports.identity = exports.https = exports.storage = exports.database = exports.alerts = void 0;
 /**
  * The V2 API for Cloud Functions for Firebase.
  * This SDK also supports deep imports. For example, the namespace
@@ -53,6 +53,8 @@ const remoteConfig = require("./providers/remoteConfig");
 exports.remoteConfig = remoteConfig;
 const testLab = require("./providers/testLab");
 exports.testLab = testLab;
+const firestore = require("./providers/firestore");
+exports.firestore = firestore;
 var options_1 = require("./options");
 Object.defineProperty(exports, "setGlobalOptions", { enumerable: true, get: function () { return options_1.setGlobalOptions; } });
 var change_1 = require("../common/change");

package/lib/v2/options.d.ts

@@ -5,19 +5,19 @@ export { RESET_VALUE } from "../common/options";
 /**
  * List of all regions supported by Cloud Functions v2
  */
-export declare type SupportedRegion = "asia-northeast1" | "europe-north1" | "europe-west1" | "europe-west4" | "us-central1" | "us-east1" | "us-west1";
+export type SupportedRegion = "asia-northeast1" | "europe-north1" | "europe-west1" | "europe-west4" | "us-central1" | "us-east1" | "us-west1";
 /**
  * List of available memory options supported by Cloud Functions.
  */
-export declare type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";
+export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";
 /**
  * List of available options for VpcConnectorEgressSettings.
  */
-export declare type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";
+export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";
 /**
  * List of available options for IngressSettings.
  */
-export declare type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";
+export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";
 /**
  * GlobalOptions are options that can be set across an entire project.
  * These options are common to HTTPS and Event handling functions.
@@ -30,7 +30,7 @@ export interface GlobalOptions {
     /**
      * Region where functions should be deployed.
      */
-    region?: SupportedRegion | string;
+    region?: SupportedRegion | string | Expression<string> | ResetValue;
     /**
      * Amount of memory to allocate to a function.
      */
@@ -91,7 +91,7 @@ export interface GlobalOptions {
     /**
      * Specific service account for the function to run as.
      */
-    serviceAccount?: string | ResetValue;
+    serviceAccount?: string | Expression<string> | ResetValue;
     /**
      * Ingress settings which control where this function can be called from.
      */
@@ -140,9 +140,9 @@ export interface EventHandlerOptions extends Omit<GlobalOptions, "enforceAppChec
     /** Whether failed executions should be delivered again. */
     retry?: boolean | Expression<boolean> | ResetValue;
     /** Region of the EventArc trigger. */
-    region?: string;
+    region?: string | Expression<string> | ResetValue;
     /** The service account that EventArc should use to invoke this function. Requires the P4SA to have ActAs permission on this service account. */
-    serviceAccount?: string | ResetValue;
+    serviceAccount?: string | Expression<string> | ResetValue;
     /** The name of the channel where the function receives events. */
     channel?: string;
 }

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

@@ -31,7 +31,7 @@ export interface AlertEvent<T> extends CloudEvent<FirebaseAlertData<T>> {
     data: FirebaseAlertData<T>;
 }
 /** The underlying alert type of the Firebase Alerts provider. */
-export declare type AlertType = "crashlytics.newFatalIssue" | "crashlytics.newNonfatalIssue" | "crashlytics.regression" | "crashlytics.stabilityDigest" | "crashlytics.velocity" | "crashlytics.newAnrIssue" | "billing.planUpdate" | "billing.automatedPlanUpdate" | "appDistribution.newTesterIosDevice" | "appDistribution.inAppFeedback" | "performance.threshold" | string;
+export type AlertType = "crashlytics.newFatalIssue" | "crashlytics.newNonfatalIssue" | "crashlytics.regression" | "crashlytics.stabilityDigest" | "crashlytics.velocity" | "crashlytics.newAnrIssue" | "billing.planUpdate" | "billing.automatedPlanUpdate" | "appDistribution.newTesterIosDevice" | "appDistribution.inAppFeedback" | "performance.threshold" | string;
 /**
  * Configuration for Firebase Alert functions.
  */
@@ -47,7 +47,7 @@ export interface FirebaseAlertOptions extends options.EventHandlerOptions {
     /**
      * Region where functions should be deployed.
      */
-    region?: options.SupportedRegion | string;
+    region?: options.SupportedRegion | string | Expression<string> | ResetValue;
     /**
      * Amount of memory to allocate to a function.
      * A value of null restores the defaults of 256MB.
@@ -107,7 +107,7 @@ export interface FirebaseAlertOptions extends options.EventHandlerOptions {
      * Specific service account for the function to run as.
      * A value of null restores the default service account.
      */
-    serviceAccount?: string | ResetValue;
+    serviceAccount?: string | Expression<string> | ResetValue;
     /**
      * Ingress settings which control where this function can be called from.
      * A value of null turns off ingress settings.

package/lib/v2/providers/alerts/appDistribution.d.ts

@@ -70,7 +70,7 @@ export interface AppDistributionOptions extends options.EventHandlerOptions {
     /**
      * Region where functions should be deployed.
      */
-    region?: options.SupportedRegion | string;
+    region?: options.SupportedRegion | string | Expression<string> | ResetValue;
     /**
      * Amount of memory to allocate to a function.
      */
@@ -131,7 +131,7 @@ export interface AppDistributionOptions extends options.EventHandlerOptions {
     /**
      * Specific service account for the function to run as.
      */
-    serviceAccount?: string | ResetValue;
+    serviceAccount?: string | Expression<string> | ResetValue;
     /**
      * Ingress settings which control where this function can be called from.
      */

package/lib/v2/providers/alerts/crashlytics.d.ts

@@ -136,7 +136,7 @@ export interface CrashlyticsOptions extends options.EventHandlerOptions {
     /**
      * Region where functions should be deployed.
      */
-    region?: options.SupportedRegion | string;
+    region?: options.SupportedRegion | string | Expression<string> | ResetValue;
     /**
      * Amount of memory to allocate to a function.
      */
@@ -197,7 +197,7 @@ export interface CrashlyticsOptions extends options.EventHandlerOptions {
     /**
      * Specific service account for the function to run as.
      */
-    serviceAccount?: string | ResetValue;
+    serviceAccount?: string | Expression<string> | ResetValue;
     /**
      * Ingress settings which control where this function can be called from.
      */

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

@@ -58,7 +58,7 @@ export interface ReferenceOptions<Ref extends string = string> extends options.E
     /**
      * Region where functions should be deployed.
      */
-    region?: options.SupportedRegion | string;
+    region?: options.SupportedRegion | string | Expression<string> | ResetValue;
     /**
      * Amount of memory to allocate to a function.
      */
@@ -71,7 +71,7 @@ export interface ReferenceOptions<Ref extends string = string> extends options.E
      * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
      * function depends on the type of function: Event handling functions have a
      * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
-     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
      * timeout of 1,800s (30 minutes)
      */
     timeoutSeconds?: number | Expression<number> | ResetValue;
@@ -119,7 +119,7 @@ export interface ReferenceOptions<Ref extends string = string> extends options.E
     /**
      * Specific service account for the function to run as.
      */
-    serviceAccount?: string | ResetValue;
+    serviceAccount?: string | Expression<string> | ResetValue;
     /**
      * Ingress settings which control where this function can be called from.
      */

package/lib/v2/providers/database.js

@@ -178,7 +178,7 @@ function onChangedOperation(eventType, referenceOrOpts, handler) {
     // wrap the handler
     const func = (raw) => {
         const event = raw;
-        const instanceUrl = `https://${event.instance}.${event.firebasedatabasehost}`;
+        const instanceUrl = getInstance(event);
         const params = makeParams(event, pathPattern, instancePattern);
         const databaseEvent = makeChangedDatabaseEvent(event, instanceUrl, params);
         return (0, trace_1.wrapTraceContext)(handler)(databaseEvent);
@@ -196,7 +196,7 @@ function onOperation(eventType, referenceOrOpts, handler) {
     // wrap the handler
     const func = (raw) => {
         const event = raw;
-        const instanceUrl = `https://${event.instance}.${event.firebasedatabasehost}`;
+        const instanceUrl = getInstance(event);
         const params = makeParams(event, pathPattern, instancePattern);
         const data = eventType === exports.deletedEventType ? event.data.data : event.data.delta;
         const databaseEvent = makeDatabaseEvent(event, data, instanceUrl, params);
@@ -207,3 +207,9 @@ function onOperation(eventType, referenceOrOpts, handler) {
     return func;
 }
 exports.onOperation = onOperation;
+function getInstance(event) {
+    const emuHost = process.env.FIREBASE_DATABASE_EMULATOR_HOST;
+    return emuHost
+        ? `http://${emuHost}/?ns=${event.instance}`
+        : `https://${event.instance}.${event.firebasedatabasehost}`;
+}

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

@@ -35,7 +35,7 @@ export interface EventarcTriggerOptions extends options.EventHandlerOptions {
     /**
      * Region where functions should be deployed.
      */
-    region?: options.SupportedRegion | string;
+    region?: options.SupportedRegion | string | Expression<string> | ResetValue;
     /**
      * Amount of memory to allocate to a function.
      */
@@ -96,7 +96,7 @@ export interface EventarcTriggerOptions extends options.EventHandlerOptions {
     /**
      * Specific service account for the function to run as.
      */
-    serviceAccount?: string | ResetValue;
+    serviceAccount?: string | Expression<string> | ResetValue;
     /**
      * Ingress settings which control where this function can be called from.
      */

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

@@ -0,0 +1,91 @@
+import * as firestore from "firebase-admin/firestore";
+import { ParamsOf } from "../../common/params";
+import { Change, CloudEvent, CloudFunction } from "../core";
+import { EventHandlerOptions } from "../options";
+/** A Firestore DocumentSnapshot */
+export type DocumentSnapshot = firestore.DocumentSnapshot;
+/** A Firestore QueryDocumentSnapshot */
+export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;
+/** A CloudEvent that contains a DocumentSnapshot or a Change<DocumentSnapshot> */
+export interface FirestoreEvent<T, Params = Record<string, string>> extends CloudEvent<T> {
+    /** The location of the Firestore instance */
+    location: string;
+    /** The project identifier */
+    project: string;
+    /** The Firestore database */
+    database: string;
+    /** The Firestore namespace */
+    namespace: string;
+    /** The document path */
+    document: string;
+    /**
+     * An object containing the values of the path patterns.
+     * Only named capture groups will be populated - {key}, {key=*}, {key=**}
+     */
+    params: Params;
+}
+/** DocumentOptions extend EventHandlerOptions with provided document and optional database and namespace.  */
+export interface DocumentOptions<Document extends string = string> extends EventHandlerOptions {
+    /** The document path */
+    document: Document;
+    /** The Firestore database */
+    database?: string;
+    /** The Firestore namespace */
+    namespace?: string;
+}
+/**
+ * Event handler which triggers when a document is created, updated, or deleted in Firestore.
+ *
+ * @param document - The Firestore document path to trigger on.
+ * @param handler - Event handler which is run every time a Firestore create, update, or delete occurs.
+ */
+export declare function onDocumentWritten<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;
+/**
+ * Event handler which triggers when a document is created, updated, or deleted in Firestore.
+ *
+ * @param opts - Options that can be set on an individual event-handling function.
+ * @param handler - Event handler which is run every time a Firestore create, update, or delete occurs.
+ */
+export declare function onDocumentWritten<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;
+/**
+ * Event handler which triggers when a document is created in Firestore.
+ *
+ * @param document - The Firestore document path to trigger on.
+ * @param handler - Event handler which is run every time a Firestore create occurs.
+ */
+export declare function onDocumentCreated<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
+/**
+ * Event handler which triggers when a document is created in Firestore.
+ *
+ * @param opts - Options that can be set on an individual event-handling function.
+ * @param handler - Event handler which is run every time a Firestore create occurs.
+ */
+export declare function onDocumentCreated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
+/**
+ * Event handler which triggers when a document is updated in Firestore.
+ *
+ * @param document - The Firestore document path to trigger on.
+ * @param handler - Event handler which is run every time a Firestore update occurs.
+ */
+export declare function onDocumentUpdated<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
+/**
+ * Event handler which triggers when a document is updated in Firestore.
+ *
+ * @param opts - Options that can be set on an individual event-handling function.
+ * @param handler - Event handler which is run every time a Firestore update occurs.
+ */
+export declare function onDocumentUpdated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
+/**
+ * Event handler which triggers when a document is deleted in Firestore.
+ *
+ * @param document - The Firestore document path to trigger on.
+ * @param handler - Event handler which is run every time a Firestore delete occurs.
+ */
+export declare function onDocumentDeleted<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
+/**
+ * Event handler which triggers when a document is deleted in Firestore.
+ *
+ * @param opts - Options that can be set on an individual event-handling function.
+ * @param handler - Event handler which is run every time a Firestore delete occurs.
+ */
+export declare function onDocumentDeleted<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

package/lib/v2/providers/firestore.js

@@ -0,0 +1,243 @@
+"use strict";
+// The MIT License (MIT)
+//
+// Copyright (c) 2023 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onChangedOperation = exports.onOperation = exports.makeEndpoint = exports.makeChangedFirestoreEvent = exports.makeFirestoreEvent = exports.makeParams = exports.createBeforeSnapshot = exports.createSnapshot = exports.getOpts = exports.onDocumentDeleted = exports.onDocumentUpdated = exports.onDocumentCreated = exports.onDocumentWritten = exports.deletedEventType = exports.updatedEventType = exports.createdEventType = exports.writtenEventType = void 0;
+const logger = require("../../logger");
+const path_1 = require("../../common/utilities/path");
+const path_pattern_1 = require("../../common/utilities/path-pattern");
+const manifest_1 = require("../../runtime/manifest");
+const core_1 = require("../core");
+const options_1 = require("../options");
+const firestore_1 = require("../../common/providers/firestore");
+/** @internal */
+exports.writtenEventType = "google.cloud.firestore.document.v1.written";
+/** @internal */
+exports.createdEventType = "google.cloud.firestore.document.v1.created";
+/** @internal */
+exports.updatedEventType = "google.cloud.firestore.document.v1.updated";
+/** @internal */
+exports.deletedEventType = "google.cloud.firestore.document.v1.deleted";
+/**
+ * Event handler which triggers when a document is created, updated, or deleted in Firestore.
+ *
+ * @param documentOrOpts - Options or a string document path.
+ * @param handler - Event handler which is run every time a Firestore create, update, or delete occurs.
+ */
+function onDocumentWritten(documentOrOpts, handler) {
+    return onChangedOperation(exports.writtenEventType, documentOrOpts, handler);
+}
+exports.onDocumentWritten = onDocumentWritten;
+/**
+ * Event handler which triggers when a document is created in Firestore.
+ *
+ * @param documentOrOpts - Options or a string document path.
+ * @param handler - Event handler which is run every time a Firestore create occurs.
+ */
+function onDocumentCreated(documentOrOpts, handler) {
+    return onOperation(exports.createdEventType, documentOrOpts, handler);
+}
+exports.onDocumentCreated = onDocumentCreated;
+/**
+ * Event handler which triggers when a document is updated in Firestore.
+ *
+ * @param documentOrOpts - Options or a string document path.
+ * @param handler - Event handler which is run every time a Firestore update occurs.
+ */
+function onDocumentUpdated(documentOrOpts, handler) {
+    return onChangedOperation(exports.updatedEventType, documentOrOpts, handler);
+}
+exports.onDocumentUpdated = onDocumentUpdated;
+/**
+ * Event handler which triggers when a document is deleted in Firestore.
+ *
+ * @param documentOrOpts - Options or a string document path.
+ * @param handler - Event handler which is run every time a Firestore delete occurs.
+ */
+function onDocumentDeleted(documentOrOpts, handler) {
+    return onOperation(exports.deletedEventType, documentOrOpts, handler);
+}
+exports.onDocumentDeleted = onDocumentDeleted;
+/** @internal */
+function getOpts(documentOrOpts) {
+    let document;
+    let database;
+    let namespace;
+    let opts;
+    if (typeof documentOrOpts === "string") {
+        document = (0, path_1.normalizePath)(documentOrOpts);
+        database = "(default)";
+        namespace = "(default)";
+        opts = {};
+    }
+    else {
+        document = (0, path_1.normalizePath)(documentOrOpts.document);
+        database = documentOrOpts.database || "(default)";
+        namespace = documentOrOpts.namespace || "(default)";
+        opts = { ...documentOrOpts };
+        delete opts.document;
+        delete opts.database;
+        delete opts.namespace;
+    }
+    return {
+        document,
+        database,
+        namespace,
+        opts,
+    };
+}
+exports.getOpts = getOpts;
+/** @hidden */
+function getPath(event) {
+    return `projects/${event.project}/databases/${event.database}/documents/${event.document}`;
+}
+/** @internal */
+function createSnapshot(event) {
+    var _a, _b, _c, _d;
+    if (((_a = event.datacontenttype) === null || _a === void 0 ? void 0 : _a.includes("application/protobuf")) || Buffer.isBuffer(event.data)) {
+        return (0, firestore_1.createSnapshotFromProtobuf)(event.data, getPath(event));
+    }
+    else if ((_b = event.datacontenttype) === null || _b === void 0 ? void 0 : _b.includes("application/json")) {
+        return (0, firestore_1.createSnapshotFromJson)(event.data, event.source, (_c = event.data.value) === null || _c === void 0 ? void 0 : _c.createTime, (_d = event.data.value) === null || _d === void 0 ? void 0 : _d.updateTime);
+    }
+    else {
+        logger.error(`Cannot determine payload type, datacontenttype is ${event.datacontenttype}, failing out.`);
+        throw Error("Error: Cannot parse event payload.");
+    }
+}
+exports.createSnapshot = createSnapshot;
+/** @internal */
+function createBeforeSnapshot(event) {
+    var _a, _b, _c, _d;
+    if (((_a = event.datacontenttype) === null || _a === void 0 ? void 0 : _a.includes("application/protobuf")) || Buffer.isBuffer(event.data)) {
+        return (0, firestore_1.createBeforeSnapshotFromProtobuf)(event.data, getPath(event));
+    }
+    else if ((_b = event.datacontenttype) === null || _b === void 0 ? void 0 : _b.includes("application/json")) {
+        return (0, firestore_1.createBeforeSnapshotFromJson)(event.data, event.source, (_c = event.data.oldValue) === null || _c === void 0 ? void 0 : _c.createTime, (_d = event.data.oldValue) === null || _d === void 0 ? void 0 : _d.updateTime);
+    }
+    else {
+        logger.error(`Cannot determine payload type, datacontenttype is ${event.datacontenttype}, failing out.`);
+        throw Error("Error: Cannot parse event payload.");
+    }
+}
+exports.createBeforeSnapshot = createBeforeSnapshot;
+/** @internal */
+function makeParams(document, documentPattern) {
+    return {
+        ...documentPattern.extractMatches(document),
+    };
+}
+exports.makeParams = makeParams;
+/** @internal */
+function makeFirestoreEvent(eventType, event, params) {
+    const data = event.data
+        ? eventType === exports.createdEventType
+            ? createSnapshot(event)
+            : createBeforeSnapshot(event)
+        : undefined;
+    const firestoreEvent = {
+        ...event,
+        params,
+        data,
+    };
+    delete firestoreEvent.datacontenttype;
+    delete firestoreEvent.dataschema;
+    return firestoreEvent;
+}
+exports.makeFirestoreEvent = makeFirestoreEvent;
+/** @internal */
+function makeChangedFirestoreEvent(event, params) {
+    const data = event.data
+        ? core_1.Change.fromObjects(createBeforeSnapshot(event), createSnapshot(event))
+        : undefined;
+    const firestoreEvent = {
+        ...event,
+        params,
+        data,
+    };
+    delete firestoreEvent.datacontenttype;
+    delete firestoreEvent.dataschema;
+    return firestoreEvent;
+}
+exports.makeChangedFirestoreEvent = makeChangedFirestoreEvent;
+/** @internal */
+function makeEndpoint(eventType, opts, document, database, namespace) {
+    const baseOpts = (0, options_1.optionsToEndpoint)((0, options_1.getGlobalOptions)());
+    const specificOpts = (0, options_1.optionsToEndpoint)(opts);
+    const eventFilters = {
+        database,
+        namespace,
+    };
+    const eventFilterPathPatterns = {};
+    document.hasWildcards()
+        ? (eventFilterPathPatterns.document = document.getValue())
+        : (eventFilters.document = document.getValue());
+    return {
+        ...(0, manifest_1.initV2Endpoint)((0, options_1.getGlobalOptions)(), opts),
+        platform: "gcfv2",
+        ...baseOpts,
+        ...specificOpts,
+        labels: {
+            ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+            ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+        },
+        eventTrigger: {
+            eventType,
+            eventFilters,
+            eventFilterPathPatterns,
+            retry: !!opts.retry,
+        },
+    };
+}
+exports.makeEndpoint = makeEndpoint;
+/** @internal */
+function onOperation(eventType, documentOrOpts, handler) {
+    const { document, database, namespace, opts } = getOpts(documentOrOpts);
+    const documentPattern = new path_pattern_1.PathPattern(document);
+    // wrap the handler
+    const func = (raw) => {
+        const event = raw;
+        const params = makeParams(event.document, documentPattern);
+        const firestoreEvent = makeFirestoreEvent(eventType, event, params);
+        return handler(firestoreEvent);
+    };
+    func.run = handler;
+    func.__endpoint = makeEndpoint(eventType, opts, documentPattern, database, namespace);
+    return func;
+}
+exports.onOperation = onOperation;
+/** @internal */
+function onChangedOperation(eventType, documentOrOpts, handler) {
+    const { document, database, namespace, opts } = getOpts(documentOrOpts);
+    const documentPattern = new path_pattern_1.PathPattern(document);
+    // wrap the handler
+    const func = (raw) => {
+        const event = raw;
+        const params = makeParams(event.document, documentPattern);
+        const firestoreEvent = makeChangedFirestoreEvent(event, params);
+        return handler(firestoreEvent);
+    };
+    func.run = handler;
+    func.__endpoint = makeEndpoint(eventType, opts, documentPattern, database, namespace);
+    return func;
+}
+exports.onChangedOperation = onChangedOperation;

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

@@ -16,7 +16,7 @@ export interface HttpsOptions extends Omit<GlobalOptions, "region"> {
      */
     omit?: boolean | Expression<boolean>;
     /** HTTP functions can override global options and can specify multiple regions to deploy to. */
-    region?: SupportedRegion | string | Array<SupportedRegion | string>;
+    region?: SupportedRegion | string | Array<SupportedRegion | string> | Expression<string> | ResetValue;
     /** If true, allows CORS on requests to this function.
      * If this is a `string` or `RegExp`, allows requests from domains that match the provided value.
      * If this is an `Array`, allows requests from domains matching at least one entry of the array.
@@ -83,7 +83,7 @@ export interface HttpsOptions extends Omit<GlobalOptions, "region"> {
     /**
      * Specific service account for the function to run as.
      */
-    serviceAccount?: string | ResetValue;
+    serviceAccount?: string | Expression<string> | ResetValue;
     /**
      * Ingress settings which control where this function can be called from.
      */
@@ -113,7 +113,7 @@ export interface CallableOptions extends HttpsOptions {
 /**
  * Handles HTTPS requests.
  */
-export declare type HttpsFunction = ((
+export type HttpsFunction = ((
 /** An Express request object representing the HTTPS call to the function. */
 req: Request, 
 /** An Express response object, for this function to respond to callers. */

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

@@ -33,7 +33,7 @@ export interface BlockingOptions {
     /**
      * Region where functions should be deployed.
      */
-    region?: options.SupportedRegion | string;
+    region?: options.SupportedRegion | string | Expression<string> | ResetValue;
     /**
      * Amount of memory to allocate to a function.
      */
@@ -94,7 +94,7 @@ export interface BlockingOptions {
     /**
      * Specific service account for the function to run as.
      */
-    serviceAccount?: string | ResetValue;
+    serviceAccount?: string | Expression<string> | ResetValue;
     /**
      * Ingress settings which control where this function can be called from.
      */