node-native-win-utils 1.3.4 → 2.1.0

package/dist/index.mjs

@@ -0,0 +1,177 @@
+import { createRequire as _createRequire } from "module";
+const __require = _createRequire(import.meta.url);
+import EventEmitter from 'events';
+import path from "path";
+import fs from "fs";
+// @ts-ignore
+const nodeGypBuild = __require("node-gyp-build");
+import { keyCodes, KeyCodeHelper } from "./keyCodes.mjs";
+import { __dirnameLocal } from "./dirnameLocal.mjs";
+const bindings = nodeGypBuild(path.resolve(__dirnameLocal, ".."));
+const { setKeyDownCallback, setKeyUpCallback, unsetKeyDownCallback, unsetKeyUpCallback, getWindowData, captureWindowN, captureScreenAsync, mouseMove, mouseClick, mouseDrag, typeString, pressKey, imread, imwrite, matchTemplate, blur, bgrToGray, drawRectangle, getRegion, textRecognition } = bindings;
+const rawPressKey = pressKey;
+/**
+ * Captures a window and saves it to a file.
+ * @param windowName - The name of the window to capture.
+ * @param path - The file path to save the captured image.
+ * @returns True if the capture and save operation is successful, otherwise false.
+ */
+function captureWindow(windowName, path) {
+    const buffer = captureWindowN(windowName);
+    if (!buffer)
+        return false;
+    fs.writeFileSync(path, new Uint8Array(buffer));
+    return true;
+}
+/**
+ * Captures a screen and saves it to a file.
+ * @param path - The file path to save the captured image.
+ * @returns True if the capture and save operation is successful, otherwise false.
+ */
+function captureScreenToFile(path) {
+    return new Promise((resolve, reject) => {
+        captureScreenAsync().then((buffer) => {
+            fs.writeFileSync(path, new Uint8Array(buffer));
+            resolve(true);
+        }).catch((err => {
+            reject(err);
+        }));
+    });
+}
+/**
+ * Represents a class to listen to keyboard events.
+ * @extends EventEmitter
+ */
+class KeyboardListenerPrivate extends EventEmitter {
+    constructor() {
+        super();
+        setKeyDownCallback((keyCode) => {
+            const keyName = keyCodes.get(keyCode.toString());
+            this.emit("keyDown", {
+                keyCode,
+                keyName,
+            });
+        });
+        setKeyUpCallback((keyCode) => {
+            const keyName = keyCodes.get(keyCode.toString());
+            this.emit("keyUp", {
+                keyCode,
+                keyName,
+            });
+        });
+    }
+}
+class KeyboardListener {
+    static listenerInstance = null;
+    static listener() {
+        if (!this.listenerInstance)
+            this.listenerInstance = new KeyboardListenerPrivate();
+        return this.listenerInstance;
+    }
+    static destroy() {
+        this.listenerInstance = null;
+        unsetKeyDownCallback();
+        unsetKeyUpCallback();
+    }
+}
+/**
+ * Represents the OpenCV class that provides image processing functionality.
+ */
+class OpenCV {
+    imageData;
+    /**
+     * Represents the OpenCV class that provides image processing functionality.
+     */
+    constructor(image) {
+        if (typeof image === "string") {
+            this.imageData = imread(image);
+        }
+        else {
+            this.imageData = image;
+        }
+    }
+    /**
+     * The width of the image.
+     */
+    get width() {
+        return this.imageData.width;
+    }
+    /**
+     * The height of the image.
+     */
+    get height() {
+        return this.imageData.height;
+    }
+    /**
+     * Matches a template image within the current image.
+     * @param template - The template image data to search for.
+     * @param method - The template matching method (optional).
+     * @param mask - The optional mask image data to apply the operation (optional).
+     * @returns The result of the template matching operation.
+     */
+    matchTemplate(template, method, mask) {
+        return matchTemplate(this.imageData, template, method, mask);
+    }
+    /**
+     * Applies a blur filter to the image.
+     * @param sizeX - The horizontal size of the blur filter.
+     * @param sizeY - The vertical size of the blur filter.
+     * @returns A new OpenCV instance with the blurred image data.
+     */
+    blur(sizeX, sizeY) {
+        return new OpenCV(blur(this.imageData, sizeX, sizeY));
+    }
+    /**
+     * Converts the image from BGR to grayscale.
+     * @returns A new OpenCV instance with the grayscale image data.
+     */
+    bgrToGray() {
+        return new OpenCV(bgrToGray(this.imageData));
+    }
+    /**
+     * Draws a rectangle on the image.
+     * @param start - The starting point of the rectangle.
+     * @param end - The ending point of the rectangle.
+     * @param rgb - The color (RGB) of the rectangle.
+     * @param thickness - The thickness of the rectangle's border.
+     * @returns A new OpenCV instance with the image containing the drawn rectangle.
+     */
+    drawRectangle(start, end, rgb, thickness) {
+        return new OpenCV(drawRectangle(this.imageData, start, end, rgb, thickness));
+    }
+    /**
+     * Extracts a region of interest (ROI) from the image.
+     * @param region - The region of interest defined as [x, y, width, height].
+     * @returns A new OpenCV instance with the extracted region of interest.
+     */
+    getRegion(region) {
+        return new OpenCV(getRegion(this.imageData, region));
+    }
+    /**
+     * Writes the image data to a file.
+     * @param path - The file path to save the image.
+     */
+    imwrite(path) {
+        const buffer = imwrite(this.imageData);
+        if (!buffer)
+            return;
+        fs.writeFileSync(path, new Uint8Array(buffer));
+    }
+}
+function keyPress(keyCode, repeat) {
+    return new Promise((resolve, reject) => {
+        if (!repeat) {
+            let result = rawPressKey(keyCode);
+            if (!result)
+                reject('Something went wrong');
+            return resolve(true);
+        }
+        for (let i = 0; i <= repeat; i++) {
+            let result = rawPressKey(keyCode);
+            if (!result)
+                reject('Something went wrong');
+        }
+        return resolve(true);
+    });
+}
+export { getWindowData, captureWindow, captureWindowN, mouseMove, mouseClick, mouseDrag, typeString, keyPress, rawPressKey, KeyCodeHelper, textRecognition, captureScreenToFile, KeyboardListener, OpenCV };

