@limrun/appium-xcuitest-driver 10.4.3-lim.1

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

@@ -0,0 +1,297 @@
+/**
+ * @this {XCUITestDriver}
+ * @group Mobile Web Only
+ * @param {number|string|null} frame
+ * @returns {Promise<void>}
+ */
+export function setFrame(this: import("../driver").XCUITestDriver, frame: number | string | null): Promise<void>;
+export class setFrame {
+    /**
+     * @this {XCUITestDriver}
+     * @group Mobile Web Only
+     * @param {number|string|null} frame
+     * @returns {Promise<void>}
+     */
+    constructor(this: import("../driver").XCUITestDriver, frame: number | string | null);
+    curWebFrames: any[] | undefined;
+}
+/**
+ * @this {XCUITestDriver}
+ * @group Mobile Web Only
+ * @param {string} propertyName
+ * @param {Element | string} el
+ * @returns {Promise<string>}
+ */
+export function getCssProperty(this: import("../driver").XCUITestDriver, propertyName: string, el: Element | string): Promise<string>;
+/**
+ * Submit the form an element is in
+ *
+ * @param {string|Element} el - the element ID
+ * @group Mobile Web Only
+ * @this {XCUITestDriver}
+ */
+export function submit(this: import("../driver").XCUITestDriver, el: string | Element): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ * @group Mobile Web Only
+ */
+export function refresh(this: import("../driver").XCUITestDriver): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ * @group Mobile Web Only
+ * @returns {Promise<string>}
+ */
+export function getUrl(this: import("../driver").XCUITestDriver): Promise<string>;
+/**
+ * @this {XCUITestDriver}
+ * @group Mobile Web Only
+ * @returns {Promise<string>}
+ */
+export function title(this: import("../driver").XCUITestDriver): Promise<string>;
+/**
+ * @this {XCUITestDriver}
+ * @group Mobile Web Only
+ * @returns {Promise<import('@appium/types').Cookie[]>}
+ */
+export function getCookies(this: import("../driver").XCUITestDriver): Promise<import("@appium/types").Cookie[]>;
+/**
+ * @this {XCUITestDriver}
+ * @group Mobile Web Only
+ * @param {import('@appium/types').Cookie} cookie
+ * @returns {Promise<void>}
+ */
+export function setCookie(this: import("../driver").XCUITestDriver, cookie: import("@appium/types").Cookie): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ * @param {string} cookieName
+ * @returns {Promise<void>}
+ * @group Mobile Web Only
+ */
+export function deleteCookie(this: import("../driver").XCUITestDriver, cookieName: string): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ * @group Mobile Web Only
+ * @returns {Promise<void>}
+ */
+export function deleteCookies(this: import("../driver").XCUITestDriver): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ * @param {Element | string} el
+ * @returns {Element | string}
+ */
+export function cacheWebElement(this: import("../driver").XCUITestDriver, el: Element | string): Element | string;
+/**
+ * @this {XCUITestDriver}
+ * @param {any} response
+ * @returns {any}
+ */
+export function cacheWebElements(this: import("../driver").XCUITestDriver, response: any): any;
+/**
+ * @param {string} atom
+ * @param {unknown[]} args
+ * @returns {Promise<any>}
+ * @privateRemarks This should return `Promise<T>` where `T` extends `unknown`, but that's going to cause a lot of things to break.
+ * @this {XCUITestDriver}
+ */
+export function executeAtom(this: import("../driver").XCUITestDriver, atom: string, args: unknown[], alwaysDefaultFrame?: boolean): Promise<any>;
+/**
+ * @this {XCUITestDriver}
+ * @param {string} atom
+ * @param {any[]} args
+ */
+export function executeAtomAsync(this: import("../driver").XCUITestDriver, atom: string, args: any[]): Promise<any>;
+export class executeAtomAsync {
+    /**
+     * @this {XCUITestDriver}
+     * @param {string} atom
+     * @param {any[]} args
+     */
+    constructor(this: import("../driver").XCUITestDriver, atom: string, args: any[]);
+    asyncPromise: {
+        resolve: (thenableOrResult?: any) => void;
+        reject: (error?: any) => void;
+    };
+}
+/**
+ * @template {string} S
+ * @param {S|Element<S>} elOrId
+ * @returns {import('./types').AtomsElement<S>}
+ * @this {XCUITestDriver}
+ */
+export function getAtomsElement<S extends string>(this: import("../driver").XCUITestDriver, elOrId: S | Element<S>): import("./types").AtomsElement<S>;
+/**
+ * @param {readonly any[]} [args]
+ * @this {XCUITestDriver}
+ */
+export function convertElementsForAtoms(this: import("../driver").XCUITestDriver, args?: readonly any[]): any;
+/**
+ *
+ * @param {any} element
+ * @returns {string | undefined}
+ */
+export function getElementId(element: any): string | undefined;
+/**
+ * @param {any} element
+ * @returns {element is Element}
+ */
+export function hasElementId(element: any): element is Element;
+/**
+ * @this {XCUITestDriver}
+ * @param {string} strategy
+ * @param {string} selector
+ * @param {boolean} [many]
+ * @param {Element | string | null} [ctx]
+ * @returns {Promise<Element | Element[]>}
+ */
+export function findWebElementOrElements(this: import("../driver").XCUITestDriver, strategy: string, selector: string, many?: boolean, ctx?: Element | string | null): Promise<Element | Element[]>;
+/**
+ * @this {XCUITestDriver}
+ * @param {number} x
+ * @param {number} y
+ */
+export function clickWebCoords(this: import("../driver").XCUITestDriver, x: number, y: number): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<boolean>}
+ */
+export function getSafariIsIphone(this: import("../driver").XCUITestDriver): Promise<boolean>;
+export class getSafariIsIphone {
+    _isSafariIphone: boolean | undefined;
+}
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<import('@appium/types').Size>}
+ */
+export function getSafariDeviceSize(this: import("../driver").XCUITestDriver): Promise<import("@appium/types").Size>;
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<boolean>}
+ */
+export function getSafariIsNotched(this: import("../driver").XCUITestDriver): Promise<boolean>;
+export class getSafariIsNotched {
+    _isSafariNotched: boolean | undefined;
+}
+/**
+ * @this {XCUITestDriver}
+ */
+export function getExtraTranslateWebCoordsOffset(this: import("../driver").XCUITestDriver, wvPos: any, realDims: any): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ * @param {boolean} isIphone
+ * @param {string} bannerVisibility
+ * @returns {Promise<number>}
+ */
+export function getExtraNativeWebTapOffset(this: import("../driver").XCUITestDriver, isIphone: boolean, bannerVisibility: string): Promise<number>;
+/**
+ * @this {XCUITestDriver}
+ * @param {any} el
+ * @returns {Promise<void>}
+ */
+export function nativeWebTap(this: import("../driver").XCUITestDriver, el: any): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ * @param {number} x
+ * @param {number} y
+ * @returns {Promise<import('@appium/types').Position>}
+ */
+export function translateWebCoords(this: import("../driver").XCUITestDriver, x: number, y: number): Promise<import("@appium/types").Position>;
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<boolean>}
+ */
+export function checkForAlert(this: import("../driver").XCUITestDriver): Promise<boolean>;
+/**
+ * @param {Promise<any>} promise
+ * @this {XCUITestDriver}
+ */
+export function waitForAtom(this: import("../driver").XCUITestDriver, promise: Promise<any>): Promise<any>;
+/**
+ * @param {string} navType
+ * @this {XCUITestDriver}
+ */
+export function mobileWebNav(this: import("../driver").XCUITestDriver, navType: string): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ * @returns {string} The base url which could be used to access WDA HTTP endpoints.
+ */
+export function getWdaLocalhostRoot(this: import("../driver").XCUITestDriver): string;
+/**
+ * Calibrates web to real coordinates translation.
+ * This API can only be called from Safari web context.
+ * It must load a custom page to the browser, and then restore
+ * the original one, so don't call it if you can potentially
+ * lose the current web app state.
+ * The outcome of this API is then used in nativeWebTap mode.
+ * The returned value could also be used to manually transform web coordinates
+ * to real devices ones in client scripts.
+ *
+ * @this {XCUITestDriver}
+ * @returns {Promise<import('../types').CalibrationData>}
+ */
+export function mobileCalibrateWebToRealCoordinatesTranslation(this: import("../driver").XCUITestDriver): Promise<import("../types").CalibrationData>;
+export class mobileCalibrateWebToRealCoordinatesTranslation {
+    webviewCalibrationResult: {
+        offsetX: number;
+        offsetY: number;
+        pixelRatioX: number;
+        pixelRatioY: number;
+    };
+}
+/**
+ * @typedef {Object} SafariOpts
+ * @property {object} preferences An object containing Safari settings to be updated.
+ * The list of available setting names and their values could be retrieved by
+ * changing the corresponding Safari settings in the UI and then inspecting
+ * 'Library/Preferences/com.apple.mobilesafari.plist' file inside of
+ * com.apple.mobilesafari app container.
+ * The full path to the Mobile Safari's container could be retrieved from
+ * `xcrun simctl get_app_container <sim_udid> com.apple.mobilesafari data`
+ * command output.
+ * Use the `xcrun simctl spawn <sim_udid> defaults read <path_to_plist>` command
+ * to print the plist content to the Terminal.
+ */
+/**
+ * Updates Mobile Safari preferences on an iOS Simulator
+ *
+ * @param {import('@appium/types').StringRecord} preferences - An object containing Safari settings to be updated.
+ * The list of available setting names and their values can be retrieved by changing the
+ * corresponding Safari settings in the UI and then inspecting
+ * `Library/Preferences/com.apple.mobilesafari.plist` file inside of the `com.apple.mobilesafari`
+ * app container within the simulator filesystem. The full path to Mobile Safari's container can
+ * be retrieved by running `xcrun simctl get_app_container <sim_udid> com.apple.mobilesafari
+ * data`. Use the `xcrun simctl spawn <sim_udid> defaults read <path_to_plist>` command to print
+ * the plist content to the Terminal.
+ *
+ * @group Simulator Only
+ * @returns {Promise<void>}
+ * @throws {Error} if run on a real device or if the preferences argument is invalid
+ * @this {XCUITestDriver}
+ */
+export function mobileUpdateSafariPreferences(this: import("../driver").XCUITestDriver, preferences: import("@appium/types").StringRecord): Promise<void>;
+export type SafariOpts = {
+    /**
+     * An object containing Safari settings to be updated.
+     * The list of available setting names and their values could be retrieved by
+     * changing the corresponding Safari settings in the UI and then inspecting
+     * 'Library/Preferences/com.apple.mobilesafari.plist' file inside of
+     * com.apple.mobilesafari app container.
+     * The full path to the Mobile Safari's container could be retrieved from
+     * `xcrun simctl get_app_container <sim_udid> com.apple.mobilesafari data`
+     * command output.
+     * Use the `xcrun simctl spawn <sim_udid> defaults read <path_to_plist>` command
+     * to print the plist content to the Terminal.
+     */
+    preferences: object;
+};
+export type CookieOptions = {
+    expires?: string | undefined;
+    path?: string | undefined;
+    domain?: string | undefined;
+    secure?: boolean | undefined;
+    httpOnly?: boolean | undefined;
+};
+export type XCUITestDriver = import("../driver").XCUITestDriver;
+export type Rect = import("@appium/types").Rect;
+export type Element<S extends string = string> = import("@appium/types").Element<S>;
+export type RemoteDebugger = import("appium-remote-debugger").RemoteDebugger;
+//# sourceMappingURL=web.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../../../lib/commands/web.js"],"names":[],"mappings":"AAqDA;;;;;GAKG;AACH,0EAHW,MAAM,GAAC,MAAM,GAAC,IAAI,GAChB,OAAO,CAAC,IAAI,CAAC,CA2BzB;;IA/BD;;;;;OAKG;IACH,6DAHW,MAAM,GAAC,MAAM,GAAC,IAAI,EA4B5B;IAnBG,gCAAsB;;AAqB1B;;;;;;GAMG;AACH,uFAJW,MAAM,MACN,OAAO,GAAG,MAAM,GACd,OAAO,CAAC,MAAM,CAAC,CAS3B;AAED;;;;;;GAMG;AACH,qEAJW,MAAM,GAAC,OAAO,iBAWxB;AAED;;;GAGG;AACH,iFAMC;AAED;;;;GAIG;AACH,kEAFa,OAAO,CAAC,MAAM,CAAC,CAQ3B;AAED;;;;GAIG;AACH,iEAFa,OAAO,CAAC,MAAM,CAAC,CAQ3B;AAED;;;;GAIG;AACH,sEAFa,OAAO,CAAC,OAAO,eAAe,EAAE,MAAM,EAAE,CAAC,CAyBrD;AAED;;;;;GAKG;AACH,4EAHW,OAAO,eAAe,EAAE,MAAM,GAC5B,OAAO,CAAC,IAAI,CAAC,CAuBzB;AAED;;;;;GAKG;AACH,mFAJW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAgBzB;AAED;;;;GAIG;AACH,yEAFa,OAAO,CAAC,IAAI,CAAC,CASzB;AAED;;;;GAIG;AACH,8EAHW,OAAO,GAAG,MAAM,GACd,OAAO,GAAG,MAAM,CAe5B;AAED;;;;GAIG;AACH,qFAHW,GAAG,GACD,GAAG,CAef;AAED;;;;;;GAMG;AACH,4EANW,MAAM,QACN,OAAO,EAAE,iCACP,OAAO,CAAC,GAAG,CAAC,CAQxB;AAED;;;;GAIG;AACH,iFAHW,MAAM,QACN,GAAG,EAAE,gBASf;;IAZD;;;;OAIG;IACH,4DAHW,MAAM,QACN,GAAG,EAAE,EASf;IAJG;;;MAAqC;;AAMzC;;;;;GAKG;AACH,gCALsB,CAAC,SAAV,MAAQ,oDACV,CAAC,GAAC,OAAO,CAAC,CAAC,CAAC,GACV,OAAO,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,CAS7C;AAED;;;GAGG;AACH,yFAHW,SAAS,GAAG,EAAE,OAiBxB;AAED;;;;GAIG;AACH,sCAHW,GAAG,GACD,MAAM,GAAG,SAAS,CAI9B;AAED;;;GAGG;AACH,sCAHW,GAAG,GACD,OAAO,IAAI,OAAO,CAO9B;AAED;;;;;;;GAOG;AACH,6FANW,MAAM,YACN,MAAM,SACN,OAAO,QACP,OAAO,GAAG,MAAM,GAAG,IAAI,GACrB,OAAO,CAAC,OAAO,GAAG,OAAO,EAAE,CAAC,CA4BxC;AAED;;;;GAIG;AACH,4EAHW,MAAM,KACN,MAAM,iBAKhB;AAED;;;GAGG;AACH,6EAFa,OAAO,CAAC,OAAO,CAAC,CAc5B;;IANG,qCAAiE;;AAQrE;;;GAGG;AACH,+EAFa,OAAO,CAAC,OAAO,eAAe,EAAE,IAAI,CAAC,CAajD;AAED;;;GAGG;AACH,8EAFa,OAAO,CAAC,OAAO,CAAC,CAqB5B;;IAVO,sCAA4B;;AAYpC;;GAEG;AACH,qIA0FC;AAED;;;;;GAKG;AACH,+FAJW,OAAO,oBACP,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAuB3B;AAED;;;;GAIG;AACH,2EAHW,GAAG,GACD,OAAO,CAAC,IAAI,CAAC,CAwBzB;AAED;;;;;GAKG;AACH,gFAJW,MAAM,KACN,MAAM,GACJ,OAAO,CAAC,OAAO,eAAe,EAAE,QAAQ,CAAC,CA4FrD;AAED;;;GAGG;AACH,yEAFa,OAAO,CAAC,OAAO,CAAC,CAI5B;AAED;;;GAGG;AACH,+EAHW,OAAO,CAAC,GAAG,CAAC,gBA+EtB;AAED;;;GAGG;AACH,gFAHW,MAAM,iBAUhB;AAED;;;GAGG;AACH,+EAFa,MAAM,CAUlB;AAED;;;;;;;;;;;;GAYG;AACH,0GAFa,OAAO,CAAC,OAAO,UAAU,EAAE,eAAe,CAAC,CAgEvD;;IAnBK;;;;;MAKC;;AAgBP;;;;;;;;;;;;GAYG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,qGAdW,OAAO,eAAe,EAAE,YAAY,GAUlC,OAAO,CAAC,IAAI,CAAC,CAczB;;;;;;;;;;;;;;iBAvCa,MAAM;;;;;;;;;6BAiLP,OAAO,WAAW,EAAE,cAAc;mBAClC,OAAO,eAAe,EAAE,IAAI;oBAIlB,CAAC,SAAX,MAAQ,aACR,OAAO,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;6BAIlC,OAAO,wBAAwB,EAAE,cAAc"}