@theia/core 1.67.0-next.56 → 1.67.0-next.86

package/lib/common/keybinding.d.ts

@@ -0,0 +1,76 @@
+/**
+ * A Keybinding binds a specific key sequence ({@link Keybinding#keybinding}) to trigger a command ({@link Keybinding#command}). A Keybinding optionally may
+ * define a "when clause" ({@link Keybinding#when}) to specify in which context it becomes active.
+ * @see KeyBindingRegistry
+ */
+export interface Keybinding {
+    /**
+     * Unique command identifier of the command to be triggered by this keybinding.
+     */
+    command: string;
+    /**
+     * The key sequence for the keybinding as defined in packages/keymaps/README.md.
+     */
+    keybinding: string;
+    /**
+     * The optional keybinding context where this binding belongs to.
+     * If not specified, then this keybinding context belongs to the NOOP
+     * keybinding context.
+     *
+     * @deprecated use `when` closure instead
+     */
+    context?: string;
+    /**
+     * An optional clause defining the condition when the keybinding is active, e.g. based on the current focus.
+     * See {@link https://code.visualstudio.com/docs/getstarted/keybindings#_when-clause-contexts} for more details.
+     */
+    when?: string;
+    /**
+     * Optional arguments that will be passed to the command when it gets triggered via this keybinding.
+     * Needs to be specified when the triggered command expects arguments to be passed to the command handler.
+     */
+    args?: any;
+}
+export declare namespace Keybinding {
+    /**
+     * Compares two keybindings for equality.
+     * Can optionally ignore the keybinding and/or args property in the comparison.
+     * @param a The first Keybinding in the comparison
+     * @param b The second Keybinding in the comparison
+     * @param ignoreKeybinding Ignore the 'keybinding' property in the comparison
+     * @param ignoreArgs Ignore the 'args' property in the comparison
+     */
+    function equals(a: Keybinding, b: Keybinding, ignoreKeybinding?: boolean, ignoreArgs?: boolean): boolean;
+    /**
+     * Returns a new object only containing properties which
+     * are described on the `Keybinding` API.
+     *
+     * @param binding the binding to create an API object for.
+     */
+    function apiObjectify(binding: Keybinding | RawKeybinding): Keybinding;
+    function retrieveKeybinding(binding: Partial<Keybinding & RawKeybinding>): string;
+    /**
+     * Returns with the string representation of the binding.
+     * Any additional properties which are not described on
+     * the `Keybinding` API will be ignored.
+     *
+     * @param binding the binding to stringify.
+     */
+    function stringify(binding: Keybinding): string;
+    function is(arg: unknown): arg is Keybinding;
+    function replaceKeybinding(keybindings: Keybinding[], oldKeybinding: Keybinding, newKeybinding: Keybinding): boolean;
+    function addKeybinding(keybindings: Keybinding[], newKeybinding: Keybinding): void;
+}
+/**
+ * @internal
+ *
+ * Optional representation of key sequence as found in `keymaps.json` file.
+ * Use `keybinding` as the official representation.
+ */
+export interface RawKeybinding extends Omit<Keybinding, 'keybinding'> {
+    key: string;
+}
+export declare namespace RawKeybinding {
+    function is(candidate: unknown): candidate is RawKeybinding;
+}
+//# sourceMappingURL=keybinding.d.ts.map

package/lib/common/keybinding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keybinding.d.ts","sourceRoot":"","sources":["../../src/common/keybinding.ts"],"names":[],"mappings":"AAkBA;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IAEH,IAAI,CAAC,EAAE,GAAG,CAAC;CACd;AACD,yBAAiB,UAAU,CAAC;IAExB;;;;;;;OAOG;IACH,SAAgB,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE,gBAAgB,GAAE,OAAe,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAS5H;IAED;;;;;OAKG;IACH,SAAgB,YAAY,CAAC,OAAO,EAAE,UAAU,GAAG,aAAa,GAAG,UAAU,CAQ5E;IAED,SAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,GAAG,aAAa,CAAC,GAAG,MAAM,CAEvF;IAED;;;;;;OAMG;IACH,SAAgB,SAAS,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM,CAErD;IAGD,SAAgB,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,UAAU,CAElD;IAED,SAAgB,iBAAiB,CAAC,WAAW,EAAE,UAAU,EAAE,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,UAAU,GAAG,OAAO,CAc1H;IAED,SAAgB,aAAa,CAAC,WAAW,EAAE,UAAU,EAAE,EAAE,aAAa,EAAE,UAAU,GAAG,IAAI,CAQxF;CACJ;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC;IACjE,GAAG,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,aAAa,CAAC;IAC3B,SAAgB,EAAE,CAAC,SAAS,EAAE,OAAO,GAAG,SAAS,IAAI,aAAa,CAEjE;CACJ"}

