@asdf-overlay/electron 0.9.0 → 0.9.2

package/lib/index.d.ts

@@ -1,7 +1,14 @@
 import type { Overlay } from '@asdf-overlay/core';
-export * from './input/index.js';
-export * from './surface.js';
+/**
+ * Describe a window in `Overlay`.
+ */
 export type OverlayWindow = {
+    /**
+     * Associated `Overlay` instance.
+     */
     overlay: Overlay;
+    /**
+     * Window id.
+     */
     id: number;
 };

package/lib/index.js

@@ -1,2 +1 @@
-export * from './input/index.js';
-export * from './surface.js';
+export {};

package/lib/input/conv.d.ts

@@ -1,3 +1,17 @@
 import { Cursor } from '@asdf-overlay/core';
-export declare function toCursor(cursor: string): Cursor | undefined;
-export declare const KEYS: Record<number, string | undefined>;
+/**
+ * Map CSS cursor into overlay `Cursor`.
+ *
+ * Invalid CSS cursors will be mapped to `Default`.
+ *
+ * @see https://developer.mozilla.org/ko/docs/Web/CSS/cursor
+ * @see https://www.electronjs.org/docs/latest/api/web-contents
+ */
+export declare function mapCssCursor(cursor: string): Cursor | undefined;
+/**
+ * Map Windows virtual key code into Electron accelerator keycode.
+ *
+ * @see https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes
+ * @see https://www.electronjs.org/docs/latest/api/accelerator
+ */
+export declare function mapKeycode(code: number): string | undefined;

package/lib/input/conv.js

@@ -1,7 +1,13 @@
 import { Cursor } from '@asdf-overlay/core';
