electron-infra-kit 0.0.2

package/dist/preload/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../../src/preload/index.ts"],"sourcesContent":["import { ipcRenderer, contextBridge } from 'electron';\nimport { IpcRendererBindings, PreloadConfig } from './preload.type';\nimport { IPC_CHANNELS } from '@/core/window/constants';\nexport * from './preload.type';\n\n/**\n * IpcRendererBridge - Secure IPC Bridge for Renderer Process\n * IpcRendererBridge - 渲染进程的安全 IPC 桥接器\n */\nexport class IpcRendererBridge {\n  private bindings: IpcRendererBindings;\n  private channel: string = IPC_CHANNELS.RENDERER_TO_MAIN;\n  private syncChannel: string = IPC_CHANNELS.RENDERER_TO_MAIN_SYNC;\n\n  constructor() {\n    this.bindings = {\n      invoke: this.invoke.bind(this),\n      sendSync: this.sendSync.bind(this),\n    };\n  }\n\n  /**\n   * Configure the IPC channels\n   * 配置 IPC 频道\n   * @param config - The configuration object\n   */\n  public configure(config: PreloadConfig): void {\n    if (config.channel) {\n      this.channel = config.channel;\n    }\n    if (config.syncChannel) {\n      this.syncChannel = config.syncChannel;\n    }\n  }\n\n  /**\n   * Send an asynchronous message to the main process\n   * 发送异步消息到主进程\n   * @param name - Handler name (处理器名称)\n   * @param payload - Data payload (数据负载)\n   */\n  private invoke = async <T = unknown>(name: string, payload?: unknown): Promise<T> => {\n    const response = await ipcRenderer.invoke(this.channel, {\n      name,\n      payload,\n    });\n\n    // Automatic unwrapping of standard response format\n    // 自动解包标准响应格式\n    if (response && typeof response === 'object' && 'code' in response) {\n      if (response.code === 0) {\n        return response.data as T;\n      }\n      throw new Error(response.message || `IPC Error: ${response.code}`);\n    }\n\n    return response as T;\n  };\n\n  /**\n   * Send a synchronous message to the main process\n   * 发送同步消息到主进程\n   * @param name - Handler name (处理器名称)\n   * @param payload - Data payload (数据负载)\n   */\n  private sendSync = <T = unknown>(name: string, payload?: unknown): T => {\n    const response = ipcRenderer.sendSync(this.syncChannel, {\n      name,\n      payload,\n    });\n\n    // Automatic unwrapping of standard response format\n    // 自动解包标准响应格式\n    if (response && typeof response === 'object' && 'code' in response) {\n      if (response.code === 0) {\n        return response.data as T;\n      }\n      throw new Error(response.message || `IPC Error: ${response.code}`);\n    }\n\n    return response as T;\n  };\n\n  /**\n   * Get the bindings object\n   * 获取绑定对象\n   */\n  public getBindings(): IpcRendererBindings {\n    return this.bindings;\n  }\n\n  /**\n   * Expose API to the main world using contextBridge\n   * 使用 contextBridge 将 API 暴露给主世界\n   * @param apiKey - The key to expose on window object (default: 'ipcApi')\n   */\n  public exposeApi(apiKey: string = 'ipcApi'): void {\n    try {\n      contextBridge.exposeInMainWorld(apiKey, this.bindings);\n    } catch (error) {\n      console.error('[IpcRendererBridge] Failed to expose API:', error);\n    }\n  }\n}\n\nconst ipcRendererBridge = new IpcRendererBridge();\nexport { ipcRendererBridge };\n"],"names":[],"mappings":"yGAKA;;;AAGG;MACU,iBAAiB,CAAA;AACpB,IAAA,QAAQ;AACR,IAAA,OAAO,GAAW,YAAY,CAAC,gBAAgB;AAC/C,IAAA,WAAW,GAAW,YAAY,CAAC,qBAAqB;AAEhE,IAAA,WAAA,GAAA;QACE,IAAI,CAAC,QAAQ,GAAG;YACd,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;YAC9B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;SACnC;IACH;AAEA;;;;AAIG;AACI,IAAA,SAAS,CAAC,MAAqB,EAAA;AACpC,QAAA,IAAI,MAAM,CAAC,OAAO,EAAE;AAClB,YAAA,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO;QAC/B;AACA,QAAA,IAAI,MAAM,CAAC,WAAW,EAAE;AACtB,YAAA,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW;QACvC;IACF;AAEA;;;;;AAKG;AACK,IAAA,MAAM,GAAG,OAAoB,IAAY,EAAE,OAAiB,KAAgB;QAClF,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE;YACtD,IAAI;YACJ,OAAO;AACR,SAAA,CAAC;;;QAIF,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,MAAM,IAAI,QAAQ,EAAE;AAClE,YAAA,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE;gBACvB,OAAO,QAAQ,CAAC,IAAS;YAC3B;AACA,YAAA,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,IAAI,CAAA,WAAA,EAAc,QAAQ,CAAC,IAAI,CAAA,CAAE,CAAC;QACpE;AAEA,QAAA,OAAO,QAAa;AACtB,IAAA,CAAC;AAED;;;;;AAKG;AACK,IAAA,QAAQ,GAAG,CAAc,IAAY,EAAE,OAAiB,KAAO;QACrE,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE;YACtD,IAAI;YACJ,OAAO;AACR,SAAA,CAAC;;;QAIF,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,MAAM,IAAI,QAAQ,EAAE;AAClE,YAAA,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE;gBACvB,OAAO,QAAQ,CAAC,IAAS;YAC3B;AACA,YAAA,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,IAAI,CAAA,WAAA,EAAc,QAAQ,CAAC,IAAI,CAAA,CAAE,CAAC;QACpE;AAEA,QAAA,OAAO,QAAa;AACtB,IAAA,CAAC;AAED;;;AAGG;IACI,WAAW,GAAA;QAChB,OAAO,IAAI,CAAC,QAAQ;IACtB;AAEA;;;;AAIG;IACI,SAAS,CAAC,SAAiB,QAAQ,EAAA;AACxC,QAAA,IAAI;YACF,aAAa,CAAC,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC;QACxD;QAAE,OAAO,KAAK,EAAE;AACd,YAAA,OAAO,CAAC,KAAK,CAAC,2CAA2C,EAAE,KAAK,CAAC;QACnE;IACF;AACD;AAED,MAAM,iBAAiB,GAAG,IAAI,iBAAiB"}

package/dist/preload/preload.type.d.ts

@@ -0,0 +1,15 @@
+export interface IpcRendererBindings {
+    invoke: <T = unknown>(name: string, payload?: unknown) => Promise<T>;
+    sendSync: <T = unknown>(name: string, payload?: unknown) => T;
+    [key: string]: any;
+}
+export interface PreloadConfig {
+    channel?: string;
+    syncChannel?: string;
+    /**
+     * API Key to expose in window object
+     * 暴露在 window 对象上的 API 键名
+     * @default 'ipcApi'
+     */
+    apiKey?: string;
+}

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+export * from './core/window/window-manager.type';
+export * from './core/ipc/ipc-router.type';
+export * from './core/ipc/transport/ipc.type';
+export * from './core/message-bus/message-bus.type';
+export * from './preload/preload.type';
+export * from './infrastructure/logger/logger.type';
+export * from './internal/types/BrandedTypes';

package/dist/types.js

@@ -0,0 +1 @@
+'use strict';var messageBus_type=require('./core/message-bus/message-bus.type.js'),BrandedTypes=require('./internal/types/BrandedTypes.js');Object.defineProperty(exports,"MessageProtocolType",{enumerable:true,get:function(){return messageBus_type.MessageProtocolType}});exports.createChannelName=BrandedTypes.createChannelName;exports.createEventName=BrandedTypes.createEventName;exports.createFieldKey=BrandedTypes.createFieldKey;exports.createHandlerName=BrandedTypes.createHandlerName;exports.createWindowId=BrandedTypes.createWindowId;//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/types.mjs

@@ -0,0 +1 @@
+export{MessageProtocolType}from'./core/message-bus/message-bus.type.mjs';export{createChannelName,createEventName,createFieldKey,createHandlerName,createWindowId}from'./internal/types/BrandedTypes.mjs';//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,143 @@
+{
+  "name": "electron-infra-kit",
+  "version": "0.0.2",
+  "description": "A comprehensive infrastructure kit for Electron applications, featuring a robust window manager with state persistence, inter-window communication, and full TypeScript support.",
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "author": "chunhao",
+  "license": "MIT",
+  "keywords": [
+    "electron",
+    "window-manager",
+    "ipc",
+    "typescript",
+    "state-management",
+    "message-bus"
+  ],
+  "homepage": "https://github.com/chunhaofen/electron-infra-kit#readme",
+  "bugs": {
+    "url": "https://github.com/chunhaofen/electron-infra-kit/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chunhaofen/electron-infra-kit.git"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./core/window": {
+      "import": "./dist/core/window/index.mjs",
+      "require": "./dist/core/window/index.js",
+      "types": "./dist/core/window/index.d.ts"
+    },
+    "./core/ipc": {
+      "import": "./dist/core/ipc/index.mjs",
+      "require": "./dist/core/ipc/index.js",
+      "types": "./dist/core/ipc/index.d.ts"
+    },
+    "./core/ipc/transport": {
+      "import": "./dist/core/ipc/transport/index.mjs",
+      "require": "./dist/core/ipc/transport/index.js",
+      "types": "./dist/core/ipc/transport/index.d.ts"
+    },
+    "./core/message-bus": {
+      "import": "./dist/core/message-bus/index.mjs",
+      "require": "./dist/core/message-bus/index.js",
+      "types": "./dist/core/message-bus/index.d.ts"
+    },
+    "./preload": {
+      "import": "./dist/preload/index.mjs",
+      "require": "./dist/preload/index.js",
+      "types": "./dist/preload/index.d.ts"
+    },
+    "./infrastructure/logger": {
+      "import": "./dist/infrastructure/logger/index.mjs",
+      "require": "./dist/infrastructure/logger/index.js",
+      "types": "./dist/infrastructure/logger/index.d.ts"
+    },
+    "./infrastructure/errors": {
+      "import": "./dist/infrastructure/errors/index.mjs",
+      "require": "./dist/infrastructure/errors/index.js",
+      "types": "./dist/infrastructure/errors/index.d.ts"
+    },
+    "./infrastructure/debug": {
+      "import": "./dist/infrastructure/debug/index.mjs",
+      "require": "./dist/infrastructure/debug/index.js",
+      "types": "./dist/infrastructure/debug/index.d.ts"
+    },
+    "./types": {
+      "import": "./dist/types.mjs",
+      "require": "./dist/types.js",
+      "types": "./dist/types.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "electron": ">=22.0.0"
+  },
+  "dependencies": {
+    "electron-log": "^5.4.3",
+    "tiny-typed-emitter": "^2.1.0",
+    "uuid": "^9.0.0",
+    "zod": "^4.1.13"
+  },
+  "devDependencies": {
+    "@rollup/plugin-alias": "^6.0.0",
+    "@rollup/plugin-commonjs": "^29.0.0",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@types/node": "^22.0.0",
+    "@types/uuid": "^9.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.13.2",
+    "@typescript-eslint/parser": "^6.13.2",
+    "electron": "^25.0.0",
+    "eslint": "^8.55.0",
+    "eslint-config-prettier": "^9.1.0",
+    "ghooks": "^2.0.4",
+    "prettier": "^3.1.0",
+    "rollup": "^4.53.3",
+    "rollup-plugin-dts": "^6.3.0",
+    "standard-version": "^9.5.0",
+    "tslib": "^2.8.1",
+    "typedoc": "^0.28.15",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typescript": "^5.0.0",
+    "validate-commit-msg": "^2.14.0",
+    "vite": "^4.0.0",
+    "vite-plugin-dts": "^3.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "config": {
+    "ghooks": {
+      "commit-msg": "validate-commit-msg",
+      "pre-commit": "pnpm run lint && pnpm run format"
+    }
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "dev": "rollup -c -w",
+    "build:vite": "vite build",
+    "dev:vite": "vite build --watch",
+    "docs": "typedoc",
+    "lint": "eslint src --ext .ts --fix",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\"",
+    "type-check": "tsc --noEmit",
+    "release": "standard-version",
+    "release:patch": "standard-version --release-as patch",
+    "release:minor": "standard-version --release-as minor",
+    "release:major": "standard-version --release-as major",
+    "release:dry": "standard-version --dry-run"
+  }
+}