package/lib/common/keybinding.js

@@ -0,0 +1,114 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2017 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RawKeybinding = exports.Keybinding = void 0;
+const types_1 = require("./types");
+var Keybinding;
+(function (Keybinding) {
+    /**
+     * Compares two keybindings for equality.
+     * Can optionally ignore the keybinding and/or args property in the comparison.
+     * @param a The first Keybinding in the comparison
+     * @param b The second Keybinding in the comparison
+     * @param ignoreKeybinding Ignore the 'keybinding' property in the comparison
+     * @param ignoreArgs Ignore the 'args' property in the comparison
+     */
+    function equals(a, b, ignoreKeybinding = false, ignoreArgs = false) {
+        if (a.command === b.command &&
+            (a.context || '') === (b.context || '') &&
+            (a.when || '') === (b.when || '') &&
+            (ignoreKeybinding || a.keybinding === b.keybinding) &&
+            (ignoreArgs || (a.args || '') === (b.args || ''))) {
+            return true;
+        }
+        return false;
+    }
+    Keybinding.equals = equals;
+    /**
+     * Returns a new object only containing properties which
+     * are described on the `Keybinding` API.
+     *
+     * @param binding the binding to create an API object for.
+     */
+    function apiObjectify(binding) {
+        return {
+            command: binding.command,
+            keybinding: retrieveKeybinding(binding),
+            context: binding.context,
+            when: binding.when,
+            args: binding.args
+        };
+    }
+    Keybinding.apiObjectify = apiObjectify;
+    function retrieveKeybinding(binding) {
+        var _a, _b;
+        return (_b = (_a = binding.keybinding) !== null && _a !== void 0 ? _a : binding.key) !== null && _b !== void 0 ? _b : '';
+    }
+    Keybinding.retrieveKeybinding = retrieveKeybinding;
+    /**
+     * Returns with the string representation of the binding.
+     * Any additional properties which are not described on
+     * the `Keybinding` API will be ignored.
+     *
+     * @param binding the binding to stringify.
+     */
+    function stringify(binding) {
+        return JSON.stringify(apiObjectify(binding));
+    }
+    Keybinding.stringify = stringify;
+    /* Determine whether object is a KeyBinding */
+    function is(arg) {
+        return (0, types_1.isObject)(arg) && 'command' in arg && 'keybinding' in arg;
+    }
+    Keybinding.is = is;
+    function replaceKeybinding(keybindings, oldKeybinding, newKeybinding) {
+        const indexOld = keybindings.findIndex(keybinding => Keybinding.equals(keybinding, oldKeybinding, false, true));
+        if (indexOld >= 0) {
+            const indexNew = keybindings.findIndex(keybinding => Keybinding.equals(keybinding, newKeybinding, false, true));
+            if (indexNew >= 0 && indexNew !== indexOld) {
+                // if keybindings already contain the new keybinding, remove the old keybinding and update the new one
+                keybindings.splice(indexOld, 1);
+                keybindings[indexNew] = newKeybinding;
+            }
+            else {
+                keybindings[indexOld] = newKeybinding;
+            }
+            return true;
+        }
+        return false;
+    }
+    Keybinding.replaceKeybinding = replaceKeybinding;
+    function addKeybinding(keybindings, newKeybinding) {
+        const index = keybindings.findIndex(keybinding => Keybinding.equals(keybinding, newKeybinding, false, true));
+        if (index >= 0) {
+            // if keybindings already contain the new keybinding, update it
+            keybindings[index] = newKeybinding;
+        }
+        else {
+            keybindings.push(newKeybinding);
+        }
+    }
+    Keybinding.addKeybinding = addKeybinding;
+})(Keybinding || (exports.Keybinding = Keybinding = {}));
+var RawKeybinding;
+(function (RawKeybinding) {
+    function is(candidate) {
+        return (0, types_1.isObject)(candidate) && 'command' in candidate && 'key' in candidate;
+    }
+    RawKeybinding.is = is;
+})(RawKeybinding || (exports.RawKeybinding = RawKeybinding = {}));
+//# sourceMappingURL=keybinding.js.map

