@illgrenoble/webx-client 0.1.1

package/dist/input/WebXMouse.d.ts

@@ -0,0 +1,97 @@
+import { WebXMouseState } from './mouse';
+export declare class WebXMouse {
+    private _element;
+    /**
+     * The current mouse state. The properties of this state are updated when
+     * mouse events fire. This state object is also passed in as a parameter to
+     * the handler of any mouse events.
+     */
+    private _currentState;
+    private _contextMenuHandler;
+    private _mouseMoveHandler;
+    private _mouseDownHandler;
+    private _mouseUpHandler;
+    private _mouseOutHandler;
+    private _mouseWheelHandler;
+    /**
+     * Provides cross-browser mouse events for a given element
+     * @param _element The element to use to provide mouse events
+     */
+    constructor(_element: HTMLElement);
+    dispose(): void;
+    /**
+     * Cancel an event
+     * @param event the event to cancel
+     */
+    private _cancelEvent;
+    /**
+     * Bind the mouse listeners to the given element
+     */
+    private _bindListeners;
+    private _unbindListeners;
+    private _createDefaultState;
+    /**
+     * Process mouse up event
+     * @param event the mouse event
+     */
+    private _handleMouseUp;
+    /**
+     * Process mouse down event
+     * @param event the mouse event
+     */
+    private _handleMouseDown;
+    /**
+     * Process mouse wheel event
+     * @param event the mouse event
+     */
+    private _handleMouseWheel;
+    /**
+     * Process mouse out event
+     * @param event the mouse event
+     */
+    private _handleMouseOut;
+    /**
+     * Process the mouse move event
+     * @param event the mouse event
+     */
+    private _handleMouseMove;
+    /**
+     * Resets the mouse state
+     */
+    reset(): void;
+    /**
+     * Process the context menu event
+     * Block context menu so right-click gets sent properly
+     * @param event the mouse event
+     */
+    private _handleContextMenu;
+    /**
+     * Fired whenever the user moves the mouse
+     * @param mouseState the current mouse state
+     */
+    onMouseMove(mouseState: WebXMouseState): void;
+    /**
+     * Fired whenever a mouse button is effectively pressed. This can happen
+     * as part of a "click" gesture initiated by the user by tapping one
+     * or more fingers over the touchpad element, as part of a "scroll"
+     * gesture initiated by dragging two fingers up or down, etc.
+     *
+     * @param mouseState the current mouse state
+     */
+    onMouseDown(mouseState: WebXMouseState): void;
+    /**
+     * Fired whenever a mouse button is effectively released. This can happen
+     * as part of a "click" gesture initiated by the user by tapping one
+     * or more fingers over the touchpad element, as part of a "scroll"
+     * gesture initiated by dragging two fingers up or down, etc.
+     * @param mouseState the current mouse state
+     */
+    onMouseUp(mouseState: WebXMouseState): void;
+    /**
+     * Fired whenever the mouse leaves the boundaries of the element associated
+     * with this mouse
+     *
+     * @param mouseState the current mouse state
+     */
+    onMouseOut(mouseState: WebXMouseState): void;
+}

package/dist/input/WebXMouse.js

