firebase-functions 4.0.1 → 4.1.0

package/lib/common/encoding.d.ts

@@ -1,3 +1,10 @@
+/**
+ * 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;
+/** Get a google.protobuf.Duration for a number of seconds. */
+export declare function durationFromSeconds(s: number): Duration;
 /**
  * Utility function to help copy fields from type A to B.
  * As a safety net, catches typos or fields that aren't named the same
@@ -5,4 +12,5 @@
  */
 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 convertInvoker(invoker: string | string[]): string[];

package/lib/common/encoding.js

@@ -21,8 +21,12 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertInvoker = exports.convertIfPresent = exports.copyIfPresent = void 0;
-// Copied from firebase-tools/src/gcp/proto
+exports.convertInvoker = exports.serviceAccountFromShorthand = exports.convertIfPresent = exports.copyIfPresent = exports.durationFromSeconds = void 0;
+/** Get a google.protobuf.Duration for a number of seconds. */
+function durationFromSeconds(s) {
+    return `${s}s`;
+}
+exports.durationFromSeconds = durationFromSeconds;
 /**
  * Utility function to help copy fields from type A to B.
  * As a safety net, catches typos or fields that aren't named the same
@@ -52,6 +56,24 @@ function convertIfPresent(dest, src, destField, srcField, converter = (from) =>
     dest[destField] = converter(src[srcField]);
 }
 exports.convertIfPresent = convertIfPresent;
+function serviceAccountFromShorthand(serviceAccount) {
+    if (serviceAccount === "default") {
+        return null;
+    }
+    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.`);
+        }
+        return `${serviceAccount}${process.env.GCLOUD_PROJECT}.iam.gserviceaccount.com`;
+    }
+    else if (serviceAccount.includes("@")) {
+        return serviceAccount;
+    }
+    else {
+        throw new Error(`Invalid option for serviceAccount: '${serviceAccount}'. Valid options are 'default', a service account email, or '{serviceAccountName}@'`);
+    }
+}
+exports.serviceAccountFromShorthand = serviceAccountFromShorthand;
 function convertInvoker(invoker) {
     if (typeof invoker === "string") {
         invoker = [invoker];

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;
 }
@@ -148,6 +153,8 @@ export declare class SecretParam {
     static type: ParamValueType;
     name: string;
     constructor(name: string);
+    /** Returns the secret's value at runtime. Throws an error if accessed during deployment. */
+    value(): string;
 }
 /**
  *  A parametrized value of String type that will be read from .env files

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}`;
     }
@@ -204,7 +211,11 @@ class SecretParam {
     }
     /** @internal */
     runtimeValue() {
-        return process.env[this.name] || "";
+        const val = process.env[this.name];
+        if (val === undefined) {
+            logger.warn(`No value found for secret parameter "${this.name}". A function can only access a secret if you include the secret in the function's dependency array.`);
+        }
+        return val || "";
     }
     /** @internal */
     toSpec() {
@@ -213,6 +224,13 @@ class SecretParam {
             name: this.name,
         };
     }
+    /** Returns the secret's value at runtime. Throws an error if accessed during deployment. */
+    value() {
+        if (process.env.FUNCTIONS_CONTROL_API === "true") {
+            throw new Error(`Cannot access the value of secret "${this.name}" during function deployment. Secret values are only available at runtime.`);
+        }
+        return this.runtimeValue();
+    }
 }
 exports.SecretParam = SecretParam;
 SecretParam.type = "secret";

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.d.ts

@@ -1,4 +1,5 @@
 import { Request, Response } from "express";
+import { DeploymentOptions, FailurePolicy, Schedule } from "./function-configuration";
 export { Request, Response };
 import { ManifestEndpoint, ManifestRequiredAPI } from "../runtime/manifest";
 export { Change } from "../common/change";
@@ -174,6 +175,37 @@ export interface Resource {
         [tag: string]: string;
     };
 }
