@fastgpt-plugin/sdk-factory 0.0.1-alpha.5 → 0.0.1-alpha.7

package/README.md

@@ -21,15 +21,24 @@ When developing inside this monorepo, use the workspace dependency directly.
 The plugin entry file must default-export the instance returned by `defineTool()` or `defineToolSet()`.
 
 ```ts
-import { createToolHandler, defineTool } from '@fastgpt-plugin/sdk-factory';
+import {
+  createToolHandler,
+  defineTool,
+  type InputSchemaMetaType,
+  type OutputSchemaMetaType
+} from '@fastgpt-plugin/sdk-factory';
 import z from 'zod';
 
 const handler = createToolHandler({
   inputSchema: z.object({
-    text: z.string()
+    text: z.string().meta({
+      title: 'Text'
+    } satisfies InputSchemaMetaType)
   }),
   outputSchema: z.object({
-    result: z.string()
+    result: z.string().meta({
+      title: 'Result'
+    } satisfies OutputSchemaMetaType)
   }),
   handler: async (input) => {
     return {
@@ -71,13 +80,20 @@ Defines a tool handler and infers `input`, `output`, and `secrets` types from Zo
 ```ts
 const handler = createToolHandler({
   inputSchema: z.object({
-    query: z.string()
+    query: z.string().meta({
+      title: 'Query'
+    } satisfies InputSchemaMetaType)
   }),
   outputSchema: z.object({
-    answer: z.string()
+    answer: z.string().meta({
+      title: 'Answer'
+    } satisfies OutputSchemaMetaType)
   }),
   secretSchema: z.object({
-    apiKey: z.string()
+    apiKey: z.string().meta({
+      title: 'API Key',
+      isSecret: true
+    } satisfies SecretSchemaMetaType)
   }),
   handler: async (input, ctx) => {
     ctx.streamResponse({
@@ -124,14 +140,30 @@ Defines a tool set with multiple child tools. All child tools share the top-leve
 
 ```ts
 const searchHandler = createToolHandler({
-  inputSchema: z.object({ query: z.string() }),
-  outputSchema: z.object({ items: z.array(z.string()) }),
+  inputSchema: z.object({
+    query: z.string().meta({
+      title: 'Query'
+    } satisfies InputSchemaMetaType)
+  }),
+  outputSchema: z.object({
+    items: z.array(z.string()).meta({
+      title: 'Items'
+    } satisfies OutputSchemaMetaType)
+  }),
   handler: async (input) => ({ items: [input.query] })
 });
 
 const summaryHandler = createToolHandler({
-  inputSchema: z.object({ content: z.string() }),
-  outputSchema: z.object({ summary: z.string() }),
+  inputSchema: z.object({
+    content: z.string().meta({
+      title: 'Content'
+    } satisfies InputSchemaMetaType)
+  }),
+  outputSchema: z.object({
+    summary: z.string().meta({
+      title: 'Summary'
+    } satisfies OutputSchemaMetaType)
+  }),
   handler: async (input) => ({ summary: input.content.slice(0, 100) })
 });
 
@@ -206,14 +238,33 @@ export default defineToolSet({
 
 A single tool can declare `secretSchema` in its handler. A tool set can declare a shared `secretSchema` at the top level of `defineToolSet()`.
 
+Schema 字段元数据通过 Zod `.meta()` 写入构建后的 JSON Schema。输入字段使用 `InputSchemaMetaType`，输出字段使用 `OutputSchemaMetaType`，密钥字段使用 `SecretSchemaMetaType`。`secretSchema` 的每个字段都要包含 `isSecret`，需要加密存储时设为 `true`。
+
+Schema field metadata is written into the built JSON Schema through Zod `.meta()`. Use `InputSchemaMetaType` for input fields, `OutputSchemaMetaType` for output fields, and `SecretSchemaMetaType` for secret fields. Every `secretSchema` field must include `isSecret`; set it to `true` for values that need encrypted storage.
+
 ```ts
 const secretSchema = z.object({
-  apiKey: z.string()
+  apiKey: z.string().meta({
+    title: 'API Key',
+    isSecret: true
+  } satisfies SecretSchemaMetaType),
+  baseURL: z.url().meta({
+    title: 'Base URL',
+    isSecret: false
+  } satisfies SecretSchemaMetaType)
 });
 
 const handler = createToolHandler({
-  inputSchema: z.object({ prompt: z.string() }),
-  outputSchema: z.object({ text: z.string() }),
+  inputSchema: z.object({
+    prompt: z.string().meta({
+      title: 'Prompt'
+    } satisfies InputSchemaMetaType)
+  }),
+  outputSchema: z.object({
+    text: z.string().meta({
+      title: 'Text'
+    } satisfies OutputSchemaMetaType)
+  }),
   secretSchema,
   handler: async (input, ctx) => {
     return {
@@ -232,12 +283,20 @@ Use `ctx.invoke` to call FastGPT host capabilities. The SDK currently exposes fi
 ```ts
 const handler = createToolHandler({
   inputSchema: z.object({
-    content: z.string()
+    content: z.string().meta({
+      title: 'Content'
+    } satisfies InputSchemaMetaType)
   }),
   outputSchema: z.object({
-    accessURL: z.string(),
-    fileName: z.string(),
-    size: z.number()
+    accessURL: z.string().meta({
+      title: 'Access URL'
+    } satisfies OutputSchemaMetaType),
+    fileName: z.string().meta({
+      title: 'File Name'
+    } satisfies OutputSchemaMetaType),
+    size: z.number().meta({
+      title: 'Size'
+    } satisfies OutputSchemaMetaType)
   }),
   handler: async (input, { invoke }) => {
     const [result, err] = await invoke.uploadFile({
@@ -246,7 +305,10 @@ const handler = createToolHandler({
       file: Buffer.from(input.content, 'utf-8')
     });
 
-    if (err || !result) {
+    if (err) {
+      throw err;
+    }
+    if (!result) {
       throw new Error('Failed to upload file');
     }
 

package/dist/index.d.ts

@@ -102,6 +102,40 @@ declare const InvokeUploadFileInputSchema: z.ZodObject<{
 }, z.core.$strip>;
 declare const InvokeUploadFileOutputSchema: z.ZodObject<{
   accessURL: z.ZodString;
+  etag: z.ZodOptional<z.ZodString>;
+  fileName: z.ZodOptional<z.ZodString>;
+  contentType: z.ZodOptional<z.ZodIntersection<z.ZodEnum<{
+    "application/javascript": "application/javascript";
+    "application/json": "application/json";
+    "application/yaml": "application/yaml";
+    "application/zip": "application/zip";
+    "image/jpeg": "image/jpeg";
+    "image/png": "image/png";
+    "image/gif": "image/gif";
+    "image/webp": "image/webp";
+    "image/svg+xml": "image/svg+xml";
+    "application/pdf": "application/pdf";
+    "text/plain": "text/plain";
+    "text/csv": "text/csv";
+    "application/vnd.openxmlformats-officedocument.wordprocessingml.document": "application/vnd.openxmlformats-officedocument.wordprocessingml.document";
+    "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+    "application/vnd.openxmlformats-officedocument.presentationml.presentation": "application/vnd.openxmlformats-officedocument.presentationml.presentation";
+    "application/msword": "application/msword";
+    "application/vnd.ms-excel": "application/vnd.ms-excel";
+    "application/vnd.ms-powerpoint": "application/vnd.ms-powerpoint";
+    "text/markdown": "text/markdown";
+    "audio/mpeg": "audio/mpeg";
+    "video/mp4": "video/mp4";
+    "audio/wav": "audio/wav";
+    "text/html": "text/html";
+    "application/xml": "application/xml";
+    "application/gzip": "application/gzip";
+    "application/octet-stream": "application/octet-stream";
+    "multipart/form-data": "multipart/form-data";
+    "text/event-stream": "text/event-stream";
+  }>, z.ZodString>>;
+  size: z.ZodOptional<z.ZodNumber>;
+  createTime: z.ZodOptional<z.ZodDate>;
 }, z.core.$strip>;
 type InvokeUploadFileInputType = z.infer<typeof InvokeUploadFileInputSchema>;
 type InvokeUploadFileOutputType = z.infer<typeof InvokeUploadFileOutputSchema>;
@@ -118,6 +152,10 @@ declare const InvokeUserInfoOutputSchema: z.ZodObject<{
   }, z.core.$strip>>;
 }, z.core.$strip>;
 type InvokeUserInfoOutputType = z.infer<typeof InvokeUserInfoOutputSchema>;
+type InvokeWecomCorpTokenOutputType = {
+  access_token: string;
+  expires_in: number;
+};
 /**
  * 反向调用 FastGPT 的能力
  */
@@ -125,6 +163,7 @@ interface InvokePort {
   /** 上传文件 */
   uploadFile(input: InvokeUploadFileInputType): Promise<Result<InvokeUploadFileOutputType>>;
   userInfo(): Promise<Result<InvokeUserInfoOutputType>>;
+  getWecomCorpToken(): Promise<Result<InvokeWecomCorpTokenOutputType>>;
 }
 //#endregion
 //#region ../../packages/domain/src/value-objects/system-var.vo.d.ts
@@ -180,6 +219,11 @@ type ToolHandlerDefinition<TInput extends ToolInputSchema = ToolInputSchema, TOu
 declare function createToolHandler<TInput extends ToolInputSchema, TOutput extends ToolOutputSchema, TSecret extends ToolSecretSchema = undefined>(def: ToolHandlerDefinition<TInput, TOutput, TSecret>): ToolHandlerDefinition<TInput, TOutput, TSecret>;
 //#endregion
 //#region src/index.d.ts
+type InputSchemaMetaType = z.GlobalMeta;
+type OutputSchemaMetaType = z.GlobalMeta;
+type SecretSchemaMetaType = z.GlobalMeta & {
+  /** 标注该字段是否需要加密存储 */isSecret: boolean;
+};
 interface DefinedToolFactory {
   setSecretSchema<TSecret extends Record<string, unknown>>(schema: z.ZodType<TSecret>): void;
   registerTool(definition: ToolHandlerDefinition, id?: string, childManifest?: ToolChildManifestDefinition): void;
@@ -208,4 +252,4 @@ declare const defineToolSet: ({
   })[];
 }) => DefinedToolFactory;
 //#endregion
-export { DefinedToolFactory, type ToolHandlerContext, createToolHandler, defineTool, defineToolSet };
+export { DefinedToolFactory, InputSchemaMetaType, OutputSchemaMetaType, SecretSchemaMetaType, type ToolHandlerContext, createToolHandler, defineTool, defineToolSet };

package/dist/index.js

@@ -1 +1 @@
-import e from"zod";import{Readable as t}from"node:stream";import{randomUUID as n}from"node:crypto";import r,{Readable as i}from"stream";var a=class e{stream;closed=!1;constructor(e){this.stream=new t({objectMode:!0,read(){}}),e?.(this)}static create(t){return new e(t)}write(e){this.ensureWritable(),this.stream.push(e)}send(e){this.write(e)}close(){this.closed||(this.closed=!0,this.stream.push(null))}end(){this.close()}fail(e){this.closed=!0,this.stream.destroy(e)}toReadable(){return this.stream}onData(e){return this.stream.on(`data`,e),this}onEnd(e){return this.stream.on(`end`,e),this}onError(e){return this.stream.on(`error`,e),this}async consume(e){for await(let t of this.values())await e(t)}async*values(){for await(let e of this.stream)yield e}ensureWritable(){if(this.closed||this.stream.destroyed)throw Error(`StreamData is already closed`)}};const o=e=>(e=e.replace(/(?<=https?:\/\/)[^\s]+/g,`xxx`),e=e.replace(/ns-[\w-]+/g,`xxx`),e),s=(e,t=``)=>o(typeof e==`string`?e:e?.response?.data?.message||e?.response?.message||e?.message||e?.response?.data?.msg||e?.response?.msg||e?.msg||t),c=`application/javascript,application/json,application/yaml,application/zip,image/jpeg,image/png,image/gif,image/webp,image/svg+xml,application/pdf,text/plain,text/csv,application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,application/vnd.openxmlformats-officedocument.presentationml.presentation,application/msword,application/vnd.ms-excel,application/vnd.ms-powerpoint,text/markdown,audio/mpeg,video/mp4,audio/wav,text/html,application/xml,application/gzip,application/octet-stream,multipart/form-data,text/event-stream`.split(`,`),l=e.enum(c).and(e.string().regex(/^[^/]+\/[^/]+$/));e.object({fileKey:e.string(),fileName:e.string(),contentType:l,size:e.number(),etag:e.string(),createTime:e.date()});const u=e.object({fileKey:e.string().optional(),path:e.string().optional(),fileName:e.string().optional(),contentType:l.optional(),overwrite:e.boolean().optional(),file:e.union([e.instanceof(i,{error:`Stream cannot be empty`}),e.union([e.instanceof(Buffer,{error:`Buffer is required`}),e.instanceof(Uint8Array,{error:`Uint8Array is required`})]).transform(e=>e instanceof Uint8Array&&!(e instanceof Buffer)?Buffer.from(e):e)])});e.object({...u.omit({fileKey:!0,overwrite:!0,path:!0}).shape});const d=e.object({accessURL:e.string()});e.object({username:e.string(),contact:e.string().nullish(),memberName:e.string().nullish(),orgs:e.array(e.object({pathId:e.string(),name:e.string()})),groups:e.array(e.object({name:e.string()}))});const f=e.enum([`uploadFile`,`userInfo`]).enum,p=e=>[e,null];function m(e,t){return h(e)?[null,e]:[null,{reason:e,error:t}]}function h(e){return!!(e&&typeof e==`object`&&`reason`in e&&`error`in e)}const g=`__host_invoke__`,_=`__plugin_ipc_stream__`,v=`__pluginIpcDuplexReply__`;var y=class{pending=new Map;readyHandlers=new Set;errorHandlers=new Set;streamHandlers=new Map;incomingStreams=new Map;bufferedIncomingStreams=new Map;pendingStreamWaiters=new Map;requestHandler=null;eventHandler=null;endpoint;options;unsubscribeMessage;closed=!1;constructor(e,t={}){C(e)?(this.endpoint=e,this.options=t):(this.endpoint=process,this.options=e??{}),this.unsubscribeMessage=x(this.endpoint,e=>{this.dispatch(e).catch(e=>{this.emitError(e instanceof Error?e:Error(String(e)))})})}onReady(e){return this.readyHandlers.add(e),()=>{this.readyHandlers.delete(e)}}onError(e){return this.errorHandlers.add(e),()=>{this.errorHandlers.delete(e)}}setRequestHandler(e){this.requestHandler=e}setEventHandler(e){this.eventHandler=e}async requestDuplex(e,t,r){this.ensureOpen();let i=r?.requestId??n(),a=r?.timeoutMs??this.options.defaultTimeoutMs??3e4,o=Date.now(),s=r?.input===void 0?void 0:this.pipeStream(j(i),r.input,{traceId:r.traceId,streamId:r.inputStreamId,meta:r.inputMeta});s&&s.catch(e=>{this.emitError(e instanceof Error?e:Error(String(e)))});let c=await this.request(e,t,{timeoutMs:a,traceId:r?.traceId,requestId:i});if(!E(c))return{requestId:i,result:c,...s===void 0?{}:{inputDone:s}};let l;if(c.hasOutputStream){let e=Date.now()-o,t=Math.max(1,a-e);l=await this.waitForStream(M(i),{timeoutMs:t})}return{requestId:i,result:c.result,...l===void 0?{}:{output:l},...s===void 0?{}:{inputDone:s}}}replyDuplex(e,t,n){return{[v]:!0,...t===void 0?{}:{result:t},...n?.output===void 0?{}:{output:n.output},...n===void 0?{}:{options:{...n.traceId===void 0?{}:{traceId:n.traceId},...n.outputStreamId===void 0?{}:{outputStreamId:n.outputStreamId},...n.outputMeta===void 0?{}:{outputMeta:n.outputMeta}}}}}async waitForRequestInputStream(e,t){return this.waitForStream(j(e.id),t)}onStream(e,t){this.streamHandlers.has(e)||this.streamHandlers.set(e,new Set);let n=this.streamHandlers.get(e),r=t;return n.add(r),()=>{n.delete(r),n.size===0&&this.streamHandlers.delete(e)}}async waitForStream(e,t){this.ensureOpen();let n=this.bufferedIncomingStreams.get(e);if(n&&n.length>0){let t=n.shift();return n.length===0&&this.bufferedIncomingStreams.delete(e),t}return new Promise((n,r)=>{let i={resolve:n,reject:r};t?.timeoutMs!==void 0&&(i.timer=setTimeout(()=>{let t=this.pendingStreamWaiters.get(e);if(!t)return;let n=t.indexOf(i);n>=0&&t.splice(n,1),t.length===0&&this.pendingStreamWaiters.delete(e),r(Error(`Wait stream timeout: ${e}`))},t.timeoutMs)),this.pendingStreamWaiters.has(e)||this.pendingStreamWaiters.set(e,[]),this.pendingStreamWaiters.get(e).push(i)})}async createWritableStream(e,t){this.ensureOpen();let r=t?.streamId??n(),i=!1;return await this.sendStreamFrame({type:`start`,streamId:r,streamName:e,...t?.meta===void 0?{}:{meta:t.meta}},t?.traceId),{streamId:r,write:async e=>{if(i)throw Error(`Stream is already closed: ${r}`);await this.sendStreamFrame({type:`chunk`,streamId:r,chunk:e},t?.traceId)},end:async()=>{i||(i=!0,await this.sendStreamFrame({type:`end`,streamId:r},t?.traceId))},fail:async e=>{i||(i=!0,await this.sendStreamFrame({type:`error`,streamId:r,error:O(e)},t?.traceId))}}}async pipeStream(e,t,n){let r=await this.createWritableStream(e,n);try{for await(let e of A(t))await r.write(e);await r.end()}catch(e){throw await r.fail(e instanceof Error?e:Error(String(e))),e}}async request(e,t,r){this.ensureOpen();let i=r?.requestId??n(),a=r?.timeoutMs??this.options.defaultTimeoutMs??3e4;return new Promise((n,o)=>{let s=setTimeout(()=>{this.pending.delete(i),o(Object.assign(Error(`Request timeout: ${e}`),{code:`REQUEST_TIMEOUT`,requestId:i,method:e}))},a);this.pending.set(i,{resolve:n,reject:o,timer:s}),this.send({id:i,messageType:`request`,method:e,params:t,...r?.traceId===void 0?{}:{traceId:r.traceId},timestamp:Date.now()}).catch(e=>{clearTimeout(s),this.pending.delete(i),o(e)})})}async emit(e,t,r){this.ensureOpen(),await this.send({id:n(),messageType:`event`,method:e,params:t,...r===void 0?{}:{traceId:r},timestamp:Date.now()})}async sendReady(){this.ensureOpen(),await this.send({id:n(),messageType:`ready`,timestamp:Date.now()})}async reply(e,t){this.ensureOpen(),await this.send({id:e.id,messageType:`response`,...t===void 0?{}:{result:t},...e.traceId===void 0?{}:{traceId:e.traceId},timestamp:Date.now()})}async replyError(e,t){this.ensureOpen();let n=O(t);await this.send({id:e.id,messageType:`error`,error:n,...e.traceId===void 0?{}:{traceId:e.traceId},timestamp:Date.now()})}async close(e=Error(`IPC channel closed`)){this.closed||(this.closed=!0,this.unsubscribeMessage(),this.rejectAllPending(e),this.rejectAllPendingStreamWaiters(e),this.failAllIncomingStreams(e))}async dispatch(e){if(!this.closed){if(e.messageType===`response`||e.messageType===`error`){this.handleResponse(e);return}if(e.messageType===`ready`){this.readyHandlers.forEach(t=>t(e));return}if(e.messageType===`event`){if(T(e)){await this.handleStreamFrameMessage(e);return}await this.eventHandler?.(e);return}e.messageType===`request`&&await this.handleRequest(e)}}handleResponse(e){let t=this.pending.get(e.id);if(t){if(clearTimeout(t.timer),this.pending.delete(e.id),e.error){t.reject(k(e.error));return}t.resolve(e.result)}}async handleRequest(e){if(!e.method){await this.replyError(e,{code:`INVALID_REQUEST`,message:`Request method is required`});return}if(!this.requestHandler){await this.replyError(e,{code:`METHOD_NOT_FOUND`,message:`Method not found: ${e.method}`});return}try{let t=await this.requestHandler(e);if(D(t)){await this.handleDuplexReply(e,t);return}await this.reply(e,t)}catch(t){await this.replyError(e,t instanceof Error?t:Error(String(t)))}}rejectAllPending(e){this.pending.forEach((t,n)=>{clearTimeout(t.timer),t.reject(e),this.pending.delete(n)})}rejectAllPendingStreamWaiters(e){this.pendingStreamWaiters.forEach((t,n)=>{t.forEach(t=>{t.timer&&clearTimeout(t.timer),t.reject(e)}),this.pendingStreamWaiters.delete(n)})}failAllIncomingStreams(e){this.incomingStreams.forEach((t,n)=>{t.stream.fail(e),this.incomingStreams.delete(n)}),this.bufferedIncomingStreams.clear()}async sendStreamFrame(e,t){await this.emit(_,e,t)}async handleDuplexReply(e,t){let n=t.options?.traceId??e.traceId;t.output!==void 0&&this.pipeStream(M(e.id),t.output,{traceId:n,streamId:t.options?.outputStreamId,meta:t.options?.outputMeta}).catch(e=>{this.emitError(e instanceof Error?e:Error(String(e)))}),await this.reply(e,{[v]:!0,hasOutputStream:t.output!==void 0,...t.result===void 0?{}:{result:t.result}})}async handleStreamFrameMessage(e){let t=e.params;switch(t.type){case`start`:{let n={streamId:t.streamId,streamName:t.streamName,stream:a.create(),...e.traceId===void 0?{}:{traceId:e.traceId},...t.meta===void 0?{}:{meta:t.meta}};this.incomingStreams.set(t.streamId,n),this.dispatchIncomingStream(n);return}case`chunk`:{let e=this.incomingStreams.get(t.streamId);if(!e){this.emitError(Error(`Stream not found: ${t.streamId}`));return}e.stream.write(t.chunk);return}case`end`:{let e=this.incomingStreams.get(t.streamId);if(!e)return;e.stream.close(),this.incomingStreams.delete(t.streamId);return}case`error`:{let e=this.incomingStreams.get(t.streamId);if(!e)return;e.stream.fail(k(t.error)),this.incomingStreams.delete(t.streamId);return}}}dispatchIncomingStream(e){let t=!1,n=this.pendingStreamWaiters.get(e.streamName);if(n&&n.length>0){let r=n.shift();r.timer&&clearTimeout(r.timer),n.length===0&&this.pendingStreamWaiters.delete(e.streamName),r.resolve(e),t=!0}let r=this.streamHandlers.get(e.streamName);if(r&&r.size>0){r.forEach(t=>{Promise.resolve(t(e)).catch(e=>{this.emitError(e instanceof Error?e:Error(String(e)))})});return}t||(this.bufferedIncomingStreams.has(e.streamName)||this.bufferedIncomingStreams.set(e.streamName,[]),this.bufferedIncomingStreams.get(e.streamName).push(e))}emitError(e){this.errorHandlers.forEach(t=>t(e))}async send(e){await S(this.endpoint,e)}ensureOpen(){if(this.closed)throw Error(`IPC channel closed`)}};function b(e){return new y(process,e)}function x(e,t){let n=e,r=e=>{w(e)&&t(e)};return n.on(`message`,r),()=>n.off(`message`,r)}function S(e,t){let n=e;if(typeof n.send!=`function`)throw Error(`IPC channel not available`);return new Promise((e,r)=>{n.send(t,t=>{if(t){r(t);return}e()})})}function C(e){return!!(e&&typeof e==`object`&&`on`in e&&typeof e.on==`function`&&`off`in e&&typeof e.off==`function`)}function w(e){return!!(e&&typeof e==`object`&&`messageType`in e)}function T(e){return e.messageType===`event`&&e.method===_}function E(e){return!!(e&&typeof e==`object`&&v in e&&`hasOutputStream`in e)}function D(e){return!!(e&&typeof e==`object`&&v in e)}function O(e){return typeof e==`string`?{code:`HANDLER_ERROR`,message:e}:(e instanceof Error,{code:e.code??`HANDLER_ERROR`,message:e.message,...e.stack===void 0?{}:{stack:e.stack}})}function k(e){return Object.assign(Error(e.message),{code:e.code,stack:e.stack})}function A(e){return e instanceof a?e.values():e}function j(e){return`__plugin_ipc_request_input_stream__:${e}`}function M(e){return`__plugin_ipc_request_output_stream__:${e}`}var N=class{constructor(e,t={}){this.channel=e,this.options=t}async userInfo(){try{let[e,t]=(await this.channel.requestDuplex(g,{method:f.userInfo,args:{}},{requestId:n(),traceId:this.options.invocationId})).result;return t?m({en:`Failed to get user info`,"zh-CN":`获取用户信息失败`},t):p(e)}catch(e){return m({en:`Failed to get user info`,"zh-CN":`获取用户信息失败`},e)}}async uploadFile(e){try{let[t,r]=(await this.channel.requestDuplex(g,{method:f.uploadFile,args:{contentType:e.contentType,fileName:e.fileName}},{requestId:n(),traceId:this.options.invocationId,input:this.toUploadInputStream(e.file)})).result;return r?m({en:`Failed to upload file`,"zh-CN":`上传文件失败`},r):p(d.parse(t))}catch(e){return m({en:`Failed to upload file`,"zh-CN":`上传文件失败`},e)}}toUploadInputStream(e){return e instanceof r.Readable?e:r.Readable.from(Buffer.from(e))}};const P=e.enum([`en`,`zh-CN`,`zh-Hant`]).enum;e.object({[P.en]:e.string(),[P[`zh-CN`]]:e.string().optional(),[P[`zh-Hant`]]:e.string().optional()});const F=e.object({[P.en]:e.string(),[P[`zh-CN`]]:e.string(),[P[`zh-Hant`]]:e.string()});e.object({pluginId:e.string(),version:e.string(),etag:e.string()});const I=e.literal(`system`).or(e.string()),L=e.object({id:e.string(),name:F});e.array(L);const R=e.enum([`localPool`,`serverless`]).enum;e.object({pluginId:e.string(),version:e.string().optional(),source:I.optional()});var z=class{channel;getChannel(){if(!this.channel)throw Error(`Channel is not initialized yet.`);return this.channel}mode;checkRuntimeMode(){process.env.RUNTIME_MODE==R.localPool&&(this.mode=R.localPool),process.env.RUNTIME_MODE===`dev`&&(this.mode=`dev`)}async init(){this.checkRuntimeMode(),this.mode===`localPool`&&(this.channel=b(),setImmediate(()=>this.getChannel().sendReady())),this.mode===`dev`&&(this.channel=B().pluginChannel,setImmediate(()=>this.getChannel().sendReady()))}constructor(){this.init()}};function B(){let e=globalThis.__FASTGPT_PLUGIN_LOCAL_DEBUG_RUNTIME__;if(!e)throw Error(`Local debug runtime is not initialized. Set it before importing the plugin.`);return e}function V(e){return e}var H=class t extends z{toolHandlers=new Map;childManifests=new Map;secretSchema=e.record(e.string(),e.unknown());constructor(e){super(),this.userToolManifest=e,this.mode&&this.getChannel().setRequestHandler(async e=>{if(e.method===`run`)try{let{input:t,systemVar:n,childId:r,secrets:i}=e.params,o=this.toolHandlers.get(r??`tool`);if(!o)throw Error(`No tool registered`);let c=a.create();return(async()=>{try{let r=await o.handler(t,{systemVar:n,secrets:i,invoke:new N(this.getChannel(),{invocationId:e.traceId}),streamResponse:e=>{c.send({type:`stream`,data:e})}});c.send({type:`response`,data:r})}catch(e){c.send({data:s(e,`Unknown error during tool execution`),type:`error`})}finally{c.end()}})(),this.getChannel().replyDuplex(e,void 0,{output:c})}catch(t){let n=a.create();return n.write({data:s(t,`Unknown error during tool execution`),type:`error`}),n.end(),this.getChannel().replyDuplex(e,void 0,{output:n})}})}setSecretSchema(e){this.secretSchema=e}registerTool(e,t=`tool`,n){this.toolHandlers.set(t,e),n&&this.childManifests.set(t,n)}static getInstance(e){return new t(e)}getSecretSchema(){return this.secretSchema}getToolHandler(e=`tool`){return this.toolHandlers.get(e)}getUserToolManifest(){return this.userToolManifest}getChildManifests(){return[...this.childManifests.values()]}};const U=({manifest:t,handler:n})=>{let r=H.getInstance(t);return r.setSecretSchema(n.secretSchema??e.object()),r.registerTool(n),r},W=({manifest:t,children:n,secretSchema:r})=>{let i=H.getInstance(t);return n.forEach(e=>{i.registerTool(e.handler,e.id,{id:e.id,description:e.description,name:e.name,...e.icon===void 0?{}:{icon:e.icon},...e.toolDescription===void 0?{}:{toolDescription:e.toolDescription}})}),i.setSecretSchema(r??e.object()),i};export{V as createToolHandler,U as defineTool,W as defineToolSet};
+import e from"zod";import{Readable as t}from"node:stream";import n,{Readable as r}from"stream";import{randomUUID as i}from"node:crypto";var a=class e{stream;closed=!1;constructor(e){this.stream=new t({objectMode:!0,read(){}}),e?.(this)}static create(t){return new e(t)}write(e){this.ensureWritable(),this.stream.push(e)}send(e){this.write(e)}close(){this.closed||(this.closed=!0,this.stream.push(null))}end(){this.close()}fail(e){this.closed=!0,this.stream.destroy(e)}toReadable(){return this.stream}onData(e){return this.stream.on(`data`,e),this}onEnd(e){return this.stream.on(`end`,e),this}onError(e){return this.stream.on(`error`,e),this}async consume(e){for await(let t of this.values())await e(t)}async*values(){for await(let e of this.stream)yield e}ensureWritable(){if(this.closed||this.stream.destroyed)throw Error(`StreamData is already closed`)}};const o={ready:`client.ready`,stdio:`client.stdio`,fail:`client.fail`,request:`client.request`},s=e.enum([o.ready,o.stdio,o.fail,o.request]);e.object({pid:e.number().optional(),version:e.string().optional(),runtimeMode:e.string().optional(),capabilities:e.array(e.string()).optional(),startedAt:e.number().optional(),meta:e.unknown().optional()}),e.object({stream:e.enum([`stdout`,`stderr`]),chunk:e.string(),timestamp:e.number().optional()}),e.object({reason:e.enum([`startup`,`runtime`,`crash`,`shutdown`,`unknown`]),error:e.object({code:e.string(),message:e.string(),data:e.unknown().optional()}).optional(),exitCode:e.number().nullable().optional(),signal:e.string().nullable().optional(),timestamp:e.number().optional()});const c={streamFrame:`channel.stream`},l=e.enum([c.streamFrame]),u={request:`host.request`,ping:`host.ping`,shutdown:`host.shutdown`},d=e.enum([u.request,u.ping,u.shutdown]);e.object({timestamp:e.number()}),e.object({timestamp:e.number(),receivedAt:e.number().optional()}),e.object({reason:e.string().optional(),timeoutMs:e.number().nonnegative().optional()}),e.object({accepted:e.boolean(),message:e.string().optional()}),e.union([s,l,d]);const f=e.literal(`1.0`),p=e.union([e.string(),e.number()]),m=e.object({code:e.string(),message:e.string(),data:e.unknown().optional()}),h={parseError:`PARSE_ERROR`,invalidMessage:`INVALID_MESSAGE`,methodNotFound:`METHOD_NOT_FOUND`,invalidParams:`INVALID_PARAMS`,internalError:`INTERNAL_ERROR`,requestTimeout:`REQUEST_TIMEOUT`,channelClosed:`CHANNEL_CLOSED`,streamError:`STREAM_ERROR`},g=e.object({protocol:f,id:p,method:e.string(),params:e.unknown().optional(),traceId:e.string().optional(),timestamp:e.number().optional()}),_=g.omit({id:!0}),v=e.object({protocol:f,id:p,result:e.unknown().optional(),traceId:e.string().optional(),timestamp:e.number().optional()}),y=e.object({protocol:f,id:p,error:m,traceId:e.string().optional(),timestamp:e.number().optional()});e.union([g,_,v,y]),e.enum([`ipc`,`tcp`,`http`]),e.enum([`host`,`client`]),e.object({streamId:e.string(),streamName:e.string(),meta:e.unknown().optional()}),e.discriminatedUnion(`type`,[e.object({type:e.literal(`start`),streamId:e.string(),streamName:e.string(),meta:e.unknown().optional()}),e.object({type:e.literal(`chunk`),streamId:e.string(),chunk:e.unknown()}),e.object({type:e.literal(`end`),streamId:e.string()}),e.object({type:e.literal(`error`),streamId:e.string(),error:m})]);const ee=e=>(e=e.replace(/(?<=https?:\/\/)[^\s]+/g,`xxx`),e=e.replace(/ns-[\w-]+/g,`xxx`),e),b=(e,t=``)=>ee(x(e)||t),x=(e,t=0)=>t>5?void 0:typeof e==`string`?e:!e||typeof e!=`object`?void 0:S(e,t)||T(C(e?.response?.data,t),C(e?.response?.body,t),C(e?.body,t),w(e?.response?.data?.reason),w(e?.response?.reason),e?.response?.data?.message||e?.response?.message||e?.message||e?.response?.data?.msg||e?.response?.msg||e?.msg,w(e?.response?.data?.error),w(e?.response?.error),w(e?.error),x(e?.error,t+1),x(e?.cause,t+1),w(e)),S=(e,t)=>{if(!(!(`reason`in e)&&!(`error`in e)))return E(w(e.reason),x(e.error,t+1))},C=(e,t)=>{if(e){if(typeof e!=`string`)return x(e,t+1);try{let n=JSON.parse(e);return x(n?.error,t+1)||x(n,t+1)}catch{return e||void 0}}},w=e=>{if(!e||typeof e!=`object`)return;let t=e,n=t[`zh-CN`]??t.en??t[`zh-Hant`];return typeof n==`string`?n:void 0},T=(...e)=>e.find(e=>typeof e==`string`&&e.length>0),E=(...e)=>{let t=e.filter((t,n)=>!!t&&e.indexOf(t)===n);return t.length>0?t.join(`: `):void 0},te=`application/javascript,application/json,application/yaml,application/zip,image/jpeg,image/png,image/gif,image/webp,image/svg+xml,application/pdf,text/plain,text/csv,application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,application/vnd.openxmlformats-officedocument.presentationml.presentation,application/msword,application/vnd.ms-excel,application/vnd.ms-powerpoint,text/markdown,audio/mpeg,video/mp4,audio/wav,text/html,application/xml,application/gzip,application/octet-stream,multipart/form-data,text/event-stream`.split(`,`),D=e.enum(te).and(e.string().regex(/^[^/]+\/[^/]+$/)),ne=e.object({fileKey:e.string(),fileName:e.string(),contentType:D,size:e.number(),etag:e.string(),createTime:e.date()}),re=e.object({fileKey:e.string().optional(),path:e.string().optional(),fileName:e.string().optional(),contentType:D.optional(),overwrite:e.boolean().optional(),file:e.union([e.instanceof(r,{error:`Stream cannot be empty`}),e.union([e.instanceof(Buffer,{error:`Buffer is required`}),e.instanceof(Uint8Array,{error:`Uint8Array is required`})]).transform(e=>e instanceof Uint8Array&&!(e instanceof Buffer)?Buffer.from(e):e)])});e.object({...re.omit({fileKey:!0,overwrite:!0,path:!0}).shape});const ie=e.object({...ne.omit({fileKey:!0}).partial().shape,accessURL:e.string()});e.object({username:e.string(),contact:e.string().nullish(),memberName:e.string().nullish(),orgs:e.array(e.object({pathId:e.string(),name:e.string()})),groups:e.array(e.object({name:e.string()}))});const O=e.enum([`uploadFile`,`userInfo`,`wecomCorpToken`]).enum,k=e=>[e,null];function A(e,t){return j(e)?[null,e]:[null,{reason:e,error:t}]}function j(e){return!!(e&&typeof e==`object`&&`reason`in e&&`error`in e)}var M=class{constructor(e,t={}){this.channel=e,this.options=t}async userInfo(){try{let[e,t]=(await this.channel.request(o.request,{method:O.userInfo,args:{}},{traceId:this.options.invocationId})).result;return t?A({en:`Failed to get user info`,"zh-CN":`获取用户信息失败`},t):k(e)}catch(e){return A({en:`Failed to get user info`,"zh-CN":`获取用户信息失败`},e)}}async uploadFile(e){try{let[t,n]=(await this.channel.request(o.request,{method:O.uploadFile,args:{contentType:e.contentType,fileName:e.fileName}},{traceId:this.options.invocationId,input:this.toUploadInputStream(e.file)})).result;return n?A({en:`Failed to upload file`,"zh-CN":`上传文件失败`},n):k(ie.parse(t))}catch(e){return A({en:`Failed to upload file`,"zh-CN":`上传文件失败`},e)}}toUploadInputStream(e){return e instanceof n.Readable?e:n.Readable.from(Buffer.from(e))}};const N=e.enum([`en`,`zh-CN`,`zh-Hant`]).enum;e.object({[N.en]:e.string(),[N[`zh-CN`]]:e.string().optional(),[N[`zh-Hant`]]:e.string().optional()});const P=e.object({[N.en]:e.string(),[N[`zh-CN`]]:e.string(),[N[`zh-Hant`]]:e.string()});e.object({pluginId:e.string(),version:e.string(),etag:e.string()});const F=e.literal(`system`).or(e.string()),I=e.object({id:e.string(),name:P});e.array(I);const L=e.enum([`localPool`,`serverless`]).enum;e.object({pluginId:e.string(),version:e.string().optional(),source:F.optional()});const R=`__fastgptChannelReply__`;var z=class{transport=`ipc`;pending=new Map;errorHandlers=new Set;closeHandlers=new Set;incomingStreams=new Map;bufferedIncomingStreams=new Map;pendingStreamWaiters=new Map;requestHandler=null;notificationHandler=null;closed=!1;unsubscribeMessage;constructor(e,t,n={}){this.side=e,this.endpoint=t,this.options=n,this.unsubscribeMessage=V(t,e=>{this.dispatch(e).catch(e=>{this.emitError(e instanceof Error?e:Error(String(e)))})})}async request(e,t,n){this.ensureOpen();let r=n?.id??i(),a=n?.timeoutMs??this.options.defaultTimeoutMs??3e4,o=n?.input===void 0?void 0:this.pipeStream(X(r),n.input,{traceId:n.traceId,streamId:n.inputStream?.streamId,streamName:n.inputStream?.streamName,meta:n.inputStream?.meta}),s=Date.now();o&&o.catch(e=>{this.emitError(e instanceof Error?e:Error(String(e)))});let c=await new Promise((i,o)=>{let s=setTimeout(()=>{this.pending.delete(r),o(Object.assign(Error(`Request timeout: ${String(e)}`),{code:h.requestTimeout,requestId:r,method:e}))},a);this.pending.set(r,{method:String(e),resolve:i,reject:o,timer:s}),this.send({protocol:`1.0`,id:r,method:String(e),params:t,...n?.traceId===void 0?{}:{traceId:n.traceId},timestamp:Date.now()}).catch(e=>{clearTimeout(s),this.pending.delete(r),o(e)})}),l=c,u;if(q(c)&&(l=c.result,c.hasOutputStream)){let e=Date.now()-s,t=Math.max(1,a-e);u=await this.waitForStream(Z(r),{timeoutMs:t})}return{requestId:r,result:l,...u===void 0?{}:{output:u},...o===void 0?{}:{inputDone:o}}}async notify(e,t,n){this.ensureOpen(),await this.send({protocol:`1.0`,method:String(e),params:t,...n?.traceId===void 0?{}:{traceId:n.traceId},timestamp:Date.now()})}setRequestHandler(e){this.requestHandler=e}setNotificationHandler(e){this.notificationHandler=e}async waitForStream(e,t){this.ensureOpen();let n=this.bufferedIncomingStreams.get(e);if(n&&n.length>0){let t=n.shift();return n.length===0&&this.bufferedIncomingStreams.delete(e),t}return new Promise((n,r)=>{let i={resolve:n,reject:r};t?.timeoutMs!==void 0&&(i.timer=setTimeout(()=>{let t=this.pendingStreamWaiters.get(e);if(!t)return;let n=t.indexOf(i);n>=0&&t.splice(n,1),t.length===0&&this.pendingStreamWaiters.delete(e),r(Error(`Wait stream timeout: ${e}`))},t.timeoutMs)),this.pendingStreamWaiters.has(e)||this.pendingStreamWaiters.set(e,[]),this.pendingStreamWaiters.get(e).push(i)})}async createWritableStream(e,t){this.ensureOpen();let n=t?.streamId??i(),r=!1,a=t?.streamName??e;return await this.sendStreamFrame({type:`start`,streamId:n,streamName:a,...t?.meta===void 0?{}:{meta:t.meta}},t?.traceId),{streamId:n,streamName:a,...t?.meta===void 0?{}:{meta:t.meta},write:async e=>{if(r)throw Error(`Stream is already closed: ${n}`);await this.sendStreamFrame({type:`chunk`,streamId:n,chunk:e},t?.traceId)},end:async()=>{r||(r=!0,await this.sendStreamFrame({type:`end`,streamId:n},t?.traceId))},fail:async e=>{r||(r=!0,await this.sendStreamFrame({type:`error`,streamId:n,error:J(e)},t?.traceId))}}}async pipeStream(e,t,n){let r=await this.createWritableStream(e,n);try{for await(let e of ae(t))await r.write(e);await r.end()}catch(e){throw await r.fail(e instanceof Error?e:Error(String(e))),e}}onError(e){return this.errorHandlers.add(e),()=>{this.errorHandlers.delete(e)}}onClose(e){return this.closeHandlers.add(e),()=>{this.closeHandlers.delete(e)}}async close(e=Error(`Channel closed`)){this.closed||(this.closed=!0,this.unsubscribeMessage(),this.rejectAllPending(e),this.rejectAllPendingStreamWaiters(e),this.failAllIncomingStreams(e),this.closeHandlers.forEach(t=>t(e)))}createReply(e,t){return{[R]:!0,...e===void 0?{}:{result:e},...t?.output===void 0?{}:{output:t.output},...t?.outputStream===void 0?{}:{outputStream:t.outputStream}}}async dispatch(e){if(!this.closed){if(G(e)){this.handleResponse(e);return}if(W(e)){await this.handleRequest(e);return}await this.handleNotification(e)}}handleResponse(e){let t=this.pending.get(e.id);if(t){if(clearTimeout(t.timer),this.pending.delete(e.id),`error`in e){t.reject(Y(e.error));return}t.resolve(e.result)}}async handleRequest(e){if(!this.requestHandler){await this.replyError(e,{code:h.methodNotFound,message:`Method not found: ${e.method}`});return}try{let t=await this.requestHandler({id:e.id,method:e.method,params:e.params,...e.traceId===void 0?{}:{traceId:e.traceId},raw:e,waitForInputStream:t=>this.waitForStream(X(e.id),t)});if(K(t)){await this.handleReplyDescriptor(e,t);return}await this.reply(e,t)}catch(t){await this.replyError(e,t instanceof Error?t:Error(String(t)))}}async handleNotification(e){if(e.method===c.streamFrame){await this.handleStreamFrame(e.params,e.traceId);return}await this.notificationHandler?.({method:e.method,params:e.params,...e.traceId===void 0?{}:{traceId:e.traceId},raw:e})}async handleReplyDescriptor(e,t){t.output!==void 0&&this.pipeStream(Z(e.id),t.output,{traceId:t.outputStream?.traceId??e.traceId,streamId:t.outputStream?.streamId,streamName:t.outputStream?.streamName,meta:t.outputStream?.meta}).catch(e=>{this.emitError(e instanceof Error?e:Error(String(e)))}),await this.reply(e,{[R]:!0,hasOutputStream:t.output!==void 0,...t.result===void 0?{}:{result:t.result}})}async reply(e,t){await this.send({protocol:`1.0`,id:e.id,...t===void 0?{}:{result:t},...e.traceId===void 0?{}:{traceId:e.traceId},timestamp:Date.now()})}async replyError(e,t){await this.send({protocol:`1.0`,id:e.id,error:J(t),...e.traceId===void 0?{}:{traceId:e.traceId},timestamp:Date.now()})}async sendStreamFrame(e,t){await this.notify(c.streamFrame,e,{traceId:t})}async handleStreamFrame(e,t){switch(e.type){case`start`:{let n={streamId:e.streamId,streamName:e.streamName,stream:a.create(),...t===void 0?{}:{traceId:t},...e.meta===void 0?{}:{meta:e.meta}};this.incomingStreams.set(e.streamId,n),this.dispatchIncomingStream(n);return}case`chunk`:{let t=this.incomingStreams.get(e.streamId);if(!t){this.emitError(Error(`Stream not found: ${e.streamId}`));return}t.stream.write(e.chunk);return}case`end`:{let t=this.incomingStreams.get(e.streamId);if(!t)return;t.stream.end(),this.incomingStreams.delete(e.streamId);return}case`error`:{let t=this.incomingStreams.get(e.streamId);if(!t)return;t.stream.fail(Y(e.error)),this.incomingStreams.delete(e.streamId);return}}}dispatchIncomingStream(e){let t=!1,n=this.pendingStreamWaiters.get(e.streamName);if(n&&n.length>0){let r=n.shift();r.timer&&clearTimeout(r.timer),n.length===0&&this.pendingStreamWaiters.delete(e.streamName),r.resolve(e),t=!0}t||(this.bufferedIncomingStreams.has(e.streamName)||this.bufferedIncomingStreams.set(e.streamName,[]),this.bufferedIncomingStreams.get(e.streamName).push(e))}rejectAllPending(e){this.pending.forEach((t,n)=>{clearTimeout(t.timer),t.reject(e),this.pending.delete(n)})}rejectAllPendingStreamWaiters(e){this.pendingStreamWaiters.forEach((t,n)=>{t.forEach(t=>{t.timer&&clearTimeout(t.timer),t.reject(e)}),this.pendingStreamWaiters.delete(n)})}failAllIncomingStreams(e){this.incomingStreams.forEach((t,n)=>{t.stream.fail(e),this.incomingStreams.delete(n)}),this.bufferedIncomingStreams.clear()}emitError(e){this.errorHandlers.forEach(t=>t(e))}async send(e){await H(this.endpoint,e)}ensureOpen(){if(this.closed)throw Error(`Channel closed`)}};function B(e){return new z(`client`,process,e)}function V(e,t){let n=e,r=e=>{U(e)&&t(e)};return n.on(`message`,r),()=>n.off(`message`,r)}function H(e,t){let n=e;if(typeof n.send!=`function`)throw Error(`IPC channel not available`);return new Promise((e,r)=>{n.send(t,t=>{if(t){r(t);return}e()})})}function U(e){return!!(e&&typeof e==`object`&&`protocol`in e)}function W(e){return`id`in e&&`method`in e}function G(e){return`id`in e&&!(`method`in e)&&(`result`in e||`error`in e)}function K(e){return!!(e&&typeof e==`object`&&R in e&&e[R]===!0)}function q(e){return!!(e&&typeof e==`object`&&R in e&&`hasOutputStream`in e)}function J(e){return typeof e==`string`?{code:h.internalError,message:e}:e instanceof Error?{code:e.code??h.internalError,message:e.message,...e.stack===void 0?{}:{data:{stack:e.stack}}}:e}function Y(e){return Object.assign(Error(e.message),{code:e.code,data:e.data})}function ae(e){return e instanceof a?e.values():e}function X(e){return`request.input:${String(e)}`}function Z(e){return`request.output:${String(e)}`}var oe=class{channel;getChannel(){if(!this.channel)throw Error(`Channel is not initialized yet.`);return this.channel}mode;checkRuntimeMode(){process.env.RUNTIME_MODE==L.localPool&&(this.mode=L.localPool),process.env.RUNTIME_MODE===`dev`&&(this.mode=`dev`)}async init(){this.checkRuntimeMode(),this.mode===`localPool`&&(this.channel=B(),setImmediate(()=>{this.getChannel().notify(o.ready,{pid:process.pid,runtimeMode:L.localPool,startedAt:Date.now()})})),this.mode===`dev`&&(this.channel=se().pluginChannel,setImmediate(()=>{this.getChannel().notify(o.ready,{pid:process.pid,runtimeMode:`dev`,startedAt:Date.now()})}))}constructor(){this.init()}};function se(){let e=globalThis.__FASTGPT_PLUGIN_LOCAL_DEBUG_RUNTIME__;if(!e)throw Error(`Local debug runtime is not initialized. Set it before importing the plugin.`);return e}function ce(e){return e}var Q=class t extends oe{toolHandlers=new Map;childManifests=new Map;secretSchema=e.record(e.string(),e.unknown());constructor(e){super(),this.userToolManifest=e,this.mode&&this.getChannel().setRequestHandler(async e=>{if(e.method===u.request&&e.params.eventName===`run`)try{let{input:t,systemVar:n,childId:r,secrets:i}=e.params.payload,o=this.toolHandlers.get(r??`tool`);if(!o)throw Error(`No tool registered`);let s=a.create();return(async()=>{try{let r=await o.handler(t,{systemVar:n,secrets:i,invoke:new M(this.getChannel(),{invocationId:e.traceId}),streamResponse:e=>{s.send({type:`stream`,data:e})}});s.send({type:`response`,data:r})}catch(e){s.send({data:b(e,`Unknown error during tool execution`),type:`error`})}finally{s.end()}})(),this.getChannel().createReply(void 0,{output:s})}catch(e){let t=a.create();return t.write({data:b(e,`Unknown error during tool execution`),type:`error`}),t.end(),this.getChannel().createReply(void 0,{output:t})}})}setSecretSchema(e){this.secretSchema=e}registerTool(e,t=`tool`,n){this.toolHandlers.set(t,e),n&&this.childManifests.set(t,n)}static getInstance(e){return new t(e)}getSecretSchema(){return this.secretSchema}getToolHandler(e=`tool`){return this.toolHandlers.get(e)}getUserToolManifest(){return this.userToolManifest}getChildManifests(){return[...this.childManifests.values()]}};const le=({manifest:t,handler:n})=>{let r=Q.getInstance(t);return r.setSecretSchema(n.secretSchema??e.object()),r.registerTool(n),r},$=({manifest:t,children:n,secretSchema:r})=>{let i=Q.getInstance(t);return n.forEach(e=>{i.registerTool(e.handler,e.id,{id:e.id,description:e.description,name:e.name,...e.icon===void 0?{}:{icon:e.icon},...e.toolDescription===void 0?{}:{toolDescription:e.toolDescription}})}),i.setSecretSchema(r??e.object()),i};export{ce as createToolHandler,le as defineTool,$ as defineToolSet};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastgpt-plugin/sdk-factory",
-  "version": "0.0.1-alpha.5",
+  "version": "0.0.1-alpha.7",
   "devDependencies": {
     "tsdown": "^0.21.10"
   },

package/skills/fastgpt-sdk-factory/SKILL.md

@@ -12,15 +12,24 @@ Use this skill when working on a FastGPT Tool Plugin that imports `@fastgpt-plug
 Plugin entry files default-export the instance returned by `defineTool()` or `defineToolSet()`.
 
 ```ts
-import { createToolHandler, defineTool } from '@fastgpt-plugin/sdk-factory';
+import {
+  createToolHandler,
+  defineTool,
+  type InputSchemaMetaType,
+  type OutputSchemaMetaType
+} from '@fastgpt-plugin/sdk-factory';
 import z from 'zod';
 
 const handler = createToolHandler({
   inputSchema: z.object({
-    text: z.string()
+    text: z.string().meta({
+      title: 'Text'
+    } satisfies InputSchemaMetaType)
   }),
   outputSchema: z.object({
-    result: z.string()
+    result: z.string().meta({
+      title: 'Result'
+    } satisfies OutputSchemaMetaType)
   }),
   handler: async (input) => ({
     result: input.text.toUpperCase()
@@ -53,6 +62,9 @@ export default defineTool({
 
 - Define handlers with `createToolHandler({ inputSchema, outputSchema, secretSchema?, handler })`.
 - Use `z.object(...)` for `inputSchema` and `outputSchema` so TypeScript can infer `input` and return types.
+- Import `InputSchemaMetaType`, `OutputSchemaMetaType`, and `SecretSchemaMetaType` from `@fastgpt-plugin/sdk-factory` when schema metadata is used.
+- Add `.meta({ ... } satisfies InputSchemaMetaType)` to input fields and `.meta({ ... } satisfies OutputSchemaMetaType)` to output fields that need UI/manifest metadata.
+- Add `.meta({ isSecret: true | false, ... } satisfies SecretSchemaMetaType)` to every `secretSchema` field; set `isSecret: true` for values that must be encrypted at rest.
 - Return an object that matches `outputSchema`; throw errors for failed operations.
 - Add `secretSchema` when plugin configuration needs secrets such as API keys.
 - Read secrets from `ctx.secrets`; the value is typed from `secretSchema`.
@@ -61,15 +73,22 @@ export default defineTool({
 
 ```ts
 const secretSchema = z.object({
-  apiKey: z.string()
+  apiKey: z.string().meta({
+    title: 'API Key',
+    isSecret: true
+  } satisfies SecretSchemaMetaType)
 });
 
 const handler = createToolHandler({
   inputSchema: z.object({
-    query: z.string()
+    query: z.string().meta({
+      title: 'Query'
+    } satisfies InputSchemaMetaType)
   }),
   outputSchema: z.object({
-    answer: z.string()
+    answer: z.string().meta({
+      title: 'Answer'
+    } satisfies OutputSchemaMetaType)
   }),
   secretSchema,
   handler: async (input, ctx) => {
@@ -112,16 +131,33 @@ Keep `pluginId`, child tool `id`, input field names, and output field names stab
 Use `defineToolSet()` for one plugin with multiple child tools. Put shared metadata in the top-level `manifest`; put each child tool's `id`, `name`, `description`, optional `icon`, optional `toolDescription`, and `handler` in `children`.
 
 ```ts
-import { createToolHandler, defineToolSet } from '@fastgpt-plugin/sdk-factory';
+import {
+  createToolHandler,
+  defineToolSet,
+  type InputSchemaMetaType,
+  type OutputSchemaMetaType,
+  type SecretSchemaMetaType
+} from '@fastgpt-plugin/sdk-factory';
 import z from 'zod';
 
 const secretSchema = z.object({
-  apiKey: z.string()
+  apiKey: z.string().meta({
+    title: 'API Key',
+    isSecret: true
+  } satisfies SecretSchemaMetaType)
 });
 
 const searchHandler = createToolHandler({
-  inputSchema: z.object({ query: z.string() }),
-  outputSchema: z.object({ items: z.array(z.string()) }),
+  inputSchema: z.object({
+    query: z.string().meta({
+      title: 'Query'
+    } satisfies InputSchemaMetaType)
+  }),
+  outputSchema: z.object({
+    items: z.array(z.string()).meta({
+      title: 'Items'
+    } satisfies OutputSchemaMetaType)
+  }),
   secretSchema,
   handler: async (input) => ({ items: [input.query] })
 });
@@ -160,17 +196,25 @@ export default defineToolSet({
 
 ## Host Invocation
 
-Use `ctx.invoke` for host capabilities. The SDK exposes `userInfo()` and `uploadFile()`. These methods return a `Result` tuple shaped as `[result, err]`; check `err` before using `result`.
+Use `ctx.invoke` for host capabilities. The SDK exposes `userInfo()` and `uploadFile()`. These methods return a `Result` tuple shaped as `[result, err]`; check `err` before using `result`. When `err` is present, throw or return that original `err` so host-side error details are preserved.
 
 ```ts
 const uploadHandler = createToolHandler({
   inputSchema: z.object({
-    content: z.string()
+    content: z.string().meta({
+      title: 'Content'
+    } satisfies InputSchemaMetaType)
   }),
   outputSchema: z.object({
-    accessURL: z.string(),
-    fileName: z.string(),
-    size: z.number()
+    accessURL: z.string().meta({
+      title: 'Access URL'
+    } satisfies OutputSchemaMetaType),
+    fileName: z.string().meta({
+      title: 'File Name'
+    } satisfies OutputSchemaMetaType),
+    size: z.number().meta({
+      title: 'Size'
+    } satisfies OutputSchemaMetaType)
   }),
   handler: async (input, { invoke }) => {
     const [result, err] = await invoke.uploadFile({
@@ -179,7 +223,10 @@ const uploadHandler = createToolHandler({
       file: Buffer.from(input.content, 'utf-8')
     });
 
-    if (err || !result) {
+    if (err) {
+      throw err;
+    }
+    if (!result) {
       throw new Error('Failed to upload file');
     }
 

package/skills/fastgpt-system-tool-development/SKILL.md

@@ -61,6 +61,9 @@ npx @fastgpt-plugin/cli pack --entry <plugin-directory> --dist <plugin-directory
 - 多个相关工具组成一个插件时使用 `defineToolSet()`。
 - 每个 handler 用 `createToolHandler()` 定义。
 - `inputSchema` 和 `outputSchema` 使用 `z.object(...)`。
+- `inputSchema` 字段使用 `.meta({ ... } satisfies InputSchemaMetaType)`。
+- `outputSchema` 字段使用 `.meta({ ... } satisfies OutputSchemaMetaType)`。
+- `secretSchema` 字段使用 `.meta({ isSecret: true | false, ... } satisfies SecretSchemaMetaType)`；需要加密存储的字段标记为 `isSecret: true`。
 - handler 返回值必须匹配 `outputSchema`。
 
 manifest 至少包含：
@@ -87,7 +90,7 @@ manifest 至少包含：
 - 用户配置的密钥、API Key、Base URL 等使用 `secretSchema` 描述，通过 `ctx.secrets` 读取。
 - 错误信息应能帮助定位问题，同时避免暴露密钥、令牌和完整上游敏感响应。
 - 需要向用户展示执行进度时使用 `ctx.streamResponse()`。
-- 需要生成文件时使用 `ctx.invoke.uploadFile()`。
+- 需要生成文件时使用 `ctx.invoke.uploadFile()`；收到 `[result, err]` 的 `err` 时保留原始 `err`，避免覆盖反向调用的宿主错误信息。
 
 ## 头像规范
 
@@ -111,15 +114,24 @@ CLI 构建时会自动扫描系统工具根目录中的头像文件，并写入
 ## 单工具模板
 
 ```ts
-import { createToolHandler, defineTool } from '@fastgpt-plugin/sdk-factory';
+import {
+  createToolHandler,
+  defineTool,
+  type InputSchemaMetaType,
+  type OutputSchemaMetaType
+} from '@fastgpt-plugin/sdk-factory';
 import z from 'zod';
 
 const handler = createToolHandler({
   inputSchema: z.object({
-    text: z.string().min(1)
+    text: z.string().min(1).meta({
+      title: 'Text'
+    } satisfies InputSchemaMetaType)
   }),
   outputSchema: z.object({
-    result: z.string()
+    result: z.string().meta({
+      title: 'Result'
+    } satisfies OutputSchemaMetaType)
   }),
   handler: async (input) => {
     return {
@@ -152,19 +164,32 @@ export default defineTool({
 ## 工具集模板
 
 ```ts
-import { createToolHandler, defineToolSet } from '@fastgpt-plugin/sdk-factory';
+import {
+  createToolHandler,
+  defineToolSet,
+  type InputSchemaMetaType,
+  type OutputSchemaMetaType,
+  type SecretSchemaMetaType
+} from '@fastgpt-plugin/sdk-factory';
 import z from 'zod';
 
 const secretSchema = z.object({
-  apiKey: z.string().min(1)
+  apiKey: z.string().min(1).meta({
+    title: 'API Key',
+    isSecret: true
+  } satisfies SecretSchemaMetaType)
 });
 
 const searchHandler = createToolHandler({
   inputSchema: z.object({
-    query: z.string().min(1)
+    query: z.string().min(1).meta({
+      title: 'Query'
+    } satisfies InputSchemaMetaType)
   }),
   outputSchema: z.object({
-    items: z.array(z.string())
+    items: z.array(z.string()).meta({
+      title: 'Items'
+    } satisfies OutputSchemaMetaType)
   }),
   secretSchema,
   handler: async (input, ctx) => {