@openmouse/protocol 0.1.0

package/dist/drivers/mouse-types.d.ts

@@ -0,0 +1,388 @@
+/**
+ * Optional UI policy from a driver (used by control.ts).
+ * Drivers added in a PR should set only the flags they need so the shell
+ * stays free of brand-specific branching.
+ */
+export interface MouseUiHints {
+    /** Stable driver id, e.g. "egg-we". */
+    family?: string;
+    /** When false, core settings grid stays hidden. Default true. */
+    settingsReady?: boolean;
+    /**
+     * DPI and polling in this status were read from the mouse rather than filled
+     * in, so they are worth reporting even while `settingsReady` hides the grid.
+     */
+    valuesVerified?: boolean;
+    /** Hide the Low LOD option. */
+    hideLodLow?: boolean;
+    /** Disable LOD controls while gamingSurfaceMode is "Off". */
+    lodRequiresSurface?: boolean;
+    /** Hide poll rates not listed in supportedPollingRates. */
+    hideUnsupportedPollingRates?: boolean;
+    /** Show the polling rate the mouse reports, but refuse to stage a change. */
+    pollingReadOnly?: boolean;
+    /** Hide Motion Sync / angle snap / ripple card. */
+    hideProcessingCard?: boolean;
+    /** Hide Motion Sync while leaving other processing controls available. */
+    hideMotionSync?: boolean;
+    /** Hide angle snapping while leaving other processing controls available. */
+    hideAngleSnapping?: boolean;
+    /** Hide ripple control while leaving other processing controls available. */
+    hideRippleControl?: boolean;
+    /** Hide the receiver signal-strength card when no command reports link quality. */
+    hideSignalCard?: boolean;
+    /** Hide auto-sleep when this protocol generation does not expose it. */
+    hideSleepCard?: boolean;
+    /**
+     * Render the advanced settings section for a driver outside the brands that
+     * open it by default. The section is the only place the signal, debounce,
+     * sleep and processing cards live, so a driver that fills one of them stays
+     * invisible without this. Set it only when a card in there will show.
+     */
+    showAdvancedSection?: boolean;
+    /** Always show battery column (even wired with null %). */
+    forceShowBattery?: boolean;
+    /** Group the device's battery, DPI-indicator, and sleep controls on Overview. */
+    powerOverview?: boolean;
+    /**
+     * Extra sentence appended to the connected status line, for drivers whose
+     * connection is deliberately limited (e.g. why settings are unavailable).
+     */
+    statusNote?: string;
+    /** Override the polling-rate footnote. */
+    pollingNote?: string;
+    /** Sidebar name before first status read. */
+    defaultDisplayName?: string;
+    /**
+     * Simple multi-stage DPI editor in the Sensitivity card (single-axis stages).
+     * Distinct from Logitech onboard slots and Endgame CPI tiles. When set with
+     * `dpiStages` on the status, the shared stage list is shown.
+     */
+    dpiStageEditor?: {
+        /** Highest number of stages the mouse can enable. */
+        maxStages: number;
+        /** When false, stage count is fixed and the count picker is hidden. */
+        countEditable?: boolean;
+        minDpi: number;
+        maxDpi: number;
+        stepDpi: number;
+    };
+    /** Simple DPI indicator modes normalized as 0 off, 1 steady, 2 breathing. */
+    dpiLighting?: {
+        modes: readonly (0 | 1 | 2)[];
+        brightness: readonly number[];
+        speed: readonly number[];
+        /** Optional DPI-indicator-only sleep values in seconds. */
+        sleepTimeouts?: readonly number[];
+    };
+}
+/**
+ * A lighting zone a driver can write effects to. The mouse may not be able to
+ * report its current effect back (Razer's effect commands are writes without a
+ * matching read), in which case `writeOnly` marks that `mode` and friends come
+ * from the driver's own last-write cache rather than the hardware.
+ */
+export interface MouseLighting {
+    /** Label for the lit zone, e.g. "Logo". */
+    zone: string;
+    /** Effects the driver can write, in display order. */
+    modes: readonly MouseLightingMode[];
+    /** Effect currently selected; null before any value is known. */
+    mode: MouseLightingMode | null;
+    /** Base colour "#rrggbb". */
+    color: string | null;
+    /** Second colour for two-colour effects "#rrggbb". */
+    color2: string | null;
+    /** Effects that use the single colour picker. */
+    colorModes: readonly MouseLightingMode[];
+    /** Effects that use the second colour picker. */
+    dualColorModes: readonly MouseLightingMode[];
+    /** Effects that use the reactive speed picker. */
+    reactiveModes: readonly MouseLightingMode[];
+    /** Reactive speed levels the driver understands. */
+    speeds: readonly number[];
+    /** Reactive speed currently selected. */
+    speed: number | null;
+    /** Optional brightness percentage for zones that expose it. */
+    brightness?: number | null;
+    /** Brightness percentages the device accepts. */
+    brightnessLevels?: readonly number[];
+    /** True when the mouse cannot report the effect back (Razer effect writes). */
+    writeOnly?: boolean;
+    /** HID++ per-key/per-LED zone id when this is a directly painted RGB cell. */
+    hardwareZoneId?: number;
+    /** Lets the UI group individually painted cells into one physical surface. */
+    group?: string;
+}
+export type MouseLightingMode = "Off" | "Static" | "Cycling" | "Wave" | "Spectrum" | "Reactive" | "Breathing random" | "Breathing single" | "Breathing dual";
+export interface AtkStoredButton {
+    id: "left" | "right" | "middle" | "back" | "forward" | "bottom";
+    name: string;
+    address: number;
+    keyClass: number;
+    value1: number;
+    value2: number;
+    checksumValid: boolean;
+    action: string;
+    raw: string;
+}
+export interface AtkReceiverInfo {
+    online: boolean;
+    status: number;
+    rfId: string;
+    pairingStatus: number | null;
+    pairingSecondsRemaining: number | null;
+}
+export interface MouseStatus {
+    brand: "RAWM" | "Logitech" | "Pulsar" | "Endgame Gear" | "WLMouse" | "G-Wolves" | "Lamzu" | "CRDRAKO" | "Attack Shark" | "Orbital" | "Razer" | "Teevolution" | "ATK" | "VXE" | "VGN" | "Finalmouse" | "Keychron" | "moddoMOUSE" | "Ninjutso" | "Zaunkoenig" | "Fantech" | "Wooting" | "WALLHACK" | "SteelSeries" | "Glorious" | "MCHOSE" | "K-snake" | "Lingbao" | "GearHub" | "Corsair" | "Microsoft" | "Dareu" | "Incott" | "HyperX" | "ASUS";
+    name: string;
+    /** Driver-supplied UI policy (optional; keeps control.ts brand-agnostic). */
+    ui?: MouseUiHints;
+    batteryPercent: number | null;
+    batteryVoltageMv?: number | null;
+    batteryState: "Charging" | "Charging slowly" | "Almost full" | "Full" | "Discharging" | "Unknown";
+    dpi: number;
+    dpiY?: number;
+    supportsSeparateDpiAxes?: boolean;
+    /** Hall-effect primary-button tuning exposed by Logitech's 0x1B0C HID++ feature. */
+    analogButtonTuning?: {
+        maxActuation: number;
+        maxRapidTrigger: number;
+        maxHaptics: number;
+        buttons: Array<{
+            actuation: number;
+            rapidTrigger: number;
+            haptics: number;
+        }>;
+    };
+    pollingRateHz: number;
+    supportedPollingRates?: number[];
+    activeProfile: number | null;
+    /** Number of firmware-managed ATK configuration banks, when readable. */
+    atkProfileCount?: number;
+    /** Lossless, read-only ATK button assignments from the active configuration bank. */
+    atkButtonMappings?: AtkStoredButton[];
+    /** Receiver and pairing telemetry. Pairing controls are intentionally separate. */
+    atkReceiver?: AtkReceiverInfo;
+    /**
+     * How many onboard profiles the device exposes, when it has a simple
+     * numbered set the user can switch between (distinct from Logitech's
+     * onboard-profile editor). Set together with a 1-based `activeProfile` and a
+     * `setProfile(index)` method, and the shared profile selector appears.
+     */
+    profileCount?: number;
+    /**
+     * Current button assignments, keyed by physical button name. Set together
+     * with `buttonOptions` and a `setButtonMapping(button, action)` method, and
+     * the shared button remapper appears. Distinct from the Razer and Endgame
+     * fields above, which predate this and carry brand-specific shapes.
+     */
+    buttonMappings?: Record<string, string>;
+    /**
+     * Named power/performance modes a device offers as a single choice, with
+     * `powerMode` holding the current one and a `setPowerMode(name)` method.
+     * Distinct from the boolean `performanceMode` above, which is a switch.
+     */
+    powerModes?: string[];
+    powerMode?: string;
+    /** Names for each onboard profile, when the device stores them. */
+    profileNames?: string[];
+    /** Every action `setButtonMapping` will accept, in display order. */
+    buttonOptions?: string[];
+    /** Button names the device reported in an unknown or macro encoding. */
+    fixedButtons?: string[];
+    deviceMode?: "Onboard" | "Host" | "Unknown";
+    unitId?: string | null;
+    modelId?: string | null;
+    transportIds?: Record<string, string>;
+    connectionType?: "Wired" | "Wireless";
+    connectionDetail?: string;
+    /** Zaunkoenig exposes the USB link mode as part of its packed configuration. */
+    usbSpeed?: "Full" | "High";
+    /** Physical button which sends the primary/left-click action. */
+    primaryButton?: "Left" | "Right";
+    dongleLedEnabled?: boolean | null;
+    finalmouseDongleLedMode?: number | null;
+    finalmouseTournamentScrollMode?: number | null;
+    finalmouseTournamentScrollTimeoutMs?: number | null;
+    /**
+     * Incott's 2.4 GHz receiver LED: 0 connect & polling rate, 1 battery
+     * status, 2 battery warning. A property of the dongle, so it is omitted
+     * entirely over the cable rather than reported as a value the user cannot
+     * act on. Does not fit `dongleLedEnabled`, which is a boolean.
+     */
+    incottReceiverLedMode?: number | null;
+    /**
+     * Incott's "Fire Key" rapid-fire settings: how many clicks a press sends
+     * (1-3) and the gap between them in milliseconds (0-255). Global to the
+     * device — the command carries no button index, so these apply to whichever
+     * button is bound to the rapid-fire action.
+     */
+    incottFireKeyTimes?: number | null;
+    incottFireKeyIntervalMs?: number | null;
+    signalStrength?: number | null;
+    motionSync?: boolean | null;
+    /** On-device DPI stages, where supported (Teevolution, Ninjutso, …). */
+    dpiStages?: number[];
+    /** RGB colour for each DPI stage, as lowercase #rrggbb. */
+    dpiStageColors?: string[];
+    /** Active DPI stage index into `dpiStages` (0-based). */
+    activeDpiStage?: number;
+    ninjutsoSystemMode?: "High Speed" | "Competitive" | "Ultra" | null;
+    ninjutsoSystemModes?: Array<"High Speed" | "Competitive" | "Ultra">;
+    ninjutsoHyperClick?: boolean | null;
+    ninjutsoOpticalEngine?: "Standard" | "Burst" | null;
+    ninjutsoSlamClick?: "Low" | "Medium" | "High" | null;
+    debounceMs?: number | null;
+    sleepTimeout?: number | null;
+    angleSnapping?: boolean | null;
+    rippleControl?: boolean | null;
+    slamclickFilter?: boolean | null;
+    motionJitterFilter?: boolean | null;
+    leftSpdtMode?: "Off" | "GX Safe" | "GX Speed" | null;
+    rightSpdtMode?: "Off" | "GX Safe" | "GX Speed" | null;
+    eggCpiLevels?: number;
+    eggCpiStages?: Array<{
+        x: number;
+        y: number;
+    }>;
+    eggPollingDivider?: number;
+    eggMulticlickFilters?: number[];
+    eggButtonMappings?: string[];
+    /**
+     * Every shipped Razer control's current state, keyed by control name — the
+     * four cross-assignable `RazerButtonControl`s and the three two-state
+     * `RazerToggleControl`s share one dict, since each family's renderer
+     * iterates its own fixed control list and the two lists share no control
+     * names. Undefined on a model that has not been confirmed to support the
+     * class `0x02` write at all. A control whose reply the driver cannot decode
+     * (a keyboard shortcut, Hypershift data, an index nothing here knows) is
+     * omitted rather than guessed at.
+     */
+    razerButtonMappings?: Record<string, string>;
+    /** Keychron Nape Pro user layer currently running on the device (1–8).
+     * Matches firmware get/set. Undefined when the layer commands were not answered.
+     */
+    napeLayer?: number;
+    /** How many Nape onboard layers VIA reported. Undefined when unread. */
+    napeLayerCount?: number;
+    performanceMode?: boolean | null;
+    /**
+     * Long-range / far-distance radio mode: trades battery for link range on
+     * receivers that offer it (ATK calls it Ultra Long Range).
+     */
+    longRangeMode?: boolean | null;
+    hyperMode?: boolean | null;
+    /** Sensor pinned to its highest frame rate (WLmouse "Turbo Mode"). */
+    turboMode?: boolean | null;
+    /** Whether button chords can change mouse settings without the driver. */
+    buttonCombination?: boolean | null;
+    sensorMode?: "Eco" | "High" | "Ultra" | null;
+    sensorModeStored?: 0 | 1 | null;
+    sensorModeEditable?: boolean | null;
+    performanceDuration?: number | null;
+    angleTuning?: number | null;
+    wheelAcceleration?: boolean | null;
+    lowBatteryWarning?: number | null;
+    remoteLedMode1?: number | null;
+    remoteLedMode2?: number | null;
+    dpiLedMode?: number | null;
+    dpiLedBrightness?: number | null;
+    dpiLedSpeed?: number | null;
+    /** DPI-indicator-only sleep timeout in seconds, distinct from mouse sleep. */
+    dpiLedSleepTimeout?: number | null;
+    liftOffDistance: "Low" | "Medium" | "High" | null;
+    /**
+     * A single lift-off height the device tunes continuously, for mice whose
+     * firmware exposes a range rather than the three Low/Medium/High stops. The
+     * value and bounds are raw device codes; the millimetre figures are what the
+     * control labels. Drivers that only offer the stops leave this undefined, and
+     * a driver that sets it should still fill `liftOffDistance` with the nearest
+     * stop so anything reading the coarse field keeps working.
+     */
+    liftOffScale?: {
+        value: number;
+        min: number;
+        max: number;
+        millimetres: number;
+        minMillimetres: number;
+        maxMillimetres: number;
+    } | null;
+    /** Explicit LOD choices when a mouse does not support all three common levels. */
+    supportedLiftOffDistances?: Array<NonNullable<MouseStatus["liftOffDistance"]>>;
+    /**
+     * Separate cut-off and re-engage heights, where a mouse offers them instead
+     * of the single three-stop `liftOffDistance`. Only drivers that have verified
+     * it on hardware populate this; everywhere else it stays undefined and the
+     * control does not appear.
+     *
+     * `enabled` is which of the two the mouse is actually using, and may be null
+     * when a driver cannot establish it.
+     */
+    asymmetricLiftOff?: {
+        enabled: boolean | null;
+        liftOff: number;
+        landing: number;
+        liftOffRange: {
+            min: number;
+            max: number;
+        };
+        landingRange: {
+            min: number;
+            max: number;
+        };
+    } | null;
+    /** Logitech onboard profile format (HID++ 0x8100), which selects the layout. */
+    onboardProfileFormat?: {
+        id: number;
+        name: string;
+        base: string;
+        supported: boolean;
+        /** False when the layout comes from vendor code but was never confirmed on hardware. */
+        verified: boolean;
+        /** False until profile-content writes were applied and restored on hardware. */
+        writable: boolean;
+    } | null;
+    /** Logitech 0x19B0 haptic strength, 0-100. Null when the device has no haptics. */
+    /**
+     * Logitech 0x2111 byte 0 — the wheel's ratchet mode, the same thing the
+     * button behind the wheel toggles. Not SmartShift on/off.
+     */
+    wheelMode?: "Freespin" | "Ratchet" | null;
+    /**
+     * Logitech 0x2111 byte 1. 255 disables SmartShift; any lower value enables
+     * it and sets how gentle a flick releases the ratchet.
+     */
+    smartShiftThreshold?: number | null;
+    /** Logitech 0x2121 — high-resolution (smooth) scrolling. */
+    hiResScroll?: boolean | null;
+    invertScroll?: boolean | null;
+    supportsInvertScroll?: boolean;
+    /** Live read of whether the wheel is currently ratcheted. */
+    wheelRatchetEngaged?: boolean | null;
+    /** Logitech 0x2150 — the horizontal thumb wheel. */
+    thumbWheelInverted?: boolean | null;
+    supportsThumbWheelInvert?: boolean;
+    /** Logitech 0x0007 — the editable name, distinct from the fixed device name. */
+    friendlyName?: string | null;
+    friendlyNameMaxLength?: number | null;
+    /** Logitech 0x1815 — Easy-Switch slot count, or null without the feature. */
+    hostCount?: number | null;
+    /** Zero-based active slot; the button under the mouse counts from one. */
+    currentHost?: number | null;
+    /** One entry per slot, true when a computer is paired to it. */
+    hostSlotsPaired?: boolean[] | null;
+    hapticIntensity?: number | null;
+    /** Logitech 0x19B0 byte 0 bit 0 — haptic feedback on or off. */
+    hapticEnabled?: boolean | null;
+    /** Logitech 0x19B0 byte 0 bit 1 — the device's own haptic battery saver. */
+    hapticBatterySaving?: boolean | null;
+    gamingSurfaceMode?: "On" | "Off" | "Auto" | null;
+    lightforceSwitchMode?: "Hybrid" | "Optical" | null;
+    /** Razer lighting zones. */
+    lighting?: MouseLighting;
+    /** Independently addressable lighting zones. `lighting` remains the first zone for compatibility. */
+    lightingZones?: MouseLighting[];
+    firmware: string[];
+}
+//# sourceMappingURL=mouse-types.d.ts.map

