appium-xcuitest-driver 10.12.1 → 10.13.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [10.13.0](https://github.com/appium/appium-xcuitest-driver/compare/v10.12.2...v10.13.0) (2025-12-23)
+
+### Features
+
+* Migrate various command modules to typescript (part 1) ([#2683](https://github.com/appium/appium-xcuitest-driver/issues/2683)) ([c0b53ba](https://github.com/appium/appium-xcuitest-driver/commit/c0b53ba8fd212ce09f9d4c4d45f869a7c3f40fd2))
+
+## [10.12.2](https://github.com/appium/appium-xcuitest-driver/compare/v10.12.1...v10.12.2) (2025-12-22)
+
+### Miscellaneous Chores
+
+* **deps:** bump teen_process from 3.0.6 to 4.0.4 ([#2684](https://github.com/appium/appium-xcuitest-driver/issues/2684)) ([005e984](https://github.com/appium/appium-xcuitest-driver/commit/005e9846229fc2d4bcb468758f4e653a295599e6))
+
 ## [10.12.1](https://github.com/appium/appium-xcuitest-driver/compare/v10.12.0...v10.12.1) (2025-12-22)
 
 ### Miscellaneous Chores

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

@@ -1,43 +1,33 @@
+import { RemoteDebugger } from 'appium-remote-debugger';
+import type { XCUITestDriver } from '../driver';
+import type { Page } from '../types';
+import type { ViewContext, FullContext, PageChangeNotification } from './types';
 /**
- * @this {XCUITestDriver}
- * @param {boolean} [useUrl=false]
- * @returns {Promise<import('./types').ViewContext[]>}
+ * Retrieves the list of available contexts and their associated views.
+ *
+ * @param useUrl - Whether to filter webviews by URL
  */
-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[]>}
-     */
-    constructor(this: import("../driver").XCUITestDriver, useUrl?: boolean);
-    contexts: string[];
-}
+export declare function getContextsAndViews(this: XCUITestDriver, useUrl?: boolean): Promise<ViewContext[]>;
 /**
- * @deprecated this method is not used anywhere and will be removed in the future
- * @this {XCUITestDriver}
- * @returns {boolean}
+ * @deprecated This method is not used anywhere and will be removed in the future
  */
-export function useNewSafari(this: import("../driver").XCUITestDriver): boolean;
+export declare function useNewSafari(this: XCUITestDriver): boolean;
 /**
- * @this {XCUITestDriver}
- * @returns {Promise<void>}
+ * Activates the most recently available webview context.
+ *
+ * @throws {Error} If no webview is available or if the remote debugger cannot connect
  */
-export function activateRecentWebview(this: import("../driver").XCUITestDriver): Promise<void>;
+export declare function activateRecentWebview(this: XCUITestDriver): Promise<void>;
 /**
- * @this {XCUITestDriver}
- * @returns {Promise<import('../types').Page[]>}
+ * Lists all available web frames (pages) from the remote debugger.
+ *
+ * @param useUrl - Whether to filter pages by the current URL
  */
-export function listWebFrames(this: import("../driver").XCUITestDriver, useUrl?: boolean): Promise<import("../types").Page[]>;
+export declare function listWebFrames(this: XCUITestDriver, useUrl?: boolean): Promise<Page[]>;
 /**
- * @this {XCUITestDriver}
- * @returns {Promise<void>}
+ * Establishes a connection to the remote debugger and sets up event listeners.
  */
-export function connectToRemoteDebugger(this: import("../driver").XCUITestDriver): Promise<void>;
-export class connectToRemoteDebugger {
-    remote: RemoteDebugger;
-    curWebFrames: any[];
-}
+export declare function connectToRemoteDebugger(this: XCUITestDriver): Promise<void>;
 /**
  * Retrieves the list of available contexts.
  *
@@ -49,143 +39,122 @@ export class connectToRemoteDebugger {
  * 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>}
-     */
-    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>}
-     */
-    constructor(this: import("../driver").XCUITestDriver, closeWindowBeforeDisconnecting?: boolean);
-    curContext: any;
-    curWebFrames: any[];
-    remote: any;
-}
-/**
- * @this {XCUITestDriver}
- * @param {string|null} url
- */
-export function setCurrentUrl(this: import("../driver").XCUITestDriver, url: string | null): void;
-export class setCurrentUrl {
-    /**
-     * @this {XCUITestDriver}
-     * @param {string|null} url
-     */
-    constructor(this: import("../driver").XCUITestDriver, url: string | null);
-    _currentUrl: string | null;
-}
-/**
- * @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<void>}
-     */
-    constructor(this: import("../driver").XCUITestDriver, name: string | Context, callback?: any, skipReadyCheck?: boolean);
-    curContext: string | null | undefined;
-    curWindowHandle: string | undefined;
-    selectingNewPage: boolean | undefined;
-}
-/**
- * @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>}
+ *
+ * @param waitForWebviewMs - The period to poll for available webview(s) (in ms)
+ * @returns The list of available context objects along with their properties.
  */
