@isdk/tool-electron 1.0.0

package/docs/classes/IpcClientToolTransport.md

@@ -0,0 +1,416 @@
+[**@isdk/tool-electron**](../README.md)
+
+***
+
+[@isdk/tool-electron](../globals.md) / IpcClientToolTransport
+
+# Class: IpcClientToolTransport
+
+Defined in: [tool-electron/src/ipc-client.ts:65](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-client.ts#L65)
+
+Renderer-side RPC transport over Electron IPC.
+
+## Param
+
+URI in `electron://host` format; defaults to `IPCDefaultChannelName`
+  (see normalizeNamespace for URI extraction logic).
+
+## Param
+
+Optional config.
+
+## Param
+
+Injectable bridge object with `invoke` method.
+  When provided, used instead of directly importing `ipcRenderer`.
+  Required when `contextIsolation` is enabled.
+
+## Extends
+
+- `ClientToolTransport`
+
+## Constructors
+
+### Constructor
+
+> **new IpcClientToolTransport**(`apiUrl?`, `options?`): `IpcClientToolTransport`
+
+Defined in: [tool-electron/src/ipc-client.ts:69](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-client.ts#L69)
+
+#### Parameters
+
+##### apiUrl?
+
+`string` = `IPCDefaultChannelName`
+
+##### options?
+
+`IpcClientToolTransportOptions`
+
+#### Returns
+
+`IpcClientToolTransport`
+
+#### Overrides
+
+`ClientToolTransport.constructor`
+
+## Properties
+
+### apiUrl
+
+> **apiUrl**: `string`
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:571
+
+#### Inherited from
+
+`ClientToolTransport.apiUrl`
+
+***
+
+### channels
+
+> **channels**: [`Channels`](../type-aliases/Channels.md)
+
+Defined in: [tool-electron/src/ipc-client.ts:66](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-client.ts#L66)
+
+***
+
+### manager
+
+> **manager**: `RpcTransportManager`
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:558
+
+所属管理器引用
+
+#### Inherited from
+
+`ClientToolTransport.manager`
+
+***
+
+### options?
+
+> `optional` **options?**: `ClientToolTransportOptions`
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:572
+
+#### Inherited from
+
+`ClientToolTransport.options`
+
+## Accessors
+
+### apiRoot
+
+#### Get Signature
+
+> **get** **apiRoot**(): `string`
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:575
+
+##### Deprecated
+
+use apiUrl instead
+
+##### Returns
+
+`string`
+
+#### Set Signature
+
+> **set** **apiRoot**(`val`): `void`
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:577
+
+##### Deprecated
+
+use apiUrl instead
+
+##### Parameters
+
+###### val
+
+`string`
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+`ClientToolTransport.apiRoot`
+
+## Methods
+
+### \_fetch()
+
+> **\_fetch**(`name`, `args?`, `act?`, `subName?`, `_fetchOptions?`): `Promise`\<`any`\>
+
+Defined in: [tool-electron/src/ipc-client.ts:136](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-client.ts#L136)
+
+Call a remote tool via IPC.
+Sends an RPC request on the `{namespace}:rpc` channel and returns the result.
+Server errors (`{ __error__: true, error: ... }`) are automatically re-thrown as `CommonError`.
+
+#### Parameters
+
+##### name
+
+`string`
+
+Tool name (becomes `toolId` in the IPC payload).
+
+##### args?
+
+`any`
+
+Parameters to pass to the tool.
+
+##### act?
+
+`string`
+
+Optional action name for REST-style sub-resources.
+
+##### subName?
+
+`any`
+
+Optional sub-resource identifier.
+
+##### \_fetchOptions?
+
+`any`
+
+Optional fetch options (e.g., `{ signal: AbortSignal }` for cancellation).
+
+#### Returns
+
+`Promise`\<`any`\>
+
+The tool's return value.
+
+#### Throws
+
+If the server returns an error response.
+
+#### Throws
+
+If the request is cancelled via `AbortSignal`.
+
+#### Overrides
+
+`ClientToolTransport._fetch`
+
+***
+
+### fetch()
+
+> **fetch**(`name`, `args?`, `act?`, `subName?`, `fetchOptions?`, `toolTimeout?`): `Promise`\<`any`\>
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:584
+
+#### Parameters
+
+##### name
+
+`string`
+
+##### args?
+
+`any`
+
+##### act?
+
+`string`
+
+##### subName?
+
+`any`
+
+##### fetchOptions?
+
+`any`
+
+##### toolTimeout?
+
+`any`
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Inherited from
+
+`ClientToolTransport.fetch`
+
+***
+
+### loadApis()
+
+> **loadApis**(): `Promise`\<`Funcs`\>
+
+Defined in: [tool-electron/src/ipc-client.ts:113](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-client.ts#L113)
+
+Load available tool definitions from the server via IPC.
+Invokes the `{namespace}:discover` channel to fetch the tool manifest.
+
+#### Returns
+
+`Promise`\<`Funcs`\>
+
+A promise resolving to the tool function definitions.
+
+#### Throws
+
+If `apiUrl` has not been set (channels not initialized).
+
+#### Overrides
+
+`ClientToolTransport.loadApis`
+
+***
+
+### mount()
+
+> **mount**(`toolsClass`): `void`
+
+Defined in: [tool-electron/src/ipc-client.ts:78](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-client.ts#L78)
+
+Mount the transport to a tools class and register with RpcTransportManager.
+
+#### Parameters
+
+##### toolsClass
+
+`any`
+
+The client tools class to mount (e.g., `ClientTools`).
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+`ClientToolTransport.mount`
+
+***
+
+### pollTaskStatus()
+
+> **pollTaskStatus**(`taskId`, `parentFetchOptions?`): `Promise`\<`any`\>
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:592
+
+模块化复用的轮询探查接口
+
+#### Parameters
+
+##### taskId
+
+`string`
+
+##### parentFetchOptions?
+
+`any`
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Inherited from
+
+`ClientToolTransport.pollTaskStatus`
+
+***
+
+### ~~setApiRoot()~~
+
+> **setApiRoot**(`apiRoot`): `void`
+
+Defined in: [tool-electron/src/ipc-client.ts:103](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-client.ts#L103)
+
+#### Parameters
+
+##### apiRoot
+
+`string`
+
+#### Returns
+
+`void`
+
+#### Deprecated
+
+Use [setApiUrl](#setapiurl) instead
+
+***
+
+### setApiUrl()
+
+> **setApiUrl**(`apiUrl`): `void`
+
+Defined in: [tool-electron/src/ipc-client.ts:92](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-client.ts#L92)
+
+Set the API URL and derive IPC channel names.
+
+#### Parameters
+
+##### apiUrl
+
+`string`
+
+URI in `electron://host` format (e.g., `'electron://my-app'`).
+  The host is extracted as the namespace for channel generation:
+  `electron://my-app` → channels `my-app:discover`, `my-app:rpc`.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+`ClientToolTransport.setApiUrl`
+
+***
+
+### ~~toObject()~~
+
+> **toObject**(`res`): `Promise`\<`any`\>
+
+Defined in: [tool-electron/src/ipc-client.ts:210](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-client.ts#L210)
+
+Convert an IPC response to a plain object.
+If the response contains a server error (`{ __error__: true }`),
+it is re-thrown as a `CommonError`.
+Otherwise, the response is passed through as-is.
+
+#### Parameters
+
+##### res
+
+`any`
+
+The raw response from the IPC channel.
+
+#### Returns
+
+`Promise`\<`any`\>
+
+The deserialized result.
+
+#### Throws
+
+If the response indicates a server error.
+
+#### Deprecated
+
+Use `_fetch` directly, which throws `CommonError` automatically.
+
+#### Overrides
+
+`ClientToolTransport.toObject`