firebase-functions 4.2.1 → 4.3.0

package/lib/common/change.js

@@ -54,10 +54,6 @@ exports.applyFieldMask = applyFieldMask;
  *
  */
 class Change {
-    constructor(before, after) {
-        this.before = before;
-        this.after = after;
-    }
     /**
      * Factory method for creating a Change from a `before` object and an `after`
      * object.
@@ -76,5 +72,9 @@ class Change {
         }
         return Change.fromObjects(customizer(before || {}), customizer(json.after || {}));
     }
+    constructor(before, after) {
+        this.before = before;
+        this.after = after;
+    }
 }
 exports.Change = Change;

package/lib/common/encoding.d.ts

@@ -1,8 +1,9 @@
+import { Expression } from "../params";
 /**
  * A type alias used to annotate interfaces as using a google.protobuf.Duration.
  * This type is parsed/encoded as a string of seconds + the "s" prefix.
  */
-export declare type Duration = string;
+export type Duration = string;
 /** Get a google.protobuf.Duration for a number of seconds. */
 export declare function durationFromSeconds(s: number): Duration;
 /**
@@ -12,5 +13,5 @@ export declare function durationFromSeconds(s: number): Duration;
  */
 export declare function copyIfPresent<Src, Dest>(dest: Dest, src: Src, ...fields: Array<keyof Src & keyof Dest>): void;
 export declare function convertIfPresent<Src, Dest>(dest: Dest, src: Src, destField: keyof Dest, srcField: keyof Src, converter?: (from: any) => any): void;
-export declare function serviceAccountFromShorthand(serviceAccount: string): string | null;
+export declare function serviceAccountFromShorthand(serviceAccount: string | Expression<string>): string | Expression<string> | null;
 export declare function convertInvoker(invoker: string | string[]): string[];

package/lib/common/encoding.js

@@ -22,6 +22,7 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertInvoker = exports.serviceAccountFromShorthand = exports.convertIfPresent = exports.copyIfPresent = exports.durationFromSeconds = void 0;
+const params_1 = require("../params");
 /** Get a google.protobuf.Duration for a number of seconds. */
 function durationFromSeconds(s) {
     return `${s}s`;
@@ -60,6 +61,9 @@ function serviceAccountFromShorthand(serviceAccount) {
     if (serviceAccount === "default") {
         return null;
     }
+    else if (serviceAccount instanceof params_1.Expression) {
+        return serviceAccount;
+    }
     else if (serviceAccount.endsWith("@")) {
         if (!process.env.GCLOUD_PROJECT) {
             throw new Error(`Unable to determine email for service account '${serviceAccount}' because process.env.GCLOUD_PROJECT is not set.`);

package/lib/common/params.d.ts

@@ -3,13 +3,13 @@
  *
  * For example Split<"a/b/c", "/"> is ['a' | "b" | "c"]
  */
-export declare type Split<S extends string, D extends string> = string extends S ? string[] : S extends "" ? [] : S extends `${D}${infer Tail}` ? [...Split<Tail, D>] : S extends `${infer Head}${D}${infer Tail}` ? string extends Head ? [...Split<Tail, D>] : [Head, ...Split<Tail, D>] : [
+export type Split<S extends string, D extends string> = string extends S ? string[] : S extends "" ? [] : S extends `${D}${infer Tail}` ? [...Split<Tail, D>] : S extends `${infer Head}${D}${infer Tail}` ? string extends Head ? [...Split<Tail, D>] : [Head, ...Split<Tail, D>] : [
     S
 ];
 /**
  * A type that ensure that type S is not null or undefined.
  */
-export declare type NullSafe<S extends null | undefined | string> = S extends null ? never : S extends undefined ? never : S extends string ? S : never;
+export type NullSafe<S extends null | undefined | string> = S extends null ? never : S extends undefined ? never : S extends string ? S : never;
 /**
  * A type that extracts parameter name enclosed in bracket as string.
  * Ignore wildcard matches
@@ -18,7 +18,7 @@ export declare type NullSafe<S extends null | undefined | string> = S extends nu
  * For example, Extract<"{uid=*}"> is "uid".
  * For example, Extract<"{uid=**}"> is "uid".
  */
-export declare type Extract<Part extends string> = Part extends `{${infer Param}=**}` ? Param : Part extends `{${infer Param}=*}` ? Param : Part extends `{${infer Param}}` ? Param : never;
+export type Extract<Part extends string> = Part extends `{${infer Param}=**}` ? Param : Part extends `{${infer Param}=*}` ? Param : Part extends `{${infer Param}}` ? Param : never;
 /**
  * A type that maps all parameter capture gropus into keys of a record.
  * For example, ParamsOf<"users/{uid}"> is { uid: string }
@@ -27,6 +27,6 @@ export declare type Extract<Part extends string> = Part extends `{${infer Param}
  *
  * For flexibility reasons, ParamsOf<string> is Record<string, string>
  */
-export declare type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
+export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
     [Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
 };

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

@@ -0,0 +1 @@
+export {};

package/lib/common/providers/firestore.js

@@ -0,0 +1,106 @@
+"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.createBeforeSnapshotFromJson = exports.createSnapshotFromJson = exports.createBeforeSnapshotFromProtobuf = exports.createSnapshotFromProtobuf = void 0;
+const firestore = require("firebase-admin/firestore");
+const logger = require("../../logger");
+const app_1 = require("../../common/app");
+const compiledFirestore_1 = require("../../../protos/compiledFirestore");
+const encoder_1 = require("../../common/utilities/encoder");
+/** static-complied protobufs */
+const DocumentEventData = compiledFirestore_1.google.events.cloud.firestore.v1.DocumentEventData;
+let firestoreInstance;
+/** @hidden */
+function _getValueProto(data, resource, valueFieldName) {
+    const value = data === null || data === void 0 ? void 0 : data[valueFieldName];
+    if (typeof value === "undefined" ||
+        value === null ||
+        (typeof value === "object" && !Object.keys(value).length)) {
+        // Firestore#snapshot_ takes resource string instead of proto for a non-existent snapshot
+        return resource;
+    }
+    const proto = {
+        fields: (value === null || value === void 0 ? void 0 : value.fields) || {},
+        createTime: (0, encoder_1.dateToTimestampProto)(value === null || value === void 0 ? void 0 : value.createTime),
+        updateTime: (0, encoder_1.dateToTimestampProto)(value === null || value === void 0 ? void 0 : value.updateTime),
+        name: (value === null || value === void 0 ? void 0 : value.name) || resource,
+    };
+    return proto;
+}
+/** @internal */
+function createSnapshotFromProtobuf(data, path) {
+    if (!firestoreInstance) {
+        firestoreInstance = firestore.getFirestore((0, app_1.getApp)());
+    }
+    try {
+        const dataBuffer = Buffer.from(data);
+        const firestoreDecoded = DocumentEventData.decode(dataBuffer);
+        return firestoreInstance.snapshot_(firestoreDecoded.value || path, null, "protobufJS");
+    }
+    catch (err) {
+        logger.error("Failed to decode protobuf and create a snapshot.");
+        throw err;
+    }
+}
+exports.createSnapshotFromProtobuf = createSnapshotFromProtobuf;
+/** @internal */
+function createBeforeSnapshotFromProtobuf(data, path) {
+    if (!firestoreInstance) {
+        firestoreInstance = firestore.getFirestore((0, app_1.getApp)());
+    }
+    try {
+        const dataBuffer = Buffer.from(data);
+        const firestoreDecoded = DocumentEventData.decode(dataBuffer);
+        return firestoreInstance.snapshot_(firestoreDecoded.oldValue || path, null, "protobufJS");
+    }
+    catch (err) {
+        logger.error("Failed to decode protobuf and create a before snapshot.");
+        throw err;
+    }
+}
+exports.createBeforeSnapshotFromProtobuf = createBeforeSnapshotFromProtobuf;
+/** @internal */
+function createSnapshotFromJson(data, source, createTime, updateTime) {
+    if (!firestoreInstance) {
+        firestoreInstance = firestore.getFirestore((0, app_1.getApp)());
+    }
+    const valueProto = _getValueProto(data, source, "value");
+    let timeString = createTime || updateTime;
+    if (!timeString) {
+        logger.warn("Snapshot has no readTime. Using now()");
+        timeString = new Date().toISOString();
+    }
+    const readTime = (0, encoder_1.dateToTimestampProto)(timeString);
+    return firestoreInstance.snapshot_(valueProto, readTime, "json");
+}
+exports.createSnapshotFromJson = createSnapshotFromJson;
+/** @internal */
+function createBeforeSnapshotFromJson(data, source, createTime, updateTime) {
+    if (!firestoreInstance) {
+        firestoreInstance = firestore.getFirestore((0, app_1.getApp)());
+    }
+    const oldValueProto = _getValueProto(data, source, "oldValue");
+    const oldReadTime = (0, encoder_1.dateToTimestampProto)(createTime || updateTime);
+    return firestoreInstance.snapshot_(oldValueProto, oldReadTime, "json");
+}
+exports.createBeforeSnapshotFromJson = createBeforeSnapshotFromJson;

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

@@ -123,9 +123,9 @@ export interface CallableRequest<T = any> {
  * - `unauthenticated`: The request does not have valid authentication
  *   credentials for the operation.
  */
-export declare type FunctionsErrorCode = "ok" | "cancelled" | "unknown" | "invalid-argument" | "deadline-exceeded" | "not-found" | "already-exists" | "permission-denied" | "resource-exhausted" | "failed-precondition" | "aborted" | "out-of-range" | "unimplemented" | "internal" | "unavailable" | "data-loss" | "unauthenticated";
+export type FunctionsErrorCode = "ok" | "cancelled" | "unknown" | "invalid-argument" | "deadline-exceeded" | "not-found" | "already-exists" | "permission-denied" | "resource-exhausted" | "failed-precondition" | "aborted" | "out-of-range" | "unimplemented" | "internal" | "unavailable" | "data-loss" | "unauthenticated";
 /** @hidden */
-export declare type CanonicalErrorCodeName = "OK" | "CANCELLED" | "UNKNOWN" | "INVALID_ARGUMENT" | "DEADLINE_EXCEEDED" | "NOT_FOUND" | "ALREADY_EXISTS" | "PERMISSION_DENIED" | "UNAUTHENTICATED" | "RESOURCE_EXHAUSTED" | "FAILED_PRECONDITION" | "ABORTED" | "OUT_OF_RANGE" | "UNIMPLEMENTED" | "INTERNAL" | "UNAVAILABLE" | "DATA_LOSS";
+export type CanonicalErrorCodeName = "OK" | "CANCELLED" | "UNKNOWN" | "INVALID_ARGUMENT" | "DEADLINE_EXCEEDED" | "NOT_FOUND" | "ALREADY_EXISTS" | "PERMISSION_DENIED" | "UNAUTHENTICATED" | "RESOURCE_EXHAUSTED" | "FAILED_PRECONDITION" | "ABORTED" | "OUT_OF_RANGE" | "UNIMPLEMENTED" | "INTERNAL" | "UNAVAILABLE" | "DATA_LOSS";
 /** @hidden */
 interface HttpErrorCode {
     canonicalName: CanonicalErrorCodeName;
@@ -191,7 +191,7 @@ export declare function decode(data: any): any;
  *
  */
 /** @hidden */
-declare type TokenStatus = "MISSING" | "VALID" | "INVALID";
+type TokenStatus = "MISSING" | "VALID" | "INVALID";
 /** @interanl */
 export declare function checkAuthToken(req: Request, ctx: CallableContext | TaskContext): Promise<TokenStatus>;
 export {};

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

@@ -7,16 +7,16 @@ export { HttpsError };
  * @hidden
  * @alpha
  */
-export declare type AuthBlockingEventType = "beforeCreate" | "beforeSignIn";
+export type AuthBlockingEventType = "beforeCreate" | "beforeSignIn";
 /**
  * The UserRecord passed to Cloud Functions is the same UserRecord that is returned by the Firebase Admin
  * SDK.
  */
-export declare type UserRecord = auth.UserRecord;
+export type UserRecord = auth.UserRecord;
 /**
  * UserInfo that is part of the UserRecord
  */
-export declare type UserInfo = auth.UserInfo;
+export type UserInfo = auth.UserInfo;
 /**
  * Helper class to create the user metadata in a UserRecord object
  */

package/lib/common/providers/tasks.d.ts

@@ -32,7 +32,7 @@ export interface RetryConfig {
 /** How congestion control should be applied to the function. */
 export interface RateLimits {
     /**
-     * The maximum number of requests that can be outstanding at a time.
+     * The maximum number of requests that can be processed at a time.
      * If left unspecified, will default to 1000.
      */
     maxConcurrentDispatches?: number | Expression<number> | ResetValue;

package/lib/common/timezone.d.ts

@@ -1,2 +1,2 @@
 export declare const tzDatabase: Record<string, string>;
-export declare type timezone = keyof typeof tzDatabase;
+export type timezone = keyof typeof tzDatabase;

package/lib/common/utilities/path-pattern.js

@@ -82,16 +82,16 @@ class MultiCaptureSegment {
  * @internal
  */
 class PathPattern {
-    constructor(raw) {
-        this.raw = raw;
-        this.segments = [];
-        this.initPathSegments(raw);
-    }
     /** @throws on validation error */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     static compile(rawPath) {
         return undefined;
     }
+    constructor(raw) {
+        this.raw = raw;
+        this.segments = [];
+        this.initPathSegments(raw);
+    }
     getValue() {
         return this.raw;
     }

package/lib/logger/index.d.ts

@@ -2,7 +2,7 @@
  * `LogSeverity` indicates the detailed severity of the log entry. See [LogSeverity](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity).
  * @public
  */
-export declare type LogSeverity = "DEBUG" | "INFO" | "NOTICE" | "WARNING" | "ERROR" | "CRITICAL" | "ALERT" | "EMERGENCY";
+export type LogSeverity = "DEBUG" | "INFO" | "NOTICE" | "WARNING" | "ERROR" | "CRITICAL" | "ALERT" | "EMERGENCY";
 /**
  * `LogEntry` represents a [structured Cloud Logging](https://cloud.google.com/logging/docs/structured-logging)
  * entry. All keys aside from `severity` and `message` are

package/lib/params/index.d.ts

@@ -4,7 +4,7 @@
  */
 import { BooleanParam, Expression, IntParam, Param, ParamOptions, SecretParam, StringParam, ListParam } from "./types";
 export { ParamOptions, Expression };
-declare type SecretOrExpr = Param<any> | SecretParam;
+type SecretOrExpr = Param<any> | SecretParam;
 export declare const declaredParams: SecretOrExpr[];
 /**
  * A builtin param that resolves to the default RTDB database URL associated

package/lib/params/types.d.ts

@@ -29,8 +29,8 @@ export declare class CompareExpression<T extends string | number | boolean | str
     thenElse<retT extends string | number | boolean | string[]>(ifTrue: retT | Expression<retT>, ifFalse: retT | Expression<retT>): TernaryExpression<retT>;
 }
 /** @hidden */
-declare type ParamValueType = "string" | "list" | "boolean" | "int" | "float" | "secret";
-declare type ParamInput<T> = {
+type ParamValueType = "string" | "list" | "boolean" | "int" | "float" | "secret";
+type ParamInput<T> = {
     text: TextInput<T>;
 } | {
     select: SelectInput<T>;
@@ -92,7 +92,7 @@ export interface SelectOptions<T = unknown> {
     value: T;
 }
 /** The wire representation of a Param when it's sent to the CLI. A superset of ParamOptions. */
-export declare type ParamSpec<T extends string | number | boolean | string[]> = {
+export type ParamSpec<T extends string | number | boolean | string[]> = {
     /** The name of the parameter which will be stored in .env files. Use UPPERCASE. */
     name: string;
     /** An optional default value to be used while prompting for input. Can be a literal or another parametrized expression. */
@@ -112,7 +112,7 @@ export declare type ParamSpec<T extends string | number | boolean | string[]> =
  *
  * @alpha
  */
-export declare type WireParamSpec<T extends string | number | boolean | string[]> = {
+export type WireParamSpec<T extends string | number | boolean | string[]> = {
     name: string;
     default?: T | string;
     label?: string;
@@ -121,7 +121,7 @@ export declare type WireParamSpec<T extends string | number | boolean | string[]
     input?: ParamInput<T>;
 };
 /** Configuration options which can be used to customize the prompting behavior of a Param. */
-export declare type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;
+export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;
 /**
  * Represents a parametrized value that will be read from .env files if present,
  * or prompted for by the CLI if missing. Instantiate these with the defineX

package/lib/v1/function-builder.d.ts

@@ -1,4 +1,6 @@
 import * as express from "express";
+import { ResetValue } from "../common/options";
+import { Expression } from "../params/types";
 import { EventContext } from "./cloud-functions";
 import { DeploymentOptions, RuntimeOptions, SUPPORTED_REGIONS } from "./function-configuration";
 import * as analytics from "./providers/analytics";
@@ -19,7 +21,7 @@ import * as testLab from "./providers/testLab";
  * @example
  * functions.region('us-east1', 'us-central1')
  */
-export declare function region(...regions: Array<typeof SUPPORTED_REGIONS[number] | string>): FunctionBuilder;
+export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
 /**
  * Configure runtime options for the function.
  * @param runtimeOptions Object with optional fields:
@@ -50,7 +52,7 @@ export declare class FunctionBuilder {
      * @example
      * functions.region('us-east1', 'us-central1')
      */
-    region(...regions: Array<typeof SUPPORTED_REGIONS[number] | string>): FunctionBuilder;
+    region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
     /**
      * Configure runtime options for the function.
      * @param runtimeOptions Object with optional fields:

package/lib/v1/function-builder.js

@@ -45,7 +45,8 @@ function assertRuntimeOptionsValid(runtimeOptions) {
     if (mem && typeof mem !== "object" && !function_configuration_1.VALID_MEMORY_OPTIONS.includes(mem)) {
         throw new Error(`The only valid memory allocation values are: ${function_configuration_1.VALID_MEMORY_OPTIONS.join(", ")}`);
     }
-    if (runtimeOptions.timeoutSeconds > function_configuration_1.MAX_TIMEOUT_SECONDS || runtimeOptions.timeoutSeconds < 0) {
+    if (typeof runtimeOptions.timeoutSeconds === "number" &&
+        (runtimeOptions.timeoutSeconds > function_configuration_1.MAX_TIMEOUT_SECONDS || runtimeOptions.timeoutSeconds < 0)) {
         throw new Error(`TimeoutSeconds must be between 0 and ${function_configuration_1.MAX_TIMEOUT_SECONDS}`);
     }
     if (runtimeOptions.ingressSettings &&
@@ -61,10 +62,11 @@ function assertRuntimeOptionsValid(runtimeOptions) {
     validateFailurePolicy(runtimeOptions.failurePolicy);
     const serviceAccount = runtimeOptions.serviceAccount;
     if (serviceAccount &&
-        serviceAccount !== "default" &&
-        !(serviceAccount instanceof options_1.ResetValue) &&
-        !serviceAccount.includes("@")) {
-        throw new Error(`serviceAccount must be set to 'default', a service account email, or '{serviceAccountName}@'`);
+        !(serviceAccount === "default" ||
+            serviceAccount instanceof options_1.ResetValue ||
+            serviceAccount instanceof types_1.Expression ||
+            serviceAccount.includes("@"))) {
+        throw new Error(`serviceAccount must be set to 'default', a string expression, a service account email, or '{serviceAccountName}@'`);
     }
     if (runtimeOptions.labels) {
         // Labels must follow the rules listed in

package/lib/v1/function-configuration.d.ts

@@ -121,7 +121,7 @@ export interface RuntimeOptions {
     /**
      * Amount of memory to allocate to the function.
      */
-    memory?: typeof VALID_MEMORY_OPTIONS[number] | Expression<number> | ResetValue;
+    memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;
     /**
      * Timeout for the function in seconds, possible values are 0 to 540.
      */
@@ -145,15 +145,15 @@ export interface RuntimeOptions {
     /**
      * Egress settings for VPC connector.
      */
-    vpcConnectorEgressSettings?: typeof VPC_EGRESS_SETTINGS_OPTIONS[number] | ResetValue;
+    vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;
     /**
      * Specific service account for the function to run as.
      */
-    serviceAccount?: "default" | string | ResetValue;
+    serviceAccount?: "default" | string | Expression<string> | ResetValue;
     /**
      * Ingress settings which control where this function can be called from.
      */
-    ingressSettings?: typeof INGRESS_SETTINGS_OPTIONS[number] | ResetValue;
+    ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;
     /**
      * User labels to set on the function.
      */
@@ -194,7 +194,7 @@ export interface DeploymentOptions extends RuntimeOptions {
     /**
      * Regions where function should be deployed.
      */
-    regions?: Array<typeof SUPPORTED_REGIONS[number] | string>;
+    regions?: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>;
     /**
      * Schedule for the scheduled function.
      */

package/lib/v1/providers/auth.js

@@ -59,15 +59,15 @@ exports._userWithOptions = _userWithOptions;
  * @public
  */
 class UserBuilder {
+    static dataConstructor(raw) {
+        return (0, identity_1.userRecordConstructor)(raw.data);
+    }
     /* @internal */
     constructor(triggerResource, options, userOptions) {
         this.triggerResource = triggerResource;
         this.options = options;
         this.userOptions = userOptions;
     }
-    static dataConstructor(raw) {
-        return (0, identity_1.userRecordConstructor)(raw.data);
-    }
     /**
      * Responds to the creation of a Firebase Auth user.
      *

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

@@ -3,8 +3,8 @@ import { Change } from "../../common/change";
 import { ParamsOf } from "../../common/params";
 import { CloudFunction, Event, EventContext } from "../cloud-functions";
 import { DeploymentOptions } from "../function-configuration";
-export declare type DocumentSnapshot = firestore.DocumentSnapshot;
-export declare type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;
+export type DocumentSnapshot = firestore.DocumentSnapshot;
+export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;
 /**
  * Select the Firestore document to listen to for events.
  * @param path Full database path to listen to. This includes the name of

package/lib/v1/providers/firestore.js

@@ -22,12 +22,9 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentBuilder = exports.beforeSnapshotConstructor = exports.snapshotConstructor = exports.NamespaceBuilder = exports.DatabaseBuilder = exports._documentWithOptions = exports._namespaceWithOptions = exports._databaseWithOptions = exports.database = exports.namespace = exports.document = exports.defaultDatabase = exports.service = exports.provider = void 0;
-const firestore = require("firebase-admin/firestore");
 const path_1 = require("path");
-const app_1 = require("../../common/app");
 const change_1 = require("../../common/change");
-const encoder_1 = require("../../common/utilities/encoder");
-const logger = require("../../logger");
+const firestore_1 = require("../../common/providers/firestore");
 const cloud_functions_1 = require("../cloud-functions");
 /** @internal */
 exports.provider = "google.firestore";
@@ -35,7 +32,6 @@ exports.provider = "google.firestore";
 exports.service = "firestore.googleapis.com";
 /** @internal */
 exports.defaultDatabase = "(default)";
-let firestoreInstance;
 /**
  * Select the Firestore document to listen to for events.
  * @param path Full database path to listen to. This includes the name of
@@ -102,46 +98,15 @@ class NamespaceBuilder {
     }
 }
 exports.NamespaceBuilder = NamespaceBuilder;
-function _getValueProto(data, resource, valueFieldName) {
-    const value = data === null || data === void 0 ? void 0 : data[valueFieldName];
-    if (typeof value === "undefined" ||
-        value === null ||
-        (typeof value === "object" && !Object.keys(value).length)) {
-        // Firestore#snapshot_ takes resource string instead of proto for a non-existent snapshot
-        return resource;
-    }
-    const proto = {
-        fields: (value === null || value === void 0 ? void 0 : value.fields) || {},
-        createTime: (0, encoder_1.dateToTimestampProto)(value === null || value === void 0 ? void 0 : value.createTime),
-        updateTime: (0, encoder_1.dateToTimestampProto)(value === null || value === void 0 ? void 0 : value.updateTime),
-        name: (value === null || value === void 0 ? void 0 : value.name) || resource,
-    };
-    return proto;
-}
 function snapshotConstructor(event) {
-    var _a, _b, _c, _d, _e;
-    if (!firestoreInstance) {
-        firestoreInstance = firestore.getFirestore((0, app_1.getApp)());
-    }
-    const valueProto = _getValueProto(event.data, event.context.resource.name, "value");
-    let timeString = (_c = (_b = (_a = event === null || event === void 0 ? void 0 : event.data) === null || _a === void 0 ? void 0 : _a.value) === null || _b === void 0 ? void 0 : _b.readTime) !== null && _c !== void 0 ? _c : (_e = (_d = event === null || event === void 0 ? void 0 : event.data) === null || _d === void 0 ? void 0 : _d.value) === null || _e === void 0 ? void 0 : _e.updateTime;
-    if (!timeString) {
-        logger.warn("Snapshot has no readTime. Using now()");
-        timeString = new Date().toISOString();
-    }
-    const readTime = (0, encoder_1.dateToTimestampProto)(timeString);
-    return firestoreInstance.snapshot_(valueProto, readTime, "json");
+    var _a, _b, _c, _d;
+    return (0, firestore_1.createSnapshotFromJson)(event.data, event.context.resource.name, (_b = (_a = event === null || event === void 0 ? void 0 : event.data) === null || _a === void 0 ? void 0 : _a.value) === null || _b === void 0 ? void 0 : _b.readTime, (_d = (_c = event === null || event === void 0 ? void 0 : event.data) === null || _c === void 0 ? void 0 : _c.value) === null || _d === void 0 ? void 0 : _d.updateTime);
 }
 exports.snapshotConstructor = snapshotConstructor;
 // TODO remove this function when wire format changes to new format
 function beforeSnapshotConstructor(event) {
     var _a, _b;
-    if (!firestoreInstance) {
-        firestoreInstance = firestore.getFirestore((0, app_1.getApp)());
-    }
-    const oldValueProto = _getValueProto(event.data, event.context.resource.name, "oldValue");
-    const oldReadTime = (0, encoder_1.dateToTimestampProto)((_b = (_a = event === null || event === void 0 ? void 0 : event.data) === null || _a === void 0 ? void 0 : _a.oldValue) === null || _b === void 0 ? void 0 : _b.readTime);
-    return firestoreInstance.snapshot_(oldValueProto, oldReadTime, "json");
+    return (0, firestore_1.createBeforeSnapshotFromJson)(event.data, event.context.resource.name, (_b = (_a = event === null || event === void 0 ? void 0 : event.data) === null || _a === void 0 ? void 0 : _a.oldValue) === null || _b === void 0 ? void 0 : _b.readTime, undefined);
 }
 exports.beforeSnapshotConstructor = beforeSnapshotConstructor;
 function changeConstructor(raw) {

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

@@ -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");