✨ (transport): Extracted MockServer + mockserver-client

Also exported the factories to make it easier to pass to addTransport

.changeset/cool-dancers-join.md

@@ -5,7 +5,7 @@
 "@ledgerhq/device-signer-kit-ethereum": patch
 "@ledgerhq/tsconfig-dsdk": patch
 "@ledgerhq/prettier-config-dsdk": patch
-"@ledgerhq/device-transport-kit-mock-client": patch
+"@ledgerhq/device-mockserver-client": patch
 "@ledgerhq/eslint-config-dsdk": patch
 "@ledgerhq/device-sdk-trusted-apps": patch
 "@ledgerhq/jest-config-dsdk": patch

.changeset/lemon-suits-notice.md

@@ -2,7 +2,7 @@
 "@ledgerhq/device-management-kit-flipper-plugin-client": patch
 "@ledgerhq/device-signer-kit-solana": patch
 "@ledgerhq/device-signer-kit-ethereum": patch
-"@ledgerhq/device-transport-kit-mock-client": patch
+"@ledgerhq/device-mockserver-client": patch
 "@ledgerhq/device-management-kit": patch
 "@ledgerhq/device-management-kit-sample": patch
 ---

.changeset/smart-games-brush.md

@@ -1,5 +1,5 @@
 ---
-"@ledgerhq/device-transport-kit-mock-client": patch
+"@ledgerhq/device-mockserver-client": patch
 "@ledgerhq/device-management-kit": patch
 "@ledgerhq/device-management-kit-sample": patch
 ---

README.md

@@ -93,6 +93,7 @@ A brief description of this project packages:
 | @ledgerhq/device-management-kit-flipper-plugin-client | packages/flipper-plugin-client | external package that contains [flipper](https://github.com/facebook/flipper) logger for Device Management Kit                           |
 | @ledgerhq/device-transport-kit-web-hid                | packages/transport/web-hid     | external package that contains the Web Hid transport implementation                                                                      |
 | @ledgerhq/device-transport-kit-web-ble                | packages/transport/web-ble     | external package that contains the Web Ble transport implementation                                                                      |
+| @ledgerhq/device-mockserver-client                    | packages/mockserver-client     | external package that contains the client to interact with the mock-server                                                               |
 
 # Getting started
 
@@ -180,7 +181,7 @@ Please configure JEST extention accordingly.
 
 Each package is built using the following command (at the root of the monorepo).
 
-### Core
+### Devie Management Kit
 
 Device Management Kit main module.
 

apps/sample/package.json

@@ -18,9 +18,10 @@
     "@ledgerhq/context-module": "workspace:*",
     "@ledgerhq/device-management-kit": "workspace:*",
     "@ledgerhq/device-management-kit-flipper-plugin-client": "workspace:*",
+    "@ledgerhq/device-mockserver-client": "workspace:*",
     "@ledgerhq/device-signer-kit-ethereum": "workspace:*",
     "@ledgerhq/device-signer-kit-solana": "workspace:*",
-    "@ledgerhq/device-transport-kit-mock-client": "workspace:*",
+    "@ledgerhq/device-transport-kit-mockserver": "workspace:*",
     "@ledgerhq/device-transport-kit-web-ble": "workspace:*",
     "@ledgerhq/device-transport-kit-web-hid": "workspace:*",
     "@ledgerhq/react-ui": "^0.16.2",

apps/sample/src/components/MockView/MockDeviceDrawer.tsx

@@ -3,7 +3,7 @@ import {
   type Mock,
   type MockClient,
   type Session,
-} from "@ledgerhq/device-transport-kit-mock-client";
+} from "@ledgerhq/device-mockserver-client";
 import { Button, Divider, Flex, Input, Text } from "@ledgerhq/react-ui";
 import styled from "styled-components";
 

apps/sample/src/components/MockView/MockItem.tsx

@@ -1,5 +1,5 @@
 import React, { useState } from "react";
