appium-ios-device 3.1.11 → 3.1.13

package/lib/instrument/index.js

@@ -13,9 +13,9 @@ const WAIT_REPLY_TIME_MS = 10000;
 const CHANNEL_CANCELED = '_channelCanceled';
 const CHANNEL_OFFSET = 2 ** 32;
 
-const INSTRUMENT_SERVICE_NAME_VERSION_14 =
+export const INSTRUMENT_SERVICE_NAME_VERSION_14 =
   'com.apple.instruments.remoteserver.DVTSecureSocketProxy';
-const INSTRUMENT_SERVICE_NAME = 'com.apple.instruments.remoteserver';
+export const INSTRUMENT_SERVICE_NAME = 'com.apple.instruments.remoteserver';
 
 export const INSTRUMENT_CHANNEL = Object.freeze({
   DEVICE_INFO: 'com.apple.instruments.server.services.deviceinfo',
@@ -28,23 +28,7 @@ export const INSTRUMENT_CHANNEL = Object.freeze({
   CONDITION_INDUCER: 'com.apple.instruments.server.services.ConditionInducer',
 });
 
-function defaultDict(createValue) {
-  return Proxy.revocable(Object.create(null), {
-    get(storage, property) {
-      if (!(property in storage)) {
-        storage[property] = createValue(property);
-      }
-      return storage[property];
-    },
-  });
-}
-
-/** The callback function which will be called during the data transmission in instrument serve
- * @callback DTXCallback
- * @param {DTXMessage} object
- */
-
-class InstrumentService extends BaseServiceSocket {
+export class InstrumentService extends BaseServiceSocket {
   /**
    * @param {import('net').Socket} socketClient  DTXMessage.selector
    * @param {DTXCallback?} event if empty will ignore any messages
@@ -167,7 +151,7 @@ class InstrumentService extends BaseServiceSocket {
         );
       } catch (err) {
         this.close();
-        throw new Error(err);
+        throw new Error(String(err), {cause: err});
       }
     }
   }
@@ -223,4 +207,18 @@ class InstrumentService extends BaseServiceSocket {
   }
 }
 
-export {InstrumentService, INSTRUMENT_SERVICE_NAME_VERSION_14, INSTRUMENT_SERVICE_NAME};
+/** The callback function which will be called during the data transmission in instrument serve
+ * @callback DTXCallback
+ * @param {DTXMessage} object
+ */
+
+function defaultDict(createValue) {
+  return Proxy.revocable(Object.create(null), {
+    get(storage, property) {
+      if (!(property in storage)) {
+        storage[property] = createValue(property);
+      }
+      return storage[property];
+    },
+  });
+}

package/lib/instrument/transformer/dtx-decode.js

@@ -8,7 +8,7 @@ import {
 } from '../headers';
 import {log} from '../../logger';
 
-class DTXDecoder extends Stream.Transform {
+export class DTXDecoder extends Stream.Transform {
   constructor() {
     super({objectMode: true});
     this._dtxManager = {};
@@ -89,5 +89,3 @@ class DTXDecoder extends Stream.Transform {
     return buf;
   }
 }
-
-export {DTXDecoder};

package/lib/instrument/transformer/dtx-encode.js

@@ -1,7 +1,7 @@
 import Stream from 'node:stream';
 import {DTXMessage, DTXMessageAux} from '../headers';
 
-class DTXEncoder extends Stream.Transform {
+export class DTXEncoder extends Stream.Transform {
   constructor() {
     super({objectMode: true});
   }
@@ -27,5 +27,3 @@ class DTXEncoder extends Stream.Transform {
     return dtx.build();
   }
 }
-
-export {DTXEncoder};

package/lib/instrument/transformer/nskeyed.js

@@ -59,7 +59,7 @@ class ArchivingObject {
  * This class must be inherited when creating an archive/unarchive subclass
  * And you need to call `updateNSKeyedArchiveClass` add subclass to archive/unarchive object
  */
-class BaseArchiveHandler {
+export class BaseArchiveHandler {
   /**
    * some of the classes may have to add 'NSObject' or maybe more in $classes while encoding.
    */
@@ -136,7 +136,55 @@ class NSException extends BaseArchiveHandler {
   }
 }
 
-class NSURL extends BaseArchiveHandler {
+class NSMutableString extends BaseArchiveHandler {
+  decodeArchive(archive) {
+    return archive.decode('NS.string');
+  }
+}
+
+class NSMutableData extends BaseArchiveHandler {
+  decodeArchive(archive) {
+    return archive.decode('NS.data');
+  }
+}
+
+class XCTCapabilities extends BaseArchiveHandler {
+  decodeArchive(archive) {
+    return archive.decode('capabilities-dictionary');
+  }
+}
+
+/**
+ * Some of the plist classes may not be included and should not be cared.
+ * Using this as a default decoder for unknown entities to avoid interrupting decode process.
+ */
+class NSIgnore extends BaseArchiveHandler {
+  decodeArchive() {
+    return null;
+  }
+}
+
+class NSNull extends BaseArchiveHandler {
+  constructor() {
+    super();
+    this.additionClasses = [NS_OBJECT];
+  }
+  decodeArchive() {
+    return null;
+  }
+}
+
+class XCActivityRecord extends BaseArchiveHandler {
+  static _keys = ['activityType', 'attachments', 'finish', 'start', 'title', 'uuid'];
+  decodeArchive(archive) {
+    return XCActivityRecord._keys.reduce((acc, key) => {
+      acc[key] = archive.decode(key);
+      return acc;
+    }, {});
+  }
+}
+
+export class NSURL extends BaseArchiveHandler {
   /**
    * @param {*} base
    * @param {string} relative usually ios device relative path e.g: file://xx/
@@ -162,7 +210,7 @@ class NSURL extends BaseArchiveHandler {
   }
 }
 
-class NSDate extends BaseArchiveHandler {
+export class NSDate extends BaseArchiveHandler {
   /**
    * @param {number} data timestamp in seconds
    */
@@ -180,19 +228,7 @@ class NSDate extends BaseArchiveHandler {
   }
 }
 
-class NSMutableString extends BaseArchiveHandler {
-  decodeArchive(archive) {
-    return archive.decode('NS.string');
-  }
-}
-
-class NSMutableData extends BaseArchiveHandler {
-  decodeArchive(archive) {
-    return archive.decode('NS.data');
-  }
-}
-
-class NSUUID extends BaseArchiveHandler {
+export class NSUUID extends BaseArchiveHandler {
   /**
    * @param {string} data uuid format data e.g:00000000-0000-0000-0000-000000000000
    */
@@ -211,32 +247,6 @@ class NSUUID extends BaseArchiveHandler {
   }
 }
 
-class XCTCapabilities extends BaseArchiveHandler {
-  decodeArchive(archive) {
-    return archive.decode('capabilities-dictionary');
-  }
-}
-
-/**
- * Some of the plist classes may not be included and should not be cared.
- * Using this as a default decoder for unknown entities to avoid interrupting decode process.
- */
-class NSIgnore extends BaseArchiveHandler {
-  decodeArchive() {
-    return null;
-  }
-}
-
-class NSNull extends BaseArchiveHandler {
-  constructor() {
-    super();
-    this.additionClasses = [NS_OBJECT];
-  }
-  decodeArchive() {
-    return null;
-  }
-}
-
 /**
  * @typedef {Object} XCTestConfigurationPlist
  * @property {string | NSURL} testBundleURL
@@ -247,7 +257,7 @@ class NSNull extends BaseArchiveHandler {
  * @property {string[]?} testsToRun
  * @property {string[]?} testsToSkip
  */
-class XCTestConfiguration extends BaseArchiveHandler {
+export class XCTestConfiguration extends BaseArchiveHandler {
   static _default = {
     aggregateStatisticsBeforeCrash: {
       XCSuiteRecordsKey: {},
@@ -321,16 +331,6 @@ class XCTestConfiguration extends BaseArchiveHandler {
   }
 }
 
-class XCActivityRecord extends BaseArchiveHandler {
-  static _keys = ['activityType', 'attachments', 'finish', 'start', 'title', 'uuid'];
-  decodeArchive(archive) {
-    return XCActivityRecord._keys.reduce((acc, key) => {
-      acc[key] = archive.decode(key);
-      return acc;
-    }, {});
-  }
-}
-
 /**
  * decode and encode Archive of currently known data formats
  */
@@ -559,7 +559,7 @@ class Archive {
  * @param {Object} inputObject
  * @returns {Buffer} NSKeyed Buffer
  */
-function archive(inputObject) {
+export function archive(inputObject) {
   return new Archive(inputObject).toBytes();
 }
 
@@ -568,7 +568,7 @@ function archive(inputObject) {
  * @param {Buffer} inputBytes NSKeyed Buffer
  * @returns {Object} JS Object
  */
-function unarchive(inputBytes) {
+export function unarchive(inputBytes) {
   return new Unarchive(inputBytes).toObject();
 }
 
@@ -577,7 +577,7 @@ function unarchive(inputBytes) {
  * @param {String} name packing/unpacking key name
  * @param {BaseArchiveHandler} subClass inherit from BaseArchiveHandler class
  */
-function updateNSKeyedArchiveClass(name, subClass) {
+export function updateNSKeyedArchiveClass(name, subClass) {
   if (
     // @ts-ignore prototype always exists
     !_.isFunction(subClass.prototype?.decodeArchive) &&
@@ -590,14 +590,3 @@ function updateNSKeyedArchiveClass(name, subClass) {
     UNARCHIVE_CLASS_MAP[name] = subClass;
   }
 }
-
-export {
-  updateNSKeyedArchiveClass,
-  BaseArchiveHandler,
-  NSURL,
-  NSUUID,
-  NSDate,
-  XCTestConfiguration,
-  unarchive,
-  archive,
-};

package/lib/lockdown/index.js

@@ -1,11 +1,11 @@
 import _ from 'lodash';
 import {BaseServicePlist} from '../base-service';
 
-const LOCKDOWN_PORT = 62078;
+export const LOCKDOWN_PORT = 62078;
 const LABEL = 'usbmuxd';
 const PROTOCOL_VERSION = 2;
 
-class Lockdown extends BaseServicePlist {
+export class Lockdown extends BaseServicePlist {
   /**
    * Makes a query type request to lockdown
    * @param {number} [timeout=5000] the timeout of receiving a response from lockdownd
@@ -118,5 +118,4 @@ class Lockdown extends BaseServicePlist {
   }
 }
 
-export {Lockdown, LOCKDOWN_PORT};
 export default Lockdown;

package/lib/mcinstall/index.js

@@ -1,17 +1,10 @@
 import {BaseServicePlist} from '../base-service';
 import {fs, plist} from '@appium/support';
 
-const MC_INSTALL_SERVICE_NAME = 'com.apple.mobile.MCInstall';
+export const MC_INSTALL_SERVICE_NAME = 'com.apple.mobile.MCInstall';
 const ACKNOWLEDGED = 'Acknowledged';
 
-function checkACK(res, name) {
-  if (res.Status !== ACKNOWLEDGED) {
-    throw new Error(`${name} error: ${JSON.stringify(res)}`);
-  }
-  return res;
-}
-
-class MCInstallProxyService extends BaseServicePlist {
+export class MCInstallProxyService extends BaseServicePlist {
   constructor(socketClient) {
     super(socketClient);
   }
@@ -92,5 +85,11 @@ class MCInstallProxyService extends BaseServicePlist {
   }
 }
 
-export {MCInstallProxyService, MC_INSTALL_SERVICE_NAME};
+function checkACK(res, name) {
+  if (res.Status !== ACKNOWLEDGED) {
+    throw new Error(`${name} error: ${JSON.stringify(res)}`);
+  }
+  return res;
+}
+
 export default MCInstallProxyService;

package/lib/notification-proxy/index.js

@@ -6,13 +6,13 @@ import _ from 'lodash';
 import {BaseServiceSocket} from '../base-service';
 import {getMaxFrameLength} from '../utilities';
 
-const NOTIFICATION_PROXY_SERVICE_NAME = 'com.apple.mobile.notification_proxy';
+export const NOTIFICATION_PROXY_SERVICE_NAME = 'com.apple.mobile.notification_proxy';
 const MAX_FRAME_SIZE = 16 * KB;
 
 const RELAY_NOTIFICATION = 'RelayNotification';
 const PROXY_DEATH = 'ProxyDeath';
 
-class NotificationProxyService extends BaseServiceSocket {
+export class NotificationProxyService extends BaseServiceSocket {
   constructor(socketClient) {
     super(socketClient);
 
@@ -108,4 +108,3 @@ class NotificationProxyService extends BaseServiceSocket {
 }
 
 export default NotificationProxyService;
-export {NotificationProxyService, NOTIFICATION_PROXY_SERVICE_NAME};

package/lib/plist-service/index.js

@@ -11,7 +11,7 @@ const MAX_FRAME_SIZE = 1 * MB;
 
 const CHECK_FREQ_MS = 50;
 
-class PlistService extends BaseServiceSocket {
+export class PlistService extends BaseServiceSocket {
   constructor(socketClient) {
     super(socketClient);
 
@@ -78,5 +78,4 @@ class PlistService extends BaseServiceSocket {
   }
 }
 
-export {PlistService};
 export default PlistService;

package/lib/plist-service/transformer/plist-service-decoder.js

@@ -4,7 +4,7 @@ import {plist} from '@appium/support';
 
 const HEADER_LENGTH = 4;
 
-class PlistServiceDecoder extends Stream.Transform {
+export class PlistServiceDecoder extends Stream.Transform {
   constructor() {
     super({objectMode: true});
   }
@@ -27,5 +27,4 @@ class PlistServiceDecoder extends Stream.Transform {
   }
 }
 
-export {PlistServiceDecoder};
 export default PlistServiceDecoder;

package/lib/plist-service/transformer/plist-service-encoder.js

@@ -3,7 +3,7 @@ import {plist} from '@appium/support';
 
 const HEADER_LENGTH = 4;
 
-class PlistServiceEncoder extends Stream.Transform {
+export class PlistServiceEncoder extends Stream.Transform {
   constructor() {
     super({objectMode: true});
   }
@@ -21,5 +21,4 @@ class PlistServiceEncoder extends Stream.Transform {
   }
 }
 
-export {PlistServiceEncoder};
 export default PlistServiceEncoder;

package/lib/services.js

@@ -25,17 +25,35 @@ const CRASH_LOG_SERVICE_NAME = 'com.apple.crashreportcopymobile';
 const INSTRUMENT_HANDSHAKE_VERSION = 14;
 const TESTMANAGERD_HANDSHAKE_VERSION = 14;
 
-async function startSyslogService(udid, opts = {}) {
+/**
+ * Starts the syslog service.
+ * @param {string} udid
+ * @param {ServiceOpts=} opts
+ * @returns {Promise<SyslogService>}
+ */
+export async function startSyslogService(udid, opts = {}) {
   const socket = await startService(udid, SYSLOG_SERVICE_NAME, opts.socket);
   return new SyslogService(socket);
 }
 
-async function startSimulateLocationService(udid, opts = {}) {
+/**
+ * Starts the simulate-location service.
+ * @param {string} udid
+ * @param {ServiceOpts=} opts
+ * @returns {Promise<SimulateLocationService>}
+ */
+export async function startSimulateLocationService(udid, opts = {}) {
   const socket = await startService(udid, SIMULATE_LOCATION_SERVICE_NAME, opts.socket);
   return new SimulateLocationService(socket);
 }
 
-async function startWebInspectorService(udid, opts = {}) {
+/**
+ * Starts the web inspector service.
+ * @param {string} udid
+ * @param {ServiceOpts=} opts
+ * @returns {Promise<WebInspectorService>}
+ */
+export async function startWebInspectorService(udid, opts = {}) {
   const osVersion = opts.osVersion || (await getOSVersion(udid, opts.socket));
   const isSimulator = !!opts.isSimulator;
   const verbose = !!opts.verbose;
@@ -69,32 +87,68 @@ async function startWebInspectorService(udid, opts = {}) {
   });
 }
 
-async function startInstallationProxyService(udid, opts = {}) {
+/**
+ * Starts the installation proxy service.
+ * @param {string} udid
+ * @param {ServiceOpts=} opts
+ * @returns {Promise<InstallationProxyService>}
+ */
+export async function startInstallationProxyService(udid, opts = {}) {
   const socket = await startService(udid, INSTALLATION_PROXY_SERVICE_NAME, opts.socket);
   return new InstallationProxyService(new PlistService(socket));
 }
 
-async function startAfcService(udid, opts = {}) {
+/**
+ * Starts the AFC service.
+ * @param {string} udid
+ * @param {ServiceOpts=} opts
+ * @returns {Promise<AfcService>}
+ */
+export async function startAfcService(udid, opts = {}) {
   const socket = await startService(udid, AFC_SERVICE_NAME, opts.socket);
   return new AfcService(socket);
 }
 
-async function startCrashLogService(udid, opts = {}) {
+/**
+ * Starts the crash log service.
+ * @param {string} udid
+ * @param {ServiceOpts=} opts
+ * @returns {Promise<AfcService>}
+ */
+export async function startCrashLogService(udid, opts = {}) {
   const socket = await startService(udid, CRASH_LOG_SERVICE_NAME, opts.socket);
   return new AfcService(socket);
 }
 
-async function startNotificationProxyService(udid, opts = {}) {
+/**
+ * Starts the notification proxy service.
+ * @param {string} udid
+ * @param {ServiceOpts=} opts
+ * @returns {Promise<NotificationProxyService>}
+ */
+export async function startNotificationProxyService(udid, opts = {}) {
   const socket = await startService(udid, NOTIFICATION_PROXY_SERVICE_NAME, opts.socket);
   return new NotificationProxyService(socket);
 }
 
-async function startHouseArrestService(udid, opts = {}) {
+/**
+ * Starts the house arrest service.
+ * @param {string} udid
+ * @param {ServiceOpts=} opts
+ * @returns {Promise<HouseArrestService>}
+ */
+export async function startHouseArrestService(udid, opts = {}) {
   const socket = await startService(udid, HOUSE_ARREST_SERVICE_NAME, opts.socket);
   return new HouseArrestService(socket);
 }
 
-async function startInstrumentService(udid, opts = {}) {
+/**
+ * Starts the instrument service.
+ * @param {string} udid
+ * @param {ServiceOpts=} opts
+ * @returns {Promise<InstrumentService>}
+ */
+export async function startInstrumentService(udid, opts = {}) {
   const osVersion = opts.osVersion || (await getOSVersion(udid, opts.socket));
   return new InstrumentService(
     parseInt(osVersion.split('.')[0], 10) < INSTRUMENT_HANDSHAKE_VERSION
@@ -103,7 +157,13 @@ async function startInstrumentService(udid, opts = {}) {
   );
 }
 
-async function startTestmanagerdService(udid, opts = {}) {
+/**
+ * Starts the testmanagerd service.
+ * @param {string} udid
+ * @param {ServiceOpts=} opts
+ * @returns {Promise<TestmanagerdService>}
+ */
+export async function startTestmanagerdService(udid, opts = {}) {
   const osVersion = opts.osVersion || (await getOSVersion(udid, opts.socket));
   return new TestmanagerdService(
     parseInt(osVersion.split('.')[0], 10) < TESTMANAGERD_HANDSHAKE_VERSION
@@ -112,16 +172,35 @@ async function startTestmanagerdService(udid, opts = {}) {
   );
 }
 
-async function startMCInstallService(udid, opts = {}) {
+/**
+ * Starts the MCInstall proxy service.
+ * @param {string} udid
+ * @param {ServiceOpts=} opts
+ * @returns {Promise<MCInstallProxyService>}
+ */
+export async function startMCInstallService(udid, opts = {}) {
   const socket = await startService(udid, MC_INSTALL_SERVICE_NAME, opts.socket);
   return new MCInstallProxyService(new PlistService(socket));
 }
 
-async function startImageMounterService(udid, opts = {}) {
+/**
+ * Starts the image mounter service.
+ * @param {string} udid
+ * @param {ServiceOpts=} opts
+ * @returns {Promise<ImageMounter>}
+ */
+export async function startImageMounterService(udid, opts = {}) {
   const socket = await startService(udid, MOBILE_IMAGE_MOUNTER_SERVICE_NAME, opts.socket, false);
   return new ImageMounter(new PlistService(socket));
 }
 
+/**
+ * @param {string} udid
+ * @param {string} serviceName
+ * @param {import('net').Socket=} socket
+ * @param {boolean=} handshakeOnly
+ * @returns {Promise<import('net').Socket>}
+ */
 async function startService(udid, serviceName, socket, handshakeOnly = false) {
   const lockdown = await startLockdownSession(udid, socket);
   try {
@@ -136,17 +215,13 @@ async function startService(udid, serviceName, socket, handshakeOnly = false) {
   }
 }
 
-export {
-  startSyslogService,
-  startWebInspectorService,
-  startInstallationProxyService,
-  startSimulateLocationService,
-  startAfcService,
-  startCrashLogService,
-  startNotificationProxyService,
-  startHouseArrestService,
-  startInstrumentService,
-  startTestmanagerdService,
-  startMCInstallService,
-  startImageMounterService,
-};
+/**
+ * @typedef {Object} ServiceOpts
+ * @property {import('net').Socket=} socket
+ * @property {string=} osVersion
+ * @property {boolean=} isSimulator
+ * @property {boolean=} verbose
+ * @property {boolean=} verboseHexDump
+ * @property {number=} socketChunkSize
+ * @property {number=} maxFrameLength
+ */

package/lib/simulatelocation/index.js

@@ -1,11 +1,11 @@
 import {BaseServiceSocket} from '../base-service';
 
-const SIMULATE_LOCATION_SERVICE_NAME = 'com.apple.dt.simulatelocation';
+export const SIMULATE_LOCATION_SERVICE_NAME = 'com.apple.dt.simulatelocation';
 
 const RESET_MESSAGE = Buffer.from([0, 0, 0, 1]);
 const SET_LOCATION_MESSAGE = Buffer.from([0, 0, 0, 0]);
 
-class SimulateLocationService extends BaseServiceSocket {
+export class SimulateLocationService extends BaseServiceSocket {
   /**
    * Reset the mock location to the phones original settings
    */
@@ -38,5 +38,4 @@ class SimulateLocationService extends BaseServiceSocket {
   }
 }
 
-export {SimulateLocationService, SIMULATE_LOCATION_SERVICE_NAME};
 export default SimulateLocationService;

package/lib/ssl-helper.js

@@ -4,7 +4,14 @@ import B from 'bluebird';
 
 const HANDSHAKE_TIMEOUT_MS = 10000;
 
-function upgradeToSSL(socket, key, cert) {
+/**
+ * Wraps an existing socket in a TLS socket.
+ * @param {import('net').Socket} socket
+ * @param {Buffer|string} key
+ * @param {Buffer|string} cert
+ * @returns {import('node:tls').TLSSocket}
+ */
+export function upgradeToSSL(socket, key, cert) {
   return new tls.TLSSocket(socket, {
     rejectUnauthorized: false,
     secureContext: tls.createSecureContext({
@@ -21,7 +28,7 @@ function upgradeToSSL(socket, key, cert) {
  * @param cert
  * @returns {Promise<NodeJS.Socket>} Duplicate the input socket
  */
-async function enableSSLHandshakeOnly(socket, key, cert) {
+export async function enableSSLHandshakeOnly(socket, key, cert) {
   const sslSocket = tls.connect({
     socket,
     secureContext: tls.createSecureContext({
@@ -50,5 +57,3 @@ async function enableSSLHandshakeOnly(socket, key, cert) {
   // Duplicate the socket. Return a new socket object connected to the same system resource
   return new net.Socket({fd: socket._handle.fd});
 }
-
-export {upgradeToSSL, enableSSLHandshakeOnly};

package/lib/syslog/index.js

@@ -3,10 +3,10 @@ import {KB} from '../constants';
 import {BaseServiceSocket} from '../base-service';
 
 //We just need to write any data to the client. It doesn't matter what we send
-const SYSLOG_SERVICE_NAME = 'com.apple.syslog_relay';
+export const SYSLOG_SERVICE_NAME = 'com.apple.syslog_relay';
 const START_MESSAGE = 'start';
 
-class SyslogService extends BaseServiceSocket {
+export class SyslogService extends BaseServiceSocket {
   constructor(socketClient) {
     super(socketClient);
 
@@ -29,5 +29,4 @@ class SyslogService extends BaseServiceSocket {
   }
 }
 
-export {SyslogService, SYSLOG_SERVICE_NAME};
 export default SyslogService;