appium-mac2-driver 1.16.0 → 1.17.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.17.0](https://github.com/appium/appium-mac2-driver/compare/v1.16.0...v1.17.0) (2024-04-21)
+
+
+### Features
+
+* Improve the typing system ([#298](https://github.com/appium/appium-mac2-driver/issues/298)) ([20bdd85](https://github.com/appium/appium-mac2-driver/commit/20bdd85de5b801098a23b1f95dd46f72d97a9506))
+
 ## [1.16.0](https://github.com/appium/appium-mac2-driver/compare/v1.15.0...v1.16.0) (2024-04-20)
 
 

package/build/lib/commands/app-management.d.ts

@@ -1,130 +1,40 @@
-export default commands;
-export type LaunchAppOptions = {
-    /**
-     * Bundle identifier of the app to be launched
-     * or activated. Either this property or `path` must be provided
-     */
-    bundleId?: string | undefined;
-    /**
-     * Full path to the app bundle. Either this property
-     * or `bundleId` must be provided
-     */
-    path?: string | undefined;
-    /**
-     * the list of command line arguments
-     * for the app to be be launched with. This parameter is ignored if the app
-     * is already running.
-     */
-    arguments: string[];
-    /**
-     * environment variables mapping. Custom
-     * variables are added to the default process environment.
-     */
-    environment: any;
-};
-export type ActivateAppOptions = {
-    /**
-     * Bundle identifier of the app to be activated.
-     * Either this property or `path` must be provided
-     */
-    bundleId?: string | undefined;
-    /**
-     * Full path to the app bundle. Either this property
-     * or `bundleId` must be provided
-     */
-    path?: string | undefined;
-};
-export type TerminateAppOptions = {
-    /**
-     * Bundle identifier of the app to be terminated.
-     * Either this property or `path` must be provided
-     */
-    bundleId?: string | undefined;
-    /**
-     * Full path to the app bundle. Either this property
-     * or `bundleId` must be provided
-     */
-    path?: string | undefined;
-};
-export type QueryAppStateOptions = {
-    /**
-     * Bundle identifier of the app whose state should be queried.
-     * Either this property or `path` must be provided
-     */
-    bundleId?: string | undefined;
-    /**
-     * Full path to the app bundle. Either this property
-     * or `bundleId` must be provided
-     */
-    path?: string | undefined;
-};
-declare namespace commands {
-    /**
-     * @typedef {Object} LaunchAppOptions
-     * @property {string} [bundleId] Bundle identifier of the app to be launched
-     * or activated. Either this property or `path` must be provided
-     * @property {string} [path] Full path to the app bundle. Either this property
-     * or `bundleId` must be provided
-     * @property {string[]} arguments the list of command line arguments
-     * for the app to be be launched with. This parameter is ignored if the app
-     * is already running.
-     * @property {Object} environment environment variables mapping. Custom
-     * variables are added to the default process environment.
-     */
-    /**
-     * 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.
-     *
-     * @param {LaunchAppOptions} opts
-     */
-    function macosLaunchApp(opts: LaunchAppOptions): Promise<any>;
-    /**
-     * @typedef {Object} ActivateAppOptions
-     * @property {string} [bundleId] Bundle identifier of the app to be activated.
-     * Either this property or `path` must be provided
-     * @property {string} [path] Full path to the app bundle. Either this property
-     * or `bundleId` must be provided
-     */
-    /**
-     * Activate an app with given bundle identifier. An exception is thrown if the
-     * app cannot be found or is not running.
-     *
-     * @param {ActivateAppOptions} opts
-     */
-    function macosActivateApp(opts: ActivateAppOptions): Promise<any>;
-    /**
-     * @typedef {Object} TerminateAppOptions
-     * @property {string} [bundleId] Bundle identifier of the app to be terminated.
-     * Either this property or `path` must be provided
-     * @property {string} [path] Full path to the app bundle. Either this property
-     * or `bundleId` must be provided
-     */
-    /**
-     * Terminate an app with given bundle identifier. An exception is thrown if the
-     * app cannot be found.
-     *
-     * @param {TerminateAppOptions} opts
-     * @returns {Promise<boolean>} `true` if the app was running and has been successfully terminated.
-     * `false` if the app was not running before.
-     */
-    function macosTerminateApp(opts: TerminateAppOptions): Promise<boolean>;
-    /**
-     * @typedef {Object} QueryAppStateOptions
-     * @property {string} [bundleId] Bundle identifier of the app whose state should be queried.
-     * Either this property or `path` must be provided
-     * @property {string} [path] Full path to the app bundle. Either this property
-     * or `bundleId` must be provided
-     */
-    /**
-     * Query an app state with given bundle identifier. An exception is thrown if the
-     * app cannot be found.
-     *
-     * @param {QueryAppStateOptions} opts
-     * @returns {Promise<number>} The application state code. See
-     * https://developer.apple.com/documentation/xctest/xcuiapplicationstate?language=objc
-     * for more details
-     */
-    function macosQueryAppState(opts: QueryAppStateOptions): Promise<number>;
-}
+/**
+ * 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 {import('../types').LaunchAppOptions} [opts={}]
+ */
+export function macosLaunchApp(this: import("../driver").Mac2Driver, opts?: import("../types").LaunchAppOptions | undefined): Promise<unknown>;
+/**
+ * Activate an app with given bundle identifier. An exception is thrown if the
+ * app cannot be found or is not running.
+ *
+ * @this {Mac2Driver}
+ * @param {import('../types').ActivateAppOptions} [opts={}]
+ */
+export function macosActivateApp(this: import("../driver").Mac2Driver, opts?: import("../types").ActivateAppOptions | undefined): Promise<unknown>;
+/**
+ * Terminate an app with given bundle identifier. An exception is thrown if the
+ * app cannot be found.
+ *
+ * @this {Mac2Driver}
+ * @param {import('../types').TerminateAppOptions} opts
+ * @returns {Promise<boolean>} `true` if the app was running and has been successfully terminated.
+ * `false` if the app was not running before.
+ */
+export function macosTerminateApp(this: import("../driver").Mac2Driver, opts: import('../types').TerminateAppOptions): Promise<boolean>;
+/**
+ * Query an app state with given bundle identifier. An exception is thrown if the
+ * app cannot be found.
+ *
+ * @this {Mac2Driver}
+ * @param {import('../types').QueryAppStateOptions} opts
+ * @returns {Promise<number>} The application state code. See
+ * https://developer.apple.com/documentation/xctest/xcuiapplicationstate?language=objc
+ * for more details
+ */
+export function macosQueryAppState(this: import("../driver").Mac2Driver, opts: import('../types').QueryAppStateOptions): Promise<number>;
+export type Mac2Driver = import('../driver').Mac2Driver;
 //# sourceMappingURL=app-management.d.ts.map

package/build/lib/commands/app-management.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app-management.d.ts","sourceRoot":"","sources":["../../../lib/commands/app-management.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;eAQc,MAAM,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IANtB;;;;;;;;;;;OAWG;IAEH;;;;;;OAMG;IACH,8DAQC;IAED;;;;;;OAMG;IAEH;;;;;OAKG;IACH,kEAGC;IAED;;;;;;OAMG;IAEH;;;;;;;OAOG;IACH,wEAGC;IAED;;;;;;OAMG;IAEH;;;;;;;;OAQG;IACH,yEAGC"}
+{"version":3,"file":"app-management.d.ts","sourceRoot":"","sources":["../../../lib/commands/app-management.js"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,+IAQC;AAED;;;;;;GAMG;AACH,mJAGC;AAED;;;;;;;;GAQG;AACH,8EAJW,OAAO,UAAU,EAAE,mBAAmB,GACpC,QAAQ,OAAO,CAAC,CAQ5B;AAED;;;;;;;;;GASG;AACH,+EALW,OAAO,UAAU,EAAE,oBAAoB,GACrC,QAAQ,MAAM,CAAC,CAS3B;yBAGY,OAAO,WAAW,EAAE,UAAU"}

package/build/lib/commands/app-management.js

@@ -1,89 +1,70 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const commands = {};
-/**
- * @typedef {Object} LaunchAppOptions
- * @property {string} [bundleId] Bundle identifier of the app to be launched
- * or activated. Either this property or `path` must be provided
- * @property {string} [path] Full path to the app bundle. Either this property
- * or `bundleId` must be provided
- * @property {string[]} arguments the list of command line arguments
- * for the app to be be launched with. This parameter is ignored if the app
- * is already running.
- * @property {Object} environment environment variables mapping. Custom
- * variables are added to the default process environment.
- */
+exports.macosQueryAppState = exports.macosTerminateApp = exports.macosActivateApp = exports.macosLaunchApp = void 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.
  *
- * @param {LaunchAppOptions} opts
+ * @this {Mac2Driver}
+ * @param {import('../types').LaunchAppOptions} [opts={}]
  */
-commands.macosLaunchApp = async function macosLaunchApp(opts) {
-    const { bundleId, environment, path } = opts ?? {};
+async function macosLaunchApp(opts = {}) {
+    const { bundleId, environment, path } = opts;
     return await this.wda.proxy.command('/wda/apps/launch', 'POST', {
         arguments: opts.arguments,
         environment,
         bundleId,
         path,
     });
-};
-/**
- * @typedef {Object} ActivateAppOptions
- * @property {string} [bundleId] Bundle identifier of the app to be activated.
- * Either this property or `path` must be provided
- * @property {string} [path] Full path to the app bundle. Either this property
- * or `bundleId` must be provided
- */
+}
+exports.macosLaunchApp = macosLaunchApp;
+;
 /**
  * Activate an app with given bundle identifier. An exception is thrown if the
  * app cannot be found or is not running.
  *
- * @param {ActivateAppOptions} opts
+ * @this {Mac2Driver}
+ * @param {import('../types').ActivateAppOptions} [opts={}]
  */
-commands.macosActivateApp = async function macosActivateApp(opts) {
-    const { bundleId, path } = opts ?? {};
+async function macosActivateApp(opts = {}) {
+    const { bundleId, path } = opts;
     return await this.wda.proxy.command('/wda/apps/activate', 'POST', { bundleId, path });
-};
-/**
- * @typedef {Object} TerminateAppOptions
- * @property {string} [bundleId] Bundle identifier of the app to be terminated.
- * Either this property or `path` must be provided
- * @property {string} [path] Full path to the app bundle. Either this property
- * or `bundleId` must be provided
- */
+}
+exports.macosActivateApp = macosActivateApp;
+;
 /**
  * Terminate an app with given bundle identifier. An exception is thrown if the
  * app cannot be found.
  *
- * @param {TerminateAppOptions} opts
+ * @this {Mac2Driver}
+ * @param {import('../types').TerminateAppOptions} opts
  * @returns {Promise<boolean>} `true` if the app was running and has been successfully terminated.
  * `false` if the app was not running before.
  */
-commands.macosTerminateApp = async function macosTerminateApp(opts) {
+async function macosTerminateApp(opts) {
     const { bundleId, path } = opts ?? {};
-    return await this.wda.proxy.command('/wda/apps/terminate', 'POST', { bundleId, path });
-};
-/**
- * @typedef {Object} QueryAppStateOptions
- * @property {string} [bundleId] Bundle identifier of the app whose state should be queried.
- * Either this property or `path` must be provided
- * @property {string} [path] Full path to the app bundle. Either this property
- * or `bundleId` must be provided
- */
+    return /** @type {boolean} */ (await this.wda.proxy.command('/wda/apps/terminate', 'POST', { bundleId, path }));
+}
+exports.macosTerminateApp = macosTerminateApp;
+;
 /**
  * Query an app state with given bundle identifier. An exception is thrown if the
  * app cannot be found.
  *
- * @param {QueryAppStateOptions} opts
+ * @this {Mac2Driver}
+ * @param {import('../types').QueryAppStateOptions} opts
  * @returns {Promise<number>} The application state code. See
  * https://developer.apple.com/documentation/xctest/xcuiapplicationstate?language=objc
  * for more details
  */
-commands.macosQueryAppState = async function macosQueryAppState(opts) {
+async function macosQueryAppState(opts) {
     const { bundleId, path } = opts ?? {};
-    return await this.wda.proxy.command('/wda/apps/state', 'POST', { bundleId, path });
-};
-exports.default = commands;
+    return /** @type {number} */ (await this.wda.proxy.command('/wda/apps/state', 'POST', { bundleId, path }));
+}
+exports.macosQueryAppState = macosQueryAppState;
+;
+/**
+ * @typedef {import('../driver').Mac2Driver} Mac2Driver
+ */
 //# sourceMappingURL=app-management.js.map

package/build/lib/commands/app-management.js.map

@@ -1 +1 @@
-{"version":3,"file":"app-management.js","sourceRoot":"","sources":["../../../lib/commands/app-management.js"],"names":[],"mappings":";;AAAA,MAAM,QAAQ,GAAG,EAAE,CAAC;AAEpB;;;;;;;;;;;GAWG;AAEH;;;;;;GAMG;AACH,QAAQ,CAAC,cAAc,GAAG,KAAK,UAAU,cAAc,CAAE,IAAI;IAC3D,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;IACnD,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,kBAAkB,EAAE,MAAM,EAAE;QAC9D,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,WAAW;QACX,QAAQ;QACR,IAAI;KACL,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;GAMG;AAEH;;;;;GAKG;AACH,QAAQ,CAAC,gBAAgB,GAAG,KAAK,UAAU,gBAAgB,CAAE,IAAI;IAC/D,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;IACtC,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,oBAAoB,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;AACxF,CAAC,CAAC;AAEF;;;;;;GAMG;AAEH;;;;;;;GAOG;AACH,QAAQ,CAAC,iBAAiB,GAAG,KAAK,UAAU,iBAAiB,CAAE,IAAI;IACjE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;IACtC,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;AACzF,CAAC,CAAC;AAEF;;;;;;GAMG;AAEH;;;;;;;;GAQG;AACH,QAAQ,CAAC,kBAAkB,GAAG,KAAK,UAAU,kBAAkB,CAAE,IAAI;IACnE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;IACtC,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;AACrF,CAAC,CAAC;AAEF,kBAAe,QAAQ,CAAC"}
+{"version":3,"file":"app-management.js","sourceRoot":"","sources":["../../../lib/commands/app-management.js"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACI,KAAK,UAAU,cAAc,CAAE,IAAI,GAAG,EAAE;IAC7C,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAC7C,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,kBAAkB,EAAE,MAAM,EAAE;QAC9D,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,WAAW;QACX,QAAQ;QACR,IAAI;KACL,CAAC,CAAC;AACL,CAAC;AARD,wCAQC;AAAA,CAAC;AAEF;;;;;;GAMG;AACI,KAAK,UAAU,gBAAgB,CAAE,IAAI,GAAG,EAAE;IAC/C,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAChC,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,oBAAoB,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;AACxF,CAAC;AAHD,4CAGC;AAAA,CAAC;AAEF;;;;;;;;GAQG;AACI,KAAK,UAAU,iBAAiB,CAAE,IAAI;IAC3C,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;IACtC,OAAO,sBAAsB,CAAC,CAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAChF,CAAC;AACJ,CAAC;AALD,8CAKC;AAAA,CAAC;AAEF;;;;;;;;;GASG;AACI,KAAK,UAAU,kBAAkB,CAAE,IAAI;IAC5C,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;IACtC,OAAO,qBAAqB,CAAC,CAC3B,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAC5E,CAAC;AACJ,CAAC;AALD,gDAKC;AAAA,CAAC;AAEF;;GAEG"}

package/build/lib/commands/applescript.d.ts

@@ -1,57 +1,20 @@
-export default commands;
-export type ExecAppleScriptOptions = {
-    /**
-     * A valid AppleScript to execute
-     */
-    script: string;
-    /**
-     * Overrides the scripting language. Basically, sets the value of `-l` command
-     * line argument of `osascript` tool. If unset the AppleScript language is assumed.
-     */
-    language: string;
-    /**
-     * A valid AppleScript as a single command (no line breaks) to execute
-     */
-    command: string;
-    /**
-     * [20000] The number of seconds to wait until a long-running command is
-     * finished. An error is thrown if the command is still running after this timeout expires.
-     */
-    timeout: number;
-    /**
-     * The path to an existing folder, which is going to be set as the
-     * working directory for the command/script being executed.
-     */
-    cwd: string;
-};
-export namespace commands {
-    /**
-     * @typedef {Object} ExecAppleScriptOptions
-     * @property {string} script A valid AppleScript to execute
-     * @property {string} language Overrides the scripting language. Basically, sets the value of `-l` command
-     * line argument of `osascript` tool. If unset the AppleScript language is assumed.
-     * @property {string} command A valid AppleScript as a single command (no line breaks) to execute
-     * @property {number} timeout [20000] The number of seconds to wait until a long-running command is
-     * finished. An error is thrown if the command is still running after this timeout expires.
-     * @property {string} cwd The path to an existing folder, which is going to be set as the
-     * working directory for the command/script being executed.
-     */
-    /**
-     * Executes the given AppleScript command or a whole script based on the
-     * given options. Either of these options must be provided. If both are provided
-     * then the `command` one gets the priority.
-     * Note that AppleScript command cannot contain line breaks. Consider making it
-     * to a script in such case.
-     * Note that by default AppleScript engine blocks commands/scripts execution if your script
-     * is trying to access some private entities, like cameras or the desktop screen
-     * and no permissions to do it are given to the parent (for example, Appium or Terminal)
-     * process in System Preferences -> Privacy list.
-     *
-     * @param {ExecAppleScriptOptions} opts
-     * @returns {Promise<string>} The actual stdout of the given command/script
-     * @throws {Error} If the exit code of the given command/script is not zero.
-     * The actual stderr output is set to the error message value.
-     */
-    function macosExecAppleScript(opts: ExecAppleScriptOptions): Promise<string>;
-}
+/**
+ * Executes the given AppleScript command or a whole script based on the
+ * given options. Either of these options must be provided. If both are provided
+ * then the `command` one gets the priority.
+ * Note that AppleScript command cannot contain line breaks. Consider making it
+ * to a script in such case.
+ * Note that by default AppleScript engine blocks commands/scripts execution if your script
+ * is trying to access some private entities, like cameras or the desktop screen
+ * and no permissions to do it are given to the parent (for example, Appium or Terminal)
+ * process in System Preferences -> Privacy list.
+ *
+ * @this {Mac2Driver}
+ * @param {import('../types').ExecAppleScriptOptions} opts
+ * @returns {Promise<string>} The actual stdout of the given command/script
+ * @throws {Error} If the exit code of the given command/script is not zero.
+ * The actual stderr output is set to the error message value.
+ */
+export function macosExecAppleScript(this: import("../driver").Mac2Driver, opts?: import('../types').ExecAppleScriptOptions): Promise<string>;
+export type Mac2Driver = import('../driver').Mac2Driver;
 //# sourceMappingURL=applescript.d.ts.map

package/build/lib/commands/applescript.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"applescript.d.ts","sourceRoot":"","sources":["../../../lib/commands/applescript.js"],"names":[],"mappings":";;;;;YAYc,MAAM;;;;;cACN,MAAM;;;;aAEN,MAAM;;;;;aACN,MAAM;;;;;SAEN,MAAM;;;IARpB;;;;;;;;;;OAUG;IAEH;;;;;;;;;;;;;;;OAeG;IACH,6EA6CC"}
+{"version":3,"file":"applescript.d.ts","sourceRoot":"","sources":["../../../lib/commands/applescript.js"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;GAgBG;AACH,kFALW,OAAO,UAAU,EAAE,sBAAsB,GACvC,QAAQ,MAAM,CAAC,CAiD3B;yBAGY,OAAO,WAAW,EAAE,UAAU"}

package/build/lib/commands/applescript.js

@@ -3,26 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.commands = void 0;
+exports.macosExecAppleScript = void 0;
 const support_1 = require("appium/support");
 const teen_process_1 = require("teen_process");
-const logger_1 = __importDefault(require("../logger"));
 const path_1 = __importDefault(require("path"));
 const OSASCRIPT = 'osascript';
 const APPLE_SCRIPT_FEATURE = 'apple_script';
-const commands = {};
-exports.commands = commands;
-/**
- * @typedef {Object} ExecAppleScriptOptions
- * @property {string} script A valid AppleScript to execute
- * @property {string} language Overrides the scripting language. Basically, sets the value of `-l` command
- * line argument of `osascript` tool. If unset the AppleScript language is assumed.
- * @property {string} command A valid AppleScript as a single command (no line breaks) to execute
- * @property {number} timeout [20000] The number of seconds to wait until a long-running command is
- * finished. An error is thrown if the command is still running after this timeout expires.
- * @property {string} cwd The path to an existing folder, which is going to be set as the
- * working directory for the command/script being executed.
- */
 /**
  * Executes the given AppleScript command or a whole script based on the
  * given options. Either of these options must be provided. If both are provided
@@ -34,19 +20,20 @@ exports.commands = commands;
  * and no permissions to do it are given to the parent (for example, Appium or Terminal)
  * process in System Preferences -> Privacy list.
  *
- * @param {ExecAppleScriptOptions} opts
+ * @this {Mac2Driver}
+ * @param {import('../types').ExecAppleScriptOptions} opts
  * @returns {Promise<string>} The actual stdout of the given command/script
  * @throws {Error} If the exit code of the given command/script is not zero.
  * The actual stderr output is set to the error message value.
  */
-commands.macosExecAppleScript = async function macosExecAppleScript(opts) {
+async function macosExecAppleScript(opts = {}) {
     this.ensureFeatureEnabled(APPLE_SCRIPT_FEATURE);
-    const { script, language, command, cwd, timeout, } = opts ?? {};
+    const { script, language, command, cwd, timeout, } = opts;
     if (!script && !command) {
-        logger_1.default.errorAndThrow('AppleScript script/command must not be empty');
+        this.log.errorAndThrow('AppleScript script/command must not be empty');
     }
-    if (/\n/.test(command)) {
-        logger_1.default.errorAndThrow('AppleScript commands cannot contain line breaks');
+    if (/\n/.test(/** @type {string} */ (command))) {
+        this.log.errorAndThrow('AppleScript commands cannot contain line breaks');
     }
     // 'command' has priority over 'script'
     const shouldRunScript = !command;
@@ -59,13 +46,13 @@ commands.macosExecAppleScript = async function macosExecAppleScript(opts) {
         if (shouldRunScript) {
             tmpRoot = await support_1.tempDir.openDir();
             const tmpScriptPath = path_1.default.resolve(tmpRoot, 'appium_script.scpt');
-            await support_1.fs.writeFile(tmpScriptPath, script, 'utf8');
+            await support_1.fs.writeFile(tmpScriptPath, /** @type {string} */ (script), 'utf8');
             args.push(tmpScriptPath);
         }
         else {
             args.push('-e', command);
         }
-        logger_1.default.info(`Running ${OSASCRIPT} with arguments: ${support_1.util.quote(args)}`);
+        this.log.info(`Running ${OSASCRIPT} with arguments: ${support_1.util.quote(args)}`);
         try {
             const { stdout } = await (0, teen_process_1.exec)(OSASCRIPT, args, { cwd, timeout });
             return stdout;
@@ -79,6 +66,10 @@ commands.macosExecAppleScript = async function macosExecAppleScript(opts) {
             await support_1.fs.rimraf(tmpRoot);
         }
     }
-};
-exports.default = commands;
+}
+exports.macosExecAppleScript = macosExecAppleScript;
+;
+/**
+ * @typedef {import('../driver').Mac2Driver} Mac2Driver
+ */
 //# sourceMappingURL=applescript.js.map

package/build/lib/commands/applescript.js.map

@@ -1 +1 @@
-{"version":3,"file":"applescript.js","sourceRoot":"","sources":["../../../lib/commands/applescript.js"],"names":[],"mappings":";;;;;;AAAA,4CAAmD;AACnD,+CAAoC;AACpC,uDAA4B;AAC5B,gDAAwB;AAExB,MAAM,SAAS,GAAG,WAAW,CAAC;AAC9B,MAAM,oBAAoB,GAAG,cAAc,CAAC;AAE5C,MAAM,QAAQ,GAAG,EAAE,CAAC;AA6EX,4BAAQ;AA3EjB;;;;;;;;;;GAUG;AAEH;;;;;;;;;;;;;;;GAeG;AACH,QAAQ,CAAC,oBAAoB,GAAG,KAAK,UAAU,oBAAoB,CAAE,IAAI;IACvE,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;IAEhD,MAAM,EACJ,MAAM,EACN,QAAQ,EACR,OAAO,EACP,GAAG,EACH,OAAO,GACR,GAAG,IAAI,IAAI,EAAE,CAAC;IACf,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACxB,gBAAG,CAAC,aAAa,CAAC,8CAA8C,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACvB,gBAAG,CAAC,aAAa,CAAC,iDAAiD,CAAC,CAAC;IACvE,CAAC;IACD,uCAAuC;IACvC,MAAM,eAAe,GAAG,CAAC,OAAO,CAAC;IAEjC,MAAM,IAAI,GAAG,EAAE,CAAC;IAChB,IAAI,QAAQ,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC5B,CAAC;IACD,IAAI,OAAO,CAAC;IACZ,IAAI,CAAC;QACH,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,GAAG,MAAM,iBAAO,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,aAAa,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;YAClE,MAAM,YAAE,CAAC,SAAS,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;YAClD,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC3B,CAAC;QACD,gBAAG,CAAC,IAAI,CAAC,WAAW,SAAS,oBAAoB,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC;YACH,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,SAAS,EAAE,IAAI,EAAE,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC,CAAC;YAC7D,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;YAAS,CAAC;QACT,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,YAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAGF,kBAAe,QAAQ,CAAC"}
+{"version":3,"file":"applescript.js","sourceRoot":"","sources":["../../../lib/commands/applescript.js"],"names":[],"mappings":";;;;;;AAAA,4CAAmD;AACnD,+CAAoC;AACpC,gDAAwB;AAExB,MAAM,SAAS,GAAG,WAAW,CAAC;AAC9B,MAAM,oBAAoB,GAAG,cAAc,CAAC;AAE5C;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,oBAAoB,CAAE,IAAI,GAAG,EAAE;IACnD,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;IAEhD,MAAM,EACJ,MAAM,EACN,QAAQ,EACR,OAAO,EACP,GAAG,EACH,OAAO,GACR,GAAG,IAAI,CAAC;IACT,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACxB,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,8CAA8C,CAAC,CAAC;IACzE,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAA,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QAC9C,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,iDAAiD,CAAC,CAAC;IAC5E,CAAC;IACD,uCAAuC;IACvC,MAAM,eAAe,GAAG,CAAC,OAAO,CAAC;IAEjC,MAAM,IAAI,GAAG,EAAE,CAAC;IAChB,IAAI,QAAQ,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC5B,CAAC;IACD,IAAI,OAAO,CAAC;IACZ,IAAI,CAAC;QACH,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,GAAG,MAAM,iBAAO,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,aAAa,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;YAClE,MAAM,YAAE,CAAC,SAAS,CAAC,aAAa,EAAE,qBAAqB,CAAA,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;YACzE,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,SAAS,oBAAoB,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1E,IAAI,CAAC;YACH,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,SAAS,EAAE,IAAI,EAAE,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC,CAAC;YAC7D,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;YAAS,CAAC;QACT,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,YAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;AACH,CAAC;AA7CD,oDA6CC;AAAA,CAAC;AAEF;;GAEG"}

package/build/lib/commands/execute.d.ts

@@ -1,6 +1,18 @@
-export default commands;
-declare namespace commands {
-    function execute(script: any, args: any): Promise<any>;
-    function executeMacosCommand(command: any, opts?: {}): Promise<any>;
-}
+/**
+ *
+ * @this {Mac2Driver}
+ * @param {string} script
+ * @param {any[]|import('@appium/types').StringRecord} [args]
+ * @returns {Promise<any>}
+ */
+export function execute(this: import("../driver").Mac2Driver, script: string, args?: any[] | import("@appium/types").StringRecord<any> | undefined): Promise<any>;
+/**
+ *
+ * @this {Mac2Driver}
+ * @param {string} command
+ * @param {import('@appium/types').StringRecord} [opts={}]
+ * @returns {Promise<any>}
+ */
+export function executeMacosCommand(this: import("../driver").Mac2Driver, command: string, opts?: import("@appium/types").StringRecord<any> | undefined): Promise<any>;
+export type Mac2Driver = import('../driver').Mac2Driver;
 //# sourceMappingURL=execute.d.ts.map

package/build/lib/commands/execute.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"execute.d.ts","sourceRoot":"","sources":["../../../lib/commands/execute.js"],"names":[],"mappings":";;IAyCA,uDAOC;IAED,oEAMC"}
+{"version":3,"file":"execute.d.ts","sourceRoot":"","sources":["../../../lib/commands/execute.js"],"names":[],"mappings":"AAsCA;;;;;;GAMG;AACH,sEAJW,MAAM,yEAEJ,QAAQ,GAAG,CAAC,CASxB;AAED;;;;;;GAMG;AACH,mFAJW,MAAM,iEAEJ,QAAQ,GAAG,CAAC,CAQxB;yBAGY,OAAO,WAAW,EAAE,UAAU"}

package/build/lib/commands/execute.js

@@ -3,10 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeMacosCommand = exports.execute = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const driver_1 = require("appium/driver");
-const logger_1 = __importDefault(require("../logger"));
-const commands = {};
 const EXTENSION_COMMANDS_MAPPING = {
     setValue: 'macosSetValue',
     click: 'macosClick',
@@ -34,20 +33,40 @@ const EXTENSION_COMMANDS_MAPPING = {
     screenshots: 'macosScreenshots',
     deepLink: 'macosDeepLink',
 };
-commands.execute = async function execute(script, args) {
+/**
+ *
+ * @this {Mac2Driver}
+ * @param {string} script
+ * @param {any[]|import('@appium/types').StringRecord} [args]
+ * @returns {Promise<any>}
+ */
+async function execute(script, args) {
     if (script.match(/^macos:/)) {
-        logger_1.default.info(`Executing extension command '${script}'`);
+        this.log.info(`Executing extension command '${script}'`);
         script = script.replace(/^macos:/, '').trim();
         return await this.executeMacosCommand(script, lodash_1.default.isArray(args) ? args[0] : args);
     }
     throw new driver_1.errors.NotImplementedError();
-};
-commands.executeMacosCommand = async function executeMacosCommand(command, opts = {}) {
+}
+exports.execute = execute;
+;
+/**
+ *
+ * @this {Mac2Driver}
+ * @param {string} command
+ * @param {import('@appium/types').StringRecord} [opts={}]
+ * @returns {Promise<any>}
+ */
+async function executeMacosCommand(command, opts = {}) {
     if (!lodash_1.default.has(EXTENSION_COMMANDS_MAPPING, command)) {
         throw new driver_1.errors.UnknownCommandError(`Unknown extension command "${command}". ` +
             `Only ${lodash_1.default.keys(EXTENSION_COMMANDS_MAPPING)} commands are supported.`);
     }
     return await this[EXTENSION_COMMANDS_MAPPING[command]](opts);
-};
-exports.default = commands;
+}
+exports.executeMacosCommand = executeMacosCommand;
+;
+/**
+ * @typedef {import('../driver').Mac2Driver} Mac2Driver
+ */
 //# sourceMappingURL=execute.js.map

package/build/lib/commands/execute.js.map

@@ -1 +1 @@
-{"version":3,"file":"execute.js","sourceRoot":"","sources":["../../../lib/commands/execute.js"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AACvB,0CAAuC;AACvC,uDAA4B;AAE5B,MAAM,QAAQ,GAAG,EAAE,CAAC;AAEpB,MAAM,0BAA0B,GAAG;IACjC,QAAQ,EAAE,eAAe;IACzB,KAAK,EAAE,YAAY;IACnB,MAAM,EAAE,aAAa;IACrB,KAAK,EAAE,YAAY;IACnB,UAAU,EAAE,iBAAiB;IAC7B,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,kBAAkB;IAC/B,YAAY,EAAE,mBAAmB;IACjC,mBAAmB,EAAE,0BAA0B;IAC/C,IAAI,EAAE,WAAW;IAEjB,GAAG,EAAE,UAAU;IACf,SAAS,EAAE,gBAAgB;IAC3B,KAAK,EAAE,YAAY;IACnB,YAAY,EAAE,mBAAmB;IACjC,mBAAmB,EAAE,0BAA0B;IAE/C,MAAM,EAAE,aAAa;IAErB,SAAS,EAAE,gBAAgB;IAC3B,WAAW,EAAE,kBAAkB;IAC/B,YAAY,EAAE,mBAAmB;IACjC,aAAa,EAAE,oBAAoB;IAEnC,WAAW,EAAE,sBAAsB;IAEnC,oBAAoB,EAAE,sBAAsB;IAC5C,mBAAmB,EAAE,qBAAqB;IAE1C,WAAW,EAAE,kBAAkB;IAE/B,QAAQ,EAAE,eAAe;CAC1B,CAAC;AAEF,QAAQ,CAAC,OAAO,GAAG,KAAK,UAAU,OAAO,CAAE,MAAM,EAAE,IAAI;IACrD,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,gBAAG,CAAC,IAAI,CAAC,gCAAgC,MAAM,GAAG,CAAC,CAAC;QACpD,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC9C,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAClF,CAAC;IACD,MAAM,IAAI,eAAM,CAAC,mBAAmB,EAAE,CAAC;AACzC,CAAC,CAAC;AAEF,QAAQ,CAAC,mBAAmB,GAAG,KAAK,UAAU,mBAAmB,CAAE,OAAO,EAAE,IAAI,GAAG,EAAE;IACnF,IAAI,CAAC,gBAAC,CAAC,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,8BAA8B,OAAO,KAAK;YAC7E,QAAQ,gBAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,0BAA0B,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO,MAAM,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF,kBAAe,QAAQ,CAAC"}
+{"version":3,"file":"execute.js","sourceRoot":"","sources":["../../../lib/commands/execute.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,0CAAuC;AAEvC,MAAM,0BAA0B,GAAG;IACjC,QAAQ,EAAE,eAAe;IACzB,KAAK,EAAE,YAAY;IACnB,MAAM,EAAE,aAAa;IACrB,KAAK,EAAE,YAAY;IACnB,UAAU,EAAE,iBAAiB;IAC7B,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,kBAAkB;IAC/B,YAAY,EAAE,mBAAmB;IACjC,mBAAmB,EAAE,0BAA0B;IAC/C,IAAI,EAAE,WAAW;IAEjB,GAAG,EAAE,UAAU;IACf,SAAS,EAAE,gBAAgB;IAC3B,KAAK,EAAE,YAAY;IACnB,YAAY,EAAE,mBAAmB;IACjC,mBAAmB,EAAE,0BAA0B;IAE/C,MAAM,EAAE,aAAa;IAErB,SAAS,EAAE,gBAAgB;IAC3B,WAAW,EAAE,kBAAkB;IAC/B,YAAY,EAAE,mBAAmB;IACjC,aAAa,EAAE,oBAAoB;IAEnC,WAAW,EAAE,sBAAsB;IAEnC,oBAAoB,EAAE,sBAAsB;IAC5C,mBAAmB,EAAE,qBAAqB;IAE1C,WAAW,EAAE,kBAAkB;IAE/B,QAAQ,EAAE,eAAe;CAC1B,CAAC;AAEF;;;;;;GAMG;AACI,KAAK,UAAU,OAAO,CAAE,MAAM,EAAE,IAAI;IACzC,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gCAAgC,MAAM,GAAG,CAAC,CAAC;QACzD,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC9C,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAClF,CAAC;IACD,MAAM,IAAI,eAAM,CAAC,mBAAmB,EAAE,CAAC;AACzC,CAAC;AAPD,0BAOC;AAAA,CAAC;AAEF;;;;;;GAMG;AACI,KAAK,UAAU,mBAAmB,CAAE,OAAO,EAAE,IAAI,GAAG,EAAE;IAC3D,IAAI,CAAC,gBAAC,CAAC,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,8BAA8B,OAAO,KAAK;YAC7E,QAAQ,gBAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,0BAA0B,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO,MAAM,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC/D,CAAC;AAND,kDAMC;AAAA,CAAC;AAEF;;GAEG"}

package/build/lib/commands/find.d.ts

@@ -1,5 +1,13 @@
-export default commands;
-export namespace commands {
-    function findElOrEls(strategy: any, selector: any, mult: any, context: any): Promise<any>;
-}
+/**
+ * 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 function findElOrEls(this: import("../driver").Mac2Driver, strategy: string, selector: string, mult: boolean, context?: string | undefined): Promise<any>;
+export type Mac2Driver = import('../driver').Mac2Driver;
 //# sourceMappingURL=find.d.ts.map

package/build/lib/commands/find.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../../lib/commands/find.js"],"names":[],"mappings":";;IAMA,0FAcC"}
+{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../../lib/commands/find.js"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AACH,4EANW,MAAM,YACN,MAAM,QACN,OAAO,iCAEL,QAAQ,GAAG,CAAC,CAgBxB;yBAGY,OAAO,WAAW,EAAE,UAAU"}