@@ -0,0 +1,205 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebXMouse = void 0;
+const mouse_1 = require("./mouse");
+class WebXMouse {
+    /**
+     * Provides cross-browser mouse events for a given element
+     * @param _element The element to use to provide mouse events
+     */
+    constructor(_element) {
+        this._element = _element;
+        this._contextMenuHandler = this._handleContextMenu.bind(this);
+        this._mouseMoveHandler = this._handleMouseMove.bind(this);
+        this._mouseDownHandler = this._handleMouseDown.bind(this);
+        this._mouseUpHandler = this._handleMouseUp.bind(this);
+        this._mouseOutHandler = this._handleMouseOut.bind(this);
+        this._mouseWheelHandler = this._handleMouseWheel.bind(this);
+        this._bindListeners();
+        this._createDefaultState();
+    }
+    dispose() {
+        this._unbindListeners();
+    }
+    /**
+     * Cancel an event
+     * @param event the event to cancel
+     */
+    _cancelEvent(event) {
+        event.stopPropagation();
+        if (event.preventDefault) {
+            event.preventDefault();
+        }
+        event.returnValue = false;
+    }
+    /**
+     * Bind the mouse listeners to the given element
+     */
+    _bindListeners() {
+        const element = this._element;
+        element.addEventListener('contextmenu', this._contextMenuHandler, false);
+        element.addEventListener('mousemove', this._mouseMoveHandler);
+        element.addEventListener('mousedown', this._mouseDownHandler);
+        element.addEventListener('mouseup', this._mouseUpHandler);
+        element.addEventListener('mouseout', this._mouseOutHandler);
+        ['DOMMouseScroll', 'mousewheel', 'wheel'].forEach(listener => {
+            element.addEventListener(listener, this._mouseWheelHandler, { passive: false });
+        });
+        this.reset = this.reset.bind(this);
+    }
+    _unbindListeners() {
+        const element = this._element;
+        element.removeEventListener('contextmenu', this._contextMenuHandler, false);
+        element.removeEventListener('mousemove', this._mouseMoveHandler);
+        element.removeEventListener('mousedown', this._mouseDownHandler);
+        element.removeEventListener('mouseup', this._mouseUpHandler);
+        element.removeEventListener('mouseout', this._mouseOutHandler);
+        ['DOMMouseScroll', 'mousewheel', 'wheel'].forEach(listener => {
+            element.removeEventListener(listener, this._mouseWheelHandler);
+        });
+        this.reset = this.reset.bind(this);
+    }
+    _createDefaultState() {
+        this._currentState = new mouse_1.WebXMouseState({
+            x: 0,
+            y: 0,
+            left: false,
+            middle: false,
+            right: false,
+            up: false,
+            down: false
+        });
+    }
+    /**
+     * Process mouse up event
+     * @param event the mouse event
+     */
+    _handleMouseUp(event) {
+        const currentState = this._currentState;
+        switch (event.button) {
+            case 0:
+                currentState.left = false;
+                break;
+            case 1:
+                currentState.middle = false;
+                break;
+            case 2:
+                currentState.right = false;
+                break;
+        }
+        this.onMouseUp(currentState);
+    }
+    /**
+     * Process mouse down event
+     * @param event the mouse event
+     */
+    _handleMouseDown(event) {
+        this._cancelEvent(event);
+        const currentState = this._currentState;
+        switch (event.button) {
+            case 0:
+                currentState.left = true;
+                break;
+            case 1:
+                currentState.middle = true;
+                break;
+            case 2:
+                currentState.right = true;
+                break;
+        }
+        this.onMouseDown(currentState);
+    }
+    /**
+     * Process mouse wheel event
+     * @param event the mouse event
+     */
+    _handleMouseWheel(event) {
+        const currentState = this._currentState;
+        if (event.deltaY < 0) {
+            currentState.up = true;
+            this.onMouseDown(currentState);
+            currentState.up = false;
+            this.onMouseUp(currentState);
+        }
+        if (event.deltaY > 0) {
+            currentState.down = true;
+            this.onMouseDown(currentState);
+            currentState.down = false;
+            this.onMouseUp(currentState);
+        }
+        this._cancelEvent(event);
+    }
+    /**
+     * Process mouse out event
+     * @param event the mouse event
+     */
+    _handleMouseOut() {
+        // reset all buttons
+        const currentState = this._currentState;
+        currentState.releaseButtons();
+        this.onMouseUp(currentState);
+        this.onMouseOut(currentState);
+    }
+    /**
+     * Process the mouse move event
+     * @param event the mouse event
+     */
+    _handleMouseMove(event) {
+        this._cancelEvent(event);
+        const currentState = this._currentState;
+        // get the container wrapping the display canvas element
+        const bounds = this._element.firstElementChild.getBoundingClientRect();
+        currentState.x = event.clientX - bounds.left;
+        currentState.y = event.clientY - bounds.top;
+        this.onMouseMove(currentState);
+    }
+    /**
+     * Resets the mouse state
+     */
+    reset() {
+        this._createDefaultState();
+    }
+    /**
+     * Process the context menu event
+     * Block context menu so right-click gets sent properly
+     * @param event the mouse event
+     */
+    _handleContextMenu(event) {
+        this._cancelEvent(event);
+    }
+    /**
+     * Fired whenever the user moves the mouse
+     * @param mouseState the current mouse state
+     */
+    // eslint-disable-next-line
+    onMouseMove(mouseState) { }
+    /**
+     * Fired whenever a mouse button is effectively pressed. This can happen
+     * as part of a "click" gesture initiated by the user by tapping one
+     * or more fingers over the touchpad element, as part of a "scroll"
+     * gesture initiated by dragging two fingers up or down, etc.
+     *
+     * @param mouseState the current mouse state
+     */
+    // eslint-disable-next-line
+    onMouseDown(mouseState) { }
+    /**
+     * Fired whenever a mouse button is effectively released. This can happen
+     * as part of a "click" gesture initiated by the user by tapping one
+     * or more fingers over the touchpad element, as part of a "scroll"
+     * gesture initiated by dragging two fingers up or down, etc.
+     * @param mouseState the current mouse state
+     */
+    // eslint-disable-next-line
+    onMouseUp(mouseState) { }
+    /**
+     * Fired whenever the mouse leaves the boundaries of the element associated
+     * with this mouse
+     *
+     * @param mouseState the current mouse state
+     */
+    // eslint-disable-next-line
+    onMouseOut(mouseState) { }
+}
+exports.WebXMouse = WebXMouse;
+//# sourceMappingURL=WebXMouse.js.map

