@arkts/image-manager 0.2.3 → 0.3.1

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { a as DeviceType, c as SnakecaseDeviceType, d as DeployedImageConfig, f as DeployedImageConfigWithProductName, g as ProductNameable, h as FullDeployedImageOptions, i as Arch, l as Stringifiable, m as DevModel, n as ProductConfigItem, o as OS, p as DeployedImageOptions, r as createDeployedImageConfig, s as PascalCaseDeviceType, t as ProductConfig, u as DeployedDevModel } from "./product-config-C-0AD84Q.cjs";
+import { a as OS, c as Stringifiable, i as DeviceType, n as ProductConfigItem, o as PascalCaseDeviceType, r as Arch, s as SnakecaseDeviceType, t as ProductConfig } from "./product-config-2xNDbvax.cjs";
 import { AxiosProgressEvent } from "axios";
 import { Emitter } from "mitt";
 import * as node_child_process0 from "node:child_process";
@@ -15,14 +15,14 @@ declare let version: string;
 //#region src/images/local-image.d.ts
 interface LocalImage extends BaseImage, Stringifiable<LocalImage.Stringifiable> {
   imageType: 'local';
-  createDevice(name: string, config: DeployedImageConfigWithProductName): Device;
-  getProductConfig(): Promise<ProductConfigItem[]>;
-  delete(): Promise<void | Error>;
-  buildStartCommand(deployer: Device): Promise<string>;
-  start(deployer: Device): Promise<node_child_process0.ChildProcess>;
-  buildStopCommand(deployer: Device): Promise<string>;
-  stop(deployer: Device): Promise<node_child_process0.ChildProcess>;
   getDevices(): Promise<Device[]>;
+  createDevice(options: Device.Options): Device;
+  delete(): Promise<void | Error>;
+  start(device: Device): Promise<node_child_process0.ChildProcess>;
+  stop(device: Device): Promise<node_child_process0.ChildProcess>;
+  buildStartCommand(device: Device): Promise<string>;
+  buildStopCommand(device: Device): Promise<string>;
+  getProductConfig(): Promise<ProductConfigItem[]>;
 }
 declare namespace LocalImage {
   interface Stringifiable extends Omit<BaseImage.Stringifiable, 'imageType'> {
@@ -187,6 +187,10 @@ interface ImageManager {
    * Get the architecture.
    */
   getArch(): Arch;
+  /**
+   * Check if the emulator is compatible with current image manager.
+   */
+  isCompatible(): Promise<boolean>;
 }
 declare function createImageManager(options?: ImageManagerOptions): Promise<ImageManager>;
 //#endregion
@@ -196,6 +200,7 @@ declare class DeployError extends Error {
   readonly message: string;
   readonly cause?: Error;
   constructor(code: DeployError.Code, message: string, cause?: Error);
+  getCode(): DeployError.Code;
 }
 declare namespace DeployError {
   enum Code {
@@ -221,6 +226,7 @@ interface BaseImage {
   getPath(): string;
   getArch(): 'arm' | 'x86' | (string & {});
   getChecksum(): string;
+  getReleaseType(): string;
   getVersion(): string;
   getApiVersion(): string;
   getTargetOS(): string;
@@ -250,58 +256,275 @@ declare namespace BaseImage {
 type Image = LocalImage | RemoteImage;
 type ImageType = 'local' | 'remote';
 //#endregion
-//#region src/deployer/image-deployer.d.ts
-interface Device {
-  setUuid(uuid: `${string}-${string}-${string}-${string}-${string}`): this;
-  setModel(model: string): this;
-  setDevModel(devModel: FullDeployedImageOptions['devModel']): this;
-  setCpuNumber(cpuNumber: number): this;
-  setMemoryRamSize(memoryRamSize: number): this;
-  setDataDiskSize(dataDiskSize: number): this;
-  setCoverResolutionWidth(coverResolutionWidth: number | string): this;
-  setCoverResolutionHeight(coverResolutionHeight: number | string): this;
-  setCoverDiagonalSize(coverDiagonalSize: number | string): this;
-  setIsDefault(isDefault: boolean): this;
-  setIsCustomize(isCustomize: boolean): this;
-  setIsPublic(isPublic: boolean): this;
-  setVendorCountry(vendorCountry: string): this;
-  setHwHdcPort(hwHdcPort: string | number): this;
+//#region src/screens/screen.d.ts
+interface Screen {
+  getDiagonal(): number;
+  setDiagonal(diagonal: number): this;
+  getDensity(): number;
+  setDensity(density: number): this;
+  getHeight(): number;
+  setHeight(height: number): this;
+  getWidth(): number;
+  setWidth(width: number): this;
+  toJSON(): Screen.Options;
+}
+declare namespace Screen {
+  interface Options {
+    diagonal: number;
+    density: number;
+    height: number;
+    width: number;
+  }
+  interface Stringifiable extends Options {}
+}
+declare function createScreen(options: Screen.Options): Screen;
+//#endregion
+//#region src/screens/product-preset.d.ts
+interface ProductPreset {
+  getProductConfig(): ProductConfigItem;
+  getDeviceType(): PascalCaseDeviceType;
+  toScreen(): Screen;
+  toJSON(): ProductPreset.Stringifiable;
+}
+declare namespace ProductPreset {
+  interface Stringifiable {
+    product: ProductConfigItem;
+    deviceType: PascalCaseDeviceType;
+  }
+}
+declare function createProductPreset(productConfig: ProductConfigItem, deviceType: PascalCaseDeviceType): Promise<ProductPreset>;
+//#endregion
+//#region src/devices/list.d.ts
+declare enum DevModel {
+  MCHEMU_AL00CN = "MCHEMU-AL00CN",
+  PHEMU_FD00 = "PHEMU-FD00",
+  PHEMU_FD01 = "PHEMU-FD01",
+  PHEMU_FD02 = "PHEMU-FD02",
+  PHEMU_FD06 = "PHEMU-FD06",
+  PCEMU_FD00 = "PCEMU-FD00",
+  PCEMU_FD05 = "PCEMU-FD05"
+}
+type DeployedDevModel = 'MCHEMU-AL00CN' | 'PHEMU-FD00' | 'PHEMU-FD01' | 'PHEMU-FD02' | 'PHEMU-FD06' | 'PCEMU-FD00' | 'PCEMU-FD05' | DevModel | (string & {});
+type ProductNameable<T> = T & {
   /**
-   * Build the list object of the current device.
+   * The name of the product.
    *
-   * @returns The list object of the current device. Can be used to build the `lists.json` file.
+   * @example 'Mate 80 Pro Max、Mate 80 RS'
    */
-  buildList(): Promise<FullDeployedImageOptions>;
+  productName: string;
+};
+interface DeployedImageConfig {
   /**
-   * Build the `config.ini` object of the current device.
+   * Diagonal size.
    *
-   * @returns The `config.ini` object of the current device.
+   * @example '1.6'
    */
-  buildIni(): Promise<Record<string, string | undefined>>;
+  diagonalSize: string;
   /**
-   * Build the `config.ini` string of the current device.
+   * Density.
    *
-   * @returns The `config.ini` string of the current device, can write to file directly.
+   * @example '320'
    */
-  toIniString(): Promise<string>;
+  density: string;
   /**
-   * Deploy the device.
+   * Resolution height.
    *
-   * @param symlinkImage - If true, symlink the system image to current device directory. Default is `true`.
+   * @example '466'
    */
-  deploy(symlinkImage?: boolean): Promise<void | Error>;
+  resolutionHeight: string;
   /**
-   * Check if the device is deployed.
+   * Resolution width.
    *
-   * @returns True if the device is deployed, false otherwise.
+   * @example '466'
    */
-  isDeployed(): Promise<boolean>;
+  resolutionWidth: string;
+}
+interface DeployedImageConfigWithProductName extends DeployedImageConfig {
   /**
-   * Delete the device.
+   * The name of the product.
    *
-   * @returns True if the device is deleted, false otherwise.
+   * @example 'Mate 80 Pro Max、Mate 80 RS'
    */
-  delete(): Promise<void | Error>;
+  productName: string;
+}
+interface DeployedImageOptions extends DeployedImageConfig {
+  /**
+   * RAM size.
+   *
+   * @example '4096'
+   */
+  'memoryRamSize': string;
+  /**
+   * CPU number.
+   *
+   * @example '4'
+   */
+  'cpuNumber': string;
+  /**
+   * Data disk size.
+   *
+   * @example '6144'
+   */
+  'dataDiskSize': string;
+  /**
+   * Deployed name.
+   *
+   * @example 'Huawei_Wearable'
+   */
+  'name': string;
+  /**
+   * UUID.
+   *
+   * @example 'ce454934-3a1b-4770-9838-dc85c5d7b6c1'
+   */
+  'uuid': string;
+  /**
+   * OpenHarmony/HarmonyOS version.
+   *
+   * @example '6.0.1'
+   */
+  'hw.apiName': string;
+  /**
+   * Device model.
+   *
+   * @example 'MCHEMU-AL00CN'
+   */
+  'devModel'?: DeployedDevModel;
+  /**
+   * Model.
+   *
+   * @example 'Mate 80 Pro Max、Mate 80 RS'
+   */
+  'model'?: string;
+}
+interface FullDeployedImageOptions extends DeployedImageOptions {
+  /**
+   * Image directory.
+   *
+   * @example 'system-image/HarmonyOS-6.0.1/wearable_arm/'
+   */
+  'imageDir': string;
+  /**
+   * Image SDK version.
+   *
+   * @example '6.0.0.112'
+   */
+  'version': string;
+  /**
+   * Device type.
+   *
+   * @example 'wearable', 'phone', 'tablet'
+   */
+  'type': 'wearable' | 'phone' | 'tablet' | '2in1' | 'tv' | (string & {});
+  /**
+   * Architecture.
+   *
+   * @example 'arm'
+   */
+  'abi': string;
+  /**
+   * API version.
+   *
+   * @example '21'
+   */
+  'apiVersion': string;
+  /**
+   * Deployed path.
+   *
+   * @example '/Users/xxx/.Huawei/Emulator/deployed/Huawei_Wearable'
+   */
+  'path': string;
+  /**
+   * Show version.
+   *
+   * @example 'HarmonyOS 6.0.1(21)'
+   */
+  'showVersion': string;
+  /**
+   * HarmonyOS version.
+   *
+   * @example 'HarmonyOS-6.0.1'
+   */
+  'harmonyOSVersion'?: string;
+  /**
+   * Guest version.
+   *
+   * @example 'HarmonyOS 6.0.1(21)'
+   */
+  'guestVersion'?: string;
+  /**
+   * Cover resolution width.
+   *
+   * @example '2472'
+   */
+  'coverResolutionWidth'?: string;
+  /**
+   * Cover resolution height.
+   *
+   * @example '1648'
+   */
+  'coverResolutionHeight'?: string;
+  /**
+   * Cover diagonal size.
+   *
+   * @example '13.0'
+   */
+  'coverDiagonalSize'?: string;
+  /**
+   * HarmonyOS SDK path.
+   *
+   * @example '/Applications/DevEco-Studio.app/Contents/sdk'
+   */
+  'harmonyos.sdk.path': string;
+  /**
+   * HarmonyOS config path.
+   *
+   * @example '/Users/xxx/Library/Application Support/Huawei/DevEcoStudio6.0'
+   */
+  'harmonyos.config.path': string;
+  /**
+   * HarmonyOS log path.
+   *
+   * @example '/Users/xxx/Library/Logs/Huawei/DevEcoStudio6.0'
+   */
+  'harmonyos.log.path': string;
+}
+//#endregion
+//#region src/devices/device.d.ts
+interface Device {
+  getOptions(): Device.Options;
+  getImage(): LocalImage;
+  setUuid(uuid: Device.UUID): this;
+  getUuid(): Device.UUID;
+  buildList(): FullDeployedImageOptions;
+  buildIni(): Record<string, string | undefined>;
+  toIniString(): Promise<string>;
+  deploy(): Promise<void>;
+  delete(): Promise<void>;
+  isDeployed(): Promise<boolean>;
+  toJSON(): Device.Stringifiable;
+}
+declare namespace Device {
+  type UUID = `${string}-${string}-${string}-${string}-${string}`;
+  interface Options {
+    name: string;
+    cpuNumber: number;
+    diskSize: number;
+    memorySize: number;
+    screen: Screen | ProductPreset;
+  }
+  interface IniOptions {
+    /** @default CN */
+    vendorCountry?: string;
+    /** @default true */
+    isPublic?: boolean;
+    /** Override the ini options. */
+    overrides?: Record<string, string | undefined>;
+  }
+  interface Stringifiable extends Omit<Options, 'screen'> {
+    list: FullDeployedImageOptions;
+    ini: Record<string, string | undefined>;
+  }
 }
 //#endregion
-export { Arch, DeployError, DeployedDevModel, DeployedImageConfig, DeployedImageConfigWithProductName, DeployedImageOptions, DevModel, Device, DeviceType, FullDeployedImageOptions, Image, type ImageManager, type ImageManagerOptions, ImageType, LocalImage, OS, PascalCaseDeviceType, type ProductConfig, type ProductConfigItem, ProductNameable, RemoteImage, RequestUrlError, SnakecaseDeviceType, Stringifiable, createDeployedImageConfig, createImageManager, version };
+export { Arch, DeployError, DeployedDevModel, DeployedImageConfig, DeployedImageConfigWithProductName, DeployedImageOptions, DevModel, Device, DeviceType, FullDeployedImageOptions, Image, type ImageManager, type ImageManagerOptions, ImageType, LocalImage, OS, PascalCaseDeviceType, type ProductConfig, type ProductConfigItem, ProductNameable, ProductPreset, RemoteImage, RequestUrlError, Screen, SnakecaseDeviceType, Stringifiable, createImageManager, createProductPreset, createScreen, version };