package/lib/common/keybinding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keybinding.js","sourceRoot":"","sources":["../../src/common/keybinding.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yCAAyC;AACzC,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;;AAEhF,mCAAmC;AAqCnC,IAAiB,UAAU,CAkF1B;AAlFD,WAAiB,UAAU;IAEvB;;;;;;;OAOG;IACH,SAAgB,MAAM,CAAC,CAAa,EAAE,CAAa,EAAE,mBAA4B,KAAK,EAAE,aAAsB,KAAK;QAC/G,IAAI,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO;YACvB,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC;YACvC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;YACjC,CAAC,gBAAgB,IAAI,CAAC,CAAC,UAAU,KAAK,CAAC,CAAC,UAAU,CAAC;YACnD,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;YACpD,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IATe,iBAAM,SASrB,CAAA;IAED;;;;;OAKG;IACH,SAAgB,YAAY,CAAC,OAAmC;QAC5D,OAAO;YACH,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,UAAU,EAAE,kBAAkB,CAAC,OAAO,CAAC;YACvC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;SACrB,CAAC;IACN,CAAC;IARe,uBAAY,eAQ3B,CAAA;IAED,SAAgB,kBAAkB,CAAC,OAA4C;;QAC3E,OAAO,MAAA,MAAA,OAAO,CAAC,UAAU,mCAAI,OAAO,CAAC,GAAG,mCAAI,EAAE,CAAC;IACnD,CAAC;IAFe,6BAAkB,qBAEjC,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,SAAS,CAAC,OAAmB;QACzC,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;IACjD,CAAC;IAFe,oBAAS,YAExB,CAAA;IAED,8CAA8C;IAC9C,SAAgB,EAAE,CAAC,GAAY;QAC3B,OAAO,IAAA,gBAAQ,EAAC,GAAG,CAAC,IAAI,SAAS,IAAI,GAAG,IAAI,YAAY,IAAI,GAAG,CAAC;IACpE,CAAC;IAFe,aAAE,KAEjB,CAAA;IAED,SAAgB,iBAAiB,CAAC,WAAyB,EAAE,aAAyB,EAAE,aAAyB;QAC7G,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;QAChH,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC;YAChB,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;YAChH,IAAI,QAAQ,IAAI,CAAC,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACzC,sGAAsG;gBACtG,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;gBAChC,WAAW,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC;YAC1C,CAAC;iBAAM,CAAC;gBACJ,WAAW,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC;YAC1C,CAAC;YACD,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAde,4BAAiB,oBAchC,CAAA;IAED,SAAgB,aAAa,CAAC,WAAyB,EAAE,aAAyB;QAC9E,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;QAC7G,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACb,+DAA+D;YAC/D,WAAW,CAAC,KAAK,CAAC,GAAG,aAAa,CAAC;QACvC,CAAC;aAAM,CAAC;YACJ,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,CAAC;IACL,CAAC;IARe,wBAAa,gBAQ5B,CAAA;AACL,CAAC,EAlFgB,UAAU,0BAAV,UAAU,QAkF1B;AAYD,IAAiB,aAAa,CAI7B;AAJD,WAAiB,aAAa;IAC1B,SAAgB,EAAE,CAAC,SAAkB;QACjC,OAAO,IAAA,gBAAQ,EAAC,SAAS,CAAC,IAAI,SAAS,IAAI,SAAS,IAAI,KAAK,IAAI,SAAS,CAAC;IAC/E,CAAC;IAFe,gBAAE,KAEjB,CAAA;AACL,CAAC,EAJgB,aAAa,6BAAb,aAAa,QAI7B"}

package/lib/common/keyboard/keyboard-layout-provider.d.ts

