firebase-functions 4.1.0 → 4.2.0

package/lib/params/index.d.ts

@@ -2,7 +2,7 @@
  * @hidden
  * @alpha
  */
-import { BooleanParam, Expression, FloatParam, IntParam, Param, ParamOptions, SecretParam, StringParam } from "./types";
+import { BooleanParam, Expression, IntParam, Param, ParamOptions, SecretParam, StringParam, ListParam } from "./types";
 export { ParamOptions, Expression };
 declare type SecretOrExpr = Param<any> | SecretParam;
 export declare const declaredParams: SecretOrExpr[];
@@ -62,10 +62,10 @@ export declare function defineBoolean(name: string, options?: ParamOptions<boole
  */
 export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
 /**
- * Declare a float param.
+ * Declare a list param.
  *
  * @param name The name of the environment variable to use to load the param.
  * @param options Configuration options for the param.
- * @returns A Param with a `number` return type for `.value`.
+ * @returns A Param with a `string[]` return type for `.value`.
  */
-export declare function defineFloat(name: string, options?: ParamOptions<number>): FloatParam;
+export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;

package/lib/params/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.defineFloat = exports.defineInt = exports.defineBoolean = exports.defineString = exports.defineSecret = exports.storageBucket = exports.gcloudProject = exports.projectID = exports.databaseURL = exports.clearParams = exports.declaredParams = exports.Expression = void 0;
+exports.defineList = exports.defineFloat = exports.defineInt = exports.defineBoolean = exports.defineString = exports.defineSecret = exports.storageBucket = exports.gcloudProject = exports.projectID = exports.databaseURL = exports.clearParams = exports.declaredParams = exports.Expression = void 0;
 /**
  * @hidden
  * @alpha
@@ -131,6 +131,8 @@ exports.defineInt = defineInt;
  * @param name The name of the environment variable to use to load the param.
  * @param options Configuration options for the param.
  * @returns A Param with a `number` return type for `.value`.
+ *
+ * @internal
  */
 function defineFloat(name, options = {}) {
     const param = new types_1.FloatParam(name, options);
@@ -138,3 +140,16 @@ function defineFloat(name, options = {}) {
     return param;
 }
 exports.defineFloat = defineFloat;
+/**
+ * Declare a list param.
+ *
+ * @param name The name of the environment variable to use to load the param.
+ * @param options Configuration options for the param.
+ * @returns A Param with a `string[]` return type for `.value`.
+ */
+function defineList(name, options = {}) {
+    const param = new types_1.ListParam(name, options);
+    registerParam(param);
+    return param;
+}
+exports.defineList = defineList;

package/lib/params/types.d.ts

@@ -34,6 +34,8 @@ declare type ParamInput<T> = {
     text: TextInput<T>;
 } | {
     select: SelectInput<T>;
+} | {
+    multiSelect: MultiSelectInput;
 } | {
     resource: ResourceInput;
 };
@@ -73,6 +75,14 @@ export interface ResourceInput {
 export interface SelectInput<T = unknown> {
     options: Array<SelectOptions<T>>;
 }
+/**
+ * Specifies that a Param's value should be determined by having the user select
+ * a subset from a list of pre-canned options interactively at deploy-time.
+ * Will result in errors if used on Params of type other than string[].
+ */
+export interface MultiSelectInput {
+    options: Array<SelectOptions<string>>;
+}
 /**
  * One of the options provided to a SelectInput, containing a value and
  * optionally a human-readable label to display in the selection interface.
@@ -182,6 +192,23 @@ export declare class FloatParam extends Param<number> {
  */
 export declare class BooleanParam extends Param<boolean> {
     static type: ParamValueType;
+    /** @deprecated */
     then<T extends string | number | boolean>(ifTrue: T | Expression<T>, ifFalse: T | Expression<T>): TernaryExpression<T>;
+    thenElse<T extends string | number | boolean>(ifTrue: T | Expression<T>, ifFalse: T | Expression<T>): TernaryExpression<T>;
+}
+/**
+ *  A parametrized value of String[] type that will be read from .env files
+ *  if present, or prompted for by the CLI if missing.
+ */
+export declare class ListParam extends Param<string[]> {
+    static type: ParamValueType;
+    /** @hidden */
+    greaterThan(rhs: string[] | Expression<string[]>): CompareExpression<string[]>;
+    /** @hidden */
+    greaterThanOrEqualTo(rhs: string[] | Expression<string[]>): CompareExpression<string[]>;
+    /** @hidden */
+    lessThan(rhs: string[] | Expression<string[]>): CompareExpression<string[]>;
+    /** @hidden */
+    lessThanorEqualTo(rhs: string[] | Expression<string[]>): CompareExpression<string[]>;
 }
 export {};

package/lib/params/types.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.BooleanParam = exports.FloatParam = exports.IntParam = exports.InternalExpression = exports.StringParam = exports.SecretParam = exports.Param = exports.CompareExpression = exports.TernaryExpression = exports.Expression = void 0;
+exports.ListParam = exports.BooleanParam = exports.FloatParam = exports.IntParam = exports.InternalExpression = exports.StringParam = exports.SecretParam = exports.Param = exports.CompareExpression = exports.TernaryExpression = exports.Expression = void 0;
 const logger = require("../logger");
 /*
  * A CEL expression which can be evaluated during function deployment, and
@@ -51,15 +51,29 @@ class Expression {
     }
 }
 exports.Expression = Expression;
-function quoteIfString(literal) {
-    // TODO(vsfan@): CEL's string escape semantics are slightly different than Javascript's, what do we do here?
-    return typeof literal === "string" ? `"${literal}"` : literal;
-}
 function valueOf(arg) {
     return arg instanceof Expression ? arg.runtimeValue() : arg;
 }
+/**
+ * Returns how an entity (either an Expression or a literal value) should be represented in CEL.
+ * - Expressions delegate to the .toString() method, which is used by the WireManifest
+ * - Strings have to be quoted explicitly
+ * - Arrays are represented as []-delimited, parsable JSON
+ * - Numbers and booleans are not quoted explicitly
+ */
 function refOf(arg) {
-    return arg instanceof Expression ? arg.toString() : quoteIfString(arg).toString();
+    if (arg instanceof Expression) {
+        return arg.toString();
+    }
+    else if (typeof arg === "string") {
+        return `"${arg}"`;
+    }
+    else if (Array.isArray(arg)) {
+        return JSON.stringify(arg);
+    }
+    else {
+        return arg.toString();
+    }
 }
 /**
  * A CEL expression corresponding to a ternary operator, e.g {{ cond ? ifTrue : ifFalse }}
@@ -99,9 +113,9 @@ class CompareExpression extends Expression {
         const right = valueOf(this.rhs);
         switch (this.cmp) {
             case "==":
-                return left === right;
+                return Array.isArray(left) ? this.arrayEquals(left, right) : left === right;
             case "!=":
-                return left !== right;
+                return Array.isArray(left) ? !this.arrayEquals(left, right) : left !== right;
             case ">":
                 return left > right;
             case ">=":
@@ -114,6 +128,10 @@ class CompareExpression extends Expression {
                 throw new Error(`Unknown comparator ${this.cmp}`);
         }
     }
+    /** @internal */
+    arrayEquals(a, b) {
+        return a.every((item) => b.includes(item)) && b.every((item) => a.includes(item));
+    }
     toString() {
         const rhsStr = refOf(this.rhs);
         return `${this.lhs} ${this.cmp} ${rhsStr}`;
@@ -299,9 +317,49 @@ class BooleanParam extends Param {
     runtimeValue() {
         return !!process.env[this.name] && process.env[this.name] === "true";
     }
+    /** @deprecated */
     then(ifTrue, ifFalse) {
+        return this.thenElse(ifTrue, ifFalse);
+    }
+    thenElse(ifTrue, ifFalse) {
         return new TernaryExpression(this, ifTrue, ifFalse);
     }
 }
 exports.BooleanParam = BooleanParam;
 BooleanParam.type = "boolean";
+/**
+ *  A parametrized value of String[] type that will be read from .env files
+ *  if present, or prompted for by the CLI if missing.
+ */
+class ListParam extends Param {
+    /** @internal */
+    runtimeValue() {
+        const val = JSON.parse(process.env[this.name]);
+        if (!Array.isArray(val) || !val.every((v) => typeof v === "string")) {
+            return [];
+        }
+        return val;
+    }
+    /** @hidden */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    greaterThan(rhs) {
+        throw new Error(">/< comparison operators not supported on params of type List");
+    }
+    /** @hidden */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    greaterThanOrEqualTo(rhs) {
+        throw new Error(">/< comparison operators not supported on params of type List");
+    }
+    /** @hidden */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    lessThan(rhs) {
+        throw new Error(">/< comparison operators not supported on params of type List");
+    }
+    /** @hidden */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    lessThanorEqualTo(rhs) {
+        throw new Error(">/< comparison operators not supported on params of type List");
+    }
+}
+exports.ListParam = ListParam;
+ListParam.type = "list";

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

@@ -141,7 +141,7 @@ export interface RuntimeOptions {
     /**
      * Connect cloud function to specified VPC connector.
      */
-    vpcConnector?: string | ResetValue;
+    vpcConnector?: string | Expression<string> | ResetValue;
     /**
      * Egress settings for VPC connector.
      */

package/lib/v2/options.d.ts

@@ -36,7 +36,7 @@ export interface GlobalOptions {
      */
     memory?: MemoryOption | Expression<number> | ResetValue;
     /**
-     * Timeout for the function in sections, possible values are 0 to 540.
+     * Timeout for the function in seconds, possible values are 0 to 540.
      * HTTPS functions can specify a higher timeout.
      *
      * @remarks
@@ -83,7 +83,7 @@ export interface GlobalOptions {
     /**
      * Connect cloud function to specified VPC connector.
      */
-    vpcConnector?: string | ResetValue;
+    vpcConnector?: string | Expression<string> | ResetValue;
     /**
      * Egress settings for VPC connector.
      */

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

@@ -54,7 +54,7 @@ export interface FirebaseAlertOptions extends options.EventHandlerOptions {
      */
     memory?: options.MemoryOption | Expression<number> | ResetValue;
     /**
-     * Timeout for the function in sections, possible values are 0 to 540.
+     * Timeout for the function in seconds, possible values are 0 to 540.
      * HTTPS functions can specify a higher timeout.
      * A value of null restores the default of 60s
      * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
@@ -97,7 +97,7 @@ export interface FirebaseAlertOptions extends options.EventHandlerOptions {
      * Connect cloud function to specified VPC connector.
      * A value of null removes the VPC connector
      */
-    vpcConnector?: string | ResetValue;
+    vpcConnector?: string | Expression<string> | ResetValue;
     /**
      * Egress settings for VPC connector.
      * A value of null turns off VPC connector egress settings

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

@@ -30,7 +30,7 @@ exports.eventType = "google.firebase.firebasealerts.alerts.v1.published";
 function onAlertPublished(alertTypeOrOpts, handler) {
     const [opts, alertType, appId] = getOptsAndAlertTypeAndApp(alertTypeOrOpts);
     const func = (raw) => {
-        return (0, trace_1.wrapTraceContext)(handler(convertAlertAndApp(raw)));
+        return (0, trace_1.wrapTraceContext)(handler)(convertAlertAndApp(raw));
     };
     func.run = handler;
     func.__endpoint = getEndpointAnnotation(opts, alertType, appId);

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

@@ -76,7 +76,7 @@ export interface AppDistributionOptions extends options.EventHandlerOptions {
      */
     memory?: options.MemoryOption | Expression<number> | ResetValue;
     /**
-     * Timeout for the function in sections, possible values are 0 to 540.
+     * Timeout for the function in seconds, possible values are 0 to 540.
      * HTTPS functions can specify a higher timeout.
      *
      * @remarks
@@ -123,7 +123,7 @@ export interface AppDistributionOptions extends options.EventHandlerOptions {
     /**
      * Connect cloud function to specified VPC connector.
      */
-    vpcConnector?: string | ResetValue;
+    vpcConnector?: string | Expression<string> | ResetValue;
     /**
      * Egress settings for VPC connector.
      */

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

@@ -41,7 +41,7 @@ function onNewTesterIosDevicePublished(appIdOrOptsOrHandler, handler) {
     }
     const [opts, appId] = getOptsAndApp(appIdOrOptsOrHandler);
     const func = (raw) => {
-        return (0, trace_1.wrapTraceContext)(handler((0, alerts_1.convertAlertAndApp)(raw)));
+        return (0, trace_1.wrapTraceContext)(handler)((0, alerts_1.convertAlertAndApp)(raw));
     };
     func.run = handler;
     func.__endpoint = (0, alerts_1.getEndpointAnnotation)(opts, exports.newTesterIosDeviceAlert, appId);
@@ -61,7 +61,7 @@ function onInAppFeedbackPublished(appIdOrOptsOrHandler, handler) {
     }
     const [opts, appId] = getOptsAndApp(appIdOrOptsOrHandler);
     const func = (raw) => {
-        return (0, trace_1.wrapTraceContext)(handler((0, alerts_1.convertAlertAndApp)(raw)));
+        return (0, trace_1.wrapTraceContext)(handler)((0, alerts_1.convertAlertAndApp)(raw));
     };
     func.run = handler;
     func.__endpoint = (0, alerts_1.getEndpointAnnotation)(opts, exports.inAppFeedbackAlert, appId);

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

@@ -55,7 +55,7 @@ function onOperation(alertType, optsOrHandler, handler) {
         optsOrHandler = {};
     }
     const func = (raw) => {
-        return (0, trace_1.wrapTraceContext)(handler((0, alerts_1.convertAlertAndApp)(raw)));
+        return (0, trace_1.wrapTraceContext)(handler)((0, alerts_1.convertAlertAndApp)(raw));
     };
     func.run = handler;
     func.__endpoint = (0, alerts_1.getEndpointAnnotation)(optsOrHandler, alertType);

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

@@ -142,7 +142,7 @@ export interface CrashlyticsOptions extends options.EventHandlerOptions {
      */
     memory?: options.MemoryOption | Expression<number> | ResetValue;
     /**
-     * Timeout for the function in sections, possible values are 0 to 540.
+     * Timeout for the function in seconds, possible values are 0 to 540.
      * HTTPS functions can specify a higher timeout.
      *
      * @remarks
@@ -189,7 +189,7 @@ export interface CrashlyticsOptions extends options.EventHandlerOptions {
     /**
      * Connect cloud function to specified VPC connector.
      */
-    vpcConnector?: string | ResetValue;
+    vpcConnector?: string | Expression<string> | ResetValue;
     /**
      * Egress settings for VPC connector.
      */

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

@@ -64,7 +64,7 @@ export interface ReferenceOptions<Ref extends string = string> extends options.E
      */
     memory?: options.MemoryOption | Expression<number> | ResetValue;
     /**
-     * Timeout for the function in sections, possible values are 0 to 540.
+     * Timeout for the function in seconds, possible values are 0 to 540.
      * HTTPS functions can specify a higher timeout.
      *
      * @remarks
@@ -111,7 +111,7 @@ export interface ReferenceOptions<Ref extends string = string> extends options.E
     /**
      * Connect cloud function to specified VPC connector.
      */
-    vpcConnector?: string | ResetValue;
+    vpcConnector?: string | Expression<string> | ResetValue;
     /**
      * Egress settings for VPC connector.
      */

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

@@ -41,7 +41,7 @@ export interface EventarcTriggerOptions extends options.EventHandlerOptions {
      */
     memory?: options.MemoryOption | Expression<number> | ResetValue;
     /**
-     * Timeout for the function in sections, possible values are 0 to 540.
+     * Timeout for the function in seconds, possible values are 0 to 540.
      * HTTPS functions can specify a higher timeout.
      *
      * @remarks
@@ -88,7 +88,7 @@ export interface EventarcTriggerOptions extends options.EventHandlerOptions {
     /**
      * Connect cloud function to specified VPC connector.
      */
-    vpcConnector?: string | ResetValue;
+    vpcConnector?: string | Expression<string> | ResetValue;
     /**
      * Egress settings for VPC connector.
      */

package/lib/v2/providers/eventarc.js

@@ -67,6 +67,12 @@ function onCustomEventPublished(eventTypeOrOpts, handler) {
     (0, encoding_1.convertIfPresent)(endpoint.eventTrigger, opts, "eventFilters", "filters");
     (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, "retry");
     func.__endpoint = endpoint;
+    func.__requiredAPIs = [
+        {
+            api: "eventarcpublishing.googleapis.com",
+            reason: "Needed for custom event functions",
+        },
+    ];
     return func;
 }
 exports.onCustomEventPublished = onCustomEventPublished;

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

@@ -28,7 +28,7 @@ export interface HttpsOptions extends Omit<GlobalOptions, "region"> {
      */
     memory?: options.MemoryOption | Expression<number> | ResetValue;
     /**
-     * Timeout for the function in sections, possible values are 0 to 540.
+     * Timeout for the function in seconds, possible values are 0 to 540.
      * HTTPS functions can specify a higher timeout.
      *
      * @remarks
@@ -75,7 +75,7 @@ export interface HttpsOptions extends Omit<GlobalOptions, "region"> {
     /**
      * Connect cloud function to specified VPC connector.
      */
-    vpcConnector?: string | ResetValue;
+    vpcConnector?: string | Expression<string> | ResetValue;
     /**
      * Egress settings for VPC connector.
      */

package/lib/v2/providers/https.js

@@ -44,7 +44,11 @@ function onRequest(optsOrHandler, handler) {
         opts = optsOrHandler;
     }
     if ((0, debug_1.isDebugFeatureEnabled)("enableCors") || "cors" in opts) {
-        const origin = (0, debug_1.isDebugFeatureEnabled)("enableCors") ? true : opts.cors;
+        let origin = opts.cors;
+        if ((0, debug_1.isDebugFeatureEnabled)("enableCors")) {
+            // Respect `cors: false` to turn off cors even if debug feature is enabled.
+            origin = opts.cors === false ? false : true;
+        }
         const userProvidedHandler = handler;
         handler = (req, res) => {
             return new Promise((resolve) => {

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

@@ -39,7 +39,7 @@ export interface BlockingOptions {
      */
     memory?: options.MemoryOption | Expression<number> | ResetValue;
     /**
-     * Timeout for the function in sections, possible values are 0 to 540.
+     * Timeout for the function in seconds, possible values are 0 to 540.
      * HTTPS functions can specify a higher timeout.
      *
      * @remarks
@@ -86,7 +86,7 @@ export interface BlockingOptions {
     /**
      * Connect cloud function to specified VPC connector.
      */
-    vpcConnector?: string | ResetValue;
+    vpcConnector?: string | Expression<string> | ResetValue;
     /**
      * Egress settings for VPC connector.
      */

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

@@ -97,7 +97,7 @@ export interface PubSubOptions extends options.EventHandlerOptions {
      */
     memory?: options.MemoryOption | Expression<number> | ResetValue;
     /**
-     * Timeout for the function in sections, possible values are 0 to 540.
+     * Timeout for the function in seconds, possible values are 0 to 540.
      * HTTPS functions can specify a higher timeout.
      *
      * @remarks
@@ -144,7 +144,7 @@ export interface PubSubOptions extends options.EventHandlerOptions {
     /**
      * Connect cloud function to specified VPC connector.
      */
-    vpcConnector?: string | ResetValue;
+    vpcConnector?: string | Expression<string> | ResetValue;
     /**
      * Egress settings for VPC connector.
      */

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

@@ -173,7 +173,7 @@ export interface StorageOptions extends options.EventHandlerOptions {
      */
     memory?: options.MemoryOption | Expression<number> | ResetValue;
     /**
-     * Timeout for the function in sections, possible values are 0 to 540.
+     * Timeout for the function in seconds, possible values are 0 to 540.
      * HTTPS functions can specify a higher timeout.
      *
      * @remarks
@@ -220,7 +220,7 @@ export interface StorageOptions extends options.EventHandlerOptions {
     /**
      * Connect cloud function to specified VPC connector.
      */
-    vpcConnector?: string | ResetValue;
+    vpcConnector?: string | Expression<string> | ResetValue;
     /**
      * Egress settings for VPC connector.
      */

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

@@ -32,7 +32,7 @@ export interface TaskQueueOptions extends options.EventHandlerOptions {
      */
     memory?: options.MemoryOption | Expression<number> | ResetValue;
     /**
-     * Timeout for the function in sections, possible values are 0 to 540.
+     * Timeout for the function in seconds, possible values are 0 to 540.
      * HTTPS functions can specify a higher timeout.
      *
      * @remarks
@@ -79,7 +79,7 @@ export interface TaskQueueOptions extends options.EventHandlerOptions {
     /**
      * Connect cloud function to specified VPC connector.
      */
-    vpcConnector?: string | ResetValue;
+    vpcConnector?: string | Expression<string> | ResetValue;
     /**
      * Egress settings for VPC connector.
      */

package/lib/v2/providers/testLab.js

@@ -43,7 +43,7 @@ function onTestMatrixCompleted(optsOrHandler, handler) {
     const baseOpts = (0, options_1.optionsToEndpoint)((0, options_1.getGlobalOptions)());
     const specificOpts = (0, options_1.optionsToEndpoint)(optsOrHandler);
     const func = (raw) => {
-        return (0, trace_1.wrapTraceContext)(handler(raw));
+        return (0, trace_1.wrapTraceContext)(handler)(raw);
     };
     func.run = handler;
     const ep = {

package/lib/v2/trace.js

@@ -15,7 +15,7 @@ function wrapTraceContext(handler) {
             // eslint-disable-next-line prefer-spread
             return handler.apply(null, args);
         }
-        trace_1.traceContext.run(traceParent, handler, ...args);
+        return trace_1.traceContext.run(traceParent, handler, ...args);
     };
 }
 exports.wrapTraceContext = wrapTraceContext;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -201,7 +201,7 @@
     "@microsoft/api-extractor": "^7.18.7",
     "@types/chai": "^4.1.7",
     "@types/chai-as-promised": "^7.1.0",
-    "@types/jsonwebtoken": "^8.3.2",
+    "@types/jsonwebtoken": "^9.0.0",
     "@types/mocha": "^5.2.7",
     "@types/mock-require": "^2.0.0",
     "@types/nock": "^10.0.3",
@@ -222,12 +222,12 @@
     "firebase-admin": "^10.3.0",
     "js-yaml": "^3.13.1",
     "jsdom": "^16.2.1",
-    "jsonwebtoken": "^8.5.1",
+    "jsonwebtoken": "^9.0.0",
     "jwk-to-pem": "^2.0.5",
     "mocha": "^6.1.4",
     "mock-require": "^3.0.3",
     "mz": "^2.7.0",
-    "nock": "^10.0.6",
+    "nock": "^13.2.9",
     "node-fetch": "^2.6.7",
     "portfinder": "^1.0.28",
     "prettier": "^2.7.1",