@etsoo/shared 1.1.5 → 1.1.6

package/README.md

@@ -18,6 +18,16 @@ $ yarn add @etsoo/shared
 ## storage
 Storage interface and browser storage implementation
 
+## Keyboard
+Keyboard keys and codes
+
+|Name|Description|
+|---:|---|
+|Keys|KeyboardEvent.key constants|
+|Codes|KeyboardEvent.code constants|
+
+|isTypingContent|Is typing content or press command key|
+
 ## DataTypes
 Data type definitions and type safe functions
 

package/__tests__/Keyboard.ts

@@ -0,0 +1,8 @@
+import { Keyboard } from '../src/Keyboard';
+
+test('Tests for isTypingContent', () => {
+    expect(Keyboard.isTypingContent(Keyboard.Keys.A)).toBeTruthy();
+    expect(Keyboard.isTypingContent(Keyboard.Keys.Ampersand)).toBeTruthy();
+    expect(Keyboard.isTypingContent(Keyboard.Keys.Shift)).toBeFalsy();
+    expect(Keyboard.isTypingContent(Keyboard.Keys.PrintScreen)).toBeFalsy();
+});

package/lib/cjs/Keyboard.d.ts

@@ -0,0 +1,261 @@
+/**
+ * Keyboard functions
+ */
+export declare namespace Keyboard {
+    /**
+     * Keys for KeyboardEvent.key
+     */
+    enum Keys {
+        Backspace = "Backspace",
+        Tab = "Tab",
+        Enter = "Enter",
+        Shift = "Shift",
+        Control = "Control",
+        Alt = "Alt",
+        Pause = "Pause",
+        CapsLock = "CapsLock",
+        Escape = "Escape",
+        Space = "",
+        PageUp = "PageUp",
+        PageDown = "PageDown",
+        End = "End",
+        Home = "Home",
+        ArrowLeft = "ArrowLeft",
+        ArrowUp = "ArrowUp",
+        ArrowRight = "ArrowRight",
+        ArrowDown = "ArrowDown",
+        PrintScreen = "PrintScreen",
+        Insert = "Insert",
+        Delete = "Delete",
+        Digit0 = "0",
+        Digit1 = "1",
+        Digit2 = "2",
+        Digit3 = "3",
+        Digit4 = "4",
+        Digit5 = "5",
+        Digit6 = "6",
+        Digit7 = "7",
+        Digit8 = "8",
+        Digit9 = "9",
+        A = "A",
+        B = "B",
+        C = "C",
+        D = "D",
+        E = "E",
+        F = "F",
+        G = "G",
+        H = "H",
+        I = "I",
+        J = "J",
+        K = "K",
+        L = "L",
+        M = "M",
+        N = "N",
+        O = "O",
+        P = "P",
+        Q = "Q",
+        R = "R",
+        S = "S",
+        T = "T",
+        U = "U",
+        V = "V",
+        W = "W",
+        X = "X",
+        Y = "Y",
+        Z = "Z",
+        a = "a",
+        b = "b",
+        c = "c",
+        d = "d",
+        e = "e",
+        f = "f",
+        g = "g",
+        h = "h",
+        i = "i",
+        j = "j",
+        k = "k",
+        l = "l",
+        m = "m",
+        n = "n",
+        o = "o",
+        p = "p",
+        q = "q",
+        r = "r",
+        s = "s",
+        t = "t",
+        u = "u",
+        v = "v",
+        w = "w",
+        x = "x",
+        y = "y",
+        z = "z",
+        Meta = "Meta",
+        ContextMenu = "ContextMenu",
+        AudioVolumeMute = "AudioVolumeMute",
+        AudioVolumeDown = "AudioVolumeDown",
+        AudioVolumeUp = "AudioVolumeUp",
+        F1 = "F1",
+        F2 = "F2",
+        F3 = "F3",
+        F4 = "F4",
+        F5 = "F5",
+        F6 = "F6",
+        F7 = "F7",
+        F8 = "F8",
+        F9 = "F9",
+        F10 = "F10",
+        F11 = "F11",
+        F12 = "F12",
+        NumLock = "NumLock",
+        ScrollLock = "ScrollLock",
+        Semicolon = ";",
+        Equal = "=",
+        Comma = ",",
+        Minus = "-",
+        Period = ".",
+        Slash = "/",
+        Backquote = "`",
+        BracketLeft = "[",
+        Backslash = "\\",
+        BracketRight = "]",
+        Quote = "'",
+        Tilde = "~",
+        Exclamation = "!",
+        At = "@",
+        Sharp = "#",
+        Dollar = "$",
+        Percent = "%",
+        Caret = "^",
+        Ampersand = "&",
+        Asterisk = "*",
+        ParenthesisLeft = "(",
+        ParenthesisRight = ")",
+        Underscore = "_",
+        Plus = "+",
+        OpenBrace = "{",
+        CloseBrace = "}",
+        Pipe = "|",
+        Colon = ":",
+        Quote2 = "\"",
+        AngleBracketLeft = "<",
+        AngleBracketRight = ">",
+        QuestionMark = "?"
+    }
+    /**
+     * Codes for KeyboardEvent.code
+     */
+    enum Codes {
+        Backspace = "Backspace",
+        Tab = "Tab",
+        Enter = "Enter",
+        ShiftLeft = "ShiftLeft",
+        ShiftRight = "ShiftRight",
+        ControlLeft = "ControlLeft",
+        ControlRight = "ControlRight",
+        AltLeft = "AltLeft",
+        AltRight = "AltRight",
+        Pause = "Pause",
+        CapsLock = "CapsLock",
+        Escape = "Escape",
+        Space = "Space",
+        PageUp = "PageUp",
+        PageDown = "PageDown",
+        End = "End",
+        Home = "Home",
+        ArrowLeft = "ArrowLeft",
+        ArrowUp = "ArrowUp",
+        ArrowRight = "ArrowRight",
+        ArrowDown = "ArrowDown",
+        PrintScreen = "PrintScreen",
+        Insert = "Insert",
+        Delete = "Delete",
+        Digit0 = "Digit0",
+        Digit1 = "Digit1",
+        Digit2 = "Digit2",
+        Digit3 = "Digit3",
+        Digit4 = "Digit4",
+        Digit5 = "Digit5",
+        Digit6 = "Digit6",
+        Digit7 = "Digit7",
+        Digit8 = "Digit8",
+        Digit9 = "Digit9",
+        AudioVolumeMute = "AudioVolumeMute",
+        AudioVolumeDown = "AudioVolumeDown",
+        AudioVolumeUp = "AudioVolumeUp",
+        KeyA = "KeyA",
+        KeyB = "KeyB",
+        KeyC = "KeyC",
+        KeyD = "KeyD",
+        KeyE = "KeyE",
+        KeyF = "KeyF",
+        KeyG = "KeyG",
+        KeyH = "KeyH",
+        KeyI = "KeyI",
+        KeyJ = "KeyJ",
+        KeyK = "KeyK",
+        KeyL = "KeyL",
+        KeyM = "KeyM",
+        KeyN = "KeyN",
+        KeyO = "KeyO",
+        KeyP = "KeyP",
+        KeyQ = "KeyQ",
+        KeyR = "KeyR",
+        KeyS = "KeyS",
+        KeyT = "KeyT",
+        KeyU = "KeyU",
+        KeyV = "KeyV",
+        KeyW = "KeyW",
+        KeyX = "KeyX",
+        KeyY = "KeyY",
+        KeyZ = "KeyZ",
+        MetaLeft = "MetaLeft",
+        MetaRight = "MetaRight",
+        ContextMenu = "ContextMenu",
+        Numpad0 = "Numpad0",
+        Numpad1 = "Numpad1",
+        Numpad2 = "Numpad2",
+        Numpad3 = "Numpad3",
+        Numpad4 = "Numpad4",
+        Numpad5 = "Numpad5",
+        Numpad6 = "Numpad6",
+        Numpad7 = "Numpad7",
+        Numpad8 = "Numpad8",
+        Numpad9 = "Numpad9",
+        NumpadMultiply = "NumpadMultiply",
+        NumpadAdd = "NumpadAdd",
+        NumpadSubtract = "NumpadSubtract",
+        NumpadDecimal = "NumpadDecimal",
+        NumpadDivide = "NumpadDivide",
+        F1 = "F1",
+        F2 = "F2",
+        F3 = "F3",
+        F4 = "F4",
+        F5 = "F5",
+        F6 = "F6",
+        F7 = "F7",
+        F8 = "F8",
+        F9 = "F9",
+        F10 = "F10",
+        F11 = "F11",
+        F12 = "F12",
+        NumLock = "NumLock",
+        ScrollLock = "ScrollLock",
+        Semicolon = "Semicolon",
+        Equal = "Equal",
+        Comma = "Comma",
+        Minus = "Minus",
+        Period = "Period",
+        Slash = "Slash",
+        Backquote = "Backquote",
+        BracketLeft = "BracketLeft",
+        Backslash = "Backslash",
+        BracketRight = "BracketRight",
+        Quote = "Quote"
+    }
+    /**
+     * Is typing content or press command key
+     * @param input Input key
+     * @returns Result
+     */
+    function isTypingContent(input: Keys | string): boolean;
+}

