@ledgerhq/device-management-kit 0.0.0-20241212001220

package/LICENSE.MD

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024-present Ledger
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

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.js

@@ -0,0 +1,2 @@
+"use strict";var a=Object.defineProperty;var b=Object.getOwnPropertyDescriptor;var c=Object.getOwnPropertyNames;var d=Object.prototype.hasOwnProperty;var p=(r,o,f,x)=>{if(o&&typeof o=="object"||typeof o=="function")for(let e of c(o))!d.call(r,e)&&e!==f&&a(r,e,{get:()=>o[e],enumerable:!(x=b(o,e))||x.enumerable});return r},t=(r,o,f)=>(p(r,o,"default"),f&&p(f,o,"default"));var g=r=>p(a({},"__esModule",{value:!0}),r);var m={};module.exports=g(m);t(m,require("./src"),module.exports);0&&(module.exports={...require("./src")});
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../index.ts"],
+  "sourcesContent": ["export * from \"./src\";\n"],
+  "mappings": "iaAAA,IAAAA,EAAA,kBAAAC,EAAAD,GAAAE,EAAAF,EAAc,iBAAd",
+  "names": ["device_management_kit_exports", "__toCommonJS", "__reExport"]
+}

package/lib/cjs/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@ledgerhq/device-management-kit",
+  "version": "0.5.1",
+  "license": "Apache-2.0",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js"
+    },
+    "./*": {
+      "types": "./lib/types/*",
+      "import": "./lib/esm/*",
+      "require": "./lib/cjs/*"
+    }
+  },
+  "files": [
+    "./lib",
+    "package.json"
+  ],
+  "scripts": {
+    "prebuild": "rimraf lib",
+    "build": "pnpm lmdk-build --entryPoints index.ts,src/**/*.ts --tsconfig tsconfig.prod.json",
+    "dev": "concurrently \"pnpm watch:builds\" \"pnpm watch:types\"",
+    "watch:builds": "pnpm lmdk-watch --entryPoints index.ts,src/**/*.ts --tsconfig tsconfig.prod.json",
+    "watch:types": "concurrently \"tsc --watch -p tsconfig.prod.json\" \"tsc-alias --watch -p tsconfig.prod.json\"",
+    "lint": "eslint",
+    "lint:fix": "pnpm lint --fix",
+    "postpack": "find . -name '*.tgz' -exec cp {} ../../dist/ \\; ",
+    "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": {
+    "@ledgerhq/device-mockserver-client": "workspace:*",
+    "@sentry/minimal": "^6.19.7",
+    "@statelyai/inspect": "^0.4.0",
+    "axios": "^1.7.9",
+    "inversify": "^6.1.6",
+    "inversify-logger-middleware": "^3.1.0",
+    "purify-ts": "^2.1.0",
+    "reflect-metadata": "^0.2.2",
+    "semver": "^7.6.3",
+    "uuid": "^11.0.3",
+    "xstate": "^5.19.0"
+  },
+  "peerDependencies": {
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "@ledgerhq/esbuild-tools": "workspace:*",
+    "@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",
+    "rxjs": "^7.8.1",
+    "ts-node": "^10.9.2"
+  }
+}

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

