@isdk/ai-tool 0.6.0 → 0.7.0

package/docs/api/classes/NotImplementationError.md

@@ -0,0 +1,431 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / NotImplementationError
+
+# Class: NotImplementationError
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:124
+
+Represents an error when a function or method is not implemented.
+Inherits from BaseError.
+
+## Example
+
+```ts
+throw new NotImplementationError()
+```
+
+## Extends
+
+- [`CommonError`](CommonError.md)
+
+## Constructors
+
+### new NotImplementationError()
+
+> **new NotImplementationError**(`msg`?, `name`?): [`NotImplementationError`](NotImplementationError.md)
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:125
+
+#### Parameters
+
+##### msg?
+
+`string`
+
+##### name?
+
+`string` | `Record`\<`string`, `any`\>
+
+#### Returns
+
+[`NotImplementationError`](NotImplementationError.md)
+
+#### Overrides
+
+[`CommonError`](CommonError.md).[`constructor`](CommonError.md#constructors)
+
+## Properties
+
+### caller
+
+> **caller**: `string`
+
+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.
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`caller`](CommonError.md#caller)
+
+***
+
+### cause?
+
+> `optional` **cause**: `unknown`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`cause`](CommonError.md#cause)
+
+***
+
+### code
+
+> **code**: `ErrorCodeType`
+
+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
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`code`](CommonError.md#code)
+
+***
+
+### data?
+
+> `optional` **data**: `any`
+
+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.
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`data`](CommonError.md#data)
+
+***
+
+### message
+
+> **message**: `string`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`message`](CommonError.md#message-1)
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`name`](CommonError.md#name-1)
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`stack`](CommonError.md#stack)
+
+***
+
+### code
+
+> `static` **code**: `ErrorCodeType`
+
+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.
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`code`](CommonError.md#code-1)
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@types+node@24.3.0/node\_modules/@types/node/globals.d.ts:162
+
+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)`).
+
+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.
+
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`stackTraceLimit`](CommonError.md#stacktracelimit)
+
+## Methods
+
+### fromJSON()
+
+> **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:104
+
+#### Parameters
+
+##### json
+
+`any`
+
+#### Returns
+
+[`BaseError`](BaseError.md)
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`fromJSON`](CommonError.md#fromjson)
+
+***
+
+### toJSON()
+
+> **toJSON**(): `any`
+
+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.
+
+#### Returns
+
+`any`
+
+A JSON representation of the error.
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`toJSON`](CommonError.md#tojson)
+
+***
+
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
+
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@types+node@24.3.0/node\_modules/@types/node/globals.d.ts:146
+
+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
+
+##### targetObject
+
+`object`
+
+##### constructorOpt?
+
+`Function`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`captureStackTrace`](CommonError.md#capturestacktrace)
+
+***
+
+### create()
+
+> `static` **create**(`__namedParameters`): [`CommonError`](CommonError.md)
+
+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
+
+##### \_\_namedParameters
+
+###### code?
+
+`string` \| `number`
+
+###### data?
+
+`any`
+
+###### error
+
+`string`
+
+###### name?
+
+`string`
+
+#### Returns
+
+[`CommonError`](CommonError.md)
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`create`](CommonError.md#create)
+
+***
+
+### createErrorClass()
+
+> `static` **createErrorClass**(`aType`, `aErrorCode`?, `ParentErrorClass`?): *typeof* [`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:66
+
+Create an Error Class
+
+#### Parameters
+
+##### aType
+
+`string`
+
+the error type(class) name
+
+##### aErrorCode?
+
+`string` | `number` | *typeof* `AbstractError`
+
+##### ParentErrorClass?
+
+*typeof* [`BaseError`](BaseError.md)
+
+the parent error class. defaults to AbstractError
+
+#### Returns
+
+*typeof* [`BaseError`](BaseError.md)
+
+the new Error Class
+
+#### Inherited from
+
+[`CommonError`](CommonError.md).[`createErrorClass`](CommonError.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
+
+[`CommonError`](CommonError.md).[`fromJSON`](CommonError.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
+
+[`CommonError`](CommonError.md).[`prepareStackTrace`](CommonError.md#preparestacktrace)

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

@@ -6,7 +6,7 @@
 
 # Class: PromptExampleSelector\<T\>
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:46](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/prompt-example-selector.ts#L46)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:46](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/prompt-example-selector.ts#L46)
 
 The `PromptExampleSelector` class provides a mechanism to selectively choose examples from a given set based on
 configurable options such as maximum length and probability threshold. This class is meant to be extended and customized
@@ -46,7 +46,7 @@ The type of the prompt examples.
 
 > **new PromptExampleSelector**\<`T`\>(`examples`, `options`?): [`PromptExampleSelector`](PromptExampleSelector.md)\<`T`\>
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:62](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/prompt-example-selector.ts#L62)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:62](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/prompt-example-selector.ts#L62)
 
 Constructs a new `PromptExampleSelector` instance with the given examples and options.
 
@@ -74,7 +74,7 @@ An optional configuration object.
 
 > **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:55](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/prompt-example-selector.ts#L55)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:55](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/prompt-example-selector.ts#L55)
 
 The collection of prompt examples.
 
@@ -84,7 +84,7 @@ The collection of prompt examples.
 
 > **maxLength**: `undefined` \| `number`
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:47](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/prompt-example-selector.ts#L47)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:47](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/prompt-example-selector.ts#L47)
 
 ***
 
@@ -92,7 +92,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:47](ht
 
 > **threshold**: `undefined` \| `number`
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:51](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/prompt-example-selector.ts#L51)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:51](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/prompt-example-selector.ts#L51)
 
 The probability threshold (0-1) for selecting an example. If `undefined`, no filtering by probability occurs.
 
@@ -102,7 +102,7 @@ The probability threshold (0-1) for selecting an example. If `undefined`, no fil
 
 > **\[asyncIterator\]**(): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:119](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/prompt-example-selector.ts#L119)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:119](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/prompt-example-selector.ts#L119)
 
 Returns an asynchronous iterator for the selected examples.
 
@@ -118,7 +118,7 @@ An asynchronous iterator over the selected examples.
 
 > **initialize**(`examples`, `options`?): `void`
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:71](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/prompt-example-selector.ts#L71)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:71](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/prompt-example-selector.ts#L71)
 
 Initializes the selector with examples and options.
 
@@ -146,7 +146,7 @@ An optional configuration object.
 
 > **selectExample**(`example`, `threshold`?): `void` \| `T`
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:92](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/prompt-example-selector.ts#L92)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:92](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/prompt-example-selector.ts#L92)
 
 Select an example. Can overwrite this in subclasses.
 
@@ -176,7 +176,7 @@ The selected example, or `undefined` if not selected.
 
 > **selectExamples**(`examples`): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:103](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/prompt-example-selector.ts#L103)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:103](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/prompt-example-selector.ts#L103)
 
 Asynchronously selects examples from the given examples, applying the configured threshold (if any).