@rg-dev/electron-helpers 1.0.3 → 1.0.5

package/dist/TypedIpc.d.cjs

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;

package/dist/TypedIpc.d.d.cts

@@ -40,7 +40,7 @@ interface TypedIpcMain<IpcEvents extends InputMap, IpcCommands extends InputMap
 
 
 
-
+ //@ts-ignore
 interface TypedIpcRenderer<IpcEvents extends InputMap, IpcCommands extends InputMap
 > extends IpcRenderer {
 	on<K extends keyof IpcEvents>(
@@ -64,6 +64,13 @@ interface TypedIpcRenderer<IpcEvents extends InputMap, IpcCommands extends Input
 	...args: Parameters<IpcEvents[K]>
 	) => void
 	): this;
+    off<K extends keyof IpcEvents>(
+	channel: K,
+	listener: (
+	event: IpcRendererEvent,
+	...args: Parameters<IpcEvents[K]>
+	) => void
+	): this;
 	removeAllListeners<K extends keyof IpcEvents>(channel: K): this;
 	off<K extends keyof IpcEvents>(channel: K): this;
 	send<K extends keyof IpcEvents>(

package/dist/TypedIpc.d.d.ts

@@ -40,7 +40,7 @@ interface TypedIpcMain<IpcEvents extends InputMap, IpcCommands extends InputMap
 
 
 
-
+ //@ts-ignore
 interface TypedIpcRenderer<IpcEvents extends InputMap, IpcCommands extends InputMap
 > extends IpcRenderer {
 	on<K extends keyof IpcEvents>(
@@ -64,6 +64,13 @@ interface TypedIpcRenderer<IpcEvents extends InputMap, IpcCommands extends Input
 	...args: Parameters<IpcEvents[K]>
 	) => void
 	): this;
+    off<K extends keyof IpcEvents>(
+	channel: K,
+	listener: (
+	event: IpcRendererEvent,
+	...args: Parameters<IpcEvents[K]>
+	) => void
+	): this;
 	removeAllListeners<K extends keyof IpcEvents>(channel: K): this;
 	off<K extends keyof IpcEvents>(channel: K): this;
 	send<K extends keyof IpcEvents>(

package/dist/backend.cjs

@@ -1,6 +1,9 @@
+"use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -14,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/backend.ts
@@ -29,6 +40,10 @@ var import_electron = require("electron");
 var __electron_helpers = "1";
 
 // src/backend.ts
+var import_path = __toESM(require("path"), 1);
+var import_fs = __toESM(require("fs"), 1);
+var import_node_env = require("@rg-dev/stdlib/lib/node-env");
+var import_electron2 = __toESM(require("electron"), 1);
 var electronHelpers = class {
   static isRunningInElectron() {
     return process.versions["electron"] != void 0;
@@ -53,6 +68,48 @@ var electronHelpers = class {
       throw new Error("no path");
     }
   }
+  static createTempSession() {
+    const sessionName = String(process.pid);
+    const session2 = import_electron2.default.session.fromPartition(sessionName);
+    return { sessionName, session: session2 };
+  }
+  //win.loadURL('file://')
+  static async intercept(opts) {
+    await (0, import_node_env.checkIfDirExistsOrThrow)(opts.filesDir);
+    await (0, import_node_env.checkIfFileExistsOrThrow)(import_path.default.join(opts.filesDir, "index.html"));
+    const filesDir = import_path.default.resolve(opts.filesDir);
+    const indexFile = import_path.default.join(filesDir, "index.html");
+    const proto = opts.session ? opts.session.protocol : import_electron.protocol;
+    if (proto.isProtocolIntercepted("file")) {
+      throw new Error("already intercepted file protocol");
+    }
+    proto.interceptFileProtocol(
+      "file",
+      (request, callback) => {
+        try {
+          const url = new URL(request.url);
+          let resource = decodeURIComponent(url.pathname);
+          resource = resource.replace(/^\/+/, "");
+          const file = import_path.default.resolve(filesDir, resource);
+          const relative = import_path.default.relative(filesDir, file);
+          if (relative.startsWith(".." + import_path.default.sep) || import_path.default.isAbsolute(relative)) {
+            console.warn(`Blocked path traversal: ${request.url}`);
+            callback({ path: indexFile });
+            return;
+          }
+          if (import_fs.default.existsSync(file) && import_fs.default.statSync(file).isFile()) {
+            callback({ path: file });
+            return;
+          }
+          console.log("intercpet", `file not found ${file}`);
+          callback({ path: indexFile });
+        } catch (err) {
+          console.error("Failed to intercept file:", request.url, err);
+          callback({ path: indexFile });
+        }
+      }
+    );
+  }
   static async electronFilePicker() {
     if (!this.isRunningInElectron()) {
       throw new Error("only work in electron");

package/dist/backend.d.cts

@@ -3,6 +3,14 @@ export { __electron_helpers } from './index.cjs';
 declare class electronHelpers {
     static isRunningInElectron(): boolean;
     static electronSaveFileDialog(type: string): Promise<string>;
+    static createTempSession(): {
+        sessionName: string;
+        session: Electron.Session;
+    };
+    static intercept(opts: {
+        filesDir: string;
+        session?: Electron.Session;
+    }): Promise<void>;
     static electronFilePicker(): Promise<string>;
 }
 

package/dist/backend.d.ts

@@ -3,6 +3,14 @@ export { __electron_helpers } from './index.js';
 declare class electronHelpers {
     static isRunningInElectron(): boolean;
     static electronSaveFileDialog(type: string): Promise<string>;
+    static createTempSession(): {
+        sessionName: string;
+        session: Electron.Session;
+    };
+    static intercept(opts: {
+        filesDir: string;
+        session?: Electron.Session;
+    }): Promise<void>;
     static electronFilePicker(): Promise<string>;
 }
 

package/dist/backend.js

@@ -1,10 +1,14 @@
 // src/backend.ts
-import { dialog } from "electron";
+import { dialog, protocol } from "electron";
 
 // src/index.ts
 var __electron_helpers = "1";
 
 // src/backend.ts
+import path from "path";
+import fs from "fs";
+import { checkIfDirExistsOrThrow, checkIfFileExistsOrThrow } from "@rg-dev/stdlib/lib/node-env";
+import electron from "electron";
 var electronHelpers = class {
   static isRunningInElectron() {
     return process.versions["electron"] != void 0;
@@ -29,6 +33,48 @@ var electronHelpers = class {
       throw new Error("no path");
     }
   }
+  static createTempSession() {
+    const sessionName = String(process.pid);
+    const session2 = electron.session.fromPartition(sessionName);
+    return { sessionName, session: session2 };
+  }
+  //win.loadURL('file://')
+  static async intercept(opts) {
+    await checkIfDirExistsOrThrow(opts.filesDir);
+    await checkIfFileExistsOrThrow(path.join(opts.filesDir, "index.html"));
+    const filesDir = path.resolve(opts.filesDir);
+    const indexFile = path.join(filesDir, "index.html");
+    const proto = opts.session ? opts.session.protocol : protocol;
+    if (proto.isProtocolIntercepted("file")) {
+      throw new Error("already intercepted file protocol");
+    }
+    proto.interceptFileProtocol(
+      "file",
+      (request, callback) => {
+        try {
+          const url = new URL(request.url);
+          let resource = decodeURIComponent(url.pathname);
+          resource = resource.replace(/^\/+/, "");
+          const file = path.resolve(filesDir, resource);
+          const relative = path.relative(filesDir, file);
+          if (relative.startsWith(".." + path.sep) || path.isAbsolute(relative)) {
+            console.warn(`Blocked path traversal: ${request.url}`);
+            callback({ path: indexFile });
+            return;
+          }
+          if (fs.existsSync(file) && fs.statSync(file).isFile()) {
+            callback({ path: file });
+            return;
+          }
+          console.log("intercpet", `file not found ${file}`);
+          callback({ path: indexFile });
+        } catch (err) {
+          console.error("Failed to intercept file:", request.url, err);
+          callback({ path: indexFile });
+        }
+      }
+    );
+  }
   static async electronFilePicker() {
     if (!this.isRunningInElectron()) {
       throw new Error("only work in electron");

package/dist/client.cjs

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
@@ -36,6 +37,9 @@ var IpcClient = class _IpcClient {
   ipc;
   static create(electronIpc, _shape) {
     const client = new _IpcClient();
+    if (!electronIpc) {
+      console.warn("electron ipc object undefined");
+    }
     client.ipc = electronIpc;
     return client;
   }
@@ -43,6 +47,10 @@ var IpcClient = class _IpcClient {
     return new Promise(
       async (resolve, reject) => {
         try {
+          if (!this.ipc) {
+            resolve(void 0);
+            return;
+          }
           const res = await this.ipc.invoke(route, ...args);
           if (!res) {
             resolve(void 0);
@@ -61,11 +69,17 @@ var IpcClient = class _IpcClient {
     );
   }
   on(channel, listener) {
+    if (!this.ipc) {
+      return this;
+    }
     this.ipc.on(channel, (_event, ...args) => listener(...args));
     return this;
   }
   off(channel, listener) {
-    this.ipc.removeListener(channel, (_event, ...args) => listener(...args));
+    if (!this.ipc) {
+      return this;
+    }
+    this.ipc.off(channel, (_event, ...args) => listener(...args));
     return this;
   }
 };

package/dist/client.js

@@ -8,6 +8,9 @@ var IpcClient = class _IpcClient {
   ipc;
   static create(electronIpc, _shape) {
     const client = new _IpcClient();
+    if (!electronIpc) {
+      console.warn("electron ipc object undefined");
+    }
     client.ipc = electronIpc;
     return client;
   }
@@ -15,6 +18,10 @@ var IpcClient = class _IpcClient {
     return new Promise(
       async (resolve, reject) => {
         try {
+          if (!this.ipc) {
+            resolve(void 0);
+            return;
+          }
           const res = await this.ipc.invoke(route, ...args);
           if (!res) {
             resolve(void 0);
@@ -33,11 +40,17 @@ var IpcClient = class _IpcClient {
     );
   }
   on(channel, listener) {
+    if (!this.ipc) {
+      return this;
+    }
     this.ipc.on(channel, (_event, ...args) => listener(...args));
     return this;
   }
   off(channel, listener) {
-    this.ipc.removeListener(channel, (_event, ...args) => listener(...args));
+    if (!this.ipc) {
+      return this;
+    }
+    this.ipc.off(channel, (_event, ...args) => listener(...args));
     return this;
   }
 };

package/dist/index.cjs

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rg-dev/electron-helpers",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "",
   "scripts": {
     "test": "tsup && node dist/index.cjs",
@@ -12,13 +12,13 @@
   "files": [
     "dist"
   ],
-   "publishConfig": {
-   "access": "public"
+  "publishConfig": {
+    "access": "public"
   },
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "type": "module",
-    "typesVersions": {
+  "typesVersions": {
     "*": {
       "dist/backend": [
         "dist/backend.d.ts"
@@ -29,17 +29,17 @@
     }
   },
   "exports": {
-   ".": {
-     "import": "./dist/index.js",
-     "require": "./dist/index.cjs"
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     },
-     "./dist/client": {
-    "import": "./dist/client.js",
-    "require": "./dist/client.cjs"
+    "./dist/client": {
+      "import": "./dist/client.js",
+      "require": "./dist/client.cjs"
     },
-  "./dist/backend": {
-   "import": "./dist/backend.js",
-   "require": "./dist/backend.cjs"
+    "./dist/backend": {
+      "import": "./dist/backend.js",
+      "require": "./dist/backend.cjs"
     }
   },
   "devDependencies": {
@@ -49,5 +49,8 @@
     "execa": "^8.0.1",
     "tsup": "^8.0.2",
     "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "@rg-dev/stdlib": "^1.0.80"
   }
 }