umbr-key-master 1.0.3 → 1.0.4

package/README.md

@@ -1,107 +1,120 @@
 # KeyMaster
 
-`KeyMaster` is a TypeScript library for managing complex keyboard shortcuts and key combinations in the browser. It allows you to register callbacks for specific key sequences, supporting all W3C/DOM-standard key types.
+`KeyMaster` is a TypeScript library for managing complex keyboard shortcuts and key combinations in the browser. It allows you to register callbacks for specific key sequences, supporting all W3C/DOM-standard key values.
 
 ---
 
 ## Features
 
-* Listen to single keys or combinations of multiple keys.
-* Supports all standard key types, including:
-
-  * Alphabet keys (A-Z)
-  * Control characters (Enter, Escape, etc.)
-  * Modifier keys (Shift, Ctrl, Alt, Meta)
-  * Navigation keys (Arrow keys, Home, End, etc.)
-  * Function keys (F1-F12)
-  * Multimedia and Audio keys
-  * And more…
-* Optional callback data via a custom function.
-* Easy registration and removal of callbacks.
-* Handles multiple key presses simultaneously.
-* Safe cleanup of event listeners.
+* **Multi-Key Support**: Listen to single keys or complex combinations (e.g., `Ctrl + Shift + S`).
+* **Standard Compliant**: Supports all standard key types defined by the W3C UI Events spec:
+* **Alphabet keys** (A-Z)
+* **Control keys** (Enter, Escape, Backspace)
+* **Modifier keys** (Shift, Ctrl, Alt, Meta)
+* **Navigation keys** (Arrow keys, Home, End)
+* **Function keys** (F1-F12)
+* **Multimedia & Device keys**
+
+
+* **Contextual Data**: Pass custom data or state to your callbacks automatically.
+* **Memory Safe**: Simple `dispose()` method to clean up event listeners and prevent memory leaks.
 
 ---
 
 ## Installation
 
 ```bash
-npm i umbr-key-master
+npm install umbr-key-master
+
 ```
 
 ---
 
 ## Usage
 
-```ts
-import { KeyMaster } from "umbr-key-master";
-import { Alphabet, ModifierKey } from "umbr-key-master/w3";
+```typescript
+import { KeyMaster, PressableKey } from "umbr-key-master";
 
-// Optional function to provide custom data to callbacks
-const getData = () => ({ user: "Alice" });
+// 1. (Optional) Define a function to provide context/data to your callbacks
+const getContext = () => ({ 
+  timestamp: Date.now(),
+  activeEditor: "main-text-area" 
+});
 
-// Initialize KeyMaster
-const km = new KeyMaster(getData);
+// 2. Initialize KeyMaster
+const km = new KeyMaster(getContext);
 