package/dist/drivers/mouse-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mouse-types.d.ts","sourceRoot":"","sources":["../../src/drivers/mouse-types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iEAAiE;IACjE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,+BAA+B;IAC/B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,6DAA6D;IAC7D,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,2DAA2D;IAC3D,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,6EAA6E;IAC7E,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mDAAmD;IACnD,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,0EAA0E;IAC1E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,6EAA6E;IAC7E,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,6EAA6E;IAC7E,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,mFAAmF;IACnF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,wEAAwE;IACxE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,2DAA2D;IAC3D,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iFAAiF;IACjF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6CAA6C;IAC7C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,cAAc,CAAC,EAAE;QACf,qDAAqD;QACrD,SAAS,EAAE,MAAM,CAAC;QAClB,uEAAuE;QACvE,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,6EAA6E;IAC7E,WAAW,CAAC,EAAE;QACZ,KAAK,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QAC9B,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;QAC9B,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;QACzB,2DAA2D;QAC3D,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;KACnC,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,sDAAsD;IACtD,KAAK,EAAE,SAAS,iBAAiB,EAAE,CAAC;IACpC,iEAAiE;IACjE,IAAI,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAC/B,6BAA6B;IAC7B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,sDAAsD;IACtD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,iDAAiD;IACjD,UAAU,EAAE,SAAS,iBAAiB,EAAE,CAAC;IACzC,iDAAiD;IACjD,cAAc,EAAE,SAAS,iBAAiB,EAAE,CAAC;IAC7C,kDAAkD;IAClD,aAAa,EAAE,SAAS,iBAAiB,EAAE,CAAC;IAC5C,oDAAoD;IACpD,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,yCAAyC;IACzC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,+EAA+E;IAC/E,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,8EAA8E;IAC9E,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,8EAA8E;IAC9E,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,iBAAiB,GACzB,KAAK,GACL,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,UAAU,GACV,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,CAAC;AAErB,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC;IAChE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,OAAO,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,cAAc,GAAG,SAAS,GAAG,UAAU,GAAG,OAAO,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,GAAG,OAAO,GAAG,aAAa,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,YAAY,GAAG,UAAU,GAAG,YAAY,GAAG,UAAU,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,aAAa,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;IAChb,IAAI,EAAE,MAAM,CAAC;IACb,6EAA6E;IAC7E,EAAE,CAAC,EAAE,YAAY,CAAC;IAClB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,YAAY,EAAE,UAAU,GAAG,iBAAiB,GAAG,aAAa,GAAG,MAAM,GAAG,aAAa,GAAG,SAAS,CAAC;IAClG,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,oFAAoF;IACpF,kBAAkB,CAAC,EAAE;QACnB,YAAY,EAAE,MAAM,CAAC;QACrB,eAAe,EAAE,MAAM,CAAC;QACxB,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,KAAK,CAAC;YAAE,SAAS,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;KAC9E,CAAC;IACF,aAAa,EAAE,MAAM,CAAC;IACtB,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IACjC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,yEAAyE;IACzE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,qFAAqF;IACrF,iBAAiB,CAAC,EAAE,eAAe,EAAE,CAAC;IACtC,mFAAmF;IACnF,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mEAAmE;IACnE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,qEAAqE;IACrE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,wEAAwE;IACxE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,UAAU,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC;IAC5C,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,cAAc,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;IACtC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gFAAgF;IAChF,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,iEAAiE;IACjE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAClC,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,8BAA8B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/C,mCAAmC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpD;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,wEAAwE;IACxE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,2DAA2D;IAC3D,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,yDAAyD;IACzD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kBAAkB,CAAC,EAAE,YAAY,GAAG,aAAa,GAAG,OAAO,GAAG,IAAI,CAAC;IACnE,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,aAAa,GAAG,OAAO,CAAC,CAAC;IACpE,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACpC,qBAAqB,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,IAAI,CAAC;IACpD,iBAAiB,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;IACrD,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACpC,YAAY,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,UAAU,GAAG,IAAI,CAAC;IACrD,aAAa,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,UAAU,GAAG,IAAI,CAAC;IACtD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC/C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B;;;;;;;;;OASG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wEAAwE;IACxE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3B,sEAAsE;IACtE,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3B,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACnC,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IAC7C,gBAAgB,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAChC,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACpC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACnC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,8EAA8E;IAC9E,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,eAAe,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;IAClD;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE;QACb,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,WAAW,EAAE,MAAM,CAAC;QACpB,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,IAAI,CAAC;IACT,kFAAkF;IAClF,yBAAyB,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC/E;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE;QAClB,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;QACxB,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,YAAY,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAA;SAAE,CAAC;QAC3C,YAAY,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAA;SAAE,CAAC;KAC5C,GAAG,IAAI,CAAC;IACT,gFAAgF;IAChF,oBAAoB,CAAC,EAAE;QACrB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,OAAO,CAAC;QACnB,wFAAwF;QACxF,QAAQ,EAAE,OAAO,CAAC;QAClB,gFAAgF;QAChF,QAAQ,EAAE,OAAO,CAAC;KACnB,GAAG,IAAI,CAAC;IACT,mFAAmF;IACnF;;;OAGG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI,CAAC;IAC1C;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,4DAA4D;IAC5D,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7B,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,6DAA6D;IAC7D,mBAAmB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACrC,oDAAoD;IACpD,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACpC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,gFAAgF;IAChF,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,6EAA6E;IAC7E,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,0EAA0E;IAC1E,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,gEAAgE;IAChE,eAAe,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IACnC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,gEAAgE;IAChE,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,4EAA4E;IAC5E,mBAAmB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACrC,iBAAiB,CAAC,EAAE,IAAI,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;IACjD,oBAAoB,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI,CAAC;IACnD,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,qGAAqG;IACrG,aAAa,CAAC,EAAE,aAAa,EAAE,CAAC;IAChC,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB"}

