@openmouse/protocol 0.1.0

package/dist/drivers/endgame/egg-we-control.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Control-shell integration for Endgame Gear WE (OP1we).
+ *
+ * Keeps multi-collection HID discovery, peer bind, and connect coalescing out
+ * of control.ts so other brand PRs do not touch WE-specific paths.
+ */
+import { EggWeHidClient } from "./egg-we-hid.ts";
+export type { EggWeHidClient };
+/** WebHID filters for requestDevice (cmd FF02, notify FF01, identity FF04). */
+export declare const EGG_WE_HID_FILTERS: HIDDeviceFilter[];
+export declare const EGG_WE_DISPLAY_NAME = "Endgame Gear OP1we";
+export declare function isEggWeClient(client: unknown): client is EggWeHidClient;
+export declare function eggWeIsSupported(device: HIDDevice): boolean;
+export declare function eggWeSupportScore(device: HIDDevice): number;
+export declare function eggWeCreate(device: HIDDevice): EggWeHidClient;
+/** One logical mouse from cable + receiver (+ multi-collection USB). */
+export declare function eggWePickDevices(devices: readonly HIDDevice[]): HIDDevice[];
+export declare function eggWeFromAuthorized(devices: readonly HIDDevice[]): EggWeHidClient | null;
+/** Unique merge of requestDevice results + already-authorized devices. */
+export declare function eggWeAuthorizedPool(selected: readonly HIDDevice[]): Promise<HIDDevice[]>;
+export declare function eggWePrepare(client: EggWeHidClient, devices?: readonly HIDDevice[]): Promise<void>;
+/**
+ * Sidebar list: non-WE devices + one WE logical entry.
+ * `isOtherSupported` is provided by the shell (createSupportedClient !== null).
+ */
+export declare function eggWeMergeLogicalDevices(all: readonly HIDDevice[], isOtherSupported: (device: HIDDevice) => boolean): HIDDevice[];
+export type EggWeConnectResult = {
+    action: "ignore";
+} | {
+    action: "refresh";
+    client: EggWeHidClient;
+} | {
+    action: "activate";
+    client: EggWeHidClient;
+    reason: "path" | "new";
+};
+/**
+ * Coalesce multi-interface connect events for an already-known or new WE mouse.
+ */
+export declare function eggWeResolveConnect(eventDevice: HIDDevice, active: EggWeHidClient | null, activeDevice: HIDDevice | null, allDevices: readonly HIDDevice[]): Promise<EggWeConnectResult>;
+export declare function eggWeOwnsDevice(client: EggWeHidClient | null, device: HIDDevice): boolean;
+//# sourceMappingURL=egg-we-control.d.ts.map

package/dist/drivers/endgame/egg-we-control.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"egg-we-control.d.ts","sourceRoot":"","sources":["../../../src/drivers/endgame/egg-we-control.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,YAAY,EAAE,cAAc,EAAE,CAAC;AAE/B,+EAA+E;AAC/E,eAAO,MAAM,kBAAkB,EAAE,eAAe,EAK/C,CAAC;AAEF,eAAO,MAAM,mBAAmB,uBAAuB,CAAC;AAExD,wBAAgB,aAAa,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,cAAc,CAEvE;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAE3D;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAE3D;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,SAAS,GAAG,cAAc,CAE7D;AAED,wEAAwE;AACxE,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,SAAS,SAAS,EAAE,GAAG,SAAS,EAAE,CAE3E;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,SAAS,SAAS,EAAE,GAAG,cAAc,GAAG,IAAI,CAExF;AAED,0EAA0E;AAC1E,wBAAsB,mBAAmB,CACvC,QAAQ,EAAE,SAAS,SAAS,EAAE,GAC7B,OAAO,CAAC,SAAS,EAAE,CAAC,CAOtB;AAED,wBAAsB,YAAY,CAChC,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,SAAS,SAAS,EAAE,GAC7B,OAAO,CAAC,IAAI,CAAC,CAMf;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,GAAG,EAAE,SAAS,SAAS,EAAE,EACzB,gBAAgB,EAAE,CAAC,MAAM,EAAE,SAAS,KAAK,OAAO,GAC/C,SAAS,EAAE,CAKb;AAED,MAAM,MAAM,kBAAkB,GAC1B;IAAE,MAAM,EAAE,QAAQ,CAAA;CAAE,GACpB;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,cAAc,CAAA;CAAE,GAC7C;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,MAAM,EAAE,cAAc,CAAC;IAAC,MAAM,EAAE,MAAM,GAAG,KAAK,CAAA;CAAE,CAAC;AAE3E;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,WAAW,EAAE,SAAS,EACtB,MAAM,EAAE,cAAc,GAAG,IAAI,EAC7B,YAAY,EAAE,SAAS,GAAG,IAAI,EAC9B,UAAU,EAAE,SAAS,SAAS,EAAE,GAC/B,OAAO,CAAC,kBAAkB,CAAC,CAsB7B;AAED,wBAAgB,eAAe,CAC7B,MAAM,EAAE,cAAc,GAAG,IAAI,EAC7B,MAAM,EAAE,SAAS,GAChB,OAAO,CAET"}

