firebase-functions 4.0.2 → 4.1.0

package/lib/params/types.d.ts

@@ -135,6 +135,11 @@ export declare abstract class Param<T extends string | number | boolean | string
     /** Returns a parametrized expression of Boolean type, based on comparing the value of this param to a literal or a different expression. */
     lessThan(rhs: T | Expression<T>): CompareExpression<T>;
     /** Returns a parametrized expression of Boolean type, based on comparing the value of this param to a literal or a different expression. */
+    lessThanOrEqualTo(rhs: T | Expression<T>): CompareExpression<T>;
+    /**
+     * Returns a parametrized expression of Boolean type, based on comparing the value of this param to a literal or a different expression.
+     * @deprecated A typo. Use lessThanOrEqualTo instead.
+     */
     lessThanorEqualTo(rhs: T | Expression<T>): CompareExpression<T>;
     toString(): string;
 }

package/lib/params/types.js

@@ -164,9 +164,16 @@ class Param extends Expression {
         return this.cmp("<", rhs);
     }
     /** Returns a parametrized expression of Boolean type, based on comparing the value of this param to a literal or a different expression. */
-    lessThanorEqualTo(rhs) {
+    lessThanOrEqualTo(rhs) {
         return this.cmp("<=", rhs);
     }
+    /**
+     * Returns a parametrized expression of Boolean type, based on comparing the value of this param to a literal or a different expression.
+     * @deprecated A typo. Use lessThanOrEqualTo instead.
+     */
+    lessThanorEqualTo(rhs) {
+        return this.lessThanOrEqualTo(rhs);
+    }
     toString() {
         return `params.${this.name}`;
     }

package/lib/runtime/manifest.d.ts

@@ -9,6 +9,7 @@ import { WireParamSpec } from "../params/types";
 export interface ManifestEndpoint {
     entryPoint?: string;
     region?: string[];
+    omit?: boolean | Expression<boolean>;
     platform?: string;
     availableMemoryMb?: number | Expression<number> | ResetValue;
     maxInstances?: number | Expression<number> | ResetValue;

package/lib/runtime/manifest.js

@@ -101,17 +101,17 @@ const RESETTABLE_RATE_LIMITS_OPTIONS = {
  * @internal
  */
 function initTaskQueueTrigger(...opts) {
-    let taskQueueTrigger = {};
+    const taskQueueTrigger = {
+        retryConfig: {},
+        rateLimits: {},
+    };
     if (opts.every((opt) => !(opt === null || opt === void 0 ? void 0 : opt.preserveExternalChanges))) {
-        const retryConfig = {};
         for (const key of Object.keys(RESETTABLE_RETRY_CONFIG_OPTIONS)) {
-            retryConfig[key] = options_1.RESET_VALUE;
+            taskQueueTrigger.retryConfig[key] = options_1.RESET_VALUE;
         }
-        const rateLimits = {};
         for (const key of Object.keys(RESETTABLE_RATE_LIMITS_OPTIONS)) {
-            rateLimits[key] = options_1.RESET_VALUE;
+            taskQueueTrigger.rateLimits[key] = options_1.RESET_VALUE;
         }
-        taskQueueTrigger = { retryConfig, rateLimits };
     }
     return taskQueueTrigger;
 }
@@ -131,13 +131,15 @@ const RESETTABLE_V2_SCHEDULE_OPTIONS = {
     maxBackoffSeconds: null,
 };
 function initScheduleTrigger(resetOptions, schedule, ...opts) {
-    let scheduleTrigger = { schedule };
+    let scheduleTrigger = {
+        schedule,
+        retryConfig: {},
+    };
     if (opts.every((opt) => !(opt === null || opt === void 0 ? void 0 : opt.preserveExternalChanges))) {
-        const retryConfig = {};
         for (const key of Object.keys(resetOptions)) {
-            retryConfig[key] = options_1.RESET_VALUE;
+            scheduleTrigger.retryConfig[key] = options_1.RESET_VALUE;
         }
-        scheduleTrigger = { ...scheduleTrigger, timeZone: options_1.RESET_VALUE, retryConfig };
+        scheduleTrigger = { ...scheduleTrigger, timeZone: options_1.RESET_VALUE };
     }
     return scheduleTrigger;
 }

package/lib/v1/cloud-functions.js

@@ -224,7 +224,7 @@ function optionsToTrigger(options) {
 exports.optionsToTrigger = optionsToTrigger;
 function optionsToEndpoint(options) {
     const endpoint = {};
-    (0, encoding_1.copyIfPresent)(endpoint, options, "minInstances", "maxInstances", "ingressSettings", "labels", "timeoutSeconds");
+    (0, encoding_1.copyIfPresent)(endpoint, options, "omit", "minInstances", "maxInstances", "ingressSettings", "labels", "timeoutSeconds");
     (0, encoding_1.convertIfPresent)(endpoint, options, "region", "regions");
     (0, encoding_1.convertIfPresent)(endpoint, options, "serviceAccountEmail", "serviceAccount", (sa) => sa);
     (0, encoding_1.convertIfPresent)(endpoint, options, "secretEnvironmentVariables", "secrets", (secrets) => secrets.map((secret) => ({ key: secret instanceof types_1.SecretParam ? secret.name : secret })));

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

@@ -172,11 +172,25 @@ export interface RuntimeOptions {
      * When false, requests with invalid tokens set context.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.
+     */
+    preserveExternalChanges?: boolean;
 }
 /**
  * Configuration options for a function that applies during function deployment.
  */
 export interface DeploymentOptions extends RuntimeOptions {
+    /**
+     * If true, do not deploy or emulate this function.
+     */
+    omit?: boolean | Expression<boolean>;
     /**
      * Regions where function should be deployed.
      */
@@ -185,14 +199,4 @@ export interface DeploymentOptions extends RuntimeOptions {
      * Schedule for the scheduled function.
      */
     schedule?: Schedule;
-    /**
-     * 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.
-     */
-    preserveExternalChanges?: boolean;
 }

package/lib/v1/providers/tasks.js

@@ -41,6 +41,7 @@ class TaskQueueBuilder {
      * @returns A function you can export and deploy.
      */
     onDispatch(handler) {
+        var _a, _b;
         // onEnqueueHandler sniffs the function length of the passed-in callback
         // and the user could have only tried to listen to data. Wrap their handler
         // in another handler to avoid accidentally triggering the v2 API
@@ -59,8 +60,8 @@ class TaskQueueBuilder {
             ...(0, cloud_functions_1.optionsToEndpoint)(this.depOpts),
             taskQueueTrigger: (0, manifest_1.initTaskQueueTrigger)(this.depOpts),
         };
-        (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger, this.tqOpts, "retryConfig");
-        (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger, this.tqOpts, "rateLimits");
+        (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger.retryConfig, ((_a = this.tqOpts) === null || _a === void 0 ? void 0 : _a.retryConfig) || {}, "maxAttempts", "maxBackoffSeconds", "maxDoublings", "maxRetrySeconds", "minBackoffSeconds");
+        (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger.rateLimits, ((_b = this.tqOpts) === null || _b === void 0 ? void 0 : _b.rateLimits) || {}, "maxConcurrentDispatches", "maxDispatchesPerSecond");
         (0, encoding_1.convertIfPresent)(func.__endpoint.taskQueueTrigger, this.tqOpts, "invoker", "invoker", encoding_1.convertInvoker);
         func.__requiredAPIs = [
             {

package/lib/v2/options.d.ts

@@ -23,6 +23,10 @@ export declare type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLO
  * These options are common to HTTPS and Event handling functions.
  */
 export interface GlobalOptions {
+    /**
+     * If true, do not deploy or emulate this function.
+     */
+    omit?: boolean | Expression<boolean>;
     /**
      * Region where functions should be deployed.
      */

package/lib/v2/options.js

@@ -95,7 +95,7 @@ exports.optionsToTriggerAnnotations = optionsToTriggerAnnotations;
  */
 function optionsToEndpoint(opts) {
     const endpoint = {};
-    (0, encoding_1.copyIfPresent)(endpoint, opts, "concurrency", "minInstances", "maxInstances", "ingressSettings", "labels", "timeoutSeconds", "cpu");
+    (0, encoding_1.copyIfPresent)(endpoint, opts, "omit", "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) {

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

@@ -40,6 +40,10 @@ export interface FirebaseAlertOptions extends options.EventHandlerOptions {
     alertType: AlertType;
     /** Scope the function to trigger on a specific application. */
     appId?: string;
+    /**
+     * If true, do not deploy or emulate this function.
+     */
+    omit?: boolean | Expression<boolean>;
     /**
      * Region where functions should be deployed.
      */

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

@@ -63,6 +63,10 @@ export interface AppDistributionEvent<T> extends CloudEvent<FirebaseAlertData<T>
 export interface AppDistributionOptions extends options.EventHandlerOptions {
     /** Scope the function to trigger on a specific application. */
     appId?: string;
+    /**
+     * If true, do not deploy or emulate this function.
+     */
+    omit?: boolean | Expression<boolean>;
     /**
      * Region where functions should be deployed.
      */

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

@@ -129,6 +129,10 @@ export interface CrashlyticsEvent<T> extends CloudEvent<FirebaseAlertData<T>> {
 export interface CrashlyticsOptions extends options.EventHandlerOptions {
     /** Scope the function to trigger on a specific application. */
     appId?: string;
+    /**
+     * If true, do not deploy or emulate this function.
+     */
+    omit?: boolean | Expression<boolean>;
     /**
      * Region where functions should be deployed.
      */

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

@@ -51,6 +51,10 @@ export interface ReferenceOptions<Ref extends string = string> extends options.E
      * Note: The capture syntax cannot be used for 'instance'.
      */
     instance?: string;
+    /**
+     * If true, do not deploy or emulate this function.
+     */
+    omit?: boolean | Expression<boolean>;
     /**
      * Region where functions should be deployed.
      */

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

@@ -28,6 +28,10 @@ export interface EventarcTriggerOptions extends options.EventHandlerOptions {
      * Eventarc event exact match filter.
      */
     filters?: Record<string, string>;
+    /**
+     * If true, do not deploy or emulate this function.
+     */
+    omit?: boolean | Expression<boolean>;
     /**
      * Region where functions should be deployed.
      */

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

@@ -11,6 +11,10 @@ export { Request, CallableRequest, FunctionsErrorCode, HttpsError };
  * Options that can be set on an onRequest HTTPS function.
  */
 export interface HttpsOptions extends Omit<GlobalOptions, "region"> {
+    /**
+     * If true, do not deploy or emulate this function.
+     */
+    omit?: boolean | Expression<boolean>;
     /** HTTP functions can override global options and can specify multiple regions to deploy to. */
     region?: SupportedRegion | string | Array<SupportedRegion | string>;
     /** If true, allows CORS on requests to this function.

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

@@ -26,6 +26,10 @@ export interface BlockingOptions {
     accessToken?: boolean;
     /** Pass the Refresh Token credential to the function. */
     refreshToken?: boolean;
+    /**
+     * If true, do not deploy or emulate this function.
+     */
+    omit?: boolean | Expression<boolean>;
     /**
      * Region where functions should be deployed.
      */

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

@@ -84,6 +84,10 @@ export interface MessagePublishedData<T = any> {
 export interface PubSubOptions extends options.EventHandlerOptions {
     /** The Pub/Sub topic to watch for message events */
     topic: string;
+    /**
+     * If true, do not deploy or emulate this function.
+     */
+    omit?: boolean | Expression<boolean>;
     /**
      * Region where functions should be deployed.
      */

package/lib/v2/providers/scheduler.js

@@ -38,11 +38,13 @@ function getOpts(args) {
     return {
         schedule: args.schedule,
         timeZone: args.timeZone,
-        retryCount: args.retryCount,
-        maxRetrySeconds: args.maxRetrySeconds,
-        minBackoffSeconds: args.minBackoffSeconds,
-        maxBackoffSeconds: args.maxBackoffSeconds,
-        maxDoublings: args.maxDoublings,
+        retryConfig: {
+            retryCount: args.retryCount,
+            maxRetrySeconds: args.maxRetrySeconds,
+            minBackoffSeconds: args.minBackoffSeconds,
+            maxBackoffSeconds: args.maxBackoffSeconds,
+            maxDoublings: args.maxDoublings,
+        },
         opts: args,
     };
 }
@@ -87,7 +89,7 @@ function onSchedule(args, handler) {
         scheduleTrigger: (0, manifest_1.initV2ScheduleTrigger)(separatedOpts.schedule, globalOpts, separatedOpts.opts),
     };
     (0, encoding_1.copyIfPresent)(ep.scheduleTrigger, separatedOpts, "timeZone");
-    (0, encoding_1.copyIfPresent)(ep.scheduleTrigger.retryConfig, separatedOpts, "retryCount", "maxRetrySeconds", "minBackoffSeconds", "maxBackoffSeconds", "maxDoublings");
+    (0, encoding_1.copyIfPresent)(ep.scheduleTrigger.retryConfig, separatedOpts.retryConfig, "retryCount", "maxRetrySeconds", "minBackoffSeconds", "maxBackoffSeconds", "maxDoublings");
     func.__endpoint = ep;
     func.__requiredAPIs = [
         {

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

@@ -160,6 +160,10 @@ export interface StorageEvent extends CloudEvent<StorageObjectData> {
 export interface StorageOptions extends options.EventHandlerOptions {
     /** The name of the bucket containing this object. */
     bucket?: string;
+    /**
+     * If true, do not deploy or emulate this function.
+     */
+    omit?: boolean | Expression<boolean>;
     /**
      * Region where functions should be deployed.
      */

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

@@ -19,6 +19,10 @@ export interface TaskQueueOptions extends options.EventHandlerOptions {
      * will have permissions.
      */
     invoker?: "private" | string | string[];
+    /**
+     * If true, do not deploy or emulate this function.
+     */
+    omit?: boolean | Expression<boolean>;
     /**
      * Region where functions should be deployed.
      */

package/lib/v2/providers/tasks.js

@@ -80,8 +80,8 @@ function onTaskDispatched(optsOrHandler, handler) {
         },
         taskQueueTrigger: (0, manifest_1.initTaskQueueTrigger)(options.getGlobalOptions(), opts),
     };
-    (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger, opts, "retryConfig");
-    (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger, opts, "rateLimits");
+    (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger.retryConfig, opts.retryConfig, "maxAttempts", "maxBackoffSeconds", "maxDoublings", "maxRetrySeconds", "minBackoffSeconds");
+    (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger.rateLimits, opts.rateLimits, "maxConcurrentDispatches", "maxDispatchesPerSecond");
     (0, encoding_1.convertIfPresent)(func.__endpoint.taskQueueTrigger, opts, "invoker", "invoker", encoding_1.convertInvoker);
     func.__requiredAPIs = [
         {

package/lib/v2/providers/testLab.js

@@ -22,6 +22,7 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.onTestMatrixCompleted = exports.eventType = void 0;
+const manifest_1 = require("../../runtime/manifest");
 const options_1 = require("../options");
 const trace_1 = require("../trace");
 /** @internal */
@@ -46,6 +47,7 @@ function onTestMatrixCompleted(optsOrHandler, handler) {
     };
     func.run = handler;
     const ep = {
+        ...(0, manifest_1.initV2Endpoint)((0, options_1.getGlobalOptions)(), optsOrHandler),
         platform: "gcfv2",
         ...baseOpts,
         ...specificOpts,

package/package.json

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