-export function setWindow(this: import("../driver").XCUITestDriver, name: string, skipReadyCheck?: boolean): Promise<void>;
+export declare function mobileGetContexts(this: XCUITestDriver, waitForWebviewMs?: number): Promise<FullContext[]>;
 /**
- * @this {XCUITestDriver}
- * @returns {Promise<string>}
+ * Handles page change notifications from the remote debugger.
+ *
+ * Updates the current context when new pages are detected or when pages are closed.
+ *
+ * @param pageChangeNotification - The notification containing page array and app ID
  */
-export function getWindowHandle(this: import("../driver").XCUITestDriver): Promise<string>;
+export declare function onPageChange(this: XCUITestDriver, pageChangeNotification: PageChangeNotification): Promise<void>;
 /**
- * @this {XCUITestDriver}
- * @returns {Promise<string[]>}
+ * Disconnects from the remote debugger and cleans up context state.
  */
-export function getWindowHandles(this: import("../driver").XCUITestDriver): Promise<string[]>;
+export declare function stopRemote(this: XCUITestDriver): Promise<void>;
 /**
- * https://github.com/appium/appium/issues/20741
+ * Sets the current URL for the active webview context.
  *
- * @this {XCUITestDriver}
- * @returns {Promise<void>}
+ * @param url - The URL to set, or null to clear
  */
