@limrun/appium-xcuitest-driver 10.10.1-lim.8 → 10.11.0-lim.1

package/build/lib/utils.d.ts

@@ -1,133 +1,47 @@
-/**
- * Stops and removes all web socket handlers that are listening
- * in scope of the current session.
- *
- * @this {XCUITestDriver}
- * @returns {Promise<void>}
- */
-export function removeAllSessionWebSocketHandlers(this: import("./driver").XCUITestDriver): Promise<void>;
-/**
- * Asserts that the given driver is running on a Simulator and return
- * the simlator instance.
- *
- * @param {string} action - Description of action
- * @param {import('./driver').XCUITestDriver} driver
- * @returns {Simulator}
- */
-export function assertSimulator(action: string, driver: import("./driver").XCUITestDriver): Simulator;
-/**
- * Check if platform name is the TV OS one.
- *
- * @param {string|null|undefined} platformName
- * @returns {boolean}
- */
-export function isTvOs(platformName: string | null | undefined): boolean;
-/**
- * Return normalized platform name.
- *
- * @param {string|null|undefined} platformName
- * @returns {string}
- */
-export function normalizePlatformName(platformName: string | null | undefined): string;
-/**
- * @param {import('./driver').XCUITestDriverOpts} opts
- * @returns {boolean}
- */
-export function shouldSetInitialSafariUrl(opts: import("./driver").XCUITestDriverOpts): boolean;
-/**
- * @param {import('./driver').XCUITestDriverOpts} opts
- * @returns {boolean}
- */
-export function isIos17OrNewer(opts: import("./driver").XCUITestDriverOpts): boolean;
-/**
- * @param {import('./driver').XCUITestDriverOpts} opts
- * @returns {boolean}
- */
-export function isIos18OrNewer(opts: import("./driver").XCUITestDriverOpts): boolean;
-export const UDID_AUTO: "auto";
-export const NATIVE_WIN: "NATIVE_APP";
-export type UploadOptions = {
-    /**
-     * - The name of the user for the remote authentication. Only works if `remotePath` is provided.
-     */
-    user?: string | undefined;
-    /**
-     * - The password for the remote authentication. Only works if `remotePath` is provided.
-     */
-    pass?: string | undefined;
-    /**
-     * - The http multipart upload method name. The 'PUT' one is used by default.
-     * Only works if `remotePath` is provided.
-     */
-    method?: import("axios").Method | undefined;
-    /**
-     * - Additional headers mapping for multipart http(s) uploads
-     */
-    headers?: import("@appium/types").HTTPHeaders | undefined;
-    /**
-     * [file] - The name of the form field, where the file content BLOB should be stored for
-     *          http(s) uploads
-     */
-    fileFieldName?: string | undefined;
-    /**
-     * - Additional form fields for multipart http(s) uploads
-     */
-    formFields?: [string, any][] | Record<string, any> | undefined;
-};
-export type DriverInfo = {
-    /**
-     * Driver version string
-     */
-    version: string;
-    /**
-     * Driver build timestamp
-     */
-    built: string;
-};
-export type XcodeVersion = import("appium-xcode").XcodeVersion;
-export type Simulator = import("appium-ios-simulator").Simulator;
-export type XCUITestDriver = import("./driver").XCUITestDriver;
-/**
- * @privateRemarks Is the minimum version really Xcode 7.3?
- * @returns {Promise<XcodeVersion>}
- */
-export function getAndCheckXcodeVersion(): Promise<XcodeVersion>;
-/**
- * @returns {Promise<string|null>}
- */
-export function getAndCheckIosSdkVersion(): Promise<string | null>;
-export function checkAppPresent(app: any): Promise<void>;
+import _ from 'lodash';
+import type { XCUITestDriverOpts, XCUITestDriver } from './driver';
+import type { XcodeVersion } from 'appium-xcode';
+import type { Simulator } from 'appium-ios-simulator';
+import type { HTTPHeaders } from '@appium/types';
+import type { Method } from 'axios';
+export declare const UDID_AUTO = "auto";
+export declare const DEFAULT_TIMEOUT_KEY = "default";
+export declare const NATIVE_WIN = "NATIVE_APP";
+export declare function getAndCheckXcodeVersion(): Promise<XcodeVersion>;
+export declare function getAndCheckIosSdkVersion(): Promise<string | null>;
+export declare function clearLogs(locations: string[]): Promise<void>;
+export declare function markSystemFilesForCleanup(wda: any): Promise<void>;
+export declare function clearSystemFiles(wda: any): Promise<void>;
+export declare function checkAppPresent(app: string): Promise<void>;
 /**
  * @typedef {Object} DriverInfo
  * @property {string} version Driver version string
  * @property {string} built Driver build timestamp
  */
