@mcesystems/adb-kit 1.0.87 → 1.0.91

package/README.md

@@ -61,7 +61,11 @@ await device.uninstallApp('com.example.app');
 
 ```typescript
 const hasDebugging = await device.hasUsbDebugging();
-await device.waitForUsbDebugging(30000); // 30s timeout
+const { promise, events } = device.waitForUsbDebugging(30000); // 30s timeout
+events.on("usbDebuggingOff", () => console.log("Enable USB debugging on device"));
+events.on("usbDebuggingNeedsAlwaysAllow", () => console.log("Tap Always allow on device"));
+events.on("usbDebuggingAuthorized", () => console.log("Device ready"));
+const ok = await promise;
 ```
 
 **Port forwarding**
@@ -97,7 +101,18 @@ Interactive example that runs the same flow 5 times to verify `waitForUsbDebuggi
 pnpm example:usb-debugging
 ```
 
-See [examples/usb-debugging-robustness.ts](./examples/usb-debugging-robustness.ts) for the script.
+See [src/examples/usb-debugging-robustness.ts](./src/examples/usb-debugging-robustness.ts) for the script.
+
+**USB debugging playground**
+
+Interactive playground to observe status events while you toggle USB debugging on/off or revoke authorizations. Prints events in real time as you change device settings.
+
+```bash
+# From packages/adb-kit (set ADB_DEVICE_SERIAL if USB debugging is off)
+pnpm example:usb-debugging-playground
+```
+
+See [src/examples/usb-debugging-playground.ts](./src/examples/usb-debugging-playground.ts) for the script.
 
 For more scenarios and step-by-step explanations, see [Example.md](./Example.md).
 
@@ -148,7 +163,10 @@ For more scenarios and step-by-step explanations, see [Example.md](./Example.md)
 **waitForUsbDebugging(timeout?, numberOfAllowedAttempts?)**
 
 - **Input:** `timeout?: number` (default `120000` ms), `numberOfAllowedAttempts?: number` (default `5`, accepted for backward compatibility; give-up is determined by timeout and tracker end only)
-- **Output:** `Promise<boolean>` — `true` when device is present and ready, `false` when tracking ends without device; rejects on timeout, device removal, or connection error.
+- **Output:** `{ promise: Promise<boolean>; events: EventEmitter }` — await `promise` for the result (`true` when device is ready, `false` when tracking ends without device; rejects on timeout, device removal, or connection error). Subscribe to `events` for state changes:
+  - `usbDebuggingOff` — waiting started (USB debugging not enabled on device)
+  - `usbDebuggingNeedsAlwaysAllow` — device visible but user must tap "Always allow" on device
+  - `usbDebuggingAuthorized` — device ready
 
 **startPortForward(serviceName)**
 
@@ -191,7 +209,8 @@ const deviceId = 'ABC123'; // from your device discovery
 const device = new AdbDeviceKit(deviceId, 1);
 
 // 1. Wait for USB debugging (e.g. after user enables it)
-await device.waitForUsbDebugging(60000);
+const { promise } = device.waitForUsbDebugging(60000);
+await promise;
 
 // 2. Identify device
 const [manufacturer, model] = await device.getDeviceProperties(['Manufacturer', 'Model']);

package/dist/index.js

