appium-mac2-driver 3.2.2 → 3.2.4

package/lib/doctor/{utils.js → utils.ts}

@@ -3,10 +3,10 @@ import {fs} from 'appium/support';
 /**
  * Return an executable path of cmd
  *
- * @param {string} cmd Standard output by command
- * @return {Promise<string?>} The full path of cmd. `null` if the cmd is not found.
+ * @param cmd Standard output by command
+ * @return The full path of cmd. `null` if the cmd is not found.
  */
-export async function resolveExecutablePath(cmd) {
+export async function resolveExecutablePath(cmd: string): Promise<string | null> {
   try {
     const executablePath = await fs.which(cmd);
     if (executablePath && (await fs.exists(executablePath))) {
@@ -15,3 +15,4 @@ export async function resolveExecutablePath(cmd) {
   } catch {}
   return null;
 }
+

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

@@ -3,3 +3,4 @@ import { logger } from 'appium/support';
 const log = logger.getLogger('Mac2Driver');
 
 export default log;
+

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

@@ -7,10 +7,10 @@ const MODULE_NAME = 'appium-mac2-driver';
 /**
  * Calculates the path to the current module's root folder
  *
- * @returns {string} The full path to module root
- * @throws {Error} If the current module root folder cannot be determined
+ * @returns The full path to module root
+ * @throws If the current module root folder cannot be determined
  */
-const getModuleRoot = _.memoize(function getModuleRoot () {
+export const getModuleRoot = _.memoize(function getModuleRoot (): string {
   const root = node.getModuleRootSync(MODULE_NAME, __filename);
   if (!root) {
     throw new Error(`Cannot find the root folder of the ${MODULE_NAME} Node.js module`);
@@ -22,21 +22,19 @@ const getModuleRoot = _.memoize(function getModuleRoot () {
  * Retrieves process ids of all the children processes created by the given
  * parent process identifier
  *
- * @param {number|string} parentPid parent process ID
- * @returns {Promise<string[]>} the list of matched children process ids
+ * @param parentPid parent process ID
+ * @returns the list of matched children process ids
  * or an empty list if none matched
  */
-async function listChildrenProcessIds (parentPid) {
+export async function listChildrenProcessIds (parentPid: number | string): Promise<string[]> {
   const { stdout } = await exec('ps', ['axu', '-o', 'ppid']);
   // USER  PID  %CPU %MEM  VSZ  RSS   TT  STAT STARTED  TIME COMMAND  PPID
   return stdout.split('\n')
     .filter(_.trim)
-    .map((line) => {
+    .map((line: string) => {
       const [, pid, ...rest] = line.split(/\s+/).filter(_.trim);
       return [pid, _.last(rest)];
     })
     .filter(([, ppid]) => ppid === `${parentPid}`)
-    .map(([pid]) => (String) (pid));
+    .map(([pid]) => String(pid));
 }
-
-export { listChildrenProcessIds, getModuleRoot };

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-mac2-driver",
-  "version": "3.2.2",
+  "version": "3.2.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-mac2-driver",
-      "version": "3.2.2",
+      "version": "3.2.4",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/strongbox": "^1.0.0-rc.1",
@@ -1542,14 +1542,14 @@
       }
     },
     "node_modules/color": {
-      "version": "5.0.2",
-      "resolved": "https://registry.npmjs.org/color/-/color-5.0.2.tgz",
-      "integrity": "sha512-e2hz5BzbUPcYlIRHo8ieAhYgoajrJr+hWoceg6E345TPsATMUKqDgzt8fSXZJJbxfpiPzkWyphz8yn8At7q3fA==",
+      "version": "5.0.3",
+      "resolved": "https://registry.npmjs.org/color/-/color-5.0.3.tgz",
+      "integrity": "sha512-ezmVcLR3xAVp8kYOm4GS45ZLLgIE6SPAFoduLr6hTDajwb3KZ2F46gulK3XpcwRFb5KKGCSezCBAY4Dw4HsyXA==",
       "extraneous": true,
       "license": "MIT",
       "dependencies": {
-        "color-convert": "^3.0.1",
-        "color-string": "^2.0.0"
+        "color-convert": "^3.1.3",
+        "color-string": "^2.1.3"
       },
       "engines": {
         "node": ">=18"
@@ -1574,9 +1574,9 @@
       "license": "MIT"
     },
     "node_modules/color-string": {
-      "version": "2.1.2",
-      "resolved": "https://registry.npmjs.org/color-string/-/color-string-2.1.2.tgz",
-      "integrity": "sha512-RxmjYxbWemV9gKu4zPgiZagUxbH3RQpEIO77XoSSX0ivgABDZ+h8Zuash/EMFLTI4N9QgFPOJ6JQpPZKFxa+dA==",
+      "version": "2.1.4",
+      "resolved": "https://registry.npmjs.org/color-string/-/color-string-2.1.4.tgz",
+      "integrity": "sha512-Bb6Cq8oq0IjDOe8wJmi4JeNn763Xs9cfrBcaylK1tPypWzyoy2G3l90v9k64kjphl/ZJjPIShFztenRomi8WTg==",
       "extraneous": true,
       "license": "MIT",
       "dependencies": {
@@ -1597,9 +1597,9 @@
       }
     },
     "node_modules/color/node_modules/color-convert": {
-      "version": "3.1.2",
-      "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-3.1.2.tgz",
-      "integrity": "sha512-UNqkvCDXstVck3kdowtOTWROIJQwafjOfXSmddoDrXo4cewMKmusCeF22Q24zvjR8nwWib/3S/dfyzPItPEiJg==",
+      "version": "3.1.3",
+      "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-3.1.3.tgz",
+      "integrity": "sha512-fasDH2ont2GqF5HpyO4w0+BcewlhHEZOFn9c1ckZdHpJ56Qb7MHhH/IcJZbBGgvdtwdwNbLvxiBEdg336iA9Sg==",
       "extraneous": true,
       "license": "MIT",
       "dependencies": {

package/package.json

@@ -6,7 +6,7 @@
     "mac",
     "XCTest"
   ],
-  "version": "3.2.2",
+  "version": "3.2.4",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {

package/lib/commands/app-management.js

@@ -1,83 +0,0 @@
-/**
- * Start an app with given bundle identifier or activates it
- * if the app is already running. An exception is thrown if the
- * app with the given identifier cannot be found.
- *
- * @this {Mac2Driver}
- * @param {string} [bundleId] Bundle identifier of the app to be launched or activated.
- *                 Either this property or `path` must be provided
- * @param {string} [path] Full path to the app bundle. Either this property or
- *                 `bundleId` must be provided
- * @param {string[]} [args] The list of command line arguments for the app to be launched with.
- *                   This parameter is ignored if the app is already running.
- * @param {import('@appium/types').StringRecord} [environment] Environment variables mapping.
- *                   Custom variables are added to the default process environment.
- */
-export async function macosLaunchApp (
-  bundleId,
-  path,
-  args,
-  environment,
-) {
-  return await this.wda.proxy.command('/wda/apps/launch', 'POST', {
-    arguments: args,
-    environment,
-    bundleId,
-    path,
-  });
-};
-
-/**
- * Activate an app with given bundle identifier. An exception is thrown if the
- * app cannot be found or is not running.
- *
- * @this {Mac2Driver}
- * @param {string} [bundleId] Bundle identifier of the app to be activated.
- *                 Either this property or `path` must be provided
- * @param {string} [path] Full path to the app bundle. Either this property
- *                 or `bundleId` must be provided
- */
-export async function macosActivateApp (bundleId, path) {
-  return await this.wda.proxy.command('/wda/apps/activate', 'POST', { bundleId, path });
-};
-
-/**
- * Terminate an app with given bundle identifier. An exception is thrown if the
- * app cannot be found.
- *
- * @this {Mac2Driver}
- * @param {string} [bundleId] Bundle identifier of the app to be terminated.
- *                 Either this property or `path` must be provided
- * @param {string} [path] Full path to the app bundle. Either this property
- *                 or `bundleId` must be provided
- * @returns {Promise<boolean>} `true` if the app was running and has been successfully terminated.
- * `false` if the app was not running before.
- */
-export async function macosTerminateApp (bundleId, path) {
-  return /** @type {boolean} */ (
-    await this.wda.proxy.command('/wda/apps/terminate', 'POST', { bundleId, path })
-  );
-};
-
-/**
- * Query an app state with given bundle identifier. An exception is thrown if the
- * app cannot be found.
- *
- * @this {Mac2Driver}
- * @param {string} [bundleId] Bundle identifier of the app whose state should be queried.
- *                 Either this property or `path` must be provided
- * @param {string} [path] Full path to the app bundle. Either this property
- *                 or `bundleId` must be provided
- * @returns {Promise<number>} The application state code. See
- * https://developer.apple.com/documentation/xctest/xcuiapplicationstate?language=objc
- * for more details
- */
-export async function macosQueryAppState (bundleId, path) {
-  return /** @type {number} */ (
-    await this.wda.proxy.command('/wda/apps/state', 'POST', { bundleId, path })
-  );
-};
-
-/**
- * @typedef {import('../driver').Mac2Driver} Mac2Driver
- */

package/lib/commands/execute.js

@@ -1,33 +0,0 @@
-import _ from 'lodash';
-
-const EXECUTE_SCRIPT_PREFIX = 'macos:';
-
-/**
- *
- * @this {Mac2Driver}
- * @param {string} script
- * @param {any[]|import('@appium/types').StringRecord} [args]
- * @returns {Promise<any>}
- */
-export async function execute (script, args) {
-  this.log.info(`Executing extension command '${script}'`);
-  const formattedScript = String(script).trim().replace(/^macos:\s*/, `${EXECUTE_SCRIPT_PREFIX} `);
-  const preprocessedArgs = preprocessExecuteMethodArgs(args);
-  return await this.executeMethod(formattedScript, [preprocessedArgs]);
-};
-
-/**
- * Massages the arguments going into an execute method.
- *
- * @param {ExecuteMethodArgs} [args]
- * @returns {StringRecord}
- */
-function preprocessExecuteMethodArgs(args) {
-  return /** @type {StringRecord} */ ((_.isArray(args) ? _.first(args) : args) ?? {});
-}
-
-/**
- * @typedef {import('../driver').Mac2Driver} Mac2Driver
- * @typedef {import('@appium/types').StringRecord} StringRecord
- * @typedef {readonly any[] | readonly [StringRecord] | Readonly<StringRecord>} ExecuteMethodArgs
- */

package/lib/commands/find.js

@@ -1,31 +0,0 @@
-import { util } from 'appium/support';
-
-/**
- * This is needed to make lookup by image working
- *
- * @this {Mac2Driver}
- * @param {string} strategy
- * @param {string} selector
- * @param {boolean} mult
- * @param {string} [context]
- * @returns {Promise<any>}
- */
-export async function findElOrEls (strategy, selector, mult, context) {
-  const contextId = context ? util.unwrapElement(context) : context;
-  const endpoint = `/element${contextId ? `/${contextId}/element` : ''}${mult ? 's' : ''}`;
-
-  if (strategy === '-ios predicate string') {
-    strategy = 'predicate string';
-  } else if (strategy === '-ios class chain') {
-    strategy = 'class chain';
-  }
-
-  return await this.wda.proxy.command(endpoint, 'POST', {
-    using: strategy,
-    value: selector,
-  });
-};
-
-/**
- * @typedef {import('../driver').Mac2Driver} Mac2Driver
- */

package/lib/commands/navigation.js

@@ -1,18 +0,0 @@
-/**
- * Opens the given URL with the default or the given application.
- * Xcode must be at version 14.3+.
- *
- * @this {Mac2Driver}
- * @param {string} url The URL to be opened.
- * @param {string} [bundleId] The bundle identifier of an application to open
- *                 the given url with. If not provided then the default application
- *                 for the given url scheme is going to be used.
- * @returns {Promise<unknown>}
- */
-export async function macosDeepLink (url, bundleId) {
-  return await this.wda.proxy.command('/url', 'POST', {url, bundleId});
-};
-
-/**
- * @typedef {import('../driver').Mac2Driver} Mac2Driver
- */

package/lib/commands/screenshots.js

@@ -1,18 +0,0 @@
-/**
- * Retrieves screenshots of each display available to macOS
- *
- * @this {Mac2Driver}
- * @param {number} [displayId] macOS display identifier to take a screenshot for.
- *                 If not provided then screenshots of all displays are going to be returned.
- *                 If no matches were found then an error is thrown.
- * @returns {Promise<import('../types').ScreenshotsInfo>}
- */
-export async function macosScreenshots (displayId) {
-  return /** @type {import('../types').ScreenshotsInfo} */ (
-    await this.wda.proxy.command('/wda/screenshots', 'POST', {displayId})
-  );
-};
-
-/**
- * @typedef {import('../driver').Mac2Driver} Mac2Driver
- */

package/lib/doctor/optional-checks.js

@@ -1,64 +0,0 @@
-import {resolveExecutablePath} from './utils';
-import {doctor} from 'appium/support';
-import {exec} from 'teen_process';
-import '@colors/colors';
-
-/** @satisfies {import('@appium/types').IDoctorCheck} */
-export class OptionalFfmpegCheck {
-  FFMPEG_BINARY = 'ffmpeg';
-  FFMPEG_INSTALL_LINK = 'https://www.ffmpeg.org/download.html';
-
-  async diagnose() {
-    const ffmpegPath = await resolveExecutablePath(this.FFMPEG_BINARY);
-
-    return ffmpegPath
-      ? doctor.okOptional(`${this.FFMPEG_BINARY} exists at '${ffmpegPath}'`)
-      : doctor.nokOptional(`${this.FFMPEG_BINARY} cannot be found`);
-  }
-
-  async fix() {
-    return (
-      `${`${this.FFMPEG_BINARY}`.bold} is used to capture screen recordings. ` +
-      `Please read ${this.FFMPEG_INSTALL_LINK}.`
-    );
-  }
-
-  hasAutofix() {
-    return false;
-  }
-
-  isOptional() {
-    return true;
-  }
-}
-export const optionalFfmpegCheck = new OptionalFfmpegCheck();
-
-
-/** @satisfies {import('@appium/types').IDoctorCheck} */
-export class OptionalAutomationModeCheck {
-  async diagnose() {
-    let stdout;
-    try {
-      ({stdout} = await exec('automationmodetool'));
-    } catch (err) {
-      return doctor.nokOptional(`Cannot run 'automationmodetool': ${err.stderr || err.message}`);
-    }
-    if (stdout.includes('DOES NOT REQUIRE')) {
-      return doctor.okOptional(`Automation Mode does not require user authentication`);
-    }
-    return doctor.nokOptional(`Automation Mode requires user authentication`);
-  }
-
-  async fix() {
-    return `Run \`automationmodetool enable-automationmode-without-authentication\` to disable Automation Mode authentication`;
-  }
-
-  hasAutofix() {
-    return false;
-  }
-
-  isOptional() {
-    return true;
-  }
-}
-export const optionalAutomationModeCheck = new OptionalAutomationModeCheck();

package/lib/doctor/required-checks.js

@@ -1,72 +0,0 @@
-import {doctor} from 'appium/support';
-import {exec} from 'teen_process';
-import { getPath as getXcodePath } from 'appium-xcode';
-import '@colors/colors';
-
-
-/** @satisfies {import('@appium/types').IDoctorCheck} */
-export class XcodeCheck {
-  async diagnose() {
-    try {
-      const xcodePath = await getXcodePath();
-      return doctor.ok(`xCode is installed at '${xcodePath}'`);
-    } catch (err) {
-      return doctor.nok(err.message);
-    }
-  }
-
-  async fix() {
-    return `Manually install ${'Xcode'.bold} and configure the active developer directory path using the xcode-select tool`;
-  }
-
-  hasAutofix() {
-    return false;
-  }
-
-  isOptional() {
-    return false;
-  }
-}
-export const xcodeCheck = new XcodeCheck();
-
-
-/** @satisfies {import('@appium/types').IDoctorCheck} */
-export class XcodebuildCheck {
-  XCODE_VER_PATTERN = /^Xcode\s+([\d.]+)$/m;
-  MIN_XCODE_VERSION = 13;
-
-  async diagnose() {
-    let xcodeVerMatch;
-    let stdout;
-    let stderr;
-    try {
-      ({stdout, stderr} = await exec('xcodebuild', ['-version']));
-      xcodeVerMatch = this.XCODE_VER_PATTERN.exec(stdout);
-    } catch (err) {
-      return doctor.nok(`Cannot run 'xcodebuild': ${err.stderr || err.message}`);
-    }
-    if (!xcodeVerMatch) {
-      return doctor.nok(`Cannot determine Xcode version. stdout: ${stdout}; stderr: ${stderr}`);
-    }
-    const xcodeMajorVer = parseInt(xcodeVerMatch[1], 10);
-    if (xcodeMajorVer < this.MIN_XCODE_VERSION) {
-      return doctor.nok(`The actual Xcode version (${xcodeVerMatch[0]}) is older than the expected ` +
-        `one (${this.MIN_XCODE_VERSION})`);
-    }
-    return doctor.ok(`xcodebuild is installed and has a matching version number ` +
-      `(${xcodeVerMatch[1]} >= ${this.MIN_XCODE_VERSION})`);
-  }
-
-  async fix() {
-    return `Install ${'Xcode'.bold} ${this.MIN_XCODE_VERSION}+ or upgrade the existing setup`;
-  }
-
-  hasAutofix() {
-    return false;
-  }
-
-  isOptional() {
-    return false;
-  }
-}
-export const xcodebuildCheck = new XcodebuildCheck();