@isdk/ai-tool 0.5.2 → 0.5.4

package/docs/interfaces/AIStreamParser.md

@@ -0,0 +1,43 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIStreamParser
+
+# Interface: AIStreamParser()\<T, TOptions\>
+
+Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/stream/ai-stream.ts#L25)
+
+Custom parser for AIStream data.
+
+## Type Parameters
+
+• **T** = `any`
+
+• **TOptions** = `any`
+
+> **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/7135b3a67072644f21685b76900b7f351401749e/src/utils/stream/ai-stream.ts#L26)
+
+Custom parser for AIStream data.
+
+## Parameters
+
+### data
+
+`string`
+
+The data to be parsed.
+
+### options
+
+[`AIStreamParserOptions`](AIStreamParserOptions.md)
+
+The options for the parser.
+
+## Returns
+
+`void` \| [`AIResult`](AIResult.md)\<`T`, `TOptions`\>
+
+The parsed data or void.

package/docs/interfaces/AIStreamParserOptions.md

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

package/docs/interfaces/BaseFunc.md

@@ -0,0 +1,145 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / BaseFunc
+
+# Interface: BaseFunc
+
+Defined in: [packages/ai-tool/src/tool-func.ts:37](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L37)
+
+## Extends
+
+- [`BaseFuncItem`](BaseFuncItem.md)
+
+## Extended by
+
+- [`ToolFunc`](../classes/ToolFunc.md)
+
+## Properties
+
+### isApi?
+
+> `optional` **isApi**: `boolean`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L29)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`isApi`](BaseFuncItem.md#isapi)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L23)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name)
+
+***
+
+### params?
+
+> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L24)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`params`](BaseFuncItem.md#params)
+
+***
+
+### result?
+
+> `optional` **result**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L25)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`result`](BaseFuncItem.md#result)
+
+***
+
+### scope?
+
+> `optional` **scope**: `any`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L26)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`scope`](BaseFuncItem.md#scope)
+
+***
+
+### setup()?
+
+> `optional` **setup**: (`this`, `options`?) => `void`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L28)
+
+#### Parameters
+
+##### this
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+##### options?
+
+[`FuncItem`](FuncItem.md)
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`setup`](BaseFuncItem.md#setup)
+
+***
+
+### stream?
+
+> `optional` **stream**: `boolean`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L30)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`stream`](BaseFuncItem.md#stream)
+
+***
+
+### tags?
+
+> `optional` **tags**: `string` \| `string`[]
+
+Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L27)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`tags`](BaseFuncItem.md#tags)
+
+## Methods
+
+### func()
+
+> **func**(...`params`): `any`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:38](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L38)
+
+#### Parameters
+
+##### params
+
+...`any`
+
+#### Returns
+
+`any`

package/docs/interfaces/BaseFuncItem.md

@@ -0,0 +1,93 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / BaseFuncItem
+
+# Interface: BaseFuncItem
+
+Defined in: [packages/ai-tool/src/tool-func.ts:22](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L22)
+
+## Extended by
+
+- [`RemoteFuncItem`](RemoteFuncItem.md)
+- [`FuncItem`](FuncItem.md)
+- [`BaseFunc`](BaseFunc.md)
+
+## Properties
+
+### isApi?
+
+> `optional` **isApi**: `boolean`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L29)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L23)
+
+***
+
+### params?
+
+> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L24)
+
+***
+
+### result?
+
+> `optional` **result**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L25)
+
+***
+
+### scope?
+
+> `optional` **scope**: `any`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L26)
+
+***
+
+### setup()?
+
+> `optional` **setup**: (`this`, `options`?) => `void`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L28)
+
+#### Parameters
+
+##### this
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+##### options?
+
+[`FuncItem`](FuncItem.md)
+
+#### Returns
+
+`void`
+
+***
+
+### stream?
+
+> `optional` **stream**: `boolean`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L30)
+
+***
+
+### tags?
+
+> `optional` **tags**: `string` \| `string`[]
+
+Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L27)