package/dist/keyCodes.d.mts

@@ -0,0 +1,101 @@
+export declare const keyCodes: Map<string, string>;
+export declare enum KeyCodeHelper {
+    "Backspace" = 8,
+    "Tab" = 9,
+    "Enter" = 13,
+    "Shift" = 16,
+    "Ctrl" = 17,
+    "Alt" = 18,
+    "CapsLock" = 20,
+    "Escape" = 27,
+    "Space" = 32,
+    "PageUp" = 33,
+    "PageDown" = 34,
+    "End" = 35,
+    "Home" = 36,
+    "ArrowLeft" = 37,
+    "ArrowUp" = 38,
+    "ArrowRight" = 39,
+    "ArrowDown" = 40,
+    "Insert" = 45,
+    "Delete" = 46,
+    "Zero" = 48,
+    "One" = 49,
+    "Two" = 50,
+    "Three" = 51,
+    "Four" = 52,
+    "Five" = 53,
+    "Six" = 54,
+    "Seven" = 55,
+    "Eight" = 56,
+    "Nine" = 57,
+    "A" = 65,
+    "B" = 66,
+    "C" = 67,
+    "D" = 68,
+    "E" = 69,
+    "F" = 70,
+    "G" = 71,
+    "H" = 72,
+    "I" = 73,
+    "J" = 74,
+    "K" = 75,
+    "L" = 76,
+    "M" = 77,
+    "N" = 78,
+    "O" = 79,
+    "P" = 80,
+    "Q" = 81,
+    "R" = 82,
+    "S" = 83,
+    "T" = 84,
+    "U" = 85,
+    "V" = 86,
+    "W" = 87,
+    "X" = 88,
+    "Y" = 89,
+    "Z" = 90,
+    "MetaLeft" = 91,
+    "MetaRight" = 92,
+    "ContextMenu" = 93,
+    "Numpad0" = 96,
+    "Numpad1" = 97,
+    "Numpad2" = 98,
+    "Numpad3" = 99,
+    "Numpad4" = 100,
+    "Numpad5" = 101,
+    "Numpad6" = 102,
+    "Numpad7" = 103,
+    "Numpad8" = 104,
+    "Numpad9" = 105,
+    "NumpadMultiply" = 106,
+    "NumpadAdd" = 107,
+    "NumpadSubtract" = 109,
+    "NumpadDecimal" = 110,
+    "NumpadDivide" = 111,
+    "F1" = 112,
+    "F2" = 113,
+    "F3" = 114,
+    "F4" = 115,
+    "F5" = 116,
+    "F6" = 117,
+    "F7" = 118,
+    "F8" = 119,
+    "F9" = 120,
+    "F10" = 121,
+    "F11" = 122,
+    "F12" = 123,
+    "NumLock" = 144,
+    "ScrollLock" = 145,
+    "Semicolon" = 186,
+    "Equal" = 187,
+    "Comma" = 188,
+    "Minus" = 189,
+    "Period" = 190,
+    "Slash" = 191,
+    "Backquote" = 192,
+    "BracketLeft" = 219,
+    "Backslash" = 220,
+    "BracketRight" = 221,
+    "Quote" = 222
+}

