@cldmv/droidsock 2.0.3 → 2.1.0

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 CHANGED
@@ -25,18 +25,18 @@ It talks to devices directly over TCP, with no `adb` binary or ADB server in bet
25
25
 
26
26
  ## ✨ What's New
27
27
 
28
- ### Latest: v2.0.3 (October 2026)
28
+ ### Latest: v2.1.0 (October 2026)
29
29
 
30
- - **Bundler-friendly CommonJS entry** - `index.cjs` now loads the ESM entry with a plain `require()` instead of `createRequire`, so esbuild and webpack can follow it, and on a Node.js version without `require(esm)` it fails with a clear message pointing to `import()`. The ESM entry and the API are unchanged ([#58](https://github.com/CLDMV/droidsock/pull/58)).
31
- - **`devcheck` no longer published** - the source-checkout-only `devcheck.mjs` and its `./devcheck` subpath export are gone from the package. It never did anything in an installed copy, but importing `@cldmv/droidsock/devcheck` now throws `ERR_PACKAGE_PATH_NOT_EXPORTED`, so remove any such import ([#58](https://github.com/CLDMV/droidsock/pull/58)).
32
- - [View full v2.0.3 Changelog](https://github.com/CLDMV/droidsock/blob/master/docs/changelog/v2/v2.0.3.md)
30
+ - **Device lifecycle events and opt-in auto-reconnect** - each device emits `connecting`, `connected`, `disconnected`, `reconnecting`, `reconnected`, `error` and `gave-up`, and `device.connect(host, port, { autoReconnect })` redials after an unexpected drop with exponential backoff and jitter. An explicit `disconnect()` or `remove()` never triggers it, and a device that rejects authentication is not retried ([#75](https://github.com/CLDMV/droidsock/pull/75)).
31
+ - **Keepalive, heartbeat and a leak fix** - the `keepAlive` config now enables TCP keepalive, an optional `heartbeat` option probes the device with a trivial shell command to catch a hung `adbd`, and a failed handshake no longer leaves its socket open. `engines.node` rises to `>=22.15.0` to match `@cldmv/slothlet` 3.22 ([#74](https://github.com/CLDMV/droidsock/pull/74)).
32
+ - [View full v2.1.0 Changelog](https://github.com/CLDMV/droidsock/blob/master/docs/changelog/v2/v2.1.0.md)
33
33
 
34
34
  ### Recent Releases
35
35
 
36
+ - **v2.0.3** (October 2026) - `index.cjs` loads the ESM entry with a plain `require()` and fails clearly without `require(esm)`; `@cldmv/droidsock/devcheck` is no longer exported or published ([Changelog](https://github.com/CLDMV/droidsock/blob/master/docs/changelog/v2/v2.0.3.md))
36
37
  - **v2.0.2** (October 2026) - Dev tooling only: shared CLDMV fix-headers config and a required PR check that never reports as skipped, no runtime change ([Changelog](https://github.com/CLDMV/droidsock/blob/master/docs/changelog/v2/v2.0.2.md))
37
38
  - **v2.0.1** (October 2026) - No runtime change, but `engines.node` rose to `>=22.12.0` (from `>=20.19.0`) to match the vitest 5 toolchain; also syncs the v4 workflows with the v4.29.2 templates ([Changelog](https://github.com/CLDMV/droidsock/blob/master/docs/changelog/v2/v2.0.1.md))
38
39
  - **v2.0.0** (September 2026) - Breaking: the `device` module splits into `device` and `devices`, device leaves persist across a disconnect, plus IPv6, `devices.get()`, and experimental `device.reverse()`, Wi-Fi pairing, streaming install and SYNC V2 ([Changelog](https://github.com/CLDMV/droidsock/blob/master/docs/changelog/v2/v2.0.0.md))
39
- - **v1.2.0** (September 2026) - Device discovery (`discover.subnet()` CIDR sweep, `discover.mdns()` for wireless-debugging-advertised devices, both experimental) and a shell-injection fix across every `files.*` shell-based method ([Changelog](https://github.com/CLDMV/droidsock/blob/master/docs/changelog/v1/v1.2.0.md))
40
40
 
41
41
  📚 **For complete version history and detailed release notes, see the [docs/changelog/](https://github.com/CLDMV/droidsock/tree/master/docs/changelog/) folder.**
42
42
 
@@ -62,8 +62,8 @@ It talks to devices directly over TCP, with no `adb` binary or ADB server in bet
62
62
 
63
63
  ### Requirements
64
64
 
65
- - **Node.js v22.12.0 or higher** (the package's `engines.node` floor)
66
- - Both `import` and `require()` are supported. `require()` loads the ESM entry through Node's synchronous `require(esm)`, which needs Node.js ^20.19.0 or >=22.12.0; on older versions, load the package with `import()` instead.
65
+ - **Node.js v22.15.0 or higher** (the package's `engines.node` floor)
66
+ - Both `import` and `require()` are supported. `require()` loads the ESM entry through Node's synchronous `require(esm)`, which every supported Node.js version (22.15+) provides; on older versions, load the package with `import()` instead.
67
67
 
68
68
  ### Install
69
69
 
@@ -14,4 +14,4 @@
14
14
  limitations under the License.
15
15
  */
16
16
 
17
- import{self}from"@cldmv/slothlet/runtime";import net from"node:net";const ADB_PROTOCOL_VERSION=16777216;const ADB_MAX_PAYLOAD=4096;const MSG_CNXN=1314410051;const MSG_AUTH=1213486401;const MSG_OKAY=1497451343;const SUPPORTED_FEATURES=["shell_v2","cmd","stat_v2","ls_v2","sendrecv_v2","sendrecv_v2_brotli"];async function create(options){const{host,port,privateKey,adbPublicKey}=options;const socket=new net.Socket;const connection={socket,host,port,authorized:false,connected:false,onUnhandledPacket:null,disconnect:()=>{if(socket&&!socket.destroyed){self.log.debug(`Disconnecting from ${host}:${port}`);socket.destroy()}connection.connected=false;connection.authorized=false}};return new Promise((resolve,reject)=>{const timeout=setTimeout(()=>{socket.destroy();reject(new Error("Connection timeout"))},1e4);socket.connect(port,host,async()=>{try{self.log.debug(`Connected to ${host}:${port}, sending CNXN message...`);const systemIdentity=`device::features=${SUPPORTED_FEATURES.join(",")}`;const cnxnPayload=Buffer.from(systemIdentity);await sendMessage(socket,MSG_CNXN,ADB_PROTOCOL_VERSION,ADB_MAX_PAYLOAD,cnxnPayload);self.log.debug(`${self.config.get("debugArrowSent")} CNXN message sent, waiting for AUTH response...`);const authMessage=await receiveMessage(socket);self.log.debug(`${self.config.get("debugArrowReceived")} Received AUTH message, command:`,authMessage.command.toString(16));if(authMessage.command!==MSG_AUTH){throw new Error(`Expected AUTH message (0x${MSG_AUTH.toString(16)}), got 0x${authMessage.command.toString(16)}`)}self.log.debug(`${self.config.get("debugArrowReceived")} AUTH message received, token length:`,authMessage.data.length);const token=authMessage.data;const signature=await self.auth.sign(token,privateKey);await sendMessage(socket,MSG_AUTH,2,0,signature);const pubKeyBuffer=Buffer.from(adbPublicKey);await sendMessage(socket,MSG_AUTH,3,0,pubKeyBuffer);const okayMessage=await receiveMessage(socket);self.log.debug(`${self.config.get("debugArrowReceived")} After auth, received command:`,okayMessage.command.toString(16));self.log.debug("Expected CNXN:",MSG_CNXN.toString(16),"or OKAY:",MSG_OKAY.toString(16));if(okayMessage.command===MSG_CNXN){const cnxnPayload2=okayMessage.data.toString().replace(/\0/g,"");self.log.debug(`${self.config.get("debugArrowReceived")} Device sent CNXN response - authentication successful!`);self.log.debug(`${self.config.get("debugArrowReceived")} CNXN payload:`,cnxnPayload2);const featuresMatch=cnxnPayload2.match(/features=([^;]+)/);connection.deviceFeatures=featuresMatch?featuresMatch[1].split(","):[];connection.authorized=true;connection.connected=true;self.log.debug("Authentication successful!")}else if(okayMessage.command===MSG_OKAY){self.log.debug(`${self.config.get("debugArrowReceived")} Device sent OKAY response - authentication successful!`);connection.authorized=true;connection.connected=true}else{throw new Error(`Authentication failed - expected CNXN (${MSG_CNXN.toString(16)}) or OKAY (${MSG_OKAY.toString(16)}), got ${okayMessage.command.toString(16)}`)}clearTimeout(timeout);socket.on("data",data=>{if(connection.onUnhandledPacket){connection.onUnhandledPacket(data)}});resolve(connection)}catch(error){clearTimeout(timeout);self.log.debug("Connection error:",error.message);reject(error)}});socket.on("error",error=>{clearTimeout(timeout);self.log.debug("Socket error:",error.message);reject(error)})})}async function sendMessage(socket,command,arg0,arg1,data=Buffer.alloc(0)){const header=Buffer.alloc(24);let offset=0;header.writeUInt32LE(command,offset);offset+=4;header.writeUInt32LE(arg0,offset);offset+=4;header.writeUInt32LE(arg1,offset);offset+=4;header.writeUInt32LE(data.length,offset);offset+=4;header.writeUInt32LE(checksum(data),offset);offset+=4;header.writeUInt32LE((command^4294967295)>>>0,offset);socket.write(header);if(data.length>0){socket.write(data)}}function receiveMessage(socket){return new Promise((resolve,reject)=>{let headerReceived=false;let expectedDataLength=0;let receivedHeader=null;let receivedData=Buffer.alloc(0);const onData=chunk=>{if(!headerReceived){if(chunk.length>=24){receivedHeader=chunk.slice(0,24);self.log.debug("Header bytes:",Array.from(receivedHeader).map(b=>b.toString(16).padStart(2,"0")).join(" "));try{expectedDataLength=receivedHeader.readUInt32LE(12);self.log.debug("Raw data length from header:",expectedDataLength)}catch(readError){reject(new Error(`Failed to read data length from header: ${readError.message}`));return}if(isNaN(expectedDataLength)||expectedDataLength<0||expectedDataLength>1024*1024){reject(new Error(`Invalid data length: ${expectedDataLength} (header: ${receivedHeader.toString("hex")})`));return}headerReceived=true;if(chunk.length>24){receivedData=Buffer.concat([receivedData,chunk.slice(24)])}}}else{receivedData=Buffer.concat([receivedData,chunk])}if(headerReceived&&receivedData.length>=expectedDataLength){socket.removeListener("data",onData);try{const command=receivedHeader.readUInt32LE(0);const arg0=receivedHeader.readUInt32LE(4);const arg1=receivedHeader.readUInt32LE(8);const dataLength=receivedHeader.readUInt32LE(12);const headerChecksum=receivedHeader.readUInt32LE(16);const magic=receivedHeader.readUInt32LE(20);self.log.debug("Parsed header - command:",command.toString(16),"arg0:",arg0,"arg1:",arg1,"length:",dataLength,"checksum:",headerChecksum,"magic:",magic.toString(16));const expectedMagic=(command^4294967295)>>>0;if(magic!==expectedMagic){self.log.debug("Magic mismatch - expected:",expectedMagic.toString(16),"got:",magic.toString(16))}const data=receivedData.slice(0,expectedDataLength);if(data.length>0){const calculatedChecksum=checksum(data);self.log.debug("Data checksum - expected:",headerChecksum,"calculated:",calculatedChecksum)}resolve({command,arg0,arg1,data})}catch(parseError){reject(new Error(`Failed to parse message header: ${parseError.message}`))}}};socket.on("data",onData);socket.on("error",reject)})}function checksum(data){let sum=0;for(let i=0;i<data.length;i++){sum=sum+data[i]>>>0}return sum}export{create};
17
+ import{self}from"@cldmv/slothlet/runtime";import net from"node:net";const ADB_PROTOCOL_VERSION=16777216;const ADB_MAX_PAYLOAD=4096;const MSG_CNXN=1314410051;const MSG_AUTH=1213486401;const MSG_OKAY=1497451343;const SUPPORTED_FEATURES=["shell_v2","cmd","stat_v2","ls_v2","sendrecv_v2","sendrecv_v2_brotli"];async function create(options){const{host,port,privateKey,adbPublicKey}=options;const socket=new net.Socket;const connection={socket,host,port,authorized:false,connected:false,onUnhandledPacket:null,disconnect:()=>{if(socket&&!socket.destroyed){self.log.debug(`Disconnecting from ${host}:${port}`);socket.destroy()}connection.connected=false;connection.authorized=false}};return new Promise((resolve,reject)=>{const timeout=setTimeout(()=>{socket.destroy();reject(new Error("Connection timeout"))},1e4);socket.connect(port,host,async()=>{try{self.log.debug(`Connected to ${host}:${port}, sending CNXN message...`);const systemIdentity=`device::features=${SUPPORTED_FEATURES.join(",")}`;const cnxnPayload=Buffer.from(systemIdentity);await sendMessage(socket,MSG_CNXN,ADB_PROTOCOL_VERSION,ADB_MAX_PAYLOAD,cnxnPayload);self.log.debug(`${self.config.get("debugArrowSent")} CNXN message sent, waiting for AUTH response...`);const authMessage=await receiveMessage(socket);self.log.debug(`${self.config.get("debugArrowReceived")} Received AUTH message, command:`,authMessage.command.toString(16));if(authMessage.command!==MSG_AUTH){throw new Error(`Expected AUTH message (0x${MSG_AUTH.toString(16)}), got 0x${authMessage.command.toString(16)}`)}self.log.debug(`${self.config.get("debugArrowReceived")} AUTH message received, token length:`,authMessage.data.length);const token=authMessage.data;const signature=await self.auth.sign(token,privateKey);await sendMessage(socket,MSG_AUTH,2,0,signature);const pubKeyBuffer=Buffer.from(adbPublicKey);await sendMessage(socket,MSG_AUTH,3,0,pubKeyBuffer);const okayMessage=await receiveMessage(socket);self.log.debug(`${self.config.get("debugArrowReceived")} After auth, received command:`,okayMessage.command.toString(16));self.log.debug("Expected CNXN:",MSG_CNXN.toString(16),"or OKAY:",MSG_OKAY.toString(16));if(okayMessage.command===MSG_CNXN){const cnxnPayload2=okayMessage.data.toString().replace(/\0/g,"");self.log.debug(`${self.config.get("debugArrowReceived")} Device sent CNXN response - authentication successful!`);self.log.debug(`${self.config.get("debugArrowReceived")} CNXN payload:`,cnxnPayload2);const featuresMatch=cnxnPayload2.match(/features=([^;]+)/);connection.deviceFeatures=featuresMatch?featuresMatch[1].split(","):[];connection.authorized=true;connection.connected=true;self.log.debug("Authentication successful!")}else if(okayMessage.command===MSG_OKAY){self.log.debug(`${self.config.get("debugArrowReceived")} Device sent OKAY response - authentication successful!`);connection.authorized=true;connection.connected=true}else{throw new Error(`Authentication failed - expected CNXN (${MSG_CNXN.toString(16)}) or OKAY (${MSG_OKAY.toString(16)}), got ${okayMessage.command.toString(16)}`)}clearTimeout(timeout);socket.on("data",data=>{if(connection.onUnhandledPacket){connection.onUnhandledPacket(data)}});resolve(connection)}catch(error){clearTimeout(timeout);self.log.debug("Connection error:",error.message);socket.destroy();reject(error)}});socket.on("error",error=>{clearTimeout(timeout);self.log.debug("Socket error:",error.message);reject(error)})})}async function sendMessage(socket,command,arg0,arg1,data=Buffer.alloc(0)){const header=Buffer.alloc(24);let offset=0;header.writeUInt32LE(command,offset);offset+=4;header.writeUInt32LE(arg0,offset);offset+=4;header.writeUInt32LE(arg1,offset);offset+=4;header.writeUInt32LE(data.length,offset);offset+=4;header.writeUInt32LE(checksum(data),offset);offset+=4;header.writeUInt32LE((command^4294967295)>>>0,offset);socket.write(header);if(data.length>0){socket.write(data)}}function receiveMessage(socket){return new Promise((resolve,reject)=>{let headerReceived=false;let expectedDataLength=0;let receivedHeader=null;let receivedData=Buffer.alloc(0);const onData=chunk=>{if(!headerReceived){if(chunk.length>=24){receivedHeader=chunk.slice(0,24);self.log.debug("Header bytes:",Array.from(receivedHeader).map(b=>b.toString(16).padStart(2,"0")).join(" "));try{expectedDataLength=receivedHeader.readUInt32LE(12);self.log.debug("Raw data length from header:",expectedDataLength)}catch(readError){reject(new Error(`Failed to read data length from header: ${readError.message}`));return}if(isNaN(expectedDataLength)||expectedDataLength<0||expectedDataLength>1024*1024){reject(new Error(`Invalid data length: ${expectedDataLength} (header: ${receivedHeader.toString("hex")})`));return}headerReceived=true;if(chunk.length>24){receivedData=Buffer.concat([receivedData,chunk.slice(24)])}}}else{receivedData=Buffer.concat([receivedData,chunk])}if(headerReceived&&receivedData.length>=expectedDataLength){socket.removeListener("data",onData);try{const command=receivedHeader.readUInt32LE(0);const arg0=receivedHeader.readUInt32LE(4);const arg1=receivedHeader.readUInt32LE(8);const dataLength=receivedHeader.readUInt32LE(12);const headerChecksum=receivedHeader.readUInt32LE(16);const magic=receivedHeader.readUInt32LE(20);self.log.debug("Parsed header - command:",command.toString(16),"arg0:",arg0,"arg1:",arg1,"length:",dataLength,"checksum:",headerChecksum,"magic:",magic.toString(16));const expectedMagic=(command^4294967295)>>>0;if(magic!==expectedMagic){self.log.debug("Magic mismatch - expected:",expectedMagic.toString(16),"got:",magic.toString(16))}const data=receivedData.slice(0,expectedDataLength);if(data.length>0){const calculatedChecksum=checksum(data);self.log.debug("Data checksum - expected:",headerChecksum,"calculated:",calculatedChecksum)}resolve({command,arg0,arg1,data})}catch(parseError){reject(new Error(`Failed to parse message header: ${parseError.message}`))}}};socket.on("data",onData);socket.on("error",reject)})}function checksum(data){let sum=0;for(let i=0;i<data.length;i++){sum=sum+data[i]>>>0}return sum}export{create};
@@ -14,4 +14,4 @@
14
14
  limitations under the License.
15
15
  */
16
16
 
17
- import{self}from"@cldmv/slothlet/runtime";import{quoteShellArg,sanitizeKey}from"./utils.mjs";async function openSession(host,port,options){const keys=await self.auth.getKeys(options.keyDir);const connection=await self.connection.create({host,port,publicKey:keys.publicKey,privateKey:keys.privateKey,adbPublicKey:keys.adbPublicKey});const streamManager=await self.stream.create(connection.socket);connection.onUnhandledPacket=packet=>streamManager.handlePacket(packet);return{connection,streamManager}}function buildDeviceLeaf(host,port,deviceId,deviceKey,options){const session={connection:null,streamManager:null};function assertReady(){if(!leaf.isConnected()){throw new Error("Device not connected")}if(!session.connection.authorized){throw new Error("Device not authorized. Please accept authorization dialog.")}}const leaf={host,port,deviceId,options,connection:null,streamManager:null,isConnected:()=>Boolean(session.connection&&session.connection.connected&&session.connection.socket&&!session.connection.socket.destroyed),disconnect:()=>{if(session.connection)session.connection.disconnect()},reconnect:async(reconnectOptions={})=>{leaf.options={...leaf.options,...reconnectOptions};if(leaf.isConnected())return self.devices[deviceKey];const{connection,streamManager}=await openSession(host,port,leaf.options);session.connection=connection;session.streamManager=streamManager;self.devices[deviceKey].connection=connection;self.devices[deviceKey].streamManager=streamManager;return self.devices[deviceKey]},remove:async()=>{leaf.disconnect();await self.slothlet.api.remove(`devices.${deviceKey}`).catch(()=>{})},shell:async(command,shellOptions={})=>{assertReady();return await self.shell.execute(session.connection.socket,session.streamManager,command,{...shellOptions,deviceFeatures:session.connection.deviceFeatures||[]})},startStreamingShell:(command,shellOptions={})=>{assertReady();return self.shell.startStreaming(session.connection.socket,session.streamManager,command,shellOptions)},startInteractiveShell:(command,shellOptions={})=>{assertReady();return self.shell.startInteractive(session.connection.socket,session.streamManager,command,shellOptions)},push:async(localPath,remotePath,transferOptions={})=>{assertReady();return await self.files.push(session.connection.socket,session.streamManager,localPath,remotePath,transferOptions)},pull:async(remotePath,localPath,transferOptions={})=>{assertReady();return await self.files.pull(session.connection.socket,session.streamManager,remotePath,localPath,transferOptions)},pushV2:async(localPath,remotePath,transferOptions={})=>{assertReady();return await self.files.pushV2(session.connection.socket,session.streamManager,localPath,remotePath,transferOptions)},pullV2:async(remotePath,localPath,transferOptions={})=>{assertReady();return await self.files.pullV2(session.connection.socket,session.streamManager,remotePath,localPath,transferOptions)},list:async remotePath=>{assertReady();return await self.files.list(session.connection.socket,session.streamManager,remotePath)},stat:async remotePath=>{assertReady();return await self.files.stat(session.connection.socket,session.streamManager,remotePath)},listV2:async remotePath=>{assertReady();return await self.files.listV2(session.connection.socket,session.streamManager,remotePath)},statV2:async remotePath=>{assertReady();return await self.files.statV2(session.connection.socket,session.streamManager,remotePath)},reboot:async(mode="")=>{assertReady();return await self.reboot.execute(session.connection.socket,session.streamManager,mode)},forward:async(devicePort,forwardOptions={})=>{assertReady();return await self.forward.start(session.connection.socket,session.streamManager,devicePort,forwardOptions)},reverse:async(devicePort,hostPort,reverseOptions={})=>{assertReady();return await self.reverse.start(session.connection.socket,session.streamManager,devicePort,hostPort,reverseOptions)},install:async(localPath,installOptions={})=>{assertReady();if((session.connection.deviceFeatures||[]).includes("cmd")){try{return await self.install.streaming(session.connection.socket,session.streamManager,localPath,installOptions)}catch(streamingError){try{return await self.install.classic(session.connection.socket,session.streamManager,localPath,installOptions)}catch(classicError){throw new Error(`Streaming install failed (${streamingError.message}), and the classic fallback also failed: ${classicError.message}`,{cause:classicError})}}}return await self.install.classic(session.connection.socket,session.streamManager,localPath,installOptions)},ls:(path=".")=>leaf.shell(`ls -la ${quoteShellArg(path)}`),pwd:()=>leaf.shell("pwd"),getprop:(prop=null)=>leaf.shell(prop?`getprop ${quoteShellArg(prop)}`:"getprop"),getModel:()=>leaf.shell("getprop ro.product.model"),getAndroidVersion:()=>leaf.shell("getprop ro.build.version.release"),getBattery:()=>leaf.shell("dumpsys battery"),screenshot:(filename="/sdcard/screenshot.png")=>leaf.shell(`screencap -p ${quoteShellArg(filename)}`),logcat:(logOptions={})=>leaf.startStreamingShell("logcat",logOptions),top:(topOptions={})=>leaf.startStreamingShell("top -m 10",topOptions),keypress:key=>leaf.shell(`input keyevent ${quoteShellArg(key)}`),launchApp:(packageName,activity="")=>{const target=activity?`${packageName}/${activity}`:packageName;return leaf.shell(`am start -n ${quoteShellArg(target)}`)},rebootBootloader:()=>leaf.reboot("bootloader"),rebootRecovery:()=>leaf.reboot("recovery"),rebootSideload:()=>leaf.reboot("sideload")};return leaf}async function connect(host,port=5555,options={}){const deviceId=`${host}:${port}`;const deviceKey=sanitizeKey(deviceId);const existing=self.devices&&self.devices[deviceKey];if(existing){return await existing.reconnect(options)}const leaf=buildDeviceLeaf(host,port,deviceId,deviceKey,options);await self.slothlet.api.add(`devices.${deviceKey}`,leaf,{moduleID:`device:${deviceId}`});await self.devices[deviceKey].reconnect(options);return self.devices[deviceKey]}function disconnect(host,port=5555){const deviceKey=sanitizeKey(`${host}:${port}`);const entry=self.devices&&self.devices[deviceKey];if(!entry){return false}entry.disconnect();return true}async function remove(host,port=5555){const deviceKey=sanitizeKey(`${host}:${port}`);const entry=self.devices&&self.devices[deviceKey];if(!entry){return false}await entry.remove();return true}export{connect,disconnect,remove};
17
+ import{EventEmitter}from"node:events";import{self}from"@cldmv/slothlet/runtime";import{quoteShellArg,sanitizeKey}from"./utils.mjs";const DEFAULT_RECONNECT_POLICY={maxAttempts:Infinity,maxDelay:3e4,factor:2,jitter:.2};function resolveReconnectPolicy(autoReconnect){if(!autoReconnect)return null;const custom=typeof autoReconnect==="object"?autoReconnect:{};return{...DEFAULT_RECONNECT_POLICY,initialDelay:self.config.get("retryDelay",1e3),...custom}}function backoffDelay(policy,attempt){const base=Math.min(policy.maxDelay,policy.initialDelay*policy.factor**(attempt-1));const spread=base*policy.jitter;return Math.max(0,Math.round(base-spread+Math.random()*spread*2))}function resolveHeartbeatPolicy(heartbeat){if(!heartbeat)return null;return{interval:15e3,timeout:5e3,...typeof heartbeat==="object"?heartbeat:{}}}function isFatalConnectError(error){return/^Authentication failed/.test(error?.message||"")}async function openSession(host,port,options){const keys=await self.auth.getKeys(options.keyDir);const connection=await self.connection.create({host,port,publicKey:keys.publicKey,privateKey:keys.privateKey,adbPublicKey:keys.adbPublicKey});const streamManager=await self.stream.create(connection.socket);connection.onUnhandledPacket=packet=>streamManager.handlePacket(packet);return{connection,streamManager}}function buildDeviceLeaf(host,port,deviceId,deviceKey,options){const session={connection:null,streamManager:null};const emitter=new EventEmitter;const closedByUs=new WeakSet;const closeReasons=new WeakMap;let reconnectTimer=null;let heartbeatTimer=null;let inflight=null;function emit(event,detail={}){if(!self.config.get("emitEvents",true))return;if(event==="error"&&emitter.listenerCount("error")===0)return;try{emitter.emit(event,{deviceId,host,port,...detail})}catch(listenerError){self.log.error(`Listener for "${event}" on ${deviceId} threw:`,listenerError)}}function stopHeartbeat(){if(heartbeatTimer)clearInterval(heartbeatTimer);heartbeatTimer=null}function startHeartbeat(connection){stopHeartbeat();const policy=resolveHeartbeatPolicy(leaf.options.heartbeat);if(!policy)return;let probing=false;heartbeatTimer=setInterval(async()=>{if(probing||session.connection!==connection||!leaf.isConnected())return;probing=true;try{await self.shell.execute(connection.socket,session.streamManager,"echo",{timeout:policy.timeout,deviceFeatures:connection.deviceFeatures||[]})}catch(error){if(session.connection===connection){closeReasons.set(connection,"heartbeat");emit("error",{error});connection.disconnect()}}finally{probing=false}},policy.interval)}function cancelReconnect(){if(reconnectTimer)clearTimeout(reconnectTimer);reconnectTimer=null}function establish(phase="connect"){if(inflight)return inflight;inflight=(async()=>{emit("connecting",{phase});const{connection,streamManager}=await openSession(host,port,leaf.options);session.connection=connection;session.streamManager=streamManager;self.devices[deviceKey].connection=connection;self.devices[deviceKey].streamManager=streamManager;watchConnection(connection);startHeartbeat(connection);emit("connected",{phase})})().finally(()=>{inflight=null});return inflight}function watchConnection(connection){const socket=connection.socket;if(self.config.get("keepAlive",true))socket.setKeepAlive(true,self.config.get("keepAliveInterval",3e4));socket.once("close",hadError=>{if(session.connection!==connection)return;connection.connected=false;stopHeartbeat();const intentional=closedByUs.has(connection);emit("disconnected",{intentional,hadError,reason:closeReasons.get(connection)??(intentional?"requested":"closed")});if(!intentional)scheduleReconnect(1)})}function scheduleReconnect(attempt,lastError){const policy=resolveReconnectPolicy(leaf.options.autoReconnect);if(!policy)return;if(attempt>policy.maxAttempts){emit("gave-up",{reason:"max-attempts",attempts:attempt-1,error:lastError});return}const delay=backoffDelay(policy,attempt);emit("reconnecting",{attempt,delay,error:lastError});reconnectTimer=setTimeout(async()=>{reconnectTimer=null;try{await establish("reconnect");emit("reconnected",{attempt})}catch(error){emit("error",{error,attempt});if(isFatalConnectError(error))emit("gave-up",{reason:"auth",attempts:attempt,error});else scheduleReconnect(attempt+1,error)}},delay)}function assertReady(){if(!leaf.isConnected()){throw new Error("Device not connected")}if(!session.connection.authorized){throw new Error("Device not authorized. Please accept authorization dialog.")}}const leaf={host,port,deviceId,options,connection:null,streamManager:null,isConnected:()=>Boolean(session.connection&&session.connection.connected&&session.connection.socket&&!session.connection.socket.destroyed),disconnect:()=>{cancelReconnect();if(session.connection){closedByUs.add(session.connection);session.connection.disconnect()}},on:(event,listener)=>{emitter.on(event,listener);return self.devices[deviceKey]},once:(event,listener)=>{emitter.once(event,listener);return self.devices[deviceKey]},off:(event,listener)=>{emitter.off(event,listener);return self.devices[deviceKey]},reconnect:async(reconnectOptions={})=>{leaf.options={...leaf.options,...reconnectOptions};if(leaf.isConnected())return self.devices[deviceKey];cancelReconnect();await establish();return self.devices[deviceKey]},remove:async()=>{leaf.disconnect();await self.slothlet.api.remove(`devices.${deviceKey}`).catch(()=>{})},shell:async(command,shellOptions={})=>{assertReady();return await self.shell.execute(session.connection.socket,session.streamManager,command,{...shellOptions,deviceFeatures:session.connection.deviceFeatures||[]})},startStreamingShell:(command,shellOptions={})=>{assertReady();return self.shell.startStreaming(session.connection.socket,session.streamManager,command,shellOptions)},startInteractiveShell:(command,shellOptions={})=>{assertReady();return self.shell.startInteractive(session.connection.socket,session.streamManager,command,shellOptions)},push:async(localPath,remotePath,transferOptions={})=>{assertReady();return await self.files.push(session.connection.socket,session.streamManager,localPath,remotePath,transferOptions)},pull:async(remotePath,localPath,transferOptions={})=>{assertReady();return await self.files.pull(session.connection.socket,session.streamManager,remotePath,localPath,transferOptions)},pushV2:async(localPath,remotePath,transferOptions={})=>{assertReady();return await self.files.pushV2(session.connection.socket,session.streamManager,localPath,remotePath,transferOptions)},pullV2:async(remotePath,localPath,transferOptions={})=>{assertReady();return await self.files.pullV2(session.connection.socket,session.streamManager,remotePath,localPath,transferOptions)},list:async remotePath=>{assertReady();return await self.files.list(session.connection.socket,session.streamManager,remotePath)},stat:async remotePath=>{assertReady();return await self.files.stat(session.connection.socket,session.streamManager,remotePath)},listV2:async remotePath=>{assertReady();return await self.files.listV2(session.connection.socket,session.streamManager,remotePath)},statV2:async remotePath=>{assertReady();return await self.files.statV2(session.connection.socket,session.streamManager,remotePath)},reboot:async(mode="")=>{assertReady();return await self.reboot.execute(session.connection.socket,session.streamManager,mode)},forward:async(devicePort,forwardOptions={})=>{assertReady();return await self.forward.start(session.connection.socket,session.streamManager,devicePort,forwardOptions)},reverse:async(devicePort,hostPort,reverseOptions={})=>{assertReady();return await self.reverse.start(session.connection.socket,session.streamManager,devicePort,hostPort,reverseOptions)},install:async(localPath,installOptions={})=>{assertReady();if((session.connection.deviceFeatures||[]).includes("cmd")){try{return await self.install.streaming(session.connection.socket,session.streamManager,localPath,installOptions)}catch(streamingError){try{return await self.install.classic(session.connection.socket,session.streamManager,localPath,installOptions)}catch(classicError){throw new Error(`Streaming install failed (${streamingError.message}), and the classic fallback also failed: ${classicError.message}`,{cause:classicError})}}}return await self.install.classic(session.connection.socket,session.streamManager,localPath,installOptions)},ls:(path=".")=>leaf.shell(`ls -la ${quoteShellArg(path)}`),pwd:()=>leaf.shell("pwd"),getprop:(prop=null)=>leaf.shell(prop?`getprop ${quoteShellArg(prop)}`:"getprop"),getModel:()=>leaf.shell("getprop ro.product.model"),getAndroidVersion:()=>leaf.shell("getprop ro.build.version.release"),getBattery:()=>leaf.shell("dumpsys battery"),screenshot:(filename="/sdcard/screenshot.png")=>leaf.shell(`screencap -p ${quoteShellArg(filename)}`),logcat:(logOptions={})=>leaf.startStreamingShell("logcat",logOptions),top:(topOptions={})=>leaf.startStreamingShell("top -m 10",topOptions),keypress:key=>leaf.shell(`input keyevent ${quoteShellArg(key)}`),launchApp:(packageName,activity="")=>{const target=activity?`${packageName}/${activity}`:packageName;return leaf.shell(`am start -n ${quoteShellArg(target)}`)},rebootBootloader:()=>leaf.reboot("bootloader"),rebootRecovery:()=>leaf.reboot("recovery"),rebootSideload:()=>leaf.reboot("sideload")};return leaf}async function connect(host,port=5555,options={}){const deviceId=`${host}:${port}`;const deviceKey=sanitizeKey(deviceId);const existing=self.devices&&self.devices[deviceKey];if(existing){return await existing.reconnect(options)}const leaf=buildDeviceLeaf(host,port,deviceId,deviceKey,options);await self.slothlet.api.add(`devices.${deviceKey}`,leaf,{moduleID:`device:${deviceId}`});await self.devices[deviceKey].reconnect(options);return self.devices[deviceKey]}function disconnect(host,port=5555){const deviceKey=sanitizeKey(`${host}:${port}`);const entry=self.devices&&self.devices[deviceKey];if(!entry){return false}entry.disconnect();return true}async function remove(host,port=5555){const deviceKey=sanitizeKey(`${host}:${port}`);const entry=self.devices&&self.devices[deviceKey];if(!entry){return false}await entry.remove();return true}export{connect,disconnect,remove};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cldmv/droidsock",
3
- "version": "2.0.3",
3
+ "version": "2.1.0",
4
4
  "description": "Complete Node.js implementation of the Android Debug Bridge (ADB) protocol",
5
5
  "main": "./index.cjs",
6
6
  "module": "./index.mjs",
@@ -22,7 +22,7 @@
22
22
  },
23
23
  "type": "module",
24
24
  "engines": {
25
- "node": ">=22.12.0"
25
+ "node": ">=22.15.0"
26
26
  },
27
27
  "scripts": {
28
28
  "build": "node build.mjs",
@@ -1 +1 @@
1
- {"version":3,"file":"connection.d.mts","sourceRoot":"","sources":["../../../dist/api/connection.mjs"],"names":[],"mappings":"AAgBkT,mDAAwhG"}
1
+ {"version":3,"file":"connection.d.mts","sourceRoot":"","sources":["../../../dist/api/connection.mjs"],"names":[],"mappings":"AAgBkT,mDAAyiG"}
@@ -1 +1 @@
1
- {"version":3,"file":"device.d.mts","sourceRoot":"","sources":["../../../dist/api/device.mjs"],"names":[],"mappings":"AAgBu4K,8EAA8c;AAAA,8DAA4L;AAAA,mEAAgM"}
1
+ {"version":3,"file":"device.d.mts","sourceRoot":"","sources":["../../../dist/api/device.mjs"],"names":[],"mappings":"AAgB2iS,8EAA8c;AAAA,8DAA4L;AAAA,mEAAgM"}