@ukeyfe/hardware-transport-web-device 1.1.13

package/README.md

@@ -0,0 +1,29 @@
+# `@ukeyfe/hardware-transport-webusb`
+
+`@ukeyfe/hardware-transport-webusb` is a library that implements transport communication by WebUSB.
+
+## What is the purpose
+
+- translate JSON payloads to binary messages using protobuf definitions comprehensible to UKey devices
+- chunking and reading chunked messages according to the [UKey protocol](./protocol.md)
+- exposing single API for various transport methods:
+  - Http Transport
+  - React Native Transport
+  - WebUSB
+- Create and expose typescript definitions based on protobuf definitions.
+
+### The short version
+
+In order to be able to use new features of ukey-firmware you need to update protobuf definitions.
+
+1. `git submodule update --init --recursive` to initialize git submodules.
+1. `yarn update-submodules` to update firmware submodule
+1. `yarn update:protobuf` to generate new `./messages.json` and `./src/types/messages.ts`
+
+git submodule update --init --recursive to initialize firmware submodule
+yarn update-submodules to update firmware submodule
+yar update:protobuf to generate new ./messages.json and ./src/types/messages.ts
+
+## Docs
+
+Documentation is available [hardware-js-sdk](https://developer.ukey.so/connect-to-hardware/hardware-sdk/start)

package/dist/electron-ble-transport.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="node" />
+import transport from '@ukeyfe/hardware-transport';
+import { Deferred } from '@ukeyfe/hardware-shared';
+import type EventEmitter from 'events';
+import type { DesktopAPI } from '@ukeyfe/hardware-transport-electron';
+declare global {
+    interface Window {
+        desktopApi?: DesktopAPI;
+    }
+}
+export type BleAcquireInput = {
+    uuid: string;
+    forceCleanRunPromise?: boolean;
+};
+export default class ElectronBleTransport {
+    _messages: ReturnType<typeof transport.parseConfigure> | undefined;
+    name: string;
+    configured: boolean;
+    runPromise: Deferred<any> | null;
+    Log?: any;
+    emitter?: EventEmitter;
+    private connectedDevices;
+    private dataBuffers;
+    private notificationCleanups;
+    private disconnectCleanups;
+    private handleBluetoothError;
+    private cleanupDeviceState;
+    init(logger: any, emitter?: EventEmitter): void;
+    configure(signedData: any): void;
+    listen(): void;
+    enumerate(): Promise<{
+        id: string;
+        name: string;
+    }[]>;
+    acquire(input: BleAcquireInput): Promise<{
+        uuid: string;
+        path: string;
+    }>;
+    release(id: string): Promise<void>;
+    private handleNotificationData;
+    call(uuid: string, name: string, data: Record<string, unknown>): Promise<import("@ukeyfe/hardware-transport").MessageFromUKey>;
+    private processNotificationPacket;
+}
+//# sourceMappingURL=electron-ble-transport.d.ts.map

package/dist/electron-ble-transport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"electron-ble-transport.d.ts","sourceRoot":"","sources":["../src/electron-ble-transport.ts"],"names":[],"mappings":";AAAA,OAAO,SAAkD,MAAM,4BAA4B,CAAC;AAC5F,OAAO,EAIL,QAAQ,EAGT,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAC;AAEvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AAKtE,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,UAAU,CAAC,EAAE,UAAU,CAAC;KACzB;CACF;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC,CAAC;AASF,MAAM,CAAC,OAAO,OAAO,oBAAoB;IACvC,SAAS,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IAEnE,IAAI,SAA0B;IAE9B,UAAU,UAAS;IAEnB,UAAU,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,CAAQ;IAExC,GAAG,CAAC,EAAE,GAAG,CAAC;IAEV,OAAO,CAAC,EAAE,YAAY,CAAC;IAGvB,OAAO,CAAC,gBAAgB,CAA0B;IAGlD,OAAO,CAAC,WAAW,CAAsE;IAGzF,OAAO,CAAC,oBAAoB,CAAsC;IAGlE,OAAO,CAAC,kBAAkB,CAAsC;IAGhE,OAAO,CAAC,oBAAoB;IAmC5B,OAAO,CAAC,kBAAkB;IAmB1B,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY;IAexC,SAAS,CAAC,UAAU,EAAE,GAAG;IAMzB,MAAM;IAEA,SAAS,IAAI,OAAO,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAcpD,OAAO,CAAC,KAAK,EAAE,eAAe;;;;IA8E9B,OAAO,CAAC,EAAE,EAAE,MAAM;IAwBxB,OAAO,CAAC,sBAAsB;IA2BxB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IA2EpE,OAAO,CAAC,yBAAyB;CAyDlC"}

