@mcesystems/adb-kit 1.0.25 → 1.0.26

package/dist/types/logic/adbDeviceKit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"adbDeviceKit.d.ts","sourceRoot":"","sources":["../../../src/logic/adbDeviceKit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,SAAS,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC9E,OAAO,KAAK,MAAM,MAAM,sBAAsB,CAAC;AAoB/C,QAAA,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BhB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,WAAW,CAAC;AAEtD,qBAAa,YAAY;IAQvB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAPtB,OAAO,CAAC,MAAM,CAAY;IAC1B,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,UAAU,CAAuB;gBAGxC,QAAQ,EAAE,MAAM,EACC,IAAI,EAAE,MAAM;IAUjB,WAAW;YAKV,WAAW;IAqBZ,sBAAsB;IAOtB,mBAAmB,CAAC,UAAU,EAAE,cAAc,EAAE;IAWhD,UAAU,CAAC,OAAO,EAAE,MAAM;IAQ1B,YAAY,CAAC,WAAW,EAAE,MAAM;IAQhC,cAAc,CAAC,WAAW,EAAE,MAAM;IAQ/C;;;OAGG;IACU,SAAS;IAKT,eAAe;IAKf,mBAAmB,CAAC,OAAO,SAAS;IAgCpC,gBAAgB,CAAC,WAAW,EAAE,MAAM;IAW1C,WAAW;IAIX,OAAO;IAID,eAAe;CAI5B"}
+{"version":3,"file":"adbDeviceKit.d.ts","sourceRoot":"","sources":["../../../src/logic/adbDeviceKit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,SAAS,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC9E,OAAO,KAAK,MAAM,MAAM,sBAAsB,CAAC;AAc/C,QAAA,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BhB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,WAAW,CAAC;AAEtD,qBAAa,YAAY;IAQvB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAPtB,OAAO,CAAC,MAAM,CAAY;IAC1B,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,UAAU,CAAuB;gBAGxC,QAAQ,EAAE,MAAM,EACC,IAAI,EAAE,MAAM;IAYjB,WAAW;YAKV,WAAW;IAqBZ,sBAAsB;IAOtB,mBAAmB,CAAC,UAAU,EAAE,cAAc,EAAE;IAWhD,UAAU,CAAC,OAAO,EAAE,MAAM;IAQ1B,YAAY,CAAC,WAAW,EAAE,MAAM;IAQhC,cAAc,CAAC,WAAW,EAAE,MAAM;IAQ/C;;;OAGG;IACU,SAAS;IAKT,eAAe;IAKf,mBAAmB,CAAC,OAAO,SAAS;IAgCpC,gBAAgB,CAAC,WAAW,EAAE,MAAM;IAW1C,WAAW;IAIX,OAAO;IAID,eAAe;CAI5B"}

package/dist/types/utils/adbPath.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"adbPath.d.ts","sourceRoot":"","sources":["../../../src/utils/adbPath.ts"],"names":[],"mappings":"AAiCA;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,GAAG,IAAI,CA4BhD;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,IAAI,MAAM,GAAG,IAAI,CAwBlD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAEvC"}
+{"version":3,"file":"adbPath.d.ts","sourceRoot":"","sources":["../../../src/utils/adbPath.ts"],"names":[],"mappings":"AAiCA;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,GAAG,IAAI,CAkBhD;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,IAAI,MAAM,GAAG,IAAI,CAwBlD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAEvC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mcesystems/adb-kit",
-  "version": "1.0.25",
+  "version": "1.0.26",
   "description": "ADB (Android Debug Bridge) toolkit for device management",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -30,7 +30,8 @@
   "dependencies": {
     "@devicefarmer/adbkit": "^3.3.8",
     "debug": "^4.4.3",
-    "get-port": "^7.1.0"
+    "get-port": "^7.1.0",
+    "tsx": "^4.21.0"
   },
   "devDependencies": {
     "@types/debug": "^4.1.12",
@@ -39,16 +40,18 @@
     "esbuild": "^0.27.0",
     "esbuild-plugin-copy": "^2.1.1",
     "rimraf": "^6.0.1",
-    "tsx": "^4.21.0",
     "typescript": "^5.7.2",
     "vitest": "^2.1.8"
   },
   "files": [
     "dist",
+    "scripts",
     "README.md"
   ],
+  "bin": {
+    "export-adb-resources": "./scripts/export-resources.ts"
+  },
   "scripts": {
-    "prepareResources": "tsx scripts/prepareResources.ts",
     "build": "tsx esbuild.config.mts && tsc --emitDeclarationOnly",
     "clean": "node-gyp clean && rimraf dist",
     "pack": "npm pack",

package/scripts/README.md

@@ -0,0 +1,183 @@
+# Export ADB Resources Script
+
+This script downloads Android Debug Bridge (ADB) platform tools from Google and exports them to a specified target directory. The exported resources can be used by applications that depend on `@mcesystems/adb-kit`.
+
+## Usage
+
+After installing `@mcesystems/adb-kit`:
+
+```bash
+# Using the binary (recommended)
+npx export-adb-resources <target-path> [options]
+
+# Or run the script directly with tsx
+npx tsx node_modules/@mcesystems/adb-kit/scripts/export-resources.ts <target-path> [options]
+```
+
+### Arguments
+
+| Argument | Description |
+|----------|-------------|
+| `target-path` | Directory where resources will be exported |
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| `--all` | Download resources for all platforms (Windows, macOS, Linux) |
+| `--platform <name>` | Download resources for a specific platform (`windows`, `darwin`, `linux`) |
+| `--help`, `-h` | Show usage information |
+
+### Examples
+
+```bash
+# Export for current platform only
+npx tsx export-resources.ts ./my-app/resources/adb-kit
+
+# Export for all platforms
+npx tsx export-resources.ts ./my-app/resources/adb-kit --all
+
+# Export for a specific platform
+npx tsx export-resources.ts ./my-app/resources/adb-kit --platform windows
+```
+
+### Output Structure
+
+The script creates the following directory structure:
+
+```
+<target-path>/
+├── bin/
+│   ├── darwin/          # macOS
+│   │   └── adb
+│   ├── windows/         # Windows
+│   │   ├── adb.exe
+│   │   ├── AdbWinApi.dll
+│   │   └── AdbWinUsbApi.dll
+│   └── linux/           # Linux
+│       └── adb
+└── licenses/
+    └── APACHE-2.0.txt
+```
+
+---
+
+## Prerequisites
+
+### All Platforms
+
+1. **Node.js 18+** with `tsx` available:
+   ```bash
+   npm install -g tsx
+   # or use npx
+   ```
+
+2. **Internet connection** to download from Google's servers
+
+### macOS / Linux
+
+- **unzip** command available (usually pre-installed)
+
+### Windows
+
+- **PowerShell** available (included with Windows 10+)
+
+---
+
+## How It Works
+
+1. Downloads the official platform-tools ZIP from Google's Android SDK repository
+2. Extracts the required ADB binaries
+3. Copies them to the target directory with proper permissions
+4. Creates a license file for Apache 2.0 compliance
+
+---
+
+## Files Included
+
+### Windows
+| File | Description |
+|------|-------------|
+| `adb.exe` | Android Debug Bridge executable |
+| `AdbWinApi.dll` | ADB Windows API library |
+| `AdbWinUsbApi.dll` | ADB Windows USB API library |
+
+### macOS / Linux
+| File | Description |
+|------|-------------|
+| `adb` | Android Debug Bridge executable |
+
+---
+
+## Integrating with Your Application
+
+After exporting resources, configure `adb-kit` to use them:
+
+### Option 1: Environment Variable
+
+Set `AdbBinPath` to point to the bin directory:
+
+```bash
+# macOS
+export AdbBinPath=/path/to/resources/bin/darwin
+
+# Linux
+export AdbBinPath=/path/to/resources/bin/linux
+
+# Windows (PowerShell)
+$env:AdbBinPath = "C:\path\to\resources\bin\windows"
+```
+
+### Option 2: Bundle with Your App
+
+Copy the exported resources into your application's resources folder. The `adb-kit` package will automatically detect binaries in:
+- `<your-app>/resources/bin/darwin/` (macOS)
+- `<your-app>/resources/bin/linux/` (Linux)
+- `<your-app>/resources/bin/windows/` (Windows)
+
+---
+
+## Driver Requirements
+
+### Windows
+
+On Windows, you may need to install USB drivers for your Android device:
+
+1. **Google USB Driver** (for Nexus/Pixel devices):
+   - Download from [Android Developer site](https://developer.android.com/studio/run/win-usb)
+   
+2. **Manufacturer drivers** (for other devices):
+   - Check your device manufacturer's website
+
+### macOS / Linux
+
+No additional drivers required. USB works out of the box.
+
+### Linux udev Rules
+
+On Linux, you may need to add udev rules for your device:
+
+```bash
+# Create udev rules file
+sudo nano /etc/udev/rules.d/51-android.rules
+
+# Add a rule for your device (example for Google devices)
+SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", MODE="0666", GROUP="plugdev"
+
+# Reload udev rules
+sudo udevadm control --reload-rules
+sudo udevadm trigger
+```
+
+---
+
+## License
+
+ADB is licensed under **Apache License 2.0**.
+
+The binaries are downloaded from Google's official Android SDK repository:
+- https://developer.android.com/studio/releases/platform-tools
+
+Source code:
+- https://android.googlesource.com/platform/packages/modules/adb/
+

package/scripts/export-resources.ts

@@ -0,0 +1,368 @@
+#!/usr/bin/env tsx
+/**
+ * Export ADB (Android Debug Bridge) resources to a specified path
+ *
+ * This script downloads ADB platform tools from Google and exports them
+ * to a target directory. The resources can then be used by applications
+ * that depend on adb-kit.
+ *
+ * Usage:
+ *   npx tsx export-resources.ts <target-path>
+ *
+ * Example:
+ *   npx tsx export-resources.ts /path/to/my-app/resources/adb-kit
+ *
+ * Platform support:
+ *   - macOS: Downloads darwin platform-tools from Google
+ *   - Windows: Downloads windows platform-tools from Google
+ *   - Linux: Downloads linux platform-tools from Google
+ */
+
+import { exec } from "node:child_process";
+import {
+	chmodSync,
+	copyFileSync,
+	createWriteStream,
+	existsSync,
+	mkdirSync,
+	writeFileSync,
+} from "node:fs";
+import path from "node:path";
+import { promisify } from "node:util";
+
+const execAsync = promisify(exec);
+
+// ============================================================================
+// Configuration
+// ============================================================================
+
+// ADB download URLs from Google
+const ADB_URLS: Record<string, string> = {
+	windows:
+		"https://dl.google.com/android/repository/platform-tools-latest-windows.zip",
+	darwin:
+		"https://dl.google.com/android/repository/platform-tools-latest-darwin.zip",
+	linux:
+		"https://dl.google.com/android/repository/platform-tools-latest-linux.zip",
+};
+
+// Files to extract from platform-tools per platform
+const PLATFORM_FILES: Record<string, string[]> = {
+	windows: ["adb.exe", "AdbWinApi.dll", "AdbWinUsbApi.dll"],
+	darwin: ["adb"],
+	linux: ["adb"],
+};
+
+// ============================================================================
+// Utility Functions
+// ============================================================================
+
+function printUsage(): void {
+	console.log(`
+Usage: npx tsx export-resources.ts <target-path>
+
+Arguments:
+  target-path    Directory where resources will be exported
+
+Examples:
+  npx tsx export-resources.ts ./my-app/resources/adb-kit
+  npx tsx export-resources.ts /absolute/path/to/resources
+
+The script will create the following structure:
+  <target-path>/
+    bin/
+      darwin/     (macOS ADB binary)
+      windows/    (Windows ADB binaries and DLLs)
+      linux/      (Linux ADB binary)
+    licenses/
+      APACHE-2.0.txt
+`);
+}
+
+async function downloadFile(url: string, destPath: string): Promise<void> {
+	console.log(`Downloading ${url}...`);
+
+	let response: Response;
+	try {
+		response = await fetch(url);
+	} catch {
+		// Fallback to https module if fetch is not available
+		const https = await import("node:https");
+		const http = await import("node:http");
+		const urlObj = new URL(url);
+		const client = urlObj.protocol === "https:" ? https : http;
+
+		return new Promise((resolve, reject) => {
+			const fileStream = createWriteStream(destPath);
+			const request = client.get(url, (res) => {
+				if (
+					res.statusCode &&
+					res.statusCode >= 300 &&
+					res.statusCode < 400 &&
+					res.headers.location
+				) {
+					// Handle redirect
+					fileStream.close();
+					return downloadFile(res.headers.location, destPath)
+						.then(resolve)
+						.catch(reject);
+				}
+				if (res.statusCode && res.statusCode !== 200) {
+					fileStream.close();
+					reject(
+						new Error(
+							`Failed to download ${url}: ${res.statusCode} ${res.statusMessage}`
+						)
+					);
+					return;
+				}
+				res.pipe(fileStream);
+				fileStream.on("finish", () => {
+					fileStream.close();
+					resolve();
+				});
+			});
+			request.on("error", (err) => {
+				fileStream.close();
+				reject(err);
+			});
+		});
+	}
+
+	if (!response.ok) {
+		throw new Error(`Failed to download ${url}: ${response.statusText}`);
+	}
+
+	const fileStream = createWriteStream(destPath);
+	const reader = response.body?.getReader();
+	if (!reader) {
+		throw new Error(`Failed to get response body for ${url}`);
+	}
+
+	try {
+		while (true) {
+			const { done, value } = await reader.read();
+			if (done) break;
+			fileStream.write(value);
+		}
+		fileStream.end();
+		await new Promise<void>((resolve, reject) => {
+			fileStream.on("finish", resolve);
+			fileStream.on("error", reject);
+		});
+		console.log(`✓ Downloaded to ${destPath}`);
+	} finally {
+		reader.releaseLock();
+	}
+}
+
+async function extractZip(
+	zipPath: string,
+	extractDir: string
+): Promise<void> {
+	console.log(`Extracting ${zipPath}...`);
+
+	if (process.platform === "win32") {
+		// On Windows, use PowerShell Expand-Archive
+		try {
+			const escapedZipPath = zipPath.replace(/'/g, "''");
+			const escapedExtractDir = extractDir.replace(/'/g, "''");
+			await execAsync(
+				`powershell -Command "Expand-Archive -Path '${escapedZipPath}' -DestinationPath '${escapedExtractDir}' -Force"`
+			);
+		} catch (error) {
+			const err = error as { message?: string };
+			throw new Error(
+				`Failed to extract zip file. Please ensure PowerShell is available. Error: ${err.message || error}`
+			);
+		}
+	} else {
+		// On Unix-like systems, use unzip command
+		try {
+			await execAsync(`unzip -o "${zipPath}" -d "${extractDir}"`);
+		} catch (error) {
+			const err = error as { message?: string };
+			throw new Error(
+				`Failed to extract zip file. Please ensure 'unzip' is installed. Error: ${err.message || error}`
+			);
+		}
+	}
+	console.log(`✓ Extracted to ${extractDir}`);
+}
+
+async function copyFiles(
+	sourceDir: string,
+	targetDir: string,
+	files: string[]
+): Promise<void> {
+	mkdirSync(targetDir, { recursive: true });
+
+	for (const file of files) {
+		const sourcePath = path.join(sourceDir, "platform-tools", file);
+		const targetPath = path.join(targetDir, file);
+
+		if (!existsSync(sourcePath)) {
+			console.warn(`Warning: ${file} not found in ${sourcePath}`);
+			continue;
+		}
+
+		copyFileSync(sourcePath, targetPath);
+		console.log(`✓ Copied ${file}`);
+	}
+}
+
+function makeExecutable(filePath: string): void {
+	if (process.platform !== "win32") {
+		chmodSync(filePath, 0o755);
+	}
+}
+
+async function cleanupDir(dirPath: string): Promise<void> {
+	try {
+		const { rimraf } = await import("rimraf");
+		await rimraf(dirPath);
+	} catch {
+		// Ignore cleanup errors
+	}
+}
+
+// ============================================================================
+// Export Functions
+// ============================================================================
+
+type PlatformType = "windows" | "darwin" | "linux";
+
+async function exportPlatformResources(
+	platform: PlatformType,
+	targetDir: string
+): Promise<void> {
+	console.log(`\n=== Exporting ${platform} Resources ===\n`);
+
+	const binDir = path.join(targetDir, "bin", platform);
+	const files = PLATFORM_FILES[platform];
+	const url = ADB_URLS[platform];
+
+	// Create temp directory for extraction
+	const tempDir = path.join(targetDir, ".temp", platform);
+	mkdirSync(tempDir, { recursive: true });
+	const zipPath = path.join(tempDir, `platform-tools-${platform}.zip`);
+
+	try {
+		// Download
+		await downloadFile(url, zipPath);
+
+		// Extract
+		await extractZip(zipPath, tempDir);
+
+		// Copy files to target
+		await copyFiles(tempDir, binDir, files);
+
+		// Make executable on Unix
+		if (platform !== "windows") {
+			for (const file of files) {
+				makeExecutable(path.join(binDir, file));
+			}
+		}
+
+		console.log(`\n✓ ${platform} resources exported to: ${binDir}`);
+	} finally {
+		// Clean up temp directory
+		await cleanupDir(tempDir);
+	}
+}
+
+// ============================================================================
+// License
+// ============================================================================
+
+function createLicenseFile(targetDir: string): void {
+	const licensesDir = path.join(targetDir, "licenses");
+	mkdirSync(licensesDir, { recursive: true });
+
+	const apacheLicense = `Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+Android Debug Bridge (ADB) is licensed under the Apache License 2.0.
+
+For full license text, see:
+https://www.apache.org/licenses/LICENSE-2.0
+
+These binaries are downloaded from Google's official Android SDK repository:
+https://developer.android.com/studio/releases/platform-tools
+
+Source code is available at:
+https://android.googlesource.com/platform/packages/modules/adb/
+`;
+
+	const licensePath = path.join(licensesDir, "APACHE-2.0.txt");
+	writeFileSync(licensePath, apacheLicense);
+	console.log(`✓ Created license file: ${licensePath}`);
+}
+
+// ============================================================================
+// Main
+// ============================================================================
+
+async function main(): Promise<void> {
+	const args = process.argv.slice(2);
+
+	if (args.length === 0 || args.includes("--help") || args.includes("-h")) {
+		printUsage();
+		process.exit(args.length === 0 ? 1 : 0);
+	}
+
+	const targetPath = path.resolve(args[0]);
+
+	// Check for optional platform argument
+	let platforms: PlatformType[];
+	if (args.includes("--all")) {
+		platforms = ["windows", "darwin", "linux"];
+	} else if (args.includes("--platform")) {
+		const platformIdx = args.indexOf("--platform");
+		const platformArg = args[platformIdx + 1] as PlatformType;
+		if (!["windows", "darwin", "linux"].includes(platformArg)) {
+			console.error(`Invalid platform: ${platformArg}`);
+			console.error("Valid platforms: windows, darwin, linux");
+			process.exit(1);
+		}
+		platforms = [platformArg];
+	} else {
+		// Default to current platform
+		const currentPlatform =
+			process.platform === "win32" ? "windows" : process.platform;
+		if (!["windows", "darwin", "linux"].includes(currentPlatform)) {
+			console.error(`Unsupported platform: ${currentPlatform}`);
+			process.exit(1);
+		}
+		platforms = [currentPlatform as PlatformType];
+	}
+
+	console.log("=== ADB Resources Export ===");
+	console.log(`Target: ${targetPath}`);
+	console.log(`Platforms: ${platforms.join(", ")}`);
+
+	// Create target directory
+	mkdirSync(targetPath, { recursive: true });
+
+	// Export resources for each platform
+	for (const platform of platforms) {
+		await exportPlatformResources(platform, targetPath);
+	}
+
+	// Create license file
+	console.log("");
+	createLicenseFile(targetPath);
+
+	// Clean up temp directory
+	await cleanupDir(path.join(targetPath, ".temp"));
+
+	console.log("\n=== Export Complete ===");
+	console.log(`Resources exported to: ${targetPath}`);
+}
+
+main().catch((error) => {
+	console.error("Export failed:", error);
+	process.exit(1);
+});
+