@hopple/sdk 1.0.0-next.5 → 1.0.0-next.9

package/index.d.ts

@@ -1,4 +1,4 @@
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/protocol/src/analytics.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/protocol/src/analytics.d.ts
 /**
  * What a game says happened.
  *
@@ -29,7 +29,7 @@ type AnalyticsValue = string | number | boolean;
 /** @group Analytics */
 type AnalyticsProps = Record<string, AnalyticsValue>;
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/protocol/src/errors.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/protocol/src/errors.d.ts
 /**
  * How a call fails.
  *
@@ -115,7 +115,7 @@ declare class BridgeError extends Error {
   constructor(error: ProtocolError);
 }
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/protocol/src/input.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/protocol/src/input.d.ts
 /**
  * What the host says about how this game is being played.
  *
@@ -175,7 +175,7 @@ type InputBinding = {
   label?: string;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/protocol/src/pause.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/protocol/src/pause.d.ts
 /**
  * Whether the game is holding still, which the host may ask for and only the
  * game can answer.
@@ -233,7 +233,7 @@ type PauseState =
  */
 'unpausable';
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/protocol/src/save.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/protocol/src/save.d.ts
 /**
  * The one thing a game may keep.
  *
@@ -285,7 +285,7 @@ type SaveStored = {
   bytes: number;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/protocol/src/score.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/protocol/src/score.d.ts
 /**
  * What the host says came of it.
  *
@@ -323,7 +323,7 @@ type ScoreStanding = {
   of?: number;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/protocol/src/share.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/protocol/src/share.d.ts
 /**
  * A link to this game, offered to the player by the host.
  *
@@ -423,7 +423,7 @@ type ShareMeta = {
   [key: string]: ShareMetaValue;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/protocol/src/methods.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/protocol/src/methods.d.ts
 /**
  * How far a game has got with its own preparation.
  *
@@ -603,7 +603,7 @@ type DeviceInfo = {
   tier: DeviceTier;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/protocol/src/listeners.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/protocol/src/listeners.d.ts
 /**
  * The one way anything here is listened to: `on(listener)` hands back the
  * function that stops it.
@@ -632,7 +632,7 @@ type DeviceInfo = {
  */
 type Unsubscribe = () => void;
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/manifest/src/manifest.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/manifest/src/manifest.d.ts
 /**
  * The API a game is written against: `M.m`, a major and the least minor it
  * needs, or `next`, the pre-releases of the next stable release.
@@ -1121,7 +1121,7 @@ type InputDeviceSet = InputDevice[];
  * doubled. A thumbstick is not one of these; see `InputStick`.
  *
  * @group Input
- * @pattern ^(?:key\.(?!Escape$)(?=.{1,48}$)[A-Za-z][A-Za-z0-9]*|pointer\.(?:primary|secondary)|mouse\.(?:left|middle|right)|touch\.tap|controls\.(?=.{1,48}$)[a-z0-9]+(?:[_-][a-z0-9]+)*|pad\.(?:north|south|east|west|start|select)|pad\.(?:left|right)\.(?:north|south|east|west|bumper|trigger))$
+ * @pattern ^(?:key\.(?!Escape$)(?=.{1,48}$)[A-Za-z][A-Za-z0-9]*|pointer\.(?:primary|secondary)|mouse\.(?:left|middle|right|wheelup|wheeldown)|touch\.tap|controls\.(?=.{1,48}$)[a-z0-9]+(?:[_-][a-z0-9]+)*|pad\.(?:north|south|east|west|start|select)|pad\.(?:left|right)\.(?:north|south|east|west|bumper|trigger))$
  * @errorMessage is not a binding this SDK knows (a thumbstick is read rather than bound, and Escape is the host's key)
  */
 type InputBinding$1 = string;
@@ -1197,7 +1197,7 @@ type PlayerBinding = string;
  * mouse button.
  *
  * @group Input
