electron-json-rpc 1.0.0

package/dist/types-BnGse9DF.d.mts

@@ -0,0 +1,201 @@
+//#region src/types.d.ts
+/**
+ * JSON-RPC 2.0 types for Electron IPC communication
+ */
+/**
+ * JSON-RPC 2.0 Request
+ * id is optional for notifications (one-way calls)
+ */
+interface JsonRpcRequest {
+  jsonrpc: "2.0";
+  id?: string | number | null;
+  method: string;
+  params?: unknown[] | Record<string, unknown>;
+}
+/**
+ * JSON-RPC 2.0 Response
+ */
+interface JsonRpcResponse {
+  jsonrpc: "2.0";
+  id: string | number | null;
+  result?: unknown;
+  error?: JsonRpcError;
+}
+/**
+ * JSON-RPC 2.0 Error
+ */
+interface JsonRpcError {
+  code: number;
+  message: string;
+  data?: unknown;
+}
+/**
+ * JSON-RPC 2.0 Error codes
+ */
+declare enum JsonRpcErrorCode {
+  ParseError = -32700,
+  InvalidRequest = -32600,
+  MethodNotFound = -32601,
+  InvalidParams = -32602,
+  InternalError = -32603,
+}
+/**
+ * RPC method handler type
+ */
+type RpcHandler = (...params: unknown[]) => unknown | Promise<unknown>;
+/**
+ * Validator function for params
+ * Throw an error to reject the request with InvalidParams error
+ */
+type RpcValidator = (params: unknown[]) => void | Promise<void>;
+/**
+ * RPC method registration options
+ */
+interface RpcMethodOptions {
+  /** Optional validator for parameters */
+  validate?: RpcValidator;
+  /** Optional description for documentation */
+  description?: string;
+}
+/**
+ * Typed API interface for RPC client
+ * Converts method signatures to match JSON-RPC behavior
+ */
+type RpcApi<T extends Record<string, (...args: any[]) => any>> = { [K in keyof T]: T[K] extends ((...args: infer P) => infer R) ? R extends void ? (...params: P) => void : (...params: P) => Promise<Awaited<R>> : never };
+/**
+ * Options for RPC client
+ */
+interface RpcClientOptions {
+  /** Timeout in milliseconds (default: 30000) */
+  timeout?: number;
+  /** API name exposed by preload (default: 'rpc') */
+  apiName?: string;
+}
+/**
+ * Options for exposing RPC API in preload
+ */
+interface ExposeRpcApiOptions {
+  contextBridge: {
+    exposeInMainWorld: (name: string, api: Record<string, unknown>) => void;
+  };
+  ipcRenderer: {
+    send: (channel: string, ...args: unknown[]) => void;
+    on: (channel: string, listener: (event: unknown, ...args: unknown[]) => void) => void;
+    removeListener: (channel: string, listener: (...args: unknown[]) => void) => void;
+  };
+  /** Optional whitelist of methods to expose */
+  methods?: string[];
+  /** API name exposed to renderer (default: 'rpc') */
+  apiName?: string;
+}
+/**
+ * Stream chunk message for IPC
+ */
+interface StreamChunk {
+  streamId: string | number;
+  type: "chunk" | "end" | "error";
+  data?: unknown;
+  error?: JsonRpcError;
+}
+/**
+ * Stream request with stream flag
+ */
+interface StreamRequest extends JsonRpcRequest {
+  stream?: true;
+}
+/**
+ * Stream handler - returns a ReadableStream
+ */
+type StreamHandler = (...params: unknown[]) => ReadableStream;
+/**
+ * Stream method registration options
+ */
+interface StreamMethodOptions extends RpcMethodOptions {
+  /** Indicates this method returns a stream */
+  stream?: true;
+}
+/**
+ * Underlying source for ReadableStream
+ */
+type UnderlyingSource<T> = {
+  start?: (controller: ReadableStreamDefaultController<T>) => void | Promise<void>;
+  pull?: (controller: ReadableStreamDefaultController<T>) => void | Promise<void>;
+  cancel?: (reason?: unknown) => void | Promise<void>;
+  type?: undefined;
+};
+/**
+ * Event handler callback type
+ */
+type EventHandler<T = unknown> = (data: T) => void;
+/**
+ * Event subscriber information
+ */
+interface EventSubscriber {
+  windowId: number;
+  eventName: string;
+}
+/**
+ * Event bus API type
+ * Maps event names to their data types
+ */
+type EventBusEvents<T extends Record<string, unknown>> = { [K in keyof T]: T[K] };
+/**
+ * Typed event bus interface
+ */
+type EventBus<T extends Record<string, unknown> = Record<string, unknown>> = {
+  /**
+       * Subscribe to an event
+       * @returns Unsubscribe function
+       */
+  on<K extends keyof T>(eventName: K, callback: EventHandler<T[K]>): () => void;
+  /**
+       * Unsubscribe from an event
+       * If no callback is provided, removes all handlers for the event
+       */
+  off<K extends keyof T>(eventName: K, callback?: EventHandler<T[K]>): void;
+  /**
+       * Subscribe to an event once (auto-unsubscribe after first call)
+       */
+  once<K extends keyof T>(eventName: K, callback: EventHandler<T[K]>): void;
+  /**
+       * Get list of subscribed event names
+       */
+  getSubscribedEvents(): string[];
+};
+/**
+ * RPC debug log entry type
+ */
+interface RpcLogEntry {
+  /** Log entry type */
+  type: "request" | "response" | "error" | "notify" | "stream" | "event";
+  /** RPC method or event name */
+  method: string;
+  /** Request parameters */
+  params?: unknown[];
+  /** Response result */
+  result?: unknown;
+  /** Error message */
+  error?: string;
+  /** Timestamp in milliseconds */
+  timestamp: number;
+  /** Duration in milliseconds (for responses/errors) */
+  duration?: number;
+  /** Request ID for correlating request/response */
+  requestId?: string | number;
+}
+/**
+ * RPC logger function type
+ */
+type RpcLogger = (entry: RpcLogEntry) => void;
+/**
+ * Debug options for RPC clients
+ */
+interface RpcDebugOptions {
+  /** Enable debug logging */
+  debug?: boolean;
+  /** Custom logger function */
+  logger?: RpcLogger;
+}
+//#endregion
+export { UnderlyingSource as S, RpcValidator as _, ExposeRpcApiOptions as a, StreamMethodOptions as b, JsonRpcRequest as c, RpcClientOptions as d, RpcDebugOptions as f, RpcMethodOptions as g, RpcLogger as h, EventSubscriber as i, JsonRpcResponse as l, RpcLogEntry as m, EventBusEvents as n, JsonRpcError as o, RpcHandler as p, EventHandler as r, JsonRpcErrorCode as s, EventBus as t, RpcApi as u, StreamChunk as v, StreamRequest as x, StreamHandler as y };
+//# sourceMappingURL=types-BnGse9DF.d.mts.map

