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

package/lib/esm/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/esm/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/esm/src/api/DeviceSdk.js

@@ -0,0 +1,137 @@
+import { commandTypes } from "./command/di/commandTypes";
+import { configTypes } from "../internal/config/di/configTypes";
+import { deviceSessionTypes } from "../internal/device-session/di/deviceSessionTypes";
+import { discoveryTypes } from "../internal/discovery/di/discoveryTypes";
+import { sendTypes } from "../internal/send/di/sendTypes";
+import { usbDiTypes } from "../internal/usb/di/usbDiTypes";
+import { makeContainer } from "../../src/di";
+import { deviceActionTypes } from "./device-action/di/deviceActionTypes";
+/**
+ * The main class to interact with the SDK.
+ *
+ * NB: do not instantiate this class directly, instead, use `DeviceSdkBuilder`.
+ */
+export 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 = makeContainer({ stub, loggers, config });
+    }
+    /**
+     * Returns a promise resolving to the version of the SDK.
+     */
+    getVersion() {
+        return this.container
+            .get(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.StartDiscoveringUseCase)
+            .execute();
+    }
+    /**
+     * Stops discovering devices connected via USB HID (and later BLE).
+     */
+    stopDiscovering() {
+        return this.container
+            .get(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.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.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.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.SendCommandUseCase)
+            .execute(args);
+    }
+    executeDeviceAction(args) {
+        return this.container
+            .get(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.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.GetDeviceSessionStateUseCase)
+            .execute(args);
+    }
+    /**
+     * Lists all device sessions.
+     *
+     * @returns {DeviceSession[]} The list of device sessions.
+     */
+    listDeviceSessions() {
+        return this.container
+            .get(deviceSessionTypes.ListDeviceSessionsUseCase)
+            .execute();
+    }
+}
+//# sourceMappingURL=DeviceSdk.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceSdk.js","sourceRoot":"","sources":["../../../../src/api/DeviceSdk.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAoB5D,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AAIpF,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AAKvE,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAExD,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAKzD,OAAO,EAAE,aAAa,EAAsB,MAAM,cAAc,CAAC;AAMjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AAGzE;;;;GAIG;AACH,MAAM,OAAO,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,aAAa,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CAAuB,WAAW,CAAC,oBAAoB,CAAC;aAC3D,aAAa,EAAE,CAAC;IACrB,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CAA0B,cAAc,CAAC,uBAAuB,CAAC;aACpE,OAAO,EAAE,CAAC;IACf,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CAAyB,cAAc,CAAC,sBAAsB,CAAC;aAClE,OAAO,EAAE,CAAC;IACf,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,IAAwB;QAC9B,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CAAiB,cAAc,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,cAAc,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,SAAS,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,YAAY,CAAC,kBAAkB,CAAC;aACxD,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED,mBAAmB,CAMjB,IAKC;QAED,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CACF,iBAAiB,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,UAAU,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,kBAAkB,CAAC,4BAA4B,CAChD;aACA,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,SAAS;aAClB,GAAG,CACF,kBAAkB,CAAC,yBAAyB,CAC7C;aACA,OAAO,EAAE,CAAC;IACf,CAAC;CACF"}

package/lib/esm/src/api/DeviceSdkBuilder.d.ts

@@ -0,0 +1,27 @@
+import { LoggerSubscriberService } from "./logger-subscriber/service/LoggerSubscriberService";
+import { DeviceSdk } from "./DeviceSdk";
+import { SdkConfig } from "./SdkConfig";
+/**
+ * Builder for the `DeviceSdk` class.
+ *
+ * @example
+ * ```
+ * const sdk = new LedgerDeviceSdkBuilder()
+ *  .setStub(false)
+ *  .addLogger(myLogger)
+ *  .build();
+ * ```
+ */
+export declare class LedgerDeviceSdkBuilder {
+    private stub;
+    private readonly loggers;
+    private config;
+    build(): DeviceSdk;
+    setStub(stubbed: boolean): LedgerDeviceSdkBuilder;
+    /**
+     * Add a logger to the SDK that will receive its logs
+     */
+    addLogger(logger: LoggerSubscriberService): LedgerDeviceSdkBuilder;
+    addConfig(config: SdkConfig): LedgerDeviceSdkBuilder;
+}
+//# sourceMappingURL=DeviceSdkBuilder.d.ts.map