package/dist/input/WebXMouse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebXMouse.js","sourceRoot":"","sources":["../../src/input/WebXMouse.ts"],"names":[],"mappings":";;;AAAA,mCAAyC;AAEzC,MAAa,SAAS;IAepB;;;OAGG;IACH,YAAoB,QAAqB;QAArB,aAAQ,GAAR,QAAQ,CAAa;QAXjC,wBAAmB,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzD,sBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrD,sBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrD,oBAAe,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjD,qBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,uBAAkB,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAO7D,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC7B,CAAC;IAED,OAAO;QACL,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACK,YAAY,CAAC,KAAY;QAC/B,KAAK,CAAC,eAAe,EAAE,CAAC;QACxB,IAAI,KAAK,CAAC,cAAc,EAAE;YACxB,KAAK,CAAC,cAAc,EAAE,CAAC;SACxB;QACD,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED;;OAEG;IACK,cAAc;QACpB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,OAAO,CAAC,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QACzE,OAAO,CAAC,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC9D,OAAO,CAAC,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC9D,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC1D,OAAO,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC5D,CAAC,gBAAgB,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC3D,OAAO,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAEO,gBAAgB;QACtB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,OAAO,CAAC,mBAAmB,CAAC,aAAa,EAAE,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAC5E,OAAO,CAAC,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACjE,OAAO,CAAC,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACjE,OAAO,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7D,OAAO,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC/D,CAAC,gBAAgB,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC3D,OAAO,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAEO,mBAAmB;QACzB,IAAI,CAAC,aAAa,GAAG,IAAI,sBAAc,CAAC;YACtC,CAAC,EAAE,CAAC;YACJ,CAAC,EAAE,CAAC;YACJ,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,KAAK;YACZ,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,cAAc,CAAC,KAAiB;QACtC,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,QAAQ,KAAK,CAAC,MAAM,EAAE;YACpB,KAAK,CAAC;gBACJ,YAAY,CAAC,IAAI,GAAG,KAAK,CAAC;gBAC1B,MAAM;YACR,KAAK,CAAC;gBACJ,YAAY,CAAC,MAAM,GAAG,KAAK,CAAC;gBAC5B,MAAM;YACR,KAAK,CAAC;gBACJ,YAAY,CAAC,KAAK,GAAG,KAAK,CAAC;gBAC3B,MAAM;SACT;QACD,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACK,gBAAgB,CAAC,KAAiB;QACxC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QACzB,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,QAAQ,KAAK,CAAC,MAAM,EAAE;YACpB,KAAK,CAAC;gBACJ,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC;gBACzB,MAAM;YACR,KAAK,CAAC;gBACJ,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC;gBAC3B,MAAM;YACR,KAAK,CAAC;gBACJ,YAAY,CAAC,KAAK,GAAG,IAAI,CAAC;gBAC1B,MAAM;SACT;QACD,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IACjC,CAAC;IAED;;;OAGG;IACK,iBAAiB,CAAC,KAAiB;QACzC,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACpB,YAAY,CAAC,EAAE,GAAG,IAAI,CAAC;YACvB,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YAE/B,YAAY,CAAC,EAAE,GAAG,KAAK,CAAC;YACxB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;SAC9B;QAED,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACpB,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC;YACzB,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YAE/B,YAAY,CAAC,IAAI,GAAG,KAAK,CAAC;YAC1B,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;SAC9B;QACD,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACK,eAAe;QACrB,oBAAoB;QACpB,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,YAAY,CAAC,cAAc,EAAE,CAAC;QAC9B,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAC7B,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACK,gBAAgB,CAAC,KAAiB;QACxC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QACzB,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,wDAAwD;QACxD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,qBAAqB,EAAE,CAAC;QACvE,YAAY,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC;QAC7C,YAAY,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC;QAC5C,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC7B,CAAC;IACD;;;;OAIG;IACK,kBAAkB,CAAC,KAAiB;QAC1C,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAGD;;;OAGG;IACH,2BAA2B;IAC3B,WAAW,CAAC,UAA0B,IAAU,CAAC;IAEjD;;;;;;;OAOG;IACH,2BAA2B;IAC3B,WAAW,CAAC,UAA0B,IAAU,CAAC;IAEjD;;;;;;OAMG;IACH,2BAA2B;IAC3B,SAAS,CAAC,UAA0B,IAAU,CAAC;IAE/C;;;;;OAKG;IACH,2BAA2B;IAC3B,UAAU,CAAC,UAA0B,IAAU,CAAC;CAEjD;AAjOD,8BAiOC"}