package/lib/cjs/Keyboard.js

@@ -0,0 +1,270 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Keyboard = void 0;
+/**
+ * Keyboard functions
+ */
+var Keyboard;
+(function (Keyboard) {
+    /**
+     * Keys for KeyboardEvent.key
+     */
+    let Keys;
+    (function (Keys) {
+        Keys["Backspace"] = "Backspace";
+        Keys["Tab"] = "Tab";
+        Keys["Enter"] = "Enter";
+        Keys["Shift"] = "Shift";
+        Keys["Control"] = "Control";
+        Keys["Alt"] = "Alt";
+        Keys["Pause"] = "Pause";
+        Keys["CapsLock"] = "CapsLock";
+        Keys["Escape"] = "Escape";
+        Keys["Space"] = "";
+        Keys["PageUp"] = "PageUp";
+        Keys["PageDown"] = "PageDown";
+        Keys["End"] = "End";
+        Keys["Home"] = "Home";
+        Keys["ArrowLeft"] = "ArrowLeft";
+        Keys["ArrowUp"] = "ArrowUp";
+        Keys["ArrowRight"] = "ArrowRight";
+        Keys["ArrowDown"] = "ArrowDown";
+        Keys["PrintScreen"] = "PrintScreen";
+        Keys["Insert"] = "Insert";
+        Keys["Delete"] = "Delete";
+        Keys["Digit0"] = "0";
+        Keys["Digit1"] = "1";
+        Keys["Digit2"] = "2";
+        Keys["Digit3"] = "3";
+        Keys["Digit4"] = "4";
+        Keys["Digit5"] = "5";
+        Keys["Digit6"] = "6";
+        Keys["Digit7"] = "7";
+        Keys["Digit8"] = "8";
+        Keys["Digit9"] = "9";
+        Keys["A"] = "A";
+        Keys["B"] = "B";
+        Keys["C"] = "C";
+        Keys["D"] = "D";
+        Keys["E"] = "E";
+        Keys["F"] = "F";
+        Keys["G"] = "G";
+        Keys["H"] = "H";
+        Keys["I"] = "I";
+        Keys["J"] = "J";
+        Keys["K"] = "K";
+        Keys["L"] = "L";
+        Keys["M"] = "M";
+        Keys["N"] = "N";
+        Keys["O"] = "O";
+        Keys["P"] = "P";
+        Keys["Q"] = "Q";
+        Keys["R"] = "R";
+        Keys["S"] = "S";
+        Keys["T"] = "T";
+        Keys["U"] = "U";
+        Keys["V"] = "V";
+        Keys["W"] = "W";
+        Keys["X"] = "X";
+        Keys["Y"] = "Y";
+        Keys["Z"] = "Z";
+        Keys["a"] = "a";
+        Keys["b"] = "b";
+        Keys["c"] = "c";
+        Keys["d"] = "d";
+        Keys["e"] = "e";
+        Keys["f"] = "f";
+        Keys["g"] = "g";
+        Keys["h"] = "h";
+        Keys["i"] = "i";
+        Keys["j"] = "j";
+        Keys["k"] = "k";
+        Keys["l"] = "l";
+        Keys["m"] = "m";
+        Keys["n"] = "n";
+        Keys["o"] = "o";
+        Keys["p"] = "p";
+        Keys["q"] = "q";
+        Keys["r"] = "r";
+        Keys["s"] = "s";
+        Keys["t"] = "t";
+        Keys["u"] = "u";
+        Keys["v"] = "v";
+        Keys["w"] = "w";
+        Keys["x"] = "x";
+        Keys["y"] = "y";
+        Keys["z"] = "z";
+        Keys["Meta"] = "Meta";
+        Keys["ContextMenu"] = "ContextMenu";
+        Keys["AudioVolumeMute"] = "AudioVolumeMute";
+        Keys["AudioVolumeDown"] = "AudioVolumeDown";
+        Keys["AudioVolumeUp"] = "AudioVolumeUp";
+        Keys["F1"] = "F1";
+        Keys["F2"] = "F2";
+        Keys["F3"] = "F3";
+        Keys["F4"] = "F4";
+        Keys["F5"] = "F5";
+        Keys["F6"] = "F6";
+        Keys["F7"] = "F7";
+        Keys["F8"] = "F8";
+        Keys["F9"] = "F9";
+        Keys["F10"] = "F10";
+        Keys["F11"] = "F11";
+        Keys["F12"] = "F12";
+        Keys["NumLock"] = "NumLock";
+        Keys["ScrollLock"] = "ScrollLock";
+        Keys["Semicolon"] = ";";
+        Keys["Equal"] = "=";
+        Keys["Comma"] = ",";
+        Keys["Minus"] = "-";
+        Keys["Period"] = ".";
+        Keys["Slash"] = "/";
+        Keys["Backquote"] = "`";
+        Keys["BracketLeft"] = "[";
+        Keys["Backslash"] = "\\";
+        Keys["BracketRight"] = "]";
+        Keys["Quote"] = "'";
+        Keys["Tilde"] = "~";
+        Keys["Exclamation"] = "!";
+        Keys["At"] = "@";
+        Keys["Sharp"] = "#";
+        Keys["Dollar"] = "$";
+        Keys["Percent"] = "%";
+        Keys["Caret"] = "^";
+        Keys["Ampersand"] = "&";
+        Keys["Asterisk"] = "*";
+        Keys["ParenthesisLeft"] = "(";
+        Keys["ParenthesisRight"] = ")";
+        Keys["Underscore"] = "_";
+        Keys["Plus"] = "+";
+        Keys["OpenBrace"] = "{";
+        Keys["CloseBrace"] = "}";
+        Keys["Pipe"] = "|";
+        Keys["Colon"] = ":";
+        Keys["Quote2"] = "\"";
+        Keys["AngleBracketLeft"] = "<";
+        Keys["AngleBracketRight"] = ">";
+        Keys["QuestionMark"] = "?";
+    })(Keys = Keyboard.Keys || (Keyboard.Keys = {}));
+    /**
+     * Codes for KeyboardEvent.code
+     */
+    let Codes;
+    (function (Codes) {
+        Codes["Backspace"] = "Backspace";
+        Codes["Tab"] = "Tab";
+        Codes["Enter"] = "Enter";
+        Codes["ShiftLeft"] = "ShiftLeft";
+        Codes["ShiftRight"] = "ShiftRight";
+        Codes["ControlLeft"] = "ControlLeft";
+        Codes["ControlRight"] = "ControlRight";
+        Codes["AltLeft"] = "AltLeft";
+        Codes["AltRight"] = "AltRight";
+        Codes["Pause"] = "Pause";
+        Codes["CapsLock"] = "CapsLock";
+        Codes["Escape"] = "Escape";
+        Codes["Space"] = "Space";
+        Codes["PageUp"] = "PageUp";
+        Codes["PageDown"] = "PageDown";
+        Codes["End"] = "End";
+        Codes["Home"] = "Home";
+        Codes["ArrowLeft"] = "ArrowLeft";
+        Codes["ArrowUp"] = "ArrowUp";
+        Codes["ArrowRight"] = "ArrowRight";
+        Codes["ArrowDown"] = "ArrowDown";
+        Codes["PrintScreen"] = "PrintScreen";
+        Codes["Insert"] = "Insert";
+        Codes["Delete"] = "Delete";
+        Codes["Digit0"] = "Digit0";
+        Codes["Digit1"] = "Digit1";
+        Codes["Digit2"] = "Digit2";
+        Codes["Digit3"] = "Digit3";
+        Codes["Digit4"] = "Digit4";
+        Codes["Digit5"] = "Digit5";
+        Codes["Digit6"] = "Digit6";
+        Codes["Digit7"] = "Digit7";
+        Codes["Digit8"] = "Digit8";
+        Codes["Digit9"] = "Digit9";
+        Codes["AudioVolumeMute"] = "AudioVolumeMute";
+        Codes["AudioVolumeDown"] = "AudioVolumeDown";
+        Codes["AudioVolumeUp"] = "AudioVolumeUp";
+        Codes["KeyA"] = "KeyA";
+        Codes["KeyB"] = "KeyB";
+        Codes["KeyC"] = "KeyC";
+        Codes["KeyD"] = "KeyD";
+        Codes["KeyE"] = "KeyE";
+        Codes["KeyF"] = "KeyF";
+        Codes["KeyG"] = "KeyG";
+        Codes["KeyH"] = "KeyH";
+        Codes["KeyI"] = "KeyI";
+        Codes["KeyJ"] = "KeyJ";
+        Codes["KeyK"] = "KeyK";
+        Codes["KeyL"] = "KeyL";
+        Codes["KeyM"] = "KeyM";
+        Codes["KeyN"] = "KeyN";
+        Codes["KeyO"] = "KeyO";
+        Codes["KeyP"] = "KeyP";
+        Codes["KeyQ"] = "KeyQ";
+        Codes["KeyR"] = "KeyR";
+        Codes["KeyS"] = "KeyS";
+        Codes["KeyT"] = "KeyT";
+        Codes["KeyU"] = "KeyU";
+        Codes["KeyV"] = "KeyV";
+        Codes["KeyW"] = "KeyW";
+        Codes["KeyX"] = "KeyX";
+        Codes["KeyY"] = "KeyY";
+        Codes["KeyZ"] = "KeyZ";
+        Codes["MetaLeft"] = "MetaLeft";
+        Codes["MetaRight"] = "MetaRight";
+        Codes["ContextMenu"] = "ContextMenu";
+        Codes["Numpad0"] = "Numpad0";
+        Codes["Numpad1"] = "Numpad1";
+        Codes["Numpad2"] = "Numpad2";
+        Codes["Numpad3"] = "Numpad3";
+        Codes["Numpad4"] = "Numpad4";
+        Codes["Numpad5"] = "Numpad5";
+        Codes["Numpad6"] = "Numpad6";
+        Codes["Numpad7"] = "Numpad7";
+        Codes["Numpad8"] = "Numpad8";
+        Codes["Numpad9"] = "Numpad9";
+        Codes["NumpadMultiply"] = "NumpadMultiply";
+        Codes["NumpadAdd"] = "NumpadAdd";
+        Codes["NumpadSubtract"] = "NumpadSubtract";
+        Codes["NumpadDecimal"] = "NumpadDecimal";
+        Codes["NumpadDivide"] = "NumpadDivide";
+        Codes["F1"] = "F1";
+        Codes["F2"] = "F2";
+        Codes["F3"] = "F3";
+        Codes["F4"] = "F4";
+        Codes["F5"] = "F5";
+        Codes["F6"] = "F6";
+        Codes["F7"] = "F7";
+        Codes["F8"] = "F8";
+        Codes["F9"] = "F9";
+        Codes["F10"] = "F10";
+        Codes["F11"] = "F11";
+        Codes["F12"] = "F12";
+        Codes["NumLock"] = "NumLock";
+        Codes["ScrollLock"] = "ScrollLock";
+        Codes["Semicolon"] = "Semicolon";
+        Codes["Equal"] = "Equal";
+        Codes["Comma"] = "Comma";
+        Codes["Minus"] = "Minus";
+        Codes["Period"] = "Period";
+        Codes["Slash"] = "Slash";
+        Codes["Backquote"] = "Backquote";
+        Codes["BracketLeft"] = "BracketLeft";
+        Codes["Backslash"] = "Backslash";
+        Codes["BracketRight"] = "BracketRight";
+        Codes["Quote"] = "Quote";
+    })(Codes = Keyboard.Codes || (Keyboard.Codes = {}));
+    /**
+     * Is typing content or press command key
+     * @param input Input key
+     * @returns Result
+     */
+    function isTypingContent(input) {
+        return input.length === 1;
+    }
+    Keyboard.isTypingContent = isTypingContent;
+})(Keyboard = exports.Keyboard || (exports.Keyboard = {}));

package/lib/cjs/index.d.ts

@@ -5,6 +5,7 @@ export * from './DataTypes';
 export * from './DateUtils';
 export * from './DomUtils';
 export * from './ExtendUtils';
+export * from './Keyboard';
 export * from './NumberUtils';
 export * from './StorageUtils';
 export * from './Utils';

package/lib/cjs/index.js

@@ -17,6 +17,7 @@ __exportStar(require("./DataTypes"), exports);
 __exportStar(require("./DateUtils"), exports);
 __exportStar(require("./DomUtils"), exports);
 __exportStar(require("./ExtendUtils"), exports);
+__exportStar(require("./Keyboard"), exports);
 __exportStar(require("./NumberUtils"), exports);
 __exportStar(require("./StorageUtils"), exports);
 __exportStar(require("./Utils"), exports);