@isdk/ai-tool 0.6.0 → 0.7.1

package/docs/api/interfaces/AIChatUserMessageParam.md

@@ -0,0 +1,137 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIChatUserMessageParam
+
+# Interface: AIChatUserMessageParam
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:70](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L70)
+
+## Extends
+
+- [`AIChatMessageParamBase`](AIChatMessageParamBase.md)
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Properties
+
+### charId?
+
+> `optional` **charId**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:77](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L77)
+
+***
+
+### content
+
+> **content**: `string` \| [`AIChatContentPart`](../type-aliases/AIChatContentPart.md)[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:72](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L72)
+
+***
+
+### createdAt?
+
+> `optional` **createdAt**: `string` \| `Date`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:74](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L74)
+
+***
+
+### from?
+
+> `optional` **from**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:79](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L79)
+
+***
+
+### private?
+
+> `optional` **private**: `boolean`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:58](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L58)
+
+#### Inherited from
+
+[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`private`](AIChatMessageParamBase.md#private)
+
+***
+
+### replies?
+
+> `optional` **replies**: `Record`\<`string`, `Partial`\<[`AIChatMessageParam`](../type-aliases/AIChatMessageParam.md)\>\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:57](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L57)
+
+#### Inherited from
+
+[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`replies`](AIChatMessageParamBase.md#replies)
+
+***
+
+### role
+
+> **role**: `"user"`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:71](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L71)
+
+#### Overrides
+
+[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`role`](AIChatMessageParamBase.md#role)
+
+***
+
+### templateFormat?
+
+> `optional` **templateFormat**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:80](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L80)
+
+***
+
+### thinking?
+
+> `optional` **thinking**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:60](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L60)
+
+#### Inherited from
+
+[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`thinking`](AIChatMessageParamBase.md#thinking)
+
+***
+
+### tools?
+
+> `optional` **tools**: `Record`\<`string`, `string`\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:59](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L59)
+
+#### Inherited from
+
+[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`tools`](AIChatMessageParamBase.md#tools)
+
+***
+
+### toRole?
+
+> `optional` **toRole**: `string` \| `string`[] \| `Record`\<`string`, `Partial`\<[`AIChatMessageParam`](../type-aliases/AIChatMessageParam.md)\>\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:56](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L56)
+
+#### Inherited from
+
+[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`toRole`](AIChatMessageParamBase.md#torole)
+
+***
+
+### updatedAt?
+
+> `optional` **updatedAt**: `string` \| `Date`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:75](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L75)

package/docs/api/interfaces/AIChoiceConfig.md