@@ -0,0 +1,28 @@
+/// <reference path="../../../src/typings/native-keymap.d.ts" />
+import type { IKeyboardLayoutInfo, IKeyboardMapping } from 'native-keymap';
+import { Event } from '../event';
+export declare const keyboardPath = "/services/keyboard";
+export declare const KeyboardLayoutProvider: unique symbol;
+export interface KeyboardLayoutProvider {
+    getNativeLayout(): Promise<NativeKeyboardLayout>;
+}
+export declare const KeyboardLayoutChangeNotifier: unique symbol;
+export interface KeyboardLayoutChangeNotifier {
+    onDidChangeNativeLayout: Event<NativeKeyboardLayout>;
+}
+export interface KeyValidationInput {
+    code: string;
+    character: string;
+    shiftKey?: boolean;
+    ctrlKey?: boolean;
+    altKey?: boolean;
+}
+export declare const KeyValidator: unique symbol;
+export interface KeyValidator {
+    validateKey(input: KeyValidationInput): void;
+}
+export interface NativeKeyboardLayout {
+    info: IKeyboardLayoutInfo;
+    mapping: IKeyboardMapping;
+}
+//# sourceMappingURL=keyboard-layout-provider.d.ts.map

package/lib/common/keyboard/keyboard-layout-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboard-layout-provider.d.ts","sourceRoot":"","sources":["../../../src/common/keyboard/keyboard-layout-provider.ts"],"names":[],"mappings":";AAgBA,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC3E,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC,eAAO,MAAM,YAAY,uBAAuB,CAAC;AAEjD,eAAO,MAAM,sBAAsB,eAAmC,CAAC;AAEvE,MAAM,WAAW,sBAAsB;IACnC,eAAe,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC;CACpD;AAED,eAAO,MAAM,4BAA4B,eAAyC,CAAC;AAEnF,MAAM,WAAW,4BAA4B;IACzC,uBAAuB,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACxD;AAED,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,eAAO,MAAM,YAAY,eAAyB,CAAC;AAEnD,MAAM,WAAW,YAAY;IACzB,WAAW,CAAC,KAAK,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,gBAAgB,CAAC;CAC7B"}

package/lib/common/keyboard/keyboard-layout-provider.js

@@ -0,0 +1,23 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2019 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyValidator = exports.KeyboardLayoutChangeNotifier = exports.KeyboardLayoutProvider = exports.keyboardPath = void 0;
+exports.keyboardPath = '/services/keyboard';
+exports.KeyboardLayoutProvider = Symbol('KeyboardLayoutProvider');
+exports.KeyboardLayoutChangeNotifier = Symbol('KeyboardLayoutChangeNotifier');
+exports.KeyValidator = Symbol('KeyValidator');
+//# sourceMappingURL=keyboard-layout-provider.js.map

package/lib/common/keyboard/keyboard-layout-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboard-layout-provider.js","sourceRoot":"","sources":["../../../src/common/keyboard/keyboard-layout-provider.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yCAAyC;AACzC,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;;AAKnE,QAAA,YAAY,GAAG,oBAAoB,CAAC;AAEpC,QAAA,sBAAsB,GAAG,MAAM,CAAC,wBAAwB,CAAC,CAAC;AAM1D,QAAA,4BAA4B,GAAG,MAAM,CAAC,8BAA8B,CAAC,CAAC;AActE,QAAA,YAAY,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC"}

package/lib/common/keys.d.ts