+/**
+ * TriggerAnnotion is used internally by the firebase CLI to understand what
+ * type of Cloud Function to deploy.
+ */
+interface TriggerAnnotation {
+    availableMemoryMb?: number;
+    blockingTrigger?: {
+        eventType: string;
+        options?: Record<string, unknown>;
+    };
+    eventTrigger?: {
+        eventType: string;
+        resource: string;
+        service: string;
+    };
+    failurePolicy?: FailurePolicy;
+    httpsTrigger?: {
+        invoker?: string[];
+    };
+    labels?: {
+        [key: string]: string;
+    };
+    regions?: string[];
+    schedule?: Schedule;
+    timeout?: string;
+    vpcConnector?: string;
+    vpcConnectorEgressSettings?: string;
+    serviceAccountEmail?: string;
+    ingressSettings?: string;
+    secrets?: string[];
+}
 /**
  * A Runnable has a `run` method which directly invokes the user-defined
  * function - useful for unit testing.
@@ -195,6 +227,8 @@ export interface Runnable<T> {
 export interface HttpsFunction {
     (req: Request, resp: Response): void | Promise<void>;
     /** @alpha */
+    __trigger: TriggerAnnotation;
+    /** @alpha */
     __endpoint: ManifestEndpoint;
     /** @alpha */
     __requiredAPIs?: ManifestRequiredAPI[];
