firebase-functions 3.24.1 → 4.0.0-rc.0

package/lib/{providers → v1/providers}/testLab.d.ts

@@ -1,4 +1,4 @@
-import { CloudFunction, EventContext } from '../cloud-functions';
+import { CloudFunction, EventContext } from "../cloud-functions";
 /** Handle events related to Test Lab test matrices. */
 export declare function testMatrix(): TestMatrixBuilder;
 /** Builder used to create Cloud Functions for Test Lab test matrices events. */
@@ -54,91 +54,131 @@ export declare class ResultStorage {
 /**
  * The detailed reason that a Matrix was deemed INVALID.
  *
+ * @remarks
  * Possible values:
- * - 'DETAILS_UNAVAILABLE': The matrix is INVALID, but there are no further
- *   details available.
- * - 'MALFORMED_APK': The input app APK could not be parsed.
- * - 'MALFORMED_TEST_APK': The input test APK could not be parsed.
- * - 'NO_MANIFEST': The AndroidManifest.xml could not be found.
- * - 'NO_PACKAGE_NAME': The APK manifest does not declare a package name.
- * - 'INVALID_PACKAGE_NAME': The APK application ID is invalid.
- * - 'TEST_SAME_AS_APP': The test package and app package are the same.
- * - 'NO_INSTRUMENTATION': The test apk does not declare an instrumentation.
- * - 'NO_SIGNATURE': The input app apk does not have a signature.
- * - 'INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE': The test runner class
- *   specified by user or in the test APK's manifest file is not compatible with
- *   Android Test Orchestrator.
- * - 'NO_TEST_RUNNER_CLASS': The test APK does not contain the test runner class
+ *
+ * - `DETAILS_UNAVAILABLE`: The matrix is INVALID, but there are no further details available.
+ *
+ * - `MALFORMED_APK`: The input app APK could not be parsed.
+ *
+ * - `MALFORMED_TEST_APK`: The input test APK could not be parsed.
+ *
+ * - `NO_MANIFEST`: The AndroidManifest.xml could not be found.
+ *
+ * - `NO_PACKAGE_NAME`: The APK manifest does not declare a package name.
+ *
+ * - `INVALID_PACKAGE_NAME`: The APK application ID is invalid.
+ *
+ * - `TEST_SAME_AS_APP`: The test package and app package are the same.
+ *
+ * - `NO_INSTRUMENTATION`: The test apk does not declare an instrumentation.
+ *
+ * - `NO_SIGNATURE`: The input app apk does not have a signature.
+ *
+ * - `INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE`: The test runner class specified by
+ * user or in the test APK`s manifest file is not compatible with Android Test Orchestrator.
+ *
+ * - `NO_TEST_RUNNER_CLASS`: The test APK does not contain the test runner class
  *   specified by user or in the manifest file.
- * - 'NO_LAUNCHER_ACTIVITY': A main launcher activity could not be found.
- * - 'FORBIDDEN_PERMISSIONS': The app declares one or more permissions that are
+ *
+ * - `NO_LAUNCHER_ACTIVITY`: A main launcher activity could not be found.
+ *
+ * - `FORBIDDEN_PERMISSIONS`: The app declares one or more permissions that are
  *   not allowed.
- * - 'INVALID_ROBO_DIRECTIVES': There is a conflict in the provided
+ *
+ * - `INVALID_ROBO_DIRECTIVES`: There is a conflict in the provided
  *   robo_directives.
- * - 'INVALID_RESOURCE_NAME': There is at least one invalid resource name in the
+ *
+ * - `INVALID_RESOURCE_NAME`: There is at least one invalid resource name in the
  *   provided robo directives.
- * - 'INVALID_DIRECTIVE_ACTION': Invalid definition of action in the robo
+ *
+ * - `INVALID_DIRECTIVE_ACTION`: Invalid definition of action in the robo
  *   directives, e.g. a click or ignore action includes an input text field.
- * - 'TEST_LOOP_INTENT_FILTER_NOT_FOUND': There is no test loop intent filter,
+ *
+ * - `TEST_LOOP_INTENT_FILTER_NOT_FOUND`: There is no test loop intent filter,
  *   or the one that is given is not formatted correctly.
- * - 'SCENARIO_LABEL_NOT_DECLARED': The request contains a scenario label that
+ *
+ * - `SCENARIO_LABEL_NOT_DECLARED`: The request contains a scenario label that
  *   was not declared in the manifest.
- * - 'SCENARIO_LABEL_MALFORMED': There was an error when parsing a label value.
- * - 'SCENARIO_NOT_DECLARED': The request contains a scenario number that was
+ *
+ * - `SCENARIO_LABEL_MALFORMED`: There was an error when parsing a label value.
+ *
+ * - `SCENARIO_NOT_DECLARED`: The request contains a scenario number that was
  *   not declared in the manifest.
- * - 'DEVICE_ADMIN_RECEIVER': Device administrator applications are not allowed.
- * - 'MALFORMED_XC_TEST_ZIP': The zipped XCTest was malformed. The zip did not ]
+ *
+ * - `DEVICE_ADMIN_RECEIVER`: Device administrator applications are not allowed.
+ *
+ * - `MALFORMED_XC_TEST_ZIP`: The zipped XCTest was malformed. The zip did not ]
  *   contain a single .xctestrun file and the contents of the
  *   DerivedData/Build/Products directory.
- * - 'BUILT_FOR_IOS_SIMULATOR': The zipped XCTest was built for the iOS
+ *
+ * - `BUILT_FOR_IOS_SIMULATOR`: The zipped XCTest was built for the iOS
  *   simulator rather than for a physical device.
- * - 'NO_TESTS_IN_XC_TEST_ZIP': The .xctestrun file did not specify any test
+ *
+ * - `NO_TESTS_IN_XC_TEST_ZIP`: The .xctestrun file did not specify any test
  *   targets.
- * - 'USE_DESTINATION_ARTIFACTS': One or more of the test targets defined in the
+ *
+ * - `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_NON_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
+ *
+ * - `PLIST_CANNOT_BE_PARSED`: An Info.plist file in the XCTest zip could not be
  *   parsed.
- * - 'NO_CODE_APK': APK contains no code.
- * - 'INVALID_INPUT_APK': Either the provided input APK path was malformed, the
+ *
+ * - `NO_CODE_APK`: APK contains no code.
+ *
+ * - `INVALID_INPUT_APK`: Either the provided input APK path was malformed, the
  *   APK file does not exist, or the user does not have permission to access the
  *   APK file.
- * - 'INVALID_APK_PREVIEW_SDK': APK is built for a preview SDK which is
+ *
+ * - `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 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";
 /**
  * The state (i.e. progress) of a TestMatrix.
  *
+ * @remarks
  * Possible values:
- * - 'VALIDATING': The matrix is being validated.
- * - 'PENDING': The matrix is waiting for resources to become available.
- * - 'FINISHED': The matrix has terminated normally. This means that the matrix
+ *
+ * - `VALIDATING`: The matrix is being validated.
+ *
+ * - `PENDING`: The matrix is waiting for resources to become available.
+ *
+ * - `FINISHED`: The matrix has terminated normally. This means that the matrix
  *   level processing completed normally, but individual executions may be in an
  *   ERROR state.
- * - 'ERROR': The matrix has stopped because it encountered an infrastructure
+ *
+ * - `ERROR`: The matrix has stopped because it encountered an infrastructure
  *   failure.
- * - 'INVALID': The matrix was not run because the provided inputs are not
+ *
+ * - `INVALID`: The matrix was not run because the provided inputs are not
  *   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 declare type TestState = "VALIDATING" | "PENDING" | "FINISHED" | "ERROR" | "INVALID";
 /**
  * Outcome summary for a finished TestMatrix.
  *
+ * @remarks
  * Possible values:
- * - 'SUCCESS': The test matrix run was successful, for instance:
+ *
+ * - `SUCCESS`: The test matrix run was successful, for instance:
  *   - All the test cases passed.
  *   - Robo did not detect a crash of the application under test.
- * - 'FAILURE': The test run failed, for instance:
+ *
+ * - `FAILURE`: The test run failed, for instance:
  *   - One or more test cases failed.
  *   - A test timed out.
  *   - The application under test crashed.
- * - 'INCONCLUSIVE': Something unexpected happened. The run should still be
+ *
+ * - `INCONCLUSIVE`: Something unexpected happened. The run should still be
  *   considered unsuccessful but this is likely a transient problem and
  *   re-running the test might be successful.
- * - 'SKIPPED': All tests were skipped, for instance:
+ *
+ * - `SKIPPED`: All tests were skipped, for instance:
  *   - All device configurations were incompatible.
  */
-export declare type OutcomeSummary = 'SUCCESS' | 'FAILURE' | 'INCONCLUSIVE' | 'SKIPPED';
+export declare type OutcomeSummary = "SUCCESS" | "FAILURE" | "INCONCLUSIVE" | "SKIPPED";

package/lib/{providers → v1/providers}/testLab.js

@@ -22,14 +22,13 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ResultStorage = exports.ClientInfo = exports.TestMatrix = exports.TestMatrixBuilder = exports._testMatrixWithOpts = exports.testMatrix = exports.TEST_MATRIX_COMPLETE_EVENT_TYPE = exports.SERVICE = exports.PROVIDER = void 0;
-const _ = require("lodash");
 const cloud_functions_1 = require("../cloud-functions");
 /** @internal */
-exports.PROVIDER = 'google.testing';
+exports.PROVIDER = "google.testing";
 /** @internal */
-exports.SERVICE = 'testing.googleapis.com';
+exports.SERVICE = "testing.googleapis.com";
 /** @internal */
-exports.TEST_MATRIX_COMPLETE_EVENT_TYPE = 'testMatrix.complete';
+exports.TEST_MATRIX_COMPLETE_EVENT_TYPE = "testMatrix.complete";
 /** Handle events related to Test Lab test matrices. */
 function testMatrix() {
     return _testMatrixWithOpts({});
@@ -39,9 +38,9 @@ exports.testMatrix = testMatrix;
 function _testMatrixWithOpts(opts) {
     return new TestMatrixBuilder(() => {
         if (!process.env.GCLOUD_PROJECT) {
-            throw new Error('process.env.GCLOUD_PROJECT is not set.');
+            throw new Error("process.env.GCLOUD_PROJECT is not set.");
         }
-        return 'projects/' + process.env.GCLOUD_PROJECT + '/testMatrices/{matrix}';
+        return "projects/" + process.env.GCLOUD_PROJECT + "/testMatrices/{matrix}";
     }, opts);
 }
 exports._testMatrixWithOpts = _testMatrixWithOpts;
@@ -87,11 +86,11 @@ exports.TestMatrix = TestMatrix;
 class ClientInfo {
     /** @internal */
     constructor(data) {
-        this.name = _.get(data, 'name', '');
+        this.name = (data === null || data === void 0 ? void 0 : data.name) || "";
         this.details = {};
-        _.forEach(_.get(data, 'clientInfoDetails'), (detail) => {
-            this.details[detail.key] = detail.value || '';
-        });
+        for (const detail of (data === null || data === void 0 ? void 0 : data.clientInfoDetails) || []) {
+            this.details[detail.key] = detail.value || "";
+        }
     }
 }
 exports.ClientInfo = ClientInfo;
@@ -99,10 +98,11 @@ exports.ClientInfo = ClientInfo;
 class ResultStorage {
     /** @internal */
     constructor(data) {
-        this.gcsPath = _.get(data, 'googleCloudStorage.gcsPath');
-        this.toolResultsHistoryId = _.get(data, 'toolResultsHistory.historyId');
-        this.toolResultsExecutionId = _.get(data, 'toolResultsExecution.executionId');
-        this.resultsUrl = _.get(data, 'resultsUrl');
+        var _a, _b, _c;
+        this.gcsPath = (_a = data === null || data === void 0 ? void 0 : data.googleCloudStorage) === null || _a === void 0 ? void 0 : _a.gcsPath;
+        this.toolResultsHistoryId = (_b = data === null || data === void 0 ? void 0 : data.toolResultsHistory) === null || _b === void 0 ? void 0 : _b.historyId;
+        this.toolResultsExecutionId = (_c = data === null || data === void 0 ? void 0 : data.toolResultsExecution) === null || _c === void 0 ? void 0 : _c.executionId;
+        this.resultsUrl = data === null || data === void 0 ? void 0 : data.resultsUrl;
     }
 }
 exports.ResultStorage = ResultStorage;

package/lib/v2/core.d.ts

@@ -2,9 +2,10 @@
  * Core functionality of the Firebase Functions v2 SDK.
  * @packageDocumentation
  */
-import { Change } from '../common/change';
-import { ManifestEndpoint } from '../runtime/manifest';
+import { Change } from "../common/change";
+import { ManifestEndpoint } from "../runtime/manifest";
 export { Change };
+export { ParamsOf } from "../common/params";
 /**
  * A CloudEventBase is the base of a cross-platform format for encoding a serverless event.
  * More information can be found in https://github.com/cloudevents/spec
@@ -13,7 +14,7 @@ export { Change };
  */
 export interface CloudEvent<T> {
     /** Version of the CloudEvents spec for this event. */
-    readonly specversion: '1.0';
+    readonly specversion: "1.0";
     /** A globally unique ID for this event. */
     id: string;
     /** The resource which published this event. */
@@ -36,8 +37,6 @@ export interface CloudEvent<T> {
 export interface CloudFunction<EventType extends CloudEvent<unknown>> {
     (raw: CloudEvent<unknown>): any | Promise<any>;
     /** @alpha */
-    __trigger?: unknown;
-    /** @alpha */
     __endpoint: ManifestEndpoint;
     /**
      * The callback passed to the CloudFunction constructor.

package/lib/v2/index.d.ts

@@ -5,17 +5,19 @@
  * from 'firebase-functions/v2/pubsub'.
  * @packageDocumentation
  */
-import * as logger from '../logger';
-import * as alerts from './providers/alerts';
-import * as database from './providers/database';
-import * as eventarc from './providers/eventarc';
-import * as https from './providers/https';
-import * as identity from './providers/identity';
-import * as pubsub from './providers/pubsub';
-import * as scheduler from './providers/scheduler';
-import * as storage from './providers/storage';
-import * as tasks from './providers/tasks';
-export { alerts, database, storage, https, identity, pubsub, logger, tasks, eventarc, scheduler, };
-export { setGlobalOptions, GlobalOptions, SupportedRegion, MemoryOption, VpcEgressSetting, IngressSetting, EventHandlerOptions, } from './options';
-export { Change } from '../common/change';
-export { CloudFunction, CloudEvent } from './core';
+import * as logger from "../logger";
+import * as alerts from "./providers/alerts";
+import * as database from "./providers/database";
+import * as eventarc from "./providers/eventarc";
+import * as https from "./providers/https";
+import * as identity from "./providers/identity";
+import * as pubsub from "./providers/pubsub";
+import * as scheduler from "./providers/scheduler";
+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, };
+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.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.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
@@ -49,6 +49,10 @@ const storage = require("./providers/storage");
 exports.storage = storage;
 const tasks = require("./providers/tasks");
 exports.tasks = tasks;
+const remoteConfig = require("./providers/remoteConfig");
+exports.remoteConfig = remoteConfig;
+const testLab = require("./providers/testLab");
+exports.testLab = testLab;
 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

@@ -1,21 +1,23 @@
-import { Expression } from './params';
-import { ParamSpec } from './params/types';
+import { ResetValue } from "../common/options";
+import { Expression } from "../params";
+import { ParamSpec, SecretParam } from "../params/types";
+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 declare 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 declare 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 declare 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 declare 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.
@@ -23,83 +25,101 @@ export declare type IngressSetting = 'ALLOW_ALL' | 'ALLOW_INTERNAL_ONLY' | 'ALLO
 export interface GlobalOptions {
     /**
      * Region where functions should be deployed.
-     * HTTP functions can override and specify more than one region.
      */
     region?: SupportedRegion | string;
     /**
      * Amount of memory to allocate to a function.
-     * A value of null restores the defaults of 256MB.
      */
-    memory?: MemoryOption | Expression<number> | null;
+    memory?: MemoryOption | Expression<number> | ResetValue;
     /**
      * Timeout for the function in sections, possible values are 0 to 540.
      * HTTPS functions can specify a higher timeout.
-     * A value of null restores the default of 60s
+     *
+     * @remarks
      * 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
      * timeout of 1,800s (30 minutes)
      */
-    timeoutSeconds?: number | Expression<number> | null;
+    timeoutSeconds?: number | Expression<number> | ResetValue;
     /**
      * Min number of actual instances to be running at a given time.
+     *
+     * @remarks
      * Instances will be billed for memory allocation and 10% of CPU allocation
      * while idle.
-     * A value of null restores the default min instances.
      */
-    minInstances?: number | Expression<number> | null;
+    minInstances?: number | Expression<number> | ResetValue;
     /**
      * Max number of instances to be running in parallel.
-     * A value of null restores the default max instances.
      */
-    maxInstances?: number | Expression<number> | null;
+    maxInstances?: number | Expression<number> | ResetValue;
     /**
      * Number of requests a function can serve at once.
+     *
+     * @remarks
      * Can only be applied to functions running on Cloud Functions v2.
      * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise).
      * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1.
      * The maximum value for concurrency is 1,000.
      */
-    concurrency?: number | Expression<number> | null;
+    concurrency?: number | Expression<number> | ResetValue;
     /**
      * Fractional number of CPUs to allocate to a function.
+     *
+     * @remarks
      * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes.
      * This is different from the defaults when using the gcloud utility and is different from
      * the fixed amount assigned in Google Cloud Functions generation 1.
      * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this
      * to the value "gcf_gen1"
      */
-    cpu?: number | 'gcf_gen1';
+    cpu?: number | "gcf_gen1";
     /**
      * Connect cloud function to specified VPC connector.
-     * A value of null removes the VPC connector
      */
-    vpcConnector?: string | null;
+    vpcConnector?: string | ResetValue;
     /**
      * Egress settings for VPC connector.
-     * A value of null turns off VPC connector egress settings
      */
-    vpcConnectorEgressSettings?: VpcEgressSetting | null;
+    vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;
     /**
      * Specific service account for the function to run as.
-     * A value of null restores the default service account.
      */
-    serviceAccount?: string | null;
+    serviceAccount?: string | ResetValue;
     /**
      * Ingress settings which control where this function can be called from.
-     * A value of null turns off ingress settings.
      */
-    ingressSettings?: IngressSetting | null;
+    ingressSettings?: IngressSetting | ResetValue;
+    /**
+     * Invoker to set access control on https functions.
+     */
+    invoker?: "public" | "private" | string | string[];
     /**
      * User labels to set on the function.
      */
     labels?: Record<string, string>;
+    secrets?: (string | SecretParam)[];
     /**
-     * Invoker to set access control on https functions.
+     * Determines whether Firebase AppCheck is enforced. Defaults to false.
+     *
+     * @remarks
+     * When true, requests with invalid tokens autorespond with a 401
+     * (Unauthorized) error.
+     * When false, requests with invalid tokens set event.app to undefiend.
+     */
+    enforceAppCheck?: boolean;
+    /**
+     * Controls whether function configuration modified outside of function source is preserved. Defaults to false.
+     *
+     * @remarks
+     * When setting configuration available in the underlying platform that is not yet available in the Firebase Functions
+     * SDK, we highly recommend setting `preserveExternalChanges` to `true`. Otherwise, when the Firebase Functions SDK releases
+     * a new version of the SDK with support for the missing configuration, your function's manually configured setting
+     * may inadvertently be wiped out.
      */
-    invoker?: 'public' | 'private' | string | string[];
-    secrets?: string[];
+    preserveExternalChanges?: boolean;
 }
 /**
  * Sets default options for all functions written using the v2 SDK.
@@ -109,16 +129,16 @@ export declare function setGlobalOptions(options: GlobalOptions): void;
 /**
  * Additional fields that can be set on any event-handling Cloud Function.
  */
-export interface EventHandlerOptions extends GlobalOptions {
+export interface EventHandlerOptions extends Omit<GlobalOptions, "enforceAppCheck"> {
     eventType?: string;
     eventFilters?: Record<string, string | Expression<string>>;
     eventFilterPathPatterns?: Record<string, string | Expression<string>>;
     /** Whether failed executions should be delivered again. */
-    retry?: boolean | Expression<boolean> | null;
+    retry?: boolean | Expression<boolean> | ResetValue;
     /** Region of the EventArc trigger. */
     region?: string;
     /** The service account that EventArc should use to invoke this function. Requires the P4SA to have ActAs permission on this service account. */
-    serviceAccount?: string | null;
+    serviceAccount?: string | ResetValue;
     /** The name of the channel where the function receives events. */
     channel?: string;
 }
@@ -128,5 +148,5 @@ export interface EventHandlerOptions extends GlobalOptions {
  */
 export declare function __getSpec(): {
     globalOptions: GlobalOptions;
-    params: ParamSpec[];
+    params: ParamSpec<any>[];
 };

package/lib/v2/options.js

@@ -21,24 +21,28 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.__getSpec = exports.optionsToEndpoint = exports.optionsToTriggerAnnotations = exports.getGlobalOptions = exports.setGlobalOptions = void 0;
+exports.__getSpec = exports.optionsToEndpoint = exports.getGlobalOptions = exports.setGlobalOptions = exports.RESET_VALUE = void 0;
 /**
  * Options to configure cloud functions.
  * @packageDocumentation
  */
 const encoding_1 = require("../common/encoding");
+const options_1 = require("../common/options");
+const params_1 = require("../params");
+const types_1 = require("../params/types");
 const logger = require("../logger");
-const params_1 = require("./params");
+var options_2 = require("../common/options");
+Object.defineProperty(exports, "RESET_VALUE", { enumerable: true, get: function () { return options_2.RESET_VALUE; } });
 const MemoryOptionToMB = {
-    '128MiB': 128,
-    '256MiB': 256,
-    '512MiB': 512,
-    '1GiB': 1024,
-    '2GiB': 2048,
-    '4GiB': 4096,
-    '8GiB': 8192,
-    '16GiB': 16384,
-    '32GiB': 32768,
+    "128MiB": 128,
+    "256MiB": 256,
+    "512MiB": 512,
+    "1GiB": 1024,
+    "2GiB": 2048,
+    "4GiB": 4096,
+    "8GiB": 8192,
+    "16GiB": 16384,
+    "32GiB": 32768,
 };
 let globalOptions;
 /**
@@ -47,7 +51,7 @@ let globalOptions;
  */
 function setGlobalOptions(options) {
     if (globalOptions) {
-        logger.warn('Calling setGlobalOptions twice leads to undefined behavior');
+        logger.warn("Calling setGlobalOptions twice leads to undefined behavior");
     }
     globalOptions = options;
 }
@@ -61,53 +65,34 @@ function getGlobalOptions() {
     return globalOptions || {};
 }
 exports.getGlobalOptions = getGlobalOptions;
-/**
- * Apply GlobalOptions to trigger definitions.
- * @internal
- */
-function optionsToTriggerAnnotations(opts) {
-    const annotation = {};
-    (0, encoding_1.copyIfPresent)(annotation, opts, 'concurrency', 'minInstances', 'maxInstances', 'ingressSettings', 'labels', 'vpcConnector', 'vpcConnectorEgressSettings', 'secrets');
-    (0, encoding_1.convertIfPresent)(annotation, opts, 'availableMemoryMb', 'memory', (mem) => {
-        return typeof mem === 'object' ? mem : MemoryOptionToMB[mem];
-    });
-    (0, encoding_1.convertIfPresent)(annotation, opts, 'regions', 'region', (region) => {
-        if (typeof region === 'string') {
-            return [region];
-        }
-        return region;
-    });
-    (0, encoding_1.convertIfPresent)(annotation, opts, 'serviceAccountEmail', 'serviceAccount', encoding_1.serviceAccountFromShorthand);
-    (0, encoding_1.convertIfPresent)(annotation, opts, 'timeout', 'timeoutSeconds', encoding_1.durationFromSeconds);
-    (0, encoding_1.convertIfPresent)(annotation, opts, 'failurePolicy', 'retry', (retry) => {
-        return retry ? { retry: true } : null;
-    });
-    return annotation;
-}
-exports.optionsToTriggerAnnotations = optionsToTriggerAnnotations;
 /**
  * Apply GlobalOptions to endpoint manifest.
  * @internal
  */
 function optionsToEndpoint(opts) {
     const endpoint = {};
-    (0, encoding_1.copyIfPresent)(endpoint, opts, 'concurrency', 'minInstances', 'maxInstances', 'ingressSettings', 'labels', 'timeoutSeconds', 'cpu');
-    (0, encoding_1.convertIfPresent)(endpoint, opts, 'serviceAccountEmail', 'serviceAccount');
-    if (opts.vpcConnector) {
-        const vpc = { connector: opts.vpcConnector };
-        (0, encoding_1.convertIfPresent)(vpc, opts, 'egressSettings', 'vpcConnectorEgressSettings');
-        endpoint.vpc = vpc;
+    (0, encoding_1.copyIfPresent)(endpoint, opts, "concurrency", "minInstances", "maxInstances", "ingressSettings", "labels", "timeoutSeconds", "cpu");
+    (0, encoding_1.convertIfPresent)(endpoint, opts, "serviceAccountEmail", "serviceAccount");
+    if (opts.vpcConnector !== undefined) {
+        if (opts.vpcConnector === null || opts.vpcConnector instanceof options_1.ResetValue) {
+            endpoint.vpc = options_1.RESET_VALUE;
+        }
+        else {
+            const vpc = { connector: opts.vpcConnector };
+            (0, encoding_1.convertIfPresent)(vpc, opts, "egressSettings", "vpcConnectorEgressSettings");
+            endpoint.vpc = vpc;
+        }
     }
-    (0, encoding_1.convertIfPresent)(endpoint, opts, 'availableMemoryMb', 'memory', (mem) => {
-        return typeof mem === 'object' ? mem : MemoryOptionToMB[mem];
+    (0, encoding_1.convertIfPresent)(endpoint, opts, "availableMemoryMb", "memory", (mem) => {
+        return typeof mem === "object" ? mem : MemoryOptionToMB[mem];
     });
-    (0, encoding_1.convertIfPresent)(endpoint, opts, 'region', 'region', (region) => {
-        if (typeof region === 'string') {
+    (0, encoding_1.convertIfPresent)(endpoint, opts, "region", "region", (region) => {
+        if (typeof region === "string") {
             return [region];
         }
         return region;
     });
-    (0, encoding_1.convertIfPresent)(endpoint, opts, 'secretEnvironmentVariables', 'secrets', (secrets) => secrets.map((secret) => ({ key: secret })));
+    (0, encoding_1.convertIfPresent)(endpoint, opts, "secretEnvironmentVariables", "secrets", (secrets) => secrets.map((secret) => ({ key: secret instanceof types_1.SecretParam ? secret.name : secret })));
     return endpoint;
 }
 exports.optionsToEndpoint = optionsToEndpoint;