@isdk/ai-tool 0.3.0 → 0.5.0

package/docs/functions/parseJsJsonSimpleSync.md

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

package/docs/functions/parseObjectArgInfo.md

@@ -1,27 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / parseObjectArgInfo
-
-# Function: parseObjectArgInfo()
-
-> **parseObjectArgInfo**(`argInfo`, `ix`, `scope`?, `options`?): `Promise`\<`string`\>
-
-## Parameters
-
-• **argInfo**: `ArgInfo`
-
-• **ix**: `number`
-
-• **scope?**: `Record`\<`string`, `any`\>
-
-• **options?**: [`ParseObjectArgumentOptions`](../interfaces/ParseObjectArgumentOptions.md)
-
-## Returns
-
-`Promise`\<`string`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:254](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L254)

package/docs/functions/parseObjectArgumentInfos.md

@@ -1,25 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / parseObjectArgumentInfos
-
-# Function: parseObjectArgumentInfos()
-
-> **parseObjectArgumentInfos**(`args`, `scope`?, `options`?): `Promise`\<`any`\>
-
-## Parameters
-
-• **args**: `ArgInfo`[]
-
-• **scope?**: `Record`\<`string`, `any`\>
-
-• **options?**: [`ParseObjectArgumentOptions`](../interfaces/ParseObjectArgumentOptions.md)
-
-## Returns
-
-`Promise`\<`any`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:92](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L92)

package/docs/functions/parseObjectArguments.md

@@ -1,68 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / parseObjectArguments
-
-# Function: parseObjectArguments()
-
-> **parseObjectArguments**(`argsStr`, `scope`?, `options`?): `Promise`\<`any`\>
-
-Asynchronously parses a string of object arguments into an actual object.
-
-## Parameters
-
-• **argsStr**: `string`
-
-The string of arguments to be parsed.
-
-• **scope?**: `Record`\<`string`, `any`\>
-
-An optional scope object that provides values for variables during parsing.
-
-• **options?**: [`ParseObjectArgumentOptions`](../interfaces/ParseObjectArgumentOptions.md)
-
-An optional configuration object containing the delimiter and argument processor.
-
-## Returns
-
-`Promise`\<`any`\>
-
-The parsed object or undefined.
-
-This function first parses the argument string into an object string and then converts it
-into a proper JavaScript/JSON object based on the parsing results and configuration options.
-It handles the conversion of single objects, arrays, and key-value pairs. The default delimiter
-between parameters is a comma (`,`), but this can be customized using the `options.delimiter`.
-Parameter assignment always uses an equal sign (`=`) and cannot be modified.
-
-The function returns:
-- An object if the input string represents a set of key-value pairs.
-- An array if the input string represents a sequence of elements, where each element can be
-  parsed as a number (indices are used as keys).
-- A single value if the input string represents a single value or a single key-value pair.
-- `undefined` if the input string is empty or cannot be parsed into a valid object.
-
-## Example
-
-```typescript
-// Example call with default delimiter
-const result = await parseObjectArguments("name=John,age=30");
-console.log(result); // Output: { name: 'John', age: '30' }
-
-// Example call with custom delimiter
-const resultCustomDelimiter = await parseObjectArguments("name=John|age=30", undefined, { delimiter: '|' });
-console.log(resultCustomDelimiter); // Output: { name: 'John', age: '30' }
-
-// Example with a single value
-const singleValue = await parseObjectArguments("42");
-console.log(singleValue); // Output: 42
-
-// Example with an array
-const arrayResult = await parseObjectArguments("1,2,3");
-console.log(arrayResult); // Output: [1, 2, 3]
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:70](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L70)

package/docs/functions/parseObjectArgumentsAsArgInfos.md

@@ -1,42 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / parseObjectArgumentsAsArgInfos
-
-# Function: parseObjectArgumentsAsArgInfos()
-
-> **parseObjectArgumentsAsArgInfos**(`argsStr`, `scope`?, `options`?): `ArgInfo`[]
-
-Parses an object arguments string into an array of ArgInfo.
-
-This function processes a parameter string and parses it according to specific rules, allowing for custom delimiters.
-It can handle quotes, escape characters, and expressions within brackets. The parsing is designed to interpret
-object literal strings from dynamic languages, such as JSON objects or similar custom formats.
-
-## Parameters
-
-• **argsStr**: `string`
-
-The string containing the arguments to be parsed.
-
-• **scope?**: `Record`\<`string`, `any`\>
-
-An optional scope object used for further processing of the parsed arguments. Default is undefined.
-
-• **options?**: [`ParseObjectArgumentOptions`](../interfaces/ParseObjectArgumentOptions.md)
-
-Parsing options, including:
-  - delimiter: The character used to separate arguments. Default is ','.
-  - argProcessor: An optional instance of ArgProcessor used for further processing of the parsed arguments.
-
-## Returns
-
-`ArgInfo`[]
-
-An array of parsed argument information, where each item contains a boolean indicating whether the argument is named,
-         and the string representation of the argument.
-
-## Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:303](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L303)

package/docs/functions/parseYaml.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / parseYaml
-
-# Function: parseYaml()
-
-> **parseYaml**(`content`): `any`
-
-## Parameters
-
-• **content**: `string`
-
-## Returns
-
-`any`
-
-## Defined in
-
-[packages/ai-tool/src/utils/config.ts:24](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/config.ts#L24)

package/docs/functions/quoteStr.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / quoteStr
-
-# Function: quoteStr()
-
-> **quoteStr**(`str`): `string`
-
-## Parameters
-
-• **str**: `string`
-
-## Returns
-
-`string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:204](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L204)

