umbr-key-master 1.0.0

package/README.md

@@ -0,0 +1,3 @@
+# Key master 
+
+A simple vanilla JS libary to handle key events and run logic

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+import { Alphabet, AudioKey, ControlCharacter, DeviceKey, EditingKey, FunctionKey, GlyphModifierKey, IMEKey, ModifierKey, MultimediaKey, MultimediaNumpadKey, NavigationKey, SpecialKey, SpeechKey, UIKey, WhitespaceKey } from "./w3";
+/**
+ * Helper used to get custom data to pass to your callback when its conditions are met
+ */
+type GetDataCallback = (() => any | Promise<any>) | null;
+/**
+ * The key value of a keydown can be mapped from W3C UI Events / DOM spec
+ *
+ * these are what a keydown / keyup `key` value can be and is what you can pass to listen to specific combinations to trigger logic
+ */
+type PressableKey = Alphabet | ControlCharacter | GlyphModifierKey | SpecialKey | ModifierKey | WhitespaceKey | NavigationKey | EditingKey | UIKey | DeviceKey | IMEKey | FunctionKey | MultimediaKey | MultimediaNumpadKey | AudioKey | SpeechKey;
+/**
+ * Custom callback to run when the specific keys registered are met
+ */
+type KeyCallback = (...args: any[]) => any | Promise<any>;
+/**
+ * Represents a key combination manager that holds callbacks to run for specific key combinations
+ */
+export declare class KeyMaster {
+    private _getData;
+    /**
+     * Holds a list of current keys being pressed down
+     */
+    private readonly _keys;
+    /**
+     * Contains all the callbacks to run
+     */
+    private readonly _callbacks;
+    constructor(getDataFunc?: GetDataCallback);
+    /**
+     * Creates a key for list of pressable keys
+     * @param keys The list of keys to make an ID for specific callbacks
+     * @returns Key
+     */
+    private makeKey;
+    private handleKeyDown;
+    private run;
+    private handleKeyUp;
+    add(targetKeys: PressableKey[], callback: KeyCallback): void;
+    remove(callback: KeyCallback): void;
+    /**
+     * Call before destroying to clean up event listeners
+     */
+    dispose(): void;
+}
+export {};

package/dist/index.js

