@arkts/image-manager 0.0.2

package/dist/index.d.cts

@@ -0,0 +1,264 @@
+import { a as OS, c as Stringifiable, d as DeployedImageConfigWithProductName, f as DeployedImageOptions, i as DeviceType, l as DeployedDevModel, m as FullDeployedImageOptions, n as ProductConfigItem, o as PascalCaseDeviceType, p as DevModel, r as Arch, s as SnakecaseDeviceType, t as ProductConfig, u as DeployedImageConfig } from "./product-config-Dk21FD9U.cjs";
+import { AxiosProgressEvent } from "axios";
+import { Emitter } from "mitt";
+import * as node_child_process0 from "node:child_process";
+import progress from "progress-stream";
+import * as node_os0 from "node:os";
+import * as node_fs0 from "node:fs";
+import * as node_path0 from "node:path";
+import * as node_process0 from "node:process";
+import * as node_crypto0 from "node:crypto";
+
+//#region src/images/local-image.d.ts
+interface LocalImage extends BaseImage, Stringifiable<LocalImage.Stringifiable> {
+  imageType: 'local';
+  createDeployer(name: string, config: DeployedImageConfigWithProductName): ImageDeployer;
+  getProductConfig(): Promise<ProductConfigItem[]>;
+  delete(): Promise<void | Error>;
+  buildStartCommand(deployer: ImageDeployer): Promise<string>;
+  start(deployer: ImageDeployer): Promise<node_child_process0.ChildProcess>;
+  buildStopCommand(deployer: ImageDeployer): Promise<string>;
+  stop(deployer: ImageDeployer): Promise<node_child_process0.ChildProcess>;
+}
+declare namespace LocalImage {
+  interface Stringifiable {
+    imageType: 'local';
+    path: string;
+    version: string;
+    apiVersion: string;
+    targetVersion: string;
+    checksum: string;
+  }
+}
+//#endregion
+//#region src/images/remote-image.d.ts
+interface RemoteImage extends BaseImage, Stringifiable<RemoteImage.Stringifiable> {
+  imageType: 'remote';
+}
+declare namespace RemoteImage {
+  interface Stringifiable {
+    imageType: 'remote';
+    path: string;
+    apiVersion: string;
+    checksum: string;
+  }
+}
+//#endregion
+//#region src/image-downloader.d.ts
+interface ImageDownloadProgressEvent extends AxiosProgressEvent {
+  /**
+   * The network speed of the download.
+   */
+  network: number;
+  /**
+   * The unit of the network speed.
+   */
+  unit: 'KB' | 'MB';
+  /**
+   * The increment of the {@linkcode ImageDownloadProgressEvent.percentage}.
+   */
+  increment: number;
+}
+interface ExtractProgressEvent extends progress.Progress {}
+type ImageDownloadEventMap = {
+  'download-progress': ImageDownloadProgressEvent;
+  'extract-progress': ExtractProgressEvent;
+};
+interface ImageDownloader<T extends BaseImage> extends Emitter<ImageDownloadEventMap> {
+  /**
+   * Start downloading the image.
+   *
+   * @param signal - The abort signal.
+   */
+  startDownload(signal?: AbortSignal): Promise<void>;
+  /**
+   * Check the checksum of the image.
+   *
+   * @param signal - The abort signal.
+   */
+  checkChecksum(signal?: AbortSignal): Promise<boolean>;
+  /**
+   * Extract the image.
+   *
+   * @param signal - The abort signal.
+   * @param symlinkOpenHarmonySdk - If true, symlink the OpenHarmony SDK to the image. Default is `true`.
+   */
+  extract(signal?: AbortSignal, symlinkOpenHarmonySdk?: boolean): Promise<void>;
+  /**
+   * Clean the cache of the image.
+   */
+  clean(): Promise<void>;
+  /**
+   * Get the image.
+   */
+  getImage(): T;
+  /**
+   * Get the URL of the image.
+   */
+  getUrl(): string;
+}
+//#endregion
+//#region src/options.d.ts
+interface ImageManagerOptions {
+  /**
+   * The base path to store the images.
+   */
+  imageBasePath?: string;
+  /**
+   * The path to store the deployed images.
+   */
+  deployedPath?: string;
+  /**
+   * The base path to store the downloaded images zip files.
+   *
+   * @default `imageBasePath/cache`
+   */
+  cachePath?: string;
+  /**
+   * The path to store the HarmonyOS SDK.
+   *
+   * - In macOS, it will be `/Applications/DevEco-Studio.app/Contents/sdk/default/openharmony` by default;
+   * - In Windows, it will be `C:\Program Files\Huawei\DevEco Studio\sdk\default\openharmony` by default;
+   * - In other platforms, it will be `~/.huawei/Sdk/default/openharmony` by default.
+   */
+  sdkPath?: string;
+  /**
+   * The path to store the HarmonyOS configuration files.
+   *
+   * - In macOS, it will be `~/Library/Application Support/Huawei/DevEcoStudio6.0` by default;
+   * - In Windows, it will be `%APPDATA%\Roaming\Huawei\DevEcoStudio6.0` by default;
+   * - In other platforms, it will be `~/.huawei/DevEcoStudio6.0` by default.
+   */
+  configPath?: string;
+  /**
+   * The path to store the HarmonyOS log files.
+   *
+   * - In macOS, it will be `~/Library/Logs/Huawei/DevEcoStudio6.0` by default;
+   * - In Windows, it will be `%APPDATA%\Local\Huawei\DevEcoStudio6.0\log` by default;
+   * - In other platforms, it will be `~/.huawei/DevEcoStudio6.0/log` by default.
+   */
+  logPath?: string;
+  /**
+   * The folder to store the emulator executable files.
+   *
+   * It must contain the `Emulator` (In windows, it will be `Emulator.exe`) executable file.
+   *
+   * - In macOS, it will be `/Applications/DevEco-Studio.app/Contents/tools/emulator`;
+   * - In Windows, it will be `C:\Program Files\Huawei\DevEco Studio\tools\emulator`;
+   * - In other platforms, it will be `~/.huawei/Emulator`.
+   */
+  emulatorPath?: string;
+  os?: typeof node_os0;
+  fs?: typeof node_fs0;
+  path?: typeof node_path0;
+  process?: typeof node_process0;
+  crypto?: typeof node_crypto0;
+  child_process?: typeof node_child_process0;
+}
+type ResolvedImageManagerOptions = Required<ImageManagerOptions>;
+//#endregion
+//#region src/image-manager.d.ts
+interface ImageManager {
+  /**
+   * Get the resolved options.
+   */
+  getOptions(): ResolvedImageManagerOptions;
+  /**
+   * Get the images.
+   */
+  getImages(): Promise<Image[]>;
+  /**
+   * Get the product config.
+   *
+   * It will automatically read from the `imageBasePath/productConfig.json` file if it exists.
+   * If the file does not exist, it will use the default product config.
+   */
+  getProductConfig(): Promise<ProductConfig>;
+  /**
+   * Write the product config.
+   *
+   * @param existSkip - If the file exists, skip writing. Defaults to `false`.
+   */
+  writeDefaultProductConfig(existSkip?: boolean): Promise<void>;
+  /**
+   * Get the operating system.
+   */
+  getOS(): OS;
+  /**
+   * Get the architecture.
+   */
+  getArch(): Arch;
+}
+declare function createImageManager(options?: ImageManagerOptions): Promise<ImageManager>;
+//#endregion
+//#region src/errors/request-url-error.d.ts
+declare class RequestUrlError extends Error {
+  readonly message: string;
+  readonly code: number;
+  readonly cause?: Error;
+  constructor(message: string, code: number, cause?: Error);
+}
+//#endregion
+//#region src/images/image.d.ts
+interface BaseImage {
+  getImageManager(): ImageManager;
+  getPath(): string;
+  getArch(): 'arm' | 'x86' | (string & {});
+  getChecksum(): string;
+  getVersion(): string;
+  getApiVersion(): string;
+  getTargetOS(): string;
+  getTargetVersion(): string;
+  getFsPath(): string;
+  getDeviceType(): DeviceType | (string & {});
+  getSnakecaseDeviceType(): SnakecaseDeviceType | (string & {});
+  getUrl(): Promise<string | RequestUrlError>;
+  isDownloaded(): Promise<boolean>;
+  createDownloader(signal?: AbortSignal): Promise<ImageDownloader<this> | RequestUrlError>;
+}
+type Image = LocalImage | RemoteImage;
+type ImageType = 'local' | 'remote';
+//#endregion
+//#region src/deployer/image-deployer.d.ts
+interface ImageDeployer {
+  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;
+  /**
+   * Build the list object of the current device.
+   *
+   * @returns The list object of the current device. Can be used to build the `lists.json` file.
+   */
+  buildList(): Promise<FullDeployedImageOptions>;
+  /**
+   * Build the `config.ini` object of the current device.
+   *
+   * @returns The `config.ini` object of the current device.
+   */
+  buildIni(): Promise<Record<string, string | undefined>>;
+  /**
+   * Build the `config.ini` string of the current device.
+   *
+   * @returns The `config.ini` string of the current device, can write to file directly.
+   */
+  toIniString(): Promise<string>;
+  /**
+   * Deploy the image.
+   *
+   * @param symlinkImage - If true, symlink the system image to current device directory. Default is `true`.
+   */
+  deploy(symlinkImage?: boolean): Promise<void | Error>;
+}
+//#endregion
+export { Arch, DeployedDevModel, DeployedImageConfig, DeployedImageConfigWithProductName, DeployedImageOptions, DevModel, DeviceType, FullDeployedImageOptions, Image, ImageDeployer, type ImageManager, type ImageManagerOptions, ImageType, LocalImage, OS, PascalCaseDeviceType, type ProductConfig, RemoteImage, RequestUrlError, SnakecaseDeviceType, Stringifiable, createImageManager };