+export interface DriverInfo {
+    version: string;
+    built: string;
+}
 /**
- * @returns {DriverInfo}
+ * @returns
  */
-export const getDriverInfo: (() => Promise<{
-    built: string;
-    version: any;
-}>) & _.MemoizedFunction;
-export function clearSystemFiles(wda: any): Promise<void>;
-export function normalizeCommandTimeouts(value: any): any;
-export const DEFAULT_TIMEOUT_KEY: "default";
-export function markSystemFilesForCleanup(wda: any): Promise<void>;
-export function printUser(): Promise<void>;
+export declare const getDriverInfo: (() => Promise<DriverInfo>) & _.MemoizedFunction;
+export declare function normalizeCommandTimeouts(value: string | Record<string, number>): Record<string, number>;
+export declare function printUser(): Promise<void>;
 /**
  * Get the IDs of processes listening on the particular system port.
  * It is also possible to apply additional filtering based on the
  * process command line.
  *
- * @param {string|number} port - The port number.
- * @param {?Function} filteringFunc - Optional lambda function, which
+ * @param port - The port number.
+ * @param filteringFunc - Optional lambda function, which
  *                                    receives command line string of the particular process
  *                                    listening on given port, and is expected to return
  *                                    either true or false to include/exclude the corresponding PID
  *                                    from the resulting array.
- * @returns {Promise<string[]>} - the list of matched process ids.
+ * @returns - the list of matched process ids.
  */
-export function getPIDsListeningOnPort(port: string | number, filteringFunc?: Function | null): Promise<string[]>;
+export declare function getPIDsListeningOnPort(port: string | number, filteringFunc?: ((cmdLine: string) => boolean | Promise<boolean>) | null): Promise<string[]>;
 /**
  * @typedef {Object} UploadOptions
  *
@@ -140,45 +54,73 @@ export function getPIDsListeningOnPort(port: string | number, filteringFunc?: Fu
  *                                            http(s) uploads
  * @property {Record<string, any> | [string, any][]} [formFields] - Additional form fields for multipart http(s) uploads
  */
+export interface UploadOptions {
+    user?: string;
+    pass?: string;
+    method?: Method;
+    headers?: HTTPHeaders;
+    fileFieldName?: string;
+    formFields?: Record<string, any> | [string, any][];
+}
 /**
  * Encodes the given local file to base64 and returns the resulting string
  * or uploads it to a remote server using http/https or ftp protocols
  * if `remotePath` is set
  *
- * @param {string} localPath - The path to an existing local file
- * @param {string|null} [remotePath] - The path to the remote location, where
+ * @param localPath - The path to an existing local file
+ * @param remotePath - The path to the remote location, where
  *                               this file should be uploaded
- * @param {UploadOptions} uploadOptions - Set of upload options
- * @returns {Promise<string>} Either an empty string if the upload was successful or
+ * @param uploadOptions - Set of upload options
+ * @returns Either an empty string if the upload was successful or
  * base64-encoded file representation if `remotePath` is falsy
  */
