firebase-functions 6.5.0 → 6.6.0

package/lib/params/index.d.ts

@@ -2,10 +2,10 @@
  * @hidden
  * @alpha
  */
-import { BooleanParam, Expression, IntParam, Param, ParamOptions, SecretParam, StringParam, ListParam } from "./types";
+import { BooleanParam, Expression, IntParam, Param, ParamOptions, SecretParam, JsonSecretParam, StringParam, ListParam } from "./types";
 export { BUCKET_PICKER, TextInput, SelectInput, SelectOptions, MultiSelectInput, select, multiSelect, } from "./types";
 export { ParamOptions, Expression };
-type SecretOrExpr = Param<any> | SecretParam;
+type SecretOrExpr = Param<any> | SecretParam | JsonSecretParam<any>;
 export declare const declaredParams: SecretOrExpr[];
 /**
  * A built-in parameter that resolves to the default RTDB database URL associated
@@ -37,6 +37,19 @@ export declare const storageBucket: Param<string>;
  * @returns A parameter with a `string` return type for `.value`.
  */
 export declare function defineSecret(name: string): SecretParam;
+/**
+ * Declares a secret parameter that retrieves a structured JSON object in Cloud Secret Manager.
+ * This is useful for managing groups of related configuration values, such as all settings
+ * for a third-party API, as a single unit.
+ *
+ * The secret value must be a valid JSON string. At runtime, the value will be automatically parsed
+ * and returned as a JavaScript object. If the value is not set or is not valid JSON, an error will be thrown.
+ *
+ * @param name The name of the environment variable to use to load the parameter.
+ * @returns A parameter whose `.value()` method returns the parsed JSON object.
+ * ```
+ */
+export declare function defineJsonSecret<T = any>(name: string): JsonSecretParam<T>;
 /**
  * Declare a string parameter.
  *

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.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;
+exports.defineList = exports.defineFloat = exports.defineInt = exports.defineBoolean = exports.defineString = exports.defineJsonSecret = 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
@@ -89,6 +89,24 @@ function defineSecret(name) {
     return param;
 }
 exports.defineSecret = defineSecret;
+/**
+ * Declares a secret parameter that retrieves a structured JSON object in Cloud Secret Manager.
+ * This is useful for managing groups of related configuration values, such as all settings
+ * for a third-party API, as a single unit.
+ *
+ * The secret value must be a valid JSON string. At runtime, the value will be automatically parsed
+ * and returned as a JavaScript object. If the value is not set or is not valid JSON, an error will be thrown.
+ *
+ * @param name The name of the environment variable to use to load the parameter.
+ * @returns A parameter whose `.value()` method returns the parsed JSON object.
+ * ```
+ */
+function defineJsonSecret(name) {
+    const param = new types_1.JsonSecretParam(name);
+    registerParam(param);
+    return param;
+}
+exports.defineJsonSecret = defineJsonSecret;
 /**
  * Declare a string parameter.
  *

package/lib/params/types.d.ts

@@ -114,6 +114,8 @@ export type ParamSpec<T extends string | number | boolean | string[]> = {
     description?: string;
     /** The way in which the Firebase CLI will prompt for the value of this parameter. Defaults to a TextInput. */
     input?: ParamInput<T>;
+    /** Optional format annotation for additional type information (e.g., "json" for JSON-encoded secrets). */
+    format?: string;
 };
 /**
  * Representation of parameters for the stack over the wire.
@@ -130,6 +132,7 @@ export type WireParamSpec<T extends string | number | boolean | string[]> = {
     description?: string;
     type: ParamValueType;
     input?: ParamInput<T>;
+    format?: string;
 };
 /** Configuration options which can be used to customize the prompting behavior of a parameter. */
 export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;
@@ -177,6 +180,20 @@ export declare class SecretParam {
     /** Returns the secret's value at runtime. Throws an error if accessed during deployment. */
     value(): string;
 }
