feat: Switch babel to typescript (#128)

* feat: Switch babel to typescript

* Fix linter

.eslintrc.json

@@ -1,11 +1,22 @@
 {
-  "extends": "@appium/eslint-config-appium",
+  "extends": ["@appium/eslint-config-appium-ts"],
   "overrides": [
     {
       "files": "test/**/*.js",
       "rules": {
-        "func-names": "off"
+        "func-names": "off",
+        "@typescript-eslint/no-var-requires": "off"
+      }
+    },
+    {
+      "files": "scripts/**/*",
+      "parserOptions": {"sourceType": "script"},
+      "rules": {
+        "@typescript-eslint/no-var-requires": "off"
       }
     }
-  ]
+  ],
+  "rules": {
+    "require-await": "error"
+  }
 }

.mocharc.js

@@ -1,4 +1,4 @@
 module.exports = {
-  require: ['@babel/register'],
+  require: ['ts-node/register'],
   forbidOnly: Boolean(process.env.CI)
 };

lib/afc/index.js

@@ -84,7 +84,7 @@ class AfcService extends BaseServiceSocket {
   /**
    * Lists a directory's contents and returns them in an array
    * @param {string} path The path in unix format
-   * @return {Array.<string>}
+   * @return {Promise<string[]>}
    */
   async listDirectory (path) {
     const {packetNumber, response} = this._createPacketPromise(`List directory '${path}'`);
@@ -107,7 +107,7 @@ class AfcService extends BaseServiceSocket {
    * Opens a file and creates a file handle
    * @param {string} path The path in unix format
    * @param {number} mode The file mode that will be used
-   * @return {number}
+   * @return {Promise<number>}
    */
   async openFile (path, mode) {
     const {packetNumber, response} = this._createPacketPromise(`Open file '${path}'`);
@@ -134,7 +134,7 @@ class AfcService extends BaseServiceSocket {
    * Opens a file and creates a nodejs write stream
    * @param {string} filePath The path in unix format
    * @param {Object} opts The regular options that are passed to a Stream.Writable
-   * @return {AfcWritableFileStream}
+   * @return {Promise<AfcWritableFileStream>}
    */
   async createWriteStream (filePath, opts) {
     const fileHandle = await this.openFile(filePath, FileModes.w);
@@ -144,8 +144,8 @@ class AfcService extends BaseServiceSocket {
   /**
    * Opens a file and creates a nodejs read stream
    * @param {string} filePath The path in unix format
-   * @param {Object} opts The regular options that are passed to a Stream.Readable
-   * @return {AfcReadableFileStream}
+   * @param {Object} options The regular options that are passed to a Stream.Readable
+   * @return {Promise<AfcReadableFileStream>}
    */
   async createReadStream (filePath, options) {
     const fileHandle = await this.openFile(filePath, FileModes.r);
@@ -198,7 +198,7 @@ class AfcService extends BaseServiceSocket {
    * Read a certain length of buffer from the file handle
    * @param {number} fileHandle The file handle to be used
    * @param {number} length The length that wants to be read from the file handle
-   * @return {Buffer}
+   * @return {Promise<Buffer>}
    */
   async readFile (fileHandle, length) {
     const {packetNumber, response} = this._createPacketPromise(`Read from file handle '${fileHandle}'`);
@@ -223,7 +223,7 @@ class AfcService extends BaseServiceSocket {
   /**
    * Get the file info of the given path
    * @param {string} path The path in unix format
-   * @return {FileInfo}
+   * @return {Promise<FileInfo>}
    */
   async getFileInfo (path) {
     const {packetNumber, response} = this._createPacketPromise(`Get file info '${path}'`);
@@ -238,6 +238,7 @@ class AfcService extends BaseServiceSocket {
     if (res.opCode !== Operations.DATA) {
       this._checkStatus(res);
     }
+    // @ts-ignore this should be ok
     return new FileInfo(this._parseObject(res.content));
   }
 

lib/house-arrest/index.js

@@ -34,7 +34,7 @@ class HouseArrestService extends BaseServiceSocket {
    * Vends into the application container and returns an AfcService
    * @param {string} bundleId The bundle id of the app container that we will enter to
    * @throws Will throw an error if house arrest fails to access the application's container
-   * @returns {AfcService}
+   * @returns {Promise<AfcService>}
    */
   async vendContainer (bundleId) {
     const responsePromise = this._receivePlistPromise();
@@ -55,7 +55,7 @@ class HouseArrestService extends BaseServiceSocket {
    * Vends into the application documents and returns an AfcService
    * @param {string} bundleId The bundle id of the app documents that we will enter to
    * @throws Will throw an error if house arrest fails to access the application's documents
-   * @returns {AfcService}
+   * @returns {Promise<AfcService>}
    */
   async vendDocuments (bundleId) {
     const responsePromise = this._receivePlistPromise();

lib/imagemounter/utils/list_developer_image.js

@@ -162,7 +162,7 @@ async function searchAndDownloadDeveloperImageFromGithub(finalVersion, fullDownl
     let fileUrl;
     const fileList = await listGithubImageList(githubImageOption);
     if (!fileList) {
-        throw new Error(`Failed to list https://github.com/${githubRepo}`);;
+        throw new Error(`Failed to list https://github.com/${githubRepo}`);
     }
     const targetFile = _.find(fileList, (item) => fileNameRegExp.test(item.path));
     const splitter = subFolderList.length > 0 ? '/' : '';

lib/installation-proxy/index.js

@@ -54,8 +54,8 @@ class InstallationProxyService extends BaseServicePlist {
 
   /**
    * Lists applications according to the opts and returns them as a map
-   * @param {ListApplicationOptions} opts the listing options that wants to be passed
-   * @returns A map of the applications which the key is the bundleId
+   * @param {Partial<ListApplicationOptions>} opts the listing options that wants to be passed
+   * @returns {Promise<Record<any, any>>} A map of the applications which the key is the bundleId
    */
   async listApplications (opts = {}) {
     const request = {
@@ -93,8 +93,8 @@ class InstallationProxyService extends BaseServicePlist {
 
   /**
    * Lists applications according to the opts and returns them as a map
-   * @param {LookupApplicationOptions} opts the lookup options that wants to be passed
-   * @returns A map of the applications which the key is the bundleId
+   * @param {Partial<LookupApplicationOptions>} opts the lookup options that wants to be passed
+   * @returns {Promise<Record<any, any>>} A map of the applications which the key is the bundleId
    */
   async lookupApplications (opts = {}) {
     const request = {
@@ -146,6 +146,7 @@ class InstallationProxyService extends BaseServicePlist {
         return messages;
       }
     }
+    return messages;
   }
 
   _isFinished (response) {

lib/instrument/headers.js

@@ -41,6 +41,7 @@ const AUX_TYPES = Object.freeze({
 
 /**
  * @typedef {Object} DTXMessageOptions
+ * @property {any} selector
  * @property {number} identifier packet transmission sequence, this value is incremented for each request
  * @property {number} channelCode the data transmission of the service will use this channel code.
  * Each service has a separate channel
@@ -52,7 +53,7 @@ const AUX_TYPES = Object.freeze({
 
 class DTXMessageHeader {
   /**
-   * @param {DTXMessageOptions} data
+   * @param {Partial<DTXMessageOptions>} data
    * @returns {Buffer} DTXMessageHeaderBuffer
    */
   static build (data) {
@@ -61,11 +62,11 @@ class DTXMessageHeader {
     messageHeader.writeUInt32LE(DTX_MESSAGE_HEADER_LENGTH, 4);
     messageHeader.writeUInt16LE(0, 8);
     messageHeader.writeUInt16LE(1, 10);
-    messageHeader.writeUInt32LE(data.payloadLength, 12);
-    messageHeader.writeUInt32LE(data.identifier, 16);
-    messageHeader.writeUInt32LE(data.conversationIndex, 20);
-    messageHeader.writeUInt32LE(data.channelCode, 24);
-    messageHeader.writeUInt32LE(data.expectsReply, 28);
+    messageHeader.writeUInt32LE(data.payloadLength ?? 0, 12);
+    messageHeader.writeUInt32LE(data.identifier ?? 0, 16);
+    messageHeader.writeUInt32LE(data.conversationIndex ?? 0, 20);
+    messageHeader.writeUInt32LE(data.channelCode ?? 0, 24);
+    messageHeader.writeUInt32LE(+(data.expectsReply ?? false), 28);
     return messageHeader;
   }
 
@@ -166,7 +167,7 @@ class DTXMessageAux {
    * Parses nskeyed Buffer into js array
    * @param {Buffer} headerBuffer
    * @param {DTXMessagePayloadHeaderObject} payloadHeader
-   * @returns {Array}
+   * @returns {any[]}
    */
   static parse (headerBuffer, payloadHeader) {
     let cursor = 0;
@@ -298,7 +299,7 @@ class DTXMessageAuxBuffer {
 
 class DTXMessage {
   /**
-   * @param {DTXMessageOptions} opts
+   * @param {Partial<DTXMessageOptions>} opts
    */
   constructor (opts = {}) {
     const {
@@ -415,6 +416,7 @@ class DTXMessage {
       return ret;
     }
     if (ret._payloadHeader.auxLength > 0) {
+      // @ts-ignore Not 100% sure if this ok
       ret.auxiliaries = DTXMessageAux.parse(payloadBuf.slice(cursor, cursor + ret._payloadHeader.auxLength), ret._payloadHeader);
       cursor += ret._payloadHeader.auxLength;
     }

lib/instrument/index.js

@@ -48,7 +48,7 @@ class InstrumentService extends BaseServiceSocket {
    * @param {import('net').Socket} socketClient  DTXMessage.selector
    * @param {DTXCallback?} event if empty will ignore any messages
    */
-  constructor(socketClient, event) {
+  constructor(socketClient, event = null) {
     super(socketClient);
     this._undefinedCallback = event;
     this._callbacks = new events.EventEmitter();
@@ -172,8 +172,8 @@ class InstrumentService extends BaseServiceSocket {
     }
     if (data.conversationIndex === 1) {
       this._replyQueues[data.identifier].push(data);
-    } else if (this._channelCallbacks.listenerCount(CHANNEL_OFFSET - data.channelCode) > 0) {
-      this._channelCallbacks.emit(CHANNEL_OFFSET - data.channelCode, data);
+    } else if (this._channelCallbacks.listenerCount(`${CHANNEL_OFFSET - data.channelCode}`) > 0) {
+      this._channelCallbacks.emit(`${CHANNEL_OFFSET - data.channelCode}`, data);
     } else {
       const selector = data.selector;
       if (_.isString(selector) && this._callbacks.listenerCount(selector) > 0) {

lib/instrument/transformer/dtx-decode.js

@@ -32,7 +32,7 @@ class DTXDecoder extends Stream.Transform {
         if (this.header.fragmentId === 0) {
           // only the 0th fragment contains a message header
           if (!(this.header.channel in this._dtxManager)) {
-            this._dtxManager[this.header.channel] = {headerBuffer, payloadBuffer: new Buffer.allocUnsafe(0)};
+            this._dtxManager[this.header.channel] = {headerBuffer, payloadBuffer: Buffer.allocUnsafe(0)};
           }
           if (this.header.fragmentCount > 1) {
             // Continue to get the next message fragments

lib/instrument/transformer/dtx-encode.js

@@ -9,7 +9,7 @@ class DTXEncoder extends Stream.Transform {
   }
 
   _transform (data, encoding, onData) {
-    this.push(this._encode(data), 'buffer');
+    this.push(this._encode(data), 'binary');
     onData();
   }
 

lib/instrument/transformer/nskeyed.js

@@ -5,6 +5,7 @@ import _ from 'lodash';
 import { format as stringFormat } from 'node:util';
 
 const NSKEYED_ARCHIVE_VERSION = 100_000;
+// @ts-ignore UID is not exposed to typedefs
 const NULL_UID = new plistlib.UID(0);
 const CYCLE_TOKEN = 'CycleToken';
 const PRIMITIVE_TYPES = ['Number', 'String', 'Boolean', 'UID', 'Buffer'];
@@ -65,16 +66,16 @@ class BaseArchiveHandler {
   /**
    * @param {ArchivedObject} archive
    */
-  // eslint-disable-next-line no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   decodeArchive(archive) {
     throw new Error(`Did not know how to decode the object`);
   }
 
   /**
-   * @param {Object} obj  an instance of this class
+   * @param {Object} obj  an instance of this §class
    * @param {ArchivingObject} archive
    */
-  // eslint-disable-next-line no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   encodeArchive(obj, archive) {
     throw new Error(`Did not know how to encode the object`);
   }
@@ -276,7 +277,7 @@ class XCTestConfiguration extends BaseArchiveHandler {
     testsToSkip: undefined,
     treatMissingBaselinesAsFailures: false,
     userAttachmentLifetime: 1
-  }
+  };
 
   /**
    * @param {XCTestConfigurationPlist} data
@@ -293,13 +294,19 @@ class XCTestConfiguration extends BaseArchiveHandler {
       data.testBundleURL = new NSURL(undefined, data.testBundleURL);
     }
     if (!(data.testBundleURL instanceof NSURL)) {
-      throw new TypeError(`Expected testBundleURL to be a valid NSURL instance, got ${data.testBundleURL.constructor.name} instead`);
+      throw new TypeError(
+        // @ts-ignore contructor is always present
+        `Expected testBundleURL to be a valid NSURL instance, got ${data.testBundleURL.constructor.name} instead`
+      );
     }
     if (typeof data.sessionIdentifier === 'string') {
       data.sessionIdentifier = new NSUUID(data.sessionIdentifier);
     }
     if (!(data.sessionIdentifier instanceof NSUUID)) {
-      throw new TypeError(`Expected sessionIdentifier to be a valid NSUUID instance, got ${data.sessionIdentifier.constructor.name} instead`);
+      throw new TypeError(
+        // @ts-ignore contructor is always present
+        `Expected sessionIdentifier to be a valid NSUUID instance, got ${data.sessionIdentifier.constructor.name} instead`
+      );
     }
     this._data = { ...XCTestConfiguration._default, ...data };
   }
@@ -432,10 +439,12 @@ class Unarchive {
 class Archive {
   constructor(inputObject) {
     this.input = inputObject;
+    /** @type {any[]} */
     this.objects = ['$null']; // objects that go directly into the archive, always start with $null
   }
 
   uidForArchiver(archiver, ...addition) {
+    // @ts-ignore UID is not exposed to typedefs
     const val = new plistlib.UID(this.objects.length);
     this.objects.push({
       $classes: [archiver, ...addition],
@@ -448,6 +457,7 @@ class Archive {
     if (_.isUndefined(obj) || _.isNull(obj)) {
       return NULL_UID;
     }
+    // @ts-ignore UID is not exposed to typedefs
     const index = new plistlib.UID(this.objects.length);
     if (PRIMITIVE_TYPES.includes(obj.constructor.name)) {
       this.objects.push(obj);
@@ -522,6 +532,7 @@ class Archive {
     const d = {
       $version: NSKEYED_ARCHIVE_VERSION,
       $archiver: NSKEYEDARCHIVER,
+      // @ts-ignore UID is not exposed to typedefs
       $top: { root: new plistlib.UID(1) },
       $objects: this.objects
     };
@@ -553,6 +564,7 @@ function unarchive(inputBytes) {
  * @param {BaseArchiveHandler} subClass inherit from BaseArchiveHandler class
  */
 function updateNSKeyedArchiveClass(name, subClass) {
+  // @ts-ignore prototype always exists
   if (!_.isFunction(subClass.prototype?.decodeArchive) && !_.isFunction(subClass.prototype?.encodeArchive)) {
     throw new Error('subClass must have decodeArchive or encodeArchive methods');
   }