rx-hotkeys 2.2.0 → 2.3.0

package/README.md

@@ -128,7 +128,7 @@ Registers a key sequence shortcut.
 * `config`: The KeySequenceConfig object.
 * Returns the shortcut ID if successful, undefined otherwise.
 
-`setContext(contextName: string | null): void`
+`setContext(contextName: string | null): boolean`
 
 Sets the active context. Only shortcuts matching this context or global shortcuts (no context) will trigger.
 

package/dist/hotkeys.d.ts

@@ -84,8 +84,9 @@ export declare class Hotkeys {
      * will be active and can be triggered.
      * @param contextName - The name of the context (e.g., "modal", "editor", "global").
      * Pass `null` to activate shortcuts with no context or to deactivate context-specific shortcuts.
+     * @returns boolean
      */
-    setContext(contextName: string | null): void;
+    setContext(contextName: string | null): boolean;
     /**
      * Gets the current active context.
      * @returns The current context name as a string, or `null` if no context is set.

package/dist/hotkeys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hotkeys.d.ts","sourceRoot":"","sources":["../src/hotkeys.ts"],"names":[],"mappings":"AAAA,OAAO,EACuC,UAAU,EAEvD,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAIxC,oBAAY,aAAa;IACrB,WAAW,gBAAgB;IAC3B,QAAQ,aAAa;CACxB;AAED,UAAU,kBAAkB;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;IAC1C,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB;IAC5D;;;;;;;;;;OAUG;IACH,IAAI,EAAE;QACF;;;;;;;;;WASG;QACH,GAAG,EAAE,WAAW,CAAC;QACjB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,OAAO,CAAC,EAAE,OAAO,CAAC;KACrB,GAAG,WAAW,CAAC;CACnB;AAED,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IACzD;;;;;;;;OAQG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAyCD;;;;GAIG;AACH,qBAAa,OAAO;IAChB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAa;IAClD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAc;IAEhD,OAAO,CAAC,QAAQ,CAA4B;IAC5C,OAAO,CAAC,cAAc,CAAiC;IACvD,OAAO,CAAC,eAAe,CAA8B;IACrD,OAAO,CAAC,SAAS,CAAU;IAE3B;;;;;OAKG;gBACS,cAAc,GAAE,MAAM,GAAG,IAAW,EAAE,SAAS,GAAE,OAAe;IAe5E;;;;;;OAMG;IACI,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAiBnD;;;OAGG;IACI,UAAU,IAAI,MAAM,GAAG,IAAI;IAIlC;;;;OAIG;IACI,YAAY,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAa1C;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAW,gBAAgB,IAAI,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,CAEvD;IAED;;;;OAIG;IACI,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAIvC,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,iBAAiB;IAkBzB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,MAAM,GAAG,SAAS;IA6EvE;;;;;;;;;;;;;;;;;;;OAmBG;IACI,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,GAAG,SAAS;IAiHjE;;;;;;OAMG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAYlC;;;;;;OAMG;IACI,kBAAkB,IAAI;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,aAAa,CAAA;KAAC,EAAE;IAa/G;;;;;OAKG;IACI,OAAO,IAAI,IAAI;CAOzB"}
+{"version":3,"file":"hotkeys.d.ts","sourceRoot":"","sources":["../src/hotkeys.ts"],"names":[],"mappings":"AAAA,OAAO,EACuC,UAAU,EAEvD,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAIxC,oBAAY,aAAa;IACrB,WAAW,gBAAgB;IAC3B,QAAQ,aAAa;CACxB;AAED,UAAU,kBAAkB;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;IAC1C,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB;IAC5D;;;;;;;;;;OAUG;IACH,IAAI,EAAE;QACF;;;;;;;;;WASG;QACH,GAAG,EAAE,WAAW,CAAC;QACjB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,OAAO,CAAC,EAAE,OAAO,CAAC;KACrB,GAAG,WAAW,CAAC;CACnB;AAED,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IACzD;;;;;;;;OAQG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAyCD;;;;GAIG;AACH,qBAAa,OAAO;IAChB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAa;IAClD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAc;IAEhD,OAAO,CAAC,QAAQ,CAA4B;IAC5C,OAAO,CAAC,cAAc,CAAiC;IACvD,OAAO,CAAC,eAAe,CAA8B;IACrD,OAAO,CAAC,SAAS,CAAU;IAE3B;;;;;OAKG;gBACS,cAAc,GAAE,MAAM,GAAG,IAAW,EAAE,SAAS,GAAE,OAAe;IAe5E;;;;;;;OAOG;IACI,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAkBtD;;;OAGG;IACI,UAAU,IAAI,MAAM,GAAG,IAAI;IAIlC;;;;OAIG;IACI,YAAY,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAa1C;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAW,gBAAgB,IAAI,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,CAEvD;IAED;;;;OAIG;IACI,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAIvC,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,iBAAiB;IAkBzB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,MAAM,GAAG,SAAS;IAgFvE;;;;;;;;;;;;;;;;;;;OAmBG;IACI,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,GAAG,SAAS;IAkHjE;;;;;;OAMG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAYlC;;;;;;OAMG;IACI,kBAAkB,IAAI;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,aAAa,CAAA;KAAC,EAAE;IAa/G;;;;;OAKG;IACI,OAAO,IAAI,IAAI;CAOzB"}

package/dist/hotkeys.js

@@ -63,21 +63,23 @@ export class Hotkeys {
      * will be active and can be triggered.
      * @param contextName - The name of the context (e.g., "modal", "editor", "global").
      * Pass `null` to activate shortcuts with no context or to deactivate context-specific shortcuts.
+     * @returns boolean
      */
     setContext(contextName) {
-        if (this.activeContext$.getValue() === contextName) {
+        const currentContext = this.activeContext$.getValue();
+        if (currentContext === contextName) {
             if (this.debugMode) {
                 // Optional: Log that no change is happening, or simply do nothing.
                 console.log(`${Hotkeys.LOG_PREFIX} setContext called with the same context "${contextName}". No change made.`);
             }
-            return; // Context is the same, so no further action is needed.
+            return false; // Context is the same, so no further action is needed.
         }
         // If we reach here, the context is actually changing.
-        const oldContext = this.activeContext$.getValue(); // For more informative logging
         if (this.debugMode) {
-            console.log(`${Hotkeys.LOG_PREFIX} Context changed from "${oldContext}" to "${contextName}".`);
+            console.log(`${Hotkeys.LOG_PREFIX} Context changed from "${currentContext}" to "${contextName}".`);
         }
         this.activeContext$.next(contextName);
+        return true;
     }
     /**
      * Gets the current active context.
@@ -184,8 +186,9 @@ export class Hotkeys {
         let keyDetailsForLog;
         if (typeof keys === "string") {
             // Shorthand: keys is StandardKey, implying no modifiers should be active
-            if (keys.trim() === "") {
-                console.warn(`${Hotkeys.LOG_PREFIX} Invalid "keys" (shorthand) for combination shortcut "${id}". Key string must not be empty. Shortcut not added.`);
+            // Corrected validation: Check for actual empty string, not a string that trims to empty.
+            if (keys === "") { // StandardKey type should prevent this, but check for robustness.
+                console.warn(`${Hotkeys.LOG_PREFIX} Invalid "keys" (shorthand) for combination shortcut "${id}". Key must not be an empty string. Shortcut not added.`);
                 return undefined;
             }
             configuredMainKey = keys;
@@ -197,8 +200,9 @@ export class Hotkeys {
         }
         else {
             // Object form
-            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.`);
+            // Corrected validation for keys.key
+            if (!keys || !keys.key || typeof keys.key !== "string" || keys.key === "") { // StandardKey type should prevent empty string for key.key
+                console.warn(`${Hotkeys.LOG_PREFIX} Invalid "keys.key" for combination shortcut "${id}". Key must be a non-empty string value from Keys. Shortcut not added.`);
                 return undefined;
             }
             configuredMainKey = keys.key;
@@ -270,8 +274,9 @@ export class Hotkeys {
             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.`);
+        // Corrected validation: Check for actual empty string, not a string that trims to empty.
+        if (sequence.some(key => typeof key !== "string" || key === "")) { // StandardKey type should prevent empty strings.
+            console.warn(`${Hotkeys.LOG_PREFIX} Invalid key in sequence for shortcut "${id}". All keys must be non-empty string values from Keys. Shortcut not added.`);
             return undefined;
         }
         const configuredSequence = sequence;

package/dist/hotkeys.test.js

@@ -152,16 +152,59 @@ describe("Hotkeys Library (Node.js Test Runner)", () => {
             activeContextNextSpy.mock.restore();
             consoleLogMock.mock.restore();
         });
+        it(`should log "no change" if context is set to the same value (debug mode on)`, () => {
+            keyManager.setContext("sameCtx"); // Set initial context
+            const consoleLogMock = mock.method(console, "log");
+            keyManager.setDebugMode(true);
+            consoleLogMock.mock.resetCalls(); // Clear previous logs
+            keyManager.setContext("sameCtx"); // Attempt to set the same context
+            const noChangeLogCall = consoleLogMock.mock.calls.find(call => call.arguments[0].includes(`setContext called with the same context "sameCtx". No change made.`));
+            assert.ok(noChangeLogCall, "No-change log not found or incorrect for same context.");
+            const changedLogCall = consoleLogMock.mock.calls.find(call => call.arguments[0].includes("Context changed from"));
+            assert.strictEqual(changedLogCall, undefined, "Context changed log should not appear for same context.");
+            consoleLogMock.mock.restore();
+        });
         it("should toggle debug mode and log its state", () => {
             const consoleLogMock = mock.method(console, "log");
             keyManager.setDebugMode(true);
             assert.ok(consoleLogMock.mock.calls.some(call => call.arguments[0].includes("Debug mode enabled")));
             consoleLogMock.mock.resetCalls();
             keyManager.setDebugMode(false);
-            console.log(">>>>>>>>>>>>>>>>>>>>>>>>>>>", consoleLogMock.mock.calls);
             assert.ok(consoleLogMock.mock.calls.some(call => call.arguments[0].includes("Debug mode disabled")));
             consoleLogMock.mock.restore();
         });
+        describe("setContext return value", () => {
+            it("should return true when context is changed from null to a new value", () => {
+                assert.strictEqual(keyManager.getContext(), null, "Initial context should be null");
+                const result = keyManager.setContext("newContext");
+                assert.strictEqual(result, true, "setContext should return true for a change from null");
+                assert.strictEqual(keyManager.getContext(), "newContext");
+            });
+            it("should return true when context is changed from one value to another", () => {
+                keyManager.setContext("initialContext"); // Set a non-null initial context
+                const result = keyManager.setContext("changedContext");
+                assert.strictEqual(result, true, "setContext should return true for a value-to-value change");
+                assert.strictEqual(keyManager.getContext(), "changedContext");
+            });
+            it("should return false when context is set to the same value (non-null)", () => {
+                keyManager.setContext("sameContext");
+                const result = keyManager.setContext("sameContext");
+                assert.strictEqual(result, false, "setContext should return false for no change (non-null)");
+                assert.strictEqual(keyManager.getContext(), "sameContext");
+            });
+            it("should return true when context is changed from a value to null", () => {
+                keyManager.setContext("initialContext");
+                const result = keyManager.setContext(null);
+                assert.strictEqual(result, true, "setContext should return true for a change to null");
+                assert.strictEqual(keyManager.getContext(), null);
+            });
+            it("should return false when context is set to null and already null", () => {
+                keyManager.setContext(null); // Ensure context is null
+                const result = keyManager.setContext(null);
+                assert.strictEqual(result, false, "setContext should return false for no change (already null)");
+                assert.strictEqual(keyManager.getContext(), null);
+            });
+        });
         describe("onContextChange$ observable", () => {
             it("should emit initial context to new subscriber", () => {
                 const manager = new Hotkeys("initial", false);
@@ -176,14 +219,14 @@ describe("Hotkeys Library (Node.js Test Runner)", () => {
                 const spy = createMockFn();
                 const sub = keyManager.onContextChange$.subscribe(spy); // Subscribes, gets initial null
                 spy.mockClear(); // Clear initial emission
-                keyManager.setContext("newContext");
-                assert.strictEqual(spy.calledCount, 1);
+                assert.ok(keyManager.setContext("newContext"), "setContext should have returned true for change");
+                assert.strictEqual(spy.calledCount, 1, "onContextChange$ did not emit on first change");
                 assert.strictEqual(spy.lastArgs[0], "newContext");
-                keyManager.setContext("anotherContext");
-                assert.strictEqual(spy.calledCount, 2);
+                assert.ok(keyManager.setContext("anotherContext"), "setContext should have returned true for second change");
+                assert.strictEqual(spy.calledCount, 2, "onContextChange$ did not emit on second change");
                 assert.strictEqual(spy.lastArgs[0], "anotherContext");
-                keyManager.setContext(null);
-                assert.strictEqual(spy.calledCount, 3);
+                assert.ok(keyManager.setContext(null), "setContext should have returned true for change to null");
+                assert.strictEqual(spy.calledCount, 3, "onContextChange$ did not emit on change to null");
                 assert.strictEqual(spy.lastArgs[0], null);
                 sub.unsubscribe();
             });
@@ -192,7 +235,7 @@ describe("Hotkeys Library (Node.js Test Runner)", () => {
                 const spy = createMockFn();
                 const sub = keyManager.onContextChange$.subscribe(spy); // Subscribes, gets "testContext"
                 spy.mockClear(); // Clear initial emission
-                keyManager.setContext("testContext"); // Set same context
+                assert.strictEqual(keyManager.setContext("testContext"), false, "setContext should have returned false for no change"); // Set same context
                 assert.strictEqual(spy.calledCount, 0, "Observable should not emit if context value is the same.");
                 sub.unsubscribe();
             });
@@ -340,6 +383,18 @@ describe("Hotkeys Library (Node.js Test Runner)", () => {
                 consoleLogMock.mock.restore();
                 keyManager.setDebugMode(false);
             });
+            it("should trigger callback for Keys.Space using shorthand", () => {
+                const config = { id: "spaceShorthand", keys: Keys.Space, callback: mockCallback };
+                keyManager.addCombination(config);
+                dispatchKeyEvent(" "); // Event key for space is " "
+                assert.strictEqual(mockCallback.calledCount, 1, "Callback for Keys.Space (shorthand) not called");
+            });
+            it("should trigger callback for Keys.Space using object form", () => {
+                const config = { id: "spaceObject", keys: { key: Keys.Space }, callback: mockCallback };
+                keyManager.addCombination(config);
+                dispatchKeyEvent(" ");
+                assert.strictEqual(mockCallback.calledCount, 1, "Callback for Keys.Space (object form) not called");
+            });
         });
     });
     describe("addSequence", () => {
@@ -402,6 +457,29 @@ describe("Hotkeys Library (Node.js Test Runner)", () => {
             assert.strictEqual(consoleErrorMock.mock.calls.length, 1);
             assert.ok(consoleErrorMock.mock.calls[0].arguments[0].includes(`Error in user callback for sequence shortcut "errorSeq"`));
         });
+        it("should trigger callback for a sequence including Keys.Space", () => {
+            const config = {
+                id: "seqWithSpace",
+                sequence: [Keys.G, Keys.Space, Keys.I],
+                callback: mockCallback
+            };
+            keyManager.addSequence(config);
+            dispatchKeyEvent(Keys.G);
+            dispatchKeyEvent(Keys.Space); // Dispatch " " for space
+            dispatchKeyEvent(Keys.I);
+            assert.strictEqual(mockCallback.calledCount, 1, "Callback for sequence with Keys.Space not called");
+        });
+        it("should trigger callback for a sequence starting or ending with Keys.Space", () => {
+            const config = {
+                id: "seqStartSpace",
+                sequence: [Keys.Space, Keys.A],
+                callback: mockCallback
+            };
+            keyManager.addSequence(config);
+            dispatchKeyEvent(Keys.Space);
+            dispatchKeyEvent(Keys.A);
+            assert.strictEqual(mockCallback.calledCount, 1, "Callback for sequence starting with Keys.Space not called");
+        });
         describe("Sequence Contextual Triggering", () => {
             let editorSequenceConfig;
             beforeEach(() => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rx-hotkeys",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "type": "module",
   "scripts": {
     "build": "tsc",