@witchcraft/nuxt-electron 0.0.9 → 0.1.0

package/dist/runtime/electron/promisifyApi.d.ts

@@ -0,0 +1,40 @@
+import type { IpcRenderer } from "electron";
+/**
+ * Promisify an electron api and make it type safe so it can be awaited client side. Note that promisifyReply will throw if it can't find a window.
+ *
+ * ```ts[type.st]
+ * export type ElectronApi = {
+ * 	api: {
+ * 		someApi: (apiParam: string, apiParam2: number) => Promise<void>
+ * 	}
+ * }
+ * ```
+ * ```ts [preload.ts]
+ * contextBridge.exposeInMainWorld("electron", {
+ * 	api: {
+ * 		...promisifyApi<"someApi", ElectronApi["api"]["someApi"]>(ipcRenderer, "someApi", MESSAGE.UNIQUE_KEY),
+ * 	},
+ * })
+ * ```
+ *
+ * ```ts [main.ts]
+ * import { promisifyReply } from "@witchcraft/nuxt-electron/runtime/electron"
+ * promisifyReply<
+ * 	ElectronApi["api"]["someApi"]
+ * >(ipcRenderer, MESSAGE.UNIQUE_KEY, (win, apiParam, apiParam2) => {
+ * 	// this doesn't have to be async, though on the client side,
+ * 	// it will always be async
+ * 	return electronSideOfApi(apiParam, apiParam2)
+ * })
+ * ```
+ *
+ * ```ts [renderer.ts]
+ * const result = await electron.api.someApi(apiParam, apiParam2)
+ * ```
+ *
+ * By default, calls will timeout and reject after 10 seconds. This can be changed by changing the timeout option.
+ */
+export declare function promisifyApi<TKey extends string, TFunction extends (...args: any) => Promise<any>, TArgs extends Parameters<TFunction> = Parameters<TFunction>>(ipcRenderer: IpcRenderer, key: TKey, messageKey: string, modifyArgs?: (args: TArgs) => any, { debug, timeout }?: {
+    debug?: boolean;
+    timeout?: number;
+}): Record<TKey, TFunction>;

package/dist/runtime/electron/promisifyApi.js

@@ -0,0 +1,41 @@
+const promiseResolveMap = /* @__PURE__ */ new Map();
+export function promisifyApi(ipcRenderer, key, messageKey, modifyArgs, { debug, timeout } = { debug: true, timeout: 1e4 }) {
+  return {
+    [key]: async (...args) => new Promise((resolve, reject) => {
+      const promiseId = crypto.randomUUID();
+      promiseResolveMap.set(promiseId, { resolve, reject });
+      if (modifyArgs) {
+        args = modifyArgs(args);
+      }
+      if (debug) {
+        console.log("promisifyApi:sent", messageKey, promiseId, args);
+      }
+      const timer = setTimeout(() => {
+        const resolver = promiseResolveMap.get(promiseId);
+        if (resolver) {
+          promiseResolveMap.delete(promiseId);
+          ipcRenderer.off(messageKey, listener);
+          resolver.reject(new Error(`promisifyApi: Timeout for ${messageKey}`));
+        }
+      }, timeout);
+      function listener(_event, resPromiseId, res, info) {
+        if (debug) {
+          console.log("promiseApi:received", resPromiseId, res);
+        }
+        const resolver = promiseResolveMap.get(resPromiseId);
+        if (resolver) {
+          clearTimeout(timer);
+          promiseResolveMap.delete(resPromiseId);
+          ipcRenderer.off(messageKey, listener);
+          if (info?.isError) {
+            resolver.reject(res);
+          } else {
+            resolver.resolve(res);
+          }
+        }
+      }
+      ipcRenderer.on(messageKey, listener);
+      ipcRenderer.send(messageKey, promiseId, ...args);
+    })
+  };
+}

package/dist/runtime/electron/promisifyReply.d.ts

