@yume-chan/adb 0.0.15 → 0.0.17

package/src/commands/power.ts

@@ -1,54 +1,54 @@
-// cspell: ignore bootloader
-// cspell: ignore fastboot
-// cspell: ignore keyevent
-// cspell: ignore longpress
-
-import { AdbCommandBase } from "./base.js";
-
-export class AdbPower extends AdbCommandBase {
-    public reboot(name: string = '') {
-        return this.adb.createSocketAndWait(`reboot:${name}`);
-    }
-
-    public bootloader() {
-        return this.reboot('bootloader');
-    }
-
-    public fastboot() {
-        return this.reboot('fastboot');
-    }
-
-    public recovery() {
-        return this.reboot('recovery');
-    }
-
-    public sideload() {
-        return this.reboot('sideload');
-    }
-
-    /**
-     * Reboot to Qualcomm Emergency Download (EDL) Mode.
-     *
-     * Only works on some Qualcomm devices.
-     */
-    public qualcommEdlMode() {
-        return this.reboot('edl');
-    }
-
-    public powerOff() {
-        return this.adb.subprocess.spawnAndWaitLegacy(['reboot', '-p']);
-    }
-
-    public powerButton(longPress: boolean = false) {
-        return this.adb.subprocess.spawnAndWaitLegacy(['input', 'keyevent', longPress ? '--longpress POWER' : 'POWER']);
-    }
-
-    /**
-     * Reboot to Samsung Odin download mode.
-     *
-     * Only works on Samsung devices.
-     */
-    public samsungOdin() {
-        return this.reboot('download');
-    }
-}
+// cspell: ignore bootloader
+// cspell: ignore fastboot
+// cspell: ignore keyevent
+// cspell: ignore longpress
+
+import { AdbCommandBase } from './base.js';
+
+export class AdbPower extends AdbCommandBase {
+    public reboot(name: string = '') {
+        return this.adb.createSocketAndWait(`reboot:${name}`);
+    }
+
+    public bootloader() {
+        return this.reboot('bootloader');
+    }
+
+    public fastboot() {
+        return this.reboot('fastboot');
+    }
+
+    public recovery() {
+        return this.reboot('recovery');
+    }
+
+    public sideload() {
+        return this.reboot('sideload');
+    }
+
+    /**
+     * Reboot to Qualcomm Emergency Download (EDL) Mode.
+     *
+     * Only works on some Qualcomm devices.
+     */
+    public qualcommEdlMode() {
+        return this.reboot('edl');
+    }
+
+    public powerOff() {
+        return this.adb.subprocess.spawnAndWaitLegacy(['reboot', '-p']);
+    }
+
+    public powerButton(longPress: boolean = false) {
+        return this.adb.subprocess.spawnAndWaitLegacy(['input', 'keyevent', longPress ? '--longpress POWER' : 'POWER']);
+    }
+
+    /**
+     * Reboot to Samsung Odin download mode.
+     *
+     * Only works on Samsung devices.
+     */
+    public samsungOdin() {
+        return this.reboot('download');
+    }
+}

package/src/commands/reverse.ts