package/dist/drivers/endgame/egg-we-control.js

@@ -0,0 +1,87 @@
+/**
+ * Control-shell integration for Endgame Gear WE (OP1we).
+ *
+ * Keeps multi-collection HID discovery, peer bind, and connect coalescing out
+ * of control.ts so other brand PRs do not touch WE-specific paths.
+ */
+import { EggWeHidClient } from "./egg-we-hid.js";
+/** WebHID filters for requestDevice (cmd FF02, notify FF01, identity FF04). */
+export const EGG_WE_HID_FILTERS = [
+    { vendorId: 0x3367, usagePage: 0xff02 },
+    { vendorId: 0x3367, usagePage: 0xff01 },
+    { vendorId: 0x3367, usagePage: 0xff04 },
+    { vendorId: 0x3367 },
+];
+export const EGG_WE_DISPLAY_NAME = "Endgame Gear OP1we";
+export function isEggWeClient(client) {
+    return client instanceof EggWeHidClient;
+}
+export function eggWeIsSupported(device) {
+    return EggWeHidClient.isSupported(device);
+}
+export function eggWeSupportScore(device) {
+    return EggWeHidClient.supportScore(device);
+}
+export function eggWeCreate(device) {
+    return new EggWeHidClient(device);
+}
+/** One logical mouse from cable + receiver (+ multi-collection USB). */
+export function eggWePickDevices(devices) {
+    return EggWeHidClient.pickDevices(devices);
+}
+export function eggWeFromAuthorized(devices) {
+    return EggWeHidClient.fromAuthorizedDevices(devices);
+}
+/** Unique merge of requestDevice results + already-authorized devices. */
+export async function eggWeAuthorizedPool(selected) {
+    const granted = typeof navigator !== "undefined" && navigator.hid
+        ? await navigator.hid.getDevices()
+        : [];
+    return [...selected, ...granted].filter((device, index, list) => list.indexOf(device) === index);
+}
+export async function eggWePrepare(client, devices) {
+    const all = devices
+        ?? (typeof navigator !== "undefined" && navigator.hid
+            ? await navigator.hid.getDevices()
+            : []);
+    client.bindPeers(all);
+}
+/**
+ * Sidebar list: non-WE devices + one WE logical entry.
+ * `isOtherSupported` is provided by the shell (createSupportedClient !== null).
+ */
+export function eggWeMergeLogicalDevices(all, isOtherSupported) {
+    const nonWe = all.filter((device) => isOtherSupported(device) && !EggWeHidClient.isSupported(device));
+    return [...nonWe, ...EggWeHidClient.pickDevices(all)];
+}
+/**
+ * Coalesce multi-interface connect events for an already-known or new WE mouse.
+ */
+export async function eggWeResolveConnect(eventDevice, active, activeDevice, allDevices) {
+    const preferred = EggWeHidClient.pickDevices(allDevices)[0];
+    if (!preferred)
+        return { action: "ignore" };
+    if (active?.ownsDevice(eventDevice) || activeDevice === preferred) {
+        if (active) {
+            active.bindPeers(allDevices);
+            return { action: "refresh", client: active };
+        }
+        return { action: "ignore" };
+    }
+    if (preferred !== eventDevice) {
+        const next = EggWeHidClient.fromAuthorizedDevices(allDevices);
+        if (!next || next.device === activeDevice)
+            return { action: "ignore" };
+        return { action: "activate", client: next, reason: "path" };
+    }
+    if (activeDevice === preferred)
+        return { action: "ignore" };
+    const weClient = EggWeHidClient.fromAuthorizedDevices(allDevices);
+    if (!weClient)
+        return { action: "ignore" };
+    return { action: "activate", client: weClient, reason: "new" };
+}
+export function eggWeOwnsDevice(client, device) {
+    return client?.ownsDevice(device) ?? false;
+}
+//# sourceMappingURL=egg-we-control.js.map