@@ -0,0 +1,8 @@
+import { type BrowserWindow } from "electron";
+/** See {@link promisifyApi} for more info. */
+export declare function promisifyReply<TFunction extends ((...args: any[]) => any), TKey extends string = string, TArgs extends Parameters<TFunction> = Parameters<TFunction>, TReturn extends ReturnType<TFunction> = ReturnType<TFunction>>(key: TKey, cb: (win?: BrowserWindow, ...args: TArgs) => Promise<TReturn> | TReturn, 
+/** See {@link getEventWindow}. */
+{ defaultToFocused, debug }?: {
+    defaultToFocused?: boolean;
+    debug?: boolean;
+}): void;

package/dist/runtime/electron/promisifyReply.js

@@ -0,0 +1,29 @@
+import { ipcMain } from "electron";
+import { getEventWindow } from "./getEventWindow.js";
+export function promisifyReply(key, cb, {
+  defaultToFocused = true,
+  debug = false
+} = {}) {
+  ipcMain.on(key, (e, promiseId, ...args) => {
+    const win = getEventWindow(e, { defaultToFocused });
+    if (!win) {
+      const err = new Error("No window to send reply to.");
+      console.error(err, { key, promiseId, args });
+      throw err;
+    }
+    if (debug) {
+      console.log({ key, promiseId, args });
+    }
+    const res = cb(win, ...args);
+    if (res instanceof Promise) {
+      res.then((innerRes) => {
+        win.webContents.send(key, promiseId, innerRes);
+      }).catch((err) => {
+        console.error(err, { key, promiseId, args });
+        win.webContents.send(key, promiseId, err, { isError: true });
+      });
+    } else {
+      win.webContents.send(key, promiseId, res);
+    }
+  });
+}

package/dist/runtime/electron/registerDevtoolsShortcuts.d.ts

@@ -0,0 +1,2 @@
+/** Registers F12 and Ctrl+Shift+I as shortcuts to open the devtools. */
+export declare function registerDevtoolsShortcuts(win: Electron.BrowserWindow): void;

package/dist/runtime/electron/registerDevtoolsShortcuts.js

@@ -0,0 +1,10 @@
+export function registerDevtoolsShortcuts(win) {
+  win.webContents.on("before-input-event", (event, input) => {
+    if (input.type === "keyDown") {
+      if (input.shift && input.control && input.key.toLowerCase() === "i" || input.key === "F12") {
+        win.webContents.openDevTools();
+        event.preventDefault();
+      }
+    }
+  });
+}

package/dist/runtime/electron/static.d.ts

@@ -0,0 +1,12 @@
+import type { PublicRuntimeConfig } from "nuxt/schema";
+/**
+ * Group of the module's vite's injected variables.
+ */
+export declare const STATIC: {
+    ELECTRON_ROUTE: string;
+    ELECTRON_PROD_URL: string;
+    ELECTRON_NUXT_DIR: string;
+    ELECTRON_NUXT_PUBLIC_DIR: string;
+    ELECTRON_BUILD_DIR: string;
+    ELECTRON_RUNTIME_CONFIG: PublicRuntimeConfig;
+};

package/dist/runtime/electron/static.js

@@ -0,0 +1,8 @@
+export const STATIC = {
+  ELECTRON_ROUTE: process.env.ELECTRON_ROUTE,
+  ELECTRON_PROD_URL: process.env.ELECTRON_PROD_URL,
+  ELECTRON_NUXT_DIR: process.env.ELECTRON_NUXT_DIR,
+  ELECTRON_NUXT_PUBLIC_DIR: process.env.ELECTRON_NUXT_PUBLIC_DIR,
+  ELECTRON_BUILD_DIR: process.env.ELECTRON_BUILD_DIR,
+  ELECTRON_RUNTIME_CONFIG: process.env.ELECTRON_RUNTIME_CONFIG ? JSON.parse(process.env.ELECTRON_RUNTIME_CONFIG) : void 0
+};

package/dist/runtime/electron/types.d.ts

@@ -0,0 +1 @@
+export type WindowControlsApi = (action: "close" | "minimize" | "toggleMaximize" | "togglePin") => Promise<void>;

package/dist/runtime/electron/useDevDataDir.d.ts

@@ -0,0 +1 @@
+export declare function useDevDataDir(): string | undefined;

package/dist/runtime/electron/useDevDataDir.js