-// https://www.electronjs.org/docs/latest/api/web-contents
-// https://developer.mozilla.org/ko/docs/Web/CSS/cursor
-export function toCursor(cursor) {
+/**
+ * Map CSS cursor into overlay `Cursor`.
+ *
+ * Invalid CSS cursors will be mapped to `Default`.
+ *
+ * @see https://developer.mozilla.org/ko/docs/Web/CSS/cursor
+ * @see https://www.electronjs.org/docs/latest/api/web-contents
+ */
+export function mapCssCursor(cursor) {
     switch (cursor) {
         case 'pointer': return Cursor.Default;
         case 'crosshair': return Cursor.Crosshair;
@@ -50,9 +56,19 @@ export function toCursor(cursor) {
         default: return Cursor.Default;
     }
 }
-// As per https://www.electronjs.org/docs/latest/api/accelerator
-// and https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes
-export const KEYS = {
+/**
+ * Map Windows virtual key code into Electron accelerator keycode.
+ *
+ * @see https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes
+ * @see https://www.electronjs.org/docs/latest/api/accelerator
+ */
+export function mapKeycode(code) {
+    return KEYS[code];
+}
+/**
+ * Conversion map from windows keycode to Electron accelerator keycode.
+ */
+const KEYS = {
     8: 'Backspace',
     9: 'Tab',
     13: 'Enter',
@@ -111,6 +127,21 @@ export const KEYS = {
     91: 'Super',
     92: 'Super',
     93: 'Meta',
+    96: 'num0',
+    97: 'num1',
+    98: 'num2',
+    99: 'num3',
+    100: 'num4',
+    101: 'num5',
+    102: 'num6',
+    103: 'num7',
+    104: 'num8',
+    105: 'num9',
+    106: 'nummult',
+    108: 'numsub',
+    109: 'numsub',
+    110: 'numdec',
+    111: 'numdiv',
     112: 'F1',
     113: 'F2',
     114: 'F3',

package/lib/{input/index.d.ts → input.d.ts}

@@ -1,15 +1,23 @@
 import type { WebContents } from 'electron';
-import type { OverlayWindow } from '../index.js';
+import type { OverlayWindow } from './index.js';
 import type { CursorInput, KeyboardInput } from '@asdf-overlay/core/input';
+/**
+ * Connection from a overlay window to a Electron window.
+ */
 export declare class ElectronOverlayInput {
     private readonly window;
     private readonly contents;
     private readonly cursorInputHandler;
     private readonly keyboardInputHandler;
     private readonly cursorChangedHandler;
-    forwardInput: boolean;
     private constructor();
+    /**
+     * Connect overlay inputs to a Electron `WebContents`.
+     */
     static connect(window: OverlayWindow, contents: WebContents): ElectronOverlayInput;
+    /**
+     * Disconnect overlay inputs.
+     */
     disconnect(): Promise<void>;
     private readonly clickCounts;
     private processCursorAction;
@@ -20,5 +28,4 @@ export declare class ElectronOverlayInput {
     private updateModifiers;
     sendKeyboardInput(input: KeyboardInput): void;
     private processIme;
-    private sendInput;
 }

package/lib/{input/index.js → input.js}

@@ -1,12 +1,14 @@
-import { KEYS, toCursor } from './conv.js';
+import { mapCssCursor, mapKeycode } from './input/conv.js';
 import { Cursor } from '@asdf-overlay/core';
+/**
+ * Connection from a overlay window to a Electron window.
+ */
 export class ElectronOverlayInput {
     window;
     contents;
     cursorInputHandler;
     keyboardInputHandler;
     cursorChangedHandler;
-    forwardInput = false;
     constructor(window, contents) {
         this.window = window;
         this.contents = contents;
@@ -24,12 +26,18 @@ export class ElectronOverlayInput {
             this.sendKeyboardInput(input);
         });
         this.contents.on('cursor-changed', this.cursorChangedHandler = (_, type) => {
-            void this.window.overlay.setBlockingCursor(this.window.id, toCursor(type));
+            void this.window.overlay.setBlockingCursor(this.window.id, mapCssCursor(type));
         });
     }
+    /**
+     * Connect overlay inputs to a Electron `WebContents`.
+     */
     static connect(window, contents) {
         return new ElectronOverlayInput({ ...window }, contents);
     }
+    /**
+     * Disconnect overlay inputs.
+     */
     async disconnect() {
         this.window.overlay.event.off('cursor_input', this.cursorInputHandler);
         this.window.overlay.event.off('keyboard_input', this.keyboardInputHandler);
@@ -69,7 +77,7 @@ export class ElectronOverlayInput {
         if (input.state === 'Pressed') {
             const clickCount = 1 + ~~input.doubleClick;
             this.clickCounts.push(clickCount);
-            this.sendInput({
+            this.contents.sendInputEvent({
                 type: 'mouseDown',
                 button,
                 clickCount,
@@ -84,7 +92,7 @@ export class ElectronOverlayInput {
         }
         else {
             const clickCount = this.clickCounts.pop() ?? 1;
-            this.sendInput({
+            this.contents.sendInputEvent({
                 type: 'mouseUp',
                 button,
                 clickCount,
@@ -107,7 +115,7 @@ export class ElectronOverlayInput {
         const movementY = input.windowY - this.lastWindowCursor.y;
         switch (input.kind) {
             case 'Enter': {
-                this.sendInput({
+                this.contents.sendInputEvent({
                     type: 'mouseEnter',
                     x: input.clientX,
                     y: input.clientY,
@@ -120,7 +128,7 @@ export class ElectronOverlayInput {
                 break;
             }
             case 'Leave': {
-                this.sendInput({
+                this.contents.sendInputEvent({
                     type: 'mouseLeave',
                     x: input.clientX,
                     y: input.clientY,
@@ -133,7 +141,7 @@ export class ElectronOverlayInput {
                 break;
             }
             case 'Move': {
-                this.sendInput({
+                this.contents.sendInputEvent({
                     type: 'mouseMove',
                     x: input.clientX,
                     y: input.clientY,
@@ -173,7 +181,7 @@ export class ElectronOverlayInput {
                         modifiers: this.modifiers,
                     };
                 }
-                this.sendInput(scroll);
+                this.contents.sendInputEvent(scroll);
                 break;
             }
             case 'Action': {
@@ -238,13 +246,13 @@ export class ElectronOverlayInput {
     sendKeyboardInput(input) {
         switch (input.kind) {
             case 'Key': {
-                const keyCode = KEYS[input.key.code];
+                const keyCode = mapKeycode(input.key.code);
                 if (!keyCode) {
                     return;
                 }
                 const pressed = input.state === 'Pressed';
                 this.updateModifiers(keyCode, pressed);
-                this.sendInput({
+                this.contents.sendInputEvent({
                     type: pressed ? 'keyDown' : 'keyUp',
                     keyCode,
                     modifiers: this.modifiers,
@@ -252,7 +260,7 @@ export class ElectronOverlayInput {
                 return;
             }
             case 'Char': {
-                this.sendInput({
+                this.contents.sendInputEvent({
                     type: 'char',
                     keyCode: input.ch,
                     modifiers: this.modifiers,
@@ -270,17 +278,11 @@ export class ElectronOverlayInput {
             return;
         }
         for (const ch of input.ime.text) {
-            this.sendInput({
+            this.contents.sendInputEvent({
                 type: 'char',
                 keyCode: ch,
                 modifiers: this.modifiers,
             });
         }
     }
-    sendInput(e) {
-        if (!this.forwardInput) {
-            return;
-        }
-        this.contents.sendInputEvent(e);
-    }
 }

package/lib/surface.d.ts

@@ -2,17 +2,38 @@ import type { WebContents } from 'electron';
 import type { OverlayWindow } from './index.js';
 import EventEmitter from 'node:events';
 type Emitter = EventEmitter<{
+    /**
+     * An error has been occured while copying to overlay surface.
+     */
     error: [e: unknown];
 }>;
+/**
+ * Connection from a Electron offscreen window to a overlay surface.
+ */
 export declare class ElectronOverlaySurface {
     private readonly window;
     private readonly contents;
+    /**
+     * Events during paints.
+     */
     readonly events: Emitter;
     private handler;
     private constructor();
+    /**
+     * Connect Electron `WebContents` surface to target overlay window.
+     */
     static connect(window: OverlayWindow, contents: WebContents): ElectronOverlaySurface;
+    /**
+     * Disconnect surface from Electron window and clear overlay surface.
+     */
     disconnect(): Promise<void>;
+    /**
+     * Copy overlay texture in gpu accelerated shared texture mode.
+     */
     private paintAccelerated;
+    /**
+     * Copy overlay texture from bitmap surface.
+     */
     private paintSoftware;
     private emitError;
 }

package/lib/surface.js

@@ -1,7 +1,13 @@
 import EventEmitter from 'node:events';
+/**
+ * Connection from a Electron offscreen window to a overlay surface.
+ */
 export class ElectronOverlaySurface {
     window;
     contents;
+    /**
+     * Events during paints.
+     */
     events = new EventEmitter();
     handler;
     constructor(window, contents) {
@@ -26,13 +32,22 @@ export class ElectronOverlaySurface {
         contents.on('paint', this.handler);
         contents.invalidate();
     }
+    /**
+     * Connect Electron `WebContents` surface to target overlay window.
+     */
     static connect(window, contents) {
         return new ElectronOverlaySurface({ ...window }, contents);
     }
+    /**
+     * Disconnect surface from Electron window and clear overlay surface.
+     */
     async disconnect() {
         this.contents.off('paint', this.handler);
         await this.window.overlay.clearSurface(this.window.id);
     }
+    /**
+     * Copy overlay texture in gpu accelerated shared texture mode.
+     */
     async paintAccelerated(texture) {
         const rect = texture.metadata.captureUpdateRect ?? texture.contentRect;
         // update only changed part
@@ -47,6 +62,9 @@ export class ElectronOverlaySurface {
             this.emitError(e);
         }
     }
+    /**
+     * Copy overlay texture from bitmap surface.
+     */
     async paintSoftware(_dirtyRect, image) {
         // TODO:: update only changed part
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asdf-overlay/electron",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "Asdf overlay Electron integration",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -15,6 +15,16 @@
     "type": "git",
     "url": "https://github.com/storycraft/asdf-overlay"
   },
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./*": {
+      "types": "./lib/*.d.ts",
+      "default": "./lib/*.js"
+    }
+  },
   "files": [
     "lib/**/*"
   ],
@@ -24,7 +34,7 @@
   },
   "peerDependencies": {
     "electron": "^37.3.1",
-    "@asdf-overlay/core": "0.9.0"
+    "@asdf-overlay/core": "0.9.2"
   },
   "scripts": {
     "build:dist": "tsc",