+/**
+ * A parametrized object whose value is stored as a JSON string in Cloud Secret Manager.
+ * This is useful for managing groups of related configuration values, such as all settings
+ * for a third-party API, as a single unit. Supply instances of JsonSecretParam to the
+ * secrets array while defining a Function to make their values accessible during execution
+ * of that Function.
+ */
+export declare class JsonSecretParam<T = any> {
+    static type: ParamValueType;
+    name: string;
+    constructor(name: string);
+    /** Returns the secret's parsed JSON value at runtime. Throws an error if accessed during deployment, if the secret is not set, or if the value is not valid JSON. */
+    value(): T;
+}
 /**
  *  A parametrized value of String type that will be read from .env files
  *  if present, or prompted for by the CLI if missing.

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.BUCKET_PICKER = exports.multiSelect = exports.select = exports.CompareExpression = exports.TernaryExpression = exports.Expression = void 0;
+exports.ListParam = exports.BooleanParam = exports.FloatParam = exports.IntParam = exports.InternalExpression = exports.StringParam = exports.JsonSecretParam = 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
@@ -293,6 +293,48 @@ class SecretParam {
 }
 exports.SecretParam = SecretParam;
 SecretParam.type = "secret";
+/**
+ * A parametrized object whose value is stored as a JSON string in Cloud Secret Manager.
+ * This is useful for managing groups of related configuration values, such as all settings
+ * for a third-party API, as a single unit. Supply instances of JsonSecretParam to the
+ * secrets array while defining a Function to make their values accessible during execution
+ * of that Function.
+ */
+class JsonSecretParam {
+    constructor(name) {
+        this.name = name;
+    }
+    /** @internal */
+    runtimeValue() {
+        const val = process.env[this.name];
+        if (val === undefined) {
+            throw new Error(`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.`);
+        }
+        try {
+            return JSON.parse(val);
+        }
+        catch (error) {
+            throw new Error(`"${this.name}" could not be parsed as JSON. Please verify its value in Secret Manager. Details: ${error}`);
+        }
+    }
+    /** @internal */
+    toSpec() {
+        return {
+            type: "secret",
+            name: this.name,
+            format: "json",
+        };
+    }
+    /** Returns the secret's parsed JSON value at runtime. Throws an error if accessed during deployment, if the secret is not set, or if the value is not valid JSON. */
+    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.JsonSecretParam = JsonSecretParam;
+JsonSecretParam.type = "secret";
 /**
  *  A parametrized value of String type that will be read from .env files
  *  if present, or prompted for by the CLI if missing.

package/lib/v1/providers/analytics.js

@@ -104,6 +104,19 @@ class AnalyticsEvent {
     }
 }
 exports.AnalyticsEvent = AnalyticsEvent;
+function isValidUserProperty(property) {
+    if (property == null || typeof property !== "object" || !("value" in property)) {
+        return false;
+    }
+    const { value } = property;
+    if (value == null) {
+        return false;
+    }
+    if (typeof value === "object" && Object.keys(value).length === 0) {
+        return false;
+    }
+    return true;
+}
 /**
  * Interface representing the user who triggered the events.
  */
@@ -116,7 +129,9 @@ class UserDimensions {
         copyTimestampToString(wireFormat, this, "firstOpenTimestampMicros", "firstOpenTime");
         this.userProperties = {}; // With no entries in the wire format, present an empty (as opposed to absent) map.
         copyField(wireFormat, this, "userProperties", (r) => {
-            const entries = Object.entries(r).map(([k, v]) => [k, new UserPropertyValue(v)]);
+            const entries = Object.entries(r)
+                .filter(([, v]) => isValidUserProperty(v))
+                .map(([k, v]) => [k, new UserPropertyValue(v)]);
             return Object.fromEntries(entries);
         });
         copyField(wireFormat, this, "bundleInfo", (r) => new ExportBundleInfo(r));
@@ -203,8 +218,19 @@ function mapKeys(obj, transform) {
 // 'unwrapValue' method just below.
 /** @hidden */
 function unwrapValueAsString(wrapped) {
-    const key = Object.keys(wrapped)[0];
-    return wrapped[key].toString();
+    if (!wrapped || typeof wrapped !== "object") {
+        return "";
+    }
+    const keys = Object.keys(wrapped);
+    if (keys.length === 0) {
+        return "";
+    }
+    const key = keys[0];
+    const value = wrapped[key];
+    if (value === null || value === undefined) {
+        return "";
+    }
+    return value.toString();
 }
 // Ditto as the method above, but returning the values in the idiomatic JavaScript type (string for strings,
 // number for numbers):

package/package.json

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