@isdk/ai-tool 0.2.0 → 0.2.1

package/docs/functions/createEmptyReadableStream.md

@@ -0,0 +1,23 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / createEmptyReadableStream
+
+# Function: createEmptyReadableStream()
+
+> **createEmptyReadableStream**(): `ReadableStream`
+
+Creates an empty ReadableStream that immediately closes upon creation.
+This function is used as a fallback for creating a ReadableStream when the response body is null or undefined,
+ensuring that the subsequent pipeline processing doesn't fail due to a lack of a stream.
+
+## Returns
+
+`ReadableStream`
+
+An empty and closed ReadableStream instance.
+
+## Defined in
+
+[packages/ai-tool/src/utils/stream/create-empty-stream.ts:8](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/stream/create-empty-stream.ts#L8)

package/docs/functions/createEndWithRepetitionDetector.md

@@ -0,0 +1,29 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / createEndWithRepetitionDetector
+
+# Function: createEndWithRepetitionDetector()
+
+> **createEndWithRepetitionDetector**(`repetitionThreshold`): (`value`) => `null` \| `RegExpExecArray`
+
+## Parameters
+
+• **repetitionThreshold**: `number`
+
+## Returns
+
+`Function`
+
+### Parameters
+
+• **value**: `string`
+
+### Returns
+
+`null` \| `RegExpExecArray`
+
+## Defined in
+
+[packages/ai-tool/src/utils/end-with-repeated-sequence.ts:3](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/end-with-repeated-sequence.ts#L3)

package/docs/functions/createError.md

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

package/docs/functions/createEventStreamTransformer.md

@@ -0,0 +1,33 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / createEventStreamTransformer
+
+# Function: createEventStreamTransformer()
+
+> **createEventStreamTransformer**\<`TValue`, `TOptions`\>(`customParser`?): `TransformStream`\<`Uint8Array`, [`AIResult`](../interfaces/AIResult.md)\<`TValue`, `TOptions`\>\>
+
+Creates a TransformStream that parses events from an EventSource stream using a custom parser.
+
+## Type Parameters
+
+• **TValue** = `any`
+
+• **TOptions** = `any`
+
+## Parameters
+
+• **customParser?**: [`AIStreamParser`](../interfaces/AIStreamParser.md)\<`any`, `any`\>
+
+Function to handle event data.
+
+## Returns
+
+`TransformStream`\<`Uint8Array`, [`AIResult`](../interfaces/AIResult.md)\<`TValue`, `TOptions`\>\>
+
+TransformStream parsing events.
+
+## Defined in
+
+[packages/ai-tool/src/utils/stream/ai-stream.ts:37](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/stream/ai-stream.ts#L37)

package/docs/functions/createHfValueFunc.md

@@ -0,0 +1,29 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / createHfValueFunc
+
+# Function: createHfValueFunc()
+
+> **createHfValueFunc**(`fn`): (`_data`) => `Function`
+
+## Parameters
+
+• **fn**: `Function`
+
+## Returns
+
+`Function`
+
+### Parameters
+
+• **\_data**: `any`
+
+### Returns
+
+`Function`
+
+## Defined in
+
+[packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:140](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/hf-prompt-template.ts#L140)

package/docs/functions/createLRUCache.md

@@ -0,0 +1,23 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / createLRUCache
+
+# Function: createLRUCache()
+
+> **createLRUCache**(`name`, `options`?): [`ToolFunc`](../classes/ToolFunc.md)
+
+## Parameters
+
+• **name**: `string`
+
+• **options?**: `number` \| `ICacheOptions`
+
+## Returns
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+## Defined in
+
+[packages/ai-tool/src/funcs/lrucache.ts:22](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/funcs/lrucache.ts#L22)

package/docs/functions/dateToText.md

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

package/docs/functions/expandEnv.md

@@ -0,0 +1,40 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / expandEnv
+
+# Function: expandEnv()
+
+> **expandEnv**(`options`): [`DotenvExpandOptions`](../interfaces/DotenvExpandOptions.md)
+
+Expand environment variables in the parsed object
+
+## Parameters
+
+• **options**: [`DotenvExpandOptions`](../interfaces/DotenvExpandOptions.md)
+
+## Returns
+
+[`DotenvExpandOptions`](../interfaces/DotenvExpandOptions.md)
+
+## Example
+
+```ts
+const myEnv = {}
+const env = {
+  processEnv: myEnv,
+  parsed: {
+    WORD: 'World',
+    HELLO: 'Hello ${WORD}'
+  }
+}
+expandEnv.expand(env)
+
+console.log(myEnv.HELLO) // Hello World
+console.log(process.env.HELLO) // undefined
+```
+
+## Defined in
+
+[packages/ai-tool/src/utils/prompt/template/env.ts:82](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/template/env.ts#L82)

package/docs/functions/expandObjEnv.md

@@ -0,0 +1,54 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / expandObjEnv
+
+# Function: expandObjEnv()
+
+> **expandObjEnv**(`obj`, `options`, `parsedObjs`?): `any`
+
+Expands environment variables in an object/array or string.
+
+This function replaces placeholders like `${VAR}` in strings and recursively
+processes objects and arrays with environment variable references.
+
+## Parameters
+
+• **obj**: `any`
+
+The object/array or string to be processed. Can be any value, but
+             primarily designed for objects, array and strings.
+
+• **options**: [`DotenvExpandOptions`](../interfaces/DotenvExpandOptions.md) = `{}`
+
+Configuration options:
+  - processEnv: - An object to source environment variables from, defaults to `process.env`.
+  - parsed: - Specify an object to provide the value of environment variables.
+
+• **parsedObjs?**: `WeakSet`\<`any`\>
+
+## Returns
+
+`any`
+
+- Returns the expanded object or string.
+
+## Example
+
+```ts
+const obj = {
+  name: 'MyApp',
+  envVar: '${ENV_VAR_NAME}',
+  config: {
+    url: 'http://${HOST}:${PORT}'
+  },
+  list: ['item1', '${ITEM2}']
+};
+// the expandedObj will have the actual values instead of placeholders.
+const expandedObj = expandObjEnv(obj, { processEnv: myCustomEnv }); // Assuming 'ENV_VAR_NAME' is defined as 'Production' and 'HOST', 'PORT', 'ITEM2' are set,
+```
+
+## Defined in
+
+[packages/ai-tool/src/utils/prompt/template/env.ts:142](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/template/env.ts#L142)

package/docs/functions/extNameLevel.md

@@ -0,0 +1,43 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / extNameLevel
+
+# Function: extNameLevel()
+
+> **extNameLevel**(`extName`): `number`
+
+Calculates the level of an extension name.
+
+The level represents the number of dots ('.') in the extension name, excluding the first dot which separates
+the base filename from the extension. For example, the level of ".txt" is 1, and the level of ".tar.gz" is 2.
+
+## Parameters
+
+• **extName**: `string`
+
+The extension name to analyze. It should start with a dot ('.').
+
+## Returns
+
+`number`
+
+The level of the extension name, which is the count of dots minus one.
+
+## Example
+
+```typescript
+// Returns 0
+extNameLevel("no-file-ext");
+
+// Returns 2
+extNameLevel(".tar.gz");
+
+// Returns 1
+extNameLevel(".json5");
+```
+
+## Defined in
+
+[packages/ai-tool/src/utils/filename.ts:209](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/filename.ts#L209)

package/docs/functions/fileIsExists.md

@@ -0,0 +1,34 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / fileIsExists
+
+# Function: fileIsExists()
+
+> **fileIsExists**(`filepath`): `undefined` \| `boolean`
+
+Checks if a file (not a directory) exists at the specified path.
+
+## Parameters
+
+• **filepath**: `string`
+
+The path to the file to check.
+
+## Returns
+
+`undefined` \| `boolean`
+
+true if the file exists and is not a directory; otherwise, false.
+
+## Example
+
+```typescript
+const exists = fileIsExists('path/to/file.txt');
+console.log(exists); // Outputs: true or false
+```
+
+## Defined in
+
+[packages/ai-tool/src/utils/load-file-from-paths.ts:18](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/load-file-from-paths.ts#L18)

package/docs/functions/filenameReservedRegex.md

@@ -0,0 +1,22 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / filenameReservedRegex
+
+# Function: filenameReservedRegex()
+
+> **filenameReservedRegex**(): `RegExp`
+
+Returns a new regular expression instance for reserved filename characters with the 'g' flag.
+use this to reset the with global option
+
+## Returns
+
+`RegExp`
+
+A compiled regular expression for reserved filename characters.
+
+## Defined in
+
+[packages/ai-tool/src/utils/filename.ts:42](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/filename.ts#L42)

package/docs/functions/filterValidFnScope.md

@@ -0,0 +1,21 @@
+[**@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:33](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/parse-js-json.ts#L33)

package/docs/functions/findPort.md

@@ -0,0 +1,23 @@
+[**@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/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/find-port.ts#L3)

package/docs/functions/formatISO.md

@@ -0,0 +1,71 @@
+[**@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/getAllEnumKeys.md

@@ -0,0 +1,31 @@
+[**@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/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/get-all-enum-keys.ts#L7)

package/docs/functions/getConfigFileNames.md

@@ -0,0 +1,23 @@
+[**@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:56](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/config.ts#L56)

package/docs/functions/getConfigs.md

@@ -0,0 +1,23 @@
+[**@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:80](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/config.ts#L80)

package/docs/functions/getKeysPath.md

@@ -0,0 +1,38 @@
+[**@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/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/get-keys-path.ts#L16)

package/docs/functions/getMultiLevelExtname.md

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