@isdk/tool-electron 1.0.0

package/docs/classes/ElectronClientPubSubTransport.md

@@ -0,0 +1,163 @@
+[**@isdk/tool-electron**](../README.md)
+
+***
+
+[@isdk/tool-electron](../globals.md) / ElectronClientPubSubTransport
+
+# Class: ElectronClientPubSubTransport
+
+Defined in: [tool-electron/src/pubsub/electron-client.ts:53](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-client.ts#L53)
+
+Renderer-side Pub/Sub transport over Electron IPC.
+
+## Param
+
+Namespace for IPC channel generation. Supports `electron://` URI format
+  (e.g., `'electron://my-app'` → namespace `my-app`). Defaults to empty string
+  (call [setApiRoot](#setapiroot) before [connect](#connect)).
+
+## Param
+
+Optional config.
+
+## Param
+
+Injectable bridge with `on`, `off`, and `send` methods.
+  When provided, used instead of directly importing `ipcRenderer`.
+
+## Implements
+
+- `IPubSubClientTransport`
+
+## Constructors
+
+### Constructor
+
+> **new ElectronClientPubSubTransport**(`apiRoot?`, `options?`): `ElectronClientPubSubTransport`
+
+Defined in: [tool-electron/src/pubsub/electron-client.ts:60](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-client.ts#L60)
+
+#### Parameters
+
+##### apiRoot?
+
+`string`
+
+##### options?
+
+###### bridge?
+
+[`PubSubBridge`](../type-aliases/PubSubBridge.md)
+
+#### Returns
+
+`ElectronClientPubSubTransport`
+
+## Methods
+
+### cleanup()
+
+> **cleanup**(): `Promise`\<`void`\>
+
+Defined in: [tool-electron/src/pubsub/electron-client.ts:199](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-client.ts#L199)
+
+Clean up all IPC listeners and event subscriptions.
+Removes the downstream IPC listener and clears all registered event handlers.
+Should be called when the transport is no longer needed (e.g., when the window closes).
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### connect()
+
+> **connect**(`toolName`, `params?`): `PubSubClientStream`
+
+Defined in: [tool-electron/src/pubsub/electron-client.ts:108](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-client.ts#L108)
+
+Establish a PubSub connection stream.
+Sends a `pubsub-connect:{ns}` IPC message and returns a `PubSubClientStream`
+for subscribing to events and sending messages upstream.
+
+#### Parameters
+
+##### toolName
+
+`string`
+
+Logical connection name (not used for channel routing;
+  channels are derived from the constructor's `apiRoot`).
+
+##### params?
+
+`any`
+
+Optional connection parameters (e.g., `{ events: ['event-a', 'event-b'] }`
+  for initial event subscriptions).
+
+#### Returns
+
+`PubSubClientStream`
+
+A `PubSubClientStream` instance.
+
+#### Implementation of
+
+`IPubSubClientTransport.connect`
+
+***
+
+### disconnect()
+
+> **disconnect**(`stream`): `void`
+
+Defined in: [tool-electron/src/pubsub/electron-client.ts:190](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-client.ts#L190)
+
+Disconnect a PubSub stream.
+Delegates to `stream.close()` which sends a `pubsub-disconnect:{ns}` IPC message
+and cleans up local event listeners.
+
+#### Parameters
+
+##### stream
+
+`PubSubClientStream`
+
+The stream to disconnect.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IPubSubClientTransport.disconnect`
+
+***
+
+### setApiRoot()
+
+> **setApiRoot**(`apiRoot`): `void`
+
+Defined in: [tool-electron/src/pubsub/electron-client.ts:70](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-client.ts#L70)
+
+Set the API root (namespace) and derive IPC channel names.
+
+#### Parameters
+
+##### apiRoot
+
+`string`
+
+Namespace in `electron://` URI format (e.g., `'electron://my-app'`).
+  The host is extracted as the namespace for PubSub channel generation.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IPubSubClientTransport.setApiRoot`

package/docs/classes/ElectronServerPubSubTransport.md

@@ -0,0 +1,384 @@
+[**@isdk/tool-electron**](../README.md)
+
+***
+
+[@isdk/tool-electron](../globals.md) / ElectronServerPubSubTransport
+
+# Class: ElectronServerPubSubTransport
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:50](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L50)
+
+Main-process Pub/Sub transport over Electron IPC.
+
+## Param
+
+Namespace in `electron://` URI format (e.g., `'electron://my-app'`).
+  Used to derive all IPC channel names for PubSub communication.
+  Must be non-empty.
+
+## Param
+
+Optional config.
+
+## Param
+
+Injectable bridge with `on`, `removeAllListeners` methods.
+  When provided, used instead of directly importing `ipcMain`.
+
+## Implements
+
+- `IPubSubServerTransport`
+
+## Constructors
+
+### Constructor
+
+> **new ElectronServerPubSubTransport**(`namespace`, `options?`): `ElectronServerPubSubTransport`
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:63](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L63)
+
+#### Parameters
+
+##### namespace
+
+`string`
+
+##### options?
+
+###### ipcMain?
+
+[`ServerPubSubIpcMain`](../type-aliases/ServerPubSubIpcMain.md)
+
+#### Returns
+
+`ElectronServerPubSubTransport`
+
+## Properties
+
+### name
+
+> `readonly` **name**: `"electron"` = `'electron'`
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:51](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L51)
+
+A unique, human-readable name for the transport (e.g., 'sse', 'websocket').
+
+#### Implementation of
+
+`IPubSubServerTransport.name`
+
+***
+
+### protocol
+
+> `readonly` **protocol**: `"electron"`
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:52](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L52)
+
+The protocol identifier.
+
+#### Implementation of
+
+`IPubSubServerTransport.protocol`
+
+## Methods
+
+### cleanup()
+
+> **cleanup**(): `void`
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:254](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L254)
+
+Clean up all IPC listeners and session state.
+Removes `connect`, `disconnect`, and `upstream` IPC listeners,
+clears all sessions and subscriptions.
+Should be called when the transport is no longer needed (e.g., during app shutdown).
+
+#### Returns
+
+`void`
+
+***
+
+### connect()
+
+> **connect**(`options?`): `PubSubServerSession`
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:117](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L117)
+
+Connect a client session.
+Called internally by the IPC listener (registered in [listen](#listen)) when
+a client sends a `pubsub-connect:{ns}` message. Creates a `PubSubServerSession`
+for the new client and stores it for event broadcasting.
+
+#### Parameters
+
+##### options?
+
+###### events?
+
+`string`[]
+
+Optional initial event subscriptions for the session.
+
+###### req
+
+`IpcMainEvent`
+
+The `IpcMainEvent` from Electron IPC.
+
+###### res
+
+`WebContents`
+
+The `WebContents` of the client window.
+
+#### Returns
+
+`PubSubServerSession`
+
+The newly created `PubSubServerSession`.
+
+#### Throws
+
+If `req` or `res` are not provided.
+
+#### Implementation of
+
+`IPubSubServerTransport.connect`
+
+***
+
+### getSessionFromReq()
+
+> **getSessionFromReq**(`req`): `PubSubServerSession` \| `undefined`
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:266](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L266)
+
+Find a client session by its IPC request event.
+
+#### Parameters
+
+##### req
+
+`IpcMainEvent`
+
+The `IpcMainEvent` to look up.
+
+#### Returns
+
+`PubSubServerSession` \| `undefined`
+
+The corresponding `PubSubServerSession`, or `undefined` if not found.
+
+#### Implementation of
+
+`IPubSubServerTransport.getSessionFromReq`
+
+***
+
+### listen()
+
+> **listen**(): `void`
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:75](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L75)
+
+Activates the transport by setting up listeners for IPC events.
+This method should be called once in the main process during application setup.
+
+#### Returns
+
+`void`
+
+***
+
+### onConnection()
+
+> **onConnection**(`cb`): `void`
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:234](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L234)
+
+Register a callback for new client connections.
+
+#### Parameters
+
+##### cb
+
+(`s`) => `void`
+
+Callback receiving the new `PubSubServerSession`.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IPubSubServerTransport.onConnection`
+
+***
+
+### onDisconnect()
+
+> **onDisconnect**(`cb`): `void`
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:240](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L240)
+
+Register a callback for client disconnections.
+
+#### Parameters
+
+##### cb
+
+(`s`) => `void`
+
+Callback receiving the disconnected `PubSubServerSession`.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IPubSubServerTransport.onDisconnect`
+
+***
+
+### onMessage()
+
+> **onMessage**(`cb`): `void`
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:246](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L246)
+
+Register a callback for incoming messages from clients.
+
+#### Parameters
+
+##### cb
+
+(`session`, `event`, `data`, `ctx?`) => `void`
+
+Callback receiving the session, event name, data, and optional context.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IPubSubServerTransport.onMessage`
+
+***
+
+### publish()
+
+> **publish**(`event`, `data`, `target?`, `ctx?`): `void`
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:210](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L210)
+
+Publish an event to connected clients.
+If `target.clientId` is provided, only the specified client(s) receive the event.
+Otherwise, the event is broadcast to all subscribed clients.
+
+#### Parameters
+
+##### event
+
+`string`
+
+The event name to publish.
+
+##### data
+
+`any`
+
+The event payload.
+
+##### target?
+
+Optional target specification for directed delivery.
+
+###### clientId?
+
+`string` \| `string`[]
+
+A single client ID or array of client IDs to target.
+
+##### ctx?
+
+`PubSubCtx`
+
+Optional PubSub context.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IPubSubServerTransport.publish`
+
+***
+
+### subscribe()
+
+> **subscribe**(`session`, `events`): `void`
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:172](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L172)
+
+Subscribe a client session to one or more events.
+Events must be subscribed before they can be received by the client.
+
+#### Parameters
+
+##### session
+
+`PubSubServerSession`
+
+The client session to subscribe.
+
+##### events
+
+`string`[]
+
+Array of event names to subscribe to.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IPubSubServerTransport.subscribe`
+
+***
+
+### unsubscribe()
+
+> **unsubscribe**(`session`, `events`): `void`
+
+Defined in: [tool-electron/src/pubsub/electron-server.ts:191](https://github.com/isdk/ai-tool-electron.js/blob/7342c9cf7d483faaa9613fa3cacb08c7e4c19c6f/src/pubsub/electron-server.ts#L191)
+
+Unsubscribe a client session from one or more events.
+
+#### Parameters
+
+##### session
+
+`PubSubServerSession`
+
+The client session to unsubscribe.
+
+##### events
+
+`string`[]
+
+Array of event names to unsubscribe from.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IPubSubServerTransport.unsubscribe`