package/docs/functions/reControlCharsRegex.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / reControlCharsRegex
-
-# Function: reControlCharsRegex()
-
-> **reControlCharsRegex**(): `RegExp`
-
-Returns a new regular expression instance for control characters in a filename with the 'g' flag.
-
-## Returns
-
-`RegExp`
-
-A compiled regular expression for control characters in a filename.
-
-## Defined in
-
-[packages/ai-tool/src/utils/filename.ts:50](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/filename.ts#L50)

package/docs/functions/readFilenamesRecursiveSync.md

@@ -1,47 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / readFilenamesRecursiveSync
-
-# Function: readFilenamesRecursiveSync()
-
-> **readFilenamesRecursiveSync**(`dir`, `options`?): `string`[]
-
-Recursively reads all filenames in the given directory or directories.
-Optionally filters the results using a file matching callback.
-
-## Parameters
-
-• **dir**: `string` \| `string`[]
-
-A single directory path or an array of directory paths to start the search from.
-
-• **options?**
-
-• **options.isFileMatched?**
-
-An optional callback that determines whether a file should be included in the result.
-
-• **options.level?**: `number`
-
-• **options.signal?**: `AbortSignal`
-
-An optional signal to abort the operation.
-
-## Returns
-
-`string`[]
-
-An array of file paths that match the criteria.
-
-## Example
-
-```typescript
-const files = readFilenamesRecursiveSync('/path/to/directory', {isFileMatched: (filepath) => filepath.endsWith('.js')});
-console.log(files); // Outputs an array of JavaScript file paths.
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:136](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L136)

package/docs/functions/readTextFileChunks.md

@@ -1,51 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / readTextFileChunks
-
-# Function: readTextFileChunks()
-
-> **readTextFileChunks**(`filePath`, `options`?): `AsyncIterable`\<`string`\>
-
-Reads a text file and yields chunks of text that are within a specified token limit.
-This function supports both small files that can be read entirely into memory,
-and large files that require streaming.
-
-Note: The specified `size` must not be less than the token count of the longest sentence.
-If the `size` is less than the token count of the longest sentence, some sentences may not
-fit completely into a single chunk.
-Without completeSentence and corrected Only!
-
-## Parameters
-
-• **filePath**: `string`
-
-The path to the text file to be read.
-
-• **options?**: [`IReadTextFileChunksOptions`](../interfaces/IReadTextFileChunksOptions.md)
-
-optional Options for reading the file.
-
-## Returns
-
-`AsyncIterable`\<`string`\>
-
-## Example
-
-```typescript
-const filePath = 'path/to/file.txt';
-const options = {
-  size: 2048,
-  modelId: 'gpt-3.5',
-  metaInfo: { size: 10240 }
-};
-
-for await (const chunk of readTextFileChunks(filePath, options)) {
-  console.log('Chunk:', chunk);
-}
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/read-text-file-chunks.ts:41](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/read-text-file-chunks.ts#L41)

package/docs/functions/readTextFileChunksEx.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / readTextFileChunksEx
-
-# Function: readTextFileChunksEx()
-
-> **readTextFileChunksEx**(`filePath`, `options`?): `AsyncIterable`\<`string`[]\>
-
-## Parameters
-
-• **filePath**: `string`
-
-• **options?**: [`IReadTextFileChunksOptions`](../interfaces/IReadTextFileChunksOptions.md)
-
-## Returns
-
-`AsyncIterable`\<`string`[]\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/read-text-file-chunks.ts:109](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/read-text-file-chunks.ts#L109)

package/docs/functions/readableFromAsyncIterable.md

@@ -1,28 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / readableFromAsyncIterable
-
-# Function: readableFromAsyncIterable()
-
-> **readableFromAsyncIterable**\<`T`\>(`iterable`): `ReadableStream`\<`T`\>
-
-Implements ReadableStream.from(asyncIterable), which isn't documented in MDN and isn't implemented in node.
-https://github.com/whatwg/streams/commit/8d7a0bf26eb2cc23e884ddbaac7c1da4b91cf2bc
-
-## Type Parameters
-
-• **T**
-
-## Parameters
-
-• **iterable**: `AsyncIterable`\<`T`, `any`, `any`\>
-
-## Returns
-
-`ReadableStream`\<`T`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/stream/ai-stream.ts:166](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/stream/ai-stream.ts#L166)

package/docs/functions/registerCoreTools.md

@@ -1,17 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / registerCoreTools
-
-# Function: registerCoreTools()
-
-> **registerCoreTools**(): `void`
-
-## Returns
-
-`void`
-
-## Defined in
-
-[packages/ai-tool/src/funcs/index.ts:9](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/index.ts#L9)

package/docs/functions/registerYamlTag.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / registerYamlTag
-
-# Function: registerYamlTag()
-
-> **registerYamlTag**(`tags`): `void`
-
-## Parameters
-
-• **tags**: `any`
-
-## Returns
-
-`void`
-
-## Defined in
-
-[packages/ai-tool/src/utils/config.ts:14](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/config.ts#L14)

package/docs/functions/removeMarkdownBold.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / removeMarkdownBold
-
-# Function: removeMarkdownBold()
-
-> **removeMarkdownBold**(`s`, `once`?): `string`
-
-## Parameters
-
-• **s**: `string`
-
-• **once?**: `boolean`
-
-## Returns
-
-`string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:292](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L292)

package/docs/functions/removeMarkdownBoldAndItalic.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / removeMarkdownBoldAndItalic
-
-# Function: removeMarkdownBoldAndItalic()
-
-> **removeMarkdownBoldAndItalic**(`s`, `once`?): `string`
-
-## Parameters
-
-• **s**: `string`
-
-• **once?**: `boolean`
-
-## Returns
-
-`string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:312](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L312)

package/docs/functions/removeMarkdownItalic.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / removeMarkdownItalic
-
-# Function: removeMarkdownItalic()
-
-> **removeMarkdownItalic**(`s`, `once`?): `string`
-
-## Parameters
-
-• **s**: `string`
-
-• **once?**: `boolean`
-
-## Returns
-
-`string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:302](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L302)

package/docs/functions/replaceWithPlaceholder.md

@@ -1,41 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / replaceWithPlaceholder
-
-# Function: replaceWithPlaceholder()
-
-> **replaceWithPlaceholder**(`content`, `options`?): [`string`, `string`[]]
-
-Replaces substrings in the given content with placeholders.
-
-## Parameters
-
-• **content**: `string`
-
-The string content to process.
-
-• **options?**: [`ReplacePlacehoderOptions`](../interfaces/ReplacePlacehoderOptions.md)
-
-Optional configuration object with the following properties:
-  - `startChar` - The starting character(s) of the substrings to replace. Can be a single character or an array of characters. Defaults to `["\"", "'"]`.
-  - `endChar` - The ending character(s) of the substrings to replace. Can be a single character or an array of characters. Defaults to the value of `startChar`.
-  - `placeholder` - The prefix for the placeholder names. Defaults to `defaultPlaceholderName`.
-  - `placehoders` - An array of placeholders to use instead of generating new one.
-
-## Returns
-
-[`string`, `string`[]]
-
-An array containing:
-  - `content` - The modified content with placeholders.
-  - `placehoders` - An array of the original substrings that were replaced.
-
-## Throws
-
-If the lengths of `startChar` and `endChar` are not the same.
-
-## Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:436](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L436)

package/docs/functions/restoreFromPlacehoders.md

@@ -1,45 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / restoreFromPlacehoders
-
-# Function: restoreFromPlacehoders()
-
-> **restoreFromPlacehoders**(`content`, `placehoders`, `options`?): `string`
-
-Restores the original substrings from placeholders in the given content.
-
-## Parameters
-
-• **content**: `string`
-
-The string content containing placeholders to be restored.
-
-• **placehoders**: `string`[]
-
-An array of the original substrings that were replaced by placeholders.
-
-• **options?**: [`ReplacePlacehoderOptions`](../interfaces/ReplacePlacehoderOptions.md)
-
-Optional configuration object with the following properties:
-  - `placeholder` - The prefix for the placeholder names. Defaults to `__PlacEhoLdeR_`.
-
-## Returns
-
-`string`
-
-The modified content with the original substrings restored.
-
-## Example
-
-```typescript
-const contentWithPlaceholders = "Hello __PlacEhoLdeR_0, welcome to __PlacEhoLdeR_1!";
-const originalSubstrings = ["World", "the site"];
-const restoredContent = restoreFromPlacehoders(contentWithPlaceholders, originalSubstrings);
-console.log(restoredContent); // Output: "Hello World, welcome to the site!"
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:489](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L489)

package/docs/functions/sanitizeFilename.md

@@ -1,37 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / sanitizeFilename
-
-# Function: sanitizeFilename()
-
-> **sanitizeFilename**(`filename`, `options`): `string`
-
-Sanitizes a given filename by replacing invalid characters with a specified replacement character or a default.
-
-## Parameters
-
-• **filename**: `string`
-
-The filename to sanitize, represented as a string.
-
-• **options**: [`SanitizeFilenameOptions`](../interfaces/SanitizeFilenameOptions.md) = `{}`
-
-An optional object containing configuration options:
-  - `replacement` {string} - The character to replace invalid characters with. Default is '!'. Cannot contain reserved filename characters.
-  - `maxLength` {number} - The maximum length of the sanitized filename. Default is `MAX_FILENAME_LENGTH`.
-
-## Returns
-
-`string`
-
-The sanitized filename.
-
-## Throws
-
-- If the `replacement` contains reserved filename characters or control characters.
-
-## Defined in
-
-[packages/ai-tool/src/utils/filename.ts:97](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/filename.ts#L97)

package/docs/functions/sanitizeFilepath.md

@@ -1,31 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / sanitizeFilepath
-
-# Function: sanitizeFilepath()
-
-> **sanitizeFilepath**(`filepath`, `options`): `string`
-
-Sanitizes each part of a file path and reassembles it, ensuring the path is valid according to provided options.
-
-## Parameters
-
-• **filepath**: `string`
-
-The file path to sanitize, represented as a string.
-
-• **options**: [`SanitizeFilenameOptions`](../interfaces/SanitizeFilenameOptions.md) = `{}`
-
-Optional settings for sanitization, extending `SanitizeFilenameOptions`. Allows customization of replacement characters and maximum filename length.
-
-## Returns
-
-`string`
-
-The sanitized file path as a string.
-
-## Defined in
-
-[packages/ai-tool/src/utils/filename.ts:149](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/filename.ts#L149)