node-native-win-utils 1.3.2 → 1.3.4

package/binding.gyp

@@ -1,46 +1,46 @@
-{
-    "targets": [
-        {
-            "target_name": "node-native-win-utils",
-            "sources": ["src/cpp/main.cpp"],
-            "openssl_flips": "",
-            "include_dirs": [
-                "<!@(node -p \"require('node-addon-api').include\")",
-                "src/cpp",
-                "libs",
-                "include",
-                "dll"
-            ],
-            "dependencies": [
-                "<!(node -p \"require('node-addon-api').gyp\")"
-            ],
-            "libraries": [
-                "dwmapi.lib",
-                "windowsapp.lib",
-                "<!(node -p \"require('path').resolve('libs/libjpeg-turbo.lib')\")",
-                "<!(node -p \"require('path').resolve('libs/libpng.lib')\")",
-                "<!(node -p \"require('path').resolve('libs/zlib.lib')\")",
-                "<!(node -p \"require('path').resolve('libs/opencv_core470.lib')\")",
-                "<!(node -p \"require('path').resolve('libs/opencv_imgcodecs470.lib')\")",
-                "<!(node -p \"require('path').resolve('libs/opencv_imgproc470.lib')\")",
-
-            ],
-            "conditions": [
-                ["OS=='win'", {
-                    "defines": [
-                        "_CRT_SECURE_NO_WARNINGS"
-                    ],
-                    "msvs_settings": {
-                        "VCCLCompilerTool": {
-                            "AdditionalOptions": ["/EHsc"]
-                        }
-                    }
-                }]
-            ],
-            "defines": ["NAPI_CPP_EXCEPTIONS"],
-            "cflags!": ["-fno-exceptions"],
-            "cflags_cc!": ["-fno-rtti"],
-            "cflags": ["/std:c++17"]
-        }
-    ]
-}
+{
+    "targets": [
+        {
+            "target_name": "node-native-win-utils",
+            "sources": ["src/cpp/main.cpp"],
+            "openssl_flips": "",
+            "include_dirs": [
+                "<!@(node -p \"require('node-addon-api').include\")",
+                "src/cpp",
+                "libs",
+                "include",
+                "dll"
+            ],
+            "dependencies": [
+                "<!(node -p \"require('node-addon-api').gyp\")"
+            ],
+            "libraries": [
+                "dwmapi.lib",
+                "windowsapp.lib",
+                "<!(node -p \"require('path').resolve('libs/libjpeg-turbo.lib')\")",
+                "<!(node -p \"require('path').resolve('libs/libpng.lib')\")",
+                "<!(node -p \"require('path').resolve('libs/zlib.lib')\")",
+                "<!(node -p \"require('path').resolve('libs/opencv_core470.lib')\")",
+                "<!(node -p \"require('path').resolve('libs/opencv_imgcodecs470.lib')\")",
+                "<!(node -p \"require('path').resolve('libs/opencv_imgproc470.lib')\")",
+
+            ],
+            "conditions": [
+                ["OS=='win'", {
+                    "defines": [
+                        "_CRT_SECURE_NO_WARNINGS"
+                    ],
+                    "msvs_settings": {
+                        "VCCLCompilerTool": {
+                            "AdditionalOptions": ["/EHsc"]
+                        }
+                    }
+                }]
+            ],
+            "defines": ["NAPI_CPP_EXCEPTIONS"],
+            "cflags!": ["-fno-exceptions"],
+            "cflags_cc!": ["-fno-rtti"],
+            "cflags": ["/std:c++21"]
+        }
+    ]
+}

package/dist/index.d.ts