package/lib/esm/src/api/DeviceSdkBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceSdkBuilder.d.ts","sourceRoot":"","sources":["../../../../src/api/DeviceSdkBuilder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,uBAAuB,EAAE,MAAM,qDAAqD,CAAC;AAC9F,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;;;;GAUG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiC;IACzD,OAAO,CAAC,MAAM,CAEZ;IAEF,KAAK,IAAI,SAAS;IAQlB,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,sBAAsB;IAKjD;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,uBAAuB,GAAG,sBAAsB;IAKlE,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,sBAAsB;CAOrD"}

package/lib/esm/src/api/DeviceSdkBuilder.js

@@ -0,0 +1,46 @@
+import { DEFAULT_MANAGER_API_BASE_URL } from "../internal/manager-api/model/Const";
+import { DeviceSdk } from "./DeviceSdk";
+/**
+ * Builder for the `DeviceSdk` class.
+ *
+ * @example
+ * ```
+ * const sdk = new LedgerDeviceSdkBuilder()
+ *  .setStub(false)
+ *  .addLogger(myLogger)
+ *  .build();
+ * ```
+ */
+export class LedgerDeviceSdkBuilder {
+    stub = false;
+    loggers = [];
+    config = {
+        managerApiUrl: DEFAULT_MANAGER_API_BASE_URL,
+    };
+    build() {
+        return new DeviceSdk({
+            stub: this.stub,
+            loggers: this.loggers,
+            config: this.config,
+        });
+    }
+    setStub(stubbed) {
+        this.stub = stubbed;
+        return this;
+    }
+    /**
+     * Add a logger to the SDK that will receive its logs
+     */
+    addLogger(logger) {
+        this.loggers.push(logger);
+        return this;
+    }
+    addConfig(config) {
+        this.config = {
+            ...this.config,
+            ...config,
+        };
+        return this;
+    }
+}
+//# sourceMappingURL=DeviceSdkBuilder.js.map

package/lib/esm/src/api/DeviceSdkBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceSdkBuilder.js","sourceRoot":"","sources":["../../../../src/api/DeviceSdkBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AAGjF,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;;;;;;;;;GAUG;AACH,MAAM,OAAO,sBAAsB;IACzB,IAAI,GAAG,KAAK,CAAC;IACJ,OAAO,GAA8B,EAAE,CAAC;IACjD,MAAM,GAAc;QAC1B,aAAa,EAAE,4BAA4B;KAC5C,CAAC;IAEF,KAAK;QACH,OAAO,IAAI,SAAS,CAAC;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,OAAgB;QACtB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,MAA+B;QACvC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,MAAiB;QACzB,IAAI,CAAC,MAAM,GAAG;YACZ,GAAG,IAAI,CAAC,MAAM;YACd,GAAG,MAAM;SACV,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/lib/esm/src/api/Error.d.ts

@@ -0,0 +1,26 @@
+export interface SdkError {
+    readonly _tag: string;
+    readonly originalError?: unknown;
+    message?: string;
+}
+export type DeviceExchangeErrorArgs<SpecificErrorCodes> = {
+    tag: string;
+    originalError?: unknown;
+    errorCode: SpecificErrorCodes;
+    message: string;
+};
+export type CommandErrorArgs<SpecificErrorCodes> = Omit<DeviceExchangeErrorArgs<SpecificErrorCodes>, "tag">;
+export declare abstract class DeviceExchangeError<SpecificErrorCodes = void> {
+    readonly _tag: string;
+    readonly originalError?: unknown;
+    readonly errorCode: SpecificErrorCodes;
+    readonly message: string;
+    protected constructor({ tag, errorCode, originalError, message, }: DeviceExchangeErrorArgs<SpecificErrorCodes>);
+}
+export declare class UnknownDeviceExchangeError implements SdkError {
+    readonly _tag = "UnknownDeviceExchangeError";
+    readonly originalError?: unknown;
+    readonly message: string;
+    constructor(originalError?: unknown);
+}
+//# sourceMappingURL=Error.d.ts.map

