@isdk/ai-tool 0.3.0 → 0.5.0

package/docs/classes/YamlTypeBaseObject.md

@@ -1,29 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / YamlTypeBaseObject
-
-# Class: YamlTypeBaseObject
-
-## Indexable
-
- \[`name`: `string`\]: `any`
-
-## Constructors
-
-### new YamlTypeBaseObject()
-
-> **new YamlTypeBaseObject**(`options`?): [`YamlTypeBaseObject`](YamlTypeBaseObject.md)
-
-#### Parameters
-
-• **options?**: `any`
-
-#### Returns
-
-[`YamlTypeBaseObject`](YamlTypeBaseObject.md)
-
-#### Defined in
-
-[packages/ai-tool/src/utils/yaml-type-base-object.ts:5](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/yaml-type-base-object.ts#L5)

package/docs/enumerations/AsyncFeatureBits.md

@@ -1,37 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / AsyncFeatureBits
-
-# Enumeration: AsyncFeatureBits
-
-## Enumeration Members
-
-### Cancelable
-
-> **Cancelable**: `1`
-
-#### Defined in
-
-[packages/ai-tool/src/tool-func.ts:13](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L13)
-
-***
-
-### MultiTask
-
-> **MultiTask**: `0`
-
-#### Defined in
-
-[packages/ai-tool/src/tool-func.ts:12](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L12)
-
-***
-
-### Priority
-
-> **Priority**: `2`
-
-#### Defined in
-
-[packages/ai-tool/src/tool-func.ts:14](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L14)

package/docs/enumerations/AsyncFeatures.md

@@ -1,37 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / AsyncFeatures
-
-# Enumeration: AsyncFeatures
-
-## Enumeration Members
-
-### Cancelable
-
-> **Cancelable**: `2`
-
-#### Defined in
-
-[packages/ai-tool/src/tool-func.ts:20](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L20)
-
-***
-
-### MultiTask
-
-> **MultiTask**: `1`
-
-#### Defined in
-
-[packages/ai-tool/src/tool-func.ts:19](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L19)
-
-***
-
-### Priority
-
-> **Priority**: `4`
-
-#### Defined in
-
-[packages/ai-tool/src/tool-func.ts:21](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L21)

package/docs/enumerations/ErrorCode.md

@@ -1,217 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / ErrorCode
-
-# Enumeration: ErrorCode
-
-## Enumeration Members
-
-### Aborted
-
-> **Aborted**: `499`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:19
-
-***
-
-### Accepted
-
-> **Accepted**: `202`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:6
-
-***
-
-### BadGateway
-
-> **BadGateway**: `502`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:23
-
-***
-
-### BadRequest
-
-> **BadRequest**: `400`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:7
-
-***
-
-### Conflict
-
-> **Conflict**: `409`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:16
-
-***
-
-### Corruption
-
-> **Corruption**: `409`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:17
-
-***
-
-### Forbidden
-
-> **Forbidden**: `403`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:11
-
-***
-
-### GatewayTimeout
-
-> **GatewayTimeout**: `504`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:25
-
-***
-
-### InternalError
-
-> **InternalError**: `500`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:20
-
-***
-
-### InvalidArgument
-
-> **InvalidArgument**: `400`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:8
-
-***
-
-### MethodNotAllowed
-
-> **MethodNotAllowed**: `405`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:13
-
-***
-
-### NotAcceptable
-
-> **NotAcceptable**: `406`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:14
-
-***
-
-### NotFound
-
-> **NotFound**: `404`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:12
-
-***
-
-### NotImplemented
-
-> **NotImplemented**: `501`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:21
-
-***
-
-### NotSupported
-
-> **NotSupported**: `501`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:22
-
-***
-
-### OK
-
-> **OK**: `200`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:5
-
-***
-
-### PaymentRequired
-
-> **PaymentRequired**: `402`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:10
-
-***
-
-### RequestTimeout
-
-> **RequestTimeout**: `408`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:15
-
-***
-
-### ServiceUnavailable
-
-> **ServiceUnavailable**: `503`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:24
-
-***
-
-### TooManyRequests
-
-> **TooManyRequests**: `429`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:18
-
-***
-
-### Unauthorized
-
-> **Unauthorized**: `401`
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:9

package/docs/enumerations/HashAlgorithm.md

@@ -1,117 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / HashAlgorithm
-
-# Enumeration: HashAlgorithm
-
-## Enumeration Members
-
-### md5
-
-> **md5**: `1`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/hash/xxhash.ts:27](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L27)
-
-***
-
-### ripemd
-
-> **ripemd**: `3`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/hash/xxhash.ts:29](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L29)
-
-***
-
-### sha1
-
-> **sha1**: `2`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/hash/xxhash.ts:28](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L28)
-
-***
-
-### sha224
-
-> **sha224**: `11`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/hash/xxhash.ts:33](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L33)
-
-***
-
-### sha256
-
-> **sha256**: `8`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/hash/xxhash.ts:30](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L30)
-
-***
-
-### sha384
-
-> **sha384**: `9`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/hash/xxhash.ts:31](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L31)
-
-***
-
-### sha512
-
-> **sha512**: `10`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/hash/xxhash.ts:32](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L32)
-
-***
-
-### xxhash
-
-> **xxhash**: `111`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/hash/xxhash.ts:34](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L34)
-
-***
-
-### xxhash128
-
-> **xxhash128**: `113`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/hash/xxhash.ts:37](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L37)
-
-***
-
-### xxhash32
-
-> **xxhash32**: `112`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/hash/xxhash.ts:36](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L36)
-
-***
-
-### xxhash64
-
-> **xxhash64**: `111`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/hash/xxhash.ts:35](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L35)

