@vueuse/electron 12.8.1 → 13.0.0-beta.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vueuse/electron",
   "type": "module",
-  "version": "12.8.1",
+  "version": "13.0.0-beta.1",
   "description": "Electron renderer process modules for VueUse",
   "author": "Archer Gu<https://github.com/ArcherGu>",
   "license": "MIT",
@@ -24,20 +24,14 @@
   ],
   "sideEffects": false,
   "exports": {
-    ".": {
-      "import": "./index.mjs",
-      "require": "./index.cjs"
-    },
+    ".": "./index.mjs",
     "./*": "./*"
   },
-  "main": "./index.cjs",
+  "main": "./index.mjs",
   "module": "./index.mjs",
-  "types": "./index.d.ts",
+  "types": "./index.d.mts",
   "files": [
-    "*.cjs",
-    "*.d.cts",
     "*.d.mts",
-    "*.d.ts",
     "*.js",
     "*.mjs"
   ],
@@ -46,7 +40,7 @@
   },
   "dependencies": {
     "vue": "^3.5.13",
-    "@vueuse/shared": "12.8.1"
+    "@vueuse/shared": "13.0.0-beta.1"
   },
   "devDependencies": {
     "electron": "^13.1.0"

package/index.cjs

@@ -1,125 +0,0 @@
-'use strict';
-
-var vue = require('vue');
-var shared = require('@vueuse/shared');
-
-function useIpcRendererInvoke(...args) {
-  let ipcRenderer;
-  let channel;
-  let invokeArgs;
-  if (typeof args[0] === "string") {
-    [channel, ...invokeArgs] = args;
-    ipcRenderer = window.require ? window.require("electron").ipcRenderer : void 0;
-  } else {
-    [ipcRenderer, channel, ...invokeArgs] = args;
-  }
-  if (!ipcRenderer)
-    throw new Error("please provide IpcRenderer module or enable nodeIntegration");
-  const result = vue.shallowRef(null);
-  ipcRenderer.invoke(channel, ...invokeArgs).then((response) => {
-    result.value = response;
-  });
-  return result;
-}
-
-function useIpcRendererOn(...args) {
-  let ipcRenderer;
-  let channel;
-  let listener;
-  if (typeof args[0] === "string") {
-    [channel, listener] = args;
-    ipcRenderer = window.require ? window.require("electron").ipcRenderer : void 0;
-  } else {
-    [ipcRenderer, channel, listener] = args;
-  }
-  if (!ipcRenderer)
-    throw new Error("please provide IpcRenderer module or enable nodeIntegration");
-  shared.tryOnScopeDispose(() => {
-    ipcRenderer.removeListener(channel, listener);
-  });
-  return ipcRenderer.on(channel, listener);
-}
-
-function setSendSync(ipcRenderer) {
-  return (channel, ...args) => {
-    const result = vue.shallowRef(null);
-    result.value = ipcRenderer.sendSync(channel, ...args);
-    return result;
-  };
-}
-function useIpcRenderer(ipcRenderer) {
-  if (!ipcRenderer)
-    ipcRenderer = window == null ? void 0 : window.require("electron").ipcRenderer;
-  if (!ipcRenderer)
-    throw new Error("provide IpcRenderer module or enable nodeIntegration");
-  return {
-    on: (channel, listener) => useIpcRendererOn(channel, listener),
-    once: ipcRenderer.once.bind(ipcRenderer),
-    removeListener: ipcRenderer.removeListener.bind(ipcRenderer),
-    removeAllListeners: ipcRenderer.removeAllListeners.bind(ipcRenderer),
-    send: ipcRenderer.send,
-    invoke: (channel, ...args) => useIpcRendererInvoke(ipcRenderer, channel, ...args),
-    sendSync: setSendSync(ipcRenderer),
-    postMessage: ipcRenderer.postMessage,
-    sendTo: ipcRenderer.sendTo,
-    sendToHost: ipcRenderer.sendToHost
-  };
-}
-
-function useZoomFactor(...args) {
-  let webFrame;
-  let newFactor = null;
-  if (args.length === 0 || vue.isRef(args[0]) && typeof args[0].value === "number" || typeof args[0] === "number") {
-    webFrame = window.require ? window.require("electron").webFrame : void 0;
-    newFactor = args.length > 0 ? vue.ref(args[0]) : null;
-  } else {
-    webFrame = args[0];
-    newFactor = args.length > 1 ? vue.ref(args[1]) : null;
-  }
-  if (!webFrame)
-    throw new Error("provide WebFrame module or enable nodeIntegration");
-  if (newFactor && newFactor.value === 0)
-    throw new Error("the factor must be greater than 0.0.");
-  const factor = vue.ref(newFactor != null ? newFactor : webFrame.getZoomFactor());
-  vue.watch(
-    factor,
-    (f, o) => {
-      if (typeof f === "number" && f === 0)
-        throw new Error("the factor must be greater than 0.0.");
-      if (typeof f === "number" && f !== o)
-        webFrame == null ? void 0 : webFrame.setZoomFactor(f);
-    },
-    { immediate: true }
-  );
-  return factor;
-}
-
-function useZoomLevel(...args) {
-  let webFrame;
-  let newLevel = null;
-  if (args.length === 0 || vue.isRef(args[0]) && typeof args[0].value === "number" || typeof args[0] === "number") {
-    webFrame = window.require ? window.require("electron").webFrame : void 0;
-    newLevel = args.length > 0 ? vue.ref(args[0]) : null;
-  } else {
-    webFrame = args[0];
-    newLevel = args.length > 1 ? vue.ref(args[1]) : null;
-  }
-  if (!webFrame)
-    throw new Error("provide WebFrame module or enable nodeIntegration");
-  const level = vue.ref(newLevel != null ? newLevel : webFrame.getZoomLevel());
-  vue.watch(
-    level,
-    (f, o) => {
-      if (typeof f === "number" && f !== o)
-        webFrame == null ? void 0 : webFrame.setZoomLevel(f);
-    },
-    { immediate: true }
-  );
-  return level;
-}
-
-exports.useIpcRenderer = useIpcRenderer;
-exports.useIpcRendererInvoke = useIpcRendererInvoke;
-exports.useIpcRendererOn = useIpcRendererOn;
-exports.useZoomFactor = useZoomFactor;
-exports.useZoomLevel = useZoomLevel;

package/index.d.cts

@@ -1,139 +0,0 @@
-import { IpcRendererEvent, IpcRenderer, WebFrame } from 'electron';
-import { ShallowRef, MaybeRef, Ref } from 'vue';
-
-type IpcRendererListener = (event: IpcRendererEvent, ...args: any[]) => void;
-
-/**
- * Result from useIpcRenderer
- *
- * @see https://www.electronjs.org/docs/api/ipc-renderer
- */
-interface UseIpcRendererReturn {
-    /**
-     * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
-     * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
-     */
-    on: (channel: string, listener: IpcRendererListener) => IpcRenderer;
-    /**
-     * Adds a one time listener function for the event. This listener is invoked only the next time a message is sent to channel, after which it is removed.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereroncechannel-listener
-     */
-    once: (channel: string, listener: (event: IpcRendererEvent, ...args: any[]) => void) => IpcRenderer;
-    /**
-     * Removes the specified listener from the listener array for the specified channel.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener
-     */
-    removeListener: (channel: string, listener: (...args: any[]) => void) => IpcRenderer;
-    /**
-     * Removes all listeners, or those of the specified channel.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovealllistenerschannel
-     */
-    removeAllListeners: (channel: string) => IpcRenderer;
-    /**
-     * Send an asynchronous message to the main process via channel, along with arguments.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendchannel-args
-     */
-    send: (channel: string, ...args: any[]) => void;
-    /**
-     * Returns Promise<any> - Resolves with the response from the main process.
-     * Send a message to the main process via channel and expect a result ~~asynchronously~~.
-     * As composition-api, it makes asynchronous operations look like synchronous.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
-     */
-    invoke: <T>(channel: string, ...args: any[]) => ShallowRef<T | null>;
-    /**
-     * Returns any - The value sent back by the ipcMain handler.
-     * Send a message to the main process via channel and expect a result synchronously.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendsyncchannel-args
-     */
-    sendSync: <T>(channel: string, ...args: any[]) => ShallowRef<T | null>;
-    /**
-     * Send a message to the main process, optionally transferring ownership of zero or more MessagePort objects.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererpostmessagechannel-message-transfer
-     */
-    postMessage: (channel: string, message: any, transfer?: MessagePort[]) => void;
-    /**
-     * Sends a message to a window with webContentsId via channel.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtowebcontentsid-channel-args
-     */
-    sendTo: (webContentsId: number, channel: string, ...args: any[]) => void;
-    /**
-     * Like ipcRenderer.send but the event will be sent to the <webview> element in the host page instead of the main process.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-args
-     */
-    sendToHost: (channel: string, ...args: any[]) => void;
-}
-/**
- * Get the `ipcRenderer` module with all APIs.
- *
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-args
- * @see https://vueuse.org/useIpcRenderer
- */
-declare function useIpcRenderer(ipcRenderer?: IpcRenderer): UseIpcRendererReturn;
-
-/**
- * Returns Promise<any> - Resolves with the response from the main process.
- *
- * Send a message to the main process via channel and expect a result ~~asynchronously~~. As composition-api, it makes asynchronous operations look like synchronous.
- *
- * You need to provide `ipcRenderer` to this function.
- *
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
- * @see https://vueuse.org/useIpcRendererInvoke
- */
-declare function useIpcRendererInvoke<T>(ipcRenderer: IpcRenderer, channel: string, ...args: any[]): ShallowRef<T | null>;
-/**
- * Returns Promise<any> - Resolves with the response from the main process.
- *
- * Send a message to the main process via channel and expect a result ~~asynchronously~~. As composition-api, it makes asynchronous operations look like synchronous.
- *
- * `ipcRenderer` will be automatically gotten.
- *
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
- * @see https://vueuse.org/useIpcRendererInvoke
- */
-declare function useIpcRendererInvoke<T>(channel: string, ...args: any[]): ShallowRef<T | null>;
-
-/**
- * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
- * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
- *
- * You need to provide `ipcRenderer` to this function.
- *
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
- * @see https://vueuse.org/useIpcRendererOn
- */
-declare function useIpcRendererOn(ipcRenderer: IpcRenderer, channel: string, listener: IpcRendererListener): IpcRenderer;
-/**
- * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
- * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
- *
- * `ipcRenderer` will be automatically gotten.
- *
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
- * @see https://vueuse.org/useIpcRendererOn
- */
-declare function useIpcRendererOn(channel: string, listener: IpcRendererListener): IpcRenderer;
-
-declare function useZoomFactor(factor: MaybeRef<number>): Ref<number>;
-declare function useZoomFactor(webFrame: WebFrame, factor: MaybeRef<number>): Ref<number>;
-declare function useZoomFactor(webFrame: WebFrame): Ref<number>;
-declare function useZoomFactor(): Ref<number>;
-
-declare function useZoomLevel(level: MaybeRef<number>): Ref<number>;
-declare function useZoomLevel(webFrame: WebFrame, level: MaybeRef<number>): Ref<number>;
-declare function useZoomLevel(webFrame: WebFrame): Ref<number>;
-declare function useZoomLevel(): Ref<number>;
-
-export { type UseIpcRendererReturn, useIpcRenderer, useIpcRendererInvoke, useIpcRendererOn, useZoomFactor, useZoomLevel };

package/index.d.ts

@@ -1,139 +0,0 @@
-import { IpcRendererEvent, IpcRenderer, WebFrame } from 'electron';
-import { ShallowRef, MaybeRef, Ref } from 'vue';
-
-type IpcRendererListener = (event: IpcRendererEvent, ...args: any[]) => void;
-
-/**
- * Result from useIpcRenderer
- *
- * @see https://www.electronjs.org/docs/api/ipc-renderer
- */
-interface UseIpcRendererReturn {
-    /**
-     * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
-     * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
-     */
-    on: (channel: string, listener: IpcRendererListener) => IpcRenderer;
-    /**
-     * Adds a one time listener function for the event. This listener is invoked only the next time a message is sent to channel, after which it is removed.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereroncechannel-listener
-     */
-    once: (channel: string, listener: (event: IpcRendererEvent, ...args: any[]) => void) => IpcRenderer;
-    /**
-     * Removes the specified listener from the listener array for the specified channel.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener
-     */
-    removeListener: (channel: string, listener: (...args: any[]) => void) => IpcRenderer;
-    /**
-     * Removes all listeners, or those of the specified channel.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovealllistenerschannel
-     */
-    removeAllListeners: (channel: string) => IpcRenderer;
-    /**
-     * Send an asynchronous message to the main process via channel, along with arguments.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendchannel-args
-     */
-    send: (channel: string, ...args: any[]) => void;
-    /**
-     * Returns Promise<any> - Resolves with the response from the main process.
-     * Send a message to the main process via channel and expect a result ~~asynchronously~~.
-     * As composition-api, it makes asynchronous operations look like synchronous.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
-     */
-    invoke: <T>(channel: string, ...args: any[]) => ShallowRef<T | null>;
-    /**
-     * Returns any - The value sent back by the ipcMain handler.
-     * Send a message to the main process via channel and expect a result synchronously.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendsyncchannel-args
-     */
-    sendSync: <T>(channel: string, ...args: any[]) => ShallowRef<T | null>;
-    /**
-     * Send a message to the main process, optionally transferring ownership of zero or more MessagePort objects.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererpostmessagechannel-message-transfer
-     */
-    postMessage: (channel: string, message: any, transfer?: MessagePort[]) => void;
-    /**
-     * Sends a message to a window with webContentsId via channel.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtowebcontentsid-channel-args
-     */
-    sendTo: (webContentsId: number, channel: string, ...args: any[]) => void;
-    /**
-     * Like ipcRenderer.send but the event will be sent to the <webview> element in the host page instead of the main process.
-     *
-     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-args
-     */
-    sendToHost: (channel: string, ...args: any[]) => void;
-}
-/**
- * Get the `ipcRenderer` module with all APIs.
- *
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-args
- * @see https://vueuse.org/useIpcRenderer
- */
-declare function useIpcRenderer(ipcRenderer?: IpcRenderer): UseIpcRendererReturn;
-
-/**
- * Returns Promise<any> - Resolves with the response from the main process.
- *
- * Send a message to the main process via channel and expect a result ~~asynchronously~~. As composition-api, it makes asynchronous operations look like synchronous.
- *
- * You need to provide `ipcRenderer` to this function.
- *
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
- * @see https://vueuse.org/useIpcRendererInvoke
- */
-declare function useIpcRendererInvoke<T>(ipcRenderer: IpcRenderer, channel: string, ...args: any[]): ShallowRef<T | null>;
-/**
- * Returns Promise<any> - Resolves with the response from the main process.
- *
- * Send a message to the main process via channel and expect a result ~~asynchronously~~. As composition-api, it makes asynchronous operations look like synchronous.
- *
- * `ipcRenderer` will be automatically gotten.
- *
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
- * @see https://vueuse.org/useIpcRendererInvoke
- */
-declare function useIpcRendererInvoke<T>(channel: string, ...args: any[]): ShallowRef<T | null>;
-
-/**
- * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
- * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
- *
- * You need to provide `ipcRenderer` to this function.
- *
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
- * @see https://vueuse.org/useIpcRendererOn
- */
-declare function useIpcRendererOn(ipcRenderer: IpcRenderer, channel: string, listener: IpcRendererListener): IpcRenderer;
-/**
- * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
- * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
- *
- * `ipcRenderer` will be automatically gotten.
- *
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
- * @see https://vueuse.org/useIpcRendererOn
- */
-declare function useIpcRendererOn(channel: string, listener: IpcRendererListener): IpcRenderer;
-
-declare function useZoomFactor(factor: MaybeRef<number>): Ref<number>;
-declare function useZoomFactor(webFrame: WebFrame, factor: MaybeRef<number>): Ref<number>;
-declare function useZoomFactor(webFrame: WebFrame): Ref<number>;
-declare function useZoomFactor(): Ref<number>;
-
-declare function useZoomLevel(level: MaybeRef<number>): Ref<number>;
-declare function useZoomLevel(webFrame: WebFrame, level: MaybeRef<number>): Ref<number>;
-declare function useZoomLevel(webFrame: WebFrame): Ref<number>;
-declare function useZoomLevel(): Ref<number>;
-
-export { type UseIpcRendererReturn, useIpcRenderer, useIpcRendererInvoke, useIpcRendererOn, useZoomFactor, useZoomLevel };