@@ -1,140 +1,141 @@
-// cspell: ignore killforward
-
-import { AutoDisposable } from '@yume-chan/event';
-import Struct from '@yume-chan/struct';
-import type { Adb } from "../adb.js";
-import type { AdbIncomingSocketHandler, AdbSocket } from '../socket/index.js';
-import { AdbBufferedStream, BufferedStreamEndedError } from '../stream/index.js';
-import { decodeUtf8 } from "../utils/index.js";
-
-export interface AdbForwardListener {
-    deviceSerial: string;
-
-    localName: string;
-
-    remoteName: string;
-}
-
-const AdbReverseStringResponse =
-    new Struct()
-        .string('length', { length: 4 })
-        .string('content', { lengthField: 'length', lengthFieldRadix: 16 });
-
-const AdbReverseErrorResponse =
-    new Struct()
-        .fields(AdbReverseStringResponse)
-        .postDeserialize((value) => {
-            throw new Error(value.content);
-        });
-
-export class AdbReverseCommand extends AutoDisposable {
-    protected localAddressToHandler = new Map<string, AdbIncomingSocketHandler>();
-
-    protected deviceAddressToLocalAddress = new Map<string, string>();
-
-    protected adb: Adb;
-
-    protected listening = false;
-
-    public constructor(adb: Adb) {
-        super();
-
-        this.adb = adb;
-        this.addDisposable(this.adb.addIncomingSocketHandler(this.handleIncomingSocket));
-    }
-
-    protected handleIncomingSocket = async (socket: AdbSocket) => {
-        let address = socket.serviceString;
-        // ADB daemon appends `\0` to the service string
-        address = address.replace(/\0/g, '');
-        return !!(await this.localAddressToHandler.get(address)?.(socket));
-    };
-
-    private async createBufferedStream(service: string) {
-        const socket = await this.adb.createSocket(service);
-        return new AdbBufferedStream(socket);
-    }
-
-    private async sendRequest(service: string) {
-        const stream = await this.createBufferedStream(service);
-        const success = decodeUtf8(await stream.read(4)) === 'OKAY';
-        if (!success) {
-            await AdbReverseErrorResponse.deserialize(stream);
-        }
-        return stream;
-    }
-
-    public async list(): Promise<AdbForwardListener[]> {
-        const stream = await this.createBufferedStream('reverse:list-forward');
-
-        const response = await AdbReverseStringResponse.deserialize(stream);
-        return response.content!.split('\n').map(line => {
-            const [deviceSerial, localName, remoteName] = line.split(' ') as [string, string, string];
-            return { deviceSerial, localName, remoteName };
-        });
-
-        // No need to close the stream, device will close it
-    }
-
-    /**
-     * @param deviceAddress The address adbd on device is listening on. Can be `tcp:0` to let adbd choose an available TCP port by itself.
-     * @param localAddress Native ADB client will open a connection to this address when reverse connection received. In WebADB, it's only used to uniquely identify a reverse tunnel registry, `handler` will be called to handle the connection.
-     * @param handler A callback to handle incoming connections
-     * @returns If `deviceAddress` is `tcp:0`, return `tcp:{ACTUAL_LISTENING_PORT}`; otherwise, return `deviceAddress`.
-     */
-    public async add(
-        deviceAddress: string,
-        localAddress: string,
-        handler: AdbIncomingSocketHandler,
-    ): Promise<string> {
-        const stream = await this.sendRequest(`reverse:forward:${deviceAddress};${localAddress}`);
-
-        // `tcp:0` tells the device to pick an available port.
-        // Begin with Android 8, device will respond with the selected port for all `tcp:` requests.
-        if (deviceAddress.startsWith('tcp:')) {
-            let length: number | undefined;
-            try {
-                length = Number.parseInt(decodeUtf8(await stream.read(4)), 16);
-            } catch (e) {
-                if (!(e instanceof BufferedStreamEndedError)) {
-                    throw e;
-                }
-
-                // Device before Android 8 doesn't have this response.
-                // (the stream is closed now)
-                // Can be safely ignored.
-            }
-
-            if (length !== undefined) {
-                const port = decodeUtf8(await stream.read(length!));
-                deviceAddress = `tcp:${Number.parseInt(port, 10)}`;
-            }
-        }
-
-        this.localAddressToHandler.set(localAddress, handler);
-        this.deviceAddressToLocalAddress.set(deviceAddress, localAddress);
-        return deviceAddress;
-
-        // No need to close the stream, device will close it
-    }
-
-    public async remove(deviceAddress: string): Promise<void> {
-        await this.sendRequest(`reverse:killforward:${deviceAddress}`);
-
-        if (this.deviceAddressToLocalAddress.has(deviceAddress)) {
-            this.localAddressToHandler.delete(this.deviceAddressToLocalAddress.get(deviceAddress)!);
-            this.deviceAddressToLocalAddress.delete(deviceAddress);
-        }
-
-        // No need to close the stream, device will close it
-    }
-
-    public async removeAll(): Promise<void> {
-        await this.sendRequest(`reverse:killforward-all`);
-
-        this.deviceAddressToLocalAddress.clear();
-        this.localAddressToHandler.clear();
-
-        // No need to close the stream, device will close it
-    }
-}
+// cspell: ignore killforward
+
+import { AutoDisposable } from '@yume-chan/event';
+import { BufferedReadableStream, BufferedReadableStreamEndedError } from '@yume-chan/stream-extra';
+import Struct from '@yume-chan/struct';
+
+import type { Adb } from '../adb.js';
+import type { AdbIncomingSocketHandler, AdbSocket } from '../socket/index.js';
+import { decodeUtf8 } from '../utils/index.js';
+
+export interface AdbForwardListener {
+    deviceSerial: string;
+
+    localName: string;
+
+    remoteName: string;
+}
+
+const AdbReverseStringResponse =
+    new Struct()
+        .string('length', { length: 4 })
+        .string('content', { lengthField: 'length', lengthFieldRadix: 16 });
+
+const AdbReverseErrorResponse =
+    new Struct()
+        .fields(AdbReverseStringResponse)
+        .postDeserialize((value) => {
+            throw new Error(value.content);
+        });
+
+export class AdbReverseCommand extends AutoDisposable {
+    protected localAddressToHandler = new Map<string, AdbIncomingSocketHandler>();
+
+    protected deviceAddressToLocalAddress = new Map<string, string>();
+
+    protected adb: Adb;
+
+    protected listening = false;
+
+    public constructor(adb: Adb) {
+        super();
+
+        this.adb = adb;
+        this.addDisposable(this.adb.onIncomingSocket(this.handleIncomingSocket));
+    }
+
+    protected handleIncomingSocket = async (socket: AdbSocket) => {
+        let address = socket.serviceString;
+        // ADB daemon appends `\0` to the service string
+        address = address.replace(/\0/g, '');
+        return !!(await this.localAddressToHandler.get(address)?.(socket));
+    };
+
+    private async createBufferedStream(service: string) {
+        const socket = await this.adb.createSocket(service);
+        return new BufferedReadableStream(socket.readable);
+    }
+
+    private async sendRequest(service: string) {
+        const stream = await this.createBufferedStream(service);
+        const success = decodeUtf8(await stream.read(4)) === 'OKAY';
+        if (!success) {
+            await AdbReverseErrorResponse.deserialize(stream);
+        }
+        return stream;
+    }
+
+    public async list(): Promise<AdbForwardListener[]> {
+        const stream = await this.createBufferedStream('reverse:list-forward');
+
+        const response = await AdbReverseStringResponse.deserialize(stream);
+        return response.content!.split('\n').map(line => {
+            const [deviceSerial, localName, remoteName] = line.split(' ') as [string, string, string];
+            return { deviceSerial, localName, remoteName };
+        });
+
+        // No need to close the stream, device will close it
+    }
+
+    /**
+     * @param deviceAddress The address adbd on device is listening on. Can be `tcp:0` to let adbd choose an available TCP port by itself.
+     * @param localAddress Native ADB client will open a connection to this address when reverse connection received. In WebADB, it's only used to uniquely identify a reverse tunnel registry, `handler` will be called to handle the connection.
+     * @param handler A callback to handle incoming connections. It must return `true` if it accepts the connection.
+     * @returns `tcp:{ACTUAL_LISTENING_PORT}`, If `deviceAddress` is `tcp:0`; otherwise, `deviceAddress`.
+     */
+    public async add(
+        deviceAddress: string,
+        localAddress: string,
+        handler: AdbIncomingSocketHandler,
+    ): Promise<string> {
+        const stream = await this.sendRequest(`reverse:forward:${deviceAddress};${localAddress}`);
+
+        // `tcp:0` tells the device to pick an available port.
+        // On Android >=8, device will respond with the selected port for all `tcp:` requests.
+        if (deviceAddress.startsWith('tcp:')) {
+            let length: number | undefined;
+            try {
+                length = Number.parseInt(decodeUtf8(await stream.read(4)), 16);
+            } catch (e) {
+                if (!(e instanceof BufferedReadableStreamEndedError)) {
+                    throw e;
+                }
+
+                // Android <8 doesn't have this response.
+                // (the stream is closed now)
+                // Can be safely ignored.
+            }
+
+            if (length !== undefined) {
+                const port = decodeUtf8(await stream.read(length!));
+                deviceAddress = `tcp:${Number.parseInt(port, 10)}`;
+            }
+        }
+
+        this.localAddressToHandler.set(localAddress, handler);
+        this.deviceAddressToLocalAddress.set(deviceAddress, localAddress);
+        return deviceAddress;
+
+        // No need to close the stream, device will close it
+    }
+
+    public async remove(deviceAddress: string): Promise<void> {
+        await this.sendRequest(`reverse:killforward:${deviceAddress}`);
+
+        if (this.deviceAddressToLocalAddress.has(deviceAddress)) {
+            this.localAddressToHandler.delete(this.deviceAddressToLocalAddress.get(deviceAddress)!);
+            this.deviceAddressToLocalAddress.delete(deviceAddress);
+        }
+
+        // No need to close the stream, device will close it
+    }
+
+    public async removeAll(): Promise<void> {
+        await this.sendRequest(`reverse:killforward-all`);
+
+        this.deviceAddressToLocalAddress.clear();
+        this.localAddressToHandler.clear();
+
+        // No need to close the stream, device will close it
+    }
+}

