@isdk/ai-tool 0.6.0 → 0.7.0

package/docs/api/variables/RemoteToolFuncSchema.md

@@ -0,0 +1,84 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / RemoteToolFuncSchema
+
+# Variable: RemoteToolFuncSchema
+
+> `const` **RemoteToolFuncSchema**: `object`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:40](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L40)
+
+**`Internal`**
+
+A schema object defining properties common to all remote tool functions.
+This is used by `AdvancePropertyManager` to define how these properties are handled.
+
+## Type declaration
+
+### action
+
+> **action**: `object`
+
+The action for the remote call. This is primarily interpreted as an RPC method name.
+For HTTP transports, it defaults to being sent as a custom RPC method name (e.g., via POST).
+Only specific RESTful server implementations might map certain 'action' values (like 'get', 'delete')
+to corresponding HTTP methods. Defaults to 'post'.
+
+#### action.type
+
+> **type**: `string` = `'string'`
+
+#### action.assign()
+
+##### Parameters
+
+###### value
+
+`"get"` | `"post"` | `"put"` | `"delete"` | `"patch"` | `"list"` | `"res"`
+
+###### dest
+
+`any`
+
+###### src?
+
+`any`
+
+###### name?
+
+`string`
+
+###### options?
+
+`any`
+
+##### Returns
+
+`"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
+
+### allowExportFunc
+
+> **allowExportFunc**: `object`
+
+If true, allows the function's body to be exported to the client for local execution.
+This is a server-side setting.
+
+#### allowExportFunc.type
+
+> **type**: `string` = `'boolean'`
+
+### ~~fetchOptions~~
+
+> **fetchOptions**: `object`
+
+Optional fetch options, primarily for use with HTTP-based transports.
+
+#### Deprecated
+
+Use `transport` instead.
+
+#### fetchOptions.type
+
+> **type**: `string` = `'object'`

package/docs/api/variables/ResponseRStreamErrCode.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ResponseRStreamErrCode
+
+# Variable: ResponseRStreamErrCode
+
+> `const` **ResponseRStreamErrCode**: `601` = `601`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/error-readable-stream.ts:4](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/stream/error-readable-stream.ts#L4)

package/docs/{variables → api/variables}/SHUTDOWN_SIGNALS.md

@@ -8,7 +8,7 @@
 
 > `const` **SHUTDOWN\_SIGNALS**: `string`[]
 
-Defined in: [packages/ai-tool/src/utils/node/before-shutdown.ts:21](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/node/before-shutdown.ts#L21)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/node/before-shutdown.ts:21](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/node/before-shutdown.ts#L21)
 
 System signals the app will listen to initiate shutdown.
 

package/docs/{variables → api/variables}/SSEChannelAlreadyClosedErrCode.md

@@ -8,4 +8,4 @@
 
 > `const` **SSEChannelAlreadyClosedErrCode**: `498` = `498`
 
-Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:17](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/event/sse-channel.ts#L17)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/event/sse-channel.ts:33](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/event/sse-channel.ts#L33)

package/docs/api/variables/SecondaryCache.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / SecondaryCache
+
+# Variable: SecondaryCache
+
+> `const` **SecondaryCache**: *typeof* `Cache` = `_Cache`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/lrucache.ts:6](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/lrucache.ts#L6)

package/docs/api/variables/ServerToolFuncSchema.md

@@ -0,0 +1,83 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ServerToolFuncSchema
+
+# Variable: ServerToolFuncSchema
+
+> `const` **ServerToolFuncSchema**: `object`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:119](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L119)
+
+**`Internal`**
+
+The schema definition for `ServerTools` properties.
+
+## Type declaration
+
+### action
+
+> **action**: `object`
+
+The action for the remote call. This is primarily interpreted as an RPC method name.
+For HTTP transports, it defaults to being sent as a custom RPC method name (e.g., via POST).
+Only specific RESTful server implementations might map certain 'action' values (like 'get', 'delete')
+to corresponding HTTP methods. Defaults to 'post'.
+
+#### action.type
+
+> **type**: `string` = `'string'`
+
+#### action.assign()
+
+##### Parameters
+
+###### value
+
+`"get"` | `"post"` | `"put"` | `"delete"` | `"patch"` | `"list"` | `"res"`
+
+###### dest
+
+`any`
+
+###### src?
+
+`any`
+
+###### name?
+
+`string`
+
+###### options?
+
+`any`
+
+##### Returns
+
+`"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
+
+### allowExportFunc
+
+> **allowExportFunc**: `object`
+
+If true, allows the function's body to be exported to the client for local execution.
+This is a server-side setting.
+
+#### allowExportFunc.type
+
+> **type**: `string` = `'boolean'`
+
+### ~~fetchOptions~~
+
+> **fetchOptions**: `object`
+
+Optional fetch options, primarily for use with HTTP-based transports.
+
+#### Deprecated
+
+Use `transport` instead.
+
+#### fetchOptions.type
+
+> **type**: `string` = `'object'`

