agent-device 0.13.2 → 0.14.0

package/dist/src/testing/conformance.d.ts

@@ -1,753 +0,0 @@
-export declare const adminConformanceSuite: CommandConformanceSuite;
-
-declare type AgentDeviceBackend = {
-    platform: AgentDeviceBackendPlatform;
-    capabilities?: BackendCapabilitySet;
-    escapeHatches?: BackendEscapeHatches;
-    captureSnapshot?(context: BackendCommandContext, options?: BackendSnapshotOptions): Promise<BackendSnapshotResult>;
-    captureScreenshot?(context: BackendCommandContext, outPath: string, options?: BackendScreenshotOptions): Promise<BackendScreenshotResult | void>;
-    readText?(context: BackendCommandContext, node: SnapshotNode): Promise<BackendReadTextResult>;
-    findText?(context: BackendCommandContext, text: string): Promise<BackendFindTextResult>;
-    tap?(context: BackendCommandContext, point: Point, options?: BackendTapOptions): Promise<BackendActionResult>;
-    fill?(context: BackendCommandContext, point: Point, text: string, options?: BackendFillOptions): Promise<BackendActionResult>;
-    typeText?(context: BackendCommandContext, text: string, options?: {
-        delayMs?: number;
-    }): Promise<BackendActionResult>;
-    focus?(context: BackendCommandContext, point: Point): Promise<BackendActionResult>;
-    longPress?(context: BackendCommandContext, point: Point, options?: BackendLongPressOptions): Promise<BackendActionResult>;
-    swipe?(context: BackendCommandContext, from: Point, to: Point, options?: BackendSwipeOptions): Promise<BackendActionResult>;
-    scroll?(context: BackendCommandContext, target: BackendScrollTarget, options: BackendScrollOptions): Promise<BackendActionResult>;
-    pinch?(context: BackendCommandContext, options: BackendPinchOptions): Promise<BackendActionResult>;
-    pressKey?(context: BackendCommandContext, key: string, options?: {
-        modifiers?: string[];
-    }): Promise<BackendActionResult>;
-    pressBack?(context: BackendCommandContext, options?: BackendBackOptions): Promise<BackendActionResult>;
-    pressHome?(context: BackendCommandContext): Promise<BackendActionResult>;
-    rotate?(context: BackendCommandContext, orientation: BackendDeviceOrientation): Promise<BackendActionResult>;
-    setKeyboard?(context: BackendCommandContext, options: BackendKeyboardOptions): Promise<BackendKeyboardResult | BackendActionResult>;
-    getClipboard?(context: BackendCommandContext): Promise<string | BackendClipboardTextResult>;
-    setClipboard?(context: BackendCommandContext, text: string): Promise<BackendActionResult>;
-    openSettings?(context: BackendCommandContext, target?: string): Promise<BackendActionResult>;
-    handleAlert?(context: BackendCommandContext, action: BackendAlertAction, options?: {
-        timeoutMs?: number;
-    }): Promise<BackendAlertResult>;
-    openAppSwitcher?(context: BackendCommandContext): Promise<BackendActionResult>;
-    openApp?(context: BackendCommandContext, target: BackendOpenTarget, options?: BackendOpenOptions): Promise<BackendActionResult>;
-    closeApp?(context: BackendCommandContext, app?: string): Promise<BackendActionResult>;
-    listApps?(context: BackendCommandContext, filter?: BackendAppListFilter): Promise<readonly BackendAppInfo[]>;
-    getAppState?(context: BackendCommandContext, app: string): Promise<BackendAppState>;
-    pushFile?(context: BackendCommandContext, input: BackendPushInput, target: string): Promise<BackendActionResult>;
-    triggerAppEvent?(context: BackendCommandContext, event: BackendAppEvent): Promise<BackendActionResult>;
-    listDevices?(context: BackendCommandContext, filter?: BackendDeviceFilter): Promise<readonly BackendDeviceInfo[]>;
-    bootDevice?(context: BackendCommandContext, target?: BackendDeviceTarget): Promise<BackendActionResult>;
-    ensureSimulator?(context: BackendCommandContext, options: BackendEnsureSimulatorOptions): Promise<BackendEnsureSimulatorResult>;
-    resolveInstallSource?(context: BackendCommandContext, source: BackendInstallSource): Promise<BackendInstallSource>;
-    installApp?(context: BackendCommandContext, target: BackendInstallTarget): Promise<BackendInstallResult>;
-    reinstallApp?(context: BackendCommandContext, target: BackendInstallTarget): Promise<BackendInstallResult>;
-    startRecording?(context: BackendCommandContext, options?: BackendRecordingOptions): Promise<BackendRecordingResult>;
-    stopRecording?(context: BackendCommandContext, options?: BackendRecordingOptions): Promise<BackendRecordingResult>;
-    startTrace?(context: BackendCommandContext, options?: BackendTraceOptions): Promise<BackendTraceResult>;
-    stopTrace?(context: BackendCommandContext, options?: BackendTraceOptions): Promise<BackendTraceResult>;
-    readLogs?(context: BackendCommandContext, options?: BackendReadLogsOptions): Promise<BackendReadLogsResult>;
-    dumpNetwork?(context: BackendCommandContext, options?: BackendDumpNetworkOptions): Promise<BackendDumpNetworkResult>;
-    measurePerf?(context: BackendCommandContext, options?: BackendMeasurePerfOptions): Promise<BackendMeasurePerfResult>;
-};
-
-declare type AgentDeviceBackendPlatform = 'ios' | 'android' | 'macos' | 'linux';
-
-declare type AgentDeviceRuntime = {
-    backend: AgentDeviceBackend;
-    artifacts: ArtifactAdapter;
-    sessions: CommandSessionStore;
-    policy: CommandPolicy;
-    diagnostics?: DiagnosticsSink;
-    clock?: CommandClock;
-    signal?: AbortSignal;
-};
-
-export declare const appsConformanceSuite: CommandConformanceSuite;
-
-declare type ArtifactAdapter = {
-    resolveInput(ref: FileInputRef, options: ResolveInputOptions): Promise<ResolvedInputFile>;
-    reserveOutput(ref: FileOutputRef | undefined, options: ReserveOutputOptions): Promise<ReservedOutputFile>;
-    createTempFile(options: CreateTempFileOptions): Promise<TemporaryFile>;
-};
-
-declare type ArtifactDescriptor = {
-    kind: 'localPath';
-    field: string;
-    path: string;
-    fileName?: string;
-    metadata?: Record<string, unknown>;
-} | {
-    kind: 'artifact';
-    field: string;
-    artifactId: string;
-    fileName?: string;
-    url?: string;
-    clientPath?: string;
-    metadata?: Record<string, unknown>;
-};
-
-export declare function assertCommandConformance(target: CommandConformanceTarget, options?: {
-    suites?: readonly CommandConformanceSuite[];
-}): Promise<CommandConformanceReport>;
-
-declare const BACKEND_CAPABILITY_NAMES: readonly ["android.shell", "ios.runnerCommand", "macos.desktopScreenshot"];
-
-declare type BackendActionResult = Record<string, unknown> | void;
-
-declare type BackendAlertAction = 'get' | 'accept' | 'dismiss' | 'wait';
-
-declare type BackendAlertInfo = {
-    title?: string;
-    message?: string;
-    buttons?: string[];
-};
-
-declare type BackendAlertResult = {
-    kind: 'alertStatus';
-    alert: BackendAlertInfo | null;
-} | {
-    kind: 'alertHandled';
-    handled: boolean;
-    alert?: BackendAlertInfo;
-    button?: string;
-} | {
-    kind: 'alertWait';
-    alert: BackendAlertInfo | null;
-    waitedMs?: number;
-    timedOut?: boolean;
-};
-
-declare type BackendAppEvent = {
-    name: string;
-    payload?: Record<string, unknown>;
-};
-
-declare type BackendAppInfo = {
-    id: string;
-    name?: string;
-    bundleId?: string;
-    packageName?: string;
-    activity?: string;
-};
-
-declare type BackendAppListFilter = 'all' | 'user-installed';
-
-declare type BackendAppState = {
-    appId?: string;
-    bundleId?: string;
-    packageName?: string;
-    activity?: string;
-    state?: 'unknown' | 'notRunning' | 'running' | 'foreground' | 'background';
-    details?: Record<string, unknown>;
-};
-
-declare type BackendBackOptions = {
-    mode?: 'in-app' | 'system';
-};
-
-declare type BackendCapabilityName = (typeof BACKEND_CAPABILITY_NAMES)[number];
-
-declare type BackendCapabilitySet = readonly BackendCapabilityName[];
-
-declare type BackendClipboardTextResult = {
-    text: string;
-};
-
-declare type BackendCommandContext = {
-    session?: string;
-    requestId?: string;
-    appId?: string;
-    appBundleId?: string;
-    signal?: AbortSignal;
-    metadata?: Record<string, unknown>;
-};
-
-declare type BackendDeviceFilter = {
-    platform?: AgentDeviceBackendPlatform | 'apple';
-    target?: 'mobile' | 'tv' | 'desktop';
-    kind?: 'simulator' | 'emulator' | 'device' | 'desktop';
-};
-
-declare type BackendDeviceInfo = {
-    id: string;
-    name: string;
-    platform: AgentDeviceBackendPlatform;
-    target?: 'mobile' | 'tv' | 'desktop';
-    kind?: 'simulator' | 'emulator' | 'device' | 'desktop';
-    booted?: boolean;
-    details?: Record<string, unknown>;
-};
-
-declare type BackendDeviceOrientation = 'portrait' | 'portrait-upside-down' | 'landscape-left' | 'landscape-right';
-
-declare type BackendDeviceTarget = {
-    id?: string;
-    name?: string;
-    platform?: AgentDeviceBackendPlatform;
-    target?: 'mobile' | 'tv' | 'desktop';
-    headless?: boolean;
-};
-
-declare type BackendDiagnosticsPageOptions = BackendDiagnosticsTimeWindow & {
-    cursor?: string;
-    limit?: number;
-};
-
-declare type BackendDiagnosticsTimeWindow = {
-    since?: string;
-    until?: string;
-};
-
-declare type BackendDumpNetworkOptions = BackendDiagnosticsPageOptions & {
-    include?: BackendNetworkIncludeMode;
-};
-
-declare type BackendDumpNetworkResult = {
-    entries: readonly BackendNetworkEntry[];
-    nextCursor?: string;
-    timeWindow?: BackendDiagnosticsTimeWindow;
-    backend?: string;
-    redacted?: boolean;
-    notes?: readonly string[];
-};
-
-declare type BackendEnsureSimulatorOptions = {
-    device: string;
-    runtime?: string;
-    boot?: boolean;
-    reuseExisting?: boolean;
-};
-
-declare type BackendEnsureSimulatorResult = {
-    udid: string;
-    device: string;
-    runtime: string;
-    created: boolean;
-    booted: boolean;
-    simulatorSetPath?: string | null;
-};
-
-declare type BackendEscapeHatches = {
-    androidShell?(context: BackendCommandContext, args: readonly string[]): Promise<BackendShellResult>;
-    iosRunnerCommand?(context: BackendCommandContext, command: BackendRunnerCommand): Promise<BackendActionResult>;
-    macosDesktopScreenshot?(context: BackendCommandContext, outPath: string, options?: BackendScreenshotOptions): Promise<BackendScreenshotResult | void>;
-};
-
-declare type BackendFillOptions = {
-    delayMs?: number;
-};
-
-declare type BackendFindTextResult = {
-    found: boolean;
-};
-
-declare type BackendInstallResult = Record<string, unknown> & {
-    appId?: string;
-    appName?: string;
-    bundleId?: string;
-    packageName?: string;
-    launchTarget?: string;
-    installablePath?: string;
-    archivePath?: string;
-};
-
-declare type BackendInstallSource = {
-    kind: 'path';
-    path: string;
-} | {
-    kind: 'uploadedArtifact';
-    id: string;
-} | {
-    kind: 'url';
-    url: string;
-};
-
-declare type BackendInstallTarget = {
-    app?: string;
-    source: BackendInstallSource;
-};
-
-declare type BackendKeyboardOptions = {
-    action: 'status' | 'get' | 'dismiss';
-};
-
-declare type BackendKeyboardResult = {
-    platform?: 'android' | 'ios' | 'macos' | 'linux';
-    action?: BackendKeyboardOptions['action'];
-    visible?: boolean;
-    inputType?: string | null;
-    type?: string | null;
-    wasVisible?: boolean;
-    dismissed?: boolean;
-    attempts?: number;
-};
-
-declare type BackendLogEntry = {
-    timestamp?: string;
-    level?: 'debug' | 'info' | 'warn' | 'error' | string;
-    message: string;
-    source?: string;
-    metadata?: Record<string, unknown>;
-};
-
-declare type BackendLongPressOptions = {
-    durationMs?: number;
-};
-
-declare type BackendMeasurePerfOptions = BackendDiagnosticsTimeWindow & {
-    sampleMs?: number;
-    metrics?: readonly string[];
-};
-
-declare type BackendMeasurePerfResult = {
-    metrics: readonly BackendPerfMetric[];
-    startedAt?: string;
-    endedAt?: string;
-    backend?: string;
-    redacted?: boolean;
-    notes?: readonly string[];
-};
-
-declare type BackendNetworkEntry = {
-    timestamp?: string;
-    method?: string;
-    url?: string;
-    status?: number;
-    durationMs?: number;
-    requestHeaders?: Record<string, string>;
-    responseHeaders?: Record<string, string>;
-    requestBody?: string;
-    responseBody?: string;
-    metadata?: Record<string, unknown>;
-};
-
-declare type BackendNetworkIncludeMode = 'summary' | 'headers' | 'body' | 'all';
-
-declare type BackendOpenOptions = {
-    relaunch?: boolean;
-};
-
-declare type BackendOpenTarget = {
-    /**
-     * Generic app identifier accepted by the backend. Hosted adapters should
-     * prefer structured appId, bundleId, or packageName when available.
-     */
-    app?: string;
-    appId?: string;
-    bundleId?: string;
-    packageName?: string;
-    /**
-     * URL may be used by itself for a deep link or with an app identifier when
-     * the backend supports opening a URL in a specific app context.
-     */
-    url?: string;
-    /**
-     * Platform-specific activity override, primarily for Android app launches.
-     */
-    activity?: string;
-};
-
-declare type BackendPerfMetric = {
-    name: string;
-    value?: number;
-    unit?: string;
-    status?: 'ok' | 'unavailable' | 'error';
-    message?: string;
-    metadata?: Record<string, unknown>;
-};
-
-declare type BackendPinchOptions = {
-    scale: number;
-    center?: Point;
-};
-
-declare type BackendPushInput = {
-    kind: 'json';
-    payload: Record<string, unknown>;
-} | {
-    kind: 'file';
-    path: string;
-};
-
-declare type BackendReadLogsOptions = BackendDiagnosticsPageOptions & {
-    levels?: readonly string[];
-    search?: string;
-    source?: string;
-};
-
-declare type BackendReadLogsResult = {
-    entries: readonly BackendLogEntry[];
-    nextCursor?: string;
-    timeWindow?: BackendDiagnosticsTimeWindow;
-    backend?: string;
-    redacted?: boolean;
-    notes?: readonly string[];
-};
-
-declare type BackendReadTextResult = {
-    text: string;
-};
-
-declare type BackendRecordingOptions = {
-    outPath?: string;
-    fps?: number;
-    quality?: number;
-    showTouches?: boolean;
-};
-
-declare type BackendRecordingResult = Record<string, unknown> & {
-    path?: string;
-    telemetryPath?: string;
-    warning?: string;
-};
-
-declare type BackendRunnerCommand = {
-    command: string;
-    args?: readonly string[];
-    payload?: Record<string, unknown>;
-};
-
-declare type BackendScreenshotOptions = {
-    fullscreen?: boolean;
-    overlayRefs?: boolean;
-    surface?: 'app' | 'frontmost-app' | 'desktop' | 'menubar';
-};
-
-declare type BackendScreenshotResult = {
-    path?: string;
-    overlayRefs?: ScreenshotOverlayRef[];
-};
-
-declare type BackendScrollOptions = {
-    direction: 'up' | 'down' | 'left' | 'right';
-    amount?: number;
-    pixels?: number;
-};
-
-declare type BackendScrollTarget = {
-    kind: 'viewport';
-} | {
-    kind: 'point';
-    point: Point;
-};
-
-declare type BackendShellResult = {
-    exitCode: number;
-    stdout: string;
-    stderr: string;
-};
-
-declare type BackendSnapshotAnalysis = {
-    rawNodeCount?: number;
-    maxDepth?: number;
-};
-
-declare type BackendSnapshotFreshness = {
-    action: string;
-    retryCount: number;
-    staleAfterRetries: boolean;
-    reason?: 'empty-interactive' | 'sharp-drop' | 'stuck-route';
-};
-
-declare type BackendSnapshotOptions = SnapshotOptions & {
-    outPath?: string;
-};
-
-declare type BackendSnapshotResult = {
-    nodes?: SnapshotNode[];
-    truncated?: boolean;
-    backend?: string;
-    snapshot?: SnapshotState;
-    analysis?: BackendSnapshotAnalysis;
-    freshness?: BackendSnapshotFreshness;
-    warnings?: string[];
-    appName?: string;
-    appBundleId?: string;
-};
-
-declare type BackendSwipeOptions = {
-    durationMs?: number;
-};
-
-declare type BackendTapOptions = {
-    button?: 'primary' | 'secondary' | 'middle';
-    count?: number;
-    intervalMs?: number;
-    holdMs?: number;
-    jitterPx?: number;
-    doubleTap?: boolean;
-};
-
-declare type BackendTraceOptions = {
-    outPath?: string;
-};
-
-declare type BackendTraceResult = Record<string, unknown> & {
-    outPath?: string;
-};
-
-export declare const captureConformanceSuite: CommandConformanceSuite;
-
-declare type CommandClock = {
-    now(): number;
-    sleep(ms: number): Promise<void>;
-};
-
-export declare type CommandConformanceCase = {
-    name: string;
-    command: string;
-    run(runtime: AgentDeviceRuntime, fixtures: CommandConformanceFixtures): Promise<void>;
-};
-
-export declare type CommandConformanceCaseContext = {
-    suite: string;
-    caseName: string;
-    fixtures: CommandConformanceFixtures;
-};
-
-export declare type CommandConformanceFailure = {
-    suite: string;
-    caseName: string;
-    command: string;
-    error: unknown;
-};
-
-export declare type CommandConformanceFixtures = {
-    session: string;
-    app: string;
-    installSourcePath: string;
-    appEventName: string;
-    appPushPayload: Record<string, unknown>;
-    visibleSelector: string;
-    visibleText: string;
-    editableTarget: InteractionTarget;
-    fillText: string;
-    point: Point;
-    swipeTo: Point;
-};
-
-export declare type CommandConformanceReport = {
-    target: string;
-    passed: number;
-    failed: number;
-    failures: CommandConformanceFailure[];
-    suites: CommandConformanceSuiteResult[];
-};
-
-export declare type CommandConformanceSuite = {
-    name: string;
-    cases: readonly CommandConformanceCase[];
-    run(target: CommandConformanceTarget): Promise<CommandConformanceSuiteResult>;
-};
-
-export declare type CommandConformanceSuiteResult = {
-    suite: string;
-    passed: number;
-    failed: number;
-    failures: CommandConformanceFailure[];
-};
-
-export declare const commandConformanceSuites: readonly CommandConformanceSuite[];
-
-export declare type CommandConformanceTarget = {
-    name: string;
-    createRuntime: ConformanceRuntimeFactory;
-    fixtures?: Partial<CommandConformanceFixtures>;
-    beforeEach?(context: CommandConformanceCaseContext): void | Promise<void>;
-    afterEach?(context: CommandConformanceCaseContext): void | Promise<void>;
-};
-
-declare type CommandPolicy = {
-    allowLocalInputPaths: boolean;
-    allowLocalOutputPaths: boolean;
-    maxImagePixels: number;
-    allowNamedBackendCapabilities: readonly BackendCapabilityName[];
-};
-
-declare type CommandSessionRecord = {
-    name: string;
-    appId?: string;
-    appBundleId?: string;
-    appName?: string;
-    backendSessionId?: string;
-    snapshot?: SnapshotState;
-    metadata?: Record<string, unknown>;
-};
-
-declare type CommandSessionStore = {
-    get(name: string): CommandSessionRecord | undefined | Promise<CommandSessionRecord | undefined>;
-    set(record: CommandSessionRecord): void | Promise<void>;
-    delete?(name: string): void | Promise<void>;
-    list?(): readonly CommandSessionRecord[] | Promise<readonly CommandSessionRecord[]>;
-};
-
-export declare type ConformanceRuntimeFactory = () => AgentDeviceRuntime | Promise<AgentDeviceRuntime>;
-
-declare type CreateTempFileOptions = {
-    prefix: string;
-    ext: string;
-};
-
-export declare const defaultCommandConformanceFixtures: CommandConformanceFixtures;
-
-export declare const diagnosticsConformanceSuite: CommandConformanceSuite;
-
-declare type DiagnosticsSink = {
-    emit(event: {
-        level: 'debug' | 'info' | 'warn' | 'error';
-        message: string;
-        data?: unknown;
-    }): void;
-};
-
-declare type ElementTarget = SelectorTarget | RefTarget;
-
-declare type FileInputRef = {
-    kind: 'path';
-    path: string;
-} | {
-    kind: 'uploadedArtifact';
-    id: string;
-};
-
-declare type FileOutputRef = {
-    kind: 'path';
-    path: string;
-} | {
-    kind: 'downloadableArtifact';
-    clientPath?: string;
-    fileName?: string;
-};
-
-export declare const interactionConformanceSuite: CommandConformanceSuite;
-
-declare type InteractionTarget = ElementTarget | PointTarget;
-
-declare type OutputVisibility = 'client-visible' | 'internal';
-
-declare type Point = {
-    x: number;
-    y: number;
-};
-
-declare type PointTarget = {
-    kind: 'point';
-    x: number;
-    y: number;
-};
-
-declare type RawSnapshotNode = {
-    index: number;
-    type?: string;
-    role?: string;
-    subrole?: string;
-    label?: string;
-    value?: string;
-    identifier?: string;
-    rect?: Rect;
-    enabled?: boolean;
-    selected?: boolean;
-    hittable?: boolean;
-    depth?: number;
-    parentIndex?: number;
-    pid?: number;
-    bundleId?: string;
-    appName?: string;
-    windowTitle?: string;
-    surface?: string;
-    hiddenContentAbove?: boolean;
-    hiddenContentBelow?: boolean;
-};
-
-export declare const recordingConformanceSuite: CommandConformanceSuite;
-
-declare type Rect = {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-};
-
-declare type RefTarget = {
-    kind: 'ref';
-    ref: string;
-    fallbackLabel?: string;
-};
-
-declare type ReservedOutputFile = {
-    path: string;
-    visibility: OutputVisibility;
-    publish: () => Promise<ArtifactDescriptor | undefined>;
-    cleanup?: () => Promise<void>;
-};
-
-declare type ReserveOutputOptions = {
-    field: string;
-    ext: string;
-    requestedClientPath?: string;
-    visibility?: OutputVisibility;
-};
-
-declare type ResolvedInputFile = {
-    path: string;
-    cleanup?: () => Promise<void>;
-};
-
-declare type ResolveInputOptions = {
-    usage: string;
-    field?: string;
-};
-
-export declare function runCommandConformance(target: CommandConformanceTarget, options?: {
-    suites?: readonly CommandConformanceSuite[];
-}): Promise<CommandConformanceReport>;
-
-declare type ScreenshotOverlayRef = {
-    ref: string;
-    label?: string;
-    rect: Rect;
-    overlayRect: Rect;
-    center: Point;
-};
-
-export declare const selectorConformanceSuite: CommandConformanceSuite;
-
-declare type SelectorTarget = {
-    kind: 'selector';
-    selector: string;
-};
-
-declare type SnapshotBackend = 'xctest' | 'android' | 'macos-helper' | 'linux-atspi';
-
-declare type SnapshotNode = RawSnapshotNode & {
-    ref: string;
-};
-
-declare type SnapshotOptions = {
-    interactiveOnly?: boolean;
-    compact?: boolean;
-    depth?: number;
-    scope?: string;
-    raw?: boolean;
-};
-
-declare type SnapshotState = {
-    nodes: SnapshotNode[];
-    createdAt: number;
-    truncated?: boolean;
-    backend?: SnapshotBackend;
-    comparisonSafe?: boolean;
-};
-
-export declare const systemConformanceSuite: CommandConformanceSuite;
-
-declare type TemporaryFile = {
-    path: string;
-    visibility: 'internal';
-    cleanup: () => Promise<void>;
-};
-
-export { }