@@ -0,0 +1,8 @@
+export function useDevDataDir() {
+  if (import.meta.dev) {
+    const index = process.argv.findIndex((arg) => arg.startsWith("--dev-user-data-dir"));
+    if (index === -1) return void 0;
+    return process.argv[index + 1];
+  }
+  return void 0;
+}

package/dist/runtime/electron/useNuxtRuntimeConfig.d.ts

@@ -0,0 +1,2 @@
+import type { PublicRuntimeConfig } from "nuxt/schema";
+export declare function useNuxtRuntimeConfig(): PublicRuntimeConfig;

package/dist/runtime/electron/useNuxtRuntimeConfig.js

@@ -0,0 +1,4 @@
+import { STATIC } from "./static.js";
+export function useNuxtRuntimeConfig() {
+  return STATIC.ELECTRON_RUNTIME_CONFIG;
+}

package/dist/runtime/utils/isElectron.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This requires electron's preload script set the `electron` property on the window:
+ *
+ * ```ts
+ * // preload.ts
+ * contextBridge.exposeInMainWorld("electron", { })
+ * ```
+ */
+export declare function isElectron(): boolean;

package/dist/runtime/utils/isElectron.js

@@ -0,0 +1,3 @@
+export function isElectron() {
+  return typeof window !== "undefined" && "electron" in window && typeof window.electron !== "undefined";
+}

package/dist/types.d.mts

@@ -1,13 +1,3 @@
-import type { ModuleHooks, ModuleRuntimeHooks, ModuleRuntimeConfig, ModulePublicRuntimeConfig } from './module.mjs'
+export { default } from './module.mjs'
 
-declare module '#app' {
-  interface RuntimeNuxtHooks extends ModuleRuntimeHooks {}
-}
-
-declare module '@nuxt/schema' {
-  interface NuxtHooks extends ModuleHooks {}
-  interface RuntimeConfig extends ModuleRuntimeConfig {}
-  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
-}
-
-export * from "./module.mjs"
+export { type ModuleOptions } from './module.mjs'

package/genDevDesktop.js

@@ -3,6 +3,11 @@ import JSON5 from "json5"
 import fs from "node:fs/promises"
 import path from "node:path"
 