package/dist/keyCodes.mjs

@@ -0,0 +1,201 @@
+export const keyCodes = new Map(Object.entries({
+    8: "Backspace",
+    9: "Tab",
+    13: "Enter",
+    16: "Shift",
+    17: "Ctrl",
+    18: "Alt",
+    20: "CapsLock",
+    27: "Escape",
+    32: "Space",
+    33: "PageUp",
+    34: "PageDown",
+    35: "End",
+    36: "Home",
+    37: "ArrowLeft",
+    38: "ArrowUp",
+    39: "ArrowRight",
+    40: "ArrowDown",
+    45: "Insert",
+    46: "Delete",
+    48: "0",
+    49: "1",
+    50: "2",
+    51: "3",
+    52: "4",
+    53: "5",
+    54: "6",
+    55: "7",
+    56: "8",
+    57: "9",
+    65: "A",
+    66: "B",
+    67: "C",
+    68: "D",
+    69: "E",
+    70: "F",
+    71: "G",
+    72: "H",
+    73: "I",
+    74: "J",
+    75: "K",
+    76: "L",
+    77: "M",
+    78: "N",
+    79: "O",
+    80: "P",
+    81: "Q",
+    82: "R",
+    83: "S",
+    84: "T",
+    85: "U",
+    86: "V",
+    87: "W",
+    88: "X",
+    89: "Y",
+    90: "Z",
+    91: "MetaLeft",
+    92: "MetaRight",
+    93: "ContextMenu",
+    96: "Numpad0",
+    97: "Numpad1",
+    98: "Numpad2",
+    99: "Numpad3",
+    100: "Numpad4",
+    101: "Numpad5",
+    102: "Numpad6",
+    103: "Numpad7",
+    104: "Numpad8",
+    105: "Numpad9",
+    106: "NumpadMultiply",
+    107: "NumpadAdd",
+    109: "NumpadSubtract",
+    110: "NumpadDecimal",
+    111: "NumpadDivide",
+    112: "F1",
+    113: "F2",
+    114: "F3",
+    115: "F4",
+    116: "F5",
+    117: "F6",
+    118: "F7",
+    119: "F8",
+    120: "F9",
+    121: "F10",
+    122: "F11",
+    123: "F12",
+    144: "NumLock",
+    145: "ScrollLock",
+    186: "Semicolon",
+    187: "Equal",
+    188: "Comma",
+    189: "Minus",
+    190: "Period",
+    191: "Slash",
+    192: "Backquote",
+    219: "BracketLeft",
+    220: "Backslash",
+    221: "BracketRight",
+    222: "Quote",
+}));
+export var KeyCodeHelper;
+(function (KeyCodeHelper) {
+    KeyCodeHelper[KeyCodeHelper["Backspace"] = 8] = "Backspace";
+    KeyCodeHelper[KeyCodeHelper["Tab"] = 9] = "Tab";
+    KeyCodeHelper[KeyCodeHelper["Enter"] = 13] = "Enter";
+    KeyCodeHelper[KeyCodeHelper["Shift"] = 16] = "Shift";
+    KeyCodeHelper[KeyCodeHelper["Ctrl"] = 17] = "Ctrl";
+    KeyCodeHelper[KeyCodeHelper["Alt"] = 18] = "Alt";
+    KeyCodeHelper[KeyCodeHelper["CapsLock"] = 20] = "CapsLock";
+    KeyCodeHelper[KeyCodeHelper["Escape"] = 27] = "Escape";
+    KeyCodeHelper[KeyCodeHelper["Space"] = 32] = "Space";
+    KeyCodeHelper[KeyCodeHelper["PageUp"] = 33] = "PageUp";
+    KeyCodeHelper[KeyCodeHelper["PageDown"] = 34] = "PageDown";
+    KeyCodeHelper[KeyCodeHelper["End"] = 35] = "End";
+    KeyCodeHelper[KeyCodeHelper["Home"] = 36] = "Home";
+    KeyCodeHelper[KeyCodeHelper["ArrowLeft"] = 37] = "ArrowLeft";
+    KeyCodeHelper[KeyCodeHelper["ArrowUp"] = 38] = "ArrowUp";
+    KeyCodeHelper[KeyCodeHelper["ArrowRight"] = 39] = "ArrowRight";
+    KeyCodeHelper[KeyCodeHelper["ArrowDown"] = 40] = "ArrowDown";
+    KeyCodeHelper[KeyCodeHelper["Insert"] = 45] = "Insert";
+    KeyCodeHelper[KeyCodeHelper["Delete"] = 46] = "Delete";
+    KeyCodeHelper[KeyCodeHelper["Zero"] = 48] = "Zero";
+    KeyCodeHelper[KeyCodeHelper["One"] = 49] = "One";
+    KeyCodeHelper[KeyCodeHelper["Two"] = 50] = "Two";
+    KeyCodeHelper[KeyCodeHelper["Three"] = 51] = "Three";
+    KeyCodeHelper[KeyCodeHelper["Four"] = 52] = "Four";
+    KeyCodeHelper[KeyCodeHelper["Five"] = 53] = "Five";
+    KeyCodeHelper[KeyCodeHelper["Six"] = 54] = "Six";
+    KeyCodeHelper[KeyCodeHelper["Seven"] = 55] = "Seven";
+    KeyCodeHelper[KeyCodeHelper["Eight"] = 56] = "Eight";
+    KeyCodeHelper[KeyCodeHelper["Nine"] = 57] = "Nine";
+    KeyCodeHelper[KeyCodeHelper["A"] = 65] = "A";
+    KeyCodeHelper[KeyCodeHelper["B"] = 66] = "B";
+    KeyCodeHelper[KeyCodeHelper["C"] = 67] = "C";
+    KeyCodeHelper[KeyCodeHelper["D"] = 68] = "D";
+    KeyCodeHelper[KeyCodeHelper["E"] = 69] = "E";
+    KeyCodeHelper[KeyCodeHelper["F"] = 70] = "F";
+    KeyCodeHelper[KeyCodeHelper["G"] = 71] = "G";
+    KeyCodeHelper[KeyCodeHelper["H"] = 72] = "H";
+    KeyCodeHelper[KeyCodeHelper["I"] = 73] = "I";
+    KeyCodeHelper[KeyCodeHelper["J"] = 74] = "J";
+    KeyCodeHelper[KeyCodeHelper["K"] = 75] = "K";
+    KeyCodeHelper[KeyCodeHelper["L"] = 76] = "L";
+    KeyCodeHelper[KeyCodeHelper["M"] = 77] = "M";
+    KeyCodeHelper[KeyCodeHelper["N"] = 78] = "N";
+    KeyCodeHelper[KeyCodeHelper["O"] = 79] = "O";
+    KeyCodeHelper[KeyCodeHelper["P"] = 80] = "P";
+    KeyCodeHelper[KeyCodeHelper["Q"] = 81] = "Q";
+    KeyCodeHelper[KeyCodeHelper["R"] = 82] = "R";
+    KeyCodeHelper[KeyCodeHelper["S"] = 83] = "S";
+    KeyCodeHelper[KeyCodeHelper["T"] = 84] = "T";
+    KeyCodeHelper[KeyCodeHelper["U"] = 85] = "U";
+    KeyCodeHelper[KeyCodeHelper["V"] = 86] = "V";
+    KeyCodeHelper[KeyCodeHelper["W"] = 87] = "W";
+    KeyCodeHelper[KeyCodeHelper["X"] = 88] = "X";
+    KeyCodeHelper[KeyCodeHelper["Y"] = 89] = "Y";
+    KeyCodeHelper[KeyCodeHelper["Z"] = 90] = "Z";
+    KeyCodeHelper[KeyCodeHelper["MetaLeft"] = 91] = "MetaLeft";
+    KeyCodeHelper[KeyCodeHelper["MetaRight"] = 92] = "MetaRight";
+    KeyCodeHelper[KeyCodeHelper["ContextMenu"] = 93] = "ContextMenu";
+    KeyCodeHelper[KeyCodeHelper["Numpad0"] = 96] = "Numpad0";
+    KeyCodeHelper[KeyCodeHelper["Numpad1"] = 97] = "Numpad1";
+    KeyCodeHelper[KeyCodeHelper["Numpad2"] = 98] = "Numpad2";
+    KeyCodeHelper[KeyCodeHelper["Numpad3"] = 99] = "Numpad3";
+    KeyCodeHelper[KeyCodeHelper["Numpad4"] = 100] = "Numpad4";
+    KeyCodeHelper[KeyCodeHelper["Numpad5"] = 101] = "Numpad5";
+    KeyCodeHelper[KeyCodeHelper["Numpad6"] = 102] = "Numpad6";
+    KeyCodeHelper[KeyCodeHelper["Numpad7"] = 103] = "Numpad7";
+    KeyCodeHelper[KeyCodeHelper["Numpad8"] = 104] = "Numpad8";
+    KeyCodeHelper[KeyCodeHelper["Numpad9"] = 105] = "Numpad9";
+    KeyCodeHelper[KeyCodeHelper["NumpadMultiply"] = 106] = "NumpadMultiply";
+    KeyCodeHelper[KeyCodeHelper["NumpadAdd"] = 107] = "NumpadAdd";
+    KeyCodeHelper[KeyCodeHelper["NumpadSubtract"] = 109] = "NumpadSubtract";
+    KeyCodeHelper[KeyCodeHelper["NumpadDecimal"] = 110] = "NumpadDecimal";
+    KeyCodeHelper[KeyCodeHelper["NumpadDivide"] = 111] = "NumpadDivide";
+    KeyCodeHelper[KeyCodeHelper["F1"] = 112] = "F1";
+    KeyCodeHelper[KeyCodeHelper["F2"] = 113] = "F2";
+    KeyCodeHelper[KeyCodeHelper["F3"] = 114] = "F3";
+    KeyCodeHelper[KeyCodeHelper["F4"] = 115] = "F4";
+    KeyCodeHelper[KeyCodeHelper["F5"] = 116] = "F5";
+    KeyCodeHelper[KeyCodeHelper["F6"] = 117] = "F6";
+    KeyCodeHelper[KeyCodeHelper["F7"] = 118] = "F7";
+    KeyCodeHelper[KeyCodeHelper["F8"] = 119] = "F8";
+    KeyCodeHelper[KeyCodeHelper["F9"] = 120] = "F9";
+    KeyCodeHelper[KeyCodeHelper["F10"] = 121] = "F10";
+    KeyCodeHelper[KeyCodeHelper["F11"] = 122] = "F11";
+    KeyCodeHelper[KeyCodeHelper["F12"] = 123] = "F12";
+    KeyCodeHelper[KeyCodeHelper["NumLock"] = 144] = "NumLock";
+    KeyCodeHelper[KeyCodeHelper["ScrollLock"] = 145] = "ScrollLock";
+    KeyCodeHelper[KeyCodeHelper["Semicolon"] = 186] = "Semicolon";
+    KeyCodeHelper[KeyCodeHelper["Equal"] = 187] = "Equal";
+    KeyCodeHelper[KeyCodeHelper["Comma"] = 188] = "Comma";
+    KeyCodeHelper[KeyCodeHelper["Minus"] = 189] = "Minus";
+    KeyCodeHelper[KeyCodeHelper["Period"] = 190] = "Period";
+    KeyCodeHelper[KeyCodeHelper["Slash"] = 191] = "Slash";
+    KeyCodeHelper[KeyCodeHelper["Backquote"] = 192] = "Backquote";
+    KeyCodeHelper[KeyCodeHelper["BracketLeft"] = 219] = "BracketLeft";
+    KeyCodeHelper[KeyCodeHelper["Backslash"] = 220] = "Backslash";
+    KeyCodeHelper[KeyCodeHelper["BracketRight"] = 221] = "BracketRight";
+    KeyCodeHelper[KeyCodeHelper["Quote"] = 222] = "Quote";
+})(KeyCodeHelper || (KeyCodeHelper = {}));