package/dist/input/index.d.ts

@@ -0,0 +1,4 @@
+export * from './WebXKeyboard';
+export * from './WebXMouse';
+export * from './mouse';
+export * from './keyboard';

package/dist/input/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./WebXKeyboard"), exports);
+__exportStar(require("./WebXMouse"), exports);
+__exportStar(require("./mouse"), exports);
+__exportStar(require("./keyboard"), exports);
+//# sourceMappingURL=index.js.map

package/dist/input/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/input/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,8CAA4B;AAC5B,0CAAwB;AACxB,6CAA2B"}

package/dist/input/keyboard/WebXKeyEvent.d.ts

@@ -0,0 +1,47 @@
+/**
+ * A key event having a corresponding timestamp. This event is non-specific.
+ * Its subclasses should be used instead when recording specific key
+ * events.
+ */
+export declare abstract class WebXKeyEvent {
+    /**
+   * Map of known JavaScript keyidentifiers which do not map to typable
+   * characters to their unshifted X11 keysym equivalents.
+   */
+    static keyidentifier_keysym: {
+        [index: string]: Array<number>;
+    };
+    /**
+     * Whether the default action of this key event should be prevented.
+     */
+    protected _defaultPrevented: boolean;
+    /**
+     * The keysym of the key associated with this key event, as determined
+     * by a best-effort guess using available event properties and keyboard
+     * state.
+     */
+    protected _keysym: number;
+    /**
+     * Whether the keysym value of this key event is known to be reliable.
+     * If false, the keysym may still be valid, but it's only a best guess,
+     * and future key events may be a better source of information.
+     */
+    protected _reliable: boolean;
+    get defaultPrevented(): boolean;
+    set defaultPrevented(defaultPrevented: boolean);
+    get keysym(): number;
+    set keysym(keysym: number);
+    get reliable(): boolean;
+    set reliable(reliable: boolean);
+    /**
+     * Returns true if the given keysym corresponds to a printable character,
+     * false otherwise.
+     *
+     * @returns {Boolean}
+     *     true if the given keysym corresponds to a printable character,
+     *     false otherwise.
+     */
+    isPrintable(): boolean;
+    getKeysym(keysyms: Array<number>, location: number): number;
+    keysymFromKeyIdentifier(identifier: any, location: any, shifted?: any): number;
+}

package/dist/input/keyboard/WebXKeyEvent.js

