@asdf-overlay/core 1.2.4 → 2.0.0

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@asdf-overlay/core",
-  "version": "1.2.4",
+  "version": "2.0.0",
   "description": "Asdf overlay core Node addon",
-  "main": "./lib/index.js",
-  "type": "module",
-  "author": "storycraft <storycraft@pancake.sh>",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "author": "storycraft <me@pancake.sh>",
   "homepage": "https://github.com/storycraft/asdf-overlay#readme",
   "license": "MIT OR Apache-2.0",
   "bugs": {
@@ -21,34 +21,37 @@
     "x64",
     "arm64"
   ],
-  "exports": {
-    ".": {
-      "types": "./lib/index.d.ts",
-      "default": "./lib/index.js"
-    },
-    "./*": {
-      "types": "./lib/*.d.ts",
-      "default": "./lib/*.js"
-    }
-  },
-  "types": "./lib/index.d.ts",
   "files": [
-    "lib/**/*",
-    "addon-x64.node",
-    "addon-aarch64.node",
+    "index.js",
+    "index.d.ts",
+    "native.js",
+    "native.d.ts",
+    "addon.win32-arm64-msvc.node",
+    "addon.win32-ia32-msvc.node",
+    "addon.win32-x64-msvc.node",
+    "asdf_overlay-aarch64.dll",
     "asdf_overlay-x64.dll",
-    "asdf_overlay-x86.dll",
-    "asdf_overlay-aarch64.dll"
+    "asdf_overlay-x86.dll"
   ],
+  "napi": {
+    "binaryName": "addon",
+    "targets": [
+      "aarch64-pc-windows-msvc",
+      "i686-pc-windows-msvc",
+      "x86_64-pc-windows-msvc"
+    ]
+  },
+  "engines": {
+    "node": ">= 12.22.0 < 13 || >= 14.17.0 < 15 || >= 15.12.0 < 16 || >= 16.0.0"
+  },
   "devDependencies": {
-    "@types/node": "^25.6.0",
-    "typescript": "^6.0.3"
+    "@napi-rs/cli": "^3.2.0",
+    "@types/node": "^22.13.14"
   },
   "scripts": {
-    "build-dll": "cargo xtask build-dll --",
-    "cargo-build": "cargo xtask build-node --",
-    "build:debug": "npm run cargo-build && npm run build-dll && tsc",
-    "build:dist": "tsc",
-    "build": "npm run cargo-build -- --release && npm run build-dll -- --release && npm run build:dist"
+    "build:addon": "node build.mjs",
+    "build:dll": "cargo xtask build-dll --",
+    "build": "npm run build:dll -- --release && npm run build:addon -- --release",
+    "build:debug": "npm run build:dll && npm run build:addon"
   }
 }

package/lib/addon.d.ts

@@ -1,18 +0,0 @@
-import { OverlayEventEmitter } from './index.js';
-import { CopyRect, Cursor, PercentLength, type GpuLuid, type UpdateSharedHandle } from './types.js';
-export type Addon = {
-    attach(dllDir: string, pid: number, timeout?: number): Promise<unknown>;
-    overlaySetPosition(id: unknown, winId: number, x: PercentLength, y: PercentLength): Promise<void>;
-    overlaySetAnchor(id: unknown, winId: number, x: PercentLength, y: PercentLength): Promise<void>;
-    overlaySetMargin(id: unknown, winId: number, top: PercentLength, right: PercentLength, bottom: PercentLength, left: PercentLength): Promise<void>;
-    overlayUpdateHandle(id: unknown, winId: number, update: UpdateSharedHandle): Promise<void>;
-    overlayListenInput(id: unknown, winId: number, cursor: boolean, keyboard: boolean): Promise<void>;
-    overlayBlockInput(id: unknown, winId: number, block: boolean): Promise<void>;
-    overlaySetBlockingCursor(id: unknown, winId: number, cursor?: Cursor): Promise<void>;
-    overlayCallNextEvent(id: unknown, emitter: OverlayEventEmitter, emit: OverlayEventEmitter['emit']): Promise<boolean>;
-    overlayDestroy(id: unknown): void;
-    surfaceCreate(luid: GpuLuid): unknown;
-    surfaceClear(id: unknown): void;
-    surfaceUpdateBitmap(id: unknown, width: number, data: Buffer): UpdateSharedHandle | null;
-    surfaceUpdateShtex(id: unknown, width: number, height: number, handle: Buffer, rect?: CopyRect): UpdateSharedHandle | null;
-};

