@flighthq/input 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './inputManager';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './inputManager';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC"}

package/dist/inputManager.d.ts

@@ -0,0 +1,175 @@
+import type { AttachInputOptions, GamepadAxisKind, GamepadButtonKind, GamepadMappingKind, InputKeyRepeatOptions, InputKeyRepeatTimer, InputManager, InputPointerData, InputSignals, InputState, MouseWheelMode } from '@flighthq/types';
+/**
+ * Filters a single gamepad axis value through a simple dead zone.
+ * Values within `[-deadZone, deadZone]` are mapped to `0`; values outside
+ * are rescaled linearly to `[-1, 1]` so the live range is continuous.
+ * `deadZone` must be in `[0, 1)`.
+ */
+export declare function applyGamepadAxisDeadZone(value: number, deadZone: number): number;
+/**
+ * Filters a 2-D stick (left or right) through a **radial** dead zone.
+ * The magnitude of `(x, y)` is compared against `deadZone`; if within the
+ * dead zone the output is `(0, 0)`, otherwise the input direction is
+ * preserved and the magnitude is rescaled linearly to `[0, 1]`.
+ *
+ * Writes the filtered X and Y into `out.x` and `out.y`.
+ * Safe when `out` is the same object as the input (alias-safe).
+ *
+ * `deadZone` must be in `[0, 1)`.
+ */
+export declare function applyGamepadStickDeadZone(out: {
+    x: number;
+    y: number;
+}, x: number, y: number, deadZone: number): void;
+export declare function attachGamepadInput(manager: InputManager, target: Window, options?: Readonly<AttachInputOptions>): void;
+export declare function attachKeyboardInput(manager: InputManager, target: EventTarget, options?: Readonly<AttachInputOptions>): void;
+export declare function attachPointerInput(manager: InputManager, element: HTMLElement, options?: Readonly<AttachInputOptions>): void;
+export declare function attachRelativePointerInput(manager: InputManager, element: HTMLElement, options?: Readonly<AttachInputOptions>): void;
+export declare function attachTextInput(manager: InputManager, element: HTMLElement, options?: Readonly<AttachInputOptions>): void;
+export declare function attachWheelInput(manager: InputManager, element: HTMLElement, options?: Readonly<AttachInputOptions>): void;
+/**
+ * Subscribes `state` to all signals on `manager` to maintain a live held-state snapshot.
+ * Also tracks per-frame edge sets (`justPressedKeys`, `justReleasedKeys`,
+ * `justPressedGamepadButtons`, `justReleasedGamepadButtons`) that accumulate
+ * until `endInputStateFrame` is called.
+ * Returns a disposer that disconnects the subscriptions.
+ */
+export declare function connectInputStateToInputManager(state: InputState, manager: InputManager): () => void;
+/**
+ * Creates a key-repeat timer for non-DOM sources (gamepad d-pad buttons,
+ * virtual on-screen keys, native backends) that do not generate their own
+ * auto-repeat events.
+ *
+ * Call `start(callback)` when a "key" is pressed. The `callback` is invoked
+ * immediately on press, then again after `options.delay` ms, then every
+ * `options.interval` ms until `stop()` is called.
+ *
+ * Returns a handle with `start(callback)` and `stop()` methods.
+ * The handle may be reused across multiple press/release cycles.
+ *
+ * ```ts
+ * const timer = createInputKeyRepeatTimer({ delay: 500, interval: 33 });
+ * // on press:
+ * timer.start(() => emitSignal(manager.onKeyDown, dpadData));
+ * // on release:
+ * timer.stop();
+ * ```
+ */
+export declare function createInputKeyRepeatTimer(options: Readonly<InputKeyRepeatOptions>): InputKeyRepeatTimer;
+export declare function createInputManager(): InputManager;
+export declare function createInputSignals(): InputSignals;
+/**
+ * Creates a fresh `InputState` with empty held-state maps/sets and empty
+ * frame-edge sets. Connect it to an `InputManager` via
+ * `connectInputStateToInputManager`, and call `endInputStateFrame` once per
+ * logical frame to roll the edge sets.
+ */
+export declare function createInputState(): InputState;
+export declare function detachGamepadInput(manager: InputManager, target: Window): void;
+export declare function detachKeyboardInput(manager: InputManager, target: EventTarget): void;
+export declare function detachPointerInput(manager: InputManager, element: HTMLElement): void;
+export declare function detachRelativePointerInput(manager: InputManager, element: HTMLElement): void;
+export declare function detachTextInput(manager: InputManager, element: HTMLElement): void;
+export declare function detachWheelInput(manager: InputManager, element: HTMLElement): void;
+/**
+ * Rolls the per-frame edge sets on `state`, clearing `justPressedKeys`,
+ * `justReleasedKeys`, `justPressedGamepadButtons`, and
+ * `justReleasedGamepadButtons`. Call this once at the end of each logical
+ * frame (or input-poll cycle) to prepare the edge sets for the next frame.
+ */
+export declare function endInputStateFrame(state: InputState): void;
+/**
+ * Exits pointer lock, returning the pointer to normal movement.
+ * No-op if pointer lock is not currently active.
+ */
+export declare function exitInputPointerLock(): void;
+/**
+ * Returns coalesced pointer event data for a `pointermove` event, iterating
+ * over the high-frequency intermediate positions captured since the last
+ * delivered event. Falls back to a single entry with the event itself when
+ * `getCoalescedEvents` is unavailable (e.g. in jsdom).
+ *
+ * The callback receives each coalesced `InputPointerData` in order. The
+ * payload object is reused across calls — do not retain a reference to it.
+ */
+export declare function getCoalescedInputPointerEvents(event: PointerEvent, callback: (data: Readonly<InputPointerData>) => void): void;
+/**
+ * Returns the semantic name string (a `GamepadAxisKind`) for `index` in the
+ * standard gamepad mapping, or `null` if `mapping` is not `'standard'` or
+ * `index` is out of the standard range.
+ */
+export declare function getGamepadAxisName(mapping: GamepadMappingKind, index: number): GamepadAxisKind | null;
+/**
+ * Returns the semantic name string (a `GamepadButtonKind`) for `index` in the
+ * standard gamepad mapping, or `null` if `mapping` is not `'standard'` or
+ * `index` is out of the standard range.
+ */
+export declare function getGamepadButtonName(mapping: GamepadMappingKind, index: number): GamepadButtonKind | null;
+/**
+ * Returns the current value of a gamepad axis from `state`, or `0` if not recorded.
+ * `gamepad` is the gamepad index; `axis` is the axis index.
+ */
+export declare function getInputGamepadAxis(state: Readonly<InputState>, gamepad: number, axis: number): number;
+export declare function getKeyCodeFromDomKeyboardEvent(event: Readonly<KeyboardEvent>): number;
+export declare function getKeyModifierFromDomKeyboardEvent(event: Readonly<KeyboardEvent>): number;
+export declare function getMouseWheelModeFromDomWheelEvent(event: Readonly<WheelEvent>): MouseWheelMode;
+/**
+ * Returns `true` if pointer lock is currently active on any element.
+ */
+export declare function hasInputPointerLock(): boolean;
+/**
+ * Returns `true` if the given gamepad button is currently held.
+ * `gamepad` is the gamepad index; `button` is the button index.
+ */
+export declare function isInputGamepadButtonDown(state: Readonly<InputState>, gamepad: number, button: number): boolean;
+/**
+ * Returns `true` if the given `keyCode` (from `KeyCode`) is currently held.
+ */
+export declare function isInputKeyDown(state: Readonly<InputState>, keyCode: number): boolean;
+/**
+ * Returns `true` if the given pointer button is currently held for the given `pointerId`.
+ * `button` corresponds to `MouseEvent.button` (0 = primary, 1 = middle, 2 = secondary, …).
+ */
+export declare function isInputPointerButtonDown(state: Readonly<InputState>, pointerId: number, button: number): boolean;
+export declare function pollGamepadInput(manager: InputManager): void;
+/**
+ * Releases pointer capture for `pointerId` from `element`, allowing pointer
+ * events to fire on the element under the pointer again.
+ * No-op if `element` does not have capture for this pointer.
+ */
+export declare function releaseInputPointerCapture(element: HTMLElement, pointerId: number): void;
+/**
+ * Requests pointer lock on `element`. Returns a `Promise<boolean>` that
+ * resolves to `true` when lock is granted or `false` if the request is
+ * rejected (e.g. outside a user gesture, or the browser denies it).
+ */
+export declare function requestInputPointerLock(element: HTMLElement): Promise<boolean>;
+/**
+ * Explicitly captures all pointer events for `pointerId` to `element`,
+ * regardless of where the pointer moves. Useful for drag operations.
+ * Automatically released on `pointerup` or `pointercancel` per the spec.
+ */
+export declare function setInputPointerCapture(element: HTMLElement, pointerId: number): void;
+/**
+ * Returns `true` if the gamepad button at `gamepad`/`button` was pressed
+ * this frame (i.e. transitioned from up → down since the last
+ * `endInputStateFrame` call).
+ */
+export declare function wasInputGamepadButtonPressed(state: Readonly<InputState>, gamepad: number, button: number): boolean;
+/**
+ * Returns `true` if the gamepad button at `gamepad`/`button` was released
+ * this frame (i.e. transitioned from down → up since the last
+ * `endInputStateFrame` call).
+ */
+export declare function wasInputGamepadButtonReleased(state: Readonly<InputState>, gamepad: number, button: number): boolean;
+/**
+ * Returns `true` if the key with `keyCode` was pressed this frame (i.e.
+ * transitioned from up → down since the last `endInputStateFrame` call).
+ */
+export declare function wasInputKeyPressed(state: Readonly<InputState>, keyCode: number): boolean;
+/**
+ * Returns `true` if the key with `keyCode` was released this frame (i.e.
+ * transitioned from down → up since the last `endInputStateFrame` call).
+ */
+export declare function wasInputKeyReleased(state: Readonly<InputState>, keyCode: number): boolean;
+//# sourceMappingURL=inputManager.d.ts.map

