firebase-functions 6.5.0 → 7.0.0-rc.0

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.