@isdk/ai-tool 0.8.2 → 0.9.0

package/docs/api/classes/MailboxServerTransport.md

@@ -0,0 +1,433 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / MailboxServerTransport
+
+# Class: MailboxServerTransport
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:606
+
+A server-side transport implementation using @mboxlabs/mailbox.
+
+## Extends
+
+- [`ServerToolTransport`](ServerToolTransport.md)
+
+## Constructors
+
+### Constructor
+
+> **new MailboxServerTransport**(`options?`): `MailboxServerTransport`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:618
+
+#### Parameters
+
+##### options?
+
+[`MailboxServerOptions`](../interfaces/MailboxServerOptions.md)
+
+#### Returns
+
+`MailboxServerTransport`
+
+#### Overrides
+
+[`ServerToolTransport`](ServerToolTransport.md).[`constructor`](ServerToolTransport.md#constructor)
+
+## Properties
+
+### apiRoot
+
+> **apiRoot**: `string`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:442
+
+The root endpoint for the remote service.
+For HTTP, this is a URL. For IPC, it could be a channel name.
+
+#### Inherited from
+
+[`ServerToolTransport`](ServerToolTransport.md).[`apiRoot`](ServerToolTransport.md#apiroot)
+
+***
+
+### discoveryHandlerInfo
+
+> `protected` **discoveryHandlerInfo**: \{ `handler`: () => `any`; `prefix`: `string`; \} \| `null`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:609
+
+***
+
+### isInternalMailbox
+
+> `protected` **isInternalMailbox**: `boolean`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:617
+
+***
+
+### isRunning
+
+> `protected` **isRunning**: `boolean`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:616
+
+***
+
+### listenAddress?
+
+> `protected` `optional` **listenAddress**: `string`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:608
+
+***
+
+### mailbox
+
+> `protected` **mailbox**: `Mailbox`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:607
+
+***
+
+### mode
+
+> `protected` **mode**: `"push"` \| `"pull"`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:614
+
+***
+
+### options?
+
+> `optional` **options**: `any`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:444
+
+Additional options for the transport start or fetch, passed by mount.
+
+#### Inherited from
+
+[`ServerToolTransport`](ServerToolTransport.md).[`options`](ServerToolTransport.md#options)
+
+***
+
+### pullInterval
+
+> `protected` **pullInterval**: `number`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:615
+
+***
+
+### subscription
+
+> `protected` **subscription**: `any`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:613
+
+***
+
+### Tools
+
+> **Tools**: *typeof* [`ServerTools`](ServerTools.md)
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:443
+
+#### Inherited from
+
+[`ServerToolTransport`](ServerToolTransport.md).[`Tools`](ServerToolTransport.md#tools)
+
+## Methods
+
+### \_mount()
+
+> **\_mount**(`Tools`, `apiPrefix`, `options?`): `void`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:445
+
+#### Parameters
+
+##### Tools
+
+*typeof* [`ServerTools`](ServerTools.md)
+
+##### apiPrefix
+
+`string`
+
+##### options?
+
+`any`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`ServerToolTransport`](ServerToolTransport.md).[`_mount`](ServerToolTransport.md#_mount)
+
+***
+
+### \_start()
+
+> **\_start**(`options?`): `Promise`\<`void`\>
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:622
+
+#### Parameters
+
+##### options?
+
+`any`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+[`ServerToolTransport`](ServerToolTransport.md).[`_start`](ServerToolTransport.md#_start)
+
+***
+
+### addDiscoveryHandler()
+
+> **addDiscoveryHandler**(`apiPrefix`, `handler`): `void`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:619
+
+#### Parameters
+
+##### apiPrefix
+
+`string`
+
+##### handler
+
+() => `any`
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`ServerToolTransport`](ServerToolTransport.md).[`addDiscoveryHandler`](ServerToolTransport.md#adddiscoveryhandler)
+
+***
+
+### addRpcHandler()
+
+> **addRpcHandler**(`serverTools`, `apiPrefix`, `options?`): `void`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:620
+
+#### Parameters
+
+##### serverTools
+
+*typeof* [`ServerTools`](ServerTools.md)
+
+##### apiPrefix
+
+`string`
+
+##### options?
+
+`any`
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`ServerToolTransport`](ServerToolTransport.md).[`addRpcHandler`](ServerToolTransport.md#addrpchandler)
+
+***
+
+### drainBacklog()
+
+> `protected` **drainBacklog**(`address`): `Promise`\<`void`\>
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:623
+
+#### Parameters
+
+##### address
+
+`string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### getRaw()
+
+> **getRaw**(): `Mailbox`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:626
+
+Gets the underlying raw server instance.
+
+#### Returns
+
+`Mailbox`
+
+#### Overrides
+
+[`ServerToolTransport`](ServerToolTransport.md).[`getRaw`](ServerToolTransport.md#getraw)
+
+***
+
+### mount()
+
+> **mount**(`Tools`, `apiRoot?`, `options?`): `any`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:140
+
+Mounts the ServerTools registry, creating the necessary API routes.
+
+This method is responsible for integrating the tool-handling logic with a
+running server instance.
+
+#### Parameters
+
+##### Tools
+
+*typeof* [`ToolFunc`](ToolFunc.md)
+
+The ServerTools class containing the tool definitions.
+
+##### apiRoot?
+
+`string`
+
+An optional prefix for all API routes (e.g., '/api').
+
+##### options?
+
+`any`
+
+A container for transport-specific options. For example,
+  an HTTP-based transport would expect an `{ server: http.Server }` object
+  to attach its route handlers to.
+
+#### Returns
+
+`any`
+
+#### Inherited from
+
+[`ServerToolTransport`](ServerToolTransport.md).[`mount`](ServerToolTransport.md#mount)
+
+***
+
+### onReceive()
+
+> `protected` **onReceive**(`message`): `Promise`\<`void`\>
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:621
+
+#### Parameters
+
+##### message
+
+`MailMessage`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### runPullLoop()
+
+> `protected` **runPullLoop**(`address`): `Promise`\<`void`\>
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:624
+
+#### Parameters
+
+##### address
+
+`string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### setApiRoot()
+
+> **setApiRoot**(`apiRoot`): `void`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:139
+
+#### Parameters
+
+##### apiRoot
+
+`string`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`ServerToolTransport`](ServerToolTransport.md).[`setApiRoot`](ServerToolTransport.md#setapiroot)
+
+***
+
+### start()
+
+> **start**(`options?`): `Promise`\<`any`\>
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:446
+
+Starts the transport layer, making it listen for incoming connections.
+
+#### Parameters
+
+##### options?
+
+`any`
+
+Protocol-specific options (e.g., { port, host }).
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Inherited from
+
+[`ServerToolTransport`](ServerToolTransport.md).[`start`](ServerToolTransport.md#start)
+
+***
+
+### stop()
+
+> **stop**(): `Promise`\<`void`\>
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:625
+
+Stops the server instance gracefully.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise<void> when server is fully stopped
+
+#### Overrides
+
+[`ServerToolTransport`](ServerToolTransport.md).[`stop`](ServerToolTransport.md#stop)

package/docs/api/classes/PromptExampleSelector.md

@@ -6,7 +6,7 @@
 
 # Class: PromptExampleSelector\<T\>
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:46](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/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/d10fb4cda65fc1975152a2c3ab327ecab008dea1/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
@@ -48,7 +48,7 @@ The type of the prompt examples.
 
 > **new PromptExampleSelector**\<`T`\>(`examples`, `options?`): `PromptExampleSelector`\<`T`\>
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:62](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/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/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/prompt/prompt-example-selector.ts#L62)
 
 Constructs a new `PromptExampleSelector` instance with the given examples and options.
 
@@ -76,7 +76,7 @@ An optional configuration object.
 
 > **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:55](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/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/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/prompt/prompt-example-selector.ts#L55)
 
 The collection of prompt examples.
 
@@ -84,17 +84,17 @@ The collection of prompt examples.
 
 ### maxLength
 
-> **maxLength**: `undefined` \| `number`
+> **maxLength**: `number` \| `undefined`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:47](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/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/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/prompt/prompt-example-selector.ts#L47)
 
 ***
 
 ### threshold
 
-> **threshold**: `undefined` \| `number`
+> **threshold**: `number` \| `undefined`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:51](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/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/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/prompt/prompt-example-selector.ts#L51)
 
 The probability threshold (0-1) for selecting an example. If `undefined`, no filtering by probability occurs.
 
@@ -104,7 +104,7 @@ The probability threshold (0-1) for selecting an example. If `undefined`, no fil
 
 > **\[asyncIterator\]**(): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:119](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/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/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/prompt/prompt-example-selector.ts#L119)
 
 Returns an asynchronous iterator for the selected examples.
 
@@ -120,7 +120,7 @@ An asynchronous iterator over the selected examples.
 
 > **initialize**(`examples`, `options?`): `void`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:71](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/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/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/prompt/prompt-example-selector.ts#L71)
 
 Initializes the selector with examples and options.
 
@@ -148,7 +148,7 @@ An optional configuration object.
 
 > **selectExample**(`example`, `threshold?`): `void` \| `T`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:92](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/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/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/prompt/prompt-example-selector.ts#L92)
 
 Select an example. Can overwrite this in subclasses.
 
@@ -178,7 +178,7 @@ The selected example, or `undefined` if not selected.
 
 > **selectExamples**(`examples`): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:103](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/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/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/prompt/prompt-example-selector.ts#L103)
 
 Asynchronously selects examples from the given examples, applying the configured threshold (if any).