@cldmv/droidsock 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,8 +14,8 @@ A complete, from-scratch implementation of the Android Debug Bridge (ADB) protoc
|
|
|
14
14
|
> **Current status:**
|
|
15
15
|
>
|
|
16
16
|
> - **Shell + streaming**: Stable - command execution, interactive shells, and log/process streaming all work over the real ADB protocol.
|
|
17
|
-
> - **File transfer**: `mkdir
|
|
18
|
-
> - **Experimental**: `push
|
|
17
|
+
> - **File transfer**: `mkdir` / `remove` / `move` / `copy` / `chmod` / `diskUsage` / `find` / `stat` work today via shell commands. `list` prefers a binary-safe SYNC-based implementation with automatic shell fallback.
|
|
18
|
+
> - **Experimental**: `push` / `pull` / `listSync` (real ADB SYNC sub-protocol usage), `device.reboot()`, `device.forward()`, and `device.install()` are all implemented - built from the ADB protocol spec and covered by mocked unit tests - but **none of them have been run against a real device yet**. See [#1](https://github.com/CLDMV/droidsock/issues/1). Forwarding is host → device only; install is push-then-install only - see the [v1.1.0 changelog](./docs/changelog/v1/v1.1.0.md) for what's tracked separately.
|
|
19
19
|
|
|
20
20
|
---
|
|
21
21
|
|
|
@@ -23,9 +23,9 @@ A complete, from-scratch implementation of the Android Debug Bridge (ADB) protoc
|
|
|
23
23
|
|
|
24
24
|
### Latest: v1.1.0 (September 2026)
|
|
25
25
|
|
|
26
|
-
- **`list
|
|
26
|
+
- **`list` / `stat` fixed** - v1.0.0 shipped both throwing due to a dangling reference to a module that never existed in the repo.
|
|
27
27
|
- **Binary-safe `list()`** - prefers the ADB SYNC `LIST` command, falls back to shell `ls -la` parsing only when SYNC isn't usable.
|
|
28
|
-
- **`push
|
|
28
|
+
- **`push` / `pull` implemented (experimental)** - real binary file transfer via the ADB SYNC sub-protocol.
|
|
29
29
|
- **`device.reboot()`** (experimental) - the real ADB `reboot:` service, including bootloader/recovery/sideload modes.
|
|
30
30
|
- **`device.forward()`** (experimental) - TCP port forwarding (host → device direction).
|
|
31
31
|
- **`device.install()`** (experimental) - local APK install via the classic push-then-install flow.
|
|
@@ -34,7 +34,7 @@ A complete, from-scratch implementation of the Android Debug Bridge (ADB) protoc
|
|
|
34
34
|
### Previous: v1.0.0 (September 2026)
|
|
35
35
|
|
|
36
36
|
- **First stable release** - a real Vitest test suite with measured coverage, the full CLDMV v4 CI/release pipeline, a real `dist/` build, and an API surface that's been reviewed rather than just grown.
|
|
37
|
-
- **Breaking**: the default export is now itself the callable quick path (`await droidsock()`); the old top-level `connect()
|
|
37
|
+
- **Breaking**: the default export is now itself the callable quick path (`await droidsock()`); the old top-level `connect()` / `listDevices()` exports are gone.
|
|
38
38
|
- [View full v1.0.0 Changelog](./docs/changelog/v1/v1.0.0.md)
|
|
39
39
|
|
|
40
40
|
📚 **For complete version history and detailed release notes, see [docs/changelog/](./docs/changelog/) folder.**
|
|
@@ -47,7 +47,7 @@ A complete, from-scratch implementation of the Android Debug Bridge (ADB) protoc
|
|
|
47
47
|
- ✅ **RSA Authentication**: Automatic key generation and ADB-specific signature/public-key formatting
|
|
48
48
|
- ✅ **Stream Multiplexing**: Multiple concurrent operations over a single connection
|
|
49
49
|
- ✅ **Shell Commands**: Execute commands, stream output, interactive sessions
|
|
50
|
-
- ✅ **File Operations**: Shell-based `mkdir
|
|
50
|
+
- ✅ **File Operations**: Shell-based `mkdir` / `remove` / `move` / `copy` / `chmod` / `diskUsage` / `find`, plus binary-safe SYNC-based `list`, and experimental `push` / `pull`
|
|
51
51
|
- ✅ **Reboot** (experimental): Real `reboot:` service, including bootloader/recovery/sideload modes
|
|
52
52
|
- ✅ **Port Forwarding** (experimental): `adb forward`-equivalent TCP tunneling (host → device)
|
|
53
53
|
- ✅ **APK Install** (experimental): `adb install`-equivalent local APK installation
|
|
@@ -112,9 +112,9 @@ Use the `references/devices.json` file to configure your devices:
|
|
|
112
112
|
|
|
113
113
|
## API Reference
|
|
114
114
|
|
|
115
|
-
`droidsock(options)` (also `createDroidSock`) creates the API instance; `api.device.connect(host, port, options)` returns a device object exposing connection state, shell execution/streaming, file operations (`push
|
|
115
|
+
`droidsock(options)` (also `createDroidSock`) creates the API instance; `api.device.connect(host, port, options)` returns a device object exposing connection state, shell execution/streaming, file operations (`push` / `pull` / `list` / `stat`), reboot, port forwarding, and APK install.
|
|
116
116
|
|
|
117
|
-
📚 **See [docs/API.md](./docs/API.md) for the full method reference**, including every option and the experimental/scope caveats on `push
|
|
117
|
+
📚 **See [docs/API.md](./docs/API.md) for the full method reference**, including every option and the experimental/scope caveats on `push` / `pull` / `list` / `forward` / `install`.
|
|
118
118
|
|
|
119
119
|
## Examples
|
|
120
120
|
|
|
@@ -149,7 +149,7 @@ node examples/streaming-example.mjs files
|
|
|
149
149
|
2. **Authentication Layer** (`src/api/auth.mjs`): RSA key management and ADB signature/public-key formatting
|
|
150
150
|
3. **Stream Layer** (`src/api/stream.mjs`): ADB stream multiplexing (OPEN/WRTE/OKAY/CLSE)
|
|
151
151
|
4. **Shell Layer** (`src/api/shell.mjs`): Command execution, streaming, and interactive shell APIs
|
|
152
|
-
5. **Files Layer** (`src/api/files.mjs`): Shell-based file operations, a binary-safe SYNC `LIST` implementation with automatic shell fallback, and an experimental ADB SYNC sub-protocol implementation for real binary transfer (`push
|
|
152
|
+
5. **Files Layer** (`src/api/files.mjs`): Shell-based file operations, a binary-safe SYNC `LIST` implementation with automatic shell fallback, and an experimental ADB SYNC sub-protocol implementation for real binary transfer (`push` / `pull`) - not yet validated against a real device
|
|
153
153
|
6. **Reboot Layer** (`src/api/reboot.mjs`): Real ADB `reboot:` service
|
|
154
154
|
7. **Forward Layer** (`src/api/forward.mjs`): TCP port forwarding (host → device) via the `tcp:` service
|
|
155
155
|
8. **Install Layer** (`src/api/install.mjs`): Local APK install, composed from the Files and Shell layers
|
|
@@ -181,7 +181,7 @@ node examples/streaming-example.mjs files
|
|
|
181
181
|
|
|
182
182
|
## Development
|
|
183
183
|
|
|
184
|
-
The implementation is built directly from the public ADB protocol documentation (AOSP `SYNC.TXT` and the wire-protocol references), cross-checked against Google's own reference client (`google/python-adb`) where the public docs are ambiguous, and covered by a mocked Vitest suite. The core connection/shell/stream-multiplexing path has real device usage behind it; the newer SYNC-protocol and service additions (`push
|
|
184
|
+
The implementation is built directly from the public ADB protocol documentation (AOSP `SYNC.TXT` and the wire-protocol references), cross-checked against Google's own reference client (`google/python-adb`) where the public docs are ambiguous, and covered by a mocked Vitest suite. The core connection/shell/stream-multiplexing path has real device usage behind it; the newer SYNC-protocol and service additions (`push` / `pull` / `listSync` / `reboot` / `forward` / `install`) have not yet been run against a real device - see the status note at the top of this README and [#1](https://github.com/CLDMV/droidsock/issues/1).
|
|
185
185
|
|
|
186
186
|
## License
|
|
187
187
|
|