package/dist/index.d.mts

@@ -0,0 +1,264 @@
+import { a as OS, c as Stringifiable, d as DeployedImageConfigWithProductName, f as DeployedImageOptions, i as DeviceType, l as DeployedDevModel, m as FullDeployedImageOptions, n as ProductConfigItem, o as PascalCaseDeviceType, p as DevModel, r as Arch, s as SnakecaseDeviceType, t as ProductConfig, u as DeployedImageConfig } from "./product-config-BbaYsaoV.mjs";
+import { AxiosProgressEvent } from "axios";
+import { Emitter } from "mitt";
+import progress from "progress-stream";
+import * as node_child_process0 from "node:child_process";
+import * as node_crypto0 from "node:crypto";
+import * as node_fs0 from "node:fs";
+import * as node_os0 from "node:os";
+import * as node_path0 from "node:path";
+import * as node_process0 from "node:process";
+
+//#region src/images/local-image.d.ts
+interface LocalImage extends BaseImage, Stringifiable<LocalImage.Stringifiable> {
+  imageType: 'local';
+  createDeployer(name: string, config: DeployedImageConfigWithProductName): ImageDeployer;
+  getProductConfig(): Promise<ProductConfigItem[]>;
+  delete(): Promise<void | Error>;
+  buildStartCommand(deployer: ImageDeployer): Promise<string>;
+  start(deployer: ImageDeployer): Promise<node_child_process0.ChildProcess>;
+  buildStopCommand(deployer: ImageDeployer): Promise<string>;
+  stop(deployer: ImageDeployer): Promise<node_child_process0.ChildProcess>;
+}
+declare namespace LocalImage {
+  interface Stringifiable {
+    imageType: 'local';
+    path: string;
+    version: string;
+    apiVersion: string;
+    targetVersion: string;
+    checksum: string;
+  }
+}
+//#endregion
+//#region src/images/remote-image.d.ts
+interface RemoteImage extends BaseImage, Stringifiable<RemoteImage.Stringifiable> {
+  imageType: 'remote';
+}
+declare namespace RemoteImage {
+  interface Stringifiable {
+    imageType: 'remote';
+    path: string;
+    apiVersion: string;
+    checksum: string;
+  }
+}
+//#endregion
+//#region src/image-downloader.d.ts
+interface ImageDownloadProgressEvent extends AxiosProgressEvent {
+  /**
+   * The network speed of the download.
+   */
+  network: number;
+  /**
+   * The unit of the network speed.
+   */
+  unit: 'KB' | 'MB';
+  /**
+   * The increment of the {@linkcode ImageDownloadProgressEvent.percentage}.
+   */
+  increment: number;
+}
+interface ExtractProgressEvent extends progress.Progress {}
+type ImageDownloadEventMap = {
+  'download-progress': ImageDownloadProgressEvent;
+  'extract-progress': ExtractProgressEvent;
+};
+interface ImageDownloader<T extends BaseImage> extends Emitter<ImageDownloadEventMap> {
+  /**
+   * Start downloading the image.
+   *
+   * @param signal - The abort signal.
+   */
+  startDownload(signal?: AbortSignal): Promise<void>;
+  /**
+   * Check the checksum of the image.
+   *
+   * @param signal - The abort signal.
+   */
+  checkChecksum(signal?: AbortSignal): Promise<boolean>;
+  /**
+   * Extract the image.
+   *
+   * @param signal - The abort signal.
+   * @param symlinkOpenHarmonySdk - If true, symlink the OpenHarmony SDK to the image. Default is `true`.
+   */
+  extract(signal?: AbortSignal, symlinkOpenHarmonySdk?: boolean): Promise<void>;
+  /**
+   * Clean the cache of the image.
+   */
+  clean(): Promise<void>;
+  /**
+   * Get the image.
+   */
+  getImage(): T;
+  /**
+   * Get the URL of the image.
+   */
+  getUrl(): string;
+}
+//#endregion
+//#region src/options.d.ts
+interface ImageManagerOptions {
+  /**
+   * The base path to store the images.
+   */
+  imageBasePath?: string;
+  /**
+   * The path to store the deployed images.
+   */
+  deployedPath?: string;
+  /**
+   * The base path to store the downloaded images zip files.
+   *
+   * @default `imageBasePath/cache`
+   */
+  cachePath?: string;
+  /**
+   * The path to store the HarmonyOS SDK.
+   *
+   * - In macOS, it will be `/Applications/DevEco-Studio.app/Contents/sdk/default/openharmony` by default;
+   * - In Windows, it will be `C:\Program Files\Huawei\DevEco Studio\sdk\default\openharmony` by default;
+   * - In other platforms, it will be `~/.huawei/Sdk/default/openharmony` by default.
+   */
+  sdkPath?: string;
+  /**
+   * The path to store the HarmonyOS configuration files.
+   *
+   * - In macOS, it will be `~/Library/Application Support/Huawei/DevEcoStudio6.0` by default;
+   * - In Windows, it will be `%APPDATA%\Roaming\Huawei\DevEcoStudio6.0` by default;
+   * - In other platforms, it will be `~/.huawei/DevEcoStudio6.0` by default.
+   */
+  configPath?: string;
+  /**
+   * The path to store the HarmonyOS log files.
+   *
+   * - In macOS, it will be `~/Library/Logs/Huawei/DevEcoStudio6.0` by default;
+   * - In Windows, it will be `%APPDATA%\Local\Huawei\DevEcoStudio6.0\log` by default;
+   * - In other platforms, it will be `~/.huawei/DevEcoStudio6.0/log` by default.
+   */
+  logPath?: string;
+  /**
+   * The folder to store the emulator executable files.
+   *
+   * It must contain the `Emulator` (In windows, it will be `Emulator.exe`) executable file.
+   *
+   * - In macOS, it will be `/Applications/DevEco-Studio.app/Contents/tools/emulator`;
+   * - In Windows, it will be `C:\Program Files\Huawei\DevEco Studio\tools\emulator`;
+   * - In other platforms, it will be `~/.huawei/Emulator`.
+   */
+  emulatorPath?: string;
+  os?: typeof node_os0;
+  fs?: typeof node_fs0;
+  path?: typeof node_path0;
+  process?: typeof node_process0;
+  crypto?: typeof node_crypto0;
+  child_process?: typeof node_child_process0;
+}
+type ResolvedImageManagerOptions = Required<ImageManagerOptions>;
+//#endregion
+//#region src/image-manager.d.ts
+interface ImageManager {
+  /**
+   * Get the resolved options.
+   */
+  getOptions(): ResolvedImageManagerOptions;
+  /**
+   * Get the images.
+   */
+  getImages(): Promise<Image[]>;
+  /**
+   * Get the product config.
+   *
+   * It will automatically read from the `imageBasePath/productConfig.json` file if it exists.
+   * If the file does not exist, it will use the default product config.
+   */
+  getProductConfig(): Promise<ProductConfig>;
+  /**
+   * Write the product config.
+   *
+   * @param existSkip - If the file exists, skip writing. Defaults to `false`.
+   */
+  writeDefaultProductConfig(existSkip?: boolean): Promise<void>;
+  /**
+   * Get the operating system.
+   */
+  getOS(): OS;
+  /**
+   * Get the architecture.
+   */
+  getArch(): Arch;
+}
+declare function createImageManager(options?: ImageManagerOptions): Promise<ImageManager>;
+//#endregion
+//#region src/errors/request-url-error.d.ts
+declare class RequestUrlError extends Error {
+  readonly message: string;
+  readonly code: number;
+  readonly cause?: Error;
+  constructor(message: string, code: number, cause?: Error);
+}
+//#endregion
+//#region src/images/image.d.ts
+interface BaseImage {
+  getImageManager(): ImageManager;
+  getPath(): string;
+  getArch(): 'arm' | 'x86' | (string & {});
+  getChecksum(): string;
+  getVersion(): string;
+  getApiVersion(): string;
+  getTargetOS(): string;
+  getTargetVersion(): string;
+  getFsPath(): string;
+  getDeviceType(): DeviceType | (string & {});
+  getSnakecaseDeviceType(): SnakecaseDeviceType | (string & {});
+  getUrl(): Promise<string | RequestUrlError>;
+  isDownloaded(): Promise<boolean>;
+  createDownloader(signal?: AbortSignal): Promise<ImageDownloader<this> | RequestUrlError>;
+}
+type Image = LocalImage | RemoteImage;
+type ImageType = 'local' | 'remote';
+//#endregion
+//#region src/deployer/image-deployer.d.ts
+interface ImageDeployer {
+  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;
+  /**
+   * Build the list object of the current device.
+   *
+   * @returns The list object of the current device. Can be used to build the `lists.json` file.
+   */
+  buildList(): Promise<FullDeployedImageOptions>;
+  /**
+   * Build the `config.ini` object of the current device.
+   *
+   * @returns The `config.ini` object of the current device.
+   */
+  buildIni(): Promise<Record<string, string | undefined>>;
+  /**
+   * Build the `config.ini` string of the current device.
+   *
+   * @returns The `config.ini` string of the current device, can write to file directly.
+   */
+  toIniString(): Promise<string>;
+  /**
+   * Deploy the image.
+   *
+   * @param symlinkImage - If true, symlink the system image to current device directory. Default is `true`.
+   */
+  deploy(symlinkImage?: boolean): Promise<void | Error>;
+}
+//#endregion
+export { Arch, DeployedDevModel, DeployedImageConfig, DeployedImageConfigWithProductName, DeployedImageOptions, DevModel, DeviceType, FullDeployedImageOptions, type Image, type ImageDeployer, type ImageManager, type ImageManagerOptions, type ImageType, type LocalImage, OS, PascalCaseDeviceType, type ProductConfig, type RemoteImage, RequestUrlError, SnakecaseDeviceType, Stringifiable, createImageManager };