package/dist/index.d.ts

@@ -0,0 +1,76 @@
+import * as transport from '@ukeyfe/hardware-transport';
+import transport__default, { AcquireInput } from '@ukeyfe/hardware-transport';
+import { Deferred } from '@ukeyfe/hardware-shared';
+import EventEmitter from 'events';
+import { DesktopAPI } from '@ukeyfe/hardware-transport-electron';
+
+interface DeviceInfo {
+    path: string;
+    device: USBDevice;
+}
+declare class WebUsbTransport {
+    messages: ReturnType<typeof transport__default.parseConfigure> | undefined;
+    name: string;
+    stopped: boolean;
+    configured: boolean;
+    Log?: any;
+    usb?: USB;
+    deviceList: Array<DeviceInfo>;
+    configurationId: number;
+    endpointId: number;
+    interfaceId: number;
+    init(logger: any): void;
+    configure(signedData: any): void;
+    promptDeviceAccess(): Promise<USBDevice | null>;
+    enumerate(): Promise<DeviceInfo[]>;
+    getConnectedDevices(): Promise<DeviceInfo[]>;
+    acquire(input: AcquireInput): Promise<string | undefined>;
+    findDevice(path: string): Promise<USBDevice>;
+    connect(path: string, first: boolean): Promise<void>;
+    connectToDevice(path: string, first: boolean): Promise<void>;
+    post(session: string, name: string, data: Record<string, unknown>): Promise<void>;
+    call(path: string, name: string, data: Record<string, unknown>): Promise<transport.MessageFromUKey>;
+    receiveData(path: string): Promise<string>;
+    release(path: string): Promise<void>;
+}
+
+declare global {
+    interface Window {
+        desktopApi?: DesktopAPI;
+    }
+}
+type BleAcquireInput = {
+    uuid: string;
+    forceCleanRunPromise?: boolean;
+};
+declare class ElectronBleTransport {
+    _messages: ReturnType<typeof transport__default.parseConfigure> | undefined;
+    name: string;
+    configured: boolean;
+    runPromise: Deferred<any> | null;
+    Log?: any;
+    emitter?: EventEmitter;
+    private connectedDevices;
+    private dataBuffers;
+    private notificationCleanups;
+    private disconnectCleanups;
+    private handleBluetoothError;
+    private cleanupDeviceState;
+    init(logger: any, emitter?: EventEmitter): void;
+    configure(signedData: any): void;
+    listen(): void;
+    enumerate(): Promise<{
+        id: string;
+        name: string;
+    }[]>;
+    acquire(input: BleAcquireInput): Promise<{
+        uuid: string;
+        path: string;
+    }>;
+    release(id: string): Promise<void>;
+    private handleNotificationData;
+    call(uuid: string, name: string, data: Record<string, unknown>): Promise<transport.MessageFromUKey>;
+    private processNotificationPacket;
+}
+
+export { ElectronBleTransport, WebUsbTransport };

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,UAAU,CAAC;AACvC,OAAO,oBAAoB,MAAM,0BAA0B,CAAC;AAE5D,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,CAAC"}