@isdk/ai-tool 0.5.2 → 0.5.4

package/docs/functions/eventable.md

@@ -0,0 +1,82 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / eventable
+
+# Function: eventable()
+
+> **eventable**\<`T`\>(`targetClass`?, `options`?): `T` & (`aClass`?) => `Function` & `T` *extends* (...`args`) => `any` ? `InstanceType`\<`T`\<`T`\>\> : `T`
+
+Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/eventable.d.ts:48
+
+Adds event-emitting capabilities to a class by injecting necessary methods and properties.
+
+This function uses `createAbilityInjector` from `custom-ability` to inject event-related methods
+into the target class. The injected methods include standard EventEmitter functionality such as
+`on`, `off`, `emit`, `emitAsync`, `once`, `listeners`, `@listenerCount` and more. It also ensures compatibility with Node.js `EventEmitter`
+by including methods like `listenerCount`, `setMaxListeners`, `addListener`, `removeListener`, and `removeAllListeners`.
+
+## Type Parameters
+
+• **T** *extends* `Function` \| (...`args`) => `any`
+
+## Parameters
+
+### targetClass?
+
+`T`
+
+### options?
+
+`AbilityOptions`
+
+Optional configuration for the injection process:
+  * `include` (string[]|string): Specifies which methods should be added.
+    Static methods should use the prefix '@'.
+  * `exclude` (string[]|string): Specifies which methods should not be added.
+    Static methods should use the prefix '@'.
+  * `methods` (Object): Custom methods to override or extend the default behavior.
+    Use `this.super()` to call the original method and `this.self` to access the original context.
+  * `classMethods` (Object): Custom static methods to be added to the class.
+
+## Returns
+
+`T` & (`aClass`?) => `Function` & `T` *extends* (...`args`) => `any` ? `InstanceType`\<`T`\<`T`\>\> : `T`
+
+The same `aClass` class with event capabilities injected. The return value is the modified `aClass` itself.
+
+## Function
+
+eventable
+
+## Examples
+
+```ts
+import { eventable } from 'events-ex';
+
+class MyClass {}
+
+// Inject only specific methods: 'on', 'off', 'emit', 'emitAsync', and the static 'listenerCount'
+eventable(MyClass, { include: ['on', 'off', 'emit', 'emitAsync', '@listenerCount'] });
+```
+
+```ts
+import { eventable } from 'events-ex';
+
+class OtherClass {
+  exec() {
+    console.log("Original exec");
+  }
+}
+
+// Inject event capabilities and override the `exec` method
+eventable(OtherClass, {
+  methods: {
+    exec() {
+      console.log("New exec");
+      this.super(); // Calls the original `exec` method
+    }
+  }
+});
+```

