@lysyyds/win32-mouse-keyboard-hook 1.0.10 → 1.0.11

package/README.md

@@ -1,4 +1,108 @@
-Before starting, please configure the development environment: desktop development using C++/Windows 10/11 SDK/Python 3, and then run  `npm run build`
+## What's this for
+
+C++ mouse-keyboard-hook for Electron -> Windows
+
+supported Electron verion:
+
+- "22.3.27", // 最后一个支持 Win7 的版本
+- "23.3.13",
+- "24.8.3",
+- "25.9.0",
+- "26.2.0",
+- "27.3.0",
+- "28.2.0",
+- "29.4.0",
+- "30.5.1",
+- "31.0.0",
+
+## Usage
+
+### install
+
+```
+npm i @lysyyds/win32-mouse-keyboard-hook
+
+```
+
+### use
+
+```typescript
+// import
+const win32KeyboardHook = require("@lysyyds/win32-mouse-keyboard-hook");
+// or
+// import win32KeyboardHook from "@lysyyds/win32-mouse-keyboard-hook";
+
+// import types
+import type { Callback } from "@lysyyds/win32-mouse-keyboard-hook";
+
+const callback: Callback = (type, eventType, x, y) => {
+  const [type, eventType, x, y] = args;
+  if (type === "key") {
+    // keyboard event
+    if (eventType == 1) {
+      // keydown
+      x; // keycode
+    } else if (eventType == 2) {
+      // keyup
+      x; // keycode
+    }
+  } else if (type === "mouse") {
+    x; // mouse position x
+    y; // mouse position y
+
+    if (eventType == 2) {
+      // mouse left button down
+    } else if (eventType == 3) {
+      // mouse left button up
+    } else if (eventType == 4) {
+      // mouse right button down
+    } else if (eventType == 5) {
+      // mouse right button up
+    } else if (eventType == 6) {
+      // wheel active
+    }
+  }
+};
+
+win32KeyboardHook.start(callback);
+```
+
+
+types
+``` typescript
+declare module "@lysyyds/win32-mouse-keyboard-hook" {
+  export type Callback = (
+    type: "key" | "mouse",
+    eventType: number,
+    x: number,
+    y: number,
+  ) => void;
+
+  export type CallbackArgs = Parameters<Callback>;
+
+  export function start(callback: Callback): void;
+  export function stop(): void;
+
+  export enum KeyboardEventType {
+    KeyDown = 1,
+    KeyUp = 2,
+  }
+
+  export enum MouseEventType {
+    Move = 1,
+    LeftDown = 2,
+    LeftUp = 3,
+    RightDown = 4,
+    RightUp = 5,
+    Wheel = 6,
+  }
+}
+
+```
+
+## Build yourself
+
+Before starting, please configure the development environment: desktop development using C++/Windows 10/11 SDK/Python 3, and then run `npm run build`
 
 ```
 **********************************************************************
@@ -24,4 +128,4 @@ D:\sourcecode\win32-keyboard-hook>python --version
 Python 3.14.2
 
 D:\sourcecode\win32-keyboard-hook>npm run build
-```
+```

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "@lysyyds/win32-mouse-keyboard-hook",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "description": "C++ mouse-keyboard-hook for NodeJS & Electron",
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
-    "build": "node-gyp rebuild --target=30.0.0 --dist-url=https://electronjs.org/headers",
+    "build-all": "node scripts/prebuild.js",
     "install": "prebuild-install || echo \"skip node build\"",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/meiguiyisenluo/win32-mouse-keyboard-hook.git"
+  },
   "files": [
     "index.js",
     "index.d.ts",
@@ -29,11 +33,14 @@
   "license": "ISC",
   "dependencies": {
     "node-addon-api": "^8.5.0",
-    "prebuild-install": "^7.1.3",
-    "node-gyp-build": "^4.8.4"
+    "node-gyp-build": "^4.8.4",
+    "prebuild-install": "^7.1.3"
   },
   "devDependencies": {
-    "node-gyp": "^12.2.0"
+    "install": "^0.13.0",
+    "node-abi": "^4.26.0",
+    "node-gyp": "^12.2.0",
+    "npm": "^11.8.0"
   },
   "exports": {
     ".": {