@tanstack/hotkeys 0.0.1 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tanner Linsley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,45 +1,121 @@
-# @tanstack/hotkeys
-
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@tanstack/hotkeys`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+<div align="center">
+  <img src="./media/header_hotkeys.png" alt="TanStack Hotkeys" />
+</div>
+
+<br />
+
+<div align="center">
+	<a href="https://www.npmjs.com/package/@tanstack/hotkeys" target="\_parent">
+	  <img alt="" src="https://img.shields.io/npm/dm/@tanstack/hotkeys.svg" alt="npm downloads" />
+	</a>
+	<a href="https://github.com/TanStack/hotkeys" target="\_parent">
+	  <img alt="" src="https://img.shields.io/github/stars/TanStack/hotkeys.svg?style=social&label=Star" alt="GitHub stars" />
+	</a>
+	<a href="https://bundlephobia.com/result?p=@tanstack/react-hotkeys@latest" target="\_parent">
+	  <img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-hotkeys@latest" alt="Bundle size" />
+	</a>
+</div>
+
+<div align="center">
+	<a href="#badge">
+	  <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
+	</a>
+	<a href="#badge">
+	  <img src="https://img.shields.io/github/v/release/tanstack/hotkeys" alt="Release"/>
+	</a>
+	<a href="https://twitter.com/tan_stack">
+	  <img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/>
+	</a>
+</div>
+
+<div align="center">
+
+### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
+
+</div>
+
+# TanStack Hotkeys
+
+> [!NOTE]
+> TanStack Hotkeys is pre-alpha (prototyping phase). We are actively developing the library and are open to feedback and contributions.
+
+Type-safe keyboard shortcuts for the web. Template-string bindings, parsed objects, a cross-platform `Mod` key, a singleton Hotkey Manager, and utilities for cheatsheet UIs—built to stay SSR-friendly.
+
+- Type-safe bindings — template strings (`Mod+Shift+S`, `Escape`) or parsed objects for full control
+- Flexible options — `keydown`/`keyup`, `preventDefault`, `stopPropagation`, conditional enabled, `requireReset`
+- Cross-platform Mod — maps to Cmd on macOS and Ctrl on Windows/Linux
+- Batteries included — validation + matching, sequences (Vim-style), key-state tracking, recorder UI helpers, React hooks, and devtools (in progress)
+
+### <a href="https://tanstack.com/hotkeys">Read the docs →</a>
+
+<br />
+
+> [!NOTE]
+> You may know **TanStack Hotkeys** by our adapter names, too!
+>
+> - [**React Hotkeys**](https://tanstack.com/hotkeys/latest/docs/framework/react/react-hotkeys)
+> - Solid Hotkeys – needs a contributor!
+> - Angular Hotkeys – needs a contributor!
+> - Svelte Hotkeys – needs a contributor!
+> - Vue Hotkeys – needs a contributor!
+
+## Get Involved
+
+- We welcome issues and pull requests!
+- Participate in [GitHub discussions](https://github.com/TanStack/hotkeys/discussions)
+- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ)
+- See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions
+
+## Partners
+
+<div align="center">
+
+<table align="center">
+  <tr>
+    <td>
+      <a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS" >
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-D643Zkrv.svg" height="40" />
+          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-CIzGLYU_.svg" height="40" />
+          <img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="CodeRabbit" />
+        </picture>
+      </a>
+    </td>
+    <td>
+      <a href="https://www.cloudflare.com?utm_source=tanstack">
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-Co-Tyjbl.svg" height="60" />
+          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-6Ojsn8yh.svg" height="60" />
+          <img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" alt="Cloudflare" />
+        </picture>
+      </a>
+    </td>
+  </tr>
+</table>
+
+<div align="center">
+<img src="media/partner_logo.svg" alt="Keys & you?" height="65">
+<p>
+We're looking for TanStack Hotkeys Partners to join our mission! Partner with us to push the boundaries of TanStack Hotkeys and build amazing things together.
+</p>
+<a href="mailto:partners@tanstack.com?subject=TanStack Hotkeys Partnership"><b>LET'S CHAT</b></a>
+</div>
+
+</div>
+
+## Explore the TanStack Ecosystem
+
+- <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages
+- <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store
+- <a href="https://github.com/tanstack/devtools"><b>TanStack DevTools</b></a> – Unified devtools panel
+- <a href="https://github.com/tanstack/form"><b>TanStack Form</b></a> – Type‑safe form state
+- <a href="https://github.com/tanstack/hotkeys"><b>TanStack Hotkeys</b></a> – Type‑safe keyboard shortcuts
+- <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching
+- <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives
+- <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state
+- <a href="https://github.com/tanstack/start"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
+- <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store
+- <a href="https://github.com/tanstack/table"><b>TanStack Table</b></a> – Headless datagrids
+- <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering
+
+… and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a>

package/dist/constants.cjs

@@ -0,0 +1,444 @@
+
+//#region src/constants.ts
+/**
+* Detects the current platform based on browser navigator properties.
+*
+* Used internally to resolve platform-adaptive modifiers like 'Mod' (Command on Mac,
+* Control elsewhere) and for platform-specific hotkey formatting.
+*
+* @returns The detected platform: 'mac', 'windows', or 'linux'
+* @remarks Defaults to 'linux' in SSR environments where navigator is undefined
+*
+* @example
+* ```ts
+* const platform = detectPlatform() // 'mac' | 'windows' | 'linux'
+* const modifier = resolveModifier('Mod', platform) // 'Meta' on Mac, 'Control' elsewhere
+* ```
+*/
+function detectPlatform() {
+	if (typeof navigator === "undefined") return "linux";
+	const platform = navigator.platform.toLowerCase();
+	const userAgent = navigator.userAgent.toLowerCase();
+	if (platform.includes("mac") || userAgent.includes("mac")) return "mac";
+	if (platform.includes("win") || userAgent.includes("win")) return "windows";
+	return "linux";
+}
+/**
+* Canonical order for modifiers in normalized hotkey strings.
+*
+* Defines the standard order in which modifiers should appear when formatting
+* hotkeys. This ensures consistent, predictable output across the library.
+*
+* Order: Control → Alt → Shift → Meta
+*
+* @example
+* ```ts
+* // Input: 'Shift+Control+Meta+S'
+* // Normalized: 'Control+Alt+Shift+Meta+S' (following MODIFIER_ORDER)
+* ```
+*/
+const MODIFIER_ORDER = [
+	"Control",
+	"Alt",
+	"Shift",
+	"Meta"
+];
+/**
+* Set of canonical modifier key names for fast lookup.
+*
+* Derived from `MODIFIER_ORDER` to ensure consistency. Used to detect when
+* a modifier is released so we can clear non-modifier keys whose keyup events
+* may have been swallowed by the OS (e.g. macOS Cmd+key combos).
+*/
+const MODIFIER_KEYS = new Set(MODIFIER_ORDER);
+/**
+* Maps modifier key aliases to their canonical form or platform-adaptive 'Mod'.
+*
+* This map allows users to write hotkeys using various aliases (e.g., 'Ctrl', 'Cmd', 'Option')
+* which are then normalized to canonical names ('Control', 'Meta', 'Alt') or the
+* platform-adaptive 'Mod' token.
+*
+* The 'Mod' and 'CommandOrControl' aliases are resolved at runtime via `resolveModifier()`
+* based on the detected platform (Command on Mac, Control elsewhere).
+*
+* @remarks Case-insensitive lookups are supported via lowercase variants
+*
+* @example
+* ```ts
+* MODIFIER_ALIASES['Ctrl'] // 'Control'
+* MODIFIER_ALIASES['Cmd'] // 'Meta'
+* MODIFIER_ALIASES['Mod'] // 'Mod' (resolved at runtime)
+* ```
+*/
+const MODIFIER_ALIASES = {
+	Control: "Control",
+	Ctrl: "Control",
+	control: "Control",
+	ctrl: "Control",
+	Shift: "Shift",
+	shift: "Shift",
+	Alt: "Alt",
+	Option: "Alt",
+	alt: "Alt",
+	option: "Alt",
+	Command: "Meta",
+	Cmd: "Meta",
+	Meta: "Meta",
+	command: "Meta",
+	cmd: "Meta",
+	meta: "Meta",
+	CommandOrControl: "Mod",
+	Mod: "Mod",
+	commandorcontrol: "Mod",
+	mod: "Mod"
+};
+/**
+* Resolves the platform-adaptive 'Mod' modifier to the appropriate canonical modifier.
+*
+* The 'Mod' token represents the "primary modifier" on each platform:
+* - macOS: 'Meta' (Command key ⌘)
+* - Windows/Linux: 'Control' (Ctrl key)
+*
+* This enables cross-platform hotkey definitions like 'Mod+S' that automatically
+* map to Command+S on Mac and Ctrl+S on Windows/Linux.
+*
+* @param modifier - The modifier to resolve. If 'Mod', resolves based on platform.
+* @param platform - The target platform. Defaults to auto-detection.
+* @returns The canonical modifier name ('Control', 'Shift', 'Alt', or 'Meta')
+*
+* @example
+* ```ts
+* resolveModifier('Mod', 'mac') // 'Meta'
+* resolveModifier('Mod', 'windows') // 'Control'
+* resolveModifier('Control', 'mac') // 'Control' (unchanged)
+* ```
+*/
+function resolveModifier(modifier, platform = detectPlatform()) {
+	if (modifier === "Mod") return platform === "mac" ? "Meta" : "Control";
+	return modifier;
+}
+/**
+* Set of all valid letter keys (A-Z).
+*
+* Used for validation and type checking. Letter keys are matched case-insensitively
+* in hotkey matching, but normalized to uppercase in canonical form.
+*/
+const LETTER_KEYS = new Set([
+	"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"
+]);
+/**
+* Set of all valid number keys (0-9).
+*
+* Note: Number keys are affected by Shift (Shift+1 → '!' on US layout),
+* so they're excluded from Shift-based hotkey combinations to avoid
+* layout-dependent behavior.
+*/
+const NUMBER_KEYS = new Set([
+	"0",
+	"1",
+	"2",
+	"3",
+	"4",
+	"5",
+	"6",
+	"7",
+	"8",
+	"9"
+]);
+/**
+* Set of all valid function keys (F1-F12).
+*
+* Function keys are commonly used for system shortcuts (e.g., F12 for DevTools,
+* Alt+F4 to close windows) and application-specific commands.
+*/
+const FUNCTION_KEYS = new Set([
+	"F1",
+	"F2",
+	"F3",
+	"F4",
+	"F5",
+	"F6",
+	"F7",
+	"F8",
+	"F9",
+	"F10",
+	"F11",
+	"F12"
+]);
+/**
+* Set of all valid navigation keys for cursor movement and document navigation.
+*
+* Includes arrow keys, Home/End (line navigation), and PageUp/PageDown (page navigation).
+* These keys are commonly combined with modifiers for selection (Shift+ArrowUp) or
+* navigation shortcuts (Alt+ArrowLeft for back).
+*/
+const NAVIGATION_KEYS = new Set([
+	"ArrowUp",
+	"ArrowDown",
+	"ArrowLeft",
+	"ArrowRight",
+	"Home",
+	"End",
+	"PageUp",
+	"PageDown"
+]);
+/**
+* Set of all valid editing and special keys.
+*
+* Includes keys commonly used for text editing (Enter, Backspace, Delete, Tab) and
+* special actions (Escape, Space). These keys are frequently combined with modifiers
+* for editor shortcuts (Mod+Enter to submit, Shift+Tab to go back).
+*/
+const EDITING_KEYS = new Set([
+	"Enter",
+	"Escape",
+	"Space",
+	"Tab",
+	"Backspace",
+	"Delete"
+]);
+/**
+* Set of all valid punctuation keys commonly used in keyboard shortcuts.
+*
+* These are the literal characters as they appear in `KeyboardEvent.key` (layout-dependent,
+* typically US keyboard layout). Common shortcuts include:
+* - `Mod+/` - Toggle comment
+* - `Mod+[` / `Mod+]` - Indent/outdent
+* - `Mod+=` / `Mod+-` - Zoom in/out
+*
+* Note: Punctuation keys are affected by Shift (Shift+',' → '<' on US layout),
+* so they're excluded from Shift-based hotkey combinations to avoid layout-dependent behavior.
+*/
+const PUNCTUATION_KEYS = new Set([
+	"/",
+	"[",
+	"]",
+	"\\",
+	"=",
+	"-",
+	",",
+	".",
+	"`"
+]);
+/**
+* Set of all valid non-modifier keys.
+*
+* This is the union of all key type sets (letters, numbers, function keys, navigation,
+* editing, and punctuation). Used primarily for validation to check if a key string
+* is recognized and will have type-safe autocomplete support.
+*
+* @see {@link LETTER_KEYS}
+* @see {@link NUMBER_KEYS}
+* @see {@link FUNCTION_KEYS}
+* @see {@link NAVIGATION_KEYS}
+* @see {@link EDITING_KEYS}
+* @see {@link PUNCTUATION_KEYS}
+*/
+const ALL_KEYS = new Set([
+	...LETTER_KEYS,
+	...NUMBER_KEYS,
+	...FUNCTION_KEYS,
+	...NAVIGATION_KEYS,
+	...EDITING_KEYS,
+	...PUNCTUATION_KEYS
+]);
+/**
+* Maps key name aliases to their canonical form.
+*
+* Handles common variations and alternative names for keys to provide a more
+* forgiving API. For example, users can write 'Esc', 'esc', or 'escape' and
+* they'll all normalize to 'Escape'.
+*
+* This map is used internally by `normalizeKeyName()` to convert user input
+* into the canonical key names used throughout the library.
+*
+* @remarks Case-insensitive lookups are supported via lowercase variants
+*
+* @example
+* ```ts
+* KEY_ALIASES['Esc'] // 'Escape'
+* KEY_ALIASES['Del'] // 'Delete'
+* KEY_ALIASES['Up'] // 'ArrowUp'
+* ```
+*/
+const KEY_ALIASES = {
+	Esc: "Escape",
+	esc: "Escape",
+	escape: "Escape",
+	Return: "Enter",
+	return: "Enter",
+	enter: "Enter",
+	" ": "Space",
+	space: "Space",
+	Spacebar: "Space",
+	spacebar: "Space",
+	tab: "Tab",
+	backspace: "Backspace",
+	Del: "Delete",
+	del: "Delete",
+	delete: "Delete",
+	Up: "ArrowUp",
+	up: "ArrowUp",
+	arrowup: "ArrowUp",
+	Down: "ArrowDown",
+	down: "ArrowDown",
+	arrowdown: "ArrowDown",
+	Left: "ArrowLeft",
+	left: "ArrowLeft",
+	arrowleft: "ArrowLeft",
+	Right: "ArrowRight",
+	right: "ArrowRight",
+	arrowright: "ArrowRight",
+	home: "Home",
+	end: "End",
+	pageup: "PageUp",
+	pagedown: "PageDown",
+	PgUp: "PageUp",
+	PgDn: "PageDown",
+	pgup: "PageUp",
+	pgdn: "PageDown"
+};
+/**
+* Normalizes a key name to its canonical form.
+*
+* Converts various key name formats (aliases, case variations) into the standard
+* canonical names used throughout the library. This enables a more forgiving API
+* where users can write keys in different ways and still get correct behavior.
+*
+* Normalization rules:
+* 1. Check aliases first (e.g., 'Esc' → 'Escape', 'Del' → 'Delete')
+* 2. Single letters → uppercase (e.g., 'a' → 'A', 's' → 'S')
+* 3. Function keys → uppercase (e.g., 'f1' → 'F1', 'F12' → 'F12')
+* 4. Other keys → returned as-is (already canonical or unknown)
+*
+* @param key - The key name to normalize (can be an alias, lowercase, etc.)
+* @returns The canonical key name
+*
+* @example
+* ```ts
+* normalizeKeyName('esc') // 'Escape'
+* normalizeKeyName('a') // 'A'
+* normalizeKeyName('f1') // 'F1'
+* normalizeKeyName('ArrowUp') // 'ArrowUp' (already canonical)
+* ```
+*/
+function normalizeKeyName(key) {
+	if (key in KEY_ALIASES) return KEY_ALIASES[key];
+	if (key.length === 1 && /^[a-zA-Z]$/.test(key)) return key.toUpperCase();
+	const upperKey = key.toUpperCase();
+	if (/^F([1-9]|1[0-2])$/.test(upperKey)) return upperKey;
+	return key;
+}
+/**
+* Modifier key symbols for macOS display.
+*
+* Used by formatting functions to display hotkeys with macOS-style symbols
+* (e.g., ⌘ for Command, ⌃ for Control) instead of text labels. This provides
+* a native macOS look and feel in hotkey displays.
+*
+* @example
+* ```ts
+* MAC_MODIFIER_SYMBOLS['Meta'] // '⌘'
+* MAC_MODIFIER_SYMBOLS['Control'] // '⌃'
+* MAC_MODIFIER_SYMBOLS['Alt'] // '⌥'
+* MAC_MODIFIER_SYMBOLS['Shift'] // '⇧'
+* ```
+*/
+const MAC_MODIFIER_SYMBOLS = {
+	Control: "⌃",
+	Alt: "⌥",
+	Shift: "⇧",
+	Meta: "⌘"
+};
+/**
+* Modifier key labels for Windows/Linux display.
+*
+* Used by formatting functions to display hotkeys with standard text labels
+* (e.g., 'Ctrl' for Control, 'Win' for Meta/Windows key) instead of symbols.
+* This provides a familiar Windows/Linux look and feel in hotkey displays.
+*
+* @example
+* ```ts
+* STANDARD_MODIFIER_LABELS['Control'] // 'Ctrl'
+* STANDARD_MODIFIER_LABELS['Meta'] // 'Win'
+* STANDARD_MODIFIER_LABELS['Alt'] // 'Alt'
+* STANDARD_MODIFIER_LABELS['Shift'] // 'Shift'
+* ```
+*/
+const STANDARD_MODIFIER_LABELS = {
+	Control: "Ctrl",
+	Alt: "Alt",
+	Shift: "Shift",
+	Meta: "Win"
+};
+/**
+* Special key symbols for display formatting.
+*
+* Maps certain keys to their visual symbols for better readability in hotkey displays.
+* Used by formatting functions to show symbols like ↑ for ArrowUp or ↵ for Enter
+* instead of text labels.
+*
+* @example
+* ```ts
+* KEY_DISPLAY_SYMBOLS['ArrowUp'] // '↑'
+* KEY_DISPLAY_SYMBOLS['Enter'] // '↵'
+* KEY_DISPLAY_SYMBOLS['Escape'] // 'Esc'
+* KEY_DISPLAY_SYMBOLS['Space'] // '␣'
+* ```
+*/
+const KEY_DISPLAY_SYMBOLS = {
+	ArrowUp: "↑",
+	ArrowDown: "↓",
+	ArrowLeft: "←",
+	ArrowRight: "→",
+	Enter: "↵",
+	Escape: "Esc",
+	Backspace: "⌫",
+	Delete: "⌦",
+	Tab: "⇥",
+	Space: "␣"
+};
+
+//#endregion
+exports.ALL_KEYS = ALL_KEYS;
+exports.EDITING_KEYS = EDITING_KEYS;
+exports.FUNCTION_KEYS = FUNCTION_KEYS;
+exports.KEY_DISPLAY_SYMBOLS = KEY_DISPLAY_SYMBOLS;
+exports.LETTER_KEYS = LETTER_KEYS;
+exports.MAC_MODIFIER_SYMBOLS = MAC_MODIFIER_SYMBOLS;
+exports.MODIFIER_ALIASES = MODIFIER_ALIASES;
+exports.MODIFIER_KEYS = MODIFIER_KEYS;
+exports.MODIFIER_ORDER = MODIFIER_ORDER;
+exports.NAVIGATION_KEYS = NAVIGATION_KEYS;
+exports.NUMBER_KEYS = NUMBER_KEYS;
+exports.PUNCTUATION_KEYS = PUNCTUATION_KEYS;
+exports.STANDARD_MODIFIER_LABELS = STANDARD_MODIFIER_LABELS;
+exports.detectPlatform = detectPlatform;
+exports.normalizeKeyName = normalizeKeyName;
+exports.resolveModifier = resolveModifier;
+//# sourceMappingURL=constants.cjs.map