package/dist/drivers/mouse-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=mouse-types.js.map

package/dist/drivers/mouse-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mouse-types.js","sourceRoot":"","sources":["../../src/drivers/mouse-types.ts"],"names":[],"mappings":""}

package/dist/drivers/ninjutso/hid.d.ts

@@ -0,0 +1,62 @@
+import type { MouseLighting, MouseStatus } from "../mouse-types.ts";
+type LiftOffDistance = NonNullable<MouseStatus["liftOffDistance"]>;
+/**
+ * NinjaForce-derived WebHID implementation for Sora V2/V3 and TEN-family mice.
+ * Packet layouts are public and deterministic; hardware verification is still pending.
+ */
+export declare class NinjutsoHidClient {
+    readonly canDisableSleep = false;
+    readonly device: HIDDevice;
+    private queue;
+    private lastStatus;
+    private profile;
+    private effectiveProductId;
+    constructor(device: HIDDevice);
+    static isSupported(device: HIDDevice): boolean;
+    get pollIntervalMs(): number;
+    open(): Promise<void>;
+    close(): Promise<void>;
+    startNotifications(_onChange?: () => void): Promise<boolean>;
+    isLegacy(): boolean;
+    isWireless(): boolean;
+    displayName(): string;
+    getDpiOptions(): number[];
+    getSupportedPollingRates(): number[];
+    getSleepOptions(): readonly number[];
+    getDebounceMaxMs(): number;
+    readStatus(_live?: boolean): Promise<MouseStatus>;
+    setDpi(dpi: number): Promise<number>;
+    setPollingRate(rate: number): Promise<number>;
+    setLiftOffDistance(value: LiftOffDistance): Promise<LiftOffDistance>;
+    setMotionSync(enabled: boolean): Promise<boolean>;
+    setSleepTimeout(seconds: number): Promise<number>;
+    setNinjutsoSystemMode(mode: NonNullable<MouseStatus["ninjutsoSystemMode"]>): Promise<typeof mode>;
+    setNinjutsoHyperClick(enabled: boolean): Promise<boolean>;
+    setNinjutsoOpticalEngine(mode: "Standard" | "Burst"): Promise<typeof mode>;
+    setNinjutsoSlamClick(level: NonNullable<MouseStatus["ninjutsoSlamClick"]>): Promise<typeof level>;
+    setNinjutsoActiveDpiStage(stage: number): Promise<number>;
+    setLighting(lighting: MouseLighting): Promise<MouseLighting>;
+    private readCurrentStatus;
+    private readLegacyStatus;
+    private setCurrentDpi;
+    private setLegacyDpi;
+    private ensureEffectiveProductId;
+    private readCurrent;
+    private readCurrentOptional;
+    private sendCurrent;
+    private setCurrentOption;
+    private readCurrentLighting;
+    private rgbToHex;
+    private hexToRgb;
+    private setControl;
+    private readLegacySettings;
+    private readLegacyFirmware;
+    private decodeFirmware;
+    private legacyRate;
+    private decodeLod;
+    private signedByte;
+    private patch;
+    private run;
+}
+export {};
+//# sourceMappingURL=hid.d.ts.map

