@isdk/ai-tool 0.5.8 → 0.7.0

package/docs/{classes → api/classes}/CommonError.md

@@ -6,7 +6,7 @@
 
 # Class: CommonError
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:95
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:106
 
 BaseError class that extends the Error class.
 
@@ -54,7 +54,7 @@ fromJSON - Creates a new BaseError instance from a JSON representation.
 
 > **new CommonError**(`message`, `name`?, `status`?): [`CommonError`](CommonError.md)
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:102
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:113
 
 #### Parameters
 
@@ -84,7 +84,7 @@ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/com
 
 > **caller**: `string`
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:63
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:63
 
 The name of the function that threw the error.
 
@@ -98,7 +98,7 @@ The name of the function that threw the error.
 
 > `optional` **cause**: `unknown`
 
-Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
 
 #### Inherited from
 
@@ -110,7 +110,7 @@ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/li
 
 > **code**: `ErrorCodeType`
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:64
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:64
 
 the error code
 
@@ -124,7 +124,7 @@ the error code
 
 > `optional` **data**: `any`
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:65
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:65
 
 Additional data associated with the error.
 
@@ -138,7 +138,7 @@ Additional data associated with the error.
 
 > **message**: `string`
 
-Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
 
 #### Inherited from
 
@@ -150,7 +150,7 @@ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/li
 
 > **name**: `string`
 
-Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
 
 #### Inherited from
 
@@ -162,7 +162,7 @@ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/li
 
 > `optional` **stack**: `string`
 
-Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
 
 #### Inherited from
 
@@ -174,7 +174,7 @@ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/li
 
 > `static` **code**: `ErrorCodeType`
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:62
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:62
 
 The error code associated with the error.
 
@@ -184,43 +184,21 @@ The error code associated with the error.
 
 ***
 
-### prepareStackTrace()?
-
-> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
-
-Defined in: node\_modules/.pnpm/@types+node@22.10.5/node\_modules/@types/node/globals.d.ts:143
-
-Optional override for formatting stack traces
-
-#### Parameters
-
-##### err
-
-`Error`
-
-##### stackTraces
+### stackTraceLimit
 
-`CallSite`[]
+> `static` **stackTraceLimit**: `number`
 
-#### Returns
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@types+node@24.3.0/node\_modules/@types/node/globals.d.ts:162
 
-`any`
+The `Error.stackTraceLimit` property specifies the number of stack frames
+collected by a stack trace (whether generated by `new Error().stack` or
+`Error.captureStackTrace(obj)`).
 
