@isdk/ai-tool 0.5.2 → 0.5.3

package/docs/classes/YamlTypeBaseObject.md

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

package/docs/enumerations/AsyncFeatureBits.md

@@ -0,0 +1,33 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AsyncFeatureBits
+
+# Enumeration: AsyncFeatureBits
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:14](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L14)
+
+## Enumeration Members
+
+### Cancelable
+
+> **Cancelable**: `1`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:16](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L16)
+
+***
+
+### MultiTask
+
+> **MultiTask**: `0`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:15](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L15)
+
+***
+
+### Priority
+
+> **Priority**: `2`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:17](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L17)

package/docs/enumerations/AsyncFeatures.md

@@ -0,0 +1,33 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AsyncFeatures
+
+# Enumeration: AsyncFeatures
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:21](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L21)
+
+## Enumeration Members
+
+### Cancelable
+
+> **Cancelable**: `2`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L23)
+
+***
+
+### MultiTask
+
+> **MultiTask**: `1`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:22](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L22)
+
+***
+
+### Priority
+
+> **Priority**: `4`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L24)

package/docs/enumerations/ErrorCode.md

@@ -0,0 +1,177 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ErrorCode
+
+# Enumeration: ErrorCode
+
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:4
+
+## 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

@@ -0,0 +1,97 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / HashAlgorithm
+
+# Enumeration: HashAlgorithm
+
+Defined in: [packages/ai-tool/src/utils/hash/const.ts:5](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/hash/const.ts#L5)
+
+## Enumeration Members
+
+### md5
+
+> **md5**: `1`
+
+Defined in: [packages/ai-tool/src/utils/hash/const.ts:6](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/hash/const.ts#L6)
+
+***
+
+### ripemd
+
+> **ripemd**: `3`
+
+Defined in: [packages/ai-tool/src/utils/hash/const.ts:8](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/hash/const.ts#L8)
+
+***
+
+### sha1
+
+> **sha1**: `2`
+
+Defined in: [packages/ai-tool/src/utils/hash/const.ts:7](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/hash/const.ts#L7)
+
+***
+
+### sha224
+
+> **sha224**: `11`
+
+Defined in: [packages/ai-tool/src/utils/hash/const.ts:12](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/hash/const.ts#L12)
+
+***
+
+### sha256
+
+> **sha256**: `8`
+
+Defined in: [packages/ai-tool/src/utils/hash/const.ts:9](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/hash/const.ts#L9)
+
+***
+
+### sha384
+
+> **sha384**: `9`
+
+Defined in: [packages/ai-tool/src/utils/hash/const.ts:10](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/hash/const.ts#L10)
+
+***
+
+### sha512
+
+> **sha512**: `10`
+
+Defined in: [packages/ai-tool/src/utils/hash/const.ts:11](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/hash/const.ts#L11)
+
+***
+
+### xxhash
+
+> **xxhash**: `111`
+
+Defined in: [packages/ai-tool/src/utils/hash/const.ts:13](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/hash/const.ts#L13)
+
+***
+
+### xxhash128
+
+> **xxhash128**: `113`
+
+Defined in: [packages/ai-tool/src/utils/hash/const.ts:16](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/hash/const.ts#L16)
+
+***
+
+### xxhash32
+
+> **xxhash32**: `112`
+
+Defined in: [packages/ai-tool/src/utils/hash/const.ts:15](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/hash/const.ts#L15)
+
+***
+
+### xxhash64
+
+> **xxhash64**: `111`
+
+Defined in: [packages/ai-tool/src/utils/hash/const.ts:14](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/hash/const.ts#L14)

package/docs/functions/AIArgProcessor.md

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

package/docs/functions/AIStream.md

@@ -0,0 +1,52 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIStream
+
+# Function: AIStream()
+
+> **AIStream**\<`T`, `TOptions`\>(`response`, `customParser`?): `ReadableStream`\<[`AIResult`](../interfaces/AIResult.md)\<`T`, `TOptions`\>\>
+
+Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:120](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/ai-stream.ts#L120)
+
+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.

package/docs/functions/ChoiceArgProcessor.md

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

package/docs/functions/ObjectArgsToArgsInfo.md

@@ -0,0 +1,29 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ObjectArgsToArgsInfo
+
+# Function: ObjectArgsToArgsInfo()
+
+> **ObjectArgsToArgsInfo**(`args`): `object`
+
+Defined in: [packages/ai-tool/src/utils/parse-command.ts:86](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/parse-command.ts#L86)
+
+## Parameters
+
+### args
+
+`any`
+
+## Returns
+
+`object`
+
+### args
+
+> **args**: `any`[]
+
+### kvArgs?
+
+> `optional` **kvArgs**: `Record`\<`string`, `any`\>

package/docs/functions/RateLimit.md

@@ -0,0 +1,37 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / RateLimit
+
+# Function: RateLimit()
+
+> **RateLimit**(`rps`, `__namedParameters`): () => `Promise`\<`void`\>
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:476](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L476)
+
+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
+
+#### timeUnit?
+
+`number` = `1000`
+
+#### uniformDistribution?
+
+`boolean` = `false`
+
+## Returns
+
+`Function`
+
+### Returns
+
+`Promise`\<`void`\>

package/docs/functions/TemplateArgProcessor.md

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

package/docs/functions/assignDirs.md

@@ -0,0 +1,33 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / assignDirs
+
+# Function: assignDirs()
+
+> **assignDirs**(`dest`, `src`): `string`[]
+
+Defined in: [packages/ai-tool/src/utils/has-directory-in.ts:48](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/has-directory-in.ts#L48)
+
+Assigns directories from the source array to the destination array if they do not already exist in the destination.
+
+## Parameters
+
+### dest
+
+`string`[]
+
+The destination array to which new directories will be added.
+
+### src
+
+`string`[]
+
+The source array containing directories to be assigned to the destination.
+
+## Returns
+
+`string`[]
+
+The updated destination array with newly assigned directories from the source.

package/docs/functions/backendEventable.md

@@ -0,0 +1,29 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / backendEventable
+
+# Function: backendEventable()
+
+> **backendEventable**\<`T`\>(`targetClass`?, `options`?): `EnhancedClass`\<`T`, (`Backend`) => *typeof* `BackendEventable`\>
+
+Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:82](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/event/event-ability.ts#L82)
+
+## Type Parameters
+
+• **T** *extends* `ClassEx`
+
+## Parameters
+
+### targetClass?
+
+`T`
+
+### options?
+
+`AbilityOptions`
+
+## Returns
+
+`EnhancedClass`\<`T`, (`Backend`) => *typeof* `BackendEventable`\>

package/docs/functions/beforeShutdown.md

@@ -0,0 +1,29 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / beforeShutdown
+
+# Function: beforeShutdown()
+
+> **beforeShutdown**(`listener`): `undefined` \| [`BeforeShutdownListener`](../type-aliases/BeforeShutdownListener.md)
+
+Defined in: [packages/ai-tool/src/utils/node/before-shutdown.ts:95](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/node/before-shutdown.ts#L95)
+
+Registers a new shutdown listener to be invoked before exiting
+the main process. Listener handlers are guaranteed to be called in the order
+they were registered.
+
+## Parameters
+
+### listener
+
+[`BeforeShutdownListener`](../type-aliases/BeforeShutdownListener.md)
+
+The shutdown listener to register.
+
+## Returns
+
+`undefined` \| [`BeforeShutdownListener`](../type-aliases/BeforeShutdownListener.md)
+
+Echoes back the supplied `listener`.