@isdk/ai-tool 0.4.0 → 0.5.0

package/docs/functions/countLLMTokens.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / countLLMTokens
-
-# Function: countLLMTokens()
-
-> **countLLMTokens**(`text`, `modelId`): `Promise`\<`number`\>
-
-## Parameters
-
-• **text**: `string`
-
-• **modelId**: `string` = `'qwen2.5'`
-
-## Returns
-
-`Promise`\<`number`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/llm-tokenizer.ts:74](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/llm-tokenizer.ts#L74)

package/docs/functions/countRegexMatches.md

@@ -1,33 +0,0 @@
-[**@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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/count-regex-matches.ts#L10)

package/docs/functions/createAbilityInjector.md

@@ -1,87 +0,0 @@
-[**@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

@@ -1,49 +0,0 @@
-[**@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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/stream/create-callbacks-stream.ts#L36)

package/docs/functions/createEmptyReadableStream.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / createEmptyReadableStream
-
-# Function: createEmptyReadableStream()
-
-> **createEmptyReadableStream**(): `ReadableStream`
-
-Creates an empty ReadableStream that immediately closes upon creation.
-This function is used as a fallback for creating a ReadableStream when the response body is null or undefined,
-ensuring that the subsequent pipeline processing doesn't fail due to a lack of a stream.
-
-## Returns
-
-`ReadableStream`
-
-An empty and closed ReadableStream instance.
-
-## Defined in
-
-[packages/ai-tool/src/utils/stream/create-empty-stream.ts:8](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/stream/create-empty-stream.ts#L8)

package/docs/functions/createEndWithRepetitionDetector.md

@@ -1,29 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / createEndWithRepetitionDetector
-
-# Function: createEndWithRepetitionDetector()
-
-> **createEndWithRepetitionDetector**(`repetitionThreshold`): (`value`) => `null` \| `RegExpExecArray`
-
-## Parameters
-
-• **repetitionThreshold**: `number`
-
-## Returns
-
-`Function`
-
-### Parameters
-
-• **value**: `string`
-
-### Returns
-
-`null` \| `RegExpExecArray`
-
-## Defined in
-
-[packages/ai-tool/src/utils/end-with-repeated-sequence.ts:3](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/end-with-repeated-sequence.ts#L3)

package/docs/functions/createError.md

@@ -1,35 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / createError
-
-# Function: createError()
-
-> **createError**(`message`, `name`?, `status`?): [`CommonError`](../classes/CommonError.md)
-
-Create an error object
-
-## Parameters
-
-• **message**: `string`
-
-Error message
-
-• **name?**: `string` \| `Record`\<`string`, `any`\>
-
-Error name, optional
-
-• **status?**: `string` \| `number`
-
-Error status code, default to 500
-
-## Returns
-
-[`CommonError`](../classes/CommonError.md)
-
-Error object
-
-## Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:153

package/docs/functions/createEventStreamTransformer.md

@@ -1,33 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / createEventStreamTransformer
-
-# Function: createEventStreamTransformer()
-
-> **createEventStreamTransformer**\<`TValue`, `TOptions`\>(`customParser`?): `TransformStream`\<`Uint8Array`, [`AIResult`](../interfaces/AIResult.md)\<`TValue`, `TOptions`\>\>
-
-Creates a TransformStream that parses events from an EventSource stream using a custom parser.
-
-## Type Parameters
-
-• **TValue** = `any`
-
-• **TOptions** = `any`
-
-## Parameters
-
-• **customParser?**: [`AIStreamParser`](../interfaces/AIStreamParser.md)\<`any`, `any`\>
-
-Function to handle event data.
-
-## Returns
-
-`TransformStream`\<`Uint8Array`, [`AIResult`](../interfaces/AIResult.md)\<`TValue`, `TOptions`\>\>
-
-TransformStream parsing events.
-
-## Defined in
-
-[packages/ai-tool/src/utils/stream/ai-stream.ts:37](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/stream/ai-stream.ts#L37)

package/docs/functions/createHfValueFunc.md

@@ -1,29 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / createHfValueFunc
-
-# Function: createHfValueFunc()
-
-> **createHfValueFunc**(`fn`): (`_data`) => `Function`
-
-## Parameters
-
-• **fn**: `Function`
-
-## Returns
-
-`Function`
-
-### Parameters
-
-• **\_data**: `any`
-
-### Returns
-
-`Function`
-
-## Defined in
-
-[packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:140](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/hf-prompt-template.ts#L140)

package/docs/functions/createLRUCache.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / createLRUCache
-
-# Function: createLRUCache()
-
-> **createLRUCache**(`name`, `options`?): [`ToolFunc`](../classes/ToolFunc.md)
-
-## Parameters
-
-• **name**: `string`
-
-• **options?**: `number` \| `ICacheOptions`
-
-## Returns
-
-[`ToolFunc`](../classes/ToolFunc.md)
-
-## Defined in
-
-[packages/ai-tool/src/funcs/lrucache.ts:22](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/funcs/lrucache.ts#L22)

package/docs/functions/createYamlObjectTag.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / createYamlObjectTag
-
-# Function: createYamlObjectTag()
-
-> **createYamlObjectTag**(`tag`, `BaseObject`): `any`
-
-## Parameters
-
-• **tag**: `string`
-
-• **BaseObject**: *typeof* [`YamlTypeBaseObject`](../classes/YamlTypeBaseObject.md)
-
-## Returns
-
-`any`
-
-## Defined in
-
-[packages/ai-tool/src/utils/yaml-type-base-object.ts:10](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/yaml-type-base-object.ts#L10)

package/docs/functions/dateToText.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / dateToText
-
-# Function: dateToText()
-
-> **dateToText**(`date`, `format`): `string`
-
-## Parameters
-
-• **date**: `Date`
-
-• **format**: `string` = `FormatDateStr`
-
-## Returns
-
-`string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/to-datetime.ts:29](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/to-datetime.ts#L29)

package/docs/functions/decodeCharset.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / decodeCharset
-
-# Function: decodeCharset()
-
-> **decodeCharset**(`result`, `encoding`?): `string`
-
-## Parameters
-
-• **result**: `Buffer`
-
-• **encoding?**: `BufferEncoding`
-
-## Returns
-
-`string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:113](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/load-file-from-paths.ts#L113)

package/docs/functions/detectCharset.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / detectCharset
-
-# Function: detectCharset()
-
-> **detectCharset**(`content`, `options`?): `string`
-
-## Parameters
-
-• **content**: `string` \| `Buffer`
-
-• **options?**: `any`
-
-## Returns
-
-`string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:248](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/load-file-from-paths.ts#L248)

package/docs/functions/encodeLLMTokens.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / encodeLLMTokens
-
-# Function: encodeLLMTokens()
-
-> **encodeLLMTokens**(`text`, `modelId`): `Promise`\<`number`[]\>
-
-## Parameters
-
-• **text**: `string`
-
-• **modelId**: `string` = `'qwen2.5'`
-
-## Returns
-
-`Promise`\<`number`[]\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/llm-tokenizer.ts:68](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/llm-tokenizer.ts#L68)

package/docs/functions/expandEnv.md

@@ -1,40 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / expandEnv
-
-# Function: expandEnv()
-
-> **expandEnv**(`options`): [`DotenvExpandOptions`](../interfaces/DotenvExpandOptions.md)
-
-Expand environment variables in the parsed object
-
-## Parameters
-
-• **options**: [`DotenvExpandOptions`](../interfaces/DotenvExpandOptions.md)
-
-## Returns
-
-[`DotenvExpandOptions`](../interfaces/DotenvExpandOptions.md)
-
-## Example
-
-```ts
-const myEnv = {}
-const env = {
-  processEnv: myEnv,
-  parsed: {
-    WORD: 'World',
-    HELLO: 'Hello ${WORD}'
-  }
-}
-expandEnv.expand(env)
-
-console.log(myEnv.HELLO) // Hello World
-console.log(process.env.HELLO) // undefined
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/prompt/template/env.ts:82](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/template/env.ts#L82)

package/docs/functions/expandObjEnv.md

@@ -1,54 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / expandObjEnv
-
-# Function: expandObjEnv()
-
-> **expandObjEnv**(`obj`, `options`, `parsedObjs`?): `any`
-
-Expands environment variables in an object/array or string.
-
-This function replaces placeholders like `${VAR}` in strings and recursively
-processes objects and arrays with environment variable references.
-
-## Parameters
-
-• **obj**: `any`
-
-The object/array or string to be processed. Can be any value, but
-             primarily designed for objects, array and strings.
-
-• **options**: [`DotenvExpandOptions`](../interfaces/DotenvExpandOptions.md) = `{}`
-
-Configuration options:
-  - processEnv: - An object to source environment variables from, defaults to `process.env`.
-  - parsed: - Specify an object to provide the value of environment variables.
-
-• **parsedObjs?**: `WeakSet`\<`any`\>
-
-## Returns
-
-`any`
-
-- Returns the expanded object or string.
-
-## Example
-
-```ts
-const obj = {
-  name: 'MyApp',
-  envVar: '${ENV_VAR_NAME}',
-  config: {
-    url: 'http://${HOST}:${PORT}'
-  },
-  list: ['item1', '${ITEM2}']
-};
-// the expandedObj will have the actual values instead of placeholders.
-const expandedObj = expandObjEnv(obj, { processEnv: myCustomEnv }); // Assuming 'ENV_VAR_NAME' is defined as 'Production' and 'HOST', 'PORT', 'ITEM2' are set,
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/prompt/template/env.ts:142](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/template/env.ts#L142)

package/docs/functions/extNameLevel.md

@@ -1,43 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / extNameLevel
-
-# Function: extNameLevel()
-
-> **extNameLevel**(`extName`): `number`
-
-Calculates the level of an extension name.
-
-The level represents the number of dots ('.') in the extension name, excluding the first dot which separates
-the base filename from the extension. For example, the level of ".txt" is 1, and the level of ".tar.gz" is 2.
-
-## Parameters
-
-• **extName**: `string`
-
-The extension name to analyze. It should start with a dot ('.').
-
-## Returns
-
-`number`
-
-The level of the extension name, which is the count of dots minus one.
-
-## Example
-
-```typescript
-// Returns 0
-extNameLevel("no-file-ext");
-
-// Returns 2
-extNameLevel(".tar.gz");
-
-// Returns 1
-extNameLevel(".json5");
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/filename.ts:209](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/filename.ts#L209)

package/docs/functions/fileIsExists.md

@@ -1,34 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / fileIsExists
-
-# Function: fileIsExists()
-
-> **fileIsExists**(`filepath`): `undefined` \| `boolean`
-
-Checks if a file (not a directory) exists at the specified path.
-
-## Parameters
-
-• **filepath**: `string`
-
-The path to the file to check.
-
-## Returns
-
-`undefined` \| `boolean`
-
-true if the file exists and is not a directory; otherwise, false.
-
-## Example
-
-```typescript
-const exists = fileIsExists('path/to/file.txt');
-console.log(exists); // Outputs: true or false
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:23](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/load-file-from-paths.ts#L23)

package/docs/functions/filenameReservedRegex.md

@@ -1,22 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / filenameReservedRegex
-
-# Function: filenameReservedRegex()
-
-> **filenameReservedRegex**(): `RegExp`
-
-Returns a new regular expression instance for reserved filename characters with the 'g' flag.
-use this to reset the with global option
-
-## Returns
-
-`RegExp`
-
-A compiled regular expression for reserved filename characters.
-
-## Defined in
-
-[packages/ai-tool/src/utils/filename.ts:42](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/filename.ts#L42)