firebase-functions 4.6.0 → 4.7.0

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

@@ -1,5 +1,12 @@
 import { App } from "firebase-admin/app";
 import * as database from "firebase-admin/database";
+/**
+ * Pulled from @firebase/database-types, make sure the interface is updated on dependencies upgrades.
+ * Represents a child snapshot of a `Reference` that is being iterated over. The key will never be undefined.
+ */
+interface IteratedDataSnapshot extends DataSnapshot {
+    key: string;
+}
 /**
  * Interface representing a Firebase Realtime database data snapshot.
  */
@@ -97,7 +104,7 @@ export declare class DataSnapshot implements database.DataSnapshot {
      * @return `true` if enumeration was canceled due to your callback
      *   returning `true`.
      */
-    forEach(action: (a: DataSnapshot) => boolean | void): boolean;
+    forEach(action: (a: IteratedDataSnapshot) => boolean | void): boolean;
     /**
      * Returns `true` if the specified child path has (non-`null`) data.
      *
@@ -141,3 +148,4 @@ export declare class DataSnapshot implements database.DataSnapshot {
     /** @hidden */
     private _fullPath;
 }
+export {};

package/lib/common/providers/database.js

@@ -101,6 +101,9 @@ class DataSnapshot {
         let source = this._data;
         if (parts.length) {
             for (const part of parts) {
+                if (source[part] === undefined) {
+                    return null;
+                }
                 source = source[part];
             }
         }

package/lib/params/index.d.ts

@@ -3,6 +3,7 @@
  * @alpha
  */
 import { BooleanParam, Expression, IntParam, Param, ParamOptions, SecretParam, StringParam, ListParam } from "./types";
+export { BUCKET_PICKER, TextInput, SelectInput, SelectOptions, MultiSelectInput, select, multiSelect, } from "./types";
 export { ParamOptions, Expression };
 type SecretOrExpr = Param<any> | SecretParam;
 export declare const declaredParams: SecretOrExpr[];

package/lib/params/index.js

@@ -21,13 +21,17 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+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 = exports.multiSelect = exports.select = exports.BUCKET_PICKER = void 0;
 /**
  * @hidden
  * @alpha
  */
 const types_1 = require("./types");
 Object.defineProperty(exports, "Expression", { enumerable: true, get: function () { return types_1.Expression; } });
+var types_2 = require("./types");
+Object.defineProperty(exports, "BUCKET_PICKER", { enumerable: true, get: function () { return types_2.BUCKET_PICKER; } });
+Object.defineProperty(exports, "select", { enumerable: true, get: function () { return types_2.select; } });
+Object.defineProperty(exports, "multiSelect", { enumerable: true, get: function () { return types_2.multiSelect; } });
 exports.declaredParams = [];
 /**
  * Use a helper to manage the list such that params are uniquely

package/lib/params/types.d.ts

@@ -30,33 +30,35 @@ export declare class CompareExpression<T extends string | number | boolean | str
 }
 /** @hidden */
 type ParamValueType = "string" | "list" | "boolean" | "int" | "float" | "secret";
-type ParamInput<T> = {
-    text: TextInput<T>;
-} | {
-    select: SelectInput<T>;
-} | {
-    multiSelect: MultiSelectInput;
-} | {
-    resource: ResourceInput;
-};
+/** Create a select input from a series of values. */
+export declare function select<T>(options: T[]): SelectInput<T>;
+/** Create a select input from a map of labels to vaues. */
+export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
+/** Create a multi-select input from a series of values. */
+export declare function multiSelect(options: string[]): MultiSelectInput;
+/** Create a multi-select input from map of labels to values. */
+export declare function multiSelect(options: Record<string, string>): MultiSelectInput;
+type ParamInput<T> = TextInput<T> | SelectInput<T> | (T extends string[] ? MultiSelectInput : never) | (T extends string ? ResourceInput : never);
 /**
  * Specifies that a Param's value should be determined by prompting the user
  * to type it in interactively at deploy-time. Input that does not match the
  * provided validationRegex, if present, will be retried.
  */
 export interface TextInput<T = unknown> {
-    example?: string;
-    /**
-     * A regular expression (or an escaped string to compile into a regular
-     * expression) which the prompted text must satisfy; the prompt will retry
-     * until input matching the regex is provided.
-     */
-    validationRegex?: string | RegExp;
-    /**
-     * A custom error message to display when retrying the prompt based on input
-     * failing to conform to the validationRegex,
-     */
-    validationErrorMessage?: string;
+    text: {
+        example?: string;
+        /**
+         * A regular expression (or an escaped string to compile into a regular
+         * expression) which the prompted text must satisfy; the prompt will retry
+         * until input matching the regex is provided.
+         */
+        validationRegex?: string | RegExp;
+        /**
+         * A custom error message to display when retrying the prompt based on input
+         * failing to conform to the validationRegex,
+         */
+        validationErrorMessage?: string;
+    };
 }
 /**
  * Specifies that a Param's value should be determined by having the user
@@ -65,15 +67,18 @@ export interface TextInput<T = unknown> {
  */
 export interface ResourceInput {
     resource: {
-        type: string;
+        type: "storage.googleapis.com/Bucket";
     };
 }
+export declare const BUCKET_PICKER: ResourceInput;
 /**
  * Specifies that a Param's value should be determined by having the user select
  * from a list of pre-canned options interactively at deploy-time.
  */
 export interface SelectInput<T = unknown> {
-    options: Array<SelectOptions<T>>;
+    select: {
+        options: Array<SelectOptions<T>>;
+    };
 }
 /**
  * Specifies that a Param's value should be determined by having the user select
@@ -81,7 +86,9 @@ export interface SelectInput<T = unknown> {
  * Will result in errors if used on Params of type other than string[].
  */
 export interface MultiSelectInput {
-    options: Array<SelectOptions<string>>;
+    multiSelect: {
+        options: Array<SelectOptions<string>>;
+    };
 }
 /**
  * One of the options provided to a SelectInput, containing a value and

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.ListParam = 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.BUCKET_PICKER = exports.multiSelect = exports.select = exports.CompareExpression = exports.TernaryExpression = exports.Expression = void 0;
 const logger = require("../logger");
 /*
  * A CEL expression which can be evaluated during function deployment, and
@@ -142,6 +142,43 @@ class CompareExpression extends Expression {
     }
 }
 exports.CompareExpression = CompareExpression;
+/** Create a select input from a series of values or a map of labels to values */
+function select(options) {
+    let wireOpts;
+    if (Array.isArray(options)) {
+        wireOpts = options.map((opt) => ({ value: opt }));
+    }
+    else {
+        wireOpts = Object.entries(options).map(([label, value]) => ({ label, value }));
+    }
+    return {
+        select: {
+            options: wireOpts,
+        },
+    };
+}
+exports.select = select;
+/** Create a multi-select input from a series of values or map of labels to values. */
+function multiSelect(options) {
+    let wireOpts;
+    if (Array.isArray(options)) {
+        wireOpts = options.map((opt) => ({ value: opt }));
+    }
+    else {
+        wireOpts = Object.entries(options).map(([label, value]) => ({ label, value }));
+    }
+    return {
+        multiSelect: {
+            options: wireOpts,
+        },
+    };
+}
+exports.multiSelect = multiSelect;
+exports.BUCKET_PICKER = {
+    resource: {
+        type: "storage.googleapis.com/Bucket",
+    },
+};
 /**
  * Represents a parametrized value that will be read from .env files if present,
  * or prompted for by the CLI if missing. Instantiate these with the defineX

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

@@ -159,7 +159,7 @@ export interface StorageEvent extends CloudEvent<StorageObjectData> {
 /** StorageOptions extend EventHandlerOptions with a bucket name  */
 export interface StorageOptions extends options.EventHandlerOptions {
     /** The name of the bucket containing this object. */
-    bucket?: string;
+    bucket?: string | Expression<string>;
     /**
      * If true, do not deploy or emulate this function.
      */
@@ -259,7 +259,7 @@ export declare function onObjectArchived(handler: (event: StorageEvent) => any |
  * @param bucket - The name of the bucket containing this object.
  * @param handler - Event handler which is run every time a Google Cloud Storage archival occurs.
  */
-export declare function onObjectArchived(bucket: string, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+export declare function onObjectArchived(bucket: string | Expression<string>, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
 /**
  * Event handler sent only when a bucket has enabled object versioning.
  * This event indicates that the live version of an object has become an
@@ -292,7 +292,7 @@ export declare function onObjectFinalized(handler: (event: StorageEvent) => any
  * @param bucket - The name of the bucket containing this object.
  * @param handler - Event handler which is run every time a Google Cloud Storage object creation occurs.
  */
-export declare function onObjectFinalized(bucket: string, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+export declare function onObjectFinalized(bucket: string | Expression<string>, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
 /**
  * Event handler which fires every time a Google Cloud Storage object
  * creation occurs.
@@ -329,7 +329,7 @@ export declare function onObjectDeleted(handler: (event: StorageEvent) => any |
  * @param bucket - The name of the bucket containing this object.
  * @param handler - Event handler which is run every time a Google Cloud Storage object deletion occurs.
  */
-export declare function onObjectDeleted(bucket: string, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+export declare function onObjectDeleted(bucket: string | Expression<string>, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
 /**
  * Event handler which fires every time a Google Cloud Storage deletion occurs.
  *
@@ -358,7 +358,7 @@ export declare function onObjectMetadataUpdated(handler: (event: StorageEvent) =
  * @param bucket - The name of the bucket containing this object.
  * @param handler - Event handler which is run every time a Google Cloud Storage object metadata update occurs.
  */
-export declare function onObjectMetadataUpdated(bucket: string, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+export declare function onObjectMetadataUpdated(bucket: string | Expression<string>, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
 /**
  * Event handler which fires every time the metadata of an existing object
  * changes.

package/lib/v2/providers/storage.js

@@ -161,7 +161,8 @@ function getOptsAndBucket(bucketOrOpts) {
     var _a;
     let bucket;
     let opts;
-    if (typeof bucketOrOpts === "string") {
+    // If bucket is a string or Expression<string>
+    if (typeof bucketOrOpts === "string" || "value" in bucketOrOpts) {
         bucket = bucketOrOpts;
         opts = {};
     }
@@ -174,7 +175,7 @@ function getOptsAndBucket(bucketOrOpts) {
         throw new Error("Missing bucket name. If you are unit testing, please provide a bucket name" +
             " by providing bucket name directly in the event handler or by setting process.env.FIREBASE_CONFIG.");
     }
-    if (!/^[a-z\d][a-z\d\\._-]{1,230}[a-z\d]$/.test(bucket)) {
+    if (typeof bucket === "string" && !/^[a-z\d][a-z\d\\._-]{1,230}[a-z\d]$/.test(bucket)) {
         throw new Error(`Invalid bucket name ${bucket}`);
     }
     return [opts, bucket];

package/package.json

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