@ledgerhq/device-management-kit 0.4.0 → 0.5.1

package/lib/types/src/internal/transport/usb/transport/WebUsbHidTransport.d.ts

@@ -0,0 +1,97 @@
+import { Either } from "purify-ts";
+import { Observable } from "rxjs";
+import { DeviceId } from "../../../../api/device/DeviceModel";
+import { DmkError } from "../../../../api/Error";
+import { Transport } from "../../../../api/transport/model/Transport";
+import { TransportIdentifier } from "../../../../api/transport/model/TransportIdentifier";
+import type { DeviceModelDataSource } from "../../../device-model/data/DeviceModelDataSource";
+import type { LoggerPublisherService } from "../../../logger-publisher/service/LoggerPublisherService";
+import { DisconnectHandler } from "../../../transport/model/DeviceConnection";
+import { ConnectError } from "../../../transport/model/Errors";
+import { InternalConnectedDevice } from "../../../transport/model/InternalConnectedDevice";
+import { InternalDiscoveredDevice } from "../../../transport/model/InternalDiscoveredDevice";
+import { UsbHidDeviceConnectionFactory } from "../../../transport/usb/service/UsbHidDeviceConnectionFactory";
+export declare class WebUsbHidTransport implements Transport {
+    private deviceModelDataSource;
+    /** List of HID devices that have been discovered */
+    private _internalDiscoveredDevices;
+    /** Map of *connected* HIDDevice to their UsbHidDeviceConnection */
+    private _deviceConnectionsByHidDevice;
+    /**
+     * Set of UsbHidDeviceConnection for which the HIDDevice has been
+     * disconnected, so they are waiting for a reconnection
+     */
+    private _deviceConnectionsPendingReconnection;
+    /** AbortController to stop listening to HID connection events */
+    private _connectionListenersAbortController;
+    private _logger;
+    private _usbHidDeviceConnectionFactory;
+    private readonly connectionType;
+    private readonly identifier;
+    constructor(deviceModelDataSource: DeviceModelDataSource, loggerServiceFactory: (tag: string) => LoggerPublisherService, usbHidDeviceConnectionFactory: UsbHidDeviceConnectionFactory);
+    /**
+     * Get the WebHID API if supported or error
+     * @returns `Either<UsbHidTransportNotSupportedError, HID>`
+     */
+    private get hidApi();
+    isSupported(): boolean;
+    getIdentifier(): TransportIdentifier;
+    /**
+     * Wrapper around `navigator.hid.getDevices()`.
+     * It will return the list of plugged in HID devices to which the user has
+     * previously granted access through `navigator.hid.requestDevice()`.
+     */
+    private getDevices;
+    /**
+     * Map a HIDDevice to an InternalDiscoveredDevice, either by creating a new one or returning an existing one
+     */
+    private mapHIDDeviceToInternalDiscoveredDevice;
+    /**
+     * Listen to known devices (devices to which the user has granted access)
+     */
+    listenToKnownDevices(): Observable<InternalDiscoveredDevice[]>;
+    private updateInternalDiscoveredDevices;
+    /**
+     * Wrapper around navigator.hid.requestDevice()
+     * In a browser, it will show a native dialog to select a HID device.
+     */
+    private promptDeviceAccess;
+    startDiscovering(): Observable<InternalDiscoveredDevice>;
+    stopDiscovering(): void;
+    private startListeningToConnectionEvents;
+    private stopListeningToConnectionEvents;
+    /**
+     * Connect to a HID USB device and update the internal state of the associated device
+     */
+    connect({ deviceId, onDisconnect, }: {
+        deviceId: DeviceId;
+        onDisconnect: DisconnectHandler;
+    }): Promise<Either<ConnectError, InternalConnectedDevice>>;
+    private getDeviceModel;
+    private getHidUsbProductId;
+    /**
+     * Disconnect from a HID USB device
+     */
+    disconnect(params: {
+        connectedDevice: InternalConnectedDevice;
+    }): Promise<Either<DmkError, void>>;
+    /**
+     * Type guard to check if the event is a HID connection event
+     * @param event
+     * @private
+     */
+    private isHIDConnectionEvent;
+    /**
+     * Handle the disconnection event of a HID device
+     * @param event
+     */
+    private handleDeviceDisconnectionEvent;
+    private handleDeviceReconnection;
+    /**
+     * Handle the connection event of a HID device
+     * @param event
+     */
+    private handleDeviceConnectionEvent;
+    destroy(): void;
+}
+//# sourceMappingURL=WebUsbHidTransport.d.ts.map