@@ -0,0 +1,212 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebXKeyEvent = void 0;
+const WebXKeyboardUtils_1 = require("./WebXKeyboardUtils");
+/**
+ * A key event having a corresponding timestamp. This event is non-specific.
+ * Its subclasses should be used instead when recording specific key
+ * events.
+ */
+class WebXKeyEvent {
+    constructor() {
+        /**
+         * Whether the default action of this key event should be prevented.
+         */
+        this._defaultPrevented = false;
+        /**
+         * The keysym of the key associated with this key event, as determined
+         * by a best-effort guess using available event properties and keyboard
+         * state.
+         */
+        this._keysym = null;
+        /**
+         * Whether the keysym value of this key event is known to be reliable.
+         * If false, the keysym may still be valid, but it's only a best guess,
+         * and future key events may be a better source of information.
+         */
+        this._reliable = false;
+    }
+    get defaultPrevented() {
+        return this._defaultPrevented;
+    }
+    set defaultPrevented(defaultPrevented) {
+        this._defaultPrevented = defaultPrevented;
+    }
+    get keysym() {
+        return this._keysym;
+    }
+    set keysym(keysym) {
+        this._keysym = keysym;
+    }
+    get reliable() {
+        return this._reliable;
+    }
+    set reliable(reliable) {
+        this._reliable = reliable;
+    }
+    /**
+     * Returns true if the given keysym corresponds to a printable character,
+     * false otherwise.
+     *
+     * @returns {Boolean}
+     *     true if the given keysym corresponds to a printable character,
+     *     false otherwise.
+     */
+    isPrintable() {
+        const keysym = this._keysym;
+        // Keysyms with Unicode equivalents are printable
+        return (keysym >= 0x00 && keysym <= 0xff) || (keysym & 0xffff0000) === 0x01000000;
+    }
+    getKeysym(keysyms, location) {
+        if (!keysyms) {
+            return null;
+        }
+        return keysyms[location] || keysyms[0];
+    }
+    keysymFromKeyIdentifier(identifier, location, shifted) {
+        if (!identifier) {
+            return null;
+        }
+        let typedCharacter;
+        // If identifier is U+xxxx, decode Unicode character
+        const unicodePrefixLocation = identifier.indexOf("U+");
+        if (unicodePrefixLocation >= 0) {
+            const hex = identifier.substring(unicodePrefixLocation + 2);
+            typedCharacter = String.fromCharCode(parseInt(hex, 16));
+        }
+        // If single character and not keypad, use that as typed character
+        else if (identifier.length === 1 && location !== 3) {
+            typedCharacter = identifier;
+        }
+        // Otherwise, look up corresponding keysym
+        else {
+            return this.getKeysym(WebXKeyEvent.keyidentifier_keysym[identifier], location);
+        }
+        // Alter case if necessary
+        if (shifted === true) {
+            typedCharacter = typedCharacter.toUpperCase();
+        }
+        else if (shifted === false) {
+            typedCharacter = typedCharacter.toLowerCase();
+        }
+        // Get codepoint
+        const codepoint = typedCharacter.charCodeAt(0);
+        return WebXKeyboardUtils_1.WebXKeyboardUtils.keysymFromCharCode(codepoint);
+    }
+}
+exports.WebXKeyEvent = WebXKeyEvent;
+/**
+* Map of known JavaScript keyidentifiers which do not map to typable
+* characters to their unshifted X11 keysym equivalents.
+*/
+WebXKeyEvent.keyidentifier_keysym = {
+    Again: [0xff66],
+    AllCandidates: [0xff3d],
+    Alphanumeric: [0xff30],
+    Alt: [0xffe9, 0xffe9, 0xfe03],
+    Attn: [0xfd0e],
+    AltGraph: [0xfe03],
+    ArrowDown: [0xff54],
+    ArrowLeft: [0xff51],
+    ArrowRight: [0xff53],
+    ArrowUp: [0xff52],
+    Backspace: [0xff08],
+    CapsLock: [0xffe5],
+    Cancel: [0xff69],
+    Clear: [0xff0b],
+    Convert: [0xff21],
+    Copy: [0xfd15],
+    Crsel: [0xfd1c],
+    CrSel: [0xfd1c],
+    CodeInput: [0xff37],
+    Compose: [0xff20],
+    Control: [0xffe3, 0xffe3, 0xffe4],
+    ContextMenu: [0xff67],
+    Delete: [0xffff],
+    Down: [0xff54],
+    End: [0xff57],
+    Enter: [0xff0d],
+    EraseEof: [0xfd06],
+    Escape: [0xff1b],
+    Execute: [0xff62],
+    Exsel: [0xfd1d],
+    ExSel: [0xfd1d],
+    F1: [0xffbe],
+    F2: [0xffbf],
+    F3: [0xffc0],
+    F4: [0xffc1],
+    F5: [0xffc2],
+    F6: [0xffc3],
+    F7: [0xffc4],
+    F8: [0xffc5],
+    F9: [0xffc6],
+    F10: [0xffc7],
+    F11: [0xffc8],
+    F12: [0xffc9],
+    F13: [0xffca],
+    F14: [0xffcb],
+    F15: [0xffcc],
+    F16: [0xffcd],
+    F17: [0xffce],
+    F18: [0xffcf],
+    F19: [0xffd0],
+    F20: [0xffd1],
+    F21: [0xffd2],
+    F22: [0xffd3],
+    F23: [0xffd4],
+    F24: [0xffd5],
+    Find: [0xff68],
+    GroupFirst: [0xfe0c],
+    GroupLast: [0xfe0e],
+    GroupNext: [0xfe08],
+    GroupPrevious: [0xfe0a],
+    FullWidth: null,
+    HalfWidth: null,
+    HangulMode: [0xff31],
+    Hankaku: [0xff29],
+    HanjaMode: [0xff34],
+    Help: [0xff6a],
+    Hiragana: [0xff25],
+    HiraganaKatakana: [0xff27],
+    Home: [0xff50],
+    Hyper: [0xffed, 0xffed, 0xffee],
+    Insert: [0xff63],
+    JapaneseHiragana: [0xff25],
+    JapaneseKatakana: [0xff26],
+    JapaneseRomaji: [0xff24],
+    JunjaMode: [0xff38],
+    KanaMode: [0xff2d],
+    KanjiMode: [0xff21],
+    Katakana: [0xff26],
+    Left: [0xff51],
+    Meta: [0xffe7, 0xffe7, 0xffe8],
+    ModeChange: [0xff7e],
+    NumLock: [0xff7f],
+    PageDown: [0xff56],
+    PageUp: [0xff55],
+    Pause: [0xff13],
+    Play: [0xfd16],
+    PreviousCandidate: [0xff3e],
+    PrintScreen: [0xff61],
+    Redo: [0xff66],
+    Right: [0xff53],
+    RomanCharacters: null,
+    Scroll: [0xff14],
+    Select: [0xff60],
+    Separator: [0xffac],
+    Shift: [0xffe1, 0xffe1, 0xffe2],
+    SingleCandidate: [0xff3c],
+    Super: [0xffeb, 0xffeb, 0xffec],
+    Tab: [0xff09],
+    UIKeyInputDownArrow: [0xff54],
+    UIKeyInputEscape: [0xff1b],
+    UIKeyInputLeftArrow: [0xff51],
+    UIKeyInputRightArrow: [0xff53],
+    UIKeyInputUpArrow: [0xff52],
+    Up: [0xff52],
+    Undo: [0xff65],
+    Win: [0xffeb],
+    Zenkaku: [0xff28],
+    ZenkakuHankaku: [0xff2a]
+};
+//# sourceMappingURL=WebXKeyEvent.js.map