package/lib/esm/src/api/Error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../../../src/api/Error.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,uBAAuB,CAAC,kBAAkB,IAAI;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAAC,kBAAkB,IAAI,IAAI,CACrD,uBAAuB,CAAC,kBAAkB,CAAC,EAC3C,KAAK,CACN,CAAC;AAEF,8BAAsB,mBAAmB,CAAC,kBAAkB,GAAG,IAAI;IACjE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,SAAS,aAAa,EACpB,GAAG,EACH,SAAS,EACT,aAAa,EACb,OAAO,GACR,EAAE,uBAAuB,CAAC,kBAAkB,CAAC;CAM/C;AAED,qBAAa,0BAA2B,YAAW,QAAQ;IACzD,QAAQ,CAAC,IAAI,gCAAgC;IAC7C,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;gBAEb,aAAa,CAAC,EAAE,OAAO;CAIpC"}

package/lib/esm/src/api/Error.js

@@ -0,0 +1,22 @@
+export class DeviceExchangeError {
+    _tag;
+    originalError;
+    errorCode;
+    message;
+    constructor({ tag, errorCode, originalError, message, }) {
+        this._tag = tag;
+        this.originalError = originalError;
+        this.errorCode = errorCode;
+        this.message = message;
+    }
+}
+export class UnknownDeviceExchangeError {
+    _tag = "UnknownDeviceExchangeError";
+    originalError;
+    message;
+    constructor(originalError) {
+        this.originalError = originalError;
+        this.message = "Unexpected device exchange error happened.";
+    }
+}
+//# sourceMappingURL=Error.js.map

package/lib/esm/src/api/Error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Error.js","sourceRoot":"","sources":["../../../../src/api/Error.ts"],"names":[],"mappings":"AAkBA,MAAM,OAAgB,mBAAmB;IAC9B,IAAI,CAAS;IACb,aAAa,CAAW;IACxB,SAAS,CAAqB;IAC9B,OAAO,CAAS;IAEzB,YAAsB,EACpB,GAAG,EACH,SAAS,EACT,aAAa,EACb,OAAO,GACqC;QAC5C,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,MAAM,OAAO,0BAA0B;IAC5B,IAAI,GAAG,4BAA4B,CAAC;IACpC,aAAa,CAAW;IACxB,OAAO,CAAS;IAEzB,YAAY,aAAuB;QACjC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,4CAA4C,CAAC;IAC9D,CAAC;CACF"}

package/lib/esm/src/api/SdkConfig.d.ts

@@ -0,0 +1,4 @@
+export type SdkConfig = {
+    managerApiUrl: string;
+};
+//# sourceMappingURL=SdkConfig.d.ts.map

package/lib/esm/src/api/SdkConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SdkConfig.d.ts","sourceRoot":"","sources":["../../../../src/api/SdkConfig.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG;IACtB,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC"}

package/lib/esm/src/api/SdkConfig.js

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

package/lib/esm/src/api/SdkConfig.js.map

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

package/lib/esm/src/api/apdu/model/Apdu.d.ts

@@ -0,0 +1,33 @@
+/**
+ * An APDU command that can be sent to a device.
+ * DO NOT USE THIS CLASS DIRECTLY, use ApduBuilder instead.
+ */
+export declare class Apdu {
+    /**
+     * Instruction class (1 byte)
+     */
+    readonly cla: number;
+    /**
+     * Instruction code (1 byte)
+     */
+    readonly ins: number;
+    /**
+     * Instruction parameter 1 (2 bytes)
+     */
+    readonly p1: number;
+    /**
+     * Instruction parameter 2 (2 bytes)
+     */
+    readonly p2: number;
+    /**
+     * Bytes of data
+     */
+    readonly data: Uint8Array;
+    constructor(cla: number, ins: number, p1: number, p2: number, data?: Uint8Array);
+    /**
+     * Get the raw binary data of the APDU command
+     * @returns {Uint8Array} - The raw APDU command
+     */
+    getRawApdu(): Uint8Array;
+}
+//# sourceMappingURL=Apdu.d.ts.map

package/lib/esm/src/api/apdu/model/Apdu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Apdu.d.ts","sourceRoot":"","sources":["../../../../../../src/api/apdu/model/Apdu.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,qBAAa,IAAI;IACf;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;gBAGxB,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,MAAM,EACV,IAAI,CAAC,EAAE,UAAU;IASnB;;;OAGG;IACH,UAAU,IAAI,UAAU;CAkBzB"}

package/lib/esm/src/api/apdu/model/Apdu.js

