@electron-ipc-bridge/vite-plugin 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 metacurb
+
+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

@@ -0,0 +1,54 @@
+<h1 align="center">@electron-ipc-bridge/vite-plugin</h1>
+
+<p align="center">
+  A <a href="https://vitejs.dev/">Vite</a> plugin for <a href="https://metacurb.github.io/electron-ipc-bridge/">Electron IPC Bridge</a>. It parses your main entry, discovers controllers registered with <code>createIpcApp</code>, and generates global (e.g. <code>Window</code>) and/or runtime type modules so the renderer gets typed IPC (e.g. <code>window.ipc</code>).
+</p>
+
+## Install
+
+```bash
+npm install -D @electron-ipc-bridge/vite-plugin
+```
+
+Peer: `vite` ^5 / ^6 / ^7, `typescript` ^5.
+
+## Usage
+
+```ts
+// vite.config.ts
+import { electronIpcBridge } from "@electron-ipc-bridge/vite-plugin";
+
+export default {
+  plugins: [electronIpcBridge()],
+};
+```
+
+## Options
+
+| Option               | Description                                                                                                                   |
+| -------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `main`               | Path to main process entry. Default: `"src/main/index.ts"`                                                                    |
+| `preload`            | Path to preload entry. Default: `"src/preload/index.ts"`                                                                      |
+| `types.global`       | Output path for generated global `Window` augmentation (`.d.ts`). Default: preload dir + `ipc.d.ts`. Set `false` to disable.  |
+| `types.runtime`      | Output path for generated runtime types module. Default: auto (e.g. `src/renderer/src/ipc.types.ts`). Set `false` to disable. |
+| `resolutionStrategy` | Optional strategy when `controllers` is a call and default resolution finds nothing. Set to `"nest"` for NestJS. See below.   |
+
+### Resolution behaviour
+
+- **Array:** `createIpcApp({ controllers: [FooController, ...] })` — resolved from the array.
+- **Call with module/class:** `createIpcApp({ controllers: getIpcControllers(SomeModule) })` — plugin follows call args to class refs and resolves from decorators with `controllers`/`providers` (e.g. Nest `@Module`). No strategy needed.
+- **Call with no static refs (e.g. DI):** When the above yields no controllers, an optional `resolutionStrategy` runs. For Nest, set `resolutionStrategy: "nest"`.
+
+```ts
+import { electronIpcBridge } from "@electron-ipc-bridge/vite-plugin";
+
+export default {
+  plugins: [electronIpcBridge({ resolutionStrategy: "nest" })],
+};
+```
+
+Full defaults and semantics: [Plugin Options](https://metacurb.github.io/electron-ipc-bridge/reference/vite-plugin/plugin-options) · [Generation Behaviour](https://metacurb.github.io/electron-ipc-bridge/reference/vite-plugin/generation-behaviour).
+
+## Documentation
+
+[metacurb.github.io/electron-ipc-bridge](https://metacurb.github.io/electron-ipc-bridge/)

package/dist/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const DEFAULT_GLOBAL_TYPES_FILENAME = "ipc.d.ts";
+export declare const DEFAULT_MAIN_ENTRY = "src/main/index.ts";
+export declare const DEFAULT_PRELOAD_ENTRY = "src/preload/index.ts";
+export declare const DEFAULT_RENDERER_RUNTIME_DIR = "src/renderer/src";
+export declare const DEFAULT_RUNTIME_TYPES_FILENAME = "ipc.types.ts";

package/dist/generate-ipc.d.ts

@@ -0,0 +1,9 @@
+import { Logger } from "vite";
+import { PluginState } from "./plugin-state.js";
+import type { PluginTypesOptions, ResolutionStrategy } from "./types.js";
+export declare function generateIpc(root: string, logger: Logger, state: PluginState, options: {
+    main: string;
+    preload: string;
+    types: PluginTypesOptions;
+    resolutionStrategy?: ResolutionStrategy;
+}): void;

package/dist/generator/build-namespaces.d.ts

@@ -0,0 +1,2 @@
+import type { ControllerMetadata } from "../parser/types.js";
+export declare const buildNamespaces: (controllers: ControllerMetadata[]) => string[];

package/dist/generator/build-type-definitions.d.ts

@@ -0,0 +1,2 @@
+import type { ControllerMetadata } from "../parser/types.js";
+export declare const buildTypeDefinitions: (controllers: ControllerMetadata[]) => string;

package/dist/generator/generate-global-types.d.ts

@@ -0,0 +1 @@
+export declare const generateGlobalTypes: (namespace: string | undefined, ipcApiImportPath: string) => string;

package/dist/generator/generate-runtime-types.d.ts

@@ -0,0 +1,2 @@
+import type { ControllerMetadata } from "../parser/types.js";
+export declare const generateRuntimeTypes: (controllers: ControllerMetadata[]) => string;

package/dist/generator/generate-types.d.ts

@@ -0,0 +1,2 @@
+import { ControllerMetadata } from "../parser/types.js";
+export declare const generateTypes: (controllers: ControllerMetadata[], namespace?: string) => string;

package/dist/generator/get-return-type.d.ts

@@ -0,0 +1 @@
+export declare const getReturnType: (decorator: string, originalReturnType: string) => string;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { electronIpcBridge, type PluginOptions } from "./plugin.js";