appium-xcode 6.0.2 → 6.1.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [6.1.0](https://github.com/appium/appium-xcode/compare/v6.0.2...v6.1.0) (2025-10-14)
+
+### Features
+
+* Port to typescript ([#156](https://github.com/appium/appium-xcode/issues/156)) ([c17d76b](https://github.com/appium/appium-xcode/commit/c17d76b199c91bf4009bfefc27e6e1098f526386))
+
 ## [6.0.2](https://github.com/appium/appium-xcode/compare/v6.0.1...v6.0.2) (2025-10-09)
 
 ### Bug Fixes

package/build/lib/helpers.d.ts

@@ -1,25 +1,26 @@
+import type { TeenProcessExecResult } from 'teen_process';
+export declare const XCRUN_TIMEOUT = 15000;
 /**
  * Executes 'xcrun' command line utility
  *
- * @param {string[]} args xcrun arguments
- * @param {number} timeout [15000] The maximum number of milliseconds to wait until xcrun exists
- * @returns {Promise<import("teen_process").TeenProcessExecResult>} The result of xcrun execution
+ * @param args xcrun arguments
+ * @param timeout The maximum number of milliseconds to wait until xcrun exists
+ * @returns The result of xcrun execution
  * @throws {Error} If xcrun returned non-zero exit code or timed out
  */
-export function runXcrunCommand(args: string[], timeout?: number): Promise<import("teen_process").TeenProcessExecResult<any>>;
+export declare function runXcrunCommand(args: string[], timeout?: number): Promise<TeenProcessExecResult<string>>;
 /**
  * Uses macOS Spotlight service to detect where the given app is installed
  *
- * @param {string} bundleId Bundle identifier of the target app
- * @returns {Promise<string[]>} Full paths to where the app with the given bundle id is present.
+ * @param bundleId Bundle identifier of the target app
+ * @returns Full paths to where the app with the given bundle id is present.
  */
-export function findAppPaths(bundleId: string): Promise<string[]>;
+export declare function findAppPaths(bundleId: string): Promise<string[]>;
 /**
  * Finds and retrieves the content of the Xcode's Info.plist file
  *
- * @param {string} developerRoot Full path to the Contents/Developer folder under Xcode.app root
- * @returns {Promise<object>} All plist entries as an object or an empty object if no plist was found
+ * @param developerRoot Full path to the Contents/Developer folder under Xcode.app root
+ * @returns All plist entries as an object or an empty object if no plist was found
  */
-export function readXcodePlist(developerRoot: string): Promise<object>;
-export const XCRUN_TIMEOUT: 15000;
+export declare function readXcodePlist(developerRoot: string): Promise<Record<string, any>>;
 //# sourceMappingURL=helpers.d.ts.map

package/build/lib/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../lib/helpers.js"],"names":[],"mappings":"AAQA;;;;;;;GAOG;AACH,sCALW,MAAM,EAAE,YACR,MAAM,GACJ,OAAO,CAAC,iDAA4C,CAAC,CAcjE;AAED;;;;;GAKG;AACH,uCAHW,MAAM,GACJ,OAAO,CAAC,MAAM,EAAE,CAAC,CAyB7B;AAED;;;;;GAKG;AACH,8CAHW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAO3B;AAjED,4BAA6B,KAAK,CAAC"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../lib/helpers.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAI1D,eAAO,MAAM,aAAa,QAAQ,CAAC;AAEnC;;;;;;;GAOG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,MAAsB,GAAG,OAAO,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAW7H;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAuBtE;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAKxF"}

package/build/lib/helpers.js

@@ -11,14 +11,14 @@ const lodash_1 = __importDefault(require("lodash"));
 const bluebird_1 = __importDefault(require("bluebird"));
 const teen_process_1 = require("teen_process");
 const support_1 = require("@appium/support");
-const path_1 = __importDefault(require("path"));
+const node_path_1 = __importDefault(require("node:path"));
 exports.XCRUN_TIMEOUT = 15000;
 /**
  * Executes 'xcrun' command line utility
  *
- * @param {string[]} args xcrun arguments
- * @param {number} timeout [15000] The maximum number of milliseconds to wait until xcrun exists
- * @returns {Promise<import("teen_process").TeenProcessExecResult>} The result of xcrun execution
+ * @param args xcrun arguments
+ * @param timeout The maximum number of milliseconds to wait until xcrun exists
+ * @returns The result of xcrun execution
  * @throws {Error} If xcrun returned non-zero exit code or timed out
  */
 async function runXcrunCommand(args, timeout = exports.XCRUN_TIMEOUT) {
@@ -36,8 +36,8 @@ async function runXcrunCommand(args, timeout = exports.XCRUN_TIMEOUT) {
 /**
  * Uses macOS Spotlight service to detect where the given app is installed
  *
- * @param {string} bundleId Bundle identifier of the target app
- * @returns {Promise<string[]>} Full paths to where the app with the given bundle id is present.
+ * @param bundleId Bundle identifier of the target app
+ * @returns Full paths to where the app with the given bundle id is present.
  */
 async function findAppPaths(bundleId) {
     let stdout;
@@ -61,16 +61,16 @@ async function findAppPaths(bundleId) {
             return p;
         }
     })());
-    return /** @type {string[]} */ (await bluebird_1.default.all(results)).filter(Boolean);
+    return (await bluebird_1.default.all(results)).filter(Boolean);
 }
 /**
  * Finds and retrieves the content of the Xcode's Info.plist file
  *
- * @param {string} developerRoot Full path to the Contents/Developer folder under Xcode.app root
- * @returns {Promise<object>} All plist entries as an object or an empty object if no plist was found
+ * @param developerRoot Full path to the Contents/Developer folder under Xcode.app root
+ * @returns All plist entries as an object or an empty object if no plist was found
  */
 async function readXcodePlist(developerRoot) {
-    const plistPath = path_1.default.resolve(developerRoot, '..', 'Info.plist');
+    const plistPath = node_path_1.default.resolve(developerRoot, '..', 'Info.plist');
     return await support_1.fs.exists(plistPath)
         ? await support_1.plist.parsePlistFile(plistPath)
         : {};

package/build/lib/helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../lib/helpers.js"],"names":[],"mappings":";;;;;;AAgBA,0CAWC;AAQD,oCAuBC;AAQD,wCAKC;AAvED,oDAAuB;AACvB,wDAAyB;AACzB,+CAAoC;AACpC,6CAA4C;AAC5C,gDAAwB;AAEX,QAAA,aAAa,GAAG,KAAK,CAAC;AAEnC;;;;;;;GAOG;AACI,KAAK,UAAU,eAAe,CAAE,IAAI,EAAE,OAAO,GAAG,qBAAa;IAClE,IAAI,CAAC;QACH,OAAO,MAAM,IAAA,mBAAI,EAAC,OAAO,EAAE,IAAI,EAAE,EAAC,OAAO,EAAC,CAAC,CAAC;IAC9C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,iDAAiD;QACjD,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACf,GAAG,CAAC,OAAO,GAAG,GAAG,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,MAAM,EAAE,CAAC;QAChD,CAAC;QAED,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAAE,QAAQ;IAC1C,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,CAAC,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,iBAAiB,EAAE;YACxC,6BAA6B,QAAQ,EAAE;SACxC,CAAC,CAAC,CAAC;IACN,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,YAAY,GAAG,gBAAC,CAAC,IAAI,CAAC,MAAM,CAAC;SAChC,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,gBAAC,CAAC,IAAI,CAAC;SACX,MAAM,CAAC,OAAO,CAAC,CAAC;IACnB,IAAI,gBAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,EAAE;QAClD,IAAI,MAAM,YAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YACvB,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC,CAAC,EAAE,CAAC,CAAC;IACN,OAAO,uBAAuB,CAAA,CAAC,MAAM,kBAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AACvE,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,cAAc,CAAE,aAAa;IACjD,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IAClE,OAAO,MAAM,YAAE,CAAC,MAAM,CAAC,SAAS,CAAC;QAC/B,CAAC,CAAC,MAAM,eAAK,CAAC,cAAc,CAAC,SAAS,CAAC;QACvC,CAAC,CAAC,EAAE,CAAC;AACT,CAAC"}
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../lib/helpers.ts"],"names":[],"mappings":";;;;;;AAiBA,0CAWC;AAQD,oCAuBC;AAQD,wCAKC;AAxED,oDAAuB;AACvB,wDAAyB;AACzB,+CAAoC;AAEpC,6CAA4C;AAC5C,0DAA6B;AAEhB,QAAA,aAAa,GAAG,KAAK,CAAC;AAEnC;;;;;;;GAOG;AACI,KAAK,UAAU,eAAe,CAAC,IAAc,EAAE,UAAkB,qBAAa;IACnF,IAAI,CAAC;QACH,OAAO,MAAM,IAAA,mBAAI,EAAC,OAAO,EAAE,IAAI,EAAE,EAAC,OAAO,EAAC,CAAC,CAAC;IAC9C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,iDAAiD;QACjD,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACf,GAAG,CAAC,OAAO,GAAG,GAAG,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,MAAM,EAAE,CAAC;QAChD,CAAC;QAED,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAAC,QAAgB;IACjD,IAAI,MAAc,CAAC;IACnB,IAAI,CAAC;QACH,CAAC,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,iBAAiB,EAAE;YACxC,6BAA6B,QAAQ,EAAE;SACxC,CAAC,CAAC,CAAC;IACN,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,YAAY,GAAG,gBAAC,CAAC,IAAI,CAAC,MAAM,CAAC;SAChC,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,gBAAC,CAAC,IAAI,CAAC;SACX,MAAM,CAAC,OAAO,CAAC,CAAC;IACnB,IAAI,gBAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,EAAE;QAClD,IAAI,MAAM,YAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YACvB,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC,CAAC,EAAE,CAAC,CAAC;IACN,OAAO,CAAC,MAAM,kBAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAa,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,cAAc,CAAC,aAAqB;IACxD,MAAM,SAAS,GAAG,mBAAI,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IAClE,OAAO,MAAM,YAAE,CAAC,MAAM,CAAC,SAAS,CAAC;QAC/B,CAAC,CAAC,MAAM,eAAK,CAAC,cAAc,CAAC,SAAS,CAAC;QACvC,CAAC,CAAC,EAAE,CAAC;AACT,CAAC"}

package/build/lib/index.d.ts

@@ -1,16 +1,12 @@
-export default xcode;
-export type XcodeVersion = import("./xcode").XcodeVersion;
-import { getPath } from './xcode';
-import { getVersion } from './xcode';
-import { getMaxIOSSDK } from './xcode';
-import { getMaxTVOSSDK } from './xcode';
-import { getClangVersion } from './xcode';
-declare namespace xcode {
-    export { getPath };
-    export { getVersion };
-    export { getMaxIOSSDK };
-    export { getMaxTVOSSDK };
-    export { getClangVersion };
-}
+import { getPath, getVersion, getMaxIOSSDK, getMaxTVOSSDK, getClangVersion } from './xcode';
+declare const xcode: {
+    getPath: ((timeout?: number) => Promise<string>) & import("lodash").MemoizedFunction;
+    getVersion: typeof getVersion;
+    getMaxIOSSDK: ((retries?: number, timeout?: number) => Promise<string | null>) & import("lodash").MemoizedFunction;
+    getMaxTVOSSDK: ((retries?: number, timeout?: number) => Promise<string>) & import("lodash").MemoizedFunction;
+    getClangVersion: typeof getClangVersion;
+};
 export { getPath, getVersion, getMaxIOSSDK, getMaxTVOSSDK, getClangVersion };
+export default xcode;
+export type { XcodeVersion } from './types';
 //# sourceMappingURL=index.d.ts.map

package/build/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.js"],"names":[],"mappings":";2BA2Ba,OAAO,SAAS,EAAE,YAAY;wBApBpC,SAAS;2BAAT,SAAS;6BAAT,SAAS;8BAAT,SAAS;gCAAT,SAAS"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,OAAO,EACP,UAAU,EACV,YAAY,EACZ,aAAa,EACb,eAAe,EAChB,MAAM,SAAS,CAAC;AAEjB,QAAA,MAAM,KAAK;;;;;;CAMV,CAAC;AAEF,OAAO,EACL,OAAO,EACP,UAAU,EACV,YAAY,EACZ,aAAa,EACb,eAAe,EAChB,CAAC;AACF,eAAe,KAAK,CAAC;AAErB,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC"}

package/build/lib/index.js

@@ -16,7 +16,4 @@ const xcode = {
     getClangVersion: xcode_1.getClangVersion
 };
 exports.default = xcode;
-/**
- * @typedef {import('./xcode').XcodeVersion} XcodeVersion
- */
 //# sourceMappingURL=index.js.map

package/build/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.js"],"names":[],"mappings":";;;AAAA,iBAAiB;AACjB,mCAMiB;AAWf,wFAhBA,eAAO,OAgBA;AACP,2FAhBA,kBAAU,OAgBA;AACV,6FAhBA,oBAAY,OAgBA;AACZ,8FAhBA,qBAAa,OAgBA;AACb,gGAhBA,uBAAe,OAgBA;AAbjB,MAAM,KAAK,GAAG;IACZ,OAAO,EAAP,eAAO;IACP,UAAU,EAAV,kBAAU;IACV,YAAY,EAAZ,oBAAY;IACZ,aAAa,EAAb,qBAAa;IACb,eAAe,EAAf,uBAAe;CAChB,CAAC;AASF,kBAAe,KAAK,CAAC;AAErB;;GAEG"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";;;AAAA,iBAAiB;AACjB,mCAMiB;AAWf,wFAhBA,eAAO,OAgBA;AACP,2FAhBA,kBAAU,OAgBA;AACV,6FAhBA,oBAAY,OAgBA;AACZ,8FAhBA,qBAAa,OAgBA;AACb,gGAhBA,uBAAe,OAgBA;AAbjB,MAAM,KAAK,GAAG;IACZ,OAAO,EAAP,eAAO;IACP,UAAU,EAAV,kBAAU;IACV,YAAY,EAAZ,oBAAY;IACZ,aAAa,EAAb,qBAAa;IACb,eAAe,EAAf,uBAAe;CAChB,CAAC;AASF,kBAAe,KAAK,CAAC"}

package/build/lib/types.d.ts

@@ -0,0 +1,9 @@
+export interface XcodeVersion {
+    versionString: string;
+    versionFloat: number;
+    major: number;
+    minor: number;
+    patch?: number;
+    toString(): string;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,IAAI,MAAM,CAAC;CACpB"}

package/build/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":""}

package/build/lib/xcode.d.ts

@@ -1,111 +1,81 @@
-export type XcodeVersion = {
-    /**
-     * Xcode version as a string
-     */
-    versionString: string;
-    /**
-     * Xcode version as a float number
-     */
-    versionFloat: number;
-    /**
-     * Major number of Xcode version
-     */
-    major: number;
-    /**
-     * Minor number of Xcode version
-     */
-    minor: number;
-    /**
-     * Patch number of Xcode version (if exists)
-     */
-    patch?: number | undefined;
-    /**
-     * Returns Xcode version as a string
-     */
-    toString: () => string;
-};
+import _ from 'lodash';
+import type { XcodeVersion } from './types';
+/**
+ * Retrieves the full path to Xcode Developer subfolder via xcode-select
+ *
+ * @param timeout The maximum timeout for xcode-select execution
+ * @returns Full path to Xcode Developer subfolder
+ * @throws {Error} If it is not possible to retrieve a proper path
+ */
+export declare function getPathFromXcodeSelect(timeout?: number): Promise<string>;
+/**
+ * Retrieves the full path to Xcode Developer subfolder via `DEVELOPER_DIR` environment variable
+ *
+ * @returns Full path to Xcode Developer subfolder
+ * @throws {Error} If it is not possible to retrieve a proper path
+ * @privateRemarks This method assumes `DEVELOPER_DIR` is defined.
+ */
+export declare function getPathFromDeveloperDir(): Promise<string>;
 /**
  * Retrieves the full path to Xcode Developer subfolder.
  * If `DEVELOPER_DIR` environment variable is provided then its value has a priority.
- * @param {number} timeout The maximum timeout for xcode-select execution
- * @returns {Promise<string>} Full path to Xcode Developer subfolder timeout
+ * @param timeout The maximum timeout for xcode-select execution
+ * @returns Full path to Xcode Developer subfolder timeout
  * @throws {Error} If there was an error while retrieving the path.
  */
-export const getPath: ((timeout?: number) => Promise<string>) & _.MemoizedFunction;
-/**
- * @typedef {Object} XcodeVersion
- * @property {string} versionString Xcode version as a string
- * @property {number} versionFloat Xcode version as a float number
- * @property {number} major Major number of Xcode version
- * @property {number} minor Minor number of Xcode version
- * @property {number} [patch] Patch number of Xcode version (if exists)
- * @property {() => string} toString Returns Xcode version as a string
- */
+export declare const getPath: ((timeout?: number) => Promise<string>) & _.MemoizedFunction;
 /**
  * Retrieves Xcode version
  *
- * @param {boolean} parse [false] Whether to parse the version to a XcodeVersion version
- * @param {number} retries [2] How many retries to apply for getting the version number
- * @param {number} timeout [15000] Timeout of milliseconds to wait for terminal commands
- * @returns {Promise<XcodeVersion | string>} Xcode version depending on the value of `parse` flag
+ * @param parse Whether to parse the version to a XcodeVersion version
+ * @param retries How many retries to apply for getting the version number
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @returns Xcode version depending on the value of `parse` flag
  * @throws {Error} If there was a failure while retrieving the version
  */
-export function getVersion(parse?: boolean, retries?: number, timeout?: number): Promise<XcodeVersion | string>;
+export declare function getVersion(parse: false, retries?: number, timeout?: number): Promise<string>;
+export declare function getVersion(parse: true, retries?: number, timeout?: number): Promise<XcodeVersion>;
 /**
- * Retrieves the maximum version of iOS SDK supported by the installed Xcode
+ * Check https://trac.macports.org/wiki/XcodeVersionInfo
+ * to see the actual mapping between clang and other components.
  *
- * @param {number} timeout Timeout of milliseconds to wait for terminal commands
- * @param {number} retries The maximum number of retries
- * @returns {string} The SDK version
- * @throws {Error} If the SDK version number cannot be determined
+ * @returns The actual Clang version in x.x.x.x or x.x.x format,
+ * which is supplied with Command Line Tools. `null` is returned
+ * if CLT are not installed.
  */
-export const getMaxIOSSDK: ((retries?: any, timeout?: any) => Promise<string | null>) & _.MemoizedFunction;
+export declare function getClangVersion(): Promise<string | null>;
 /**
  * Retrieves the maximum version of iOS SDK supported by the installed Xcode
  *
- * @param {number} timeout [15000] Timeout of milliseconds to wait for terminal commands
- * @returns {Promise<string>} The SDK version
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @returns The SDK version
  * @throws {Error} If the SDK version number cannot be determined
  */
-export function getMaxIOSSDKWithoutRetry(timeout?: number): Promise<string>;
+export declare function getMaxIOSSDKWithoutRetry(timeout?: number): Promise<string>;
 /**
- * Retrieves the maximum version of tvOS SDK supported by the installed Xcode
+ * Retrieves the maximum version of iOS SDK supported by the installed Xcode
  *
+ * @param retries The maximum number of retries
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @returns The SDK version
  * @throws {Error} If the SDK version number cannot be determined
  */
-export const getMaxTVOSSDK: ((retries?: number, timeout?: number) => Promise<string>) & _.MemoizedFunction;
+export declare const getMaxIOSSDK: ((retries?: number, timeout?: number) => Promise<string | null>) & _.MemoizedFunction;
 /**
  * Retrieves the maximum version of tvOS SDK supported by the installed Xcode
  *
- * @param {number} timeout Timeout of milliseconds to wait for terminal commands
- * @returns {Promise<string>} The SDK version
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @returns The SDK version
  * @throws {Error} If the SDK version number cannot be determined
  */
-export function getMaxTVOSSDKWithoutRetry(timeout?: number): Promise<string>;
-/**
- * Check https://trac.macports.org/wiki/XcodeVersionInfo
- * to see the actual mapping between clang and other components.
- *
- * @returns {Promise<string|null>} The actual Clang version in x.x.x.x or x.x.x format,
- * which is supplied with Command Line Tools. `null` is returned
- * if CLT are not installed.
- */
-export function getClangVersion(): Promise<string | null>;
-/**
- * Retrieves the full path to Xcode Developer subfolder via `DEVELOPER_DIR` environment variable
- *
- * @returns {Promise<string>} Full path to Xcode Developer subfolder
- * @throws {Error} If it is not possible to retrieve a proper path
- * @privateRemarks This method assumes `DEVELOPER_DIR` is defined.
- */
-export function getPathFromDeveloperDir(): Promise<string>;
+export declare function getMaxTVOSSDKWithoutRetry(timeout?: number): Promise<string>;
 /**
- * Retrieves the full path to Xcode Developer subfolder via xcode-select
+ * Retrieves the maximum version of tvOS SDK supported by the installed Xcode
  *
- * @param {number} timeout The maximum timeout for xcode-select execution
- * @returns {Promise<string>} Full path to Xcode Developer subfolder
- * @throws {Error} If it is not possible to retrieve a proper path
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @param retries The maximum number of retries
+ * @returns The SDK version
+ * @throws {Error} If the SDK version number cannot be determined
  */
-export function getPathFromXcodeSelect(timeout?: number): Promise<string>;
-import _ from 'lodash';
+export declare const getMaxTVOSSDK: ((retries?: number, timeout?: number) => Promise<string>) & _.MemoizedFunction;
 //# sourceMappingURL=xcode.d.ts.map

package/build/lib/xcode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"xcode.d.ts","sourceRoot":"","sources":["../../lib/xcode.js"],"names":[],"mappings":";;;;mBA+Hc,MAAM;;;;kBACN,MAAM;;;;WACN,MAAM;;;;WACN,MAAM;;;;;;;;cAEN,MAAM,MAAM;;AAjD1B;;;;;;GAMG;AACH,kCAEa,MAAM,KACJ,OAAO,CAAC,MAAM,CAAC,uBAE0F;AA8BxH;;;;;;;;GAQG;AAEH;;;;;;;;GAQG;AACH,mCANW,OAAO,YACP,MAAM,YACN,MAAM,GACJ,OAAO,CAAC,YAAY,GAAG,MAAM,CAAC,CAsB1C;AA6CD;;;;;;;GAOG;AACH,2GAIE;AA9BF;;;;;;GAMG;AACH,mDAJW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAY3B;AAiCD;;;;GAIG;AACH,wCAGa,MAAM,YADN,MAAM,KAEJ,OAAO,CAAC,MAAM,CAAC,uBAK5B;AA/BF;;;;;;GAMG;AACH,oDAJW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAW3B;AAxED;;;;;;;GAOG;AACH,mCAJa,OAAO,CAAC,MAAM,GAAC,IAAI,CAAC,CAmBhC;AA9HD;;;;;;GAMG;AACH,2CAJa,OAAO,CAAC,MAAM,CAAC,CAgB3B;AAlED;;;;;;GAMG;AACH,iDAJW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAyC3B;cAzDa,QAAQ"}
+{"version":3,"file":"xcode.d.ts","sourceRoot":"","sources":["../../lib/xcode.ts"],"names":[],"mappings":"AAGA,OAAO,CAAC,MAAM,QAAQ,CAAC;AAMvB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAO5C;;;;;;GAMG;AACH,wBAAsB,sBAAsB,CAAC,OAAO,GAAE,MAAsB,GAAG,OAAO,CAAC,MAAM,CAAC,CAkC7F;AAED;;;;;;GAMG;AACH,wBAAsB,uBAAuB,IAAI,OAAO,CAAC,MAAM,CAAC,CAgB/D;AAED;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,cACR,MAAM,KAAmB,OAAO,CAAC,MAAM,CAAC,sBAEnD,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAsB,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AACpG,wBAAsB,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAsBzG;;;;;;;GAOG;AACH,wBAAsB,eAAe,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAe9D;AAED;;;;;;GAMG;AACH,wBAAsB,wBAAwB,CAAC,OAAO,GAAE,MAAsB,GAAG,OAAO,CAAC,MAAM,CAAC,CAS/F;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,cACQ,MAAM,YAAuC,MAAM,iDAGnF,CAAC;AAEF;;;;;;GAMG;AACH,wBAAsB,yBAAyB,CAAC,OAAO,GAAE,MAAsB,GAAG,OAAO,CAAC,MAAM,CAAC,CAQhG;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,cACc,MAAM,YAAuC,MAAM,KAAmB,OAAO,CAAC,MAAM,CAAC,sBAG5H,CAAC"}

package/build/lib/xcode.js

@@ -37,14 +37,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getMaxTVOSSDK = exports.getMaxIOSSDK = exports.getPath = void 0;
+exports.getPathFromXcodeSelect = getPathFromXcodeSelect;
+exports.getPathFromDeveloperDir = getPathFromDeveloperDir;
 exports.getVersion = getVersion;
+exports.getClangVersion = getClangVersion;
 exports.getMaxIOSSDKWithoutRetry = getMaxIOSSDKWithoutRetry;
 exports.getMaxTVOSSDKWithoutRetry = getMaxTVOSSDKWithoutRetry;
-exports.getClangVersion = getClangVersion;
-exports.getPathFromDeveloperDir = getPathFromDeveloperDir;
-exports.getPathFromXcodeSelect = getPathFromXcodeSelect;
 const support_1 = require("@appium/support");
-const path_1 = __importDefault(require("path"));
+const node_path_1 = __importDefault(require("node:path"));
 const asyncbox_1 = require("asyncbox");
 const lodash_1 = __importDefault(require("lodash"));
 const teen_process_1 = require("teen_process");
@@ -56,21 +56,17 @@ const log = support_1.logger.getLogger('Xcode');
 /**
  * Retrieves the full path to Xcode Developer subfolder via xcode-select
  *
- * @param {number} timeout The maximum timeout for xcode-select execution
- * @returns {Promise<string>} Full path to Xcode Developer subfolder
+ * @param timeout The maximum timeout for xcode-select execution
+ * @returns Full path to Xcode Developer subfolder
  * @throws {Error} If it is not possible to retrieve a proper path
  */
 async function getPathFromXcodeSelect(timeout = helpers_1.XCRUN_TIMEOUT) {
-    /**
-     * @param {string} prefix
-     * @returns {Promise<string>}
-     */
     const generateErrorMessage = async (prefix) => {
         const xcodePaths = await (0, helpers_1.findAppPaths)(XCODE_BUNDLE_ID);
         if (lodash_1.default.isEmpty(xcodePaths)) {
             return `${prefix}. Consider installing Xcode to address this issue.`;
         }
-        const proposals = xcodePaths.map((p) => `    sudo xcode-select -s "${path_1.default.join(p, 'Contents', 'Developer')}"`);
+        const proposals = xcodePaths.map((p) => `    sudo xcode-select -s "${node_path_1.default.join(p, 'Contents', 'Developer')}"`);
         return `${prefix}. ` +
             `Consider running${proposals.length > 1 ? ' any of' : ''}:\n${proposals.join('\n')}\nto address this issue.`;
     };
@@ -100,12 +96,15 @@ async function getPathFromXcodeSelect(timeout = helpers_1.XCRUN_TIMEOUT) {
 /**
  * Retrieves the full path to Xcode Developer subfolder via `DEVELOPER_DIR` environment variable
  *
- * @returns {Promise<string>} Full path to Xcode Developer subfolder
+ * @returns Full path to Xcode Developer subfolder
  * @throws {Error} If it is not possible to retrieve a proper path
  * @privateRemarks This method assumes `DEVELOPER_DIR` is defined.
  */
 async function getPathFromDeveloperDir() {
-    const developerRoot = /** @type {string} */ (process.env.DEVELOPER_DIR);
+    const developerRoot = process.env.DEVELOPER_DIR;
+    if (!developerRoot) {
+        throw new Error('DEVELOPER_DIR environment variable is not set');
+    }
     const { CFBundleIdentifier } = await (0, helpers_1.readXcodePlist)(developerRoot);
     if (CFBundleIdentifier === XCODE_BUNDLE_ID) {
         return developerRoot;
@@ -117,61 +116,13 @@ async function getPathFromDeveloperDir() {
 /**
  * Retrieves the full path to Xcode Developer subfolder.
  * If `DEVELOPER_DIR` environment variable is provided then its value has a priority.
- * @param {number} timeout The maximum timeout for xcode-select execution
- * @returns {Promise<string>} Full path to Xcode Developer subfolder timeout
+ * @param timeout The maximum timeout for xcode-select execution
+ * @returns Full path to Xcode Developer subfolder timeout
  * @throws {Error} If there was an error while retrieving the path.
  */
-const getPath = lodash_1.default.memoize(
-/**
- * @param {number} timeout
- * @returns {Promise<string>}
- */
-(timeout = helpers_1.XCRUN_TIMEOUT) => process.env.DEVELOPER_DIR ? getPathFromDeveloperDir() : getPathFromXcodeSelect(timeout));
-exports.getPath = getPath;
-/**
- * Retrieves Xcode version
- *
- * @param {number} timeout [15000] Timeout of milliseconds to wait for terminal commands.
- * @returns {Promise<import("semver").SemVer | null>} Xcode version
- * @throws {Error} If there was a failure while retrieving the version
- */
-async function getVersionWithoutRetry(timeout = helpers_1.XCRUN_TIMEOUT) {
-    const developerPath = await getPath(timeout);
-    // we want to read the CFBundleShortVersionString from Xcode's plist.
-    const { CFBundleShortVersionString } = await (0, helpers_1.readXcodePlist)(developerPath);
-    return semver.coerce(CFBundleShortVersionString);
-}
-/**
- * Retrieves Xcode version or the cached one if called more than once
- *
- * @param {number} retries  How many retries to apply for version retrieval
- * @param {number} timeout Timeout of milliseconds to wait for terminal commands
- * @returns {Promise<import("semver").SemVer | null>} Xcode version
- * @throws {Error} If there was a failure while retrieving the version
- */
-const getVersionMemoized = lodash_1.default.memoize(function getVersionMemoized(retries = DEFAULT_NUMBER_OF_RETRIES, timeout = helpers_1.XCRUN_TIMEOUT) {
-    return (0, asyncbox_1.retry)(retries, getVersionWithoutRetry, timeout);
-});
-/**
- * @typedef {Object} XcodeVersion
- * @property {string} versionString Xcode version as a string
- * @property {number} versionFloat Xcode version as a float number
- * @property {number} major Major number of Xcode version
- * @property {number} minor Minor number of Xcode version
- * @property {number} [patch] Patch number of Xcode version (if exists)
- * @property {() => string} toString Returns Xcode version as a string
- */
-/**
- * Retrieves Xcode version
- *
- * @param {boolean} parse [false] Whether to parse the version to a XcodeVersion version
- * @param {number} retries [2] How many retries to apply for getting the version number
- * @param {number} timeout [15000] Timeout of milliseconds to wait for terminal commands
- * @returns {Promise<XcodeVersion | string>} Xcode version depending on the value of `parse` flag
- * @throws {Error} If there was a failure while retrieving the version
- */
+exports.getPath = lodash_1.default.memoize((timeout = helpers_1.XCRUN_TIMEOUT) => process.env.DEVELOPER_DIR ? getPathFromDeveloperDir() : getPathFromXcodeSelect(timeout));
 async function getVersion(parse = false, retries = DEFAULT_NUMBER_OF_RETRIES, timeout = helpers_1.XCRUN_TIMEOUT) {
-    const version = /** @type {import('semver').SemVer} */ (await getVersionMemoized(retries, timeout));
+    const version = await getVersionMemoized(retries, timeout);
     // xcode version strings are not exactly semver string: patch versions of 0
     // are removed (e.g., '10.0.0' => '10.0')
     const versionString = version.patch > 0 ? version.version : `${version.major}.${version.minor}`;
@@ -193,7 +144,7 @@ async function getVersion(parse = false, retries = DEFAULT_NUMBER_OF_RETRIES, ti
  * Check https://trac.macports.org/wiki/XcodeVersionInfo
  * to see the actual mapping between clang and other components.
  *
- * @returns {Promise<string|null>} The actual Clang version in x.x.x.x or x.x.x format,
+ * @returns The actual Clang version in x.x.x.x or x.x.x format,
  * which is supplied with Command Line Tools. `null` is returned
  * if CLT are not installed.
  */
@@ -217,8 +168,8 @@ async function getClangVersion() {
 /**
  * Retrieves the maximum version of iOS SDK supported by the installed Xcode
  *
- * @param {number} timeout [15000] Timeout of milliseconds to wait for terminal commands
- * @returns {Promise<string>} The SDK version
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @returns The SDK version
  * @throws {Error} If the SDK version number cannot be determined
  */
 async function getMaxIOSSDKWithoutRetry(timeout = helpers_1.XCRUN_TIMEOUT) {
@@ -234,20 +185,19 @@ async function getMaxIOSSDKWithoutRetry(timeout = helpers_1.XCRUN_TIMEOUT) {
 /**
  * Retrieves the maximum version of iOS SDK supported by the installed Xcode
  *
- * @param {number} timeout Timeout of milliseconds to wait for terminal commands
- * @param {number} retries The maximum number of retries
- * @returns {string} The SDK version
+ * @param retries The maximum number of retries
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @returns The SDK version
  * @throws {Error} If the SDK version number cannot be determined
  */
-const getMaxIOSSDK = lodash_1.default.memoize(function getMaxIOSSDK(retries = DEFAULT_NUMBER_OF_RETRIES, timeout = helpers_1.XCRUN_TIMEOUT) {
+exports.getMaxIOSSDK = lodash_1.default.memoize(function getMaxIOSSDK(retries = DEFAULT_NUMBER_OF_RETRIES, timeout = helpers_1.XCRUN_TIMEOUT) {
     return (0, asyncbox_1.retry)(retries, getMaxIOSSDKWithoutRetry, timeout);
 });
-exports.getMaxIOSSDK = getMaxIOSSDK;
 /**
  * Retrieves the maximum version of tvOS SDK supported by the installed Xcode
  *
- * @param {number} timeout Timeout of milliseconds to wait for terminal commands
- * @returns {Promise<string>} The SDK version
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @returns The SDK version
  * @throws {Error} If the SDK version number cannot be determined
  */
 async function getMaxTVOSSDKWithoutRetry(timeout = helpers_1.XCRUN_TIMEOUT) {
@@ -262,16 +212,37 @@ async function getMaxTVOSSDKWithoutRetry(timeout = helpers_1.XCRUN_TIMEOUT) {
 /**
  * Retrieves the maximum version of tvOS SDK supported by the installed Xcode
  *
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @param retries The maximum number of retries
+ * @returns The SDK version
  * @throws {Error} If the SDK version number cannot be determined
  */
-const getMaxTVOSSDK = lodash_1.default.memoize(
+exports.getMaxTVOSSDK = lodash_1.default.memoize(async function getMaxTVOSSDK(retries = DEFAULT_NUMBER_OF_RETRIES, timeout = helpers_1.XCRUN_TIMEOUT) {
+    return await (0, asyncbox_1.retry)(retries, getMaxTVOSSDKWithoutRetry, timeout);
+});
+// Private helper functions
 /**
- * @param {number} timeout Timeout of milliseconds to wait for terminal commands
- * @param {number} retries The maximum number of retries
- * @returns {Promise<string>} The SDK version
+ * Retrieves Xcode version
+ *
+ * @param timeout Timeout of milliseconds to wait for terminal commands.
+ * @returns Xcode version
+ * @throws {Error} If there was a failure while retrieving the version
  */
-async function getMaxTVOSSDK(retries = DEFAULT_NUMBER_OF_RETRIES, timeout = helpers_1.XCRUN_TIMEOUT) {
-    return /** @type {string} */ (await (0, asyncbox_1.retry)(retries, getMaxTVOSSDKWithoutRetry, timeout));
+async function getVersionWithoutRetry(timeout = helpers_1.XCRUN_TIMEOUT) {
+    const developerPath = await (0, exports.getPath)(timeout);
+    // we want to read the CFBundleShortVersionString from Xcode's plist.
+    const { CFBundleShortVersionString } = await (0, helpers_1.readXcodePlist)(developerPath);
+    return semver.coerce(CFBundleShortVersionString);
+}
+/**
+ * Retrieves Xcode version or the cached one if called more than once
+ *
+ * @param retries  How many retries to apply for version retrieval
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @returns Xcode version
+ * @throws {Error} If there was a failure while retrieving the version
+ */
+const getVersionMemoized = lodash_1.default.memoize(function getVersionMemoized(retries = DEFAULT_NUMBER_OF_RETRIES, timeout = helpers_1.XCRUN_TIMEOUT) {
+    return (0, asyncbox_1.retry)(retries, getVersionWithoutRetry, timeout);
 });
-exports.getMaxTVOSSDK = getMaxTVOSSDK;
 //# sourceMappingURL=xcode.js.map

package/build/lib/xcode.js.map

@@ -1 +1 @@
-{"version":3,"file":"xcode.js","sourceRoot":"","sources":["../../lib/xcode.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgQW,gCAAU;AAAgB,4DAAwB;AAC5C,8DAAyB;AAAE,0CAAe;AACzD,0DAAuB;AAAE,wDAAsB;AAlQjD,6CAA6C;AAC7C,gDAAwB;AACxB,uCAAiC;AACjC,oDAAuB;AACvB,+CAAoC;AACpC,+CAAiC;AACjC,uCAEmB;AAEnB,MAAM,yBAAyB,GAAG,CAAC,CAAC;AACpC,MAAM,eAAe,GAAG,oBAAoB,CAAC;AAE7C,MAAM,GAAG,GAAG,gBAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AAEtC;;;;;;GAMG;AACH,KAAK,UAAU,sBAAsB,CAAE,OAAO,GAAG,uBAAa;IAC5D;;;OAGG;IACH,MAAM,oBAAoB,GAAG,KAAK,EAAE,MAAM,EAAE,EAAE;QAC5C,MAAM,UAAU,GAAG,MAAM,IAAA,sBAAY,EAAC,eAAe,CAAC,CAAC;QACvD,IAAI,gBAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAC1B,OAAO,GAAG,MAAM,oDAAoD,CAAC;QACvE,CAAC;QAED,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,6BAA6B,cAAI,CAAC,IAAI,CAAC,CAAC,EAAE,UAAU,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;QAC/G,OAAO,GAAG,MAAM,IAAI;YAClB,mBAAmB,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC;IACjH,CAAC,CAAC;IAEF,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,CAAC,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,cAAc,EAAE,CAAC,cAAc,CAAC,EAAE,EAAC,OAAO,EAAC,CAAC,CAAC,CAAC;IACvE,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,GAAG,GAAG,2EAA2E;YACvF,mBAAmB,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,iCAAiC;IACjC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC/D,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,GAAG,GAAG,MAAM,oBAAoB,CAAC,4CAA4C,CAAC,CAAC;QACrF,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,8DAA8D;IAC9D,MAAM,EAAC,kBAAkB,EAAC,GAAG,MAAM,IAAA,wBAAc,EAAC,aAAa,CAAC,CAAC;IACjE,IAAI,kBAAkB,KAAK,eAAe,EAAE,CAAC;QAC3C,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,oBAAoB,CAAC,IAAI,aAAa,6BAA6B,CAAC,CAAC;IACvF,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,uBAAuB;IACpC,MAAM,aAAa,GAAG,qBAAqB,CAAA,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACvE,MAAM,EAAC,kBAAkB,EAAC,GAAG,MAAM,IAAA,wBAAc,EAAC,aAAa,CAAC,CAAC;IACjE,IAAI,kBAAkB,KAAK,eAAe,EAAE,CAAC;QAC3C,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,GAAG,GAAG,CACV,oCAAoC,aAAa,8BAA8B;QAC/E,0CAA0C,CAC3C,CAAC;IACF,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAO,GAAG,gBAAC,CAAC,OAAO;AACvB;;;GAGG;AACH,CAAC,OAAO,GAAG,uBAAa,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC;AAiKtH,0BAAO;AA/JT;;;;;;GAMG;AACH,KAAK,UAAU,sBAAsB,CAAE,OAAO,GAAG,uBAAa;IAC5D,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C,qEAAqE;IACrE,MAAM,EAAC,0BAA0B,EAAC,GAAG,MAAM,IAAA,wBAAc,EAAC,aAAa,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;AACnD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,kBAAkB,GAAG,gBAAC,CAAC,OAAO,CAClC,SAAS,kBAAkB,CAAE,OAAO,GAAG,yBAAyB,EAAE,OAAO,GAAG,uBAAa;IACvF,OAAO,IAAA,gBAAK,EAAC,OAAO,EAAE,sBAAsB,EAAE,OAAO,CAAC,CAAC;AACzD,CAAC,CACF,CAAC;AAEF;;;;;;;;GAQG;AAEH;;;;;;;;GAQG;AACH,KAAK,UAAU,UAAU,CAAE,KAAK,GAAG,KAAK,EAAE,OAAO,GAAG,yBAAyB,EAAE,OAAO,GAAG,uBAAa;IACpG,MAAM,OAAO,GAAG,sCAAsC,CAAA,CAAC,MAAM,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IACnG,2EAA2E;IAC3E,yCAAyC;IACzC,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;IAChG,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,OAAO;QACL,aAAa;QACb,YAAY,EAAE,UAAU,CAAC,aAAa,CAAC;QACvC,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;QACpD,QAAQ;YACN,OAAO,aAAa,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,eAAe;IAC5B,IAAI,CAAC;QACH,MAAM,YAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,GAAG,CAAC,IAAI,CAAC,oDAAoD;YAC3D,yCAAyC,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,OAAO,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IACpD,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7C,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,GAAG,CAAC,IAAI,CAAC,mCAAmC,MAAM,EAAE,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,wBAAwB,CAAE,OAAO,GAAG,uBAAa;IAC9D,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;IAChE,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,yBAAe,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IACjC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACnC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,kDAAkD,UAAU,GAAG,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,YAAY,GAAG,gBAAC,CAAC,OAAO,CAC5B,SAAS,YAAY,CAAE,OAAO,GAAG,yBAAyB,EAAE,OAAO,GAAG,uBAAa;IACjF,OAAO,IAAA,gBAAK,EAAC,OAAO,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAAC;AAC3D,CAAC,CACF,CAAC;AAoCqB,oCAAY;AAlCnC;;;;;;GAMG;AACH,KAAK,UAAU,yBAAyB,CAAE,OAAO,GAAG,uBAAa;IAC/D,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;IACjE,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,yBAAe,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IACjC,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,mDAAmD,UAAU,GAAG,CAAC,CAAC;IACpF,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,aAAa,GAAG,gBAAC,CAAC,OAAO;AAC7B;;;;GAIG;AACH,KAAK,UAAU,aAAa,CAAE,OAAO,GAAG,yBAAyB,EAAE,OAAO,GAAG,uBAAa;IACxF,OAAO,qBAAqB,CAAA,CAAC,MAAM,IAAA,gBAAK,EAAC,OAAO,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC,CAAC;AACzF,CAAC,CACF,CAAC;AAIA,sCAAa"}
+{"version":3,"file":"xcode.js","sourceRoot":"","sources":["../../lib/xcode.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuBA,wDAkCC;AASD,0DAgBC;AAyBD,gCAmBC;AAUD,0CAeC;AASD,4DASC;AAuBD,8DAQC;AAxMD,6CAA6C;AAC7C,0DAA6B;AAC7B,uCAAiC;AACjC,oDAAuB;AACvB,+CAAoC;AACpC,+CAAiC;AACjC,uCAEmB;AAGnB,MAAM,yBAAyB,GAAG,CAAC,CAAC;AACpC,MAAM,eAAe,GAAG,oBAAoB,CAAC;AAE7C,MAAM,GAAG,GAAG,gBAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AAEtC;;;;;;GAMG;AACI,KAAK,UAAU,sBAAsB,CAAC,UAAkB,uBAAa;IAC1E,MAAM,oBAAoB,GAAG,KAAK,EAAE,MAAc,EAAmB,EAAE;QACrE,MAAM,UAAU,GAAG,MAAM,IAAA,sBAAY,EAAC,eAAe,CAAC,CAAC;QACvD,IAAI,gBAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAC1B,OAAO,GAAG,MAAM,oDAAoD,CAAC;QACvE,CAAC;QAED,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,6BAA6B,mBAAI,CAAC,IAAI,CAAC,CAAC,EAAE,UAAU,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;QAC/G,OAAO,GAAG,MAAM,IAAI;YAClB,mBAAmB,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC;IACjH,CAAC,CAAC;IAEF,IAAI,MAAc,CAAC;IACnB,IAAI,CAAC;QACH,CAAC,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,cAAc,EAAE,CAAC,cAAc,CAAC,EAAE,EAAC,OAAO,EAAC,CAAC,CAAC,CAAC;IACvE,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,GAAG,GAAG,2EAA2E;YACvF,mBAAmB,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,iCAAiC;IACjC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC/D,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,GAAG,GAAG,MAAM,oBAAoB,CAAC,4CAA4C,CAAC,CAAC;QACrF,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,8DAA8D;IAC9D,MAAM,EAAC,kBAAkB,EAAC,GAAG,MAAM,IAAA,wBAAc,EAAC,aAAa,CAAC,CAAC;IACjE,IAAI,kBAAkB,KAAK,eAAe,EAAE,CAAC;QAC3C,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,oBAAoB,CAAC,IAAI,aAAa,6BAA6B,CAAC,CAAC;IACvF,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,uBAAuB;IAC3C,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,aAAuB,CAAC;IAC1D,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,EAAC,kBAAkB,EAAC,GAAG,MAAM,IAAA,wBAAc,EAAC,aAAa,CAAC,CAAC;IACjE,IAAI,kBAAkB,KAAK,eAAe,EAAE,CAAC;QAC3C,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,GAAG,GAAG,CACV,oCAAoC,aAAa,8BAA8B;QAC/E,0CAA0C,CAC3C,CAAC;IACF,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACU,QAAA,OAAO,GAAG,gBAAC,CAAC,OAAO,CAC9B,CAAC,UAAkB,uBAAa,EAAmB,EAAE,CACnD,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAC1F,CAAC;AAaK,KAAK,UAAU,UAAU,CAAC,QAAiB,KAAK,EAAE,UAAkB,yBAAyB,EAAE,UAAkB,uBAAa;IACnI,MAAM,OAAO,GAAG,MAAM,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAkB,CAAC;IAC5E,2EAA2E;IAC3E,yCAAyC;IACzC,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;IAChG,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,OAAO;QACL,aAAa;QACb,YAAY,EAAE,UAAU,CAAC,aAAa,CAAC;QACvC,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;QACpD,QAAQ;YACN,OAAO,aAAa,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,eAAe;IACnC,IAAI,CAAC;QACH,MAAM,YAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,GAAG,CAAC,IAAI,CAAC,oDAAoD;YAC3D,yCAAyC,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,OAAO,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IACpD,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7C,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,GAAG,CAAC,IAAI,CAAC,mCAAmC,MAAM,EAAE,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,wBAAwB,CAAC,UAAkB,uBAAa;IAC5E,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;IAChE,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,yBAAe,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IACjC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACnC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,kDAAkD,UAAU,GAAG,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;;GAOG;AACU,QAAA,YAAY,GAAG,gBAAC,CAAC,OAAO,CACnC,SAAS,YAAY,CAAC,UAAkB,yBAAyB,EAAE,UAAkB,uBAAa;IAChG,OAAO,IAAA,gBAAK,EAAC,OAAO,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAAC;AAC3D,CAAC,CACF,CAAC;AAEF;;;;;;GAMG;AACI,KAAK,UAAU,yBAAyB,CAAC,UAAkB,uBAAa;IAC7E,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;IACjE,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,yBAAe,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IACjC,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,mDAAmD,UAAU,GAAG,CAAC,CAAC;IACpF,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;;GAOG;AACU,QAAA,aAAa,GAAG,gBAAC,CAAC,OAAO,CACpC,KAAK,UAAU,aAAa,CAAC,UAAkB,yBAAyB,EAAE,UAAkB,uBAAa;IACvG,OAAO,MAAM,IAAA,gBAAK,EAAC,OAAO,EAAE,yBAAyB,EAAE,OAAO,CAAW,CAAC;AAC5E,CAAC,CACF,CAAC;AAEF,2BAA2B;AAE3B;;;;;;GAMG;AACH,KAAK,UAAU,sBAAsB,CAAC,UAAkB,uBAAa;IACnE,MAAM,aAAa,GAAG,MAAM,IAAA,eAAO,EAAC,OAAO,CAAC,CAAC;IAC7C,qEAAqE;IACrE,MAAM,EAAC,0BAA0B,EAAC,GAAG,MAAM,IAAA,wBAAc,EAAC,aAAa,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;AACnD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,kBAAkB,GAAG,gBAAC,CAAC,OAAO,CAClC,SAAS,kBAAkB,CAAC,UAAkB,yBAAyB,EAAE,UAAkB,uBAAa;IACtG,OAAO,IAAA,gBAAK,EAAC,OAAO,EAAE,sBAAsB,EAAE,OAAO,CAAC,CAAC;AACzD,CAAC,CACF,CAAC"}

package/lib/{helpers.js → helpers.ts}

@@ -1,20 +1,21 @@
 import _ from 'lodash';
 import B from 'bluebird';
 import { exec } from 'teen_process';
+import type { TeenProcessExecResult } from 'teen_process';
 import { fs, plist } from '@appium/support';
-import path from 'path';
+import path from 'node:path';
 
 export const XCRUN_TIMEOUT = 15000;
 
 /**
  * Executes 'xcrun' command line utility
  *
- * @param {string[]} args xcrun arguments
- * @param {number} timeout [15000] The maximum number of milliseconds to wait until xcrun exists
- * @returns {Promise<import("teen_process").TeenProcessExecResult>} The result of xcrun execution
+ * @param args xcrun arguments
+ * @param timeout The maximum number of milliseconds to wait until xcrun exists
+ * @returns The result of xcrun execution
  * @throws {Error} If xcrun returned non-zero exit code or timed out
  */
-export async function runXcrunCommand (args, timeout = XCRUN_TIMEOUT) {
+export async function runXcrunCommand(args: string[], timeout: number = XCRUN_TIMEOUT): Promise<TeenProcessExecResult<string>> {
   try {
     return await exec('xcrun', args, {timeout});
   } catch (err) {
@@ -30,11 +31,11 @@ export async function runXcrunCommand (args, timeout = XCRUN_TIMEOUT) {
 /**
  * Uses macOS Spotlight service to detect where the given app is installed
  *
- * @param {string} bundleId Bundle identifier of the target app
- * @returns {Promise<string[]>} Full paths to where the app with the given bundle id is present.
+ * @param bundleId Bundle identifier of the target app
+ * @returns Full paths to where the app with the given bundle id is present.
  */
-export async function findAppPaths (bundleId) {
-  let stdout;
+export async function findAppPaths(bundleId: string): Promise<string[]> {
+  let stdout: string;
   try {
     ({stdout} = await exec('/usr/bin/mdfind', [
       `kMDItemCFBundleIdentifier=${bundleId}`
@@ -55,16 +56,16 @@ export async function findAppPaths (bundleId) {
       return p;
     }
   })());
-  return /** @type {string[]} */(await B.all(results)).filter(Boolean);
+  return (await B.all(results)).filter(Boolean) as string[];
 }
 
 /**
  * Finds and retrieves the content of the Xcode's Info.plist file
  *
- * @param {string} developerRoot Full path to the Contents/Developer folder under Xcode.app root
- * @returns {Promise<object>} All plist entries as an object or an empty object if no plist was found
+ * @param developerRoot Full path to the Contents/Developer folder under Xcode.app root
+ * @returns All plist entries as an object or an empty object if no plist was found
  */
-export async function readXcodePlist (developerRoot) {
+export async function readXcodePlist(developerRoot: string): Promise<Record<string, any>> {
   const plistPath = path.resolve(developerRoot, '..', 'Info.plist');
   return await fs.exists(plistPath)
     ? await plist.parsePlistFile(plistPath)

package/lib/{index.js → index.ts}

@@ -24,6 +24,5 @@ export {
 };
 export default xcode;
 
-/**
- * @typedef {import('./xcode').XcodeVersion} XcodeVersion
- */
+export type { XcodeVersion } from './types';
+

package/lib/types.ts

@@ -0,0 +1,9 @@
+export interface XcodeVersion {
+  versionString: string;
+  versionFloat: number;
+  major: number;
+  minor: number;
+  patch?: number;
+  toString(): string;
+}
+

package/lib/{xcode.js → xcode.ts}

@@ -1,5 +1,5 @@
 import { fs, logger } from '@appium/support';
-import path from 'path';
+import path from 'node:path';
 import { retry } from 'asyncbox';
 import _ from 'lodash';
 import { exec } from 'teen_process';
@@ -7,6 +7,7 @@ import * as semver from 'semver';
 import {
   runXcrunCommand, findAppPaths, XCRUN_TIMEOUT, readXcodePlist
 } from './helpers';
+import type { XcodeVersion } from './types';
 
 const DEFAULT_NUMBER_OF_RETRIES = 2;
 const XCODE_BUNDLE_ID = 'com.apple.dt.Xcode';
@@ -16,16 +17,12 @@ const log = logger.getLogger('Xcode');
 /**
  * Retrieves the full path to Xcode Developer subfolder via xcode-select
  *
- * @param {number} timeout The maximum timeout for xcode-select execution
- * @returns {Promise<string>} Full path to Xcode Developer subfolder
+ * @param timeout The maximum timeout for xcode-select execution
+ * @returns Full path to Xcode Developer subfolder
  * @throws {Error} If it is not possible to retrieve a proper path
  */
-async function getPathFromXcodeSelect (timeout = XCRUN_TIMEOUT) {
-  /**
-   * @param {string} prefix
-   * @returns {Promise<string>}
-   */
-  const generateErrorMessage = async (prefix) => {
+export async function getPathFromXcodeSelect(timeout: number = XCRUN_TIMEOUT): Promise<string> {
+  const generateErrorMessage = async (prefix: string): Promise<string> => {
     const xcodePaths = await findAppPaths(XCODE_BUNDLE_ID);
     if (_.isEmpty(xcodePaths)) {
       return `${prefix}. Consider installing Xcode to address this issue.`;
@@ -36,7 +33,7 @@ async function getPathFromXcodeSelect (timeout = XCRUN_TIMEOUT) {
       `Consider running${proposals.length > 1 ? ' any of' : ''}:\n${proposals.join('\n')}\nto address this issue.`;
   };
 
-  let stdout;
+  let stdout: string;
   try {
     ({stdout} = await exec('xcode-select', ['--print-path'], {timeout}));
   } catch (e) {
@@ -63,12 +60,16 @@ async function getPathFromXcodeSelect (timeout = XCRUN_TIMEOUT) {
 /**
  * Retrieves the full path to Xcode Developer subfolder via `DEVELOPER_DIR` environment variable
  *
- * @returns {Promise<string>} Full path to Xcode Developer subfolder
+ * @returns Full path to Xcode Developer subfolder
  * @throws {Error} If it is not possible to retrieve a proper path
  * @privateRemarks This method assumes `DEVELOPER_DIR` is defined.
  */
-async function getPathFromDeveloperDir () {
-  const developerRoot = /** @type {string} */(process.env.DEVELOPER_DIR);
+export async function getPathFromDeveloperDir(): Promise<string> {
+  const developerRoot = process.env.DEVELOPER_DIR as string;
+  if (!developerRoot) {
+    throw new Error('DEVELOPER_DIR environment variable is not set');
+  }
+
   const {CFBundleIdentifier} = await readXcodePlist(developerRoot);
   if (CFBundleIdentifier === XCODE_BUNDLE_ID) {
     return developerRoot;
@@ -84,66 +85,28 @@ async function getPathFromDeveloperDir () {
 /**
  * Retrieves the full path to Xcode Developer subfolder.
  * If `DEVELOPER_DIR` environment variable is provided then its value has a priority.
- * @param {number} timeout The maximum timeout for xcode-select execution
- * @returns {Promise<string>} Full path to Xcode Developer subfolder timeout
+ * @param timeout The maximum timeout for xcode-select execution
+ * @returns Full path to Xcode Developer subfolder timeout
  * @throws {Error} If there was an error while retrieving the path.
  */
-const getPath = _.memoize(
-  /**
-   * @param {number} timeout
-   * @returns {Promise<string>}
-   */
-  (timeout = XCRUN_TIMEOUT) => process.env.DEVELOPER_DIR ? getPathFromDeveloperDir() : getPathFromXcodeSelect(timeout));
-
-/**
- * Retrieves Xcode version
- *
- * @param {number} timeout [15000] Timeout of milliseconds to wait for terminal commands.
- * @returns {Promise<import("semver").SemVer | null>} Xcode version
- * @throws {Error} If there was a failure while retrieving the version
- */
-async function getVersionWithoutRetry (timeout = XCRUN_TIMEOUT) {
-  const developerPath = await getPath(timeout);
-  // we want to read the CFBundleShortVersionString from Xcode's plist.
-  const {CFBundleShortVersionString} = await readXcodePlist(developerPath);
-  return semver.coerce(CFBundleShortVersionString);
-}
-
-/**
- * Retrieves Xcode version or the cached one if called more than once
- *
- * @param {number} retries  How many retries to apply for version retrieval
- * @param {number} timeout Timeout of milliseconds to wait for terminal commands
- * @returns {Promise<import("semver").SemVer | null>} Xcode version
- * @throws {Error} If there was a failure while retrieving the version
- */
-const getVersionMemoized = _.memoize(
-  function getVersionMemoized (retries = DEFAULT_NUMBER_OF_RETRIES, timeout = XCRUN_TIMEOUT) {
-    return retry(retries, getVersionWithoutRetry, timeout);
-  }
+export const getPath = _.memoize(
+  (timeout: number = XCRUN_TIMEOUT): Promise<string> =>
+    process.env.DEVELOPER_DIR ? getPathFromDeveloperDir() : getPathFromXcodeSelect(timeout)
 );
 
-/**
- * @typedef {Object} XcodeVersion
- * @property {string} versionString Xcode version as a string
- * @property {number} versionFloat Xcode version as a float number
- * @property {number} major Major number of Xcode version
- * @property {number} minor Minor number of Xcode version
- * @property {number} [patch] Patch number of Xcode version (if exists)
- * @property {() => string} toString Returns Xcode version as a string
- */
-
 /**
  * Retrieves Xcode version
  *
- * @param {boolean} parse [false] Whether to parse the version to a XcodeVersion version
- * @param {number} retries [2] How many retries to apply for getting the version number
- * @param {number} timeout [15000] Timeout of milliseconds to wait for terminal commands
- * @returns {Promise<XcodeVersion | string>} Xcode version depending on the value of `parse` flag
+ * @param parse Whether to parse the version to a XcodeVersion version
+ * @param retries How many retries to apply for getting the version number
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @returns Xcode version depending on the value of `parse` flag
  * @throws {Error} If there was a failure while retrieving the version
  */
-async function getVersion (parse = false, retries = DEFAULT_NUMBER_OF_RETRIES, timeout = XCRUN_TIMEOUT) {
-  const version = /** @type {import('semver').SemVer} */(await getVersionMemoized(retries, timeout));
+export async function getVersion(parse: false, retries?: number, timeout?: number): Promise<string>;
+export async function getVersion(parse: true, retries?: number, timeout?: number): Promise<XcodeVersion>;
+export async function getVersion(parse: boolean = false, retries: number = DEFAULT_NUMBER_OF_RETRIES, timeout: number = XCRUN_TIMEOUT): Promise<string | XcodeVersion> {
+  const version = await getVersionMemoized(retries, timeout) as semver.SemVer;
   // xcode version strings are not exactly semver string: patch versions of 0
   // are removed (e.g., '10.0.0' => '10.0')
   const versionString = version.patch > 0 ? version.version : `${version.major}.${version.minor}`;
@@ -157,7 +120,7 @@ async function getVersion (parse = false, retries = DEFAULT_NUMBER_OF_RETRIES, t
     major: version.major,
     minor: version.minor,
     patch: version.patch > 0 ? version.patch : undefined,
-    toString () {
+    toString() {
       return versionString;
     },
   };
@@ -167,11 +130,11 @@ async function getVersion (parse = false, retries = DEFAULT_NUMBER_OF_RETRIES, t
  * Check https://trac.macports.org/wiki/XcodeVersionInfo
  * to see the actual mapping between clang and other components.
  *
- * @returns {Promise<string|null>} The actual Clang version in x.x.x.x or x.x.x format,
+ * @returns The actual Clang version in x.x.x.x or x.x.x format,
  * which is supplied with Command Line Tools. `null` is returned
  * if CLT are not installed.
  */
-async function getClangVersion () {
+export async function getClangVersion(): Promise<string | null> {
   try {
     await fs.which('clang');
   } catch {
@@ -191,11 +154,11 @@ async function getClangVersion () {
 /**
  * Retrieves the maximum version of iOS SDK supported by the installed Xcode
  *
- * @param {number} timeout [15000] Timeout of milliseconds to wait for terminal commands
- * @returns {Promise<string>} The SDK version
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @returns The SDK version
  * @throws {Error} If the SDK version number cannot be determined
  */
-async function getMaxIOSSDKWithoutRetry (timeout = XCRUN_TIMEOUT) {
+export async function getMaxIOSSDKWithoutRetry(timeout: number = XCRUN_TIMEOUT): Promise<string> {
   const args = ['--sdk', 'iphonesimulator', '--show-sdk-version'];
   const {stdout} = await runXcrunCommand(args, timeout);
   const sdkVersion = stdout.trim();
@@ -209,13 +172,13 @@ async function getMaxIOSSDKWithoutRetry (timeout = XCRUN_TIMEOUT) {
 /**
  * Retrieves the maximum version of iOS SDK supported by the installed Xcode
  *
- * @param {number} timeout Timeout of milliseconds to wait for terminal commands
- * @param {number} retries The maximum number of retries
- * @returns {string} The SDK version
+ * @param retries The maximum number of retries
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @returns The SDK version
  * @throws {Error} If the SDK version number cannot be determined
  */
-const getMaxIOSSDK = _.memoize(
-  function getMaxIOSSDK (retries = DEFAULT_NUMBER_OF_RETRIES, timeout = XCRUN_TIMEOUT) {
+export const getMaxIOSSDK = _.memoize(
+  function getMaxIOSSDK(retries: number = DEFAULT_NUMBER_OF_RETRIES, timeout: number = XCRUN_TIMEOUT) {
     return retry(retries, getMaxIOSSDKWithoutRetry, timeout);
   }
 );
@@ -223,11 +186,11 @@ const getMaxIOSSDK = _.memoize(
 /**
  * Retrieves the maximum version of tvOS SDK supported by the installed Xcode
  *
- * @param {number} timeout Timeout of milliseconds to wait for terminal commands
- * @returns {Promise<string>} The SDK version
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @returns The SDK version
  * @throws {Error} If the SDK version number cannot be determined
  */
-async function getMaxTVOSSDKWithoutRetry (timeout = XCRUN_TIMEOUT) {
+export async function getMaxTVOSSDKWithoutRetry(timeout: number = XCRUN_TIMEOUT): Promise<string> {
   const args = ['--sdk', 'appletvsimulator', '--show-sdk-version'];
   const {stdout} = await runXcrunCommand(args, timeout);
   const sdkVersion = stdout.trim();
@@ -240,21 +203,43 @@ async function getMaxTVOSSDKWithoutRetry (timeout = XCRUN_TIMEOUT) {
 /**
  * Retrieves the maximum version of tvOS SDK supported by the installed Xcode
  *
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @param retries The maximum number of retries
+ * @returns The SDK version
  * @throws {Error} If the SDK version number cannot be determined
  */
-const getMaxTVOSSDK = _.memoize(
-  /**
-   * @param {number} timeout Timeout of milliseconds to wait for terminal commands
-   * @param {number} retries The maximum number of retries
-   * @returns {Promise<string>} The SDK version
-   */
-  async function getMaxTVOSSDK (retries = DEFAULT_NUMBER_OF_RETRIES, timeout = XCRUN_TIMEOUT) {
-    return /** @type {string} */(await retry(retries, getMaxTVOSSDKWithoutRetry, timeout));
+export const getMaxTVOSSDK = _.memoize(
+  async function getMaxTVOSSDK(retries: number = DEFAULT_NUMBER_OF_RETRIES, timeout: number = XCRUN_TIMEOUT): Promise<string> {
+    return await retry(retries, getMaxTVOSSDKWithoutRetry, timeout) as string;
   }
 );
 
-export {
-  getPath, getVersion, getMaxIOSSDK, getMaxIOSSDKWithoutRetry,
-  getMaxTVOSSDK, getMaxTVOSSDKWithoutRetry, getClangVersion,
-  getPathFromDeveloperDir, getPathFromXcodeSelect,
-};
+// Private helper functions
+
+/**
+ * Retrieves Xcode version
+ *
+ * @param timeout Timeout of milliseconds to wait for terminal commands.
+ * @returns Xcode version
+ * @throws {Error} If there was a failure while retrieving the version
+ */
+async function getVersionWithoutRetry(timeout: number = XCRUN_TIMEOUT): Promise<semver.SemVer | null> {
+  const developerPath = await getPath(timeout);
+  // we want to read the CFBundleShortVersionString from Xcode's plist.
+  const {CFBundleShortVersionString} = await readXcodePlist(developerPath);
+  return semver.coerce(CFBundleShortVersionString);
+}
+
+/**
+ * Retrieves Xcode version or the cached one if called more than once
+ *
+ * @param retries  How many retries to apply for version retrieval
+ * @param timeout Timeout of milliseconds to wait for terminal commands
+ * @returns Xcode version
+ * @throws {Error} If there was a failure while retrieving the version
+ */
+const getVersionMemoized = _.memoize(
+  function getVersionMemoized(retries: number = DEFAULT_NUMBER_OF_RETRIES, timeout: number = XCRUN_TIMEOUT): Promise<semver.SemVer | null> {
+    return retry(retries, getVersionWithoutRetry, timeout);
+  }
+);

package/package.json

@@ -6,7 +6,7 @@
     "ios",
     "xcode"
   ],
-  "version": "6.0.2",
+  "version": "6.1.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -21,6 +21,7 @@
     "npm": ">=10"
   },
   "main": "./build/lib/index.js",
+  "types": "./build/lib/index.d.ts",
   "files": [
     "lib",
     "build/lib",
@@ -71,6 +72,5 @@
     "semantic-release": "^24.0.0",
     "ts-node": "^10.9.1",
     "typescript": "^5.4.2"
-  },
-  "types": "./build/lib/index.d.ts"
+  }
 }