@ledgerhq/device-management-kit 0.0.0-develop-20241011001048 → 0.0.0-develop-20241219141541

package/lib/types/src/api/DeviceManagementKit.d.ts

@@ -0,0 +1,119 @@
+import { type Container } from "inversify";
+import { type Observable } from "rxjs";
+import { type CommandResult } from "./command/model/CommandResult";
+import { type SendCommandUseCaseArgs } from "./command/use-case/SendCommandUseCase";
+import { type ExecuteDeviceActionUseCaseArgs } from "./device-action/use-case/ExecuteDeviceActionUseCase";
+import { type ApduResponse } from "./device-session/ApduResponse";
+import { type DeviceSessionState } from "./device-session/DeviceSessionState";
+import { type DeviceSessionId } from "./device-session/types";
+import { type ConnectedDevice } from "./transport/model/ConnectedDevice";
+import { type ConnectUseCaseArgs, type DisconnectUseCaseArgs, type DiscoveredDevice, type GetConnectedDeviceUseCaseArgs, type SendApduUseCaseArgs, type StartDiscoveringUseCaseArgs } from "./types";
+import { type DeviceActionIntermediateValue, type ExecuteDeviceActionReturnType } from "./device-action/DeviceAction";
+import { type DmkError } from "./Error";
+/**
+ * The main class to interact with the Device Management Kit.
+ *
+ * NB: do not instantiate this class directly, instead, use `LedgerDMKBuilder`.
+ */
+export declare class DeviceManagementKit {
+    readonly container: Container;
+    /**
+     * Returns a promise resolving to the version of the SDK.
+     */
+    getVersion(): Promise<string>;
+    /**
+     * Starts discovering devices connected.
+     *
+     * For the WeHID implementation, this use-case needs to be called as a result
+     * of an user interaction (button "click" event for ex).
+     *
+     * @param {StartDiscoveringUseCaseArgs} args - The transport to use for discover, or undefined to discover from all transports.
+     * @returns {Observable<DiscoveredDevice>} An observable of discovered devices.
+     */
+    startDiscovering(args: StartDiscoveringUseCaseArgs): Observable<DiscoveredDevice>;
+    /**
+     * Stops discovering devices connected.
+     */
+    stopDiscovering(): void;
+    /**
+     * Listen to list of known discovered devices (and later BLE).
+     *
+     * @returns {Observable<DiscoveredDevice[]>} An observable of known discovered devices.
+     */
+    listenToKnownDevices(): Observable<DiscoveredDevice[]>;
+    /**
+     * Connects to a device previously discovered with `DeviceManagementKit.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 `DeviceManagementKit.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.
+     *
+     * @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 DmkError, 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>;
+    /**
+     * Close the Device Management kit.
+     *
+     */
+    close(): void;
+    /**
+     * Lists all connected devices.
+     *
+     * @returns {ConnectedDevice[]} The list of device sessions.
+     */
+    listConnectedDevices(): ConnectedDevice[];
+    /**
+     * Listen to connected device.
+     *
+     * @returns {Observable<ConnectedDevice>} An observable of connected device.
+     */
+    listenToConnectedDevice(): Observable<ConnectedDevice>;
+    /**
+     * Toggle the device session refresher.
+     *
+     * @param {DeviceSessionId} args - The device session ID.
+     */
+    toggleDeviceSessionRefresher(args: {
+        sessionId: DeviceSessionId;
+        enabled: boolean;
+    }): void;
+}
+//# sourceMappingURL=DeviceManagementKit.d.ts.map