@@ -0,0 +1,53 @@
+/**
+ * An APDU command that can be sent to a device.
+ * DO NOT USE THIS CLASS DIRECTLY, use ApduBuilder instead.
+ */
+export class Apdu {
+    /**
+     * Instruction class (1 byte)
+     */
+    cla;
+    /**
+     * Instruction code (1 byte)
+     */
+    ins;
+    /**
+     * Instruction parameter 1 (2 bytes)
+     */
+    p1;
+    /**
+     * Instruction parameter 2 (2 bytes)
+     */
+    p2;
+    /**
+     * Bytes of data
+     */
+    data;
+    constructor(cla, ins, p1, p2, data) {
+        this.cla = cla;
+        this.ins = ins;
+        this.p1 = p1;
+        this.p2 = p2;
+        this.data = data ?? new Uint8Array();
+    }
+    /**
+     * Get the raw binary data of the APDU command
+     * @returns {Uint8Array} - The raw APDU command
+     */
+    getRawApdu() {
+        const header = Uint8Array.from([
+            this.cla,
+            this.ins,
+            this.p1,
+            this.p2,
+            this.data.length,
+        ]);
+        const apdu = new Uint8Array(header.length + this.data.length);
+        apdu.set(header, 0);
+        if (this.data.length > 0) {
+            apdu.set(this.data, header.length);
+        }
+        return apdu;
+    }
+}
+//# sourceMappingURL=Apdu.js.map

package/lib/esm/src/api/apdu/model/Apdu.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Apdu.js","sourceRoot":"","sources":["../../../../../../src/api/apdu/model/Apdu.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,OAAO,IAAI;IACf;;OAEG;IACM,GAAG,CAAS;IAErB;;OAEG;IACM,GAAG,CAAS;IAErB;;OAEG;IACM,EAAE,CAAS;IAEpB;;OAEG;IACM,EAAE,CAAS;IAEpB;;OAEG;IACM,IAAI,CAAa;IAE1B,YACE,GAAW,EACX,GAAW,EACX,EAAU,EACV,EAAU,EACV,IAAiB;QAEjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,IAAI,UAAU,EAAE,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC;YAC7B,IAAI,CAAC,GAAG;YACR,IAAI,CAAC,GAAG;YACR,IAAI,CAAC,EAAE;YACP,IAAI,CAAC,EAAE;YACP,IAAI,CAAC,IAAI,CAAC,MAAM;SACjB,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9D,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAEpB,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/lib/esm/src/api/apdu/utils/ApduBuilder.d.ts

