rx-hotkeys 1.0.0 → 2.0.0

package/README.md

@@ -26,18 +26,18 @@ npm install rxjs rx-hotkeys
 First, ensure you have the `rx-hotkeys` library and its helper Keys imported:
 
 ```typescript
-import { HotKeys, Keys, KeyCombinationConfig, KeySequenceConfig } from 'rx-hotkeys';
+import { Hotkeys, Keys, KeyCombinationConfig, KeySequenceConfig } from 'rx-hotkeys';
 ```
 
-1. Initialize HotKeys
+1. Initialize Hotkeys
 
 Create an instance of the `Hotkeys` class. You can optionally provide an initial context and enable debug mode.
 
 ```typescript
-const keyManager = new HotKeys(); // No initial context, debug mode off
+const keyManager = new Hotkeys(); // No initial context, debug mode off
 
 // With an initial context and debug mode enabled:
-// const keyManager = new HotKeys('editor', true);
+// const keyManager = new Hotkeys('editor', true);
 ```
 
 2. Add a Key Combination
@@ -93,7 +93,7 @@ keyManager.setContext(null);
 
 5. Clean Up
 
-When the HotKeys instance is no longer needed (e.g., component unmount), call `destroy()` to clean up subscriptions and prevent memory leaks.
+When the Hotkeys instance is no longer needed (e.g., component unmount), call `destroy()` to clean up subscriptions and prevent memory leaks.
 
 ```typescript
 // In a component lifecycle cleanup method or similar:
@@ -108,11 +108,11 @@ keyManager.destroy();
 * `Keys`: An exported constant object containing standard KeyboardEvent.key string values (e.g., Keys.Enter, Keys.ArrowUp, Keys.A). It's highly recommended to use these when defining key in `KeyCombinationConfig` or keys in the sequence array of `KeySequenceConfig`.
 * `StandardKey`: A TypeScript type representing any valid key string from the Keys object.
 
-### `HotKeys` Class
+### `Hotkeys` Class
 
 `constructor(initialContext?: string | null, debugMode?: boolean)`
 
-Creates a new HotKeys instance.
+Creates a new Hotkeys instance.
 
 `addCombination(config: KeyCombinationConfig): string | undefined`
 

package/dist/hotkeys.d.ts

@@ -48,7 +48,7 @@ export interface KeySequenceConfig extends ShortcutConfigBase {
  * Allows registration of single key combinations (e.g., Ctrl+S) and key sequences (e.g., g -> i).
  * Supports contexts to enable/disable shortcuts based on application state.
  */
-export declare class HotKeys {
+export declare class Hotkeys {
     private static readonly KEYDOWN_EVENT;
     private static readonly LOG_PREFIX;
     private keydown$;

package/dist/hotkeys.js

@@ -20,7 +20,7 @@ function compareKey(eventKey, configuredKey) {
  * Allows registration of single key combinations (e.g., Ctrl+S) and key sequences (e.g., g -> i).
  * Supports contexts to enable/disable shortcuts based on application state.
  */
-export class HotKeys {
+export class Hotkeys {
     static KEYDOWN_EVENT = "keydown";
     static LOG_PREFIX = "Hotkeys:";
     keydown$;
@@ -36,13 +36,13 @@ export class HotKeys {
     constructor(initialContext = null, debugMode = false) {
         this.debugMode = debugMode;
         if (typeof document === "undefined" || typeof performance === "undefined") {
-            throw new Error(`${HotKeys.LOG_PREFIX} Hotkeys can only be used in a browser environment with global 'document' and 'performance' objects.`);
+            throw new Error(`${Hotkeys.LOG_PREFIX} Hotkeys can only be used in a browser environment with global 'document' and 'performance' objects.`);
         }
-        this.keydown$ = fromEvent(document, HotKeys.KEYDOWN_EVENT);
+        this.keydown$ = fromEvent(document, Hotkeys.KEYDOWN_EVENT);
         this.activeContext$ = new BehaviorSubject(initialContext);
         this.activeShortcuts = new Map();
         if (this.debugMode) {
-            console.log(`${HotKeys.LOG_PREFIX} Library initialized. Initial context: "${initialContext}". Debug mode: ${debugMode}.`);
+            console.log(`${Hotkeys.LOG_PREFIX} Library initialized. Initial context: "${initialContext}". Debug mode: ${debugMode}.`);
         }
     }
     /**
@@ -54,7 +54,7 @@ export class HotKeys {
      */
     setContext(contextName) {
         if (this.debugMode) {
-            console.log(`${HotKeys.LOG_PREFIX} Context changed to "${contextName}"`);
+            console.log(`${Hotkeys.LOG_PREFIX} Context changed to "${contextName}"`);
         }
         this.activeContext$.next(contextName);
     }
@@ -73,7 +73,7 @@ export class HotKeys {
     setDebugMode(enable) {
         this.debugMode = enable;
         if (this.debugMode) {
-            console.log(`${HotKeys.LOG_PREFIX} Debug mode ${enable ? 'enabled' : 'disabled'}.`);
+            console.log(`${Hotkeys.LOG_PREFIX} Debug mode ${enable ? 'enabled' : 'disabled'}.`);
         }
     }
     /**
@@ -90,12 +90,12 @@ export class HotKeys {
     _registerShortcut(config, subscription, type, detailsForLog) {
         const existingShortcut = this.activeShortcuts.get(config.id);
         if (existingShortcut) {
-            console.warn(`${HotKeys.LOG_PREFIX} Shortcut with ID "${config.id}" already exists. It will be overwritten.`);
+            console.warn(`${Hotkeys.LOG_PREFIX} Shortcut with ID "${config.id}" already exists. It will be overwritten.`);
             existingShortcut.subscription.unsubscribe();
         }
         this.activeShortcuts.set(config.id, { id: config.id, config, subscription });
         if (this.debugMode) {
-            console.log(`${HotKeys.LOG_PREFIX} ${type} shortcut "${config.id}" added. ${detailsForLog}, Context: ${config.context ?? "any"}`);
+            console.log(`${Hotkeys.LOG_PREFIX} ${type} shortcut "${config.id}" added. ${detailsForLog}, Context: ${config.context ?? "any"}`);
         }
         return config.id;
     }
@@ -121,7 +121,7 @@ export class HotKeys {
     addCombination(config) {
         const { keys, callback, context, preventDefault = false, id } = config;
         if (!keys || !keys.key || typeof keys.key !== 'string' || keys.key.trim() === '') {
-            console.warn(`${HotKeys.LOG_PREFIX} Invalid 'keys.key' for combination shortcut "${id}". Key must be a non-empty value from Keys. Shortcut not added.`);
+            console.warn(`${Hotkeys.LOG_PREFIX} Invalid 'keys.key' for combination shortcut "${id}". Key must be a non-empty value from Keys. Shortcut not added.`);
             return undefined;
         }
         const configuredMainKey = keys.key;
@@ -131,12 +131,12 @@ export class HotKeys {
             (keys.metaKey === undefined || event.metaKey === keys.metaKey)), filter(event => compareKey(event.key, configuredMainKey)), tap(event => {
             if (this.debugMode) {
                 const preventAction = preventDefault ? ", preventing default" : "";
-                console.log(`${HotKeys.LOG_PREFIX} Combination "${id}" triggered${preventAction}.`);
+                console.log(`${Hotkeys.LOG_PREFIX} Combination "${id}" triggered${preventAction}.`);
             }
             if (preventDefault)
                 event.preventDefault();
         }), catchError(err => {
-            console.error(`${HotKeys.LOG_PREFIX} Error in combination stream for shortcut "${id}":`, err);
+            console.error(`${Hotkeys.LOG_PREFIX} Error in combination stream for shortcut "${id}":`, err);
             return EMPTY;
         }));
         const subscription = shortcut$.subscribe(event => {
@@ -144,7 +144,7 @@ export class HotKeys {
                 callback(event);
             }
             catch (e) {
-                console.error(`${HotKeys.LOG_PREFIX} Error in user callback for combination shortcut "${id}":`, e);
+                console.error(`${Hotkeys.LOG_PREFIX} Error in user callback for combination shortcut "${id}":`, e);
             }
         });
         const keyDetails = `key: "${keys.key}"` +
@@ -177,11 +177,11 @@ export class HotKeys {
     addSequence(config) {
         const { sequence, callback, context, preventDefault = false, id, sequenceTimeoutMs } = config;
         if (!Array.isArray(sequence) || sequence.length === 0) {
-            console.warn(`${HotKeys.LOG_PREFIX} Sequence for shortcut "${id}" is empty or invalid. Shortcut not added.`);
+            console.warn(`${Hotkeys.LOG_PREFIX} Sequence for shortcut "${id}" is empty or invalid. Shortcut not added.`);
             return undefined;
         }
         if (sequence.some(key => typeof key !== 'string' || key.trim() === '')) {
-            console.warn(`${HotKeys.LOG_PREFIX} Invalid key in sequence for shortcut "${id}". All keys must be non-empty strings from Keys. Shortcut not added.`);
+            console.warn(`${Hotkeys.LOG_PREFIX} Invalid key in sequence for shortcut "${id}". All keys must be non-empty strings from Keys. Shortcut not added.`);
             return undefined;
         }
         const configuredSequence = sequence;
@@ -198,7 +198,7 @@ export class HotKeys {
                 }
                 if (matchedEvents.length > 0 && (currentTime - lastEventTime > sequenceTimeoutMs)) {
                     if (this.debugMode) {
-                        console.log(`${HotKeys.LOG_PREFIX} Sequence "${id}" (timeout: ${sequenceTimeoutMs}ms) attempt timed out. Matched: ${matchedEvents.map(e => e.key).join(',')}. Resetting.`);
+                        console.log(`${Hotkeys.LOG_PREFIX} Sequence "${id}" (timeout: ${sequenceTimeoutMs}ms) attempt timed out. Matched: ${matchedEvents.map(e => e.key).join(',')}. Resetting.`);
                     }
                     matchedEvents = [];
                 }
@@ -213,7 +213,7 @@ export class HotKeys {
                     const newMatchedEvents = [...matchedEvents, event];
                     if (newMatchedEvents.length === sequenceLength) {
                         if (this.debugMode)
-                            console.log(`${HotKeys.LOG_PREFIX} Sequence "${id}" (timeout: ${sequenceTimeoutMs}ms) matched.`);
+                            console.log(`${Hotkeys.LOG_PREFIX} Sequence "${id}" (timeout: ${sequenceTimeoutMs}ms) matched.`);
                         return { matchedEvents: newMatchedEvents, lastEventTime: currentTime, emitState: 'emit' };
                     }
                     else {
@@ -222,7 +222,7 @@ export class HotKeys {
                 }
                 else {
                     if (matchedEvents.length > 0 && this.debugMode) {
-                        console.log(`${HotKeys.LOG_PREFIX} Sequence "${id}" (timeout: ${sequenceTimeoutMs}ms) broken by key "${event.key}". Matched: ${matchedEvents.map(e => e.key).join(',')}. Resetting.`);
+                        console.log(`${Hotkeys.LOG_PREFIX} Sequence "${id}" (timeout: ${sequenceTimeoutMs}ms) broken by key "${event.key}". Matched: ${matchedEvents.map(e => e.key).join(',')}. Resetting.`);
                     }
                     if (sequenceLength > 0 && compareKey(event.key, configuredSequence[0])) {
                         return { matchedEvents: [event], lastEventTime: currentTime, emitState: 'in-progress' };
@@ -244,13 +244,13 @@ export class HotKeys {
             if (this.debugMode) {
                 const timeoutInfo = (sequenceTimeoutMs && sequenceTimeoutMs > 0) ? ` (with timeout logic)` : ` (no timeout logic)`;
                 const preventAction = preventDefault ? ", preventing default for last event" : "";
-                console.log(`${HotKeys.LOG_PREFIX} Sequence "${id}" triggered${timeoutInfo}${preventAction}.`);
+                console.log(`${Hotkeys.LOG_PREFIX} Sequence "${id}" triggered${timeoutInfo}${preventAction}.`);
             }
             if (preventDefault && events.length > 0) {
                 events[events.length - 1].preventDefault();
             }
         }), catchError(err => {
-            console.error(`${HotKeys.LOG_PREFIX} Error in sequence stream for shortcut "${id}":`, err);
+            console.error(`${Hotkeys.LOG_PREFIX} Error in sequence stream for shortcut "${id}":`, err);
             return EMPTY;
         }));
         const subscription = finalShortcut$.subscribe((events) => {
@@ -259,7 +259,7 @@ export class HotKeys {
                     callback(events[events.length - 1]);
             }
             catch (e) {
-                console.error(`${HotKeys.LOG_PREFIX} Error in user callback for sequence shortcut "${id}":`, e);
+                console.error(`${Hotkeys.LOG_PREFIX} Error in user callback for sequence shortcut "${id}":`, e);
             }
         });
         const logDetails = `Sequence: ${sequence.join(" -> ")}${sequenceTimeoutMs && sequenceTimeoutMs > 0 ? ` (timeout: ${sequenceTimeoutMs}ms)` : ''}`;
@@ -278,10 +278,10 @@ export class HotKeys {
             shortcut.subscription.unsubscribe();
             this.activeShortcuts.delete(id);
             if (this.debugMode)
-                console.log(`${HotKeys.LOG_PREFIX} Shortcut "${id}" removed.`);
+                console.log(`${Hotkeys.LOG_PREFIX} Shortcut "${id}" removed.`);
             return true;
         }
-        console.warn(`${HotKeys.LOG_PREFIX} Shortcut with ID "${id}" not found for removal.`);
+        console.warn(`${Hotkeys.LOG_PREFIX} Shortcut with ID "${id}" not found for removal.`);
         return false;
     }
     /**
@@ -311,11 +311,11 @@ export class HotKeys {
      */
     destroy() {
         if (this.debugMode)
-            console.log(`${HotKeys.LOG_PREFIX} Destroying library instance and unsubscribing all shortcuts.`);
+            console.log(`${Hotkeys.LOG_PREFIX} Destroying library instance and unsubscribing all shortcuts.`);
         this.activeShortcuts.forEach(shortcut => shortcut.subscription.unsubscribe());
         this.activeShortcuts.clear();
         this.activeContext$.complete(); // Complete the BehaviorSubject to release its resources
         if (this.debugMode)
-            console.log(`${HotKeys.LOG_PREFIX} Library destroyed.`);
+            console.log(`${Hotkeys.LOG_PREFIX} Library destroyed.`);
     }
 }

package/dist/hotkeys.test.js

@@ -1,7 +1,7 @@
 import { describe, it, before, beforeEach, afterEach, mock } from "node:test";
 import assert from "node:assert";
 // Importing main library components
-import { HotKeys } from "./hotkeys.js";
+import { Hotkeys } from "./hotkeys.js";
 // Importing Keys and StandardKey from the separate keys.js file
 import { Keys } from "./keys.js";
 import { fromEvent, BehaviorSubject } from "rxjs";
@@ -49,7 +49,7 @@ describe("Hotkeys Library (Node.js Test Runner)", () => {
     let consoleErrorMock;
     let performanceNowMock; // To mock global.performance.now specifically for sequence tests
     beforeEach(() => {
-        keyManager = new HotKeys(null, false);
+        keyManager = new Hotkeys(null, false);
         mockCallback = createMockFn();
         consoleWarnMock = mock.method(console, "warn");
         consoleErrorMock = mock.method(console, "error");
@@ -72,13 +72,13 @@ describe("Hotkeys Library (Node.js Test Runner)", () => {
     });
     describe("Initialization and Basic Context", () => {
         it("should initialize without errors", () => {
-            assert(keyManager instanceof HotKeys);
+            assert(keyManager instanceof Hotkeys);
         });
         it("should initialize with a null context by default", () => {
             assert.strictEqual(keyManager.getContext(), null);
         });
         it("should initialize with a given initial context", () => {
-            const manager = new HotKeys("editor");
+            const manager = new Hotkeys("editor");
             assert.strictEqual(manager.getContext(), "editor");
             manager.destroy();
         });

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { type StandardKey, Keys, } from "./keys.js";
-export { type KeyCombinationConfig, type KeySequenceConfig, HotKeys, } from "./hotkeys.js";
+export { type KeyCombinationConfig, type KeySequenceConfig, Hotkeys, } from "./hotkeys.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,2 +1,2 @@
 export { Keys, } from "./keys.js";
-export { HotKeys, } from "./hotkeys.js";
+export { Hotkeys, } from "./hotkeys.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rx-hotkeys",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "type": "module",
   "scripts": {
     "build": "tsc",
@@ -14,7 +14,12 @@
       "types": "./dist/index.d.ts"
     }
   },
-  "keywords": ["rxjs", "hotkeys", "hotkey", "key"],
+  "keywords": [
+    "rxjs",
+    "hotkeys",
+    "hotkey",
+    "key"
+  ],
   "author": "Colin Cheng <zbinlin@outlook.com>",
   "repository": {
     "type": "git",