package/dist/drivers/endgame/egg-we-control.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"egg-we-control.js","sourceRoot":"","sources":["../../../src/drivers/endgame/egg-we-control.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,+EAA+E;AAC/E,MAAM,CAAC,MAAM,kBAAkB,GAAsB;IACnD,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE;IACvC,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE;IACvC,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE;IACvC,EAAE,QAAQ,EAAE,MAAM,EAAE;CACrB,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,oBAAoB,CAAC;AAExD,MAAM,UAAU,aAAa,CAAC,MAAe;IAC3C,OAAO,MAAM,YAAY,cAAc,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,MAAiB;IAChD,OAAO,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAiB;IACjD,OAAO,cAAc,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,MAAiB;IAC3C,OAAO,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,gBAAgB,CAAC,OAA6B;IAC5D,OAAO,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,OAA6B;IAC/D,OAAO,cAAc,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;AACvD,CAAC;AAED,0EAA0E;AAC1E,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,QAA8B;IAE9B,MAAM,OAAO,GAAG,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,CAAC,GAAG;QAC/D,CAAC,CAAC,MAAM,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE;QAClC,CAAC,CAAC,EAAE,CAAC;IACP,OAAO,CAAC,GAAG,QAAQ,EAAE,GAAG,OAAO,CAAC,CAAC,MAAM,CACrC,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,CACxD,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAsB,EACtB,OAA8B;IAE9B,MAAM,GAAG,GAAG,OAAO;WACd,CAAC,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,CAAC,GAAG;YACnD,CAAC,CAAC,MAAM,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE;YAClC,CAAC,CAAC,EAAE,CAAC,CAAC;IACV,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AACxB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CACtC,GAAyB,EACzB,gBAAgD;IAEhD,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CACtB,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,CAC5E,CAAC;IACF,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;AACxD,CAAC;AAOD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,WAAsB,EACtB,MAA6B,EAC7B,YAA8B,EAC9B,UAAgC;IAEhC,MAAM,SAAS,GAAG,cAAc,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5D,IAAI,CAAC,SAAS;QAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAE5C,IAAI,MAAM,EAAE,UAAU,CAAC,WAAW,CAAC,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAClE,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAC7B,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAC/C,CAAC;QACD,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED,IAAI,SAAS,KAAK,WAAW,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,cAAc,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,YAAY;YAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QACvE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAC9D,CAAC;IAED,IAAI,YAAY,KAAK,SAAS;QAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC5D,MAAM,QAAQ,GAAG,cAAc,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAClE,IAAI,CAAC,QAAQ;QAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC3C,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AACjE,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,MAA6B,EAC7B,MAAiB;IAEjB,OAAO,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC;AAC7C,CAAC"}

package/dist/drivers/endgame/egg-we-hid.d.ts