package/lib/addon.js

@@ -1 +0,0 @@
-export {};

package/lib/index.d.ts

@@ -1,151 +0,0 @@
-import { EventEmitter } from 'node:events';
-import { CursorInput, KeyboardInput } from './input.js';
-import { PercentLength, CopyRect, Cursor, type UpdateSharedHandle, type GpuLuid } from './types.js';
-export * from './types.js';
-export * from './util.js';
-/**
- * Unique symbol for accessing internal id
- */
-declare const idSym: unique symbol;
-export type OverlayEventEmitter = EventEmitter<{
-    /**
-     * A window has been added.
-     */
-    added: [id: number, width: number, height: number, luid: GpuLuid];
-    /**
-     * A window has been resized.
-     */
-    resized: [id: number, width: number, height: number];
-    /**
-     * Cursor input from a window.
-     */
-    cursor_input: [id: number, input: CursorInput];
-    /**
-     * Keyboard input from a window.
-     */
-    keyboard_input: [id: number, input: KeyboardInput];
-    /**
-     * Input blocking to a window is interrupted and turned off.
-     */
-    input_blocking_ended: [id: number];
-    /**
-     * Window is destroyed.
-     */
-    destroyed: [id: number];
-    /**
-     * An error has occured on ipc connection.
-     */
-    error: [err: unknown];
-    /**
-     * Ipc disconnected.
-     */
-    disconnected: [];
-}>;
-export declare class Overlay {
-    readonly event: OverlayEventEmitter;
-    readonly [idSym]: unknown;
-    private destroyed;
-    private constructor();
-    /**
-     * Update overlay position relative to window
-     * @param id target window id
-     * @param x x position
-     * @param y y position
-     */
-    setPosition(id: number, x: PercentLength, y: PercentLength): Promise<void>;
-    /**
-     * Update overlay anchor
-     * @param id target window id
-     * @param x x anchor
-     * @param y y anchor
-     */
-    setAnchor(id: number, x: PercentLength, y: PercentLength): Promise<void>;
-    /**
-     * Update overlay margin
-     * @param id target window id
-     * @param top top margin
-     * @param right right margin
-     * @param bottom bottom margin
-     * @param left left margin
-     */
-    setMargin(id: number, top: PercentLength, right: PercentLength, bottom: PercentLength, left: PercentLength): Promise<void>;
-    /**
-     * Listen to window input without blocking
-     * @param id target window id
-     * @param cursor listen cursor input or not
-     * @param keyboard listen keyboard input or not
-     */
-    listenInput(id: number, cursor: boolean, keyboard: boolean): Promise<void>;
-    /**
-     * Block window input and listen them
-     * @param id target window id
-     * @param block set true to block input, false to release
-     */
-    blockInput(id: number, block: boolean): Promise<void>;
-    /**
-     * Set cursor while in input blocking mode
-     * @param id target window id
-     * @param cursor cursor to set. Do not supply this value to hide cursor.
-     */
-    setBlockingCursor(id: number, cursor?: Cursor): Promise<void>;
-    /**
-     * Update overlay surface.
-     * @param id target window id
-     * @param update shared handle update
-     */
-    updateHandle(id: number, update: UpdateSharedHandle): Promise<void>;
-    /**
-     * Destroy overlay
-     */
-    destroy(): void;
-    /**
-     * Attach overlay to target process
-     *
-     * Name must be unique or it will fail if there is a connection with same name
-     * @param dllDir path to dlls
-     * @param pid target process pid
-     * @param timeout Timeout for injection, in milliseconds. Will wait indefinitely if not provided.
-     * @returns new {@link Overlay} object
-     */
-    static attach(dllDir: string, pid: number, timeout?: number): Promise<Overlay>;
-}
-/**
- * Represent a surface for overlay.
- */
-export declare class OverlaySurface {
-    readonly [idSym]: unknown;
-    private constructor();
-    /**
-     * Update surface using bitmap buffer. The size of overlay is `width x (data.byteLength / 4 / width)`
-     * @param width width of the bitmap
-     * @param data bgra formatted bitmap
-     */
-    updateBitmap(width: number, data: Buffer): UpdateSharedHandle | null;
-    /**
-     * Update surface using D3D11 shared texture.
-     * @param width width of the surface
-     * @param height height of the surface
-     * @param handle NT Handle of shared D3D11 Texture
-     * @param rect Area to update
-     */
-    updateShtex(width: number, height: number, handle: Buffer, rect?: CopyRect): UpdateSharedHandle | null;
-    /**
-     * Clear the surface.
-     */
-    clear(): void;
-    /**
-     * @deprecated Do not need to be called.
-     *
-     * Destroy the surface.
-     */
-    destroy(): void;
-    /**
-     * Create a new overlay surface.
-     * @param luid The GPU LUID for surface textures.
-     */
-    static create(luid: GpuLuid): OverlaySurface;
-}
-/**
- * Default dll directory path
- */
-export declare function defaultDllDir(): string;

