firebase-functions 6.2.0 → 6.3.0

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

@@ -69,7 +69,7 @@ export interface CallableRequest<T = any> {
      */
     data: T;
     /**
-     * The result of decoding and verifying a Firebase AppCheck token.
+     * The result of decoding and verifying a Firebase App Check token.
      */
     app?: AppCheckData;
     /**
@@ -87,14 +87,14 @@ export interface CallableRequest<T = any> {
     /**
      * Whether this is a streaming request.
      * Code can be optimized by not trying to generate a stream of chunks to
-     * call response.sendChunk on if request.acceptsStreaming is false.
-     * It is always safe, however, to call response.sendChunk as this will
-     * noop if acceptsStreaming is false.
+     * call `response.sendChunk` if `request.acceptsStreaming` is false.
+     * It is always safe, however, to call `response.sendChunk` as this will
+     * noop if `acceptsStreaming` is false.
      */
     acceptsStreaming: boolean;
 }
 /**
- * CallableProxyResponse allows streaming response chunks and listening to signals
+ * `CallableProxyResponse` allows streaming response chunks and listening to signals
  * triggered in events such as a disconnect.
  */
 export interface CallableResponse<T = unknown> {
@@ -106,7 +106,7 @@ export interface CallableResponse<T = unknown> {
      */
     sendChunk: (chunk: T) => Promise<boolean>;
     /**
-     * An AbortSignal that is triggered when the client disconnects or the
+     * An `AbortSignal` that is triggered when the client disconnects or the
      * request is terminated prematurely.
      */
     signal: AbortSignal;

package/lib/common/providers/https.js

@@ -396,7 +396,7 @@ function onCallHandler(options, handler, version) {
 }
 exports.onCallHandler = onCallHandler;
 function encodeSSE(data) {
-    return `data: ${JSON.stringify(data)}\n`;
+    return `data: ${JSON.stringify(data)}\n\n`;
 }
 /** @internal */
 function wrapOnCallHandler(options, handler, version) {
@@ -416,7 +416,7 @@ function wrapOnCallHandler(options, handler, version) {
             if (!abortController.signal.aborted) {
                 heartbeatInterval = setTimeout(() => {
                     if (!abortController.signal.aborted) {
-                        res.write(": ping\n");
+                        res.write(": ping\n\n");
                         scheduleHeartbeat();
                     }
                 }, heartbeatSeconds * 1000);

package/lib/runtime/manifest.d.ts

@@ -42,7 +42,9 @@ export interface ManifestEndpoint {
     httpsTrigger?: {
         invoker?: string[];
     };
-    callableTrigger?: Record<string, never>;
+    callableTrigger?: {
+        genkitAction?: string;
+    };
     eventTrigger?: {
         eventFilters: Record<string, string | Expression<string>>;
         eventFilterPathPatterns?: Record<string, string | Expression<string>>;

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

@@ -60,7 +60,7 @@ export interface FirebaseAlertOptions extends options.EventHandlerOptions {
      * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
      * function depends on the type of function: Event handling functions have a
      * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
-     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
      * timeout of 1,800s (30 minutes)
      */
     timeoutSeconds?: number | Expression<number> | ResetValue;

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

@@ -83,7 +83,7 @@ export interface AppDistributionOptions extends options.EventHandlerOptions {
      * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
      * function depends on the type of function: Event handling functions have a
      * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
-     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
      * timeout of 1,800s (30 minutes)
      */
     timeoutSeconds?: number | Expression<number> | ResetValue;

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

@@ -149,7 +149,7 @@ export interface CrashlyticsOptions extends options.EventHandlerOptions {
      * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
      * function depends on the type of function: Event handling functions have a
      * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
-     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
      * timeout of 1,800s (30 minutes)
      */
     timeoutSeconds?: number | Expression<number> | ResetValue;

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

@@ -48,7 +48,7 @@ export interface EventarcTriggerOptions extends options.EventHandlerOptions {
      * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
      * function depends on the type of function: Event handling functions have a
      * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
-     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
      * timeout of 1,800s (30 minutes)
      */
     timeoutSeconds?: number | Expression<number> | ResetValue;

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

@@ -6,7 +6,7 @@ import { GlobalOptions, SupportedRegion } from "../options";
 import { Expression } from "../../params";
 import { SecretParam } from "../../params/types";
 import * as options from "../options";
-export { Request, CallableRequest, FunctionsErrorCode, HttpsError };
+export { Request, CallableRequest, CallableResponse, FunctionsErrorCode, HttpsError };
 /**
  * Options that can be set on an onRequest HTTPS function.
  */
@@ -35,7 +35,7 @@ export interface HttpsOptions extends Omit<GlobalOptions, "region" | "enforceApp
      * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
      * function depends on the type of function: Event handling functions have a
      * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
-     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
      * timeout of 1,800s (30 minutes)
      */
     timeoutSeconds?: number | Expression<number> | ResetValue;
@@ -178,7 +178,7 @@ export interface CallableFunction<T, Return, Stream = unknown> extends HttpsFunc
      */
     run(request: CallableRequest<T>): Return;
     stream(request: CallableRequest<T>, response: CallableResponse<Stream>): {
-        stream: AsyncIterator<Stream>;
+        stream: AsyncIterable<Stream>;
         output: Return;
     };
 }
@@ -208,3 +208,26 @@ export declare function onCall<T = any, Return = any | Promise<any>, Stream = un
  * @returns A function that you can export and deploy.
  */
 export declare function onCall<T = any, Return = any | Promise<any>, Stream = unknown>(handler: (request: CallableRequest<T>, response?: CallableResponse<Stream>) => Return): CallableFunction<T, Return extends Promise<unknown> ? Return : Promise<Return>>;
+interface ZodType<T = any> {
+    __output: T;
+}
+interface GenkitRunOptions {
+    context?: any;
+}
+type GenkitAction<I extends ZodType = ZodType<any>, O extends ZodType = ZodType<any>, S extends ZodType = ZodType<any>> = {
+    run(input: I["__output"], options: GenkitRunOptions): Promise<{
+        result: O["__output"];
+    }>;
+    stream(input: I["__output"], options: GenkitRunOptions): {
+        stream: AsyncIterable<S["__output"]>;
+        output: Promise<O["__output"]>;
+    };
+    __action: {
+        name: string;
+    };
+};
+type ActionInput<F extends GenkitAction> = F extends GenkitAction<infer I extends ZodType, any, any> ? I["__output"] : never;
+type ActionOutput<F extends GenkitAction> = F extends GenkitAction<any, infer O extends ZodType, any> ? O["__output"] : never;
+type ActionStream<F extends GenkitAction> = F extends GenkitAction<any, any, infer S extends ZodType> ? S["__output"] : never;
+export declare function onCallGenkit<A extends GenkitAction>(action: A): CallableFunction<ActionInput<A>, Promise<ActionOutput<A>>, ActionStream<A>>;
+export declare function onCallGenkit<A extends GenkitAction>(opts: CallableOptions<ActionInput<A>>, flow: A): CallableFunction<ActionInput<A>, Promise<ActionOutput<A>>, ActionStream<A>>;

package/lib/v2/providers/https.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.onCall = exports.onRequest = exports.hasClaim = exports.isSignedIn = exports.HttpsError = void 0;
+exports.onCallGenkit = exports.onCall = exports.onRequest = exports.hasClaim = exports.isSignedIn = exports.HttpsError = void 0;
 /**
  * Cloud functions to handle HTTPS request or callable RPCs.
  * @packageDocumentation
@@ -35,6 +35,7 @@ Object.defineProperty(exports, "HttpsError", { enumerable: true, get: function (
 const manifest_1 = require("../../runtime/manifest");
 const options = require("../options");
 const onInit_1 = require("../../common/onInit");
+const logger = require("../../logger");
 /**
  * An auth policy that requires a user to be signed in.
  */
@@ -209,3 +210,33 @@ function onCall(optsOrHandler, handler) {
     return func;
 }
 exports.onCall = onCall;
+function onCallGenkit(optsOrAction, action) {
+    var _a;
+    let opts;
+    if (arguments.length === 2) {
+        opts = optsOrAction;
+    }
+    else {
+        opts = {};
+        action = optsOrAction;
+    }
+    if (!((_a = opts.secrets) === null || _a === void 0 ? void 0 : _a.length)) {
+        logger.debug(`Genkit function for ${action.__action.name} is not bound to any secret. This may mean that you are not storing API keys as a secret or that you are not binding your secret to this function. See https://firebase.google.com/docs/functions/config-env?gen=2nd#secret_parameters for more information.`);
+    }
+    const cloudFunction = onCall(opts, async (req, res) => {
+        const context = {};
+        (0, encoding_1.copyIfPresent)(context, req, "auth", "app", "instanceIdToken");
+        if (!req.acceptsStreaming) {
+            const { result } = await action.run(req.data, { context });
+            return result;
+        }
+        const { stream, output } = action.stream(req.data, { context });
+        for await (const chunk of stream) {
+            await res.sendChunk(chunk);
+        }
+        return output;
+    });
+    cloudFunction.__endpoint.callableTrigger.genkitAction = action.__action.name;
+    return cloudFunction;
+}
+exports.onCallGenkit = onCallGenkit;

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

@@ -46,7 +46,7 @@ export interface BlockingOptions {
      * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
      * function depends on the type of function: Event handling functions have a
      * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
-     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
      * timeout of 1,800s (30 minutes)
      */
     timeoutSeconds?: number | Expression<number> | ResetValue;

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

@@ -104,7 +104,7 @@ export interface PubSubOptions extends options.EventHandlerOptions {
      * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
      * function depends on the type of function: Event handling functions have a
      * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
-     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
      * timeout of 1,800s (30 minutes)
      */
     timeoutSeconds?: number | Expression<number> | ResetValue;

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

@@ -180,7 +180,7 @@ export interface StorageOptions extends options.EventHandlerOptions {
      * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
      * function depends on the type of function: Event handling functions have a
      * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
-     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
      * timeout of 1,800s (30 minutes)
      */
     timeoutSeconds?: number | Expression<number> | ResetValue;

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

@@ -39,7 +39,7 @@ export interface TaskQueueOptions extends options.EventHandlerOptions {
      * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
      * function depends on the type of function: Event handling functions have a
      * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
-     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
      * timeout of 1,800s (30 minutes)
      */
     timeoutSeconds?: number | Expression<number> | ResetValue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "6.2.0",
+  "version": "6.3.0",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -300,6 +300,7 @@
     "eslint-plugin-jsdoc": "^39.2.9",
     "eslint-plugin-prettier": "^4.0.0",
     "firebase-admin": "^13.0.0",
+    "genkit": "^1.0.0-rc.4",
     "js-yaml": "^3.13.1",
     "jsdom": "^16.2.1",
     "jsonwebtoken": "^9.0.0",