@asdf-overlay/core 0.9.0 → 0.9.1

package/lib/index.d.ts

@@ -3,15 +3,42 @@ import { CursorInput, KeyboardInput } from './input.js';
 import { PercentLength, CopyRect, Cursor } 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];
+    /**
+     * 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 {

package/lib/index.js

@@ -4,7 +4,13 @@ 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;
@@ -22,6 +28,9 @@ function loadAddon() {
     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();

package/lib/input.d.ts

@@ -1,82 +1,240 @@
 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
+     * 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;
     /**
-     * Key input state
+     * 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';
-    /** ETF language tag(BCP 47) */
+    /**
+     * 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[];
 };
-export declare const enum ImeConversion {
+/**
+ * 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';

package/lib/input.js

@@ -1,9 +1,29 @@
+/**
+ * IME conversion bit flags.
+ *
+ * There can be multiple flag set.
+ */
 export var ImeConversion;
 (function (ImeConversion) {
     ImeConversion[ImeConversion["None"] = 0] = "None";
+    /**
+     * IME converts to native langauge.
+     */
     ImeConversion[ImeConversion["Native"] = 1] = "Native";
+    /**
+     * IME composes in full-width characters.
+     */
     ImeConversion[ImeConversion["Fullshape"] = 2] = "Fullshape";
+    /**
+     * Conversion is disabled.
+     */
     ImeConversion[ImeConversion["NoConversion"] = 4] = "NoConversion";
+    /**
+     * Converting to hanja.
+     */
     ImeConversion[ImeConversion["HanjaConvert"] = 8] = "HanjaConvert";
+    /**
+     * Converting to katakana.
+     */
     ImeConversion[ImeConversion["Katakana"] = 16] = "Katakana";
 })(ImeConversion || (ImeConversion = {}));

package/lib/types.d.ts

@@ -1,28 +1,66 @@
+/**
+ * A length which can be expressed in absolute or relative percent.
+ */
 export type PercentLength = {
     ty: 'percent' | 'length';
     value: number;
 };
+/**
+ * Describe a rectangle when copying from source to destination.
+ */
 export type CopyRect = {
+    /**
+     * Destination X position.
+     */
     dstX: number;
+    /**
+     * Destination Y position.
+     */
     dstY: number;
+    /**
+     * Source rectangle.
+     */
     src: Rect;
 };
+/**
+ * Describe a Reactangle.
+ */
 export type Rect = {
+    /**
+     * X position.
+     */
     x: number;
+    /**
+     * Y position.
+     */
     y: number;
+    /**
+     * Width of the Rectangle.
+     */
     width: number;
+    /**
+     * Height of the Rectangle.
+     */
     height: number;
 };
+/**
+ * A keyboard key.
+ */
 export type Key = {
     /**
-     * Windows virtual key code
+     * Windows virtual key code.
      */
     code: number;
     /**
-     * Extended flag
+     * Extended flag.
+     *
+     * True for right key variant (e.g. Right shift), or Numpad variant (e.g. NumPad 1)
      */
     extended: boolean;
 };
+/**
+ * Describe a cursor type.
+ */
 export declare enum Cursor {
     Default = 0,
     Help = 1,

package/lib/types.js

@@ -1,3 +1,6 @@
+/**
+ * Describe a cursor type.
+ */
 export var Cursor;
 (function (Cursor) {
     Cursor[Cursor["Default"] = 0] = "Default";
@@ -29,7 +32,7 @@ export var Cursor;
     Cursor[Cursor["Person"] = 25] = "Person";
     Cursor[Cursor["Pen"] = 26] = "Pen";
     Cursor[Cursor["Cd"] = 27] = "Cd";
-    // panning
+    // Panning cursors
     Cursor[Cursor["PanMiddle"] = 28] = "PanMiddle";
     Cursor[Cursor["PanMiddleHorizontal"] = 29] = "PanMiddleHorizontal";
     Cursor[Cursor["PanMiddleVertical"] = 30] = "PanMiddleVertical";

package/lib/util.d.ts

@@ -1,4 +1,13 @@
 import { Key, PercentLength } from './index.js';
+/**
+ * Utility function to create `PercentLength` using percent relative value.
+ */
 export declare function percent(value: number): PercentLength;
+/**
+ * Utilty function to create `PercentLength` using absolute length value.
+ */
 export declare function length(value: number): PercentLength;
+/**
+ * Utility function to create `Key` using key code and optional extended flag.
+ */
 export declare function key(code: number, extended?: boolean): Key;

package/lib/util.js

@@ -1,15 +1,24 @@
+/**
+ * Utility function to create `PercentLength` using percent relative value.
+ */
 export function percent(value) {
     return {
         ty: 'percent',
         value,
     };
 }
+/**
+ * Utilty function to create `PercentLength` using absolute length value.
+ */
 export function length(value) {
     return {
         ty: 'length',
         value,
     };
 }
+/**
+ * Utility function to create `Key` using key code and optional extended flag.
+ */
 export function key(code, extended = false) {
     return {
         code,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asdf-overlay/core",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Asdf overlay core Node addon",
   "main": "./lib/index.js",
   "type": "module",