@yume-chan/android-bin 0.0.19 → 0.0.21

package/CHANGELOG.json

@@ -1,6 +1,42 @@
 {
   "name": "@yume-chan/android-bin",
   "entries": [
+    {
+      "version": "0.0.21",
+      "tag": "@yume-chan/android-bin_v0.0.21",
+      "date": "Fri, 25 Aug 2023 14:05:18 GMT",
+      "comments": {
+        "none": [
+          {
+            "comment": "Add wrapper for `bu`"
+          },
+          {
+            "comment": "Remove the last `\\n` from `Settings#get`"
+          },
+          {
+            "comment": "Add wrappers for `dumpsys diskstats` and `dumpsys battery`"
+          },
+          {
+            "comment": "Add wrapper for `pm list packages`"
+          },
+          {
+            "comment": "Rewrite `Settings` to use `Cmd` if available"
+          },
+          {
+            "comment": "Add support to stop `bugreport`"
+          },
+          {
+            "comment": "Merge `bugreport` and `bugreportz` wrappers, providing an `automatic` method to choose the best available bugreport method"
+          }
+        ]
+      }
+    },
+    {
+      "version": "0.0.20",
+      "tag": "@yume-chan/android-bin_v0.0.20",
+      "date": "Mon, 05 Jun 2023 02:51:41 GMT",
+      "comments": {}
+    },
     {
       "version": "0.0.19",
       "tag": "@yume-chan/android-bin_v0.0.19",

package/CHANGELOG.md

@@ -1,6 +1,24 @@
 # Change Log - @yume-chan/android-bin
 
-This log was last generated on Sun, 09 Apr 2023 05:55:33 GMT and should not be manually modified.
+This log was last generated on Fri, 25 Aug 2023 14:05:18 GMT and should not be manually modified.
+
+## 0.0.21
+Fri, 25 Aug 2023 14:05:18 GMT
+
+### Updates
+
+- Add wrapper for `bu`
+- Remove the last `\n` from `Settings#get`
+- Add wrappers for `dumpsys diskstats` and `dumpsys battery`
+- Add wrapper for `pm list packages`
+- Rewrite `Settings` to use `Cmd` if available
+- Add support to stop `bugreport`
+- Merge `bugreport` and `bugreportz` wrappers, providing an `automatic` method to choose the best available bugreport method
+
+## 0.0.20
+Mon, 05 Jun 2023 02:51:41 GMT
+
+_Version update only_
 
 ## 0.0.19
 Sun, 09 Apr 2023 05:55:33 GMT

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-2023 Simon Chan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/esm/bu.d.ts

@@ -1,15 +1,28 @@
 import { AdbCommandBase } from "@yume-chan/adb";
+import type { Consumable, ReadableStream } from "@yume-chan/stream-extra";
 export interface AdbBackupOptions {
-    apps: string[] | "all" | "all-including-system";
-    apks: boolean;
-    obbs: boolean;
-    shared: boolean;
-    widgets: boolean;
+    user: number;
+    saveSharedStorage?: boolean;
+    saveWidgets?: boolean;
+    packages: string[] | "user" | "all";
+    savePackageApk: boolean;
+    savePackageObb: boolean;
+    savePackageKeyValue: boolean;
     compress: boolean;
+}
+export interface AdbRestoreOptions {
     user: number;
+    file: ReadableStream<Consumable<Uint8Array>>;
 }
 export declare class AdbBackup extends AdbCommandBase {
-    backup(options: AdbBackupOptions): Promise<void>;
-    restore(options: AdbBackupOptions): Promise<void>;
+    /**
+     * User must confirm backup on device within 60 seconds.
+     */
+    backup(options: AdbBackupOptions): Promise<ReadableStream<Uint8Array>>;
+    /**
+     * User must enter the password (if any) and
+     * confirm restore on device within 60 seconds.
+     */
+    restore(options: AdbRestoreOptions): Promise<string>;
 }
 //# sourceMappingURL=bu.d.ts.map

package/esm/bu.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bu.d.ts","sourceRoot":"","sources":["../src/bu.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,GAAG,sBAAsB,CAAC;IAChD,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,qBAAa,SAAU,SAAQ,cAAc;IACzC,MAAM,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAKhD,OAAO,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAIpD"}
+{"version":3,"file":"bu.d.ts","sourceRoot":"","sources":["../src/bu.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAG1E,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,KAAK,CAAC;IACpC,cAAc,EAAE,OAAO,CAAC;IACxB,cAAc,EAAE,OAAO,CAAC;IACxB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;CAChD;AAED,qBAAa,SAAU,SAAQ,cAAc;IACzC;;OAEG;IACG,MAAM,CACR,OAAO,EAAE,gBAAgB,GAC1B,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAmCtC;;;OAGG;IACG,OAAO,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC;CAc7D"}

package/esm/bu.js

@@ -1,14 +1,53 @@
-// cspell: ignore apks
-// cspell: ignore obbs
 import { AdbCommandBase } from "@yume-chan/adb";
+import { ConcatStringStream, DecodeUtf8Stream } from "@yume-chan/stream-extra";
 export class AdbBackup extends AdbCommandBase {
-    backup(options) {
-        void options;
-        throw new Error("Not implemented");
+    /**
+     * User must confirm backup on device within 60 seconds.
+     */
+    async backup(options) {
+        const args = ["bu", "backup"];
+        if (options.user !== undefined) {
+            args.push("--user", options.user.toString());
+        }
+        args.push(options.saveSharedStorage ? "--shared" : "--no-shared");
+        args.push(options.saveWidgets ? "--widgets" : "--no-widgets");
+        args.push(options.savePackageApk ? "--apk" : "--no-apk");
+        args.push(options.savePackageObb ? "--obb" : "--no-obb");
+        args.push(options.savePackageKeyValue ? "--key-value" : "--no-key-value");
+        args.push(options.compress ? "--compress" : "--no-compress");
+        if (typeof options.packages === "string") {
+            switch (options.packages) {
+                case "user":
+                    args.push("--all", "--no-system");
+                    break;
+                case "all":
+                    args.push("--all", "--system");
+                    break;
+            }
+        }
+        else {
+            args.push(...options.packages);
+        }
+        const process = await this.adb.subprocess.spawn(args);
+        return process.stdout;
     }
-    restore(options) {
-        void options;
-        throw new Error("Not implemented");
+    /**
+     * User must enter the password (if any) and
+     * confirm restore on device within 60 seconds.
+     */
+    async restore(options) {
+        const args = ["bu", "restore"];
+        if (options.user !== undefined) {
+            args.push("--user", options.user.toString());
+        }
+        const process = await this.adb.subprocess.spawn(args);
+        const [output] = await Promise.all([
+            process.stdout
+                .pipeThrough(new DecodeUtf8Stream())
+                .pipeThrough(new ConcatStringStream()),
+            options.file.pipeTo(process.stdin),
+        ]);
+        return output;
     }
 }
 //# sourceMappingURL=bu.js.map

package/esm/bu.js.map

@@ -1 +1 @@
-{"version":3,"file":"bu.js","sourceRoot":"","sources":["../src/bu.ts"],"names":[],"mappings":"AAAA,sBAAsB;AACtB,sBAAsB;AAEtB,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAYhD,MAAM,OAAO,SAAU,SAAQ,cAAc;IACzC,MAAM,CAAC,OAAyB;QAC5B,KAAK,OAAO,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED,OAAO,CAAC,OAAyB;QAC7B,KAAK,OAAO,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;CACJ"}
+{"version":3,"file":"bu.js","sourceRoot":"","sources":["../src/bu.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAkB/E,MAAM,OAAO,SAAU,SAAQ,cAAc;IACzC;;OAEG;IACH,KAAK,CAAC,MAAM,CACR,OAAyB;QAEzB,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAE9B,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;SAChD;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;QAClE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;QAE9D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,CACL,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,gBAAgB,CACjE,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;QAE7D,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE;YACtC,QAAQ,OAAO,CAAC,QAAQ,EAAE;gBACtB,KAAK,MAAM;oBACP,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;oBAClC,MAAM;gBACV,KAAK,KAAK;oBACN,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;oBAC/B,MAAM;aACb;SACJ;aAAM;YACH,IAAI,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;SAClC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtD,OAAO,OAAO,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,OAA0B;QACpC,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAC/B,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;SAChD;QACD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC/B,OAAO,CAAC,MAAM;iBACT,WAAW,CAAC,IAAI,gBAAgB,EAAE,CAAC;iBACnC,WAAW,CAAC,IAAI,kBAAkB,EAAE,CAAC;YAC1C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;SACrC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ"}

package/esm/bug-report.d.ts

@@ -1,38 +1,99 @@
+import type { Adb } from "@yume-chan/adb";
 import { AdbCommandBase } from "@yume-chan/adb";
-import type { ReadableStream } from "@yume-chan/stream-extra";
-export interface BugReportZVersion {
-    major: number;
-    minor: number;
-    supportProgress: boolean;
-    supportStream: boolean;
+import type { AbortSignal, ReadableStream } from "@yume-chan/stream-extra";
+export interface BugReportCapabilities {
+    supportsBugReport: boolean;
+    bugReportZVersion?: string | undefined;
+    supportsBugReportZ: boolean;
+    supportsBugReportZProgress: boolean;
+    supportsBugReportZStream: boolean;
 }
-export declare class BugReportZ extends AdbCommandBase {
+export interface BugReportZOptions {
+    signal?: AbortSignal;
+    /**
+     * A callback that will be called when progress is updated.
+     *
+     * Specify `onProgress` when `supportsBugReportZProgress` is `false` will throw an error.
+     */
+    onProgress?: ((completed: string, total: string) => void) | undefined;
+}
+export declare class BugReport extends AdbCommandBase {
+    #private;
     static VERSION_REGEX: RegExp;
     static BEGIN_REGEX: RegExp;
     static PROGRESS_REGEX: RegExp;
     static OK_REGEX: RegExp;
     static FAIL_REGEX: RegExp;
     /**
-     * Retrieve the version of bugreportz.
+     * Queries the device's bugreport capabilities.
+     */
+    static queryCapabilities(adb: Adb): Promise<BugReport>;
+    /**
+     * Gets whether the device supports flat (text file, non-zipped) bugreport.
+     *
+     * Should be `true` for Android version <= 11.
+     */
+    get supportsBugReport(): boolean;
+    /**
+     * Gets the version of BugReportZ.
+     *
+     * Will be `undefined` if BugReportZ is not supported.
+     */
+    get bugReportZVersion(): string | undefined;
+    /**
+     * Gets whether the device supports zipped bugreport.
+     *
+     * Should be `true` for Android version >= 7.
+     */
+    get supportsBugReportZ(): boolean;
+    /**
+     * Gets whether the device supports progress report for zipped bugreport.
      *
-     * @returns a `BugReportVersion` object, or `undefined` if `bugreportz` is not available.
+     * Should be `true` for Android version >= 8.
      */
-    version(): Promise<BugReportZVersion | undefined>;
-    supportProgress(major: number, minor: number): boolean;
+    get supportsBugReportZProgress(): boolean;
     /**
-     * Create a zipped bugreport file.
+     * Gets whether the device supports streaming zipped bugreport.
      *
-     * Compare to `stream`, this method will write the output to a file on device.
+     * Should be `true` for Android version >= 12.
+     */
+    get supportsBugReportZStream(): boolean;
+    constructor(adb: Adb, capabilities: BugReportCapabilities);
+    /**
+     * Creates a legacy, non-zipped bugreport file, or throws an error if `supportsBugReport` is `false`.
+     *
+     * @returns A flat (text file, non-zipped) bugreport.
+     */
+    bugReport(): ReadableStream<Uint8Array>;
+    /**
+     * Creates a zipped bugreport file, or throws an error if `supportsBugReportZ` is `false`.
+     *
+     * Compare to `bugReportZStream`, this method will write the output to a file on device.
      * You can pull it later using sync protocol.
      *
-     * @param onProgress Progress callback. Only specify this if `supportsProgress` is `true`.
-     * @returns The path of the bugreport file.
+     * @returns The path to the generated bugreport file on device filesystem.
      */
-    generate(onProgress?: (progress: string, total: string) => void): Promise<string>;
-    supportStream(major: number, minor: number): boolean;
-    stream(): ReadableStream<Uint8Array>;
-}
-export declare class BugReport extends AdbCommandBase {
-    generate(): ReadableStream<Uint8Array>;
+    bugReportZ(options?: BugReportZOptions): Promise<string>;
+    /**
+     * Creates a zipped bugreport file, or throws an error if `supportsBugReportZStream` is `false`.
+     *
+     * @returns The content of the generated bugreport file.
+     */
+    bugReportZStream(): ReadableStream<Uint8Array>;
+    /**
+     * Automatically choose the best bugreport method.
+     *
+     * * If `supportsBugReportZStream` is `true`, this method will return a stream of zipped bugreport.
+     * * If `supportsBugReportZ` is `true`, this method will return a stream of zipped bugreport, and will delete the file on device after the stream is closed.
+     * * If `supportsBugReport` is `true`, this method will return a stream of flat bugreport.
+     *
+     * @param onProgress
+     * If `supportsBugReportZStream` is `false` and `supportsBugReportZProgress` is `true`,
+     * this callback will be called when progress is updated.
+     */
+    automatic(onProgress?: (completed: string, total: string) => void): {
+        type: "bugreport" | "bugreportz";
+        stream: ReadableStream<Uint8Array>;
+    };
 }
 //# sourceMappingURL=bug-report.d.ts.map

package/esm/bug-report.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bug-report.d.ts","sourceRoot":"","sources":["../src/bug-report.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAA8B,MAAM,gBAAgB,CAAC;AAC5E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAS9D,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IAEd,eAAe,EAAE,OAAO,CAAC;IACzB,aAAa,EAAE,OAAO,CAAC;CAC1B;AAED,qBAAa,UAAW,SAAQ,cAAc;IAC1C,OAAc,aAAa,SAAkB;IAE7C,OAAc,WAAW,SAAgB;IAEzC,OAAc,cAAc,SAAyB;IAErD,OAAc,QAAQ,SAAa;IAEnC,OAAc,UAAU,SAAe;IAEvC;;;;OAIG;IACU,OAAO,IAAI,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IA8BvD,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAI7D;;;;;;;;OAQG;IACU,QAAQ,CACjB,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,GACvD,OAAO,CAAC,MAAM,CAAC;IAqDX,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAIpD,MAAM,IAAI,cAAc,CAAC,UAAU,CAAC;CAgC9C;AAGD,qBAAa,SAAU,SAAQ,cAAc;IAClC,QAAQ,IAAI,cAAc,CAAC,UAAU,CAAC;CAMhD"}
+{"version":3,"file":"bug-report.d.ts","sourceRoot":"","sources":["../src/bug-report.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,GAAG,EAAW,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,cAAc,EAA8B,MAAM,gBAAgB,CAAC;AAC5E,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAU3E,MAAM,WAAW,qBAAqB;IAClC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,kBAAkB,EAAE,OAAO,CAAC;IAC5B,0BAA0B,EAAE,OAAO,CAAC;IACpC,wBAAwB,EAAE,OAAO,CAAC;CACrC;AAED,MAAM,WAAW,iBAAiB;IAC9B,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;CACzE;AAED,qBAAa,SAAU,SAAQ,cAAc;;IACzC,MAAM,CAAC,aAAa,SAAkB;IAEtC,MAAM,CAAC,WAAW,SAAgB;IAElC,MAAM,CAAC,cAAc,SAAyB;IAE9C,MAAM,CAAC,QAAQ,SAAa;IAE5B,MAAM,CAAC,UAAU,SAAe;IAEhC;;OAEG;WACU,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,SAAS,CAAC;IAmD5D;;;;OAIG;IACH,IAAI,iBAAiB,YAEpB;IAGD;;;;OAIG;IACH,IAAI,iBAAiB,uBAEpB;IAGD;;;;OAIG;IACH,IAAI,kBAAkB,YAErB;IAGD;;;;OAIG;IACH,IAAI,0BAA0B,YAE7B;IAGD;;;;OAIG;IACH,IAAI,wBAAwB,YAE3B;gBAEW,GAAG,EAAE,GAAG,EAAE,YAAY,EAAE,qBAAqB;IAWzD;;;;OAIG;IACH,SAAS,IAAI,cAAc,CAAC,UAAU,CAAC;IAcvC;;;;;;;OAOG;IACG,UAAU,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC;IAwE9D;;;;OAIG;IACH,gBAAgB,IAAI,cAAc,CAAC,UAAU,CAAC;IAiC9C;;;;;;;;;;OAUG;IACH,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG;QAChE,IAAI,EAAE,WAAW,GAAG,YAAY,CAAC;QACjC,MAAM,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;KACtC;CAsCJ"}

package/esm/bug-report.js

@@ -1,60 +1,159 @@
 // cspell: ignore bugreport
 // cspell: ignore bugreportz
 import { AdbCommandBase, AdbSubprocessShellProtocol } from "@yume-chan/adb";
-import { DecodeUtf8Stream, PushReadableStream, SplitStringStream, WrapReadableStream, WritableStream, } from "@yume-chan/stream-extra";
-class BugReportZ extends AdbCommandBase {
+import { AbortController, DecodeUtf8Stream, PushReadableStream, SplitStringStream, WrapReadableStream, WritableStream, } from "@yume-chan/stream-extra";
+export class BugReport extends AdbCommandBase {
     static VERSION_REGEX = /(\d+)\.(\d+)/;
     static BEGIN_REGEX = /BEGIN:(.*)/;
     static PROGRESS_REGEX = /PROGRESS:(.*)\/(.*)/;
     static OK_REGEX = /OK:(.*)/;
     static FAIL_REGEX = /FAIL:(.*)/;
     /**
-     * Retrieve the version of bugreportz.
-     *
-     * @returns a `BugReportVersion` object, or `undefined` if `bugreportz` is not available.
+     * Queries the device's bugreport capabilities.
      */
-    async version() {
+    static async queryCapabilities(adb) {
         // bugreportz requires shell protocol
-        if (!AdbSubprocessShellProtocol.isSupported(this.adb)) {
-            return undefined;
+        if (!AdbSubprocessShellProtocol.isSupported(adb)) {
+            return new BugReport(adb, {
+                supportsBugReport: true,
+                bugReportZVersion: undefined,
+                supportsBugReportZ: false,
+                supportsBugReportZProgress: false,
+                supportsBugReportZStream: false,
+            });
         }
-        const { stderr, exitCode } = await this.adb.subprocess.spawnAndWait([
+        const { stderr, exitCode } = await adb.subprocess.spawnAndWait([
             "bugreportz",
             "-v",
         ]);
         if (exitCode !== 0 || stderr === "") {
-            return undefined;
+            return new BugReport(adb, {
+                supportsBugReport: true,
+                bugReportZVersion: undefined,
+                supportsBugReportZ: false,
+                supportsBugReportZProgress: false,
+                supportsBugReportZStream: false,
+            });
         }
-        const match = stderr.match(BugReportZ.VERSION_REGEX);
+        const match = stderr.match(BugReport.VERSION_REGEX);
         if (!match) {
-            return undefined;
+            return new BugReport(adb, {
+                supportsBugReport: true,
+                bugReportZVersion: undefined,
+                supportsBugReportZ: false,
+                supportsBugReportZProgress: false,
+                supportsBugReportZStream: false,
+            });
         }
-        const major = parseInt(match[1], 10);
-        const minor = parseInt(match[2], 10);
-        return {
-            major,
-            minor,
-            supportProgress: this.supportProgress(major, minor),
-            supportStream: this.supportStream(major, minor),
-        };
+        const [major, minor] = match[0]
+            .split(".")
+            .map((x) => parseInt(x, 10));
+        return new BugReport(adb, {
+            // Before BugReportZ version 1.2 (Android 12), BugReport was deprecated but still works.
+            supportsBugReport: major === 1 && minor <= 1,
+            bugReportZVersion: match[0],
+            supportsBugReportZ: true,
+            supportsBugReportZProgress: major > 1 || minor >= 1,
+            supportsBugReportZStream: major > 1 || minor >= 2,
+        });
+    }
+    #supportsBugReport;
+    /**
+     * Gets whether the device supports flat (text file, non-zipped) bugreport.
+     *
+     * Should be `true` for Android version <= 11.
+     */
+    get supportsBugReport() {
+        return this.#supportsBugReport;
+    }
+    #bugReportZVersion;
+    /**
+     * Gets the version of BugReportZ.
+     *
+     * Will be `undefined` if BugReportZ is not supported.
+     */
+    get bugReportZVersion() {
+        return this.#bugReportZVersion;
+    }
+    #supportsBugReportZ;
+    /**
+     * Gets whether the device supports zipped bugreport.
+     *
+     * Should be `true` for Android version >= 7.
+     */
+    get supportsBugReportZ() {
+        return this.#supportsBugReportZ;
     }
-    supportProgress(major, minor) {
-        return major > 1 || minor >= 1;
+    #supportsBugReportZProgress;
+    /**
+     * Gets whether the device supports progress report for zipped bugreport.
+     *
+     * Should be `true` for Android version >= 8.
+     */
+    get supportsBugReportZProgress() {
+        return this.#supportsBugReportZProgress;
     }
+    #supportsBugReportZStream;
     /**
-     * Create a zipped bugreport file.
+     * Gets whether the device supports streaming zipped bugreport.
      *
-     * Compare to `stream`, this method will write the output to a file on device.
+     * Should be `true` for Android version >= 12.
+     */
+    get supportsBugReportZStream() {
+        return this.#supportsBugReportZStream;
+    }
+    constructor(adb, capabilities) {
+        super(adb);
+        this.#supportsBugReport = capabilities.supportsBugReport;
+        this.#bugReportZVersion = capabilities.bugReportZVersion;
+        this.#supportsBugReportZ = capabilities.supportsBugReportZ;
+        this.#supportsBugReportZProgress =
+            capabilities.supportsBugReportZProgress;
+        this.#supportsBugReportZStream = capabilities.supportsBugReportZStream;
+    }
+    /**
+     * Creates a legacy, non-zipped bugreport file, or throws an error if `supportsBugReport` is `false`.
+     *
+     * @returns A flat (text file, non-zipped) bugreport.
+     */
+    bugReport() {
+        if (!this.#supportsBugReport) {
+            throw new Error("Flat (text file, non-zipped) bugreport is not supported.");
+        }
+        return new WrapReadableStream(async () => {
+            // https://cs.android.com/android/platform/superproject/+/master:frameworks/native/cmds/bugreport/bugreport.cpp;drc=9b73bf07d73dbab5b792632e1e233edbad77f5fd;bpv=0;bpt=0
+            const process = await this.adb.subprocess.spawn(["bugreport"]);
+            return process.stdout;
+        });
+    }
+    /**
+     * Creates a zipped bugreport file, or throws an error if `supportsBugReportZ` is `false`.
+     *
+     * Compare to `bugReportZStream`, this method will write the output to a file on device.
      * You can pull it later using sync protocol.
      *
-     * @param onProgress Progress callback. Only specify this if `supportsProgress` is `true`.
-     * @returns The path of the bugreport file.
+     * @returns The path to the generated bugreport file on device filesystem.
      */
-    async generate(onProgress) {
-        const process = await this.adb.subprocess.spawn([
-            "bugreportz",
-            ...(onProgress ? ["-p"] : []),
-        ]);
+    async bugReportZ(options) {
+        if (options?.signal?.aborted) {
+            throw options?.signal.reason ?? new Error("Aborted");
+        }
+        if (!this.#supportsBugReportZ) {
+            throw new Error("bugreportz is not supported");
+        }
+        const args = ["bugreportz"];
+        if (options?.onProgress) {
+            if (!this.#supportsBugReportZProgress) {
+                throw new Error("bugreportz progress is not supported");
+            }
+            args.push("-p");
+        }
+        const process = await this.adb.subprocess.spawn(args, {
+            protocols: [AdbSubprocessShellProtocol],
+        });
+        options?.signal?.addEventListener("abort", () => {
+            void process.kill();
+        });
         let filename;
         let error;
         await process.stdout
@@ -63,19 +162,19 @@ class BugReportZ extends AdbCommandBase {
             .pipeTo(new WritableStream({
             write(line) {
                 // `BEGIN:` and `PROGRESS:` only appear when `-p` is specified.
-                let match = line.match(BugReportZ.PROGRESS_REGEX);
+                let match = line.match(BugReport.PROGRESS_REGEX);
                 if (match) {
-                    onProgress?.(match[1], match[2]);
+                    options?.onProgress?.(match[1], match[2]);
                 }
-                match = line.match(BugReportZ.BEGIN_REGEX);
+                match = line.match(BugReport.BEGIN_REGEX);
                 if (match) {
                     filename = match[1];
                 }
-                match = line.match(BugReportZ.OK_REGEX);
+                match = line.match(BugReport.OK_REGEX);
                 if (match) {
                     filename = match[1];
                 }
-                match = line.match(BugReportZ.FAIL_REGEX);
+                match = line.match(BugReport.FAIL_REGEX);
                 if (match) {
                     // Don't report error now
                     // We want to gather all output.
@@ -92,15 +191,14 @@ class BugReportZ extends AdbCommandBase {
         // Design choice: we don't automatically pull the file to avoid more dependency on `@yume-chan/adb`
         return filename;
     }
-    supportStream(major, minor) {
-        return major > 1 || minor >= 2;
-    }
-    stream() {
+    /**
+     * Creates a zipped bugreport file, or throws an error if `supportsBugReportZStream` is `false`.
+     *
+     * @returns The content of the generated bugreport file.
+     */
+    bugReportZStream() {
         return new PushReadableStream(async (controller) => {
-            const process = await this.adb.subprocess.spawn([
-                "bugreportz",
-                "-s",
-            ]);
+            const process = await this.adb.subprocess.spawn(["bugreportz", "-s"], { protocols: [AdbSubprocessShellProtocol] });
             process.stdout
                 .pipeTo(new WritableStream({
                 async write(chunk) {
@@ -108,7 +206,7 @@ class BugReportZ extends AdbCommandBase {
                 },
             }))
                 .catch((e) => {
-                void e;
+                controller.error(e);
             });
             process.stderr
                 .pipeThrough(new DecodeUtf8Stream())
@@ -118,20 +216,56 @@ class BugReportZ extends AdbCommandBase {
                 },
             }))
                 .catch((e) => {
-                void e;
+                controller.error(e);
             });
             await process.exit;
         });
     }
-}
-export { BugReportZ };
-// https://cs.android.com/android/platform/superproject/+/master:frameworks/native/cmds/bugreport/bugreport.cpp;drc=9b73bf07d73dbab5b792632e1e233edbad77f5fd;bpv=0;bpt=0
-export class BugReport extends AdbCommandBase {
-    generate() {
-        return new WrapReadableStream(async () => {
-            const process = await this.adb.subprocess.spawn(["bugreport"]);
-            return process.stdout;
-        });
+    /**
+     * Automatically choose the best bugreport method.
+     *
+     * * If `supportsBugReportZStream` is `true`, this method will return a stream of zipped bugreport.
+     * * If `supportsBugReportZ` is `true`, this method will return a stream of zipped bugreport, and will delete the file on device after the stream is closed.
+     * * If `supportsBugReport` is `true`, this method will return a stream of flat bugreport.
+     *
+     * @param onProgress
+     * If `supportsBugReportZStream` is `false` and `supportsBugReportZProgress` is `true`,
+     * this callback will be called when progress is updated.
+     */
+    automatic(onProgress) {
+        if (this.#supportsBugReportZStream) {
+            return { type: "bugreportz", stream: this.bugReportZStream() };
+        }
+        if (this.#supportsBugReportZ) {
+            let path;
+            let sync;
+            const controller = new AbortController();
+            const cleanup = async () => {
+                controller.abort();
+                await sync?.dispose();
+                if (path) {
+                    await this.adb.rm(path);
+                }
+            };
+            return {
+                type: "bugreportz",
+                stream: new WrapReadableStream({
+                    start: async () => {
+                        path = await this.bugReportZ({
+                            signal: controller.signal,
+                            onProgress: this.#supportsBugReportZProgress
+                                ? onProgress
+                                : undefined,
+                        });
+                        sync = await this.adb.sync();
+                        return sync.read(path);
+                    },
+                    cancel: cleanup,
+                    close: cleanup,
+                }),
+            };
+        }
+        return { type: "bugreport", stream: this.bugReport() };
     }
 }
 //# sourceMappingURL=bug-report.js.map