package/docs/api/variables/StrangeHumanName.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / StrangeHumanName
+
+# Variable: StrangeHumanName
+
+> `const` **StrangeHumanName**: `"陌生人"` = `'陌生人'`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:44](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L44)

package/docs/api/variables/ToolAsyncCancelableBit.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ToolAsyncCancelableBit
+
+# Variable: ToolAsyncCancelableBit
+
+> `const` **ToolAsyncCancelableBit**: `1` = `1`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:11](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L11)

package/docs/api/variables/ToolAsyncMultiTaskBit.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ToolAsyncMultiTaskBit
+
+# Variable: ToolAsyncMultiTaskBit
+
+> `const` **ToolAsyncMultiTaskBit**: `0` = `0`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:10](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L10)

package/docs/api/variables/ToolAsyncPriorityBit.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ToolAsyncPriorityBit
+
+# Variable: ToolAsyncPriorityBit
+
+> `const` **ToolAsyncPriorityBit**: `2` = `2`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:12](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L12)

package/docs/{variables → api/variables}/ToolFuncSchema.md

@@ -8,7 +8,12 @@
 
 > `const` **ToolFuncSchema**: `object`
 
-Defined in: [packages/ai-tool/src/tool-func.ts:363](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L363)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:821](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L821)
+
+**`Internal`**
+
+Defines the schema for `ToolFunc` properties, used by `AdvancePropertyManager`.
+This controls how properties are assigned and exported.
 
 ## Type declaration
 
@@ -139,3 +144,11 @@ Defined in: [packages/ai-tool/src/tool-func.ts:363](https://github.com/isdk/ai-t
 #### tags.type
 
 > **type**: `string`[]
+
+### title
+
+> **title**: `object`
+
+#### title.type
+
+> **type**: `string` = `'string'`

package/docs/{variables → api/variables}/WindowsReservedNameRegex.md

@@ -8,6 +8,6 @@
 
 > `const` **WindowsReservedNameRegex**: `RegExp`
 
-Defined in: node\_modules/.pnpm/@isdk+util@0.3.0/node\_modules/@isdk/util/dist/index.d.ts:352
+Defined in: @isdk/util/dist/index.d.ts:379
 
 Regular expression pattern for reserved names on Windows systems.

package/docs/api/variables/base32768.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / base32768
+
+# Variable: base32768
+
+> `const` **base32768**: `__module` = `_base32768`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:7](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/hash/hash.ts#L7)

package/docs/{variables → api/variables}/defaultTemplateFormat.md

@@ -8,4 +8,4 @@
 
 > `const` **defaultTemplateFormat**: `"default"` = `"default"`
 
-Defined in: packages/template-engines/dist/index.d.ts:12
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:12

package/docs/api/variables/event.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / event
+
+# Variable: event
+
+> `const` **event**: [`EventToolFunc`](../classes/EventToolFunc.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:21](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event.ts#L21)

package/docs/api/variables/eventClient.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / eventClient
+
+# Variable: eventClient
+
+> `const` **eventClient**: [`EventClient`](../classes/EventClient.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:187](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-client.ts#L187)

package/docs/api/variables/eventServer.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / eventServer
+
+# Variable: eventServer
+
+> `const` **eventServer**: [`EventServer`](../classes/EventServer.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:150](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L150)

package/docs/api/variables/lrucache.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / lrucache
+
+# Variable: lrucache
+
+> `const` **lrucache**: [`ToolFunc`](../classes/ToolFunc.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/lrucache.ts:42](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/lrucache.ts#L42)

package/docs/{variables → api/variables}/mimeType.md

@@ -8,4 +8,4 @@
 
 > `const` **mimeType**: `MimeType`
 
-Defined in: node\_modules/.pnpm/mime-type@5.0.0/node\_modules/mime-type/src/with-db.d.ts:3
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/mime-type@5.0.3/node\_modules/mime-type/src/with-db.d.ts:3

package/docs/{variables → api/variables}/uuidNIL.md

@@ -8,4 +8,4 @@
 
 > `const` **uuidNIL**: `"00000000-0000-0000-0000-000000000000"`
 
-Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/nil.d.ts:1
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/uuid@11.1.0/node\_modules/uuid/dist/esm-browser/nil.d.ts:1