@@ -25692,7 +25692,7 @@ var require_server = __commonJS({
 var require_api = __commonJS({
   "../../node_modules/.pnpm/@devicefarmer+adbkit-monkey@1.2.1/node_modules/@devicefarmer/adbkit-monkey/lib/monkey/api.js"(exports2, module2) {
     (function() {
-      var Api, EventEmitter, _ref, __hasProp = {}.hasOwnProperty, __extends = function(child, parent) {
+      var Api, EventEmitter2, _ref, __hasProp = {}.hasOwnProperty, __extends = function(child, parent) {
         for (var key in parent) {
           if (__hasProp.call(parent, key)) child[key] = parent[key];
         }
@@ -25704,7 +25704,7 @@ var require_api = __commonJS({
         child.__super__ = parent.prototype;
         return child;
       };
-      EventEmitter = require("events").EventEmitter;
+      EventEmitter2 = require("events").EventEmitter;
       Api = (function(_super) {
         __extends(Api2, _super);
         function Api2() {
@@ -25918,7 +25918,7 @@ var require_api = __commonJS({
           return this;
         };
         return Api2;
-      })(EventEmitter);
+      })(EventEmitter2);
       module2.exports = Api;
     }).call(exports2);
   }
@@ -26099,7 +26099,7 @@ var require_multi = __commonJS({
 var require_parser2 = __commonJS({
   "../../node_modules/.pnpm/@devicefarmer+adbkit-monkey@1.2.1/node_modules/@devicefarmer/adbkit-monkey/lib/monkey/parser.js"(exports2, module2) {
     (function() {
-      var EventEmitter, Parser, Reply, __hasProp = {}.hasOwnProperty, __extends = function(child, parent) {
+      var EventEmitter2, Parser, Reply, __hasProp = {}.hasOwnProperty, __extends = function(child, parent) {
         for (var key in parent) {
           if (__hasProp.call(parent, key)) child[key] = parent[key];
         }
@@ -26111,7 +26111,7 @@ var require_parser2 = __commonJS({
         child.__super__ = parent.prototype;
         return child;
       };
-      EventEmitter = require("events").EventEmitter;
+      EventEmitter2 = require("events").EventEmitter;
       Reply = require_reply();
       Parser = (function(_super) {
         __extends(Parser2, _super);
@@ -26159,7 +26159,7 @@ var require_parser2 = __commonJS({
           this.emit("error", new SyntaxError("Unparseable line '" + line + "'"));
         };
         return Parser2;
-      })(EventEmitter);
+      })(EventEmitter2);
       module2.exports = Parser;
     }).call(exports2);
   }
@@ -30214,11 +30214,15 @@ var require_dist = __commonJS({
 var index_exports = {};
 __export(index_exports, {
   AdbDeviceKit: () => AdbDeviceKit,
+  USB_DEBUGGING_EVENT_AUTHORIZED: () => USB_DEBUGGING_EVENT_AUTHORIZED,
+  USB_DEBUGGING_EVENT_NEEDS_ALWAYS_ALLOW: () => USB_DEBUGGING_EVENT_NEEDS_ALWAYS_ALLOW,
+  USB_DEBUGGING_EVENT_OFF: () => USB_DEBUGGING_EVENT_OFF,
   readAll: () => readAll
 });
 module.exports = __toCommonJS(index_exports);
 
 // src/logic/adbDeviceKit.ts
+var import_node_events = require("node:events");
 var adbkit = __toESM(require_dist());
 
 // ../tool-debug/dist/index.mjs
@@ -31353,6 +31357,11 @@ function portNumbers(from, to) {
   return generator(from, to);
 }
 
+// src/types/usbDebugging.ts
+var USB_DEBUGGING_EVENT_OFF = "usbDebuggingOff";
+var USB_DEBUGGING_EVENT_NEEDS_ALWAYS_ALLOW = "usbDebuggingNeedsAlwaysAllow";
+var USB_DEBUGGING_EVENT_AUTHORIZED = "usbDebuggingAuthorized";
+
 // src/utils/adbPath.ts
 var import_node_fs = require("node:fs");
 var import_node_path = __toESM(require("node:path"));
@@ -31449,8 +31458,9 @@ var deviceProps = {
   "Build User": "ro.build.user"
 };
 var AdbDeviceKit = class {
-  constructor(deviceId, port) {
+  constructor(deviceId, port, config) {
     this.port = port;
+    this.config = config;
     setNamespace(`adb-kit:${deviceId}`);
     ensureAdbPathFromResources();
     installConnectionErrorHandler();
@@ -31464,7 +31474,7 @@ var AdbDeviceKit = class {
   deviceId;
   devicePort = null;
   connect() {
-    const adbBin = process.env.ADB_PATH ?? getAdbBinaryPath() ?? "adb";
+    const adbBin = process.env.ADB_PATH ?? this.config?.binPath ?? "adb";
     const client = adbkit.default.createClient({ bin: adbBin });
     const errorHandler = (err) => {
       logError(`ADB client connection error (e.g. device disconnected): ${err.message}`);
@@ -31530,81 +31540,95 @@ var AdbDeviceKit = class {
    * during tracking don't affect other operations.
    */
   createTrackingClient() {
-    const adbBin = process.env.ADB_PATH ?? getAdbBinaryPath() ?? "adb";
+    const adbBin = process.env.ADB_PATH ?? this.config?.binPath ?? "adb";
     return adbkit.default.createClient({ bin: adbBin });
   }
-  async waitForUsbDebugging(timeout2 = 12e4, _numberOfAllowedAttempts = 5) {
-    if (await this.hasUsbDebugging()) {
-      logDetail("USB debugging is already enabled");
-      return true;
-    }
-    const trackingClient = this.createTrackingClient();
-    const tracker = await trackingClient.trackDevices();
-    let settled = false;
-    return new Promise((resolve, reject) => {
-      const timeoutId = setTimeout(() => {
-        logError("Timeout waiting for USB debugging");
-        settle({ type: "reject", err: new Error("Timeout waiting for USB debugging") });
-      }, timeout2);
-      const cleanupTrackingClient = () => {
-        try {
-          tracker.end();
-        } catch {
-        }
-        trackingClient.on("error", () => {
+  matchesDeviceId(device) {
+    return device.id === this.deviceId || device.id.endsWith(this.deviceId);
+  }
+  waitForUsbDebugging(timeout2 = 12e4, _numberOfAllowedAttempts = 5) {
+    const events = new import_node_events.EventEmitter();
+    const promise = (async () => {
+      if (await this.hasUsbDebugging()) {
+        logDetail("USB debugging is already enabled");
+        return true;
+      }
+      const trackingClient = this.createTrackingClient();
+      const tracker = await trackingClient.trackDevices();
+      events.emit(USB_DEBUGGING_EVENT_OFF);
+      let settled = false;
+      return new Promise((resolve, reject) => {
+        const timeoutId = setTimeout(() => {
+          logError("Timeout waiting for USB debugging");
+          settle({ type: "reject", err: new Error("Timeout waiting for USB debugging") });
+        }, timeout2);
+        const cleanupTrackingClient = () => {
+          try {
+            tracker.end();
+          } catch {
+          }
+          trackingClient.on("error", () => {
+          });
+        };
+        const settle = (result) => {
+          if (settled) return;
+          settled = true;
+          clearTimeout(timeoutId);
+          cleanupTrackingClient();
+          if (result.type === "resolve") {
+            resolve(result.value);
+          } else {
+            logError(result.err.message);
+            reject(result.err);
+          }
+        };
+        const handleAddOrChange = (device) => {
+          if (!this.matchesDeviceId(device)) return;
+          if (device.type === "unauthorized") {
+            logDetail("Device needs 'Always allow' authorization");
+            events.emit(USB_DEBUGGING_EVENT_NEEDS_ALWAYS_ALLOW);
+            return;
+          }
+          if (device.type === "device") {
+            logDetail("Device authorized");
+            events.emit(USB_DEBUGGING_EVENT_AUTHORIZED);
+            settle({ type: "resolve", value: true });
+          }
+        };
+        trackingClient.on("error", (err) => {
+          if (isConnectionErrorMessage(err)) {
+            logDetail(`Tracking client connection closed: ${err.message}`);
+            settle({ type: "resolve", value: false });
+          } else {
+            logError(`Tracking client error: ${err.message}`);
+            settle({ type: "reject", err });
+          }
         });
-      };
-      const settle = (result) => {
-        if (settled) return;
-        settled = true;
-        clearTimeout(timeoutId);
-        cleanupTrackingClient();
-        if (result.type === "resolve") {
-          resolve(result.value);
-        } else {
-          logError(result.err.message);
-          reject(result.err);
-        }
-      };
-      trackingClient.on("error", (err) => {
-        if (isConnectionErrorMessage(err)) {
-          logDetail(`Tracking client connection closed: ${err.message}`);
-          settle({ type: "resolve", value: false });
-        } else {
-          logError(`Tracking client error: ${err.message}`);
-          settle({ type: "reject", err });
-        }
-      });
-      tracker.on("error", (err) => {
-        if (isConnectionErrorMessage(err)) {
-          logDetail(`Tracker connection closed: ${err.message}`);
+        tracker.on("error", (err) => {
+          if (isConnectionErrorMessage(err)) {
+            logDetail(`Tracker connection closed: ${err.message}`);
+            settle({ type: "resolve", value: false });
+          } else {
+            logError(`Tracker error: ${err.message}`);
+            settle({ type: "reject", err });
+          }
+        });
+        tracker.on("end", () => {
+          logDetail("Device tracking ended");
           settle({ type: "resolve", value: false });
-        } else {
-          logError(`Tracker error: ${err.message}`);
-          settle({ type: "reject", err });
-        }
-      });
-      tracker.on("end", () => {
-        logDetail("Device tracking ended");
-        settle({ type: "resolve", value: false });
-      });
-      tracker.on("remove", (_) => {
-        logError("Device removed from tracker");
-        settle({ type: "reject", err: new Error("Device removed while waiting for USB debugging") });
-      });
-      tracker.on("add", (device) => {
-        if (device.type === "device") {
-          logDetail("Device added to tracker");
-          settle({ type: "resolve", value: true });
-        }
-      });
-      tracker.on("change", (device) => {
-        if (device.type === "device") {
-          logDetail("Device changed in tracker");
-          settle({ type: "resolve", value: true });
-        }
+        });
+        tracker.on("remove", (_) => {
+          logError("Device removed from tracker");
+          settle({
+            type: "reject",
+            err: new Error("Device removed while waiting for USB debugging")
+          });
+        });
+        tracker.on("add", handleAddOrChange);
+        tracker.on("change", handleAddOrChange);
       });
-    });
+    })();
+    return { promise, events };
   }
   async startPortForward(serviceName) {
     if (this.devicePort) {
@@ -31634,6 +31658,9 @@ var readAll = import_adbkit.default.util.readAll;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AdbDeviceKit,
+  USB_DEBUGGING_EVENT_AUTHORIZED,
+  USB_DEBUGGING_EVENT_NEEDS_ALWAYS_ALLOW,
+  USB_DEBUGGING_EVENT_OFF,
   readAll
 });
 //# sourceMappingURL=index.js.map