package/docs/interfaces/BinarySemaphoreAcquireOptions.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / BinarySemaphoreAcquireOptions
+
+# Interface: BinarySemaphoreAcquireOptions
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:28](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L28)
+
+## Extended by
+
+- [`SemaphoreTaskItem`](SemaphoreTaskItem.md)
+
+## Indexable
+
+\[`n`: `string`\]: `any`
+
+## Properties
+
+### signal?
+
+> `optional` **signal**: `AbortSignal`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L29)

package/docs/interfaces/BinarySemaphoreOptions.md

@@ -0,0 +1,57 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / BinarySemaphoreOptions
+
+# Interface: BinarySemaphoreOptions
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:21](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L21)
+
+## Extended by
+
+- [`SemaphoreOptions`](SemaphoreOptions.md)
+
+## Properties
+
+### capacity?
+
+> `optional` **capacity**: `number`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L25)
+
+***
+
+### initFn()?
+
+> `optional` **initFn**: () => `any`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:22](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L22)
+
+#### Returns
+
+`any`
+
+***
+
+### pauseFn()?
+
+> `optional` **pauseFn**: () => `void`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L23)
+
+#### Returns
+
+`void`
+
+***
+
+### resumeFn()?
+
+> `optional` **resumeFn**: () => `void`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L24)
+
+#### Returns
+
+`void`

package/docs/interfaces/BinarySemaphoreReleaseOptions.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / BinarySemaphoreReleaseOptions
+
+# Interface: BinarySemaphoreReleaseOptions
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:33](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L33)
+
+## Extended by
+
+- [`BinarySemaphoreReleaserFunc`](BinarySemaphoreReleaserFunc.md)
+
+## Indexable
+
+\[`n`: `string`\]: `any`
+
+## Properties
+
+### token?
+
+> `optional` **token**: `any`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:34](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L34)

package/docs/interfaces/BinarySemaphoreReleaserFunc.md

@@ -0,0 +1,37 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / BinarySemaphoreReleaserFunc
+
+# Interface: BinarySemaphoreReleaserFunc()
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:38](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L38)
+
+## Extends
+
+- [`BinarySemaphoreReleaseOptions`](BinarySemaphoreReleaseOptions.md)
+
+> **BinarySemaphoreReleaserFunc**(): `void`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:39](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L39)
+
+## Returns
+
+`void`
+
+## Indexable
+
+\[`n`: `string`\]: `any`
+
+## Properties
+
+### token?
+
+> `optional` **token**: `any`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:34](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L34)
+
+#### Inherited from
+
+[`BinarySemaphoreReleaseOptions`](BinarySemaphoreReleaseOptions.md).[`token`](BinarySemaphoreReleaseOptions.md#token)

package/docs/interfaces/CancelableAbilityOptions.md

@@ -0,0 +1,113 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / CancelableAbilityOptions
+
+# Interface: CancelableAbilityOptions
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L29)
+
+## Extends
+
+- `AbilityOptions`
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Properties
+
+### asyncFeatures?
+
+> `optional` **asyncFeatures**: [`AsyncFeatures`](../enumerations/AsyncFeatures.md)
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:30](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L30)
+
+***
+
+### classMethods?
+
+> `optional` **classMethods**: `Record`\<`string`, `Function`\>
+
+Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:13
+
+#### Inherited from
+
+`AbilityOptions.classMethods`
+
+***
+
+### exclude?
+
+> `optional` **exclude**: `string` \| `string`[]
+
+Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:11
+
+#### Inherited from
+
+`AbilityOptions.exclude`
+
+***
+
+### id?
+
+> `optional` **id**: `string`
+
+Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:8
+
+#### Inherited from
+
+`AbilityOptions.id`
+
+***
+
+### include?
+
+> `optional` **include**: `string` \| `string`[]
+
+Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:10
+
+#### Inherited from
+
+`AbilityOptions.include`
+
+***
+
+### isReadyFn?
+
+> `optional` **isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:32](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L32)
+
+***
+
+### maxTaskConcurrency?
+
+> `optional` **maxTaskConcurrency**: `number`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:31](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L31)
+
+***
+
+### methods?
+
+> `optional` **methods**: `Record`\<`string`, `Function`\>
+
+Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:12
+
+#### Inherited from
+
+`AbilityOptions.methods`
+
+***
+
+### mode?
+
+> `optional` **mode**: `number`
+
+Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:9
+
+#### Inherited from
+
+`AbilityOptions.mode`