package/dist/drivers/ninjutso/hid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hid.d.ts","sourceRoot":"","sources":["../../../src/drivers/ninjutso/hid.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAsCpE,KAAK,eAAe,GAAG,WAAW,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC;AAInE;;;GAGG;AACH,qBAAa,iBAAiB;IAC5B,QAAQ,CAAC,eAAe,SAAS;IACjC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAE3B,OAAO,CAAC,KAAK,CAAuC;IACpD,OAAO,CAAC,UAAU,CAA4B;IAC9C,OAAO,CAAC,OAAO,CAAK;IACpB,OAAO,CAAC,kBAAkB,CAAuB;gBAErC,MAAM,EAAE,SAAS;IAI7B,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO;IAW9C,IAAI,cAAc,IAAI,MAAM,CAE3B;IAEK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAMtB,kBAAkB,CAAC,SAAS,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlE,QAAQ,IAAI,OAAO;IAInB,UAAU,IAAI,OAAO;IAIrB,WAAW,IAAI,MAAM;IAYrB,aAAa,IAAI,MAAM,EAAE;IAOzB,wBAAwB,IAAI,MAAM,EAAE;IAKpC,eAAe,IAAI,SAAS,MAAM,EAAE;IAIpC,gBAAgB,IAAI,MAAM;IAKpB,UAAU,CAAC,KAAK,UAAQ,GAAG,OAAO,CAAC,WAAW,CAAC;IAS/C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOpC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmB7C,kBAAkB,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAsBpE,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAkBjD,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAejD,qBAAqB,CAAC,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,CAAC;IAoBjG,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzD,wBAAwB,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,CAAC;IAY1E,oBAAoB,CAAC,KAAK,EAAE,WAAW,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,KAAK,CAAC;IAqBjG,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAuBzD,WAAW,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;YA6BpD,iBAAiB;YAmFjB,gBAAgB;YAkDhB,aAAa;YAqBb,YAAY;YAyBZ,wBAAwB;YAexB,WAAW;YA+BX,mBAAmB;YAWnB,WAAW;YAIX,gBAAgB;YAYhB,mBAAmB;IA0BjC,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,QAAQ;YAKF,UAAU;YAOV,kBAAkB;YA2BlB,kBAAkB;IAchC,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,KAAK;YAIC,GAAG;CAKlB"}