appium-xcuitest-driver 10.2.2 → 10.4.0

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

@@ -1,136 +1,189 @@
 /**
- * https://github.com/appium/appium/issues/20741
- *
  * @this {XCUITestDriver}
- * @returns {Promise<void>}
+ * @param {boolean} [useUrl=false]
+ * @returns {Promise<import('./types').ViewContext[]>}
  */
-export function notifyBiDiContextChange(this: import("../driver").XCUITestDriver): Promise<void>;
-declare namespace _default {
-    /**
-     * @this {XCUITestDriver}
-     * @returns {Promise<string>}
-     */
-    function getCurrentContext(this: import("../driver").XCUITestDriver): Promise<string>;
-    /**
-     * Set context
-     *
-     * @param {string|Context} name - The name of context to set. It could be 'null' as NATIVE_WIN.
-     * @param {any} [callback] The callback. (It is not called in this method)
-     * @param {boolean} [skipReadyCheck=false] - Whether it waits for the new context is ready
-     * @this {XCUITestDriver}
-     * @returns {Promise<void>}
-     */
-    function setContext(this: import("../driver").XCUITestDriver, name: string | Context, callback?: any, skipReadyCheck?: boolean): Promise<void>;
-    /**
-     * @this {XCUITestDriver}
-     * @returns {Promise<string[]|FullContext[]>}
-     */
-    function getContexts(this: import("../driver").XCUITestDriver): Promise<string[] | FullContext[]>;
-    /**
-     * @this {XCUITestDriver}
-     * @param {string} name
-     * @param {boolean} [skipReadyCheck]
-     * @returns {Promise<void>}
-     */
-    function setWindow(this: import("../driver").XCUITestDriver, name: string, skipReadyCheck?: boolean): Promise<void>;
-    /**
-     * @this {XCUITestDriver}
-     * @returns {Promise<string>}
-     */
-    function getWindowHandle(this: import("../driver").XCUITestDriver): Promise<string>;
-    /**
-     * @this {XCUITestDriver}
-     * @returns {Promise<string[]>}
-     */
-    function getWindowHandles(this: import("../driver").XCUITestDriver): Promise<string[]>;
+export function getContextsAndViews(this: import("../driver").XCUITestDriver, useUrl?: boolean): Promise<import("./types").ViewContext[]>;
+export class getContextsAndViews {
     /**
      * @this {XCUITestDriver}
      * @param {boolean} [useUrl=false]
      * @returns {Promise<import('./types').ViewContext[]>}
      */
-    function getContextsAndViews(this: import("../driver").XCUITestDriver, useUrl?: boolean): Promise<import("./types").ViewContext[]>;
-    /**
-     * @deprecated this method is not used anywhere and will be removed in the future
-     * @this {XCUITestDriver}
-     * @returns {boolean}
-     */
-    function useNewSafari(this: import("../driver").XCUITestDriver): boolean;
-    /**
-     * @this {XCUITestDriver}
-     * @returns {Promise<void>}
-     */
-    function activateRecentWebview(this: import("../driver").XCUITestDriver): Promise<void>;
-    /**
-     * @this {XCUITestDriver}
-     * @returns {Promise<import('../types').Page[]>}
-     */
-    function listWebFrames(this: import("../driver").XCUITestDriver, useUrl?: boolean): Promise<import("../types").Page[]>;
-    /**
-     * @this {XCUITestDriver}
-     * @returns {Promise<void>}
-     */
-    function connectToRemoteDebugger(this: import("../driver").XCUITestDriver): Promise<void>;
-    /**
-     * Retrieves the list of available contexts.
-     *
-     * The list includes extended context information, like URLs and page names.
-     * This is different from the standard `getContexts` API, because the latter
-     * only has web view names without any additional information.
-     *
-     * @remarks In situations where multiple web views are available at once, the
-     * client code would have to connect to each of them in order to detect the
-     * one which needs to be interacted with. This extra effort is not needed with
-     * the information provided by this extension.
-     * @param {number} [waitForWebviewMs=0] - The period to poll for available webview(s) (in ms)
-     * @returns {Promise<Context[]>} The list of available context objects along with their properties.
-     * @this {XCUITestDriver}
-     */
-    function mobileGetContexts(this: import("../driver").XCUITestDriver, waitForWebviewMs?: number): Promise<Context[]>;
+    constructor(this: import("../driver").XCUITestDriver, useUrl?: boolean);
+    contexts: string[];
+}
+/**
+ * @deprecated this method is not used anywhere and will be removed in the future
+ * @this {XCUITestDriver}
+ * @returns {boolean}
+ */
+export function useNewSafari(this: import("../driver").XCUITestDriver): boolean;
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
+ */
+export function activateRecentWebview(this: import("../driver").XCUITestDriver): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<import('../types').Page[]>}
+ */
+export function listWebFrames(this: import("../driver").XCUITestDriver, useUrl?: boolean): Promise<import("../types").Page[]>;
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
+ */
+export function connectToRemoteDebugger(this: import("../driver").XCUITestDriver): Promise<void>;
+export class connectToRemoteDebugger {
+    remote: RemoteDebugger;
+    curWebFrames: any[];
+}
+/**
+ * Retrieves the list of available contexts.
+ *
+ * The list includes extended context information, like URLs and page names.
+ * This is different from the standard `getContexts` API, because the latter
+ * only has web view names without any additional information.
+ *
+ * @remarks In situations where multiple web views are available at once, the
+ * client code would have to connect to each of them in order to detect the
+ * one which needs to be interacted with. This extra effort is not needed with
+ * the information provided by this extension.
+ * @param {number} [waitForWebviewMs=0] - The period to poll for available webview(s) (in ms)
+ * @returns {Promise<Context[]>} The list of available context objects along with their properties.
+ * @this {XCUITestDriver}
+ */
+export function mobileGetContexts(this: import("../driver").XCUITestDriver, waitForWebviewMs?: number): Promise<Context[]>;
+/**
+ * @this {XCUITestDriver}
+ * @param {import('./types').PageChangeNotification} pageChangeNotification
+ * @returns {Promise<void>}
+ */
+export function onPageChange(this: import("../driver").XCUITestDriver, pageChangeNotification: import("./types").PageChangeNotification): Promise<void>;
+export class onPageChange {
     /**
      * @this {XCUITestDriver}
      * @param {import('./types').PageChangeNotification} pageChangeNotification
      * @returns {Promise<void>}
      */
-    function onPageChange(this: import("../driver").XCUITestDriver, pageChangeNotification: import("./types").PageChangeNotification): Promise<void>;
+    constructor(this: import("../driver").XCUITestDriver, pageChangeNotification: import("./types").PageChangeNotification);
+    curContext: string | undefined;
+    selectingNewPage: boolean | undefined;
+}
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
+ */
+export function stopRemote(this: import("../driver").XCUITestDriver, closeWindowBeforeDisconnecting?: boolean): Promise<void>;
+export class stopRemote {
     /**
      * @this {XCUITestDriver}
      * @returns {Promise<void>}
      */
-    function stopRemote(this: import("../driver").XCUITestDriver, closeWindowBeforeDisconnecting?: boolean): Promise<void>;
+    constructor(this: import("../driver").XCUITestDriver, closeWindowBeforeDisconnecting?: boolean);
+    curContext: any;
+    curWebFrames: any[];
+    remote: any;
+}
+/**
+ * @this {XCUITestDriver}
+ * @param {string|undefined|null} url
+ */
+export function setCurrentUrl(this: import("../driver").XCUITestDriver, url: string | undefined | null): void;
+export class setCurrentUrl {
     /**
      * @this {XCUITestDriver}
      * @param {string|undefined|null} url
      */
-    function setCurrentUrl(this: import("../driver").XCUITestDriver, url: string | undefined | null): void;
-    /**
-     * @this {XCUITestDriver}
-     * @returns {string|undefined|null}
-     */
-    function getCurrentUrl(this: import("../driver").XCUITestDriver): string | undefined | null;
-    /**
-     * @param {RegExp} titleRegExp
-     * @param {RegExp} urlRegExp
-     * @this {XCUITestDriver}
-     * @returns {Promise<string|undefined>}
-     */
-    function getRecentWebviewContextId(this: import("../driver").XCUITestDriver, titleRegExp: RegExp, urlRegExp: RegExp): Promise<string | undefined>;
-    /**
-     * @this {XCUITestDriver}
-     * @returns {boolean}
-     */
-    function isWebContext(this: import("../driver").XCUITestDriver): boolean;
-    /**
-     * @this {XCUITestDriver}
-     * @returns {boolean}
-     */
-    function isWebview(this: import("../driver").XCUITestDriver): boolean;
+    constructor(this: import("../driver").XCUITestDriver, url: string | undefined | null);
+    _currentUrl: string | null | undefined;
+}
+/**
+ * @this {XCUITestDriver}
+ * @returns {string|undefined|null}
+ */
+export function getCurrentUrl(this: import("../driver").XCUITestDriver): string | undefined | null;
+/**
+ * @param {RegExp} titleRegExp
+ * @param {RegExp} urlRegExp
+ * @this {XCUITestDriver}
+ * @returns {Promise<string|undefined>}
+ */
+export function getRecentWebviewContextId(this: import("../driver").XCUITestDriver, titleRegExp: RegExp, urlRegExp: RegExp): Promise<string | undefined>;
+/**
+ * @this {XCUITestDriver}
+ * @returns {boolean}
+ */
+export function isWebContext(this: import("../driver").XCUITestDriver): boolean;
+/**
+ * @this {XCUITestDriver}
+ * @returns {boolean}
+ */
+export function isWebview(this: import("../driver").XCUITestDriver): boolean;
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<RemoteDebugger>}
+ */
+export function getNewRemoteDebugger(this: import("../driver").XCUITestDriver): Promise<RemoteDebugger>;
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<string>}
+ */
+export function getCurrentContext(this: import("../driver").XCUITestDriver): Promise<string>;
+/**
+ * Set context
+ *
+ * @param {string|Context} name - The name of context to set. It could be 'null' as NATIVE_WIN.
+ * @param {any} [callback] The callback. (It is not called in this method)
+ * @param {boolean} [skipReadyCheck=false] - Whether it waits for the new context is ready
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
+ */
+export function setContext(this: import("../driver").XCUITestDriver, name: string | Context, callback?: any, skipReadyCheck?: boolean): Promise<void>;
+export class setContext {
     /**
+     * Set context
+     *
+     * @param {string|Context} name - The name of context to set. It could be 'null' as NATIVE_WIN.
+     * @param {any} [callback] The callback. (It is not called in this method)
+     * @param {boolean} [skipReadyCheck=false] - Whether it waits for the new context is ready
      * @this {XCUITestDriver}
-     * @returns {Promise<RemoteDebugger>}
+     * @returns {Promise<void>}
      */
-    function getNewRemoteDebugger(this: import("../driver").XCUITestDriver): Promise<RemoteDebugger>;
+    constructor(this: import("../driver").XCUITestDriver, name: string | Context, callback?: any, skipReadyCheck?: boolean);
+    curContext: string | null | undefined;
+    curWindowHandle: string | undefined;
+    selectingNewPage: boolean | undefined;
 }
