@alwatr/keyboard-shortcut 9.26.0

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+Permanent-link, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1,156 @@
+# @alwatr/keyboard-shortcut
+
+**Global keyboard-to-action bridge for Alwatr Flux.**
+
+Listens for `keydown` events on `document`, normalizes the pressed key combination, and dispatches a corresponding Flux action. Designed to allow modules to react to keyboard shortcuts declaratively using `onAction()` without coupling to raw DOM events.
+
+---
+
+## Why `@alwatr/keyboard-shortcut`?
+
+In structured, reactive web applications, UI elements and user interactions should flow unidirectionally. Hardcoding `addEventListener('keydown')` within multiple UI components leads to fragmented shortcut management, duplicate event listeners, and difficulty in testing or overriding shortcuts.
+
+`@alwatr/keyboard-shortcut` unifies all keyboard interactions by:
+
+- Listening once globally on the document.
+- Normalizing the keyboard combo (e.g. modifier keys ordered deterministically as `ctrl → shift → alt`).
+- Dispatching standard typed Flux actions, which components can cleanly subscribe to.
+
+---
+
+## Installation
+
+```bash
+bun add @alwatr/keyboard-shortcut
+# or
+npm i @alwatr/keyboard-shortcut
+```
+
+---
+
+## Quick Start
+
+### 1. Initialize the shortcut listener
+
+Call `keyboardShortcutService.setup()` at application bootstrap:
+
+```ts
+import {keyboardShortcutService} from '@alwatr/keyboard-shortcut';
+
+keyboardShortcutService.setup();
+```
+
+### 2. Subscribe to shortcuts
+
+Subscribe to specific key action types using `onAction` from `@alwatr/action` or `@alwatr/flux`:
+
+```ts
+import {onAction} from '@alwatr/flux';
+
+// Close a drawer when Escape is pressed
+onAction('key_escape', () => {
+  closeDrawer();
+});
+
+// Save changes when Ctrl+S is pressed
+onAction('key_ctrl_s', () => {
+  saveChanges();
+});
+```
+
+### 3. Registering new shortcuts (Type Safety)
+
+Extend the global `ActionRecord` interface via declaration merging in your codebase to restrict and autocomplete shortcut actions:
+
+```ts
+declare module '@alwatr/action' {
+  interface ActionRecord {
+    'key_escape': void;
+    'key_ctrl_s': void;
+    'key_ctrl_space': void;
+    'key_ctrl_shift_u': void;
+  }
+}
+```
+
+---
+
+## Action Naming Convention
+
+Action types are prefixed with `key_` followed by the lowercase combo joined by `_`:
+
+| Keys pressed           | Action type            |
+| ---------------------- | ---------------------- |
+| Escape                 | `key_escape`           |
+| Space                  | `key_space`            |
+| Ctrl + S               | `key_ctrl_s`           |
+| Ctrl + Space           | `key_ctrl_space`       |
+| Shift + Ctrl + U       | `key_ctrl_shift_u`     |
+| Alt + Enter            | `key_alt_enter`        |
+| Ctrl + Shift + Alt + U | `key_ctrl_shift_alt_u` |
+
+Modifier order is always normalized to: **ctrl → shift → alt** (note: Meta/Command key is treated as Ctrl on Apple devices).
+
+### Text Fields Protection
+
+To prevent intercepting normal user typing, bare shortcut actions (without modifiers, e.g. letters, numbers, Escape, Enter) are automatically ignored when the focus is inside editable elements:
+
+- `<input>`
+- `<textarea>`
+- `<select>`
+- Any element with `contenteditable` attribute
+
+Shortcut combos that **include** a modifier (like `ctrlKey`, `metaKey`, or `altKey`) will still fire inside editable inputs normally (e.g. `Ctrl+S` will still trigger a save action).
+
+---
+
+## API Reference
+
+### `keyboardShortcutService`
+
+The singleton instance of `KeyboardShortcutService` used to manage the lifecycle of keyboard shortcut dispatching.
+
+#### `.setup()`
+
+Registers the global `keydown` event listener on `document` with `capture: true`. Safe to call multiple times (idempotent).
+
+```ts
+keyboardShortcutService.setup();
+```
+
+#### `.teardown()`
+
+Removes the global `keydown` event listener from the document. Useful for unit tests or micro-frontend unmounting.
+
+```ts
+keyboardShortcutService.teardown();
+```
+
+---
+
+## 🌊 Part of Alwatr Flux
+
+`@alwatr/keyboard-shortcut` is part of the [Alwatr Flux](https://github.com/Alwatr/alwatr/tree/next/pkg/flux) architecture — a complete Unidirectional Data Flow system for building scalable Progressive Web Applications.
+
+In the Flux architecture, it bridges physical keyboard events to the global action dispatcher, enabling clean separation of concerns between DOM event handling and business logic.
+
+```typescript
+// Use @alwatr/flux for the complete architecture
+import {keyboardShortcutService, onAction} from '@alwatr/flux';
+
+// Or use standalone
+import {keyboardShortcutService} from '@alwatr/keyboard-shortcut';
+import {onAction} from '@alwatr/action';
+```
+
+→ [View the complete Flux documentation](https://github.com/Alwatr/alwatr/tree/next/pkg/flux)
+
+---
+
+## Contributing
+
+Contributions are welcome! Please read our [contribution guidelines](https://github.com/Alwatr/.github/blob/next/CONTRIBUTING.md) before submitting a pull request.
+
+## License
+
+MPL-2.0 — see [LICENSE](./LICENSE).

package/dist/keyboard-shortcut.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Global keyboard-to-action bridge for Alwatr Flux.
+ *
+ * Listens for `keydown` on `document` and dispatches a flux action whose
+ * name is derived from the pressed key combination. This lets any module
+ * react to keyboard shortcuts declaratively via `onAction()` without
+ * coupling to raw DOM events.
+ *
+ * ## Action naming convention
+ *
+ * The action type follows the pattern `key_<combo>` where `<combo>` is
+ * built from active modifiers + key name, all **lowercase**, joined by `_`:
+ *
+ * | Keys pressed          | Action type              |
+ * | --------------------- | ------------------------ |
+ * | Escape                | `key_escape`             |
+ * | Space                 | `key_space`              |
+ * | Ctrl + S              | `key_ctrl_s`             |
+ * | Shift + Ctrl + U      | `key_ctrl_shift_u`       |
+ * | Alt + Enter           | `key_alt_enter`          |
+ *
+ * Modifier order is always **ctrl → shift → alt** for consistency.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * import {keyboardShortcutService, onAction} from '@alwatr/flux';
+ *
+ * // Initialize keyboard shortcut listener
+ * keyboardShortcutService.setup();
+ *
+ * // Close drawer on Escape
+ * onAction('key_escape', () => closeDrawer());
+ *
+ * // Save on Ctrl+S
+ * onAction('key_ctrl_s', () => save());
+ *
+ * // Cleanup when no longer needed
+ * keyboardShortcutService.teardown();
+ * ```
+ */
+/**
+ * Service to manage global keyboard shortcut mapping and dispatching.
+ *
+ * Implements global `keydown` event listener on `document` in the capture phase,
+ * normalizes modifier combinations, and dispatches equivalent flux actions.
+ */
+export declare class KeyboardShortcutService {
+    protected readonly logger_: import("@alwatr/logger").AlwatrLogger;
+    private readonly modifierKeys__;
+    private readonly editableTags__;
+    private hasRegistered__;
+    constructor();
+    /**
+     * Registers global event listener for `keydown` on `document`.
+     * Safe to call multiple times (idempotent).
+     *
+     * @example
+     * ```ts
+     * keyboardShortcutService.setup();
+     * ```
+     */
+    setup(): void;
+    /**
+     * Removes global event listener for `keydown` on `document`.
+     *
+     * @example
+     * ```ts
+     * keyboardShortcutService.teardown();
+     * ```
+     */
+    teardown(): void;
+    /**
+     * Global keydown event listener handler.
+     */
+    private handleKeyDown__;
+    /**
+     * Whether the event target is an editable element (input, textarea, select,
+     * or any element with `contenteditable`).
+     */
+    private isEditable__;
+    /**
+     * Whether the event carries at least one non-shift modifier (ctrl/meta/alt).
+     *
+     * Shift alone is not considered a modifier shortcut because Shift+Letter
+     * is normal typing (uppercase). Only ctrl/meta/alt signal an intentional
+     * keyboard shortcut.
+     */
+    private hasModifier__;
+    /**
+     * Builds a normalized, deterministic combo string from a KeyboardEvent.
+     *
+     * Modifier order is fixed (ctrl → shift → alt) so the same
+     * physical combination always produces the same string regardless of
+     * the order the user pressed the modifier keys.
+     */
+    private buildCombo__;
+}
+/**
+ * Singleton instance of KeyboardShortcutService.
+ *
+ * @example
+ * ```ts
+ * import {keyboardShortcutService} from '@alwatr/keyboard-shortcut';
+ *
+ * keyboardShortcutService.setup();
+ * ```
+ */
+export declare const keyboardShortcutService: KeyboardShortcutService;
+declare module '@alwatr/action' {
+    interface ActionRecord {
+        [key: `key_${string}`]: void;
+    }
+}
+//# sourceMappingURL=keyboard-shortcut.d.ts.map

package/dist/keyboard-shortcut.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboard-shortcut.d.ts","sourceRoot":"","sources":["../src/keyboard-shortcut.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAKH;;;;;GAKG;AACH,qBAAa,uBAAuB;IAClC,SAAS,CAAC,QAAQ,CAAC,OAAO,wCAA6C;IAGvE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgD;IAG/E,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA4C;IAE3E,OAAO,CAAC,eAAe,CAAS;;IAOhC;;;;;;;;OAQG;IACH,KAAK,IAAI,IAAI;IAOb;;;;;;;OAOG;IACH,QAAQ,IAAI,IAAI;IAOhB;;OAEG;IACH,OAAO,CAAC,eAAe;IAiBvB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAMpB;;;;;;OAMG;IACH,OAAO,CAAC,aAAa;IAIrB;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;CAYrB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,uBAAuB,yBAAgC,CAAC;AAIrE,OAAO,QAAQ,gBAAgB,CAAC;IAC9B,UAAU,YAAY;QACpB,CAAC,GAAG,EAAE,OAAO,MAAM,EAAE,GAAG,IAAI,CAAC;KAC9B;CACF"}

package/dist/main.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @alwatr/keyboard-shortcut — Global keyboard-to-action bridge.
+ *
+ * Listens for `keydown` on `document` and dispatches a flux action whose
+ * name is derived from the pressed key combination. This lets any module
+ * react to keyboard shortcuts declaratively via `onAction()` without
+ * coupling to raw DOM events.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * import {keyboardShortcutService, onAction} from '@alwatr/keyboard-shortcut';
+ *
+ * // Initialize keyboard shortcut listener
+ * keyboardShortcutService.setup();
+ *
+ * // Close drawer on Escape
+ * onAction('key_escape', () => closeDrawer());
+ * ```
+ */
+export * from './keyboard-shortcut.js';
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,cAAc,wBAAwB,CAAC"}

package/dist/main.js

@@ -0,0 +1,5 @@
+/* 📦 @alwatr/keyboard-shortcut v9.26.0 */
+import{dispatchAction as a}from"@alwatr/action";import{createLogger as r}from"@alwatr/logger";class i{logger_=r("keyboard-shortcut-service");modifierKeys__=new Set(["Control","Shift","Alt","Meta"]);editableTags__=new Set(["INPUT","TEXTAREA","SELECT"]);hasRegistered__=!1;constructor(){this.logger_.logMethod?.("constructor"),this.handleKeyDown__=this.handleKeyDown__.bind(this)}setup(){if(this.logger_.logMethod?.("setup"),this.hasRegistered__)return;this.hasRegistered__=!0,document.addEventListener("keydown",this.handleKeyDown__,{capture:!0})}teardown(){if(this.logger_.logMethod?.("teardown"),!this.hasRegistered__)return;this.hasRegistered__=!1,document.removeEventListener("keydown",this.handleKeyDown__,{capture:!0})}handleKeyDown__(o){if(this.modifierKeys__.has(o.key))return;if(this.isEditable__(o)&&!this.hasModifier__(o))return;let s=this.buildCombo__(o);this.logger_.logMethodArgs?.("keyboard_handler",{combo:s}),a({type:`key_${s}`})}isEditable__(o){let s=o.target;if(!(s instanceof HTMLElement))return!1;return this.editableTags__.has(s.tagName)||s.isContentEditable}hasModifier__(o){return o.ctrlKey||o.metaKey||o.altKey}buildCombo__(o){let s=[];if(o.ctrlKey||o.metaKey)s.push("ctrl");if(o.shiftKey)s.push("shift");if(o.altKey)s.push("alt");let d=o.key===" "?"space":o.key.toLowerCase();return s.push(d),s.join("_")}}var u=new i;export{u as keyboardShortcutService,i as KeyboardShortcutService};
+
+//# debugId=1EF3F6B2FDE9074464756E2164756E21
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../src/keyboard-shortcut.ts"],
+  "sourcesContent": [
+    "/**\n * Global keyboard-to-action bridge for Alwatr Flux.\n *\n * Listens for `keydown` on `document` and dispatches a flux action whose\n * name is derived from the pressed key combination. This lets any module\n * react to keyboard shortcuts declaratively via `onAction()` without\n * coupling to raw DOM events.\n *\n * ## Action naming convention\n *\n * The action type follows the pattern `key_<combo>` where `<combo>` is\n * built from active modifiers + key name, all **lowercase**, joined by `_`:\n *\n * | Keys pressed          | Action type              |\n * | --------------------- | ------------------------ |\n * | Escape                | `key_escape`             |\n * | Space                 | `key_space`              |\n * | Ctrl + S              | `key_ctrl_s`             |\n * | Shift + Ctrl + U      | `key_ctrl_shift_u`       |\n * | Alt + Enter           | `key_alt_enter`          |\n *\n * Modifier order is always **ctrl → shift → alt** for consistency.\n *\n * ## Usage\n *\n * ```ts\n * import {keyboardShortcutService, onAction} from '@alwatr/flux';\n *\n * // Initialize keyboard shortcut listener\n * keyboardShortcutService.setup();\n *\n * // Close drawer on Escape\n * onAction('key_escape', () => closeDrawer());\n *\n * // Save on Ctrl+S\n * onAction('key_ctrl_s', () => save());\n *\n * // Cleanup when no longer needed\n * keyboardShortcutService.teardown();\n * ```\n */\n\nimport {dispatchAction} from '@alwatr/action';\nimport {createLogger} from '@alwatr/logger';\n\n/**\n * Service to manage global keyboard shortcut mapping and dispatching.\n *\n * Implements global `keydown` event listener on `document` in the capture phase,\n * normalizes modifier combinations, and dispatches equivalent flux actions.\n */\nexport class KeyboardShortcutService {\n  protected readonly logger_ = createLogger('keyboard-shortcut-service');\n\n  // Modifier keys that should not produce standalone actions.\n  private readonly modifierKeys__ = new Set(['Control', 'Shift', 'Alt', 'Meta']);\n\n  // Editable element tags where bare key presses (no modifier) are user input, not shortcuts.\n  private readonly editableTags__ = new Set(['INPUT', 'TEXTAREA', 'SELECT']);\n\n  private hasRegistered__ = false;\n\n  constructor() {\n    this.logger_.logMethod?.('constructor');\n    this.handleKeyDown__ = this.handleKeyDown__.bind(this);\n  }\n\n  /**\n   * Registers global event listener for `keydown` on `document`.\n   * Safe to call multiple times (idempotent).\n   *\n   * @example\n   * ```ts\n   * keyboardShortcutService.setup();\n   * ```\n   */\n  setup(): void {\n    this.logger_.logMethod?.('setup');\n    if (this.hasRegistered__) return;\n    this.hasRegistered__ = true;\n    document.addEventListener('keydown', this.handleKeyDown__, {capture: true});\n  }\n\n  /**\n   * Removes global event listener for `keydown` on `document`.\n   *\n   * @example\n   * ```ts\n   * keyboardShortcutService.teardown();\n   * ```\n   */\n  teardown(): void {\n    this.logger_.logMethod?.('teardown');\n    if (!this.hasRegistered__) return;\n    this.hasRegistered__ = false;\n    document.removeEventListener('keydown', this.handleKeyDown__, {capture: true});\n  }\n\n  /**\n   * Global keydown event listener handler.\n   */\n  private handleKeyDown__(event: KeyboardEvent): void {\n    // Ignore standalone modifier presses — they are not actionable shortcuts.\n    if (this.modifierKeys__.has(event.key)) return;\n\n    // When focus is inside an editable element, only dispatch shortcut actions\n    // that include a real modifier (ctrl/meta/alt). Bare key presses like\n    // letters, digits, Escape, Enter, etc. are normal user input and must\n    // not be intercepted.\n    if (this.isEditable__(event) && !this.hasModifier__(event)) return;\n\n    const combo = this.buildCombo__(event);\n\n    this.logger_.logMethodArgs?.('keyboard_handler', {combo});\n\n    dispatchAction({type: `key_${combo}`});\n  }\n\n  /**\n   * Whether the event target is an editable element (input, textarea, select,\n   * or any element with `contenteditable`).\n   */\n  private isEditable__(event: KeyboardEvent): boolean {\n    const target = event.target;\n    if (!(target instanceof HTMLElement)) return false;\n    return this.editableTags__.has(target.tagName) || target.isContentEditable;\n  }\n\n  /**\n   * Whether the event carries at least one non-shift modifier (ctrl/meta/alt).\n   *\n   * Shift alone is not considered a modifier shortcut because Shift+Letter\n   * is normal typing (uppercase). Only ctrl/meta/alt signal an intentional\n   * keyboard shortcut.\n   */\n  private hasModifier__(event: KeyboardEvent): boolean {\n    return event.ctrlKey || event.metaKey || event.altKey;\n  }\n\n  /**\n   * Builds a normalized, deterministic combo string from a KeyboardEvent.\n   *\n   * Modifier order is fixed (ctrl → shift → alt) so the same\n   * physical combination always produces the same string regardless of\n   * the order the user pressed the modifier keys.\n   */\n  private buildCombo__(event: KeyboardEvent): string {\n    const parts: string[] = [];\n\n    if (event.ctrlKey || event.metaKey) parts.push('ctrl');\n    if (event.shiftKey) parts.push('shift');\n    if (event.altKey) parts.push('alt');\n\n    const key = event.key === ' ' ? 'space' : event.key.toLowerCase();\n    parts.push(key);\n\n    return parts.join('_');\n  }\n}\n\n/**\n * Singleton instance of KeyboardShortcutService.\n *\n * @example\n * ```ts\n * import {keyboardShortcutService} from '@alwatr/keyboard-shortcut';\n *\n * keyboardShortcutService.setup();\n * ```\n */\nexport const keyboardShortcutService = new KeyboardShortcutService();\n\n// Type augmentation — register the `key_*` pattern so any module can\n// declare specific shortcuts via ActionRecord merging.\ndeclare module '@alwatr/action' {\n  interface ActionRecord {\n    [key: `key_${string}`]: void;\n  }\n}\n"
+  ],
+  "mappings": ";AA0CA,yBAAQ,uBACR,uBAAQ,uBAQD,MAAM,CAAwB,CAChB,QAAU,EAAa,2BAA2B,EAGpD,eAAiB,IAAI,IAAI,CAAC,UAAW,QAAS,MAAO,MAAM,CAAC,EAG5D,eAAiB,IAAI,IAAI,CAAC,QAAS,WAAY,QAAQ,CAAC,EAEjE,gBAAkB,GAE1B,WAAW,EAAG,CACZ,KAAK,QAAQ,YAAY,aAAa,EACtC,KAAK,gBAAkB,KAAK,gBAAgB,KAAK,IAAI,EAYvD,KAAK,EAAS,CAEZ,GADA,KAAK,QAAQ,YAAY,OAAO,EAC5B,KAAK,gBAAiB,OAC1B,KAAK,gBAAkB,GACvB,SAAS,iBAAiB,UAAW,KAAK,gBAAiB,CAAC,QAAS,EAAI,CAAC,EAW5E,QAAQ,EAAS,CAEf,GADA,KAAK,QAAQ,YAAY,UAAU,EAC/B,CAAC,KAAK,gBAAiB,OAC3B,KAAK,gBAAkB,GACvB,SAAS,oBAAoB,UAAW,KAAK,gBAAiB,CAAC,QAAS,EAAI,CAAC,EAMvE,eAAe,CAAC,EAA4B,CAElD,GAAI,KAAK,eAAe,IAAI,EAAM,GAAG,EAAG,OAMxC,GAAI,KAAK,aAAa,CAAK,GAAK,CAAC,KAAK,cAAc,CAAK,EAAG,OAE5D,IAAM,EAAQ,KAAK,aAAa,CAAK,EAErC,KAAK,QAAQ,gBAAgB,mBAAoB,CAAC,OAAK,CAAC,EAExD,EAAe,CAAC,KAAM,OAAO,GAAO,CAAC,EAO/B,YAAY,CAAC,EAA+B,CAClD,IAAM,EAAS,EAAM,OACrB,GAAI,EAAE,aAAkB,aAAc,MAAO,GAC7C,OAAO,KAAK,eAAe,IAAI,EAAO,OAAO,GAAK,EAAO,kBAUnD,aAAa,CAAC,EAA+B,CACnD,OAAO,EAAM,SAAW,EAAM,SAAW,EAAM,OAUzC,YAAY,CAAC,EAA8B,CACjD,IAAM,EAAkB,CAAC,EAEzB,GAAI,EAAM,SAAW,EAAM,QAAS,EAAM,KAAK,MAAM,EACrD,GAAI,EAAM,SAAU,EAAM,KAAK,OAAO,EACtC,GAAI,EAAM,OAAQ,EAAM,KAAK,KAAK,EAElC,IAAM,EAAM,EAAM,MAAQ,IAAM,QAAU,EAAM,IAAI,YAAY,EAGhE,OAFA,EAAM,KAAK,CAAG,EAEP,EAAM,KAAK,GAAG,EAEzB,CAYO,IAAM,EAA0B,IAAI",
+  "debugId": "1EF3F6B2FDE9074464756E2164756E21",
+  "names": []
+}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@alwatr/keyboard-shortcut",
+  "version": "9.26.0",
+  "description": "Global keyboard-to-action bridge for Alwatr Flux. Listens for keydown and dispatches Flux actions based on normalized key combos.",
+  "license": "MPL-2.0",
+  "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com> (https://ali.mihandoost.com)",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Alwatr/alwatr",
+    "directory": "pkg/nanolib/keyboard-shortcut"
+  },
+  "homepage": "https://github.com/Alwatr/alwatr/tree/next/pkg/nanolib/keyboard-shortcut#readme",
+  "bugs": "https://github.com/Alwatr/alwatr/issues",
+  "exports": {
+    ".": {
+      "types": "./dist/main.d.ts",
+      "import": "./dist/main.js",
+      "default": "./dist/main.js"
+    }
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "@alwatr/action": "9.26.0",
+    "@alwatr/logger": "9.25.0"
+  },
+  "devDependencies": {
+    "@alwatr/nano-build": "9.25.0",
+    "@alwatr/standard": "9.16.0",
+    "@alwatr/type-helper": "9.14.0",
+    "@happy-dom/global-registrator": "^20.9.0",
+    "typescript": "^6.0.3"
+  },
+  "scripts": {
+    "b": "bun run build",
+    "build": "bun run build:ts && bun run build:es",
+    "build:es": "nano-build --preset=module-web src/main.ts",
+    "build:ts": "tsc --build",
+    "cl": "bun run clean",
+    "clean": "rm -rfv dist *.tsbuildinfo",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "eslint src/ --ext .ts",
+    "t": "bun run test",
+    "test": "ALWATR_DEBUG=0 bun test",
+    "w": "bun run watch",
+    "watch": "bun run watch:ts & bun run watch:es",
+    "watch:es": "bun run build:es --watch",
+    "watch:ts": "bun run build:ts --watch --preserveWatchOutput"
+  },
+  "files": [
+    "dist",
+    "src/**/*.ts",
+    "!src/**/*.test.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "alwatr",
+    "browser",
+    "esm",
+    "javascript",
+    "module",
+    "nanolib",
+    "keyboard",
+    "shortcut",
+    "action",
+    "flux",
+    "typescript"
+  ],
+  "gitHead": "ef62969b649929413c640e69d241f4e99d6062e8"
+}

