@isdk/ai-tool 0.2.0 → 0.2.2

package/docs/functions/parseObjectArguments.md

@@ -0,0 +1,68 @@
+[**@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:66](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/parse-command.ts#L66)

package/docs/functions/parseObjectArgumentsAsArgInfos.md

@@ -0,0 +1,42 @@
+[**@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:285](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/parse-command.ts#L285)

package/docs/functions/parseYaml.md

@@ -0,0 +1,21 @@
+[**@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:25](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/config.ts#L25)

package/docs/functions/quoteStr.md

@@ -0,0 +1,21 @@
+[**@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:200](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/parse-command.ts#L200)

package/docs/functions/reControlCharsRegex.md

@@ -0,0 +1,21 @@
+[**@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/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/filename.ts#L50)

package/docs/functions/readFilenamesRecursiveSync.md

@@ -0,0 +1,47 @@
+[**@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:123](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/load-file-from-paths.ts#L123)

package/docs/functions/readableFromAsyncIterable.md

@@ -0,0 +1,28 @@
+[**@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/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/stream/ai-stream.ts#L166)

package/docs/functions/registerCoreTools.md

@@ -0,0 +1,17 @@
+[**@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/37ada542a786fbbc770f2d61beb564f6e603941d/src/funcs/index.ts#L9)

package/docs/functions/registerYamlTag.md

@@ -0,0 +1,21 @@
+[**@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:15](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/config.ts#L15)

package/docs/functions/sanitizeFilename.md

@@ -0,0 +1,37 @@
+[**@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/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/filename.ts#L97)

package/docs/functions/sanitizeFilepath.md

@@ -0,0 +1,31 @@
+[**@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/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/filename.ts#L149)

package/docs/functions/saveConfigFile.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / saveConfigFile
+
+# Function: saveConfigFile()
+
+> **saveConfigFile**(`filename`, `config`, `extLevel`): `string`
+
+## Parameters
+
+• **filename**: `string`
+
+• **config**: `any`
+
+• **extLevel**: `number` = `1`
+
+## Returns
+
+`string`
+
+## Defined in
+
+[packages/ai-tool/src/utils/config.ts:85](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/config.ts#L85)

package/docs/functions/scaleStrToParamsSize.md

@@ -0,0 +1,27 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / scaleStrToParamsSize
+
+# Function: scaleStrToParamsSize()
+
+> **scaleStrToParamsSize**(`scale`): `number`
+
+Converts a formatted parameters size string (with units T, B, M, or K) back to its byte value.
+
+## Parameters
+
+• **scale**: `string`
+
+The formatted parameter size string (e.g., "1.23B", "456M", "789K", or "123").
+
+## Returns
+
+`number`
+
+The parameter size in bytes.
+
+## Defined in
+
+[packages/ai-tool/src/utils/convert-params-size.ts:44](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/convert-params-size.ts#L44)

package/docs/functions/simplifyObjectArguments.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / simplifyObjectArguments
+
+# Function: simplifyObjectArguments()
+
+> **simplifyObjectArguments**(`args`): `any`
+
+## Parameters
+
+• **args**: `any`
+
+## Returns
+
+`any`
+
+## Defined in
+
+[packages/ai-tool/src/utils/parse-command.ts:71](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/parse-command.ts#L71)

package/docs/functions/sortedValues.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / sortedValues
+
+# Function: sortedValues()
+
+> **sortedValues**\<`T`\>(`values`): `T`[]
+
+## Type Parameters
+
+• **T**
+
+## Parameters
+
+• **values**: `Record`\<`string`, `T`\>
+
+## Returns
+
+`T`[]
+
+## Defined in
+
+[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:4](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/prompt/few-shot-prompt-template.ts#L4)

package/docs/functions/splitSentence.md

@@ -0,0 +1,37 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / splitSentence
+
+# Function: splitSentence()
+
+> **splitSentence**(`text`, `best`): `string`[]
+
+Splits a text into sentences.
+This function is used to split a text into separate sentences, based on punctuation marks such as '.', '?', or '!' and other rules.
+
+## Parameters
+
+• **text**: `string`
+
+The input string that needs to be split into sentences.
+
+• **best**: `boolean` = `true`
+
+A boolean flag indicating if the function should use the best possible sentence splitting method (default is true).
+If set to false, it will not perform any additional processing and simply split on newline characters ('\n').
+
+## Returns
+
+`string`[]
+
+An array of strings where each string represents a sentence in the input text.
+
+Example:
+const text = "Hello world! How are you today? I am fine.";
+console.log(splitSentence(text));  // returns ['Hello world!', 'How are you today?', 'I am fine.']
+
+## Defined in
+
+[packages/ai-tool/src/utils/split-sentence.ts:29](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/split-sentence.ts#L29)

package/docs/functions/stringifyYaml.md

@@ -0,0 +1,49 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / stringifyYaml
+
+# Function: stringifyYaml()
+
+## stringifyYaml(value, options)
+
+> **stringifyYaml**(`value`, `options`?): `string`
+
+Stringify a value as a YAML document.
+
+### Parameters
+
+• **value**: `any`
+
+• **options?**: `DocumentOptions` & `SchemaOptions` & `ParseOptions` & `CreateNodeOptions` & `ToStringOptions`
+
+### Returns
+
+`string`
+
+Will always include `\n` as the last character, as is expected of YAML documents.
+
+### Defined in
+
+node\_modules/.pnpm/yaml@2.5.1/node\_modules/yaml/dist/public-api.d.ts:42
+
+## stringifyYaml(value, replacer, options)
+
+> **stringifyYaml**(`value`, `replacer`?, `options`?): `string`
+
+### Parameters
+
+• **value**: `any`
+
+• **replacer?**: `null` \| `Replacer`
+
+• **options?**: `string` \| `number` \| `DocumentOptions` & `SchemaOptions` & `ParseOptions` & `CreateNodeOptions` & `ToStringOptions`
+
+### Returns
+
+`string`
+
+### Defined in
+
+node\_modules/.pnpm/yaml@2.5.1/node\_modules/yaml/dist/public-api.d.ts:43

package/docs/functions/textToDate.md

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

package/docs/functions/throwError.md

@@ -0,0 +1,37 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / throwError
+
+# Function: throwError()
+
+> **throwError**(`message`, `name`?, `status`?): `void`
+
+Throw an error
+
+## Parameters
+
+• **message**: `string`
+
+Error message
+
+• **name?**: `string` \| `Record`\<`string`, `any`\>
+
+Error name, optional
+
+• **status?**: `string` \| `number`
+
+Error status code, default to 500
+
+## Returns
+
+`void`
+
+## Throws
+
+Throws a BaseError object
+
+## Defined in
+
+node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:149