@agentscope-ai/agentscope 0.0.3 → 0.0.5

package/src/message/block.ts

@@ -1,3 +1,5 @@
+import { PermissionRule } from '../permission';
+
 export interface TextBlock {
     type: 'text';
     text: string;
@@ -16,20 +18,25 @@ export interface HintBlock {
     id: string;
 }
 
+export type ToolCallState = 'pending' | 'asking' | 'allowed' | 'submitted' | 'finished';
+
 export interface ToolCallBlock {
     type: 'tool_call';
     name: string;
     id: string;
     input: string;
-    awaitUserConfirmation?: boolean;
+    state: ToolCallState;
+    suggested_rules?: PermissionRule[];
 }
 
+export type ToolResultState = 'success' | 'error' | 'interrupted' | 'denied' | 'running';
+
 export interface ToolResultBlock {
     type: 'tool_result';
     id: string;
     name: string;
     output: string | (TextBlock | DataBlock)[];
-    state: 'success' | 'error' | 'interrupted' | 'running';
+    state: ToolResultState;
 }
 
 export interface Base64Source {

package/src/message/index.ts

@@ -6,12 +6,15 @@ export {
     SystemMsg,
     getTextContent,
     getContentBlocks,
+    appendEvent,
 } from './message';
 export {
     TextBlock,
     ThinkingBlock,
     ToolCallBlock,
+    ToolCallState,
     ToolResultBlock,
+    ToolResultState,
     ContentBlock,
     Base64Source,
     URLSource,

package/src/message/message.test.ts

@@ -38,6 +38,7 @@ describe('Message', () => {
                     id: '1',
                     name: 'test',
                     input: "{ query: 'What is AI?' }",
+                    state: 'pending',
                 },
                 {
                     type: 'tool_result',
@@ -64,6 +65,7 @@ describe('Message', () => {
                 id: '1',
                 name: 'test',
                 input: "{ query: 'What is AI?' }",
+                state: 'pending',
             },
         ]);
         expect(getContentBlocks(msg, 'tool_result')).toStrictEqual([

package/src/message/message.ts

@@ -6,7 +6,10 @@ import {
     ToolResultBlock,
     ToolCallBlock,
     DataBlock,
+    Base64Source,
+    URLSource,
 } from './block';
+import { AgentEvent, EventType } from '../event';
 
 /** A chat message exchanged between agents or between an agent and a model. */
 export interface Msg {
@@ -183,3 +186,227 @@ export function getContentBlocks(
     if (!blockType) return msg.content;
     return msg.content.filter(block => block.type === blockType);
 }
+
+/**
+ * Find a content block by type and id within a message.
+ * @param msg
+ * @param blockType
+ * @param blockId
+ * @returns The matching {@link ContentBlock}, or `undefined` if not found.
+ */
+function findBlock(msg: Msg, blockType: string, blockId: string): ContentBlock | undefined {
+    return msg.content.find(block => block.type === blockType && block.id === blockId);
+}
+
+/**
+ * Apply a streaming {@link AgentEvent} to a {@link Msg}, mutating it in place.
+ *
+ * Only `content` and `finished_at` are ever modified. Events whose
+ * `reply_id` does not match `msg.id` are skipped with a warning.
+ * @param msg
+ * @param event
+ * @returns The mutated {@link Msg} object.
+ */
+export function appendEvent(msg: Msg, event: AgentEvent): Msg {
+    if (!('reply_id' in event)) return msg;
+    if (event.reply_id !== msg.id) {
+        console.warn(
+            `Event reply_id "${event.reply_id}" does not match message id "${msg.id}", skipping.`
+        );
+        return msg;
+    }
+
+    switch (event.type) {
+        case EventType.REPLY_END:
+            msg.finished_at = event.created_at;
+            break;
+
+        case EventType.TEXT_BLOCK_START:
+            msg.content.push({ type: 'text', id: event.block_id, text: '' });
+            break;
+
+        case EventType.TEXT_BLOCK_DELTA: {
+            const block = findBlock(msg, 'text', event.block_id);
+            if (!block) {
+                console.warn(`TextBlock "${event.block_id}" not found, skipping.`);
+            } else {
+                (block as TextBlock).text += event.delta;
+            }
+            break;
+        }
+
+        case EventType.TEXT_BLOCK_END:
+            break;
+
+        case EventType.THINKING_BLOCK_START:
+            msg.content.push({ type: 'thinking', id: event.block_id, thinking: '' });
+            break;
+
+        case EventType.THINKING_BLOCK_DELTA: {
+            const block = findBlock(msg, 'thinking', event.block_id);
+            if (!block) {
+                console.warn(`ThinkingBlock "${event.block_id}" not found, skipping.`);
+            } else {
+                (block as ThinkingBlock).thinking += event.delta;
+            }
+            break;
+        }
+
+        case EventType.THINKING_BLOCK_END:
+            break;
+
+        case EventType.DATA_BLOCK_START:
+            msg.content.push({
+                type: 'data',
+                id: event.block_id,
+                source: { type: 'base64', data: '', media_type: event.media_type },
+            });
+            break;
+
+        case EventType.DATA_BLOCK_DELTA: {
+            const block = findBlock(msg, 'data', event.block_id);
+            if (!block) {
+                console.warn(`DataBlock "${event.block_id}" not found, skipping.`);
+            } else {
+                ((block as DataBlock).source as Base64Source).data += event.data;
+            }
+            break;
+        }
+
+        case EventType.DATA_BLOCK_END:
+            break;
+
+        case EventType.TOOL_CALL_START:
+            msg.content.push({
+                type: 'tool_call',
+                id: event.tool_call_id,
+                name: event.tool_call_name,
+                input: '',
+                state: 'pending',
+            });
+            break;
+
+        case EventType.TOOL_CALL_DELTA: {
+            const block = findBlock(msg, 'tool_call', event.tool_call_id);
+            if (!block) {
+                console.warn(`ToolCallBlock "${event.tool_call_id}" not found, skipping.`);
+            } else {
+                (block as ToolCallBlock).input += event.delta;
+            }
+            break;
+        }
+
+        case EventType.TOOL_CALL_END:
+            break;
+
+        case EventType.TOOL_RESULT_START:
+            msg.content.push({
+                type: 'tool_result',
+                id: event.tool_call_id,
+                name: event.tool_call_name,
+                output: [],
+                state: 'running',
+            });
+            break;
+
+        case EventType.TOOL_RESULT_TEXT_DELTA: {
+            const block = findBlock(msg, 'tool_result', event.tool_call_id);
+            if (!block) {
+                console.warn(`ToolResultBlock "${event.tool_call_id}" not found, skipping.`);
+            } else {
+                const trb = block as ToolResultBlock;
+                if (typeof trb.output === 'string') {
+                    trb.output = [{ type: 'text', id: crypto.randomUUID(), text: trb.output }];
+                }
+                const last = trb.output[trb.output.length - 1];
+                if (!last || last.type !== 'text') {
+                    trb.output.push({
+                        type: 'text',
+                        id: event.block_id ?? crypto.randomUUID(),
+                        text: event.delta,
+                    });
+                } else {
+                    (last as TextBlock).text += event.delta;
+                }
+            }
+            break;
+        }
+
+        case EventType.TOOL_RESULT_DATA_DELTA: {
+            const block = findBlock(msg, 'tool_result', event.tool_call_id);
+            if (!block) {
+                console.warn(`ToolResultBlock "${event.tool_call_id}" not found, skipping.`);
+            } else {
+                const trb = block as ToolResultBlock;
+                if (typeof trb.output === 'string') {
+                    trb.output = [{ type: 'text', id: crypto.randomUUID(), text: trb.output }];
+                }
+                const source: Base64Source | URLSource =
+                    event.data != null
+                        ? { type: 'base64', data: event.data, media_type: event.media_type }
+                        : { type: 'url', url: event.url!, media_type: event.media_type };
+                trb.output.push({ type: 'data', id: event.block_id, source });
+            }
+            break;
+        }
+
+        case EventType.TOOL_RESULT_END: {
+            const block = findBlock(msg, 'tool_result', event.tool_call_id);
+            if (!block) {
+                console.warn(`ToolResultBlock "${event.tool_call_id}" not found, skipping.`);
+            } else {
+                (block as ToolResultBlock).state = event.state;
+            }
+            break;
+        }
+
+        case EventType.MODEL_CALL_END:
+            // Accumulated the input and output tokens here.
+            if (msg.usage) {
+                msg.usage.inputTokens += event.input_tokens;
+                msg.usage.outputTokens += event.output_tokens;
+            } else {
+                msg.usage = {
+                    inputTokens: event.input_tokens,
+                    outputTokens: event.output_tokens,
+                };
+            }
+            break;
+
+        case EventType.REQUIRE_USER_CONFIRM:
+            for (const tc of event.tool_calls) {
+                const b = findBlock(msg, 'tool_call', tc.id);
+                if (b) {
+                    (b as ToolCallBlock).state = 'asking';
+                    if (tc.suggested_rules !== undefined) {
+                        (b as ToolCallBlock).suggested_rules = tc.suggested_rules;
+                    }
+                }
+            }
+            break;
+
+        case EventType.USER_CONFIRM_RESULT:
+            for (const result of event.confirm_results) {
+                const b = findBlock(msg, 'tool_call', result.tool_call.id);
+                if (b) {
+                    (b as ToolCallBlock).state = result.confirmed ? 'allowed' : 'finished';
+                }
+            }
+            break;
+
+        case EventType.REQUIRE_EXTERNAL_EXECUTION:
+            for (const tc of event.tool_calls) {
+                const b = findBlock(msg, 'tool_call', tc.id);
+                if (b) (b as ToolCallBlock).state = 'submitted';
+            }
+            break;
+
+        case EventType.EXTERNAL_EXECUTION_RESULT:
+            for (const result of event.execution_results) {
+                msg.content.push(result);
+            }
+            break;
+    }
+
+    return msg;
+}

package/src/model/dashscope-model.test.ts

@@ -122,6 +122,7 @@ describe('DashScopeChatModel', () => {
             name: 'get_current_weather',
             id: 'call-123',
             input: '{"location"',
+            state: 'pending',
         });
 
         // Chunk 4: Tool call with second part of arguments (delta)
@@ -131,6 +132,7 @@ describe('DashScopeChatModel', () => {
             name: 'get_current_weather',
             id: 'call-123',
             input: ':"Beijing"}',
+            state: 'pending',
         });
 
         // Chunk 5: Empty content with usage info
@@ -158,6 +160,7 @@ describe('DashScopeChatModel', () => {
             name: 'get_current_weather',
             id: 'call-123',
             input: '{"location":"Beijing"}',
+            state: 'pending',
         });
 
         // Verify usage
@@ -266,6 +269,7 @@ describe('DashScopeChatModel', () => {
             name: 'get_current_weather',
             id: 'call-123',
             input: '{"location":"Beijing"}',
+            state: 'pending',
         });
 
         // Verify usage

package/src/model/dashscope-model.ts

@@ -231,6 +231,7 @@ export class DashScopeChatModel extends ChatModelBase {
                         id: String(toolCall.id),
                         name: String(toolCall.function.name),
                         input: inputString,
+                        state: 'pending',
                     });
                 }
             });
@@ -354,6 +355,7 @@ export class DashScopeChatModel extends ChatModelBase {
                                 id: meta.id,
                                 name: meta.name,
                                 input: deltaArgs,
+                                state: 'pending',
                             });
                         }
                     });
