appium-android-driver 12.4.7 → 12.4.8

package/build/lib/commands/intent.js

@@ -31,18 +31,19 @@ const SUPPORTED_EXTRA_TYPES = [
     'sal',
 ];
 /**
- * @deprecated
- * @this {import('../driver').AndroidDriver}
- * @param {string} appPackage
- * @param {string} appActivity
- * @param {string} [appWaitPackage]
- * @param {string} [appWaitActivity]
- * @param {string} [intentAction]
- * @param {string} [intentCategory]
- * @param {string} [intentFlags]
- * @param {string} [optionalIntentArguments]
- * @param {boolean} [dontStopAppOnReset]
- * @returns {Promise<void>}
+ * Starts an Android activity.
+ *
+ * @deprecated Use {@link mobileStartActivity} instead.
+ * @param appPackage The package name of the application to start.
+ * @param appActivity The activity name to start.
+ * @param appWaitPackage The package name to wait for. Defaults to `appPackage` if not provided.
+ * @param appWaitActivity The activity name to wait for. Defaults to `appActivity` if not provided.
+ * @param intentAction The intent action to use.
+ * @param intentCategory The intent category to use.
+ * @param intentFlags The intent flags to use.
+ * @param optionalIntentArguments Optional intent arguments.
+ * @param dontStopAppOnReset If `true`, does not stop the app on reset. If not provided, uses the capability value.
+ * @returns Promise that resolves when the activity is started.
  */
 async function startActivity(appPackage, appActivity, appWaitPackage, appWaitActivity, intentAction, intentCategory, intentFlags, optionalIntentArguments, dontStopAppOnReset) {
     this.log.debug(`Starting package '${appPackage}' and activity '${appActivity}'`);
@@ -51,8 +52,7 @@ async function startActivity(appPackage, appActivity, appWaitPackage, appWaitAct
     if (!support_1.util.hasValue(dontStopAppOnReset)) {
         dontStopAppOnReset = !!this.opts.dontStopAppOnReset;
     }
-    /** @type {import('appium-adb').StartAppOptions} */
-    let args = {
+    const args = {
         pkg: appPackage,
         activity: appActivity,
         waitPkg: appWaitPackage || appPackage,
@@ -68,34 +68,35 @@ async function startActivity(appPackage, appActivity, appWaitPackage, appWaitAct
     await this.adb.startApp(args);
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {boolean} [wait] Set it to `true` if you want to block the method call
+ * Starts an Android activity using the activity manager.
+ *
+ * @param wait Set it to `true` if you want to block the method call
  * until the activity manager's process returns the control to the system.
- * false by default.
- * @param {boolean} [stop] Set it to `true` to force stop the target
- * app before starting the activity
- * false by default.
- * @param {string | number} [windowingMode] The windowing mode to launch the activity into.
- * Check
- * https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/app/WindowConfiguration.java
- * for more details on possible windowing modes (constants starting with
- * `WINDOWING_MODE_`).
- * @param {string | number} [activityType] The activity type to launch the activity as.
+ * `false` by default.
+ * @param stop Set it to `true` to force stop the target
+ * app before starting the activity. `false` by default.
+ * @param windowingMode The windowing mode to launch the activity into.
+ * Check https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/app/WindowConfiguration.java
+ * for more details on possible windowing modes (constants starting with `WINDOWING_MODE_`).
+ * @param activityType The activity type to launch the activity as.
  * Check https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/app/WindowConfiguration.java
  * for more details on possible activity types (constants starting with `ACTIVITY_TYPE_`).
- * @param {number | string} [display] The display identifier to launch the activity into.
- * @param {string} [user]
- * @param {string} [intent]
- * @param {string} [action]
- * @param {string} [pkg]
- * @param {string} [uri]
- * @param {string} [mimeType]
- * @param {string} [identifier]
- * @param {string} [component]
- * @param {string | string[]} [categories]
- * @param {string[][]} [extras]
- * @param {string} [flags]
- * @returns {Promise<string>}
+ * @param display The display identifier to launch the activity into.
+ * @param user The user ID for which the activity is started.
+ * @param intent The name of the activity intent to start, for example
+ * `com.some.package.name/.YourActivitySubClassName`.
+ * @param action Action name.
+ * @param pkg Package name.
+ * @param uri Unified resource identifier.
+ * @param mimeType Mime type.
+ * @param identifier Optional identifier.
+ * @param component Component name.
+ * @param categories One or more category names.
+ * @param extras Optional intent arguments. Must be represented as array of arrays,
+ * where each subarray item contains two or three string items: value type, key name and the value itself.
+ * See {@link IntentOpts} for supported value types.
+ * @param flags Intent startup-specific flags as a hexadecimal string.
+ * @returns Promise that resolves to the command output string.
  */
 async function mobileStartActivity(wait, stop, windowingMode, activityType, display, user, intent, action, pkg, uri, mimeType, identifier, component, categories, extras, flags) {
     const cmd = [
@@ -135,23 +136,26 @@ async function mobileStartActivity(wait, stop, windowingMode, activityType, disp
     return await this.adb.shell(cmd);
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string | number} [user] The user ID for which the broadcast is sent.
- * The `current` alias assumes the current user ID.
- * `all` by default.
- * @param {string} [receiverPermission] Require receiver to hold the given permission.
- * @param {boolean} [allowBackgroundActivityStarts] Whether the receiver may start activities even if in the background.
- * @param {string} [intent]
- * @param {string} [action]
- * @param {string} [pkg]
- * @param {string} [uri]
- * @param {string} [mimeType]
- * @param {string} [identifier]
- * @param {string} [component]
- * @param {string | string[]} [categories]
- * @param {string[][]} [extras]
- * @param {string} [flags]
- * @returns {Promise<string>}
+ * Sends a broadcast intent to the Android system.
+ *
+ * @param receiverPermission Require receiver to hold the given permission.
+ * @param allowBackgroundActivityStarts Whether the receiver may start activities even if in the background.
+ * @param user The user ID for which the broadcast is sent.
+ * The `current` alias assumes the current user ID. `all` by default.
+ * @param intent The name of the activity intent to broadcast, for example
+ * `com.some.package.name/.YourServiceSubClassName`.
+ * @param action Action name.
+ * @param pkg Package name.
+ * @param uri Unified resource identifier.
+ * @param mimeType Mime type.
+ * @param identifier Optional identifier.
+ * @param component Component name.
+ * @param categories One or more category names.
+ * @param extras Optional intent arguments. Must be represented as array of arrays,
+ * where each subarray item contains two or three string items: value type, key name and the value itself.
+ * See {@link IntentOpts} for supported value types.
+ * @param flags Intent startup-specific flags as a hexadecimal string.
+ * @returns Promise that resolves to the command output string.
  */
 async function mobileBroadcast(receiverPermission, allowBackgroundActivityStarts, user, intent, action, pkg, uri, mimeType, identifier, component, categories, extras, flags) {
     const cmd = ['am', 'broadcast'];
@@ -179,22 +183,26 @@ async function mobileBroadcast(receiverPermission, allowBackgroundActivityStarts
     return await this.adb.shell(cmd);
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {boolean} [foreground] Set it to `true` if your service must be started as foreground service.
- * This option is ignored if the API level of the device under test is below
- *   26 (Android 8).
- * @param {string} [user]
- * @param {string} [intent]
- * @param {string} [action]
- * @param {string} [pkg]
- * @param {string} [uri]
- * @param {string} [mimeType]
- * @param {string} [identifier]
- * @param {string} [component]
- * @param {string | string[]} [categories]
- * @param {string[][]} [extras]
- * @param {string} [flags]
- * @returns {Promise<string>}
+ * Starts an Android service.
+ *
+ * @param foreground Set it to `true` if your service must be started as foreground service.
+ * This option is ignored if the API level of the device under test is below 26 (Android 8).
+ * @param user The user ID for which the service is started.
+ * The `current` user id is used by default.
+ * @param intent The name of the activity intent to start, for example
+ * `com.some.package.name/.YourServiceSubClassName`.
+ * @param action Action name.
+ * @param pkg Package name.
+ * @param uri Unified resource identifier.
+ * @param mimeType Mime type.
+ * @param identifier Optional identifier.
+ * @param component Component name.
+ * @param categories One or more category names.
+ * @param extras Optional intent arguments. Must be represented as array of arrays,
+ * where each subarray item contains two or three string items: value type, key name and the value itself.
+ * See {@link IntentOpts} for supported value types.
+ * @param flags Intent startup-specific flags as a hexadecimal string.
+ * @returns Promise that resolves to the command output string.
  */
 async function mobileStartService(foreground, user, intent, action, pkg, uri, mimeType, identifier, component, categories, extras, flags) {
     const cmd = ['am'];
@@ -217,19 +225,24 @@ async function mobileStartService(foreground, user, intent, action, pkg, uri, mi
     return await this.adb.shell(cmd);
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} [user]
- * @param {string} [intent]
- * @param {string} [action]
- * @param {string} [pkg]
- * @param {string} [uri]
- * @param {string} [mimeType]
- * @param {string} [identifier]
- * @param {string} [component]
- * @param {string | string[]} [categories]
- * @param {string[][]} [extras]
- * @param {string} [flags]
- * @returns {Promise<string>}
+ * Stops an Android service.
+ *
+ * @param user The user ID for which the service is stopped.
+ * @param intent The name of the activity intent to stop, for example
+ * `com.some.package.name/.YourServiceSubClassName`.
+ * @param action Action name.
+ * @param pkg Package name.
+ * @param uri Unified resource identifier.
+ * @param mimeType Mime type.
+ * @param identifier Optional identifier.
+ * @param component Component name.
+ * @param categories One or more category names.
+ * @param extras Optional intent arguments. Must be represented as array of arrays,
+ * where each subarray item contains two or three string items: value type, key name and the value itself.
+ * See {@link IntentOpts} for supported value types.
+ * @param flags Intent startup-specific flags as a hexadecimal string.
+ * @returns Promise that resolves to the command output string.
+ * If the service was already stopped, returns the error message.
  */
 async function mobileStopService(user, intent, action, pkg, uri, mimeType, identifier, component, categories, extras, flags) {
     const cmd = [
@@ -256,18 +269,14 @@ async function mobileStopService(user, intent, action, pkg, uri, mimeType, ident
     }
     catch (e) {
         // https://github.com/appium/appium-uiautomator2-driver/issues/792
-        if (e.code === 255 && e.stderr?.includes('Service stopped')) {
-            return e.stderr;
+        const err = e;
+        if (err.code === 255 && err.stderr?.includes('Service stopped')) {
+            return err.stderr;
         }
         throw e;
     }
 }
 // #region Internal helpers
-/**
- *
- * @param {import('./types').IntentOpts} opts
- * @returns {string[]}
- */
 function parseIntentSpec(opts = {}) {
     const { intent, action, uri, mimeType, identifier, categories, component, extras, flags } = opts;
     const resultArgs = [];
@@ -309,9 +318,9 @@ function parseIntentSpec(opts = {}) {
                 throw new driver_1.errors.InvalidArgumentError(`Extra argument '${item}' must be an array`);
             }
             const [type, key, value] = item;
-            if (!lodash_1.default.includes(SUPPORTED_EXTRA_TYPES, type)) {
+            if (!SUPPORTED_EXTRA_TYPES.includes(type)) {
                 throw new driver_1.errors.InvalidArgumentError(`Extra argument type '${type}' is not known. ` +
-                    `Supported intent argument types are: ${SUPPORTED_EXTRA_TYPES}`);
+                    `Supported intent argument types are: ${SUPPORTED_EXTRA_TYPES.join(', ')}`);
             }
             if (lodash_1.default.isEmpty(key) || (lodash_1.default.isString(key) && lodash_1.default.trim(key) === '')) {
                 throw new driver_1.errors.InvalidArgumentError(`Extra argument's key in '${JSON.stringify(item)}' must be a valid string identifier`);
@@ -334,7 +343,4 @@ function parseIntentSpec(opts = {}) {
     return resultArgs;
 }
 // #endregion
-/**
- * @typedef {import('appium-adb').ADB} ADB
- */
 //# sourceMappingURL=intent.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"intent.js","sourceRoot":"","sources":["../../../lib/commands/intent.js"],"names":[],"mappings":";;;;;AAsCA,sCAkCC;AAgCD,kDAqDC;AAqBD,0CAsCC;AAoBD,gDAgCC;AAiBD,8CAyCC;AAtUD,oDAAuB;AACvB,0CAAqC;AACrC,6CAAqC;AAErC,MAAM,iBAAiB,GAAG,IAAI,CAAC;AAC/B,MAAM,qBAAqB,GAAG;IAC5B,GAAG;IACH,iBAAiB;IACjB,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;CACN,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,aAAa,CACjC,UAAU,EACV,WAAW,EACX,cAAc,EACd,eAAe,EACf,YAAY,EACZ,cAAc,EACd,WAAW,EACX,uBAAuB,EACvB,kBAAkB;IAElB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qBAAqB,UAAU,mBAAmB,WAAW,GAAG,CAAC,CAAC;IAEjF,wEAAwE;IACxE,wDAAwD;IACxD,IAAI,CAAC,cAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACvC,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC;IACtD,CAAC;IAED,mDAAmD;IACnD,IAAI,IAAI,GAAG;QACT,GAAG,EAAE,UAAU;QACf,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE,cAAc,IAAI,UAAU;QACrC,YAAY,EAAE,eAAe,IAAI,WAAW;QAC5C,MAAM,EAAE,YAAY;QACpB,QAAQ,EAAE,cAAc;QACxB,KAAK,EAAE,WAAW;QAClB,uBAAuB;QACvB,OAAO,EAAE,CAAC,kBAAkB;KAC7B,CAAC;IACF,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,IAAI,EAAE,CAAC;IAC1D,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC,GAAG,IAAI,CAAC;IACxE,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACI,KAAK,UAAU,mBAAmB,CACvC,IAAI,EACJ,IAAI,EACJ,aAAa,EACb,YAAY,EACZ,OAAO,EACP,IAAI,EACJ,MAAM,EACN,MAAM,EACN,GAAG,EACH,GAAG,EACH,QAAQ,EACR,UAAU,EACV,SAAS,EACT,UAAU,EACV,MAAM,EACN,KAAK;IAEL,MAAM,GAAG,GAAG;QACV,IAAI;QACJ,gBAAgB;KACjB,CAAC;IACF,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACnB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;QAC5B,GAAG,CAAC,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;IACrD,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;QAC3B,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACtB,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACzC,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;QAC1B,MAAM;QACN,MAAM;QACN,OAAO,EAAE,GAAG;QACZ,GAAG;QACH,QAAQ;QACR,UAAU;QACV,SAAS;QACT,UAAU;QACV,MAAM;QACN,KAAK;KACN,CAAC,CAAC,CAAC;IACJ,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,eAAe,CACnC,kBAAkB,EAClB,6BAA6B,EAC7B,IAAI,EACJ,MAAM,EACN,MAAM,EACN,GAAG,EACH,GAAG,EACH,QAAQ,EACR,UAAU,EACV,SAAS,EACT,UAAU,EACV,MAAM,EACN,KAAK;IAEL,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAChC,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACnB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,kBAAkB,EAAE,CAAC;QACvB,GAAG,CAAC,IAAI,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAC;IACxD,CAAC;IACD,IAAI,6BAA6B,EAAE,CAAC;QAClC,GAAG,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;IACjD,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;QAC1B,MAAM;QACN,MAAM;QACN,OAAO,EAAE,GAAG;QACZ,GAAG;QACH,QAAQ;QACR,UAAU;QACV,SAAS;QACT,UAAU;QACV,MAAM;QACN,KAAK;KACN,CAAC,CAAC,CAAC;IACJ,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,kBAAkB,CACtC,UAAU,EACV,IAAI,EACJ,MAAM,EACN,MAAM,EACN,GAAG,EACH,GAAG,EACH,QAAQ,EACR,UAAU,EACV,SAAS,EACT,UAAU,EACV,MAAM,EACN,KAAK;IAEL,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;IACnB,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;IACpE,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACnB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;QAC1B,MAAM;QACN,MAAM;QACN,OAAO,EAAE,GAAG;QACZ,GAAG;QACH,QAAQ;QACR,UAAU;QACV,SAAS;QACT,UAAU;QACV,MAAM;QACN,KAAK;KACN,CAAC,CAAC,CAAC;IACJ,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,iBAAiB,CACrC,IAAI,EACJ,MAAM,EACN,MAAM,EACN,GAAG,EACH,GAAG,EACH,QAAQ,EACR,UAAU,EACV,SAAS,EACT,UAAU,EACV,MAAM,EACN,KAAK;IAEL,MAAM,GAAG,GAAG;QACV,IAAI;QACJ,cAAc;KACf,CAAC;IACF,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACnB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;QAC1B,MAAM;QACN,MAAM;QACN,OAAO,EAAE,GAAG;QACZ,GAAG;QACH,QAAQ;QACR,UAAU;QACV,SAAS;QACT,UAAU;QACV,MAAM;QACN,KAAK;KACN,CAAC,CAAC,CAAC;IACJ,IAAI,CAAC;QACH,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,kEAAkE;QAClE,IAAI,CAAC,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAC5D,OAAO,CAAC,CAAC,MAAM,CAAC;QAClB,CAAC;QACD,MAAM,CAAC,CAAC;IACV,CAAC;AACH,CAAC;AAED,2BAA2B;AAE3B;;;;GAIG;AACH,SAAS,eAAe,CAAC,IAAI,GAAG,EAAE;IAChC,MAAM,EAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAC,GAAG,IAAI,CAAC;IAC/F,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,IAAI,MAAM,EAAE,CAAC;QACX,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;IACD,IAAI,MAAM,EAAE,CAAC;QACX,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAChC,CAAC;IACD,IAAI,GAAG,EAAE,CAAC;QACR,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC7B,CAAC;IACD,IAAI,QAAQ,EAAE,CAAC;QACb,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QACzB,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACpC,CAAC;IACD,IAAI,UAAU,EAAE,CAAC;QACf,IAAI,gBAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAC1B,UAAU,CAAC,IAAI,CAAC,GAAG,gBAAC,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1E,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IACD,IAAI,SAAS,EAAE,CAAC;QACd,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IACD,IAAI,MAAM,EAAE,CAAC;QACX,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;QACrE,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,mBAAmB,IAAI,oBAAoB,CAAC,CAAC;YACrF,CAAC;YACD,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC;YAChC,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,qBAAqB,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC7C,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,wBAAwB,IAAI,kBAAkB;oBAC5C,wCAAwC,qBAAqB,EAAE,CAClE,CAAC;YACJ,CAAC;YACD,IAAI,gBAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,gBAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC;gBAC9D,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,4BAA4B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,qCAAqC,CACtF,CAAC;YACJ,CAAC;YACD,IAAI,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBAC/B,UAAU,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;YACrC,CAAC;iBAAM,IAAI,gBAAC,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,yBAAyB,IAAI,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe;oBACvE,4BAA4B,CAC/B,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,KAAK,EAAE,CAAC;QACV,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,aAAa;AAEb;;GAEG"}
+{"version":3,"file":"intent.js","sourceRoot":"","sources":["../../../lib/commands/intent.ts"],"names":[],"mappings":";;;;;AAyCA,sCAkCC;AAiCD,kDAsDC;AAwBD,0CAuCC;AAwBD,gDAiCC;AAsBD,8CA2CC;AA3VD,oDAAuB;AACvB,0CAAqC;AACrC,6CAAqC;AAIrC,MAAM,iBAAiB,GAAG,IAAI,CAAC;AAC/B,MAAM,qBAAqB,GAAG;IAC5B,GAAG;IACH,iBAAiB;IACjB,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;CACG,CAAC;AAEX;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,aAAa,CAEjC,UAAkB,EAClB,WAAmB,EACnB,cAAuB,EACvB,eAAwB,EACxB,YAAqB,EACrB,cAAuB,EACvB,WAAoB,EACpB,uBAAgC,EAChC,kBAA4B;IAE5B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qBAAqB,UAAU,mBAAmB,WAAW,GAAG,CAAC,CAAC;IAEjF,wEAAwE;IACxE,wDAAwD;IACxD,IAAI,CAAC,cAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACvC,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC;IACtD,CAAC;IAED,MAAM,IAAI,GAAG;QACX,GAAG,EAAE,UAAU;QACf,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE,cAAc,IAAI,UAAU;QACrC,YAAY,EAAE,eAAe,IAAI,WAAW;QAC5C,MAAM,EAAE,YAAY;QACpB,QAAQ,EAAE,cAAc;QACxB,KAAK,EAAE,WAAW;QAClB,uBAAuB;QACvB,OAAO,EAAE,CAAC,kBAAkB;KAC7B,CAAC;IACF,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,IAAI,EAAE,CAAC;IAC1D,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC,GAAG,IAAI,CAAC;IACxE,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACI,KAAK,UAAU,mBAAmB,CAEvC,IAAc,EACd,IAAc,EACd,aAA+B,EAC/B,YAA8B,EAC9B,OAAyB,EACzB,IAAa,EACb,MAAe,EACf,MAAe,EACf,GAAY,EACZ,GAAY,EACZ,QAAiB,EACjB,UAAmB,EACnB,SAAkB,EAClB,UAA8B,EAC9B,MAAmB,EACnB,KAAc;IAEd,MAAM,GAAG,GAAG;QACV,IAAI;QACJ,gBAAgB;KACjB,CAAC;IACF,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACnB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;QAC5B,GAAG,CAAC,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;IACrD,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;QAC3B,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACtB,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACzC,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;QAC1B,MAAM;QACN,MAAM;QACN,OAAO,EAAE,GAAG;QACZ,GAAG;QACH,QAAQ;QACR,UAAU;QACV,SAAS;QACT,UAAU;QACV,MAAM;QACN,KAAK;KACN,CAAC,CAAC,CAAC;IACJ,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACI,KAAK,UAAU,eAAe,CAEnC,kBAA2B,EAC3B,6BAAuC,EACvC,IAAsB,EACtB,MAAe,EACf,MAAe,EACf,GAAY,EACZ,GAAY,EACZ,QAAiB,EACjB,UAAmB,EACnB,SAAkB,EAClB,UAA8B,EAC9B,MAAmB,EACnB,KAAc;IAEd,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAChC,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACnB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,kBAAkB,EAAE,CAAC;QACvB,GAAG,CAAC,IAAI,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAC;IACxD,CAAC;IACD,IAAI,6BAA6B,EAAE,CAAC;QAClC,GAAG,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;IACjD,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;QAC1B,MAAM;QACN,MAAM;QACN,OAAO,EAAE,GAAG;QACZ,GAAG;QACH,QAAQ;QACR,UAAU;QACV,SAAS;QACT,UAAU;QACV,MAAM;QACN,KAAK;KACN,CAAC,CAAC,CAAC;IACJ,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACI,KAAK,UAAU,kBAAkB,CAEtC,UAAoB,EACpB,IAAa,EACb,MAAe,EACf,MAAe,EACf,GAAY,EACZ,GAAY,EACZ,QAAiB,EACjB,UAAmB,EACnB,SAAkB,EAClB,UAA8B,EAC9B,MAAmB,EACnB,KAAc;IAEd,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;IACnB,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;IACpE,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACnB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;QAC1B,MAAM;QACN,MAAM;QACN,OAAO,EAAE,GAAG;QACZ,GAAG;QACH,QAAQ;QACR,UAAU;QACV,SAAS;QACT,UAAU;QACV,MAAM;QACN,KAAK;KACN,CAAC,CAAC,CAAC;IACJ,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,iBAAiB,CAErC,IAAa,EACb,MAAe,EACf,MAAe,EACf,GAAY,EACZ,GAAY,EACZ,QAAiB,EACjB,UAAmB,EACnB,SAAkB,EAClB,UAA8B,EAC9B,MAAmB,EACnB,KAAc;IAEd,MAAM,GAAG,GAAG;QACV,IAAI;QACJ,cAAc;KACf,CAAC;IACF,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACnB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;QAC1B,MAAM;QACN,MAAM;QACN,OAAO,EAAE,GAAG;QACZ,GAAG;QACH,QAAQ;QACR,UAAU;QACV,SAAS;QACT,UAAU;QACV,MAAM;QACN,KAAK;KACN,CAAC,CAAC,CAAC;IACJ,IAAI,CAAC;QACH,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,kEAAkE;QAClE,MAAM,GAAG,GAAG,CAAqC,CAAC;QAClD,IAAI,GAAG,CAAC,IAAI,KAAK,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC,MAAM,CAAC;QACpB,CAAC;QACD,MAAM,CAAC,CAAC;IACV,CAAC;AACH,CAAC;AAED,2BAA2B;AAE3B,SAAS,eAAe,CAAC,OAAmB,EAAE;IAC5C,MAAM,EAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAC,GAAG,IAAI,CAAC;IAC/F,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,IAAI,MAAM,EAAE,CAAC;QACX,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;IACD,IAAI,MAAM,EAAE,CAAC;QACX,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAChC,CAAC;IACD,IAAI,GAAG,EAAE,CAAC;QACR,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC7B,CAAC;IACD,IAAI,QAAQ,EAAE,CAAC;QACb,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QACzB,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACpC,CAAC;IACD,IAAI,UAAU,EAAE,CAAC;QACf,IAAI,gBAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAC1B,UAAU,CAAC,IAAI,CAAC,GAAG,gBAAC,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1E,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IACD,IAAI,SAAS,EAAE,CAAC;QACd,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IACD,IAAI,MAAM,EAAE,CAAC;QACX,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;QACrE,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,mBAAmB,IAAI,oBAAoB,CAAC,CAAC;YACrF,CAAC;YACD,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC;YAChC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAW,CAAC,EAAE,CAAC;gBACjD,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,wBAAwB,IAAI,kBAAkB;oBAC5C,wCAAwC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC7E,CAAC;YACJ,CAAC;YACD,IAAI,gBAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,gBAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC;gBAC9D,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,4BAA4B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,qCAAqC,CACtF,CAAC;YACJ,CAAC;YACD,IAAI,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBAC/B,UAAU,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;YACrC,CAAC;iBAAM,IAAI,gBAAC,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,yBAAyB,IAAI,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe;oBACvE,4BAA4B,CAC/B,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,KAAK,EAAE,CAAC;QACV,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,aAAa"}

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

@@ -1,47 +1,32 @@
+import type { AndroidDriver } from '../driver';
+import type { StartScreenRecordingOpts, StopScreenRecordingOpts } from './types';
 /**
+ * Starts screen recording on the Android device.
  *
- * @this {import('../driver').AndroidDriver}
- * @param {import('./types').StartScreenRecordingOpts} [options={}]
- * @returns {Promise<string>}
+ * This method uses Android's `screenrecord` command to capture the screen.
+ * The recording can be configured with various options such as video size,
+ * bit rate, time limit, and more.
+ *
+ * @param options Recording options. See {@link StartScreenRecordingOpts} for details.
+ * @returns Promise that resolves to the result of stopping any previous recording,
+ * or an empty string if no previous recording was active.
+ * @throws {Error} If screen recording is not supported on the device or emulator,
+ * or if the time limit is invalid.
  */
-export function startRecordingScreen(this: import("../driver").AndroidDriver, options?: import("./types").StartScreenRecordingOpts): Promise<string>;
-export class startRecordingScreen {
-    /**
-     *
-     * @this {import('../driver').AndroidDriver}
-     * @param {import('./types').StartScreenRecordingOpts} [options={}]
-     * @returns {Promise<string>}
-     */
-    constructor(this: import("../driver").AndroidDriver, options?: import("./types").StartScreenRecordingOpts);
-    _screenRecordingProperties: {
-        timer: timing.Timer;
-        videoSize: string | undefined;
-        timeLimit: string | number;
-        currentTimeLimit: string | number;
-        bitRate: string | number | undefined;
-        bugReport: boolean | undefined;
-        records: never[];
-        recordingProcess: null;
-        stopped: boolean;
-    };
-}
+export declare function startRecordingScreen(this: AndroidDriver, options?: StartScreenRecordingOpts): Promise<string>;
 /**
+ * Stops screen recording and returns the recorded video.
+ *
+ * This method stops any active screen recording session and returns the recorded
+ * video as a base64-encoded string or uploads it to a remote location if specified.
+ * If multiple recording chunks were created (for long recordings), they will be
+ * merged using ffmpeg if available.
  *
- * @this {import('../driver').AndroidDriver}
- * @param {import('./types').StopScreenRecordingOpts} [options={}]
- * @returns {Promise<string>}
+ * @param options Stop recording options. See {@link StopScreenRecordingOpts} for details.
+ * @returns Promise that resolves to the recorded video as a base64-encoded string
+ * if `remotePath` is not provided, or an empty string if the video was uploaded to a remote location.
+ * @throws {Error} If screen recording is not supported, no recording was active,
+ * or if the recording process cannot be stopped.
  */
-export function stopRecordingScreen(this: import("../driver").AndroidDriver, options?: import("./types").StopScreenRecordingOpts): Promise<string>;
-export class stopRecordingScreen {
-    /**
-     *
-     * @this {import('../driver').AndroidDriver}
-     * @param {import('./types').StopScreenRecordingOpts} [options={}]
-     * @returns {Promise<string>}
-     */
-    constructor(this: import("../driver").AndroidDriver, options?: import("./types").StopScreenRecordingOpts);
-    _screenRecordingProperties: any;
-}
-export type ADB = import("appium-adb").ADB;
-import { timing } from '@appium/support';
+export declare function stopRecordingScreen(this: AndroidDriver, options?: StopScreenRecordingOpts): Promise<string>;
 //# sourceMappingURL=recordscreen.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"recordscreen.d.ts","sourceRoot":"","sources":["../../../lib/commands/recordscreen.js"],"names":[],"mappings":"AAkBA;;;;;GAKG;AACH,wFAHW,OAAO,SAAS,EAAE,wBAAwB,GACxC,OAAO,CAAC,MAAM,CAAC,CAsD3B;;IA1DD;;;;;OAKG;IACH,+DAHW,OAAO,SAAS,EAAE,wBAAwB,EAuDpD;IAxBG;;;;;;;;;;MAA2C;;AA0B/C;;;;;GAKG;AACH,uFAHW,OAAO,SAAS,EAAE,uBAAuB,GACvC,OAAO,CAAC,MAAM,CAAC,CA8E3B;;IAlFD;;;;;OAKG;IACH,+DAHW,OAAO,SAAS,EAAE,uBAAuB,EA+EnD;IAFG,gCAA2C;;kBAuLlC,OAAO,YAAY,EAAE,GAAG;uBArVgB,iBAAiB"}
+{"version":3,"file":"recordscreen.d.ts","sourceRoot":"","sources":["../../../lib/commands/recordscreen.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,WAAW,CAAC;AAE7C,OAAO,KAAK,EAAC,wBAAwB,EAAE,uBAAuB,EAA4B,MAAM,SAAS,CAAC;AAc1G;;;;;;;;;;;;GAYG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,aAAa,EACnB,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,MAAM,CAAC,CAsDjB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,aAAa,EACnB,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,MAAM,CAAC,CA6EjB"}

package/build/lib/commands/recordscreen.js

@@ -22,10 +22,17 @@ const MIN_EMULATOR_API_LEVEL = 27;
 const FFMPEG_BINARY = `ffmpeg${support_1.system.isWindows() ? '.exe' : ''}`;
 const ADB_PULL_TIMEOUT = 5 * 60 * 1000;
 /**
+ * Starts screen recording on the Android device.
  *
- * @this {import('../driver').AndroidDriver}
- * @param {import('./types').StartScreenRecordingOpts} [options={}]
- * @returns {Promise<string>}
+ * This method uses Android's `screenrecord` command to capture the screen.
+ * The recording can be configured with various options such as video size,
+ * bit rate, time limit, and more.
+ *
+ * @param options Recording options. See {@link StartScreenRecordingOpts} for details.
+ * @returns Promise that resolves to the result of stopping any previous recording,
+ * or an empty string if no previous recording was active.
+ * @throws {Error} If screen recording is not supported on the device or emulator,
+ * or if the time limit is invalid.
  */
 async function startRecordingScreen(options = {}) {
     await verifyScreenRecordIsSupported(this.adb, this.isEmulator());
@@ -41,7 +48,8 @@ async function startRecordingScreen(options = {}) {
     }
     if (!lodash_1.default.isEmpty(this._screenRecordingProperties)) {
         // XXX: this doesn't need to be done in serial, does it?
-        for (const record of this._screenRecordingProperties.records || []) {
+        const props = this._screenRecordingProperties;
+        for (const record of props.records || []) {
             await this.adb.rimraf(record);
         }
         this._screenRecordingProperties = undefined;
@@ -51,7 +59,7 @@ async function startRecordingScreen(options = {}) {
         throw new Error(`The timeLimit value must be in range [1, ${MAX_TIME_SEC}] seconds. ` +
             `The value of '${timeLimit}' has been passed instead.`);
     }
-    this._screenRecordingProperties = {
+    const recordingProps = {
         timer: new support_1.timing.Timer().start(),
         videoSize,
         timeLimit,
@@ -62,56 +70,66 @@ async function startRecordingScreen(options = {}) {
         recordingProcess: null,
         stopped: false,
     };
-    await scheduleScreenRecord.bind(this)(this._screenRecordingProperties);
+    this._screenRecordingProperties = recordingProps;
+    await scheduleScreenRecord.bind(this)(recordingProps);
     return result;
 }
 /**
+ * Stops screen recording and returns the recorded video.
+ *
+ * This method stops any active screen recording session and returns the recorded
+ * video as a base64-encoded string or uploads it to a remote location if specified.
+ * If multiple recording chunks were created (for long recordings), they will be
+ * merged using ffmpeg if available.
  *
- * @this {import('../driver').AndroidDriver}
- * @param {import('./types').StopScreenRecordingOpts} [options={}]
- * @returns {Promise<string>}
+ * @param options Stop recording options. See {@link StopScreenRecordingOpts} for details.
+ * @returns Promise that resolves to the recorded video as a base64-encoded string
+ * if `remotePath` is not provided, or an empty string if the video was uploaded to a remote location.
+ * @throws {Error} If screen recording is not supported, no recording was active,
+ * or if the recording process cannot be stopped.
  */
 async function stopRecordingScreen(options = {}) {
     await verifyScreenRecordIsSupported(this.adb, this.isEmulator());
-    if (!lodash_1.default.isEmpty(this._screenRecordingProperties)) {
-        this._screenRecordingProperties.stopped = true;
+    const props = this._screenRecordingProperties;
+    if (!lodash_1.default.isEmpty(props)) {
+        props.stopped = true;
     }
     try {
         await terminateBackgroundScreenRecording(this.adb, false);
     }
     catch (err) {
-        this.log.warn(/** @type {Error} */ (err).message);
-        if (!lodash_1.default.isEmpty(this._screenRecordingProperties)) {
+        this.log.warn(err.message);
+        if (!lodash_1.default.isEmpty(props)) {
             this.log.warn('The resulting video might be corrupted');
         }
     }
-    if (lodash_1.default.isEmpty(this._screenRecordingProperties)) {
+    if (lodash_1.default.isEmpty(props)) {
         this.log.info(`Screen recording has not been previously started by Appium. There is nothing to stop`);
         return '';
     }
-    if (this._screenRecordingProperties.recordingProcess?.isRunning) {
+    if (props.recordingProcess?.isRunning) {
         try {
-            await this._screenRecordingProperties.recordingProcess.stop('SIGINT', PROCESS_SHUTDOWN_TIMEOUT);
+            await props.recordingProcess.stop('SIGINT', PROCESS_SHUTDOWN_TIMEOUT);
         }
         catch {
             throw this.log.errorWithException(`Unable to stop screen recording within ${PROCESS_SHUTDOWN_TIMEOUT}ms`);
         }
-        this._screenRecordingProperties.recordingProcess = null;
+        props.recordingProcess = null;
     }
-    if (lodash_1.default.isEmpty(this._screenRecordingProperties.records)) {
+    if (lodash_1.default.isEmpty(props.records)) {
         throw this.log.errorWithException(`No screen recordings have been stored on the device so far. ` +
             `Are you sure the ${SCREENRECORD_BINARY} utility works as expected?`);
     }
     const tmpRoot = await support_1.tempDir.openDir();
     try {
         const localRecords = [];
-        for (const pathOnDevice of this._screenRecordingProperties.records) {
+        for (const pathOnDevice of props.records) {
             const relativePath = path_1.default.resolve(tmpRoot, path_1.default.posix.basename(pathOnDevice));
             localRecords.push(relativePath);
             await this.adb.pull(pathOnDevice, relativePath, { timeout: ADB_PULL_TIMEOUT });
             await this.adb.rimraf(pathOnDevice);
         }
-        let resultFilePath = /** @type {string} */ (lodash_1.default.last(localRecords));
+        let resultFilePath = lodash_1.default.last(localRecords);
         if (localRecords.length > 1) {
             this.log.info(`Got ${localRecords.length} screen recordings. Trying to merge them`);
             try {
@@ -119,7 +137,7 @@ async function stopRecordingScreen(options = {}) {
             }
             catch (e) {
                 this.log.warn(`Cannot merge the recorded files. The most recent screen recording is going to be returned as the result. ` +
-                    `Original error: ${ /** @type {Error} */(e).message}`);
+                    `Original error: ${e.message}`);
             }
         }
         if (lodash_1.default.isEmpty(options.remotePath)) {
@@ -134,21 +152,11 @@ async function stopRecordingScreen(options = {}) {
     }
 }
 // #region Internal helpers
-/**
- *
- * @param {string} localFile
- * @param {string} [remotePath]
- * @param {import('./types').StopScreenRecordingOpts} uploadOptions
- * @returns {Promise<string>}
- */
 async function uploadRecordedMedia(localFile, remotePath, uploadOptions = {}) {
     if (lodash_1.default.isEmpty(remotePath)) {
         return (await support_1.util.toInMemoryBase64(localFile)).toString();
     }
     const { user, pass, method, headers, fileFieldName, formFields } = uploadOptions;
-    /**
-     * @type {import('@appium/support').NetOptions & import('@appium/support').HttpUploadOptions}
-     */
     const options = {
         method: method || 'PUT',
         headers,
@@ -158,25 +166,15 @@ async function uploadRecordedMedia(localFile, remotePath, uploadOptions = {}) {
     if (user && pass) {
         options.auth = { user, pass };
     }
-    await support_1.net.uploadFile(localFile, /** @type {string} */ (remotePath), options);
+    await support_1.net.uploadFile(localFile, remotePath, options);
     return '';
 }
-/**
- *
- * @param {ADB} adb
- * @param {boolean} isEmulator
- */
 async function verifyScreenRecordIsSupported(adb, isEmulator) {
     const apiLevel = await adb.getApiLevel();
     if (isEmulator && apiLevel < MIN_EMULATOR_API_LEVEL) {
         throw new Error(`Screen recording does not work on emulators running Android API level less than ${MIN_EMULATOR_API_LEVEL}`);
     }
 }
-/**
- * @this {import('../driver').AndroidDriver}
- * @param {import('@appium/types').StringRecord} recordingProperties
- * @returns {Promise<void>}
- */
 async function scheduleScreenRecord(recordingProperties) {
     if (recordingProperties.stopped) {
         return;
@@ -184,7 +182,7 @@ async function scheduleScreenRecord(recordingProperties) {
     const { timer, videoSize, bitRate, timeLimit, bugReport } = recordingProperties;
     let currentTimeLimit = MAX_RECORDING_TIME_SEC;
     if (support_1.util.hasValue(recordingProperties.currentTimeLimit)) {
-        const currentTimeLimitInt = parseInt(recordingProperties.currentTimeLimit, 10);
+        const currentTimeLimitInt = parseInt(String(recordingProperties.currentTimeLimit), 10);
         if (!isNaN(currentTimeLimitInt) && currentTimeLimitInt < MAX_RECORDING_TIME_SEC) {
             currentTimeLimit = currentTimeLimitInt;
         }
@@ -202,12 +200,12 @@ async function scheduleScreenRecord(recordingProperties) {
         }
         const currentDuration = timer.getDuration().asSeconds.toFixed(0);
         this.log.debug(`The overall screen recording duration is ${currentDuration}s so far`);
-        const timeLimitInt = parseInt(timeLimit, 10);
-        if (isNaN(timeLimitInt) || currentDuration >= timeLimitInt) {
+        const timeLimitInt = parseInt(String(timeLimit), 10);
+        if (isNaN(timeLimitInt) || Number(currentDuration) >= timeLimitInt) {
             this.log.debug('There is no need to start the next recording chunk');
             return;
         }
-        recordingProperties.currentTimeLimit = timeLimitInt - currentDuration;
+        recordingProperties.currentTimeLimit = timeLimitInt - Number(currentDuration);
         const chunkDuration = recordingProperties.currentTimeLimit < MAX_RECORDING_TIME_SEC
             ? recordingProperties.currentTimeLimit
             : MAX_RECORDING_TIME_SEC;
@@ -218,7 +216,7 @@ async function scheduleScreenRecord(recordingProperties) {
                 await scheduleScreenRecord.bind(this)(recordingProperties);
             }
             catch (e) {
-                this.log.error(/** @type {Error} */ (e).stack);
+                this.log.error(e.stack);
                 recordingProperties.stopped = true;
             }
         })();
@@ -237,12 +235,6 @@ async function scheduleScreenRecord(recordingProperties) {
     recordingProperties.records.push(pathOnDevice);
     recordingProperties.recordingProcess = recordingProc;
 }
-/**
- *
- * @this {import('../driver').AndroidDriver}
- * @param {string[]} mediaFiles
- * @returns {Promise<string>}
- */
 async function mergeScreenRecords(mediaFiles) {
     try {
         await support_1.fs.which(FFMPEG_BINARY);
@@ -260,12 +252,6 @@ async function mergeScreenRecords(mediaFiles) {
     await (0, teen_process_1.exec)(FFMPEG_BINARY, args);
     return result;
 }
-/**
- *
- * @param {ADB} adb
- * @param {boolean} force
- * @returns {Promise<boolean>}
- */
 async function terminateBackgroundScreenRecording(adb, force = true) {
     const isScreenrecordRunning = async () => lodash_1.default.includes(await adb.listProcessStatus(), SCREENRECORD_BINARY);
     if (!await isScreenrecordRunning()) {
@@ -280,11 +266,8 @@ async function terminateBackgroundScreenRecording(adb, force = true) {
         return true;
     }
     catch (err) {
-        throw new Error(`Unable to stop the background screen recording: ${ /** @type {Error} */(err).message}`);
+        throw new Error(`Unable to stop the background screen recording: ${err.message}`);
     }
 }
 // #endregion
-/**
- * @typedef {import('appium-adb').ADB} ADB
- */
 //# sourceMappingURL=recordscreen.js.map