@aigne/transport 0.3.6 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [0.4.0](https://github.com/AIGNE-io/aigne-framework/compare/transport-v0.3.6...transport-v0.4.0) (2025-06-16)
+
+
+### Features
+
+* support respond progressing chunks by enable `returnProgressChunks` option for aigne.invoke ([cf4c313](https://github.com/AIGNE-io/aigne-framework/commit/cf4c313ee69f255be799ac196da675b79f69bf76))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/openai bumped to 0.3.0
+  * devDependencies
+    * @aigne/core bumped to 1.19.0
+    * @aigne/test-utils bumped to 0.4.0
+
 ## [0.3.6](https://github.com/AIGNE-io/aigne-framework/compare/transport-v0.3.5...transport-v0.3.6) (2025-06-11)
 
 

package/lib/cjs/http-client/client-agent.js

@@ -23,11 +23,13 @@ class ClientAgent extends core_1.Agent {
             });
             return result;
         }
-        return (0, stream_utils_js_1.onAgentResponseStreamEnd)(result, async (result) => {
-            await this.postprocess((0, core_1.createMessage)(input), result, {
-                ...options,
-                context: this.client,
-            });
+        return (0, stream_utils_js_1.onAgentResponseStreamEnd)(result, {
+            onResult: async (result) => {
+                await this.postprocess((0, core_1.createMessage)(input), result, {
+                    ...options,
+                    context: this.client,
+                });
+            },
         });
     }
     process(_input, _options) {

package/lib/cjs/http-client/client.d.ts

@@ -43,6 +43,7 @@ export declare class AIGNEHTTPClient<U extends UserContext = UserContext> implem
      * @param options - Configuration options for connecting to the AIGNE server
      */
     constructor(options: AIGNEHTTPClientOptions);
+    id: string;
     usage: ContextUsage;
     userContext: U;
     memories: Context["memories"];

package/lib/cjs/http-client/client.js

@@ -4,6 +4,7 @@ exports.AIGNEHTTPClient = void 0;
 const core_1 = require("@aigne/core");
 const event_stream_js_1 = require("@aigne/core/utils/event-stream.js");
 const type_utils_js_1 = require("@aigne/core/utils/type-utils.js");
+const uuid_1 = require("uuid");
 const client_agent_js_1 = require("./client-agent.js");
 /**
  * Http client for interacting with a remote AIGNE server.
@@ -28,6 +29,7 @@ class AIGNEHTTPClient {
     constructor(options) {
         this.options = options;
     }
+    id = (0, uuid_1.v7)();
     usage = (0, core_1.newEmptyContextUsage)();
     userContext = {};
     memories = [];

package/lib/cjs/http-server/server.d.ts

@@ -1,5 +1,5 @@
 import { IncomingMessage, ServerResponse } from "node:http";
-import type { AIGNE, AgentInvokeOptions, UserContext } from "@aigne/core";
+import type { AIGNE, AgentInvokeOptions, InvokeOptions, UserContext } from "@aigne/core";
 import { z } from "zod";
 /**
  * Schema for validating agent invocation payloads.
@@ -12,6 +12,7 @@ export declare const invokePayloadSchema: z.ZodObject<{
     input: z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
     options: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodObject<{
         streaming: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodBoolean>>, boolean | undefined, boolean | null | undefined>;
+        returnProgressChunks: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodBoolean>>, boolean | undefined, boolean | null | undefined>;
         userContext: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>, Record<string, unknown> | undefined, Record<string, unknown> | null | undefined>;
         memories: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
             content: z.ZodType<object, z.ZodTypeDef, object>;
@@ -30,24 +31,28 @@ export declare const invokePayloadSchema: z.ZodObject<{
         memories?: {
             content: object;
         }[] | undefined;
+        returnProgressChunks?: boolean | undefined;
     }, {
         streaming?: boolean | null | undefined;
         userContext?: Record<string, unknown> | null | undefined;
         memories?: {
             content: object;
         }[] | null | undefined;
+        returnProgressChunks?: boolean | null | undefined;
     }>>>, {
         streaming?: boolean | undefined;
         userContext?: Record<string, unknown> | undefined;
         memories?: {
             content: object;
         }[] | undefined;
+        returnProgressChunks?: boolean | undefined;
     } | undefined, {
         streaming?: boolean | null | undefined;
         userContext?: Record<string, unknown> | null | undefined;
         memories?: {
             content: object;
         }[] | null | undefined;
+        returnProgressChunks?: boolean | null | undefined;
     } | null | undefined>;
 }, "strip", z.ZodTypeAny, {
     agent: string;
@@ -58,6 +63,7 @@ export declare const invokePayloadSchema: z.ZodObject<{
         memories?: {
             content: object;
         }[] | undefined;
+        returnProgressChunks?: boolean | undefined;
     } | undefined;
 }, {
     agent: string;
@@ -68,6 +74,7 @@ export declare const invokePayloadSchema: z.ZodObject<{
         memories?: {
             content: object;
         }[] | null | undefined;
+        returnProgressChunks?: boolean | null | undefined;
     } | null | undefined;
 }>;
 /**
@@ -86,7 +93,7 @@ export interface AIGNEHTTPServerOptions {
      */
     maximumBodySize?: string;
 }
-export interface AIGNEHTTPServerInvokeOptions<U extends UserContext = UserContext> extends Pick<AgentInvokeOptions<U>, "userContext" | "memories"> {
+export interface AIGNEHTTPServerInvokeOptions<U extends UserContext = UserContext> extends Pick<AgentInvokeOptions<U>, "userContext" | "memories">, Pick<InvokeOptions, "returnProgressChunks"> {
 }
 /**
  * AIGNEHTTPServer provides HTTP API access to AIGNE capabilities.
@@ -103,15 +110,15 @@ export interface AIGNEHTTPServerInvokeOptions<U extends UserContext = UserContex
  * {@includeCode ../../test/http-server/http-server.test.ts#example-aigne-server-hono}
  */
 export declare class AIGNEHTTPServer {
-    engine: AIGNE;
+    aigne: AIGNE;
     options?: AIGNEHTTPServerOptions | undefined;
     /**
      * Creates a new AIGNEServer instance.
      *
-     * @param engine - The AIGNE engine instance that will process agent invocations
+     * @param aigne - The AIGNE instance that will process agent invocations
      * @param options - Configuration options for the server
      */
-    constructor(engine: AIGNE, options?: AIGNEHTTPServerOptions | undefined);
+    constructor(aigne: AIGNE, options?: AIGNEHTTPServerOptions | undefined);
     /**
      * Invokes an agent with the provided input and returns a standard web Response.
      * This method serves as the primary API endpoint for agent invocation.

package/lib/cjs/http-server/server.js

@@ -33,6 +33,10 @@ exports.invokePayloadSchema = zod_1.z.object({
             .boolean()
             .nullish()
             .transform((v) => v ?? undefined),
+        returnProgressChunks: zod_1.z
+            .boolean()
+            .nullish()
+            .transform((v) => v ?? undefined),
         userContext: zod_1.z
             .record(zod_1.z.string(), zod_1.z.unknown())
             .nullish()
@@ -60,16 +64,16 @@ exports.invokePayloadSchema = zod_1.z.object({
  * {@includeCode ../../test/http-server/http-server.test.ts#example-aigne-server-hono}
  */
 class AIGNEHTTPServer {
-    engine;
+    aigne;
     options;
     /**
      * Creates a new AIGNEServer instance.
      *
-     * @param engine - The AIGNE engine instance that will process agent invocations
+     * @param aigne - The AIGNE instance that will process agent invocations
      * @param options - Configuration options for the server
      */
-    constructor(engine, options) {
-        this.engine = engine;
+    constructor(aigne, options) {
+        this.aigne = aigne;
         this.options = options;
     }
     async invoke(request, response, options) {
@@ -95,24 +99,25 @@ class AIGNEHTTPServer {
      * @private
      */
     async _invoke(request, options = {}) {
-        const { engine } = this;
+        const { aigne } = this;
         try {
             const payload = await this._prepareInput(request);
             const { agent: agentName, input, options: { streaming, ...opts } = {}, } = (0, type_utils_js_1.tryOrThrow)(() => (0, type_utils_js_1.checkArguments)(`Invoke agent ${payload.agent}`, exports.invokePayloadSchema, payload), (error) => new error_js_1.ServerError(400, error.message));
-            const agent = engine.agents[agentName];
+            const agent = aigne.agents[agentName];
             if (!agent)
                 throw new error_js_1.ServerError(404, `Agent ${agentName} not found`);
             const mergedOptions = {
+                returnProgressChunks: opts.returnProgressChunks,
                 userContext: { ...opts.userContext, ...options.userContext },
                 memories: [...(opts.memories ?? []), ...(options.memories ?? [])],
             };
             if (!streaming) {
-                const result = await engine.invoke(agent, input, mergedOptions);
+                const result = await aigne.invoke(agent, input, mergedOptions);
                 return new Response(JSON.stringify(result), {
                     headers: { "Content-Type": "application/json" },
                 });
             }
-            const stream = await engine.invoke(agent, input, {
+            const stream = await aigne.invoke(agent, input, {
                 ...mergedOptions,
                 returnActiveAgent: false,
                 streaming: true,

package/lib/dts/http-client/client.d.ts

@@ -43,6 +43,7 @@ export declare class AIGNEHTTPClient<U extends UserContext = UserContext> implem
      * @param options - Configuration options for connecting to the AIGNE server
      */
     constructor(options: AIGNEHTTPClientOptions);
+    id: string;
     usage: ContextUsage;
     userContext: U;
     memories: Context["memories"];

package/lib/dts/http-server/server.d.ts

@@ -1,5 +1,5 @@
 import { IncomingMessage, ServerResponse } from "node:http";
-import type { AIGNE, AgentInvokeOptions, UserContext } from "@aigne/core";
+import type { AIGNE, AgentInvokeOptions, InvokeOptions, UserContext } from "@aigne/core";
 import { z } from "zod";
 /**
  * Schema for validating agent invocation payloads.
@@ -12,6 +12,7 @@ export declare const invokePayloadSchema: z.ZodObject<{
     input: z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
     options: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodObject<{
         streaming: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodBoolean>>, boolean | undefined, boolean | null | undefined>;
+        returnProgressChunks: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodBoolean>>, boolean | undefined, boolean | null | undefined>;
         userContext: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>, Record<string, unknown> | undefined, Record<string, unknown> | null | undefined>;
         memories: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
             content: z.ZodType<object, z.ZodTypeDef, object>;
@@ -30,24 +31,28 @@ export declare const invokePayloadSchema: z.ZodObject<{
         memories?: {
             content: object;
         }[] | undefined;
+        returnProgressChunks?: boolean | undefined;
     }, {
         streaming?: boolean | null | undefined;
         userContext?: Record<string, unknown> | null | undefined;
         memories?: {
             content: object;
         }[] | null | undefined;
+        returnProgressChunks?: boolean | null | undefined;
     }>>>, {
         streaming?: boolean | undefined;
         userContext?: Record<string, unknown> | undefined;
         memories?: {
             content: object;
         }[] | undefined;
+        returnProgressChunks?: boolean | undefined;
     } | undefined, {
         streaming?: boolean | null | undefined;
         userContext?: Record<string, unknown> | null | undefined;
         memories?: {
             content: object;
         }[] | null | undefined;
+        returnProgressChunks?: boolean | null | undefined;
     } | null | undefined>;
 }, "strip", z.ZodTypeAny, {
     agent: string;
@@ -58,6 +63,7 @@ export declare const invokePayloadSchema: z.ZodObject<{
         memories?: {
             content: object;
         }[] | undefined;
+        returnProgressChunks?: boolean | undefined;
     } | undefined;
 }, {
     agent: string;
@@ -68,6 +74,7 @@ export declare const invokePayloadSchema: z.ZodObject<{
         memories?: {
             content: object;
         }[] | null | undefined;
+        returnProgressChunks?: boolean | null | undefined;
     } | null | undefined;
 }>;
 /**
@@ -86,7 +93,7 @@ export interface AIGNEHTTPServerOptions {
      */
     maximumBodySize?: string;
 }
-export interface AIGNEHTTPServerInvokeOptions<U extends UserContext = UserContext> extends Pick<AgentInvokeOptions<U>, "userContext" | "memories"> {
+export interface AIGNEHTTPServerInvokeOptions<U extends UserContext = UserContext> extends Pick<AgentInvokeOptions<U>, "userContext" | "memories">, Pick<InvokeOptions, "returnProgressChunks"> {
 }
 /**
  * AIGNEHTTPServer provides HTTP API access to AIGNE capabilities.
@@ -103,15 +110,15 @@ export interface AIGNEHTTPServerInvokeOptions<U extends UserContext = UserContex
  * {@includeCode ../../test/http-server/http-server.test.ts#example-aigne-server-hono}
  */
 export declare class AIGNEHTTPServer {
-    engine: AIGNE;
+    aigne: AIGNE;
     options?: AIGNEHTTPServerOptions | undefined;
     /**
      * Creates a new AIGNEServer instance.
      *
-     * @param engine - The AIGNE engine instance that will process agent invocations
+     * @param aigne - The AIGNE instance that will process agent invocations
      * @param options - Configuration options for the server
      */
-    constructor(engine: AIGNE, options?: AIGNEHTTPServerOptions | undefined);
+    constructor(aigne: AIGNE, options?: AIGNEHTTPServerOptions | undefined);
     /**
      * Invokes an agent with the provided input and returns a standard web Response.
      * This method serves as the primary API endpoint for agent invocation.

package/lib/esm/http-client/client-agent.js

@@ -20,11 +20,13 @@ export class ClientAgent extends Agent {
             });
             return result;
         }
-        return onAgentResponseStreamEnd(result, async (result) => {
-            await this.postprocess(createMessage(input), result, {
-                ...options,
-                context: this.client,
-            });
+        return onAgentResponseStreamEnd(result, {
+            onResult: async (result) => {
+                await this.postprocess(createMessage(input), result, {
+                    ...options,
+                    context: this.client,
+                });
+            },
         });
     }
     process(_input, _options) {

package/lib/esm/http-client/client.d.ts

@@ -43,6 +43,7 @@ export declare class AIGNEHTTPClient<U extends UserContext = UserContext> implem
      * @param options - Configuration options for connecting to the AIGNE server
      */
     constructor(options: AIGNEHTTPClientOptions);
+    id: string;
     usage: ContextUsage;
     userContext: U;
     memories: Context["memories"];

package/lib/esm/http-client/client.js

@@ -1,6 +1,7 @@
 import { newEmptyContextUsage, } from "@aigne/core";
 import { AgentResponseStreamParser, EventStreamParser } from "@aigne/core/utils/event-stream.js";
 import { tryOrThrow } from "@aigne/core/utils/type-utils.js";
+import { v7 } from "uuid";
 import { ClientAgent } from "./client-agent.js";
 /**
  * Http client for interacting with a remote AIGNE server.
@@ -25,6 +26,7 @@ export class AIGNEHTTPClient {
     constructor(options) {
         this.options = options;
     }
+    id = v7();
     usage = newEmptyContextUsage();
     userContext = {};
     memories = [];

package/lib/esm/http-server/server.d.ts

@@ -1,5 +1,5 @@
 import { IncomingMessage, ServerResponse } from "node:http";
-import type { AIGNE, AgentInvokeOptions, UserContext } from "@aigne/core";
+import type { AIGNE, AgentInvokeOptions, InvokeOptions, UserContext } from "@aigne/core";
 import { z } from "zod";
 /**
  * Schema for validating agent invocation payloads.
@@ -12,6 +12,7 @@ export declare const invokePayloadSchema: z.ZodObject<{
     input: z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
     options: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodObject<{
         streaming: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodBoolean>>, boolean | undefined, boolean | null | undefined>;
+        returnProgressChunks: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodBoolean>>, boolean | undefined, boolean | null | undefined>;
         userContext: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>, Record<string, unknown> | undefined, Record<string, unknown> | null | undefined>;
         memories: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
             content: z.ZodType<object, z.ZodTypeDef, object>;
@@ -30,24 +31,28 @@ export declare const invokePayloadSchema: z.ZodObject<{
         memories?: {
             content: object;
         }[] | undefined;
+        returnProgressChunks?: boolean | undefined;
     }, {
         streaming?: boolean | null | undefined;
         userContext?: Record<string, unknown> | null | undefined;
         memories?: {
             content: object;
         }[] | null | undefined;
+        returnProgressChunks?: boolean | null | undefined;
     }>>>, {
         streaming?: boolean | undefined;
         userContext?: Record<string, unknown> | undefined;
         memories?: {
             content: object;
         }[] | undefined;
+        returnProgressChunks?: boolean | undefined;
     } | undefined, {
         streaming?: boolean | null | undefined;
         userContext?: Record<string, unknown> | null | undefined;
         memories?: {
             content: object;
         }[] | null | undefined;
+        returnProgressChunks?: boolean | null | undefined;
     } | null | undefined>;
 }, "strip", z.ZodTypeAny, {
     agent: string;
@@ -58,6 +63,7 @@ export declare const invokePayloadSchema: z.ZodObject<{
         memories?: {
             content: object;
         }[] | undefined;
+        returnProgressChunks?: boolean | undefined;
     } | undefined;
 }, {
     agent: string;
@@ -68,6 +74,7 @@ export declare const invokePayloadSchema: z.ZodObject<{
         memories?: {
             content: object;
         }[] | null | undefined;
+        returnProgressChunks?: boolean | null | undefined;
     } | null | undefined;
 }>;
 /**
@@ -86,7 +93,7 @@ export interface AIGNEHTTPServerOptions {
      */
     maximumBodySize?: string;
 }
-export interface AIGNEHTTPServerInvokeOptions<U extends UserContext = UserContext> extends Pick<AgentInvokeOptions<U>, "userContext" | "memories"> {
+export interface AIGNEHTTPServerInvokeOptions<U extends UserContext = UserContext> extends Pick<AgentInvokeOptions<U>, "userContext" | "memories">, Pick<InvokeOptions, "returnProgressChunks"> {
 }
 /**
  * AIGNEHTTPServer provides HTTP API access to AIGNE capabilities.
@@ -103,15 +110,15 @@ export interface AIGNEHTTPServerInvokeOptions<U extends UserContext = UserContex
  * {@includeCode ../../test/http-server/http-server.test.ts#example-aigne-server-hono}
  */
 export declare class AIGNEHTTPServer {
-    engine: AIGNE;
+    aigne: AIGNE;
     options?: AIGNEHTTPServerOptions | undefined;
     /**
      * Creates a new AIGNEServer instance.
      *
-     * @param engine - The AIGNE engine instance that will process agent invocations
+     * @param aigne - The AIGNE instance that will process agent invocations
      * @param options - Configuration options for the server
      */
-    constructor(engine: AIGNE, options?: AIGNEHTTPServerOptions | undefined);
+    constructor(aigne: AIGNE, options?: AIGNEHTTPServerOptions | undefined);
     /**
      * Invokes an agent with the provided input and returns a standard web Response.
      * This method serves as the primary API endpoint for agent invocation.

package/lib/esm/http-server/server.js

@@ -27,6 +27,10 @@ export const invokePayloadSchema = z.object({
             .boolean()
             .nullish()
             .transform((v) => v ?? undefined),
+        returnProgressChunks: z
+            .boolean()
+            .nullish()
+            .transform((v) => v ?? undefined),
         userContext: z
             .record(z.string(), z.unknown())
             .nullish()
@@ -54,16 +58,16 @@ export const invokePayloadSchema = z.object({
  * {@includeCode ../../test/http-server/http-server.test.ts#example-aigne-server-hono}
  */
 export class AIGNEHTTPServer {
-    engine;
+    aigne;
     options;
     /**
      * Creates a new AIGNEServer instance.
      *
-     * @param engine - The AIGNE engine instance that will process agent invocations
+     * @param aigne - The AIGNE instance that will process agent invocations
      * @param options - Configuration options for the server
      */
-    constructor(engine, options) {
-        this.engine = engine;
+    constructor(aigne, options) {
+        this.aigne = aigne;
         this.options = options;
     }
     async invoke(request, response, options) {
@@ -89,24 +93,25 @@ export class AIGNEHTTPServer {
      * @private
      */
     async _invoke(request, options = {}) {
-        const { engine } = this;
+        const { aigne } = this;
         try {
             const payload = await this._prepareInput(request);
             const { agent: agentName, input, options: { streaming, ...opts } = {}, } = tryOrThrow(() => checkArguments(`Invoke agent ${payload.agent}`, invokePayloadSchema, payload), (error) => new ServerError(400, error.message));
-            const agent = engine.agents[agentName];
+            const agent = aigne.agents[agentName];
             if (!agent)
                 throw new ServerError(404, `Agent ${agentName} not found`);
             const mergedOptions = {
+                returnProgressChunks: opts.returnProgressChunks,
                 userContext: { ...opts.userContext, ...options.userContext },
                 memories: [...(opts.memories ?? []), ...(options.memories ?? [])],
             };
             if (!streaming) {
-                const result = await engine.invoke(agent, input, mergedOptions);
+                const result = await aigne.invoke(agent, input, mergedOptions);
                 return new Response(JSON.stringify(result), {
                     headers: { "Content-Type": "application/json" },
                 });
             }
-            const stream = await engine.invoke(agent, input, {
+            const stream = await aigne.invoke(agent, input, {
                 ...mergedOptions,
                 returnActiveAgent: false,
                 streaming: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/transport",
-  "version": "0.3.6",
+  "version": "0.4.0",
   "description": "AIGNE Transport SDK providing HTTP client and server implementations for communication between AIGNE components",
   "publishConfig": {
     "access": "public"
@@ -39,7 +39,7 @@
     }
   },
   "dependencies": {
-    "@aigne/openai": "^0.2.7"
+    "@aigne/openai": "^0.3.0"
   },
   "devDependencies": {
     "@types/bun": "^1.2.12",
@@ -54,8 +54,8 @@
     "rimraf": "^6.0.1",
     "typescript": "^5.8.3",
     "uuid": "^11.1.0",
-    "@aigne/core": "^1.18.6",
-    "@aigne/test-utils": "^0.3.8"
+    "@aigne/core": "^1.19.0",
+    "@aigne/test-utils": "^0.4.0"
   },
   "scripts": {
     "lint": "tsc --noEmit",