@@ -0,0 +1,84 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+/**
+ * Represents a key combination manager that holds callbacks to run for specific key combinations
+ */
+export class KeyMaster {
+    constructor(getDataFunc = null) {
+        this._getData = null;
+        /**
+         * Holds a list of current keys being pressed down
+         */
+        this._keys = new Set();
+        /**
+         * Contains all the callbacks to run
+         */
+        this._callbacks = new Map();
+        this.handleKeyDown = (event) => {
+            this._keys.add(event.key);
+            const pressed = Array.from(this._keys.values());
+            const key = this.makeKey(pressed);
+            const callbacks = this._callbacks.get(key);
+            if (callbacks) {
+                this.run(callbacks);
+            }
+        };
+        this.handleKeyUp = (event) => {
+            this._keys.delete(event.key);
+        };
+        this._getData = getDataFunc;
+        document.addEventListener("keydown", this.handleKeyDown);
+        document.addEventListener("keyup", this.handleKeyUp);
+    }
+    /**
+     * Creates a key for list of pressable keys
+     * @param keys The list of keys to make an ID for specific callbacks
+     * @returns Key
+     */
+    makeKey(keys) {
+        return keys.sort().join("_");
+    }
+    run(callbacks) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = this._getData ? yield this._getData() : null;
+            for (const callback of callbacks) {
+                yield callback(data);
+            }
+        });
+    }
+    add(targetKeys, callback) {
+        const key = this.makeKey(targetKeys);
+        if (!this._callbacks.has(key)) {
+            this._callbacks.set(key, []);
+        }
+        this._callbacks.get(key).push(callback);
+    }
+    remove(callback) {
+        for (const [key, callbacks] of this._callbacks.entries()) {
+            const index = callbacks.indexOf(callback);
+            if (index !== -1) {
+                callbacks.splice(index, 1);
+                if (callbacks.length === 0) {
+                    this._callbacks.delete(key);
+                }
+            }
+        }
+    }
+    /**
+     * Call before destroying to clean up event listeners
+     */
+    dispose() {
+        document.removeEventListener("keydown", this.handleKeyDown);
+        document.removeEventListener("keyup", this.handleKeyUp);
+        this._callbacks.clear();
+        this._keys.clear();
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAoDA;;GAEG;AACH,MAAM,OAAO,SAAS;IAapB,YAAY,cAA+B,IAAI;QAZvC,aAAQ,GAAoB,IAAI,CAAC;QAEzC;;WAEG;QACc,UAAK,GAAG,IAAI,GAAG,EAAgB,CAAC;QAEjD;;WAEG;QACc,eAAU,GAA+B,IAAI,GAAG,EAAE,CAAC;QAkB5D,kBAAa,GAAG,CAAC,KAAoB,EAAE,EAAE;YAC/C,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,GAAmB,CAAC,CAAC;YAE1C,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YAChD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAElC,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC3C,IAAI,SAAS,EAAE,CAAC;gBACd,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACtB,CAAC;QACH,CAAC,CAAC;QASM,gBAAW,GAAG,CAAC,KAAoB,EAAE,EAAE;YAC7C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAmB,CAAC,CAAC;QAC/C,CAAC,CAAC;QApCA,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC;QAE5B,QAAQ,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACzD,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACK,OAAO,CAAC,IAAc;QAC5B,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;IAca,GAAG,CAAC,SAAwB;;YACxC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YAC1D,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;KAAA;IAMD,GAAG,CAAC,UAA0B,EAAE,QAAqB;QACnD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAErC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED,MAAM,CAAC,QAAqB;QAC1B,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;YACzD,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC1C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjB,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBAC3B,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC3B,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,OAAO;QACL,QAAQ,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC5D,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACxD,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;CACF"}

package/dist/w3.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Mapped from https://www.w3.org/TR/uievents-key/#key-attr-values (only english set) for all values a keydown / keyup `key` can be mapped into
+ * TS types for better intelisense
+ */
+/**
+ * Contains all english alphabet charcters inclduing uppercase
+ */
+export type Alphabet = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z";
+export type ControlCharacter = "Backspace" | "Tab" | "Enter" | "Escape" | "Delete";
+export type GlyphModifierKey = "Shift" | "CapsLock" | "AltGr";
+export type SpecialKey = "Unidentified";
+export type ModifierKey = "Alt" | "AltGraph" | "CapsLock" | "Control" | "Fn" | "FnLock" | "Meta" | "NumLock" | "ScrollLock" | "Shift" | "Symbol" | "SymbolLock" | "Hyper" | "Super";
+export type WhitespaceKey = "Enter" | "Tab";
+export type NavigationKey = "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "GoHome" | "PageDown" | "PageUp";
+export type EditingKey = "Backspace" | "Clear" | "Copy" | "CrSel" | "Cut" | "Delete" | "EraseEof" | "ExSel" | "Insert" | "Paste" | "Redo" | "Undo";
+export type UIKey = "Accept" | "Again" | "Attn" | "Cancel" | "ContextMenu" | "Escape" | "Execute" | "Find" | "Help" | "Pause" | "Play" | "Props" | "Select" | "ZoomIn" | "ZoomOut";
+export type DeviceKey = "BrightnessDown" | "BrightnessUp" | "Eject" | "LogOff" | "Power" | "PowerOff" | "PrintScreen" | "Hibernate" | "Standby" | "WakeUp";
+export type IMEKey = "AllCandidates" | "Alphanumeric" | "CodeInput" | "Compose" | "Convert" | "Dead" | "FinalMode" | "GroupFirst" | "GroupLast" | "GroupNext" | "GroupPrevious" | "ModeChange" | "NextCandidate" | "NonConvert" | "PreviousCandidate" | "Process" | "SingleCandidate" | "HangulMode" | "HanjaMode" | "JunjaMode" | "Eisu" | "Hankaku" | "Hiragana" | "HiraganaKatakana" | "KanaMode" | "KanjiMode" | "Katakana" | "Romaji" | "Zenkaku" | "ZenkakuHankaku";
+export type FunctionKey = "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | "Soft1" | "Soft2" | "Soft3" | "Soft4";
+export type MultimediaKey = "ChannelDown" | "ChannelUp" | "Close" | "MailForward" | "MailReply" | "MailSend" | "MediaClose" | "MediaFastForward" | "MediaPause" | "MediaPlay" | "MediaPlayPause" | "MediaRecord" | "MediaRewind" | "MediaStop" | "MediaTrackNext" | "MediaTrackPrevious" | "New" | "Open" | "Print" | "Save" | "SpellCheck";
+export type MultimediaNumpadKey = "Key11" | "Key12";
+export type AudioKey = "AudioBalanceLeft" | "AudioBalanceRight" | "AudioBassBoostDown" | "AudioBassBoostToggle" | "AudioBassBoostUp" | "AudioFaderFront" | "AudioFaderRear" | "AudioSurroundModeNext" | "AudioTrebleDown" | "AudioTrebleUp" | "AudioVolumeDown" | "AudioVolumeUp" | "AudioVolumeMute" | "MicrophoneToggle" | "MicrophoneVolumeDown" | "MicrophoneVolumeUp" | "MicrophoneVolumeMute";
+export type SpeechKey = "SpeechCorrectionList" | "SpeechInputToggle";

package/dist/w3.js

@@ -0,0 +1,6 @@
+/**
+ * Mapped from https://www.w3.org/TR/uievents-key/#key-attr-values (only english set) for all values a keydown / keyup `key` can be mapped into
+ * TS types for better intelisense
+ */
+export {};
+//# sourceMappingURL=w3.js.map

package/dist/w3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"w3.js","sourceRoot":"","sources":["../src/w3.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "umbr-key-master",
+  "version": "1.0.0",
+  "description": "A simple key combination helper",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [
+    "key",
+    "keyboard",
+    "shortcut",
+    "combination"
+  ],
+  "author": "Yousaf Wazir",
+  "license": "ISC",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}