@ledgerhq/device-core 0.1.0

package/src/customLockScreen/screenSpecs.ts

@@ -0,0 +1,87 @@
+import { DeviceModelId } from "@ledgerhq/devices";
+import {
+  CLSSupportedDeviceModelId,
+  supportedDeviceModelIds,
+} from "../capabilities/isCustomLockScreenSupported";
+
+type ScreenSpecs = {
+  /** width of the screen in pixels */
+  width: number;
+  /** height of the screen in pixels */
+  height: number;
+  /** number of pixels at the top of the screen which are not visible */
+  paddingTop: number;
+  /** number of pixels at the bottom of the screen which are not visible */
+  paddingBottom: number;
+  /** number of pixels at the left of the screen which are not visible */
+  paddingLeft: number;
+  /** number of pixels at the right of the screen which are not visible */
+  paddingRight: number;
+};
+
+const NO_PADDING = {
+  paddingTop: 0,
+  paddingBottom: 0,
+  paddingLeft: 0,
+  paddingRight: 0,
+} as const;
+
+export const SCREEN_SPECS: Record<CLSSupportedDeviceModelId, ScreenSpecs> = {
+  [DeviceModelId.stax]: {
+    width: 400,
+    height: 672,
+    ...NO_PADDING,
+    paddingBottom: 2,
+  },
+  [DeviceModelId.europa]: {
+    width: 480,
+    height: 600,
+    ...NO_PADDING,
+  },
+};
+
+type Dimensions = {
+  width: number;
+  height: number;
+};
+
+export function getScreenSpecs(deviceModelId: CLSSupportedDeviceModelId) {
+  return SCREEN_SPECS[deviceModelId];
+}
+
+const screenDataDimensions: Record<CLSSupportedDeviceModelId, Dimensions> =
+  supportedDeviceModelIds.reduce(
+    (acc, deviceModelId) => {
+      const { width, height } = SCREEN_SPECS[deviceModelId];
+      acc[deviceModelId] = { width, height };
+      return acc;
+    },
+    {} as Record<CLSSupportedDeviceModelId, Dimensions>,
+  );
+
+export function getScreenDataDimensions(deviceModelId: CLSSupportedDeviceModelId) {
+  return screenDataDimensions[deviceModelId];
+}
+
+const screenVisibleAreaDimensions: Record<CLSSupportedDeviceModelId, Dimensions> =
+  supportedDeviceModelIds.reduce(
+    (acc, deviceModelId) => {
+      const { width, height, paddingTop, paddingBottom, paddingLeft, paddingRight } =
+        SCREEN_SPECS[deviceModelId];
+      acc[deviceModelId] = {
+        width: width - paddingLeft - paddingRight,
+        height: height - paddingTop - paddingBottom,
+      };
+      return acc;
+    },
+    {} as Record<CLSSupportedDeviceModelId, Dimensions>,
+  );
+
+/**
+ *
+ * @param deviceModelId
+ * @returns the dimensions of the visible area of the screen (without padding)
+ */
+export function getScreenVisibleAreaDimensions(deviceModelId: CLSSupportedDeviceModelId) {
+  return screenVisibleAreaDimensions[deviceModelId];
+}

package/src/index.ts

@@ -0,0 +1,33 @@
+// src/managerApi/
+export type { DeviceInfoEntity } from "./managerApi/entities/DeviceInfoEntity";
+export type {
+  FinalFirmware,
+  OsuFirmware,
+  FirmwareUpdateContextEntity,
+} from "./managerApi/entities/FirmwareUpdateContextEntity";
+export type { ManagerApiRepository } from "./managerApi/repositories/ManagerApiRepository";
+export { HttpManagerApiRepository } from "./managerApi/repositories/HttpManagerApiRepository";
+export { StubManagerApiRepository } from "./managerApi/repositories/StubManagerApiRepository";
+export { getLatestFirmwareForDevice } from "./managerApi/use-cases/getLatestFirmwareForDevice";
+export { isDeviceLocalizationSupported } from "./commands/use-cases/isDeviceLocalizationSupported";
+export { PROVIDERS, getProviderIdUseCase } from "./managerApi/use-cases/getProviderIdUseCase";
+export { fetchMcus } from "./managerApi/use-cases/fetchMcus";
+export { aDeviceInfoBuilder } from "./managerApi/entities/mocks/aDeviceInfo";
+// src/commands/
+export type { FirmwareInfoEntity } from "./commands/entities/FirmwareInfoEntity";
+export { GET_VERSION_APDU } from "./commands/use-cases/getVersion";
+export { parseGetVersionResponse } from "./commands/use-cases/parseGetVersionResponse";
+export { getDeviceName } from "./commands/use-cases/getDeviceName";
+export { isHardwareVersionSupported } from "./commands/use-cases/isHardwareVersionSupported";
+export { isBootloaderVersionSupported } from "./commands/use-cases/isBootloaderVersionSupported";
+export { getVersion } from "./commands/use-cases/getVersion";
+// src/capabilities/
+export {
+  type CLSSupportedDeviceModelId,
+  isCustomLockScreenSupported,
+} from "./capabilities/isCustomLockScreenSupported";
+export { isEditDeviceNameSupported } from "./capabilities/isEditDeviceNameSupported";
+export { isSyncOnboardingSupported } from "./capabilities/isSyncOnboardingSupported";
+export { supportedDeviceModelIds } from "./capabilities/isCustomLockScreenSupported";
+// src/customLockScreen/
+export * from "./customLockScreen/screenSpecs";

