@isdk/ai-tool 0.3.0 → 0.5.0

package/docs/functions/filterValidFnScope.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / filterValidFnScope
-
-# Function: filterValidFnScope()
-
-> **filterValidFnScope**(`scope`?): `undefined` \| `Record`\<`string`, `any`\>
-
-## Parameters
-
-• **scope?**: `Record`\<`string`, `any`\>
-
-## Returns
-
-`undefined` \| `Record`\<`string`, `any`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/parse-js-json.ts:58](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-js-json.ts#L58)

package/docs/functions/findIndexNonEmptyFrom.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / findIndexNonEmptyFrom
-
-# Function: findIndexNonEmptyFrom()
-
-> **findIndexNonEmptyFrom**(`arr`, `start`): `number`
-
-## Parameters
-
-• **arr**: `any`[]
-
-• **start**: `number` = `0`
-
-## Returns
-
-`number`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:282](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L282)

package/docs/functions/findPort.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / findPort
-
-# Function: findPort()
-
-> **findPort**(`port`, `portRetryCount`): `Promise`\<`number`\>
-
-## Parameters
-
-• **port**: `string` \| `number`
-
-• **portRetryCount**: `number` = `10`
-
-## Returns
-
-`Promise`\<`number`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/find-port.ts:3](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/find-port.ts#L3)

package/docs/functions/formatISO.md

@@ -1,71 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / formatISO
-
-# Function: formatISO()
-
-> **formatISO**(`date`, `options`?): `string`
-
-## Parameters
-
-• **date**: `string` \| `number` \| `Date`
-
-The original date
-
-• **options?**: `FormatISOOptions`
-
-An object with options.
-
-## Returns
-
-`string`
-
-The formatted date string (in local time zone)
-
-## Name
-
-formatISO
-
-## Summary
-
-Format the date according to the ISO 8601 standard (https://support.sas.com/documentation/cdl/en/lrdict/64316/HTML/default/viewer.htm#a003169814.htm).
-
-## Description
-
-Return the formatted date string in ISO 8601 format. Options may be passed to control the parts and notations of the date.
-
-## Throws
-
-`date` must not be Invalid Date
-
-## Examples
-
-```ts
-// Represent 18 September 2019 in ISO 8601 format (local time zone is UTC):
-const result = formatISO(new Date(2019, 8, 18, 19, 0, 52))
-//=> '2019-09-18T19:00:52Z'
-```
-
-```ts
-// Represent 18 September 2019 in ISO 8601, short format (local time zone is UTC):
-const result = formatISO(new Date(2019, 8, 18, 19, 0, 52), { format: 'basic' })
-//=> '20190918T190052'
-```
-
-```ts
-// Represent 18 September 2019 in ISO 8601 format, date only:
-const result = formatISO(new Date(2019, 8, 18, 19, 0, 52), { representation: 'date' })
-//=> '2019-09-18'
-```
-
-```ts
-// Represent 18 September 2019 in ISO 8601 format, time only (local time zone is UTC):
-const result = formatISO(new Date(2019, 8, 18, 19, 0, 52), { representation: 'time' })
-//=> '19:00:52Z'
-```
-
-## Defined in
-
-node\_modules/.pnpm/date-fns@4.1.0/node\_modules/date-fns/formatISO.d.ts:43

package/docs/functions/formatTextWithSpace.md

@@ -1,59 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / formatTextWithSpace
-
-# Function: formatTextWithSpace()
-
-> **formatTextWithSpace**(`input`, `options`?): `string`
-
-Formats the input text by replacing delimiters with spaces and optionally capitalizing the first letter of each word.
-
-## Parameters
-
-• **input**: `string`
-
-The input string to be formatted.
-
-• **options?**
-
-Optional configuration for formatting.
-
-• **options.capitalize?**: `boolean`
-
-Whether to capitalize the first letter of each word. Defaults to `true`.
-
-• **options.delimiter?**: `string` \| `RegExp`
-
-The delimiter used to split the words. Defaults to `/[_-]/g`.
-
-## Returns
-
-`string`
-
-## Examples
-
-```ts
-// Returns "Hello World"
-formatTextWithSpace("hello_world");
-```
-
-```ts
-// Returns "This Is A Test"
-formatTextWithSpace("this-is-a-test", { delimiter: /-/g });
-```
-
-```ts
-// Returns "hello world"
-formatTextWithSpace("hello_world", { capitalize: false });
-```
-
-```ts
-// Returns "Hello World This Is A Test"
-formatTextWithSpace("hello-world_this_is_a_test");
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/format-text-with-space.ts:25](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/format-text-with-space.ts#L25)

package/docs/functions/getAllEnumKeys.md

@@ -1,31 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / getAllEnumKeys
-
-# Function: getAllEnumKeys()
-
-> **getAllEnumKeys**\<`T`\>(`enumType`): keyof *typeof* `enumType`[]
-
-Retrieves all string keys from the given enumeration(number).
-
-## Type Parameters
-
-• **T** *extends* `object`
-
-## Parameters
-
-• **enumType**: `T`
-
-The enumeration type with numeric values for which to retrieve keys.
-
-## Returns
-
-keyof *typeof* `enumType`[]
-
-An array containing all string keys of the specified enumeration.
-
-## Defined in
-
-[packages/ai-tool/src/utils/get-all-enum-keys.ts:7](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/get-all-enum-keys.ts#L7)

package/docs/functions/getConfigFileNames.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / getConfigFileNames
-
-# Function: getConfigFileNames()
-
-> **getConfigFileNames**(`directoryPath`, `filter`?): `string`[]
-
-## Parameters
-
-• **directoryPath**: `string`
-
-• **filter?**: `ConfigFilesFilter`
-
-## Returns
-
-`string`[]
-
-## Defined in
-
-[packages/ai-tool/src/utils/config.ts:59](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/config.ts#L59)

package/docs/functions/getConfigs.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / getConfigs
-
-# Function: getConfigs()
-
-> **getConfigs**(`directoryPath`, `filter`?): `any`[]
-
-## Parameters
-
-• **directoryPath**: `string`
-
-• **filter?**: `ConfigFilesFilter`
-
-## Returns
-
-`any`[]
-
-## Defined in
-
-[packages/ai-tool/src/utils/config.ts:83](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/config.ts#L83)

package/docs/functions/getFileMetaInfo.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / getFileMetaInfo
-
-# Function: getFileMetaInfo()
-
-> **getFileMetaInfo**(`filepath`): `Promise`\<[`IFileMetaInfo`](../interfaces/IFileMetaInfo.md)\>
-
-## Parameters
-
-• **filepath**: `string`
-
-## Returns
-
-`Promise`\<[`IFileMetaInfo`](../interfaces/IFileMetaInfo.md)\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:221](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L221)

package/docs/functions/getHashAlgoBySize.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / getHashAlgoBySize
-
-# Function: getHashAlgoBySize()
-
-> **getHashAlgoBySize**(`size`): [`HashAlgorithm`](../enumerations/HashAlgorithm.md)
-
-## Parameters
-
-• **size**: `number`
-
-## Returns
-
-[`HashAlgorithm`](../enumerations/HashAlgorithm.md)
-
-## Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:234](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L234)

package/docs/functions/getKeysPath.md

@@ -1,38 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / getKeysPath
-
-# Function: getKeysPath()
-
-> **getKeysPath**\<`TValue`\>(`value`): `string`[]
-
-Retrieves an array of all key paths as strings for a nested object or array.
-
-## Type Parameters
-
-• **TValue** *extends* `object`
-
-## Parameters
-
-• **value**: `TValue`
-
-The object or array to extract the paths from.
-
-## Returns
-
-`string`[]
-
-- An array of strings containing all the key paths.
-
-## Example
-
-```
-const obj = { a: { b: { c: 1 } }, d: [0, { e: 2 }] };
-console.log(getKeysPath(obj)); // Output: ['a.b.c', 'd[0]', 'd[1].e']
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/get-keys-path.ts:16](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/get-keys-path.ts#L16)

package/docs/functions/getLLMTokenizer.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / getLLMTokenizer
-
-# Function: getLLMTokenizer()
-
-> **getLLMTokenizer**(`modelId`): `Promise`\<`PreTrainedTokenizer`\>
-
-## Parameters
-
-• **modelId**: `string`
-
-## Returns
-
-`Promise`\<`PreTrainedTokenizer`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/llm-tokenizer.ts:58](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/llm-tokenizer.ts#L58)

package/docs/functions/getMultiLevelExtname.md

@@ -1,31 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / getMultiLevelExtname
-
-# Function: getMultiLevelExtname()
-
-> **getMultiLevelExtname**(`filename`, `level`): `string`
-
-Retrieves multi-level file extension
-
-## Parameters
-
-• **filename**: `string`
-
-The file name
-
-• **level**: `number` = `1`
-
-The level, default is 1, indicating the number of extension levels to retrieve
-
-## Returns
-
-`string`
-
-Returns a concatenated string of multiple extensions, or an empty string if no extension is found
-
-## Defined in
-
-[packages/ai-tool/src/utils/filename.ts:174](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/filename.ts#L174)

package/docs/functions/getPackageDir.md

@@ -1,39 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / getPackageDir
-
-# Function: getPackageDir()
-
-> **getPackageDir**(`cwd`): `string`
-
-Retrieves the package directory from the current working directory.
-
-## Parameters
-
-• **cwd**: `string`
-
-The current working directory.
-
-Notes:
-- The project root directory must contain either the `src` (source files directory) or `dist` (compiled files directory) as a fallback.
-- If `packageDirectorySync` fails to find the package directory, it falls back to checking for `src` or `dist` directories.
-- If none of these directories are found, an error is thrown.
- *
-
-## Returns
-
-`string`
-
-## Example
-
-```ts
-// Example usage
-const packageDir = getPackageDir(__dirname);
-console.log(packageDir); // Output: '/path/to/project'
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/get-package-dir.ts:18](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/get-package-dir.ts#L18)

package/docs/functions/getRealFilepath.md

@@ -1,34 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / getRealFilepath
-
-# Function: getRealFilepath()
-
-> **getRealFilepath**(`filepath`): `string`
-
-Resolves the real file path, handling symbolic links.
-
-## Parameters
-
-• **filepath**: `string`
-
-The file path to resolve.
-
-## Returns
-
-`string`
-
-The real file path.
-
-## Example
-
-```typescript
-const realPath = getRealFilepath('/path/to/symbolic/link');
-console.log(realPath); // Outputs the resolved path.
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:195](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L195)

package/docs/functions/getResponseErrorReadableStream.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / getResponseErrorReadableStream
-
-# Function: getResponseErrorReadableStream()
-
-> **getResponseErrorReadableStream**(`body`?): `ReadableStream`\<`any`\>
-
-## Parameters
-
-• **body?**: `null` \| `ReadableStream`\<`Uint8Array`\>
-
-## Returns
-
-`ReadableStream`\<`any`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/stream/error-readable-stream.ts:12](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/stream/error-readable-stream.ts#L12)

package/docs/functions/hasDirectoryIn.md

@@ -1,38 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / hasDirectoryIn
-
-# Function: hasDirectoryIn()
-
-> **hasDirectoryIn**(`dir`, `dirs`?): `undefined` \| `boolean`
-
-Checks if a given directory is a subdirectory of any directory in the provided array.
-
-## Parameters
-
-• **dir**: `string`
-
-The directory path to check.
-
-• **dirs?**: `string`[]
-
-An array of directory paths.
-
-## Returns
-
-`undefined` \| `boolean`
-
-true if the given directory is a subdirectory of any directory in the array; otherwise, false.
-
-## Example
-
-```ts
-// Returns true if 'subdir' is within 'parentdir'
-hasDirectoryIn('parentdir/subdir', ['parentdir', 'otherdir']); // true
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/has-directory-in.ts:37](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/has-directory-in.ts#L37)

package/docs/functions/hashFile.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / hashFile
-
-# Function: hashFile()
-
-> **hashFile**(`filepath`, `options`?): `Promise`\<`string` \| `Uint8Array`\>
-
-## Parameters
-
-• **filepath**: `string`
-
-• **options?**: [`HashAlgoParams`](../interfaces/HashAlgoParams.md)
-
-## Returns
-
-`Promise`\<`string` \| `Uint8Array`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:204](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L204)

package/docs/functions/hashStream.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / hashStream
-
-# Function: hashStream()
-
-> **hashStream**(`stream`, `__namedParameters`): `Promise`\<`string` \| `Uint8Array`\>
-
-## Parameters
-
-• **stream**: `ReadableStream`\<`any`\>
-
-• **\_\_namedParameters**: [`HashAlgoParams`](../interfaces/HashAlgoParams.md) = `{}`
-
-## Returns
-
-`Promise`\<`string` \| `Uint8Array`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/hash/xxhash.ts:81](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L81)

package/docs/functions/hfParse.md

@@ -1,24 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / hfParse
-
-# Function: hfParse()
-
-> **hfParse**(`tokens`): `Program`
-
-Generate the Abstract Syntax Tree (AST) from a list of tokens.
-Operator precedence can be found here: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Operator_precedence#table
-
-## Parameters
-
-• **tokens**: `Token`[]
-
-## Returns
-
-`Program`
-
-## Defined in
-
-[packages/ai-tool/src/utils/prompt/template/jinja/src/parser.ts:32](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/template/jinja/src/parser.ts#L32)

package/docs/functions/hfTokenize.md

@@ -1,25 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / hfTokenize
-
-# Function: hfTokenize()
-
-> **hfTokenize**(`source`, `options`): `Token`[]
-
-Generate a list of tokens from a source string.
-
-## Parameters
-
-• **source**: `string`
-
-• **options**: `PreprocessOptions` = `{}`
-
-## Returns
-
-`Token`[]
-
-## Defined in
-
-[packages/ai-tool/src/utils/prompt/template/jinja/src/lexer.ts:200](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/template/jinja/src/lexer.ts#L200)

package/docs/functions/interpolateEnv.md

@@ -1,25 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / interpolateEnv
-
-# Function: interpolateEnv()
-
-> **interpolateEnv**(`value`, `processEnv`, `parsed`): `any`
-
-## Parameters
-
-• **value**: `string`
-
-• **processEnv**: `any`
-
-• **parsed**: `any`
-
-## Returns
-
-`any`
-
-## Defined in
-
-[packages/ai-tool/src/utils/prompt/template/env.ts:17](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/template/env.ts#L17)