package/dist/input/keyboard/WebXKeyEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebXKeyEvent.js","sourceRoot":"","sources":["../../../src/input/keyboard/WebXKeyEvent.ts"],"names":[],"mappings":";;;AAAA,2DAAwD;AAExD;;;;GAIG;AACH,MAAsB,YAAY;IAAlC;QAsHE;;WAEG;QACO,sBAAiB,GAAG,KAAK,CAAC;QAEpC;;;;WAIG;QACO,YAAO,GAAW,IAAI,CAAC;QAEjC;;;;WAIG;QACO,cAAS,GAAG,KAAK,CAAC;IAwF9B,CAAC;IAtFC,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED,IAAW,gBAAgB,CAAC,gBAAyB;QACnD,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;IAC5C,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAW,MAAM,CAAC,MAAc;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAW,QAAQ,CAAC,QAAiB;QACnC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACI,WAAW;QAChB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,iDAAiD;QACjD,OAAO,CAAC,MAAM,IAAI,IAAI,IAAI,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,KAAK,UAAU,CAAC;IACpF,CAAC;IAEM,SAAS,CAAC,OAAsB,EAAE,QAAgB;QACvD,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,IAAI,CAAC;SACb;QAED,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IAGM,uBAAuB,CAAC,UAAe,EAAE,QAAa,EAAE,OAAa;QAE1E,IAAI,CAAC,UAAU,EAAE;YACf,OAAO,IAAI,CAAC;SACb;QAED,IAAI,cAAsB,CAAC;QAE3B,oDAAoD;QACpD,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,qBAAqB,IAAI,CAAC,EAAE;YAC9B,MAAM,GAAG,GAAG,UAAU,CAAC,SAAS,CAAC,qBAAqB,GAAG,CAAC,CAAC,CAAC;YAC5D,cAAc,GAAG,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;SACzD;QAED,kEAAkE;aAC7D,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,EAAE;YAClD,cAAc,GAAG,UAAU,CAAC;SAC7B;QAED,0CAA0C;aACrC;YACH,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,oBAAoB,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC;SAChF;QAED,0BAA0B;QAC1B,IAAI,OAAO,KAAK,IAAI,EAAE;YACpB,cAAc,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;SAC/C;aACI,IAAI,OAAO,KAAK,KAAK,EAAE;YAC1B,cAAc,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;SAC/C;QAED,gBAAgB;QAChB,MAAM,SAAS,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC/C,OAAO,qCAAiB,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEzD,CAAC;;AA7NH,oCA+NC;AA7NC;;;EAGC;AACa,iCAAoB,GAAuC;IACvE,KAAK,EAAE,CAAC,MAAM,CAAC;IACf,aAAa,EAAE,CAAC,MAAM,CAAC;IACvB,YAAY,EAAE,CAAC,MAAM,CAAC;IACtB,GAAG,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;IAC7B,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,SAAS,EAAE,CAAC,MAAM,CAAC;IACnB,SAAS,EAAE,CAAC,MAAM,CAAC;IACnB,UAAU,EAAE,CAAC,MAAM,CAAC;IACpB,OAAO,EAAE,CAAC,MAAM,CAAC;IACjB,SAAS,EAAE,CAAC,MAAM,CAAC;IACnB,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,MAAM,EAAE,CAAC,MAAM,CAAC;IAChB,KAAK,EAAE,CAAC,MAAM,CAAC;IACf,OAAO,EAAE,CAAC,MAAM,CAAC;IACjB,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,MAAM,CAAC;IACf,KAAK,EAAE,CAAC,MAAM,CAAC;IACf,SAAS,EAAE,CAAC,MAAM,CAAC;IACnB,OAAO,EAAE,CAAC,MAAM,CAAC;IACjB,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;IACjC,WAAW,EAAE,CAAC,MAAM,CAAC;IACrB,MAAM,EAAE,CAAC,MAAM,CAAC;IAChB,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,KAAK,EAAE,CAAC,MAAM,CAAC;IACf,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,MAAM,EAAE,CAAC,MAAM,CAAC;IAChB,OAAO,EAAE,CAAC,MAAM,CAAC;IACjB,KAAK,EAAE,CAAC,MAAM,CAAC;IACf,KAAK,EAAE,CAAC,MAAM,CAAC;IACf,EAAE,EAAE,CAAC,MAAM,CAAC;IACZ,EAAE,EAAE,CAAC,MAAM,CAAC;IACZ,EAAE,EAAE,CAAC,MAAM,CAAC;IACZ,EAAE,EAAE,CAAC,MAAM,CAAC;IACZ,EAAE,EAAE,CAAC,MAAM,CAAC;IACZ,EAAE,EAAE,CAAC,MAAM,CAAC;IACZ,EAAE,EAAE,CAAC,MAAM,CAAC;IACZ,EAAE,EAAE,CAAC,MAAM,CAAC;IACZ,EAAE,EAAE,CAAC,MAAM,CAAC;IACZ,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,UAAU,EAAE,CAAC,MAAM,CAAC;IACpB,SAAS,EAAE,CAAC,MAAM,CAAC;IACnB,SAAS,EAAE,CAAC,MAAM,CAAC;IACnB,aAAa,EAAE,CAAC,MAAM,CAAC;IACvB,SAAS,EAAE,IAAI;IACf,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,CAAC,MAAM,CAAC;IACpB,OAAO,EAAE,CAAC,MAAM,CAAC;IACjB,SAAS,EAAE,CAAC,MAAM,CAAC;IACnB,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,gBAAgB,EAAE,CAAC,MAAM,CAAC;IAC1B,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;IAC/B,MAAM,EAAE,CAAC,MAAM,CAAC;IAChB,gBAAgB,EAAE,CAAC,MAAM,CAAC;IAC1B,gBAAgB,EAAE,CAAC,MAAM,CAAC;IAC1B,cAAc,EAAE,CAAC,MAAM,CAAC;IACxB,SAAS,EAAE,CAAC,MAAM,CAAC;IACnB,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,SAAS,EAAE,CAAC,MAAM,CAAC;IACnB,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;IAC9B,UAAU,EAAE,CAAC,MAAM,CAAC;IACpB,OAAO,EAAE,CAAC,MAAM,CAAC;IACjB,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,MAAM,EAAE,CAAC,MAAM,CAAC;IAChB,KAAK,EAAE,CAAC,MAAM,CAAC;IACf,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,iBAAiB,EAAE,CAAC,MAAM,CAAC;IAC3B,WAAW,EAAE,CAAC,MAAM,CAAC;IACrB,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,MAAM,CAAC;IACf,eAAe,EAAE,IAAI;IACrB,MAAM,EAAE,CAAC,MAAM,CAAC;IAChB,MAAM,EAAE,CAAC,MAAM,CAAC;IAChB,SAAS,EAAE,CAAC,MAAM,CAAC;IACnB,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;IAC/B,eAAe,EAAE,CAAC,MAAM,CAAC;IACzB,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;IAC/B,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,mBAAmB,EAAE,CAAC,MAAM,CAAC;IAC7B,gBAAgB,EAAE,CAAC,MAAM,CAAC;IAC1B,mBAAmB,EAAE,CAAC,MAAM,CAAC;IAC7B,oBAAoB,EAAE,CAAC,MAAM,CAAC;IAC9B,iBAAiB,EAAE,CAAC,MAAM,CAAC;IAC3B,EAAE,EAAE,CAAC,MAAM,CAAC;IACZ,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,GAAG,EAAE,CAAC,MAAM,CAAC;IACb,OAAO,EAAE,CAAC,MAAM,CAAC;IACjB,cAAc,EAAE,CAAC,MAAM,CAAC;CACzB,CAAC"}