+if (process.env.CI) {
+	console.log("Skipping desktop file generation in CI.")
+	process.exit(0)
+}
+
 if (["darwin", "linux"].includes(process.platform)) {
 	// eslint-disable-next-line no-console
 	console.log("Generating dev desktop file.")

package/package.json

@@ -1,93 +1,92 @@
 {
-	"name": "@witchcraft/nuxt-electron",
-	"version": "0.0.9",
-	"description": "Nuxt module for working with electron.",
-	"repository": "witchcraftjs/nuxt-electron",
-	"license": "MIT",
-	"type": "module",
-	"sideEffects": false,
-	"exports": {
-		".": {
-			"types": "./dist/types.d.mts",
-			"import": "./dist/module.mjs"
-		},
-		"./electron": {
-			"types": "./dist/runtime/electron/index.d.ts",
-			"import": "./dist/runtime/electron/index.js"
-		},
-		"./genDevDesktop": {
-			"import": "./genDevDesktop.js"
-		}
-	},
-	"files": [
-		"src",
-		"dist",
-		"genDevDesktop.js"
-	],
-	"scripts": {
-		"prepare": "husky && pnpm dev:prepare",
-		"build": "nuxt-module-build prepare && nuxt-module-build build && nuxi build playground",
-		"build:only": "nuxt-module-build build",
-		"dev": "nuxi dev playground",
-		"dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
-		"lint": "eslint \"{src,test,playground/app}/**/*.{ts,vue}\" \"*.{js,cjs,mjs,ts}\"",
-		"lint:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
-		"test": "vitest run",
-		"test:watch": "vitest watch"
-	},
-	"dependencies": {
-		"@alanscodelog/utils": "catalog:",
-		"@nuxt/kit": "catalog:",
-		"@witchcraft/nuxt-utils": "catalog:",
-		"@witchcraft/ui": "catalog:",
-		"defu": "catalog:",
-		"es-toolkit": "catalog:",
-		"vite-plugin-electron": "catalog:",
-		"vite-plugin-externalize-deps": "catalog:"
-	},
-	"peerDependencies": {
-		"@witchcraft/ui": "catalog:",
-		"unplugin-icons": "catalog:"
-	},
-	"peerDependenciesMeta": {
-		"unplugin-icons": {
-			"optional": true
-		},
-		"@witchcraft/ui": {
-			"optional": true
-		}
-	},
-	"devDependencies": {
-		"@alanscodelog/eslint-config": "catalog:",
-		"@alanscodelog/semantic-release-config": "catalog:",
-		"@alanscodelog/tsconfigs": "catalog:",
-		"@nuxt/eslint-config": "catalog:",
-		"@nuxt/module-builder": "catalog:",
-		"@nuxt/schema": "catalog:",
-		"@nuxt/test-utils": "catalog:",
-		"@types/node": "latest",
-		"changelogen": "catalog:",
-		"electron": "^38.0.0",
-		"eslint": "catalog:",
-		"husky": "catalog:",
-		"json5": "catalog:",
-		"nuxt": "catalog:",
-		"typescript": "catalog:",
-		"unplugin-icons": "catalog:",
-		"vitest": "catalog:",
-		"vue-tsc": "catalog:"
-	},
-	"release": {
-		"extends": [
-			"@alanscodelog/semantic-release-config"
-		]
-	},
-	"commitlint": {
-		"extends": [
-			"@alanscodelog"
-		]
-	},
-	"publishConfig": {
-		"access": "public"
-	}
-}
+  "name": "@witchcraft/nuxt-electron",
+  "version": "0.1.0",
+  "description": "Nuxt module for working with electron.",
+  "repository": "witchcraftjs/nuxt-electron",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    },
+    "./electron": {
+      "types": "./dist/runtime/electron/index.d.ts",
+      "import": "./dist/runtime/electron/index.js"
+    },
+    "./genDevDesktop": {
+      "import": "./genDevDesktop.js"
+    }
+  },
+  "files": [
+    "src",
+    "dist",
+    "genDevDesktop.js"
+  ],
+  "dependencies": {
+    "@alanscodelog/utils": "^6.0.2",
+    "@nuxt/kit": "^4.0.3",
+    "@witchcraft/nuxt-utils": "^0.3.6",
+    "@witchcraft/ui": "^0.3.7",
+    "defu": "^6.1.4",
+    "es-toolkit": "^1.39.10",
+    "vite-plugin-electron": "^0.29.0",
+    "vite-plugin-externalize-deps": "^0.9.0"
+  },
+  "peerDependencies": {
+    "@witchcraft/ui": "^0.3.7",
+    "unplugin-icons": "^22.3.0"
+  },
+  "peerDependenciesMeta": {
+    "unplugin-icons": {
+      "optional": true
+    },
+    "@witchcraft/ui": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@alanscodelog/eslint-config": "^6.3.1",
+    "@alanscodelog/semantic-release-config": "^6.0.0",
+    "@alanscodelog/tsconfigs": "^6.2.0",
+    "@nuxt/eslint-config": "^1.9.0",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "^4.0.3",
+    "@nuxt/test-utils": "^3.19.2",
+    "@types/node": "latest",
+    "changelogen": "^0.6.2",
+    "electron": "^38.0.0",
+    "eslint": "^9.34.0",
+    "husky": "^9.1.7",
+    "json5": "^2.2.3",
+    "nuxt": "^4.0.3",
+    "typescript": "^5.8.3",
+    "unplugin-icons": "^22.3.0",
+    "vitest": "^3.2.4",
+    "vue-tsc": "^3.0.6"
+  },
+  "release": {
+    "extends": [
+      "@alanscodelog/semantic-release-config"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@alanscodelog"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "nuxt-module-build prepare && nuxt-module-build build && nuxi build playground",
+    "build:only": "nuxt-module-build build",
+    "dev": "nuxi dev playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "lint": "eslint \"{src,test,playground/app}/**/*.{ts,vue}\" \"*.{js,cjs,mjs,ts}\"",
+    "lint:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest watch"
+  }
+}

package/dist/module.d.cts

@@ -1,2 +0,0 @@
-export * from "/home/runner/work/nuxt-electron/nuxt-electron/src/module.js";
-export { default } from "/home/runner/work/nuxt-electron/nuxt-electron/src/module.js";