@isdk/ai-tool 0.5.8 → 0.7.0

package/docs/api/classes/HttpClientToolTransport.md

@@ -0,0 +1,324 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / HttpClientToolTransport
+
+# Class: HttpClientToolTransport
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:9](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/http-client.ts#L9)
+
+A concrete client transport implementation that uses the browser/node `fetch` API.
+
+## Extends
+
+- [`ClientToolTransport`](ClientToolTransport.md)
+
+## Constructors
+
+### new HttpClientToolTransport()
+
+> **new HttpClientToolTransport**(`apiRoot`): [`HttpClientToolTransport`](HttpClientToolTransport.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:41](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L41)
+
+#### Parameters
+
+##### apiRoot
+
+`string`
+
+#### Returns
+
+[`HttpClientToolTransport`](HttpClientToolTransport.md)
+
+#### Inherited from
+
+[`ClientToolTransport`](ClientToolTransport.md).[`constructor`](ClientToolTransport.md#constructors)
+
+## Properties
+
+### apiRoot
+
+> **apiRoot**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:37](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L37)
+
+The root endpoint for the remote service.
+For HTTP, this is a URL. For IPC, it could be a channel name.
+
+#### Inherited from
+
+[`ClientToolTransport`](ClientToolTransport.md).[`apiRoot`](ClientToolTransport.md#apiroot-1)
+
+***
+
+### options?
+
+> `optional` **options**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:36](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L36)
+
+Additional options for the transport start or fetch, passed by mount.
+
+#### Inherited from
+
+[`ClientToolTransport`](ClientToolTransport.md).[`options`](ClientToolTransport.md#options)
+
+***
+
+### Tools
+
+> **Tools**: *typeof* [`ClientTools`](ClientTools.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:38](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L38)
+
+#### Inherited from
+
+[`ClientToolTransport`](ClientToolTransport.md).[`Tools`](ClientToolTransport.md#tools)
+
+## Methods
+
+### \_fetch()
+
+> **\_fetch**(`name`, `args`?, `act`?, `subName`?, `fetchOptions`?): `Promise`\<`Response`\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:26](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/http-client.ts#L26)
+
+#### Parameters
+
+##### name
+
+`string`
+
+##### args?
+
+`any`
+
+##### act?
+
+`string`
+
+##### subName?
+
+`any`
+
+##### fetchOptions?
+
+`any`
+
+#### Returns
+
+`Promise`\<`Response`\>
+
+#### Overrides
+
+[`ClientToolTransport`](ClientToolTransport.md).[`_fetch`](ClientToolTransport.md#_fetch)
+
+***
+
+### \_mount()
+
+> **\_mount**(`clientTools`, `apiPrefix`, `options`?): `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:49](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L49)
+
+#### Parameters
+
+##### clientTools
+
+*typeof* [`ClientTools`](ClientTools.md)
+
+##### apiPrefix
+
+`string`
+
+##### options?
+
+`any`
+
+#### Returns
+
+`Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
+
+#### Inherited from
+
+[`ClientToolTransport`](ClientToolTransport.md).[`_mount`](ClientToolTransport.md#_mount)
+
+***
+
+### errorFrom()
+
+> **errorFrom**(`name`, `res`): `Promise`\<[`CommonError`](CommonError.md)\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:74](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/http-client.ts#L74)
+
+**`Internal`**
+
+A helper to create a structured error from a failed `fetch` response.
+
+#### Parameters
+
+##### name
+
+`string`
+
+##### res
+
+`Response`
+
+The HTTP response.
+
+#### Returns
+
+`Promise`\<[`CommonError`](CommonError.md)\>
+
+A structured error object.
+
+***
+
+### fetch()
+
+> **fetch**(`name`, `args`?, `act`?, `subName`?, `fetchOptions`?): `Promise`\<`any`\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:64](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L64)
+
+Fetches data from the server.
+
+#### Parameters
+
+##### name
+
+`string`
+
+The name of the tool function to fetch.
+
+##### args?
+
+`any`
+
+The object parameters to pass to the server.
+
+##### act?
+
+`string`
+
+The action to perform on the server.
+
+##### subName?
+
+`any`
+
+The name of the sub-resource to fetch.
+
+##### fetchOptions?
+
+`any`
+
+#### Returns
+
+`Promise`\<`any`\>
+
+A promise that resolves with the fetched data.
+
+#### Inherited from
+
+[`ClientToolTransport`](ClientToolTransport.md).[`fetch`](ClientToolTransport.md#fetch)
+
+***
+
+### loadApis()
+
+> **loadApis**(): `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:15](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/http-client.ts#L15)
+
+Connects to the server's discovery endpoint to get the list of available tools.
+
+#### Returns
+
+`Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
+
+A promise that resolves to a map of tool function metadata.
+
+#### Overrides
+
+[`ClientToolTransport`](ClientToolTransport.md).[`loadApis`](ClientToolTransport.md#loadapis)
+
+***
+
+### mount()
+
+> **mount**(`Tools`, `apiRoot`?, `options`?): `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:42](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L42)
+
+#### Parameters
+
+##### Tools
+
+*typeof* [`ToolFunc`](ToolFunc.md)
+
+##### apiRoot?
+
+`string`
+
+##### options?
+
+`any`
+
+#### Returns
+
+`any`
+
+#### Inherited from
+
+[`ClientToolTransport`](ClientToolTransport.md).[`mount`](ClientToolTransport.md#mount)
+
+***
+
+### setApiRoot()
+
+> **setApiRoot**(`apiRoot`): `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:38](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L38)
+
+#### Parameters
+
+##### apiRoot
+
+`string`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`ClientToolTransport`](ClientToolTransport.md).[`setApiRoot`](ClientToolTransport.md#setapiroot)
+
+***
+
+### toObject()
+
+> **toObject**(`res`, `args`?): `Promise`\<`any`\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:104](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/http-client.ts#L104)
+
+#### Parameters
+
+##### res
+
+`any`
+
+##### args?
+
+`any`
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Overrides
+
+[`ClientToolTransport`](ClientToolTransport.md).[`toObject`](ClientToolTransport.md#toobject)

package/docs/api/classes/HttpServerToolTransport.md

@@ -0,0 +1,324 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / HttpServerToolTransport
+
+# Class: HttpServerToolTransport
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:12](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/http-server.ts#L12)
+
+A concrete server transport implementation using Node.js's built-in HTTP server.
+
+## Extends
+
+- [`ServerToolTransport`](ServerToolTransport.md)
+
+## Constructors
+
+### new HttpServerToolTransport()
+
+> **new HttpServerToolTransport**(`options`?): [`HttpServerToolTransport`](HttpServerToolTransport.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:17](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/http-server.ts#L17)
+
+#### Parameters
+
+##### options?
+
+`ServerOptions`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>
+
+#### Returns
+
+[`HttpServerToolTransport`](HttpServerToolTransport.md)
+
+#### Overrides
+
+[`ServerToolTransport`](ServerToolTransport.md).[`constructor`](ServerToolTransport.md#constructors)
+
+## Properties
+
+### apiRoot
+
+> **apiRoot**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:42](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/server.ts#L42)
+
+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)
+
+***
+
+### options?
+
+> `optional` **options**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:44](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/server.ts#L44)
+
+Additional options for the transport start or fetch, passed by mount.
+
+#### Inherited from
+
+[`ServerToolTransport`](ServerToolTransport.md).[`options`](ServerToolTransport.md#options)
+
+***
+
+### server
+
+> **server**: `Server`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:13](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/http-server.ts#L13)
+
+***
+
+### Tools
+
+> **Tools**: *typeof* [`ServerTools`](ServerTools.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:43](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/server.ts#L43)
+
+#### Inherited from
+
+[`ServerToolTransport`](ServerToolTransport.md).[`Tools`](ServerToolTransport.md#tools)
+
+## Methods
+
+### \_mount()
+
+> **\_mount**(`Tools`, `apiPrefix`, `options`?): `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:46](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/server.ts#L46)
+
+#### 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/ai-tool/src/transports/http-server.ts:160](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/http-server.ts#L160)
+
+#### Parameters
+
+##### options
+
+###### host?
+
+`string`
+
+###### port
+
+`number`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+[`ServerToolTransport`](ServerToolTransport.md).[`_start`](ServerToolTransport.md#_start)
+
+***
+
+### addDiscoveryHandler()
+
+> **addDiscoveryHandler**(`apiPrefix`, `handler`): `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:62](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/http-server.ts#L62)
+
+#### 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/ai-tool/src/transports/http-server.ts:67](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/http-server.ts#L67)
+
+#### Parameters
+
+##### serverTools
+
+*typeof* [`ServerTools`](ServerTools.md)
+
+##### apiPrefix
+
+`string`
+
+##### options?
+
+`any`
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`ServerToolTransport`](ServerToolTransport.md).[`addRpcHandler`](ServerToolTransport.md#addrpchandler)
+
+***
+
+### getRaw()
+
+> **getRaw**(): `Server`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:190](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/http-server.ts#L190)
+
+Gets the underlying raw server instance.
+
+#### Returns
+
+`Server`
+
+#### Overrides
+
+[`ServerToolTransport`](ServerToolTransport.md).[`getRaw`](ServerToolTransport.md#getraw)
+
+***
+
+### mount()
+
+> **mount**(`Tools`, `apiRoot`?, `options`?): `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:42](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L42)
+
+Mounts the ServerTools registry, creating the necessary API routes.
+
+#### Parameters
+
+##### Tools
+
+*typeof* [`ToolFunc`](ToolFunc.md)
+
+The ServerTools class.
+
+##### apiRoot?
+
+`string`
+
+An optional prefix for all API routes.
+
+##### options?
+
+`any`
+
+Additional options for the transport start.
+
+#### Returns
+
+`any`
+
+#### Inherited from
+
+[`ServerToolTransport`](ServerToolTransport.md).[`mount`](ServerToolTransport.md#mount)
+
+***
+
+### setApiRoot()
+
+> **setApiRoot**(`apiRoot`): `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:38](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L38)
+
+#### 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/ai-tool/src/transports/server.ts:52](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/server.ts#L52)
+
+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/ai-tool/src/transports/http-server.ts:176](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/http-server.ts#L176)
+
+Stops the server instance gracefully.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise<void> when server is fully stopped
+
+#### Overrides
+
+[`ServerToolTransport`](ServerToolTransport.md).[`stop`](ServerToolTransport.md#stop)