@isdk/ai-tool 0.5.8 → 0.7.0

package/docs/api/interfaces/PubSubClientStream.md

@@ -0,0 +1,196 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / PubSubClientStream
+
+# Interface: PubSubClientStream
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:11](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/client.ts#L11)
+
+Represents the client-side stream for a PubSub connection.
+
+This interface abstracts the underlying connection object (like an `EventSource`
+or `WebSocket` client) into a standardized event-based stream. It provides
+methods for listening to events, sending messages (for bidirectional transports),
+and managing the connection state.
+
+## Properties
+
+### addEventListener()?
+
+> `optional` **addEventListener**: (`event`, `listener`) => `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:59](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/client.ts#L59)
+
+Optional alias for the `on` method for compatibility with the
+standard `EventTarget` interface.
+
+#### Parameters
+
+##### event
+
+`string`
+
+##### listener
+
+(`data`, `ctx`?) => `void`
+
+#### Returns
+
+`any`
+
+***
+
+### close()
+
+> **close**: () => `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:43](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/client.ts#L43)
+
+Closes the connection stream.
+
+#### Returns
+
+`void`
+
+***
+
+### off()
+
+> **off**: (`event`, `listener`) => `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:38](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/client.ts#L38)
+
+Removes a previously registered event listener.
+
+#### Parameters
+
+##### event
+
+`string`
+
+The name of the event.
+
+##### listener
+
+(`data`, `ctx`?) => `void`
+
+The listener function to remove.
+
+#### Returns
+
+`void`
+
+***
+
+### on()
+
+> **on**: (`event`, `listener`) => `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:31](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/client.ts#L31)
+
+Registers a listener for a specific event from the server.
+
+#### Parameters
+
+##### event
+
+`string`
+
+The name of the event to listen for.
+
+##### listener
+
+(`data`, `ctx`?) => `void`
+
+The callback function to execute when the event is received.
+  It receives the event data and an optional context object.
+
+#### Returns
+
+`any`
+
+***
+
+### protocol
+
+> **protocol**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:15](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/client.ts#L15)
+
+The protocol being used for this stream (e.g., 'sse', 'ws', 'ipc').
+
+***
+
+### readyState?
+
+> `optional` **readyState**: `number`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:23](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/client.ts#L23)
+
+Optional. Represents the state of the connection.
+This is provided for compatibility with the `EventSource.readyState`
+and `WebSocket.readyState` properties.
+(e.g., 0 for connecting, 1 for open, 2 for closed).
+
+***
+
+### removeEventListener()?
+
+> `optional` **removeEventListener**: (`event`, `listener`) => `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:65](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/client.ts#L65)
+
+Optional alias for the `off` method for compatibility with the
+standard `EventTarget` interface.
+
+#### Parameters
+
+##### event
+
+`string`
+
+##### listener
+
+(`data`, `ctx`?) => `void`
+
+#### Returns
+
+`void`
+
+***
+
+### send()?
+
+> `optional` **send**: (`event`, `data`, `ctx`?) => `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:53](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/client.ts#L53)
+
+Optional. Sends a message from the client to the server.
+This method is only available for bidirectional transports like WebSockets or IPC.
+It is not supported by unidirectional transports like Server-Sent Events (SSE).
+
+#### Parameters
+
+##### event
+
+`string`
+
+The name of the event to send.
+
+##### data
+
+`any`
+
+The payload for the event.
+
+##### ctx?
+
+[`PubSubCtx`](../type-aliases/PubSubCtx.md)
+
+Optional context for the PubSub operation.
+
+#### Returns
+
+`void`

package/docs/api/interfaces/PubSubServerSession.md

@@ -0,0 +1,103 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / PubSubServerSession
+
+# Interface: PubSubServerSession
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:31](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/server.ts#L31)
+
+Represents an active client connection session on the server.
+This object provides a standardized way for the `EventServer` to interact
+with a connection, regardless of the underlying transport protocol.
+
+## Properties
+
+### clientId?
+
+> `optional` **clientId**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:39](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/server.ts#L39)
+
+The unique identifier for the client associated with this session.
+
+***
+
+### close()
+
+> **close**: () => `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:54](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/server.ts#L54)
+
+Closes the connection for this session.
+
+#### Returns
+
+`void`
+
+***
+
+### id
+
+> **id**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:35](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/server.ts#L35)
+
+A unique identifier for the session, typically generated by the transport layer upon connection.
+
+***
+
+### protocol
+
+> **protocol**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:43](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/server.ts#L43)
+
+The protocol being used for this session (e.g., 'sse', 'ws', 'ipc').
+
+***
+
+### raw?
+
+> `optional` **raw**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:60](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/server.ts#L60)
+
+A reference to the raw, underlying connection object or handle
+(e.g., a Node.js `ServerResponse` for SSE, or a WebSocket instance).
+Use with caution as it is transport-specific.
+
+***
+
+### send()
+
+> **send**: (`event`, `data`, `ctx`?) => `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:50](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/server.ts#L50)
+
+Sends an event and data to the client associated with this session.
+
+#### Parameters
+
+##### event
+
+`string`
+
+The name of the event to send.
+
+##### data
+
+`any`
+
+The payload for the event.
+
+##### ctx?
+
+[`PubSubCtx`](../type-aliases/PubSubCtx.md)
+
+Optional context for the PubSub operation.
+
+#### Returns
+
+`void`

package/docs/api/interfaces/RemoteFuncItem.md

@@ -0,0 +1,316 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / RemoteFuncItem
+
+# Interface: RemoteFuncItem
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:83](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L83)
+
+Base interface for a remote function's configuration, extending `BaseFuncItem`
+with properties required for remote execution.
+
+## Extends
+
+- [`BaseFuncItem`](BaseFuncItem.md)
+
+## Extended by
+
+- [`ClientFuncItem`](ClientFuncItem.md)
+- [`ServerFuncItem`](ServerFuncItem.md)
+
+## Properties
+
+### action?
+
+> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L95)
+
+The action to be used for the remote call. This typically represents an RPC method name.
+Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (e.g., GET, POST)
+
+***
+
+### alias?
+
+> `optional` **alias**: `string` \| `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L130)
+
+Optional aliases for the function name.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`alias`](BaseFuncItem.md#alias)
+
+***
+
+### ~~apiRoot?~~
+
+> `optional` **apiRoot**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:89](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L89)
+
+The root endpoint for the remote service.
+
+#### Deprecated
+
+Use `transport` instead.
+
+***
+
+### asyncFeatures?
+
+> `optional` **asyncFeatures**: `number`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L144)
+
+A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
+This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
+
+#### See
+
+AsyncFeatureBits from `@src/utils/cancelable-ability.ts`
+
+#### Example
+
+```ts
+import { AsyncFeatures } from './utils';
+const func = new ToolFunc({
+  name: 'cancellableTask',
+  asyncFeatures: AsyncFeatures.Cancelable | AsyncFeatures.MultiTask,
+  // ...
+});
+```
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`asyncFeatures`](BaseFuncItem.md#asyncfeatures)
+
+***
+
+### depends?
+
+> `optional` **depends**: `object`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L167)
+
+A map of dependencies this function has on other tool functions.
+Declaring dependencies ensures that they are automatically registered when this function is registered.
+This is crucial for building modular functions that rely on each other without needing to manage registration order manually.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`ToolFunc`](../classes/ToolFunc.md)
+
+#### Example
+
+```ts
+const helperFunc = new ToolFunc({ name: 'helper', func: () => 'world' });
+const mainFunc = new ToolFunc({
+  name: 'main',
+  depends: {
+    helper: helperFunc,
+  },
+  func() {
+    // We can now safely run the dependency
+    const result = this.runSync('helper');
+    return `Hello, ${result}`;
+  }
+});
+// When mainFunc is registered, helperFunc will be registered automatically.
+mainFunc.register();
+```
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`depends`](BaseFuncItem.md#depends)
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L172)
+
+A detailed description of what the function does.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`description`](BaseFuncItem.md#description)
+
+***
+
+### ~~fetchOptions?~~
+
+> `optional` **fetchOptions**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:101](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L101)
+
+Options to be passed to the underlying `fetch` call in an HTTP transport.
+
+#### Deprecated
+
+Use `transport` instead.
+
+***
+
+### isApi?
+
+> `optional` **isApi**: `boolean`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L119)
+
+If true, indicates that this function should be treated as a server-side API.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`isApi`](BaseFuncItem.md#isapi)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L76)
+
+The unique name of the function.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name-2)
+
+***
+
+### params?
+
+> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L81)
+
+Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`params`](BaseFuncItem.md#params)
+
+***
+
+### result?
+
+> `optional` **result**: `string` \| `Record`\<`string`, `any`\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L86)
+
+The expected return type of the function, described as a string or a JSON schema object.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`result`](BaseFuncItem.md#result)
+
+***
+
+### scope?
+
+> `optional` **scope**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L91)
+
+The execution scope or context (`this`) for the function.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`scope`](BaseFuncItem.md#scope)
+
+***
+
+### setup()?
+
+> `optional` **setup**: (`this`, `options`?) => `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L114)
+
+A lifecycle hook called once during the `ToolFunc` instance's initialization.
+It allows for initial setup, state configuration, or property modification on the instance
+before it is used or registered. The `this` context is the `ToolFunc` instance itself.
+
+#### Parameters
+
+##### this
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+##### options?
+
+[`FuncItem`](FuncItem.md)
+
+The configuration options for the function.
+
+#### Returns
+
+`void`
+
+#### Example
+
+```ts
+const myFunc = new ToolFunc({
+  name: 'myFunc',
+  customState: 'initial',
+  setup() {
+    // `this` is the myFunc instance
+    this.customState = 'configured';
+  }
+});
+console.log(myFunc.customState); // Outputs: 'configured'
+```
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`setup`](BaseFuncItem.md#setup)
+
+***
+
+### stream?
+
+> `optional` **stream**: `boolean`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L125)
+
+If true, indicates that the function has the *capability* to stream its output.
+Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`stream`](BaseFuncItem.md#stream)
+
+***
+
+### tags?
+
+> `optional` **tags**: `string` \| `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L96)
+
+Tags for grouping or filtering functions.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`tags`](BaseFuncItem.md#tags)
+
+***
+
+### title?
+
+> `optional` **title**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L177)
+
+A concise, human-readable title for the function, often used in UI or by AI.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`title`](BaseFuncItem.md#title)

package/docs/api/interfaces/ReplacePlacehoderOptions.md

@@ -0,0 +1,41 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ReplacePlacehoderOptions
+
+# Interface: ReplacePlacehoderOptions
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:464](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/parse-command.ts#L464)
+
+## Properties
+
+### endChar?
+
+> `optional` **endChar**: `string` \| `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:466](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/parse-command.ts#L466)
+
+***
+
+### placehoders?
+
+> `optional` **placehoders**: `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:468](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/parse-command.ts#L468)
+
+***
+
+### placeholder?
+
+> `optional` **placeholder**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:467](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/parse-command.ts#L467)
+
+***
+
+### startChar?
+
+> `optional` **startChar**: `string` \| `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:465](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/parse-command.ts#L465)

package/docs/api/interfaces/ResClientFuncParams.md

@@ -0,0 +1,37 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ResClientFuncParams
+
+# Interface: ResClientFuncParams
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:5](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/res-client-tools.ts#L5)
+
+## Extends
+
+- `RpcMethodsClientFuncParams`
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Properties
+
+### act?
+
+> `optional` **act**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:5](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/rpc-methods-client-tool.ts#L5)
+
+#### Inherited from
+
+`RpcMethodsClientFuncParams.act`
+
+***
+
+### id?
+
+> `optional` **id**: `string` \| `number`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/res-client-tools.ts#L6)