@tanstack/svelte-hotkeys 0.8.4 → 0.9.1

package/dist/getHotkeyRegistrations.svelte.d.ts

@@ -0,0 +1,26 @@
+import type { HotkeyRegistrationView, SequenceRegistrationView } from '@tanstack/hotkeys';
+export interface SvelteHotkeyRegistrations {
+    readonly hotkeys: Array<HotkeyRegistrationView>;
+    readonly sequences: Array<SequenceRegistrationView>;
+}
+/**
+ * Svelte function that returns reactive access to all hotkey and sequence
+ * registrations from the singleton managers.
+ *
+ * This is a standalone function that does NOT require the HotkeysProvider.
+ *
+ * @returns Object with reactive `hotkeys` and `sequences` properties
+ *
+ * @example
+ * ```svelte
+ * <script>
+ *   import { getHotkeyRegistrations } from '@tanstack/svelte-hotkeys'
+ *
+ *   const registrations = getHotkeyRegistrations()
+ * </script>
+ * {#each registrations.hotkeys as reg}
+ *   <div>{reg.options.meta?.name} — {reg.triggerCount} triggers</div>
+ * {/each}
+ * ```
+ */
+export declare function getHotkeyRegistrations(): SvelteHotkeyRegistrations;

package/dist/getHotkeyRegistrations.svelte.js

@@ -0,0 +1,48 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _HotkeyRegistrationsState_hotkeyManager, _HotkeyRegistrationsState_sequenceManager, _HotkeyRegistrationsState_subscribeHotkeys, _HotkeyRegistrationsState_subscribeSequences;
+import { getHotkeyManager, getSequenceManager, toHotkeyRegistrationView, } from '@tanstack/hotkeys';
+import { createStoreSubscriber } from './internal.svelte';
+class HotkeyRegistrationsState {
+    constructor() {
+        _HotkeyRegistrationsState_hotkeyManager.set(this, getHotkeyManager());
+        _HotkeyRegistrationsState_sequenceManager.set(this, getSequenceManager());
+        _HotkeyRegistrationsState_subscribeHotkeys.set(this, createStoreSubscriber(__classPrivateFieldGet(this, _HotkeyRegistrationsState_hotkeyManager, "f").registrations));
+        _HotkeyRegistrationsState_subscribeSequences.set(this, createStoreSubscriber(__classPrivateFieldGet(this, _HotkeyRegistrationsState_sequenceManager, "f").registrations));
+    }
+    get hotkeys() {
+        __classPrivateFieldGet(this, _HotkeyRegistrationsState_subscribeHotkeys, "f").call(this);
+        return Array.from(__classPrivateFieldGet(this, _HotkeyRegistrationsState_hotkeyManager, "f").registrations.state.values()).map(toHotkeyRegistrationView);
+    }
+    get sequences() {
+        __classPrivateFieldGet(this, _HotkeyRegistrationsState_subscribeSequences, "f").call(this);
+        return Array.from(__classPrivateFieldGet(this, _HotkeyRegistrationsState_sequenceManager, "f").registrations.state.values());
+    }
+}
+_HotkeyRegistrationsState_hotkeyManager = new WeakMap(), _HotkeyRegistrationsState_sequenceManager = new WeakMap(), _HotkeyRegistrationsState_subscribeHotkeys = new WeakMap(), _HotkeyRegistrationsState_subscribeSequences = new WeakMap();
+/**
+ * Svelte function that returns reactive access to all hotkey and sequence
+ * registrations from the singleton managers.
+ *
+ * This is a standalone function that does NOT require the HotkeysProvider.
+ *
+ * @returns Object with reactive `hotkeys` and `sequences` properties
+ *
+ * @example
+ * ```svelte
+ * <script>
+ *   import { getHotkeyRegistrations } from '@tanstack/svelte-hotkeys'
+ *
+ *   const registrations = getHotkeyRegistrations()
+ * </script>
+ * {#each registrations.hotkeys as reg}
+ *   <div>{reg.options.meta?.name} — {reg.triggerCount} triggers</div>
+ * {/each}
+ * ```
+ */
+export function getHotkeyRegistrations() {
+    return new HotkeyRegistrationsState();
+}

package/dist/getIsKeyHeld.svelte.d.ts

@@ -1,4 +1,4 @@
-import type { HeldKey } from '@tanstack/hotkeys';
+import type { IndividualKey } from '@tanstack/hotkeys';
 export interface SvelteHeldKeyState {
     readonly held: boolean;
 }