@@ -0,0 +1,254 @@
+export type KeySequence = KeyCode[];
+export declare namespace KeySequence {
+    function equals(a: KeySequence, b: KeySequence): boolean;
+    enum CompareResult {
+        NONE = 0,
+        PARTIAL = 1,
+        SHADOW = 2,
+        FULL = 3
+    }
+    function compare(a: KeySequence, b: KeySequence): CompareResult;
+    function parse(keybinding: string): KeySequence;
+}
+/**
+ * The key sequence for this binding. This key sequence should consist of one or more key strokes. Key strokes
+ * consist of one or more keys held down at the same time. This should be zero or more modifier keys, and zero or one other key.
+ * Since `M2+M3+<Key>` (Alt+Shift+<Key>) is reserved on MacOS X for writing special characters, such bindings are commonly
+ * undefined for platform MacOS X and redefined as `M1+M3+<Key>`. The rule applies on the `M3+M2+<Key>` sequence.
+ */
+export interface Keystroke {
+    readonly first?: Key;
+    readonly modifiers?: KeyModifier[];
+}
+export interface KeyCodeSchema {
+    key?: Partial<Key>;
+    ctrl?: boolean;
+    shift?: boolean;
+    alt?: boolean;
+    meta?: boolean;
+    character?: string;
+}
+/**
+ * Representation of a pressed key combined with key modifiers.
+ */
+export declare class KeyCode {
+    readonly key: Key | undefined;
+    readonly ctrl: boolean;
+    readonly shift: boolean;
+    readonly alt: boolean;
+    readonly meta: boolean;
+    readonly character: string | undefined;
+    constructor(schema: KeyCodeSchema);
+    /**
+     * Return true if this KeyCode only contains modifiers.
+     */
+    isModifierOnly(): boolean;
+    /**
+     * Return true if the given KeyCode is equal to this one.
+     */
+    equals(other: KeyCode): boolean;
+    toString(): string;
+    /**
+     * Create a KeyCode from one of several input types.
+     */
+    static createKeyCode(input: KeyboardEvent | Keystroke | KeyCodeSchema | string, eventDispatch?: 'code' | 'keyCode'): KeyCode;
+    private static keybindings;
+    static resetKeyBindings(): void;
+    /**
+     * Parses a string and returns a KeyCode object.
+     * @param keybinding String representation of a keybinding
+     */
+    static parse(keybinding: string): KeyCode;
+}
+export declare namespace KeyCode {
+    /**
+     * Determines a `true` of `false` value for the key code argument.
+     */
+    type Predicate = (keyCode: KeyCode) => boolean;
+    function isModifierString(key: string): boolean;
+    /**
+     * Different scopes have different execution environments. This means that they have different built-ins
+     * (different global object, different constructors, etc.). This may result in unexpected results. For instance,
+     * `[] instanceof window.frames[0].Array` will return `false`, because `Array.prototype !== window.frames[0].Array`
+     * and arrays inherit from the former.
+     * See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/instanceof
+     *
+     * Note: just add another check if the current `event.type` checking is insufficient.
+     */
+    function isKeyboardEvent(event: object & {
+        readonly type?: string;
+    }): event is KeyboardEvent;
+    /**
+     * Determine the pressed key of a keyboard event. This key should correspond to the physical key according
+     * to a standard US keyboard layout. International keyboard layouts are handled by `KeyboardLayoutService`.
+     *
+     * `keyIdentifier` is used to access this deprecated field:
+     * https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyIdentifier
+     */
+    function toKey(event: KeyboardEvent, dispatch?: 'code' | 'keyCode'): Key;
+    /**
+     * Determine the actual printable character that is generated from a pressed key.
+     * If the key does not correspond to a printable character, `undefined` is returned.
+     * The result may be altered by modifier keys.
+     */
+    function toCharacter(event: KeyboardEvent): string | undefined;
+}
+export declare enum KeyModifier {
+    /**
+     * M1 is the COMMAND key on MacOS X, and the CTRL key on most other platforms.
+     */
+    CtrlCmd = "M1",
+    /**
+     * M2 is the SHIFT key.
+     */
+    Shift = "M2",
+    /**
+     * M3 is the Option key on MacOS X, and the ALT key on most other platforms.
+     */
+    Alt = "M3",
+    /**
+     * M4 is the CTRL key on MacOS X, and is undefined on other platforms.
+     */
+    MacCtrl = "M4"
+}
+export declare namespace KeyModifier {
+    /**
+     * The CTRL key, independently of the platform.
+     * _Note:_ In general `KeyModifier.CtrlCmd` should be preferred over this constant.
+     */
+    const CTRL: KeyModifier.MacCtrl | KeyModifier.CtrlCmd;
+    /**
+     * An alias for the SHIFT key (`KeyModifier.Shift`).
+     */
+    const SHIFT: KeyModifier.Shift;
+    /**
+     * `true` if the argument represents a modifier. Otherwise, `false`.
+     */
+    function isModifier(key: string | undefined): boolean;
+}
+export interface Key {
+    readonly code: string;
+    readonly keyCode: number;
+    readonly easyString: string;
+}
+export declare namespace SpecialCases {
+    const META = "meta";
+    const CTRLCMD = "ctrlcmd";
+}
+export declare namespace Key {
+    function isKey(arg: unknown): arg is Key;
+    function getKey(arg: string | number): Key | undefined;
+    function isModifier(arg: string | number): boolean;
+    function equals(key: Key, keyCode: KeyCode): boolean;
+    const BACKSPACE: Key;
+    const TAB: Key;
+    const ENTER: Key;
+    const ESCAPE: Key;
+    const SPACE: Key;
+    const PAGE_UP: Key;
+    const PAGE_DOWN: Key;
+    const END: Key;
+    const HOME: Key;
+    const ARROW_LEFT: Key;
+    const ARROW_UP: Key;
+    const ARROW_RIGHT: Key;
+    const ARROW_DOWN: Key;
+    const INSERT: Key;
+    const DELETE: Key;
+    const SHIFT_LEFT: Key;
+    const SHIFT_RIGHT: Key;
+    const CONTROL_LEFT: Key;
+    const CONTROL_RIGHT: Key;
+    const ALT_LEFT: Key;
+    const ALT_RIGHT: Key;
+    const CAPS_LOCK: Key;
+    const OS_LEFT: Key;
+    const OS_RIGHT: Key;
+    const DIGIT0: Key;
+    const DIGIT1: Key;
+    const DIGIT2: Key;
+    const DIGIT3: Key;
+    const DIGIT4: Key;
+    const DIGIT5: Key;
+    const DIGIT6: Key;
+    const DIGIT7: Key;
+    const DIGIT8: Key;
+    const DIGIT9: Key;
+    const KEY_A: Key;
+    const KEY_B: Key;
+    const KEY_C: Key;
+    const KEY_D: Key;
+    const KEY_E: Key;
+    const KEY_F: Key;
+    const KEY_G: Key;
+    const KEY_H: Key;
+    const KEY_I: Key;
+    const KEY_J: Key;
+    const KEY_K: Key;
+    const KEY_L: Key;
+    const KEY_M: Key;
+    const KEY_N: Key;
+    const KEY_O: Key;
+    const KEY_P: Key;
+    const KEY_Q: Key;
+    const KEY_R: Key;
+    const KEY_S: Key;
+    const KEY_T: Key;
+    const KEY_U: Key;
+    const KEY_V: Key;
+    const KEY_W: Key;
+    const KEY_X: Key;
+    const KEY_Y: Key;
+    const KEY_Z: Key;
+    const MULTIPLY: Key;
+    const ADD: Key;
+    const DECIMAL: Key;
+    const SUBTRACT: Key;
+    const DIVIDE: Key;
+    const F1: Key;
+    const F2: Key;
+    const F3: Key;
+    const F4: Key;
+    const F5: Key;
+    const F6: Key;
+    const F7: Key;
+    const F8: Key;
+    const F9: Key;
+    const F10: Key;
+    const F11: Key;
+    const F12: Key;
+    const F13: Key;
+    const F14: Key;
+    const F15: Key;
+    const F16: Key;
+    const F17: Key;
+    const F18: Key;
+    const F19: Key;
+    const F20: Key;
+    const F21: Key;
+    const F22: Key;
+    const F23: Key;
+    const F24: Key;
+    const NUM_LOCK: Key;
+    const SEMICOLON: Key;
+    const EQUAL: Key;
+    const COMMA: Key;
+    const MINUS: Key;
+    const PERIOD: Key;
+    const SLASH: Key;
+    const BACKQUOTE: Key;
+    const INTL_RO: Key;
+    const BRACKET_LEFT: Key;
+    const BACKSLASH: Key;
+    const BRACKET_RIGHT: Key;
+    const QUOTE: Key;
+    const INTL_BACKSLASH: Key;
+    const INTL_YEN: Key;
+    const MAX_KEY_CODE: number;
+}
+export type KeysOrKeyCodes = Key | KeyCode | (Key | KeyCode)[];
+export declare namespace KeysOrKeyCodes {
+    const toKeyCode: (keyOrKeyCode: Key | KeyCode) => KeyCode;
+    const toKeyCodes: (keysOrKeyCodes: KeysOrKeyCodes) => KeyCode[];
+}
+//# sourceMappingURL=keys.d.ts.map