package/src/commands/subprocess/command.ts

@@ -0,0 +1,131 @@
+import { GatherStringStream, DecodeUtf8Stream } from '@yume-chan/stream-extra';
+
+import { AdbCommandBase } from '../base.js';
+import { AdbSubprocessNoneProtocol, AdbSubprocessProtocol, AdbSubprocessProtocolConstructor, AdbSubprocessShellProtocol } from './protocols/index.js';
+
+export interface AdbSubprocessOptions {
+    /**
+     * A list of `AdbSubprocessProtocolConstructor`s to be used.
+     *
+     * Different `AdbSubprocessProtocol` has different capabilities, thus requires specific adaptations.
+     * Check their documentations for details.
+     *
+     * The first protocol whose `isSupported` returns `true` will be used.
+     * If no `AdbSubprocessProtocol` is supported, an error will be thrown.
+     *
+     * @default [AdbSubprocessShellProtocol, AdbSubprocessNoneProtocol]
+     */
+    protocols: AdbSubprocessProtocolConstructor[];
+}
+
+const DEFAULT_OPTIONS: AdbSubprocessOptions = {
+    protocols: [AdbSubprocessShellProtocol, AdbSubprocessNoneProtocol],
+};
+
+export interface AdbSubprocessWaitResult {
+    stdout: string;
+    stderr: string;
+    exitCode: number;
+}
+
+export class AdbSubprocess extends AdbCommandBase {
+    private async createProtocol(
+        mode: 'pty' | 'raw',
+        command?: string | string[],
+        options?: Partial<AdbSubprocessOptions>
+    ): Promise<AdbSubprocessProtocol> {
+        const { protocols } = { ...DEFAULT_OPTIONS, ...options };
+
+        let Constructor: AdbSubprocessProtocolConstructor | undefined;
+        for (const item of protocols) {
+            // It's async so can't use `Array#find`
+            if (await item.isSupported(this.adb)) {
+                Constructor = item;
+                break;
+            }
+        }
+
+        if (!Constructor) {
+            throw new Error('No specified protocol is supported by the device');
+        }
+
+        if (Array.isArray(command)) {
+            command = command.join(' ');
+        } else if (command === undefined) {
+            // spawn the default shell
+            command = '';
+        }
+        return await Constructor[mode](this.adb, command);
+    }
+
+    /**
+     * Spawns an executable in PTY (interactive) mode.
+     * @param command The command to run. If omitted, the default shell will be spawned.
+     * @param options The options for creating the `AdbSubprocessProtocol`
+     * @returns A new `AdbSubprocessProtocol` instance connecting to the spawned process.
+     */
+    public shell(
+        command?: string | string[],
+        options?: Partial<AdbSubprocessOptions>
+    ): Promise<AdbSubprocessProtocol> {
+        return this.createProtocol('pty', command, options);
+    }
+
+    /**
+     * Spawns an executable and pipe the output.
+     * @param command The command to run, or an array of strings containing both command and args.
+     * @param options The options for creating the `AdbSubprocessProtocol`
+     * @returns A new `AdbSubprocessProtocol` instance connecting to the spawned process.
+     */
+    public spawn(
+        command: string | string[],
+        options?: Partial<AdbSubprocessOptions>
+    ): Promise<AdbSubprocessProtocol> {
+        return this.createProtocol('raw', command, options);
+    }
+
+    /**
+     * Spawns a new process, waits until it exits, and returns the entire output.
+     * @param command The command to run
+     * @param options The options for creating the `AdbSubprocessProtocol`
+     * @returns The entire output of the command
+     */
+    public async spawnAndWait(
+        command: string | string[],
+        options?: Partial<AdbSubprocessOptions>
+    ): Promise<AdbSubprocessWaitResult> {
+        const shell = await this.spawn(command, options);
+
+        const stdout = new GatherStringStream();
+        const stderr = new GatherStringStream();
+
+        const [, , exitCode] = await Promise.all([
+            shell.stdout
+                .pipeThrough(new DecodeUtf8Stream())
+                .pipeTo(stdout),
+            shell.stderr
+                .pipeThrough(new DecodeUtf8Stream())
+                .pipeTo(stderr),
+            shell.exit
+        ]);
+
+        return {
+            stdout: stdout.result,
+            stderr: stderr.result,
+            exitCode,
+        };
+    }
+
+    /**
+     * Spawns a new process, waits until it exits, and returns the entire output.
+     * @param command The command to run
+     * @returns The entire output of the command
+     */
+    public async spawnAndWaitLegacy(command: string | string[]): Promise<string> {
+        const { stdout } = await this.spawnAndWait(
+            command,
+            { protocols: [AdbSubprocessNoneProtocol] }
+        );
+        return stdout;
+    }
+}

