@receptron/graphai_express 0.0.27 → 0.0.29

package/README.md

@@ -13,27 +13,38 @@ yarn add @receptron/graphai_express
 
 import express from "express";
 import * as agents from "@graphai/agents";
-import { agentDispatcher, nonStreamAgentDispatcher, streamAgentDispatcher, agentsList, agentDoc } from "@receptron/graphai_express";
+import { agentDispatcher, nonStreamAgentDispatcher, streamAgentDispatcher, agentsList, agentDoc, graphRunner} from "@receptron/graphai_express";
 import { AgentFunctionInfoDictionary } from "graphai";
 
 const agentDictionary: AgentFunctionInfoDictionary = agents;
 const hostName = "https://example.net";
-const apiPrefix = "/api/agents";
+const apiAgentPrefix = "/api/agents";
+const apiGraphPrefix = "/api/graph";
 
-app.get(apiPrefix + "/:agentId", agentDoc(agentDictionary, hostName, apiPrefix)); // each API(agent) document
-app.get(apiPrefix + "/", agentsList(agentDictionary, hostName, apiPrefix));  // API(agent) list
+app.get(apiAgentPrefix + "/:agentId", agentDoc(agentDictionary, hostName, apiAgentPrefix)); // each API(agent) document
+app.get(apiAgentPrefix + "/", agentsList(agentDictionary, hostName, apiAgentPrefix));  // API(agent) list
 
-// non stream and strwam
-app.post(apiPrefix + "/:agentId", agentDispatcher(agentDictionary));
+// non stream and stream agent server
+app.post(apiAgentPrefix + "/:agentId", agentDispatcher(agentDictionary));
 
-//  non stream
-app.post(apiPrefix + "/nonstream/:agentId", nonStreamAgentDispatcher(agentDictionary));
+// non stream agent server
+app.post(apiAgentPrefix + "/nonstream/:agentId", nonStreamAgentDispatcher(agentDictionary));
+
+// stream agent server
+app.post(apiAgentPrefix + "/stream/:agentId", streamAgentDispatcher(agentDictionary));
+
+// non stream and stream agent server
+app.post(apiGraphPrefix + "/", graphRunner(agentDictionary));
 
