@kelnishi/satmouse-client 0.10.8 → 0.12.0

package/dist/react/index.d.ts

@@ -16,10 +16,12 @@ interface Vec3 {
     y: number;
     z: number;
 }
-/** 6DOF spatial input frame — matches spatial-data.schema.json */
+/** 6DOF+W spatial input frame */
 interface SpatialData {
     translation: Vec3;
     rotation: Vec3;
+    /** Virtual W axis — application-defined (e.g., zoom, scroll, tool size) */
+    w?: number;
     timestamp: number;
     /** Source device ID (e.g., "cnx-c635", "hid-054c-5c4") */
     deviceId?: string;
@@ -46,6 +48,8 @@ interface DeviceInfo$1 {
     axisLabels?: string[];
     /** Number of buttons this device provides */
     buttonCount?: number;
+    /** Human-readable labels for buttons (indexed by targetButton) */
+    buttonLabels?: string[];
 }
 type ConnectionState = "disconnected" | "connecting" | "connected" | "failed";
 type TransportProtocol = "webtransport" | "websocket" | "none";
@@ -111,7 +115,7 @@ declare class SatMouseConnection extends TypedEmitter<SatMouseEvents> {
 }
 
 /** Axis identifier — full or half */
-type InputAxis = "tx" | "ty" | "tz" | "rx" | "ry" | "rz" | "tx+" | "ty+" | "tz+" | "rx+" | "ry+" | "rz+" | "tx-" | "ty-" | "tz-" | "rx-" | "ry-" | "rz-";
+type InputAxis = "tx" | "ty" | "tz" | "rx" | "ry" | "rz" | "w" | "tx+" | "ty+" | "tz+" | "rx+" | "ry+" | "rz+" | "w+" | "tx-" | "ty-" | "tz-" | "rx-" | "ry-" | "rz-" | "w-";
 /** A single axis route — reads from source, writes to target */
 interface AxisRoute {
     source: InputAxis;
@@ -120,12 +124,27 @@ interface AxisRoute {
     flip?: boolean;
 }
 
+/** Maps a device button to a keyboard key */
+interface ButtonRoute {
+    /** Device button index */
+    button: number;
+    /** Keyboard key value (KeyboardEvent.key, e.g., "a", "Shift", "ArrowUp") */
+    key: string;
+    /** Keyboard code (KeyboardEvent.code, e.g., "KeyA", "ShiftLeft"). Optional. */
+    code?: string;
+}
 /** Per-device configuration */
 interface DeviceConfig {
     /** Axis routing — each entry maps a device input to an output with optional flip */
     routes?: AxisRoute[];
-    /** Scale multiplier applied to all axes (default: 1) */
-    scale?: number;
+    /** Button-to-key mappings */
+    buttonRoutes?: ButtonRoute[];
+    /** Scale multiplier for translation axes (tx, ty, tz) */
+    translateScale?: number;
+    /** Scale multiplier for rotation axes (rx, ry, rz) */
+    rotateScale?: number;
+    /** Scale multiplier for W axis */
+    wScale?: number;
     /** Dead zone threshold (0-1). Values below this are zeroed. */
     deadZone?: number;
     /** Only pass the strongest axis, zero all others */
@@ -135,8 +154,14 @@ interface DeviceConfig {
 interface InputConfig {
     /** Default axis routes (used when device has no override) */
     routes: AxisRoute[];
-    /** Default scale */
-    scale: number;
+    /** Default button-to-key mappings */
+    buttonRoutes: ButtonRoute[];
+    /** Scale multiplier for translation axes */
+    translateScale: number;
+    /** Scale multiplier for rotation axes */
+    rotateScale: number;
+    /** Scale multiplier for W axis */
+    wScale: number;
     /** Dead zone threshold */
     deadZone: number;
     /** Dominant axis mode */
@@ -201,6 +226,10 @@ declare class InputManager extends TypedEmitter<InputManagerEvents> {
     private processPerDevice;
     /** Get the effective routes for a device: device config override > device axes metadata > global default */
     private resolveRoutes;
+    /** Dispatch KeyboardEvents for button routes matching this button event */
+    private dispatchButtonKeys;
+    /** Gather all button routes from global config + all device configs */
+    private collectButtonRoutes;
 }
 
 interface SatMouseContextValue {

package/dist/react/index.js

@@ -472,35 +472,45 @@ function readAxis(data, axis) {
       return data.rotation.y;
     case "rz":
       return data.rotation.z;
+    case "w":
+      return data.w ?? 0;
     default:
       return 0;
   }
 }
-function writeAxis(t, r, axis, value) {
+function writeAxis(acc, axis, value) {
   const isNeg = axis.endsWith("-");
   const base = axis.replace(/[+-]$/, "");
   const sign = isNeg ? -1 : 1;
+  if (base === "w") {
+    acc.w += value * sign;
+    return;
+  }
   const group = base[0];
   const key = base[1];
-  if (group === "t") t[key] += value * sign;
-  else r[key] += value * sign;
+  if (group === "t") acc.t[key] += value * sign;
+  else acc.r[key] += value * sign;
 }
-function applyRoutes(data, routes, scale = 1) {
-  const t = { x: 0, y: 0, z: 0 };
-  const r = { x: 0, y: 0, z: 0 };
+function applyRoutes(data, routes, translateScale = 1, rotateScale = 1, wScale = 1) {
+  const acc = { t: { x: 0, y: 0, z: 0 }, r: { x: 0, y: 0, z: 0 }, w: 0 };
   for (const route of routes) {
     let value = readAxis(data, route.source);
     if (route.flip) value = -value;
+    const targetBase = route.target.replace(/[+-]$/, "");
+    const scale = targetBase === "w" ? wScale : targetBase[0] === "t" ? translateScale : rotateScale;
     value *= scale;
-    writeAxis(t, r, route.target, value);
+    writeAxis(acc, route.target, value);
   }
-  return { translation: t, rotation: r, timestamp: data.timestamp, deviceId: data.deviceId };
+  return { translation: acc.t, rotation: acc.r, w: acc.w || void 0, timestamp: data.timestamp, deviceId: data.deviceId };
 }
 
 // src/utils/config.ts
 var DEFAULT_CONFIG = {
   routes: DEFAULT_ROUTES,
-  scale: 1e-3,
+  buttonRoutes: [],
+  translateScale: 1e-3,
+  rotateScale: 1e-3,
+  wScale: 1e-3,
   deadZone: 0,
   dominant: false,
   lockPosition: false,
@@ -534,6 +544,7 @@ function mergeConfig(base, partial) {
     ...base,
     ...partial,
     routes: partial.routes ?? [...base.routes],
+    buttonRoutes: partial.buttonRoutes ?? [...base.buttonRoutes],
     devices: { ...base.devices }
   };
   if (partial.devices) {
@@ -559,7 +570,10 @@ function resolveDeviceConfig(config, deviceId) {
   return {
     ...config,
     routes: deviceOverride.routes ?? config.routes,
-    scale: deviceOverride.scale ?? config.scale,
+    buttonRoutes: deviceOverride.buttonRoutes ?? config.buttonRoutes,
+    translateScale: deviceOverride.translateScale ?? config.translateScale,
+    rotateScale: deviceOverride.rotateScale ?? config.rotateScale,
+    wScale: deviceOverride.wScale ?? config.wScale,
     deadZone: deviceOverride.deadZone ?? config.deadZone,
     dominant: deviceOverride.dominant ?? config.dominant
   };
@@ -663,7 +677,10 @@ var InputManager = class extends TypedEmitter {
     const resolved = resolveDeviceConfig(this._config, deviceId);
     return {
       routes: resolved.routes,
-      scale: resolved.scale,
+      buttonRoutes: resolved.buttonRoutes,
+      translateScale: resolved.translateScale,
+      rotateScale: resolved.rotateScale,
+      wScale: resolved.wScale,
       deadZone: resolved.deadZone,
       dominant: resolved.dominant
     };
@@ -711,11 +728,15 @@ var InputManager = class extends TypedEmitter {
         tz: processed.translation.z,
         rx: processed.rotation.x,
         ry: processed.rotation.y,
-        rz: processed.rotation.z
+        rz: processed.rotation.z,
+        w: processed.w ?? 0
       });
       this.accDirty = true;
     });
-    connection.on("buttonEvent", (event) => this.emit("buttonEvent", event));
+    connection.on("buttonEvent", (event) => {
+      this.dispatchButtonKeys(event);
+      this.emit("buttonEvent", event);
+    });
     connection.on("stateChange", (state, proto) => {
       this._state = state;
       this._protocol = proto;
@@ -729,7 +750,7 @@ var InputManager = class extends TypedEmitter {
   }
   flushAccumulator() {
     if (!this.accDirty) return;
-    const merged = { tx: 0, ty: 0, tz: 0, rx: 0, ry: 0, rz: 0 };
+    const merged = { tx: 0, ty: 0, tz: 0, rx: 0, ry: 0, rz: 0, w: 0 };
     for (const acc of this.deviceAccumulators.values()) {
       merged.tx += acc.tx;
       merged.ty += acc.ty;
@@ -737,12 +758,14 @@ var InputManager = class extends TypedEmitter {
       merged.rx += acc.rx;
       merged.ry += acc.ry;
       merged.rz += acc.rz;
+      merged.w += acc.w;
     }
     this.deviceAccumulators.clear();
     this.accDirty = false;
     let data = {
       translation: { x: merged.tx, y: merged.ty, z: merged.tz },
       rotation: { x: merged.rx, y: merged.ry, z: merged.rz },
+      w: merged.w || void 0,
       timestamp: performance.now() * 1e3
     };
     if (this._config.lockPosition) {
@@ -783,7 +806,7 @@ var InputManager = class extends TypedEmitter {
     }
     const device = this.knownDevices.get(deviceId);
     const deviceRoutes = this.resolveRoutes(deviceId, device);
-    data = applyRoutes(data, deviceRoutes, cfg.scale);
+    data = applyRoutes(data, deviceRoutes, cfg.translateScale, cfg.rotateScale, cfg.wScale);
     return data;
   }
   /** Get the effective routes for a device: device config override > device axes metadata > global default */
@@ -798,6 +821,27 @@ var InputManager = class extends TypedEmitter {
     if (device?.axes) return buildRoutes(device.axes);
     return DEFAULT_ROUTES;
   }
+  /** Dispatch KeyboardEvents for button routes matching this button event */
+  dispatchButtonKeys(event) {
+    if (typeof document === "undefined") return;
+    const allRoutes = this.collectButtonRoutes();
+    for (const route of allRoutes) {
+      if (route.button === event.button) {
+        document.dispatchEvent(new KeyboardEvent(
+          event.pressed ? "keydown" : "keyup",
+          { key: route.key, code: route.code ?? "", bubbles: true }
+        ));
+      }
+    }
+  }
+  /** Gather all button routes from global config + all device configs */
+  collectButtonRoutes() {
+    const routes = [...this._config.buttonRoutes];
+    for (const devCfg of Object.values(this._config.devices)) {
+      if (devCfg.buttonRoutes) routes.push(...devCfg.buttonRoutes);
+    }
+    return routes;
+  }
 };
 var SatMouseContext = createContext(null);
 function SatMouseProvider({