@ledgerhq/device-management-kit 0.6.4 → 0.6.5

package/lib/types/src/internal/secure-channel/service/DefaultSecureChannelService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DefaultSecureChannelService.d.ts","sourceRoot":"","sources":["../../../../../../src/internal/secure-channel/service/DefaultSecureChannelService.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,uDAAuD,CAAC;AAErG,OAAO,EAAE,wBAAwB,EAAE,MAAM,uCAAuC,CAAC;AAUjF,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,qBACa,2BAA4B,YAAW,oBAAoB;IAGpE,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAAV,UAAU,EAAE,uBAAuB;IAGtD,YAAY,CACV,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,aAAa,GAC3B,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC;IAQ9C,UAAU,CACR,UAAU,EAAE,oBAAoB,EAChC,GAAG,EAAE,WAAW,GACf,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC;IAa9C,iBAAiB,CACf,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,aAAa,GAC3B,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC;IAQ9C,YAAY,CACV,UAAU,EAAE,oBAAoB,EAChC,GAAG,EAAE,WAAW,GACf,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC;IAa9C,cAAc,CACZ,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,aAAa,GAC3B,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC;IAU9C,SAAS,CACP,UAAU,EAAE,oBAAoB,EAChC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GACzB,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC;CAO/C"}
+{"version":3,"file":"DefaultSecureChannelService.d.ts","sourceRoot":"","sources":["../../../../../../src/internal/secure-channel/service/DefaultSecureChannelService.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,yCAAyC,CAAC;AAC3E,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,uDAAuD,CAAC;AAErG,OAAO,EAAE,wBAAwB,EAAE,MAAM,uCAAuC,CAAC;AAUjF,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,qBACa,2BAA4B,YAAW,oBAAoB;IAGpE,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAAV,UAAU,EAAE,uBAAuB;IAGtD,YAAY,CACV,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,aAAa,GAC3B,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC;IAQ9C,UAAU,CACR,UAAU,EAAE,oBAAoB,EAChC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,GAAG,UAAU,GAAG,aAAa,GAAG,MAAM,CAAC,GACpE,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC;IAY9C,iBAAiB,CACf,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,aAAa,GAC3B,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC;IAQ9C,YAAY,CACV,UAAU,EAAE,oBAAoB,EAChC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,CAAC,GAChE,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC;IAY9C,cAAc,CACZ,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,aAAa,GAC3B,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC;IAU9C,SAAS,CACP,UAAU,EAAE,oBAAoB,EAChC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GACzB,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC;CAO/C"}

package/lib/types/src/internal/secure-channel/service/SecureChannelService.d.ts

@@ -5,16 +5,50 @@ import { type Application } from "../../manager-api/model/Application";
 import { type FinalFirmware } from "../../manager-api/model/Firmware";
 import { type WebSocketConnectionError } from "../../secure-channel/model/Errors";
 /**
- * Interface representing the Secure Channel Service.
- * Some parameters are placeholders and will be updated when relative HTTP requests are ready.
+ * Interface representing a secure channel service for device management.
  */
 export interface SecureChannelService {
+    /**
+     * Construct a WebSocket connection for genuine check.
+     * @param deviceInfo - Response of the GetOsVersionCommand.
+     * @param finalFirmware - Response of the GetFirmwareVersion HTTP request in manager API.
+     * @returns Either a WebSocketConnectionError or a WebSocket.
+     */
     genuineCheck(deviceInfo: GetOsVersionResponse, finalFirmware: FinalFirmware): Either<WebSocketConnectionError, WebSocket>;
-    installApp(deviceInfo: GetOsVersionResponse, app: Application): Either<WebSocketConnectionError, WebSocket>;
+    /**
+     * Construct a WebSocket connection for installing an application.
+     * @param deviceInfo - Response of the GetOsVersionCommand.
+     * @param app - The application to be installed, must have perso, firmware, firmwareKey, and hash properties.
+     * @returns Either a WebSocketConnectionError or a WebSocket.
+     */
+    installApp(deviceInfo: GetOsVersionResponse, app: Pick<Application, "perso" | "firmware" | "firmwareKey" | "hash">): Either<WebSocketConnectionError, WebSocket>;
+    /**
+     * Construct a WebSocket connection for listing installed applications.
+     * @param deviceInfo - Response of the GetOsVersionCommand.
+     * @param finalFirmware - Response of the GetFirmwareVersion HTTP request in manager API.
+     * @returns Either a WebSocketConnectionError or a WebSocket.
+     */
     listInstalledApps(deviceInfo: GetOsVersionResponse, finalFirmware: FinalFirmware): Either<WebSocketConnectionError, WebSocket>;
-    uninstallApp(deviceInfo: GetOsVersionResponse, app: Application): Either<WebSocketConnectionError, WebSocket>;
-    updateFirmware(deviceInfo: GetOsVersionResponse, finalFirmware: FinalFirmware): Either<WebSocketConnectionError, WebSocket>;
+    /**
+     * Construct a WebSocket connection for uninstalling an application.
+     * @param deviceInfo - Response of the GetOsVersionCommand.
+     * @param app - The application to be uninstalled, must have perso, delete, deleteKey, and hash properties.
+     * @returns Either a WebSocketConnectionError or a WebSocket.
+     */
+    uninstallApp(deviceInfo: GetOsVersionResponse, app: Pick<Application, "perso" | "delete" | "deleteKey" | "hash">): Either<WebSocketConnectionError, WebSocket>;
+    /**
+     * Construct a WebSocket connection for updating the firmware of the device.
+     * @param deviceInfo - Response of the GetOsVersionCommand.
+     * @param finalFirmware - The final firmware to be updated.
+     * @returns Either a WebSocketConnectionError or a WebSocket.
+     */
     updateFirmware(deviceInfo: GetOsVersionResponse, finalFirmware: FinalFirmware): Either<WebSocketConnectionError, WebSocket>;
+    /**
+     * Construct a WebSocket connection for updating the MCU (Microcontroller Unit) of the device.
+     * @param deviceInfo -  Response of the GetOsVersionCommand.
+     * @param param - Parameters for the MCU update, including the version.
+     * @returns Either a WebSocketConnectionError or a WebSocket.
+     */
     updateMcu(deviceInfo: GetOsVersionResponse, param: {
         version: string;
     }): Either<WebSocketConnectionError, WebSocket>;

package/lib/types/src/internal/secure-channel/service/SecureChannelService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SecureChannelService.d.ts","sourceRoot":"","sources":["../../../../../../src/internal/secure-channel/service/SecureChannelService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,SAAS,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,WAAW,CAAC;AAExC,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,yCAAyC,CAAC;AAC3E,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,uCAAuC,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,YAAY,CACV,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,aAAa,GAC3B,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAC/C,UAAU,CACR,UAAU,EAAE,oBAAoB,EAChC,GAAG,EAAE,WAAW,GACf,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAC/C,iBAAiB,CACf,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,aAAa,GAC3B,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAC/C,YAAY,CACV,UAAU,EAAE,oBAAoB,EAChC,GAAG,EAAE,WAAW,GACf,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAC/C,cAAc,CACZ,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,aAAa,GAC3B,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAC/C,cAAc,CACZ,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,aAAa,GAC3B,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAE/C,SAAS,CACP,UAAU,EAAE,oBAAoB,EAChC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GACzB,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;CAChD"}
+{"version":3,"file":"SecureChannelService.d.ts","sourceRoot":"","sources":["../../../../../../src/internal/secure-channel/service/SecureChannelService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,SAAS,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,WAAW,CAAC;AAExC,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,yCAAyC,CAAC;AAC3E,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,uCAAuC,CAAC;AAEtF;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,YAAY,CACV,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,aAAa,GAC3B,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,UAAU,CACR,UAAU,EAAE,oBAAoB,EAChC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,GAAG,UAAU,GAAG,aAAa,GAAG,MAAM,CAAC,GACpE,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,iBAAiB,CACf,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,aAAa,GAC3B,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,YAAY,CACV,UAAU,EAAE,oBAAoB,EAChC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,CAAC,GAChE,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,cAAc,CACZ,UAAU,EAAE,oBAAoB,EAChC,aAAa,EAAE,aAAa,GAC3B,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,SAAS,CACP,UAAU,EAAE,oBAAoB,EAChC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GACzB,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;CAChD"}