@@ -212,6 +246,8 @@ export interface BlockingFunction {
     /** @public */
     (req: Request, resp: Response): void | Promise<void>;
     /** @alpha */
+    __trigger: TriggerAnnotation;
+    /** @alpha */
     __endpoint: ManifestEndpoint;
     /** @alpha */
     __requiredAPIs?: ManifestRequiredAPI[];
@@ -226,7 +262,12 @@ export interface BlockingFunction {
 export interface CloudFunction<T> extends Runnable<T> {
     (input: any, context?: any): PromiseLike<any> | any;
     /** @alpha */
+    __trigger: TriggerAnnotation;
+    /** @alpha */
     __endpoint: ManifestEndpoint;
     /** @alpha */
     __requiredAPIs?: ManifestRequiredAPI[];
 }
+/** @hidden */
+export declare function optionsToTrigger(options: DeploymentOptions): any;
+export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;

package/lib/v1/cloud-functions.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.optionsToEndpoint = exports.makeCloudFunction = exports.Change = void 0;
+exports.optionsToEndpoint = exports.optionsToTrigger = exports.makeCloudFunction = exports.Change = void 0;
 const logger_1 = require("../logger");
 const function_configuration_1 = require("./function-configuration");
 const encoding_1 = require("../common/encoding");
@@ -83,6 +83,25 @@ function makeCloudFunction({ contextOnlyHandler, dataConstructor = (raw) => raw.
         }
         return Promise.resolve(promise);
     };
+    Object.defineProperty(cloudFunction, "__trigger", {
+        get: () => {
+            if (triggerResource() == null) {
+                return {};
+            }
+            const trigger = {
+                ...optionsToTrigger(options),
+                eventTrigger: {
+                    resource: triggerResource(),
+                    eventType: legacyEventType || provider + "." + eventType,
+                    service,
+                },
+            };
+            if (!!labels && Object.keys(labels).length) {
+                trigger.labels = { ...trigger.labels, ...labels };
+            }
+            return trigger;
+        },
+    });
     Object.defineProperty(cloudFunction, "__endpoint", {
         get: () => {
             if (triggerResource() == null) {
@@ -171,10 +190,41 @@ function _detectAuthType(event) {
     }
     return "UNAUTHENTICATED";
 }
-/** @internal */
+/** @hidden */
+function optionsToTrigger(options) {
+    const trigger = {};
+    (0, encoding_1.copyIfPresent)(trigger, options, "regions", "schedule", "minInstances", "maxInstances", "ingressSettings", "vpcConnectorEgressSettings", "vpcConnector", "labels", "secrets");
+    (0, encoding_1.convertIfPresent)(trigger, options, "failurePolicy", "failurePolicy", (policy) => {
+        if (policy === false) {
+            return undefined;
+        }
+        else if (policy === true) {
+            return function_configuration_1.DEFAULT_FAILURE_POLICY;
+        }
+        else {
+            return policy;
+        }
+    });
+    (0, encoding_1.convertIfPresent)(trigger, options, "timeout", "timeoutSeconds", encoding_1.durationFromSeconds);
+    (0, encoding_1.convertIfPresent)(trigger, options, "availableMemoryMb", "memory", (mem) => {
+        const memoryLookup = {
+            "128MB": 128,
+            "256MB": 256,
+            "512MB": 512,
+            "1GB": 1024,
+            "2GB": 2048,
+            "4GB": 4096,
+            "8GB": 8192,
+        };
+        return memoryLookup[mem];
+    });
+    (0, encoding_1.convertIfPresent)(trigger, options, "serviceAccountEmail", "serviceAccount", encoding_1.serviceAccountFromShorthand);
+    return trigger;
+}
+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

@@ -107,6 +107,7 @@ export interface FailurePolicy {
      */
     retry: Record<string, never>;
 }
+export declare const DEFAULT_FAILURE_POLICY: FailurePolicy;
 export declare const MAX_NUMBER_USER_LABELS = 58;
 /**
  * Configuration options for a function that applicable at runtime.
@@ -171,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.
      */
@@ -184,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/function-configuration.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MAX_NUMBER_USER_LABELS = exports.INGRESS_SETTINGS_OPTIONS = exports.VPC_EGRESS_SETTINGS_OPTIONS = exports.VALID_MEMORY_OPTIONS = exports.MAX_TIMEOUT_SECONDS = exports.MIN_TIMEOUT_SECONDS = exports.SUPPORTED_REGIONS = exports.RESET_VALUE = void 0;
+exports.MAX_NUMBER_USER_LABELS = exports.DEFAULT_FAILURE_POLICY = exports.INGRESS_SETTINGS_OPTIONS = exports.VPC_EGRESS_SETTINGS_OPTIONS = exports.VALID_MEMORY_OPTIONS = exports.MAX_TIMEOUT_SECONDS = exports.MIN_TIMEOUT_SECONDS = exports.SUPPORTED_REGIONS = exports.RESET_VALUE = void 0;
 var options_1 = require("../common/options");
 Object.defineProperty(exports, "RESET_VALUE", { enumerable: true, get: function () { return options_1.RESET_VALUE; } });
 /**
@@ -67,4 +67,7 @@ exports.INGRESS_SETTINGS_OPTIONS = [
     "ALLOW_INTERNAL_ONLY",
     "ALLOW_INTERNAL_AND_GCLB",
 ];
+exports.DEFAULT_FAILURE_POLICY = {
+    retry: {},
+};
 exports.MAX_NUMBER_USER_LABELS = 58;

package/lib/v1/providers/auth.js

@@ -131,6 +131,18 @@ class UserBuilder {
         const wrappedHandler = (user, context) => handler(user, context);
         const func = (0, identity_1.wrapHandler)(eventType, wrappedHandler);
         const legacyEventType = `providers/cloud.auth/eventTypes/user.${eventType}`;
+        func.__trigger = {
+            labels: {},
+            ...(0, cloud_functions_1.optionsToTrigger)(this.options),
+            blockingTrigger: {
+                eventType: legacyEventType,
+                options: {
+                    accessToken,
+                    idToken,
+                    refreshToken,
+                },
+            },
+        };
         func.__endpoint = {
             platform: "gcfv1",
             labels: {},

package/lib/v1/providers/https.js

@@ -50,6 +50,11 @@ function _onRequestWithOptions(handler, options) {
     const cloudFunction = (req, res) => {
         return handler(req, res);
     };
+    cloudFunction.__trigger = {
+        ...(0, cloud_functions_1.optionsToTrigger)(options),
+        httpsTrigger: {},
+    };
+    (0, encoding_1.convertIfPresent)(cloudFunction.__trigger.httpsTrigger, options, "invoker", "invoker", encoding_1.convertInvoker);
     // TODO parse the options
     cloudFunction.__endpoint = {
         platform: "gcfv1",
@@ -71,6 +76,12 @@ function _onCallWithOptions(handler, options) {
         enforceAppCheck: options.enforceAppCheck,
         cors: { origin: true, methods: "POST" },
     }, fixedLen);
+    func.__trigger = {
+        labels: {},
+        ...(0, cloud_functions_1.optionsToTrigger)(options),
+        httpsTrigger: {},
+    };
+    func.__trigger.labels["deployment-callable"] = "true";
     func.__endpoint = {
         platform: "gcfv1",
         labels: {},

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

@@ -25,6 +25,8 @@ export interface TaskQueueOptions {
 export interface TaskQueueFunction {
     (req: Request, res: express.Response): Promise<void>;
     /** @alpha */
+    __trigger: unknown;
+    /** @alpha */
     __endpoint: ManifestEndpoint;
     /** @alpha */
     __requiredAPIs?: ManifestRequiredAPI[];

package/lib/v1/providers/tasks.js

@@ -41,19 +41,27 @@ 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
         const fixedLen = (data, context) => handler(data, context);
         const func = (0, tasks_1.onDispatchHandler)(fixedLen);
+        func.__trigger = {
+            ...(0, cloud_functions_1.optionsToTrigger)(this.depOpts || {}),
+            taskQueueTrigger: {},
+        };
+        (0, encoding_1.copyIfPresent)(func.__trigger.taskQueueTrigger, this.tqOpts, "retryConfig");
+        (0, encoding_1.copyIfPresent)(func.__trigger.taskQueueTrigger, this.tqOpts, "rateLimits");
+        (0, encoding_1.convertIfPresent)(func.__trigger.taskQueueTrigger, this.tqOpts, "invoker", "invoker", encoding_1.convertInvoker);
         func.__endpoint = {
             platform: "gcfv1",
             ...(0, manifest_1.initV1Endpoint)(this.depOpts),
             ...(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/core.d.ts

@@ -37,6 +37,8 @@ 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/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

@@ -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.__getSpec = exports.optionsToEndpoint = exports.getGlobalOptions = exports.setGlobalOptions = exports.RESET_VALUE = void 0;
+exports.__getSpec = exports.optionsToEndpoint = exports.optionsToTriggerAnnotations = exports.getGlobalOptions = exports.setGlobalOptions = exports.RESET_VALUE = void 0;
 /**
  * Options to configure cloud functions.
  * @packageDocumentation
@@ -65,13 +65,37 @@ 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 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.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

@@ -26,8 +26,6 @@ export interface NewTesterDevicePayload {
 /**
  * The internal payload object for receiving in-app feedback from a tester.
  * Payload is wrapped inside a `FirebaseAlertData` object.
- *
- * @alpha
  */
 export interface InAppFeedbackPayload {
     ["@type"]: "type.googleapis.com/google.events.firebase.firebasealerts.v1.AppDistroInAppFeedbackPayload";
@@ -65,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.
      */
@@ -166,8 +168,6 @@ export declare function onNewTesterIosDevicePublished(opts: AppDistributionOptio
  * Declares a function that can handle receiving new in-app feedback from a tester.
  * @param handler - Event handler which is run every time new feedback is received.
  * @returns A function that you can export and deploy.
- *
- * @alpha
  */
 export declare function onInAppFeedbackPublished(handler: (event: AppDistributionEvent<InAppFeedbackPayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>;
 /**
@@ -175,8 +175,6 @@ export declare function onInAppFeedbackPublished(handler: (event: AppDistributio
  * @param appId - A specific application the handler will trigger on.
  * @param handler - Event handler which is run every time new feedback is received.
  * @returns A function that you can export and deploy.
- *
- * @alpha
  */
 export declare function onInAppFeedbackPublished(appId: string, handler: (event: AppDistributionEvent<InAppFeedbackPayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>;
 /**
@@ -184,7 +182,5 @@ export declare function onInAppFeedbackPublished(appId: string, handler: (event:
  * @param opts - Options that can be set on the function.
  * @param handler - Event handler which is run every time new feedback is received.
  * @returns A function that you can export and deploy.
- *
- * @alpha
  */
 export declare function onInAppFeedbackPublished(opts: AppDistributionOptions, handler: (event: AppDistributionEvent<InAppFeedbackPayload>) => any | Promise<any>): CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>;

package/lib/v2/providers/alerts/appDistribution.js

@@ -53,8 +53,6 @@ exports.onNewTesterIosDevicePublished = onNewTesterIosDevicePublished;
  * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function.
  * @param handler - Event handler which is run every time new feedback is received.
  * @returns A function that you can export and deploy.
- *
- * @alpha
  */
 function onInAppFeedbackPublished(appIdOrOptsOrHandler, handler) {
     if (typeof appIdOrOptsOrHandler === "function") {

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.
@@ -114,6 +118,8 @@ export declare type HttpsFunction = ((
 req: Request, 
 /** An Express response object, for this function to respond to callers. */
 res: express.Response) => void | Promise<void>) & {
+    /** @alpha */
+    __trigger?: unknown;
     /** @alpha */
     __endpoint: ManifestEndpoint;
 };

package/lib/v2/providers/https.js

@@ -56,6 +56,28 @@ function onRequest(optsOrHandler, handler) {
         };
     }
     handler = (0, trace_1.wrapTraceContext)(handler);
+    Object.defineProperty(handler, "__trigger", {
+        get: () => {
+            const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
+            // global options calls region a scalar and https allows it to be an array,
+            // but optionsToTriggerAnnotations handles both cases.
+            const specificOpts = options.optionsToTriggerAnnotations(opts);
+            const trigger = {
+                platform: "gcfv2",
+                ...baseOpts,
+                ...specificOpts,
+                labels: {
+                    ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+                    ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+                },
+                httpsTrigger: {
+                    allowInsecure: false,
+                },
+            };
+            (0, encoding_1.convertIfPresent)(trigger.httpsTrigger, opts, "invoker", "invoker", encoding_1.convertInvoker);
+            return trigger;
+        },
+    });
     const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
     // global options calls region a scalar and https allows it to be an array,
     // but optionsToTriggerAnnotations handles both cases.
@@ -94,6 +116,27 @@ function onCall(optsOrHandler, handler) {
         cors: { origin, methods: "POST" },
         enforceAppCheck: (_a = opts.enforceAppCheck) !== null && _a !== void 0 ? _a : options.getGlobalOptions().enforceAppCheck,
     }, fixedLen);
+    Object.defineProperty(func, "__trigger", {
+        get: () => {
+            const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
+            // global options calls region a scalar and https allows it to be an array,
+            // but optionsToTriggerAnnotations handles both cases.
+            const specificOpts = options.optionsToTriggerAnnotations(opts);
+            return {
+                platform: "gcfv2",
+                ...baseOpts,
+                ...specificOpts,
+                labels: {
+                    ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+                    ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+                    "deployment-callable": "true",
+                },
+                httpsTrigger: {
+                    allowInsecure: false,
+                },
+            };
+        },
+    });
     const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
     // global options calls region a scalar and https allows it to be an array,
     // but optionsToEndpoint handles both cases.

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/pubsub.js

@@ -128,6 +128,25 @@ function onMessagePublished(topicOrOptions, handler) {
         return (0, trace_1.wrapTraceContext)(handler)(raw);
     };
     func.run = handler;
+    Object.defineProperty(func, "__trigger", {
+        get: () => {
+            const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
+            const specificOpts = options.optionsToTriggerAnnotations(opts);
+            return {
+                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: "google.cloud.pubsub.topic.v1.messagePublished",
+                    resource: `projects/${process.env.GCLOUD_PROJECT}/topics/${topic}`,
+                },
+            };
+        },
+    });
     const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
     const specificOpts = options.optionsToEndpoint(opts);
     const endpoint = {

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/storage.js

@@ -105,6 +105,25 @@ function onOperation(eventType, bucketOrOptsOrHandler, handler) {
         return (0, trace_1.wrapTraceContext)(handler)(raw);
     };
     func.run = handler;
+    Object.defineProperty(func, "__trigger", {
+        get: () => {
+            const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
+            const specificOpts = options.optionsToTriggerAnnotations(opts);
+            return {
+                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,
+                    resource: bucket, // TODO(colerogers): replace with 'bucket,' eventually
+                },
+            };
+        },
+    });
     // TypeScript doesn't recognize defineProperty as adding a property and complains
     // that __endpoint doesn't exist. We can either cast to any and lose all type safety
     // or we can just assign a meaningless value before calling defineProperty.

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

@@ -44,8 +44,28 @@ function onTaskDispatched(optsOrHandler, handler) {
     // fix the length to prevent api versions from being mismatched.
     const fixedLen = (req) => handler(req);
     const func = (0, trace_1.wrapTraceContext)((0, tasks_1.onDispatchHandler)(fixedLen));
-    const globalOpts = options.getGlobalOptions();
-    const baseOpts = options.optionsToEndpoint(globalOpts);
+    Object.defineProperty(func, "__trigger", {
+        get: () => {
+            const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
+            // global options calls region a scalar and https allows it to be an array,
+            // but optionsToTriggerAnnotations handles both cases.
+            const specificOpts = options.optionsToTriggerAnnotations(opts);
+            const taskQueueTrigger = {};
+            (0, encoding_1.copyIfPresent)(taskQueueTrigger, opts, "retryConfig", "rateLimits");
+            (0, encoding_1.convertIfPresent)(taskQueueTrigger, opts, "invoker", "invoker", encoding_1.convertInvoker);
+            return {
+                platform: "gcfv2",
+                ...baseOpts,
+                ...specificOpts,
+                labels: {
+                    ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+                    ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+                },
+                taskQueueTrigger,
+            };
+        },
+    });
+    const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
     // global options calls region a scalar and https allows it to be an array,
     // but optionsToManifestEndpoint handles both cases.
     const specificOpts = options.optionsToEndpoint(opts);
@@ -60,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.1",
+  "version": "4.1.0",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -36,6 +36,7 @@
     "./v1/auth": "./lib/v1/providers/auth.js",
     "./v1/database": "./lib/v1/providers/database.js",
     "./v1/firestore": "./lib/v1/providers/firestore.js",
+    "./v1/https": "./lib/v1/providers/https.js",
     "./v1/pubsub": "./lib/v1/providers/pubsub.js",
     "./v1/remoteConfig": "./lib/v1/providers/remoteConfig.js",
     "./v1/storage": "./lib/v1/providers/storage.js",
@@ -75,31 +76,34 @@
         "lib/v1"
       ],
       "v1/analytics": [
-        "./lib/v1/providers/analytics"
+        "lib/v1/providers/analytics"
       ],
       "v1/auth": [
-        "./lib/v1/providers/auth"
+        "lib/v1/providers/auth"
       ],
       "v1/database": [
-        "./lib/v1/privders/database"
+        "lib/v1/privders/database"
       ],
       "v1/firestore": [
-        "./lib/v1/providers/firestore"
+        "lib/v1/providers/firestore"
+      ],
+      "v1/https": [
+        "./lib/v1/providers/https"
       ],
       "v1/pubsub": [
-        "./lib/v1/providers/pubsub"
+        "lib/v1/providers/pubsub"
       ],
-      "/v1/remoteConfig": [
-        "./lib/v1/providers/remoteConfig"
+      "v1/remoteConfig": [
+        "lib/v1/providers/remoteConfig"
       ],
-      "/v1/storage": [
-        "./lib/v1/providers/storage"
+      "v1/storage": [
+        "lib/v1/providers/storage"
       ],
-      "/v1/tasks": [
-        "./lib/v1/providers/tasks"
+      "v1/tasks": [
+        "lib/v1/providers/tasks"
       ],
-      "/v1/testLab": [
-        "./lib/v1/providers/testLab"
+      "v1/testLab": [
+        "lib/v1/providers/testLab"
       ],
       "v2": [
         "lib/v2"