npm - @genkit-ai/express - Versions diffs - 1.0.0-rc.9 → 1.0.5 - Mend

@genkit-ai/express 1.0.0-rc.9 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/README.md CHANGED Viewed

@@ -6,17 +6,14 @@ This plugin provides utilities for conveninetly exposing Genkit flows and action
 import { expressHandler } from '@genkit-ai/express';
 import express from 'express';
-const simpleFlow = ai.defineFlow(
-  'simpleFlow',
-  async (input, streamingCallback) => {
-    const { text } = await ai.generate({
-      model: gemini15Flash,
-      prompt: input,
-      streamingCallback,
-    });
-    return text;
-  }
-);
+const simpleFlow = ai.defineFlow('simpleFlow', async (input, { sendChunk }) => {
+  const { text } = await ai.generate({
+    model: gemini15Flash,
+    prompt: input,
+    onChunk: (c) => sendChunk(c.text),
+  });
+  return text;
+});
 const app = express();
 app.use(express.json());
@@ -26,36 +23,34 @@ app.post('/simpleFlow', expressHandler(simpleFlow));
 app.listen(8080);
 ```
-You can also set auth policies:
+You can also handle auth using context providers:
 ```ts
-// middleware for handling auth headers.
-const authMiddleware = async (req, resp, next) => {
-  // parse auth headers and convert to auth object.
-  (req as RequestWithAuth).auth = {
-    user:
-      req.header('authorization') === 'open sesame' ? 'Ali Baba' : '40 thieves',
+import { UserFacingError } from 'genkit';
+import { ContextProvider, RequestData } from 'genkit/context';
+const context: ContextProvider<Context> = (req: RequestData) => {
+  if (req.headers['authorization'] !== 'open sesame') {
+    throw new UserFacingError('PERMISSION_DENIED', 'not authorized');
+  }
+  return {
+    auth: {
+      user: 'Ali Baba',
+    },
   };
-  next();
 };
 app.post(
   '/simpleFlow',
   authMiddleware,
-  expressHandler(simpleFlow, {
-    authPolicy: ({ auth }) => {
-      if (auth.user !== 'Ali Baba') {
-        throw new Error('not authorized');
-      }
-    },
-  })
+  expressHandler(simpleFlow, { context })
 );
 ```
-Flows and actions exposed using the `expressHandler` function can be accessed using `genkit/client` library:
+Flows and actions exposed using the `expressHandler` function can be accessed using `genkit/beta/client` library:
 ```ts
-import { runFlow, streamFlow } from 'genkit/client';
+import { runFlow, streamFlow } from 'genkit/beta/client';
 const result = await runFlow({
   url: `http://localhost:${port}/simpleFlow`,
@@ -80,10 +75,10 @@ const result = streamFlow({
   url: `http://localhost:${port}/simpleFlow`,
   input: 'say hello',
 });
-for await (const chunk of result.stream()) {
+for await (const chunk of result.stream) {
   console.log(chunk);
 }
-console.log(await result.output());
+console.log(await result.output);
 ```
 The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

package/lib/index.d.mts CHANGED Viewed

@@ -1,7 +1,8 @@
-import * as bodyParser from 'body-parser';
+import bodyParser from 'body-parser';
 import { CorsOptions } from 'cors';
-import express, { RequestHandler } from 'express';
-import { z, Action, Flow } from 'genkit';
+import express from 'express';
+import { ActionContext, z, Action, Flow } from 'genkit';
+import { ContextProvider } from 'genkit/context';
 /**
  * Copyright 2024 Google LLC
@@ -19,54 +20,29 @@ import { z, Action, Flow } from 'genkit';
  * limitations under the License.
  */
-/**
- * Auth policy context is an object passed to the auth policy providing details necessary for auth.
- */
-interface AuthPolicyContext<I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny> {
-    action?: Action<I, O, S>;
-    input: z.infer<I>;
-    auth?: Record<string, any>;
-    request: RequestWithAuth;
-}
-/**
- * Flow Auth policy. Consumes the authorization context of the flow and
- * performs checks before the flow runs. If this throws, the flow will not
- * be executed.
- */
-interface AuthPolicy<I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny> {
-    (ctx: AuthPolicyContext<I, O, S>): void | Promise<void>;
-}
-/**
- * For express-based flows, req.auth should contain the value to bepassed into
- * the flow context.
- */
-interface RequestWithAuth extends express.Request {
-    auth?: Record<string, any>;
-}
 /**
  * Exposes provided flow or an action as express handler.
  */
-declare function expressHandler<I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny>(action: Action<I, O, S>, opts?: {
-    authPolicy?: AuthPolicy<I, O, S>;
+declare function expressHandler<C extends ActionContext = ActionContext, I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny>(action: Action<I, O, S>, opts?: {
+    contextProvider?: ContextProvider<C, I>;
 }): express.RequestHandler;
 /**
  * A wrapper object containing a flow with its associated auth policy.
  */
-type FlowWithAuthPolicy<I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny> = {
+type FlowWithContextProvider<C extends ActionContext = ActionContext, I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny> = {
     flow: Flow<I, O, S>;
-    authProvider: RequestHandler;
-    authPolicy: AuthPolicy;
+    context: ContextProvider<C, I>;
 };
 /**
  * Adds an auth policy to the flow.
  */
-declare function withAuth<I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny>(flow: Flow<I, O, S>, authProvider: RequestHandler, authPolicy: AuthPolicy): FlowWithAuthPolicy<I, O, S>;
+declare function withContextProvider<C extends ActionContext = ActionContext, I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny>(flow: Flow<I, O, S>, context: ContextProvider<C, I>): FlowWithContextProvider<C, I, O, S>;
 /**
  * Options to configure the flow server.
  */
 interface FlowServerOptions {
     /** List of flows to expose via the flow server. */
-    flows: (Flow<any, any, any> | FlowWithAuthPolicy<any, any, any>)[];
+    flows: (Flow<any, any, any> | FlowWithContextProvider<any, any, any>)[];
     /** Port to run the server on. Defaults to env.PORT or 3400. */
     port?: number;
     /** CORS options for the server. */
@@ -111,4 +87,4 @@ declare class FlowServer {
     static stopAll(): Promise<void[]>;
 }
-export { type AuthPolicy, type AuthPolicyContext, FlowServer, type FlowServerOptions, type FlowWithAuthPolicy, type RequestWithAuth, expressHandler, startFlowServer, withAuth };
+export { FlowServer, type FlowServerOptions, type FlowWithContextProvider, expressHandler, startFlowServer, withContextProvider };

package/lib/index.d.ts CHANGED Viewed

@@ -1,7 +1,8 @@
-import * as bodyParser from 'body-parser';
+import bodyParser from 'body-parser';
 import { CorsOptions } from 'cors';
-import express, { RequestHandler } from 'express';
-import { z, Action, Flow } from 'genkit';
+import express from 'express';
+import { ActionContext, z, Action, Flow } from 'genkit';
+import { ContextProvider } from 'genkit/context';
 /**
  * Copyright 2024 Google LLC
@@ -19,54 +20,29 @@ import { z, Action, Flow } from 'genkit';
  * limitations under the License.
  */
-/**
- * Auth policy context is an object passed to the auth policy providing details necessary for auth.
- */
-interface AuthPolicyContext<I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny> {
-    action?: Action<I, O, S>;
-    input: z.infer<I>;
-    auth?: Record<string, any>;
-    request: RequestWithAuth;
-}
-/**
- * Flow Auth policy. Consumes the authorization context of the flow and
- * performs checks before the flow runs. If this throws, the flow will not
- * be executed.
- */
-interface AuthPolicy<I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny> {
-    (ctx: AuthPolicyContext<I, O, S>): void | Promise<void>;
-}
-/**
- * For express-based flows, req.auth should contain the value to bepassed into
- * the flow context.
- */
-interface RequestWithAuth extends express.Request {
-    auth?: Record<string, any>;
-}
 /**
  * Exposes provided flow or an action as express handler.
  */
-declare function expressHandler<I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny>(action: Action<I, O, S>, opts?: {
-    authPolicy?: AuthPolicy<I, O, S>;
+declare function expressHandler<C extends ActionContext = ActionContext, I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny>(action: Action<I, O, S>, opts?: {
+    contextProvider?: ContextProvider<C, I>;
 }): express.RequestHandler;
 /**
  * A wrapper object containing a flow with its associated auth policy.
  */
-type FlowWithAuthPolicy<I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny> = {
+type FlowWithContextProvider<C extends ActionContext = ActionContext, I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny> = {
     flow: Flow<I, O, S>;
-    authProvider: RequestHandler;
-    authPolicy: AuthPolicy;
+    context: ContextProvider<C, I>;
 };
 /**
  * Adds an auth policy to the flow.
  */
-declare function withAuth<I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny>(flow: Flow<I, O, S>, authProvider: RequestHandler, authPolicy: AuthPolicy): FlowWithAuthPolicy<I, O, S>;
+declare function withContextProvider<C extends ActionContext = ActionContext, I extends z.ZodTypeAny = z.ZodTypeAny, O extends z.ZodTypeAny = z.ZodTypeAny, S extends z.ZodTypeAny = z.ZodTypeAny>(flow: Flow<I, O, S>, context: ContextProvider<C, I>): FlowWithContextProvider<C, I, O, S>;
 /**
  * Options to configure the flow server.
  */
 interface FlowServerOptions {
     /** List of flows to expose via the flow server. */
-    flows: (Flow<any, any, any> | FlowWithAuthPolicy<any, any, any>)[];
+    flows: (Flow<any, any, any> | FlowWithContextProvider<any, any, any>)[];
     /** Port to run the server on. Defaults to env.PORT or 3400. */
     port?: number;
     /** CORS options for the server. */
@@ -111,4 +87,4 @@ declare class FlowServer {
     static stopAll(): Promise<void[]>;
 }
-export { type AuthPolicy, type AuthPolicyContext, FlowServer, type FlowServerOptions, type FlowWithAuthPolicy, type RequestWithAuth, expressHandler, startFlowServer, withAuth };
+export { FlowServer, type FlowServerOptions, type FlowWithContextProvider, expressHandler, startFlowServer, withContextProvider };

package/lib/index.js CHANGED Viewed

@@ -31,37 +31,38 @@ __export(src_exports, {
   FlowServer: () => FlowServer,
   expressHandler: () => expressHandler,
   startFlowServer: () => startFlowServer,
-  withAuth: () => withAuth
+  withContextProvider: () => withContextProvider
 });
 module.exports = __toCommonJS(src_exports);
-var bodyParser = __toESM(require("body-parser"));
+var import_body_parser = __toESM(require("body-parser"));
 var import_cors = __toESM(require("cors"));
 var import_express = __toESM(require("express"));
 var import_genkit = require("genkit");
+var import_context = require("genkit/context");
 var import_logging = require("genkit/logging");
-var import_utils = require("./utils");
 const streamDelimiter = "\n\n";
 function expressHandler(action, opts) {
   return async (request, response) => {
     const { stream } = request.query;
     let input = request.body.data;
-    const auth = request.auth;
+    let context;
     try {
-      await opts?.authPolicy?.({
-        action,
-        auth,
-        input,
-        request
-      });
+      context = await opts?.contextProvider?.({
+        method: request.method,
+        headers: Object.fromEntries(
+          Object.entries(request.headers).map(([key, value]) => [
+            key.toLowerCase(),
+            Array.isArray(value) ? value.join(" ") : String(value)
+          ])
+        ),
+        input
+      }) || {};
     } catch (e) {
-      import_logging.logger.debug(e);
-      const respBody = {
-        error: {
-          status: "PERMISSION_DENIED",
-          message: e.message || "Permission denied to resource"
-        }
-      };
-      response.status(403).send(respBody).end();
+      import_logging.logger.error(
+        `Auth policy failed with error: ${e.message}
+${e.stack}`
+      );
+      response.status((0, import_context.getHttpStatus)(e)).json((0, import_context.getCallableJSON)(e)).end();
       return;
     }
     if (request.get("Accept") === "text/event-stream" || stream === "true") {
@@ -80,7 +81,7 @@ function expressHandler(action, opts) {
           onChunk,
           () => action.run(input, {
             onChunk,
-            context: { auth }
+            context
           })
         );
         response.write(
@@ -88,43 +89,37 @@ function expressHandler(action, opts) {
         );
         response.end();
       } catch (e) {
-        import_logging.logger.error(e);
+        import_logging.logger.error(
+          `Streaming request failed with error: ${e.message}
+${e.stack}`
+        );
         response.write(
-          "data: " + JSON.stringify({
-            error: {
-              status: "INTERNAL",
-              message: (0, import_utils.getErrorMessage)(e),
-              details: (0, import_utils.getErrorStack)(e)
-            }
-          }) + streamDelimiter
+          `error: ${JSON.stringify({ error: (0, import_context.getCallableJSON)(e) })}${streamDelimiter}`
         );
         response.end();
       }
     } else {
       try {
-        const result = await action.run(input, { context: { auth } });
+        const result = await action.run(input, { context });
         response.setHeader("x-genkit-trace-id", result.telemetry.traceId);
         response.setHeader("x-genkit-span-id", result.telemetry.spanId);
-        response.status(200).send({
+        response.status(200).json({
           result: result.result
         }).end();
       } catch (e) {
-        response.status(500).send({
-          error: {
-            status: "INTERNAL",
-            message: (0, import_utils.getErrorMessage)(e),
-            details: (0, import_utils.getErrorStack)(e)
-          }
-        }).end();
+        import_logging.logger.error(
+          `Non-streaming request failed with error: ${e.message}
+${e.stack}`
+        );
+        response.status((0, import_context.getHttpStatus)(e)).json((0, import_context.getCallableJSON)(e)).end();
       }
     }
   };
 }
-function withAuth(flow, authProvider, authPolicy) {
+function withContextProvider(flow, context) {
   return {
     flow,
-    authProvider,
-    authPolicy
+    context
   };
 }
 function startFlowServer(options) {
@@ -151,27 +146,22 @@ class FlowServer {
    */
   async start() {
     const server = (0, import_express.default)();
-    server.use(bodyParser.json(this.options.jsonParserOptions));
+    server.use(import_body_parser.default.json(this.options.jsonParserOptions));
     server.use((0, import_cors.default)(this.options.cors));
     import_logging.logger.debug("Running flow server with flow paths:");
     const pathPrefix = this.options.pathPrefix ?? "";
     this.options.flows?.forEach((flow) => {
-      if (flow.authPolicy) {
-        const flowWithPolicy = flow;
-        const flowPath = `/${pathPrefix}${flowWithPolicy.flow.__action.name}`;
+      if ("context" in flow) {
+        const flowPath = `/${pathPrefix}${flow.flow.__action.name}`;
         import_logging.logger.debug(` - ${flowPath}`);
         server.post(
           flowPath,
-          flowWithPolicy.authProvider,
-          expressHandler(flowWithPolicy.flow, {
-            authPolicy: flowWithPolicy.authPolicy
-          })
+          expressHandler(flow.flow, { contextProvider: flow.context })
         );
       } else {
-        const resolvedFlow = flow;
-        const flowPath = `/${pathPrefix}${resolvedFlow.__action.name}`;
+        const flowPath = `/${pathPrefix}${flow.__action.name}`;
         import_logging.logger.debug(` - ${flowPath}`);
-        server.post(flowPath, expressHandler(resolvedFlow));
+        server.post(flowPath, expressHandler(flow));
       }
     });
     this.port = this.options?.port || (process.env.PORT ? parseInt(process.env.PORT) : 0) || 3400;
@@ -222,6 +212,6 @@ class FlowServer {
   FlowServer,
   expressHandler,
   startFlowServer,
-  withAuth
+  withContextProvider
 });
 //# sourceMappingURL=index.js.map

package/lib/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["/*\n Copyright 2024 Google LLC\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n /\n\nimport as bodyParser from 'body-parser';\nimport cors, { CorsOptions } from 'cors';\nimport express, { RequestHandler } from 'express';\nimport { Action, Flow, runWithStreamingCallback, z } from 'genkit';\nimport { logger } from 'genkit/logging';\nimport { Server } from 'http';\nimport { getErrorMessage, getErrorStack } from './utils';\n\nconst streamDelimiter = '\\n\\n';\n\n/*\n Auth policy context is an object passed to the auth policy providing details necessary for auth.\n /\nexport interface AuthPolicyContext<\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n> {\n action?: Action<I, O, S>;\n input: z.infer<I>;\n auth?: Record<string, any>;\n request: RequestWithAuth;\n}\n\n/\n Flow Auth policy. Consumes the authorization context of the flow and\n * performs checks before the flow runs. If this throws, the flow will not\n * be executed.\n /\nexport interface AuthPolicy<\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n> {\n (ctx: AuthPolicyContext<I, O, S>): void \| Promise<void>;\n}\n\n/\n For express-based flows, req.auth should contain the value to bepassed into\n * the flow context.\n /\nexport interface RequestWithAuth extends express.Request {\n auth?: Record<string, any>;\n}\n\n/\n Exposes provided flow or an action as express handler.\n /\nexport function expressHandler<\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n>(\n action: Action<I, O, S>,\n opts?: {\n authPolicy?: AuthPolicy<I, O, S>;\n }\n): express.RequestHandler {\n return async (\n request: RequestWithAuth,\n response: express.Response\n ): Promise<void> => {\n const { stream } = request.query;\n let input = request.body.data;\n const auth = request.auth;\n\n try {\n await opts?.authPolicy?.({\n action,\n auth,\n input,\n request,\n });\n } catch (e: any) {\n logger.debug(e);\n const respBody = {\n error: {\n status: 'PERMISSION_DENIED',\n message: e.message \|\| 'Permission denied to resource',\n },\n };\n response.status(403).send(respBody).end();\n return;\n }\n\n if (request.get('Accept') === 'text/event-stream' \|\| stream === 'true') {\n response.writeHead(200, {\n 'Content-Type': 'text/plain',\n 'Transfer-Encoding': 'chunked',\n });\n try {\n const onChunk = (chunk: z.infer<S>) => {\n response.write(\n 'data: ' + JSON.stringify({ message: chunk }) + streamDelimiter\n );\n };\n const result = await runWithStreamingCallback(\n action.__registry,\n onChunk,\n () =>\n action.run(input, {\n onChunk,\n context: { auth },\n })\n );\n response.write(\n 'data: ' + JSON.stringify({ result: result.result }) + streamDelimiter\n );\n response.end();\n } catch (e) {\n logger.error(e);\n response.write(\n 'data: ' +\n JSON.stringify({\n error: {\n status: 'INTERNAL',\n message: getErrorMessage(e),\n details: getErrorStack(e),\n },\n }) +\n streamDelimiter\n );\n response.end();\n }\n } else {\n try {\n const result = await action.run(input, { context: { auth } });\n response.setHeader('x-genkit-trace-id', result.telemetry.traceId);\n response.setHeader('x-genkit-span-id', result.telemetry.spanId);\n // Responses for non-streaming flows are passed back with the flow result stored in a field called \"result.\"\n response\n .status(200)\n .send({\n result: result.result,\n })\n .end();\n } catch (e) {\n // Errors for non-streaming flows are passed back as standard API errors.\n response\n .status(500)\n .send({\n error: {\n status: 'INTERNAL',\n message: getErrorMessage(e),\n details: getErrorStack(e),\n },\n })\n .end();\n }\n }\n };\n}\n\n/\n A wrapper object containing a flow with its associated auth policy.\n /\nexport type FlowWithAuthPolicy<\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n> = {\n flow: Flow<I, O, S>;\n authProvider: RequestHandler;\n authPolicy: AuthPolicy;\n};\n\n/\n Adds an auth policy to the flow.\n /\nexport function withAuth<\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n>(\n flow: Flow<I, O, S>,\n authProvider: RequestHandler,\n authPolicy: AuthPolicy\n): FlowWithAuthPolicy<I, O, S> {\n return {\n flow,\n authProvider,\n authPolicy,\n };\n}\n\n/\n Options to configure the flow server.\n /\nexport interface FlowServerOptions {\n /* List of flows to expose via the flow server. /\n flows: (Flow<any, any, any> \| FlowWithAuthPolicy<any, any, any>)[];\n /* Port to run the server on. Defaults to env.PORT or 3400. /\n port?: number;\n /* CORS options for the server. /\n cors?: CorsOptions;\n /* HTTP method path prefix for the exposed flows. /\n pathPrefix?: string;\n /* JSON body parser options. /\n jsonParserOptions?: bodyParser.OptionsJson;\n}\n\n/\n Starts an express server with the provided flows and options.\n /\nexport function startFlowServer(options: FlowServerOptions): FlowServer {\n const server = new FlowServer(options);\n server.start();\n return server;\n}\n\n/\n Flow server exposes registered flows as HTTP endpoints.\n \n This is for use in production environments.\n \n @hidden\n /\nexport class FlowServer {\n /* List of all running servers needed to be cleaned up on process exit. /\n private static RUNNING_SERVERS: FlowServer[] = [];\n\n /* Options for the flow server configured by the developer. /\n private options: FlowServerOptions;\n /* Port the server is actually running on. This may differ from `options.port` if the original was occupied. Null is server is not running. /\n private port: number \| null = null;\n /* Express server instance. Null if server is not running. /\n private server: Server \| null = null;\n\n constructor(options: FlowServerOptions) {\n this.options = {\n ...options,\n };\n }\n\n /\n Starts the server and adds it to the list of running servers to clean up on exit.\n /\n async start() {\n const server = express();\n\n server.use(bodyParser.json(this.options.jsonParserOptions));\n server.use(cors(this.options.cors));\n\n logger.debug('Running flow server with flow paths:');\n const pathPrefix = this.options.pathPrefix ?? '';\n this.options.flows?.forEach((flow) => {\n if ((flow as FlowWithAuthPolicy).authPolicy) {\n const flowWithPolicy = flow as FlowWithAuthPolicy;\n const flowPath = `/${pathPrefix}${flowWithPolicy.flow.__action.name}`;\n logger.debug(` - ${flowPath}`);\n server.post(\n flowPath,\n flowWithPolicy.authProvider,\n expressHandler(flowWithPolicy.flow, {\n authPolicy: flowWithPolicy.authPolicy,\n })\n );\n } else {\n const resolvedFlow = flow as Flow;\n const flowPath = `/${pathPrefix}${resolvedFlow.__action.name}`;\n logger.debug(` - ${flowPath}`);\n server.post(flowPath, expressHandler(resolvedFlow));\n }\n });\n this.port =\n this.options?.port \|\|\n (process.env.PORT ? parseInt(process.env.PORT) : 0) \|\|\n 3400;\n this.server = server.listen(this.port, () => {\n logger.debug(`Flow server running on http://localhost:${this.port}`);\n FlowServer.RUNNING_SERVERS.push(this);\n });\n }\n\n /\n Stops the server and removes it from the list of running servers to clean up on exit.\n /\n async stop(): Promise<void> {\n if (!this.server) {\n return;\n }\n return new Promise<void>((resolve, reject) => {\n this.server!.close((err) => {\n if (err) {\n logger.error(\n `Error shutting down flow server on port ${this.port}: ${err}`\n );\n reject(err);\n }\n const index = FlowServer.RUNNING_SERVERS.indexOf(this);\n if (index > -1) {\n FlowServer.RUNNING_SERVERS.splice(index, 1);\n }\n logger.debug(\n `Flow server on port ${this.port} has successfully shut down.`\n );\n this.port = null;\n this.server = null;\n resolve();\n });\n });\n }\n\n /\n Stops all running servers.\n */\n static async stopAll() {\n return Promise.all(\n FlowServer.RUNNING_SERVERS.map((server) => server.stop())\n );\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgBA,iBAA4B;AAC5B,kBAAkC;AAClC,qBAAwC;AACxC,oBAA0D;AAC1D,qBAAuB;AAEvB,mBAA+C;AAE/C,MAAM,kBAAkB;AAwCjB,SAAS,eAKd,QACA,MAGwB;AACxB,SAAO,OACL,SACA,aACkB;AAClB,UAAM,EAAE,OAAO,IAAI,QAAQ;AAC3B,QAAI,QAAQ,QAAQ,KAAK;AACzB,UAAM,OAAO,QAAQ;AAErB,QAAI;AACF,YAAM,MAAM,aAAa;AAAA,QACvB;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH,SAAS,GAAQ;AACf,4BAAO,MAAM,CAAC;AACd,YAAM,WAAW;AAAA,QACf,OAAO;AAAA,UACL,QAAQ;AAAA,UACR,SAAS,EAAE,WAAW;AAAA,QACxB;AAAA,MACF;AACA,eAAS,OAAO,GAAG,EAAE,KAAK,QAAQ,EAAE,IAAI;AACxC;AAAA,IACF;AAEA,QAAI,QAAQ,IAAI,QAAQ,MAAM,uBAAuB,WAAW,QAAQ;AACtE,eAAS,UAAU,KAAK;AAAA,QACtB,gBAAgB;AAAA,QAChB,qBAAqB;AAAA,MACvB,CAAC;AACD,UAAI;AACF,cAAM,UAAU,CAAC,UAAsB;AACrC,mBAAS;AAAA,YACP,WAAW,KAAK,UAAU,EAAE,SAAS,MAAM,CAAC,IAAI;AAAA,UAClD;AAAA,QACF;AACA,cAAM,SAAS,UAAM;AAAA,UACnB,OAAO;AAAA,UACP;AAAA,UACA,MACE,OAAO,IAAI,OAAO;AAAA,YAChB;AAAA,YACA,SAAS,EAAE,KAAK;AAAA,UAClB,CAAC;AAAA,QACL;AACA,iBAAS;AAAA,UACP,WAAW,KAAK,UAAU,EAAE,QAAQ,OAAO,OAAO,CAAC,IAAI;AAAA,QACzD;AACA,iBAAS,IAAI;AAAA,MACf,SAAS,GAAG;AACV,8BAAO,MAAM,CAAC;AACd,iBAAS;AAAA,UACP,WACE,KAAK,UAAU;AAAA,YACb,OAAO;AAAA,cACL,QAAQ;AAAA,cACR,aAAS,8BAAgB,CAAC;AAAA,cAC1B,aAAS,4BAAc,CAAC;AAAA,YAC1B;AAAA,UACF,CAAC,IACD;AAAA,QACJ;AACA,iBAAS,IAAI;AAAA,MACf;AAAA,IACF,OAAO;AACL,UAAI;AACF,cAAM,SAAS,MAAM,OAAO,IAAI,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;AAC5D,iBAAS,UAAU,qBAAqB,OAAO,UAAU,OAAO;AAChE,iBAAS,UAAU,oBAAoB,OAAO,UAAU,MAAM;AAE9D,iBACG,OAAO,GAAG,EACV,KAAK;AAAA,UACJ,QAAQ,OAAO;AAAA,QACjB,CAAC,EACA,IAAI;AAAA,MACT,SAAS,GAAG;AAEV,iBACG,OAAO,GAAG,EACV,KAAK;AAAA,UACJ,OAAO;AAAA,YACL,QAAQ;AAAA,YACR,aAAS,8BAAgB,CAAC;AAAA,YAC1B,aAAS,4BAAc,CAAC;AAAA,UAC1B;AAAA,QACF,CAAC,EACA,IAAI;AAAA,MACT;AAAA,IACF;AAAA,EACF;AACF;AAkBO,SAAS,SAKd,MACA,cACA,YAC6B;AAC7B,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAqBO,SAAS,gBAAgB,SAAwC;AACtE,QAAM,SAAS,IAAI,WAAW,OAAO;AACrC,SAAO,MAAM;AACb,SAAO;AACT;AASO,MAAM,WAAW;AAAA;AAAA,EAEtB,OAAe,kBAAgC,CAAC;AAAA;AAAA,EAGxC;AAAA;AAAA,EAEA,OAAsB;AAAA;AAAA,EAEtB,SAAwB;AAAA,EAEhC,YAAY,SAA4B;AACtC,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,IACL;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,QAAQ;AACZ,UAAM,aAAS,eAAAA,SAAQ;AAEvB,WAAO,IAAI,WAAW,KAAK,KAAK,QAAQ,iBAAiB,CAAC;AAC1D,WAAO,QAAI,YAAAC,SAAK,KAAK,QAAQ,IAAI,CAAC;AAElC,0BAAO,MAAM,sCAAsC;AACnD,UAAM,aAAa,KAAK,QAAQ,cAAc;AAC9C,SAAK,QAAQ,OAAO,QAAQ,CAAC,SAAS;AACpC,UAAK,KAA4B,YAAY;AAC3C,cAAM,iBAAiB;AACvB,cAAM,WAAW,IAAI,UAAU,GAAG,eAAe,KAAK,SAAS,IAAI;AACnE,8BAAO,MAAM,MAAM,QAAQ,EAAE;AAC7B,eAAO;AAAA,UACL;AAAA,UACA,eAAe;AAAA,UACf,eAAe,eAAe,MAAM;AAAA,YAClC,YAAY,eAAe;AAAA,UAC7B,CAAC;AAAA,QACH;AAAA,MACF,OAAO;AACL,cAAM,eAAe;AACrB,cAAM,WAAW,IAAI,UAAU,GAAG,aAAa,SAAS,IAAI;AAC5D,8BAAO,MAAM,MAAM,QAAQ,EAAE;AAC7B,eAAO,KAAK,UAAU,eAAe,YAAY,CAAC;AAAA,MACpD;AAAA,IACF,CAAC;AACD,SAAK,OACH,KAAK,SAAS,SACb,QAAQ,IAAI,OAAO,SAAS,QAAQ,IAAI,IAAI,IAAI,MACjD;AACF,SAAK,SAAS,OAAO,OAAO,KAAK,MAAM,MAAM;AAC3C,4BAAO,MAAM,2CAA2C,KAAK,IAAI,EAAE;AACnE,iBAAW,gBAAgB,KAAK,IAAI;AAAA,IACtC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAsB;AAC1B,QAAI,CAAC,KAAK,QAAQ;AAChB;AAAA,IACF;AACA,WAAO,IAAI,QAAc,CAAC,SAAS,WAAW;AAC5C,WAAK,OAAQ,MAAM,CAAC,QAAQ;AAC1B,YAAI,KAAK;AACP,gCAAO;AAAA,YACL,2CAA2C,KAAK,IAAI,KAAK,GAAG;AAAA,UAC9D;AACA,iBAAO,GAAG;AAAA,QACZ;AACA,cAAM,QAAQ,WAAW,gBAAgB,QAAQ,IAAI;AACrD,YAAI,QAAQ,IAAI;AACd,qBAAW,gBAAgB,OAAO,OAAO,CAAC;AAAA,QAC5C;AACA,8BAAO;AAAA,UACL,uBAAuB,KAAK,IAAI;AAAA,QAClC;AACA,aAAK,OAAO;AACZ,aAAK,SAAS;AACd,gBAAQ;AAAA,MACV,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,UAAU;AACrB,WAAO,QAAQ;AAAA,MACb,WAAW,gBAAgB,IAAI,CAAC,WAAW,OAAO,KAAK,CAAC;AAAA,IAC1D;AAAA,EACF;AACF;","names":["express","cors"]}
1	+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["/*\n Copyright 2024 Google LLC\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n /\n\nimport bodyParser from 'body-parser';\nimport cors, { CorsOptions } from 'cors';\nimport express from 'express';\nimport {\n Action,\n ActionContext,\n Flow,\n runWithStreamingCallback,\n z,\n} from 'genkit';\nimport {\n ContextProvider,\n RequestData,\n getCallableJSON,\n getHttpStatus,\n} from 'genkit/context';\nimport { logger } from 'genkit/logging';\nimport { Server } from 'http';\n\nconst streamDelimiter = '\\n\\n';\n\n/\n Exposes provided flow or an action as express handler.\n /\nexport function expressHandler<\n C extends ActionContext = ActionContext,\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n>(\n action: Action<I, O, S>,\n opts?: {\n contextProvider?: ContextProvider<C, I>;\n }\n): express.RequestHandler {\n return async (\n request: express.Request,\n response: express.Response\n ): Promise<void> => {\n const { stream } = request.query;\n let input = request.body.data as z.infer<I>;\n let context: Record<string, any>;\n\n try {\n context =\n (await opts?.contextProvider?.({\n method: request.method as RequestData['method'],\n headers: Object.fromEntries(\n Object.entries(request.headers).map(([key, value]) => [\n key.toLowerCase(),\n Array.isArray(value) ? value.join(' ') : String(value),\n ])\n ),\n input,\n })) \|\| {};\n } catch (e: any) {\n logger.error(\n `Auth policy failed with error: ${(e as Error).message}\\n${(e as Error).stack}`\n );\n response.status(getHttpStatus(e)).json(getCallableJSON(e)).end();\n return;\n }\n\n if (request.get('Accept') === 'text/event-stream' \|\| stream === 'true') {\n response.writeHead(200, {\n 'Content-Type': 'text/plain',\n 'Transfer-Encoding': 'chunked',\n });\n try {\n const onChunk = (chunk: z.infer<S>) => {\n response.write(\n 'data: ' + JSON.stringify({ message: chunk }) + streamDelimiter\n );\n };\n const result = await runWithStreamingCallback(\n action.__registry,\n onChunk,\n () =>\n action.run(input, {\n onChunk,\n context,\n })\n );\n response.write(\n 'data: ' + JSON.stringify({ result: result.result }) + streamDelimiter\n );\n response.end();\n } catch (e) {\n logger.error(\n `Streaming request failed with error: ${(e as Error).message}\\n${(e as Error).stack}`\n );\n response.write(\n `error: ${JSON.stringify({ error: getCallableJSON(e) })}${streamDelimiter}`\n );\n response.end();\n }\n } else {\n try {\n const result = await action.run(input, { context });\n response.setHeader('x-genkit-trace-id', result.telemetry.traceId);\n response.setHeader('x-genkit-span-id', result.telemetry.spanId);\n // Responses for non-streaming flows are passed back with the flow result stored in a field called \"result.\"\n response\n .status(200)\n .json({\n result: result.result,\n })\n .end();\n } catch (e) {\n // Errors for non-streaming flows are passed back as standard API errors.\n logger.error(\n `Non-streaming request failed with error: ${(e as Error).message}\\n${(e as Error).stack}`\n );\n response.status(getHttpStatus(e)).json(getCallableJSON(e)).end();\n }\n }\n };\n}\n\n/\n A wrapper object containing a flow with its associated auth policy.\n /\nexport type FlowWithContextProvider<\n C extends ActionContext = ActionContext,\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n> = {\n flow: Flow<I, O, S>;\n context: ContextProvider<C, I>;\n};\n\n/\n Adds an auth policy to the flow.\n /\nexport function withContextProvider<\n C extends ActionContext = ActionContext,\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n>(\n flow: Flow<I, O, S>,\n context: ContextProvider<C, I>\n): FlowWithContextProvider<C, I, O, S> {\n return {\n flow,\n context,\n };\n}\n\n/\n Options to configure the flow server.\n /\nexport interface FlowServerOptions {\n /* List of flows to expose via the flow server. /\n flows: (Flow<any, any, any> \| FlowWithContextProvider<any, any, any>)[];\n /* Port to run the server on. Defaults to env.PORT or 3400. /\n port?: number;\n /* CORS options for the server. /\n cors?: CorsOptions;\n /* HTTP method path prefix for the exposed flows. /\n pathPrefix?: string;\n /* JSON body parser options. /\n jsonParserOptions?: bodyParser.OptionsJson;\n}\n\n/\n Starts an express server with the provided flows and options.\n /\nexport function startFlowServer(options: FlowServerOptions): FlowServer {\n const server = new FlowServer(options);\n server.start();\n return server;\n}\n\n/\n Flow server exposes registered flows as HTTP endpoints.\n \n This is for use in production environments.\n \n @hidden\n /\nexport class FlowServer {\n /* List of all running servers needed to be cleaned up on process exit. /\n private static RUNNING_SERVERS: FlowServer[] = [];\n\n /* Options for the flow server configured by the developer. /\n private options: FlowServerOptions;\n /* Port the server is actually running on. This may differ from `options.port` if the original was occupied. Null is server is not running. /\n private port: number \| null = null;\n /* Express server instance. Null if server is not running. /\n private server: Server \| null = null;\n\n constructor(options: FlowServerOptions) {\n this.options = {\n ...options,\n };\n }\n\n /\n Starts the server and adds it to the list of running servers to clean up on exit.\n /\n async start() {\n const server = express();\n\n server.use(bodyParser.json(this.options.jsonParserOptions));\n server.use(cors(this.options.cors));\n\n logger.debug('Running flow server with flow paths:');\n const pathPrefix = this.options.pathPrefix ?? '';\n this.options.flows?.forEach((flow) => {\n if ('context' in flow) {\n const flowPath = `/${pathPrefix}${flow.flow.__action.name}`;\n logger.debug(` - ${flowPath}`);\n server.post(\n flowPath,\n expressHandler(flow.flow, { contextProvider: flow.context })\n );\n } else {\n const flowPath = `/${pathPrefix}${flow.__action.name}`;\n logger.debug(` - ${flowPath}`);\n server.post(flowPath, expressHandler(flow));\n }\n });\n this.port =\n this.options?.port \|\|\n (process.env.PORT ? parseInt(process.env.PORT) : 0) \|\|\n 3400;\n this.server = server.listen(this.port, () => {\n logger.debug(`Flow server running on http://localhost:${this.port}`);\n FlowServer.RUNNING_SERVERS.push(this);\n });\n }\n\n /\n Stops the server and removes it from the list of running servers to clean up on exit.\n /\n async stop(): Promise<void> {\n if (!this.server) {\n return;\n }\n return new Promise<void>((resolve, reject) => {\n this.server!.close((err) => {\n if (err) {\n logger.error(\n `Error shutting down flow server on port ${this.port}: ${err}`\n );\n reject(err);\n }\n const index = FlowServer.RUNNING_SERVERS.indexOf(this);\n if (index > -1) {\n FlowServer.RUNNING_SERVERS.splice(index, 1);\n }\n logger.debug(\n `Flow server on port ${this.port} has successfully shut down.`\n );\n this.port = null;\n this.server = null;\n resolve();\n });\n });\n }\n\n /\n Stops all running servers.\n */\n static async stopAll() {\n return Promise.all(\n FlowServer.RUNNING_SERVERS.map((server) => server.stop())\n );\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgBA,yBAAuB;AACvB,kBAAkC;AAClC,qBAAoB;AACpB,oBAMO;AACP,qBAKO;AACP,qBAAuB;AAGvB,MAAM,kBAAkB;AAKjB,SAAS,eAMd,QACA,MAGwB;AACxB,SAAO,OACL,SACA,aACkB;AAClB,UAAM,EAAE,OAAO,IAAI,QAAQ;AAC3B,QAAI,QAAQ,QAAQ,KAAK;AACzB,QAAI;AAEJ,QAAI;AACF,gBACG,MAAM,MAAM,kBAAkB;AAAA,QAC7B,QAAQ,QAAQ;AAAA,QAChB,SAAS,OAAO;AAAA,UACd,OAAO,QAAQ,QAAQ,OAAO,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM;AAAA,YACpD,IAAI,YAAY;AAAA,YAChB,MAAM,QAAQ,KAAK,IAAI,MAAM,KAAK,GAAG,IAAI,OAAO,KAAK;AAAA,UACvD,CAAC;AAAA,QACH;AAAA,QACA;AAAA,MACF,CAAC,KAAM,CAAC;AAAA,IACZ,SAAS,GAAQ;AACf,4BAAO;AAAA,QACL,kCAAmC,EAAY,OAAO;AAAA,EAAM,EAAY,KAAK;AAAA,MAC/E;AACA,eAAS,WAAO,8BAAc,CAAC,CAAC,EAAE,SAAK,gCAAgB,CAAC,CAAC,EAAE,IAAI;AAC/D;AAAA,IACF;AAEA,QAAI,QAAQ,IAAI,QAAQ,MAAM,uBAAuB,WAAW,QAAQ;AACtE,eAAS,UAAU,KAAK;AAAA,QACtB,gBAAgB;AAAA,QAChB,qBAAqB;AAAA,MACvB,CAAC;AACD,UAAI;AACF,cAAM,UAAU,CAAC,UAAsB;AACrC,mBAAS;AAAA,YACP,WAAW,KAAK,UAAU,EAAE,SAAS,MAAM,CAAC,IAAI;AAAA,UAClD;AAAA,QACF;AACA,cAAM,SAAS,UAAM;AAAA,UACnB,OAAO;AAAA,UACP;AAAA,UACA,MACE,OAAO,IAAI,OAAO;AAAA,YAChB;AAAA,YACA;AAAA,UACF,CAAC;AAAA,QACL;AACA,iBAAS;AAAA,UACP,WAAW,KAAK,UAAU,EAAE,QAAQ,OAAO,OAAO,CAAC,IAAI;AAAA,QACzD;AACA,iBAAS,IAAI;AAAA,MACf,SAAS,GAAG;AACV,8BAAO;AAAA,UACL,wCAAyC,EAAY,OAAO;AAAA,EAAM,EAAY,KAAK;AAAA,QACrF;AACA,iBAAS;AAAA,UACP,UAAU,KAAK,UAAU,EAAE,WAAO,gCAAgB,CAAC,EAAE,CAAC,CAAC,GAAG,eAAe;AAAA,QAC3E;AACA,iBAAS,IAAI;AAAA,MACf;AAAA,IACF,OAAO;AACL,UAAI;AACF,cAAM,SAAS,MAAM,OAAO,IAAI,OAAO,EAAE,QAAQ,CAAC;AAClD,iBAAS,UAAU,qBAAqB,OAAO,UAAU,OAAO;AAChE,iBAAS,UAAU,oBAAoB,OAAO,UAAU,MAAM;AAE9D,iBACG,OAAO,GAAG,EACV,KAAK;AAAA,UACJ,QAAQ,OAAO;AAAA,QACjB,CAAC,EACA,IAAI;AAAA,MACT,SAAS,GAAG;AAEV,8BAAO;AAAA,UACL,4CAA6C,EAAY,OAAO;AAAA,EAAM,EAAY,KAAK;AAAA,QACzF;AACA,iBAAS,WAAO,8BAAc,CAAC,CAAC,EAAE,SAAK,gCAAgB,CAAC,CAAC,EAAE,IAAI;AAAA,MACjE;AAAA,IACF;AAAA,EACF;AACF;AAkBO,SAAS,oBAMd,MACA,SACqC;AACrC,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AAqBO,SAAS,gBAAgB,SAAwC;AACtE,QAAM,SAAS,IAAI,WAAW,OAAO;AACrC,SAAO,MAAM;AACb,SAAO;AACT;AASO,MAAM,WAAW;AAAA;AAAA,EAEtB,OAAe,kBAAgC,CAAC;AAAA;AAAA,EAGxC;AAAA;AAAA,EAEA,OAAsB;AAAA;AAAA,EAEtB,SAAwB;AAAA,EAEhC,YAAY,SAA4B;AACtC,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,IACL;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,QAAQ;AACZ,UAAM,aAAS,eAAAA,SAAQ;AAEvB,WAAO,IAAI,mBAAAC,QAAW,KAAK,KAAK,QAAQ,iBAAiB,CAAC;AAC1D,WAAO,QAAI,YAAAC,SAAK,KAAK,QAAQ,IAAI,CAAC;AAElC,0BAAO,MAAM,sCAAsC;AACnD,UAAM,aAAa,KAAK,QAAQ,cAAc;AAC9C,SAAK,QAAQ,OAAO,QAAQ,CAAC,SAAS;AACpC,UAAI,aAAa,MAAM;AACrB,cAAM,WAAW,IAAI,UAAU,GAAG,KAAK,KAAK,SAAS,IAAI;AACzD,8BAAO,MAAM,MAAM,QAAQ,EAAE;AAC7B,eAAO;AAAA,UACL;AAAA,UACA,eAAe,KAAK,MAAM,EAAE,iBAAiB,KAAK,QAAQ,CAAC;AAAA,QAC7D;AAAA,MACF,OAAO;AACL,cAAM,WAAW,IAAI,UAAU,GAAG,KAAK,SAAS,IAAI;AACpD,8BAAO,MAAM,MAAM,QAAQ,EAAE;AAC7B,eAAO,KAAK,UAAU,eAAe,IAAI,CAAC;AAAA,MAC5C;AAAA,IACF,CAAC;AACD,SAAK,OACH,KAAK,SAAS,SACb,QAAQ,IAAI,OAAO,SAAS,QAAQ,IAAI,IAAI,IAAI,MACjD;AACF,SAAK,SAAS,OAAO,OAAO,KAAK,MAAM,MAAM;AAC3C,4BAAO,MAAM,2CAA2C,KAAK,IAAI,EAAE;AACnE,iBAAW,gBAAgB,KAAK,IAAI;AAAA,IACtC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAsB;AAC1B,QAAI,CAAC,KAAK,QAAQ;AAChB;AAAA,IACF;AACA,WAAO,IAAI,QAAc,CAAC,SAAS,WAAW;AAC5C,WAAK,OAAQ,MAAM,CAAC,QAAQ;AAC1B,YAAI,KAAK;AACP,gCAAO;AAAA,YACL,2CAA2C,KAAK,IAAI,KAAK,GAAG;AAAA,UAC9D;AACA,iBAAO,GAAG;AAAA,QACZ;AACA,cAAM,QAAQ,WAAW,gBAAgB,QAAQ,IAAI;AACrD,YAAI,QAAQ,IAAI;AACd,qBAAW,gBAAgB,OAAO,OAAO,CAAC;AAAA,QAC5C;AACA,8BAAO;AAAA,UACL,uBAAuB,KAAK,IAAI;AAAA,QAClC;AACA,aAAK,OAAO;AACZ,aAAK,SAAS;AACd,gBAAQ;AAAA,MACV,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,UAAU;AACrB,WAAO,QAAQ;AAAA,MACb,WAAW,gBAAgB,IAAI,CAAC,WAAW,OAAO,KAAK,CAAC;AAAA,IAC1D;AAAA,EACF;AACF;","names":["express","bodyParser","cors"]}

package/lib/index.mjs CHANGED Viewed

@@ -1,31 +1,37 @@
-import * as bodyParser from "body-parser";
+import bodyParser from "body-parser";
 import cors from "cors";
 import express from "express";
-import { runWithStreamingCallback } from "genkit";
+import {
+  runWithStreamingCallback
+} from "genkit";
+import {
+  getCallableJSON,
+  getHttpStatus
+} from "genkit/context";
 import { logger } from "genkit/logging";
-import { getErrorMessage, getErrorStack } from "./utils";
 const streamDelimiter = "\n\n";
 function expressHandler(action, opts) {
   return async (request, response) => {
     const { stream } = request.query;
     let input = request.body.data;
-    const auth = request.auth;
+    let context;
     try {
-      await opts?.authPolicy?.({
-        action,
-        auth,
-        input,
-        request
-      });
+      context = await opts?.contextProvider?.({
+        method: request.method,
+        headers: Object.fromEntries(
+          Object.entries(request.headers).map(([key, value]) => [
+            key.toLowerCase(),
+            Array.isArray(value) ? value.join(" ") : String(value)
+          ])
+        ),
+        input
+      }) || {};
     } catch (e) {
-      logger.debug(e);
-      const respBody = {
-        error: {
-          status: "PERMISSION_DENIED",
-          message: e.message || "Permission denied to resource"
-        }
-      };
-      response.status(403).send(respBody).end();
+      logger.error(
+        `Auth policy failed with error: ${e.message}
+${e.stack}`
+      );
+      response.status(getHttpStatus(e)).json(getCallableJSON(e)).end();
       return;
     }
     if (request.get("Accept") === "text/event-stream" || stream === "true") {
@@ -44,7 +50,7 @@ function expressHandler(action, opts) {
           onChunk,
           () => action.run(input, {
             onChunk,
-            context: { auth }
+            context
           })
         );
         response.write(
@@ -52,43 +58,37 @@ function expressHandler(action, opts) {
         );
         response.end();
       } catch (e) {
-        logger.error(e);
+        logger.error(
+          `Streaming request failed with error: ${e.message}
+${e.stack}`
+        );
         response.write(
-          "data: " + JSON.stringify({
-            error: {
-              status: "INTERNAL",
-              message: getErrorMessage(e),
-              details: getErrorStack(e)
-            }
-          }) + streamDelimiter
+          `error: ${JSON.stringify({ error: getCallableJSON(e) })}${streamDelimiter}`
         );
         response.end();
       }
     } else {
       try {
-        const result = await action.run(input, { context: { auth } });
+        const result = await action.run(input, { context });
         response.setHeader("x-genkit-trace-id", result.telemetry.traceId);
         response.setHeader("x-genkit-span-id", result.telemetry.spanId);
-        response.status(200).send({
+        response.status(200).json({
           result: result.result
         }).end();
       } catch (e) {
-        response.status(500).send({
-          error: {
-            status: "INTERNAL",
-            message: getErrorMessage(e),
-            details: getErrorStack(e)
-          }
-        }).end();
+        logger.error(
+          `Non-streaming request failed with error: ${e.message}
+${e.stack}`
+        );
+        response.status(getHttpStatus(e)).json(getCallableJSON(e)).end();
       }
     }
   };
 }
-function withAuth(flow, authProvider, authPolicy) {
+function withContextProvider(flow, context) {
   return {
     flow,
-    authProvider,
-    authPolicy
+    context
   };
 }
 function startFlowServer(options) {
@@ -120,22 +120,17 @@ class FlowServer {
     logger.debug("Running flow server with flow paths:");
     const pathPrefix = this.options.pathPrefix ?? "";
     this.options.flows?.forEach((flow) => {
-      if (flow.authPolicy) {
-        const flowWithPolicy = flow;
-        const flowPath = `/${pathPrefix}${flowWithPolicy.flow.__action.name}`;
+      if ("context" in flow) {
+        const flowPath = `/${pathPrefix}${flow.flow.__action.name}`;
         logger.debug(` - ${flowPath}`);
         server.post(
           flowPath,
-          flowWithPolicy.authProvider,
-          expressHandler(flowWithPolicy.flow, {
-            authPolicy: flowWithPolicy.authPolicy
-          })
+          expressHandler(flow.flow, { contextProvider: flow.context })
         );
       } else {
-        const resolvedFlow = flow;
-        const flowPath = `/${pathPrefix}${resolvedFlow.__action.name}`;
+        const flowPath = `/${pathPrefix}${flow.__action.name}`;
         logger.debug(` - ${flowPath}`);
-        server.post(flowPath, expressHandler(resolvedFlow));
+        server.post(flowPath, expressHandler(flow));
       }
     });
     this.port = this.options?.port || (process.env.PORT ? parseInt(process.env.PORT) : 0) || 3400;
@@ -185,6 +180,6 @@ export {
   FlowServer,
   expressHandler,
   startFlowServer,
-  withAuth
+  withContextProvider
 };
 //# sourceMappingURL=index.mjs.map

package/lib/index.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["/*\n Copyright 2024 Google LLC\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n /\n\nimport as bodyParser from 'body-parser';\nimport cors, { CorsOptions } from 'cors';\nimport express, { RequestHandler } from 'express';\nimport { Action, Flow, runWithStreamingCallback, z } from 'genkit';\nimport { logger } from 'genkit/logging';\nimport { Server } from 'http';\nimport { getErrorMessage, getErrorStack } from './utils';\n\nconst streamDelimiter = '\\n\\n';\n\n/*\n Auth policy context is an object passed to the auth policy providing details necessary for auth.\n /\nexport interface AuthPolicyContext<\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n> {\n action?: Action<I, O, S>;\n input: z.infer<I>;\n auth?: Record<string, any>;\n request: RequestWithAuth;\n}\n\n/\n Flow Auth policy. Consumes the authorization context of the flow and\n * performs checks before the flow runs. If this throws, the flow will not\n * be executed.\n /\nexport interface AuthPolicy<\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n> {\n (ctx: AuthPolicyContext<I, O, S>): void \| Promise<void>;\n}\n\n/\n For express-based flows, req.auth should contain the value to bepassed into\n * the flow context.\n /\nexport interface RequestWithAuth extends express.Request {\n auth?: Record<string, any>;\n}\n\n/\n Exposes provided flow or an action as express handler.\n /\nexport function expressHandler<\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n>(\n action: Action<I, O, S>,\n opts?: {\n authPolicy?: AuthPolicy<I, O, S>;\n }\n): express.RequestHandler {\n return async (\n request: RequestWithAuth,\n response: express.Response\n ): Promise<void> => {\n const { stream } = request.query;\n let input = request.body.data;\n const auth = request.auth;\n\n try {\n await opts?.authPolicy?.({\n action,\n auth,\n input,\n request,\n });\n } catch (e: any) {\n logger.debug(e);\n const respBody = {\n error: {\n status: 'PERMISSION_DENIED',\n message: e.message \|\| 'Permission denied to resource',\n },\n };\n response.status(403).send(respBody).end();\n return;\n }\n\n if (request.get('Accept') === 'text/event-stream' \|\| stream === 'true') {\n response.writeHead(200, {\n 'Content-Type': 'text/plain',\n 'Transfer-Encoding': 'chunked',\n });\n try {\n const onChunk = (chunk: z.infer<S>) => {\n response.write(\n 'data: ' + JSON.stringify({ message: chunk }) + streamDelimiter\n );\n };\n const result = await runWithStreamingCallback(\n action.__registry,\n onChunk,\n () =>\n action.run(input, {\n onChunk,\n context: { auth },\n })\n );\n response.write(\n 'data: ' + JSON.stringify({ result: result.result }) + streamDelimiter\n );\n response.end();\n } catch (e) {\n logger.error(e);\n response.write(\n 'data: ' +\n JSON.stringify({\n error: {\n status: 'INTERNAL',\n message: getErrorMessage(e),\n details: getErrorStack(e),\n },\n }) +\n streamDelimiter\n );\n response.end();\n }\n } else {\n try {\n const result = await action.run(input, { context: { auth } });\n response.setHeader('x-genkit-trace-id', result.telemetry.traceId);\n response.setHeader('x-genkit-span-id', result.telemetry.spanId);\n // Responses for non-streaming flows are passed back with the flow result stored in a field called \"result.\"\n response\n .status(200)\n .send({\n result: result.result,\n })\n .end();\n } catch (e) {\n // Errors for non-streaming flows are passed back as standard API errors.\n response\n .status(500)\n .send({\n error: {\n status: 'INTERNAL',\n message: getErrorMessage(e),\n details: getErrorStack(e),\n },\n })\n .end();\n }\n }\n };\n}\n\n/\n A wrapper object containing a flow with its associated auth policy.\n /\nexport type FlowWithAuthPolicy<\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n> = {\n flow: Flow<I, O, S>;\n authProvider: RequestHandler;\n authPolicy: AuthPolicy;\n};\n\n/\n Adds an auth policy to the flow.\n /\nexport function withAuth<\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n>(\n flow: Flow<I, O, S>,\n authProvider: RequestHandler,\n authPolicy: AuthPolicy\n): FlowWithAuthPolicy<I, O, S> {\n return {\n flow,\n authProvider,\n authPolicy,\n };\n}\n\n/\n Options to configure the flow server.\n /\nexport interface FlowServerOptions {\n /* List of flows to expose via the flow server. /\n flows: (Flow<any, any, any> \| FlowWithAuthPolicy<any, any, any>)[];\n /* Port to run the server on. Defaults to env.PORT or 3400. /\n port?: number;\n /* CORS options for the server. /\n cors?: CorsOptions;\n /* HTTP method path prefix for the exposed flows. /\n pathPrefix?: string;\n /* JSON body parser options. /\n jsonParserOptions?: bodyParser.OptionsJson;\n}\n\n/\n Starts an express server with the provided flows and options.\n /\nexport function startFlowServer(options: FlowServerOptions): FlowServer {\n const server = new FlowServer(options);\n server.start();\n return server;\n}\n\n/\n Flow server exposes registered flows as HTTP endpoints.\n \n This is for use in production environments.\n \n @hidden\n /\nexport class FlowServer {\n /* List of all running servers needed to be cleaned up on process exit. /\n private static RUNNING_SERVERS: FlowServer[] = [];\n\n /* Options for the flow server configured by the developer. /\n private options: FlowServerOptions;\n /* Port the server is actually running on. This may differ from `options.port` if the original was occupied. Null is server is not running. /\n private port: number \| null = null;\n /* Express server instance. Null if server is not running. /\n private server: Server \| null = null;\n\n constructor(options: FlowServerOptions) {\n this.options = {\n ...options,\n };\n }\n\n /\n Starts the server and adds it to the list of running servers to clean up on exit.\n /\n async start() {\n const server = express();\n\n server.use(bodyParser.json(this.options.jsonParserOptions));\n server.use(cors(this.options.cors));\n\n logger.debug('Running flow server with flow paths:');\n const pathPrefix = this.options.pathPrefix ?? '';\n this.options.flows?.forEach((flow) => {\n if ((flow as FlowWithAuthPolicy).authPolicy) {\n const flowWithPolicy = flow as FlowWithAuthPolicy;\n const flowPath = `/${pathPrefix}${flowWithPolicy.flow.__action.name}`;\n logger.debug(` - ${flowPath}`);\n server.post(\n flowPath,\n flowWithPolicy.authProvider,\n expressHandler(flowWithPolicy.flow, {\n authPolicy: flowWithPolicy.authPolicy,\n })\n );\n } else {\n const resolvedFlow = flow as Flow;\n const flowPath = `/${pathPrefix}${resolvedFlow.__action.name}`;\n logger.debug(` - ${flowPath}`);\n server.post(flowPath, expressHandler(resolvedFlow));\n }\n });\n this.port =\n this.options?.port \|\|\n (process.env.PORT ? parseInt(process.env.PORT) : 0) \|\|\n 3400;\n this.server = server.listen(this.port, () => {\n logger.debug(`Flow server running on http://localhost:${this.port}`);\n FlowServer.RUNNING_SERVERS.push(this);\n });\n }\n\n /\n Stops the server and removes it from the list of running servers to clean up on exit.\n /\n async stop(): Promise<void> {\n if (!this.server) {\n return;\n }\n return new Promise<void>((resolve, reject) => {\n this.server!.close((err) => {\n if (err) {\n logger.error(\n `Error shutting down flow server on port ${this.port}: ${err}`\n );\n reject(err);\n }\n const index = FlowServer.RUNNING_SERVERS.indexOf(this);\n if (index > -1) {\n FlowServer.RUNNING_SERVERS.splice(index, 1);\n }\n logger.debug(\n `Flow server on port ${this.port} has successfully shut down.`\n );\n this.port = null;\n this.server = null;\n resolve();\n });\n });\n }\n\n /\n Stops all running servers.\n */\n static async stopAll() {\n return Promise.all(\n FlowServer.RUNNING_SERVERS.map((server) => server.stop())\n );\n }\n}\n"],"mappings":"AAgBA,YAAY,gBAAgB;AAC5B,OAAO,UAA2B;AAClC,OAAO,aAAiC;AACxC,SAAuB,gCAAmC;AAC1D,SAAS,cAAc;AAEvB,SAAS,iBAAiB,qBAAqB;AAE/C,MAAM,kBAAkB;AAwCjB,SAAS,eAKd,QACA,MAGwB;AACxB,SAAO,OACL,SACA,aACkB;AAClB,UAAM,EAAE,OAAO,IAAI,QAAQ;AAC3B,QAAI,QAAQ,QAAQ,KAAK;AACzB,UAAM,OAAO,QAAQ;AAErB,QAAI;AACF,YAAM,MAAM,aAAa;AAAA,QACvB;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH,SAAS,GAAQ;AACf,aAAO,MAAM,CAAC;AACd,YAAM,WAAW;AAAA,QACf,OAAO;AAAA,UACL,QAAQ;AAAA,UACR,SAAS,EAAE,WAAW;AAAA,QACxB;AAAA,MACF;AACA,eAAS,OAAO,GAAG,EAAE,KAAK,QAAQ,EAAE,IAAI;AACxC;AAAA,IACF;AAEA,QAAI,QAAQ,IAAI,QAAQ,MAAM,uBAAuB,WAAW,QAAQ;AACtE,eAAS,UAAU,KAAK;AAAA,QACtB,gBAAgB;AAAA,QAChB,qBAAqB;AAAA,MACvB,CAAC;AACD,UAAI;AACF,cAAM,UAAU,CAAC,UAAsB;AACrC,mBAAS;AAAA,YACP,WAAW,KAAK,UAAU,EAAE,SAAS,MAAM,CAAC,IAAI;AAAA,UAClD;AAAA,QACF;AACA,cAAM,SAAS,MAAM;AAAA,UACnB,OAAO;AAAA,UACP;AAAA,UACA,MACE,OAAO,IAAI,OAAO;AAAA,YAChB;AAAA,YACA,SAAS,EAAE,KAAK;AAAA,UAClB,CAAC;AAAA,QACL;AACA,iBAAS;AAAA,UACP,WAAW,KAAK,UAAU,EAAE,QAAQ,OAAO,OAAO,CAAC,IAAI;AAAA,QACzD;AACA,iBAAS,IAAI;AAAA,MACf,SAAS,GAAG;AACV,eAAO,MAAM,CAAC;AACd,iBAAS;AAAA,UACP,WACE,KAAK,UAAU;AAAA,YACb,OAAO;AAAA,cACL,QAAQ;AAAA,cACR,SAAS,gBAAgB,CAAC;AAAA,cAC1B,SAAS,cAAc,CAAC;AAAA,YAC1B;AAAA,UACF,CAAC,IACD;AAAA,QACJ;AACA,iBAAS,IAAI;AAAA,MACf;AAAA,IACF,OAAO;AACL,UAAI;AACF,cAAM,SAAS,MAAM,OAAO,IAAI,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;AAC5D,iBAAS,UAAU,qBAAqB,OAAO,UAAU,OAAO;AAChE,iBAAS,UAAU,oBAAoB,OAAO,UAAU,MAAM;AAE9D,iBACG,OAAO,GAAG,EACV,KAAK;AAAA,UACJ,QAAQ,OAAO;AAAA,QACjB,CAAC,EACA,IAAI;AAAA,MACT,SAAS,GAAG;AAEV,iBACG,OAAO,GAAG,EACV,KAAK;AAAA,UACJ,OAAO;AAAA,YACL,QAAQ;AAAA,YACR,SAAS,gBAAgB,CAAC;AAAA,YAC1B,SAAS,cAAc,CAAC;AAAA,UAC1B;AAAA,QACF,CAAC,EACA,IAAI;AAAA,MACT;AAAA,IACF;AAAA,EACF;AACF;AAkBO,SAAS,SAKd,MACA,cACA,YAC6B;AAC7B,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAqBO,SAAS,gBAAgB,SAAwC;AACtE,QAAM,SAAS,IAAI,WAAW,OAAO;AACrC,SAAO,MAAM;AACb,SAAO;AACT;AASO,MAAM,WAAW;AAAA;AAAA,EAEtB,OAAe,kBAAgC,CAAC;AAAA;AAAA,EAGxC;AAAA;AAAA,EAEA,OAAsB;AAAA;AAAA,EAEtB,SAAwB;AAAA,EAEhC,YAAY,SAA4B;AACtC,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,IACL;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,QAAQ;AACZ,UAAM,SAAS,QAAQ;AAEvB,WAAO,IAAI,WAAW,KAAK,KAAK,QAAQ,iBAAiB,CAAC;AAC1D,WAAO,IAAI,KAAK,KAAK,QAAQ,IAAI,CAAC;AAElC,WAAO,MAAM,sCAAsC;AACnD,UAAM,aAAa,KAAK,QAAQ,cAAc;AAC9C,SAAK,QAAQ,OAAO,QAAQ,CAAC,SAAS;AACpC,UAAK,KAA4B,YAAY;AAC3C,cAAM,iBAAiB;AACvB,cAAM,WAAW,IAAI,UAAU,GAAG,eAAe,KAAK,SAAS,IAAI;AACnE,eAAO,MAAM,MAAM,QAAQ,EAAE;AAC7B,eAAO;AAAA,UACL;AAAA,UACA,eAAe;AAAA,UACf,eAAe,eAAe,MAAM;AAAA,YAClC,YAAY,eAAe;AAAA,UAC7B,CAAC;AAAA,QACH;AAAA,MACF,OAAO;AACL,cAAM,eAAe;AACrB,cAAM,WAAW,IAAI,UAAU,GAAG,aAAa,SAAS,IAAI;AAC5D,eAAO,MAAM,MAAM,QAAQ,EAAE;AAC7B,eAAO,KAAK,UAAU,eAAe,YAAY,CAAC;AAAA,MACpD;AAAA,IACF,CAAC;AACD,SAAK,OACH,KAAK,SAAS,SACb,QAAQ,IAAI,OAAO,SAAS,QAAQ,IAAI,IAAI,IAAI,MACjD;AACF,SAAK,SAAS,OAAO,OAAO,KAAK,MAAM,MAAM;AAC3C,aAAO,MAAM,2CAA2C,KAAK,IAAI,EAAE;AACnE,iBAAW,gBAAgB,KAAK,IAAI;AAAA,IACtC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAsB;AAC1B,QAAI,CAAC,KAAK,QAAQ;AAChB;AAAA,IACF;AACA,WAAO,IAAI,QAAc,CAAC,SAAS,WAAW;AAC5C,WAAK,OAAQ,MAAM,CAAC,QAAQ;AAC1B,YAAI,KAAK;AACP,iBAAO;AAAA,YACL,2CAA2C,KAAK,IAAI,KAAK,GAAG;AAAA,UAC9D;AACA,iBAAO,GAAG;AAAA,QACZ;AACA,cAAM,QAAQ,WAAW,gBAAgB,QAAQ,IAAI;AACrD,YAAI,QAAQ,IAAI;AACd,qBAAW,gBAAgB,OAAO,OAAO,CAAC;AAAA,QAC5C;AACA,eAAO;AAAA,UACL,uBAAuB,KAAK,IAAI;AAAA,QAClC;AACA,aAAK,OAAO;AACZ,aAAK,SAAS;AACd,gBAAQ;AAAA,MACV,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,UAAU;AACrB,WAAO,QAAQ;AAAA,MACb,WAAW,gBAAgB,IAAI,CAAC,WAAW,OAAO,KAAK,CAAC;AAAA,IAC1D;AAAA,EACF;AACF;","names":[]}
1	+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["/*\n Copyright 2024 Google LLC\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n /\n\nimport bodyParser from 'body-parser';\nimport cors, { CorsOptions } from 'cors';\nimport express from 'express';\nimport {\n Action,\n ActionContext,\n Flow,\n runWithStreamingCallback,\n z,\n} from 'genkit';\nimport {\n ContextProvider,\n RequestData,\n getCallableJSON,\n getHttpStatus,\n} from 'genkit/context';\nimport { logger } from 'genkit/logging';\nimport { Server } from 'http';\n\nconst streamDelimiter = '\\n\\n';\n\n/\n Exposes provided flow or an action as express handler.\n /\nexport function expressHandler<\n C extends ActionContext = ActionContext,\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n>(\n action: Action<I, O, S>,\n opts?: {\n contextProvider?: ContextProvider<C, I>;\n }\n): express.RequestHandler {\n return async (\n request: express.Request,\n response: express.Response\n ): Promise<void> => {\n const { stream } = request.query;\n let input = request.body.data as z.infer<I>;\n let context: Record<string, any>;\n\n try {\n context =\n (await opts?.contextProvider?.({\n method: request.method as RequestData['method'],\n headers: Object.fromEntries(\n Object.entries(request.headers).map(([key, value]) => [\n key.toLowerCase(),\n Array.isArray(value) ? value.join(' ') : String(value),\n ])\n ),\n input,\n })) \|\| {};\n } catch (e: any) {\n logger.error(\n `Auth policy failed with error: ${(e as Error).message}\\n${(e as Error).stack}`\n );\n response.status(getHttpStatus(e)).json(getCallableJSON(e)).end();\n return;\n }\n\n if (request.get('Accept') === 'text/event-stream' \|\| stream === 'true') {\n response.writeHead(200, {\n 'Content-Type': 'text/plain',\n 'Transfer-Encoding': 'chunked',\n });\n try {\n const onChunk = (chunk: z.infer<S>) => {\n response.write(\n 'data: ' + JSON.stringify({ message: chunk }) + streamDelimiter\n );\n };\n const result = await runWithStreamingCallback(\n action.__registry,\n onChunk,\n () =>\n action.run(input, {\n onChunk,\n context,\n })\n );\n response.write(\n 'data: ' + JSON.stringify({ result: result.result }) + streamDelimiter\n );\n response.end();\n } catch (e) {\n logger.error(\n `Streaming request failed with error: ${(e as Error).message}\\n${(e as Error).stack}`\n );\n response.write(\n `error: ${JSON.stringify({ error: getCallableJSON(e) })}${streamDelimiter}`\n );\n response.end();\n }\n } else {\n try {\n const result = await action.run(input, { context });\n response.setHeader('x-genkit-trace-id', result.telemetry.traceId);\n response.setHeader('x-genkit-span-id', result.telemetry.spanId);\n // Responses for non-streaming flows are passed back with the flow result stored in a field called \"result.\"\n response\n .status(200)\n .json({\n result: result.result,\n })\n .end();\n } catch (e) {\n // Errors for non-streaming flows are passed back as standard API errors.\n logger.error(\n `Non-streaming request failed with error: ${(e as Error).message}\\n${(e as Error).stack}`\n );\n response.status(getHttpStatus(e)).json(getCallableJSON(e)).end();\n }\n }\n };\n}\n\n/\n A wrapper object containing a flow with its associated auth policy.\n /\nexport type FlowWithContextProvider<\n C extends ActionContext = ActionContext,\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n> = {\n flow: Flow<I, O, S>;\n context: ContextProvider<C, I>;\n};\n\n/\n Adds an auth policy to the flow.\n /\nexport function withContextProvider<\n C extends ActionContext = ActionContext,\n I extends z.ZodTypeAny = z.ZodTypeAny,\n O extends z.ZodTypeAny = z.ZodTypeAny,\n S extends z.ZodTypeAny = z.ZodTypeAny,\n>(\n flow: Flow<I, O, S>,\n context: ContextProvider<C, I>\n): FlowWithContextProvider<C, I, O, S> {\n return {\n flow,\n context,\n };\n}\n\n/\n Options to configure the flow server.\n /\nexport interface FlowServerOptions {\n /* List of flows to expose via the flow server. /\n flows: (Flow<any, any, any> \| FlowWithContextProvider<any, any, any>)[];\n /* Port to run the server on. Defaults to env.PORT or 3400. /\n port?: number;\n /* CORS options for the server. /\n cors?: CorsOptions;\n /* HTTP method path prefix for the exposed flows. /\n pathPrefix?: string;\n /* JSON body parser options. /\n jsonParserOptions?: bodyParser.OptionsJson;\n}\n\n/\n Starts an express server with the provided flows and options.\n /\nexport function startFlowServer(options: FlowServerOptions): FlowServer {\n const server = new FlowServer(options);\n server.start();\n return server;\n}\n\n/\n Flow server exposes registered flows as HTTP endpoints.\n \n This is for use in production environments.\n \n @hidden\n /\nexport class FlowServer {\n /* List of all running servers needed to be cleaned up on process exit. /\n private static RUNNING_SERVERS: FlowServer[] = [];\n\n /* Options for the flow server configured by the developer. /\n private options: FlowServerOptions;\n /* Port the server is actually running on. This may differ from `options.port` if the original was occupied. Null is server is not running. /\n private port: number \| null = null;\n /* Express server instance. Null if server is not running. /\n private server: Server \| null = null;\n\n constructor(options: FlowServerOptions) {\n this.options = {\n ...options,\n };\n }\n\n /\n Starts the server and adds it to the list of running servers to clean up on exit.\n /\n async start() {\n const server = express();\n\n server.use(bodyParser.json(this.options.jsonParserOptions));\n server.use(cors(this.options.cors));\n\n logger.debug('Running flow server with flow paths:');\n const pathPrefix = this.options.pathPrefix ?? '';\n this.options.flows?.forEach((flow) => {\n if ('context' in flow) {\n const flowPath = `/${pathPrefix}${flow.flow.__action.name}`;\n logger.debug(` - ${flowPath}`);\n server.post(\n flowPath,\n expressHandler(flow.flow, { contextProvider: flow.context })\n );\n } else {\n const flowPath = `/${pathPrefix}${flow.__action.name}`;\n logger.debug(` - ${flowPath}`);\n server.post(flowPath, expressHandler(flow));\n }\n });\n this.port =\n this.options?.port \|\|\n (process.env.PORT ? parseInt(process.env.PORT) : 0) \|\|\n 3400;\n this.server = server.listen(this.port, () => {\n logger.debug(`Flow server running on http://localhost:${this.port}`);\n FlowServer.RUNNING_SERVERS.push(this);\n });\n }\n\n /\n Stops the server and removes it from the list of running servers to clean up on exit.\n /\n async stop(): Promise<void> {\n if (!this.server) {\n return;\n }\n return new Promise<void>((resolve, reject) => {\n this.server!.close((err) => {\n if (err) {\n logger.error(\n `Error shutting down flow server on port ${this.port}: ${err}`\n );\n reject(err);\n }\n const index = FlowServer.RUNNING_SERVERS.indexOf(this);\n if (index > -1) {\n FlowServer.RUNNING_SERVERS.splice(index, 1);\n }\n logger.debug(\n `Flow server on port ${this.port} has successfully shut down.`\n );\n this.port = null;\n this.server = null;\n resolve();\n });\n });\n }\n\n /\n Stops all running servers.\n */\n static async stopAll() {\n return Promise.all(\n FlowServer.RUNNING_SERVERS.map((server) => server.stop())\n );\n }\n}\n"],"mappings":"AAgBA,OAAO,gBAAgB;AACvB,OAAO,UAA2B;AAClC,OAAO,aAAa;AACpB;AAAA,EAIE;AAAA,OAEK;AACP;AAAA,EAGE;AAAA,EACA;AAAA,OACK;AACP,SAAS,cAAc;AAGvB,MAAM,kBAAkB;AAKjB,SAAS,eAMd,QACA,MAGwB;AACxB,SAAO,OACL,SACA,aACkB;AAClB,UAAM,EAAE,OAAO,IAAI,QAAQ;AAC3B,QAAI,QAAQ,QAAQ,KAAK;AACzB,QAAI;AAEJ,QAAI;AACF,gBACG,MAAM,MAAM,kBAAkB;AAAA,QAC7B,QAAQ,QAAQ;AAAA,QAChB,SAAS,OAAO;AAAA,UACd,OAAO,QAAQ,QAAQ,OAAO,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM;AAAA,YACpD,IAAI,YAAY;AAAA,YAChB,MAAM,QAAQ,KAAK,IAAI,MAAM,KAAK,GAAG,IAAI,OAAO,KAAK;AAAA,UACvD,CAAC;AAAA,QACH;AAAA,QACA;AAAA,MACF,CAAC,KAAM,CAAC;AAAA,IACZ,SAAS,GAAQ;AACf,aAAO;AAAA,QACL,kCAAmC,EAAY,OAAO;AAAA,EAAM,EAAY,KAAK;AAAA,MAC/E;AACA,eAAS,OAAO,cAAc,CAAC,CAAC,EAAE,KAAK,gBAAgB,CAAC,CAAC,EAAE,IAAI;AAC/D;AAAA,IACF;AAEA,QAAI,QAAQ,IAAI,QAAQ,MAAM,uBAAuB,WAAW,QAAQ;AACtE,eAAS,UAAU,KAAK;AAAA,QACtB,gBAAgB;AAAA,QAChB,qBAAqB;AAAA,MACvB,CAAC;AACD,UAAI;AACF,cAAM,UAAU,CAAC,UAAsB;AACrC,mBAAS;AAAA,YACP,WAAW,KAAK,UAAU,EAAE,SAAS,MAAM,CAAC,IAAI;AAAA,UAClD;AAAA,QACF;AACA,cAAM,SAAS,MAAM;AAAA,UACnB,OAAO;AAAA,UACP;AAAA,UACA,MACE,OAAO,IAAI,OAAO;AAAA,YAChB;AAAA,YACA;AAAA,UACF,CAAC;AAAA,QACL;AACA,iBAAS;AAAA,UACP,WAAW,KAAK,UAAU,EAAE,QAAQ,OAAO,OAAO,CAAC,IAAI;AAAA,QACzD;AACA,iBAAS,IAAI;AAAA,MACf,SAAS,GAAG;AACV,eAAO;AAAA,UACL,wCAAyC,EAAY,OAAO;AAAA,EAAM,EAAY,KAAK;AAAA,QACrF;AACA,iBAAS;AAAA,UACP,UAAU,KAAK,UAAU,EAAE,OAAO,gBAAgB,CAAC,EAAE,CAAC,CAAC,GAAG,eAAe;AAAA,QAC3E;AACA,iBAAS,IAAI;AAAA,MACf;AAAA,IACF,OAAO;AACL,UAAI;AACF,cAAM,SAAS,MAAM,OAAO,IAAI,OAAO,EAAE,QAAQ,CAAC;AAClD,iBAAS,UAAU,qBAAqB,OAAO,UAAU,OAAO;AAChE,iBAAS,UAAU,oBAAoB,OAAO,UAAU,MAAM;AAE9D,iBACG,OAAO,GAAG,EACV,KAAK;AAAA,UACJ,QAAQ,OAAO;AAAA,QACjB,CAAC,EACA,IAAI;AAAA,MACT,SAAS,GAAG;AAEV,eAAO;AAAA,UACL,4CAA6C,EAAY,OAAO;AAAA,EAAM,EAAY,KAAK;AAAA,QACzF;AACA,iBAAS,OAAO,cAAc,CAAC,CAAC,EAAE,KAAK,gBAAgB,CAAC,CAAC,EAAE,IAAI;AAAA,MACjE;AAAA,IACF;AAAA,EACF;AACF;AAkBO,SAAS,oBAMd,MACA,SACqC;AACrC,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AAqBO,SAAS,gBAAgB,SAAwC;AACtE,QAAM,SAAS,IAAI,WAAW,OAAO;AACrC,SAAO,MAAM;AACb,SAAO;AACT;AASO,MAAM,WAAW;AAAA;AAAA,EAEtB,OAAe,kBAAgC,CAAC;AAAA;AAAA,EAGxC;AAAA;AAAA,EAEA,OAAsB;AAAA;AAAA,EAEtB,SAAwB;AAAA,EAEhC,YAAY,SAA4B;AACtC,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,IACL;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,QAAQ;AACZ,UAAM,SAAS,QAAQ;AAEvB,WAAO,IAAI,WAAW,KAAK,KAAK,QAAQ,iBAAiB,CAAC;AAC1D,WAAO,IAAI,KAAK,KAAK,QAAQ,IAAI,CAAC;AAElC,WAAO,MAAM,sCAAsC;AACnD,UAAM,aAAa,KAAK,QAAQ,cAAc;AAC9C,SAAK,QAAQ,OAAO,QAAQ,CAAC,SAAS;AACpC,UAAI,aAAa,MAAM;AACrB,cAAM,WAAW,IAAI,UAAU,GAAG,KAAK,KAAK,SAAS,IAAI;AACzD,eAAO,MAAM,MAAM,QAAQ,EAAE;AAC7B,eAAO;AAAA,UACL;AAAA,UACA,eAAe,KAAK,MAAM,EAAE,iBAAiB,KAAK,QAAQ,CAAC;AAAA,QAC7D;AAAA,MACF,OAAO;AACL,cAAM,WAAW,IAAI,UAAU,GAAG,KAAK,SAAS,IAAI;AACpD,eAAO,MAAM,MAAM,QAAQ,EAAE;AAC7B,eAAO,KAAK,UAAU,eAAe,IAAI,CAAC;AAAA,MAC5C;AAAA,IACF,CAAC;AACD,SAAK,OACH,KAAK,SAAS,SACb,QAAQ,IAAI,OAAO,SAAS,QAAQ,IAAI,IAAI,IAAI,MACjD;AACF,SAAK,SAAS,OAAO,OAAO,KAAK,MAAM,MAAM;AAC3C,aAAO,MAAM,2CAA2C,KAAK,IAAI,EAAE;AACnE,iBAAW,gBAAgB,KAAK,IAAI;AAAA,IACtC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAsB;AAC1B,QAAI,CAAC,KAAK,QAAQ;AAChB;AAAA,IACF;AACA,WAAO,IAAI,QAAc,CAAC,SAAS,WAAW;AAC5C,WAAK,OAAQ,MAAM,CAAC,QAAQ;AAC1B,YAAI,KAAK;AACP,iBAAO;AAAA,YACL,2CAA2C,KAAK,IAAI,KAAK,GAAG;AAAA,UAC9D;AACA,iBAAO,GAAG;AAAA,QACZ;AACA,cAAM,QAAQ,WAAW,gBAAgB,QAAQ,IAAI;AACrD,YAAI,QAAQ,IAAI;AACd,qBAAW,gBAAgB,OAAO,OAAO,CAAC;AAAA,QAC5C;AACA,eAAO;AAAA,UACL,uBAAuB,KAAK,IAAI;AAAA,QAClC;AACA,aAAK,OAAO;AACZ,aAAK,SAAS;AACd,gBAAQ;AAAA,MACV,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,UAAU;AACrB,WAAO,QAAQ;AAAA,MACb,WAAW,gBAAgB,IAAI,CAAC,WAAW,OAAO,KAAK,CAAC;AAAA,IAC1D;AAAA,EACF;AACF;","names":[]}

package/package.json CHANGED Viewed

@@ -9,7 +9,7 @@
     "genai",
     "generative-ai"
   ],
-  "version": "1.0.0-rc.9",
+  "version": "1.0.5",
   "type": "commonjs",
   "repository": {
     "type": "git",
@@ -24,7 +24,8 @@
   },
   "peerDependencies": {
     "express": "^4.21.1",
-    "genkit": "1.0.0-rc.9"
+    "@genkit-ai/core": "1.0.5",
+    "genkit": "^1.0.5"
   },
   "devDependencies": {
     "get-port": "^5.1.0",

package/src/index.ts CHANGED Viewed

@@ -14,88 +14,66 @@
  * limitations under the License.
  */
-import * as bodyParser from 'body-parser';
+import bodyParser from 'body-parser';
 import cors, { CorsOptions } from 'cors';
-import express, { RequestHandler } from 'express';
-import { Action, Flow, runWithStreamingCallback, z } from 'genkit';
+import express from 'express';
+import {
+  Action,
+  ActionContext,
+  Flow,
+  runWithStreamingCallback,
+  z,
+} from 'genkit';
+import {
+  ContextProvider,
+  RequestData,
+  getCallableJSON,
+  getHttpStatus,
+} from 'genkit/context';
 import { logger } from 'genkit/logging';
 import { Server } from 'http';
-import { getErrorMessage, getErrorStack } from './utils';
 const streamDelimiter = '\n\n';
-/**
- * Auth policy context is an object passed to the auth policy providing details necessary for auth.
- */
-export interface AuthPolicyContext<
-  I extends z.ZodTypeAny = z.ZodTypeAny,
-  O extends z.ZodTypeAny = z.ZodTypeAny,
-  S extends z.ZodTypeAny = z.ZodTypeAny,
-> {
-  action?: Action<I, O, S>;
-  input: z.infer<I>;
-  auth?: Record<string, any>;
-  request: RequestWithAuth;
-}
-/**
- * Flow Auth policy. Consumes the authorization context of the flow and
- * performs checks before the flow runs. If this throws, the flow will not
- * be executed.
- */
-export interface AuthPolicy<
-  I extends z.ZodTypeAny = z.ZodTypeAny,
-  O extends z.ZodTypeAny = z.ZodTypeAny,
-  S extends z.ZodTypeAny = z.ZodTypeAny,
-> {
-  (ctx: AuthPolicyContext<I, O, S>): void | Promise<void>;
-}
-/**
- * For express-based flows, req.auth should contain the value to bepassed into
- * the flow context.
- */
-export interface RequestWithAuth extends express.Request {
-  auth?: Record<string, any>;
-}
 /**
  * Exposes provided flow or an action as express handler.
  */
 export function expressHandler<
+  C extends ActionContext = ActionContext,
   I extends z.ZodTypeAny = z.ZodTypeAny,
   O extends z.ZodTypeAny = z.ZodTypeAny,
   S extends z.ZodTypeAny = z.ZodTypeAny,
 >(
   action: Action<I, O, S>,
   opts?: {
-    authPolicy?: AuthPolicy<I, O, S>;
+    contextProvider?: ContextProvider<C, I>;
   }
 ): express.RequestHandler {
   return async (
-    request: RequestWithAuth,
+    request: express.Request,
     response: express.Response
   ): Promise<void> => {
     const { stream } = request.query;
-    let input = request.body.data;
-    const auth = request.auth;
+    let input = request.body.data as z.infer<I>;
+    let context: Record<string, any>;
     try {
-      await opts?.authPolicy?.({
-        action,
-        auth,
-        input,
-        request,
-      });
+      context =
+        (await opts?.contextProvider?.({
+          method: request.method as RequestData['method'],
+          headers: Object.fromEntries(
+            Object.entries(request.headers).map(([key, value]) => [
+              key.toLowerCase(),
+              Array.isArray(value) ? value.join(' ') : String(value),
+            ])
+          ),
+          input,
+        })) || {};
     } catch (e: any) {
-      logger.debug(e);
-      const respBody = {
-        error: {
-          status: 'PERMISSION_DENIED',
-          message: e.message || 'Permission denied to resource',
-        },
-      };
-      response.status(403).send(respBody).end();
+      logger.error(
+        `Auth policy failed with error: ${(e as Error).message}\n${(e as Error).stack}`
+      );
+      response.status(getHttpStatus(e)).json(getCallableJSON(e)).end();
       return;
     }
@@ -116,7 +94,7 @@ export function expressHandler<
           () =>
             action.run(input, {
               onChunk,
-              context: { auth },
+              context,
             })
         );
         response.write(
@@ -124,44 +102,32 @@ export function expressHandler<
         );
         response.end();
       } catch (e) {
-        logger.error(e);
+        logger.error(
+          `Streaming request failed with error: ${(e as Error).message}\n${(e as Error).stack}`
+        );
         response.write(
-          'data: ' +
-            JSON.stringify({
-              error: {
-                status: 'INTERNAL',
-                message: getErrorMessage(e),
-                details: getErrorStack(e),
-              },
-            }) +
-            streamDelimiter
+          `error: ${JSON.stringify({ error: getCallableJSON(e) })}${streamDelimiter}`
         );
         response.end();
       }
     } else {
       try {
-        const result = await action.run(input, { context: { auth } });
+        const result = await action.run(input, { context });
         response.setHeader('x-genkit-trace-id', result.telemetry.traceId);
         response.setHeader('x-genkit-span-id', result.telemetry.spanId);
         // Responses for non-streaming flows are passed back with the flow result stored in a field called "result."
         response
           .status(200)
-          .send({
+          .json({
             result: result.result,
           })
           .end();
       } catch (e) {
         // Errors for non-streaming flows are passed back as standard API errors.
-        response
-          .status(500)
-          .send({
-            error: {
-              status: 'INTERNAL',
-              message: getErrorMessage(e),
-              details: getErrorStack(e),
-            },
-          })
-          .end();
+        logger.error(
+          `Non-streaming request failed with error: ${(e as Error).message}\n${(e as Error).stack}`
+        );
+        response.status(getHttpStatus(e)).json(getCallableJSON(e)).end();
       }
     }
   };
@@ -170,32 +136,31 @@ export function expressHandler<
 /**
  * A wrapper object containing a flow with its associated auth policy.
  */
-export type FlowWithAuthPolicy<
+export type FlowWithContextProvider<
+  C extends ActionContext = ActionContext,
   I extends z.ZodTypeAny = z.ZodTypeAny,
   O extends z.ZodTypeAny = z.ZodTypeAny,
   S extends z.ZodTypeAny = z.ZodTypeAny,
 > = {
   flow: Flow<I, O, S>;
-  authProvider: RequestHandler;
-  authPolicy: AuthPolicy;
+  context: ContextProvider<C, I>;
 };
 /**
  * Adds an auth policy to the flow.
  */
-export function withAuth<
+export function withContextProvider<
+  C extends ActionContext = ActionContext,
   I extends z.ZodTypeAny = z.ZodTypeAny,
   O extends z.ZodTypeAny = z.ZodTypeAny,
   S extends z.ZodTypeAny = z.ZodTypeAny,
 >(
   flow: Flow<I, O, S>,
-  authProvider: RequestHandler,
-  authPolicy: AuthPolicy
-): FlowWithAuthPolicy<I, O, S> {
+  context: ContextProvider<C, I>
+): FlowWithContextProvider<C, I, O, S> {
   return {
     flow,
-    authProvider,
-    authPolicy,
+    context,
   };
 }
@@ -204,7 +169,7 @@ export function withAuth<
  */
 export interface FlowServerOptions {
   /** List of flows to expose via the flow server. */
-  flows: (Flow<any, any, any> | FlowWithAuthPolicy<any, any, any>)[];
+  flows: (Flow<any, any, any> | FlowWithContextProvider<any, any, any>)[];
   /** Port to run the server on. Defaults to env.PORT or 3400. */
   port?: number;
   /** CORS options for the server. */
@@ -260,22 +225,17 @@ export class FlowServer {
     logger.debug('Running flow server with flow paths:');
     const pathPrefix = this.options.pathPrefix ?? '';
     this.options.flows?.forEach((flow) => {
-      if ((flow as FlowWithAuthPolicy).authPolicy) {
-        const flowWithPolicy = flow as FlowWithAuthPolicy;
-        const flowPath = `/${pathPrefix}${flowWithPolicy.flow.__action.name}`;
+      if ('context' in flow) {
+        const flowPath = `/${pathPrefix}${flow.flow.__action.name}`;
         logger.debug(` - ${flowPath}`);
         server.post(
           flowPath,
-          flowWithPolicy.authProvider,
-          expressHandler(flowWithPolicy.flow, {
-            authPolicy: flowWithPolicy.authPolicy,
-          })
+          expressHandler(flow.flow, { contextProvider: flow.context })
         );
       } else {
-        const resolvedFlow = flow as Flow;
-        const flowPath = `/${pathPrefix}${resolvedFlow.__action.name}`;
+        const flowPath = `/${pathPrefix}${flow.__action.name}`;
         logger.debug(` - ${flowPath}`);
-        server.post(flowPath, expressHandler(resolvedFlow));
+        server.post(flowPath, expressHandler(flow));
       }
     });
     this.port =

package/tests/express_test.ts CHANGED Viewed

@@ -14,22 +14,50 @@
  * limitations under the License.
  */
+import { RequestData } from '@genkit-ai/core';
 import * as assert from 'assert';
 import express from 'express';
-import { GenerateResponseData, Genkit, genkit, z } from 'genkit';
-import { runFlow, streamFlow } from 'genkit/client';
+import {
+  GenerateResponseData,
+  Genkit,
+  UserFacingError,
+  genkit,
+  z,
+} from 'genkit';
+import { runFlow, streamFlow } from 'genkit/beta/client';
+import { ContextProvider } from 'genkit/context';
 import { GenerateResponseChunkData, ModelAction } from 'genkit/model';
 import getPort from 'get-port';
 import * as http from 'http';
 import { afterEach, beforeEach, describe, it } from 'node:test';
 import {
   FlowServer,
-  RequestWithAuth,
   expressHandler,
   startFlowServer,
-  withAuth,
+  withContextProvider,
 } from '../src/index.js';
+interface Context {
+  auth: {
+    user: string;
+  };
+}
+const contextProvider: ContextProvider<Context> = (req: RequestData) => {
+  assert.ok(req.method, 'method must be set');
+  assert.ok(req.headers, 'headers must be set');
+  assert.ok(req.input, 'input must be set');
+  if (req.headers['authorization'] !== 'open sesame') {
+    throw new UserFacingError('PERMISSION_DENIED', 'not authorized');
+  }
+  return {
+    auth: {
+      user: 'Ali Baba',
+    },
+  };
+};
 describe('expressHandler', async () => {
   let server: http.Server;
   let port;
@@ -82,7 +110,7 @@ describe('expressHandler', async () => {
         inputSchema: z.object({ question: z.string() }),
       },
       async (input, { context }) => {
-        return `${input.question} - ${JSON.stringify(context.auth)}`;
+        return `${input.question} - ${JSON.stringify(context!.auth)}`;
       }
     );
@@ -96,54 +124,13 @@ describe('expressHandler', async () => {
     app.post('/streamingFlow', expressHandler(streamingFlow));
     app.post(
       '/flowWithAuth',
-      async (req, resp, next) => {
-        (req as RequestWithAuth).auth = {
-          user:
-            req.header('authorization') === 'open sesame'
-              ? 'Ali Baba'
-              : '40 thieves',
-        };
-        next();
-      },
-      expressHandler(flowWithAuth, {
-        authPolicy: ({ auth, action, input, request }) => {
-          assert.ok(auth, 'auth must be set');
-          assert.ok(action, 'flow must be set');
-          assert.ok(input, 'input must be set');
-          assert.ok(request, 'request must be set');
-          if (auth.user !== 'Ali Baba') {
-            throw new Error('not authorized');
-          }
-        },
-      })
+      expressHandler(flowWithAuth, { contextProvider })
     );
     // Can also expose any action.
     app.post('/echoModel', expressHandler(echoModel));
     app.post(
       '/echoModelWithAuth',
-      async (req, resp, next) => {
-        (req as RequestWithAuth).auth = {
-          user:
-            req.header('authorization') === 'open sesame'
-              ? 'Ali Baba'
-              : '40 thieves',
-        };
-        next();
-      },
-      expressHandler(echoModel, {
-        authPolicy: ({ auth, action, input, request }) => {
-          assert.ok(auth, 'auth must be set');
-          assert.ok(action, 'flow must be set');
-          assert.ok(input, 'input must be set');
-          assert.ok(request, 'request must be set');
-          if (auth.user !== 'Ali Baba') {
-            throw new Error('not authorized');
-          }
-        },
-      })
+      expressHandler(echoModel, { contextProvider })
     );
     server = app.listen(port, () => {
@@ -213,7 +200,7 @@ describe('expressHandler', async () => {
           question: 'hello',
         },
         headers: {
-          Authorization: 'thieve #24',
+          Authorization: 'thief #24',
         },
       });
       await assert.rejects(result, (err) => {
@@ -264,7 +251,7 @@ describe('expressHandler', async () => {
           ],
         },
         headers: {
-          Authorization: 'thieve #24',
+          Authorization: 'thief #24',
         },
       });
       await assert.rejects(result, (err) => {
@@ -283,7 +270,7 @@ describe('expressHandler', async () => {
       });
       const gotChunks: GenerateResponseChunkData[] = [];
-      for await (const chunk of result.stream()) {
+      for await (const chunk of result.stream) {
         gotChunks.push(chunk);
       }
@@ -293,7 +280,7 @@ describe('expressHandler', async () => {
         { index: 0, role: 'model', content: [{ text: '1' }] },
       ]);
-      assert.strictEqual(await result.output(), 'Echo: olleh');
+      assert.strictEqual(await result.output, 'Echo: olleh');
     });
     it('stream a model', async () => {
@@ -310,11 +297,11 @@ describe('expressHandler', async () => {
       });
       const gotChunks: any[] = [];
-      for await (const chunk of result.stream()) {
+      for await (const chunk of result.stream) {
         gotChunks.push(chunk);
       }
-      const output = await result.output();
+      const output = await result.output;
       assert.strictEqual(output.finishReason, 'stop');
       assert.deepStrictEqual(output.message, {
         role: 'model',
@@ -336,7 +323,7 @@ describe('startFlowServer', async () => {
   beforeEach(async () => {
     const ai = genkit({});
-    const echoModel = defineEchoModel(ai);
+    defineEchoModel(ai);
     const voidInput = ai.defineFlow('voidInput', async () => {
       return 'banana';
@@ -382,7 +369,7 @@ describe('startFlowServer', async () => {
         inputSchema: z.object({ question: z.string() }),
       },
       async (input, { context }) => {
-        return `${input.question} - ${JSON.stringify(context.auth)}`;
+        return `${input.question} - ${JSON.stringify(context!.auth)}`;
       }
     );
@@ -394,28 +381,7 @@ describe('startFlowServer', async () => {
         stringInput,
         objectInput,
         streamingFlow,
-        withAuth(
-          flowWithAuth,
-          async (req, resp, next) => {
-            (req as RequestWithAuth).auth = {
-              user:
-                req.header('authorization') === 'open sesame'
-                  ? 'Ali Baba'
-                  : '40 thieves',
-            };
-            return next();
-          },
-          ({ auth, action, input, request }) => {
-            assert.ok(auth, 'auth must be set');
-            assert.ok(action, 'flow must be set');
-            assert.ok(input, 'input must be set');
-            assert.ok(request, 'request must be set');
-            if (auth.user !== 'Ali Baba') {
-              throw new Error('not authorized');
-            }
-          }
-        ),
+        withContextProvider(flowWithAuth, contextProvider),
       ],
       port,
     });
@@ -483,7 +449,7 @@ describe('startFlowServer', async () => {
           question: 'hello',
         },
         headers: {
-          Authorization: 'thieve #24',
+          Authorization: 'thief #24',
         },
       });
       await assert.rejects(result, (err) => {
@@ -502,7 +468,7 @@ describe('startFlowServer', async () => {
       });
       const gotChunks: GenerateResponseChunkData[] = [];
-      for await (const chunk of result.stream()) {
+      for await (const chunk of result.stream) {
         gotChunks.push(chunk);
       }
@@ -512,7 +478,7 @@ describe('startFlowServer', async () => {
         { index: 0, role: 'model', content: [{ text: '1' }] },
       ]);
-      assert.strictEqual(await result.output(), 'Echo: olleh');
+      assert.strictEqual(await result.output, 'Echo: olleh');
     });
   });
 });