@inklu/keys 1.3.0 → 1.4.1

package/README.md

@@ -15,16 +15,16 @@ A command is an addressable action. It has an id, title, and a handler.
 import { createCommands, seq } from "@inklu/keys";
 
 export const commands = createCommands({
-  "palette.open": {
-    title: "Open command palette",
-    keys: "Mod+K",
-    run: () => setPaletteOpen(true),
-  },
-  "nav.inbox": {
-    title: "Go to inbox",
-    keys: seq("G", "I"), // press G, then I
-    run: () => navigate("/inbox"),
-  },
+	"palette.open": {
+		title: "Open command palette",
+		keys: "Mod+K",
+		run: () => setPaletteOpen(true),
+	},
+	"nav.inbox": {
+		title: "Go to inbox",
+		keys: seq("G", "I"), // press G, then I
+		run: () => navigate("/inbox"),
+	},
 });
 ```
 
@@ -37,24 +37,26 @@ import { useCommands, useMountCommands, useShortcut } from "@inklu/keys/react";
 import { commands } from "./commands";
 
 function App() {
-  // Starts listening in an effect
-  useMountCommands(commands);
-  return <ShortcutButton />;
+	// Starts listening in an effect
+	useMountCommands(commands);
+	return <ShortcutButton />;
 }
 
 function ShortcutButton() {
-  // Get live shortcut state
-  const shortcut = useShortcut(commands, "palette.open");
-  
-  return (
-    <button 
-      onClick={() => commands.run("palette.open")}
-      aria-keyshortcuts={shortcut.aria || undefined}
-    >
-      Open Palette
-      {shortcut.tokens[0]?.map((token, i) => <kbd key={i}>{token}</kbd>)}
-    </button>
-  );
+	// Get live shortcut state
+	const shortcut = useShortcut(commands, "palette.open");
+
+	return (
+		<button
+			onClick={() => commands.run("palette.open")}
+			aria-keyshortcuts={shortcut.aria || undefined}
+		>
+			Open Palette
+			{shortcut.tokens[0]?.map((token, i) => (
+				<kbd key={i}>{token}</kbd>
+			))}
+		</button>
+	);
 }
 ```
 
@@ -66,10 +68,10 @@ Use scopes to isolate commands when modals or dialogs are open.
 import { useScope } from "@inklu/keys/react";
 
 function Dialog({ isOpen }) {
-  // When exclusive is true, commands outside this scope are silenced
-  useScope(commands, "dialog", isOpen, { exclusive: true });
+	// When exclusive is true, commands outside this scope are silenced
+	useScope(commands, "dialog", isOpen, { exclusive: true });
 
-  return isOpen ? <div className="dialog">...</div> : null;
+	return isOpen ? <div className="dialog">...</div> : null;
 }
 ```
 
@@ -82,27 +84,27 @@ Exactly one command runs per keypress. The winner is:
 1. The command in a named scope, over a global one. `"*"` counts as global here — it means "survives barriers", not "belongs to a region of the UI".
 2. Failing that, the one registered later. Registration order tracks mount order, so the most recently opened surface claims the key.
 
-A winner whose `when()` currently returns `false` steps aside rather than swallowing the keypress. This is how `Escape` closes the dialog when one is open and the panel otherwise, without making the dialog `exclusive`. Two commands sharing a chord *in the same scope* can never separate, so that case warns in development.
+A winner whose `when()` currently returns `false` steps aside rather than swallowing the keypress. This is how `Escape` closes the dialog when one is open and the panel otherwise, without making the dialog `exclusive`. Two commands sharing a chord _in the same scope_ can never separate, so that case warns in development.
 
 ## 4. Rebinding
 
 Overrides are layered over defaults.
 
 ```ts
-commands.keymap.set("palette.open", "Mod+P");     // remap
+commands.keymap.set("palette.open", "Mod+P"); // remap
 commands.keymap.add("palette.open", "Control+P"); // an additional key