@@ -0,0 +1,2 @@
+"use strict";var c=Object.defineProperty;var v=Object.getOwnPropertyDescriptor;var D=Object.getOwnPropertyNames;var u=Object.prototype.hasOwnProperty;var U=(t,e)=>{for(var n in e)c(t,n,{get:e[n],enumerable:!0})},g=(t,e,n,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of D(e))!u.call(t,o)&&o!==n&&c(t,o,{get:()=>e[o],enumerable:!(i=v(e,o))||i.enumerable});return t};var y=t=>g(c({},"__esModule",{value:!0}),t);var f={};U(f,{DeviceManagementKit:()=>S});module.exports=y(f);var a=require("./command/di/commandTypes"),C=require("../internal/config/di/configTypes"),r=require("../internal/device-session/di/deviceSessionTypes"),s=require("../internal/discovery/di/discoveryTypes"),m=require("../internal/send/di/sendTypes"),p=require("../../src/di"),d=require("./device-action/di/deviceActionTypes");class S{container;constructor({stub:e,transports:n,loggers:i,config:o}={}){this.container=(0,p.makeContainer)({stub:e,transports:n,loggers:i,config:o})}getVersion(){return this.container.get(C.configTypes.GetDmkVersionUseCase).getDmkVersion()}startDiscovering(e){return this.container.get(s.discoveryTypes.StartDiscoveringUseCase).execute(e)}stopDiscovering(){return this.container.get(s.discoveryTypes.StopDiscoveringUseCase).execute()}listenToKnownDevices(){return this.container.get(s.discoveryTypes.ListenToKnownDevicesUseCase).execute()}connect(e){return this.container.get(s.discoveryTypes.ConnectUseCase).execute(e)}disconnect(e){return this.container.get(s.discoveryTypes.DisconnectUseCase).execute(e)}sendApdu(e){return this.container.get(m.sendTypes.SendApduUseCase).execute(e)}sendCommand(e){return this.container.get(a.commandTypes.SendCommandUseCase).execute(e)}executeDeviceAction(e){return this.container.get(d.deviceActionTypes.ExecuteDeviceActionUseCase).execute(e)}getConnectedDevice(e){return this.container.get(s.discoveryTypes.GetConnectedDeviceUseCase).execute(e)}getDeviceSessionState(e){return this.container.get(r.deviceSessionTypes.GetDeviceSessionStateUseCase).execute(e)}close(){return this.container.get(r.deviceSessionTypes.CloseSessionsUseCase).execute()}listConnectedDevices(){return this.container.get(s.discoveryTypes.ListConnectedDevicesUseCase).execute()}listenToConnectedDevice(){return this.container.get(s.discoveryTypes.ListenToConnectedDeviceUseCase).execute()}toggleDeviceSessionRefresher(e){return this.container.get(r.deviceSessionTypes.ToggleDeviceSessionRefresherUseCase).execute(e)}}0&&(module.exports={DeviceManagementKit});
+//# sourceMappingURL=DeviceManagementKit.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/api/DeviceManagementKit.ts"],
+  "sourcesContent": ["import { type Container } from \"inversify\";\nimport { type Observable } from \"rxjs\";\n\nimport { commandTypes } from \"@api/command/di/commandTypes\";\nimport { type CommandResult } from \"@api/command/model/CommandResult\";\nimport {\n  type SendCommandUseCase,\n  type SendCommandUseCaseArgs,\n} from \"@api/command/use-case/SendCommandUseCase\";\nimport {\n  type ExecuteDeviceActionUseCase,\n  type ExecuteDeviceActionUseCaseArgs,\n} from \"@api/device-action/use-case/ExecuteDeviceActionUseCase\";\nimport { type ApduResponse } from \"@api/device-session/ApduResponse\";\nimport { type DeviceSessionState } from \"@api/device-session/DeviceSessionState\";\nimport { type DeviceSessionId } from \"@api/device-session/types\";\nimport { type ConnectedDevice } from \"@api/transport/model/ConnectedDevice\";\nimport {\n  type ConnectUseCaseArgs,\n  type DisconnectUseCaseArgs,\n  type DiscoveredDevice,\n  type GetConnectedDeviceUseCaseArgs,\n  type SendApduUseCaseArgs,\n  type StartDiscoveringUseCaseArgs,\n} from \"@api/types\";\nimport { configTypes } from \"@internal/config/di/configTypes\";\nimport { type GetDmkVersionUseCase } from \"@internal/config/use-case/GetDmkVersionUseCase\";\nimport { deviceSessionTypes } from \"@internal/device-session/di/deviceSessionTypes\";\nimport { type CloseSessionsUseCase } from \"@internal/device-session/use-case/CloseSessionsUseCase\";\nimport { type GetDeviceSessionStateUseCase } from \"@internal/device-session/use-case/GetDeviceSessionStateUseCase\";\nimport { discoveryTypes } from \"@internal/discovery/di/discoveryTypes\";\nimport { type ConnectUseCase } from \"@internal/discovery/use-case/ConnectUseCase\";\nimport { type DisconnectUseCase } from \"@internal/discovery/use-case/DisconnectUseCase\";\nimport { type GetConnectedDeviceUseCase } from \"@internal/discovery/use-case/GetConnectedDeviceUseCase\";\nimport { type ListConnectedDevicesUseCase } from \"@internal/discovery/use-case/ListConnectedDevicesUseCase\";\nimport { type ListenToConnectedDeviceUseCase } from \"@internal/discovery/use-case/ListenToConnectedDeviceUseCase\";\nimport { type ListenToKnownDevicesUseCase } from \"@internal/discovery/use-case/ListenToKnownDevicesUseCase\";\nimport type { StartDiscoveringUseCase } from \"@internal/discovery/use-case/StartDiscoveringUseCase\";\nimport type { StopDiscoveringUseCase } from \"@internal/discovery/use-case/StopDiscoveringUseCase\";\nimport { sendTypes } from \"@internal/send/di/sendTypes\";\nimport { type SendApduUseCase } from \"@internal/send/use-case/SendApduUseCase\";\nimport { makeContainer, type MakeContainerProps } from \"@root/src/di\";\n\nimport {\n  type DeviceActionIntermediateValue,\n  type ExecuteDeviceActionReturnType,\n} from \"./device-action/DeviceAction\";\nimport { deviceActionTypes } from \"./device-action/di/deviceActionTypes\";\nimport { type ToggleDeviceSessionRefresherUseCase } from \"./device-session/use-case/ToggleDeviceSessionRefresher\";\nimport { type DmkError } from \"./Error\";\n\n/**\n * The main class to interact with the Device Management Kit.\n *\n * NB: do not instantiate this class directly, instead, use `LedgerDMKBuilder`.\n */\nexport class DeviceManagementKit {\n  readonly container: Container;\n  /** @internal */\n  constructor({\n    stub,\n    transports,\n    loggers,\n    config,\n  }: Partial<MakeContainerProps> = {}) {\n    // NOTE: MakeContainerProps might not be the exact type here\n    // For the init of the project this is sufficient, but we might need to\n    // update the constructor arguments as we go (we might have more than just the container config)\n    this.container = makeContainer({\n      stub,\n      transports,\n      loggers,\n      config,\n    });\n  }\n\n  /**\n   * Returns a promise resolving to the version of the SDK.\n   */\n  getVersion(): Promise<string> {\n    return this.container\n      .get<GetDmkVersionUseCase>(configTypes.GetDmkVersionUseCase)\n      .getDmkVersion();\n  }\n\n  /**\n   * Starts discovering devices connected.\n   *\n   * For the WeHID implementation, this use-case needs to be called as a result\n   * of an user interaction (button \"click\" event for ex).\n   *\n   * @param {StartDiscoveringUseCaseArgs} args - The transport to use for discover, or undefined to discover from all transports.\n   * @returns {Observable<DiscoveredDevice>} An observable of discovered devices.\n   */\n  startDiscovering(\n    args: StartDiscoveringUseCaseArgs,\n  ): Observable<DiscoveredDevice> {\n    return this.container\n      .get<StartDiscoveringUseCase>(discoveryTypes.StartDiscoveringUseCase)\n      .execute(args);\n  }\n\n  /**\n   * Stops discovering devices connected.\n   */\n  stopDiscovering() {\n    return this.container\n      .get<StopDiscoveringUseCase>(discoveryTypes.StopDiscoveringUseCase)\n      .execute();\n  }\n\n  /**\n   * Listen to list of known discovered devices (and later BLE).\n   *\n   * @returns {Observable<DiscoveredDevice[]>} An observable of known discovered devices.\n   */\n  listenToKnownDevices(): Observable<DiscoveredDevice[]> {\n    return this.container\n      .get<ListenToKnownDevicesUseCase>(\n        discoveryTypes.ListenToKnownDevicesUseCase,\n      )\n      .execute();\n  }\n\n  /**\n   * Connects to a device previously discovered with `DeviceManagementKit.startDiscovering`.\n   * Creates a new device session which:\n   * - Represents the connection to the device.\n   * - Is terminated upon disconnection of the device.\n   * - Exposes the device state through an observable (see `DeviceManagementKit.getDeviceSessionState`)\n   * - Should be used for all subsequent communication with the device.\n   *\n   * @param {ConnectUseCaseArgs} args - The device ID (obtained in discovery) to connect to.\n   * @returns The session ID to use for further communication with the device.\n   */\n  connect(args: ConnectUseCaseArgs): Promise<DeviceSessionId> {\n    return this.container\n      .get<ConnectUseCase>(discoveryTypes.ConnectUseCase)\n      .execute(args);\n  }\n\n  /**\n   * Disconnects to a discovered device.\n   *\n   * @param {DisconnectUseCaseArgs} args - The session ID to disconnect.\n   */\n  disconnect(args: DisconnectUseCaseArgs): Promise<void> {\n    return this.container\n      .get<DisconnectUseCase>(discoveryTypes.DisconnectUseCase)\n      .execute(args);\n  }\n\n  /**\n   * Sends an APDU command to a device through a device session.\n   *\n   * @param {SendApduUseCaseArgs} args - The device session ID and APDU command to send.\n   */\n  sendApdu(args: SendApduUseCaseArgs): Promise<ApduResponse> {\n    return this.container\n      .get<SendApduUseCase>(sendTypes.SendApduUseCase)\n      .execute(args);\n  }\n\n  /**\n   * Sends a command to a device through a device session.\n   *\n   * @param {SendCommandUseCaseArgs<Response, Args, ErrorCodes>} args - The device session ID, command, command error codes and command parameters to send.\n   * @returns A promise resolving with the response from the command.\n   */\n  sendCommand<Response, Args, ErrorCodes>(\n    args: SendCommandUseCaseArgs<Response, Args, ErrorCodes>,\n  ): Promise<CommandResult<Response, ErrorCodes>> {\n    return this.container\n      .get<SendCommandUseCase>(commandTypes.SendCommandUseCase)\n      .execute(args);\n  }\n\n  executeDeviceAction<\n    Output,\n    Input,\n    Error extends DmkError,\n    IntermediateValue extends DeviceActionIntermediateValue,\n  >(\n    args: ExecuteDeviceActionUseCaseArgs<\n      Output,\n      Input,\n      Error,\n      IntermediateValue\n    >,\n  ): ExecuteDeviceActionReturnType<Output, Error, IntermediateValue> {\n    return this.container\n      .get<ExecuteDeviceActionUseCase>(\n        deviceActionTypes.ExecuteDeviceActionUseCase,\n      )\n      .execute(args);\n  }\n\n  /**\n   * Gets the connected from its device session ID.\n   *\n   * @param {GetConnectedDeviceUseCaseArgs} args - The device session ID.\n   * @returns {ConnectedDevice} The connected device.\n   */\n  getConnectedDevice(args: GetConnectedDeviceUseCaseArgs): ConnectedDevice {\n    return this.container\n      .get<GetConnectedDeviceUseCase>(discoveryTypes.GetConnectedDeviceUseCase)\n      .execute(args);\n  }\n\n  /**\n   * Gets the device state of a session.\n   *\n   * @param {{DeviceSessionId}} args - The device session ID.\n   * @returns {Observable<DeviceSessionState>} An observable of the session device state.\n   */\n  getDeviceSessionState(args: {\n    sessionId: DeviceSessionId;\n  }): Observable<DeviceSessionState> {\n    return this.container\n      .get<GetDeviceSessionStateUseCase>(\n        deviceSessionTypes.GetDeviceSessionStateUseCase,\n      )\n      .execute(args);\n  }\n\n  /**\n   * Close the Device Management kit.\n   *\n   */\n  close() {\n    return this.container\n      .get<CloseSessionsUseCase>(deviceSessionTypes.CloseSessionsUseCase)\n      .execute();\n  }\n\n  /**\n   * Lists all connected devices.\n   *\n   * @returns {ConnectedDevice[]} The list of device sessions.\n   */\n  listConnectedDevices(): ConnectedDevice[] {\n    return this.container\n      .get<ListConnectedDevicesUseCase>(\n        discoveryTypes.ListConnectedDevicesUseCase,\n      )\n      .execute();\n  }\n\n  /**\n   * Listen to connected device.\n   *\n   * @returns {Observable<ConnectedDevice>} An observable of connected device.\n   */\n  listenToConnectedDevice(): Observable<ConnectedDevice> {\n    return this.container\n      .get<ListenToConnectedDeviceUseCase>(\n        discoveryTypes.ListenToConnectedDeviceUseCase,\n      )\n      .execute();\n  }\n\n  /**\n   * Toggle the device session refresher.\n   *\n   * @param {DeviceSessionId} args - The device session ID.\n   */\n  toggleDeviceSessionRefresher(args: {\n    sessionId: DeviceSessionId;\n    enabled: boolean;\n  }) {\n    return this.container\n      .get<ToggleDeviceSessionRefresherUseCase>(\n        deviceSessionTypes.ToggleDeviceSessionRefresherUseCase,\n      )\n      .execute(args);\n  }\n}\n"],
+  "mappings": "yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,yBAAAE,IAAA,eAAAC,EAAAH,GAGA,IAAAI,EAA6B,wCAsB7BC,EAA4B,2CAE5BC,EAAmC,0DAGnCC,EAA+B,iDAS/BC,EAA0B,uCAE1BC,EAAuD,wBAMvDC,EAAkC,gDAS3B,MAAMR,CAAoB,CACtB,UAET,YAAY,CACV,KAAAS,EACA,WAAAC,EACA,QAAAC,EACA,OAAAC,CACF,EAAiC,CAAC,EAAG,CAInC,KAAK,aAAY,iBAAc,CAC7B,KAAAH,EACA,WAAAC,EACA,QAAAC,EACA,OAAAC,CACF,CAAC,CACH,CAKA,YAA8B,CAC5B,OAAO,KAAK,UACT,IAA0B,cAAY,oBAAoB,EAC1D,cAAc,CACnB,CAWA,iBACEC,EAC8B,CAC9B,OAAO,KAAK,UACT,IAA6B,iBAAe,uBAAuB,EACnE,QAAQA,CAAI,CACjB,CAKA,iBAAkB,CAChB,OAAO,KAAK,UACT,IAA4B,iBAAe,sBAAsB,EACjE,QAAQ,CACb,CAOA,sBAAuD,CACrD,OAAO,KAAK,UACT,IACC,iBAAe,2BACjB,EACC,QAAQ,CACb,CAaA,QAAQA,EAAoD,CAC1D,OAAO,KAAK,UACT,IAAoB,iBAAe,cAAc,EACjD,QAAQA,CAAI,CACjB,CAOA,WAAWA,EAA4C,CACrD,OAAO,KAAK,UACT,IAAuB,iBAAe,iBAAiB,EACvD,QAAQA,CAAI,CACjB,CAOA,SAASA,EAAkD,CACzD,OAAO,KAAK,UACT,IAAqB,YAAU,eAAe,EAC9C,QAAQA,CAAI,CACjB,CAQA,YACEA,EAC8C,CAC9C,OAAO,KAAK,UACT,IAAwB,eAAa,kBAAkB,EACvD,QAAQA,CAAI,CACjB,CAEA,oBAMEA,EAMiE,CACjE,OAAO,KAAK,UACT,IACC,oBAAkB,0BACpB,EACC,QAAQA,CAAI,CACjB,CAQA,mBAAmBA,EAAsD,CACvE,OAAO,KAAK,UACT,IAA+B,iBAAe,yBAAyB,EACvE,QAAQA,CAAI,CACjB,CAQA,sBAAsBA,EAEa,CACjC,OAAO,KAAK,UACT,IACC,qBAAmB,4BACrB,EACC,QAAQA,CAAI,CACjB,CAMA,OAAQ,CACN,OAAO,KAAK,UACT,IAA0B,qBAAmB,oBAAoB,EACjE,QAAQ,CACb,CAOA,sBAA0C,CACxC,OAAO,KAAK,UACT,IACC,iBAAe,2BACjB,EACC,QAAQ,CACb,CAOA,yBAAuD,CACrD,OAAO,KAAK,UACT,IACC,iBAAe,8BACjB,EACC,QAAQ,CACb,CAOA,6BAA6BA,EAG1B,CACD,OAAO,KAAK,UACT,IACC,qBAAmB,mCACrB,EACC,QAAQA,CAAI,CACjB,CACF",
+  "names": ["DeviceManagementKit_exports", "__export", "DeviceManagementKit", "__toCommonJS", "import_commandTypes", "import_configTypes", "import_deviceSessionTypes", "import_discoveryTypes", "import_sendTypes", "import_di", "import_deviceActionTypes", "stub", "transports", "loggers", "config", "args"]
+}