@@ -41,4 +41,4 @@ export interface SvelteHeldKeyState {
  * </div>
  * ```
  */
-export declare function getIsKeyHeld(key: HeldKey): SvelteHeldKeyState;
+export declare function getIsKeyHeld(key: IndividualKey): SvelteHeldKeyState;

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export * from './createHotkeySequences.svelte';
 export * from './createHotkeyRecorder.svelte';
 export * from './createHotkeySequenceRecorder.svelte';
 export * from './getHeldKeys.svelte';
+export * from './getHotkeyRegistrations.svelte';
 export * from './getHeldKeyCodesMap.svelte';
 export * from './getIsKeyHeld.svelte';
 export { default as HotkeysProvider } from './HotkeysProvider.svelte';

package/dist/index.js

@@ -7,6 +7,7 @@ export * from './createHotkeySequences.svelte';
 export * from './createHotkeyRecorder.svelte';
 export * from './createHotkeySequenceRecorder.svelte';
 export * from './getHeldKeys.svelte';
+export * from './getHotkeyRegistrations.svelte';
 export * from './getHeldKeyCodesMap.svelte';
 export * from './getIsKeyHeld.svelte';
 export { default as HotkeysProvider } from './HotkeysProvider.svelte';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/svelte-hotkeys",
-  "version": "0.8.4",
+  "version": "0.9.1",
   "description": "Svelte adapter for TanStack Hotkeys",
   "author": "Kunal Rao",
   "license": "MIT",
@@ -40,7 +40,7 @@
     "src"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.6.4"
+    "@tanstack/hotkeys": "0.7.1"
   },
   "devDependencies": {
     "@sveltejs/package": "^2.5.7",

package/src/getHotkeyRegistrations.svelte.ts

@@ -0,0 +1,60 @@
+import {
+  getHotkeyManager,
+  getSequenceManager,
+  toHotkeyRegistrationView,
+} from '@tanstack/hotkeys'
+import { createStoreSubscriber } from './internal.svelte'
+import type {
+  HotkeyRegistrationView,
+  SequenceRegistrationView,
+} from '@tanstack/hotkeys'
+
+export interface SvelteHotkeyRegistrations {
+  readonly hotkeys: Array<HotkeyRegistrationView>
+  readonly sequences: Array<SequenceRegistrationView>
+}
+
+class HotkeyRegistrationsState implements SvelteHotkeyRegistrations {
+  #hotkeyManager = getHotkeyManager()
+  #sequenceManager = getSequenceManager()
+  #subscribeHotkeys = createStoreSubscriber(this.#hotkeyManager.registrations)
+  #subscribeSequences = createStoreSubscriber(
+    this.#sequenceManager.registrations,
+  )
+
+  get hotkeys(): Array<HotkeyRegistrationView> {
+    this.#subscribeHotkeys()
+    return Array.from(this.#hotkeyManager.registrations.state.values()).map(
+      toHotkeyRegistrationView,
+    )
+  }
+
+  get sequences(): Array<SequenceRegistrationView> {
+    this.#subscribeSequences()
+    return Array.from(this.#sequenceManager.registrations.state.values())
+  }
+}
+
+/**
+ * Svelte function that returns reactive access to all hotkey and sequence
+ * registrations from the singleton managers.
+ *
+ * This is a standalone function that does NOT require the HotkeysProvider.
+ *
+ * @returns Object with reactive `hotkeys` and `sequences` properties
+ *
+ * @example
+ * ```svelte
+ * <script>
+ *   import { getHotkeyRegistrations } from '@tanstack/svelte-hotkeys'
+ *
+ *   const registrations = getHotkeyRegistrations()
+ * </script>
+ * {#each registrations.hotkeys as reg}
+ *   <div>{reg.options.meta?.name} — {reg.triggerCount} triggers</div>
+ * {/each}
+ * ```
+ */
+export function getHotkeyRegistrations(): SvelteHotkeyRegistrations {
+  return new HotkeyRegistrationsState()
+}

package/src/getIsKeyHeld.svelte.ts

@@ -1,6 +1,6 @@
 import { getKeyStateTracker } from '@tanstack/hotkeys'
 import { createStoreSubscriber } from './internal.svelte'
-import type { HeldKey } from '@tanstack/hotkeys'
+import type { IndividualKey } from '@tanstack/hotkeys'
 
 export interface SvelteHeldKeyState {
   readonly held: boolean
@@ -11,7 +11,7 @@ class HeldKeyState implements SvelteHeldKeyState {
   #normalizedKey: string
   #subscribe = createStoreSubscriber(this.#tracker.store)
 
-  constructor(key: HeldKey) {
+  constructor(key: IndividualKey) {
     this.#normalizedKey = key.toLowerCase()
   }
 
@@ -63,6 +63,6 @@ class HeldKeyState implements SvelteHeldKeyState {
  * ```
  */
 
-export function getIsKeyHeld(key: HeldKey): SvelteHeldKeyState {
+export function getIsKeyHeld(key: IndividualKey): SvelteHeldKeyState {
   return new HeldKeyState(key)
 }

package/src/index.ts

@@ -8,6 +8,7 @@ export * from './createHotkeySequences.svelte'
 export * from './createHotkeyRecorder.svelte'
 export * from './createHotkeySequenceRecorder.svelte'
 export * from './getHeldKeys.svelte'
+export * from './getHotkeyRegistrations.svelte'
 export * from './getHeldKeyCodesMap.svelte'
 export * from './getIsKeyHeld.svelte'
 export { default as HotkeysProvider } from './HotkeysProvider.svelte'