@@ -0,0 +1,58 @@
+import type { MouseStatus } from "../mouse-types.ts";
+export declare class EggWeHidClient {
+    /** Max report rate for this model (OEM UI: 125 / 250 / 500 / 1000 Hz). */
+    static readonly MAX_POLLING_HZ = 1000;
+    private cmdDevice;
+    private notifyDevice;
+    private channelsResolved;
+    private responseWaiter;
+    private readonly onInputReport;
+    readonly device: HIDDevice;
+    constructor(device: HIDDevice);
+    static fromAuthorizedDevices(devices: readonly HIDDevice[]): EggWeHidClient | null;
+    static isSupported(device: HIDDevice): boolean;
+    private static hasOp1EightKCommandReport;
+    static isReceiverDevice(device: HIDDevice): boolean;
+    static displayNameForDevice(device: HIDDevice): string;
+    static pickDevices(devices: readonly HIDDevice[]): HIDDevice[];
+    static supportScore(device: HIDDevice): number;
+    get pollIntervalMs(): number;
+    isWirelessPath(): boolean;
+    ownsDevice(device: HIDDevice): boolean;
+    displayName(): string;
+    /**
+     * Pair FF02 (cmd) + FF01 (notify) for this transport only.
+     * Cable primary → cable peers; receiver primary → receiver peers.
+     */
+    bindPeers(devices: readonly HIDDevice[]): void;
+    open(): Promise<void>;
+    describeCollections(): string;
+    getDpiOptions(): number[];
+    get supportedPollingRates(): number[];
+    readStatus(): Promise<MouseStatus>;
+    setDpi(dpi: number): Promise<number>;
+    setPollingRate(rate: number): Promise<number>;
+    setLiftOffDistance(value: NonNullable<MouseStatus["liftOffDistance"]>): Promise<void>;
+    close(): Promise<void>;
+    private readProfile;
+    private readProfileMemory;
+    private readEeprom;
+    private writeEeprom;
+    private delay;
+    private productMeta;
+    private requireChannels;
+    private resolvedChannels;
+    private readBatteryOnce;
+    private parseGetPowerResponse;
+    private failWaiter;
+    private transact;
+    private toHex;
+    private static hasCmdChannel;
+    private static hasNotifyChannel;
+    private static usagePages;
+    private static listFeatureReports;
+    private static listInputReports;
+    private static listReports;
+    private static reportPayloadLength;
+}
+//# sourceMappingURL=egg-we-hid.d.ts.map

package/dist/drivers/endgame/egg-we-hid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"egg-we-hid.d.ts","sourceRoot":"","sources":["../../../src/drivers/endgame/egg-we-hid.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAwErD,qBAAa,cAAc;IACzB,0EAA0E;IAC1E,MAAM,CAAC,QAAQ,CAAC,cAAc,QAAQ;IAEtC,OAAO,CAAC,SAAS,CAA0B;IAC3C,OAAO,CAAC,YAAY,CAA0B;IAC9C,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,cAAc,CAKN;IAEhB,OAAO,CAAC,QAAQ,CAAC,aAAa,CAU5B;IAEF,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;gBAEf,MAAM,EAAE,SAAS;IAI7B,MAAM,CAAC,qBAAqB,CAAC,OAAO,EAAE,SAAS,SAAS,EAAE,GAAG,cAAc,GAAG,IAAI;IAQlF,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO;IAa9C,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAIxC,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO;IAMnD,MAAM,CAAC,oBAAoB,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAOtD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,SAAS,SAAS,EAAE,GAAG,SAAS,EAAE;IAW9D,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAkB9C,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED,cAAc,IAAI,OAAO;IAIzB,UAAU,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO;IAMtC,WAAW,IAAI,MAAM;IASrB;;;OAGG;IACH,SAAS,CAAC,OAAO,EAAE,SAAS,SAAS,EAAE,GAAG,IAAI;IAexC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAoB3B,mBAAmB,IAAI,MAAM;IAgB7B,aAAa,IAAI,MAAM,EAAE;IAMzB,IAAI,qBAAqB,IAAI,MAAM,EAAE,CAGpC;IAEK,UAAU,IAAI,OAAO,CAAC,WAAW,CAAC;IAiDlC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBpC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAiB7C,kBAAkB,CAAC,KAAK,EAAE,WAAW,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAcrF,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;YAsBd,WAAW;YAIX,iBAAiB;YAgBjB,UAAU;YAcV,WAAW;IAYzB,OAAO,CAAC,KAAK;IAQb,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,gBAAgB;YAQV,eAAe;IAmB7B,OAAO,CAAC,qBAAqB;IAe7B,OAAO,CAAC,UAAU;YAQJ,QAAQ;IA+BtB,OAAO,CAAC,KAAK;IAQb,OAAO,CAAC,MAAM,CAAC,aAAa;IAO5B,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAO/B,OAAO,CAAC,MAAM,CAAC,UAAU;IAYzB,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAIjC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAI/B,OAAO,CAAC,MAAM,CAAC,WAAW;IAoB1B,OAAO,CAAC,MAAM,CAAC,mBAAmB;CAOnC"}