package/lib/types/src/internal/transport/usb/transport/WebUsbHidTransport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebUsbHidTransport.d.ts","sourceRoot":"","sources":["../../../../../../../src/internal/transport/usb/transport/WebUsbHidTransport.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAmC,MAAM,WAAW,CAAC;AACpE,OAAO,EAA8B,UAAU,EAAa,MAAM,MAAM,CAAC;AAGzE,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAEnD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAC3D,OAAO,EAEL,mBAAmB,EACpB,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mDAAmD,CAAC;AAI/F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,2DAA2D,CAAC;AACxG,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAC/E,OAAO,EACL,YAAY,EAOb,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,mDAAmD,CAAC;AAC5F,OAAO,EAAE,wBAAwB,EAAE,MAAM,oDAAoD,CAAC;AAG9F,OAAO,EAAE,6BAA6B,EAAE,MAAM,+DAA+D,CAAC;AAO9G,qBACa,kBAAmB,YAAW,SAAS;IA6BhD,OAAO,CAAC,qBAAqB;IA5B/B,oDAAoD;IACpD,OAAO,CAAC,0BAA0B,CAEoC;IAEtE,mEAAmE;IACnE,OAAO,CAAC,6BAA6B,CAGvB;IAEd;;;OAGG;IACH,OAAO,CAAC,qCAAqC,CACjC;IAEZ,iEAAiE;IACjE,OAAO,CAAC,mCAAmC,CACnB;IACxB,OAAO,CAAC,OAAO,CAAyB;IACxC,OAAO,CAAC,8BAA8B,CAAgC;IACtE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAyB;IACxD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA8C;gBAI/D,qBAAqB,EAAE,qBAAqB,EAEpD,oBAAoB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,sBAAsB,EAE7D,6BAA6B,EAAE,6BAA6B;IAQ9D;;;OAGG;IACH,OAAO,KAAK,MAAM,GAMjB;IAED,WAAW;IAWX,aAAa,IAAI,mBAAmB;IAIpC;;;;OAIG;YACW,UAAU;IAoBxB;;OAEG;IACH,OAAO,CAAC,sCAAsC;IA4C9C;;OAEG;IACI,oBAAoB,IAAI,UAAU,CAAC,wBAAwB,EAAE,CAAC;YAOvD,+BAA+B;IAmB7C;;;OAGG;YACW,kBAAkB;IA+ChC,gBAAgB,IAAI,UAAU,CAAC,wBAAwB,CAAC;IA0BxD,eAAe,IAAI,IAAI;IAOvB,OAAO,CAAC,gCAAgC;IAoBxC,OAAO,CAAC,+BAA+B;IAKvC;;OAEG;IACG,OAAO,CAAC,EACZ,QAAQ,EACR,YAAY,GACb,EAAE;QACD,QAAQ,EAAE,QAAQ,CAAC;QACnB,YAAY,EAAE,iBAAiB,CAAC;KACjC,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,uBAAuB,CAAC,CAAC;IAgE1D,OAAO,CAAC,cAAc;IAWtB,OAAO,CAAC,kBAAkB;IAO1B;;OAEG;IACG,UAAU,CAAC,MAAM,EAAE;QACvB,eAAe,EAAE,uBAAuB,CAAC;KAC1C,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAyBnC;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAU5B;;;OAGG;YACW,8BAA8B;IA+B5C,OAAO,CAAC,wBAAwB;IAiBhC;;;OAGG;IACH,OAAO,CAAC,2BAA2B;IA8B5B,OAAO;CAOf"}

package/lib/types/src/internal/transport/usb/transport/WebUsbHidTransport.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=WebUsbHidTransport.test.d.ts.map

package/lib/types/src/internal/transport/usb/transport/WebUsbHidTransport.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebUsbHidTransport.test.d.ts","sourceRoot":"","sources":["../../../../../../../src/internal/transport/usb/transport/WebUsbHidTransport.test.ts"],"names":[],"mappings":""}

package/lib/types/src/internal/transport/usb/transport/__mocks__/WebUsbHidTransport.d.ts

@@ -0,0 +1,12 @@
+import { type Transport } from "../../../../../api/transport/model/Transport";
+export declare class WebUsbHidTransport implements Transport {
+    isSupported: jest.Mock<any, any, any>;
+    getIdentifier: jest.Mock<any, any, any>;
+    connect: jest.Mock<any, any, any>;
+    startDiscovering: jest.Mock<any, any, any>;
+    stopDiscovering: jest.Mock<any, any, any>;
+    disconnect: jest.Mock<any, any, any>;
+    listenToKnownDevices: jest.Mock<any, any, any>;
+}
+export declare function usbHidTransportMockBuilder(props?: Partial<Transport>): Transport;
+//# sourceMappingURL=WebUsbHidTransport.d.ts.map

package/lib/types/src/internal/transport/usb/transport/__mocks__/WebUsbHidTransport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebUsbHidTransport.d.ts","sourceRoot":"","sources":["../../../../../../../../src/internal/transport/usb/transport/__mocks__/WebUsbHidTransport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAEhE,qBAAa,kBAAmB,YAAW,SAAS;IAClD,WAAW,2BAAa;IACxB,aAAa,2BAAa;IAC1B,OAAO,2BAAa;IACpB,gBAAgB,2BAAa;IAC7B,eAAe,2BAAa;IAE5B,UAAU,2BAAa;IACvB,oBAAoB,2BAAa;CAClC;AAED,wBAAgB,0BAA0B,CACxC,KAAK,GAAE,OAAO,CAAC,SAAS,CAAM,GAC7B,SAAS,CAWX"}