@@ -387,6 +389,7 @@ export class DashScopeChatModel extends ChatModelBase {
                 id: meta.id,
                 name: meta.name,
                 input: accToolInputs.get(index) || '{}',
+                state: 'pending',
             });
         });
 

package/src/model/deepseek-model.test.ts

@@ -106,6 +106,7 @@ describe('DeepSeekChatModel', () => {
             name: 'get_current_weather',
             id: 'call-123',
             input: '{"location":"Beijing"}',
+            state: 'pending',
         });
 
         // Verify usage
@@ -209,6 +210,7 @@ describe('DeepSeekChatModel', () => {
             name: 'get_current_weather',
             id: 'call-123',
             input: '{"location":"Beijing"}',
+            state: 'pending',
         });
 
         // Verify usage

package/src/model/deepseek-model.ts

@@ -191,6 +191,7 @@ export class DeepSeekChatModel extends ChatModelBase {
                         id: String(toolCall.id),
                         name: String(toolCall.function.name),
                         input: inputString,
+                        state: 'pending',
                     });
                 }
             });
@@ -314,6 +315,7 @@ export class DeepSeekChatModel extends ChatModelBase {
                                 id: meta.id,
                                 name: meta.name,
                                 input: deltaArgs,
+                                state: 'pending',
                             });
                         }
                     });