-export function encodeBase64OrUpload(localPath: string, remotePath?: string | null, uploadOptions?: UploadOptions): Promise<string>;
+export declare function encodeBase64OrUpload(localPath: string, remotePath?: string | null, uploadOptions?: UploadOptions): Promise<string>;
+/**
+ * Stops and removes all web socket handlers that are listening
+ * in scope of the current session.
+ *
+ * @this {XCUITestDriver}
+ * @returns
+ */
+export declare function removeAllSessionWebSocketHandlers(this: XCUITestDriver): Promise<void>;
 /**
  * Returns true if the urlString is localhost
- * @param {string} urlString
- * @returns {boolean} Return true if the urlString is localhost
+ * @param urlString
+ * @returns Return true if the urlString is localhost
  */
-export function isLocalHost(urlString: string): boolean;
+export declare function isLocalHost(urlString: string): boolean;
 /**
  * Normalizes platformVersion to a valid iOS version string
  *
- * @param {string} originalVersion - Loose version number, that can be parsed by semver
- * @return {string} iOS version number in <major>.<minor> format
- * @throws {Error} if the version number cannot be parsed
+ * @param originalVersion - Loose version number, that can be parsed by semver
+ * @return iOS version number in <major>.<minor> format
+ * @throws if the version number cannot be parsed
  */
-export function normalizePlatformVersion(originalVersion: string): string;
+export declare function normalizePlatformVersion(originalVersion: string): string;
 /**
- * @param {string[]} locations
- * @returns {Promise<void>}
+ * Assert the presence of particular keys in the given object
+ *
+ * @param argNames one or more key names
+ * @param opts the object to check
+ * @returns the same given object
  */
-export function clearLogs(locations: string[]): Promise<void>;
+export declare function requireArgs(argNames: string | string[], opts?: Record<string, any>): Record<string, any>;
 /**
- * Assert the presence of particular keys in the given object
+ * Asserts that the given driver is running on a Simulator and return
+ * the simlator instance.
  *
- * @param {string|Array<string>} argNames one or more key names
- * @param {Object} opts the object to check
- * @returns {Object} the same given object
+ * @param action - Description of action
  */
-export function requireArgs(argNames: string | Array<string>, opts?: any): any;
-import _ from 'lodash';
+export declare function assertSimulator(this: XCUITestDriver, action: string): Simulator;
+/**
+ * Check if platform name is the TV OS one.
+ */
+export declare function isTvOs(platformName: string | null | undefined): boolean;
+/**
+ * Return normalized platform name.
+ */
+export declare function normalizePlatformName(platformName: string | null | undefined): string;
+export declare function shouldSetInitialSafariUrl(opts: XCUITestDriverOpts): boolean;
+export declare function isIos17OrNewer(opts: XCUITestDriverOpts): boolean;
+export declare function isIos18OrNewer(opts: XCUITestDriverOpts): boolean;
 //# sourceMappingURL=utils.d.ts.map