package/dist/inputManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inputManager.d.ts","sourceRoot":"","sources":["../src/inputManager.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAKlB,qBAAqB,EACrB,mBAAmB,EACnB,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,UAAU,EAEV,cAAc,EACf,MAAM,iBAAiB,CAAC;AAczB;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAMhF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,EAAE;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAerH;AAED,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,YAAY,EACrB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GACrC,IAAI,CA8CN;AAED,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,YAAY,EACrB,MAAM,EAAE,WAAW,EACnB,OAAO,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GACrC,IAAI,CAwBN;AAED,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,WAAW,EACpB,OAAO,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GACrC,IAAI,CA4CN;AAED,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,WAAW,EACpB,OAAO,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GACrC,IAAI,CAYN;AAED,wBAAgB,eAAe,CAC7B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,WAAW,EACpB,OAAO,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GACrC,IAAI,CA2BN;AAED,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,WAAW,EACpB,OAAO,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GACrC,IAAI,CAYN;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,GAAG,MAAM,IAAI,CAyFpG;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,QAAQ,CAAC,qBAAqB,CAAC,GAAG,mBAAmB,CAqBvG;AAED,wBAAgB,kBAAkB,IAAI,YAAY,CAKjD;AAED,wBAAgB,kBAAkB,IAAI,YAAY,CAkBjD;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,IAAI,UAAU,CAW7C;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAE9E;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,GAAG,IAAI,CAEpF;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,GAAG,IAAI,CAEpF;AAED,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,GAAG,IAAI,CAE5F;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,GAAG,IAAI,CAEjF;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,GAAG,IAAI,CAElF;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,CAK1D;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAI3C;AAED;;;;;;;;GAQG;AACH,wBAAgB,8BAA8B,CAC5C,KAAK,EAAE,YAAY,EACnB,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,gBAAgB,CAAC,KAAK,IAAI,GACnD,IAAI,CAWN;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,EAAE,KAAK,EAAE,MAAM,GAAG,eAAe,GAAG,IAAI,CAGrG;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,kBAAkB,EAAE,KAAK,EAAE,MAAM,GAAG,iBAAiB,GAAG,IAAI,CAGzG;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAEtG;AAED,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,MAAM,CAKrF;AAED,wBAAgB,kCAAkC,CAAC,KAAK,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,MAAM,CAgBzF;AAED,wBAAgB,kCAAkC,CAAC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,cAAc,CAK9F;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,OAAO,CAE7C;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAE9G;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEpF;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhH;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,CAuC5D;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAMxF;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAa9E;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAEpF;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAElH;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnH;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAExF;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEzF"}