appium-remote-debugger 15.2.9 → 15.2.11

package/build/lib/mixins/navigate.js

@@ -60,15 +60,15 @@ const PAGE_LOAD_STRATEGY = Object.freeze({
     NORMAL: 'normal'
 });
 /**
- * @this {RemoteDebugger}
- * @returns {void}
+ * Emits a frame detached event when a frame is detached from the page.
+ * This is typically called by the RPC client when receiving a Page.frameDetached event.
  */
 function frameDetached() {
     this.emit(events_1.events.EVENT_FRAMES_DETACHED);
 }
 /**
- * @this {RemoteDebugger}
- * @returns {void}
+ * Cancels the current page load operation by unregistering from page readiness
+ * notifications and canceling any pending page load delay.
  */
 function cancelPageLoad() {
     this.log.debug('Unregistering from page readiness notifications');
@@ -76,12 +76,14 @@ function cancelPageLoad() {
     (0, property_accessors_1.getPageLoadDelay)(this)?.cancel();
 }
 /**
- * Return if current readState can be handles as page load completes
- * for the given page load strategy.
+ * Determines if the current readyState indicates that page loading is completed
+ * based on the configured page load strategy.
  *
- * @this {RemoteDebugger}
- * @param {string} readyState
- * @returns {boolean}
+ * @param readyState - The document readyState value ('loading', 'interactive', or 'complete').
+ * @returns True if the page load is considered complete for the current strategy:
+ *          - 'eager': returns true when readyState is not 'loading'
+ *          - 'none': always returns true
+ *          - 'normal' (default): returns true only when readyState is 'complete'
  */
 function isPageLoadingCompleted(readyState) {
     const pageLoadStrategy = lodash_1.default.toLower((0, property_accessors_1.getPageLoadStartegy)(this));
@@ -97,9 +99,12 @@ function isPageLoadingCompleted(readyState) {
     }
 }
 /**
- * @this {RemoteDebugger}
- * @param {timing.Timer?} [startPageLoadTimer]
- * @returns {Promise<void>}
+ * Waits for the DOM to be ready by periodically checking the page readiness state.
+ * Uses exponential backoff for retry intervals and respects the configured page load
+ * strategy and timeout settings.
+ *
+ * @param startPageLoadTimer - Optional timer instance to use for tracking elapsed time.
+ *                             If not provided, a new timer will be created and started.
  */
 async function waitForDom(startPageLoadTimer) {
     const readinessTimeoutMs = this.pageLoadMs;
@@ -108,7 +113,6 @@ async function waitForDom(startPageLoadTimer) {
     let isPageLoading = true;
     (0, property_accessors_1.setPageLoading)(this, true);
     (0, property_accessors_1.setPageLoadDelay)(this, support_1.util.cancellableDelay(readinessTimeoutMs));
-    /** @type {B<void>} */
     const pageReadinessPromise = bluebird_1.default.resolve((async () => {
         let retry = 0;
         while (isPageLoading) {
@@ -141,7 +145,6 @@ async function waitForDom(startPageLoadTimer) {
             retry++;
         }
     })());
-    /** @type {B<void>} */
     const cancellationPromise = bluebird_1.default.resolve((async () => {
         try {
             await (0, property_accessors_1.getPageLoadDelay)(this);
@@ -158,9 +161,13 @@ async function waitForDom(startPageLoadTimer) {
     }
 }
 /**
- * @this {RemoteDebugger}
- * @param {number} [timeoutMs]
- * @returns {Promise<boolean>}
+ * Checks if the current page is ready by executing a JavaScript command to
+ * retrieve the document readyState and evaluating it against the page load strategy.
+ *
+ * @param timeoutMs - Optional timeout in milliseconds for the readyState check.
+ *                    If not provided, uses the configured page ready timeout.
+ * @returns A promise that resolves to true if the page is ready according to
+ *          the page load strategy, false otherwise or if the check times out.
  */
 async function checkPageIsReady(timeoutMs) {
     const readyCmd = 'document.readyState;';
@@ -185,9 +192,12 @@ async function checkPageIsReady(timeoutMs) {
     }
 }
 /**
- * @this {RemoteDebugger}
- * @param {string} url
- * @returns {Promise<void>}
+ * Navigates to a new URL and waits for the page to be ready.
+ * Validates the URL format, waits for the page to be available, sends the navigation
+ * command, and monitors for the Page.loadEventFired event or timeout.
+ *
+ * @param url - The URL to navigate to. Must be a valid URL format.
+ * @throws TypeError if the provided URL is not a valid URL format.
  */
 async function navToUrl(url) {
     const { appIdKey, pageIdKey } = (0, utils_1.checkParams)({
@@ -203,20 +213,14 @@ async function navToUrl(url) {
     }
     this.log.debug(`Navigating to new URL: '${url}'`);
     (0, property_accessors_1.setNavigatingToPage)(this, true);
-    await rpcClient.waitForPage(
-    /** @type {import('../types').AppIdKey} */ (appIdKey), 
-    /** @type {import('../types').PageIdKey} */ (pageIdKey));
+    await rpcClient.waitForPage(appIdKey, pageIdKey);
     const readinessTimeoutMs = this.pageLoadMs;
-    /** @type {(() => void)|undefined} */
     let onPageLoaded;
-    /** @type {NodeJS.Timeout|undefined|null} */
     let onPageLoadedTimeout;
     (0, property_accessors_1.setPageLoadDelay)(this, support_1.util.cancellableDelay(readinessTimeoutMs));
     (0, property_accessors_1.setPageLoading)(this, true);
     let isPageLoading = true;
-    // /** @type {Promise<void>|null} */
     const start = new support_1.timing.Timer().start();
-    /** @type {B<void>} */
     const pageReadinessPromise = new bluebird_1.default((resolve) => {
         onPageLoadedTimeout = setTimeout(() => {
             if (isPageLoading) {
@@ -245,7 +249,6 @@ async function navToUrl(url) {
             pageIdKey,
         });
     });
-    /** @type {B<void>} */
     const cancellationPromise = bluebird_1.default.resolve((async () => {
         try {
             await (0, property_accessors_1.getPageLoadDelay)(this);
@@ -269,7 +272,4 @@ async function navToUrl(url) {
         }
     }
 }
-/**
- * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
- */
 //# sourceMappingURL=navigate.js.map

package/build/lib/mixins/navigate.js.map

@@ -1 +1 @@
-{"version":3,"file":"navigate.js","sourceRoot":"","sources":["../../../lib/mixins/navigate.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCA,sCAEC;AAMD,wCAIC;AAUD,wDAYC;AAOD,gCA6DC;AAOD,4CAqBC;AAOD,4BAsFC;AA/PD,oCAAuC;AACvC,qCAAkC;AAClC,6CAA+C;AAC/C,oDAAuB;AACvB,qDAA4D;AAC5D,6DAS8B;AAEjB,QAAA,iCAAiC,GAAG,EAAE,GAAG,IAAI,CAAC;AAC3D,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAE5C;;GAEG;AACH,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC;IACvC,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;CACjB,CAAC,CAAC;AAEH;;;GAGG;AACH,SAAgB,aAAa;IAC3B,IAAI,CAAC,IAAI,CAAC,eAAM,CAAC,qBAAqB,CAAC,CAAC;AAC1C,CAAC;AAED;;;GAGG;AACH,SAAgB,cAAc;IAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC;IAClE,IAAA,mCAAc,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;AACnC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAAE,UAAU;IAChD,MAAM,gBAAgB,GAAG,gBAAC,CAAC,OAAO,CAAC,IAAA,wCAAmB,EAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,QAAQ,gBAAgB,EAAE,CAAC;QACzB,KAAK,kBAAkB,CAAC,KAAK;YAC3B,iDAAiD;YACjD,OAAO,UAAU,KAAK,SAAS,CAAC;QAClC,KAAK,kBAAkB,CAAC,IAAI;YAC1B,OAAO,IAAI,CAAC;QACd,KAAK,kBAAkB,CAAC,MAAM,CAAC;QAC/B;YACE,OAAO,UAAU,KAAK,UAAU,CAAC;IACrC,CAAC;AACH,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,UAAU,CAAE,kBAAkB;IAClD,MAAM,kBAAkB,GAAG,IAAI,CAAC,UAAU,CAAC;IAC3C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,kBAAkB,6BAA6B,CAAC,CAAC;IACjF,MAAM,KAAK,GAAG,kBAAkB,IAAI,IAAI,gBAAM,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC;IAE/D,IAAI,aAAa,GAAG,IAAI,CAAC;IACzB,IAAA,mCAAc,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC3B,IAAA,qCAAgB,EAAC,IAAI,EAAE,cAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAClE,sBAAsB;IACtB,MAAM,oBAAoB,GAAG,kBAAC,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE;QACjD,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,OAAO,aAAa,EAAE,CAAC;YACrB,wDAAwD;YACxD,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC;YACrD,oBAAoB;YACpB,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CACzB,gCAAgC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,EACrD,kBAAkB,GAAG,SAAS,CAC/B,CAAC;YACF,MAAM,kBAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YAC1B,mEAAmE;YACnE,IAAI,CAAC,IAAA,gCAAW,EAAC,IAAI,CAAC,EAAE,CAAC;gBACvB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAC;gBAChF,OAAO;YACT,CAAC;YACD,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GAAG,CAAC,kBAAkB,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC;YAC1D,IAAI,MAAM,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC3C,IAAI,aAAa,EAAE,CAAC;oBAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oBAAoB,SAAS,IAAI,CAAC,CAAC;oBAClD,aAAa,GAAG,KAAK,CAAC;gBACxB,CAAC;gBACD,OAAO;YACT,CAAC;YACD,IAAI,SAAS,GAAG,kBAAkB,EAAE,CAAC;gBACnC,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,mBAAmB,kBAAkB,yDAAyD,CAC/F,CAAC;gBACF,aAAa,GAAG,KAAK,CAAC;gBACtB,OAAO;YACT,CAAC;YACD,KAAK,EAAE,CAAC;QACV,CAAC;IACH,CAAC,CAAC,EAAE,CAAC,CAAC;IACN,sBAAsB;IACtB,MAAM,mBAAmB,GAAG,kBAAC,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE;QAChD,IAAI,CAAC;YACH,MAAM,IAAA,qCAAgB,EAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC,CAAC,EAAE,CAAC,CAAC;IAEN,IAAI,CAAC;QACH,MAAM,kBAAC,CAAC,GAAG,CAAC,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAC3D,CAAC;YAAS,CAAC;QACT,aAAa,GAAG,KAAK,CAAC;QACtB,IAAA,mCAAc,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5B,IAAA,qCAAgB,EAAC,IAAI,EAAE,kBAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IACtC,CAAC;AACH,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,gBAAgB,CAAE,SAAS;IAC/C,MAAM,QAAQ,GAAG,sBAAsB,CAAC;IACxC,MAAM,eAAe,GAAG,SAAS,IAAI,IAAA,wCAAmB,EAAC,IAAI,CAAC,CAAC;IAC/D,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,MAAM,kBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;aACvD,OAAO,CAAC,eAAe,CAAC,CAAC;QAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,IAAI,CAAC,SAAS,CAAC;YACb,UAAU;YACV,gBAAgB,EAAE,IAAA,wCAAmB,EAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,MAAM;SACzE,CAAC,CACH,CAAC;QACF,OAAO,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,uBAAa,EAAE,CAAC;YACjC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wCAAwC,eAAe,IAAI,CAAC,CAAC;QAC9E,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oDAAoD,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QACnF,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,QAAQ,CAAE,GAAG;IACjC,MAAM,EAAC,QAAQ,EAAE,SAAS,EAAC,GAAG,IAAA,mBAAW,EAAC;QACxC,QAAQ,EAAE,IAAA,gCAAW,EAAC,IAAI,CAAC;QAC3B,SAAS,EAAE,IAAA,iCAAY,EAAC,IAAI,CAAC;KAC9B,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAE1C,IAAI,CAAC;QACH,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,SAAS,CAAC,IAAI,GAAG,sBAAsB,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,GAAG,GAAG,CAAC,CAAC;IAClD,IAAA,wCAAmB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAChC,MAAM,SAAS,CAAC,WAAW;IACzB,0CAA0C,CAAC,CAAC,QAAQ,CAAC;IACrD,2CAA2C,CAAC,CAAC,SAAS,CAAC,CACxD,CAAC;IACF,MAAM,kBAAkB,GAAG,IAAI,CAAC,UAAU,CAAC;IAC3C,qCAAqC;IACrC,IAAI,YAAY,CAAC;IACjB,4CAA4C;IAC5C,IAAI,mBAAmB,CAAC;IACxB,IAAA,qCAAgB,EAAC,IAAI,EAAE,cAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAClE,IAAA,mCAAc,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC3B,IAAI,aAAa,GAAG,IAAI,CAAC;IACzB,oCAAoC;IACpC,MAAM,KAAK,GAAG,IAAI,gBAAM,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC;IAEzC,sBAAsB;IACtB,MAAM,oBAAoB,GAAG,IAAI,kBAAC,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7C,mBAAmB,GAAG,UAAU,CAAC,GAAG,EAAE;YACpC,IAAI,aAAa,EAAE,CAAC;gBAClB,aAAa,GAAG,KAAK,CAAC;gBACtB,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,mBAAmB,KAAK,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,gBAAgB;oBAChF,WAAW,GAAG,oCAAoC,CACnD,CAAC;YACJ,CAAC;YACD,OAAO,OAAO,EAAE,CAAC;QACnB,CAAC,EAAE,kBAAkB,CAAC,CAAC;QAEvB,YAAY,GAAG,GAAG,EAAE;YAClB,IAAI,aAAa,EAAE,CAAC;gBAClB,aAAa,GAAG,KAAK,CAAC;gBACtB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,GAAG,gBAAgB,KAAK,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACnG,CAAC;YACD,IAAI,mBAAmB,EAAE,CAAC;gBACxB,YAAY,CAAC,mBAAmB,CAAC,CAAC;gBAClC,mBAAmB,GAAG,IAAI,CAAC;YAC7B,CAAC;YACD,OAAO,OAAO,EAAE,CAAC;QACnB,CAAC,CAAC;QAEF,oFAAoF;QACpF,SAAS,CAAC,IAAI,CAAC,qBAAqB,EAAE,YAAY,CAAC,CAAC;QAEpD,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE;YAC9B,GAAG;YACH,QAAQ;YACR,SAAS;SACV,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,sBAAsB;IACtB,MAAM,mBAAmB,GAAG,kBAAC,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE;QAChD,IAAI,CAAC;YACH,MAAM,IAAA,qCAAgB,EAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC,CAAC,EAAE,CAAC,CAAC;IAEN,IAAI,CAAC;QACH,MAAM,kBAAC,CAAC,GAAG,CAAC,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAC3D,CAAC;YAAS,CAAC;QACT,IAAA,mCAAc,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5B,aAAa,GAAG,KAAK,CAAC;QACtB,IAAA,wCAAmB,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACjC,IAAA,qCAAgB,EAAC,IAAI,EAAE,kBAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACpC,IAAI,mBAAmB,IAAI,oBAAoB,CAAC,WAAW,EAAE,EAAE,CAAC;YAC9D,YAAY,CAAC,mBAAmB,CAAC,CAAC;YAClC,mBAAmB,GAAG,IAAI,CAAC;QAC7B,CAAC;QACD,IAAI,YAAY,EAAE,CAAC;YACjB,SAAS,CAAC,GAAG,CAAC,qBAAqB,EAAE,YAAY,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;AACH,CAAC;AAED;;GAEG"}
+{"version":3,"file":"navigate.js","sourceRoot":"","sources":["../../../lib/mixins/navigate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCA,sCAEC;AAMD,wCAIC;AAYD,wDAYC;AAUD,gCA2DC;AAWD,4CAqBC;AAUD,4BAiFC;AAtQD,oCAAuC;AACvC,qCAAkC;AAClC,6CAA+C;AAC/C,oDAAuB;AACvB,qDAA4D;AAC5D,6DAS8B;AAIjB,QAAA,iCAAiC,GAAG,EAAE,GAAG,IAAI,CAAC;AAC3D,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAE5C;;GAEG;AACH,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC;IACvC,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;CACjB,CAAC,CAAC;AAEH;;;GAGG;AACH,SAAgB,aAAa;IAC3B,IAAI,CAAC,IAAI,CAAC,eAAM,CAAC,qBAAqB,CAAC,CAAC;AAC1C,CAAC;AAED;;;GAGG;AACH,SAAgB,cAAc;IAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC;IAClE,IAAA,mCAAc,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,sBAAsB,CAAuB,UAAkB;IAC7E,MAAM,gBAAgB,GAAG,gBAAC,CAAC,OAAO,CAAC,IAAA,wCAAmB,EAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,QAAQ,gBAAgB,EAAE,CAAC;QACzB,KAAK,kBAAkB,CAAC,KAAK;YAC3B,iDAAiD;YACjD,OAAO,UAAU,KAAK,SAAS,CAAC;QAClC,KAAK,kBAAkB,CAAC,IAAI;YAC1B,OAAO,IAAI,CAAC;QACd,KAAK,kBAAkB,CAAC,MAAM,CAAC;QAC/B;YACE,OAAO,UAAU,KAAK,UAAU,CAAC;IACrC,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,UAAU,CAAuB,kBAAiC;IACtF,MAAM,kBAAkB,GAAG,IAAI,CAAC,UAAU,CAAC;IAC3C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,kBAAkB,6BAA6B,CAAC,CAAC;IACjF,MAAM,KAAK,GAAG,kBAAkB,IAAI,IAAI,gBAAM,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC;IAE/D,IAAI,aAAa,GAAG,IAAI,CAAC;IACzB,IAAA,mCAAc,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC3B,IAAA,qCAAgB,EAAC,IAAI,EAAE,cAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAClE,MAAM,oBAAoB,GAAG,kBAAC,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE;QACjD,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,OAAO,aAAa,EAAE,CAAC;YACrB,wDAAwD;YACxD,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC;YACrD,oBAAoB;YACpB,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CACzB,gCAAgC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,EACrD,kBAAkB,GAAG,SAAS,CAC/B,CAAC;YACF,MAAM,kBAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YAC1B,mEAAmE;YACnE,IAAI,CAAC,IAAA,gCAAW,EAAC,IAAI,CAAC,EAAE,CAAC;gBACvB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAC;gBAChF,OAAO;YACT,CAAC;YACD,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GAAG,CAAC,kBAAkB,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC;YAC1D,IAAI,MAAM,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC3C,IAAI,aAAa,EAAE,CAAC;oBAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oBAAoB,SAAS,IAAI,CAAC,CAAC;oBAClD,aAAa,GAAG,KAAK,CAAC;gBACxB,CAAC;gBACD,OAAO;YACT,CAAC;YACD,IAAI,SAAS,GAAG,kBAAkB,EAAE,CAAC;gBACnC,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,mBAAmB,kBAAkB,yDAAyD,CAC/F,CAAC;gBACF,aAAa,GAAG,KAAK,CAAC;gBACtB,OAAO;YACT,CAAC;YACD,KAAK,EAAE,CAAC;QACV,CAAC;IACH,CAAC,CAAC,EAAE,CAAC,CAAC;IACN,MAAM,mBAAmB,GAAG,kBAAC,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE;QAChD,IAAI,CAAC;YACH,MAAM,IAAA,qCAAgB,EAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC,CAAC,EAAE,CAAC,CAAC;IAEN,IAAI,CAAC;QACH,MAAM,kBAAC,CAAC,GAAG,CAAC,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAC3D,CAAC;YAAS,CAAC;QACT,aAAa,GAAG,KAAK,CAAC;QACtB,IAAA,mCAAc,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5B,IAAA,qCAAgB,EAAC,IAAI,EAAE,kBAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IACtC,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,gBAAgB,CAAuB,SAAkB;IAC7E,MAAM,QAAQ,GAAG,sBAAsB,CAAC;IACxC,MAAM,eAAe,GAAG,SAAS,IAAI,IAAA,wCAAmB,EAAC,IAAI,CAAC,CAAC;IAC/D,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,MAAM,kBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;aACvD,OAAO,CAAC,eAAe,CAAC,CAAC;QAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,IAAI,CAAC,SAAS,CAAC;YACb,UAAU;YACV,gBAAgB,EAAE,IAAA,wCAAmB,EAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,MAAM;SACzE,CAAC,CACH,CAAC;QACF,OAAO,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,IAAI,GAAG,YAAY,uBAAa,EAAE,CAAC;YACjC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wCAAwC,eAAe,IAAI,CAAC,CAAC;QAC9E,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oDAAoD,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QACnF,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,QAAQ,CAAuB,GAAW;IAC9D,MAAM,EAAC,QAAQ,EAAE,SAAS,EAAC,GAAG,IAAA,mBAAW,EAAC;QACxC,QAAQ,EAAE,IAAA,gCAAW,EAAC,IAAI,CAAC;QAC3B,SAAS,EAAE,IAAA,iCAAY,EAAC,IAAI,CAAC;KAC9B,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAE1C,IAAI,CAAC;QACH,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,SAAS,CAAC,IAAI,GAAG,sBAAsB,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,GAAG,GAAG,CAAC,CAAC;IAClD,IAAA,wCAAmB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAChC,MAAM,SAAS,CAAC,WAAW,CACzB,QAAoB,EACpB,SAAsB,CACvB,CAAC;IACF,MAAM,kBAAkB,GAAG,IAAI,CAAC,UAAU,CAAC;IAC3C,IAAI,YAAsC,CAAC;IAC3C,IAAI,mBAAsD,CAAC;IAC3D,IAAA,qCAAgB,EAAC,IAAI,EAAE,cAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAClE,IAAA,mCAAc,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC3B,IAAI,aAAa,GAAG,IAAI,CAAC;IACzB,MAAM,KAAK,GAAG,IAAI,gBAAM,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC;IAEzC,MAAM,oBAAoB,GAAG,IAAI,kBAAC,CAAO,CAAC,OAAO,EAAE,EAAE;QACnD,mBAAmB,GAAG,UAAU,CAAC,GAAG,EAAE;YACpC,IAAI,aAAa,EAAE,CAAC;gBAClB,aAAa,GAAG,KAAK,CAAC;gBACtB,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,mBAAmB,KAAK,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,gBAAgB;oBAChF,WAAW,GAAG,oCAAoC,CACnD,CAAC;YACJ,CAAC;YACD,OAAO,OAAO,EAAE,CAAC;QACnB,CAAC,EAAE,kBAAkB,CAAC,CAAC;QAEvB,YAAY,GAAG,GAAG,EAAE;YAClB,IAAI,aAAa,EAAE,CAAC;gBAClB,aAAa,GAAG,KAAK,CAAC;gBACtB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,GAAG,gBAAgB,KAAK,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACnG,CAAC;YACD,IAAI,mBAAmB,EAAE,CAAC;gBACxB,YAAY,CAAC,mBAAmB,CAAC,CAAC;gBAClC,mBAAmB,GAAG,IAAI,CAAC;YAC7B,CAAC;YACD,OAAO,OAAO,EAAE,CAAC;QACnB,CAAC,CAAC;QAEF,oFAAoF;QACpF,SAAS,CAAC,IAAI,CAAC,qBAAqB,EAAE,YAAY,CAAC,CAAC;QAEpD,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE;YAC9B,GAAG;YACH,QAAQ;YACR,SAAS;SACV,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,MAAM,mBAAmB,GAAG,kBAAC,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE;QAChD,IAAI,CAAC;YACH,MAAM,IAAA,qCAAgB,EAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC,CAAC,EAAE,CAAC,CAAC;IAEN,IAAI,CAAC;QACH,MAAM,kBAAC,CAAC,GAAG,CAAC,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAC3D,CAAC;YAAS,CAAC;QACT,IAAA,mCAAc,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5B,aAAa,GAAG,KAAK,CAAC;QACtB,IAAA,wCAAmB,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACjC,IAAA,qCAAgB,EAAC,IAAI,EAAE,kBAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACpC,IAAI,mBAAmB,IAAI,oBAAoB,CAAC,WAAW,EAAE,EAAE,CAAC;YAC9D,YAAY,CAAC,mBAAmB,CAAC,CAAC;YAClC,mBAAmB,GAAG,IAAI,CAAC;QAC7B,CAAC;QACD,IAAI,YAAY,EAAE,CAAC;YACjB,SAAS,CAAC,GAAG,CAAC,qBAAqB,EAAE,YAAY,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;AACH,CAAC"}

package/build/lib/mixins/screenshot.d.ts

@@ -1,14 +1,24 @@
+import type { RemoteDebugger } from '../remote-debugger';
+import type { Rect } from '@appium/types';
 /**
- * Capture a rect of the page or by default the viewport
- * @this {RemoteDebugger}
- * @param {ScreenshotCaptureOptions} [opts={}]  if rect is null capture the whole
- * coordinate system else capture the rect in the given coordinateSystem
- * @returns {Promise<string>} a base64 encoded string of the screenshot
+ * Options for capturing a screenshot.
  */
-export function captureScreenshot(this: import("../remote-debugger").RemoteDebugger, opts?: ScreenshotCaptureOptions): Promise<string>;
-export type ScreenshotCaptureOptions = {
-    rect?: import("@appium/types").Rect | null | undefined;
-    coordinateSystem?: "Viewport" | "Page" | undefined;
-};
-export type RemoteDebugger = import("../remote-debugger").RemoteDebugger;
+export interface ScreenshotCaptureOptions {
+    /** The rectangle to capture. If null, captures the whole viewport. */
+    rect?: Rect | null;
+    /** The coordinate system to use for the rectangle. */
+    coordinateSystem?: 'Viewport' | 'Page';
+}
+/**
+ * Captures a screenshot of a rectangular area of the page or the entire viewport.
+ * If no rectangle is provided, captures the full viewport by default.
+ *
+ * @param opts - Screenshot capture options. If not provided, captures the entire viewport.
+ *               - rect: The rectangle to capture. If null, captures the whole viewport.
+ *               - coordinateSystem: The coordinate system to use ('Viewport' or 'Page').
+ *                                  Defaults to 'Viewport'.
+ * @returns A promise that resolves to a base64-encoded string of the screenshot
+ *          (without the data URL prefix).
+ */
+export declare function captureScreenshot(this: RemoteDebugger, opts?: ScreenshotCaptureOptions): Promise<string>;
 //# sourceMappingURL=screenshot.d.ts.map

package/build/lib/mixins/screenshot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"screenshot.d.ts","sourceRoot":"","sources":["../../../lib/mixins/screenshot.js"],"names":[],"mappings":"AAKA;;;;;;GAMG;AACH,4FAJW,wBAAwB,GAEtB,OAAO,CAAC,MAAM,CAAC,CAsB3B;;;;;6BASY,OAAO,oBAAoB,EAAE,cAAc"}
+{"version":3,"file":"screenshot.d.ts","sourceRoot":"","sources":["../../../lib/mixins/screenshot.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,sEAAsE;IACtE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACnB,sDAAsD;IACtD,gBAAgB,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;CACxC;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,cAAc,EACpB,IAAI,GAAE,wBAA6B,GAClC,OAAO,CAAC,MAAM,CAAC,CAoBjB"}

package/build/lib/mixins/screenshot.js

@@ -3,16 +3,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.captureScreenshot = captureScreenshot;
 const property_accessors_1 = require("./property-accessors");
 /**
- * Capture a rect of the page or by default the viewport
- * @this {RemoteDebugger}
- * @param {ScreenshotCaptureOptions} [opts={}]  if rect is null capture the whole
- * coordinate system else capture the rect in the given coordinateSystem
- * @returns {Promise<string>} a base64 encoded string of the screenshot
+ * Captures a screenshot of a rectangular area of the page or the entire viewport.
+ * If no rectangle is provided, captures the full viewport by default.
+ *
+ * @param opts - Screenshot capture options. If not provided, captures the entire viewport.
+ *               - rect: The rectangle to capture. If null, captures the whole viewport.
+ *               - coordinateSystem: The coordinate system to use ('Viewport' or 'Page').
+ *                                  Defaults to 'Viewport'.
+ * @returns A promise that resolves to a base64-encoded string of the screenshot
+ *          (without the data URL prefix).
  */
 async function captureScreenshot(opts = {}) {
     const { rect = null, coordinateSystem = 'Viewport' } = opts;
     this.log.debug('Capturing screenshot');
-    const arect = rect ?? /** @type {import('@appium/types').Rect} */ (await this.executeAtom('execute_script', ['return {x: 0, y: 0, width: window.innerWidth, height: window.innerHeight}', []]));
+    const arect = rect ?? await this.executeAtom('execute_script', ['return {x: 0, y: 0, width: window.innerWidth, height: window.innerHeight}', []]);
     const response = await this.requireRpcClient().send('Page.snapshotRect', {
         ...arect,
         appIdKey: (0, property_accessors_1.getAppIdKey)(this),
@@ -24,12 +28,4 @@ async function captureScreenshot(opts = {}) {
     }
     return response.dataURL.replace(/^data:image\/png;base64,/, '');
 }
-/**
- * @typedef {Object} ScreenshotCaptureOptions
- * @property {import('@appium/types').Rect | null} [rect=null]
- * @property {"Viewport" | "Page"} [coordinateSystem="Viewport"]
- */
-/**
- * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
- */
 //# sourceMappingURL=screenshot.js.map

package/build/lib/mixins/screenshot.js.map

@@ -1 +1 @@
-{"version":3,"file":"screenshot.js","sourceRoot":"","sources":["../../../lib/mixins/screenshot.js"],"names":[],"mappings":";;AAYA,8CAoBC;AAhCD,6DAG8B;AAE9B;;;;;;GAMG;AACI,KAAK,UAAU,iBAAiB,CAAC,IAAI,GAAG,EAAE;IAC/C,MAAM,EAAC,IAAI,GAAG,IAAI,EAAE,gBAAgB,GAAG,UAAU,EAAC,GAAG,IAAI,CAAC;IAC1D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAEvC,MAAM,KAAK,GAAG,IAAI,IAAI,2CAA2C,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CACvF,gBAAgB,EAChB,CAAC,2EAA2E,EAAE,EAAE,CAAC,CAClF,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE;QACvE,GAAG,KAAK;QACR,QAAQ,EAAE,IAAA,gCAAW,EAAC,IAAI,CAAC;QAC3B,SAAS,EAAE,IAAA,iCAAY,EAAC,IAAI,CAAC;QAC7B,gBAAgB;KACjB,CAAC,CAAC;IAEH,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAC;AAClE,CAAC;AAED;;;;GAIG;AAEH;;GAEG"}
+{"version":3,"file":"screenshot.js","sourceRoot":"","sources":["../../../lib/mixins/screenshot.ts"],"names":[],"mappings":";;AA4BA,8CAuBC;AAnDD,6DAG8B;AAc9B;;;;;;;;;;GAUG;AACI,KAAK,UAAU,iBAAiB,CAErC,OAAiC,EAAE;IAEnC,MAAM,EAAC,IAAI,GAAG,IAAI,EAAE,gBAAgB,GAAG,UAAU,EAAC,GAAG,IAAI,CAAC;IAC1D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAEvC,MAAM,KAAK,GAAG,IAAI,IAAK,MAAM,IAAI,CAAC,WAAW,CAC3C,gBAAgB,EAChB,CAAC,2EAA2E,EAAE,EAAE,CAAC,CACzE,CAAC;IACX,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE;QACvE,GAAG,KAAK;QACR,QAAQ,EAAE,IAAA,gCAAW,EAAC,IAAI,CAAC;QAC3B,SAAS,EAAE,IAAA,iCAAY,EAAC,IAAI,CAAC;QAC7B,gBAAgB;KACjB,CAAC,CAAC;IAEH,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAC;AAClE,CAAC"}