package/src/commands/subprocess/index.ts

@@ -1,139 +1,3 @@
-import type { Adb } from '../../adb.js';
-import { DecodeUtf8Stream, GatherStringStream } from "../../stream/index.js";
-import { AdbSubprocessNoneProtocol, AdbSubprocessShellProtocol, type AdbSubprocessProtocol, type AdbSubprocessProtocolConstructor } from './protocols/index.js';
-
-export * from './protocols/index.js';
-export * from './utils.js';
-
-export interface AdbSubprocessOptions {
-    /**
-     * A list of `AdbSubprocessProtocolConstructor`s to be used.
-     *
-     * Different `AdbSubprocessProtocol` has different capabilities, thus requires specific adaptations.
-     * Check their documentations for details.
-     *
-     * The first protocol whose `isSupported` returns `true` will be used.
-     * If no `AdbSubprocessProtocol` is supported, an error will be thrown.
-     *
-     * @default [AdbSubprocessShellProtocol, AdbSubprocessNoneProtocol]
-     */
-    protocols: AdbSubprocessProtocolConstructor[];
-}
-
-const DEFAULT_OPTIONS: AdbSubprocessOptions = {
-    protocols: [AdbSubprocessShellProtocol, AdbSubprocessNoneProtocol],
-};
-
-export interface AdbSubprocessWaitResult {
-    stdout: string;
-    stderr: string;
-    exitCode: number;
-}
-
-export class AdbSubprocess {
-    public readonly adb: Adb;
-
-    public constructor(adb: Adb) {
-        this.adb = adb;
-    }
-
-    private async createProtocol(
-        mode: 'pty' | 'raw',
-        command?: string | string[],
-        options?: Partial<AdbSubprocessOptions>
-    ): Promise<AdbSubprocessProtocol> {
-        const { protocols } = { ...DEFAULT_OPTIONS, ...options };
-
-        let Constructor: AdbSubprocessProtocolConstructor | undefined;
-        for (const item of protocols) {
-            // It's async so can't use `Array#find`
-            if (await item.isSupported(this.adb)) {
-                Constructor = item;
-                break;
-            }
-        }
-
-        if (!Constructor) {
-            throw new Error('No specified protocol is supported by the device');
-        }
-
-        if (Array.isArray(command)) {
-            command = command.join(' ');
-        } else if (command === undefined) {
-            // spawn the default shell
-            command = '';
-        }
-        return await Constructor[mode](this.adb, command);
-    }
-
-    /**
-     * Spawns an executable in PTY (interactive) mode.
-     * @param command The command to run. If omitted, the default shell will be spawned.
-     * @param options The options for creating the `AdbSubprocessProtocol`
-     * @returns A new `AdbSubprocessProtocol` instance connecting to the spawned process.
-     */
-    public shell(
-        command?: string | string[],
-        options?: Partial<AdbSubprocessOptions>
-    ): Promise<AdbSubprocessProtocol> {
-        return this.createProtocol('pty', command, options);
-    }
-
-    /**
-     * Spawns an executable and pipe the output.
-     * @param command The command to run, or an array of strings containing both command and args.
-     * @param options The options for creating the `AdbSubprocessProtocol`
-     * @returns A new `AdbSubprocessProtocol` instance connecting to the spawned process.
-     */
-    public spawn(
-        command: string | string[],
-        options?: Partial<AdbSubprocessOptions>
-    ): Promise<AdbSubprocessProtocol> {
-        return this.createProtocol('raw', command, options);
-    }
-
-    /**
-     * Spawns a new process, waits until it exits, and returns the entire output.
-     * @param command The command to run
-     * @param options The options for creating the `AdbSubprocessProtocol`
-     * @returns The entire output of the command
-     */
-    public async spawnAndWait(
-        command: string | string[],
-        options?: Partial<AdbSubprocessOptions>
-    ): Promise<AdbSubprocessWaitResult> {
-        const shell = await this.spawn(command, options);
-
-        const stdout = new GatherStringStream();
-        const stderr = new GatherStringStream();
-
-        const [, , exitCode] = await Promise.all([
-            shell.stdout
-                .pipeThrough(new DecodeUtf8Stream())
-                .pipeTo(stdout),
-            shell.stderr
-                .pipeThrough(new DecodeUtf8Stream())
-                .pipeTo(stderr),
-            shell.exit
-        ]);
-
-        return {
-            stdout: stdout.result,
-            stderr: stderr.result,
-            exitCode,
-        };
-    }
-
-    /**
-     * Spawns a new process, waits until it exits, and returns the entire output.
-     * @param command The command to run
-     * @returns The entire output of the command
-     */
-    public async spawnAndWaitLegacy(command: string | string[]): Promise<string> {
-        const { stdout } = await this.spawnAndWait(
-            command,
-            { protocols: [AdbSubprocessNoneProtocol] }
-        );
-        return stdout;
-    }
-}
+export * from './command.js';
+export * from './protocols/index.js';
+export * from './utils.js';