- * @pattern ^(?:key\.(?!Escape$)(?=.{1,48}$)[A-Za-z][A-Za-z0-9]*|mouse\.(?:left|middle|right))$
+ * @pattern ^(?:key\.(?!Escape$)(?=.{1,48}$)[A-Za-z][A-Za-z0-9]*|mouse\.(?:left|middle|right|wheelup|wheeldown))$
  * @errorMessage must be a key or a mouse button (and Escape is the host's key)
  */
 type KeyboardBinding = string;
@@ -1705,7 +1705,7 @@ type ProjectManifest = Omit<GameManifest, 'api'> & {
   api?: ApiVersion;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/achievements.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/achievements.d.ts
 /**
  * Where this player stands on one achievement.
  *
@@ -1803,7 +1803,7 @@ type Achievements<Id extends string = string, Measured extends string = Id> = {
   progress(id: Measured, value: number): void;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/analytics.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/analytics.d.ts
 /**
  * @group Analytics
  * @category Important
@@ -1820,7 +1820,7 @@ type Analytics<Events extends object = Record<string, AnalyticsProps>> = {
   track<Event extends keyof Events & string>(name: Event, props?: Events[Event]): void;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/audio.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/audio.d.ts
 /**
  * Something about the game's sound changed: the host's order, the player's
  * mute, a fader. Read what you need — `volume(channel)`, `allowed` — and apply
@@ -1911,7 +1911,7 @@ type Audio<Channel extends string = string> = {
   media(element: HTMLMediaElement, channel?: Channel): Unsubscribe;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/info.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/info.d.ts
 /**
  * What the host said, frozen.
  *
@@ -1929,7 +1929,7 @@ type Info = Readonly<{
   device: Readonly<DeviceInfo>;
 }>;
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/layout.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/layout.d.ts
 /**
  * How much of each edge belongs to the host. CSS pixels.
  *
@@ -2039,7 +2039,7 @@ type InsetPolicy = {
  */
 declare function insetsFrom(obstructions: readonly Obstruction[], frame: Size, policy?: InsetPolicy): Insets;
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/names.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/names.d.ts
 /**
  * The keys of a declared map, or `string` where the map is not a literal one —
  * which is what a manifest typed as the wide `GameManifest` gives — and
@@ -2159,7 +2159,7 @@ type EventProps<M> = M extends {
  */
 type StickName = 'pad.left.stick' | 'pad.right.stick' | 'pad.stick' | `controls.${string}`;
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/input/state.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/input/state.d.ts
 /**
  * Where the pointer is, in the frame's own coordinates.
  *
@@ -2220,7 +2220,7 @@ type InputSnapshot<Action extends string = string> = {
   pointer: PointerState | null;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/input/players.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/input/players.d.ts
 /**
  * What one player holds: a pad, one part of the keyboard, or the on-screen
  * controls.
@@ -2242,7 +2242,178 @@ type Controller =
   kind: 'touch';
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/input/index.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/input/gestures.d.ts
+/**
+ * Dragging, pinching and wheeling a view around, and tapping on it: what a map,
+ * a board or a level editor does with a pointer, done once.
+ *
+ * Every game that wrote this itself got some of it wrong, in the same few
+ * ways: a cancelled touch that counted as a tap, a third finger that made the
+ * view jump, a drag that stuck when the mouse was let go outside the frame, a
+ * trackpad that zoomed six times slower than a wheel, a wheel that barely
+ * moved in Firefox. So a game says what a drag, a pinch and a tap do to it,
+ * and the SDK decides which one the player is making.
+ */
+/**
+ * A mouse button, by where it is.
+ *
+ * @group Input
+ */
+type GestureButton = 'left' | 'middle' | 'right';
+/**
+ * What a game does with each gesture. Every coordinate is in CSS pixels from
+ * the element's top left corner.
+ *
+ * @group Input
+ */
+type GestureHandlers = {
+  /** Something dragged the view by this much: a finger, two, a mouse button, or a trackpad's two-finger scroll. */
+  pan?(dx: number, dy: number): void;
+  /**
+   * Something zoomed it by this factor, keeping the point at `x`, `y` where it
+   * is: a pinch, a mouse wheel, or a trackpad pinch. Above 1 is closer.
+   */
+  zoom?(factor: number, x: number, y: number): void;
+  /**
+   * A press that let go where it started, and was the only one: never a drag,
+   * never part of a pinch, never cancelled by the browser.
+   */
+  tap?(x: number, y: number, button: GestureButton | 'touch'): void;
+};
+/**
+ * @group Input
+ */
+type GestureOptions = GestureHandlers & {
+  /**
+   * A view to move: its `pan` and `zoom` are the handlers, beside a `tap` of
+   * the game's own.
+   */
+  view?: View;
+  /**
+   * Which mouse buttons drag. A finger always does. `['left', 'middle']` when
+   * left out; the right button is a game's to bind.
+   */
+  drag?: readonly GestureButton[];
+  /**
+   * What a mouse wheel and a trackpad's two-finger scroll do. `'zoom'`, the
+   * default, zooms with a wheel and pans with a trackpad, the way maps do;
+   * `'pan'` pans with both; `'none'` leaves both alone, for a game that binds
+   * `mouse.wheelup`. A pinch on a trackpad zooms whatever this says.
+   */
+  wheel?: 'zoom' | 'pan' | 'none';
+  /** How far a press may move, in CSS pixels, before it is a drag rather than a tap. 8 when left out. */
+  slop?: number;
+};
+/**
+ * Gestures being read off an element: `input.gestures`.
+ *
+ * @group Input
+ */
+type Gestures = {
+  /** Whether a finger or a dragging button is down on the element now. */
+  readonly active: boolean;
+  /** Stop reading them, and give the element back its `touch-action`. */
+  dispose(): void;
+};
+/**
+ * A camera over a flat world, moved by gestures: `input.view`.
+ *
+ * The world is in a game's own units, with `y` down; `scale` is CSS pixels to
+ * one of them, and `x`, `y` the world point at the element's top left corner.
+ * A game draws with them, `screen = (world - x) * scale`, and may set any of
+ * them; each gesture keeps them inside `min`, `max` and `bounds`.
+ *
+ * @group Input
+ */
+type View = {
+  x: number;
+  y: number;
+  scale: number;
+  /** Drag the view by this many CSS pixels, the world following the finger. */
+  pan(dx: number, dy: number): void;
+  /** Zoom by this factor, the world point at `x`, `y` staying where it is. */
+  zoom(factor: number, x: number, y: number): void;
+  /** Put the world point `x`, `y` in the middle of the element, at `scale` if given. */
+  look(x: number, y: number, scale?: number): void;
+  /** The world point at a point on the element. */
+  toWorld(x: number, y: number): {
+    x: number;
+    y: number;
+  };
+  /** The point on the element a world point is drawn at. */
+  toScreen(x: number, y: number): {
+    x: number;
+    y: number;
+  };
+  /**
+   * Say how big the element is, in CSS pixels: what `look` centres on and
+   * `bounds` keeps filled. Call it whenever the element changes size.
+   */
+  resize(width: number, height: number): void;
+};
+/**
+ * @group Input
+ */
+type ViewOptions = {
+  x?: number;
+  y?: number;
+  scale?: number;
+  /** The least `scale` a gesture zooms out to. */
+  min?: number;
+  /** The most `scale` a gesture zooms in to. */
+  max?: number;
+  /**
+   * The part of the world the view stays over, in world units: never scrolled
+   * past an edge, and centred on it once all of it fits.
+   */
+  bounds?: {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+  };
+  /** The element's size in CSS pixels, as `resize` takes it. */
+  width?: number;
+  height?: number;
+};
+//#endregion
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/input/lock.d.ts
+/**
+ * The mouse held to the game: `input.pointerLock`.
+ *
+ * @group Input
+ */
+type PointerLock = {
+  /** Whether the mouse is locked to the game now. */
+  readonly locked: boolean;
+  /**
+   * Lock the mouse to an element, the whole page when left out, now if the
+   * browser allows it and on the player's next click or key if not.
+   *
+   * Asked again after the player has just left a lock, the browser makes them
+   * wait about a second; the SDK waits with them. Ask from a press of the
+   * player's where you can, a click on the game or the key that resumes it:
+   * from a frame loop, the browser may not take it until they press something.
+   */
+  request(element?: Element): void;
+  /** Let the mouse go, and stop waiting to take it. */
+  release(): void;
+  /**
+   * Run this when the lock is taken or lost. Lost without `release` is the
+   * player leaving it, with Escape or by switching away: the time to pause.
+   * The SDK does not take it back on its own; `request` again on resuming.
+   */
+  on(listener: (locked: boolean) => void): Unsubscribe;
+  /**
+   * Run this for each move of the mouse while it is locked, in CSS pixels,
+   * or in the mouse's own counts where the browser gives those
+   * (`unadjustedMovement`). The jumps a browser sends as a lock starts are
+   * left out.
+   */
+  onMove(listener: (dx: number, dy: number) => void): Unsubscribe;
+};
+//#endregion
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/input/index.d.ts
 /**
  * A binding a game can name on its own, for a prompt about a button that is
  * not one of its actions: `pad.start`, `key.Space`.
@@ -2379,6 +2550,28 @@ type Input<Action extends string = string, Layout extends string = string, Playe
   suspend(): void;
   resume(): void;
   readonly suspended: boolean;
+  /**
+   * Read drags, pinches, wheels and taps off an element, and say what each
+   * did: for a map, a board, a level editor.
+   *
+   *     const view = hopple.input.view({ min: 0.5, max: 4, bounds: world });
+   *     hopple.input.gestures(canvas, { view, tap: (x, y) => select(view.toWorld(x, y)) });
+   *
+   * One finger or a mouse button drags; two fingers pinch, and pan as they
+   * go; a mouse wheel zooms around the pointer and a trackpad scrolls and
+   * pinches, at one speed in every browser. A tap is a press that let go where
+   * it started and was the only one. The element gets `touch-action: none`
+   * until `dispose`.
+   */
+  gestures(element: Element, options: GestureOptions): Gestures;
+  /**
+   * A camera over a flat world that `gestures` moves, kept between `min` and
+   * `max` and over `bounds`. Nothing in it is drawn: a game reads `x`, `y`
+   * and `scale` when it draws.
+   */
+  view(options?: ViewOptions): View;
+  /** The mouse held to the game, for a game that turns a camera with it. */
+  readonly pointerLock: PointerLock;
   /**
    * The players on this device, each with their own copy of the actions
    * `input.player` declares, by `slot`. Empty for a game that declares none;
@@ -2479,7 +2672,7 @@ type Controls<Layout extends string = string> = {
   readonly available: boolean;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/lifecycle.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/lifecycle.d.ts
 /** @group Lifecycle */
 type LifecycleListener = (phase: Phase, previous: Phase) => void | Promise<void>;
 /**
@@ -2498,7 +2691,7 @@ type Lifecycle = {
   on(listener: LifecycleListener): Unsubscribe;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/loop.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/loop.d.ts
 /**
  * The host has let the game run its loop, or stopped it. Return a promise to
  * make the host wait.
@@ -2552,7 +2745,7 @@ type Loop = {
   tick(frame: FrameCallback): Unsubscribe;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/panel.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/panel.d.ts
 /**
  * The pages of the host's panel a game has a name for, as the keys of this
  * interface.
@@ -2690,7 +2883,7 @@ type Panel = {
   open(page: PageId): void;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/pause.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/pause.d.ts
 /**
  * The host has asked for a pause, or for the game to carry on.
  *
@@ -2751,7 +2944,7 @@ type Pause = {
   on(listener: PauseListener): Unsubscribe;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/resources.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/resources.d.ts
 /**
  * The host has let the game hold its resources again, or asked for them back.
  * Return a promise to make the host wait until they have gone, or come back.
@@ -2781,7 +2974,7 @@ type Resources = {
   on(listener: ResourcesListener): Unsubscribe;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/save.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/save.d.ts
 /**
  * What a game gets back from a read: its own schema number, and its state.
  *
@@ -2956,7 +3149,7 @@ type Save = {
   readonly maxBytes: number;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/score.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/score.d.ts
 /**
  * Where this player stands on every board, as far as anybody has said.
  *
@@ -3033,7 +3226,7 @@ type Score<Board extends string = string> = {
   }): Promise<ScoreResult>;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/share.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/share.d.ts
 /**
  * @group Share
  * @category Important
@@ -3117,7 +3310,7 @@ type Share = {
   }): void;
 };
 //#endregion
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/game/src/init.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/game/src/init.d.ts
 /**
  * What `init` hands back: every namespace a game has, on one object.
  *
@@ -3413,4 +3606,4 @@ type InitOptions = {
  */
 declare function init<M extends object = GameManifest>(options?: InitOptions): Promise<GameSdk<M>>;
 //#endregion
-export { type Achievement, type AchievementDeclaration, type AchievementListener, type AchievementName, type AchievementProgress, type AchievementStanding, type AchievementStatus, type AchievementTier, type Achievements, type ActionListener, type ActionName, type Analytics, type AnalyticsDeclaration, type AnalyticsProps, type AnalyticsShape, type AnalyticsType, type AnalyticsValue, type ApiVersion, type AppInfo, type AppSurface, type Audio, type AudioChannel, type AudioDeclaration, type AudioListener, type BoardName, BridgeError, type ButtonName, type ChannelName, type ControlLayout, type ControlShape, type ControlSlot, type ControlZone, type Controller, type Controls, type DeclaredNames, type DeclaredValue, type DeviceInfo, type DeviceTier, type ErrorCode, type ErrorCodes, type EventName, type EventProps, type FrameCallback, type GameInfo, type GameManifest, type GameSdk, type Info, type InitOptions, type Input, type InputAction, type InputBinding, type InputDeclaration, type InputDevice, type InputListener, type InputScheme, type InputSnapshot, type InputState, type InsetMode, type InsetPolicy, type Insets, type Layout, type LayoutDeclaration, type LayoutListener, type LayoutName, type LayoutState, type Lifecycle, type LifecycleListener, type Loop, type LoopListener, MAX_STEP, type MeasuredName, type Obstruction, type ObstructionKind, type Orientation, type PageId, type Panel, type PanelListener, type PanelPages, type PanelState, type Pause, type PauseListener, type PauseState, type Phase, type Player, type PlayerActionName, type PlayerInfo, type PointerListener, type PointerState, type ProjectManifest, type Rect, type Resources, type ResourcesListener, SAVE_BYTES, SHARE_BYTES, SHARE_META_BYTES, type Save, type SaveChangeListener, type SaveChangeReason, type SaveDeclaration, type SaveListener, type SaveMerger, type SaveSetup, type SaveState, type SaveStatus, type SaveStored, type Score, type ScoreBoard, type ScoreDeclaration, type ScoreDirection, type ScoreFormat, type ScoreListener, type ScoreResult, type ScoreStanding, type ScoreStandings, type Share, type ShareMeta, type ShareMetaValue, type Size, type StickListener, type StickName, type StickState, type Unsubscribe, init, insetsFrom };
+export { type Achievement, type AchievementDeclaration, type AchievementListener, type AchievementName, type AchievementProgress, type AchievementStanding, type AchievementStatus, type AchievementTier, type Achievements, type ActionListener, type ActionName, type Analytics, type AnalyticsDeclaration, type AnalyticsProps, type AnalyticsShape, type AnalyticsType, type AnalyticsValue, type ApiVersion, type AppInfo, type AppSurface, type Audio, type AudioChannel, type AudioDeclaration, type AudioListener, type BoardName, BridgeError, type ButtonName, type ChannelName, type ControlLayout, type ControlShape, type ControlSlot, type ControlZone, type Controller, type Controls, type DeclaredNames, type DeclaredValue, type DeviceInfo, type DeviceTier, type ErrorCode, type ErrorCodes, type EventName, type EventProps, type FrameCallback, type GameInfo, type GameManifest, type GameSdk, type GestureButton, type GestureHandlers, type GestureOptions, type Gestures, type Info, type InitOptions, type Input, type InputAction, type InputBinding, type InputDeclaration, type InputDevice, type InputListener, type InputScheme, type InputSnapshot, type InputState, type InsetMode, type InsetPolicy, type Insets, type Layout, type LayoutDeclaration, type LayoutListener, type LayoutName, type LayoutState, type Lifecycle, type LifecycleListener, type Loop, type LoopListener, MAX_STEP, type MeasuredName, type Obstruction, type ObstructionKind, type Orientation, type PageId, type Panel, type PanelListener, type PanelPages, type PanelState, type Pause, type PauseListener, type PauseState, type Phase, type Player, type PlayerActionName, type PlayerInfo, type PointerListener, type PointerLock, type PointerState, type ProjectManifest, type Rect, type Resources, type ResourcesListener, SAVE_BYTES, SHARE_BYTES, SHARE_META_BYTES, type Save, type SaveChangeListener, type SaveChangeReason, type SaveDeclaration, type SaveListener, type SaveMerger, type SaveSetup, type SaveState, type SaveStatus, type SaveStored, type Score, type ScoreBoard, type ScoreDeclaration, type ScoreDirection, type ScoreFormat, type ScoreListener, type ScoreResult, type ScoreStanding, type ScoreStandings, type Share, type ShareMeta, type ShareMetaValue, type Size, type StickListener, type StickName, type StickState, type Unsubscribe, type View, type ViewOptions, init, insetsFrom };

package/index.js

@@ -1,4 +1,4 @@
-/*! @hopple/sdk 1.0.0-next.5 | Copyright (c) 2026 The Hopple authors | MIT License */
+/*! @hopple/sdk | Copyright (c) 2026 The Hopple authors | MIT License */
 // The SDK runs from the runtime the page loads as its first script, which
 // defines the global `Hopple`; this forwards each export to it.
 const runtime = globalThis.Hopple;

package/manifest.d.ts

@@ -1,4 +1,4 @@
-//#region ../../../../../../../tmp/hopple-sdk-types-ky983p/manifest/src/manifest.d.ts
+//#region ../../../../../../../tmp/hopple-sdk-types-BSfTrJ/manifest/src/manifest.d.ts
 /**
  * The API a game is written against: `M.m`, a major and the least minor it
  * needs, or `next`, the pre-releases of the next stable release.
@@ -487,7 +487,7 @@ type InputDeviceSet = InputDevice[];
  * doubled. A thumbstick is not one of these; see `InputStick`.
  *
  * @group Input
- * @pattern ^(?:key\.(?!Escape$)(?=.{1,48}$)[A-Za-z][A-Za-z0-9]*|pointer\.(?:primary|secondary)|mouse\.(?:left|middle|right)|touch\.tap|controls\.(?=.{1,48}$)[a-z0-9]+(?:[_-][a-z0-9]+)*|pad\.(?:north|south|east|west|start|select)|pad\.(?:left|right)\.(?:north|south|east|west|bumper|trigger))$
+ * @pattern ^(?:key\.(?!Escape$)(?=.{1,48}$)[A-Za-z][A-Za-z0-9]*|pointer\.(?:primary|secondary)|mouse\.(?:left|middle|right|wheelup|wheeldown)|touch\.tap|controls\.(?=.{1,48}$)[a-z0-9]+(?:[_-][a-z0-9]+)*|pad\.(?:north|south|east|west|start|select)|pad\.(?:left|right)\.(?:north|south|east|west|bumper|trigger))$
  * @errorMessage is not a binding this SDK knows (a thumbstick is read rather than bound, and Escape is the host's key)
  */
 type InputBinding = string;
@@ -563,7 +563,7 @@ type PlayerBinding = string;
  * mouse button.
  *
  * @group Input
- * @pattern ^(?:key\.(?!Escape$)(?=.{1,48}$)[A-Za-z][A-Za-z0-9]*|mouse\.(?:left|middle|right))$
+ * @pattern ^(?:key\.(?!Escape$)(?=.{1,48}$)[A-Za-z][A-Za-z0-9]*|mouse\.(?:left|middle|right|wheelup|wheeldown))$
  * @errorMessage must be a key or a mouse button (and Escape is the host's key)
  */
 type KeyboardBinding = string;

package/manifest.js

@@ -1,4 +1,4 @@
-/*! @hopple/sdk 1.0.0-next.5 | Copyright (c) 2026 The Hopple authors | MIT License */
+/*! @hopple/sdk 1.0.0-next.9 | Copyright (c) 2026 The Hopple authors | MIT License */
 //#region ../manifest/src/manifest.schema.ts
 const GameManifest = {
 	"type": "object",
@@ -375,7 +375,7 @@ const InputBindings = {
 };
 const InputBinding = {
 	"type": "string",
-	"pattern": "^(?:key\\.(?!Escape$)(?=.{1,48}$)[A-Za-z][A-Za-z0-9]*|pointer\\.(?:primary|secondary)|mouse\\.(?:left|middle|right)|touch\\.tap|controls\\.(?=.{1,48}$)[a-z0-9]+(?:[_-][a-z0-9]+)*|pad\\.(?:north|south|east|west|start|select)|pad\\.(?:left|right)\\.(?:north|south|east|west|bumper|trigger))$",
+	"pattern": "^(?:key\\.(?!Escape$)(?=.{1,48}$)[A-Za-z][A-Za-z0-9]*|pointer\\.(?:primary|secondary)|mouse\\.(?:left|middle|right|wheelup|wheeldown)|touch\\.tap|controls\\.(?=.{1,48}$)[a-z0-9]+(?:[_-][a-z0-9]+)*|pad\\.(?:north|south|east|west|start|select)|pad\\.(?:left|right)\\.(?:north|south|east|west|bumper|trigger))$",
 	"errorMessage": "is not a binding this SDK knows (a thumbstick is read rather than bound, and Escape is the host's key)"
 };
 const ControlLayout = {
@@ -572,7 +572,7 @@ const definitions = {
 	},
 	KeyboardBinding: {
 		"type": "string",
-		"pattern": "^(?:key\\.(?!Escape$)(?=.{1,48}$)[A-Za-z][A-Za-z0-9]*|mouse\\.(?:left|middle|right))$",
+		"pattern": "^(?:key\\.(?!Escape$)(?=.{1,48}$)[A-Za-z][A-Za-z0-9]*|mouse\\.(?:left|middle|right|wheelup|wheeldown))$",
 		"errorMessage": "must be a key or a mouse button (and Escape is the host's key)"
 	},
 	PlayersDeclaration: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hopple/sdk",
-  "version": "1.0.0-next.5",
+  "version": "1.0.0-next.9",
   "description": "The Hopple SDK: what a game imports to talk to the host that runs it, forwarded to the runtime its page loads.",
   "license": "MIT",
   "homepage": "https://hopple.app",