package/lib/common/keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../src/common/keys.ts"],"names":[],"mappings":"AAoBA,MAAM,MAAM,WAAW,GAAG,OAAO,EAAE,CAAC;AACpC,yBAAiB,WAAW,CAAC;IAEzB,SAAgB,MAAM,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,WAAW,GAAG,OAAO,CAW9D;IAED,KAAY,aAAa;QACrB,IAAI,IAAI;QACR,OAAO,IAAA;QACP,MAAM,IAAA;QACN,IAAI,IAAA;KACP;IAQD,SAAgB,OAAO,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,WAAW,GAAG,aAAa,CAwBrE;IAED,SAAgB,KAAK,CAAC,UAAU,EAAE,MAAM,GAAG,WAAW,CAUrD;CACJ;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACtB,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC;IACrB,QAAQ,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,aAAa;IAC1B,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACnB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,qBAAa,OAAO;IAEhB,SAAgB,GAAG,EAAE,GAAG,GAAG,SAAS,CAAC;IACrC,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B,SAAgB,KAAK,EAAE,OAAO,CAAC;IAC/B,SAAgB,GAAG,EAAE,OAAO,CAAC;IAC7B,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B,SAAgB,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;gBAE3B,MAAM,EAAE,aAAa;IAkBxC;;OAEG;IACI,cAAc,IAAI,OAAO;IAIhC;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAU/B,QAAQ,IAAI,MAAM;IAoBlB;;OAEG;WACW,aAAa,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,GAAG,aAAa,GAAG,MAAM,EAAE,aAAa,GAAE,MAAM,GAAG,SAAkB,GAAG,OAAO;IA0C3I,OAAO,CAAC,MAAM,CAAC,WAAW,CAAkC;WAG9C,gBAAgB,IAAI,IAAI;IAItC;;;OAGG;WACW,KAAK,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;CAiEnD;AAED,yBAAiB,OAAO,CAAC;IAErB;;OAEG;IACH,KAAY,SAAS,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC;IAKtD,SAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAKrD;IAED;;;;;;;;OAQG;IACH,SAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG;QAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,KAAK,IAAI,aAAa,CAYlG;IAED;;;;;;OAMG;IACH,SAAgB,KAAK,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,GAAE,MAAM,GAAG,SAAkB,GAAG,GAAG,CA4CtF;IAED;;;;OAIG;IACH,SAAgB,WAAW,CAAC,KAAK,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS,CAYpE;CAEJ;AAED,oBAAY,WAAW;IACnB;;OAEG;IACH,OAAO,OAAO;IACd;;OAEG;IACH,KAAK,OAAO;IACZ;;OAEG;IACH,GAAG,OAAO;IACV;;OAEG;IACH,OAAO,OAAO;CACjB;AAED,yBAAiB,WAAW,CAAC;IACzB;;;OAGG;IACI,MAAM,IAAI,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAA2D,CAAC;IACjH;;OAEG;IACI,MAAM,KAAK,EAAE,WAAW,CAAC,KAAyB,CAAC;IAE1D;;OAEG;IACH,SAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAW3D;CACJ;AAED,MAAM,WAAW,GAAG;IAChB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC/B;AAmBD,yBAAiB,YAAY,CAAC;IACnB,MAAM,IAAI,SAAS,CAAC;IACpB,MAAM,OAAO,YAAY,CAAC;CACpC;AAED,yBAAiB,GAAG,CAAC;IAEjB,SAAgB,KAAK,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,GAAG,CAE9C;IAED,SAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,GAAG,GAAG,SAAS,CAM5D;IAED,SAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAKxD;IAED,SAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAE1D;IAEM,MAAM,SAAS,EAAE,GAAgE,CAAC;IAClF,MAAM,GAAG,EAAE,GAAoD,CAAC;IAChE,MAAM,KAAK,EAAE,GAAyD,CAAC;IACvE,MAAM,MAAM,EAAE,GAA2D,CAAC;IAC1E,MAAM,KAAK,EAAE,GAAyD,CAAC;IACvE,MAAM,OAAO,EAAE,GAA2D,CAAC;IAC3E,MAAM,SAAS,EAAE,GAA+D,CAAC;IACjF,MAAM,GAAG,EAAE,GAAqD,CAAC;IACjE,MAAM,IAAI,EAAE,GAAuD,CAAC;IACpE,MAAM,UAAU,EAAE,GAA4D,CAAC;IAC/E,MAAM,QAAQ,EAAE,GAAwD,CAAC;IACzE,MAAM,WAAW,EAAE,GAA8D,CAAC;IAClF,MAAM,UAAU,EAAE,GAA4D,CAAC;IAC/E,MAAM,MAAM,EAAE,GAA2D,CAAC;IAC1E,MAAM,MAAM,EAAE,GAA2D,CAAC;IAE1E,MAAM,UAAU,EAAE,GAA6D,CAAC;IAChF,MAAM,WAAW,EAAE,GAA8D,CAAC;IAClF,MAAM,YAAY,EAAE,GAA8D,CAAC;IACnF,MAAM,aAAa,EAAE,GAA+D,CAAC;IACrF,MAAM,QAAQ,EAAE,GAAyD,CAAC;IAC1E,MAAM,SAAS,EAAE,GAA0D,CAAC;IAC5E,MAAM,SAAS,EAAE,GAA+D,CAAC;IACjF,MAAM,OAAO,EAAE,GAA0D,CAAC;IAC1E,MAAM,QAAQ,EAAE,GAA2D,CAAC;IAE5E,MAAM,MAAM,EAAE,GAAsD,CAAC;IACrE,MAAM,MAAM,EAAE,GAAsD,CAAC;IACrE,MAAM,MAAM,EAAE,GAAsD,CAAC;IACrE,MAAM,MAAM,EAAE,GAAsD,CAAC;IACrE,MAAM,MAAM,EAAE,GAAsD,CAAC;IACrE,MAAM,MAAM,EAAE,GAAsD,CAAC;IACrE,MAAM,MAAM,EAAE,GAAsD,CAAC;IACrE,MAAM,MAAM,EAAE,GAAsD,CAAC;IACrE,MAAM,MAAM,EAAE,GAAsD,CAAC;IACrE,MAAM,MAAM,EAAE,GAAsD,CAAC;IAErE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAClE,MAAM,KAAK,EAAE,GAAoD,CAAC;IAElE,MAAM,QAAQ,EAAE,GAAsE,CAAC;IACvF,MAAM,GAAG,EAAE,GAA4D,CAAC;IACxE,MAAM,OAAO,EAAE,GAAoE,CAAC;IACpF,MAAM,QAAQ,EAAE,GAAsE,CAAC;IACvF,MAAM,MAAM,EAAE,GAAkE,CAAC;IAEjF,MAAM,EAAE,EAAE,GAAoD,CAAC;IAC/D,MAAM,EAAE,EAAE,GAAoD,CAAC;IAC/D,MAAM,EAAE,EAAE,GAAoD,CAAC;IAC/D,MAAM,EAAE,EAAE,GAAoD,CAAC;IAC/D,MAAM,EAAE,EAAE,GAAoD,CAAC;IAC/D,MAAM,EAAE,EAAE,GAAoD,CAAC;IAC/D,MAAM,EAAE,EAAE,GAAoD,CAAC;IAC/D,MAAM,EAAE,EAAE,GAAoD,CAAC;IAC/D,MAAM,EAAE,EAAE,GAAoD,CAAC;IAC/D,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAClE,MAAM,GAAG,EAAE,GAAsD,CAAC;IAElE,MAAM,QAAQ,EAAE,GAA8D,CAAC;IAC/E,MAAM,SAAS,EAAE,GAA0D,CAAC;IAC5E,MAAM,KAAK,EAAE,GAAsD,CAAC;IACpE,MAAM,KAAK,EAAE,GAAsD,CAAC;IACpE,MAAM,KAAK,EAAE,GAAsD,CAAC;IACpE,MAAM,MAAM,EAAE,GAAuD,CAAC;IACtE,MAAM,KAAK,EAAE,GAAsD,CAAC;IACpE,MAAM,SAAS,EAAE,GAA0D,CAAC;IAC5E,MAAM,OAAO,EAAE,GAA4D,CAAC;IAC5E,MAAM,YAAY,EAAE,GAA4D,CAAC;IACjF,MAAM,SAAS,EAAE,GAA2D,CAAC;IAC7E,MAAM,aAAa,EAAE,GAA6D,CAAC;IACnF,MAAM,KAAK,EAAE,GAAuD,CAAC;IACrE,MAAM,cAAc,EAAE,GAA0E,CAAC;IACjG,MAAM,QAAQ,EAAE,GAA8D,CAAC;IAE/E,MAAM,YAAY,QAAmB,CAAC;CAEhD;AAkDD,MAAM,MAAM,cAAc,GAAG,GAAG,GAAG,OAAO,GAAG,CAAC,GAAG,GAAG,OAAO,CAAC,EAAE,CAAC;AAC/D,yBAAiB,cAAc,CAAC;IAErB,MAAM,SAAS,iBAAkB,GAAG,GAAG,OAAO,YAC8C,CAAC;IAE7F,MAAM,UAAU,mBAAoB,cAAc,cAOxD,CAAC;CAEL"}