appium-adb 14.1.2 → 14.1.3

package/lib/tools/{network-commands.js → network-commands.ts}

@@ -1,15 +1,16 @@
 import {EOL} from 'os';
 import _ from 'lodash';
 import {log} from '../logger.js';
+import type {ADB} from '../adb.js';
+import type {PortFamily, PortInfo} from './types.js';
 
 /**
  * Get TCP port forwarding with adb on the device under test.
  *
- * @this {import('../adb.js').ADB}
- * @return {Promise<string[]>} The output of the corresponding adb command.
+ * @return The output of the corresponding adb command.
  * An array contains each forwarding line of output
  */
-export async function getForwardList() {
+export async function getForwardList(this: ADB): Promise<string[]> {
   log.debug(`List forwarding ports`);
   const connections = await this.adbExec(['forward', '--list']);
   return connections.split(EOL).filter((line) => Boolean(line.trim()));
@@ -18,11 +19,14 @@ export async function getForwardList() {
 /**
  * Setup TCP port forwarding with adb on the device under test.
  *
- * @this {import('../adb.js').ADB}
- * @param {string|number} systemPort - The number of the local system port.
- * @param {string|number} devicePort - The number of the remote device port.
+ * @param systemPort - The number of the local system port.
+ * @param devicePort - The number of the remote device port.
  */
-export async function forwardPort(systemPort, devicePort) {
+export async function forwardPort(
+  this: ADB,
+  systemPort: string | number,
+  devicePort: string | number,
+): Promise<void> {
   log.debug(`Forwarding system: ${systemPort} to device: ${devicePort}`);
   await this.adbExec(['forward', `tcp:${systemPort}`, `tcp:${devicePort}`]);
 }
@@ -31,11 +35,10 @@ export async function forwardPort(systemPort, devicePort) {
  * Remove TCP port forwarding with adb on the device under test. The forwarding
  * for the given port should be setup with {@link #forwardPort} first.
  *
- * @this {import('../adb.js').ADB}
- * @param {string|number} systemPort - The number of the local system port
+ * @param systemPort - The number of the local system port
  *                                     to remove forwarding on.
  */
-export async function removePortForward(systemPort) {
+export async function removePortForward(this: ADB, systemPort: string | number): Promise<void> {
   log.debug(`Removing forwarded port socket connection: ${systemPort} `);
   await this.adbExec(['forward', `--remove`, `tcp:${systemPort}`]);
 }
@@ -43,11 +46,10 @@ export async function removePortForward(systemPort) {
 /**
  * Get TCP port forwarding with adb on the device under test.
  *
- * @this {import('../adb.js').ADB}
- * @return {Promise<string[]>} The output of the corresponding adb command.
+ * @return The output of the corresponding adb command.
  * An array contains each forwarding line of output
  */
-export async function getReverseList() {
+export async function getReverseList(this: ADB): Promise<string[]> {
   log.debug(`List reverse forwarding ports`);
   const connections = await this.adbExec(['reverse', '--list']);
   return connections.split(EOL).filter((line) => Boolean(line.trim()));
@@ -57,11 +59,14 @@ export async function getReverseList() {
  * Setup TCP port forwarding with adb on the device under test.
  * Only available for API 21+.
  *
- * @this {import('../adb.js').ADB}
- * @param {string|number} devicePort - The number of the remote device port.
- * @param {string|number} systemPort - The number of the local system port.
+ * @param devicePort - The number of the remote device port.
+ * @param systemPort - The number of the local system port.
  */
-export async function reversePort(devicePort, systemPort) {
+export async function reversePort(
+  this: ADB,
+  devicePort: string | number,
+  systemPort: string | number,
+): Promise<void> {
   log.debug(`Forwarding device: ${devicePort} to system: ${systemPort}`);
   await this.adbExec(['reverse', `tcp:${devicePort}`, `tcp:${systemPort}`]);
 }
@@ -70,11 +75,13 @@ export async function reversePort(devicePort, systemPort) {
  * Remove TCP port forwarding with adb on the device under test. The forwarding
  * for the given port should be setup with {@link #forwardPort} first.
  *
- * @this {import('../adb.js').ADB}
- * @param {string|number} devicePort - The number of the remote device port
+ * @param devicePort - The number of the remote device port
  *                                     to remove forwarding on.
  */
-export async function removePortReverse(devicePort) {
+export async function removePortReverse(
+  this: ADB,
+  devicePort: string | number,
+): Promise<void> {
   log.debug(`Removing reverse forwarded port socket connection: ${devicePort} `);
   await this.adbExec(['reverse', `--remove`, `tcp:${devicePort}`]);
 }
@@ -84,11 +91,14 @@ export async function removePortReverse(devicePort) {
  * between {@link #forwardPort} is that this method does setup for an abstract
  * local port.
  *
- * @this {import('../adb.js').ADB}
- * @param {string|number} systemPort - The number of the local system port.
- * @param {string|number} devicePort - The number of the remote device port.
+ * @param systemPort - The number of the local system port.
+ * @param devicePort - The number of the remote device port.
  */
-export async function forwardAbstractPort(systemPort, devicePort) {
+export async function forwardAbstractPort(
+  this: ADB,
+  systemPort: string | number,
+  devicePort: string | number,
+): Promise<void> {
   log.debug(`Forwarding system: ${systemPort} to abstract device: ${devicePort}`);
   await this.adbExec(['forward', `tcp:${systemPort}`, `localabstract:${devicePort}`]);
 }
@@ -96,13 +106,12 @@ export async function forwardAbstractPort(systemPort, devicePort) {
 /**
  * Execute ping shell command on the device under test.
  *
- * @this {import('../adb.js').ADB}
- * @return {Promise<boolean>} True if the command output contains 'ping' substring.
+ * @return True if the command output contains 'ping' substring.
  * @throws {Error} If there was an error while executing 'ping' command on the
  *                 device under test.
  */
-export async function ping() {
-  let stdout = await this.shell(['echo', 'ping']);
+export async function ping(this: ADB): Promise<boolean> {
+  const stdout = await this.shell(['echo', 'ping']);
   if (stdout.indexOf('ping') === 0) {
     return true;
   }
@@ -113,11 +122,10 @@ export async function ping() {
  * Returns the list of TCP port states of the given family.
  * Could be empty if no ports are opened.
  *
- * @this {import('../adb.js').ADB}
- * @param {import('./types').PortFamily} [family='4']
- * @returns {Promise<import('./types').PortInfo[]>}
+ * @param family - Port family ('4' for IPv4, '6' for IPv6)
+ * @returns Array of port information
  */
-export async function listPorts(family = '4') {
+export async function listPorts(this: ADB, family: PortFamily = '4'): Promise<PortInfo[]> {
   const sourceProcName = `/proc/net/tcp${family === '6' ? '6' : ''}`;
   const output = await this.shell(['cat', sourceProcName]);
   const lines = output.split('\n');
@@ -133,8 +141,7 @@ export async function listPorts(family = '4') {
     log.debug(lines[0]);
     throw new Error(`Cannot parse the header row of ${sourceProcName} payload`);
   }
-  /** @type {import('./types').PortInfo[]} */
-  const result = [];
+  const result: PortInfo[] = [];
   // 2: 1002000A:D036 24CE3AD8:01BB 08 00000000:00000000 00:00000000 00000000 10132 0 49104 1 0000000000000000 21 4 20 10 -1
   for (const line of lines.slice(1)) {
     const values = line.split(/\s+/).filter(Boolean);
@@ -151,3 +158,4 @@ export async function listPorts(family = '4') {
   }
   return result;
 }
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-adb",
-  "version": "14.1.2",
+  "version": "14.1.3",
   "description": "Android Debug Bridge interface",
   "main": "./build/index.js",
   "scripts": {