@isdk/ai-tool 0.2.0 → 0.2.1

package/docs/functions/getPackageDir.md

@@ -0,0 +1,39 @@
+[**@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/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/get-package-dir.ts#L18)

package/docs/functions/getRealFilepath.md

@@ -0,0 +1,34 @@
+[**@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:172](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/load-file-from-paths.ts#L172)

package/docs/functions/getResponseErrorReadableStream.md

@@ -0,0 +1,21 @@
+[**@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/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/stream/error-readable-stream.ts#L12)

package/docs/functions/hfParse.md

@@ -0,0 +1,24 @@
+[**@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/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/template/jinja/src/parser.ts#L32)

package/docs/functions/hfTokenize.md

@@ -0,0 +1,25 @@
+[**@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/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/template/jinja/src/lexer.ts#L200)

package/docs/functions/interpolateEnv.md

@@ -0,0 +1,25 @@
+[**@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/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/template/env.ts#L17)

package/docs/functions/interpolateFString.md

@@ -0,0 +1,27 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / interpolateFString
+
+# Function: interpolateFString()
+
+> **interpolateFString**(`nodes`, `values`): `string`
+
+Type that represents a function that takes a template string and a set
+of input values, and returns a string where all variables in the
+template have been replaced with their corresponding values.
+
+## Parameters
+
+• **nodes**: [`FStringPromptTemplateNode`](../type-aliases/FStringPromptTemplateNode.md)[]
+
+• **values**: `Record`\<`string`, `any`\>
+
+## Returns
+
+`string`
+
+## Defined in
+
+[packages/ai-tool/src/utils/prompt/template/python.ts:71](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/template/python.ts#L71)

package/docs/functions/interpolateGolangTemplate.md

@@ -0,0 +1,31 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / interpolateGolangTemplate
+
+# Function: interpolateGolangTemplate()
+
+> **interpolateGolangTemplate**(`str`, `variables`, `initVars`?): `string`
+
+Parse and interpolate template
+
+## Parameters
+
+• **str**: `string`
+
+golang style template
+
+• **variables**: `Record`\<`string`, `any`\>
+
+object of variables to insert
+
+• **initVars?**: `boolean`
+
+## Returns
+
+`string`
+
+## Defined in
+
+[packages/ai-tool/src/utils/prompt/template/golang.ts:269](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/template/golang.ts#L269)

package/docs/functions/isModelNameMatched.md

@@ -0,0 +1,45 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / isModelNameMatched
+
+# Function: isModelNameMatched()
+
+> **isModelNameMatched**(`modelName`, `rule`?): `undefined` \| `string` \| `RegExpExecArray`
+
+Checks if the provided model name matches the given rule.
+
+## Parameters
+
+• **modelName**: `string`
+
+The name of the model to check.
+
+• **rule?**: [`AIModelNameRules`](../type-aliases/AIModelNameRules.md)
+
+An optional rule that can be a string, an array of strings, a regular expression, or a function.
+
+## Returns
+
+`undefined` \| `string` \| `RegExpExecArray`
+
+matched result if the model name matches the rule, undefined otherwise.
+
+## Example
+
+```ts
+IsModelNameMatched("gpt-3", "gpt-3") // returns true
+IsModelNameMatched("GPT-3", "gpt-3") // returns true
+IsModelNameMatched("GPT-3", ["gpt-3", "gpt-4"]) // returns true
+IsModelNameMatched("gpt-3", /^gpt-\d+$/) // returns true
+IsModelNameMatched("gpt-3", (modelName) => modelName.startsWith("gpt-")) // returns true
+IsModelNameMatched("gpt-2", "gpt-3") // returns false
+IsModelNameMatched("gpt-2", ["gpt-3", "gpt-4"]) // returns false
+IsModelNameMatched("gpt-2", /^gpt-\d+$/) // returns false
+IsModelNameMatched("gpt-2", (modelName) => modelName.startsWith("gpt-")) // returns false
+```
+
+## Defined in
+
+[packages/ai-tool/src/utils/is-model-name-matched.ts:21](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/is-model-name-matched.ts#L21)

package/docs/functions/isValidFilename.md

@@ -0,0 +1,38 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / isValidFilename
+
+# Function: isValidFilename()
+
+> **isValidFilename**(`filename`): `boolean` \| `""`
+
+Validates if a given string is a valid filename.
+
+## Parameters
+
+• **filename**: `string`
+
+The filename to be validated.
+
+## Returns
+
+`boolean` \| `""`
+
+True if the filename is valid, false otherwise.
+
+## Throws
+
+If the input is not a string.
+
+## Example
+
+```ts
+isValidFilename('myFile.txt'); // Returns true
+isValidFilename('my<file.txt'); // Returns false
+```
+
+## Defined in
+
+[packages/ai-tool/src/utils/filename.ts:63](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/filename.ts#L63)

package/docs/functions/isValidFilepath.md

@@ -0,0 +1,27 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / isValidFilepath
+
+# Function: isValidFilepath()
+
+> **isValidFilepath**(`filepath`): `boolean`
+
+Validates whether the given filepath is valid.
+
+## Parameters
+
+• **filepath**: `string`
+
+The filepath to be checked, represented as a string.
+
+## Returns
+
+`boolean`
+
+A boolean indicating whether the filepath is valid. Returns true if valid; false otherwise.
+
+## Defined in
+
+[packages/ai-tool/src/utils/filename.ts:72](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/filename.ts#L72)

package/docs/functions/isWebStream.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / isWebStream
+
+# Function: isWebStream()
+
+> **isWebStream**(`val`): val is ReadableStream\<any\> \| WritableStream\<any\>
+
+## Parameters
+
+• **val**: `any`
+
+## Returns
+
+val is ReadableStream\<any\> \| WritableStream\<any\>
+
+## Defined in
+
+[packages/ai-tool/src/utils/stream/is-web-stream.ts:1](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/stream/is-web-stream.ts#L1)

package/docs/functions/jsonFilterToWhere.md

@@ -0,0 +1,45 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / jsonFilterToWhere
+
+# Function: jsonFilterToWhere()
+
+> **jsonFilterToWhere**(`filter`, `wrapKey`?): `string`
+
+Converts a filter object to a SQLite WHERE clause.
+
+## Parameters
+
+• **filter**: [`JsonFilter`](../interfaces/JsonFilter.md) \| [`JsonFilter`](../interfaces/JsonFilter.md)[]
+
+The filter object to convert.
+
+• **wrapKey?**
+
+## Returns
+
+`string`
+
+The generated WHERE clause.
+
+## Example
+
+```ts
+const jsonFilter: Filter = {
+  $and: [
+    { age: { $gt: 18, $lt: 30 } },
+    { name: { $like: 'John%', $nlike: 'Doe%' } },
+    { hobbies: { $in: ['reading', 'writing'] } },
+    { $or: [{ gender: 'male' }, { country: 'USA' }] },
+    { $and: [{ status: 'active' }, { registered: new Date('2020-01-01') }] },
+  ],
+};
+
+console.log(jsonFilterToWhere(jsonFilter)); // Outputs a WHERE clause based on the given filter
+```
+
+## Defined in
+
+[packages/ai-tool/src/utils/json-filter.ts:123](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/json-filter.ts#L123)

package/docs/functions/jsonToMarkdownStr.md

@@ -0,0 +1,31 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / jsonToMarkdownStr
+
+# Function: jsonToMarkdownStr()
+
+> **jsonToMarkdownStr**(`mem`, `options`?): `string`
+
+## Parameters
+
+• **mem**: `any`
+
+• **options?**
+
+• **options.arrayTag?**: `string`
+
+• **options.level?**: `number`
+
+• **options.objectTag?**: `string`
+
+• **options.visiting?**: `Set`\<`any`\>
+
+## Returns
+
+`string`
+
+## Defined in
+
+[packages/ai-tool/src/utils/json-to-markdown-str.ts:2](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/json-to-markdown-str.ts#L2)

package/docs/functions/loadFileFromPaths.md

@@ -0,0 +1,54 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / loadFileFromPaths
+
+# Function: loadFileFromPaths()
+
+> **loadFileFromPaths**(`filename`, `searchPaths`?, `extNames`?, `options`?): `Buffer`
+
+Loads a file from given paths, optionally searching for specific extensions.
+
+## Parameters
+
+• **filename**: `string`
+
+The base filename to search for, without any file extension.
+
+• **searchPaths?**: `string`[]
+
+An array of directories to search for the file. Defaults to the current directory (`"."`) if not provided.
+
+• **extNames?**: `string`[]
+
+An array of file extensions to try, in order of preference. If not provided, the file will be searched for
+                  without any extension.
+
+• **options?**
+
+• **options.exclude?**: `string` \| `string`[]
+
+• **options.filepath?**: `string`
+
+• **options.signal?**: `AbortSignal`
+
+## Returns
+
+`Buffer`
+
+The contents of the found file as a Buffer.
+
+## Throws
+
+If the file is not found in any of the search paths.
+
+## Example
+
+```typescript
+const content = loadFileFromPaths('config', ['/etc', '/usr/local/etc'], ['.json', '.yaml']);
+```
+
+## Defined in
+
+[packages/ai-tool/src/utils/load-file-from-paths.ts:39](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/load-file-from-paths.ts#L39)

package/docs/functions/loadTextFromPaths.md

@@ -0,0 +1,29 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / loadTextFromPaths
+
+# Function: loadTextFromPaths()
+
+> **loadTextFromPaths**(`filename`, `searchPaths`?, `extNames`?, `options`?, `exclude`?): `string`
+
+## Parameters
+
+• **filename**: `string`
+
+• **searchPaths?**: `string`[]
+
+• **extNames?**: `string`[]
+
+• **options?**: `BufferEncoding` \| `object`
+
+• **exclude?**: `string` \| `string`[]
+
+## Returns
+
+`string`
+
+## Defined in
+
+[packages/ai-tool/src/utils/load-file-from-paths.ts:96](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/load-file-from-paths.ts#L96)

package/docs/functions/lrucache.md

@@ -0,0 +1,29 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / \_lrucache
+
+# Function: \_lrucache()
+
+> **\_lrucache**(`this`, `__namedParameters`): `_Cache`
+
+## Parameters
+
+• **this**: [`ToolFunc`](../classes/ToolFunc.md)
+
+• **\_\_namedParameters** = `{}`
+
+• **\_\_namedParameters.key?**: `string`
+
+• **\_\_namedParameters.options?**: `number` \| `ICacheOptions`
+
+• **\_\_namedParameters.value?**: `any`
+
+## Returns
+
+`_Cache`
+
+## Defined in
+
+[packages/ai-tool/src/funcs/lrucache.ts:6](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/funcs/lrucache.ts#L6)

package/docs/functions/makeToolFuncCancelable.md

@@ -0,0 +1,23 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / makeToolFuncCancelable
+
+# Function: makeToolFuncCancelable()
+
+> **makeToolFuncCancelable**(`Tool`, `options`?): *typeof* [`ToolFunc`](../classes/ToolFunc.md)
+
+## Parameters
+
+• **Tool**: *typeof* [`ToolFunc`](../classes/ToolFunc.md)
+
+• **options?**: [`CancelableAbilityOptions`](../interfaces/CancelableAbilityOptions.md)
+
+## Returns
+
+*typeof* [`ToolFunc`](../classes/ToolFunc.md)
+
+## Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:340](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/cancelable-ability.ts#L340)

package/docs/functions/matchUrlProtocol.md

@@ -0,0 +1,48 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / matchUrlProtocol
+
+# Function: matchUrlProtocol()
+
+> **matchUrlProtocol**(`name`): `undefined` \| `string`
+
+Extracts the protocol part from a URL-like string.
+
+This function checks a given string to find the protocol section of a URL.
+If the string contains the sequence '://', it returns the substring from the start of the string
+up to the '//' characters. If the sequence is not found, the function returns undefined.
+
+## Parameters
+
+• **name**: `string`
+
+The string to inspect, expected to contain a URL.
+
+## Returns
+
+`undefined` \| `string`
+
+- The protocol part if '://' is found; otherwise, undefined.
+
+## Examples
+
+```ts
+// Returns "http"
+matchUrlProtocol("http://example.com");
+```
+
+```ts
+// Returns "ftp"
+matchUrlProtocol("ftp://myftpserver.com");
+```
+
+```ts
+// Returns undefined
+matchUrlProtocol("noProtocolHere");
+```
+
+## Defined in
+
+[packages/ai-tool/src/utils/match-url-protocol.ts:23](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/match-url-protocol.ts#L23)

package/docs/functions/memoize.md

@@ -0,0 +1,27 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / memoize
+
+# Function: memoize()
+
+> **memoize**\<`F`\>(`fn`, `options`?): `F` & `Memoized`\<`F`\>
+
+## Type Parameters
+
+• **F** *extends* (...`args`) => `any`
+
+## Parameters
+
+• **fn**: `any`
+
+• **options?**: `Options`\<`F`\>
+
+## Returns
+
+`F` & `Memoized`\<`F`\>
+
+## Defined in
+
+[packages/ai-tool/src/utils/memoize.ts:14](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/memoize.ts#L14)

package/docs/functions/messagesToText.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / messagesToText
+
+# Function: messagesToText()
+
+> **messagesToText**(`messages`): `string`
+
+## Parameters
+
+• **messages**: [`AIChatMessageParamBase`](../interfaces/AIChatMessageParamBase.md)[]
+
+## Returns
+
+`string`
+
+## Defined in
+
+[packages/ai-tool/src/utils/chat.ts:116](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/chat.ts#L116)