package/dist/input/keyboard/WebXKeyPressEvent.d.ts

@@ -0,0 +1,13 @@
+import { WebXKeyEvent } from './WebXKeyEvent';
+/**
+ * Information related to the pressing of a key, which MUST be
+ * associated with a printable character. The presence or absence of any
+ * information within this object is browser-dependent.
+ */
+export declare class WebXKeyPressEvent extends WebXKeyEvent {
+    private _key;
+    private readonly _location;
+    get key(): string;
+    get location(): number;
+    constructor(key: string, location: number);
+}

package/dist/input/keyboard/WebXKeyPressEvent.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebXKeyPressEvent = void 0;
+const WebXKeyEvent_1 = require("./WebXKeyEvent");
+/**
+ * Information related to the pressing of a key, which MUST be
+ * associated with a printable character. The presence or absence of any
+ * information within this object is browser-dependent.
+ */
+class WebXKeyPressEvent extends WebXKeyEvent_1.WebXKeyEvent {
+    constructor(key, location) {
+        super();
+        this._key = key;
+        this._location = location;
+        this._keysym = this.keysymFromKeyIdentifier(key, location);
+        this.reliable = true;
+    }
+    get key() {
+        return this._key;
+    }
+    get location() {
+        return this._location;
+    }
+}
+exports.WebXKeyPressEvent = WebXKeyPressEvent;
+//# sourceMappingURL=WebXKeyPressEvent.js.map

package/dist/input/keyboard/WebXKeyPressEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebXKeyPressEvent.js","sourceRoot":"","sources":["../../../src/input/keyboard/WebXKeyPressEvent.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAE9C;;;;GAIG;AACH,MAAa,iBAAkB,SAAQ,2BAAY;IAYjD,YAAY,GAAW,EAAE,QAAgB;QACvC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,uBAAuB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAE3D,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAfD,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;CAUF;AApBD,8CAoBC"}

package/dist/input/keyboard/WebXKeyUpEvent.d.ts

@@ -0,0 +1,12 @@
+import { WebXKeyEvent } from './WebXKeyEvent';
+export declare class WebXKeyUpEvent extends WebXKeyEvent {
+    private readonly _keyCode;
+    private readonly _key;
+    private readonly _location;
+    private readonly _keyIdentifier;
+    get keyCode(): number;
+    get key(): string;
+    get location(): number;
+    get keyIdentifier(): string;
+    constructor(key: string, location: number);
+}