@oldzy/conduit-electron-adapter 1.0.11 → 1.1.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Conduit
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 Conduit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,170 +1,202 @@
-# Conduit Electron Adapter
-
-Electron IPC adapter for [@oldzy/conduit](https://github.com/oldzy/conduit), enabling seamless communication between Electron's main and renderer processes.
-
-## Features
-
-- 🔌 IPC-based communication between main and renderer processes
-- 🎯 Request/Response pattern with UUID tracking
-- 📡 Separate handlers for simple and streaming responses
-- 🚫 Request cancellation support
-- 💉 Automatic dependency injection for Electron App and IpcMain
-- 🔄 AbortController integration for async operations
-- 🔒 Type-safe with TypeScript generics
-
-## Installation
-
-```bash
-npm install @oldzy/conduit-electron-adapter
-```
-
-## Usage
-
-### Main Process
-
-```typescript
-import { Application } from '@oldzy/conduit';
-import { ElectronAdapter } from '@oldzy/conduit-electron-adapter';
-
-const app = new Application();
-const electronAdapter = new ElectronAdapter();
-
-app.useAdapter(electronAdapter);
-
-// Register your handlers...
-await app.build();
-```
-
-### Preload Script
-
-Configure your Electron window to use the preload script:
-
-```typescript
-import { BrowserWindow } from 'electron';
-import path from 'path';
-
-// Use require.resolve to get the preload path from node_modules
-const preloadPath = require.resolve('@oldzy/conduit-electron-adapter/preload');
-
-const mainWindow = new BrowserWindow({
-  webPreferences: {
-    preload: preloadPath,
-    contextIsolation: true,
-    nodeIntegration: false
-  }
-});
-```
-
-The preload script automatically:
-- Exposes `conduit` to the renderer via `contextBridge`
-- Handles all IPC listeners for streaming, errors, and cancellation
-- Manages request timeout (30 seconds)
-- Cleans up listeners automatically
-
-### Renderer Process
-
-```typescript
-// Simple request/response (for SimpleHandler)
-const response = await window.conduit.send<GetUserResponse>({
-  uuid: crypto.randomUUID(),
-  type: 'GET_USER',
-  userId: '123'
-});
-console.log(response.userName);
-
-// Streaming request (for StreamingHandler)
-await window.conduit.stream<LogChunkResponse>(
-  {
-    uuid: crypto.randomUUID(),
-    type: 'STREAM_LOGS',
-    filename: 'app.log'
-  },
-  (chunk) => {
-    console.log('Received chunk:', chunk.line);
-  }
-);
-
-// Cancel a request
-await window.conduit.cancel('request-uuid');
-```
-
-## API
-
-### ElectronAdapter (Main Process)
-
-The adapter automatically:
-- Registers `conduit:send` IPC handler for simple requests (SimpleHandler)
-- Registers `conduit:stream` IPC handler for streaming requests (StreamingHandler)
-- Registers `conduit:cancel` IPC handler for cancelling requests
-- Injects `ElectronApp` (app instance) and `IpcMain` into the service container
-- Manages streaming responses via IPC events
-- Handles request cancellation with AbortController
-
-### IConduitService (Renderer Process)
-
-The `window.conduit` object is automatically typed when you import the package:
-
-```typescript
-import '@oldzy/conduit-electron-adapter';
-
-// Now window.conduit is fully typed!
-const response = await window.conduit.send<MyResponse>(request);
-```
-
-```typescript
-interface IConduitService {
-  send: <TResponse extends BaseResponse>(
-    request: BaseRequest
-  ) => Promise<TResponse>;
-  stream: <TResponse extends BaseResponse>(
-    request: BaseRequest,
-    onData: (response: TResponse) => void
-  ) => Promise<void>;
-  cancel: (requestUuid: string) => Promise<void>;
-}
-```
-
-#### Methodstimeout (30s) and cleanup
-  
-- **`cancel(requestUuid)`** - Cancel a pending request by UUID
-
-**Important**: Use `send()` for SimpleHandler and `stream()` for StreamingHandler. Using the wrong method will result in an error.
-
-### IPC Channels
-
-Internal channels (handled automatically by the preload script):
-- `conduit:send` - Send a simple request (invoke) - returns response
-- `conduit:stream` - Start a streaming request (invoke) - sends chunks via eventsuest (invoke) - sends chunks via eventsd cleanup
-  
-- **`cancel(requestUuid)`** - Cancel a pending request by UUID
-
-**Important**: Use `send()` for SimpleHandler and `stream()` for StreamingHandler. Using the wrong method will result in an error.
-- **`cancel(requestUuid)`** - Cancel a pending request by UUID
-
-### IPC Channels
-
-Internal channels (handled automatically by the preload script):
-- `conduit:send` - Send a request (invoke)
-- `conduit:cancel` - Cancel a pending request (invoke)
-- `conduit:response:data:{uuid}` - Streaming response data (listener)
-- `conduit:response:complete:{uuid}` - Stream completed (listener)
-- `conduit:response:error:{uuid}` - Error occurred (listener)
-- `conduit:response:cancelled:{uuid}` - Request was cancelled (listener)
-
-### Types
-
-```typescript
-interface ErrorResponse {
-class ErrorResponse extends BaseResponse {
-  constructor(
-    public requestUuid: string,
-    public error: string,
-    public stack?: string
-  );
-}
-```
-
-**Note**: The `window.conduit` type is automatically available when you import the package in your TypeScript files.
-## License
-
-MIT
+# Conduit Electron Adapter
+
+Electron IPC adapter for [@oldzy/conduit](https://github.com/oldzy/conduit), enabling seamless communication between Electron's main and renderer processes.
+
+## Features
+
+- 🔌 IPC-based communication between main and renderer processes
+- 🎯 Request/Response pattern with UUID tracking
+- 📡 Separate handlers for simple and streaming responses
+- 🚫 Request cancellation support
+- 💉 Automatic dependency injection for Electron App and IpcMain
+- 🔄 AbortController integration for async operations
+- 🔒 Type-safe with TypeScript generics
+
+## Installation
+
+```bash
+npm install @oldzy/conduit-electron-adapter
+```
+
+## Usage
+
+### Main Process
+
+```typescript
+import { Application } from '@oldzy/conduit';
+import { ElectronAdapter } from '@oldzy/conduit-electron-adapter';
+
+const app = new Application();
+const electronAdapter = new ElectronAdapter();
+
+app.useAdapter(electronAdapter);
+
+// Register your handlers...
+await app.build();
+```
+
+### Preload Script
+
+Configure your Electron window to use the preload script:
+
+```typescript
+import { BrowserWindow } from 'electron';
+import path from 'path';
+
+// Use require.resolve to get the preload path from node_modules
+const preloadPath = require.resolve('@oldzy/conduit-electron-adapter/preload');
+
+const mainWindow = new BrowserWindow({
+  webPreferences: {
+    preload: preloadPath,
+    contextIsolation: true,
+    nodeIntegration: false
+  }
+});
+```
+
+The preload script automatically:
+- Exposes `conduit` to the renderer via `contextBridge`
+- Handles all IPC listeners for streaming, errors, and cancellation
+- Manages request timeout (30 seconds)
+- Cleans up listeners automatically
+
+### Renderer Process
+
+```typescript
+// Simple request/response (for SimpleHandler)
+const response = await window.conduit.send<GetUserResponse>({
+  uuid: crypto.randomUUID(),
+  type: 'GET_USER',
+  userId: '123'
+});
+console.log(response.userName);
+
+// Streaming request (for StreamingHandler)
+await window.conduit.stream<LogChunkResponse>(
+  {
+    uuid: crypto.randomUUID(),
+    type: 'STREAM_LOGS',
+    filename: 'app.log'
+  },
+  (chunk) => {
+    console.log('Received chunk:', chunk.line);
+  }
+);
+
+// Cancel a request
+await window.conduit.cancel('request-uuid');
+```
+
+## API
+
+### ElectronAdapter (Main Process)
+
+The adapter automatically:
+- Registers `conduit:send` IPC handler for simple requests (SimpleHandler)
+- Registers `conduit:stream` IPC handler for streaming requests (StreamingHandler)
+- Registers `conduit:cancel` IPC handler for cancelling requests
+- Injects `ElectronApp` (app instance) and `IpcMain` into the service container
+- Manages streaming responses via IPC events
+- Handles request cancellation with AbortController
+
+### IConduitService (Renderer Process)
+
+The `window.conduit` object is automatically typed when you import the package:
+
+```typescript
+import '@oldzy/conduit-electron-adapter';
+
+// Now window.conduit is fully typed!
+const response = await window.conduit.send<MyResponse>(request);
+```
+
+```typescript
+interface IConduitService {
+  send: <TResponse extends BaseResponse>(
+    request: BaseRequest
+  ) => Promise<TResponse>;
+  stream: <TResponse extends BaseResponse>(
+    request: BaseRequest,
+    onData: (response: TResponse) => void
+  ) => Promise<void>;
+  cancel: (requestUuid: string) => Promise<void>;
+}
+```
+
+#### Methodstimeout (30s) and cleanup
+  
+- **`cancel(requestUuid)`** - Cancel a pending request by UUID
+
+**Important**: Use `send()` for SimpleHandler and `stream()` for StreamingHandler. Using the wrong method will result in an error.
+
+### IPC Channels
+
+Internal channels (handled automatically by the preload script):
+- `conduit:send` - Send a simple request (invoke) - returns response
+- `conduit:stream` - Start a streaming request (invoke) - sends chunks via eventsuest (invoke) - sends chunks via eventsd cleanup
+  
+- **`cancel(requestUuid)`** - Cancel a pending request by UUID
+
+**Important**: Use `send()` for SimpleHandler and `stream()` for StreamingHandler. Using the wrong method will result in an error.
+- **`cancel(requestUuid)`** - Cancel a pending request by UUID
+
+### IPC Channels
+
+Internal channels (handled automatically by the preload script):
+- `conduit:send` - Send a request (invoke)
+- `conduit:cancel` - Cancel a pending request (invoke)
+- `conduit:response:data:{uuid}` - Streaming response data (listener)
+- `conduit:response:complete:{uuid}` - Stream completed (listener)
+- `conduit:response:error:{uuid}` - Error occurred (listener)
+- `conduit:response:cancelled:{uuid}` - Request was cancelled (listener)
+
+### Types
+
+```typescript
+interface ErrorResponse {
+class ErrorResponse extends BaseResponse {
+  constructor(
+    public requestUuid: string,
+    public error: string,
+    public stack?: string
+  );
+}
+```
+
+**Note**: The `window.conduit` type is automatically available when you import the package in your TypeScript files.
+
+## Releasing
+
+This project uses [release-please](https://github.com/googleapis/release-please) to automate versioning and npm publishing via GitHub Actions.
+
+### How it works
+
+1. Push commits to `main` using **Conventional Commits** prefixes
+2. Release-please automatically creates/updates a release PR with version bump and changelog
+3. Merge the PR when you're ready → tag, GitHub Release, and npm publish happen automatically
+
+### Commit prefixes
+
+| Prefix | Version bump | Example |
+|---|---|---|
+| `fix:` | **patch** (1.0.0 → 1.0.1) | `fix: resolve scoped service disposal` |
+| `feat:` | **minor** (1.0.0 → 1.1.0) | `feat: add async handler support` |
+| `feat!:` or `BREAKING CHANGE:` | **major** (1.0.0 → 2.0.0) | `feat!: redesign mediator API` |
+
+Commits without these prefixes are ignored for versioning purposes.
+
+### Authentication
+
+Publishing uses [npm trusted publishing](https://docs.npmjs.com/trusted-publishers) (OIDC) — no npm token secret needed. Configure the trusted publisher on npmjs.com:
+
+1. Go to **npmjs.com** → **@oldzy/conduit** → **Settings** → **Trusted Publisher**
+2. Select **GitHub Actions** and fill in:
+   - **Organization or user**: `oldzy`
+   - **Repository**: `conduit-electron-adpater`
+   - **Workflow filename**: `release-please.yml`
+3. Save
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -27,10 +27,10 @@ declare class ErrorResponse extends BaseResponse {
     constructor(requestUuid: string, error: string, stack?: string | undefined);
 }
 
-declare global {
-  interface Window {
-    conduit: IConduitService;
-  }
+declare global {
+  interface Window {
+    conduit: IConduitService;
+  }
 }
 
 export { ELECTRON_APP_SERVICE_KEY, ElectronAdapter, ErrorResponse, IConduitService, IPC_MAIN_SERVICE_KEY };

package/dist/index.d.ts

@@ -27,10 +27,10 @@ declare class ErrorResponse extends BaseResponse {
     constructor(requestUuid: string, error: string, stack?: string | undefined);
 }
 
-declare global {
-  interface Window {
-    conduit: IConduitService;
-  }
+declare global {
+  interface Window {
+    conduit: IConduitService;
+  }
 }
 
 export { ELECTRON_APP_SERVICE_KEY, ElectronAdapter, ErrorResponse, IConduitService, IPC_MAIN_SERVICE_KEY };

package/package.json

@@ -1,74 +1,74 @@
-{
-  "name": "@oldzy/conduit-electron-adapter",
-  "version": "1.0.11",
-  "description": "Electron IPC adapter for @oldzy/conduit - enables seamless communication between main and renderer processes",
-  "author": "oldzy",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/oldzy/conduit-electron-adapter.git"
-  },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "require": "./dist/index.js",
-      "import": "./dist/index.mjs"
-    },
-    "./preload": {
-      "types": "./dist/preload.d.ts",
-      "require": "./dist/preload.js",
-      "import": "./dist/preload.mjs"
-    }
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "build": "tsup",
-    "build:prod": "cross-env NODE_ENV=production tsup",
-    "dev": "tsup --watch",
-    "test": "vitest",
-    "test:ui": "vitest --ui",
-    "test:coverage": "vitest --coverage",
-    "test:watch": "vitest --watch",
-    "lint": "eslint src",
-    "prepublishOnly": "npm run build:prod && npm test",
-    "publish:npm": "npm run build:prod && npm test && npm publish --access public"
-  },
-  "keywords": [
-    "conduit",
-    "electron",
-    "ipc",
-    "adapter",
-    "electron-adapter",
-    "electron-ipc",
-    "mediator",
-    "request-response",
-    "streaming",
-    "contextbridge",
-    "preload"
-  ],
-  "devDependencies": {
-    "@swc/core": "^1.15.2",
-    "@types/node": "^24.10.1",
-    "@vitest/coverage-v8": "^4.0.9",
-    "@vitest/ui": "^4.0.9",
-    "cross-env": "^10.1.0",
-    "eslint": "^9.39.1",
-    "tsup": "^8.5.1",
-    "typescript": "^5.9.3",
-    "unplugin-swc": "^1.5.8",
-    "vitest": "^4.0.9"
-  },
-  "dependencies": {
-    "@oldzy/conduit": "^1.0.10",
-    "electron": "^39.2.7"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  }
-}
+{
+  "name": "@oldzy/conduit-electron-adapter",
+  "version": "1.1.0",
+  "description": "Electron IPC adapter for @oldzy/conduit - enables seamless communication between main and renderer processes",
+  "author": "oldzy",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/oldzy/conduit-electron-adapter.git"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./preload": {
+      "types": "./dist/preload.d.ts",
+      "require": "./dist/preload.js",
+      "import": "./dist/preload.mjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "build:prod": "cross-env NODE_ENV=production tsup",
+    "dev": "tsup --watch",
+    "test": "vitest",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest --coverage",
+    "test:watch": "vitest --watch",
+    "lint": "eslint src",
+    "prepublishOnly": "npm run build:prod && npm test",
+    "publish:npm": "npm run build:prod && npm test && npm publish --access public"
+  },
+  "keywords": [
+    "conduit",
+    "electron",
+    "ipc",
+    "adapter",
+    "electron-adapter",
+    "electron-ipc",
+    "mediator",
+    "request-response",
+    "streaming",
+    "contextbridge",
+    "preload"
+  ],
+  "devDependencies": {
+    "@swc/core": "^1.15.2",
+    "@types/node": "^24.10.1",
+    "@vitest/coverage-v8": "^4.0.9",
+    "@vitest/ui": "^4.0.9",
+    "cross-env": "^10.1.0",
+    "eslint": "^9.39.1",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "unplugin-swc": "^1.5.8",
+    "vitest": "^4.0.9"
+  },
+  "dependencies": {
+    "@oldzy/conduit": "^1.1.0",
+    "electron": "^39.2.7"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}