package/docs/functions/expandConfig.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / expandConfig
+
+# Function: expandConfig()
+
+> **expandConfig**(`config`, `defaultConfig`): `any`
+
+Defined in: [packages/ai-tool/src/utils/load-config.ts:18](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-config.ts#L18)
+
+## Parameters
+
+### config
+
+`any`
+
+### defaultConfig
+
+`any`
+
+## Returns
+
+`any`

package/docs/functions/expandEnv.md

@@ -0,0 +1,40 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / expandEnv
+
+# Function: expandEnv()
+
+> **expandEnv**(`options`): [`DotenvExpandOptions`](../interfaces/DotenvExpandOptions.md)
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:97](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/env.ts#L97)
+
+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
+```

package/docs/functions/expandObjEnv.md

@@ -0,0 +1,58 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / expandObjEnv
+
+# Function: expandObjEnv()
+
+> **expandObjEnv**(`obj`, `options`, `parsedObjs`?): `any`
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:157](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/env.ts#L157)
+
+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,
+```

package/docs/functions/expandPath.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / expandPath
+
+# Function: expandPath()
+
+> **expandPath**(`path`, `config`?): `any`
+
+Defined in: [packages/ai-tool/src/utils/load-config.ts:67](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-config.ts#L67)
+
+## Parameters
+
+### path
+
+`string`
+
+### config?
+
+`any`
+
+## Returns
+
+`any`

package/docs/functions/extNameLevel.md

@@ -0,0 +1,43 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / extNameLevel
+
+# Function: extNameLevel()
+
+> **extNameLevel**(`extName`): `number`
+
+Defined in: [packages/ai-tool/src/utils/filename.ts:209](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/filename.ts#L209)
+
+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");
+```

package/docs/functions/fileIsExists.md

@@ -0,0 +1,34 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / fileIsExists
+
+# Function: fileIsExists()
+
+> **fileIsExists**(`filepath`): `undefined` \| `boolean`
+
+Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-file-from-paths.ts#L23)
+
+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
+```

package/docs/functions/filenameReservedRegex.md

@@ -0,0 +1,20 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / filenameReservedRegex
+
+# Function: filenameReservedRegex()
+
+> **filenameReservedRegex**(): `RegExp`
+
+Defined in: [packages/ai-tool/src/utils/filename.ts:42](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/filename.ts#L42)
+
+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.

package/docs/functions/filterValidFnScope.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / filterValidFnScope
+
+# Function: filterValidFnScope()
+
+> **filterValidFnScope**(`scope`?): `undefined` \| `Record`\<`string`, `any`\>
+
+Defined in: [packages/ai-tool/src/utils/parse-js-json.ts:58](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-js-json.ts#L58)
+
+## Parameters
+
+### scope?
+
+`Record`\<`string`, `any`\>
+
+## Returns
+
+`undefined` \| `Record`\<`string`, `any`\>

package/docs/functions/findIndexNonEmptyFrom.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / findIndexNonEmptyFrom
+
+# Function: findIndexNonEmptyFrom()
+
+> **findIndexNonEmptyFrom**(`arr`, `start`): `number`
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:282](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/split-sentence.ts#L282)
+
+## Parameters
+
+### arr
+
+`any`[]
+
+### start
+
+`number` = `0`
+
+## Returns
+
+`number`

package/docs/functions/findPort.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / findPort
+
+# Function: findPort()
+
+> **findPort**(`port`, `portRetryCount`): `Promise`\<`number`\>
+
+Defined in: [packages/ai-tool/src/utils/find-port.ts:3](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/find-port.ts#L3)
+
+## Parameters
+
+### port
+
+`string` | `number`
+
+### portRetryCount
+
+`number` = `10`
+
+## Returns
+
+`Promise`\<`number`\>

package/docs/functions/formatISO.md

@@ -0,0 +1,69 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / formatISO
+
+# Function: formatISO()
+
+> **formatISO**(`date`, `options`?): `string`
+
+Defined in: node\_modules/.pnpm/date-fns@4.1.0/node\_modules/date-fns/formatISO.d.ts:43
+
+## Parameters
+
+### date
+
+The original date
+
+`string` | `number` | `Date`
+
+### options?
+
+`FormatISOOptions`
+
+An object with options.
+
+## Returns
+
+`string`
+
+The formatted date string (in local time zone)
+
+## Name
+
+formatISO
+
+## 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'
+```

package/docs/functions/formatTextWithSpace.md

@@ -0,0 +1,63 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / formatTextWithSpace
+
+# Function: formatTextWithSpace()
+
+> **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/7135b3a67072644f21685b76900b7f351401749e/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`
+
+The input string to be formatted.
+
+### options?
+
+Optional configuration for formatting.
+
+#### capitalize?
+
+`boolean`
+
+Whether to capitalize the first letter of each word. Defaults to `true`.
+
+#### delimiter?
+
+`string` \| `RegExp`
+
+The delimiter used to split the words. Defaults to `/[_-]/g`.
+
+## Returns
+
+`string`
+
+## Examples
+
+```ts
+// Returns "Hello World"
+formatTextWithSpace("hello_world");
+```
+
+```ts
+// Returns "This Is A Test"
+formatTextWithSpace("this-is-a-test", { delimiter: /-/g });
+```
+
+```ts
+// Returns "hello world"
+formatTextWithSpace("hello_world", { capitalize: false });
+```
+
+```ts
+// Returns "Hello World This Is A Test"
+formatTextWithSpace("hello-world_this_is_a_test");
+```

package/docs/functions/getAllEnumKeys.md

@@ -0,0 +1,31 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / getAllEnumKeys
+
+# Function: getAllEnumKeys()
+
+> **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/7135b3a67072644f21685b76900b7f351401749e/src/utils/get-all-enum-keys.ts#L7)
+
+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 `T`[]
+
+An array containing all string keys of the specified enumeration.

package/docs/functions/getConfigFileNames.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / getConfigFileNames
+
+# Function: getConfigFileNames()
+
+> **getConfigFileNames**(`directoryPath`, `filter`?): `string`[]
+
+Defined in: [packages/ai-tool/src/utils/config.ts:85](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/config.ts#L85)
+
+## Parameters
+
+### directoryPath
+
+`string`
+
+### filter?
+
+`ConfigFilesFilter`
+
+## Returns
+
+`string`[]

package/docs/functions/getConfigs.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / getConfigs
+
+# Function: getConfigs()
+
+> **getConfigs**(`directoryPath`, `filter`?): `any`[]
+
+Defined in: [packages/ai-tool/src/utils/config.ts:109](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/config.ts#L109)
+
+## Parameters
+
+### directoryPath
+
+`string`
+
+### filter?
+
+`ConfigFilesFilter`
+
+## Returns
+
+`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/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/env.ts#L17)
+
+## Parameters
+
+### value
+
+`string`
+
+## Returns
+
+`string`[]

package/docs/functions/getFileMetaInfo.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / getFileMetaInfo
+
+# Function: getFileMetaInfo()
+
+> **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/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-file-from-paths.ts#L221)
+
+## Parameters
+
+### filepath
+
+`string`
+
+## Returns
+
+`Promise`\<[`IFileMetaInfo`](../interfaces/IFileMetaInfo.md)\>

package/docs/functions/getHashAlgoBySize.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / getHashAlgoBySize
+
+# Function: getHashAlgoBySize()
+
+> **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/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-file-from-paths.ts#L234)
+
+## Parameters
+
+### size
+
+`number`
+
+## Returns
+
+[`HashAlgorithm`](../enumerations/HashAlgorithm.md)