@midscene/harmony 1.4.7-beta-20260226072540.0

package/dist/types/cli.d.ts

@@ -0,0 +1 @@
+export { }

package/dist/types/index.d.ts

@@ -0,0 +1,139 @@
+import { AbstractInterface } from '@midscene/core/device';
+import type { ActionParam } from '@midscene/core';
+import type { ActionReturn } from '@midscene/core';
+import { Agent } from '@midscene/core/agent';
+import { AgentOpt } from '@midscene/core/agent';
+import { DeviceAction } from '@midscene/core';
+import type { ElementInfo } from '@midscene/shared/extractor';
+import { HarmonyDeviceOpt } from '@midscene/core/device';
+import { InterfaceType } from '@midscene/core';
+import { LocateResultElement } from '@midscene/core';
+import { overrideAIConfig } from '@midscene/shared/env';
+import { Point } from '@midscene/core';
+import { Size } from '@midscene/core';
+
+declare type ActionArgs<T extends DeviceAction> = [ActionParam<T>] extends [undefined] ? [] : [ActionParam<T>];
+
+export declare function agentFromHdcDevice(deviceId?: string, opts?: HarmonyAgentOpt & HarmonyDeviceOpt): Promise<HarmonyAgent>;
+
+declare type DeviceActionHarmonyBackButton = DeviceAction<undefined, void>;
+
+declare type DeviceActionHarmonyHomeButton = DeviceAction<undefined, void>;
+
+declare type DeviceActionHarmonyRecentAppsButton = DeviceAction<undefined, void>;
+
+export declare function getConnectedDevices(hdcPath?: string): Promise<HarmonyDevice_2[]>;
+
+export declare class HarmonyAgent extends Agent<HarmonyDevice> {
+    back: WrappedAction<DeviceActionHarmonyBackButton>;
+    home: WrappedAction<DeviceActionHarmonyHomeButton>;
+    recentApps: WrappedAction<DeviceActionHarmonyRecentAppsButton>;
+    private appNameMapping;
+    constructor(device: HarmonyDevice, opts?: HarmonyAgentOpt);
+    launch(uri: string): Promise<void>;
+    runHdcShell(command: string): Promise<string>;
+    private createActionWrapper;
+}
+
+export declare type HarmonyAgentOpt = AgentOpt & {
+    /**
+     * Custom mapping of app names to bundle names
+     * User-provided mappings will take precedence over default mappings
+     */
+    appNameMapping?: Record<string, string>;
+};
+
+export declare class HarmonyDevice implements AbstractInterface {
+    private deviceId;
+    private hdc;
+    private connecting;
+    private destroyed;
+    private descriptionText;
+    private customActions?;
+    private cachedScreenSize;
+    private appNameMapping;
+    private lastTapPosition;
+    interfaceType: InterfaceType;
+    uri: string | undefined;
+    options?: HarmonyDeviceOpt;
+    actionSpace(): DeviceAction<any>[];
+    constructor(deviceId: string, options?: HarmonyDeviceOpt);
+    describe(): string;
+    connect(): Promise<HdcClient>;
+    getHdc(): Promise<HdcClient>;
+    setAppNameMapping(mapping: Record<string, string>): void;
+    private resolvePackageName;
+    launch(uri: string): Promise<HarmonyDevice>;
+    getScreenSize(): Promise<{
+        width: number;
+        height: number;
+    }>;
+    size(): Promise<Size>;
+    screenshotBase64(): Promise<string>;
+    tap(x: number, y: number): Promise<void>;
+    doubleTap(x: number, y: number): Promise<void>;
+    longPress(x: number, y: number): Promise<void>;
+    inputText(text: string, element?: LocateResultElement, shouldReplace?: boolean): Promise<void>;
+    clearInput(_element?: ElementInfo): Promise<void>;
+    keyboardPress(key: string): Promise<void>;
+    private normalizeKeyName;
+    scroll(deltaX: number, deltaY: number, speed?: number): Promise<void>;
+    scrollDown(distance?: number, startPoint?: Point): Promise<void>;
+    scrollUp(distance?: number, startPoint?: Point): Promise<void>;
+    scrollLeft(distance?: number, startPoint?: Point): Promise<void>;
+    scrollRight(distance?: number, startPoint?: Point): Promise<void>;
+    scrollUntilTop(startPoint?: Point): Promise<void>;
+    scrollUntilBottom(startPoint?: Point): Promise<void>;
+    scrollUntilLeft(startPoint?: Point): Promise<void>;
+    scrollUntilRight(startPoint?: Point): Promise<void>;
+    back(): Promise<void>;
+    home(): Promise<void>;
+    recentApps(): Promise<void>;
+    hideKeyboard(): Promise<void>;
+    getTimestamp(): Promise<number>;
+    destroy(): Promise<void>;
+}
+
+declare interface HarmonyDevice_2 {
+    deviceId: string;
+}
+
+declare class HdcClient {
+    private hdcPath;
+    private deviceId;
+    private timeout;
+    constructor(options: HdcOptions);
+    private buildArgs;
+    exec(...args: string[]): Promise<string>;
+    shell(command: string): Promise<string>;
+    fileSend(localPath: string, remotePath: string): Promise<void>;
+    fileRecv(remotePath: string, localPath: string): Promise<void>;
+    screenshot(remotePath: string): Promise<void>;
+    click(x: number, y: number): Promise<void>;
+    doubleClick(x: number, y: number): Promise<void>;
+    longClick(x: number, y: number): Promise<void>;
+    swipe(fromX: number, fromY: number, toX: number, toY: number, speed?: number): Promise<void>;
+    fling(fromX: number, fromY: number, toX: number, toY: number, speed?: number): Promise<void>;
+    drag(fromX: number, fromY: number, toX: number, toY: number, speed?: number): Promise<void>;
+    inputText(x: number, y: number, text: string): Promise<void>;
+    keyEvent(...keys: string[]): Promise<void>;
+    startAbility(bundleName: string, abilityName: string): Promise<void>;
+    forceStop(bundleName: string): Promise<void>;
+    getScreenInfo(): Promise<{
+        width: number;
+        height: number;
+    }>;
+    listTargets(): Promise<string[]>;
+}
+
+declare interface HdcOptions {
+    hdcPath?: string;
+    deviceId?: string;
+    timeout?: number;
+}
+
+export { overrideAIConfig }
+
+declare type WrappedAction<T extends DeviceAction> = (...args: ActionArgs<T>) => Promise<ActionReturn<T>>;
+
+export { }