package/dist/constants.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.cjs","names":[],"sources":["../src/constants.ts"],"sourcesContent":["import type {\n  CanonicalModifier,\n  EditingKey,\n  FunctionKey,\n  LetterKey,\n  NavigationKey,\n  NumberKey,\n  PunctuationKey,\n} from './hotkey'\n\n// =============================================================================\n// Platform Detection\n// =============================================================================\n\n/**\n * Detects the current platform based on browser navigator properties.\n *\n * Used internally to resolve platform-adaptive modifiers like 'Mod' (Command on Mac,\n * Control elsewhere) and for platform-specific hotkey formatting.\n *\n * @returns The detected platform: 'mac', 'windows', or 'linux'\n * @remarks Defaults to 'linux' in SSR environments where navigator is undefined\n *\n * @example\n * ```ts\n * const platform = detectPlatform() // 'mac' | 'windows' | 'linux'\n * const modifier = resolveModifier('Mod', platform) // 'Meta' on Mac, 'Control' elsewhere\n * ```\n */\nexport function detectPlatform(): 'mac' | 'windows' | 'linux' {\n  if (typeof navigator === 'undefined') {\n    return 'linux' // Default for SSR\n  }\n\n  const platform = navigator.platform.toLowerCase()\n  const userAgent = navigator.userAgent.toLowerCase()\n\n  if (platform.includes('mac') || userAgent.includes('mac')) {\n    return 'mac'\n  }\n  if (platform.includes('win') || userAgent.includes('win')) {\n    return 'windows'\n  }\n  return 'linux'\n}\n\n// =============================================================================\n// Modifier Aliases\n// =============================================================================\n\n/**\n * Canonical order for modifiers in normalized hotkey strings.\n *\n * Defines the standard order in which modifiers should appear when formatting\n * hotkeys. This ensures consistent, predictable output across the library.\n *\n * Order: Control → Alt → Shift → Meta\n *\n * @example\n * ```ts\n * // Input: 'Shift+Control+Meta+S'\n * // Normalized: 'Control+Alt+Shift+Meta+S' (following MODIFIER_ORDER)\n * ```\n */\nexport const MODIFIER_ORDER: Array<CanonicalModifier> = [\n  'Control',\n  'Alt',\n  'Shift',\n  'Meta',\n]\n\n/**\n * Set of canonical modifier key names for fast lookup.\n *\n * Derived from `MODIFIER_ORDER` to ensure consistency. Used to detect when\n * a modifier is released so we can clear non-modifier keys whose keyup events\n * may have been swallowed by the OS (e.g. macOS Cmd+key combos).\n */\nexport const MODIFIER_KEYS = new Set<string>(MODIFIER_ORDER)\n\n/**\n * Maps modifier key aliases to their canonical form or platform-adaptive 'Mod'.\n *\n * This map allows users to write hotkeys using various aliases (e.g., 'Ctrl', 'Cmd', 'Option')\n * which are then normalized to canonical names ('Control', 'Meta', 'Alt') or the\n * platform-adaptive 'Mod' token.\n *\n * The 'Mod' and 'CommandOrControl' aliases are resolved at runtime via `resolveModifier()`\n * based on the detected platform (Command on Mac, Control elsewhere).\n *\n * @remarks Case-insensitive lookups are supported via lowercase variants\n *\n * @example\n * ```ts\n * MODIFIER_ALIASES['Ctrl'] // 'Control'\n * MODIFIER_ALIASES['Cmd'] // 'Meta'\n * MODIFIER_ALIASES['Mod'] // 'Mod' (resolved at runtime)\n * ```\n */\nexport const MODIFIER_ALIASES: Record<string, CanonicalModifier | 'Mod'> = {\n  // Control variants\n  Control: 'Control',\n  Ctrl: 'Control',\n  control: 'Control',\n  ctrl: 'Control',\n\n  // Shift variants\n  Shift: 'Shift',\n  shift: 'Shift',\n\n  // Alt variants\n  Alt: 'Alt',\n  Option: 'Alt',\n  alt: 'Alt',\n  option: 'Alt',\n\n  // Meta/Command variants\n  Command: 'Meta',\n  Cmd: 'Meta',\n  Meta: 'Meta',\n  command: 'Meta',\n  cmd: 'Meta',\n  meta: 'Meta',\n\n  // Platform-adaptive (resolved at runtime)\n  CommandOrControl: 'Mod',\n  Mod: 'Mod',\n  commandorcontrol: 'Mod',\n  mod: 'Mod',\n}\n\n/**\n * Resolves the platform-adaptive 'Mod' modifier to the appropriate canonical modifier.\n *\n * The 'Mod' token represents the \"primary modifier\" on each platform:\n * - macOS: 'Meta' (Command key ⌘)\n * - Windows/Linux: 'Control' (Ctrl key)\n *\n * This enables cross-platform hotkey definitions like 'Mod+S' that automatically\n * map to Command+S on Mac and Ctrl+S on Windows/Linux.\n *\n * @param modifier - The modifier to resolve. If 'Mod', resolves based on platform.\n * @param platform - The target platform. Defaults to auto-detection.\n * @returns The canonical modifier name ('Control', 'Shift', 'Alt', or 'Meta')\n *\n * @example\n * ```ts\n * resolveModifier('Mod', 'mac') // 'Meta'\n * resolveModifier('Mod', 'windows') // 'Control'\n * resolveModifier('Control', 'mac') // 'Control' (unchanged)\n * ```\n */\nexport function resolveModifier(\n  modifier: CanonicalModifier | 'Mod',\n  platform: 'mac' | 'windows' | 'linux' = detectPlatform(),\n): CanonicalModifier {\n  if (modifier === 'Mod') {\n    return platform === 'mac' ? 'Meta' : 'Control'\n  }\n  return modifier\n}\n\n// =============================================================================\n// Valid Keys\n// =============================================================================\n\n/**\n * Set of all valid letter keys (A-Z).\n *\n * Used for validation and type checking. Letter keys are matched case-insensitively\n * in hotkey matching, but normalized to uppercase in canonical form.\n */\nexport const LETTER_KEYS = new Set<LetterKey>([\n  'A',\n  'B',\n  'C',\n  'D',\n  'E',\n  'F',\n  'G',\n  'H',\n  'I',\n  'J',\n  'K',\n  'L',\n  'M',\n  'N',\n  'O',\n  'P',\n  'Q',\n  'R',\n  'S',\n  'T',\n  'U',\n  'V',\n  'W',\n  'X',\n  'Y',\n  'Z',\n])\n\n/**\n * Set of all valid number keys (0-9).\n *\n * Note: Number keys are affected by Shift (Shift+1 → '!' on US layout),\n * so they're excluded from Shift-based hotkey combinations to avoid\n * layout-dependent behavior.\n */\nexport const NUMBER_KEYS = new Set<NumberKey>([\n  '0',\n  '1',\n  '2',\n  '3',\n  '4',\n  '5',\n  '6',\n  '7',\n  '8',\n  '9',\n])\n\n/**\n * Set of all valid function keys (F1-F12).\n *\n * Function keys are commonly used for system shortcuts (e.g., F12 for DevTools,\n * Alt+F4 to close windows) and application-specific commands.\n */\nexport const FUNCTION_KEYS = new Set<FunctionKey>([\n  'F1',\n  'F2',\n  'F3',\n  'F4',\n  'F5',\n  'F6',\n  'F7',\n  'F8',\n  'F9',\n  'F10',\n  'F11',\n  'F12',\n])\n\n/**\n * Set of all valid navigation keys for cursor movement and document navigation.\n *\n * Includes arrow keys, Home/End (line navigation), and PageUp/PageDown (page navigation).\n * These keys are commonly combined with modifiers for selection (Shift+ArrowUp) or\n * navigation shortcuts (Alt+ArrowLeft for back).\n */\nexport const NAVIGATION_KEYS = new Set<NavigationKey>([\n  'ArrowUp',\n  'ArrowDown',\n  'ArrowLeft',\n  'ArrowRight',\n  'Home',\n  'End',\n  'PageUp',\n  'PageDown',\n])\n\n/**\n * Set of all valid editing and special keys.\n *\n * Includes keys commonly used for text editing (Enter, Backspace, Delete, Tab) and\n * special actions (Escape, Space). These keys are frequently combined with modifiers\n * for editor shortcuts (Mod+Enter to submit, Shift+Tab to go back).\n */\nexport const EDITING_KEYS = new Set<EditingKey>([\n  'Enter',\n  'Escape',\n  'Space',\n  'Tab',\n  'Backspace',\n  'Delete',\n])\n\n/**\n * Set of all valid punctuation keys commonly used in keyboard shortcuts.\n *\n * These are the literal characters as they appear in `KeyboardEvent.key` (layout-dependent,\n * typically US keyboard layout). Common shortcuts include:\n * - `Mod+/` - Toggle comment\n * - `Mod+[` / `Mod+]` - Indent/outdent\n * - `Mod+=` / `Mod+-` - Zoom in/out\n *\n * Note: Punctuation keys are affected by Shift (Shift+',' → '<' on US layout),\n * so they're excluded from Shift-based hotkey combinations to avoid layout-dependent behavior.\n */\nexport const PUNCTUATION_KEYS = new Set<PunctuationKey>([\n  '/',\n  '[',\n  ']',\n  '\\\\',\n  '=',\n  '-',\n  ',',\n  '.',\n  '`',\n])\n\n/**\n * Set of all valid non-modifier keys.\n *\n * This is the union of all key type sets (letters, numbers, function keys, navigation,\n * editing, and punctuation). Used primarily for validation to check if a key string\n * is recognized and will have type-safe autocomplete support.\n *\n * @see {@link LETTER_KEYS}\n * @see {@link NUMBER_KEYS}\n * @see {@link FUNCTION_KEYS}\n * @see {@link NAVIGATION_KEYS}\n * @see {@link EDITING_KEYS}\n * @see {@link PUNCTUATION_KEYS}\n */\nexport const ALL_KEYS = new Set([\n  ...LETTER_KEYS,\n  ...NUMBER_KEYS,\n  ...FUNCTION_KEYS,\n  ...NAVIGATION_KEYS,\n  ...EDITING_KEYS,\n  ...PUNCTUATION_KEYS,\n])\n\n/**\n * Maps key name aliases to their canonical form.\n *\n * Handles common variations and alternative names for keys to provide a more\n * forgiving API. For example, users can write 'Esc', 'esc', or 'escape' and\n * they'll all normalize to 'Escape'.\n *\n * This map is used internally by `normalizeKeyName()` to convert user input\n * into the canonical key names used throughout the library.\n *\n * @remarks Case-insensitive lookups are supported via lowercase variants\n *\n * @example\n * ```ts\n * KEY_ALIASES['Esc'] // 'Escape'\n * KEY_ALIASES['Del'] // 'Delete'\n * KEY_ALIASES['Up'] // 'ArrowUp'\n * ```\n */\nconst KEY_ALIASES: Record<string, string> = {\n  // Escape variants\n  Esc: 'Escape',\n  esc: 'Escape',\n  escape: 'Escape',\n\n  // Enter variants\n  Return: 'Enter',\n  return: 'Enter',\n  enter: 'Enter',\n\n  // Space variants\n  ' ': 'Space',\n  space: 'Space',\n  Spacebar: 'Space',\n  spacebar: 'Space',\n\n  // Tab variants\n  tab: 'Tab',\n\n  // Backspace variants\n  backspace: 'Backspace',\n\n  // Delete variants\n  Del: 'Delete',\n  del: 'Delete',\n  delete: 'Delete',\n\n  // Arrow key variants\n  Up: 'ArrowUp',\n  up: 'ArrowUp',\n  arrowup: 'ArrowUp',\n  Down: 'ArrowDown',\n  down: 'ArrowDown',\n  arrowdown: 'ArrowDown',\n  Left: 'ArrowLeft',\n  left: 'ArrowLeft',\n  arrowleft: 'ArrowLeft',\n  Right: 'ArrowRight',\n  right: 'ArrowRight',\n  arrowright: 'ArrowRight',\n\n  // Navigation variants\n  home: 'Home',\n  end: 'End',\n  pageup: 'PageUp',\n  pagedown: 'PageDown',\n  PgUp: 'PageUp',\n  PgDn: 'PageDown',\n  pgup: 'PageUp',\n  pgdn: 'PageDown',\n}\n\n/**\n * Normalizes a key name to its canonical form.\n *\n * Converts various key name formats (aliases, case variations) into the standard\n * canonical names used throughout the library. This enables a more forgiving API\n * where users can write keys in different ways and still get correct behavior.\n *\n * Normalization rules:\n * 1. Check aliases first (e.g., 'Esc' → 'Escape', 'Del' → 'Delete')\n * 2. Single letters → uppercase (e.g., 'a' → 'A', 's' → 'S')\n * 3. Function keys → uppercase (e.g., 'f1' → 'F1', 'F12' → 'F12')\n * 4. Other keys → returned as-is (already canonical or unknown)\n *\n * @param key - The key name to normalize (can be an alias, lowercase, etc.)\n * @returns The canonical key name\n *\n * @example\n * ```ts\n * normalizeKeyName('esc') // 'Escape'\n * normalizeKeyName('a') // 'A'\n * normalizeKeyName('f1') // 'F1'\n * normalizeKeyName('ArrowUp') // 'ArrowUp' (already canonical)\n * ```\n */\nexport function normalizeKeyName(key: string): string {\n  // Check aliases first\n  if (key in KEY_ALIASES) {\n    return KEY_ALIASES[key]!\n  }\n\n  // Check if it's a single letter (normalize to uppercase)\n  if (key.length === 1 && /^[a-zA-Z]$/.test(key)) {\n    return key.toUpperCase()\n  }\n\n  // Check if it's a function key (normalize case)\n  const upperKey = key.toUpperCase()\n  if (/^F([1-9]|1[0-2])$/.test(upperKey)) {\n    return upperKey\n  }\n\n  return key\n}\n\n// =============================================================================\n// Display Symbols\n// =============================================================================\n\n/**\n * Modifier key symbols for macOS display.\n *\n * Used by formatting functions to display hotkeys with macOS-style symbols\n * (e.g., ⌘ for Command, ⌃ for Control) instead of text labels. This provides\n * a native macOS look and feel in hotkey displays.\n *\n * @example\n * ```ts\n * MAC_MODIFIER_SYMBOLS['Meta'] // '⌘'\n * MAC_MODIFIER_SYMBOLS['Control'] // '⌃'\n * MAC_MODIFIER_SYMBOLS['Alt'] // '⌥'\n * MAC_MODIFIER_SYMBOLS['Shift'] // '⇧'\n * ```\n */\nexport const MAC_MODIFIER_SYMBOLS: Record<CanonicalModifier, string> = {\n  Control: '⌃',\n  Alt: '⌥',\n  Shift: '⇧',\n  Meta: '⌘',\n}\n\n/**\n * Modifier key labels for Windows/Linux display.\n *\n * Used by formatting functions to display hotkeys with standard text labels\n * (e.g., 'Ctrl' for Control, 'Win' for Meta/Windows key) instead of symbols.\n * This provides a familiar Windows/Linux look and feel in hotkey displays.\n *\n * @example\n * ```ts\n * STANDARD_MODIFIER_LABELS['Control'] // 'Ctrl'\n * STANDARD_MODIFIER_LABELS['Meta'] // 'Win'\n * STANDARD_MODIFIER_LABELS['Alt'] // 'Alt'\n * STANDARD_MODIFIER_LABELS['Shift'] // 'Shift'\n * ```\n */\nexport const STANDARD_MODIFIER_LABELS: Record<CanonicalModifier, string> = {\n  Control: 'Ctrl',\n  Alt: 'Alt',\n  Shift: 'Shift',\n  Meta: 'Win',\n}\n\n/**\n * Special key symbols for display formatting.\n *\n * Maps certain keys to their visual symbols for better readability in hotkey displays.\n * Used by formatting functions to show symbols like ↑ for ArrowUp or ↵ for Enter\n * instead of text labels.\n *\n * @example\n * ```ts\n * KEY_DISPLAY_SYMBOLS['ArrowUp'] // '↑'\n * KEY_DISPLAY_SYMBOLS['Enter'] // '↵'\n * KEY_DISPLAY_SYMBOLS['Escape'] // 'Esc'\n * KEY_DISPLAY_SYMBOLS['Space'] // '␣'\n * ```\n */\nexport const KEY_DISPLAY_SYMBOLS: Record<string, string> = {\n  ArrowUp: '↑',\n  ArrowDown: '↓',\n  ArrowLeft: '←',\n  ArrowRight: '→',\n  Enter: '↵',\n  Escape: 'Esc',\n  Backspace: '⌫',\n  Delete: '⌦',\n  Tab: '⇥',\n  Space: '␣',\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AA6BA,SAAgB,iBAA8C;AAC5D,KAAI,OAAO,cAAc,YACvB,QAAO;CAGT,MAAM,WAAW,UAAU,SAAS,aAAa;CACjD,MAAM,YAAY,UAAU,UAAU,aAAa;AAEnD,KAAI,SAAS,SAAS,MAAM,IAAI,UAAU,SAAS,MAAM,CACvD,QAAO;AAET,KAAI,SAAS,SAAS,MAAM,IAAI,UAAU,SAAS,MAAM,CACvD,QAAO;AAET,QAAO;;;;;;;;;;;;;;;;AAqBT,MAAa,iBAA2C;CACtD;CACA;CACA;CACA;CACD;;;;;;;;AASD,MAAa,gBAAgB,IAAI,IAAY,eAAe;;;;;;;;;;;;;;;;;;;;AAqB5D,MAAa,mBAA8D;CAEzE,SAAS;CACT,MAAM;CACN,SAAS;CACT,MAAM;CAGN,OAAO;CACP,OAAO;CAGP,KAAK;CACL,QAAQ;CACR,KAAK;CACL,QAAQ;CAGR,SAAS;CACT,KAAK;CACL,MAAM;CACN,SAAS;CACT,KAAK;CACL,MAAM;CAGN,kBAAkB;CAClB,KAAK;CACL,kBAAkB;CAClB,KAAK;CACN;;;;;;;;;;;;;;;;;;;;;;AAuBD,SAAgB,gBACd,UACA,WAAwC,gBAAgB,EACrC;AACnB,KAAI,aAAa,MACf,QAAO,aAAa,QAAQ,SAAS;AAEvC,QAAO;;;;;;;;AAaT,MAAa,cAAc,IAAI,IAAe;CAC5C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAC;;;;;;;;AASF,MAAa,cAAc,IAAI,IAAe;CAC5C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAC;;;;;;;AAQF,MAAa,gBAAgB,IAAI,IAAiB;CAChD;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAC;;;;;;;;AASF,MAAa,kBAAkB,IAAI,IAAmB;CACpD;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAC;;;;;;;;AASF,MAAa,eAAe,IAAI,IAAgB;CAC9C;CACA;CACA;CACA;CACA;CACA;CACD,CAAC;;;;;;;;;;;;;AAcF,MAAa,mBAAmB,IAAI,IAAoB;CACtD;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAC;;;;;;;;;;;;;;;AAgBF,MAAa,WAAW,IAAI,IAAI;CAC9B,GAAG;CACH,GAAG;CACH,GAAG;CACH,GAAG;CACH,GAAG;CACH,GAAG;CACJ,CAAC;;;;;;;;;;;;;;;;;;;;AAqBF,MAAM,cAAsC;CAE1C,KAAK;CACL,KAAK;CACL,QAAQ;CAGR,QAAQ;CACR,QAAQ;CACR,OAAO;CAGP,KAAK;CACL,OAAO;CACP,UAAU;CACV,UAAU;CAGV,KAAK;CAGL,WAAW;CAGX,KAAK;CACL,KAAK;CACL,QAAQ;CAGR,IAAI;CACJ,IAAI;CACJ,SAAS;CACT,MAAM;CACN,MAAM;CACN,WAAW;CACX,MAAM;CACN,MAAM;CACN,WAAW;CACX,OAAO;CACP,OAAO;CACP,YAAY;CAGZ,MAAM;CACN,KAAK;CACL,QAAQ;CACR,UAAU;CACV,MAAM;CACN,MAAM;CACN,MAAM;CACN,MAAM;CACP;;;;;;;;;;;;;;;;;;;;;;;;;AA0BD,SAAgB,iBAAiB,KAAqB;AAEpD,KAAI,OAAO,YACT,QAAO,YAAY;AAIrB,KAAI,IAAI,WAAW,KAAK,aAAa,KAAK,IAAI,CAC5C,QAAO,IAAI,aAAa;CAI1B,MAAM,WAAW,IAAI,aAAa;AAClC,KAAI,oBAAoB,KAAK,SAAS,CACpC,QAAO;AAGT,QAAO;;;;;;;;;;;;;;;;;AAsBT,MAAa,uBAA0D;CACrE,SAAS;CACT,KAAK;CACL,OAAO;CACP,MAAM;CACP;;;;;;;;;;;;;;;;AAiBD,MAAa,2BAA8D;CACzE,SAAS;CACT,KAAK;CACL,OAAO;CACP,MAAM;CACP;;;;;;;;;;;;;;;;AAiBD,MAAa,sBAA8C;CACzD,SAAS;CACT,WAAW;CACX,WAAW;CACX,YAAY;CACZ,OAAO;CACP,QAAQ;CACR,WAAW;CACX,QAAQ;CACR,KAAK;CACL,OAAO;CACR"}