@@ -0,0 +1,65 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIChoiceConfig
+
+# Interface: AIChoiceConfig
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:9](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/parse-command.ts#L9)
+
+## Properties
+
+### end?
+
+> `optional` **end**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:16](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/parse-command.ts#L16)
+
+***
+
+### items?
+
+> `optional` **items**: `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:10](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/parse-command.ts#L10)
+
+***
+
+### maxPick?
+
+> `optional` **maxPick**: `number`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:11](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/parse-command.ts#L11)
+
+***
+
+### minPick?
+
+> `optional` **minPick**: `number`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:12](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/parse-command.ts#L12)
+
+***
+
+### prefix?
+
+> `optional` **prefix**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:14](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/parse-command.ts#L14)
+
+***
+
+### separator?
+
+> `optional` **separator**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:13](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/parse-command.ts#L13)
+
+***
+
+### type?
+
+> `optional` **type**: `"ai"` \| `"random"`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:15](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/parse-command.ts#L15)

package/docs/api/interfaces/AIResult.md

@@ -0,0 +1,65 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIResult
+
+# Interface: AIResult\<TValue, TOptions\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:16](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L16)
+
+## Type Parameters
+
+• **TValue** = `any`
+
+• **TOptions** = `any`
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Properties
+
+### content?
+
+> `optional` **content**: `TValue`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:20](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L20)
+
+The generated value.
+
+***
+
+### finishReason?
+
+> `optional` **finishReason**: `null` \| `"length"` \| `"abort"` \| `"stop"` \| `"content_filter"` \| `"tool_calls"` \| `"function_call"` \| `"error"` \| `"other"`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:25](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L25)
+
+The reason why the generation stopped.
+
+***
+
+### options?
+
+> `optional` **options**: `TOptions`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:26](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L26)
+
+***
+
+### stop?
+
+> `optional` **stop**: `boolean`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:30](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L30)
+
+for stream mode
+
+***
+
+### taskId?
+
+> `optional` **taskId**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:31](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L31)

package/docs/{interfaces → api/interfaces}/AIStreamParser.md

@@ -6,7 +6,7 @@
 
 # Interface: AIStreamParser()\<T, TOptions\>
 
-Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:25](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/stream/ai-stream.ts#L25)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/ai-stream.ts:25](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/stream/ai-stream.ts#L25)
 
 Custom parser for AIStream data.
 
@@ -18,7 +18,7 @@ Custom parser for AIStream data.
 
 > **AIStreamParser**(`data`, `options`): `void` \| [`AIResult`](AIResult.md)\<`T`, `TOptions`\>
 
-Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:26](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/stream/ai-stream.ts#L26)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/ai-stream.ts:26](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/stream/ai-stream.ts#L26)
 
 Custom parser for AIStream data.
 

package/docs/api/interfaces/AIStreamParserOptions.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIStreamParserOptions
+
+# Interface: AIStreamParserOptions
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/ai-stream.ts:14](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/stream/ai-stream.ts#L14)
+
+Options for the AIStreamParser.
+
+## Properties
+
+### event?
+
+> `optional` **event**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/ai-stream.ts:15](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/stream/ai-stream.ts#L15)
+
+The event (type) from the server side event stream.

package/docs/api/interfaces/BaseFunc.md

@@ -0,0 +1,299 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / BaseFunc
+
+# Interface: BaseFunc
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:196](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L196)
+
+Represents a fully-defined tool function where the implementation is mandatory.
+
+## Extends
+
+- [`BaseFuncItem`](BaseFuncItem.md)
+
+## Extended by
+
+- [`ToolFunc`](../classes/ToolFunc.md)
+
+## Properties
+
+### alias?
+
+> `optional` **alias**: `string` \| `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L130)
+
+Optional aliases for the function name.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`alias`](BaseFuncItem.md#alias)
+
+***
+
+### asyncFeatures?
+
+> `optional` **asyncFeatures**: `number`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L144)
+
+A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
+This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
+
+#### See
+
+AsyncFeatureBits from `@src/utils/cancelable-ability.ts`
+
+#### Example
+
+```ts
+import { AsyncFeatures } from './utils';
+const func = new ToolFunc({
+  name: 'cancellableTask',
+  asyncFeatures: AsyncFeatures.Cancelable | AsyncFeatures.MultiTask,
+  // ...
+});
+```
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`asyncFeatures`](BaseFuncItem.md#asyncfeatures)
+
+***
+
+### depends?
+
+> `optional` **depends**: `object`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L167)
+
+A map of dependencies this function has on other tool functions.
+Declaring dependencies ensures that they are automatically registered when this function is registered.
+This is crucial for building modular functions that rely on each other without needing to manage registration order manually.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`ToolFunc`](../classes/ToolFunc.md)
+
+#### Example
+
+```ts
+const helperFunc = new ToolFunc({ name: 'helper', func: () => 'world' });
+const mainFunc = new ToolFunc({
+  name: 'main',
+  depends: {
+    helper: helperFunc,
+  },
+  func() {
+    // We can now safely run the dependency
+    const result = this.runSync('helper');
+    return `Hello, ${result}`;
+  }
+});
+// When mainFunc is registered, helperFunc will be registered automatically.
+mainFunc.register();
+```
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`depends`](BaseFuncItem.md#depends)
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L172)
+
+A detailed description of what the function does.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`description`](BaseFuncItem.md#description)
+
+***
+
+### isApi?
+
+> `optional` **isApi**: `boolean`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L119)
+
+If true, indicates that this function should be treated as a server-side API.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`isApi`](BaseFuncItem.md#isapi)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L76)
+
+The unique name of the function.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name-2)
+
+***
+
+### params?
+
+> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L81)
+
+Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`params`](BaseFuncItem.md#params)
+
+***
+
+### result?
+
+> `optional` **result**: `string` \| `Record`\<`string`, `any`\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L86)
+
+The expected return type of the function, described as a string or a JSON schema object.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`result`](BaseFuncItem.md#result)
+
+***
+
+### scope?
+
+> `optional` **scope**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L91)
+
+The execution scope or context (`this`) for the function.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`scope`](BaseFuncItem.md#scope)
+
+***
+
+### setup()?
+
+> `optional` **setup**: (`this`, `options`?) => `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L114)
+
+A lifecycle hook called once during the `ToolFunc` instance's initialization.
+It allows for initial setup, state configuration, or property modification on the instance
+before it is used or registered. The `this` context is the `ToolFunc` instance itself.
+
+#### Parameters
+
+##### this
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+##### options?
+
+[`FuncItem`](FuncItem.md)
+
+The configuration options for the function.
+
+#### Returns
+
+`void`
+
+#### Example
+
+```ts
+const myFunc = new ToolFunc({
+  name: 'myFunc',
+  customState: 'initial',
+  setup() {
+    // `this` is the myFunc instance
+    this.customState = 'configured';
+  }
+});
+console.log(myFunc.customState); // Outputs: 'configured'
+```
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`setup`](BaseFuncItem.md#setup)
+
+***
+
+### stream?
+
+> `optional` **stream**: `boolean`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L125)
+
+If true, indicates that the function has the *capability* to stream its output.
+Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`stream`](BaseFuncItem.md#stream)
+
+***
+
+### tags?
+
+> `optional` **tags**: `string` \| `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L96)
+
+Tags for grouping or filtering functions.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`tags`](BaseFuncItem.md#tags)
+
+***
+
+### title?
+
+> `optional` **title**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L177)
+
+A concise, human-readable title for the function, often used in UI or by AI.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`title`](BaseFuncItem.md#title)
+
+## Methods
+
+### func()
+
+> **func**(...`params`): `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:202](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L202)
+
+The actual function implementation.
+
+#### Parameters
+
+##### params
+
+...`any`
+
+The parameters for the function.
+
+#### Returns
+
+`any`
+
+The result of the function.