@isdk/ai-tool 0.2.0 → 0.2.1

package/docs/enumerations/AsyncFeatureBits.md

@@ -0,0 +1,37 @@
+[**@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/5f9f0083c734722103ff5468e424b48c212a55f0/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/5f9f0083c734722103ff5468e424b48c212a55f0/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/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L14)

package/docs/enumerations/AsyncFeatures.md

@@ -0,0 +1,37 @@
+[**@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/5f9f0083c734722103ff5468e424b48c212a55f0/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/5f9f0083c734722103ff5468e424b48c212a55f0/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/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L21)

package/docs/enumerations/ErrorCode.md

@@ -0,0 +1,217 @@
+[**@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.1/node\_modules/@isdk/common-error/dist/index.d.ts:19
+
+***
+
+### Accepted
+
+> **Accepted**: `202`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:6
+
+***
+
+### BadGateway
+
+> **BadGateway**: `502`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:23
+
+***
+
+### BadRequest
+
+> **BadRequest**: `400`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:7
+
+***
+
+### Conflict
+
+> **Conflict**: `409`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:16
+
+***
+
+### Corruption
+
+> **Corruption**: `409`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:17
+
+***
+
+### Forbidden
+
+> **Forbidden**: `403`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:11
+
+***
+
+### GatewayTimeout
+
+> **GatewayTimeout**: `504`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:25
+
+***
+
+### InternalError
+
+> **InternalError**: `500`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:20
+
+***
+
+### InvalidArgument
+
+> **InvalidArgument**: `400`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:8
+
+***
+
+### MethodNotAllowed
+
+> **MethodNotAllowed**: `405`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:13
+
+***
+
+### NotAcceptable
+
+> **NotAcceptable**: `406`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:14
+
+***
+
+### NotFound
+
+> **NotFound**: `404`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:12
+
+***
+
+### NotImplemented
+
+> **NotImplemented**: `501`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:21
+
+***
+
+### NotSupported
+
+> **NotSupported**: `501`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:22
+
+***
+
+### OK
+
+> **OK**: `200`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:5
+
+***
+
+### PaymentRequired
+
+> **PaymentRequired**: `402`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:10
+
+***
+
+### RequestTimeout
+
+> **RequestTimeout**: `408`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:15
+
+***
+
+### ServiceUnavailable
+
+> **ServiceUnavailable**: `503`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:24
+
+***
+
+### TooManyRequests
+
+> **TooManyRequests**: `429`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:18
+
+***
+
+### Unauthorized
+
+> **Unauthorized**: `401`
+
+#### Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:9

package/docs/enumerations/XXHashAlgorithm.md

@@ -0,0 +1,27 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / XXHashAlgorithm
+
+# Enumeration: XXHashAlgorithm
+
+## Enumeration Members
+
+### xxhash32
+
+> **xxhash32**: `112`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/hash/xxhash.ts:27](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/hash/xxhash.ts#L27)
+
+***
+
+### xxhash64
+
+> **xxhash64**: `111`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/hash/xxhash.ts:26](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/hash/xxhash.ts#L26)

package/docs/functions/AIArgProcessor.md

@@ -0,0 +1,27 @@
+[**@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:137](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/parse-command.ts#L137)

package/docs/functions/AIStream.md

@@ -0,0 +1,50 @@
+[**@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/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/stream/ai-stream.ts#L122)

package/docs/functions/ChoiceArgProcessor.md

@@ -0,0 +1,27 @@
+[**@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:105](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/parse-command.ts#L105)

package/docs/functions/RateLimit.md

@@ -0,0 +1,33 @@
+[**@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/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/async-semaphore.ts#L347)

package/docs/functions/TemplateArgProcessor.md

@@ -0,0 +1,27 @@
+[**@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:112](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/parse-command.ts#L112)

package/docs/functions/backendEventable.md

@@ -0,0 +1,23 @@
+[**@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/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/event/event-ability.ts#L80)

package/docs/functions/canonicalize.md

@@ -0,0 +1,21 @@
+[**@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/countRegexMatches.md

@@ -0,0 +1,33 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / countRegexMatches
+
+# Function: countRegexMatches()
+
+> **countRegexMatches**(`content`, `regex`): `number`
+
+Counts the number of matches for a given regular expression in a specified string.
+This function ensures that the regular expression is used globally by adding the 'g' flag,
+if it is not already present.
+
+## Parameters
+
+• **content**: `string`
+
+The string to search within.
+
+• **regex**: `RegExp`
+
+The regular expression to use for matching.
+
+## Returns
+
+`number`
+
+The total number of matches found.
+
+## Defined in
+
+[packages/ai-tool/src/utils/count-regex-matches.ts:10](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/count-regex-matches.ts#L10)

package/docs/functions/createAbilityInjector.md

@@ -0,0 +1,87 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / createAbilityInjector
+
+# Function: createAbilityInjector()
+
+## createAbilityInjector(abilityClass, isGetClassFunc, injectorOpts)
+
+> **createAbilityInjector**(`abilityClass`, `isGetClassFunc`?, `injectorOpts`?): `AbilityFn`
+
+### Parameters
+
+• **abilityClass**: `Function`
+
+• **isGetClassFunc?**: `boolean`
+
+• **injectorOpts?**: `AbilityInjectorOptions`
+
+### Returns
+
+`AbilityFn`
+
+### Defined in
+
+node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:29
+
+## createAbilityInjector(abilityClass, aCoreMethod, isGetClassFunc, injectorOpts)
+
+> **createAbilityInjector**(`abilityClass`, `aCoreMethod`?, `isGetClassFunc`?, `injectorOpts`?): `AbilityFn`
+
+### Parameters
+
+• **abilityClass**: `Function`
+
+• **aCoreMethod?**: `string` \| `string`[]
+
+• **isGetClassFunc?**: `boolean`
+
+• **injectorOpts?**: `AbilityInjectorOptions`
+
+### Returns
+
+`AbilityFn`
+
+### Defined in
+
+node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:30
+
+## createAbilityInjector(abilityClass, aCoreMethod, injectorOpts)
+
+> **createAbilityInjector**(`abilityClass`, `aCoreMethod`?, `injectorOpts`?): `AbilityFn`
+
+### Parameters
+
+• **abilityClass**: `Function`
+
+• **aCoreMethod?**: `string` \| `string`[]
+
+• **injectorOpts?**: `AbilityInjectorOptions`
+
+### Returns
+
+`AbilityFn`
+
+### Defined in
+
+node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:31
+
+## createAbilityInjector(abilityClass, injectorOpts)
+
+> **createAbilityInjector**(`abilityClass`, `injectorOpts`?): `AbilityFn`
+
+### Parameters
+
+• **abilityClass**: `Function`
+
+• **injectorOpts?**: `AbilityInjectorOptions`
+
+### Returns
+
+`AbilityFn`
+
+### Defined in
+
+node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:32

package/docs/functions/createCallbacksTransformer.md

@@ -0,0 +1,49 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / createCallbacksTransformer
+
+# Function: createCallbacksTransformer()
+
+> **createCallbacksTransformer**\<`I`, `O`\>(`cb`): `TransformStream`\<`I`, `O`\>
+
+Creates a transform stream that invokes optional callback functions.
+The transform stream uses the provided callbacks to execute custom logic at different stages of the stream's lifecycle.
+- `onStart`: Called once when the stream is initialized.
+- `onTransform`: Called for each tokenized message.
+- `onCompletion`: Called every time an AIStream completion message is received. This can occur multiple times when using e.g. OpenAI functions
+- `onFinal`: Called once when the stream is closed with the final completion message.
+
+This function is useful when you want to process a stream of messages and perform specific actions during the stream's lifecycle.
+
+## Type Parameters
+
+• **I** = `any`
+
+• **O** = `any`
+
+## Parameters
+
+• **cb**: `undefined` \| [`StreamCallbacksAndOptions`](../interfaces/StreamCallbacksAndOptions.md)\<`I`, `O`\>
+
+## Returns
+
+`TransformStream`\<`I`, `O`\>
+
+A transform stream that encodes input messages as Uint8Array and allows the execution of custom logic through callbacks.
+
+## Example
+
+```ts
+const callbacks = {
+  onStart: async () => console.log('Stream started'),
+  onTransform: async (chunk) => console.log('Token:',chunk),
+  onFinal: async () => data.close()
+};
+const transformer = createCallbacksTransformer(callbacks);
+```
+
+## Defined in
+
+[packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:36](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/stream/create-callbacks-stream.ts#L36)