package/docs/functions/AIArgProcessor.md

@@ -1,27 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / AIArgProcessor
-
-# Function: AIArgProcessor()
-
-> **AIArgProcessor**(`argInfo`, `ix`, `scope`?, `options`?): `Promise`\<`undefined` \| `string`\>
-
-## Parameters
-
-• **argInfo**: `ArgInfo`
-
-• **ix**: `number`
-
-• **scope?**: `Record`\<`string`, `any`\>
-
-• **options?**: [`ParseObjectArgumentOptions`](../interfaces/ParseObjectArgumentOptions.md)
-
-## Returns
-
-`Promise`\<`undefined` \| `string`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:141](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L141)

package/docs/functions/AIStream.md

@@ -1,50 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / AIStream
-
-# Function: AIStream()
-
-> **AIStream**\<`T`, `TOptions`\>(`response`, `customParser`?): `ReadableStream`\<[`AIResult`](../interfaces/AIResult.md)\<`T`, `TOptions`\>\>
-
-Returns a ReadableStream created from the response, parsed and handled with custom logic.
-The stream goes through two transformation stages, first parsing the events and then
-invoking the provided callbacks.
-
-For 2xx HTTP responses:
-- The function continues with standard stream processing.
-
-For non-2xx HTTP responses:
-- If the response body is defined, it asynchronously extracts and decodes the response body.
-- It then creates a custom ReadableStream to propagate a detailed error message.
-
-## Type Parameters
-
-• **T** = `any`
-
-• **TOptions** = `any`
-
-## Parameters
-
-• **response**: `Response`
-
-The response.
-
-• **customParser?**: [`AIStreamParser`](../interfaces/AIStreamParser.md)\<`T`, `TOptions`\>
-
-The custom parser function.
-
-## Returns
-
-`ReadableStream`\<[`AIResult`](../interfaces/AIResult.md)\<`T`, `TOptions`\>\>
-
-The AIStream.
-
-## Throws
-
-Will throw an error if the response is not OK.
-
-## Defined in
-
-[packages/ai-tool/src/utils/stream/ai-stream.ts:122](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/stream/ai-stream.ts#L122)

package/docs/functions/ChoiceArgProcessor.md

@@ -1,27 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / ChoiceArgProcessor
-
-# Function: ChoiceArgProcessor()
-
-> **ChoiceArgProcessor**(`argInfo`, `_ix`, `scope`?, `options`?): `undefined` \| `string`
-
-## Parameters
-
-• **argInfo**: `ArgInfo`
-
-• **\_ix**: `number`
-
-• **scope?**: `Record`\<`string`, `any`\>
-
-• **options?**: [`ParseObjectArgumentOptions`](../interfaces/ParseObjectArgumentOptions.md)
-
-## Returns
-
-`undefined` \| `string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:109](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L109)

package/docs/functions/RateLimit.md

@@ -1,33 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / RateLimit
-
-# Function: RateLimit()
-
-> **RateLimit**(`rps`, `__namedParameters`): () => `Promise`\<`void`\>
-
-Creates a rate limiter function that blocks with a promise whenever the rate limit is hit and resolves the promise once the call rate is within the limit set by rps. The second argument is optional.
-
-## Parameters
-
-• **rps**: `number`
-
-• **\_\_namedParameters** = `{}`
-
-• **\_\_namedParameters.timeUnit?**: `number` = `1000`
-
-• **\_\_namedParameters.uniformDistribution?**: `boolean` = `false`
-
-## Returns
-
-`Function`
-
-### Returns
-
-`Promise`\<`void`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/async-semaphore.ts:347](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/async-semaphore.ts#L347)

package/docs/functions/TemplateArgProcessor.md

@@ -1,27 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / TemplateArgProcessor
-
-# Function: TemplateArgProcessor()
-
-> **TemplateArgProcessor**(`__namedParameters`, `ix`, `scope`?, `options`?): `Promise`\<`undefined` \| `string`\>
-
-## Parameters
-
-• **\_\_namedParameters**: `ArgInfo`
-
-• **ix**: `number`
-
-• **scope?**: `Record`\<`string`, `any`\>
-
-• **options?**: [`ParseObjectArgumentOptions`](../interfaces/ParseObjectArgumentOptions.md)
-
-## Returns
-
-`Promise`\<`undefined` \| `string`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:116](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L116)

package/docs/functions/backendEventable.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / backendEventable
-
-# Function: backendEventable()
-
-> **backendEventable**(`targetClass`?, `options`?): `Function`
-
-## Parameters
-
-• **targetClass?**: `Function`
-
-• **options?**: `AbilityOptions`
-
-## Returns
-
-`Function`
-
-## Defined in
-
-[packages/ai-tool/src/utils/event/event-ability.ts:80](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/event-ability.ts#L80)

package/docs/functions/canonicalize.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / canonicalize
-
-# Function: canonicalize()
-
-> **canonicalize**(`obj`): `string`
-
-## Parameters
-
-• **obj**: `any`
-
-## Returns
-
-`string`
-
-## Defined in
-
-node\_modules/.pnpm/json-canonicalize@1.0.6/node\_modules/json-canonicalize/types/canonicalize.d.ts:1

package/docs/functions/completeSentences.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / completeSentences
-
-# Function: completeSentences()
-
-> **completeSentences**(`sentences`, `__namedParameters`): `string`[]
-
-## Parameters
-
-• **sentences**: `string`[]
-
-• **\_\_namedParameters**: [`SplitSentenceOptions`](../interfaces/SplitSentenceOptions.md) = `{}`
-
-## Returns
-
-`string`[]
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:123](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L123)

package/docs/functions/concatText.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / concatText
-
-# Function: concatText()
-
-> **concatText**(`left`, `right`): `string`
-
-## Parameters
-
-• **left**: `string`
-
-• **right**: `string`
-
-## Returns
-
-`string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:168](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L168)