doc: 调整函数相关jsdoc

dist/buildinfo.json

@@ -1 +1 @@
-{"sha":"3ca5cf2","timestamp":1723601022}
+{"sha":"bf2448f","timestamp":1723602033}

dist/index.js

@@ -89,9 +89,9 @@ var Environment = class {
   // -- 版本数据 --
   //
   // 当前版本
-  BUILD_TIMESTAMP = 1723601022;
+  BUILD_TIMESTAMP = 1723602033;
   // 当前版本 commit id
-  BUILD_VERSION = "3ca5cf2";
+  BUILD_VERSION = "bf2448f";
   // -- 基础配置 --
   /**
    * @type {I18n | null}
@@ -1048,7 +1048,7 @@ ERROR: ${e.message}`;
     throw new Error(options.errorExtractor(result));
   }
   try {
-    onResult?.(result);
+    await onResult?.(result);
     return options.fullContentExtractor(result);
   } catch (e) {
     console.error(e);

dist/timestamp

@@ -1 +1 @@
-1723601022
+1723602033

src/agent/agents.js

@@ -132,19 +132,6 @@ export function loadChatLLM(context) {
     return null;
 }
 
-
-/**
- * @typedef {Function} ImageAgentRequest
- * @param {string} prompt
- * @param {ContextType} context
- */
-
-/**
- * @typedef {object} ImageAgent
- * @property {string} name
- * @property {Function} enable
- * @property {ImageAgentRequest} request
- */
 /**
  * @type {ImageAgent[]}
  */

src/agent/anthropic.js

@@ -43,7 +43,7 @@ async function renderAnthropicMessage(item) {
  * 发送消息到Anthropic AI
  * @param {LlmParams} params
  * @param {ContextType} context
- * @param {Function} onStream
+ * @param {AgentTextHandler} onStream
  * @returns {Promise<string>}
  */
 export async function requestCompletionsFromAnthropicAI(params, context, onStream) {

src/agent/azure.js

@@ -33,7 +33,7 @@ export function isAzureImageEnable(context) {
  * 发送消息到Azure ChatGPT
  * @param {LlmParams} params
  * @param {ContextType} context
- * @param {Function} onStream
+ * @param {AgentTextHandler} onStream
  * @returns {Promise<string>}
  */
 export async function requestCompletionsFromAzureOpenAI(params, context, onStream) {

src/agent/cohere.js

@@ -32,7 +32,7 @@ function renderCohereMessage(item) {
  * 发送消息到Cohere AI
  * @param {LlmParams} params
  * @param {ContextType} context
- * @param {Function} onStream
+ * @param {AgentTextHandler} onStream
  * @returns {Promise<string>}
  */
 export async function requestCompletionsFromCohereAI(params, context, onStream) {

src/agent/gemini.js

@@ -34,7 +34,7 @@ function renderGeminiMessage(item) {
  * 发送消息到Gemini
  * @param {LlmParams} params
  * @param {ContextType} context
- * @param {Function} onStream
+ * @param {AgentTextHandler} onStream
  * @returns {Promise<string>}
  */
 export async function requestCompletionsFromGeminiAI(params, context, onStream) {

src/agent/mistralai.js

@@ -25,7 +25,7 @@ function renderMistralMessage(item) {
  * 发送消息到Mistral AI
  * @param {LlmParams} params
  * @param {ContextType} context
- * @param {Function} onStream
+ * @param {AgentTextHandler} onStream
  * @returns {Promise<string>}
  */
 export async function requestCompletionsFromMistralAI(params, context, onStream) {

src/agent/openai.js

@@ -60,7 +60,7 @@ export async function renderOpenAIMessage(item) {
  * 发送消息到ChatGPT
  * @param {LlmParams} params
  * @param {ContextType} context
- * @param {Function} onStream
+ * @param {AgentTextHandler} onStream
  * @returns {Promise<string>}
  */
 export async function requestCompletionsFromOpenAI(params, context, onStream) {

src/agent/request.js

@@ -4,19 +4,27 @@ import {Stream} from './stream.js';
 
 
 /**
- * @typedef {Function} StreamBuilder
+ * @callback StreamBuilder
  * @param {Response} resp
  * @param {AbortController} controller
  * @returns {Stream}
- * @typedef {Function} SSEContentExtractor
+ */
+/** 
+ * @callback SSEContentExtractor
  * @param {object} data
  * @returns {string|null}
- * @typedef {Function} FullContentExtractor
+ */
+/**
+ * @callback FullContentExtractor
  * @param {object} data
  * @returns {string|null}
- * @typedef {object} ErrorExtractor
+ */
+/** 
+ * @callback ErrorExtractor
  * @param {object} data
  * @returns {string|null}
+ */
+/**
  * @typedef {object} SseChatCompatibleOptions
  * @property {StreamBuilder} streamBuilder
  * @property {SSEContentExtractor} contentExtractor
@@ -75,8 +83,8 @@ export function isEventStreamResponse(resp) {
  * @param {object} header
  * @param {object} body
  * @param {ContextType} context
- * @param {Function} onStream
- * @param {Function} onResult
+ * @param {AgentTextHandler| null} onStream
+ * @param {AgentTextHandler | null} onResult
  * @param {SseChatCompatibleOptions | null} options
  * @returns {Promise<string>}
  */
@@ -150,7 +158,7 @@ export async function requestChatCompletions(url, header, body, context, onStrea
     }
 
     try {
-        onResult?.(result);
+        await onResult?.(result);
         return options.fullContentExtractor(result);
     } catch (e) {
         console.error(e);

src/agent/workersai.js

@@ -44,7 +44,7 @@ function renderWorkerAIMessage(item) {
  * 发送消息到Workers AI
  * @param {LlmParams} params
  * @param {ContextType} context
- * @param {Function} onStream
+ * @param {AgentTextHandler} onStream
  * @returns {Promise<string>}
  */
 export async function requestCompletionsFromWorkersAI(params, context, onStream) {

src/types/agent.js

@@ -11,20 +11,46 @@
  */
 
 /**
- * @typedef {Function} ChatAgentRequest
+ * @callback IsAgentEnable
+ * @param {ContextType} context
+ * @returns {boolean}
+ */
+
+/**
+ * @callback AgentTextHandler
+ * @param {string} text
+ * @returns {Promise<any>}
+ */
+
+/**
+ * @callback ChatAgentRequest
  * @param {LlmParams} params
  * @param {ContextType} context
- * @param {Function} onStream
+ * @param {AgentTextHandler} onStream
  * @returns {Promise<string>}
  */
 
 /**
  * @typedef {object} ChatAgent
  * @property {string} name
- * @property {Function} enable
+ * @property {IsAgentEnable} enable
  * @property {ChatAgentRequest} request
  */
 
+/**
+ * @callback ImageAgentRequest
+ * @param {string} prompt
+ * @param {ContextType} context
+ * @returns {Promise<string|Blob>}
+ */
+
+/**
+ * @typedef {object} ImageAgent
+ * @property {string} name
+ * @property {IsAgentEnable} enable
+ * @property {ImageAgentRequest} request
+ */
+
 /**
  * @typedef {object} HistoryItem
  * @property {string} role