package/lib/cjs/src/api/DeviceManagementKit.test.js

@@ -0,0 +1,2 @@
+"use strict";var D=Object.create;var a=Object.defineProperty;var C=Object.getOwnPropertyDescriptor;var b=Object.getOwnPropertyNames;var x=Object.getPrototypeOf,B=Object.prototype.hasOwnProperty;var S=(t,o,n,r)=>{if(o&&typeof o=="object"||typeof o=="function")for(let i of b(o))!B.call(t,i)&&i!==n&&a(t,i,{get:()=>o[i],enumerable:!(r=C(o,i))||r.enumerable});return t};var U=(t,o,n)=>(n=t!=null?D(x(t)):{},S(o||!t||!t.__esModule?a(n,"default",{value:t,enumerable:!0}):n,t));var m=require("../internal/config/data/LocalConfigDataSource.stub"),p=require("../internal/config/di/configTypes"),f=require("../internal/device-session/di/deviceSessionTypes"),s=require("../internal/discovery/di/discoveryTypes"),u=require("../internal/send/di/sendTypes"),l=U(require("../../package.json")),h=require("../../src/di.stub"),g=require("./command/di/commandTypes"),v=require("./logger-subscriber/service/ConsoleLogger"),c=require("./DeviceManagementKit");jest.mock("./logger-subscriber/service/ConsoleLogger");let e,d;describe("DeviceManagementKit",()=>{describe("clean",()=>{beforeEach(()=>{d=new v.ConsoleLogger,e=new c.DeviceManagementKit({stub:!1,loggers:[d],config:{managerApiUrl:"http://fake.url",mockUrl:"http://fake-mock.url"}})}),it("should create an instance",()=>{expect(e).toBeDefined(),expect(e).toBeInstanceOf(c.DeviceManagementKit)}),it("should return a clean `version`",async()=>{expect(await e.getVersion()).toBe(l.default.version)}),it("should have startDiscovery method",()=>{expect(e.startDiscovering).toBeDefined()}),it("should have stopDiscovery method",()=>{expect(e.stopDiscovering).toBeDefined()}),it("should have connect method",()=>{expect(e.connect).toBeDefined()}),it("should have sendApdu method",()=>{expect(e.sendApdu).toBeDefined()}),it("should have getConnectedDevice method",()=>{expect(e.getConnectedDevice).toBeDefined()}),it("should have sendCommand method",()=>{expect(e.sendCommand).toBeDefined()}),it("should have listConnectedDevices method",()=>{expect(e.listConnectedDevices).toBeDefined()}),it("should have listenToConnectedDevice method",()=>{expect(e.listenToConnectedDevice).toBeDefined()}),it("should have toggleDeviceSessionRefresher method",()=>{expect(e.toggleDeviceSessionRefresher).toBeDefined()})}),describe("stubbed",()=>{beforeEach(()=>{e=new c.DeviceManagementKit({stub:!0,loggers:[],config:{managerApiUrl:"http://fake.url",mockUrl:"http://fake-mock.url"}})}),it("should create a stubbed dmk",()=>{expect(e).toBeDefined(),expect(e).toBeInstanceOf(c.DeviceManagementKit)}),it("should return a stubbed config",()=>{expect(e.container.get(p.configTypes.LocalConfigDataSource)).toBeInstanceOf(m.StubLocalConfigDataSource)}),it("should return a stubbed version",async()=>{expect(await e.getVersion()).toBe("0.0.0-stub.1")}),it.each([[s.discoveryTypes.StartDiscoveringUseCase],[s.discoveryTypes.StopDiscoveringUseCase],[s.discoveryTypes.ConnectUseCase],[u.sendTypes.SendApduUseCase],[g.commandTypes.SendCommandUseCase],[s.discoveryTypes.GetConnectedDeviceUseCase],[s.discoveryTypes.DisconnectUseCase],[f.deviceSessionTypes.GetDeviceSessionStateUseCase],[s.discoveryTypes.ListConnectedDevicesUseCase],[s.discoveryTypes.ListenToConnectedDeviceUseCase]])("should have %p use case",t=>{const o=e.container.get(t);expect(o).toBeInstanceOf(h.StubUseCase),expect(o.execute()).toBe("stub")})})});
+//# sourceMappingURL=DeviceManagementKit.test.js.map