-commands.keymap.set("palette.open", null);        // unbind
-commands.keymap.reset("palette.open");            // reset to default
+commands.keymap.set("palette.open", null); // unbind
+commands.keymap.reset("palette.open"); // reset to default
 ```
 
 To rebind a command you did not define — one a package shipped — pass `bindings` when creating the registry. An unknown id is a compile error, and `reset` returns here rather than to the definition's `keys`:
 
 ```ts
 createCommands(commands, {
-  bindings: {
-    "palette.open": "Mod+P", // replace the shipped default
-    "doc.publish": null,     // ship it unbound
-  },
+	bindings: {
+		"palette.open": "Mod+P", // replace the shipped default
+		"doc.publish": null, // ship it unbound
+	},
 });
 ```
 
@@ -113,9 +115,7 @@ In React, use the `useRebind` hook for a capture flow:
 ```tsx
 const rebind = useRebind(commands, "palette.open");
 
-<button onClick={rebind.start}>
-  {rebind.recording ? "Press keys…" : rebind.display}
-</button>;
+<button onClick={rebind.start}>{rebind.recording ? "Press keys…" : rebind.display}</button>;
 ```
 
 ## API Summary

package/dist/{index-nIJJ9qsY.d.ts → index-B5iiRwCy.d.ts}

@@ -37,7 +37,7 @@ interface RebindState<Id extends string = string> {
 interface RebindOptions<Id extends string = string> {
   /** Capture mode. Defaults to `"chord"`. */
   mode?: RebindMode;
-  /** Whether to apply the recorded binding to the keymap. Defaults to `true`. */
+  /** Whether to write the recorded (or cleared) binding into the keymap. Defaults to `true`. */
   apply?: boolean;
   /** Whether to append rather than replace existing bindings. Defaults to `false`. */
   add?: boolean;
@@ -51,7 +51,7 @@ interface RebindOptions<Id extends string = string> {
   onRecord?: (binding: Binding, conflicts: ReadonlyArray<Conflict<Id>>) => void;
   /** Callback fired when recording is cancelled. */
   onCancel?: () => void;
-  /** Callback fired when bindings are cleared. */
+  /** Callback fired when Backspace or Delete clears the binding while recording. */
   onClear?: () => void;
 }
 /** Controller instance for managing a rebinding session. */

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 import { A as Platform, C as CommandDefinition, D as HotkeySequence, E as Hotkey, M as SequenceBinding, N as SerializedBinding, O as KeymapPersistence, S as CommandContext, T as Conflict, _ as formatBinding, a as Commands, b as Chord, c as PendingSequence, d as createCommands, f as CommandKeymap, g as bindingTokens, h as ariaKeyShortcuts, i as CommandId, j as ScopeOptions, k as KeymapStorage, l as RunBlockReason, m as DisplayOptions, n as observe, o as CommandsOptions, p as SerializedKeymap, r as CommandHandle, s as ConflictOptions, t as ObserveOptions, u as RunOptions, v as Binding, w as CommandSource, x as Command, y as BindingInput } from "./attributes-O6bXNKT9.js";
-import { a as Rebinder, c as seq, i as RebindState, l as validateBinding, n as RebindMode, o as createRebinder, r as RebindOptions, s as BindingValidation, t as ALWAYS_SCOPE } from "./index-nIJJ9qsY.js";
+import { a as Rebinder, c as seq, i as RebindState, l as validateBinding, n as RebindMode, o as createRebinder, r as RebindOptions, s as BindingValidation, t as ALWAYS_SCOPE } from "./index-B5iiRwCy.js";
 export { ALWAYS_SCOPE, type Binding, type BindingInput, type BindingValidation, type Chord, type Command, type CommandContext, type CommandDefinition, type CommandHandle, type CommandId, type CommandKeymap, type CommandSource, type Commands, type CommandsOptions, type Conflict, type ConflictOptions, type DisplayOptions, type Hotkey, type HotkeySequence, type KeymapPersistence, type KeymapStorage, type ObserveOptions, type PendingSequence, type Platform, type RebindMode, type RebindOptions, type RebindState, type Rebinder, type RunBlockReason, type RunOptions, type ScopeOptions, type SequenceBinding, type SerializedBinding, type SerializedKeymap, ariaKeyShortcuts, bindingTokens, createCommands, createRebinder, formatBinding, observe, seq, validateBinding };

package/dist/index.js

@@ -1,3 +1,3 @@
 import { observe } from "./attributes.js";
-import { a as bindingTokens, c as seq, i as ariaKeyShortcuts, n as ALWAYS_SCOPE, o as formatBinding, r as createRebinder, t as createCommands, u as validateBinding } from "./src-DifrdRcK.js";
+import { a as bindingTokens, c as seq, i as ariaKeyShortcuts, n as ALWAYS_SCOPE, o as formatBinding, r as createRebinder, t as createCommands, u as validateBinding } from "./src-DWmUPZSL.js";
 export { ALWAYS_SCOPE, ariaKeyShortcuts, bindingTokens, createCommands, createRebinder, formatBinding, observe, seq, validateBinding };

package/dist/react.d.ts

@@ -1,5 +1,5 @@
 import { A as Platform, C as CommandDefinition, D as HotkeySequence, E as Hotkey, M as SequenceBinding, N as SerializedBinding, O as KeymapPersistence, S as CommandContext, T as Conflict, _ as formatBinding, a as Commands, b as Chord, c as PendingSequence, d as createCommands, f as CommandKeymap, g as bindingTokens, h as ariaKeyShortcuts, i as CommandId, j as ScopeOptions, k as KeymapStorage, l as RunBlockReason, m as DisplayOptions, n as observe, o as CommandsOptions, p as SerializedKeymap, r as CommandHandle, s as ConflictOptions, t as ObserveOptions, u as RunOptions, v as Binding, w as CommandSource, x as Command, y as BindingInput } from "./attributes-O6bXNKT9.js";
-import { a as Rebinder, c as seq, i as RebindState, l as validateBinding, n as RebindMode, o as createRebinder, r as RebindOptions, s as BindingValidation, t as ALWAYS_SCOPE } from "./index-nIJJ9qsY.js";
+import { a as Rebinder, c as seq, i as RebindState, l as validateBinding, n as RebindMode, o as createRebinder, r as RebindOptions, s as BindingValidation, t as ALWAYS_SCOPE } from "./index-B5iiRwCy.js";
 //#region src/react/hooks.d.ts
 /**
  * Mounts a commands registry for the lifecycle of the component.

package/dist/react.js

@@ -1,6 +1,6 @@
 "use client";
 import { observe } from "./attributes.js";
-import { a as bindingTokens, c as seq, i as ariaKeyShortcuts, l as toBindings, n as ALWAYS_SCOPE, o as formatBinding, r as createRebinder, s as bindingSignature, t as createCommands, u as validateBinding } from "./src-DifrdRcK.js";
+import { a as bindingTokens, c as seq, i as ariaKeyShortcuts, l as toBindings, n as ALWAYS_SCOPE, o as formatBinding, r as createRebinder, s as bindingSignature, t as createCommands, u as validateBinding } from "./src-DWmUPZSL.js";
 import { getKeyStateTracker } from "@tanstack/hotkeys";
 import { useCallback, useEffect, useMemo, useRef, useState, useSyncExternalStore } from "react";
 //#region src/react/hooks.ts

package/dist/{src-DifrdRcK.js → src-DWmUPZSL.js}

@@ -192,6 +192,7 @@ function createRebinder(registry, id, options = {}) {
 	};
 	const cleared = () => {
 		releaseScope();
+		if (options.apply !== false) registry.keymap.set(id, null);
 		notify({
 			recording: false,
 			binding: null,
@@ -212,7 +213,9 @@ function createRebinder(registry, id, options = {}) {
 		onClear: cleared
 	}) : new HotkeyRecorder({
 		ignoreInputs: options.ignoreInputs ?? true,
-		onRecord: (hotkey) => record(hotkey),
+		onRecord: (hotkey) => {
+			if (hotkey) record(hotkey);
+		},
 		onCancel: cancelled,
 		onClear: cleared
 	});
@@ -468,8 +471,10 @@ var Keymap = class {
 			const raw = storage.getItem(this.#storageKey());
 			if (!raw) return;
 			this.#read(JSON.parse(raw));
-			for (const listener of this.#listeners) listener();
-		} catch {}
+		} catch {
+			return;
+		}
+		for (const listener of this.#listeners) listener();
 	}
 	/** Subscribes to keymap changes. Returns an unsubscribe function. */
 	subscribe(listener) {
@@ -666,9 +671,14 @@ var CommandRegistry = class {
 		if (this.#mounts > 0) this.#binder.sync(id);
 		this.#invalidate();
 		this.#auditAdded(id);
+		let disposed = false;
 		return {
-			run: (options) => this.run(id, options),
-			dispose: () => this.#pop(id, entry)
+			run: (options) => !disposed && this.run(id, options),
+			dispose: () => {
+				if (disposed) return;
+				disposed = true;
+				this.#pop(id, entry);
+			}
 		};
 	}
 	remove(loose) {

package/package.json

@@ -1,22 +1,37 @@
 {
   "name": "@inklu/keys",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "A command system for the web — typed commands, portable keybindings, scopes, sequences, conflict detection, rebinding, and platform-aware display.",
   "keywords": [
-    "keyboard",
-    "shortcuts",
-    "hotkeys",
-    "keybindings",
+    "accessibility",
     "command-palette",
     "commands",
+    "hotkeys",
+    "keybindings",
+    "keyboard",
+    "react",
     "scopes",
     "sequences",
-    "accessibility",
-    "react"
+    "shortcuts"
   ],
+  "homepage": "https://github.com/nkurunziza-saddy/inklu#readme",
+  "bugs": {
+    "url": "https://github.com/nkurunziza-saddy/inklu/issues"
+  },
   "license": "MIT",
   "author": "nkurunziza-saddy",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nkurunziza-saddy/inklu.git",
+    "directory": "packages/keys"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "type": "module",
+  "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -38,61 +53,47 @@
     },
     "./package.json": "./package.json"
   },
-  "sideEffects": false,
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
-  ],
-  "engines": {
-    "node": ">=18"
+  "publishConfig": {
+    "access": "public"
   },
   "dependencies": {
     "@tanstack/hotkeys": "0.8.0"
   },
-  "peerDependencies": {
-    "react": "^18.0.0 || ^19.0.0"
-  },
-  "peerDependenciesMeta": {
-    "react": {
-      "optional": true
-    }
-  },
   "devDependencies": {
+    "@inklu/tsconfig": "1.0.0",
     "@testing-library/react": "^16.3.2",
     "@types/react": "^19",
-    "@vitest/coverage-v8": "^4.1.10",
+    "@vitest/coverage-v8": "4.1.11",
     "jsdom": "^29.1.1",
     "react": "19.2.8",
     "react-dom": "19.2.8",
-    "tsdown": "^0.22.14",
     "typescript": "^5.8.2",
-    "vitest": "^4.1.10",
-    "@inklu/tsconfig": "1.0.0"
+    "vite": "npm:@voidzero-dev/vite-plus-core@0.3.0",
+    "vite-plus": "0.3.0",
+    "vitest": "4.1.11"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/nkurunziza-saddy/inklu.git",
-    "directory": "packages/keys"
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0"
   },
-  "homepage": "https://github.com/nkurunziza-saddy/inklu#readme",
-  "bugs": {
-    "url": "https://github.com/nkurunziza-saddy/inklu/issues"
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
   },
-  "publishConfig": {
-    "access": "public"
+  "engines": {
+    "node": ">=18"
   },
   "scripts": {
-    "build": "tsdown",
+    "build": "vp pack",
     "lint:exports": "publint",
-    "dev": "tsdown --watch",
-    "lint": "biome lint",
-    "check": "biome check",
-    "format": "biome format --write",
+    "dev": "vp pack --watch",
+    "lint": "vp lint",
+    "check": "vp check",
+    "format": "vp fmt --write",
     "check-types": "tsc --noEmit",
     "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage"
+    "test": "vp test run",
+    "test:watch": "vp test",
+    "test:coverage": "vp test run --coverage"
   }
 }