@isdk/ai-tool 0.8.2 → 0.9.0

package/docs/api/variables/PATH_IDENTIFIER_REGEX.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / PATH\_IDENTIFIER\_REGEX
+
+# Variable: PATH\_IDENTIFIER\_REGEX
+
+> `const` **PATH\_IDENTIFIER\_REGEX**: `RegExp`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/command-parser/utils.ts:26](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/command-parser/utils.ts#L26)
+
+Regex for dot-separated path identifiers (e.g., test.a.b).

package/docs/api/variables/RESERVED_WORDS.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / RESERVED\_WORDS
+
+# Variable: RESERVED\_WORDS
+
+> `const` **RESERVED\_WORDS**: `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/command-parser/utils.ts:15](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/command-parser/utils.ts#L15)
+
+List of JS reserved words used to filter identifiers that should not be automatically mapped to names.

package/docs/api/variables/RStreamErrCode.md

@@ -8,4 +8,4 @@
 
 > `const` **RStreamErrCode**: `600` = `600`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/error-readable-stream.ts:3](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/stream/error-readable-stream.ts#L3)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/error-readable-stream.ts:3](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/stream/error-readable-stream.ts#L3)

package/docs/api/variables/RemoteToolFuncSchema.md

@@ -8,7 +8,7 @@
 
 > `const` **RemoteToolFuncSchema**: `object`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:40](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/consts.ts#L40)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:20
 
 **`Internal`**
 
@@ -28,7 +28,7 @@ to corresponding HTTP methods. Defaults to 'post'.
 
 #### action.type
 
-> **type**: `string` = `'string'`
+> **type**: `string`
 
 #### action.assign()
 
@@ -69,7 +69,18 @@ This is a server-side setting.
 
 #### allowExportFunc.type
 
-> **type**: `string` = `'boolean'`
+> **type**: `string`
+
+### expectedDuration
+
+> **expectedDuration**: `object`
+
+The expected duration of the remote call in milliseconds.
+Used for UX improvements like progress bars.
+
+#### expectedDuration.type
+
+> **type**: `string`
 
 ### ~~fetchOptions~~
 
@@ -83,4 +94,25 @@ Use `transport` instead.
 
 #### fetchOptions.type
 
-> **type**: `string` = `'object'`
+> **type**: `string`
+
+### stream
+
+> **stream**: `object`
+
+If true, indicate the tool function will return a stream.
+
+#### stream.type
+
+> **type**: `string`
+
+### timeout
+
+> **timeout**: `object`
+
+The timeout configuration for the remote call.
+Can be a number (milliseconds) or an object for fine-grained control.
+
+#### timeout.type
+
+> **type**: `string`[]

package/docs/api/variables/ResponseRStreamErrCode.md

@@ -8,4 +8,4 @@
 
 > `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/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/stream/error-readable-stream.ts#L4)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/error-readable-stream.ts:4](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/stream/error-readable-stream.ts#L4)

package/docs/api/variables/RpcMethodsClientToolSchema.md

@@ -8,7 +8,7 @@
 
 > `const` **RpcMethodsClientToolSchema**: `object`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:44](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/rpc-methods-client-tool.ts#L44)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index.d.ts:18
 
 ## Type Declaration
 
@@ -18,7 +18,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:44](
 
 #### methods.type
 
-> **type**: `string` = `'array'`
+> **type**: `string`
 
 #### methods.assign()
 

package/docs/api/variables/RpcMethodsServerToolSchema.md

@@ -8,7 +8,7 @@
 
 > `const` **RpcMethodsServerToolSchema**: `object`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:78](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/rpc-methods-server-tool.ts#L78)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index.d.ts:45
 
 ## Type Declaration
 
@@ -18,4 +18,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:78](
 
 #### methods.type
 
-> **type**: `string` = `'array'`
+> **type**: `string`

package/docs/api/variables/SHUTDOWN_SIGNALS.md

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

package/docs/api/variables/SSEChannelAlreadyClosedErrCode.md

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

package/docs/api/variables/SecondaryCache.md

@@ -8,4 +8,4 @@
 
 > `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/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/funcs/lrucache.ts#L6)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/lrucache.ts:6](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/funcs/lrucache.ts#L6)

package/docs/api/variables/ServerToolFuncSchema.md

@@ -8,7 +8,7 @@
 
 > `const` **ServerToolFuncSchema**: `object`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:119](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/server-tools.ts#L119)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:373
 
 **`Internal`**
 
@@ -20,14 +20,9 @@ The schema definition for `ServerTools` properties.
 
 > **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'`
+> **type**: `string`
 
 #### action.assign()
 
@@ -63,23 +58,38 @@ to corresponding HTTP methods. Defaults to 'post'.
 
 > **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'`
+> **type**: `string`
 
-### ~~fetchOptions~~
+### expectedDuration
 
-> **fetchOptions**: `object`
+> **expectedDuration**: `object`
 
-Optional fetch options, primarily for use with HTTP-based transports.
+#### expectedDuration.type
 
-#### Deprecated
+> **type**: `string`
 
-Use `transport` instead.
+### fetchOptions
+
+> **fetchOptions**: `object`
 
 #### fetchOptions.type
 
-> **type**: `string` = `'object'`
+> **type**: `string`
+
+### stream
+
+> **stream**: `object`
+
+#### stream.type
+
+> **type**: `string`
+
+### timeout
+
+> **timeout**: `object`
+
+#### timeout.type
+
+> **type**: `string`[]

package/docs/api/variables/StrangeHumanName.md

@@ -8,4 +8,4 @@
 
 > `const` **StrangeHumanName**: `"陌生人"` = `'陌生人'`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:44](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/chat.ts#L44)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:45](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/chat.ts#L45)

package/docs/api/variables/ToolAsyncCancelableBit.md

@@ -8,4 +8,4 @@
 
 > `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/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/cancelable-ability.ts#L11)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:93

package/docs/api/variables/ToolAsyncMultiTaskBit.md

@@ -8,4 +8,4 @@
 
 > `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/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/cancelable-ability.ts#L10)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:92

package/docs/api/variables/ToolAsyncPriorityBit.md

@@ -8,4 +8,4 @@
 
 > `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/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/cancelable-ability.ts#L12)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:94

package/docs/api/variables/ToolFuncSchema.md

@@ -8,7 +8,7 @@
 
 > `const` **ToolFuncSchema**: `object`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:821](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L821)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:936
 
 **`Internal`**
 
@@ -31,7 +31,7 @@ This controls how properties are assigned and exported.
 
 #### asyncFeatures.type
 
-> **type**: `string` = `'number'`
+> **type**: `string`
 
 ### depends
 
@@ -39,11 +39,11 @@ This controls how properties are assigned and exported.
 
 #### depends.exported
 
-> **exported**: `boolean` = `false`
+> **exported**: `boolean`
 
 #### depends.type
 
-> **type**: `string` = `'object'`
+> **type**: `string`
 
 ### description
 
@@ -51,7 +51,7 @@ This controls how properties are assigned and exported.
 
 #### description.type
 
-> **type**: `string` = `'string'`
+> **type**: `string`
 
 ### func
 
@@ -59,7 +59,7 @@ This controls how properties are assigned and exported.
 
 #### func.type
 
-> **type**: `string` = `'function'`
+> **type**: `string`
 
 #### func.assign()
 
@@ -97,7 +97,7 @@ This controls how properties are assigned and exported.
 
 #### isApi.type
 
-> **type**: `string` = `'boolean'`
+> **type**: `string`
 
 ### name
 
@@ -105,7 +105,7 @@ This controls how properties are assigned and exported.
 
 #### name.type
 
-> **type**: `string` = `'string'`
+> **type**: `string`
 
 ### params
 
@@ -113,7 +113,7 @@ This controls how properties are assigned and exported.
 
 #### params.type
 
-> **type**: `string` = `'object'`
+> **type**: `string`
 
 ### result
 
@@ -121,7 +121,7 @@ This controls how properties are assigned and exported.
 
 #### result.type
 
-> **type**: `string` = `'any'`
+> **type**: `string`
 
 ### setup
 
@@ -129,7 +129,7 @@ This controls how properties are assigned and exported.
 
 #### setup.type
 
-> **type**: `string` = `'function'`
+> **type**: `string`
 
 ### stream
 
@@ -137,7 +137,7 @@ This controls how properties are assigned and exported.
 
 #### stream.type
 
-> **type**: `string` = `'boolean'`
+> **type**: `string`
 
 ### tags
 
@@ -153,4 +153,4 @@ This controls how properties are assigned and exported.
 
 #### title.type
 
-> **type**: `string` = `'string'`
+> **type**: `string`

package/docs/api/variables/WindowsReservedNameRegex.md

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

package/docs/api/variables/backendEventable.md

@@ -4,8 +4,28 @@
 
 [@isdk/ai-tool](../globals.md) / backendEventable
 
-# Variable: backendEventable
+# Variable: backendEventable()
 
-> `const` **backendEventable**: `ClassAbilityFn`\<(`Backend`, `options?`) => *typeof* `BackendEventable`\>
+> `const` **backendEventable**: \<`T`\>(`targetClass?`, `options?`) => `T` & *typeof* `getEventableClass` & `T` *extends* (...`args`) => `any` ? `InstanceType`\<`T`\> : `T`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/event/event-ability.ts:83](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/event/event-ability.ts#L83)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/index.d.ts:31
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Function` \| (...`args`) => `any`
+
+## Parameters
+
+### targetClass?
+
+`T`
+
+### options?
+
+`custom_ability.AbilityOptions`
+
+## Returns
+
+`T` & *typeof* `getEventableClass` & `T` *extends* (...`args`) => `any` ? `InstanceType`\<`T`\> : `T`

package/docs/api/variables/base32768.md

@@ -6,6 +6,6 @@
 
 # Variable: base32768
 
-> `const` **base32768**: `__module` = `_base32768`
+> `const` **base32768**: *typeof* `_base32768`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:7](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/hash/hash.ts#L7)
+Defined in: @isdk/ai-tools/packages/hash/dist/index.d.ts:146

package/docs/api/variables/event.md

@@ -8,4 +8,4 @@
 
 > `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/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/funcs/event.ts#L21)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/index.d.ts:152

package/docs/api/variables/eventClient.md

@@ -8,4 +8,4 @@
 
 > `const` **eventClient**: [`EventClient`](../classes/EventClient.md)
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:221](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/funcs/event-client.ts#L221)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/index.d.ts:207

package/docs/api/variables/eventServer.md

@@ -8,4 +8,4 @@
 
 > `const` **eventServer**: [`EventServer`](../classes/EventServer.md)
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:198](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/funcs/event-server.ts#L198)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/index.d.ts:269

package/docs/api/variables/lrucache.md

@@ -8,4 +8,4 @@
 
 > `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/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/funcs/lrucache.ts#L42)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/lrucache.ts:42](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/funcs/lrucache.ts#L42)

package/docs/api/variables/makeToolFuncCancelable.md

@@ -4,8 +4,28 @@
 
 [@isdk/ai-tool](../globals.md) / makeToolFuncCancelable
 
-# Variable: makeToolFuncCancelable
+# Variable: makeToolFuncCancelable()
 
-> `const` **makeToolFuncCancelable**: `ClassAbilityFn`\<*typeof* [`CancelableAbility`](../classes/CancelableAbility.md)\>
+> `const` **makeToolFuncCancelable**: \<`T`\>(`targetClass?`, `options?`) => `T` & *typeof* [`CancelableAbility`](../classes/CancelableAbility.md) & `T` *extends* (...`args`) => `any` ? `InstanceType`\<`T`\> : `T` & [`CancelableAbility`](../classes/CancelableAbility.md)
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:428](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/cancelable-ability.ts#L428)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:1072
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Function` \| (...`args`) => `any`
+
+## Parameters
+
+### targetClass?
+
+`T`
+
+### options?
+
+`AbilityOptions`
+
+## Returns
+
+`T` & *typeof* [`CancelableAbility`](../classes/CancelableAbility.md) & `T` *extends* (...`args`) => `any` ? `InstanceType`\<`T`\> : `T` & [`CancelableAbility`](../classes/CancelableAbility.md)

package/docs/api/variables/wait.md

@@ -8,7 +8,7 @@
 
 > `const` **wait**: (`ms`) => `Promise`\<`void`\> = `sleep`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/wait.ts:23](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/wait.ts#L23)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/wait.ts:11](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/wait.ts#L11)
 
 Suspends execution for a specified number of milliseconds