package/node22.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Node 22",
+  "_version": "22.0.0",
+
+  "compilerOptions": {
+    "lib": ["es2023"],
+    "module": "node16",
+    "target": "es2022",
+
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "moduleResolution": "node16"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-native-win-utils",
-  "version": "1.3.4",
+  "version": "2.1.0",
   "author": "Andrew K.",
   "license": "MIT",
   "repository": "https://github.com/T-Rumibul/node-native-win-utils.git",
@@ -25,23 +25,36 @@
     "template matching",
     "image",
     "blur",
-    "grayscale"
+    "grayscale",
+    "text recognition",
+    "OCR"
   ],
-  "main": "dist/index.js",
+  "exports": {
+    "require": "./dist/index.cjs",
+    "import": "./dist/index.mjs"
+  },
+  "main": "dist/index.cjs",
   "types": "dist/index.d.ts",
   "gypfile": true,
   "scripts": {
     "install": "node-gyp-build",
-    "build": "node-gyp clean && prebuildify --napi && tsc",
-    "test": "jest"
+    "build": "node-gyp clean && npx prebuildify --napi && node ./buildHelpers/dllCopy.js && npm run buildts",
+    "buildts": "node ./buildHelpers/cjsCompatBuild.js",
+    "test": "tap run "
   },
   "dependencies": {
-    "node-addon-api": "^6.1.0",
-    "node-gyp": "^9.3.1",
-    "node-gyp-build": "4.8.0"
+    "node-addon-api": "^8.3.1",
+    "node-gyp": "^11.1.0",
+    "node-gyp-build": "^4.8.4"
   },
   "devDependencies": {
     "@types/node": "^20.2.5",
-    "jest": "^29.7.0"
+    "node-api-headers": "^1.5.0",
+    "tap": "^21.1.0"
+  },
+  "tap": {
+    "plugin": [
+      "@tapjs/sinon"
+    ]
   }
 }