@ledgerhq/device-management-kit 0.0.0-develop-20240925001059

package/README.md

@@ -0,0 +1,322 @@
+# Device Development Kit Library Documentation
+
+> [!CAUTION]
+> This is still under development and we are free to make new interfaces which may lead to Device Development Kit breaking changes.
+
+- [Device Development Kit Library Documentation](#device-development-kit-library-documentation)
+  - [Description](#description)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Compatibility](#compatibility)
+    - [Pre-requisites](#pre-requisites)
+    - [Main Features](#main-features)
+    - [Setting up the SDK](#setting-up-the-sdk)
+    - [Connecting to a Device](#connecting-to-a-device)
+    - [Sending an APDU](#sending-an-apdu)
+    - [Sending a Pre-defined Command](#sending-a-pre-defined-command)
+      - [Open App](#open-app)
+      - [Close App](#close-app)
+      - [Get OS Version](#get-os-version)
+      - [Get App and Version](#get-app-and-version)
+    - [Building a Custom Command](#building-a-custom-command)
+    - [Executing a device action](#executing-a-device-action)
+      - [Open App Device Action](#open-app-device-action)
+    - [Example in React](#example-in-react)
+
+## Description
+
+This package contains the core of the Device Management Kit. It provides a simple interface to handle Ledger devices and features the Device Management Kit's entry points, classes, types, structures, and models.
+
+## Installation
+
+To install the core package, run the following command:
+
+```sh
+npm install @ledgerhq/device-management-kit
+```
+
+## Usage
+
+### Compatibility
+
+This library works in [any browser supporting the WebHID API](https://developer.mozilla.org/en-US/docs/Web/API/WebHID_API#browser_compatibility).
+
+### Pre-requisites
+
+Some of the APIs exposed return objects of type `Observable` from RxJS. Ensure you are familiar with the basics of the Observer pattern and RxJS before using this SDK. You can refer to [RxJS documentation](https://rxjs.dev/guide/overview) for more information.
+
+### Main Features
+
+- Discovering and connecting to Ledger devices via USB, through [WebHID](https://developer.mozilla.org/en-US/docs/Web/API/WebHID_API).
+- Observing the state of a connected device.
+- Sending custom APDU commands to Ledger devices.
+- Sending a set of pre-defined commands to Ledger devices.
+  - Get OS version
+  - Get app and version
+  - Open app
+  - Close app
+  - Get battery status
+
+> [!NOTE]  
+> At the moment we do not provide the possibility to distinguish two devices of the same model, via USB and to avoid connection to the same device twice.
+
+### Setting up the SDK
+
+The core package exposes an SDK builder `DeviceSdkBuilder` which will be used to initialise the SDK with your configuration.
+
+For now it allows you to add one or more custom loggers.
+
+In the following example, we add a console logger (`.addLogger(new ConsoleLogger())`). Then we build the SDK with `.build()`.
+
+**The returned object will be the entrypoint for all your interactions with the SDK.**
+
+The SDK should be built only once in your application runtime so keep a reference of this object somewhere.
+
+```ts
+import {
+  ConsoleLogger,
+  DeviceSdk,
+  DeviceSdkBuilder,
+} from "@ledgerhq/device-management-kit";
+
+export const sdk = new DeviceSdkBuilder()
+  .addLogger(new ConsoleLogger())
+  .build();
+```
+
+### Connecting to a Device
+
+There are two steps to connecting to a device:
+
+- **Discovery**: `sdk.startDiscovering()`
+  - Returns an observable which will emit a new `DiscoveredDevice` for every scanned device.
+  - The `DiscoveredDevice` objects contain information about the device model.
+  - Use one of these values to connect to a given discovered device.
+- **Connection**: `sdk.connect({ deviceId: device.id })`
+  - Returns a Promise resolving in a device session identifier `DeviceSessionId`.
+  - **Keep this device session identifier to further interact with the device.**
+  - Then, `sdk.getConnectedDevice({ sessionId })` returns the `ConnectedDevice`, which contains information about the device model and its name.
+
+```ts
+sdk.startDiscovering().subscribe({
+  next: (device) => {
+    sdk.connect({ deviceId: device.id }).then((sessionId) => {
+      const connectedDevice = sdk.getConnectedDevice({ sessionId });
+    });
+  },
+  error: (error) => {
+    console.error(error);
+  },
+});
+```
+
+Then once a device is connected:
+
+- **Disconnection**: `sdk.disconnect({ sessionId })`
+- **Observe the device session state**: `sdk.getDeviceSessionState({ sessionId })`
+  - This will return an `Observable<DeviceSessionState>` to listen to the known information about the device:
+    - device status:
+      - ready to process a command
+      - busy
+      - locked
+      - disconnected
+    - device name
+    - information on the OS
+    - battery status
+    - currently opened app
+
+### Sending an APDU
+
+Once you have a connected device, you can send it APDU commands.
+
+> ℹ️ It is recommended to use the [pre-defined commands](#sending-a-pre-defined-command) when possible, or [build your own command](#building-a-new-command), to avoid dealing with the APDU directly. It will make your code more reusable.
+
+```ts
+import {
+  ApduBuilder,
+  ApduParser,
+  CommandUtils,
+} from "@ledgerhq/device-management-kit";
+
+// ### 1. Building the APDU
+// Use `ApduBuilder` to easily build the APDU and add data to its data field.
+
+// Build the APDU to open the Bitcoin app
+const openAppApduArgs = {
+  cla: 0xe0,
+  ins: 0xd8,
+  p1: 0x00,
+  p2: 0x00,
+};
+const apdu = new ApduBuilder(openAppApduArgs)
+  .addAsciiStringToData("Bitcoin")
+  .build();
+
+// ### 2. Sending the APDU
+
+const apduResponse = await sdk.sendApdu({ sessionId, apdu });
+
+// ### 3. Parsing the result
+
+const parser = new ApduParser(apduResponse);
+
+if (!CommandUtils.isSuccessResponse(apduResponse)) {
+  throw new Error(
+    `Unexpected status word: ${parser.encodeToHexaString(
+      apduResponse.statusCode,
+    )}`,
+  );
+}
+```
+
+### Sending a Pre-defined Command
+
+There are some pre-defined commands that you can send to a connected device.
+
+The `sendCommand` method will take care of building the APDU, sending it to the device and returning the parsed response.
+
+> ### ❗️ Error Responses
+>
+> Most of the commands will reject with an error if the device is locked.
+> Ensure that the device is unlocked before sending commands. You can check the device session state (`sdk.getDeviceSessionState`) to know if the device is locked.
+>
+> Most of the commands will reject with an error if the response status word is not `0x9000` (success response from the device).
+
+#### Open App
+
+This command will open the app with the given name. If the device is unlocked, it will not resolve/reject until the user has confirmed or denied the app opening on the device.
+
+```ts
+import { OpenAppCommand } from "@ledgerhq/device-management-kit";
+
+const command = new OpenAppCommand("Bitcoin"); // Open the Bitcoin app
+
+await sdk.sendCommand({ sessionId, command });
+```
+
+#### Close App
+
+This command will close the currently opened app.
+
+```ts
+import { CloseAppCommand } from "@ledgerhq/device-management-kit";
+
+const command = new CloseAppCommand();
+
+await sdk.sendCommand({ sessionId, command });
+```
+
+#### Get OS Version
+
+This command will return information about the currently installed OS on the device.
+
+> ℹ️ If you want this information you can simply get it from the device session state by observing it with `sdk.getDeviceSessionState({ sessionId })`.
+
+```ts
+import { GetOsVersionCommand } from "@ledgerhq/device-management-kit";
+
+const command = new GetOsVersionCommand();
+
+const { seVersion, mcuSephVersion, mcuBootloaderVersion } =
+  await sdk.sendCommand({ sessionId, command });
+```
+
+#### Get App and Version
+
+This command will return the name and version of the currently running app on the device.
+
+> ℹ️ If you want this information you can simply get it from the device session state by observing it with `sdk.getDeviceSessionState({ sessionId })`.
+
+```ts
+import { GetAppAndVersionCommand } from "@ledgerhq/device-management-kit";
+
+const command = new GetAppAndVersionCommand();
+
+const { name, version } = await sdk.sendCommand({ sessionId, command });
+```
+
+### Building a Custom Command
+
+You can build your own command simply by extending the `Command` class and implementing the `getApdu` and `parseResponse` methods.
+
+Then you can use the `sendCommand` method to send it to a connected device.
+
+This is strongly recommended over direct usage of `sendApdu`.
+
+Check the existing commands for a variety of examples.
+
+### Executing a device action
+
+Device actions define a succession of commands to be sent to the device.
+
+They are useful for actions that require user interaction, like opening an app,
+or approving a transaction.
+
+The result of a device action execution is an observable that will emit different states of the action execution. These states contain information about the current status of the action, some intermediate values like the user action required, and the final result.
+
+#### Open App Device Action
+
+```ts
+import {
+  OpenAppDeviceAction,
+  OpenAppDAState,
+} from "@ledgerhq/device-management-kit";
+
+const openAppDeviceAction = new OpenAppDeviceAction({ appName: "Bitcoin" });
+
+const { observable, cancel } = await sdk.executeDeviceAction({
+  deviceAction: openAppDeviceAction,
+  command,
+});
+
+observable.subscribe({
+  next: (state: OpenAppDAState) => {
+    switch (state.status) {
+      case DeviceActionStatus.NotStarted:
+        console.log("Action not started yet");
+        break;
+      case DeviceActionStatus.Pending:
+        const {
+          intermediateValue: { userActionRequired },
+        } = state;
+        switch (userActionRequired) {
+          case UserActionRequiredType.None:
+            console.log("No user action required");
+            break;
+          case UserActionRequiredType.ConfirmOpenApp:
+            console.log(
+              "The user should confirm the app opening on the device",
+            );
+            break;
+          case UserActionRequiredType.UnlockDevice:
+            console.log("The user should unlock the device");
+            break;
+          default:
+            /**
+             * you should make sure that you handle all the possible user action
+             * required types by displaying them to the user.
+             */
+            throw new Exception("Unhandled user action required");
+            break;
+        }
+        console.log("Action is pending");
+        break;
+      case DeviceActionStatus.Stopped:
+        console.log("Action has been stopped");
+        break;
+      case DeviceActionStatus.Completed:
+        const { output } = state;
+        console.log("Action has been completed", output);
+        break;
+      case DeviceActionStatus.Error:
+        const { error } = state;
+        console.log("An error occurred during the action", error);
+        break;
+    }
+  },
+});
+```
+
+### Example in React
+
+Check [the sample app](https://github.com/LedgerHQ/device-sdk-ts/tree/develop/apps/sample) for an advanced example showcasing all possible usages of the Device Management Kit in a React app.

package/lib/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./src";
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC"}

package/lib/cjs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src"), exports);
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB"}

package/lib/cjs/package.json

@@ -0,0 +1,66 @@
+{
+    "name": "@ledgerhq/device-management-kit",
+    "version": "0.3.0",
+    "license": "MIT",
+    "exports": {
+        ".": {
+            "import": "./lib/esm/index.js",
+            "require": "./lib/cjs/index.js",
+            "default": "./index.ts",
+            "types": "./lib/esm/index.d.ts"
+        },
+        "./*.js": {
+            "import": "./lib/esm/*.js",
+            "require": "./lib/cjs/*.js",
+            "default": "./*.js",
+            "types": "./lib/esm/*.d.ts"
+        },
+        "./*": {
+            "import": "./lib/esm/*",
+            "require": "./lib/cjs/*",
+            "default": "./*",
+            "types": "./lib/esm/*"
+        }
+    },
+    "files": [
+        "./lib"
+    ],
+    "scripts": {
+        "build": "rimraf lib && zx scripts/build.mjs",
+        "dev": "concurrently \"pnpm dev:esm\" \"pnpm dev:cjs\"",
+        "dev:esm": "concurrently \"tsc --watch -p tsconfig.esm.json\" \"tsc-alias --watch -p tsconfig.esm.json\"",
+        "dev:cjs": "concurrently \"tsc --watch -p tsconfig.cjs.json\" \"tsc-alias --watch -p tsconfig.cjs.json\"",
+        "lint": "eslint",
+        "lint:fix": "pnpm lint --fix",
+        "prettier": "prettier . --check",
+        "prettier:fix": "prettier . --write",
+        "test": "jest",
+        "test:watch": "pnpm test -- --watch",
+        "test:coverage": "pnpm test -- --coverage",
+        "typecheck": "tsc --noEmit",
+        "module:create": "pnpm hygen core-module with-prompt"
+    },
+    "dependencies": {
+        "@sentry/minimal": "^6.19.7",
+        "@statelyai/inspect": "^0.4.0",
+        "axios": "^1.7.7",
+        "inversify": "^6.0.2",
+        "inversify-logger-middleware": "^3.1.0",
+        "purify-ts": "^2.1.0",
+        "reflect-metadata": "^0.2.2",
+        "rxjs": "^7.8.1",
+        "semver": "^7.6.3",
+        "uuid": "^10.0.0",
+        "xstate": "^5.18.1"
+    },
+    "devDependencies": {
+        "@ledgerhq/eslint-config-dsdk": "workspace:*",
+        "@ledgerhq/jest-config-dsdk": "workspace:*",
+        "@ledgerhq/prettier-config-dsdk": "workspace:*",
+        "@ledgerhq/tsconfig-dsdk": "workspace:*",
+        "@types/semver": "^7.5.8",
+        "@types/uuid": "^10.0.0",
+        "@types/w3c-web-hid": "^1.0.6",
+        "ts-node": "^10.9.2"
+    }
+}

package/lib/cjs/src/api/DeviceSdk.d.ts

@@ -0,0 +1,94 @@
+import { Container } from "inversify";
+import { Observable } from "rxjs";
+import { CommandResult } from "./command/model/CommandResult";
+import { SendCommandUseCaseArgs } from "./command/use-case/SendCommandUseCase";
+import { ExecuteDeviceActionUseCaseArgs } from "./device-action/use-case/ExecuteDeviceActionUseCase";
+import { ApduResponse } from "./device-session/ApduResponse";
+import { DeviceSessionState } from "./device-session/DeviceSessionState";
+import { DeviceSessionId } from "./device-session/types";
+import { ConnectUseCaseArgs, DisconnectUseCaseArgs, DiscoveredDevice, SendApduUseCaseArgs } from "./types";
+import { ConnectedDevice } from "./usb/model/ConnectedDevice";
+import { DeviceSession } from "../internal/device-session/model/DeviceSession";
+import { GetConnectedDeviceUseCaseArgs } from "../internal/usb/use-case/GetConnectedDeviceUseCase";
+import { DeviceActionIntermediateValue, ExecuteDeviceActionReturnType } from "./device-action/DeviceAction";
+import { SdkError } from "./Error";
+/**
+ * The main class to interact with the SDK.
+ *
+ * NB: do not instantiate this class directly, instead, use `DeviceSdkBuilder`.
+ */
+export declare class DeviceSdk {
+    readonly container: Container;
+    /**
+     * Returns a promise resolving to the version of the SDK.
+     */
+    getVersion(): Promise<string>;
+    /**
+     * Starts discovering devices connected via USB HID (BLE not implemented yet).
+     *
+     * For the WeHID implementation, this use-case needs to be called as a result
+     * of an user interaction (button "click" event for ex).
+     *
+     * @returns {Observable<DiscoveredDevice>} An observable of discovered devices.
+     */
+    startDiscovering(): Observable<DiscoveredDevice>;
+    /**
+     * Stops discovering devices connected via USB HID (and later BLE).
+     */
+    stopDiscovering(): void;
+    /**
+     * Connects to a device previously discovered with `DeviceSdk.startDiscovering`.
+     * Creates a new device session which:
+     * - Represents the connection to the device.
+     * - Is terminated upon disconnection of the device.
+     * - Exposes the device state through an observable (see `DeviceSdk.getDeviceSessionState`)
+     * - Should be used for all subsequent communication with the device.
+     *
+     * @param {ConnectUseCaseArgs} args - The device ID (obtained in discovery) to connect to.
+     * @returns The session ID to use for further communication with the device.
+     */
+    connect(args: ConnectUseCaseArgs): Promise<DeviceSessionId>;
+    /**
+     * Disconnects to a discovered device via USB HID (and later BLE).
+     *
+     * @param {DisconnectUseCaseArgs} args - The session ID to disconnect.
+     */
+    disconnect(args: DisconnectUseCaseArgs): Promise<void>;
+    /**
+     * Sends an APDU command to a device through a device session.
+     *
+     * @param {SendApduUseCaseArgs} args - The device session ID and APDU command to send.
+     */
+    sendApdu(args: SendApduUseCaseArgs): Promise<ApduResponse>;
+    /**
+     * Sends a command to a device through a device session.
+     *
+     * @param {SendCommandUseCaseArgs<Response, Args, ErrorCodes>} args - The device session ID, command, command error codes and command parameters to send.
+     * @returns A promise resolving with the response from the command.
+     */
+    sendCommand<Response, Args, ErrorCodes>(args: SendCommandUseCaseArgs<Response, Args, ErrorCodes>): Promise<CommandResult<Response, ErrorCodes>>;
+    executeDeviceAction<Output, Input, Error extends SdkError, IntermediateValue extends DeviceActionIntermediateValue>(args: ExecuteDeviceActionUseCaseArgs<Output, Input, Error, IntermediateValue>): ExecuteDeviceActionReturnType<Output, Error, IntermediateValue>;
+    /**
+     * Gets the connected from its device session ID.
+     *
+     * @param {GetConnectedDeviceUseCaseArgs} args - The device session ID.
+     * @returns {ConnectedDevice} The connected device.
+     */
+    getConnectedDevice(args: GetConnectedDeviceUseCaseArgs): ConnectedDevice;
+    /**
+     * Gets the device state of a session.
+     *
+     * @param {{DeviceSessionId}} args - The device session ID.
+     * @returns {Observable<DeviceSessionState>} An observable of the session device state.
+     */
+    getDeviceSessionState(args: {
+        sessionId: DeviceSessionId;
+    }): Observable<DeviceSessionState>;
+    /**
+     * Lists all device sessions.
+     *
+     * @returns {DeviceSession[]} The list of device sessions.
+     */
+    listDeviceSessions(): DeviceSession[];
+}
+//# sourceMappingURL=DeviceSdk.d.ts.map

package/lib/cjs/src/api/DeviceSdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceSdk.d.ts","sourceRoot":"","sources":["../../../../src/api/DeviceSdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAGlC,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAEL,sBAAsB,EACvB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAEL,8BAA8B,EAC/B,MAAM,wDAAwD,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EACL,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAIjE,OAAO,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAW7E,OAAO,EAEL,6BAA6B,EAC9B,MAAM,kDAAkD,CAAC;AAG1D,OAAO,EACL,6BAA6B,EAC7B,6BAA6B,EAC9B,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC;;;;GAIG;AACH,qBAAa,SAAS;IACpB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAS9B;;OAEG;IACH,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAM7B;;;;;;;OAOG;IACH,gBAAgB,IAAI,UAAU,CAAC,gBAAgB,CAAC;IAMhD;;OAEG;IACH,eAAe;IAMf;;;;;;;;;;OAUG;IACH,OAAO,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;IAM3D;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMtD;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC;IAM1D;;;;;OAKG;IACH,WAAW,CAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,EACpC,IAAI,EAAE,sBAAsB,CAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,CAAC,GACvD,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAM/C,mBAAmB,CACjB,MAAM,EACN,KAAK,EACL,KAAK,SAAS,QAAQ,EACtB,iBAAiB,SAAS,6BAA6B,EAEvD,IAAI,EAAE,8BAA8B,CAClC,MAAM,EACN,KAAK,EACL,KAAK,EACL,iBAAiB,CAClB,GACA,6BAA6B,CAAC,MAAM,EAAE,KAAK,EAAE,iBAAiB,CAAC;IAQlE;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,EAAE,6BAA6B,GAAG,eAAe;IAMxE;;;;;OAKG;IACH,qBAAqB,CAAC,IAAI,EAAE;QAC1B,SAAS,EAAE,eAAe,CAAC;KAC5B,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAQlC;;;;OAIG;IACH,kBAAkB,IAAI,aAAa,EAAE;CAOtC"}

package/lib/cjs/src/api/DeviceSdk.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceSdk = void 0;
+const commandTypes_1 = require("./command/di/commandTypes");
+const configTypes_1 = require("../internal/config/di/configTypes");
+const deviceSessionTypes_1 = require("../internal/device-session/di/deviceSessionTypes");
+const discoveryTypes_1 = require("../internal/discovery/di/discoveryTypes");
+const sendTypes_1 = require("../internal/send/di/sendTypes");
+const usbDiTypes_1 = require("../internal/usb/di/usbDiTypes");
+const di_1 = require("../../src/di");
+const deviceActionTypes_1 = require("./device-action/di/deviceActionTypes");
+/**
+ * The main class to interact with the SDK.
+ *
+ * NB: do not instantiate this class directly, instead, use `DeviceSdkBuilder`.
+ */
+class DeviceSdk {
+    container;
+    /** @internal */
+    constructor({ stub, loggers, config }) {
+        // NOTE: MakeContainerProps might not be the exact type here
+        // For the init of the project this is sufficient, but we might need to
+        // update the constructor arguments as we go (we might have more than just the container config)
+        this.container = (0, di_1.makeContainer)({ stub, loggers, config });
+    }
+    /**
+     * Returns a promise resolving to the version of the SDK.
+     */
+    getVersion() {
+        return this.container
+            .get(configTypes_1.configTypes.GetSdkVersionUseCase)
+            .getSdkVersion();
+    }
+    /**
+     * Starts discovering devices connected via USB HID (BLE not implemented yet).
+     *
+     * For the WeHID implementation, this use-case needs to be called as a result
+     * of an user interaction (button "click" event for ex).
+     *
+     * @returns {Observable<DiscoveredDevice>} An observable of discovered devices.
+     */
+    startDiscovering() {
+        return this.container
+            .get(discoveryTypes_1.discoveryTypes.StartDiscoveringUseCase)
+            .execute();
+    }
+    /**
+     * Stops discovering devices connected via USB HID (and later BLE).
+     */
+    stopDiscovering() {
+        return this.container
+            .get(discoveryTypes_1.discoveryTypes.StopDiscoveringUseCase)
+            .execute();
+    }
+    /**
+     * Connects to a device previously discovered with `DeviceSdk.startDiscovering`.
+     * Creates a new device session which:
+     * - Represents the connection to the device.
+     * - Is terminated upon disconnection of the device.
+     * - Exposes the device state through an observable (see `DeviceSdk.getDeviceSessionState`)
+     * - Should be used for all subsequent communication with the device.
+     *
+     * @param {ConnectUseCaseArgs} args - The device ID (obtained in discovery) to connect to.
+     * @returns The session ID to use for further communication with the device.
+     */
+    connect(args) {
+        return this.container
+            .get(discoveryTypes_1.discoveryTypes.ConnectUseCase)
+            .execute(args);
+    }
+    /**
+     * Disconnects to a discovered device via USB HID (and later BLE).
+     *
+     * @param {DisconnectUseCaseArgs} args - The session ID to disconnect.
+     */
+    disconnect(args) {
+        return this.container
+            .get(discoveryTypes_1.discoveryTypes.DisconnectUseCase)
+            .execute(args);
+    }
+    /**
+     * Sends an APDU command to a device through a device session.
+     *
+     * @param {SendApduUseCaseArgs} args - The device session ID and APDU command to send.
+     */
+    sendApdu(args) {
+        return this.container
+            .get(sendTypes_1.sendTypes.SendApduUseCase)
+            .execute(args);
+    }
+    /**
+     * Sends a command to a device through a device session.
+     *
+     * @param {SendCommandUseCaseArgs<Response, Args, ErrorCodes>} args - The device session ID, command, command error codes and command parameters to send.
+     * @returns A promise resolving with the response from the command.
+     */
+    sendCommand(args) {
+        return this.container
+            .get(commandTypes_1.commandTypes.SendCommandUseCase)
+            .execute(args);
+    }
+    executeDeviceAction(args) {
+        return this.container
+            .get(deviceActionTypes_1.deviceActionTypes.ExecuteDeviceActionUseCase)
+            .execute(args);
+    }
+    /**
+     * Gets the connected from its device session ID.
+     *
+     * @param {GetConnectedDeviceUseCaseArgs} args - The device session ID.
+     * @returns {ConnectedDevice} The connected device.
+     */
+    getConnectedDevice(args) {
+        return this.container
+            .get(usbDiTypes_1.usbDiTypes.GetConnectedDeviceUseCase)
+            .execute(args);
+    }
+    /**
+     * Gets the device state of a session.
+     *
+     * @param {{DeviceSessionId}} args - The device session ID.
+     * @returns {Observable<DeviceSessionState>} An observable of the session device state.
+     */
+    getDeviceSessionState(args) {
+        return this.container
+            .get(deviceSessionTypes_1.deviceSessionTypes.GetDeviceSessionStateUseCase)
+            .execute(args);
+    }
+    /**
+     * Lists all device sessions.
+     *
+     * @returns {DeviceSession[]} The list of device sessions.
+     */
+    listDeviceSessions() {
+        return this.container
+            .get(deviceSessionTypes_1.deviceSessionTypes.ListDeviceSessionsUseCase)
+            .execute();
+    }
+}
+exports.DeviceSdk = DeviceSdk;
+//# sourceMappingURL=DeviceSdk.js.map

package/lib/cjs/src/api/DeviceSdk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceSdk.js","sourceRoot":"","sources":["../../../../src/api/DeviceSdk.ts"],"names":[],"mappings":";;;AAGA,+DAA4D;AAoB5D,iEAA8D;AAE9D,uFAAoF;AAIpF,0EAAuE;AAKvE,2DAAwD;AAExD,4DAAyD;AAKzD,qCAAiE;AAMjE,4EAAyE;AAGzE;;;;GAIG;AACH,MAAa,SAAS;IACX,SAAS,CAAY;IAC9B,gBAAgB;IAChB,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAsB;QACvD,4DAA4D;QAC5D,uEAAuE;QACvE,gGAAgG;QAChG,IAAI,CAAC,SAAS,GAAG,IAAA,kBAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CAAuB,yBAAW,CAAC,oBAAoB,CAAC;aAC3D,aAAa,EAAE,CAAC;IACrB,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CAA0B,+BAAc,CAAC,uBAAuB,CAAC;aACpE,OAAO,EAAE,CAAC;IACf,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CAAyB,+BAAc,CAAC,sBAAsB,CAAC;aAClE,OAAO,EAAE,CAAC;IACf,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,IAAwB;QAC9B,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CAAiB,+BAAc,CAAC,cAAc,CAAC;aAClD,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,IAA2B;QACpC,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CAAoB,+BAAc,CAAC,iBAAiB,CAAC;aACxD,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,IAAyB;QAChC,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CAAkB,qBAAS,CAAC,eAAe,CAAC;aAC/C,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,WAAW,CACT,IAAwD;QAExD,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CAAqB,2BAAY,CAAC,kBAAkB,CAAC;aACxD,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED,mBAAmB,CAMjB,IAKC;QAED,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CACF,qCAAiB,CAAC,0BAA0B,CAC7C;aACA,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,IAAmC;QACpD,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CAA4B,uBAAU,CAAC,yBAAyB,CAAC;aACpE,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAC,IAErB;QACC,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CACF,uCAAkB,CAAC,4BAA4B,CAChD;aACA,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CACF,uCAAkB,CAAC,yBAAyB,CAC7C;aACA,OAAO,EAAE,CAAC;IACf,CAAC;CACF;AA3JD,8BA2JC"}