@@ -347,6 +349,7 @@ export class DeepSeekChatModel extends ChatModelBase {
                 id: meta.id,
                 name: meta.name,
                 input: accToolInputs.get(index) || '{}',
+                state: 'pending',
             });
         });
 

package/src/model/ollama-model.test.ts

@@ -106,6 +106,7 @@ describe('OllamaChatModel', () => {
             type: 'tool_call',
             name: 'get_current_weather',
             input: '{"location":"Beijing"}',
+            state: 'pending',
         });
 
         // Verify usage

package/src/model/ollama-model.ts

@@ -212,6 +212,7 @@ export class OllamaChatModel extends ChatModelBase {
                         id: toolId,
                         name: func.name,
                         input: JSON.stringify(func.arguments),
+                        state: 'pending' as const,
                     };
 
                     toolCalls.set(toolId, toolCallBlock);
@@ -284,6 +285,7 @@ export class OllamaChatModel extends ChatModelBase {
                     id: `${idx}_${toolCall.function.name}`,
                     name: toolCall.function.name,
                     input: JSON.stringify(toolCall.function.arguments),
+                    state: 'pending',
                 });
             }
         }

package/src/model/openai-model.ts

@@ -117,6 +117,7 @@ export class OpenAIChatModel extends ChatModelBase {
                         id: toolCall.id,
                         name: toolCall.function.name,
                         input: toolCall.function.arguments,
+                        state: 'pending',
                     });
                 }
             });