-export default _default;
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<string[]|FullContext[]>}
+ */
+export function getContexts(this: import("../driver").XCUITestDriver): Promise<string[] | FullContext[]>;
+/**
+ * @this {XCUITestDriver}
+ * @param {string} name
+ * @param {boolean} [skipReadyCheck]
+ * @returns {Promise<void>}
+ */
+export function setWindow(this: import("../driver").XCUITestDriver, name: string, skipReadyCheck?: boolean): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<string>}
+ */
+export function getWindowHandle(this: import("../driver").XCUITestDriver): Promise<string>;
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<string[]>}
+ */
+export function getWindowHandles(this: import("../driver").XCUITestDriver): Promise<string[]>;
+/**
+ * https://github.com/appium/appium/issues/20741
+ *
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
+ */
+export function notifyBiDiContextChange(this: import("../driver").XCUITestDriver): Promise<void>;
 export type XCUITestDriver = import("../driver").XCUITestDriver;
 export type Context = import("./types").Context;
 export type FullContext = import("./types").FullContext;

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

@@ -1 +1 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../lib/commands/context.js"],"names":[],"mappings":"AAyqBA;;;;;GAKG;AACH,mFAFa,OAAO,CAAC,IAAI,CAAC,CAMzB;;IAlPC;;;OAGG;IACH,sEAFa,OAAO,CAAC,MAAM,CAAC,CAO3B;IAED;;;;;;;;OAQG;IACH,oEANW,MAAM,GAAC,OAAO,aACd,GAAG,mBACH,OAAO,GAEL,OAAO,CAAC,IAAI,CAAC,CAqGzB;IACD;;;OAGG;IACH,gEAFa,OAAO,CAAC,MAAM,EAAE,GAAC,WAAW,EAAE,CAAC,CAiB3C;IAED;;;;;OAKG;IACH,mEAJW,MAAM,mBACN,OAAO,GACL,OAAO,CAAC,IAAI,CAAC,CAazB;IACD;;;OAGG;IACH,oEAFa,OAAO,CAAC,MAAM,CAAC,CAY3B;IACD;;;OAGG;IACH,qEAFa,OAAO,CAAC,MAAM,EAAE,CAAC,CAoB7B;IAhnBD;;;;OAIG;IACH,gFAHW,OAAO,GACL,OAAO,CAAC,OAAO,SAAS,EAAE,WAAW,EAAE,CAAC,CAepD;IAED;;;;OAIG;IACH,iEAFa,OAAO,CAInB;IAED;;;OAGG;IACH,0EAFa,OAAO,CAAC,IAAI,CAAC,CAwCzB;IACD;;;OAGG;IACH,oFAFa,OAAO,CAAC,OAAO,UAAU,EAAE,IAAI,EAAE,CAAC,CA0C9C;IACD;;;OAGG;IACH,4EAFa,OAAO,CAAC,IAAI,CAAC,CA6BzB;IAED;;;;;;;;;;;;;;OAcG;IACH,wFAJW,MAAM,GACJ,OAAO,CAAC,OAAO,EAAE,CAAC,CAmC9B;IACD;;;;OAIG;IACH,wFAHW,OAAO,SAAS,EAAE,sBAAsB,GACtC,OAAO,CAAC,IAAI,CAAC,CAmHzB;IAID;;;OAGG;IACH,yGAFa,OAAO,CAAC,IAAI,CAAC,CAezB;IACD;;;OAGG;IACH,sEAFW,MAAM,GAAC,SAAS,GAAC,IAAI,QAI/B;IACD;;;OAGG;IACH,kEAFa,MAAM,GAAC,SAAS,GAAC,IAAI,CAIjC;IACD;;;;;OAKG;IACH,0FALW,MAAM,aACN,MAAM,GAEJ,OAAO,CAAC,MAAM,GAAC,SAAS,CAAC,CAuBrC;IACD;;;OAGG;IACH,iEAFa,OAAO,CAInB;IACD;;;OAGG;IACH,8DAFa,OAAO,CAInB;IACD;;;OAGG;IACH,yEAFa,OAAO,CAAC,cAAc,CAAC,CA4BnC;;;6BA2PU,OAAO,WAAW,EAAE,cAAc;sBAClC,OAAO,SAAS,EAAE,OAAO;0BACzB,OAAO,SAAS,EAAE,WAAW;+BA1rBS,wBAAwB"}
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../lib/commands/context.js"],"names":[],"mappings":"AAoBA;;;;GAIG;AACH,uFAHW,OAAO,GACL,OAAO,CAAC,OAAO,SAAS,EAAE,WAAW,EAAE,CAAC,CAepD;;IAlBD;;;;OAIG;IACH,+DAHW,OAAO,EAgBjB;IANC,mBAA4B;;AAQ9B;;;;GAIG;AACH,wEAFa,OAAO,CAInB;AAED;;;GAGG;AACH,iFAFa,OAAO,CAAC,IAAI,CAAC,CAwCzB;AAED;;;GAGG;AACH,2FAFa,OAAO,CAAC,OAAO,UAAU,EAAE,IAAI,EAAE,CAAC,CA0C9C;AAED;;;GAGG;AACH,mFAFa,OAAO,CAAC,IAAI,CAAC,CA6BzB;;IA1BC,uBAA+C;IAc7C,oBAAsB;;AAc1B;;;;;;;;;;;;;;GAcG;AACH,+FAJW,MAAM,GACJ,OAAO,CAAC,OAAO,EAAE,CAAC,CAmC9B;AAED;;;;GAIG;AACH,+FAHW,OAAO,SAAS,EAAE,sBAAsB,GACtC,OAAO,CAAC,IAAI,CAAC,CAmHzB;;IAtHD;;;;OAIG;IACH,8EAHW,OAAO,SAAS,EAAE,sBAAsB,EAoHlD;IA/BG,+BAAwC;IAkBxC,sCAA4B;;AAehC;;;GAGG;AACH,gHAFa,OAAO,CAAC,IAAI,CAAC,CAezB;;IAjBD;;;OAGG;IACH,gGAaC;IAJC,gBAAsB;IAEtB,oBAAsB;IACtB,YAAkB;;AAGpB;;;GAGG;AACH,6EAFW,MAAM,GAAC,SAAS,GAAC,IAAI,QAI/B;;IAND;;;OAGG;IACH,2DAFW,MAAM,GAAC,SAAS,GAAC,IAAI,EAI/B;IADC,uCAAsB;;AAGxB;;;GAGG;AACH,yEAFa,MAAM,GAAC,SAAS,GAAC,IAAI,CAIjC;AAED;;;;;GAKG;AACH,iGALW,MAAM,aACN,MAAM,GAEJ,OAAO,CAAC,MAAM,GAAC,SAAS,CAAC,CAuBrC;AAED;;;GAGG;AACH,wEAFa,OAAO,CAInB;AAED;;;GAGG;AACH,qEAFa,OAAO,CAInB;AAED;;;GAGG;AACH,gFAFa,OAAO,CAAC,cAAc,CAAC,CA4BnC;AAED;;;GAGG;AACH,6EAFa,OAAO,CAAC,MAAM,CAAC,CAO3B;AAED;;;;;;;;GAQG;AACH,2EANW,MAAM,GAAC,OAAO,aACd,GAAG,mBACH,OAAO,GAEL,OAAO,CAAC,IAAI,CAAC,CAqGzB;;IA5GD;;;;;;;;OAQG;IACH,4DANW,MAAM,GAAC,OAAO,aACd,GAAG,mBACH,OAAO,EAuGjB;IApEK,sCAAsB;IAwBN,oCAAgC;IAKhD,sCAA4B;;AAyClC;;;GAGG;AACH,uEAFa,OAAO,CAAC,MAAM,EAAE,GAAC,WAAW,EAAE,CAAC,CAiB3C;AAED;;;;;GAKG;AACH,0EAJW,MAAM,mBACN,OAAO,GACL,OAAO,CAAC,IAAI,CAAC,CAazB;AAED;;;GAGG;AACH,2EAFa,OAAO,CAAC,MAAM,CAAC,CAY3B;AAED;;;GAGG;AACH,4EAFa,OAAO,CAAC,MAAM,EAAE,CAAC,CAoB7B;AAmCD;;;;;GAKG;AACH,mFAFa,OAAO,CAAC,IAAI,CAAC,CAMzB;6BAIY,OAAO,WAAW,EAAE,cAAc;sBAClC,OAAO,SAAS,EAAE,OAAO;0BACzB,OAAO,SAAS,EAAE,WAAW;+BA/rBS,wBAAwB"}