-import { type Mock } from "@ledgerhq/device-transport-kit-mock-client";
+import { type Mock } from "@ledgerhq/device-mockserver-client";
 import { Button, Flex, Icons, Input, Text } from "@ledgerhq/react-ui";
 
 type MockItemProps = {

apps/sample/src/components/MockView/index.tsx

@@ -1,5 +1,5 @@
 import React, { useCallback, useEffect, useState } from "react";
-import { type Session } from "@ledgerhq/device-transport-kit-mock-client";
+import { type Session } from "@ledgerhq/device-mockserver-client";
 import { Button, Flex, Text } from "@ledgerhq/react-ui";
 import styled from "styled-components";
 

apps/sample/src/hooks/useMockClient.ts

@@ -1,5 +1,5 @@
 import { useEffect, useState } from "react";
-import { MockClient } from "@ledgerhq/device-transport-kit-mock-client";
+import { MockClient } from "@ledgerhq/device-mockserver-client";
 
 export const useMockClient = (url: string): MockClient => {
   const [client, setClient] = useState(new MockClient(url));

apps/sample/src/providers/DeviceManagementKitProvider/index.tsx

@@ -8,8 +8,9 @@ import {
   WebLogsExporterLogger,
 } from "@ledgerhq/device-management-kit";
 import { FlipperDmkLogger } from "@ledgerhq/device-management-kit-flipper-plugin-client";
-import { WebBleTransport } from "@ledgerhq/device-transport-kit-web-ble";
-import { WebHidTransport } from "@ledgerhq/device-transport-kit-web-hid";
+import { mockserverTransportFactory } from "@ledgerhq/device-transport-kit-mockserver";
+import { webBleTransportFactory } from "@ledgerhq/device-transport-kit-web-ble";
+import { webHidTransportFactory } from "@ledgerhq/device-transport-kit-web-hid";
 
 import { useHasChanged } from "@/hooks/useHasChanged";
 import { useDmkConfigContext } from "@/providers/DmkConfig";
@@ -19,49 +20,23 @@ const LogsExporterContext = createContext<WebLogsExporterLogger | null>(null);
 
 function buildDefaultDmk(logsExporter: WebLogsExporterLogger) {
   return new DeviceManagementKitBuilder()
-    .addTransport(
-      ({
-        deviceModelDataSource,
-        loggerServiceFactory,
-        apduSenderServiceFactory,
-        apduReceiverServiceFactory,
-      }) =>
-        new WebHidTransport(
-          deviceModelDataSource,
-          loggerServiceFactory,
-          apduSenderServiceFactory,
-          apduReceiverServiceFactory,
-        ),
-    )
-    .addTransport(
-      ({
-        deviceModelDataSource,
-        loggerServiceFactory,
-        apduSenderServiceFactory,
-        apduReceiverServiceFactory,
-      }) =>
-        new WebBleTransport(
-          deviceModelDataSource,
-          loggerServiceFactory,
-          apduSenderServiceFactory,
-          apduReceiverServiceFactory,
-        ),
-    )
+    .addTransport(webHidTransportFactory)
+    .addTransport(webBleTransportFactory)
     .addLogger(new ConsoleLogger())
     .addLogger(logsExporter)
     .addLogger(new FlipperDmkLogger())
     .build();
 }
 
-// function buildMockDmk(url: string, logsExporter: WebLogsExporterLogger) {
-//   return new DeviceManagementKitBuilder()
-//     .addTransport(BuiltinTransports.MOCK_SERVER)
-//     .addLogger(new ConsoleLogger())
-//     .addLogger(logsExporter)
-//     .addLogger(new FlipperDmkLogger())
-//     .addConfig({ mockUrl: url })
-//     .build();
-// }
+function buildMockDmk(url: string, logsExporter: WebLogsExporterLogger) {
+  return new DeviceManagementKitBuilder()
+    .addTransport(mockserverTransportFactory)
+    .addLogger(new ConsoleLogger())
+    .addLogger(logsExporter)
+    .addLogger(new FlipperDmkLogger())
+    .addConfig({ mockUrl: url })
+    .build();
+}
 
 export const DmkProvider: React.FC<PropsWithChildren> = ({ children }) => {
   const {
@@ -71,10 +46,9 @@ export const DmkProvider: React.FC<PropsWithChildren> = ({ children }) => {
   const mockServerEnabled = transport === BuiltinTransports.MOCK_SERVER;
   const [state, setState] = useState(() => {
     const logsExporter = new WebLogsExporterLogger();
-    // const dmk = mockServerEnabled
-    //   ? buildMockDmk(mockServerUrl, logsExporter)
-    //   : buildDefaultDmk(logsExporter);
-    const dmk = buildDefaultDmk(logsExporter);
+    const dmk = mockServerEnabled
+      ? buildMockDmk(mockServerUrl, logsExporter)
+      : buildDefaultDmk(logsExporter);
     return { dmk, logsExporter };
   });
 
@@ -84,10 +58,9 @@ export const DmkProvider: React.FC<PropsWithChildren> = ({ children }) => {
   if (mockServerEnabledChanged || mockServerUrlChanged) {
     setState(({ logsExporter }) => {
       return {
-        dmk: buildDefaultDmk(logsExporter),
-        // dmk: mockServerEnabled
-        //   ? buildMockDmk(mockServerUrl, logsExporter)
-        //   : buildDefaultDmk(logsExporter),
+        dmk: mockServerEnabled
+          ? buildMockDmk(mockServerUrl, logsExporter)
+          : buildDefaultDmk(logsExporter),
         logsExporter,
       };
     });

package.json

@@ -21,12 +21,13 @@
     "signer-eth": "pnpm --filter @ledgerhq/device-signer-kit-ethereum",
     "signer-solana": "pnpm --filter @ledgerhq/device-signer-kit-solana",
     "signer-utils": "pnpm --filter @ledgerhq/signer-utils",
-    "mock-client": "pnpm --filter @ledgerhq/device-transport-kit-mock-client",
+    "mockserver-client": "pnpm --filter @ledgerhq/device-mockserver-client",
     "trusted-apps": "pnpm --filter @ledgerhq/device-sdk-trusted-apps",
     "ui": "pnpm --filter @ledgerhq/device-sdk-ui",
     "transports": "pnpm --filter @ledgerhq/device-transport-*",
     "transport-web-hid": "pnpm --filter @ledgerhq/device-transport-kit-web-hid",
     "transport-web-ble": "pnpm --filter @ledgerhq/device-transport-kit-web-ble",
+    "transport-mockserver": "pnpm --filter @ledgerhq/device-transport-kit-mockserver",
     "flipper": "pnpm --filter @ledgerhq/device-management-kit-flipper-plugin-client",
     "sample": "pnpm --filter @ledgerhq/device-management-kit-sample",
     "bump": "changeset version",

packages/device-management-kit/package.json

@@ -36,7 +36,7 @@
     "module:create": "pnpm hygen core-module with-prompt"
   },
   "dependencies": {
-    "@ledgerhq/device-transport-kit-mock-client": "workspace:*",
+    "@ledgerhq/device-mockserver-client": "workspace:*",
     "@sentry/minimal": "^6.19.7",
     "@statelyai/inspect": "^0.4.0",
     "axios": "^1.7.7",

packages/device-management-kit/src/api/index.ts

@@ -134,6 +134,7 @@ export { defaultApduSenderServiceStubBuilder } from "@api/device-session/service
 export { FramerUtils } from "@api/device-session/utils/FramerUtils";
 export { DeviceManagementKit } from "@api/DeviceManagementKit";
 export { DeviceManagementKitBuilder } from "@api/DeviceManagementKitBuilder";
+export { type DmkConfig } from "@api/DmkConfig";
 export { DeviceExchangeError, UnknownDeviceExchangeError } from "@api/Error";
 export { type DmkError } from "@api/Error";
 export { type LoggerPublisherService } from "@api/logger-publisher/service/LoggerPublisherService";

packages/transport-mock/package.json → packages/mockserver-client/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@ledgerhq/device-transport-kit-mock-client",
+  "name": "@ledgerhq/device-mockserver-client",
   "private": true,
   "version": "1.0.0",
   "license": "Apache-2.0",

packages/transport/mockserver/.prettierignore

@@ -0,0 +1,2 @@
+lib/*
+coverage/*

packages/transport/mockserver/.prettierrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require("@ledgerhq/prettier-config-dsdk"),
+};

packages/transport/mockserver/eslint.config.mjs

@@ -0,0 +1,13 @@
+import config from "@ledgerhq/eslint-config-dsdk";
+
+export default [
+  ...config,
+  {
+    ignores: ["eslint.config.mjs", "lib/*"],
+    languageOptions: {
+      parserOptions: {
+        project: "./tsconfig.json",
+      },
+    },
+  },
+];

packages/transport/mockserver/jest.config.ts

@@ -0,0 +1,25 @@
+/* eslint no-restricted-syntax: 0 */
+import { type JestConfigWithTsJest, pathsToModuleNameMapper } from "ts-jest";
+
+import { compilerOptions } from "./tsconfig.json";
+
+const paths = pathsToModuleNameMapper(compilerOptions.paths, {
+  prefix: "<rootDir>/",
+});
+
+const config: JestConfigWithTsJest = {
+  preset: "@ledgerhq/jest-config-dsdk",
+  // setupFiles: ["<rootDir>/jest.setup.ts"],
+  testPathIgnorePatterns: ["<rootDir>/lib/esm/", "<rootDir>/lib/cjs/"],
+  collectCoverageFrom: [
+    "src/**/*.ts",
+    "!src/**/*.stub.ts",
+    "!src/index.ts",
+    "!src/api/index.ts",
+  ],
+  moduleNameMapper: {
+    ...paths,
+  },
+};
+
+export default config;

packages/transport/mockserver/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@ledgerhq/device-transport-kit-mockserver",
+  "version": "0.0.1",
+  "license": "Apache-2.0",
+  "private": true,
+  "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"
+  ],
+  "scripts": {
+    "prebuild": "rimraf lib",
+    "build": "pnpm lmdk-build --entryPoints src/index.ts,src/**/*.ts --tsconfig tsconfig.prod.json --platform web",
+    "dev": "concurrently \"pnpm watch:builds\" \"pnpm watch:types\"",
+    "watch:builds": "pnpm lmdk-watch --entryPoints src/index.ts,src/**/*.ts --tsconfig tsconfig.prod.json --platform web",
+    "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",
+    "typecheck": "tsc --noEmit",
+    "test": "jest --passWithNoTests",
+    "test:watch": "pnpm test -- --watch",
+    "test:coverage": "pnpm test -- --coverage"
+  },
+  "dependencies": {
+    "@sentry/minimal": "^6.19.7",
+    "purify-ts": "^2.1.0"
+  },
+  "devDependencies": {
+    "@ledgerhq/device-management-kit": "workspace:*",
+    "@ledgerhq/device-mockserver-client": "workspace:*",
+    "@ledgerhq/esbuild-tools": "workspace:*",
+    "@ledgerhq/eslint-config-dsdk": "workspace:*",
+    "@ledgerhq/jest-config-dsdk": "workspace:*",
+    "@ledgerhq/prettier-config-dsdk": "workspace:*",
+    "@ledgerhq/tsconfig-dsdk": "workspace:*",
+    "rxjs": "^7.8.1",
+    "ts-node": "^10.9.2"
+  },
+  "peerDependencies": {
+    "@ledgerhq/device-management-kit": "workspace:*",
+    "rxjs": "^7.8.1"
+  }
+}