package/src/managerApi/entities/AppEntity.ts

@@ -0,0 +1,66 @@
+import { Id } from "./Id";
+
+export enum AppType {
+  app = "app", // NB Legacy from v1, drop after we default to v2.
+  currency = "currency",
+  plugin = "plugin",
+  tool = "tool",
+  swap = "swap",
+}
+
+/** App is higher level on top of Application and ApplicationVersion
+with all fields Live needs and in normalized form (but still serializable) */
+export type AppEntity = {
+  id: Id;
+  name: string;
+  displayName: string;
+  version: string;
+  currencyId: string | null | undefined;
+  description: string | null | undefined;
+  dateModified: string;
+  icon: string;
+  authorName: string | null | undefined;
+  supportURL: string | null | undefined;
+  contactURL: string | null | undefined;
+  sourceURL: string | null | undefined;
+  hash: string;
+  perso: string;
+  firmware: string;
+  firmware_key: string;
+  delete: string;
+  delete_key: string;
+  // we use names to identify an app
+  dependencies: string[];
+  bytes: number | null | undefined;
+  warning: string | null | undefined;
+  // -1 if coin not in marketcap, otherwise index in the tickers list of https://countervalues.api.live.ledger.com/tickers
+  indexOfMarketCap: number;
+  isDevTools: boolean;
+  type: AppType;
+};
+
+export type ApplicationV2Entity = {
+  versionId: Id;
+  versionName: string;
+  versionDisplayName: string;
+  version: string;
+  currencyId: string;
+  description: string;
+  applicationType: AppType;
+  dateModified: string;
+  icon: string;
+  authorName: string;
+  supportURL: string;
+  contactURL: string;
+  sourceURL: string;
+  hash: string;
+  perso: string;
+  parentName: string | null;
+  firmware: string;
+  firmwareKey: string;
+  delete: string;
+  deleteKey: string;
+  bytes: number;
+  warning: string | null;
+  isDevTools: boolean;
+};

package/src/managerApi/entities/DeviceInfoEntity.ts

@@ -0,0 +1,26 @@
+export type DeviceInfoEntity = {
+  mcuVersion: string;
+  // the raw mcu version
+  version: string;
+  // the version part, without the -osu
+  majMin: string;
+  // the x.y part of the x.y.z-v version
+  targetId: string | number;
+  // a technical id
+  isBootloader: boolean;
+  isRecoveryMode?: boolean;
+  isOSU: boolean;
+  providerName: string | null | undefined;
+  managerAllowed: boolean;
+  pinValidated: boolean;
+  // more precised raw versions
+  seVersion?: string;
+  mcuBlVersion?: string;
+  mcuTargetId?: number;
+  seTargetId?: number;
+  onboarded?: boolean;
+  hasDevFirmware?: boolean;
+  bootloaderVersion?: string;
+  hardwareVersion?: number;
+  languageId?: number;
+};

package/src/managerApi/entities/DeviceVersionEntity.ts

@@ -0,0 +1,17 @@
+import { Id } from "./Id";
+
+export type DeviceVersionEntity = {
+  id: Id;
+  name: string;
+  display_name: string;
+  target_id: string;
+  description: string;
+  device: Id;
+  providers: Array<Id>;
+  mcu_versions: Array<Id>;
+  se_firmware_final_versions: Array<Id>;
+  osu_versions: Array<Id>;
+  application_versions: Array<Id>;
+  date_creation: string;
+  date_last_modified: string;
+};

package/src/managerApi/entities/FirmwareUpdateContextEntity.ts