package/lib/index.js

@@ -1,202 +0,0 @@
-import path from 'node:path';
-import { arch } from 'node:process';
-import { fileURLToPath } from 'node:url';
-import { EventEmitter } from 'node:events';
-export * from './types.js';
-export * from './util.js';
-/**
- * Global node addon instance
- */
-const addon = loadAddon();
-/**
- * Load node addon depending on system architecture.
- */
-function loadAddon() {
-    const nodeModule = { exports: {} };
-    let name;
-    switch (arch) {
-        case 'arm64': {
-            name = '../addon-aarch64.node';
-            break;
-        }
-        case 'x64': {
-            name = '../addon-x64.node';
-            break;
-        }
-        default: throw new Error(`Unsupported arch: ${arch}`);
-    }
-    process.dlopen(nodeModule, path.resolve(path.dirname(fileURLToPath(new URL(import.meta.url))), name));
-    return nodeModule.exports;
-}
-/**
- * Unique symbol for accessing internal id
- */
-const idSym = Symbol('id');
-export class Overlay {
-    event = new EventEmitter();
-    [idSym];
-    destroyed = false;
-    constructor(id) {
-        this[idSym] = id;
-        void (async () => {
-            // wait until next tick so no events are lost
-            await new Promise((resolve) => {
-                process.nextTick(resolve);
-            });
-            try {
-                for (;;) {
-                    const hasNext = await addon.overlayCallNextEvent(id, this.event, (name, ...args) => this.event.emit(name, ...args));
-                    if (!hasNext)
-                        break;
-                }
-            }
-            catch (err) {
-                if (this.event.listenerCount('error') != 0) {
-                    this.event.emit('error', err);
-                }
-                else {
-                    throw err;
-                }
-            }
-            finally {
-                this.destroy();
-            }
-        })();
-    }
-    /**
-     * Update overlay position relative to window
-     * @param id target window id
-     * @param x x position
-     * @param y y position
-     */
-    async setPosition(id, x, y) {
-        await addon.overlaySetPosition(this[idSym], id, x, y);
-    }
-    /**
-     * Update overlay anchor
-     * @param id target window id
-     * @param x x anchor
-     * @param y y anchor
-     */
-    async setAnchor(id, x, y) {
-        await addon.overlaySetAnchor(this[idSym], id, x, y);
-    }
-    /**
-     * Update overlay margin
-     * @param id target window id
-     * @param top top margin
-     * @param right right margin
-     * @param bottom bottom margin
-     * @param left left margin
-     */
-    async setMargin(id, top, right, bottom, left) {
-        await addon.overlaySetMargin(this[idSym], id, top, right, bottom, left);
-    }
-    /**
-     * Listen to window input without blocking
-     * @param id target window id
-     * @param cursor listen cursor input or not
-     * @param keyboard listen keyboard input or not
-     */
-    async listenInput(id, cursor, keyboard) {
-        await addon.overlayListenInput(this[idSym], id, cursor, keyboard);
-    }
-    /**
-     * Block window input and listen them
-     * @param id target window id
-     * @param block set true to block input, false to release
-     */
-    async blockInput(id, block) {
-        await addon.overlayBlockInput(this[idSym], id, block);
-    }
-    /**
-     * Set cursor while in input blocking mode
-     * @param id target window id
-     * @param cursor cursor to set. Do not supply this value to hide cursor.
-     */
-    async setBlockingCursor(id, cursor) {
-        await addon.overlaySetBlockingCursor(this[idSym], id, cursor);
-    }
-    /**
-     * Update overlay surface.
-     * @param id target window id
-     * @param update shared handle update
-     */
-    async updateHandle(id, update) {
-        await addon.overlayUpdateHandle(this[idSym], id, update);
-    }
-    /**
-     * Destroy overlay
-     */
-    destroy() {
-        if (this.destroyed)
-            return;
-        this.destroyed = true;
-        addon.overlayDestroy(this[idSym]);
-        this.event.emit('disconnected');
-    }
-    /**
-     * Attach overlay to target process
-     *
-     * Name must be unique or it will fail if there is a connection with same name
-     * @param dllDir path to dlls
-     * @param pid target process pid
-     * @param timeout Timeout for injection, in milliseconds. Will wait indefinitely if not provided.
-     * @returns new {@link Overlay} object
-     */
-    static async attach(dllDir, pid, timeout) {
-        return new Overlay(await addon.attach(dllDir, pid, timeout));
-    }
-}
-/**
- * Represent a surface for overlay.
- */
-export class OverlaySurface {
-    [idSym];
-    constructor(id) {
-        this[idSym] = id;
-    }
-    /**
-     * Update surface using bitmap buffer. The size of overlay is `width x (data.byteLength / 4 / width)`
-     * @param width width of the bitmap
-     * @param data bgra formatted bitmap
-     */
-    updateBitmap(width, data) {
-        return addon.surfaceUpdateBitmap(this[idSym], width, data);
-    }
-    /**
-     * Update surface using D3D11 shared texture.
-     * @param width width of the surface
-     * @param height height of the surface
-     * @param handle NT Handle of shared D3D11 Texture
-     * @param rect Area to update
-     */
-    updateShtex(width, height, handle, rect) {
-        return addon.surfaceUpdateShtex(this[idSym], width, height, handle, rect);
-    }
-    /**
-     * Clear the surface.
-     */
-    clear() {
-        addon.surfaceClear(this[idSym]);
-    }
-    /**
-     * @deprecated Do not need to be called.
-     *
-     * Destroy the surface.
-     */
-    destroy() { }
-    /**
-     * Create a new overlay surface.
-     * @param luid The GPU LUID for surface textures.
-     */
-    static create(luid) {
-        return new OverlaySurface(addon.surfaceCreate(luid));
-    }
-}
-/**
- * Default dll directory path
- */
-export function defaultDllDir() {
-    return path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../');
-}

