@midscene/harmony 1.9.8 → 1.10.0

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

@@ -1,217 +0,0 @@
-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 { AgentBehaviorInitArgs } from '@midscene/shared/mcp/agent-behavior-init-args';
-import { AgentOpt } from '@midscene/core/agent';
-import { BaseMCPServer } from '@midscene/shared/mcp';
-import { BaseMidsceneTools } from '@midscene/shared/mcp/base-tools';
-import { DeviceAction } from '@midscene/core';
-import type { ElementInfo } from '@midscene/shared/extractor';
-import { HarmonyDeviceInputOpt as HarmonyDeviceInputOpt_2 } from '@midscene/core/device';
-import { HarmonyDeviceOpt as HarmonyDeviceOpt_2 } from '@midscene/core/device';
-import { InitArgSpec } from '@midscene/shared/mcp/base-tools';
-import { InterfaceType } from '@midscene/core';
-import { LaunchMCPServerOptions } from '@midscene/shared/mcp';
-import { LaunchMCPServerResult } from '@midscene/shared/mcp';
-import { MobileInputPrimitives } from '@midscene/core/device';
-import { Point } from '@midscene/core';
-import { Size } from '@midscene/core';
-import { Tool } from '@midscene/shared/mcp';
-import type { ToolDefinition } from '@midscene/shared/mcp/types';
-
-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>;
-    terminate(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;
-    readonly inputPrimitives: MobileInputPrimitives;
-    actionSpace(): DeviceAction<any>[];
-    private performActionScroll;
-    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>;
-    /**
-     * Terminate (force-stop) a HarmonyOS app by bundle name.
-     * Supports app name resolution via setAppNameMapping.
-     * If uri contains "/" (e.g. com.example.app/MainAbility), only the bundle part is used.
-     */
-    terminate(uri: string): Promise<void>;
-    getScreenSize(): Promise<{
-        width: number;
-        height: number;
-    }>;
-    size(): Promise<Size>;
-    private remoteScreenshotPath;
-    private localScreenshotPath;
-    screenshotBase64(): Promise<string>;
-    private tapPoint;
-    private doubleTapPoint;
-    private longPressPoint;
-    private typeText;
-    clearInput(element?: ElementInfo): Promise<void>;
-    /**
-     * Decide how many Backspaces `clearTextField` should send. Each
-     * `uitest uiInput keyEvent` invocation costs ~300ms cold-start, so blindly
-     * defaulting to 100 makes every clear take ~10s. Instead, snapshot the UI
-     * once (~1s for `uitest dumpLayout`) and tighten the bound to the current
-     * field's text length plus a small padding for transient IME composing.
-     * Falls back to the safe upper bound if the layout can't be parsed.
-     */
-    private resolveClearLength;
-    private pressKey;
-    scroll(deltaX: number, deltaY: number, speed?: number): Promise<void>;
-    private scrollInDirection;
-    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>;
-    private scrollUntilEdge;
-    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(options?: HarmonyDeviceInputOpt): Promise<void>;
-    /**
-     * Get the current device-local time as a formatted string.
-     * This avoids formatting a device timestamp in the host machine's timezone.
-     */
-    getDeviceLocalTimeString(format?: string): Promise<string>;
-    destroy(): Promise<void>;
-}
-
-declare type HarmonyDeviceInputOpt = HarmonyDeviceInputOpt_2 & {
-    keyboardDismissStrategy?: KeyboardDismissStrategy;
-};
-
-declare type HarmonyDeviceOpt = HarmonyDeviceOpt_2 & HarmonyDeviceInputOpt;
-
-declare type HarmonyInitArgs = AgentBehaviorInitArgs & {
-    deviceId?: string;
-};
-
-export declare class HarmonyMCPServer extends BaseMCPServer {
-    constructor(toolsManager?: HarmonyMidsceneTools);
-    protected createToolsManager(): HarmonyMidsceneTools;
-}
-
-declare class HarmonyMidsceneTools extends BaseMidsceneTools<HarmonyAgent, HarmonyInitArgs> {
-    private lastInitArgsSignature?;
-    protected getCliReportSessionName(): string;
-    protected readonly initArgSpec: InitArgSpec<HarmonyInitArgs>;
-    protected createTemporaryDevice(): HarmonyDevice;
-    protected ensureAgent(initArgs?: HarmonyInitArgs): Promise<HarmonyAgent>;
-    protected preparePlatformTools(): ToolDefinition[];
-}
-
-declare class HdcClient {
-    private hdcPath;
-    private deviceId;
-    private timeout;
-    private execMutex;
-    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<string>;
-    /**
-     * Capture the current UI layout via `uitest dumpLayout` and return the JSON
-     * string. The dump is written to a fixed device path then `cat`'d back in
-     * the same shell round-trip to avoid a separate `hdc file recv` call.
-     */
-    dumpLayout(): Promise<string>;
-    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>;
-    /**
-     * Clear the focused text field by sending repeated Backspace(2055) key
-     * events. `uitest uiInput keyEvent` only accepts up to 3 keyCodes per call
-     * (any more triggers "Too many parameters." with zero presses injected),
-     * so we pack codes into 3-key batches and chain the calls with shell `;`
-     * to keep a single hdc round-trip — mirroring Android adb's
-     * "one shell, many keys" design despite the per-call cap.
-     */
-    clearTextField(length?: number): Promise<void>;
-    startAbility(bundleName: string, abilityName: string): Promise<void>;
-    queryMainAbility(bundleName: string): Promise<string | undefined>;
-    forceStop(bundleName: string): Promise<void>;
-    getScreenInfo(): Promise<{
-        width: number;
-        height: number;
-    }>;
-    listTargets(): Promise<string[]>;
-}
-
-declare interface HdcOptions {
-    hdcPath?: string;
-    deviceId?: string;
-    timeout?: number;
-}
-
-declare type KeyboardDismissStrategy = 'esc-first' | 'back-first';
-
-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 { }