@@ -0,0 +1,113 @@
+import { Apdu } from "../../apdu/model/Apdu";
+import { AppBuilderError } from "./AppBuilderError";
+export declare const HEADER_LENGTH = 5;
+export declare const APDU_MAX_PAYLOAD = 255;
+export declare const APDU_MAX_SIZE: number;
+export type ApduBuilderArgs = {
+    readonly ins: number;
+    readonly cla: number;
+    readonly p1: number;
+    readonly p2: number;
+};
+/**
+ * ApduBuilder is a utility class to help build APDU commands.
+ * It allows to easily add data to the data field of the APDU command
+ * and to encode this data in different formats.
+ *
+ * @example
+ * ```
+ * const apduBuilder = new ApduBuilder({ ins: 0x01, cla: 0x02, p1: 0x03, p2: 0x04 })
+ *  .add8BitUIntToData(0x05)
+ *  .add16BitUIntToData(0x0607)
+ *  .addHexaStringToData("0x0809")
+ *  .addAsciiStringToData("hello")
+ *
+ * const apdu = apduBuilder.build();
+ * const builderErrors = apduBuilder.getErrors();
+ * ```
+ */
+export declare class ApduBuilder {
+    private readonly _ins;
+    private readonly _cla;
+    private readonly _p1;
+    private readonly p2;
+    private data;
+    constructor({ ins, cla, p1, p2 }: ApduBuilderArgs);
+    /**
+     * Build a new Apdu instance with the current state of the builder
+     * @returns {Apdu} - Returns a new Apdu instance
+     */
+    build: () => Apdu;
+    /**
+     * Add a 8-bit unsigned integer to the data field (max value 0xff = 255)
+     * @param value?: number - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    add8BitUIntToData: (value: number) => ApduBuilder;
+    /**
+     * Add a 16-bit unsigned integer to the data field (max value 0xffff = 65535)
+     * @param value: number - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    add16BitUIntToData: (value: number) => ApduBuilder;
+    /**
+     * Add a 32-bit unsigned integer to the data field (max value 0xffffffff = 4294967295)
+     * @param value: number - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    add32BitUIntToData: (value: number) => ApduBuilder;
+    /**
+     * Add a Uint8Array to the data field if it has enough remaining space
+     * @param value: Uint8Array - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    addBufferToData: (value: Uint8Array) => ApduBuilder;
+    /**
+     * Add a string to the data field if it has enough remaining space
+     * and it can be formatted as a hexadecimal string
+     * @param value: string - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    addHexaStringToData: (value: string) => ApduBuilder;
+    /**
+     * Add an ascii string to the data field if it has enough remaining space
+     * @param value: string - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    addAsciiStringToData: (value: string) => ApduBuilder;
+    /**
+     * Add a Length-Value encoded hexadecimal string to the data field if it has enough remaining space
+     * Length-Value encoding is a way to encode data in a binary format with the first byte
+     * being the length of the data and the following bytes being the data itself
+     * @param value: string - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    encodeInLVFromHexa: (value: string) => ApduBuilder;
+    /**
+     * Add a Length-Value encoded buffer to the data field if it has enough remaining space
+     * Length-Value encoding is a way to encode data in a binary format with the first byte
+     * being the length of the data and the following bytes being the data itself
+     * @param value: Uint8Array - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    encodeInLVFromBuffer: (value: Uint8Array) => ApduBuilder;
+    /**
+     * Add a Length-Value encoded ascii string to the data field if it has enough remaining space
+     * Length-Value encoding is a way to encode data in a binary format with the first byte
+     * being the length of the data and the following bytes being the data itself
+     * @param value: string - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    encodeInLVFromAscii: (value: string) => ApduBuilder;
+    /**
+     * Returns the remaining payload length
+     * @returns {number}
+     */
+    getAvailablePayloadLength: () => number;
+    /**
+     * Returns the current errors
+     * @returns {AppBuilderError[]} - Returns an array of errors
+     */
+    getErrors: () => AppBuilderError[];
+}
+//# sourceMappingURL=ApduBuilder.d.ts.map

package/lib/esm/src/api/apdu/utils/ApduBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApduBuilder.d.ts","sourceRoot":"","sources":["../../../../../../src/api/apdu/utils/ApduBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAE5C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD,eAAO,MAAM,aAAa,IAAI,CAAC;AAC/B,eAAO,MAAM,gBAAgB,MAAM,CAAC;AACpC,eAAO,MAAM,aAAa,QAAuB,CAAC;AAElD,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAS;IAC5B,OAAO,CAAC,IAAI,CAA4D;gBAE5D,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,eAAe;IAWjD;;;OAGG;IACH,KAAK,QAAO,IAAI,CACuD;IAEvE;;;;OAIG;IACH,iBAAiB,UAAW,MAAM,KAAG,WAAW,CAG9C;IAEF;;;;OAIG;IACH,kBAAkB,UAAW,MAAM,KAAG,WAAW,CAG/C;IAEF;;;;OAIG;IACH,kBAAkB,UAAW,MAAM,KAAG,WAAW,CAG/C;IAEF;;;;OAIG;IACH,eAAe,UAAW,UAAU,KAAG,WAAW,CAGhD;IAEF;;;;;OAKG;IACH,mBAAmB,UAAW,MAAM,KAAG,WAAW,CAGhD;IAEF;;;;OAIG;IACH,oBAAoB,UAAW,MAAM,KAAG,WAAW,CAGjD;IAEF;;;;;;OAMG;IACH,kBAAkB,UAAW,MAAM,KAAG,WAAW,CAG/C;IAEF;;;;;;OAMG;IACH,oBAAoB,UAAW,UAAU,KAAG,WAAW,CAGrD;IAEF;;;;;;OAMG;IACH,mBAAmB,UAAW,MAAM,KAAG,WAAW,CAGhD;IAEF;;;OAGG;IACH,yBAAyB,QAAO,MAAM,CACE;IAExC;;;OAGG;IACH,SAAS,QAAO,eAAe,EAAE,CAA0B;CAC5D"}