package/lib/input.d.ts

@@ -1,240 +0,0 @@
-import { Key } from './index.js';
-/**
- * Describe a cursor input.
- */
-export type CursorInput = {
-    /**
-     * X position relative to overlay surface.
-     */
-    clientX: number;
-    /**
-     * Y position relative to overlay surface.
-     */
-    clientY: number;
-    /**
-     * X position relative to window.
-     */
-    windowX: number;
-    /**
-     * Y position relative to window.
-     */
-    windowY: number;
-} & ({
-    /**
-     * Cursor has entered to a window.
-     */
-    kind: 'Enter';
-} | {
-    /**
-     * Cursor left a window.
-     */
-    kind: 'Leave';
-} | {
-    /**
-     * Cursor button is pressed.
-     */
-    kind: 'Action';
-    /**
-     * Cursor button input state.
-     */
-    state: InputState;
-    /**
-     * True if `state` is `Pressed` and the button is secondly pressed within system double click time.
-     */
-    doubleClick: boolean;
-    /**
-     * Pressed cursor button.
-     */
-    action: CursorAction;
-} | {
-    /**
-     * Cursor moved.
-     */
-    kind: 'Move';
-} | {
-    /**
-     * Cursor scrolled.
-     */
-    kind: 'Scroll';
-    /**
-     * Scroll axis.
-     */
-    axis: ScrollAxis;
-    /**
-     * Scroll tick delta.
-     */
-    delta: number;
-});
-/**
- * Describe a keyboard input.
- */
-export type KeyboardInput = {
-    /**
-     * A key is pressed or released.
-     */
-    kind: 'Key';
-    /**
-     * Keyboard key without considering keyboard layout.
-     */
-    key: Key;
-    /**
-     * Keyboard key input state.
-     */
-    state: InputState;
-} | {
-    /**
-     * A character input due to a key press without involving IME.
-     */
-    kind: 'Char';
-    /**
-     * Input character (1 character).
-     */
-    ch: string;
-} | {
-    /**
-     * IME related event.
-     */
-    kind: 'Ime';
-    /**
-     * An IME event.
-     */
-    ime: Ime;
-};
-/**
- * Describe a IME event.
- */
-export type Ime = {
-    /**
-     * IME is enabled due to window focus or etc.
-     */
-    kind: 'Enabled';
-    /**
-     * Initial IME language in ETF language tag(BCP 47) format.
-     */
-    lang: string;
-    /**
-     * Initial IME conversion mode.
-     */
-    conversion: ImeConversion;
-} | {
-    /**
-     * IME language is changed.
-     */
-    kind: 'Changed';
-    /**
-     * Changed IME language.
-     */
-    lang: string;
-} | {
-    /**
-     * IME conversion mode is changed.
-     */
-    kind: 'ChangedConversion';
-    /**
-     * Changed IME conversion mode.
-     */
-    conversion: ImeConversion;
-} | {
-    /**
-     * IME candidate is added/updated.
-     *
-     * The sent candidates are only valid until another `CandidateChanged` or `CandidateClosed` event.
-     */
-    kind: 'CandidateChanged';
-    list: ImeCandidateList;
-} | {
-    /**
-     * IME candidate window is closed.
-     */
-    kind: 'CandidateClosed';
-} | {
-    /**
-     * IME is composing text.
-     */
-    kind: 'Compose';
-    /**
-     * Composing text.
-     */
-    text: string;
-    /**
-     * Current caret index in composing text.
-     */
-    caret: number;
-} | {
-    /**
-     * IME commits text.
-     *
-     * This event should clear prior composing text.
-     */
-    kind: 'Commit';
-    /**
-     * Composed text.
-     */
-    text: string;
-} | {
-    /**
-     * IME is disabled due to losing focus or etc.
-     */
-    kind: 'Disabled';
-};
-/**
- * IME candidate list.
- */
-export type ImeCandidateList = {
-    /**
-     * Start index of current page.
-     */
-    pageStartIndex: number;
-    /**
-     * Count of candidate item per page.
-     */
-    pageSize: number;
-    /**
-     * Currently selected candidate index.
-     */
-    selectedIndex: number;
-    /**
-     * Candidate list.
-     */
-    candidates: string[];
-};
-/**
- * IME conversion bit flags.
- *
- * There can be multiple flag set.
- */
-export declare enum ImeConversion {
-    None = 0,
-    /**
-     * IME converts to native langauge.
-     */
-    Native = 1,
-    /**
-     * IME composes in full-width characters.
-     */
-    Fullshape = 2,
-    /**
-     * Conversion is disabled.
-     */
-    NoConversion = 4,
-    /**
-     * Converting to hanja.
-     */
-    HanjaConvert = 8,
-    /**
-     * Converting to katakana.
-     */
-    Katakana = 16
-}
-/**
- * Key input state.
- */
-export type InputState = 'Pressed' | 'Released';
-/**
- * Cursor buttons.
- */
-export type CursorAction = 'Left' | 'Right' | 'Middle' | 'Back' | 'Forward';
-/**
- * Cursor scroll axis.
- */
-export type ScrollAxis = 'X' | 'Y';