@yume-chan/android-bin 0.0.24 → 1.1.0

package/src/bug-report.ts

@@ -32,15 +32,15 @@ export interface BugReportZOptions {
 }
 
 export class BugReport extends AdbCommandBase {
-    static VERSION_REGEX = /(\d+)\.(\d+)/;
+    static VERSION_REGEX: RegExp = /(\d+)\.(\d+)/;
 
-    static BEGIN_REGEX = /BEGIN:(.*)/;
+    static BEGIN_REGEX: RegExp = /BEGIN:(.*)/;
 
-    static PROGRESS_REGEX = /PROGRESS:(.*)\/(.*)/;
+    static PROGRESS_REGEX: RegExp = /PROGRESS:(.*)\/(.*)/;
 
-    static OK_REGEX = /OK:(.*)/;
+    static OK_REGEX: RegExp = /OK:(.*)/;
 
-    static FAIL_REGEX = /FAIL:(.*)/;
+    static FAIL_REGEX: RegExp = /FAIL:(.*)/;
 
     /**
      * Queries the device's bugreport capabilities.
@@ -101,7 +101,7 @@ export class BugReport extends AdbCommandBase {
      *
      * Should be `true` for Android version <= 11.
      */
-    get supportsBugReport() {
+    get supportsBugReport(): boolean {
         return this.#supportsBugReport;
     }
 
@@ -111,7 +111,7 @@ export class BugReport extends AdbCommandBase {
      *
      * Will be `undefined` if BugReportZ is not supported.
      */
-    get bugReportZVersion() {
+    get bugReportZVersion(): string | undefined {
         return this.#bugReportZVersion;
     }
 
@@ -121,7 +121,7 @@ export class BugReport extends AdbCommandBase {
      *
      * Should be `true` for Android version >= 7.
      */
-    get supportsBugReportZ() {
+    get supportsBugReportZ(): boolean {
         return this.#supportsBugReportZ;
     }
 
@@ -131,7 +131,7 @@ export class BugReport extends AdbCommandBase {
      *
      * Should be `true` for Android version >= 8.
      */
-    get supportsBugReportZProgress() {
+    get supportsBugReportZProgress(): boolean {
         return this.#supportsBugReportZProgress;
     }
 
@@ -141,7 +141,7 @@ export class BugReport extends AdbCommandBase {
      *
      * Should be `true` for Android version >= 12.
      */
-    get supportsBugReportZStream() {
+    get supportsBugReportZStream(): boolean {
         return this.#supportsBugReportZStream;
     }
 
@@ -185,7 +185,7 @@ export class BugReport extends AdbCommandBase {
      */
     async bugReportZ(options?: BugReportZOptions): Promise<string> {
         if (options?.signal?.aborted) {
-            throw options?.signal.reason ?? new Error("Aborted");
+            throw options?.signal.reason as Error;
         }
 
         if (!this.#supportsBugReportZ) {
@@ -211,37 +211,33 @@ export class BugReport extends AdbCommandBase {
         let filename: string | undefined;
         let error: string | undefined;
 
-        await process.stdout
+        for await (const line of process.stdout
             .pipeThrough(new TextDecoderStream())
-            .pipeThrough(new SplitStringStream("\n"))
-            .pipeTo(
-                new WritableStream<string>({
-                    write(line) {
-                        // `BEGIN:` and `PROGRESS:` only appear when `-p` is specified.
-                        let match = line.match(BugReport.PROGRESS_REGEX);
-                        if (match) {
-                            options?.onProgress?.(match[1]!, match[2]!);
-                        }
-
-                        match = line.match(BugReport.BEGIN_REGEX);
-                        if (match) {
-                            filename = match[1]!;
-                        }
-
-                        match = line.match(BugReport.OK_REGEX);
-                        if (match) {
-                            filename = match[1];
-                        }
-
-                        match = line.match(BugReport.FAIL_REGEX);
-                        if (match) {
-                            // Don't report error now
-                            // We want to gather all output.
-                            error = match[1];
-                        }
-                    },
-                }),
-            );
+            // Each chunk should contain one or several full lines
+            .pipeThrough(new SplitStringStream("\n"))) {
+            // `BEGIN:` and `PROGRESS:` only appear when `-p` is specified.
+            let match = line.match(BugReport.PROGRESS_REGEX);
+            if (match) {
+                options?.onProgress?.(match[1]!, match[2]!);
+            }
+
+            match = line.match(BugReport.BEGIN_REGEX);
+            if (match) {
+                filename = match[1]!;
+            }
+
+            match = line.match(BugReport.OK_REGEX);
+            if (match) {
+                filename = match[1];
+            }
+
+            match = line.match(BugReport.FAIL_REGEX);
+            if (match) {
+                // Don't report error now
+                // We want to gather all output.
+                error = match[1];
+            }
+        }
 
         if (error) {
             throw new Error(error);

package/src/cmd.ts

@@ -14,22 +14,22 @@ import { ConcatStringStream, TextDecoderStream } from "@yume-chan/stream-extra";
 
 export class Cmd extends AdbCommandBase {
     #supportsShellV2: boolean;
-    get supportsShellV2() {
+    get supportsShellV2(): boolean {
         return this.#supportsShellV2;
     }
 
     #supportsCmd: boolean;
-    get supportsCmd() {
+    get supportsCmd(): boolean {
         return this.#supportsCmd;
     }
 
     #supportsAbb: boolean;
-    get supportsAbb() {
+    get supportsAbb(): boolean {
         return this.#supportsAbb;
     }
 
     #supportsAbbExec: boolean;
-    get supportsAbbExec() {
+    get supportsAbbExec(): boolean {
         return this.#supportsAbbExec;
     }
 

package/src/dumpsys.ts

@@ -31,7 +31,32 @@ const BatteryDumpFields: Record<
     current: { type: "number", field: "current" },
 };
 
+const Status = {
+    Unknown: 1,
+    Charging: 2,
+    Discharging: 3,
+    NotCharging: 4,
+    Full: 5,
+} as const;
+
+const Health = {
+    Unknown: 1,
+    Good: 2,
+    Overheat: 3,
+    Dead: 4,
+    OverVoltage: 5,
+    UnspecifiedFailure: 6,
+    Cold: 7,
+} as const;
+
+const Battery = {
+    Status,
+    Health,
+};
+
 export class DumpSys extends AdbCommandBase {
+    static readonly Battery = Battery;
+
     async diskStats() {
         const output = await this.adb.subprocess.spawnAndWaitLegacy([
             "dumpsys",
@@ -65,7 +90,7 @@ export class DumpSys extends AdbCommandBase {
         };
     }
 
-    async battery() {
+    async battery(): Promise<DumpSys.Battery.Info> {
         const output = await this.adb.subprocess.spawnAndWaitLegacy([
             "dumpsys",
             "battery",
@@ -113,6 +138,9 @@ export class DumpSys extends AdbCommandBase {
 
 export namespace DumpSys {
     export namespace Battery {
+        export type Status = (typeof Status)[keyof typeof Status];
+        export type Health = (typeof Health)[keyof typeof Health];
+
         export interface Info {
             acPowered: boolean;
             usbPowered: boolean;
@@ -131,23 +159,5 @@ export namespace DumpSys {
             technology?: string;
             current?: number;
         }
-
-        export enum Status {
-            Unknown = 1,
-            Charging,
-            Discharging,
-            NotCharging,
-            Full,
-        }
-
-        export enum Health {
-            Unknown = 1,
-            Good,
-            Overheat,
-            Dead,
-            OverVoltage,
-            UnspecifiedFailure,
-            Cold,
-        }
     }
 }

package/src/intent.ts

@@ -5,6 +5,7 @@ export class IntentBuilder {
     #component: string | undefined;
     #data: string | undefined;
     #type: string | undefined;
+    #stringExtras = new Map<string, string>();
 
     setAction(action: string): this {
         this.#action = action;
@@ -31,6 +32,11 @@ export class IntentBuilder {
         return this;
     }
 
+    addStringExtra(key: string, value: string): this {
+        this.#stringExtras.set(key, value);
+        return this;
+    }
+
     build(): string[] {
         const result: string[] = [];
 
@@ -58,6 +64,10 @@ export class IntentBuilder {
             result.push("-t", this.#type);
         }
 
+        for (const [key, value] of this.#stringExtras) {
+            result.push("--es", key, value);
+        }
+
         return result;
     }
 }

package/src/logcat.ts

@@ -8,39 +8,47 @@ import {
     SplitStringStream,
     TextDecoderStream,
     WrapReadableStream,
-    WritableStream,
 } from "@yume-chan/stream-extra";
-import type { AsyncExactReadable } from "@yume-chan/struct";
-import Struct, { decodeUtf8 } from "@yume-chan/struct";
+import type { AsyncExactReadable, StructValue } from "@yume-chan/struct";
+import { decodeUtf8, struct, u16, u32 } from "@yume-chan/struct";
 
 // `adb logcat` is an alias to `adb shell logcat`
 // so instead of adding to core library, it's implemented here
 
 // https://cs.android.com/android/platform/superproject/+/master:system/logging/liblog/include/android/log.h;l=141;drc=82b5738732161dbaafb2e2f25cce19cd26b9157d
-export enum LogId {
-    All = -1,
-    Main,
-    Radio,
-    Events,
-    System,
-    Crash,
-    Stats,
-    Security,
-    Kernel,
-}
+export const LogId = {
+    All: -1,
+    Main: 0,
+    Radio: 1,
+    Events: 2,
+    System: 3,
+    Crash: 4,
+    Stats: 5,
+    Security: 6,
+    Kernel: 7,
+} as const;
+
+export type LogId = (typeof LogId)[keyof typeof LogId];
+
+const LogIdName =
+    /* #__PURE__ */
+    (() => Object.fromEntries(Object.entries(LogId).map(([k, v]) => [v, k])))();
 
 // https://cs.android.com/android/platform/superproject/+/master:system/logging/liblog/include/android/log.h;l=73;drc=82b5738732161dbaafb2e2f25cce19cd26b9157d
-export enum AndroidLogPriority {
-    Unknown,
-    Default,
-    Verbose,
-    Debug,
-    Info,
-    Warn,
-    Error,
-    Fatal,
-    Silent,
-}
+export const AndroidLogPriority = {
+    Unknown: 0,
+    Default: 1,
+    Verbose: 2,
+    Debug: 3,
+    Info: 4,
+    Warn: 5,
+    Error: 6,
+    Fatal: 7,
+    Silent: 8,
+} as const;
+
+export type AndroidLogPriority =
+    (typeof AndroidLogPriority)[keyof typeof AndroidLogPriority];
 
 // https://cs.android.com/android/platform/superproject/+/master:system/logging/liblog/logprint.cpp;l=140;drc=8dbf3b2bb6b6d1652d9797e477b9abd03278bb79
 export const AndroidLogPriorityToCharacter: Record<AndroidLogPriority, string> =
@@ -56,16 +64,18 @@ export const AndroidLogPriorityToCharacter: Record<AndroidLogPriority, string> =
         [AndroidLogPriority.Silent]: "S",
     };
 
-export enum LogcatFormat {
-    Brief,
-    Process,
-    Tag,
-    Thread,
-    Raw,
-    Time,
-    ThreadTime,
-    Long,
-}
+export const LogcatFormat = {
+    Brief: 0,
+    Process: 1,
+    Tag: 2,
+    Thread: 3,
+    Raw: 4,
+    Time: 5,
+    ThreadTime: 6,
+    Long: 7,
+} as const;
+
+export type LogcatFormat = (typeof LogcatFormat)[keyof typeof LogcatFormat];
 
 export interface LogcatFormatModifiers {
     microseconds?: boolean;
@@ -85,28 +95,34 @@ export interface LogcatOptions {
     ids?: LogId[];
 }
 
-const NANOSECONDS_PER_SECOND = BigInt(1e9);
+const NANOSECONDS_PER_SECOND = /* #__PURE__ */ BigInt(1e9);
 
 // https://cs.android.com/android/platform/superproject/+/master:system/logging/liblog/include/log/log_read.h;l=39;drc=82b5738732161dbaafb2e2f25cce19cd26b9157d
-export const LoggerEntry = new Struct({ littleEndian: true })
-    .uint16("payloadSize")
-    .uint16("headerSize")
-    .int32("pid")
-    .uint32("tid")
-    .uint32("seconds")
-    .uint32("nanoseconds")
-    .uint32("logId")
-    .uint32("uid")
-    .extra({
-        get timestamp() {
-            return (
-                BigInt(this.seconds) * NANOSECONDS_PER_SECOND +
-                BigInt(this.nanoseconds)
-            );
+export const LoggerEntry = struct(
+    {
+        payloadSize: u16,
+        headerSize: u16,
+        pid: u32,
+        tid: u32,
+        seconds: u32,
+        nanoseconds: u32,
+        logId: u32,
+        uid: u32,
+    },
+    {
+        littleEndian: true,
+        extra: {
+            get timestamp(): bigint {
+                return (
+                    BigInt(this.seconds) * NANOSECONDS_PER_SECOND +
+                    BigInt(this.nanoseconds)
+                );
+            },
         },
-    });
+    },
+);
 
-export type LoggerEntry = (typeof LoggerEntry)["TDeserializeResult"];
+export type LoggerEntry = StructValue<typeof LoggerEntry>;
 
 // https://cs.android.com/android/platform/superproject/+/master:system/logging/liblog/logprint.cpp;drc=bbe77d66e7bee8bd1f0bc7e5492b5376b0207ef6;bpv=0
 export interface AndroidLogEntry extends LoggerEntry {
@@ -385,7 +401,7 @@ export interface LogSize {
 
 export class Logcat extends AdbCommandBase {
     static logIdToName(id: LogId): string {
-        return LogId[id];
+        return LogIdName[id]!;
     }
 
     static logNameToId(name: string): LogId {
@@ -404,12 +420,12 @@ export class Logcat extends AdbCommandBase {
 
     // TODO: logcat: Support output format before Android 10
     // ref https://android-review.googlesource.com/c/platform/system/core/+/748128
-    static readonly LOG_SIZE_REGEX_10 =
+    static readonly LOG_SIZE_REGEX_10: RegExp =
         /(.*): ring buffer is (.*) (.*)B \((.*) (.*)B consumed\), max entry is (.*) B, max payload is (.*) B/;
 
     // Android 11 added `readable` part
     // ref https://android-review.googlesource.com/c/platform/system/core/+/1390940
-    static readonly LOG_SIZE_REGEX_11 =
+    static readonly LOG_SIZE_REGEX_11: RegExp =
         /(.*): ring buffer is (.*) (.*)B \((.*) (.*)B consumed, (.*) (.*)B readable\), max entry is (.*) B, max payload is (.*) B/;
 
     async getLogSize(ids?: LogId[]): Promise<LogSize[]> {
@@ -420,58 +436,53 @@ export class Logcat extends AdbCommandBase {
         ]);
 
         const result: LogSize[] = [];
-        await stdout
+        for await (const line of stdout
             .pipeThrough(new TextDecoderStream())
-            .pipeThrough(new SplitStringStream("\n"))
-            .pipeTo(
-                new WritableStream({
-                    write(chunk) {
-                        let match = chunk.match(Logcat.LOG_SIZE_REGEX_11);
-                        if (match) {
-                            result.push({
-                                id: Logcat.logNameToId(match[1]!),
-                                size: Logcat.parseSize(
-                                    Number.parseInt(match[2]!, 10),
-                                    match[3]!,
-                                ),
-                                readable: Logcat.parseSize(
-                                    Number.parseInt(match[6]!, 10),
-                                    match[7]!,
-                                ),
-                                consumed: Logcat.parseSize(
-                                    Number.parseInt(match[4]!, 10),
-                                    match[5]!,
-                                ),
-                                maxEntrySize: parseInt(match[8]!, 10),
-                                maxPayloadSize: parseInt(match[9]!, 10),
-                            });
-                            return;
-                        }
-
-                        match = chunk.match(Logcat.LOG_SIZE_REGEX_10);
-                        if (match) {
-                            result.push({
-                                id: Logcat.logNameToId(match[1]!),
-                                size: Logcat.parseSize(
-                                    Number.parseInt(match[2]!, 10),
-                                    match[3]!,
-                                ),
-                                consumed: Logcat.parseSize(
-                                    Number.parseInt(match[4]!, 10),
-                                    match[5]!,
-                                ),
-                                maxEntrySize: parseInt(match[6]!, 10),
-                                maxPayloadSize: parseInt(match[7]!, 10),
-                            });
-                        }
-                    },
-                }),
-            );
+            .pipeThrough(new SplitStringStream("\n"))) {
+            let match = line.match(Logcat.LOG_SIZE_REGEX_11);
+            if (match) {
+                result.push({
+                    id: Logcat.logNameToId(match[1]!),
+                    size: Logcat.parseSize(
+                        Number.parseInt(match[2]!, 10),
+                        match[3]!,
+                    ),
+                    readable: Logcat.parseSize(
+                        Number.parseInt(match[6]!, 10),
+                        match[7]!,
+                    ),
+                    consumed: Logcat.parseSize(
+                        Number.parseInt(match[4]!, 10),
+                        match[5]!,
+                    ),
+                    maxEntrySize: parseInt(match[8]!, 10),
+                    maxPayloadSize: parseInt(match[9]!, 10),
+                });
+                break;
+            }
+
+            match = line.match(Logcat.LOG_SIZE_REGEX_10);
+            if (match) {
+                result.push({
+                    id: Logcat.logNameToId(match[1]!),
+                    size: Logcat.parseSize(
+                        Number.parseInt(match[2]!, 10),
+                        match[3]!,
+                    ),
+                    consumed: Logcat.parseSize(
+                        Number.parseInt(match[4]!, 10),
+                        match[5]!,
+                    ),
+                    maxEntrySize: parseInt(match[6]!, 10),
+                    maxPayloadSize: parseInt(match[7]!, 10),
+                });
+            }
+        }
 
         return result;
     }
 
-    async clear(ids?: LogId[]) {
+    async clear(ids?: LogId[]): Promise<void> {
         const args = ["logcat", "-c"];
         if (ids && ids.length > 0) {
             args.push("-b", Logcat.joinLogId(ids));

package/src/overlay-display.ts

@@ -36,7 +36,7 @@ export class OverlayDisplay extends AdbCommandBase {
                         p.literal("/"),
                         { name: "density", format: p.digits() },
                     ),
-                    1,
+                    { min: 1 },
                 ),
             },
             {
@@ -81,7 +81,7 @@ export class OverlayDisplay extends AdbCommandBase {
         }));
     }
 
-    async set(devices: OverlayDisplayDevice[]) {
+    async set(devices: OverlayDisplayDevice[]): Promise<void> {
         await this.#settings.put(
             "global",
             OverlayDisplay.SETTING_KEY,