appium-mac2-driver 1.15.0 → 1.17.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [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)
+
+
+### Features
+
+* Add initialDeeplinkUrl capability ([#297](https://github.com/appium/appium-mac2-driver/issues/297)) ([6dee2e8](https://github.com/appium/appium-mac2-driver/commit/6dee2e87c310d23b1a2819b6633d63ee249477d3))
+
 ## [1.15.0](https://github.com/appium/appium-mac2-driver/compare/v1.14.0...v1.15.0) (2024-04-19)
 
 

package/README.md

@@ -54,7 +54,8 @@ appium:postrun | An object containing either `script` or `command` key. The valu
 appium:noReset | Whether to restart the app whose bundle identifier was passed to capabilities as `bundleId` value if it was already running on the session startup (`false`, the default value) or just pick it up without changing the app state (`true`). Note that neither of `arguments` or `environment` capabilities will take effect if the app did not restart.
 appium:appPath | The path to the application to automate, for example `/Applications/MyAppName.app`. This is an optional capability, but it requires `bundleId` to be present until mac2 driver v1.13.0. In earlier versions if `bundleId` is empty, `appPath` would be ignored. If the path is invalid or application is damaged/incomplete then an error will be thrown on session startup. This capability could be useful when you have multiple builds of the same application with the same bundleId on your machine (for example one production build in /Applications/ and several dev builds). If you provide bundleId only, the operating system could open any of these builds. By providing `appPath` you have a guarantee that the specified .app will be launched, rather than a random one.
 appium:appLocale | A dictionary with the following possible entries: `locale` (application locale name, for example `uk_UA`), `language` (application language name, for example `de`), `useMetricUnits` (whether to use metric units for the app, if `false` then imperial units are used), `measurementUnits` (the name of measurement units to use in the app, for example `Inches`). This capability only changes the locale for the app under test, it does not modify the system locale. You can achieve the same effect by providing custom values to reserved app command line arguments like `-AppleLanguages` or `-AppleLocale` using the `appium:arguments` capability. Example: use `appLocale = {locale: "de", language: "de_DE"}` to start the app in German language (if no German resources are defined in the destination app bundle then the app is started with the default locale, usually en_US).
-| `appium:appTimeZone` | Defines the custom time zone override for the application under test. You can use UTC, PST, EST, as well as place-based timezone names such as America/Los_Angeles. The application must be (re)launched for the capability to take effect. See the [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for more details. The same behavior could be achieved by providing a custom value to the [TZ](https://developer.apple.com/forums/thread/86951#263395) environment variable via the `appium:environment` capability | UTC |
+appium:appTimeZone | Defines the custom time zone override for the application under test. You can use UTC, PST, EST, as well as place-based timezone names such as America/Los_Angeles. The application must be (re)launched for the capability to take effect. See the [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for more details. The same behavior could be achieved by providing a custom value to the [TZ](https://developer.apple.com/forums/thread/86951#263395) environment variable via the `appium:environment` capability
+appium:initialDeeplinkUrl | A deeplink URL used to run either the application assigned to `appium:bundleId`, or the default application assigned to handle the particular deeplink protocol if `appium:bundleId` is not set. An error is thrown on session init if either the value of the capability is not a valid URL, or XCTest was not able to associate it with any existing app, or the actual Xcode version is below *14.3*
 
 ## Element Attributes
 

package/WebDriverAgentMac/WebDriverAgentLib/Commands/FBSessionCommands.m

@@ -97,10 +97,24 @@ const static NSString *CAPABILITIES_KEY = @"capabilities";
 
   NSString *bundleID = requirements[AM_BUNDLE_ID_CAPABILITY];
   NSString *appPath = requirements[AM_APP_PATH_CAPABILITY];
+  NSString *deepLink = requirements[AM_INITIAL_DEEPLINK_URL_CAPABILITY];
   BOOL noReset = [requirements[AM_NO_RESET_CAPABILITY] boolValue];
   FBSession *session;
-  if (nil == bundleID && nil == appPath) {
+  if (nil == bundleID && nil == appPath && nil == deepLink) {
     session = [FBSession initWithApplication:nil];
+  } else if (nil != deepLink) {
+    NSURL *url = [NSURL URLWithString:deepLink];
+    NSError *error;
+    BOOL success = nil == bundleID
+      ? [AMXCUIDeviceWrapper.sharedDevice openUrl:url error:&error]
+      : [AMXCUIDeviceWrapper.sharedDevice openUrl:url withApplication:bundleID error:&error];
+    if (!success) {
+      return FBResponseWithStatus([FBCommandStatus sessionNotCreatedError:error.localizedDescription
+                                                                traceback:nil]);
+    }
+    if (nil != bundleID) {
+      session = [FBSession initWithApplication:[[XCUIApplication alloc] initWithBundleIdentifier:bundleID]];
+    }
   } else {
     XCUIApplication *app = nil != appPath 
       ? [[XCUIApplication alloc] initWithURL:[NSURL fileURLWithPath:appPath]]

package/WebDriverAgentMac/WebDriverAgentLib/Utilities/AMSessionCapabilities.h

@@ -34,5 +34,7 @@ extern NSString* const AM_APP_PATH_CAPABILITY;
 extern NSString* const AM_APP_TIME_ZONE_CAPABILITY;
 /** Custom locale properties for the application under test */
 extern NSString* const AM_APP_LOCALE_CAPABILITY;
+/** Deeplink URL to start the session with */
+extern NSString* const AM_INITIAL_DEEPLINK_URL_CAPABILITY;
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentMac/WebDriverAgentLib/Utilities/AMSessionCapabilities.m

@@ -24,3 +24,4 @@ NSString* const AM_NO_RESET_CAPABILITY = @"noReset";
 NSString* const AM_APP_PATH_CAPABILITY = @"appPath";
 NSString* const AM_APP_TIME_ZONE_CAPABILITY = @"appTimeZone";
 NSString* const AM_APP_LOCALE_CAPABILITY = @"appLocale";
+NSString* const AM_INITIAL_DEEPLINK_URL_CAPABILITY = @"initialDeeplinkUrl";

package/WebDriverAgentMac/WebDriverAgentLib/Utilities/AMXCUIDeviceWrapper.m

@@ -42,24 +42,24 @@
 
 - (BOOL)supportsOpenUrl
 {
-  id<XCUIApplicationProcessManaging> platformApplicationManager = [self am_platformApplicationManager];
+  id<XCUIApplicationProcessManaging> platformApplicationManager = [self platformApplicationManager];
   return nil != platformApplicationManager
     && [(NSObject *)platformApplicationManager respondsToSelector:@selector(openDefaultApplicationForURL:completion:)];
 }
 
-- (id<XCUIApplicationProcessManaging>)am_platformApplicationManager
+- (id<XCUIApplicationProcessManaging>)platformApplicationManager
 {
   return [self.xcuiDeviceInstance valueForKey:@"platformApplicationManager"];
 }
 
-- (id<XCUIEventSynthesizing>)am_eventSynthesizer
+- (id<XCUIEventSynthesizing>)eventSynthesizer
 {
   return [self.xcuiDeviceInstance valueForKey:@"eventSynthesizer"];
 }
 
 - (BOOL)openUrl:(NSURL *)url error:(NSError **)error
 {
-  id<XCUIApplicationProcessManaging> platformApplicationManager = [self am_platformApplicationManager];
+  id<XCUIApplicationProcessManaging> platformApplicationManager = [self platformApplicationManager];
   if (nil == platformApplicationManager 
       || ![(NSObject *)platformApplicationManager respondsToSelector:@selector(openDefaultApplicationForURL:completion:)]) {
     NSString *description = [NSString stringWithFormat:@"Cannot open '%@' with the default application assigned for it. Consider upgrading to Xcode 14.3+", url];
@@ -91,7 +91,7 @@
 withApplication:(NSString *)bundleId
           error:(NSError **)error
 {
-  id<XCUIApplicationProcessManaging> platformApplicationManager = [self am_platformApplicationManager];
+  id<XCUIApplicationProcessManaging> platformApplicationManager = [self platformApplicationManager];
   if (nil == platformApplicationManager 
       || ![(NSObject *)platformApplicationManager respondsToSelector:@selector(openURL:usingApplication:completion:)]) {
     NSString *description = [NSString stringWithFormat:@"Cannot open '%@' with the default application assigned for it. Consider upgrading to Xcode 14.3+", url];
@@ -125,7 +125,7 @@ withApplication:(NSString *)bundleId
 {
   __block NSError *internalError = nil;
   dispatch_semaphore_t sem = dispatch_semaphore_create(0);
-  id<XCUIEventSynthesizing> eventSynthesizer = [self am_eventSynthesizer];
+  id<XCUIEventSynthesizing> eventSynthesizer = [self eventSynthesizer];
   [eventSynthesizer synthesizeEvent:event
                          completion:(id)^(BOOL result, NSError *invokeError) {
     if (!result) {

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