package/lib/types/src/api/DeviceManagementKit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceManagementKit.d.ts","sourceRoot":"","sources":["../../../../src/api/DeviceManagementKit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,MAAM,CAAC;AAGvC,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAEL,KAAK,sBAAsB,EAC5B,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAEL,KAAK,8BAA8B,EACpC,MAAM,wDAAwD,CAAC;AAChE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AACjF,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,EACrB,KAAK,6BAA6B,EAClC,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,EACjC,MAAM,YAAY,CAAC;AAmBpB,OAAO,EACL,KAAK,6BAA6B,EAClC,KAAK,6BAA6B,EACnC,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC;;;;GAIG;AACH,qBAAa,mBAAmB;IAC9B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAmB9B;;OAEG;IACH,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAM7B;;;;;;;;OAQG;IACH,gBAAgB,CACd,IAAI,EAAE,2BAA2B,GAChC,UAAU,CAAC,gBAAgB,CAAC;IAM/B;;OAEG;IACH,eAAe;IAMf;;;;OAIG;IACH,oBAAoB,IAAI,UAAU,CAAC,gBAAgB,EAAE,CAAC;IAQtD;;;;;;;;;;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;;;OAGG;IACH,KAAK;IAML;;;;OAIG;IACH,oBAAoB,IAAI,eAAe,EAAE;IAQzC;;;;OAIG;IACH,uBAAuB,IAAI,UAAU,CAAC,eAAe,CAAC;IAQtD;;;;OAIG;IACH,4BAA4B,CAAC,IAAI,EAAE;QACjC,SAAS,EAAE,eAAe,CAAC;QAC3B,OAAO,EAAE,OAAO,CAAC;KAClB;CAOF"}

package/lib/types/src/api/DeviceManagementKit.test.d.ts

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

package/lib/types/src/api/DeviceManagementKit.test.d.ts.map

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

package/lib/types/src/api/DeviceManagementKitBuilder.d.ts

@@ -0,0 +1,32 @@
+import { type LoggerSubscriberService } from "./logger-subscriber/service/LoggerSubscriberService";
+import { type TransportFactory } from "./transport/model/Transport";
+import { DeviceManagementKit } from "./DeviceManagementKit";
+import { type DmkConfig } from "./DmkConfig";
+/**
+ * Builder for the `DeviceManagementKit` class.
+ *
+ * @example
+ * ```
+ * const dmk = new LedgerDeviceManagementKitBuilder()
+ *  .setStub(false)
+ *  .addTransport((args) => transportFactory(args))
+ *  .addTransport(transportFactory)
+ *  .addLogger(myLogger)
+ *  .build();
+ * ```
+ */
+export declare class DeviceManagementKitBuilder {
+    private stub;
+    private readonly loggers;
+    private readonly transports;
+    private config;
+    build(): DeviceManagementKit;
+    setStub(stubbed: boolean): DeviceManagementKitBuilder;
+    addTransport(transport: TransportFactory): DeviceManagementKitBuilder;
+    /**
+     * Add a logger to the SDK that will receive its logs
+     */
+    addLogger(logger: LoggerSubscriberService): DeviceManagementKitBuilder;
+    addConfig(config: Partial<DmkConfig>): DeviceManagementKitBuilder;
+}
+//# sourceMappingURL=DeviceManagementKitBuilder.d.ts.map

package/lib/types/src/api/DeviceManagementKitBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceManagementKitBuilder.d.ts","sourceRoot":"","sources":["../../../../src/api/DeviceManagementKitBuilder.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,qDAAqD,CAAC;AACnG,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;;;;;;GAYG;AACH,qBAAa,0BAA0B;IACrC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiC;IACzD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA0B;IACrD,OAAO,CAAC,MAAM,CAGZ;IAEF,KAAK,IAAI,mBAAmB;IAS5B,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,0BAA0B;IAKrD,YAAY,CAAC,SAAS,EAAE,gBAAgB,GAAG,0BAA0B;IAKrE;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,uBAAuB,GAAG,0BAA0B;IAKtE,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,0BAA0B;CAOlE"}

package/lib/types/src/api/DeviceManagementKitBuilder.test.d.ts

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

package/lib/types/src/api/DeviceManagementKitBuilder.test.d.ts.map

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

package/lib/types/src/api/DmkConfig.d.ts

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

package/lib/types/src/api/DmkConfig.d.ts.map

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

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