-// Register a key combination (Shift + A)
-km.add([ModifierKey.Shift, Alphabet.A], (data) => {
-  console.log("Shift + A pressed!", data);
+// 3. Register a key combination (e.g., Shift + A)
+// Note: Key strings match W3C "key" values
+km.add(["Shift", "a"], (data) => {
+  console.log("Combination triggered!", data);
 });
 
-// Register another combination (Ctrl + B)
-km.add([ModifierKey.Control, Alphabet.B], () => {
-  console.log("Ctrl + B pressed!");
+// 4. Register a single key callback
+km.add(["Enter"], () => {
+  console.log("Enter key was pressed");
 });
 
-// Remove a callback
-const callback = (data: any) => console.log("This will be removed", data);
-km.add([Alphabet.C], callback);
-km.remove(callback);
+// 5. Removing a callback
+const myCallback = () => console.log("Temporary shortcut");
+km.add(["Control", "s"], myCallback);
+
+// Later...
+km.remove(myCallback);
 
-// Dispose when done to clean up event listeners
+// 6. Clean up when the component or page is destroyed
 km.dispose();
+
 ```
 
 ---
 
-## API
+## API Reference
 
-### `constructor(getDataFunc?: () => any | Promise<any>)`
+### `constructor(getDataFunc?: GetDataCallback)`
 
-* `getDataFunc` (optional): Function that returns custom data passed to callbacks.
+Initializes the listener.
 
-### `add(targetKeys: PressableKey[], callback: KeyCallback)`
+* **`getDataFunc`**: (Optional) A sync or async function. The return value of this function is passed as the first argument to every triggered callback.
 
-* Registers a callback for a specific key combination.
-* `targetKeys`: Array of keys to listen for.
-* `callback`: Function to execute when the keys are pressed.
+### `add(targetKeys: PressableKey[], callback: KeyCallback): void`
 
-### `remove(callback: KeyCallback)`
+Registers a callback to a specific combination.
 
-* Removes a previously registered callback.
+* **`targetKeys`**: An array of `PressableKey` strings. The order does not matter as the library sorts them internally.
+* **`callback`**: The function to run when all keys in the array (and *only* those keys) are held down.
 
-### `dispose()`
+### `remove(callback: KeyCallback): void`
 
-* Cleans up all event listeners and callbacks. Call this before destroying KeyMaster.
+Unregisters a specific callback function from all key combinations it was assigned to.
+
+### `dispose(): void`
+
+Removes the `keydown` and `keyup` listeners from the `document` and clears all internal maps. Use this during component unmounting or page transitions.
 
 ---
 
-## Key Types
+## Supported Key Categories
 
-The library supports all keys defined in the W3C UI Events/DOM specification. Examples include:
+The library utilizes the full W3C UI Events key set. Common categories include:
 
-* `Alphabet` → A-Z
-* `ControlCharacter` → Enter, Escape, Backspace, etc.
-* `ModifierKey` → Shift, Control, Alt, Meta
-* `NavigationKey` → ArrowUp, ArrowDown, Home, End
-* `FunctionKey` → F1-F12
-* `MultimediaKey` → VolumeUp, Play, Pause
-* `AudioKey` → Mute, VolumeDown
-* `WhitespaceKey` → Space, Tab
-* And many more…
+| Category | Examples |
+| --- | --- |
+| **Modifiers** | `Shift`, `Control`, `Alt`, `Meta` |
+| **Navigation** | `ArrowUp`, `ArrowDown`, `Home`, `PageUp` |
+| **Editing** | `Backspace`, `Delete`, `Enter`, `Tab` |
+| **UI Control** | `Escape`, `ContextMenu`, `Pause` |
+| **Functions** | `F1` through `F20` |
+
+---
 
 ## License
 
 MIT © Yousaf Wazir
 
 
+# Building 
+
+- Change version up - push git change
+- Run `npm run build`
+- Run `npm run pubish`

package/dist/index.d.ts

@@ -1,45 +1,63 @@
-import { Alphabet, AudioKey, ControlCharacter, DeviceKey, EditingKey, FunctionKey, GlyphModifierKey, IMEKey, ModifierKey, MultimediaKey, MultimediaNumpadKey, NavigationKey, SpecialKey, SpeechKey, UIKey, WhitespaceKey } from "./w3";
+import { DeviceKey, EditingKey, FunctionKey, GlyphModifierKey, ModifierKey, NavigationKey, SpecialKey, UIEventUnicodeKey, UIKey, UnicodeControlKey, WhitespaceKey } from "./w3ckeyAttributeValues";
 /**
- * Helper used to get custom data to pass to your callback when its conditions are met
+ * Additional options for the KeyMaster instance.
+ */
+export type KeyMasterOptions = {
+    /**
+     * If true, key comparisons will ignore casing (e.g., 'A' and 'a' are treated as the same key).
+     * @default false
+     */
+    caseInsensitive?: boolean;
+};
+/**
+ * A function used to retrieve custom data passed to callbacks when conditions are met.
  */
 export 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
+ * Union type of valid key values mapped from the W3C UI Events / DOM specification.
  */
-export type PressableKey = Alphabet | ControlCharacter | GlyphModifierKey | SpecialKey | ModifierKey | WhitespaceKey | NavigationKey | EditingKey | UIKey | DeviceKey | IMEKey | FunctionKey | MultimediaKey | MultimediaNumpadKey | AudioKey | SpeechKey;
+export type PressableKey = UIEventUnicodeKey | UnicodeControlKey | GlyphModifierKey | SpecialKey | ModifierKey | WhitespaceKey | NavigationKey | EditingKey | UIKey | DeviceKey | FunctionKey;
 /**
- * Custom callback to run when the specific keys registered are met
+ * A callback function executed when registered key combinations are triggered.
  */
-export type KeyCallback = (...args: any[]) => any | Promise<any>;
+export type KeyCallback = (data: any) => any | Promise<any>;
 /**
- * Represents a key combination manager that holds callbacks to run for specific key combinations
+ * Manages keyboard shortcuts and multi-key combinations.
+ * Supports case-insensitive matching and contextual data injection.
  */
 export declare class KeyMaster {
     private _getData;
-    /**
-     * Holds a list of current keys being pressed down
-     */
     private readonly _keys;
+    private readonly _callbacks;
+    private _options;
     /**
-     * Contains all the callbacks to run
+     * @param getDataFunc - Optional helper to provide data to callbacks.
+     * @param options - Configuration options for key handling.
      */
-    private readonly _callbacks;
-    constructor(getDataFunc?: GetDataCallback);
+    constructor(getDataFunc?: GetDataCallback, options?: KeyMasterOptions);
     /**
-     * Creates a key for list of pressable keys
-     * @param keys The list of keys to make an ID for specific callbacks
-     * @returns Key
+     * Normalizes an array of keys into a sorted string ID.
+     * Handles case normalization if caseInsensitive is enabled.
      */
     private makeKey;
     private handleKeyDown;
-    private run;
     private handleKeyUp;
+    /**
+     * Executes a list of callbacks with injected data.
+     */
+    private run;
+    /**
+     * Registers a callback for a specific combination of keys.
+     * @param targetKeys - Array of keys (e.g., ["Control", "S"]).
+     * @param callback - Function to trigger.
+     */
     add(targetKeys: PressableKey[], callback: KeyCallback): void;
+    /**
+     * Removes a callback from all registered combinations.
+     */
     remove(callback: KeyCallback): void;
     /**
-     * Call before destroying to clean up event listeners
+     * Cleans up event listeners and internal state.
      */
     dispose(): void;
 }

package/dist/index.js

@@ -8,43 +8,54 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 /**
- * Represents a key combination manager that holds callbacks to run for specific key combinations
+ * Manages keyboard shortcuts and multi-key combinations.
+ * Supports case-insensitive matching and contextual data injection.
  */
 export class KeyMaster {
-    constructor(getDataFunc = null) {
+    /**
+     * @param getDataFunc - Optional helper to provide data to callbacks.
+     * @param options - Configuration options for key handling.
+     */
+    constructor(getDataFunc = null, options = {}) {
         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 keyToStore = this._options.caseInsensitive
+                ? event.key.toLowerCase()
+                : event.key;
+            this._keys.add(keyToStore);
             const pressed = Array.from(this._keys.values());
-            const key = this.makeKey(pressed);
-            const callbacks = this._callbacks.get(key);
+            const comboId = this.makeKey(pressed);
+            const callbacks = this._callbacks.get(comboId);
             if (callbacks) {
                 this.run(callbacks);
             }
         };
         this.handleKeyUp = (event) => {
-            this._keys.delete(event.key);
+            const keyToRemove = this._options.caseInsensitive
+                ? event.key.toLowerCase()
+                : event.key;
+            this._keys.delete(keyToRemove);
         };
         this._getData = getDataFunc;
+        this._options = Object.assign({ caseInsensitive: false }, options);
         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
+     * Normalizes an array of keys into a sorted string ID.
+     * Handles case normalization if caseInsensitive is enabled.
      */
     makeKey(keys) {
-        return keys.sort().join("_");
+        const normalizedKeys = this._options.caseInsensitive
+            ? keys.map((k) => k.toLowerCase())
+            : keys;
+        return normalizedKeys.sort().join("_");
     }
+    /**
+     * Executes a list of callbacks with injected data.
+     */
     run(callbacks) {
         return __awaiter(this, void 0, void 0, function* () {
             const data = this._getData ? yield this._getData() : null;
@@ -53,26 +64,34 @@ export class KeyMaster {
             }
         });
     }
+    /**
+     * Registers a callback for a specific combination of keys.
+     * @param targetKeys - Array of keys (e.g., ["Control", "S"]).
+     * @param callback - Function to trigger.
+     */
     add(targetKeys, callback) {
-        const key = this.makeKey(targetKeys);
-        if (!this._callbacks.has(key)) {
-            this._callbacks.set(key, []);
+        const comboId = this.makeKey(targetKeys);
+        if (!this._callbacks.has(comboId)) {
+            this._callbacks.set(comboId, []);
         }
-        this._callbacks.get(key).push(callback);
+        this._callbacks.get(comboId).push(callback);
     }
+    /**
+     * Removes a callback from all registered combinations.
+     */
     remove(callback) {
-        for (const [key, callbacks] of this._callbacks.entries()) {
+        for (const [comboId, 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);
+                    this._callbacks.delete(comboId);
                 }
             }
         }
     }
     /**
-     * Call before destroying to clean up event listeners
+     * Cleans up event listeners and internal state.
      */
     dispose() {
         document.removeEventListener("keydown", this.handleKeyDown);

package/dist/index.js.map

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAmDA;;;GAGG;AACH,MAAM,OAAO,SAAS;IAMpB;;;OAGG;IACH,YACE,cAA+B,IAAI,EACnC,UAA4B,EAAE;QAXxB,aAAQ,GAAoB,IAAI,CAAC;QACxB,UAAK,GAAG,IAAI,GAAG,EAAU,CAAC;QAC1B,eAAU,GAA+B,IAAI,GAAG,EAAE,CAAC;QAiC5D,kBAAa,GAAG,CAAC,KAAoB,EAAE,EAAE;YAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe;gBAC9C,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE;gBACzB,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC;YAEd,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAE3B,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YAChD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAEtC,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAC/C,IAAI,SAAS,EAAE,CAAC;gBACd,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACtB,CAAC;QACH,CAAC,CAAC;QAEM,gBAAW,GAAG,CAAC,KAAoB,EAAE,EAAE;YAC7C,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe;gBAC/C,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE;gBACzB,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC;YAEd,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,CAAC,CAAC;QA5CA,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC;QAC5B,IAAI,CAAC,QAAQ,mBACX,eAAe,EAAE,KAAK,IACnB,OAAO,CACX,CAAC;QAEF,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;;;OAGG;IACK,OAAO,CAAC,IAAc;QAC5B,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe;YAClD,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,CAAC,CAAC,IAAI,CAAC;QAET,OAAO,cAAc,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IA0BD;;OAEG;IACW,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;IAED;;;;OAIG;IACH,GAAG,CAAC,UAA0B,EAAE,QAAqB;QACnD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,UAAsB,CAAC,CAAC;QAErD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QACnC,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAqB;QAC1B,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;YAC7D,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,OAAO,CAAC,CAAC;gBAClC,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/w3ckeyAttributeValues.d.ts

@@ -0,0 +1,242 @@
+/**
+ * Contains the Keyboard Event key Attribute Values from https://www.w3.org/TR/uievents-key/#key-attr-values mapped into Typescript types
+ */
+/**
+ * @see {@link https://www.w3.org/TR/uievents-key/#keys-unicode}
+ * 2.1. Unicode Values
+ * * A key string is a string containing a 0 or 1 non-control characters
+ * ("base" characters) followed by 0 or more combining characters.
+ * The string MUST be in Normalized Form C (NFC).
+ */
+/**
+ * Standard English (Latin-1) printable character set used as key attribute values.
+ */
+export type UnicodeKeyEnglish = "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" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "!" | '"' | "#" | "$" | "%" | "&" | "'" | "(" | ")" | "*" | "+" | "," | "-" | "." | "/" | ":" | ";" | "<" | "=" | ">" | "?" | "@" | "[" | "\\" | "]" | "^" | "_" | "`" | "{" | "|" | "}" | "~";
+/**
+ * Non-control whitespace Unicode characters defined in the spec.
+ * Note: Tab and Enter are defined as named control keys in § 2.1.1.
+ */
+export type UnicodeWhitespaceKey = 
+/** U+0020 Space */
+" "
+/** U+00A0 No-Break Space */
+ | "\u00A0"
+/** U+2009 Thin Space */
+ | "\u2009"
+/** U+3000 Ideographic Space */
+ | "\u3000";
+/**
+ * Union of Section 2.1 compliant English characters and whitespace.
+ */
+export type UIEventUnicodeKey = UnicodeKeyEnglish | UnicodeWhitespaceKey;
+/**
+ * @see {@link https://www.w3.org/TR/uievents-key/#keys-unicode}
+ * 2.1.1. Control Characters
+ * * A small number of characters in the Unicode "Cc" General Category
+ * are supported as named key attribute values.
+ */
+export type UnicodeControlKey = 
+/** U+0008 */
+"Backspace"
+/** U+0009 */
+ | "Tab"
+/** U+000D */
+ | "Enter"
+/** U+001B */
+ | "Escape"
+/** U+007F */
+ | "Delete";
+/**
+ * @see {@link https://www.w3.org/TR/uievents-key/#keys-unicode}
+ * 2.2. Selecting key Attribute Values
+ * * A glyph modifier key is any of the following modifier keys:
+ * Shift, CapsLock or AltGr.
+ */
+export type GlyphModifierKey = "Shift" | "CapsLock" | "AltGr";
+/**
+ * @see {@link https://www.w3.org/TR/uievents-key/#keys-unicode}
+ * 3.1. Special Keys
+ * * This key value is used when an implementation is unable to identify
+ * another key value, due to either hardware, platform, or software constraints.
+ */
+export type SpecialKey = "Unidentified";
+/**
+ * @see {@link https://www.w3.org/TR/uievents-key/#keys-unicode}
+ * 3.2. Modifier Keys
+ * * Modifier keys enable alternate functions for interpreting keyboard input.
+ */
+export type ModifierKey = 
+/** The Alt (Alternative) key. Used also for the Apple Option key. */
+"Alt"
+/** The Alternate Graphics (AltGr or AltGraph) key. */
+ | "AltGraph"
+/** The Caps Lock (Capital) key. Toggles capital character lock. */
+ | "CapsLock"
+/** The Control or Ctrl key. */
+ | "Control"
+/** The Function switch Fn key. Often handled in hardware. */
+ | "Fn"
+/** The Function-Lock (FnLock or F-Lock) key. */
+ | "FnLock"
+/** The Meta key. Used for the Windows Logo key and Apple Command key. */
+ | "Meta"
+/** The NumLock or Number Lock key. */
+ | "NumLock"
+/** The Scroll Lock key. */
+ | "ScrollLock"
+/** The Shift key. */
+ | "Shift"
+/** The Symbol modifier key (virtual keyboards). */
+ | "Symbol"
+/** The Symbol Lock key. */
+ | "SymbolLock"
+/** Legacy: The Hyper key. */
+ | "Hyper"
+/** Legacy: The Super key. */
+ | "Super";
+/**
+ * @see {@link https://www.w3.org/TR/uievents-key/#keys-unicode}
+ * 3.3. Whitespace Keys
+ * * This section defines keys that represent whitespace-related actions.
+ */
+export type WhitespaceKey = 
+/** * The Enter or ↵ key. Used for Return (Macintosh) and
+ * Android KEYCODE_DPAD_CENTER.
+ */
+"Enter"
+/** The Horizontal Tabulation Tab key. */
+ | "Tab";
+/**
+ * @see {@link https://www.w3.org/TR/uievents-key/#keys-unicode}
+ * 3.4. Navigation Keys
+ * * Navigation keys are used for moving the cursor or scrolling the viewport.
+ */
+export type NavigationKey = 
+/** The down arrow key. (KEYCODE_DPAD_DOWN) */
+"ArrowDown"
+/** The left arrow key. (KEYCODE_DPAD_LEFT) */
+ | "ArrowLeft"
+/** The right arrow key. (KEYCODE_DPAD_RIGHT) */
+ | "ArrowRight"
+/** The up arrow key. (KEYCODE_DPAD_UP) */
+ | "ArrowUp"
+/** The End key. (KEYCODE_MOVE_END) */
+ | "End"
+/** The Home key. (KEYCODE_MOVE_HOME) */
+ | "Home"
+/** The Page Down key. */
+ | "PageDown"
+/** The Page Up key. */
+ | "PageUp";
+/**
+ * @see {@link https://www.w3.org/TR/uievents-key/#keys-unicode}
+ * 3.5. Editing Keys
+ * * Editing keys are used for manipulating text or content.
+ */
+export type EditingKey = 
+/** The Backspace key. Also used for the 'Delete' label on MacOS. */
+"Backspace"
+/** Remove the currently selected input. */
+ | "Clear"
+/** Copy the current selection. (APPCOMMAND_COPY) */
+ | "Copy"
+/** The Cursor Select (Crsel) key. */
+ | "CrSel"
+/** Cut the current selection. (APPCOMMAND_CUT) */
+ | "Cut"
+/** The Delete (Del) Key. Also used for MacOS 'Delete' + 'Fn'. */
+ | "Delete"
+/** The Erase to End of Field key. */
+ | "EraseEof"
+/** The Extend Selection (Exsel) key. */
+ | "ExSel"
+/** The Insert (Ins) key. (KEYCODE_INSERT) */
+ | "Insert"
+/** The Paste key. (APPCOMMAND_PASTE) */
+ | "Paste"
+/** Redo the last action. (APPCOMMAND_REDO) */
+ | "Redo"
+/** Undo the last action. (APPCOMMAND_UNDO) */
+ | "Undo";
+/**
+ * @see {@link https://www.w3.org/TR/uievents-key/#keys-unicode}
+ * 3.6. UI Keys
+ * * UI keys are used for user interface interactions, such as menus,
+ * dialogs, and application-level commands.
+ */
+export type UIKey = 
+/** The Accept (Commit, OK) key. */
+"Accept"
+/** The Again key, to redo or repeat an action. */
+ | "Again"
+/** The Attention (Attn) key. */
+ | "Attn"
+/** The Cancel key. */
+ | "Cancel"
+/** Show the application’s context menu. */
+ | "ContextMenu"
+/** The Esc key, used to exit or "escape" the current context. */
+ | "Escape"
+/** The Execute key. */
+ | "Execute"
+/** Open the Find dialog. (APPCOMMAND_FIND) */
+ | "Find"
+/** Open a help dialog. (APPCOMMAND_HELP, KEYCODE_HELP) */
+ | "Help"
+/** Pause the current state. Not for media; use "MediaPause" instead. */
+ | "Pause"
+/** Play or resume the current state. Not for media; use "MediaPlay" instead. */
+ | "Play"
+/** The properties (Props) key. */
+ | "Props"
+/** The Select key. */
+ | "Select"
+/** The ZoomIn key. (KEYCODE_ZOOM_IN) */
+ | "ZoomIn"
+/** The ZoomOut key. (KEYCODE_ZOOM_OUT) */
+ | "ZoomOut";
+/**
+ * @see {@link https://www.w3.org/TR/uievents-key/#keys-unicode}
+ * 3.7. Device Keys
+ * * Device keys represent physical hardware controls, such as screen
+ * brightness and power management.
+ */
+export type DeviceKey = 
+/** The Brightness Down key. (KEYCODE_BRIGHTNESS_DOWN) */
+"BrightnessDown"
+/** The Brightness Up key. (KEYCODE_BRIGHTNESS_UP) */
+ | "BrightnessUp"
+/** Toggle removable media to eject or insert. (KEYCODE_MEDIA_EJECT) */
+ | "Eject"
+/** The LogOff key. */
+ | "LogOff"
+/** Toggle power state. Note: May not be exposed to the OS. (KEYCODE_POWER) */
+ | "Power"
+/** The PowerOff key. Sometimes called PowerDown. */
+ | "PowerOff"
+/** The Print Screen or SnapShot key. */
+ | "PrintScreen"
+/** The Hibernate key. Saves state to disk and shuts down. */
+ | "Hibernate"
+/** The Standby key. Low-power mode; sometimes labeled Suspend or Sleep. (KEYCODE_SLEEP) */
+ | "Standby"
+/** The WakeUp key. (KEYCODE_WAKEUP) */
+ | "WakeUp";
+/**
+ * @see {@link https://www.w3.org/TR/uievents-key/#keys-unicode}
+ * 3.9. General-Purpose Function Keys
+ * * General purpose function keys. Additional function key names are
+ * implicitly defined by incrementing the base-10 index at the end.
+ */
+export type FunctionKey = 
+/** Explicitly defined function keys F1 through F12 */
+"F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12"
+/** * Implicitly defined F-keys (e.g., "F24").
+ * This template literal covers any string starting with F and a number.
+ */
+ | `F${number}`
+/** Explicitly defined virtual function keys Soft1 through Soft4 */
+ | "Soft1" | "Soft2" | "Soft3" | "Soft4"
+/** * Implicitly defined Soft-keys (e.g., "Soft8").
+ */
+ | `Soft${number}`;

package/dist/w3ckeyAttributeValues.js

@@ -0,0 +1,5 @@
+/**
+ * Contains the Keyboard Event key Attribute Values from https://www.w3.org/TR/uievents-key/#key-attr-values mapped into Typescript types
+ */
+export {};
+//# sourceMappingURL=w3ckeyAttributeValues.js.map

package/dist/w3ckeyAttributeValues.js.map

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

package/package.json

@@ -1,25 +1,39 @@
-{
-  "name": "umbr-key-master",
-  "version": "1.0.3",
-  "description": "JS library for managing complex keyboard shortcuts and key combinations in the browser",
-  "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"
-  }
-}
+{
+  "name": "umbr-key-master",
+  "version": "1.0.4",
+  "description": "A lightweight, type-safe TypeScript library for managing complex keyboard shortcuts and multi-key combinations in the browser.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/UmbrellaCrow612/key-master.git"
+  },
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [
+    "key",
+    "keyboard",
+    "shortcut",
+    "hotkeys",
+    "key-combinations",
+    "typescript",
+    "dom-events",
+    "w3c-keys",
+    "event-listener",
+    "keyboard-manager"
+  ],
+  "author": "Yousaf Wazir",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/UmbrellaCrow612/key-master/issues"
+  },
+  "homepage": "https://github.com/UmbrellaCrow612/key-master#readme",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}

package/dist/w3.d.ts

@@ -1,23 +0,0 @@
-/**
- * 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

@@ -1,6 +0,0 @@
-/**
- * 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

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