package/dist/types/mcp-server.d.ts

@@ -0,0 +1,157 @@
+import { AbstractInterface } from '@midscene/core/device';
+import type { ActionParam } from '@midscene/core';
+import type { ActionReturn } from '@midscene/core';
+import { Agent } from '@midscene/core/agent';
+import { AgentOpt } from '@midscene/core/agent';
+import { BaseMCPServer } from '@midscene/shared/mcp';
+import { BaseMidsceneTools } from '@midscene/shared/mcp';
+import { DeviceAction } from '@midscene/core';
+import type { ElementInfo } from '@midscene/shared/extractor';
+import { HarmonyDeviceOpt } from '@midscene/core/device';
+import { InterfaceType } from '@midscene/core';
+import { LaunchMCPServerOptions } from '@midscene/shared/mcp';
+import { LaunchMCPServerResult } from '@midscene/shared/mcp';
+import { LocateResultElement } from '@midscene/core';
+import { Point } from '@midscene/core';
+import { Size } from '@midscene/core';
+import { Tool } from '@midscene/shared/mcp';
+import { ToolDefinition } from '@midscene/shared/mcp';
+
+declare type ActionArgs<T extends DeviceAction> = [ActionParam<T>] extends [undefined] ? [] : [ActionParam<T>];
+
+declare type DeviceActionHarmonyBackButton = DeviceAction<undefined, void>;
+
+declare type DeviceActionHarmonyHomeButton = DeviceAction<undefined, void>;
+
+declare type DeviceActionHarmonyRecentAppsButton = DeviceAction<undefined, void>;
+
+declare class HarmonyAgent extends Agent<HarmonyDevice> {
+    back: WrappedAction<DeviceActionHarmonyBackButton>;
+    home: WrappedAction<DeviceActionHarmonyHomeButton>;
+    recentApps: WrappedAction<DeviceActionHarmonyRecentAppsButton>;
+    private appNameMapping;
+    constructor(device: HarmonyDevice, opts?: HarmonyAgentOpt);
+    launch(uri: string): Promise<void>;
+    runHdcShell(command: string): Promise<string>;
+    private createActionWrapper;
+}
+
+declare type HarmonyAgentOpt = AgentOpt & {
+    /**
+     * Custom mapping of app names to bundle names
+     * User-provided mappings will take precedence over default mappings
+     */
+    appNameMapping?: Record<string, string>;
+};
+
+declare class HarmonyDevice implements AbstractInterface {
+    private deviceId;
+    private hdc;
+    private connecting;
+    private destroyed;
+    private descriptionText;
+    private customActions?;
+    private cachedScreenSize;
+    private appNameMapping;
+    private lastTapPosition;
+    interfaceType: InterfaceType;
+    uri: string | undefined;
+    options?: HarmonyDeviceOpt;
+    actionSpace(): DeviceAction<any>[];
+    constructor(deviceId: string, options?: HarmonyDeviceOpt);
+    describe(): string;
+    connect(): Promise<HdcClient>;
+    getHdc(): Promise<HdcClient>;
+    setAppNameMapping(mapping: Record<string, string>): void;
+    private resolvePackageName;
+    launch(uri: string): Promise<HarmonyDevice>;
+    getScreenSize(): Promise<{
+        width: number;
+        height: number;
+    }>;
+    size(): Promise<Size>;
+    screenshotBase64(): Promise<string>;
+    tap(x: number, y: number): Promise<void>;
+    doubleTap(x: number, y: number): Promise<void>;
+    longPress(x: number, y: number): Promise<void>;
+    inputText(text: string, element?: LocateResultElement, shouldReplace?: boolean): Promise<void>;
+    clearInput(_element?: ElementInfo): Promise<void>;
+    keyboardPress(key: string): Promise<void>;
+    private normalizeKeyName;
+    scroll(deltaX: number, deltaY: number, speed?: number): Promise<void>;
+    scrollDown(distance?: number, startPoint?: Point): Promise<void>;
+    scrollUp(distance?: number, startPoint?: Point): Promise<void>;
+    scrollLeft(distance?: number, startPoint?: Point): Promise<void>;
+    scrollRight(distance?: number, startPoint?: Point): Promise<void>;
+    scrollUntilTop(startPoint?: Point): Promise<void>;
+    scrollUntilBottom(startPoint?: Point): Promise<void>;
+    scrollUntilLeft(startPoint?: Point): Promise<void>;
+    scrollUntilRight(startPoint?: Point): Promise<void>;
+    back(): Promise<void>;
+    home(): Promise<void>;
+    recentApps(): Promise<void>;
+    hideKeyboard(): Promise<void>;
+    getTimestamp(): Promise<number>;
+    destroy(): Promise<void>;
+}
+
+export declare class HarmonyMCPServer extends BaseMCPServer {
+    constructor(toolsManager?: HarmonyMidsceneTools);
+    protected createToolsManager(): HarmonyMidsceneTools;
+}
+
+declare class HarmonyMidsceneTools extends BaseMidsceneTools<HarmonyAgent> {
+    protected createTemporaryDevice(): HarmonyDevice;
+    protected ensureAgent(deviceId?: string): Promise<HarmonyAgent>;
+    protected preparePlatformTools(): ToolDefinition[];
+}
+
+declare class HdcClient {
+    private hdcPath;
+    private deviceId;
+    private timeout;
+    constructor(options: HdcOptions);
+    private buildArgs;
+    exec(...args: string[]): Promise<string>;
+    shell(command: string): Promise<string>;
+    fileSend(localPath: string, remotePath: string): Promise<void>;
+    fileRecv(remotePath: string, localPath: string): Promise<void>;
+    screenshot(remotePath: string): Promise<void>;
+    click(x: number, y: number): Promise<void>;
+    doubleClick(x: number, y: number): Promise<void>;
+    longClick(x: number, y: number): Promise<void>;
+    swipe(fromX: number, fromY: number, toX: number, toY: number, speed?: number): Promise<void>;
+    fling(fromX: number, fromY: number, toX: number, toY: number, speed?: number): Promise<void>;
+    drag(fromX: number, fromY: number, toX: number, toY: number, speed?: number): Promise<void>;
+    inputText(x: number, y: number, text: string): Promise<void>;
+    keyEvent(...keys: string[]): Promise<void>;
+    startAbility(bundleName: string, abilityName: string): Promise<void>;
+    forceStop(bundleName: string): Promise<void>;
+    getScreenInfo(): Promise<{
+        width: number;
+        height: number;
+    }>;
+    listTargets(): Promise<string[]>;
+}
+
+declare interface HdcOptions {
+    hdcPath?: string;
+    deviceId?: string;
+    timeout?: number;
+}
+
+export declare function mcpKitForAgent(agent: Agent | HarmonyAgent): Promise<{
+    description: string;
+    tools: Tool[];
+}>;
+
+export declare function mcpServerForAgent(agent: Agent | HarmonyAgent): {
+    launch(options?: {
+        verbose?: boolean;
+    }): Promise<LaunchMCPServerResult>;
+    launchHttp(options: LaunchMCPServerOptions): Promise<LaunchMCPServerResult>;
+};
+
+declare type WrappedAction<T extends DeviceAction> = (...args: ActionArgs<T>) => Promise<ActionReturn<T>>;
+
+export { }

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@midscene/harmony",
+  "version": "1.4.7-beta-20260226072540.0",
+  "description": "HarmonyOS automation library for Midscene",
+  "keywords": [
+    "HarmonyOS UI automation",
+    "HarmonyOS AI testing",
+    "HarmonyOS automation library",
+    "HarmonyOS automation tool",
+    "HarmonyOS NEXT"
+  ],
+  "main": "./dist/lib/index.js",
+  "module": "./dist/es/index.mjs",
+  "types": "./dist/types/index.d.ts",
+  "bin": {
+    "midscene-harmony": "./bin/midscene-harmony"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/es/index.mjs",
+      "require": "./dist/lib/index.js"
+    },
+    "./mcp-server": {
+      "types": "./dist/types/mcp-server.d.ts",
+      "import": "./dist/es/mcp-server.mjs",
+      "require": "./dist/lib/mcp-server.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@midscene/core": "1.4.7-beta-20260226072540.0",
+    "@midscene/shared": "1.4.7-beta-20260226072540.0"
+  },
+  "devDependencies": {
+    "@rslib/core": "^0.18.3",
+    "@types/node": "^18.0.0",
+    "dotenv": "^16.4.5",
+    "typescript": "^5.8.3",
+    "vitest": "3.0.5",
+    "zod": "3.24.3"
+  },
+  "license": "MIT",
+  "scripts": {
+    "dev": "npm run build:watch",
+    "build": "rslib build",
+    "build:watch": "rslib build --watch --no-clean",
+    "test": "vitest --run",
+    "test:u": "vitest --run -u",
+    "test:ai": "AI_TEST_TYPE=harmony npm run test",
+    "test:ai:cache": "MIDSCENE_CACHE=true AI_TEST_TYPE=harmony npm run test"
+  }
+}