@isdk/tool-electron 1.0.0

package/docs/classes/IpcServerToolTransport.md

@@ -0,0 +1,479 @@
+[**@isdk/tool-electron**](../README.md)
+
+***
+
+[@isdk/tool-electron](../globals.md) / IpcServerToolTransport
+
+# Class: IpcServerToolTransport
+
+Defined in: [tool-electron/src/ipc-server.ts:44](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-server.ts#L44)
+
+Main-process RPC transport over Electron IPC.
+
+Registers `ipcMain.handle` listeners for tool discovery and RPC calls.
+Supports injectable `ipcMain` bridge for testing or custom setups.
+
+## Extends
+
+- `ServerToolTransport`
+
+## Constructors
+
+### Constructor
+
+> **new IpcServerToolTransport**(`options?`): `IpcServerToolTransport`
+
+Defined in: [tool-electron/src/ipc-server.ts:60](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-server.ts#L60)
+
+Creates an IPC server transport.
+
+#### Parameters
+
+##### options?
+
+###### apiUrl?
+
+`string`
+
+URI in `electron://host` format (e.g., `'electron://my-app'`).
+  The host is extracted as the namespace for IPC channel generation:
+  `electron://my-app` → channels `my-app:discover`, `my-app:rpc`.
+  Defaults to IPCDefaultChannelName (`'electron://ai-tool'`).
+
+###### dispatcher?
+
+`RpcServerDispatcher`
+
+Optional RpcServerDispatcher for v2.6 dispatch pattern.
+
+###### ipcMain?
+
+[`ServerIpcMain`](../type-aliases/ServerIpcMain.md)
+
+Optional custom ipcMain bridge (with `handle` and `removeHandler` methods).
+  When provided, used instead of the direct `electron` import.
+  Useful for testing or custom main-process IPC setups.
+
+#### Returns
+
+`IpcServerToolTransport`
+
+#### Overrides
+
+`ServerToolTransport.constructor`
+
+## Properties
+
+### apiUrl
+
+> **apiUrl**: `string`
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:418
+
+#### Inherited from
+
+`ServerToolTransport.apiUrl`
+
+***
+
+### canStream
+
+> **canStream**: `boolean`
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:421
+
+是否支持原生的流式传输 (如 HTTP 支持, Mailbox 通常不支持)
+
+#### Inherited from
+
+`ServerToolTransport.canStream`
+
+***
+
+### dispatcher
+
+> **dispatcher**: `RpcServerDispatcher`
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:420
+
+#### Inherited from
+
+`ServerToolTransport.dispatcher`
+
+***
+
+### manager
+
+> **manager**: `RpcTransportManager`
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:558
+
+所属管理器引用
+
+#### Inherited from
+
+`ServerToolTransport.manager`
+
+***
+
+### options?
+
+> `optional` **options?**: `ServerToolTransportOptions`
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:419
+
+#### Inherited from
+
+`ServerToolTransport.options`
+
+## Methods
+
+### \_start()
+
+> **\_start**(): `Promise`\<`void`\>
+
+Defined in: [tool-electron/src/ipc-server.ts:222](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-server.ts#L222)
+
+Start the transport (marks as started).
+IPC handlers are already registered via `addRpcHandler`/`addDiscoveryHandler`,
+so this method primarily serves as a lifecycle flag.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+`ServerToolTransport._start`
+
+***
+
+### addDiscoveryHandler()
+
+> **addDiscoveryHandler**(`apiPrefix`, `handler`): `void`
+
+Defined in: [tool-electron/src/ipc-server.ts:101](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-server.ts#L101)
+
+Register an IPC handler for tool discovery.
+Listens on the `{namespace}:discover` channel and returns the tool manifest.
+Automatically removes any previous handler for the same channel to prevent duplicates.
+
+#### Parameters
+
+##### apiPrefix
+
+`string`
+
+URI or namespace for the IPC channel (e.g., `'electron://my-app'`).
+
+##### handler
+
+() => `any`
+
+Function returning the tool definitions.
+  If the return value has a `toJSON()` method, it is called for serialization.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+`ServerToolTransport.addDiscoveryHandler`
+
+***
+
+### addRpcHandler()
+
+> **addRpcHandler**(`apiPrefix`, `options?`): `void`
+
+Defined in: [tool-electron/src/ipc-server.ts:125](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-server.ts#L125)
+
+Register an IPC handler for RPC calls.
+Listens on the `{namespace}:rpc` channel and routes incoming requests
+to the appropriate tool handler. In v2.6, uses the dispatcher for routing
+when available; falls back to direct tool lookup for backward compatibility.
+
+#### Parameters
+
+##### apiPrefix
+
+`string`
+
+URI or namespace for the IPC channel (e.g., `'electron://my-app'`).
+
+##### options?
+
+Optional config.
+
+###### registry?
+
+`any`
+
+A Tools class (with static `.get()`) or a map-like registry
+  (with `.get()` method). Defaults to `ServerTools`.
+
+###### tools?
+
+`any`
+
+Alias for `options.registry`. If both are provided, `tools` takes precedence.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+`ServerToolTransport.addRpcHandler`
+
+***
+
+### getListenAddr()
+
+> **getListenAddr**(): `string`
+
+Defined in: [tool-electron/src/ipc-server.ts:252](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-server.ts#L252)
+
+Get the listen address (URI) for this transport.
+Returns the `apiUrl` in `electron://` format (e.g., `'electron://my-app'`),
+or the default `IPCDefaultChannelName` if not set.
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+`ServerToolTransport.getListenAddr`
+
+***
+
+### getRaw()
+
+> **getRaw**(): `object`
+
+Defined in: [tool-electron/src/ipc-server.ts:243](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-server.ts#L243)
+
+Get the raw IPC main object and channel names.
+Useful for testing and introspection.
+
+#### Returns
+
+`object`
+
+##### channels
+
+> **channels**: [`Channels`](../type-aliases/Channels.md)
+
+##### ipcMain
+
+> **ipcMain**: [`ServerIpcMain`](../type-aliases/ServerIpcMain.md)
+
+#### Overrides
+
+`ServerToolTransport.getRaw`
+
+***
+
+### getRoutes()
+
+> **getRoutes**(): `string`[]
+
+Defined in: [tool-electron/src/ipc-server.ts:260](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-server.ts#L260)
+
+Get the routes exposed by this transport.
+IPC transports expose a single root route `['/']`.
+
+#### Returns
+
+`string`[]
+
+#### Overrides
+
+`ServerToolTransport.getRoutes`
+
+***
+
+### processIncomingCall()
+
+> `protected` **processIncomingCall**(`rawReq`, `rawRes`, `registry?`): `Promise`\<`void`\>
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:430
+
+Template Method：处理物理请求流水线。
+下层具体协议收到请求后，将其转化为内部结构，送入 Dispatcher 并写回。
+
+#### Parameters
+
+##### rawReq
+
+`any`
+
+##### rawRes
+
+`any`
+
+##### registry?
+
+`any`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+`ServerToolTransport.processIncomingCall`
+
+***
+
+### sendRpcResponse()
+
+> `protected` **sendRpcResponse**(`rpcRes`, `rawRes`): `Promise`\<`void`\>
+
+Defined in: [tool-electron/src/ipc-server.ts:202](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-server.ts#L202)
+
+#### Parameters
+
+##### rpcRes
+
+`ToolRpcResponse`
+
+##### rawRes
+
+`any`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+`ServerToolTransport.sendRpcResponse`
+
+***
+
+### ~~setApiRoot()~~
+
+> **setApiRoot**(`apiRoot`): `void`
+
+Defined in: [tool-electron/src/ipc-server.ts:80](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-server.ts#L80)
+
+#### Parameters
+
+##### apiRoot
+
+`string`
+
+#### Returns
+
+`void`
+
+#### Deprecated
+
+Use setApiUrl instead
+
+***
+
+### setApiUrl()
+
+> **setApiUrl**(`apiUrl`): `void`
+
+Defined in: [tool-electron/src/ipc-server.ts:74](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-server.ts#L74)
+
+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
+
+`ServerToolTransport.setApiUrl`
+
+***
+
+### start()
+
+> **start**(`options?`): `Promise`\<`any`\>
+
+Defined in: tool-rpc/dist/index-Bemsc4p1.d.ts:425
+
+启动物理监听
+
+#### Parameters
+
+##### options?
+
+`any`
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Inherited from
+
+`ServerToolTransport.start`
+
+***
+
+### stop()
+
+> **stop**(`force?`): `Promise`\<`void`\>
+
+Defined in: [tool-electron/src/ipc-server.ts:230](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-server.ts#L230)
+
+Stop the transport and remove IPC handlers.
+
+#### Parameters
+
+##### force?
+
+`boolean`
+
+If `true`, skip the `started` check and always stop.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+`ServerToolTransport.stop`
+
+***
+
+### toRpcRequest()
+
+> `protected` **toRpcRequest**(`rawReq`, `rawRes?`): `Promise`\<`ToolRpcRequest`\>
+
+Defined in: [tool-electron/src/ipc-server.ts:183](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/ipc-server.ts#L183)
+
+#### Parameters
+
+##### rawReq
+
+`any`
+
+##### rawRes?
+
+`any`
+
+#### Returns
+
+`Promise`\<`ToolRpcRequest`\>
+
+#### Overrides
+
+`ServerToolTransport.toRpcRequest`

package/docs/globals.md

@@ -0,0 +1,20 @@
+[**@isdk/tool-electron**](README.md)
+
+***
+
+# @isdk/tool-electron
+
+## Classes
+
+- [ElectronClientPubSubTransport](classes/ElectronClientPubSubTransport.md)
+- [ElectronServerPubSubTransport](classes/ElectronServerPubSubTransport.md)
+- [IpcClientToolTransport](classes/IpcClientToolTransport.md)
+- [IpcServerToolTransport](classes/IpcServerToolTransport.md)
+
+## Type Aliases
+
+- [Bridge](type-aliases/Bridge.md)
+- [Channels](type-aliases/Channels.md)
+- [PubSubBridge](type-aliases/PubSubBridge.md)
+- [ServerIpcMain](type-aliases/ServerIpcMain.md)
+- [ServerPubSubIpcMain](type-aliases/ServerPubSubIpcMain.md)

package/docs/type-aliases/Bridge.md

@@ -0,0 +1,37 @@
+[**@isdk/tool-electron**](../README.md)
+
+***
+
+[@isdk/tool-electron](../globals.md) / Bridge
+
+# Type Alias: Bridge
+
+> **Bridge** = `object`
+
+Defined in: [tool-electron/src/types.ts:20](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/types.ts#L20)
+
+Renderer-side RPC bridge.
+Injected into import('./ipc-client').IpcClientToolTransport
+to call `ipcRenderer.invoke` via `contextBridge` instead of importing `electron` directly.
+
+## Properties
+
+### invoke
+
+> **invoke**: (`channel`, ...`args`) => `Promise`\<`any`\>
+
+Defined in: [tool-electron/src/types.ts:21](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/types.ts#L21)
+
+#### Parameters
+
+##### channel
+
+`string`
+
+##### args
+
+...`any`[]
+
+#### Returns
+
+`Promise`\<`any`\>

package/docs/type-aliases/Channels.md

@@ -0,0 +1,27 @@
+[**@isdk/tool-electron**](../README.md)
+
+***
+
+[@isdk/tool-electron](../globals.md) / Channels
+
+# Type Alias: Channels
+
+> **Channels** = `object`
+
+Defined in: [tool-electron/src/types.ts:58](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/types.ts#L58)
+
+## Properties
+
+### discover
+
+> **discover**: `string`
+
+Defined in: [tool-electron/src/types.ts:59](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/types.ts#L59)
+
+***
+
+### rpc
+
+> **rpc**: `string`
+
+Defined in: [tool-electron/src/types.ts:60](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/types.ts#L60)

package/docs/type-aliases/PubSubBridge.md

@@ -0,0 +1,81 @@
+[**@isdk/tool-electron**](../README.md)
+
+***
+
+[@isdk/tool-electron](../globals.md) / PubSubBridge
+
+# Type Alias: PubSubBridge
+
+> **PubSubBridge** = `object`
+
+Defined in: [tool-electron/src/types.ts:41](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/types.ts#L41)
+
+Renderer-side Pub/Sub bridge.
+Injected into import('./pubsub/electron-client').ElectronClientPubSubTransport
+to listen, remove listeners, and send IPC messages for the event bus.
+
+## Methods
+
+### off()
+
+> **off**(`channel`, `listener`): `void`
+
+Defined in: [tool-electron/src/types.ts:43](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/types.ts#L43)
+
+#### Parameters
+
+##### channel
+
+`string`
+
+##### listener
+
+(`event`, ...`args`) => `void`
+
+#### Returns
+
+`void`
+
+***
+
+### on()
+
+> **on**(`channel`, `listener`): `void`
+
+Defined in: [tool-electron/src/types.ts:42](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/types.ts#L42)
+
+#### Parameters
+
+##### channel
+
+`string`
+
+##### listener
+
+(`event`, ...`args`) => `void`
+
+#### Returns
+
+`void`
+
+***
+
+### send()
+
+> **send**(`channel`, ...`args`): `void`
+
+Defined in: [tool-electron/src/types.ts:44](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/types.ts#L44)
+
+#### Parameters
+
+##### channel
+
+`string`
+
+##### args
+
+...`any`[]
+
+#### Returns
+
+`void`

package/docs/type-aliases/ServerIpcMain.md

@@ -0,0 +1,55 @@
+[**@isdk/tool-electron**](../README.md)
+
+***
+
+[@isdk/tool-electron](../globals.md) / ServerIpcMain
+
+# Type Alias: ServerIpcMain
+
+> **ServerIpcMain** = `object`
+
+Defined in: [tool-electron/src/types.ts:30](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/types.ts#L30)
+
+Main-side RPC bridge.
+Injected into import('./ipc-server').IpcServerToolTransport
+to register `ipcMain.handle` handlers via a custom object (e.g. mock).
+
+## Methods
+
+### handle()
+
+> **handle**(`channel`, `handler`): `void`
+
+Defined in: [tool-electron/src/types.ts:31](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/types.ts#L31)
+
+#### Parameters
+
+##### channel
+
+`string`
+
+##### handler
+
+(`event`, ...`args`) => `any`
+
+#### Returns
+
+`void`
+
+***
+
+### removeHandler()
+
+> **removeHandler**(`channel`): `void`
+
+Defined in: [tool-electron/src/types.ts:32](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/types.ts#L32)
+
+#### Parameters
+
+##### channel
+
+`string`
+
+#### Returns
+
+`void`