firebase-functions 5.0.1 → 5.1.0

package/lib/runtime/loader.js

@@ -51,7 +51,7 @@ async function loadModule(functionsDir) {
     }
 }
 /* @internal */
-function extractStack(module, endpoints, requiredAPIs, prefix = "") {
+function extractStack(module, endpoints, requiredAPIs, extensions, prefix = "") {
     for (const [name, valAsUnknown] of Object.entries(module)) {
         // We're introspecting untrusted code here. Any is appropraite
         const val = valAsUnknown;
@@ -65,12 +65,75 @@ function extractStack(module, endpoints, requiredAPIs, prefix = "") {
                 requiredAPIs.push(...val.__requiredAPIs);
             }
         }
-        else if (typeof val === "object" && val !== null) {
-            extractStack(val, endpoints, requiredAPIs, prefix + name + "-");
+        else if (isFirebaseRefExtension(val)) {
+            extensions[val.instanceId] = {
+                params: convertExtensionParams(val.params),
+                ref: val.FIREBASE_EXTENSION_REFERENCE,
+                events: val.events || [],
+            };
+        }
+        else if (isFirebaseLocalExtension(val)) {
+            extensions[val.instanceId] = {
+                params: convertExtensionParams(val.params),
+                localPath: val.FIREBASE_EXTENSION_LOCAL_PATH,
+                events: val.events || [],
+            };
+        }
+        else if (isObject(val)) {
+            extractStack(val, endpoints, requiredAPIs, extensions, prefix + name + "-");
         }
     }
 }
 exports.extractStack = extractStack;
+function toTitleCase(txt) {
+    return txt.charAt(0).toUpperCase() + txt.substring(1).toLowerCase();
+}
+function snakeToCamelCase(txt) {
+    let ret = txt.toLowerCase();
+    ret = ret.replace(/_/g, " ");
+    ret = ret.replace(/\w\S*/g, toTitleCase);
+    ret = ret.charAt(0).toLowerCase() + ret.substring(1);
+    return ret;
+}
+function convertExtensionParams(params) {
+    const systemPrefixes = {
+        FUNCTION: "firebaseextensions.v1beta.function",
+        V2FUNCTION: "firebaseextensions.v1beta.v2function",
+    };
+    const converted = {};
+    for (const [rawKey, paramVal] of Object.entries(params)) {
+        let key = rawKey;
+        if (rawKey.startsWith("_") && rawKey !== "_EVENT_ARC_REGION") {
+            const prefix = rawKey.substring(1).split("_")[0];
+            const suffix = rawKey.substring(2 + prefix.length); // 2 for underscores
+            key = `${systemPrefixes[prefix]}/${snakeToCamelCase(suffix)}`;
+        }
+        if (Array.isArray(paramVal)) {
+            converted[key] = paramVal.join(",");
+        }
+        else {
+            converted[key] = paramVal;
+        }
+    }
+    return converted;
+}
+function isObject(value) {
+    return typeof value === "object" && value !== null;
+}
+const isFirebaseLocalExtension = (val) => {
+    return (isObject(val) &&
+        typeof val.FIREBASE_EXTENSION_LOCAL_PATH === "string" &&
+        typeof val.instanceId === "string" &&
+        isObject(val.params) &&
+        (!val.events || Array.isArray(val.events)));
+};
+const isFirebaseRefExtension = (val) => {
+    return (isObject(val) &&
+        typeof val.FIREBASE_EXTENSION_REFERENCE === "string" &&
+        typeof val.instanceId === "string" &&
+        isObject(val.params) &&
+        (!val.events || Array.isArray(val.events)));
+};
 /* @internal */
 function mergeRequiredAPIs(requiredAPIs) {
     const apiToReasons = {};
@@ -90,12 +153,14 @@ exports.mergeRequiredAPIs = mergeRequiredAPIs;
 async function loadStack(functionsDir) {
     const endpoints = {};
     const requiredAPIs = [];
+    const extensions = {};
     const mod = await loadModule(functionsDir);
-    extractStack(mod, endpoints, requiredAPIs);
+    extractStack(mod, endpoints, requiredAPIs, extensions);
     const stack = {
         endpoints,
         specVersion: "v1alpha1",
         requiredAPIs: mergeRequiredAPIs(requiredAPIs),
+        extensions,
     };
     if (params.declaredParams.length > 0) {
         stack.params = params.declaredParams.map((p) => p.toSpec());

package/lib/runtime/manifest.d.ts

@@ -1,8 +1,18 @@
 import { ResetValue } from "../common/options";
 import { Expression } from "../params";
-import { WireParamSpec } from "../params/types";
+import { WireParamSpec, SecretParam } from "../params/types";
 /**
- * An definition of a function as appears in the Manifest.
+ * A definition of an extension as appears in the Manifest.
+ * Exactly one of ref or localPath must be present.
+ */
+export interface ManifestExtension {
+    params: Record<string, string | SecretParam>;
+    ref?: string;
+    localPath?: string;
+    events: string[];
+}
+/**
+ * A definition of a function as appears in the Manifest.
  *
  * @alpha
  */
@@ -83,7 +93,8 @@ export interface ManifestRequiredAPI {
     reason: string;
 }
 /**
- * An definition of a function deployment as appears in the Manifest.
+ * A definition of a function/extension deployment as appears in the Manifest.
+ *
  * @alpha
  */
 export interface ManifestStack {
@@ -91,6 +102,7 @@ export interface ManifestStack {
     params?: WireParamSpec<any>[];
     requiredAPIs: ManifestRequiredAPI[];
     endpoints: Record<string, ManifestEndpoint>;
+    extensions?: Record<string, ManifestExtension>;
 }
 /**
  * Returns the JSON representation of a ManifestStack, which has CEL

package/package.json

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