@@ -238,6 +239,7 @@ export class OpenAIChatModel extends ChatModelBase {
                                 id: meta.id,
                                 name: meta.name,
                                 input: deltaArgs,
+                                state: 'pending',
                             });
                         }
                     });
@@ -276,6 +278,7 @@ export class OpenAIChatModel extends ChatModelBase {
                 id: meta.id,
                 name: meta.name,
                 input: accToolInputs.get(index) || '{}',
+                state: 'pending',
             });
         });
 

package/src/storage/file-system.test.ts

@@ -529,6 +529,7 @@ describe('LocalFileStorage', () => {
                             id: 'call-123',
                             name: 'search',
                             input: JSON.stringify({ query: 'test' }),
+                            state: 'pending',
                         },
                     ],
                     role: 'assistant',

package/src/tool/toolkit.test.ts

@@ -92,6 +92,7 @@ describe('Toolkit', () => {
             type: 'tool_call',
             name: 'test_function',
             input: '{"a":"hello","b":5}',
+            state: 'pending',
             id: '1',
         });
 
@@ -162,6 +163,7 @@ describe('Toolkit', () => {
             type: 'tool_call',
             name: 'test_function',
             input: '{"a":"hello","b":5}',
+            state: 'pending',
             id: '1b',
         });
 
@@ -229,6 +231,7 @@ describe('Toolkit', () => {
             name: 'no_param_function',
             id: '2',
             input: '{}',
+            state: 'pending',
         });
 
         for await (const chunk of res) {
@@ -263,6 +266,7 @@ describe('Toolkit', () => {
             name: 'count_function',
             id: '3',
             input: '{"count":3}',
+            state: 'pending',
         });
 
         // Verify intermediate chunks
@@ -325,6 +329,7 @@ describe('Toolkit', () => {
             name: 'async_count_function',
             id: '4',
             input: '{"count":2}',
+            state: 'pending',
         });
 
         // Verify intermediate chunks
@@ -376,6 +381,7 @@ describe('Toolkit', () => {
             name: 'string_count_function',
             id: '8',
             input: '{"count":3}',
+            state: 'pending',
         });
 
         const chunks = [];
@@ -429,6 +435,7 @@ describe('Toolkit', () => {
             name: 'async_string_count_function',
             id: '9',
             input: '{"count":2}',
+            state: 'pending',
         });
 
         const chunks = [];
@@ -467,6 +474,7 @@ describe('Toolkit', () => {
             name: 'non_existent_function',
             id: '5',
             input: '{}',
+            state: 'pending',
         });
 
         for await (const chunk of res) {
@@ -495,6 +503,7 @@ describe('Toolkit', () => {
             name: 'test_function',
             id: '6',
             input: '{"a":"hello","b":20}',
+            state: 'pending',
         });
 
         for await (const chunk of res2) {
@@ -526,6 +535,7 @@ describe('Toolkit', () => {
             name: 'test_function',
             id: '7',
             input: '{"a":"hello","b":20}',
+            state: 'pending',
         });
 
         for await (const chunk of res3) {
@@ -582,6 +592,7 @@ This skill demonstrates how to use the Skill tool to retrieve skill content.`;
                 type: 'tool_call',
                 name: 'Skill',
                 input: '{"name":"test_skill"}',
+                state: 'pending',
                 id: 'skill_test_1',
             });
 
@@ -610,6 +621,7 @@ This skill demonstrates how to use the Skill tool to retrieve skill content.`;
                 type: 'tool_call',
                 name: 'Skill',
                 input: '{"name":"non_existent_skill"}',
+                state: 'pending',
                 id: 'skill_test_2',
             });