@isdk/ai-tool 0.4.0 → 0.5.1

package/docs/functions/formatISO.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,13 +8,19 @@
 
 > **formatISO**(`date`, `options`?): `string`
 
+Defined in: node\_modules/.pnpm/date-fns@4.1.0/node\_modules/date-fns/formatISO.d.ts:43
+
 ## Parameters
 
-• **date**: `string` \| `number` \| `Date`
+### date
 
 The original date
 
-• **options?**: `FormatISOOptions`
+`string` | `number` | `Date`
+
+### options?
+
+`FormatISOOptions`
 
 An object with options.
 
@@ -28,10 +34,6 @@ The formatted date string (in local time zone)
 
 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.
@@ -65,7 +67,3 @@ const result = formatISO(new Date(2019, 8, 18, 19, 0, 52), { representation: 'da
 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,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,23 +8,31 @@
 
 > **formatTextWithSpace**(`input`, `options`?): `string`
 
+Defined in: [packages/ai-tool/src/utils/format-text-with-space.ts:25](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/format-text-with-space.ts#L25)
+
 Formats the input text by replacing delimiters with spaces and optionally capitalizing the first letter of each word.
 
 ## Parameters
 
-• **input**: `string`
+### input
+
+`string`
 
 The input string to be formatted.
 
-• **options?**
+### options?
 
 Optional configuration for formatting.
 
-• **options.capitalize?**: `boolean`
+#### capitalize?
+
+`boolean`
 
 Whether to capitalize the first letter of each word. Defaults to `true`.
 
-• **options.delimiter?**: `string` \| `RegExp`
+#### delimiter?
+
+`string` \| `RegExp`
 
 The delimiter used to split the words. Defaults to `/[_-]/g`.
 
@@ -53,7 +61,3 @@ formatTextWithSpace("hello_world", { capitalize: false });
 // 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/format-text-with-space.ts#L25)

package/docs/functions/getAllEnumKeys.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -6,7 +6,9 @@
 
 # Function: getAllEnumKeys()
 
-> **getAllEnumKeys**\<`T`\>(`enumType`): keyof *typeof* `enumType`[]
+> **getAllEnumKeys**\<`T`\>(`enumType`): keyof `T`[]
+
+Defined in: [packages/ai-tool/src/utils/get-all-enum-keys.ts:7](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/get-all-enum-keys.ts#L7)
 
 Retrieves all string keys from the given enumeration(number).
 
@@ -16,16 +18,14 @@ Retrieves all string keys from the given enumeration(number).
 
 ## Parameters
 
-• **enumType**: `T`
+### enumType
+
+`T`
 
 The enumeration type with numeric values for which to retrieve keys.
 
 ## Returns
 
-keyof *typeof* `enumType`[]
+keyof `T`[]
 
 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/get-all-enum-keys.ts#L7)

package/docs/functions/getConfigFileNames.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,16 +8,18 @@
 
 > **getConfigFileNames**(`directoryPath`, `filter`?): `string`[]
 
+Defined in: [packages/ai-tool/src/utils/config.ts:85](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/config.ts#L85)
+
 ## Parameters
 
-• **directoryPath**: `string`
+### directoryPath
 
-• **filter?**: `ConfigFilesFilter`
+`string`
 
-## Returns
+### filter?
 
-`string`[]
+`ConfigFilesFilter`
 
-## Defined in
+## Returns
 
-[packages/ai-tool/src/utils/config.ts:59](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/config.ts#L59)
+`string`[]

package/docs/functions/getConfigs.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,16 +8,18 @@
 
 > **getConfigs**(`directoryPath`, `filter`?): `any`[]
 
+Defined in: [packages/ai-tool/src/utils/config.ts:109](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/config.ts#L109)
+
 ## Parameters
 
-• **directoryPath**: `string`
+### directoryPath
 
-• **filter?**: `ConfigFilesFilter`
+`string`
 
-## Returns
+### filter?
 
-`any`[]
+`ConfigFilesFilter`
 
-## Defined in
+## Returns
 
-[packages/ai-tool/src/utils/config.ts:83](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/config.ts#L83)
+`any`[]

package/docs/functions/getEnvVairables.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / getEnvVairables
+
+# Function: getEnvVairables()
+
+> **getEnvVairables**(`value`): `string`[]
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:17](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/env.ts#L17)
+
+## Parameters
+
+### value
+
+`string`
+
+## Returns
+
+`string`[]

package/docs/functions/getFileMetaInfo.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **getFileMetaInfo**(`filepath`): `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/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/load-file-from-paths.ts#L221)
+
 ## Parameters
 
-• **filepath**: `string`
+### 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/load-file-from-paths.ts#L221)

package/docs/functions/getHashAlgoBySize.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **getHashAlgoBySize**(`size`): [`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/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/load-file-from-paths.ts#L234)
+
 ## Parameters
 
-• **size**: `number`
+### 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/load-file-from-paths.ts#L234)

package/docs/functions/getKeysPath.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,6 +8,8 @@
 
 > **getKeysPath**\<`TValue`\>(`value`): `string`[]
 
+Defined in: [packages/ai-tool/src/utils/get-keys-path.ts:21](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/get-keys-path.ts#L21)
+
 Retrieves an array of all key paths as strings for a nested object or array.
 
 ## Type Parameters
@@ -16,7 +18,9 @@ Retrieves an array of all key paths as strings for a nested object or array.
 
 ## Parameters
 
-• **value**: `TValue`
+### value
+
+`TValue`
 
 The object or array to extract the paths from.
 
@@ -32,7 +36,3 @@ The object or array to extract the paths from.
 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/get-keys-path.ts#L16)

package/docs/functions/getLLMTokenizer.md

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

package/docs/functions/getMultiLevelExtname.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,15 +8,21 @@
 
 > **getMultiLevelExtname**(`filename`, `level`): `string`
 
+Defined in: [packages/ai-tool/src/utils/filename.ts:174](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/filename.ts#L174)
+
 Retrieves multi-level file extension
 
 ## Parameters
 
-• **filename**: `string`
+### filename
+
+`string`
 
 The file name
 
-• **level**: `number` = `1`
+### level
+
+`number` = `1`
 
 The level, default is 1, indicating the number of extension levels to retrieve
 
@@ -25,7 +31,3 @@ The level, default is 1, indicating the number of extension levels to retrieve
 `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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/filename.ts#L174)

package/docs/functions/getPackageDir.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,11 +8,15 @@
 
 > **getPackageDir**(`cwd`): `string`
 
+Defined in: [packages/ai-tool/src/utils/get-package-dir.ts:18](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/get-package-dir.ts#L18)
+
 Retrieves the package directory from the current working directory.
 
 ## Parameters
 
-• **cwd**: `string`
+### cwd
+
+`string`
 
 The current working directory.
 
@@ -33,7 +37,3 @@ Notes:
 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/get-package-dir.ts#L18)

package/docs/functions/getRealFilepath.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,11 +8,15 @@
 
 > **getRealFilepath**(`filepath`): `string`
 
+Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:195](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/load-file-from-paths.ts#L195)
+
 Resolves the real file path, handling symbolic links.
 
 ## Parameters
 
-• **filepath**: `string`
+### filepath
+
+`string`
 
 The file path to resolve.
 
@@ -28,7 +32,3 @@ The real file path.
 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/load-file-from-paths.ts#L195)

package/docs/functions/getResponseErrorReadableStream.md

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

package/docs/functions/getXDGConfigs.md

@@ -0,0 +1,37 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / getXDGConfigs
+
+# Function: getXDGConfigs()
+
+> **getXDGConfigs**(`config`): `object`
+
+Defined in: [packages/ai-tool/src/utils/load-config.ts:57](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/load-config.ts#L57)
+
+## Parameters
+
+### config
+
+`any`
+
+## Returns
+
+`object`
+
+### XDG\_BIN\_HOME
+
+> **XDG\_BIN\_HOME**: `string`
+
+### XDG\_CACHE\_HOME
+
+> **XDG\_CACHE\_HOME**: `any` = `config.cacheDir`
+
+### XDG\_CONFIG\_HOME
+
+> **XDG\_CONFIG\_HOME**: `any` = `config.configDir`
+
+### XDG\_DATA\_HOME
+
+> **XDG\_DATA\_HOME**: `any` = `config.dataDir`

package/docs/functions/hasDirectoryIn.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,15 +8,21 @@
 
 > **hasDirectoryIn**(`dir`, `dirs`?): `undefined` \| `boolean`
 
+Defined in: [packages/ai-tool/src/utils/has-directory-in.ts:37](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/has-directory-in.ts#L37)
+
 Checks if a given directory is a subdirectory of any directory in the provided array.
 
 ## Parameters
 
-• **dir**: `string`
+### dir
+
+`string`
 
 The directory path to check.
 
-• **dirs?**: `string`[]
+### dirs?
+
+`string`[]
 
 An array of directory paths.
 
@@ -32,7 +38,3 @@ true if the given directory is a subdirectory of any directory in the array; oth
 // 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/has-directory-in.ts#L37)

package/docs/functions/hash.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / hash
+
+# Function: hash()
+
+> **hash**(`value`, `__namedParameters`): `Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+
+Defined in: [packages/ai-tool/src/utils/hash/hash.ts:31](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/hash/hash.ts#L31)
+
+## Parameters
+
+### value
+
+`IDataType`
+
+### \_\_namedParameters
+
+[`HashAlgoParams`](../interfaces/HashAlgoParams.md) = `{}`
+
+## Returns
+
+`Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>

package/docs/functions/hashFile.md

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

package/docs/functions/hashStream.md

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

package/docs/functions/hfParse.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,17 +8,17 @@
 
 > **hfParse**(`tokens`): `Program`
 
+Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/parser.ts:33](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/jinja/src/parser.ts#L33)
+
 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`[]
+### 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/template/jinja/src/parser.ts#L32)