@isdk/ai-tool 0.6.0 → 0.7.1

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

@@ -6,7 +6,7 @@
 
 # Class: SignalGate\<T\>
 
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:20](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/async-signal-gate.ts#L20)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:20](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L20)
 
 An asynchronous signal gate that blocks operations until a signal is emitted.
 This class allows multiple awaiters to wait for a signal and resolves all pending promises with the emitted value.
@@ -44,7 +44,7 @@ valueGate.signal(42); // Must provide a number value
 
 > `protected` **\_isSignaled**: `boolean` = `false`
 
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:21](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/async-signal-gate.ts#L21)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:21](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L21)
 
 ***
 
@@ -52,7 +52,7 @@ Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:21](https://github.
 
 > `protected` **\_signalValue**: `undefined` \| `T`
 
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:22](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/async-signal-gate.ts#L22)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:22](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L22)
 
 ***
 
@@ -60,7 +60,7 @@ Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:22](https://github.
 
 > `protected` **waitQueue**: `object`[] = `[]`
 
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:23](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/async-signal-gate.ts#L23)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:23](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L23)
 
 #### reject()
 
@@ -98,7 +98,7 @@ Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:23](https://github.
 
 > **get** **signaled**(): `boolean`
 
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:28](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/async-signal-gate.ts#L28)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:28](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L28)
 
 ##### Returns
 
@@ -110,7 +110,7 @@ Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:28](https://github.
 
 > **abort**(`reason`?): `void`
 
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:65](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/async-signal-gate.ts#L65)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:65](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L65)
 
 Aborts all pending waits, rejecting their promises with an error.
 This does **not** reset the signal state (the gate remains signaled or unsignaled).
@@ -133,7 +133,7 @@ The reason for aborting the waits.
 
 > **reset**(): `void`
 
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:53](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/async-signal-gate.ts#L53)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:53](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L53)
 
 Resets the gate to its initial state, allowing a new signal to be emitted.
 
@@ -147,7 +147,7 @@ Resets the gate to its initial state, allowing a new signal to be emitted.
 
 > **signal**(`value`?): `void`
 
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:38](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/async-signal-gate.ts#L38)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:38](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L38)
 
 Emits the signal with an optional value, resolving all pending [wait](../functions/wait.md) promises.
 Subsequent calls have no effect until [reset](SignalGate.md#reset) is called.
@@ -170,7 +170,7 @@ The value to emit with the signal (only required if T is not void).
 
 > **wait**(): `Promise`\<`T`\>
 
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:83](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/async-signal-gate.ts#L83)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:83](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L83)
 
 Returns a promise that resolves with the emitted signal value.
 If called after the signal has been emitted, resolves immediately with the stored value.

package/docs/api/classes/SseClientPubSubTransport.md

@@ -0,0 +1,92 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / SseClientPubSubTransport
+
+# Class: SseClientPubSubTransport
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:4](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-client.ts#L4)
+
+Defines the interface for a client-side PubSub transport.
+
+This abstraction is responsible for creating and managing the connection
+stream (`PubSubClientStream`) to the server.
+
+## Implements
+
+- [`IPubSubClientTransport`](../interfaces/IPubSubClientTransport.md)
+
+## Constructors
+
+### new SseClientPubSubTransport()
+
+> **new SseClientPubSubTransport**(): [`SseClientPubSubTransport`](SseClientPubSubTransport.md)
+
+#### Returns
+
+[`SseClientPubSubTransport`](SseClientPubSubTransport.md)
+
+## Methods
+
+### connect()
+
+> **connect**(`url`, `params`?): [`PubSubClientStream`](../interfaces/PubSubClientStream.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:5](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-client.ts#L5)
+
+Establishes a connection to a server endpoint.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The URL of the server's PubSub endpoint.
+
+##### params?
+
+`Record`\<`string`, `any`\>
+
+Optional parameters for the connection, which might include
+  things like authentication tokens, initial subscription topics, or a client ID.
+
+#### Returns
+
+[`PubSubClientStream`](../interfaces/PubSubClientStream.md)
+
+A `PubSubClientStream` instance that represents the active connection.
+
+#### Implementation of
+
+[`IPubSubClientTransport`](../interfaces/IPubSubClientTransport.md).[`connect`](../interfaces/IPubSubClientTransport.md#connect)
+
+***
+
+### disconnect()
+
+> **disconnect**(`stream`): `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:45](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-client.ts#L45)
+
+Optional. Disconnects a given stream.
+While the `close` method exists on the stream itself, placing `disconnect`
+on the transport can be semantically clearer in some architectures.
+By default, this should delegate to `stream.close()`.
+
+#### Parameters
+
+##### stream
+
+[`PubSubClientStream`](../interfaces/PubSubClientStream.md)
+
+The stream to disconnect.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`IPubSubClientTransport`](../interfaces/IPubSubClientTransport.md).[`disconnect`](../interfaces/IPubSubClientTransport.md#disconnect)

package/docs/api/classes/SseServerPubSubTransport.md

@@ -0,0 +1,234 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / SseServerPubSubTransport
+
+# Class: SseServerPubSubTransport
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:5](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L5)
+
+Defines the interface for a server-side PubSub transport layer.
+
+This abstraction allows the `EventServer` to operate independently of the
+underlying real-time communication protocol (e.g., SSE, WebSockets, IPC).
+An implementation of this interface is responsible for managing client
+connections, subscriptions, and message passing.
+
+## Implements
+
+- [`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md)
+
+## Constructors
+
+### new SseServerPubSubTransport()
+
+> **new SseServerPubSubTransport**(): [`SseServerPubSubTransport`](SseServerPubSubTransport.md)
+
+#### Returns
+
+[`SseServerPubSubTransport`](SseServerPubSubTransport.md)
+
+## Properties
+
+### name
+
+> `readonly` **name**: `"sse"` = `'sse'`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:6](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L6)
+
+A unique, human-readable name for the transport (e.g., 'sse', 'websocket').
+
+#### Implementation of
+
+[`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md).[`name`](../interfaces/IPubSubServerTransport.md#name)
+
+***
+
+### protocol
+
+> `readonly` **protocol**: `"sse"`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:7](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L7)
+
+The protocol identifier.
+
+#### Implementation of
+
+[`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md).[`protocol`](../interfaces/IPubSubServerTransport.md#protocol)
+
+## Methods
+
+### mount()?
+
+> `optional` **mount**(): `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:13](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L13)
+
+Optional method to mount or register the transport's endpoint with an HTTP
+server or framework. This is typically required for protocols like SSE or
+WebSockets that need to handle incoming HTTP requests at a specific path.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md).[`mount`](../interfaces/IPubSubServerTransport.md#mount)
+
+***
+
+### onConnection()
+
+> **onConnection**(`cb`): `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:44](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L44)
+
+Registers a callback to be invoked when a new client connection is established
+and a session is created.
+
+#### Parameters
+
+##### cb
+
+(`s`) => `void`
+
+The callback function that receives the new `PubSubServerSession`.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md).[`onConnection`](../interfaces/IPubSubServerTransport.md#onconnection)
+
+***
+
+### onDisconnect()
+
+> **onDisconnect**(`cb`): `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:45](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L45)
+
+Registers a callback to be invoked when a client disconnects.
+
+#### Parameters
+
+##### cb
+
+(`s`) => `void`
+
+The callback function that receives the `PubSubServerSession` of the
+  disconnected client.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md).[`onDisconnect`](../interfaces/IPubSubServerTransport.md#ondisconnect)
+
+***
+
+### publish()
+
+> **publish**(`event`, `data`, `target`?): `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:40](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L40)
+
+Publishes an event from the server to connected clients.
+
+The transport implementation should handle broadcasting to all relevant
+clients or targeting specific clients based on the `target` parameter.
+
+#### Parameters
+
+##### event
+
+`string`
+
+The name of the event to publish.
+
+##### data
+
+`any`
+
+The payload for the event.
+
+##### target?
+
+Optional. Specifies the recipient(s) of the event.
+  If omitted, the event is typically broadcast to all subscribed clients.
+
+###### clientId?
+
+`string` \| `string`[]
+
+A single `PubSubClientId` or an array of IDs to
+  send the event to.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md).[`publish`](../interfaces/IPubSubServerTransport.md#publish)
+
+***
+
+### subscribe()
+
+> **subscribe**(`events`?, `options`?): `Client`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:15](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L15)
+
+Establishes a connection with a client and subscribes it to an event stream.
+
+This method is designed to be generic. Transport-specific details, such as
+HTTP request/response objects or connection handles, should be passed
+inside the `options` parameter to avoid polluting the abstraction layer.
+
+#### Parameters
+
+##### events?
+
+`string`[]
+
+Optional array of event names to initially subscribe the client to.
+
+##### options?
+
+A container for transport-specific parameters.
+
+###### clientId?
+
+`string`
+
+An optional ID provided by the client. If not provided,
+  the transport should generate one.
+
+###### req?
+
+`IncomingMessage`
+
+The underlying request object (e.g., `http.IncomingMessage`).
+
+###### res?
+
+`ServerResponse`\<`IncomingMessage`\>
+
+The underlying response object (e.g., `http.ServerResponse`).
+
+#### Returns
+
+`Client`
+
+A `PubSubClient` object representing the newly connected client.
+
+#### Implementation of
+
+[`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md).[`subscribe`](../interfaces/IPubSubServerTransport.md#subscribe)

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

@@ -6,7 +6,7 @@
 
 # Class: TaskAbortController
 
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:35](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L35)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:35](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L35)
 
 ## Extends
 
@@ -18,7 +18,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:35](https://github
 
 > **new TaskAbortController**(`parent`): [`TaskAbortController`](TaskAbortController.md)
 
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:41](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L41)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:41](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L41)
 
 #### Parameters
 
@@ -40,7 +40,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:41](https://github
 
 > `optional` **id**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
 
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:36](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L36)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:36](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L36)
 
 ***
 
@@ -48,7 +48,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:36](https://github
 
 > **parent**: [`CancelableAbility`](CancelableAbility.md)
 
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:39](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L39)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:39](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L39)
 
 ***
 
@@ -56,7 +56,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:39](https://github
 
 > `readonly` **signal**: `AbortSignal`
 
-Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.dom.d.ts:2501
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.dom.d.ts:2501
 
 Returns the AbortSignal object associated with this object.
 
@@ -72,7 +72,7 @@ Returns the AbortSignal object associated with this object.
 
 > `optional` **streamController**: `ReadableStreamDefaultController`\<`any`\>
 
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:38](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L38)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:38](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L38)
 
 ***
 
@@ -80,7 +80,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:38](https://github
 
 > `optional` **timeoutId**: `any`
 
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:37](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L37)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:37](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L37)
 
 ## Methods
 
@@ -88,7 +88,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:37](https://github
 
 > **abort**(`reason`?, `data`?): `void`
 
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:46](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L46)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:46](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L46)
 
 Invoking this method will set this object's AbortSignal's aborted flag and signal to any observers that the associated activity is to be aborted.
 
@@ -118,7 +118,7 @@ Invoking this method will set this object's AbortSignal's aborted flag and signa
 
 > **throwRejected**(`alreadyRejected`?): `undefined` \| `true`
 
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:55](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L55)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:55](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L55)
 
 #### Parameters