agent-device 0.14.3 → 0.14.5

package/dist/src/android-snapshot-helper.d.ts

@@ -1,3 +1,7 @@
+import type { Readable } from 'node:stream';
+import { SpawnOptions } from 'node:child_process';
+import type { Writable } from 'node:stream';
+
 export declare const ANDROID_SNAPSHOT_HELPER_NAME = "android-snapshot-helper";
 
 export declare const ANDROID_SNAPSHOT_HELPER_OUTPUT_FORMAT = "uiautomator-xml";
@@ -20,6 +24,69 @@ declare type AndroidAdbExecutorOptions = Pick<ExecOptions, 'allowFailure' | 'tim
 
 declare type AndroidAdbExecutorResult = Pick<ExecResult, 'exitCode' | 'stdout' | 'stderr' | 'stdoutBuffer'>;
 
+/**
+ * Installs an APK path. Implementations are responsible for honoring semantic
+ * install options such as replace/test/downgrade/grant-permissions.
+ */
+declare type AndroidAdbInstaller = (apkPath: string, options?: AndroidAdbInstallOptions) => Promise<AndroidAdbExecutorResult>;
+
+declare type AndroidAdbInstallOptions = AndroidAdbTransferOptions & {
+    replace?: boolean;
+    allowTestPackages?: boolean;
+    allowDowngrade?: boolean;
+    grantPermissions?: boolean;
+};
+
+declare type AndroidAdbProcess = {
+    pid?: number;
+    stdin: Writable | null;
+    stdout: Readable | null;
+    stderr: Readable | null;
+    killed: boolean;
+    kill(signal?: NodeJS.Signals | number): boolean;
+    once(event: 'exit' | 'close', listener: (code: number | null, signal: NodeJS.Signals | null) => void): unknown;
+    on(event: 'error', listener: (error: Error) => void): unknown;
+    on(event: 'exit' | 'close', listener: (code: number | null, signal: NodeJS.Signals | null) => void): unknown;
+};
+
+declare type AndroidAdbProvider = {
+    /**
+     * Fallback executor for device-scoped adb arguments. Providers may omit explicit
+     * methods to keep the legacy exec-shaped pull/install fallback.
+     */
+    exec: AndroidAdbExecutor;
+    spawn?: AndroidAdbSpawner;
+    reverse?: AndroidPortReverseProvider;
+    pull?: AndroidAdbPuller;
+    install?: AndroidAdbInstaller;
+};
+
+declare type AndroidAdbPuller = (remotePath: string, localPath: string, options?: AndroidAdbTransferOptions) => Promise<AndroidAdbExecutorResult>;
+
+declare type AndroidAdbSpawner = (args: string[], options?: SpawnOptions) => AndroidAdbProcess;
+
+declare type AndroidAdbTransferOptions = AndroidAdbExecutorOptions;
+
+declare type AndroidPortReverseEndpoint = `tcp:${number}` | `localabstract:${string}`;
+
+declare type AndroidPortReverseMapping = {
+    local: AndroidPortReverseEndpoint;
+    remote: AndroidPortReverseEndpoint;
+    ownerId?: string;
+};
+
+declare type AndroidPortReverseOptions = {
+    signal?: AbortSignal;
+    timeoutMs?: number;
+};
+
+declare type AndroidPortReverseProvider = {
+    ensure(mapping: AndroidPortReverseMapping, options?: AndroidPortReverseOptions): Promise<void>;
+    remove(local: AndroidPortReverseEndpoint, options?: AndroidPortReverseOptions): Promise<void>;
+    removeAllOwned(ownerId: string, options?: AndroidPortReverseOptions): Promise<void>;
+    list?(options?: AndroidPortReverseOptions): Promise<AndroidPortReverseMapping[]>;
+};
+
 declare type AndroidSnapshotAnalysis = {
     rawNodeCount: number;
     maxDepth: number;
@@ -122,6 +189,7 @@ export declare function captureAndroidSnapshotWithHelper(options: AndroidSnapsho
 
 export declare function ensureAndroidSnapshotHelper(options: {
     adb: AndroidAdbExecutor;
+    adbProvider?: AndroidAdbProvider | AndroidAdbExecutor;
     artifact: AndroidSnapshotHelperArtifact;
     deviceKey?: string;
     installPolicy?: AndroidSnapshotHelperInstallPolicy;