package/build/lib/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../lib/utils.js"],"names":[],"mappings":"AAiWA;;;;;;GAMG;AACH,4FAFa,OAAO,CAAC,IAAI,CAAC,CAWzB;AAgDD;;;;;;;GAOG;AACH,wCAJW,MAAM,UACN,OAAO,UAAU,EAAE,cAAc,GAC/B,SAAS,CAOrB;AAED;;;;;GAKG;AACH,qCAHW,MAAM,GAAC,IAAI,GAAC,SAAS,GACnB,OAAO,CAInB;AAED;;;;;GAKG;AACH,oDAHW,MAAM,GAAC,IAAI,GAAC,SAAS,GACnB,MAAM,CAIlB;AAED;;;GAGG;AACH,gDAHW,OAAO,UAAU,EAAE,kBAAkB,GACnC,OAAO,CAKnB;AAED;;;GAGG;AACH,qCAHW,OAAO,UAAU,EAAE,kBAAkB,GACnC,OAAO,CAInB;AAED;;;GAGG;AACH,qCAHW,OAAO,UAAU,EAAE,kBAAkB,GACnC,OAAO,CAInB;AA9cD,wBAAyB,MAAM,CAAC;AAQhC,yBAA0B,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aA6LzB,MAAM;;;;WACN,MAAM;;2BA6RP,OAAO,cAAc,EAAE,YAAY;wBACnC,OAAO,sBAAsB,EAAE,SAAS;6BACxC,OAAO,UAAU,EAAE,cAAc;AA3d9C;;;GAGG;AACH,2CAFa,OAAO,CAAC,YAAY,CAAC,CAmBjC;AAED;;GAEG;AACH,4CAFa,OAAO,CAAC,MAAM,GAAC,IAAI,CAAC,CAQhC;AAwHD,yDAMC;AA2BD;;;;GAIG;AAEH;;GAEG;AACH;;;yBASG;AAjHH,0DA4DC;AAuDD,0DAgCC;AArPD,kCAA4B,SAAS,CAAC;AAkFtC,mEAcC;AAuJD,2CAOC;AAED;;;;;;;;;;;;GAYG;AACH,6CARW,MAAM,GAAC,MAAM,kBACb,eAAS,GAKP,OAAO,CAAC,MAAM,EAAE,CAAC,CAmB7B;AAED;;;;;;;;;;;GAWG;AAEH;;;;;;;;;;;GAWG;AACH,gDAPW,MAAM,eACN,MAAM,GAAC,IAAI,kBAEX,aAAa,GACX,OAAO,CAAC,MAAM,CAAC,CA0B3B;AAoBD;;;;GAIG;AACH,uCAHW,MAAM,GACJ,OAAO,CAUnB;AAED;;;;;;GAMG;AACH,0DAJW,MAAM,GACL,MAAM,CASjB;AArVD;;;GAGG;AACH,qCAHW,MAAM,EAAE,GACN,OAAO,CAAC,IAAI,CAAC,CA8BzB;AAuTD;;;;;;GAMG;AACH,sCAJW,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC,mBAW9B;cA3Za,QAAQ"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../lib/utils.ts"],"names":[],"mappings":"AAIA,OAAO,CAAC,MAAM,QAAQ,CAAC;AAQvB,OAAO,KAAK,EAAC,kBAAkB,EAAE,cAAc,EAAC,MAAM,UAAU,CAAC;AACjE,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,OAAO,CAAC;AAElC,eAAO,MAAM,SAAS,SAAS,CAAC;AAEhC,eAAO,MAAM,mBAAmB,YAAY,CAAC;AAM7C,eAAO,MAAM,UAAU,eAAe,CAAC;AAEvC,wBAAsB,uBAAuB,IAAI,OAAO,CAAC,YAAY,CAAC,CAMrE;AAED,wBAAsB,wBAAwB,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAMvE;AAED,wBAAsB,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA4BlE;AAOD,wBAAsB,yBAAyB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAevE;AAED,wBAAsB,gBAAgB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CA4D9D;AAED,wBAAsB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAMhE;AA8BD;;;;GAIG;AAEH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,SAA6C,OAAO,CAAC,UAAU,CAAC,sBASxF,CAAC;AAEH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAgCvG;AAED,wBAAsB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAO/C;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,sBAAsB,CAC1C,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,aAAa,GAAE,CAAC,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,IAAW,GAC7E,OAAO,CAAC,MAAM,EAAE,CAAC,CAiBnB;AAED;;;;;;;;;;;GAWG;AAEH,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;CACpD;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,oBAAoB,CACxC,SAAS,EAAE,MAAM,EACjB,UAAU,GAAE,MAAM,GAAG,IAAW,EAChC,aAAa,GAAE,aAAkB,GAChC,OAAO,CAAC,MAAM,CAAC,CAuBjB;AAED;;;;;;GAMG;AACH,wBAAsB,iCAAiC,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAS3F;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAQtD;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,CAMxE;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAO5G;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CAK/E;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAEvE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAErF;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAG3E;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAEhE;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAEhE"}