@irdk/usbmux 0.2.0 → 0.2.2

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Sterling DeMille <sterlingdemille@gmail.com>
+Copyright (c) 2015-2025 Sterling DeMille <sterlingdemille@gmail.com>, Maksim Alzhanov <me@alzhanov.ru>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -17,4 +17,4 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -52,7 +52,7 @@ irelay --help
 ## Module Usage
 
 ```javascript
-var usbmux = require('usbmux');
+import * as usbmux from 'usbmux';
 
 // usbmux.Relay()
 // usbmux.createListener()
@@ -278,7 +278,7 @@ The `Number` field indicates status. 0 is success, other numbers indicate an err
 
 The MIT License (MIT)
 
-Copyright (c) 2015 Sterling DeMille <sterlingdemille@gmail.com>
+Copyright (c) 2015-2025 Sterling DeMille <sterlingdemille@gmail.com>, Maksim Alzhanov <me@alzhanov.ru>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -295,4 +295,4 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/usbmux.cjs

@@ -0,0 +1,317 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// lib/usbmux.ts
+var usbmux_exports = {};
+__export(usbmux_exports, {
+  Relay: () => Relay,
+  UsbmuxdError: () => UsbmuxdError,
+  address: () => address,
+  connect: () => connect,
+  createListener: () => createListener,
+  devices: () => devices,
+  findDevice: () => findDevice,
+  getTunnel: () => getTunnel,
+  protocol: () => protocol
+});
+module.exports = __toCommonJS(usbmux_exports);
+var import_node_net = __toESM(require("net"), 1);
+var import_events = require("events");
+var import_plist = __toESM(require("plist"), 1);
+var import_debug = __toESM(require("debug"), 1);
+var debug = {
+  relay: (0, import_debug.default)("usbmux:relay"),
+  listen: (0, import_debug.default)("usbmux:listen"),
+  connect: (0, import_debug.default)("usbmux:connect")
+};
+var devices = {};
+var address = process.platform === "win32" ? { port: 27015, family: 4 } : { path: "/var/run/usbmuxd" };
+var protocol = function() {
+  function pack(payload_obj) {
+    const payload_plist = import_plist.default.build(payload_obj);
+    const payload_buf = Buffer.from(payload_plist);
+    var header = {
+      len: payload_buf.length + 16,
+      version: 1,
+      request: 8,
+      tag: 1
+    };
+    const header_buf = Buffer.alloc(16);
+    header_buf.fill(0);
+    header_buf.writeUInt32LE(header.len, 0);
+    header_buf.writeUInt32LE(header.version, 4);
+    header_buf.writeUInt32LE(header.request, 8);
+    header_buf.writeUInt32LE(header.tag, 12);
+    return Buffer.concat([header_buf, payload_buf]);
+  }
+  function byteSwap16(val) {
+    return (val & 255) << 8 | val >> 8 & 255;
+  }
+  const listen = pack({
+    MessageType: "Listen",
+    ClientVersionString: "node-usbmux",
+    ProgName: "node-usbmux"
+  });
+  function connect2(deviceID, port) {
+    return pack({
+      MessageType: "Connect",
+      ClientVersionString: "node-usbmux",
+      ProgName: "node-usbmux",
+      DeviceID: deviceID,
+      PortNumber: byteSwap16(port)
+    });
+  }
+  function makeParser(onComplete) {
+    let len, msg;
+    return function parse(data) {
+      if (!len) {
+        len = data.readUInt32LE(0) - 16;
+        msg = "";
+        data = data.subarray(16);
+        if (!data.length) return;
+      }
+      var body = data.subarray(0, len);
+      msg += body;
+      len -= body.length;
+      if (len === 0) onComplete(import_plist.default.parse(msg));
+      data = data.subarray(body.length);
+      if (data.length) parse(data);
+    };
+  }
+  return {
+    listen,
+    connect: connect2,
+    makeParser
+  };
+}();
+var UsbmuxdError = class extends Error {
+  constructor(message, number) {
+    if (number) {
+      message += ", Err #" + number;
+    }
+    if (number === 2) message += ": Device isn't connected";
+    if (number === 3) message += ": Port isn't available or open";
+    if (number === 5) message += ": Malformed request";
+    super(message);
+    if (number) {
+      this.number = number;
+    }
+  }
+};
+function createListener() {
+  const conn = import_node_net.default.connect(address);
+  const req = protocol.listen;
+  const parse = protocol.makeParser(function onMsgComplete(msg) {
+    debug.listen("Response: \n%o", msg);
+    if (msg.MessageType === "Result" && msg.Number !== 0) {
+      conn.emit("error", new UsbmuxdError("Listen failed", msg.Number));
+      conn.end();
+    }
+    if (msg.MessageType === "Attached") {
+      devices[msg.Properties.SerialNumber] = msg.Properties;
+      conn.emit("attached", msg.Properties.SerialNumber);
+    }
+    if (msg.MessageType === "Detached") {
+      Object.keys(devices).forEach(function(key) {
+        if (devices[key].DeviceID === msg.DeviceID) {
+          conn.emit("detached", devices[key].SerialNumber);
+          delete devices[key];
+        }
+      });
+    }
+  });
+  debug.listen("Request: \n%s", req.subarray(16).toString());
+  conn.on("data", parse);
+  process.nextTick(function() {
+    conn.write(req);
+  });
+  return conn;
+}
+function connect(deviceID, devicePort) {
+  return new Promise(function(resolve, reject) {
+    const conn = import_node_net.default.connect(address), req = protocol.connect(deviceID, devicePort);
+    var parse = protocol.makeParser(function onMsgComplete(msg) {
+      debug.connect("Response: \n%o", msg);
+      if (msg.MessageType === "Result" && msg.Number === 0) {
+        conn.removeListener("data", parse);
+        resolve(conn);
+        return;
+      }
+      reject(new UsbmuxdError("Tunnel failed", msg.Number));
+      conn.end();
+    });
+    debug.connect("Request: \n%s", req.subarray(16).toString());
+    conn.on("data", parse);
+    process.nextTick(function() {
+      conn.write(req);
+    });
+  });
+}
+var Relay = class extends import_events.EventEmitter {
+  constructor(devicePort, relayPort, opts) {
+    super();
+    /**
+     * Stops the relay
+     */
+    this.stop = function() {
+      this._listener.end();
+      this._server.close();
+    };
+    /**
+     * Debugging wrapper for emits
+     */
+    this._emit = function(event, data) {
+      debug.relay("Emit: %s", event + (data ? ", Data: " + data : ""));
+      this.emit(event, data);
+    };
+    /**
+     * Starts a usbmuxd listener
+     *
+     * Relay will start searching for connected devices and issue a warning if a
+     * device is not found within the timeout. If/when a device is found, it will
+     * emit a ready event.
+     *
+     * Listener events (attach, detach, error) are passed through as relay events.
+     */
+    this._startListener = function(timeout) {
+      var _this = this;
+      var timer = setTimeout(function() {
+        if (!_this._udid && !Object.keys(devices).length) {
+          _this._emit("warning", new Error("No devices connected"));
+        }
+        if (_this._udid && !devices[_this._udid]) {
+          _this._emit("warning", new Error("Requested device not connected"));
+        }
+      }, timeout || 1e3);
+      function readyCheck(udid) {
+        if (_this._udid && _this._udid !== udid) return;
+        _this._emit("ready", udid);
+        _this._listener.removeListener("attached", readyCheck);
+        clearTimeout(timer);
+      }
+      this._listener = createListener().on("attached", readyCheck).on("attached", _this._emit.bind(this, "attached")).on("detached", _this._emit.bind(this, "detached")).on("error", _this._emit.bind(this, "error"));
+    };
+    /**
+     * Start local TCP server that will pipe to the usbmuxd tunnel
+     *
+     * Server events (close and error) are passed through as relay events.
+     */
+    this._startServer = function() {
+      var _this = this;
+      this._server = import_node_net.default.createServer(this._handler.bind(this)).on("close", _this._emit.bind(this, "close")).on("error", function(err) {
+        _this._listener.end();
+        _this._emit("error", err);
+      }).listen(this._relayPort);
+    };
+    /**
+     * Handle & pipe connections from local server
+     *
+     * Fires error events and connection begin / disconnect events
+     */
+    this._handler = function(conn) {
+      if (!Object.keys(devices).length) {
+        this._emit("error", new Error("No devices connected"));
+        conn.end();
+        return;
+      }
+      if (this._udid && !devices[this._udid]) {
+        this._emit("error", new Error("Requested device not connected"));
+        conn.end();
+        return;
+      }
+      var _this = this, udid = this._udid || Object.keys(devices)[0], deviceID = devices[udid].DeviceID;
+      connect(deviceID, this._devicePort).then(function(tunnel) {
+        conn.pipe(tunnel).pipe(conn);
+        _this._emit("connect");
+        conn.on("end", function() {
+          _this._emit("disconnect");
+          tunnel.end();
+          conn.end();
+        });
+        conn.on("error", function() {
+          tunnel.end();
+          conn.end();
+        });
+      }).catch(function(err) {
+        _this._emit("error", err);
+        conn.end();
+      });
+    };
+    this._devicePort = devicePort;
+    this._relayPort = relayPort;
+    opts = opts || {};
+    this._udid = opts.udid;
+    this._startListener(opts.timeout || 1e3);
+    this._startServer();
+  }
+};
+function findDevice(opts) {
+  return new Promise(function(resolve, reject) {
+    var listener = createListener();
+    opts = opts || {};
+    var timer = setTimeout(function() {
+      listener.end();
+      opts.udid ? reject(new Error("Requested device not connected")) : reject(new Error("No devices connected"));
+    }, opts.timeout || 1e3);
+    listener.on("attached", function(udid) {
+      if (opts.udid && opts.udid !== udid) return;
+      listener.end();
+      clearTimeout(timer);
+      resolve(devices[udid].DeviceID);
+    });
+  });
+}
+async function getTunnel(devicePort, opts) {
+  opts = opts || {};
+  let udid;
+  let deviceID;
+  if (opts.udid && devices[opts.udid]) {
+    deviceID = devices[opts.udid].DeviceID;
+    return connect(deviceID, devicePort);
+  }
+  if (!opts.udid && Object.keys(devices).length) {
+    udid = Object.keys(devices)[0];
+    deviceID = devices[udid].DeviceID;
+    return connect(deviceID, devicePort);
+  }
+  const deviceID_2 = await findDevice(opts);
+  return await connect(deviceID_2, devicePort);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Relay,
+  UsbmuxdError,
+  address,
+  connect,
+  createListener,
+  devices,
+  findDevice,
+  getTunnel,
+  protocol
+});
+//# sourceMappingURL=usbmux.cjs.map

package/dist/usbmux.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../lib/usbmux.ts"],"sourcesContent":["import net from \"node:net\";\nimport { EventEmitter } from \"events\";\n\nimport plist from \"plist\";\n\n/**\n * Debugging\n * set with DEBUG=usbmux:* env variable\n *\n * on windows cmd set with: cmd /C \"SET DEBUG=usbmux:* && node script.js\"\n */\nimport bug from \"debug\";\nconst debug = {\n  relay: bug(\"usbmux:relay\"),\n  listen: bug(\"usbmux:listen\"),\n  connect: bug(\"usbmux:connect\"),\n};\n\ntype Device = {\n  ConnectionType: string;\n  DeviceID: DeviceId;\n  LocationID: number;\n  ProductID: number;\n  SerialNumber: string;\n};\n/**\n * Keep track of connected devices\n *\n * Maps device UDID to device properties, ie:\n * '22226dd59aaac687f555f8521f8ffddac32d394b': {\n *   ConnectionType: 'USB',\n *   DeviceID: 19,\n *   LocationID: 0,\n *   ProductID: 4776,\n *   SerialNumber: '22226dd59aaac687f555f8521f8ffddac32d394b'\n * }\n *\n * Devices are added and removed to this obj only by createListener()\n *\n */\nexport const devices: Record<string, Device> = {};\n\n/**\n * usbmuxd address\n *\n * OSX usbmuxd listens on a unix socket at /var/run/usbmuxd\n * Windows usbmuxd listens on port 27015\n *\n * libimobiledevice[1] looks like it operates at /var/run/usbmuxd too, but if\n * your usbmuxd is listening somewhere else you'll need to set this manually.\n *\n * [1] github.com/libimobiledevice/usbmuxd\n */\nexport const address =\n  process.platform === \"win32\"\n    ? { port: 27015, family: 4 }\n    : { path: \"/var/run/usbmuxd\" };\n\n/**\n * Exposes methods for dealing with usbmuxd protocol messages (send/receive)\n *\n * The usbmuxd message protocol has 2 versions. V1 doesn't look like its used\n * anymore. V2 is a header + plist format like this:\n *\n * Header:\n *   UInt32LE Length  - is the length of the header + plist (16 + plist.length)\n *   UInt32LE Version - is 0 for binary version, 1 for plist version\n *   UInt32LE Request - is always 8, for plist? from rcg4u/iphonessh\n *   UInt32LE Tag     - is always 1, ? from rcg4u/iphonessh\n *\n * Plist:\n *   <!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\"\n *     \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n *   <plist version=\"1.0\">\n *     <dict>\n *       <key>MessageType</key>\n *       <string>Listen</string>\n *       <key>ClientVersionString</key>\n *       <string>node-usbmux</string>\n *       <key>ProgName</key>\n *       <string>node-usbmux</string>\n *     </dict>\n *   </plist>\n *\n * References:\n * - https://github.com/rcg4u/iphonessh\n * - https://www.theiphonewiki.com/wiki/Usbmux (binary protocol)\n */\n\ntype DeviceId = number;\ntype UsbMuxPlist =\n  | {\n      MessageType: \"Result\";\n      Number: number;\n    }\n  | {\n      MessageType: \"Attached\";\n      Number: number;\n      Properties: Device;\n    }\n  | { MessageType: \"Detached\"; Number: number; DeviceID: DeviceId };\n\nexport const protocol = (function () {\n  /**\n   * Pack a request object into a buffer for usbmuxd\n   */\n  function pack(payload_obj: plist.PlistValue): Buffer {\n    const payload_plist = plist.build(payload_obj);\n    const payload_buf = Buffer.from(payload_plist);\n\n    var header = {\n      len: payload_buf.length + 16,\n      version: 1,\n      request: 8,\n      tag: 1,\n    };\n\n    const header_buf = Buffer.alloc(16);\n    header_buf.fill(0);\n    header_buf.writeUInt32LE(header.len, 0);\n    header_buf.writeUInt32LE(header.version, 4);\n    header_buf.writeUInt32LE(header.request, 8);\n    header_buf.writeUInt32LE(header.tag, 12);\n\n    return Buffer.concat([header_buf, payload_buf]);\n  }\n\n  /**\n   * Swap endianness of a 16bit value\n   */\n  function byteSwap16(val: number) {\n    return ((val & 0xff) << 8) | ((val >> 8) & 0xff);\n  }\n\n  /**\n   * Listen request\n   */\n  const listen: Buffer = pack({\n    MessageType: \"Listen\",\n    ClientVersionString: \"node-usbmux\",\n    ProgName: \"node-usbmux\",\n  });\n\n  /**\n   * Connect request\n   *\n   * Note: PortNumber must be network-endian, so it gets byte swapped here\n   */\n  function connect(deviceID: DeviceId, port: number): Buffer {\n    return pack({\n      MessageType: \"Connect\",\n      ClientVersionString: \"node-usbmux\",\n      ProgName: \"node-usbmux\",\n      DeviceID: deviceID,\n      PortNumber: byteSwap16(port),\n    });\n  }\n\n  /**\n   * Creates a function that will parse messages from data events\n   *\n   * net.Socket data events sometimes break up the incoming message across\n   * multiple events, making it necessary to combine them. This parser function\n   * assembles messages using the length given in the message header and calls\n   * the onComplete callback as new messages are assembled. Sometime multiple\n   * messages will be within a single data buffer too.\n   */\n  function makeParser(\n    onComplete: (msg: UsbMuxPlist) => void,\n  ): (data: Buffer) => void {\n    // Store status (remaining message length & msg text) of partial messages\n    // across multiple calls to the parse function\n    let len: number, msg: string;\n\n    return function parse(data: Buffer) {\n      // Check if this data represents a new incoming message or is part of an\n      // existing partially completed message\n      if (!len) {\n        // The length of the message's body is the total length (the first\n        // UInt32LE in the header) minus the length of header itself (16)\n        len = data.readUInt32LE(0) - 16;\n        msg = \"\";\n\n        // If there is data beyond the header then continue adding data to msg\n        data = data.subarray(16);\n        if (!data.length) return;\n      }\n\n      // Add in data until our remaining length is used up\n      var body = data.subarray(0, len);\n      msg += body;\n      len -= body.length;\n\n      // If msg is finished, convert plist to obj and run callback\n      if (len === 0) onComplete(plist.parse(msg) as UsbMuxPlist);\n\n      // If there is any data left over that means there is another message\n      // so we need to run this parse fct again using the rest of the data\n      data = data.subarray(body.length);\n      if (data.length) parse(data);\n    };\n  }\n\n  // Exposed methods\n  return {\n    listen: listen,\n    connect: connect,\n    makeParser: makeParser,\n  };\n})();\n\n/**\n * Custom usbmuxd error\n *\n * There's no documentation for usbmuxd responses, but I think I've figured\n * out these result numbers:\n * 0 - Success\n * 2 - Device requested isn't connected\n * 3 - Port requested isn't available \\ open\n * 5 - Malformed request\n */\nexport class UsbmuxdError extends Error {\n  number: number;\n\n  constructor(message: string, number: number) {\n    if (number) {\n      message += \", Err #\" + number;\n    }\n    if (number === 2) message += \": Device isn't connected\";\n    if (number === 3) message += \": Port isn't available or open\";\n    if (number === 5) message += \": Malformed request\";\n    super(message);\n    if (number) {\n      this.number = number;\n    }\n  }\n}\n\n/**\n * Connects to usbmuxd and listens for ios devices\n *\n * This connection stays open, listening as devices are plugged/unplugged and\n * cant be upgraded into a tcp tunnel. You have to start a second connection\n * with connect() to actually make tunnel.\n *\n * @return {net.Socket} - Socket with 2 bolted on events, attached & detached:\n *\n * Fires when devices are plugged in or first found by the listener\n * @event net.Socket#attached\n * @type {string} - UDID\n *\n * Fires when devices are unplugged\n * @event net.Socket#detached\n * @type {string} - UDID\n */\nexport function createListener(): net.Socket {\n  const conn = net.connect(address);\n  const req = protocol.listen;\n\n  /**\n   * Handle complete messages from usbmuxd\n   * @function\n   */\n  const parse = protocol.makeParser(function onMsgComplete(msg) {\n    debug.listen(\"Response: \\n%o\", msg);\n\n    // first response always acknowledges / denies the request:\n    if (msg.MessageType === \"Result\" && msg.Number !== 0) {\n      conn.emit(\"error\", new UsbmuxdError(\"Listen failed\", msg.Number));\n      conn.end();\n    }\n\n    // subsequent responses report on connected device status:\n    if (msg.MessageType === \"Attached\") {\n      devices[msg.Properties.SerialNumber] = msg.Properties;\n      conn.emit(\"attached\", msg.Properties.SerialNumber);\n    }\n\n    if (msg.MessageType === \"Detached\") {\n      // given msg.DeviceID, find matching device and remove it\n      Object.keys(devices).forEach(function (key) {\n        if (devices[key].DeviceID === msg.DeviceID) {\n          conn.emit(\"detached\", devices[key].SerialNumber);\n          delete devices[key];\n        }\n      });\n    }\n  });\n\n  debug.listen(\"Request: \\n%s\", req.subarray(16).toString());\n\n  conn.on(\"data\", parse);\n  process.nextTick(function () {\n    conn.write(req);\n  });\n\n  return conn;\n}\n\n/**\n * Connects to a device through usbmuxd for a tunneled tcp connection\n */\nexport function connect(\n  deviceID: DeviceId,\n  devicePort: number,\n): Promise<net.Socket> {\n  return new Promise(function (resolve, reject) {\n    const conn = net.connect(address),\n      req = protocol.connect(deviceID, devicePort);\n\n    /**\n     * Handle complete messages from usbmuxd\n     * @function\n     */\n    var parse = protocol.makeParser(function onMsgComplete(msg) {\n      debug.connect(\"Response: \\n%o\", msg);\n\n      if (msg.MessageType === \"Result\" && msg.Number === 0) {\n        conn.removeListener(\"data\", parse);\n        resolve(conn);\n        return;\n      }\n\n      // anything other response means it failed\n      reject(new UsbmuxdError(\"Tunnel failed\", msg.Number));\n      conn.end();\n    });\n\n    debug.connect(\"Request: \\n%s\", req.subarray(16).toString());\n\n    conn.on(\"data\", parse);\n    process.nextTick(function () {\n      conn.write(req);\n    });\n  });\n}\n\ntype RelayOpts = {\n  timeout?: number;\n  udid?: string;\n};\n/**\n * Creates a new tcp relay to a port on connected usb device\n *\n * @constructor\n * @param {integer} devicePort          - Port to connect to on device\n * @param {integer} relayPort           - Local port that will listen as relay\n * @param {object}  [opts]              - Options\n * @param {integer} [opts.timeout=1000] - Search time (ms) before warning\n * @param {string}  [opts.udid]         - UDID of specific device to connect to\n *\n * @public\n */\nexport class Relay extends EventEmitter {\n  _devicePort: number;\n  _relayPort: number;\n  _udid?: string;\n  constructor(devicePort: number, relayPort: number, opts: RelayOpts) {\n    super();\n    this._devicePort = devicePort;\n    this._relayPort = relayPort;\n\n    opts = opts || {};\n    this._udid = opts.udid;\n\n    this._startListener(opts.timeout || 1000);\n    this._startServer();\n  }\n  /**\n   * Stops the relay\n   */\n  stop = function () {\n    this._listener.end();\n    this._server.close();\n  };\n  /**\n   * Debugging wrapper for emits\n   */\n  _emit = function (event: string, data: any) {\n    debug.relay(\"Emit: %s\", event + (data ? \", Data: \" + data : \"\"));\n    this.emit(event, data);\n  };\n  /**\n   * Starts a usbmuxd listener\n   *\n   * Relay will start searching for connected devices and issue a warning if a\n   * device is not found within the timeout. If/when a device is found, it will\n   * emit a ready event.\n   *\n   * Listener events (attach, detach, error) are passed through as relay events.\n   */\n  _startListener = function (timeout: number) {\n    var _this = this;\n\n    var timer = setTimeout(function () {\n      // no UDID was given and no devices found yet\n      if (!_this._udid && !Object.keys(devices).length) {\n        _this._emit(\"warning\", new Error(\"No devices connected\"));\n      }\n      // UDID was given, but that device is not connected\n      if (_this._udid && !devices[_this._udid]) {\n        _this._emit(\"warning\", new Error(\"Requested device not connected\"));\n      }\n    }, timeout || 1000);\n\n    function readyCheck(udid: string) {\n      if (_this._udid && _this._udid !== udid) return;\n      _this._emit(\"ready\", udid);\n      _this._listener.removeListener(\"attached\", readyCheck);\n      clearTimeout(timer);\n    }\n\n    this._listener = createListener()\n      .on(\"attached\", readyCheck)\n      .on(\"attached\", _this._emit.bind(this, \"attached\"))\n      .on(\"detached\", _this._emit.bind(this, \"detached\"))\n      .on(\"error\", _this._emit.bind(this, \"error\"));\n  };\n  /**\n   * Start local TCP server that will pipe to the usbmuxd tunnel\n   *\n   * Server events (close and error) are passed through as relay events.\n   */\n  _startServer = function () {\n    var _this = this;\n    this._server = net\n      .createServer(this._handler.bind(this))\n      .on(\"close\", _this._emit.bind(this, \"close\"))\n      .on(\"error\", function (err) {\n        _this._listener.end();\n        _this._emit(\"error\", err);\n      })\n      .listen(this._relayPort);\n  };\n  /**\n   * Handle & pipe connections from local server\n   *\n   * Fires error events and connection begin / disconnect events\n   */\n  _handler = function (conn: net.Socket) {\n    // emit error if there are no devices connected\n    if (!Object.keys(devices).length) {\n      this._emit(\"error\", new Error(\"No devices connected\"));\n      conn.end();\n      return;\n    }\n\n    // emit error if a udid was specified but that device isn't connected\n    if (this._udid && !devices[this._udid]) {\n      this._emit(\"error\", new Error(\"Requested device not connected\"));\n      conn.end();\n      return;\n    }\n\n    // Use specified device or choose one from available devices\n    var _this = this,\n      udid = this._udid || Object.keys(devices)[0],\n      deviceID = devices[udid].DeviceID;\n\n    connect(deviceID, this._devicePort)\n      .then(function (tunnel) {\n        // pipe connection & tunnel together\n        conn.pipe(tunnel).pipe(conn);\n\n        _this._emit(\"connect\");\n\n        conn.on(\"end\", function () {\n          _this._emit(\"disconnect\");\n          tunnel.end();\n          conn.end();\n        });\n\n        conn.on(\"error\", function () {\n          tunnel.end();\n          conn.end();\n        });\n      })\n      .catch(function (err) {\n        _this._emit(\"error\", err);\n        conn.end();\n      });\n  };\n}\n\n/**\n * Find a device (specified or not) within a timeout\n *\n * Usbmuxd has IDs it assigned to devices as they are plugged in. The IDs\n * change as devices are unpplugged and plugged back in, so even if we have a\n * UDID we need to get the current ID from usbmuxd before we can connect.\n */\nexport function findDevice(opts: RelayOpts): Promise<number> {\n  return new Promise(function (resolve, reject) {\n    var listener = createListener();\n    opts = opts || {};\n\n    var timer = setTimeout(function () {\n      listener.end();\n      opts.udid\n        ? reject(new Error(\"Requested device not connected\"))\n        : reject(new Error(\"No devices connected\"));\n    }, opts.timeout || 1000);\n\n    listener.on(\"attached\", function (udid) {\n      if (opts.udid && opts.udid !== udid) return;\n      listener.end();\n      clearTimeout(timer);\n      resolve(devices[udid].DeviceID);\n    });\n  });\n}\n\n/**\n * Get a tunneled connection to a device (specified or not) within a timeout\n */\nexport async function getTunnel(\n  devicePort: number,\n  opts: RelayOpts,\n): Promise<net.Socket> {\n  opts = opts || {};\n  let udid: string;\n  let deviceID: DeviceId;\n\n  // If UDID was specified and that device's DeviceID is known, connect to it\n  if (opts.udid && devices[opts.udid]) {\n    deviceID = devices[opts.udid].DeviceID;\n    return connect(deviceID, devicePort);\n  }\n\n  // If no UDID given, connect to any known device\n  // (random because no key order, but there's probably only 1 option anyways)\n  if (!opts.udid && Object.keys(devices).length) {\n    udid = Object.keys(devices)[0];\n    deviceID = devices[udid].DeviceID;\n    return connect(deviceID, devicePort);\n  }\n\n  // - Try to find and connect to requested the device (given opts.UDID),\n  // - or find and connect to any device (no opts.UDID given)\n  const deviceID_2 = await findDevice(opts);\n  return await connect(deviceID_2, devicePort);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sBAAgB;AAChB,oBAA6B;AAE7B,mBAAkB;AAQlB,mBAAgB;AAChB,IAAM,QAAQ;AAAA,EACZ,WAAO,aAAAA,SAAI,cAAc;AAAA,EACzB,YAAQ,aAAAA,SAAI,eAAe;AAAA,EAC3B,aAAS,aAAAA,SAAI,gBAAgB;AAC/B;AAwBO,IAAM,UAAkC,CAAC;AAazC,IAAM,UACX,QAAQ,aAAa,UACjB,EAAE,MAAM,OAAO,QAAQ,EAAE,IACzB,EAAE,MAAM,mBAAmB;AA8C1B,IAAM,WAAY,WAAY;AAInC,WAAS,KAAK,aAAuC;AACnD,UAAM,gBAAgB,aAAAC,QAAM,MAAM,WAAW;AAC7C,UAAM,cAAc,OAAO,KAAK,aAAa;AAE7C,QAAI,SAAS;AAAA,MACX,KAAK,YAAY,SAAS;AAAA,MAC1B,SAAS;AAAA,MACT,SAAS;AAAA,MACT,KAAK;AAAA,IACP;AAEA,UAAM,aAAa,OAAO,MAAM,EAAE;AAClC,eAAW,KAAK,CAAC;AACjB,eAAW,cAAc,OAAO,KAAK,CAAC;AACtC,eAAW,cAAc,OAAO,SAAS,CAAC;AAC1C,eAAW,cAAc,OAAO,SAAS,CAAC;AAC1C,eAAW,cAAc,OAAO,KAAK,EAAE;AAEvC,WAAO,OAAO,OAAO,CAAC,YAAY,WAAW,CAAC;AAAA,EAChD;AAKA,WAAS,WAAW,KAAa;AAC/B,YAAS,MAAM,QAAS,IAAO,OAAO,IAAK;AAAA,EAC7C;AAKA,QAAM,SAAiB,KAAK;AAAA,IAC1B,aAAa;AAAA,IACb,qBAAqB;AAAA,IACrB,UAAU;AAAA,EACZ,CAAC;AAOD,WAASC,SAAQ,UAAoB,MAAsB;AACzD,WAAO,KAAK;AAAA,MACV,aAAa;AAAA,MACb,qBAAqB;AAAA,MACrB,UAAU;AAAA,MACV,UAAU;AAAA,MACV,YAAY,WAAW,IAAI;AAAA,IAC7B,CAAC;AAAA,EACH;AAWA,WAAS,WACP,YACwB;AAGxB,QAAI,KAAa;AAEjB,WAAO,SAAS,MAAM,MAAc;AAGlC,UAAI,CAAC,KAAK;AAGR,cAAM,KAAK,aAAa,CAAC,IAAI;AAC7B,cAAM;AAGN,eAAO,KAAK,SAAS,EAAE;AACvB,YAAI,CAAC,KAAK,OAAQ;AAAA,MACpB;AAGA,UAAI,OAAO,KAAK,SAAS,GAAG,GAAG;AAC/B,aAAO;AACP,aAAO,KAAK;AAGZ,UAAI,QAAQ,EAAG,YAAW,aAAAD,QAAM,MAAM,GAAG,CAAgB;AAIzD,aAAO,KAAK,SAAS,KAAK,MAAM;AAChC,UAAI,KAAK,OAAQ,OAAM,IAAI;AAAA,IAC7B;AAAA,EACF;AAGA,SAAO;AAAA,IACL;AAAA,IACA,SAASC;AAAA,IACT;AAAA,EACF;AACF,EAAG;AAYI,IAAM,eAAN,cAA2B,MAAM;AAAA,EAGtC,YAAY,SAAiB,QAAgB;AAC3C,QAAI,QAAQ;AACV,iBAAW,YAAY;AAAA,IACzB;AACA,QAAI,WAAW,EAAG,YAAW;AAC7B,QAAI,WAAW,EAAG,YAAW;AAC7B,QAAI,WAAW,EAAG,YAAW;AAC7B,UAAM,OAAO;AACb,QAAI,QAAQ;AACV,WAAK,SAAS;AAAA,IAChB;AAAA,EACF;AACF;AAmBO,SAAS,iBAA6B;AAC3C,QAAM,OAAO,gBAAAC,QAAI,QAAQ,OAAO;AAChC,QAAM,MAAM,SAAS;AAMrB,QAAM,QAAQ,SAAS,WAAW,SAAS,cAAc,KAAK;AAC5D,UAAM,OAAO,kBAAkB,GAAG;AAGlC,QAAI,IAAI,gBAAgB,YAAY,IAAI,WAAW,GAAG;AACpD,WAAK,KAAK,SAAS,IAAI,aAAa,iBAAiB,IAAI,MAAM,CAAC;AAChE,WAAK,IAAI;AAAA,IACX;AAGA,QAAI,IAAI,gBAAgB,YAAY;AAClC,cAAQ,IAAI,WAAW,YAAY,IAAI,IAAI;AAC3C,WAAK,KAAK,YAAY,IAAI,WAAW,YAAY;AAAA,IACnD;AAEA,QAAI,IAAI,gBAAgB,YAAY;AAElC,aAAO,KAAK,OAAO,EAAE,QAAQ,SAAU,KAAK;AAC1C,YAAI,QAAQ,GAAG,EAAE,aAAa,IAAI,UAAU;AAC1C,eAAK,KAAK,YAAY,QAAQ,GAAG,EAAE,YAAY;AAC/C,iBAAO,QAAQ,GAAG;AAAA,QACpB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AAED,QAAM,OAAO,iBAAiB,IAAI,SAAS,EAAE,EAAE,SAAS,CAAC;AAEzD,OAAK,GAAG,QAAQ,KAAK;AACrB,UAAQ,SAAS,WAAY;AAC3B,SAAK,MAAM,GAAG;AAAA,EAChB,CAAC;AAED,SAAO;AACT;AAKO,SAAS,QACd,UACA,YACqB;AACrB,SAAO,IAAI,QAAQ,SAAU,SAAS,QAAQ;AAC5C,UAAM,OAAO,gBAAAA,QAAI,QAAQ,OAAO,GAC9B,MAAM,SAAS,QAAQ,UAAU,UAAU;AAM7C,QAAI,QAAQ,SAAS,WAAW,SAAS,cAAc,KAAK;AAC1D,YAAM,QAAQ,kBAAkB,GAAG;AAEnC,UAAI,IAAI,gBAAgB,YAAY,IAAI,WAAW,GAAG;AACpD,aAAK,eAAe,QAAQ,KAAK;AACjC,gBAAQ,IAAI;AACZ;AAAA,MACF;AAGA,aAAO,IAAI,aAAa,iBAAiB,IAAI,MAAM,CAAC;AACpD,WAAK,IAAI;AAAA,IACX,CAAC;AAED,UAAM,QAAQ,iBAAiB,IAAI,SAAS,EAAE,EAAE,SAAS,CAAC;AAE1D,SAAK,GAAG,QAAQ,KAAK;AACrB,YAAQ,SAAS,WAAY;AAC3B,WAAK,MAAM,GAAG;AAAA,IAChB,CAAC;AAAA,EACH,CAAC;AACH;AAkBO,IAAM,QAAN,cAAoB,2BAAa;AAAA,EAItC,YAAY,YAAoB,WAAmB,MAAiB;AAClE,UAAM;AAaR;AAAA;AAAA;AAAA,gBAAO,WAAY;AACjB,WAAK,UAAU,IAAI;AACnB,WAAK,QAAQ,MAAM;AAAA,IACrB;AAIA;AAAA;AAAA;AAAA,iBAAQ,SAAU,OAAe,MAAW;AAC1C,YAAM,MAAM,YAAY,SAAS,OAAO,aAAa,OAAO,GAAG;AAC/D,WAAK,KAAK,OAAO,IAAI;AAAA,IACvB;AAUA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,0BAAiB,SAAU,SAAiB;AAC1C,UAAI,QAAQ;AAEZ,UAAI,QAAQ,WAAW,WAAY;AAEjC,YAAI,CAAC,MAAM,SAAS,CAAC,OAAO,KAAK,OAAO,EAAE,QAAQ;AAChD,gBAAM,MAAM,WAAW,IAAI,MAAM,sBAAsB,CAAC;AAAA,QAC1D;AAEA,YAAI,MAAM,SAAS,CAAC,QAAQ,MAAM,KAAK,GAAG;AACxC,gBAAM,MAAM,WAAW,IAAI,MAAM,gCAAgC,CAAC;AAAA,QACpE;AAAA,MACF,GAAG,WAAW,GAAI;AAElB,eAAS,WAAW,MAAc;AAChC,YAAI,MAAM,SAAS,MAAM,UAAU,KAAM;AACzC,cAAM,MAAM,SAAS,IAAI;AACzB,cAAM,UAAU,eAAe,YAAY,UAAU;AACrD,qBAAa,KAAK;AAAA,MACpB;AAEA,WAAK,YAAY,eAAe,EAC7B,GAAG,YAAY,UAAU,EACzB,GAAG,YAAY,MAAM,MAAM,KAAK,MAAM,UAAU,CAAC,EACjD,GAAG,YAAY,MAAM,MAAM,KAAK,MAAM,UAAU,CAAC,EACjD,GAAG,SAAS,MAAM,MAAM,KAAK,MAAM,OAAO,CAAC;AAAA,IAChD;AAMA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAe,WAAY;AACzB,UAAI,QAAQ;AACZ,WAAK,UAAU,gBAAAA,QACZ,aAAa,KAAK,SAAS,KAAK,IAAI,CAAC,EACrC,GAAG,SAAS,MAAM,MAAM,KAAK,MAAM,OAAO,CAAC,EAC3C,GAAG,SAAS,SAAU,KAAK;AAC1B,cAAM,UAAU,IAAI;AACpB,cAAM,MAAM,SAAS,GAAG;AAAA,MAC1B,CAAC,EACA,OAAO,KAAK,UAAU;AAAA,IAC3B;AAMA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAAW,SAAU,MAAkB;AAErC,UAAI,CAAC,OAAO,KAAK,OAAO,EAAE,QAAQ;AAChC,aAAK,MAAM,SAAS,IAAI,MAAM,sBAAsB,CAAC;AACrD,aAAK,IAAI;AACT;AAAA,MACF;AAGA,UAAI,KAAK,SAAS,CAAC,QAAQ,KAAK,KAAK,GAAG;AACtC,aAAK,MAAM,SAAS,IAAI,MAAM,gCAAgC,CAAC;AAC/D,aAAK,IAAI;AACT;AAAA,MACF;AAGA,UAAI,QAAQ,MACV,OAAO,KAAK,SAAS,OAAO,KAAK,OAAO,EAAE,CAAC,GAC3C,WAAW,QAAQ,IAAI,EAAE;AAE3B,cAAQ,UAAU,KAAK,WAAW,EAC/B,KAAK,SAAU,QAAQ;AAEtB,aAAK,KAAK,MAAM,EAAE,KAAK,IAAI;AAE3B,cAAM,MAAM,SAAS;AAErB,aAAK,GAAG,OAAO,WAAY;AACzB,gBAAM,MAAM,YAAY;AACxB,iBAAO,IAAI;AACX,eAAK,IAAI;AAAA,QACX,CAAC;AAED,aAAK,GAAG,SAAS,WAAY;AAC3B,iBAAO,IAAI;AACX,eAAK,IAAI;AAAA,QACX,CAAC;AAAA,MACH,CAAC,EACA,MAAM,SAAU,KAAK;AACpB,cAAM,MAAM,SAAS,GAAG;AACxB,aAAK,IAAI;AAAA,MACX,CAAC;AAAA,IACL;AA1HE,SAAK,cAAc;AACnB,SAAK,aAAa;AAElB,WAAO,QAAQ,CAAC;AAChB,SAAK,QAAQ,KAAK;AAElB,SAAK,eAAe,KAAK,WAAW,GAAI;AACxC,SAAK,aAAa;AAAA,EACpB;AAmHF;AASO,SAAS,WAAW,MAAkC;AAC3D,SAAO,IAAI,QAAQ,SAAU,SAAS,QAAQ;AAC5C,QAAI,WAAW,eAAe;AAC9B,WAAO,QAAQ,CAAC;AAEhB,QAAI,QAAQ,WAAW,WAAY;AACjC,eAAS,IAAI;AACb,WAAK,OACD,OAAO,IAAI,MAAM,gCAAgC,CAAC,IAClD,OAAO,IAAI,MAAM,sBAAsB,CAAC;AAAA,IAC9C,GAAG,KAAK,WAAW,GAAI;AAEvB,aAAS,GAAG,YAAY,SAAU,MAAM;AACtC,UAAI,KAAK,QAAQ,KAAK,SAAS,KAAM;AACrC,eAAS,IAAI;AACb,mBAAa,KAAK;AAClB,cAAQ,QAAQ,IAAI,EAAE,QAAQ;AAAA,IAChC,CAAC;AAAA,EACH,CAAC;AACH;AAKA,eAAsB,UACpB,YACA,MACqB;AACrB,SAAO,QAAQ,CAAC;AAChB,MAAI;AACJ,MAAI;AAGJ,MAAI,KAAK,QAAQ,QAAQ,KAAK,IAAI,GAAG;AACnC,eAAW,QAAQ,KAAK,IAAI,EAAE;AAC9B,WAAO,QAAQ,UAAU,UAAU;AAAA,EACrC;AAIA,MAAI,CAAC,KAAK,QAAQ,OAAO,KAAK,OAAO,EAAE,QAAQ;AAC7C,WAAO,OAAO,KAAK,OAAO,EAAE,CAAC;AAC7B,eAAW,QAAQ,IAAI,EAAE;AACzB,WAAO,QAAQ,UAAU,UAAU;AAAA,EACrC;AAIA,QAAM,aAAa,MAAM,WAAW,IAAI;AACxC,SAAO,MAAM,QAAQ,YAAY,UAAU;AAC7C;","names":["bug","plist","connect","net"]}

package/dist/usbmux.d.cts

@@ -0,0 +1,196 @@
+import net from 'node:net';
+import { EventEmitter } from 'events';
+
+type Device = {
+    ConnectionType: string;
+    DeviceID: DeviceId;
+    LocationID: number;
+    ProductID: number;
+    SerialNumber: string;
+};
+/**
+ * Keep track of connected devices
+ *
+ * Maps device UDID to device properties, ie:
+ * '22226dd59aaac687f555f8521f8ffddac32d394b': {
+ *   ConnectionType: 'USB',
+ *   DeviceID: 19,
+ *   LocationID: 0,
+ *   ProductID: 4776,
+ *   SerialNumber: '22226dd59aaac687f555f8521f8ffddac32d394b'
+ * }
+ *
+ * Devices are added and removed to this obj only by createListener()
+ *
+ */
+declare const devices: Record<string, Device>;
+/**
+ * usbmuxd address
+ *
+ * OSX usbmuxd listens on a unix socket at /var/run/usbmuxd
+ * Windows usbmuxd listens on port 27015
+ *
+ * libimobiledevice[1] looks like it operates at /var/run/usbmuxd too, but if
+ * your usbmuxd is listening somewhere else you'll need to set this manually.
+ *
+ * [1] github.com/libimobiledevice/usbmuxd
+ */
+declare const address: {
+    port: number;
+    family: number;
+    path?: undefined;
+} | {
+    path: string;
+    port?: undefined;
+    family?: undefined;
+};
+/**
+ * Exposes methods for dealing with usbmuxd protocol messages (send/receive)
+ *
+ * The usbmuxd message protocol has 2 versions. V1 doesn't look like its used
+ * anymore. V2 is a header + plist format like this:
+ *
+ * Header:
+ *   UInt32LE Length  - is the length of the header + plist (16 + plist.length)
+ *   UInt32LE Version - is 0 for binary version, 1 for plist version
+ *   UInt32LE Request - is always 8, for plist? from rcg4u/iphonessh
+ *   UInt32LE Tag     - is always 1, ? from rcg4u/iphonessh
+ *
+ * Plist:
+ *   <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
+ *     "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+ *   <plist version="1.0">
+ *     <dict>
+ *       <key>MessageType</key>
+ *       <string>Listen</string>
+ *       <key>ClientVersionString</key>
+ *       <string>node-usbmux</string>
+ *       <key>ProgName</key>
+ *       <string>node-usbmux</string>
+ *     </dict>
+ *   </plist>
+ *
+ * References:
+ * - https://github.com/rcg4u/iphonessh
+ * - https://www.theiphonewiki.com/wiki/Usbmux (binary protocol)
+ */
+type DeviceId = number;
+type UsbMuxPlist = {
+    MessageType: "Result";
+    Number: number;
+} | {
+    MessageType: "Attached";
+    Number: number;
+    Properties: Device;
+} | {
+    MessageType: "Detached";
+    Number: number;
+    DeviceID: DeviceId;
+};
+declare const protocol: {
+    listen: Buffer<ArrayBufferLike>;
+    connect: (deviceID: DeviceId, port: number) => Buffer;
+    makeParser: (onComplete: (msg: UsbMuxPlist) => void) => (data: Buffer) => void;
+};
+/**
+ * Custom usbmuxd error
+ *
+ * There's no documentation for usbmuxd responses, but I think I've figured
+ * out these result numbers:
+ * 0 - Success
+ * 2 - Device requested isn't connected
+ * 3 - Port requested isn't available \ open
+ * 5 - Malformed request
+ */
+declare class UsbmuxdError extends Error {
+    number: number;
+    constructor(message: string, number: number);
+}
+/**
+ * Connects to usbmuxd and listens for ios devices
+ *
+ * This connection stays open, listening as devices are plugged/unplugged and
+ * cant be upgraded into a tcp tunnel. You have to start a second connection
+ * with connect() to actually make tunnel.
+ *
+ * @return {net.Socket} - Socket with 2 bolted on events, attached & detached:
+ *
+ * Fires when devices are plugged in or first found by the listener
+ * @event net.Socket#attached
+ * @type {string} - UDID
+ *
+ * Fires when devices are unplugged
+ * @event net.Socket#detached
+ * @type {string} - UDID
+ */
+declare function createListener(): net.Socket;
+/**
+ * Connects to a device through usbmuxd for a tunneled tcp connection
+ */
+declare function connect(deviceID: DeviceId, devicePort: number): Promise<net.Socket>;
+type RelayOpts = {
+    timeout?: number;
+    udid?: string;
+};
+/**
+ * Creates a new tcp relay to a port on connected usb device
+ *
+ * @constructor
+ * @param {integer} devicePort          - Port to connect to on device
+ * @param {integer} relayPort           - Local port that will listen as relay
+ * @param {object}  [opts]              - Options
+ * @param {integer} [opts.timeout=1000] - Search time (ms) before warning
+ * @param {string}  [opts.udid]         - UDID of specific device to connect to
+ *
+ * @public
+ */
+declare class Relay extends EventEmitter {
+    _devicePort: number;
+    _relayPort: number;
+    _udid?: string;
+    constructor(devicePort: number, relayPort: number, opts: RelayOpts);
+    /**
+     * Stops the relay
+     */
+    stop: () => void;
+    /**
+     * Debugging wrapper for emits
+     */
+    _emit: (event: string, data: any) => void;
+    /**
+     * Starts a usbmuxd listener
+     *
+     * Relay will start searching for connected devices and issue a warning if a
+     * device is not found within the timeout. If/when a device is found, it will
+     * emit a ready event.
+     *
+     * Listener events (attach, detach, error) are passed through as relay events.
+     */
+    _startListener: (timeout: number) => void;
+    /**
+     * Start local TCP server that will pipe to the usbmuxd tunnel
+     *
+     * Server events (close and error) are passed through as relay events.
+     */
+    _startServer: () => void;
+    /**
+     * Handle & pipe connections from local server
+     *
+     * Fires error events and connection begin / disconnect events
+     */
+    _handler: (conn: net.Socket) => void;
+}
+/**
+ * Find a device (specified or not) within a timeout
+ *
+ * Usbmuxd has IDs it assigned to devices as they are plugged in. The IDs
+ * change as devices are unpplugged and plugged back in, so even if we have a
+ * UDID we need to get the current ID from usbmuxd before we can connect.
+ */
+declare function findDevice(opts: RelayOpts): Promise<number>;
+/**
+ * Get a tunneled connection to a device (specified or not) within a timeout
+ */
+declare function getTunnel(devicePort: number, opts: RelayOpts): Promise<net.Socket>;
+
+export { Relay, UsbmuxdError, address, connect, createListener, devices, findDevice, getTunnel, protocol };