-//  stream
-app.post(apiPrefix + "/stream/:agentId", streamAgentDispatcher(agentDictionary));
 
 ```
 
+### Run Test server
+
+```
+yarn run server
+```
+
 
 ### Test from curl
 
@@ -43,8 +54,9 @@ curl -X POST -H "Content-Type: application/json" -d '{"params": {"message" : "he
 
 ### from GraphAI Client
 
-T.B.D.
-
+```
+npx ts-node  test/stream_graph.ts
+```
 
 ### for this middleware development
 

package/lib/agents.d.ts

@@ -1,8 +1,9 @@
 import express from "express";
 import type { AgentFunctionInfoDictionary, AgentFilterInfo } from "graphai";
+import { StreamChunkCallback } from "./type";
 export declare const agentsList: (agentDictionary: AgentFunctionInfoDictionary, hostName?: string, urlPath?: string) => (req: express.Request, res: express.Response) => Promise<void>;
 export declare const agentDoc: (agentDictionary: AgentFunctionInfoDictionary, hostName?: string, urlPath?: string) => (req: express.Request, res: express.Response) => Promise<void>;
-export declare const agentDispatcher: (agentDictionary: AgentFunctionInfoDictionary, agentFilters?: AgentFilterInfo[]) => (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<express.Response<any, Record<string, any>> | undefined>;
-export declare const agentRunner: (agentDictionary: AgentFunctionInfoDictionary, agentFilters?: AgentFilterInfo[]) => (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<express.Response<any, Record<string, any>> | undefined>;
+export declare const agentDispatcher: (agentDictionary: AgentFunctionInfoDictionary, agentFilters?: AgentFilterInfo[], streamChunkCallback?: StreamChunkCallback) => (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<express.Response<any, Record<string, any>> | undefined>;
+export declare const agentRunner: (agentDictionary: AgentFunctionInfoDictionary, agentFilters?: AgentFilterInfo[], streamChunkCallback?: StreamChunkCallback) => (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<express.Response<any, Record<string, any>> | undefined>;
 export declare const nonStreamAgentDispatcher: (agentDictionary: AgentFunctionInfoDictionary, agentFilters?: AgentFilterInfo[], isDispatch?: boolean) => (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<express.Response<any, Record<string, any>> | undefined>;
-export declare const streamAgentDispatcher: (agentDictionary: AgentFunctionInfoDictionary, agentFilters?: AgentFilterInfo[], isDispatch?: boolean) => (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<express.Response<any, Record<string, any>> | undefined>;
+export declare const streamAgentDispatcher: (agentDictionary: AgentFunctionInfoDictionary, agentFilters?: AgentFilterInfo[], isDispatch?: boolean, streamChunkCallback?: StreamChunkCallback) => (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<express.Response<any, Record<string, any>> | undefined>;

package/lib/agents.js

@@ -56,9 +56,9 @@ exports.agentDoc = agentDoc;
 // express middleware
 // dispatch and run agent
 // app.post(apiPrefix + "/:agentId", agentDispatcher(agentDictionary));
-const agentDispatcher = (agentDictionary, agentFilters = []) => {
+const agentDispatcher = (agentDictionary, agentFilters = [], streamChunkCallback) => {
     const nonStram = (0, exports.nonStreamAgentDispatcher)(agentDictionary, agentFilters, true);
-    const stream = (0, exports.streamAgentDispatcher)(agentDictionary, agentFilters, true);
+    const stream = (0, exports.streamAgentDispatcher)(agentDictionary, agentFilters, true, streamChunkCallback);
     return async (req, res, next) => {
         const isStreaming = (req.headers["content-type"] || "").startsWith("text/event-stream");
         if (isStreaming) {
@@ -71,9 +71,9 @@ exports.agentDispatcher = agentDispatcher;
 // express middleware
 // run agent
 // app.post(agentPrefix, agentRunner(agentDictionary));
-const agentRunner = (agentDictionary, agentFilters = []) => {
+const agentRunner = (agentDictionary, agentFilters = [], streamChunkCallback) => {
     const nonStram = (0, exports.nonStreamAgentDispatcher)(agentDictionary, agentFilters, false);
-    const stream = (0, exports.streamAgentDispatcher)(agentDictionary, agentFilters, false);
+    const stream = (0, exports.streamAgentDispatcher)(agentDictionary, agentFilters, false, streamChunkCallback);
     return async (req, res, next) => {
         const isStreaming = (req.headers["content-type"] || "").startsWith("text/event-stream");
         if (isStreaming) {
@@ -100,7 +100,7 @@ const nonStreamAgentDispatcher = (agentDictionary, agentFilters = [], isDispatch
 exports.nonStreamAgentDispatcher = nonStreamAgentDispatcher;
 // express middleware
 // run agent with streaming
-const streamAgentDispatcher = (agentDictionary, agentFilters = [], isDispatch = true) => {
+const streamAgentDispatcher = (agentDictionary, agentFilters = [], isDispatch = true, streamChunkCallback) => {
     return async (req, res, next) => {
         try {
             res.setHeader("Content-Type", "text/event-stream;charset=utf-8");
@@ -108,7 +108,12 @@ const streamAgentDispatcher = (agentDictionary, agentFilters = [], isDispatch =
             res.setHeader("X-Accel-Buffering", "no");
             const callback = (context, token) => {
                 if (token) {
-                    res.write(token);
+                    if (streamChunkCallback) {
+                        res.write(streamChunkCallback(context, token));
+                    }
+                    else {
+                        res.write(token);
+                    }
                 }
             };
             const streamAgentFilter = {

package/lib/graph.d.ts

@@ -1,5 +1,6 @@
 import express from "express";
 import type { AgentFunctionInfoDictionary, AgentFilterInfo } from "graphai";
-export declare const graphRunner: (agentDictionary: AgentFunctionInfoDictionary, agentFilters?: AgentFilterInfo[]) => (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<express.Response<any, Record<string, any>> | undefined>;
-export declare const streamGraphRunner: (agentDictionary: AgentFunctionInfoDictionary, agentFilters?: AgentFilterInfo[]) => (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<express.Response<any, Record<string, any>> | undefined>;
+import { StreamChunkCallback } from "./type";
+export declare const graphRunner: (agentDictionary: AgentFunctionInfoDictionary, agentFilters?: AgentFilterInfo[], streamChunkCallback?: StreamChunkCallback) => (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<express.Response<any, Record<string, any>> | undefined>;
+export declare const streamGraphRunner: (agentDictionary: AgentFunctionInfoDictionary, agentFilters?: AgentFilterInfo[], streamChunkCallback?: StreamChunkCallback) => (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<express.Response<any, Record<string, any>> | undefined>;
 export declare const nonStreamGraphRunner: (agentDictionary: AgentFunctionInfoDictionary, agentFilters?: AgentFilterInfo[]) => (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<express.Response<any, Record<string, any>> | undefined>;

package/lib/graph.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.nonStreamGraphRunner = exports.streamGraphRunner = exports.graphRunner = void 0;
 const graphai_1 = require("graphai");
 const agent_filters_1 = require("@graphai/agent_filters");
-const graphRunner = (agentDictionary, agentFilters = []) => {
-    const stream = (0, exports.streamGraphRunner)(agentDictionary, agentFilters);
+const graphRunner = (agentDictionary, agentFilters = [], streamChunkCallback) => {
+    const stream = (0, exports.streamGraphRunner)(agentDictionary, agentFilters, streamChunkCallback);
     const nonStream = (0, exports.nonStreamGraphRunner)(agentDictionary, agentFilters);
     return async (req, res, next) => {
         const isStreaming = (req.headers["content-type"] || "").startsWith("text/event-stream");
@@ -15,20 +15,25 @@ const graphRunner = (agentDictionary, agentFilters = []) => {
     };
 };
 exports.graphRunner = graphRunner;
-const streamGraphRunner = (agentDictionary, agentFilters = []) => {
+const streamGraphRunner = (agentDictionary, agentFilters = [], streamChunkCallback) => {
     return async (req, res, next) => {
         try {
             res.setHeader("Content-Type", "text/event-stream;charset=utf-8");
             res.setHeader("Cache-Control", "no-cache, no-transform");
             res.setHeader("X-Accel-Buffering", "no");
-            const callback = (context, token) => {
+            const streamCallback = (context, token) => {
                 if (token) {
-                    res.write(token);
+                    if (streamChunkCallback) {
+                        res.write(streamChunkCallback(context, token));
+                    }
+                    else {
+                        res.write(token);
+                    }
                 }
             };
             const streamAgentFilter = {
                 name: "streamAgentFilter",
-                agent: (0, agent_filters_1.streamAgentFilterGenerator)(callback),
+                agent: (0, agent_filters_1.streamAgentFilterGenerator)(streamCallback),
             };
             const filterList = [...agentFilters, streamAgentFilter];
             const dispatcher = streamGraphRunnerInternal(agentDictionary, filterList);
@@ -59,9 +64,10 @@ const nonStreamGraphRunner = (agentDictionary, agentFilters = []) => {
 exports.nonStreamGraphRunner = nonStreamGraphRunner;
 // internal function
 const streamGraphRunnerInternal = (agentDictionary, agentFilters = []) => {
-    return async (req, __res) => {
+    return async (req, res) => {
         const { graphData } = req.body;
-        const graphai = new graphai_1.GraphAI(graphData, agentDictionary, { agentFilters });
+        const { config } = req;
+        const graphai = new graphai_1.GraphAI(graphData, agentDictionary, { agentFilters, config: config ?? {} });
         const result = await graphai.run(true);
         return result;
     };

package/lib/index.d.ts

@@ -1,3 +1,3 @@
 export { agentsList, agentDoc, agentDispatcher, agentRunner, nonStreamAgentDispatcher, streamAgentDispatcher } from "./agents";
 export { graphRunner, streamGraphRunner, nonStreamGraphRunner } from "./graph";
-export { ExpressAgentInfo } from "./type";
+export { ExpressAgentInfo, StreamChunkCallback } from "./type";

package/lib/type.d.ts

@@ -1,4 +1,4 @@
-import type { AgentFunctionInfoSample } from "graphai";
+import type { AgentFunctionInfoSample, AgentFunctionContext } from "graphai";
 export type ExpressAgentInfo = {
     agentId: string;
     name: string;
@@ -13,3 +13,4 @@ export type ExpressAgentInfo = {
     output: any;
     stream: boolean;
 };
+export type StreamChunkCallback = (context: AgentFunctionContext, token: string) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@receptron/graphai_express",
-  "version": "0.0.27",
+  "version": "0.0.29",
   "description": "GraphAI express web server middleware.",
   "main": "lib/index.js",
   "files": [
@@ -30,8 +30,12 @@
     "@graphai/agents": "^0.0.21",
     "@types/express": "^4.17.21",
     "@types/node": "^20.14.12",
+    "@types/sinon": "^17.0.3",
+    "@types/sinon-express-mock": "^1.3.12",
     "eslint": "^9.7.0",
     "prettier": "^3.3.3",
+    "sinon": "^18.0.0",
+    "sinon-express-mock": "^2.2.1",
     "ts-node": "^10.9.2",
     "tsc-alias": "^1.8.8",
     "tsconfig-paths": "^4.2.0",