@tanstack/octane-hotkeys 0.11.0 → 0.11.1

package/dist/HotkeysProvider.d.ts

@@ -1,7 +1,6 @@
 import { UseHotkeyCommonOptions } from "./useHotkey.js";
 import { AppHotkeys, AppHotkeysStore, CustomHotkeys, HotkeyChordRecorderOptions, HotkeyPlatform, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
 import { HotkeysProviderScopeProps } from "@tanstack/hotkeys/adapter";
-//#region src/HotkeysProvider.d.ts
 export interface DefaultHotkeysOptions {
   /**
    * The user's platform, for labels from `useFormatForDisplay`, hotkeys, and
@@ -37,8 +36,8 @@ export interface HotkeysProviderProps extends HotkeysProviderScopeProps {
   /**
    * The user's saved custom hotkeys. When the value changes, such as after
    * saved data loads or the user signs in, it replaces the current custom
-   * hotkeys. `undefined` leaves them unchanged; `null` clears them. Invalid
-   * entries are ignored with a warning.
+   * hotkeys. `undefined` leaves them unchanged; `null` clears them. Unknown
+   * ids and invalid entries are ignored.
    */
   customHotkeys?: CustomHotkeys | null;
   /** Called with the custom hotkeys after every change, ready to save. */
@@ -63,4 +62,4 @@ export declare function HotkeysProvider({ children, defaultOptions, appHotkeys,
   };
   children: unknown;
 }>;
-//#endregion
+export {};

package/dist/HotkeysProvider.js

@@ -1,9 +1,9 @@
 import { subSlot } from "./internal.js";
 import { publishAppHotkeysStore } from "@tanstack/hotkeys";
-import { createContext, createElement, useContext, useLayoutEffect, useRef } from "octane";
 import { activateHotkeysProviderScope, createAppHotkeysStore, getHotkeysProviderScopeKey, mergeHotkeysProviderDefaults } from "@tanstack/hotkeys/adapter";
+import { createContext, createElement, useContext, useLayoutEffect, useRef } from "octane";
 
-//#region src/HotkeysProvider.ts
+// src/HotkeysProvider.ts
 const HotkeysContext = createContext(null);
 /** Reads the nearest provider, or null outside a provider. */
 function useHotkeysContext() {
@@ -55,5 +55,4 @@ function HotkeysProvider({ children, defaultOptions, appHotkeys, customHotkeys,
 	});
 }
 
-//#endregion
 export { HotkeysProvider, useDefaultHotkeysOptions, useHotkeysContext };

package/dist/index.d.ts

@@ -1,15 +1,15 @@
-import { UseAppHotkeyOptions, UseHotkeyChordOptions, UseHotkeyCommonOptions, UseHotkeyOptions, UseHotkeyOptionsFor, UseHotkeySequenceOptions, UseHotkeyTarget, useHotkey } from "./useHotkey.js";
 import { DefaultHotkeysOptions, HotkeysProvider, HotkeysProviderOptions, HotkeysProviderProps, useDefaultHotkeysOptions, useHotkeysContext } from "./HotkeysProvider.js";
 import { UseHotkeyDefinition, useHotkeys } from "./useHotkeys.js";
+import { UseAppHotkeyOptions, UseHotkeyChordOptions, UseHotkeyCommonOptions, UseHotkeyOptions, UseHotkeyOptionsFor, UseHotkeySequenceOptions, UseHotkeyTarget, useHotkey } from "./useHotkey.js";
 import { useHeldKeys } from "./useHeldKeys.js";
 import { useHeldKeyCodes } from "./useHeldKeyCodes.js";
 import { useKeyHold } from "./useKeyHold.js";
 import { useHotkeyHint } from "./useHotkeyHint.js";
 import { useFormatForDisplay } from "./useFormatForDisplay.js";
-import { HotkeyRegistrationsResult, OctaneHotkeyRecorder, UseCustomHotkeysResult } from "./types.js";
 import { useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
 import { useHotkeyScopesState } from "./useHotkeyScopesState.js";
 import { useHotkeyRecorder } from "./useHotkeyRecorder.js";
 import { useAppHotkeyList, useAppHotkeys, useCustomHotkeys } from "./useAppHotkeys.js";
+import { HotkeyRegistrationsResult, OctaneHotkeyRecorder, UseCustomHotkeysResult } from "./types.js";
 export * from "@tanstack/hotkeys";
 export { type DefaultHotkeysOptions, HotkeyRegistrationsResult, HotkeysProvider, type HotkeysProviderOptions, type HotkeysProviderProps, OctaneHotkeyRecorder, UseAppHotkeyOptions, UseCustomHotkeysResult, UseHotkeyChordOptions, UseHotkeyCommonOptions, UseHotkeyDefinition, UseHotkeyOptions, UseHotkeyOptionsFor, UseHotkeySequenceOptions, UseHotkeyTarget, useAppHotkeyList, useAppHotkeys, useCustomHotkeys, useDefaultHotkeysOptions, useFormatForDisplay, useHeldKeyCodes, useHeldKeys, useHotkey, useHotkeyHint, useHotkeyRecorder, useHotkeyRegistrations, useHotkeyScopesState, useHotkeys, useHotkeysContext, useKeyHold };

package/dist/internal.js

@@ -1,7 +1,7 @@
-import { useCallback, useRef, useSyncExternalStore } from "octane";
 import { createStore } from "@tanstack/hotkeys/adapter";
+import { useCallback, useRef, useSyncExternalStore } from "octane";
 
-//#region src/internal.ts
+// src/internal.ts
 const subSlotCache = /* @__PURE__ */ new Map();
 const bareTagCache = /* @__PURE__ */ new Map();
 function subSlot(slot, tag) {
@@ -61,5 +61,4 @@ function useAppHotkeysStore(store, slot) {
 	return store;
 }
 
-//#endregion
 export { select, splitSlot, subSlot, useAppHotkeysStore };

package/dist/types.d.ts

@@ -1,5 +1,4 @@
 import { AppHotkey, CustomHotkeys, Hotkey, HotkeyRegistrationView, HotkeySequence, RegisteredAppHotkeys } from "@tanstack/hotkeys";
-//#region src/types.d.ts
 /** Recording state and controls owned by the containing component. */
 export interface OctaneHotkeyRecorder<THotkey extends Hotkey = Hotkey> {
   /** Whether the recorder is listening for a shortcut. */
@@ -37,5 +36,4 @@ export interface UseCustomHotkeysResult {
   resetCustomHotkeys: () => void;
   /** Other app hotkeys that would collide if `id` used `hotkey`. */
   findConflicts: (id: keyof RegisteredAppHotkeys & string, hotkey: Hotkey) => Array<AppHotkey>;
-}
-//#endregion
+}

package/dist/useAppHotkeys.d.ts

@@ -1,6 +1,5 @@
 import { UseCustomHotkeysResult } from "./types.js";
 import { AppHotkeyListItem, RegisteredAppHotkeys } from "@tanstack/hotkeys";
-//#region src/useAppHotkeys.d.ts
 /**
  * Returns the effective app hotkeys from `HotkeysProvider`, typed by
  * `Register`: each declaration with the user's custom hotkey applied.
@@ -17,5 +16,4 @@ export declare function useAppHotkeyList(): Array<AppHotkeyListItem<RegisteredAp
  * registered app hotkey immediately and are passed to the provider's
  * `onCustomHotkeysChange`, ready to save.
  */
-export declare function useCustomHotkeys(): UseCustomHotkeysResult;
-//#endregion
+export declare function useCustomHotkeys(): UseCustomHotkeysResult;

package/dist/useAppHotkeys.js

@@ -1,11 +1,11 @@
-import { subSlot, useAppHotkeysStore } from "./internal.js";
 import { useHotkeysContext } from "./HotkeysProvider.js";
+import { subSlot, useAppHotkeysStore } from "./internal.js";
 import { useHotkeyRegistrations } from "./useHotkeyRegistrations.js";
 
-//#region src/useAppHotkeys.ts
+// src/useAppHotkeys.ts
 function useRequiredStore(name, slot) {
 	const store = useAppHotkeysStore(useHotkeysContext()?.appHotkeysStore ?? null, subSlot(slot, `${name}-store`));
-	if (!store) throw new Error(`${name} requires a HotkeysProvider with appHotkeys`);
+	if (!store) throw new Error(`[hotkeys] ${name} requires a HotkeysProvider with appHotkeys`);
 	return store;
 }
 function useAppHotkeys(slot) {
@@ -27,5 +27,4 @@ function useCustomHotkeys(slot) {
 	};
 }
 
-//#endregion
 export { useAppHotkeyList, useAppHotkeys, useCustomHotkeys };

package/dist/useFormatForDisplay.d.ts

@@ -1,5 +1,4 @@
 import { formatForDisplay } from "@tanstack/hotkeys";
-//#region src/useFormatForDisplay.d.ts
 /**
  * Returns `formatForDisplay` with the platform from `HotkeysProvider`, or the
  * detected platform without one. A `platform` passed to the returned function
@@ -22,5 +21,4 @@ import { formatForDisplay } from "@tanstack/hotkeys";
  * }
  * ```
  */
-export declare function useFormatForDisplay(): typeof formatForDisplay;
-//#endregion
+export declare function useFormatForDisplay(): typeof formatForDisplay;

package/dist/useFormatForDisplay.js

@@ -1,10 +1,10 @@
-import { subSlot } from "./internal.js";
 import { useDefaultHotkeysOptions } from "./HotkeysProvider.js";
+import { subSlot } from "./internal.js";
 import { detectPlatform, formatForDisplay } from "@tanstack/hotkeys";
-import { useCallback, useSyncExternalStore } from "octane";
 import { getServerPlatformSnapshot } from "@tanstack/hotkeys/adapter";
+import { useCallback, useSyncExternalStore } from "octane";
 
-//#region src/useFormatForDisplay.ts
+// src/useFormatForDisplay.ts
 const subscribe = () => () => {};
 function useFormatForDisplay(slot) {
 	const provided = useDefaultHotkeysOptions().platform;
@@ -15,5 +15,4 @@ function useFormatForDisplay(slot) {
 	}), [platform], subSlot(slot, "format"));
 }
 
-//#endregion
 export { useFormatForDisplay };

package/dist/useHeldKeyCodes.d.ts

@@ -1,4 +1,2 @@
-//#region src/useHeldKeyCodes.d.ts
 /** Reads held physical key codes from the shared key tracker. */
-export declare function useHeldKeyCodes(): Record<string, string>;
-//#endregion
+export declare function useHeldKeyCodes(): Record<string, string>;

package/dist/useHeldKeyCodes.js

@@ -1,10 +1,9 @@
 import { select, subSlot } from "./internal.js";
 import { getKeyStateTracker } from "@tanstack/hotkeys";
 
-//#region src/useHeldKeyCodes.ts
+// src/useHeldKeyCodes.ts
 function useHeldKeyCodes(slot) {
 	return select(getKeyStateTracker().store, (state) => state.heldCodes, subSlot(slot, "held-codes"));
 }
 
-//#endregion
 export { useHeldKeyCodes };

package/dist/useHeldKeys.d.ts

@@ -1,4 +1,2 @@
-//#region src/useHeldKeys.d.ts
 /** Reads held logical keys from the shared key tracker. */
-export declare function useHeldKeys(): Array<string>;
-//#endregion
+export declare function useHeldKeys(): Array<string>;

package/dist/useHeldKeys.js

@@ -1,10 +1,9 @@
 import { select, subSlot } from "./internal.js";
 import { getKeyStateTracker } from "@tanstack/hotkeys";
 
-//#region src/useHeldKeys.ts
+// src/useHeldKeys.ts
 function useHeldKeys(slot) {
 	return select(getKeyStateTracker().store, (state) => state.heldKeys, subSlot(slot, "held-keys"));
 }
 
-//#endregion
 export { useHeldKeys };

package/dist/useHotkey.d.ts

@@ -1,6 +1,5 @@
 import { AppHotkey, HotkeyCallback, HotkeyCallbackContextFor, RegisterableHotkey, Target } from "@tanstack/hotkeys";
 import { AdapterAppHotkeyOptions, AdapterChordOptions, AdapterCommonOptions, AdapterHotkeyOptions, AdapterOptionsFor, AdapterSequenceOptions } from "@tanstack/hotkeys/adapter";
-//#region src/useHotkey.d.ts
 /** The element to listen on. A `null` target skips registration until it is set. */
 export type UseHotkeyTarget = Target | null;
 /** Options shared by chords and sequences. */
@@ -22,5 +21,4 @@ export type UseAppHotkeyOptions<T extends AppHotkey = AppHotkey> = AdapterAppHot
  * registers nothing, for an optional shortcut.
  */
 export declare function useHotkey<T extends AppHotkey>(hotkey: T | null | undefined, callback: HotkeyCallback, options?: UseAppHotkeyOptions<T>): void;
-export declare function useHotkey<const T extends RegisterableHotkey>(hotkey: T | null | undefined, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: UseHotkeyOptionsFor<T>): void;
-//#endregion
+export declare function useHotkey<const T extends RegisterableHotkey>(hotkey: T | null | undefined, callback: HotkeyCallback<HotkeyCallbackContextFor<T>>, options?: UseHotkeyOptionsFor<T>): void;

package/dist/useHotkey.js

@@ -1,7 +1,7 @@
 import { splitSlot, subSlot } from "./internal.js";
 import { useHotkeys } from "./useHotkeys.js";
 
-//#region src/useHotkey.ts
+// src/useHotkey.ts
 function useHotkey(hotkey, callback, ...rest) {
 	const [args, slot] = splitSlot(rest);
 	useHotkeys([{
@@ -11,5 +11,4 @@ function useHotkey(hotkey, callback, ...rest) {
 	}], void 0, subSlot(slot, "hotkey"));
 }
 
-//#endregion
 export { useHotkey };

package/dist/useHotkeyHint.d.ts

@@ -1,5 +1,4 @@
 import { AppHotkey, HeldModifierOptions, RegisterableHotkey } from "@tanstack/hotkeys";
-//#region src/useHotkeyHint.d.ts
 /**
  * Reports whether held modifiers reveal a shortcut hint. The hint shows only
  * while the hotkey can fire: some registration of it is enabled and in an
@@ -8,5 +7,4 @@ import { AppHotkey, HeldModifierOptions, RegisterableHotkey } from "@tanstack/ho
  * while unbound). No hotkey (`undefined`, `null`, or `''`) returns false. A
  * hotkey on an element counts only while focus is inside it.
  */
-export declare function useHotkeyHint(hotkey: RegisterableHotkey | AppHotkey | null | undefined, options?: HeldModifierOptions): boolean;
-//#endregion
+export declare function useHotkeyHint(hotkey: RegisterableHotkey | AppHotkey | null | undefined, options?: HeldModifierOptions): boolean;

package/dist/useHotkeyHint.js

@@ -1,8 +1,8 @@
-import { select, splitSlot, subSlot, useAppHotkeysStore } from "./internal.js";
 import { useHotkeysContext } from "./HotkeysProvider.js";
+import { select, splitSlot, subSlot, useAppHotkeysStore } from "./internal.js";
 import { getHotkeyManager, getKeyStateTracker, isAppHotkey, matchesHeldModifiers, resolveAppHotkey } from "@tanstack/hotkeys";
 
-//#region src/useHotkeyHint.ts
+// src/useHotkeyHint.ts
 function useHotkeyHint(hotkey, ...rest) {
 	const [args, slot] = splitSlot(rest);
 	const store = useAppHotkeysStore(useHotkeysContext()?.appHotkeysStore ?? null, subSlot(slot, "app-hotkeys"));
@@ -13,5 +13,4 @@ function useHotkeyHint(hotkey, ...rest) {
 	return active && held;
 }
 
-//#endregion
 export { useHotkeyHint };

package/dist/useHotkeyRecorder.d.ts

@@ -1,6 +1,5 @@
 import { OctaneHotkeyRecorder } from "./types.js";
 import { HotkeyChord, HotkeyChordRecorderOptions, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
-//#region src/useHotkeyRecorder.d.ts
 /**
  * Records a shortcut and destroys the recorder on unmount. With the default
  * `maxSteps: 1`, the first valid chord is recorded. With a larger `maxSteps`,
@@ -9,5 +8,4 @@ import { HotkeyChord, HotkeyChordRecorderOptions, HotkeySequenceRecorderOptions
  * `onRecord` receives a chord (one step) or a sequence.
  */
 export declare function useHotkeyRecorder(options: HotkeyChordRecorderOptions): OctaneHotkeyRecorder<HotkeyChord>;
-export declare function useHotkeyRecorder(options: HotkeySequenceRecorderOptions): OctaneHotkeyRecorder;
-//#endregion
+export declare function useHotkeyRecorder(options: HotkeySequenceRecorderOptions): OctaneHotkeyRecorder;

package/dist/useHotkeyRecorder.js

@@ -1,10 +1,10 @@
-import { select, subSlot } from "./internal.js";
 import { useDefaultHotkeysOptions } from "./HotkeysProvider.js";
+import { select, subSlot } from "./internal.js";
 import { HotkeyRecorder } from "@tanstack/hotkeys";
-import { useLayoutEffect, useRef } from "octane";
 import { withDefaults } from "@tanstack/hotkeys/adapter";
+import { useLayoutEffect, useRef } from "octane";
 
-//#region src/useHotkeyRecorder.ts
+// src/useHotkeyRecorder.ts
 function useHotkeyRecorder(options, slot) {
 	const defaults = useDefaultHotkeysOptions();
 	const merged = withDefaults(defaults.hotkeyRecorder, options);
@@ -29,5 +29,4 @@ function useHotkeyRecorder(options, slot) {
 	};
 }
 
-//#endregion
 export { useHotkeyRecorder };

package/dist/useHotkeyRegistrations.d.ts

@@ -1,5 +1,3 @@
 import { HotkeyRegistrationsResult } from "./types.js";
-//#region src/useHotkeyRegistrations.d.ts
 /** Reads public snapshots of every registration, chords and sequences. */
-export declare function useHotkeyRegistrations(): HotkeyRegistrationsResult;
-//#endregion
+export declare function useHotkeyRegistrations(): HotkeyRegistrationsResult;

package/dist/useHotkeyRegistrations.js

@@ -1,10 +1,9 @@
 import { select, subSlot } from "./internal.js";
 import { getHotkeyManager, toHotkeyRegistrationView } from "@tanstack/hotkeys";
 
-//#region src/useHotkeyRegistrations.ts
+// src/useHotkeyRegistrations.ts
 function useHotkeyRegistrations(slot) {
 	return { hotkeys: select(getHotkeyManager().registrations, (state) => Array.from(state.values()).map(toHotkeyRegistrationView), subSlot(slot, "hotkeys")) };
 }
 
-//#endregion
 export { useHotkeyRegistrations };

package/dist/useHotkeyScopesState.d.ts

@@ -1,8 +1,6 @@
 import { HotkeyScopesState } from "@tanstack/hotkeys";
-//#region src/useHotkeyScopesState.d.ts
 /**
  * Reads the hotkey manager's scope state: the active scopes, the exclusive
  * scope that owns the keyboard, and the scopes it allows or suspends.
  */
-export declare function useHotkeyScopesState(): HotkeyScopesState;
-//#endregion
+export declare function useHotkeyScopesState(): HotkeyScopesState;

package/dist/useHotkeyScopesState.js

@@ -1,10 +1,9 @@
 import { select, subSlot } from "./internal.js";
 import { getHotkeyManager } from "@tanstack/hotkeys";
 
-//#region src/useHotkeyScopesState.ts
+// src/useHotkeyScopesState.ts
 function useHotkeyScopesState(slot) {
 	return select(getHotkeyManager().scopes, (state) => state, subSlot(slot, "hotkey-scopes-state"));
 }
 
-//#endregion
 export { useHotkeyScopesState };

package/dist/useHotkeys.d.ts

@@ -1,6 +1,5 @@
 import { UseHotkeyCommonOptions, UseHotkeyTarget } from "./useHotkey.js";
 import { AdapterHotkeyDefinition } from "@tanstack/hotkeys/adapter";
-//#region src/useHotkeys.d.ts
 /**
  * One hotkey for `useHotkeys`. Chords accept `requireReset`; sequences accept
  * `timeout`; hotkeys of unknown kind accept only shared options.
@@ -12,5 +11,4 @@ export type UseHotkeyDefinition = AdapterHotkeyDefinition<UseHotkeyTarget>;
  * provider defaults, app hotkey declaration, common options, per-hotkey
  * options. Unbound app hotkeys and empty sequences register nothing.
  */
-export declare function useHotkeys(definitions: ReadonlyArray<UseHotkeyDefinition>, options?: UseHotkeyCommonOptions): void;
-//#endregion
+export declare function useHotkeys(definitions: ReadonlyArray<UseHotkeyDefinition>, options?: UseHotkeyCommonOptions): void;

package/dist/useHotkeys.js

@@ -1,9 +1,9 @@
-import { splitSlot, subSlot, useAppHotkeysStore } from "./internal.js";
 import { useHotkeysContext } from "./HotkeysProvider.js";
-import { useLayoutEffect, useRef } from "octane";
+import { splitSlot, subSlot, useAppHotkeysStore } from "./internal.js";
 import { createHotkeyBindings, prepareHotkeyDefinitions } from "@tanstack/hotkeys/adapter";
+import { useLayoutEffect, useRef } from "octane";
 
-//#region src/useHotkeys.ts
+// src/useHotkeys.ts
 function useHotkeys(definitions, ...rest) {
 	const [args, slot] = splitSlot(rest);
 	const context = useHotkeysContext();
@@ -23,5 +23,4 @@ function useHotkeys(definitions, ...rest) {
 	useLayoutEffect(() => () => bindings.destroy(), [], subSlot(slot, "cleanup"));
 }
 
-//#endregion
 export { useHotkeys };

package/dist/useKeyHold.d.ts

@@ -1,5 +1,3 @@
 import { IndividualKey } from "@tanstack/hotkeys";
-//#region src/useKeyHold.d.ts
 /** Reports whether a logical key is held. */
-export declare function useKeyHold(key: IndividualKey): boolean;
-//#endregion
+export declare function useKeyHold(key: IndividualKey): boolean;

package/dist/useKeyHold.js

@@ -1,10 +1,9 @@
 import { select, subSlot } from "./internal.js";
 import { getKeyStateTracker } from "@tanstack/hotkeys";
 
-//#region src/useKeyHold.ts
+// src/useKeyHold.ts
 function useKeyHold(key, slot) {
 	return select(getKeyStateTracker().store, (state) => state.heldKeys.includes(key), subSlot(slot, "key-hold"));
 }
 
-//#endregion
 export { useKeyHold };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/octane-hotkeys",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "description": "Octane adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -35,13 +35,13 @@
     "skills"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.24.0"
+    "@tanstack/hotkeys": "0.25.0"
   },
   "devDependencies": {
-    "@tsrx/oxc": "0.20.0",
-    "@tsrx/typescript-plugin": "^0.3.138",
-    "octane": "0.12.1",
-    "vite": "^8.3.2"
+    "@tsrx/oxc": "0.23.0",
+    "@tsrx/typescript-plugin": "^0.6.3",
+    "octane": "0.16.7",
+    "vite": "^8.3.6"
   },
   "peerDependencies": {
     "octane": ">=0.12.0"
@@ -55,9 +55,9 @@
   },
   "scripts": {
     "clean": "premove ./build ./dist",
-    "lint": "eslint ./src",
-    "lint:fix": "eslint ./src --fix",
-    "test:eslint": "eslint ./src",
+    "lint": "oxlint ./src",
+    "lint:fix": "oxlint ./src --fix",
+    "test:oxlint": "oxlint ./src",
     "test:lib": "vitest run && vitest run --config vitest.ssr.config.ts",
     "test:lib:dev": "vitest --watch",
     "test:types": "tsrx-tsc --noEmit",