@@ -0,0 +1,26 @@
+export interface DmkError {
+    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 DmkError {
+    readonly _tag = "UnknownDeviceExchangeError";
+    readonly originalError?: unknown;
+    readonly message: string;
+    constructor(originalError?: unknown);
+}
+//# sourceMappingURL=Error.d.ts.map

package/lib/types/src/api/apdu/model/Apdu.test.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"Apdu.test.d.ts","sourceRoot":"","sources":["../../../../../../src/api/apdu/model/Apdu.test.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,113 @@
+import { Apdu } from "../../apdu/model/Apdu";
+import { type 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/types/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,KAAK,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGzD,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"}

package/lib/types/src/api/apdu/utils/ApduBuilder.test.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApduBuilder.test.d.ts","sourceRoot":"","sources":["../../../../../../src/api/apdu/utils/ApduBuilder.test.ts"],"names":[],"mappings":""}

package/lib/types/src/api/apdu/utils/ApduParser.d.ts

@@ -0,0 +1,79 @@
+import { type ApduResponse } from "../../device-session/ApduResponse";
+import { type HexaString } from "../../utils/HexaString";
+export type TaggedField = {
+    readonly tag: number;
+    readonly value: Uint8Array;
+};
+/**
+ * ApduParser is a utility class to help parse APDU responses.
+ *
+ * It provides methods to extract fields of different types from the response.
+ *
+ * @example
+ * ```
+ * const parser = new ApduParser(apduResponse);
+ * const targetId = parser.encodeToHexaString(parser.extractFieldByLength(4));
+ * const seVersion = parser.encodeToString(parser.extractFieldLVEncoded());
+ * ```
+ */
+export declare class ApduParser {
+    private parser;
+    constructor(response: ApduResponse);
+    /**
+     * Test if the length is greater than the response length
+     * @param length: number
+     * @returns {boolean} - Returns false if the length is greater than the response length
+     */
+    testMinimalLength: (length: number) => boolean;
+    /**
+     * Extract a single byte from the response
+     * @returns {number | undefined} - Returns the byte extracted from the response
+     */
+    extract8BitUInt: () => number | undefined;
+    /**
+     * Extract a 16-bit unsigned integer (Big Endian coding) from the response
+     * @returns {number | undefined} - Returns the 16-bit unsigned integer extracted from the response
+     */
+    extract16BitUInt: () => number | undefined;
+    /**
+     * Extract a 32-bit unsigned integer (Big Endian coding) from the response
+     * @returns {number | undefined} - Returns the 32-bit unsigned integer extracted from the response
+     */
+    extract32BitUInt: () => number | undefined;
+    /**
+     * Extract a field of a specified length from the response
+     * @param length: number - The length of the field to extract
+     * @returns {Uint8Array | undefined} - Returns the field extracted from the response
+     */
+    extractFieldByLength: (length: number) => Uint8Array | undefined;
+    /**
+     * Extract a field from the response that is length-value encoded
+     * @returns {Uint8Array | undefined} - Returns the field extracted from the response
+     */
+    extractFieldLVEncoded: () => Uint8Array | undefined;
+    /**
+     * Extract a field from the response that is tag-length-value encoded
+     * @returns {TaggedField | undefined} - Returns the field extracted from the response
+     */
+    extractFieldTLVEncoded: () => TaggedField | undefined;
+    /**
+     * Encode a value to a hexadecimal string
+     * @param value {Uint8Array} - The value to encode
+     * @param prefix {boolean} - Whether to add a prefix to the encoded value
+     * @returns {string} - The encoded value as a hexadecimal string
+     */
+    encodeToHexaString(value?: Uint8Array, prefix?: false): string;
+    encodeToHexaString(value?: Uint8Array, prefix?: true): HexaString;
+    /**
+     * Encode a value to an ASCII string
+     * @param value {Uint8Array} - The value to encode
+     * @returns {string} - The encoded value as an ASCII string
+     */
+    encodeToString: (value?: Uint8Array) => string;
+    /**
+     * Get the remaining length of the response
+     * @returns {number} - The remaining length of the response
+     */
+    getUnparsedRemainingLength: () => number;
+}
+//# sourceMappingURL=ApduParser.d.ts.map

package/lib/types/src/api/apdu/utils/ApduParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApduParser.d.ts","sourceRoot":"","sources":["../../../../../../src/api/apdu/utils/ApduParser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAIxD,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;CAC5B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAkB;gBAEpB,QAAQ,EAAE,YAAY;IAIlC;;;;OAIG;IACH,iBAAiB,WAAY,MAAM,KAAG,OAAO,CACL;IAExC;;;OAGG;IACH,eAAe,QAAO,MAAM,GAAG,SAAS,CAAkC;IAE1E;;;OAGG;IACH,gBAAgB,QAAO,MAAM,GAAG,SAAS,CAAmC;IAE5E;;;OAGG;IACH,gBAAgB,QAAO,MAAM,GAAG,SAAS,CAAmC;IAE5E;;;;OAIG;IACH,oBAAoB,WAAY,MAAM,KAAG,UAAU,GAAG,SAAS,CACpB;IAE3C;;;OAGG;IACH,qBAAqB,QAAO,UAAU,GAAG,SAAS,CACZ;IAEtC;;;OAGG;IACH,sBAAsB,QAAO,WAAW,GAAG,SAAS,CACb;IAEvC;;;;;OAKG;IACH,kBAAkB,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM;IAC9D,kBAAkB,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,IAAI,GAAG,UAAU;IAUjE;;;;OAIG;IACH,cAAc,WAAY,UAAU,KAAG,MAAM,CACT;IAEpC;;;OAGG;IACH,0BAA0B,QAAO,MAAM,CACI;CAC5C"}

package/lib/types/src/api/apdu/utils/ApduParser.test.d.ts

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

package/lib/types/src/api/apdu/utils/ApduParser.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApduParser.test.d.ts","sourceRoot":"","sources":["../../../../../../src/api/apdu/utils/ApduParser.test.ts"],"names":[],"mappings":""}

package/lib/types/src/api/apdu/utils/AppBuilderError.d.ts

@@ -0,0 +1,28 @@
+import { type DmkError } from "../../Error";
+interface DmkAppBuilderError extends DmkError {
+    readonly message: string;
+}
+export declare class ValueOverflowError implements DmkAppBuilderError {
+    readonly _tag = "ValueOverflow";
+    readonly originalError?: Error;
+    readonly message: string;
+    constructor(value: string, max?: number | bigint);
+}
+export declare class DataOverflowError implements DmkAppBuilderError {
+    readonly _tag = "DataOverflow";
+    readonly message: string;
+    readonly originalError?: Error;
+    constructor(value: string, remaining?: number);
+}
+export declare class HexaStringEncodeError implements DmkAppBuilderError {
+    readonly _tag = "HexaString";
+    readonly message: string;
+    readonly originalError?: Error;
+    constructor(value: string);
+}
+/**
+ * Type for all possible errors that can be thrown by the AppBuilder.
+ */
+export type AppBuilderError = ValueOverflowError | DataOverflowError | HexaStringEncodeError;
+export {};
+//# sourceMappingURL=AppBuilderError.d.ts.map

package/lib/types/src/api/apdu/utils/AppBuilderError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppBuilderError.d.ts","sourceRoot":"","sources":["../../../../../../src/api/apdu/utils/AppBuilderError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAI3C,UAAU,kBAAmB,SAAQ,QAAQ;IAC3C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,qBAAa,kBAAmB,YAAW,kBAAkB;IAC3D,QAAQ,CAAC,IAAI,mBAAmB;IAChC,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC;IAC/B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;gBACb,KAAK,EAAE,MAAM,EAAE,GAAG,GAAE,MAAM,GAAG,MAAyB;CAGnE;AAED,qBAAa,iBAAkB,YAAW,kBAAkB;IAC1D,QAAQ,CAAC,IAAI,kBAAkB;IAC/B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC;gBACnB,KAAK,EAAE,MAAM,EAAE,SAAS,SAAI;CAMzC;AAED,qBAAa,qBAAsB,YAAW,kBAAkB;IAC9D,QAAQ,CAAC,IAAI,gBAAgB;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC;gBACnB,KAAK,EAAE,MAAM;CAG1B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,kBAAkB,GAClB,iBAAiB,GACjB,qBAAqB,CAAC"}