package/dist/types-BnGse9DF.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-BnGse9DF.d.mts","names":[],"sources":["../src/types.ts"],"mappings":";;AAQA;AAUA;;AAVA;AAUA;AAUA;UApBiB,cAAA;EAAA,OAAA;EAAA,EAAA;EAAA,MAAA;EAAA,MAAA,eAIM,MAAA;AAAA;AAAA;AAMvB;AAUA;AAhBuB,UAMN,eAAA;EAAA,OAAA;EAAA,EAAA;EAAA,MAAA;EAAA,KAAA,GAIP,YAAA;AAAA;AAAA;AAMV;AASA;AAfU,UAMO,YAAA;EAAA,IAAA;EAAA,OAAA;EAAA,IAAA;AAAA;AAAA;AASjB;AAWA;AApBiB,aASL,gBAAA;EAAA,UAAA;EAAA,cAAA;EAAA,cAAA;EAAA,aAAA;EAAA,aAAA;AAAA;AAAA;AAWZ;AAMA;AAjBY,KAWA,UAAA,OAAA,MAAA,0BAAiD,OAAA;AAAA;AAM7D;AAKA;AAWA;AAtB6D,KAMjD,YAAA,IAAA,MAAA,uBAA6C,OAAA;AAAA;AAKzD;AAWA;AAhByD,UAKxC,gBAAA;EAAA;EAAA,QAAA,GAEJ,YAAA;EAAA;EAAA,WAAA;AAAA;AAAA;AASb;;;AATa,KASD,MAAA,WAAiB,MAAA,aAAA,IAAA,kCACf,CAAA,GAAI,CAAA,CAAE,CAAA,eAAA,IAAA,yBAAA,CAAA,oBAAA,MAAA,EAEA,CAAA,gBAAA,MAAA,EACA,CAAA,KAAM,OAAA,CAAQ,OAAA,CAAQ,CAAA;AAAA;;;AAAA,UAOzB,gBAAA;EAAA;EAAA,OAAA;EAAA;EAAA,OAAA;AAAA;AAAA;AAUjB;AAkBA;AA5BiB,UAUA,mBAAA;EAAA,aAAA;IAAA,iBAAA,GAAA,IAAA,UAAA,GAAA,EAE0B,MAAA;EAAA;EAAA,WAAA;IAAA,IAAA,GAAA,OAAA,aAAA,IAAA;IAAA,EAAA,GAAA,OAAA,UAAA,QAAA,GAAA,KAAA,cAAA,IAAA;IAAA,cAAA,GAAA,OAAA,UAAA,QAAA,MAAA,IAAA;EAAA;EAAA;EAAA,OAAA;EAAA;EAAA,OAAA;AAAA;AAAA;AAgB3C;AAUA;AA1B2C,UAgB1B,WAAA;EAAA,QAAA;EAAA,IAAA;EAAA,IAAA;EAAA,KAAA,GAIP,YAAA;AAAA;AAAA;AAMV;AAOA;AAbU,UAMO,aAAA,SAAsB,cAAA;EAAA,MAAA;AAAA;AAAA;AAOvC;AAKA;AAZuC,KAO3B,aAAA,OAAA,MAAA,gBAA0C,cAAA;AAAA;AAKtD;AAQA;AAbsD,UAKrC,mBAAA,SAA4B,gBAAA;EAAA;EAAA,MAAA;AAAA;AAAA;AAQ7C;;AAR6C,KAQjC,gBAAA;EAAA,KAAA,IAAA,UAAA,EACW,+BAAA,CAAgC,CAAA,aAAc,OAAA;EAAA,IAAA,IAAA,UAAA,EAC/C,+BAAA,CAAgC,CAAA,aAAc,OAAA;EAAA,MAAA,IAAA,MAAA,sBAC5B,OAAA;EAAA,IAAA;AAAA;AAAA;;AAOxC;AAPwC,KAO5B,YAAA,iBAAA,IAAA,EAAmC,CAAA;AAAA;AAK/C;AASA;AAd+C,UAK9B,eAAA;EAAA,QAAA;EAAA,SAAA;AAAA;AAAA;AASjB;;;AATiB,KASL,cAAA,WAAyB,MAAA,mCACvB,CAAA,GAAI,CAAA,CAAE,CAAA;AAAA;;AAMpB;AANoB,KAMR,QAAA,WAAmB,MAAA,oBAA0B,MAAA;EAAA;;;;EAAA,EAAA,iBAKpC,CAAA,EAAA,SAAA,EAAc,CAAA,EAAA,QAAA,EAAa,YAAA,CAAa,CAAA,CAAE,CAAA;EAAA;;;;EAAA,GAAA,iBAMzC,CAAA,EAAA,SAAA,EAAc,CAAA,EAAA,QAAA,GAAc,YAAA,CAAa,CAAA,CAAE,CAAA;EAAA;;;EAAA,IAAA,iBAK1C,CAAA,EAAA,SAAA,EAAc,CAAA,EAAA,QAAA,EAAa,YAAA,CAAa,CAAA,CAAE,CAAA;EAAA;;;EAAA,mBAAA;AAAA;AAAA;;;AAAA,UAWhD,WAAA;EAAA;EAAA,IAAA;EAAA;EAAA,MAAA;EAAA;EAAA,MAAA;EAAA;EAAA,MAAA;EAAA;EAAA,KAAA;EAAA;EAAA,SAAA;EAAA;EAAA,QAAA;EAAA;EAAA,SAAA;AAAA;AAAA;AAsBjB;AAKA;AA3BiB,KAsBL,SAAA,IAAA,KAAA,EAAoB,WAAA;AAAA;AAKhC;;AALgC,UAKf,eAAA;EAAA;EAAA,KAAA;EAAA;EAAA,MAAA,GAIN,SAAA;AAAA"}

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "electron-json-rpc",
+  "version": "1.0.0",
+  "description": "JSON-RPC implementation for Electron",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./main": {
+      "types": "./dist/main.d.ts",
+      "import": "./dist/main.js"
+    },
+    "./preload": {
+      "types": "./dist/preload.d.ts",
+      "import": "./dist/preload.js"
+    },
+    "./renderer": {
+      "types": "./dist/renderer/index.d.ts",
+      "import": "./dist/renderer/index.js"
+    },
+    "./renderer/client": {
+      "types": "./dist/renderer/client.d.ts",
+      "import": "./dist/renderer/client.js"
+    },
+    "./renderer/builder": {
+      "types": "./dist/renderer/builder.d.ts",
+      "import": "./dist/renderer/builder.js"
+    },
+    "./renderer/event": {
+      "types": "./dist/renderer/event.d.ts",
+      "import": "./dist/renderer/event.js"
+    },
+    "./stream": {
+      "types": "./dist/stream.d.ts",
+      "import": "./dist/stream.js"
+    },
+    "./event": {
+      "types": "./dist/event.d.ts",
+      "import": "./dist/event.js"
+    },
+    "./debug": {
+      "types": "./dist/debug.d.ts",
+      "import": "./dist/debug.js"
+    }
+  },
+  "scripts": {
+    "lint": "oxlint",
+    "format": "oxfmt .",
+    "format:check": "oxfmt --check .",
+    "typecheck": "tsc --noEmit",
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "prepublishOnly": "bun run typecheck && bun run lint && bun run test:run && bun run build",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:ui": "vitest --ui",
+    "release": "semantic-release"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^20.3.1",
+    "@commitlint/config-conventional": "^20.3.1",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/npm": "^12.0.0",
+    "@semantic-release/release-notes-generator": "^14.0.0",
+    "@types/bun": "latest",
+    "@types/node": "^25.0.8",
+    "@vitest/coverage-v8": "^4.0.17",
+    "@vitest/ui": "^4.0.17",
+    "electron": "^39.2.7",
+    "happy-dom": "^20.3.1",
+    "oxfmt": "^0.24.0",
+    "oxlint": "^1.39.0",
+    "semantic-release": "^25.0.2",
+    "tsdown": "^0.20.0-beta.3",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.17"
+  },
+  "peerDependencies": {
+    "electron": "*"
+  }
+}