@@ -0,0 +1,44 @@
+import { Id } from "./Id";
+
+type BaseFirmware = {
+  id: Id;
+  name: string;
+  description: string | null | undefined;
+  display_name: string | null | undefined;
+  notes: string | null | undefined;
+  perso: string;
+  firmware: string;
+  firmware_key: string;
+  hash: string;
+  date_creation: string;
+  date_last_modified: string;
+  device_versions: Array<Id>;
+  providers: Array<Id>;
+};
+
+/**
+ *
+ */
+export type OsuFirmware = BaseFirmware & {
+  next_se_firmware_final_version: Id;
+  previous_se_firmware_final_version: Array<Id>;
+};
+
+/**
+ *
+ */
+export type FinalFirmware = BaseFirmware & {
+  version: string;
+  se_firmware: Id;
+  osu_versions: Array<OsuFirmware>;
+  mcu_versions: Array<Id>;
+  application_versions: Array<Id>;
+  bytes?: number;
+  updateAvailable?: FirmwareUpdateContextEntity | null | undefined;
+};
+
+export type FirmwareUpdateContextEntity = {
+  osu: OsuFirmware;
+  final: FinalFirmware;
+  shouldFlashMCU: boolean;
+};

package/src/managerApi/entities/Id.ts

@@ -0,0 +1 @@
+export type Id = number;

package/src/managerApi/entities/LanguagePackageEntity.ts

@@ -0,0 +1,21 @@
+export type Language = "french" | "english" | "spanish";
+
+export type LanguagePackageEntity = {
+  language: Language;
+  languagePackageVersionId: number;
+  version: string; // "0.0.1"
+  language_package_id: number;
+  apdu_install_url: string;
+  apdu_uninstall_url: string; // <= Useless
+  device_versions: number[];
+  se_firmware_final_versions: number[];
+  bytes: number;
+  date_creation: string;
+  date_last_modified: string;
+};
+
+export type LanguagePackageResponseEntity = {
+  id: number;
+  language: Language;
+  language_package_version: LanguagePackageEntity[];
+};

package/src/managerApi/entities/mocks/aDeviceInfo.ts

@@ -0,0 +1,16 @@
+import type { DeviceInfo } from "@ledgerhq/types-live";
+
+export const aDeviceInfoBuilder = (props?: Partial<DeviceInfo>): DeviceInfo => {
+  return {
+    mcuVersion: "A_MCU_VERSION",
+    version: "A_VERSION",
+    majMin: "A_MAJ_MIN",
+    targetId: "0.0",
+    isBootloader: false,
+    isOSU: true,
+    providerName: undefined,
+    managerAllowed: false,
+    pinValidated: true,
+    ...props,
+  };
+};

package/src/managerApi/entities/mocks/aDeviceVersion.ts

@@ -0,0 +1,22 @@
+import { DeviceVersionEntity } from "../DeviceVersionEntity";
+
+export const aDeviceVersionBuilder = (
+  props?: Partial<DeviceVersionEntity>,
+): DeviceVersionEntity => {
+  return {
+    name: "Ledger Nano S",
+    device: 3,
+    providers: [],
+    id: 5,
+    display_name: "Ledger Nano S",
+    target_id: "0x31100004",
+    description: "Ledger Nano S",
+    mcu_versions: [1.7],
+    se_firmware_final_versions: [1.2],
+    osu_versions: [],
+    application_versions: [],
+    date_creation: "2020-04-30T13:50:00.000Z",
+    date_last_modified: "2020-04-30T13:50:00.000Z",
+    ...props,
+  };
+};

package/src/managerApi/entities/mocks/aFinalFirmware.ts

@@ -0,0 +1,25 @@
+import { FinalFirmware } from "../FirmwareUpdateContextEntity";
+
+export const aFinalFirmwareBuilder = (props?: Partial<FinalFirmware>): FinalFirmware => {
+  return {
+    id: 1,
+    name: "FINAL",
+    description: null,
+    display_name: null,
+    notes: null,
+    perso: "",
+    firmware: "",
+    firmware_key: "",
+    hash: "",
+    date_creation: "",
+    date_last_modified: "",
+    device_versions: [],
+    providers: [],
+    version: "0",
+    se_firmware: 1,
+    osu_versions: [],
+    mcu_versions: [],
+    application_versions: [],
+    ...props,
+  };
+};

package/src/managerApi/entities/mocks/aOsuFirmware.ts

@@ -0,0 +1,22 @@
+import { OsuFirmware } from "../FirmwareUpdateContextEntity";
+
+export function aOsuFirmwareBuilder(props?: Partial<OsuFirmware>) {
+  return {
+    id: 0,
+    name: "",
+    display_name: "",
+    notes: "",
+    perso: "",
+    firmware: "",
+    firmware_key: "",
+    hash: "",
+    device_versions: [],
+    next_se_firmware_final_version: 0,
+    providers: [],
+    date_creation: "",
+    date_last_modified: "",
+    description: "",
+    previous_se_firmware_final_version: [],
+    ...props,
+  };
+}