package/src/keyboard-shortcut.ts

@@ -0,0 +1,179 @@
+/**
+ * Global keyboard-to-action bridge for Alwatr Flux.
+ *
+ * Listens for `keydown` on `document` and dispatches a flux action whose
+ * name is derived from the pressed key combination. This lets any module
+ * react to keyboard shortcuts declaratively via `onAction()` without
+ * coupling to raw DOM events.
+ *
+ * ## Action naming convention
+ *
+ * The action type follows the pattern `key_<combo>` where `<combo>` is
+ * built from active modifiers + key name, all **lowercase**, joined by `_`:
+ *
+ * | Keys pressed          | Action type              |
+ * | --------------------- | ------------------------ |
+ * | Escape                | `key_escape`             |
+ * | Space                 | `key_space`              |
+ * | Ctrl + S              | `key_ctrl_s`             |
+ * | Shift + Ctrl + U      | `key_ctrl_shift_u`       |
+ * | Alt + Enter           | `key_alt_enter`          |
+ *
+ * Modifier order is always **ctrl → shift → alt** for consistency.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * import {keyboardShortcutService, onAction} from '@alwatr/flux';
+ *
+ * // Initialize keyboard shortcut listener
+ * keyboardShortcutService.setup();
+ *
+ * // Close drawer on Escape
+ * onAction('key_escape', () => closeDrawer());
+ *
+ * // Save on Ctrl+S
+ * onAction('key_ctrl_s', () => save());
+ *
+ * // Cleanup when no longer needed
+ * keyboardShortcutService.teardown();
+ * ```
+ */
+
+import {dispatchAction} from '@alwatr/action';
+import {createLogger} from '@alwatr/logger';
+
+/**
+ * Service to manage global keyboard shortcut mapping and dispatching.
+ *
+ * Implements global `keydown` event listener on `document` in the capture phase,
+ * normalizes modifier combinations, and dispatches equivalent flux actions.
+ */
+export class KeyboardShortcutService {
+  protected readonly logger_ = createLogger('keyboard-shortcut-service');
+
+  // Modifier keys that should not produce standalone actions.
+  private readonly modifierKeys__ = new Set(['Control', 'Shift', 'Alt', 'Meta']);
+
+  // Editable element tags where bare key presses (no modifier) are user input, not shortcuts.
+  private readonly editableTags__ = new Set(['INPUT', 'TEXTAREA', 'SELECT']);
+
+  private hasRegistered__ = false;
+
+  constructor() {
+    this.logger_.logMethod?.('constructor');
+    this.handleKeyDown__ = this.handleKeyDown__.bind(this);
+  }
+
+  /**
+   * Registers global event listener for `keydown` on `document`.
+   * Safe to call multiple times (idempotent).
+   *
+   * @example
+   * ```ts
+   * keyboardShortcutService.setup();
+   * ```
+   */
+  setup(): void {
+    this.logger_.logMethod?.('setup');
+    if (this.hasRegistered__) return;
+    this.hasRegistered__ = true;
+    document.addEventListener('keydown', this.handleKeyDown__, {capture: true});
+  }
+
+  /**
+   * Removes global event listener for `keydown` on `document`.
+   *
+   * @example
+   * ```ts
+   * keyboardShortcutService.teardown();
+   * ```
+   */
+  teardown(): void {
+    this.logger_.logMethod?.('teardown');
+    if (!this.hasRegistered__) return;
+    this.hasRegistered__ = false;
+    document.removeEventListener('keydown', this.handleKeyDown__, {capture: true});
+  }
+
+  /**
+   * Global keydown event listener handler.
+   */
+  private handleKeyDown__(event: KeyboardEvent): void {
+    // Ignore standalone modifier presses — they are not actionable shortcuts.
+    if (this.modifierKeys__.has(event.key)) return;
+
+    // When focus is inside an editable element, only dispatch shortcut actions
+    // that include a real modifier (ctrl/meta/alt). Bare key presses like
+    // letters, digits, Escape, Enter, etc. are normal user input and must
+    // not be intercepted.
+    if (this.isEditable__(event) && !this.hasModifier__(event)) return;
+
+    const combo = this.buildCombo__(event);
+
+    this.logger_.logMethodArgs?.('keyboard_handler', {combo});
+
+    dispatchAction({type: `key_${combo}`});
+  }
+
+  /**
+   * Whether the event target is an editable element (input, textarea, select,
+   * or any element with `contenteditable`).
+   */
+  private isEditable__(event: KeyboardEvent): boolean {
+    const target = event.target;
+    if (!(target instanceof HTMLElement)) return false;
+    return this.editableTags__.has(target.tagName) || target.isContentEditable;
+  }
+
+  /**
+   * Whether the event carries at least one non-shift modifier (ctrl/meta/alt).
+   *
+   * Shift alone is not considered a modifier shortcut because Shift+Letter
+   * is normal typing (uppercase). Only ctrl/meta/alt signal an intentional
+   * keyboard shortcut.
+   */
+  private hasModifier__(event: KeyboardEvent): boolean {
+    return event.ctrlKey || event.metaKey || event.altKey;
+  }
+
+  /**
+   * Builds a normalized, deterministic combo string from a KeyboardEvent.
+   *
+   * Modifier order is fixed (ctrl → shift → alt) so the same
+   * physical combination always produces the same string regardless of
+   * the order the user pressed the modifier keys.
+   */
+  private buildCombo__(event: KeyboardEvent): string {
+    const parts: string[] = [];
+
+    if (event.ctrlKey || event.metaKey) parts.push('ctrl');
+    if (event.shiftKey) parts.push('shift');
+    if (event.altKey) parts.push('alt');
+
+    const key = event.key === ' ' ? 'space' : event.key.toLowerCase();
+    parts.push(key);
+
+    return parts.join('_');
+  }
+}
+
+/**
+ * Singleton instance of KeyboardShortcutService.
+ *
+ * @example
+ * ```ts
+ * import {keyboardShortcutService} from '@alwatr/keyboard-shortcut';
+ *
+ * keyboardShortcutService.setup();
+ * ```
+ */
+export const keyboardShortcutService = new KeyboardShortcutService();
+
+// Type augmentation — register the `key_*` pattern so any module can
+// declare specific shortcuts via ActionRecord merging.
+declare module '@alwatr/action' {
+  interface ActionRecord {
+    [key: `key_${string}`]: void;
+  }
+}

package/src/main.ts

@@ -0,0 +1,22 @@
+/**
+ * @alwatr/keyboard-shortcut — Global keyboard-to-action bridge.
+ *
+ * Listens for `keydown` on `document` and dispatches a flux action whose
+ * name is derived from the pressed key combination. This lets any module
+ * react to keyboard shortcuts declaratively via `onAction()` without
+ * coupling to raw DOM events.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * import {keyboardShortcutService, onAction} from '@alwatr/keyboard-shortcut';
+ *
+ * // Initialize keyboard shortcut listener
+ * keyboardShortcutService.setup();
+ *
+ * // Close drawer on Escape
+ * onAction('key_escape', () => closeDrawer());
+ * ```
+ */
+
+export * from './keyboard-shortcut.js';