-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;
-import { RemoteDebugger } from 'appium-remote-debugger';
+export declare function setCurrentUrl(this: XCUITestDriver, url: string | null): void;
+/**
+ * Gets the current URL for the active webview context.
+ *
+ * @returns The current URL, or undefined/null if not set
+ */
+export declare function getCurrentUrl(this: XCUITestDriver): string | undefined | null;
+/**
+ * Finds the most recent webview context ID matching the given title or URL patterns.
+ *
+ * @param titleRegExp - Regular expression to match against page titles
+ * @param urlRegExp - Regular expression to match against page URLs
+ * @returns The matching context ID, or undefined if no match is found
+ * @throws {errors.InvalidArgumentError} If neither regex is provided
+ */
+export declare function getRecentWebviewContextId(this: XCUITestDriver, titleRegExp: RegExp, urlRegExp: RegExp): Promise<string | undefined>;
+/**
+ * Checks if the current context is a web context (not native).
+ *
+ * @returns True if currently in a web context
+ */
+export declare function isWebContext(this: XCUITestDriver): boolean;
+/**
+ * Checks if the current context is a webview.
+ *
+ * This is an alias for {@linkcode isWebContext}.
+ *
+ * @returns True if currently in a webview context
+ */
+export declare function isWebview(this: XCUITestDriver): boolean;
+/**
+ * Creates a new remote debugger instance configured for the current device.
+ *
+ * @returns A configured RemoteDebugger instance
+ */
+export declare function getNewRemoteDebugger(this: XCUITestDriver): Promise<RemoteDebugger>;
+/**
+ * Gets the identifier of the current context.
+ *
+ * @returns The context identifier (e.g., 'NATIVE_APP' or 'WEBVIEW_xxx')
+ */
+export declare function getCurrentContext(this: XCUITestDriver): Promise<string>;
+/**
+ * Switches to the specified context (native or webview).
+ *
+ * @param name - The name of context to set. Can be 'NATIVE_APP', 'WEBVIEW_xxx', or null
+ * @param callback - The callback (not used, kept for compatibility)
+ * @param skipReadyCheck - Whether to skip waiting for the new context to be ready
+ * @throws {errors.NoSuchContextError} If the specified context does not exist
+ */
+export declare function setContext(this: XCUITestDriver, name: string | {
+    id: string;
+} | null, callback?: any, skipReadyCheck?: boolean): Promise<void>;
+/**
+ * Gets the list of available contexts.
+ *
+ * The format depends on the `fullContextList` option:
+ * - If enabled, returns full context objects with title, URL, and bundleId
+ * - If disabled, returns simple context ID strings
+ *
+ * @returns Array of context IDs or full context objects
+ */
+export declare function getContexts(this: XCUITestDriver): Promise<string[] | FullContext[]>;
+/**
+ * Sets the current window (context) in a web context.
+ *
+ * This is a wrapper around {@linkcode setContext} that translates errors appropriately.
+ *
+ * @param name - The window/context name to switch to
+ * @param skipReadyCheck - Whether to skip waiting for the window to be ready
+ * @throws {errors.NoSuchWindowError} If the window does not exist
+ */
+export declare function setWindow(this: XCUITestDriver, name: string, skipReadyCheck?: boolean): Promise<void>;
+/**
+ * Gets the handle of the current window.
+ *
+ * In native context, returns a default handle. In web context, returns the current context ID.
+ *
+ * @returns The window handle
+ * @throws {errors.InvalidContextError} If not in a valid context
+ */
+export declare function getWindowHandle(this: XCUITestDriver): Promise<string>;
+/**
+ * Gets the list of all available window handles.
+ *
+ * In native context, returns a single default handle. In web context, returns all webview handles.
+ *
+ * @returns Array of window handle strings
+ */
+export declare function getWindowHandles(this: XCUITestDriver): Promise<string[]>;
+/**
+ * Notifies BiDi clients about context changes.
+ *
+ * @see https://github.com/appium/appium/issues/20741
+ */
+export declare function notifyBiDiContextChange(this: XCUITestDriver): Promise<void>;
 //# sourceMappingURL=context.d.ts.map

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

@@ -1 +1 @@
-{"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,IAAI,QAIrB;;IAND;;;OAGG;IACH,2DAFW,MAAM,GAAC,IAAI,EAIrB;IADC,2BAAsB;;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"}
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../lib/commands/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAY5E,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,EAAC,WAAW,EAAE,WAAW,EAAE,sBAAsB,EAAC,MAAM,SAAS,CAAC;AAU9E;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,EAAE,cAAc,EAAE,MAAM,GAAE,OAAc,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAU9G;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAE1D;AAED;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAsC/E;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,cAAc,EAAE,MAAM,GAAE,OAAc,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAuCjG;AAED;;GAEG;AACH,wBAAsB,uBAAuB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CA2BjF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,cAAc,EAAE,gBAAgB,GAAE,MAAU,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CA+BlH;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE,cAAc,EAAE,sBAAsB,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CA6GtH;AAED;;GAEG;AACH,wBAAsB,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAiBpE;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAE5E;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAE7E;AAED;;;;;;;GAOG;AACH,wBAAsB,yBAAyB,CAC7C,IAAI,EAAE,cAAc,EACpB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAqB7B;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAE1D;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAEvD;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CA0BxF;AAED;;;;GAIG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAK7E;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAC9B,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE,MAAM,GAAG;IAAC,EAAE,EAAE,MAAM,CAAA;CAAC,GAAG,IAAI,EAClC,QAAQ,CAAC,EAAE,GAAG,EACd,cAAc,GAAE,OAAe,GAC9B,OAAO,CAAC,IAAI,CAAC,CAmGb;AAEH;;;;;;;;GAQG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,WAAW,EAAE,CAAC,CAazF;AAED;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAC7B,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE,MAAM,EACZ,cAAc,CAAC,EAAE,OAAO,GACvB,OAAO,CAAC,IAAI,CAAC,CAWf;AAED;;;;;;;GAOG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAU3E;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAkB9E;AAmCD;;;;GAIG;AACH,wBAAsB,uBAAuB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAIjF"}