-#### See
+The default value is `10` but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured _after_ the value has been changed.
 
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
-#### Inherited from
-
-[`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace)
-
-***
-
-### stackTraceLimit
-
-> `static` **stackTraceLimit**: `number`
-
-Defined in: node\_modules/.pnpm/@types+node@22.10.5/node\_modules/@types/node/globals.d.ts:145
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
 
 #### Inherited from
 
@@ -232,9 +210,7 @@ Defined in: node\_modules/.pnpm/@types+node@22.10.5/node\_modules/@types/node/gl
 
 > **fromJSON**(`json`): [`BaseError`](BaseError.md)
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:93
-
-Creates a new BaseError instance from a JSON representation.
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:104
 
 #### Parameters
 
@@ -242,14 +218,10 @@ Creates a new BaseError instance from a JSON representation.
 
 `any`
 
-A JSON representation of the error.
-
 #### Returns
 
 [`BaseError`](BaseError.md)
 
-A new BaseError instance.
-
 #### Inherited from
 
 [`BaseError`](BaseError.md).[`fromJSON`](BaseError.md#fromjson)
@@ -260,7 +232,7 @@ A new BaseError instance.
 
 > **toJSON**(): `any`
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:86
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:86
 
 Returns a JSON representation of the error.
 
@@ -280,9 +252,51 @@ A JSON representation of the error.
 
 > `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
 
-Defined in: node\_modules/.pnpm/@types+node@22.10.5/node\_modules/@types/node/globals.d.ts:136
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@types+node@24.3.0/node\_modules/@types/node/globals.d.ts:146
 
-Create .stack property on a target object
+Creates a `.stack` property on `targetObject`, which when accessed returns
+a string representing the location in the code at which
+`Error.captureStackTrace()` was called.
+
+```js
+const myObject = {};
+Error.captureStackTrace(myObject);
+myObject.stack;  // Similar to `new Error().stack`
+```
+
+The first line of the trace will be prefixed with
+`${myObject.name}: ${myObject.message}`.
+
+The optional `constructorOpt` argument accepts a function. If given, all frames
+above `constructorOpt`, including `constructorOpt`, will be omitted from the
+generated stack trace.
+
+The `constructorOpt` argument is useful for hiding implementation
+details of error generation from the user. For instance:
+
+```js
+function a() {
+  b();
+}
+
+function b() {
+  c();
+}
+
+function c() {
+  // Create an error without stack trace to avoid calculating the stack trace twice.
+  const { stackTraceLimit } = Error;
+  Error.stackTraceLimit = 0;
+  const error = new Error();
+  Error.stackTraceLimit = stackTraceLimit;
+
+  // Capture the stack trace above function b
+  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
+  throw error;
+}
+
+a();
+```
 
 #### Parameters
 
@@ -308,7 +322,7 @@ Create .stack property on a target object
 
 > `static` **create**(`__namedParameters`): [`CommonError`](CommonError.md)
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:96
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:107
 
 #### Parameters
 
@@ -344,7 +358,7 @@ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/com
 
 > `static` **createErrorClass**(`aType`, `aErrorCode`?, `ParentErrorClass`?): *typeof* [`BaseError`](BaseError.md)
 
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:66
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:66
 
 Create an Error Class
 
@@ -375,3 +389,74 @@ the new Error Class
 #### Inherited from
 
 [`BaseError`](BaseError.md).[`createErrorClass`](BaseError.md#createerrorclass)
+
+***
+
+### fromJSON()
+
+> `static` **fromJSON**(`json`): [`BaseError`](BaseError.md)
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:103
+
+Creates a new error instance from a JSON representation.
+This method is useful for deserializing an error that was serialized with `toJSON`.
+
+#### Parameters
+
+##### json
+
+`any`
+
+A JSON object representing the error.
+
+#### Returns
+
+[`BaseError`](BaseError.md)
+
+A new instance of the error class (or a subclass).
+
+#### Example
+
+```ts
+const originalError = new NotFoundError('thing');
+const json = originalError.toJSON();
+
+// Deserialize
+const newError = NotFoundError.fromJSON(json);
+console.log(newError instanceof NotFoundError); // true
+console.log(newError.message); // 'Could not find thing.'
+```
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`fromJSON`](BaseError.md#fromjson-2)
+
+***
+
+### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@types+node@24.3.0/node\_modules/@types/node/globals.d.ts:150
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`[]
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace)

package/docs/api/classes/ConfigFile.md

@@ -0,0 +1,218 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ConfigFile
+
+# Class: ConfigFile
+
+Defined in: @isdk/util/dist/index.d.ts:30
+
+Represents a configuration file utility class that provides methods to load and save configuration files.
+It supports multiple file formats such as YAML, JSON, etc., by registering corresponding parsers and stringifiers.
+
+## Example
+
+```typescript
+// Register a custom file type handler
+ConfigFile.register('.custom', (content) => {
+  return { data: content.toUpperCase() }; // Example parser
+}, (obj) => {
+  return obj.data.toLowerCase(); // Example stringifier
+});
+
+// Save a configuration file
+ConfigFile.saveSync('config.custom', { key: 'value' });
+
+// Load a configuration file
+const config = ConfigFile.loadSync('config.custom');
+console.log(config); // Output: { key: 'value' }
+```
+
+## Constructors
+
+### new ConfigFile()
+
+> **new ConfigFile**(): [`ConfigFile`](ConfigFile.md)
+
+#### Returns
+
+[`ConfigFile`](ConfigFile.md)
+
+## Properties
+
+### stringifys
+
+> `static` **stringifys**: `Record`\<`string`, `StringifyFunc`\>
+
+Defined in: @isdk/util/dist/index.d.ts:34
+
+A record of registered stringify functions for different file extensions.
+
+## Methods
+
+### existsSync()
+
+> `static` **existsSync**(`filename`, `options`?): `boolean`
+
+Defined in: @isdk/util/dist/index.d.ts:102
+
+Checks if a configuration file exists at the specified path.
+
+This method normalizes the filename by removing the extension (if present) and then delegates
+to the underlying LoadConfigFile utility to perform the existence check. The normalization
+ensures consistent handling of files regardless of whether they include extensions in the
+provided filename.
+
+#### Parameters
+
+##### filename
+
+`string`
+
+The path to the configuration file to check for existence.
+                 This can include or omit the file extension.
+
+##### options?
+
+`LoadConfigFileOptions`
+
+Optional configuration options that may affect how the file existence
+                is checked, including extension level handling.
+
+#### Returns
+
+`boolean`
+
+`true` if the configuration file exists, `false` otherwise.
+
+#### Example
+
+```typescript
+// Check if a YAML config file exists
+const exists = ConfigFile.existsSync('config.yaml');
+console.log(exists); // true or false
+
+// Check with options
+const existsWithExt = ConfigFile.existsSync('config', { extLevel: 2 });
+console.log(existsWithExt); // true or false
+```
+
+***
+
+### loadSync()
+
+> `static` **loadSync**(`filename`, `options`?): `any`
+
+Defined in: @isdk/util/dist/index.d.ts:61
+
+Loads a configuration file based on the provided filename and options.
+
+#### Parameters
+
+##### filename
+
+`string`
+
+The path to the configuration file.
+
+##### options?
+
+`LoadConfigFileOptions`
+
+Additional options for loading the configuration file.
+
+#### Returns
+
+`any`
+
+The parsed configuration object.
+
+#### Example
+
+```typescript
+const config = ConfigFile.loadSync('config.yaml');
+console.log(config); // Output: { key: 'value' }
+```
+
+***
+
+### register()
+
+> `static` **register**(`extname`, `parser`, `stringify`): `void`
+
+Defined in: @isdk/util/dist/index.d.ts:47
+
+Registers a parser and stringifier for specific file extensions.
+
+#### Parameters
+
+##### extname
+
+The file extension(s) to register the parser and stringifier for.
+
+`string` | `string`[]
+
+##### parser
+
+(`content`) => `any`
+
+A function that parses the file content into an object.
+
+##### stringify
+
+`StringifyFunc`
+
+A function that converts an object back into file content.
+
+#### Returns
+
+`void`
+
+#### Example
+
+```typescript
+ConfigFile.register(['.json'], JSON.parse, (obj) => JSON.stringify(obj, null, 2));
+```
+
+***
+
+### saveSync()
+
+> `static` **saveSync**(`filename`, `config`, `options`?): `string`
+
+Defined in: @isdk/util/dist/index.d.ts:75
+
+Saves a configuration object to a file with the specified filename and options.
+
+#### Parameters
+
+##### filename
+
+`string`
+
+The path where the configuration file should be saved.
+
+##### config
+
+`any`
+
+The configuration object to save.
+
+##### options?
+
+`LoadConfigFileOptions`
+
+Additional options for saving the configuration file.
+
+#### Returns
+
+`string`
+
+The final filename where the configuration was saved.
+
+#### Example
+
+```typescript
+ConfigFile.saveSync('config.json', { key: 'value' });
+```