@@ -1,173 +1,178 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import EventEmitter = require("events");
-/**
- * Represents the data of a window.
- */
-export type WindowData = {
-    width: number;
-    height: number;
-    x: number;
-    y: number;
-};
-/**
- * Represents the data of an image.
- */
-export type ImageData = {
-    width: number;
-    height: number;
-    data: Uint8Array;
-};
-/**
- * Represents the result of a template matching operation.
- */
-export type MatchData = {
-    minValue: number;
-    maxValue: number;
-    minLocation: {
-        x: number;
-        y: number;
-    };
-    maxLocation: {
-        x: number;
-        y: number;
-    };
-};
-export type GetWindowData = (windowName: string) => WindowData;
-export type CaptureWindow = (windowName: string) => Buffer;
-/**
- * The handler to listen to key-down events.
- * @param callback - The callback function to handle key-down events.
- */
-export type KeyDownHandler = (callback: (keyCode: number) => void) => void;
-/**
- * The handler to listen to key-up events.
- * @param callback - The callback function to handle key-up events.
- */
-export type KeyUpHandler = (callback: (keyCode: number) => void) => void;
-/**
- * Function type for moving the mouse.
- */
-export type MouseMove = (posX: number, posY: number) => boolean;
-/**
- * Function type for simulating a mouse click.
- */
-export type MouseClick = (button?: "left" | "middle" | "right") => boolean;
-/**
- * Function type for simulating typing.
- */
-export type TypeString = (stringToType: string, delay?: number) => boolean;
-/**
- * Function type for simulating a mouse drag operation.
- */
-export type MouseDrag = (starX: number, startY: number, endX: Number, endY: number, speed?: number) => boolean;
-/**
- * Represents a point in a two-dimensional space.
- */
-export type Point = [x: number, y: number];
-export type Color = [r: number, g: number, b: number];
-/**
- * Represents a region of interest in an image.
- */
-export type ROI = [x: number, y: number, width: number, height: number];
-export type Imread = (path: string) => ImageData;
-export type Imwrite = (image: ImageData) => Buffer;
-export type MatchTemplate = (image: ImageData, template: ImageData, method?: number | null, mask?: ImageData) => MatchData;
-export type Blur = (image: ImageData, sizeX: number, sizeY: number) => ImageData;
-export type BgrToGray = (image: ImageData) => ImageData;
-export type DrawRectangle = (image: ImageData, start: Point, end: Point, rgb: Color, thickness: number) => ImageData;
-export type GetRegion = (image: ImageData, region: ROI) => ImageData;
-declare const keyDownHandler: KeyDownHandler, keyUpHandler: KeyUpHandler, getWindowData: GetWindowData, captureWindowN: CaptureWindow, mouseMove: MouseMove, mouseClick: MouseClick, mouseDrag: MouseDrag, typeString: TypeString;
-/**
- * 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.
- */
-declare function captureWindow(windowName: string, path: string): boolean;
-export interface KeyListener extends EventEmitter {
-    /**
-     * Event: Fires when a key is pressed down.
-     * @param event - The event name ('keyDown').
-     * @param callback - The callback function to handle the event.
-     */
-    on(event: "keyDown", callback: (data: {
-        keyCode: number;
-        keyName: string;
-    }) => void): this;
-    /**
-     * Event: Fires when a key is released.
-     * @param event - The event name ('keyUp').
-     * @param callback - The callback function to handle the event.
-     */
-    on(event: "keyUp", callback: (data: {
-        keyCode: number;
-        keyName: string;
-    }) => void): this;
-}
-/**
- * Represents a class to listen to keyboard events.
- * @extends EventEmitter
- */
-export declare class KeyListener extends EventEmitter {
-    constructor();
-}
-/**
- * Represents the OpenCV class that provides image processing functionality.
- */
-export declare class OpenCV {
-    imageData: ImageData;
-    /**
-     * Represents the OpenCV class that provides image processing functionality.
-     */
-    constructor(image: string | ImageData);
-    /**
-     * The width of the image.
-     */
-    get width(): number;
-    /**
-     * The height of the image.
-     */
-    get height(): number;
-    /**
-     * 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: ImageData, method?: number | null, mask?: ImageData): MatchData;
-    /**
-     * 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: number, sizeY: number): OpenCV;
-    /**
-     * Converts the image from BGR to grayscale.
-     * @returns A new OpenCV instance with the grayscale image data.
-     */
-    bgrToGray(): OpenCV;
-    /**
-     * 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: Point, end: Point, rgb: Color, thickness: number): OpenCV;
-    /**
-     * 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: ROI): OpenCV;
-    /**
-     * Writes the image data to a file.
-     * @param path - The file path to save the image.
-     */
-    imwrite(path: string): void;
-}
-export { keyDownHandler, keyUpHandler, getWindowData, captureWindow, captureWindowN, mouseMove, mouseClick, mouseDrag, typeString, };
+import EventEmitter = require("events");
+import { KeyCodeHelper } from "./keyCodes";
+/**
+ * Represents the data of a window.
+ */
+export type WindowData = {
+    width: number;
+    height: number;
+    x: number;
+    y: number;
+};
+/**
+ * Represents the data of an image.
+ */
+export type ImageData = {
+    width: number;
+    height: number;
+    data: Uint8Array;
+};
+/**
+ * Represents the result of a template matching operation.
+ */
+export type MatchData = {
+    minValue: number;
+    maxValue: number;
+    minLocation: {
+        x: number;
+        y: number;
+    };
+    maxLocation: {
+        x: number;
+        y: number;
+    };
+};
+export type GetWindowData = (windowName: string) => WindowData;
+export type CaptureWindow = (windowName: string) => Buffer;
+/**
+ * The handler to listen to key-down events.
+ * @param callback - The callback function to handle key-down events.
+ */
+export type KeyDownHandler = (callback: (keyCode: number) => void) => void;
+/**
+ * The handler to listen to key-up events.
+ * @param callback - The callback function to handle key-up events.
+ */
+export type KeyUpHandler = (callback: (keyCode: number) => void) => void;
+/**
+ * Function type for moving the mouse.
+ */
+export type MouseMove = (posX: number, posY: number) => boolean;
+/**
+ * Function type for simulating a mouse click.
+ */
+export type MouseClick = (button?: "left" | "middle" | "right") => boolean;
+/**
+ * Function type for simulating typing.
+ */
+export type TypeString = (stringToType: string, delay?: number) => boolean;
+/**
+ * Function type for simulating key press and release.
+ */
+export type PressKey = (keyCode: number) => boolean;
+/**
+ * Function type for simulating a mouse drag operation.
+ */
+export type MouseDrag = (starX: number, startY: number, endX: Number, endY: number, speed?: number) => boolean;
+/**
+ * Represents a point in a two-dimensional space.
+ */
+export type Point = [x: number, y: number];
+export type Color = [r: number, g: number, b: number];
+/**
+ * Represents a region of interest in an image.
+ */
+export type ROI = [x: number, y: number, width: number, height: number];
+export type Imread = (path: string) => ImageData;
+export type Imwrite = (image: ImageData) => Buffer;
+export type MatchTemplate = (image: ImageData, template: ImageData, method?: number | null, mask?: ImageData) => MatchData;
+export type Blur = (image: ImageData, sizeX: number, sizeY: number) => ImageData;
+export type BgrToGray = (image: ImageData) => ImageData;
+export type DrawRectangle = (image: ImageData, start: Point, end: Point, rgb: Color, thickness: number) => ImageData;
+export type GetRegion = (image: ImageData, region: ROI) => ImageData;
+declare const keyDownHandler: KeyDownHandler, keyUpHandler: KeyUpHandler, getWindowData: GetWindowData, captureWindowN: CaptureWindow, mouseMove: MouseMove, mouseClick: MouseClick, mouseDrag: MouseDrag, typeString: TypeString;
+declare 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.
+ */
+declare function captureWindow(windowName: string, path: string): boolean;
+export interface KeyListener extends EventEmitter {
+    /**
+     * Event: Fires when a key is pressed down.
+     * @param event - The event name ('keyDown').
+     * @param callback - The callback function to handle the event.
+     */
+    on(event: "keyDown", callback: (data: {
+        keyCode: number;
+        keyName: string;
+    }) => void): this;
+    /**
+     * Event: Fires when a key is released.
+     * @param event - The event name ('keyUp').
+     * @param callback - The callback function to handle the event.
+     */
+    on(event: "keyUp", callback: (data: {
+        keyCode: number;
+        keyName: string;
+    }) => void): this;
+}
+/**
+ * Represents a class to listen to keyboard events.
+ * @extends EventEmitter
+ */
+export declare class KeyListener extends EventEmitter {
+    constructor();
+}
+/**
+ * Represents the OpenCV class that provides image processing functionality.
+ */
+export declare class OpenCV {
+    imageData: ImageData;
+    /**
+     * Represents the OpenCV class that provides image processing functionality.
+     */
+    constructor(image: string | ImageData);
+    /**
+     * The width of the image.
+     */
+    get width(): number;
+    /**
+     * The height of the image.
+     */
+    get height(): number;
+    /**
+     * 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: ImageData, method?: number | null, mask?: ImageData): MatchData;
+    /**
+     * 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: number, sizeY: number): OpenCV;
+    /**
+     * Converts the image from BGR to grayscale.
+     * @returns A new OpenCV instance with the grayscale image data.
+     */
+    bgrToGray(): OpenCV;
+    /**
+     * 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: Point, end: Point, rgb: Color, thickness: number): OpenCV;
+    /**
+     * 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: ROI): OpenCV;
+    /**
+     * Writes the image data to a file.
+     * @param path - The file path to save the image.
+     */
+    imwrite(path: string): void;
+}
+declare function keyPress(keyCode: number, repeat?: number): Promise<boolean>;
+export { keyDownHandler, keyUpHandler, getWindowData, captureWindow, captureWindowN, mouseMove, mouseClick, mouseDrag, typeString, keyPress, rawPressKey, KeyCodeHelper };