appium-xcuitest-driver 10.8.3 → 10.9.0

package/build/lib/device/real-device-management.d.ts

@@ -0,0 +1,146 @@
+import { Devicectl } from 'node-devicectl';
+import type { AppiumLogger } from '@appium/types';
+import type { XCUITestDriver } from '../driver';
+export declare const IO_TIMEOUT_MS: number;
+/**
+ * Retrieve a file from a real device
+ *
+ * @param afcService Apple File Client service instance from
+ * 'appium-ios-device' module
+ * @param remotePath Relative path to the file on the device
+ * @returns The file content as a buffer
+ */
+export declare function pullFile(afcService: any, remotePath: string): Promise<Buffer>;
+/**
+ * Retrieve a folder from a real device
+ *
+ * @param afcService Apple File Client service instance from
+ * 'appium-ios-device' module
+ * @param remoteRootPath Relative path to the folder on the device
+ * @returns The folder content as a zipped base64-encoded buffer
+ */
+export declare function pullFolder(afcService: any, remoteRootPath: string): Promise<Buffer>;
+/**
+ * Pushes a file to a real device
+ *
+ * @param afcService afcService Apple File Client service instance from
+ * 'appium-ios-device' module
+ * @param localPathOrPayload Either full path to the source file
+ * or a buffer payload to be written into the remote destination
+ * @param remotePath Relative path to the file on the device. The remote
+ * folder structure is created automatically if necessary.
+ * @param opts Push file options
+ */
+export declare function pushFile(afcService: any, localPathOrPayload: string | Buffer, remotePath: string, opts?: PushFileOptions): Promise<void>;
+/**
+ * Pushes a folder to a real device
+ *
+ * @param afcService Apple File Client service instance from
+ * 'appium-ios-device' module
+ * @param srcRootPath The full path to the source folder
+ * @param dstRootPath The relative path to the destination folder. The folder
+ * will be deleted if already exists.
+ * @param opts Push folder options
+ */
+export declare function pushFolder(afcService: any, srcRootPath: string, dstRootPath: string, opts?: PushFolderOptions): Promise<void>;
+/**
+ * Get list of connected devices
+ */
+export declare function getConnectedDevices(): Promise<string[]>;
+export declare class RealDevice {
+    readonly udid: string;
+    private readonly _log;
+    readonly devicectl: Devicectl;
+    constructor(udid: string, logger?: AppiumLogger);
+    get log(): AppiumLogger;
+    remove(bundleId: string): Promise<void>;
+    removeApp(bundleId: string): Promise<void>;
+    install(appPath: string, bundleId: string, opts?: RealDeviceInstallOptions): Promise<void>;
+    installOrUpgradeApplication(bundlePathOnPhone: string, opts: InstallOrUpgradeOptions): Promise<void>;
+    /**
+     * Alias for {@linkcode install}
+     */
+    installApp(appPath: string, bundleId: string, opts?: RealDeviceInstallOptions): Promise<void>;
+    /**
+     * Return an application object if test app has 'bundleid'.
+     * The target bundleid can be User and System apps.
+     *
+     * @param bundleId The bundleId to ensure it is installed
+     * @returns Returns True if the app is installed on the device under test.
+     */
+    isAppInstalled(bundleId: string): Promise<boolean>;
+    /**
+     * Fetches various attributes, like bundle id, version, entitlements etc. of
+     * an installed application.
+     *
+     * @param bundleId the bundle identifier of an app to check
+     * @param returnAttributes If provided then
+     * only fetches the requested attributes of the app into the resulting object.
+     * Some apps may have too many attributes, so it makes sense to limit these
+     * by default if you don't need all of them.
+     * @returns Either app info as an object or undefined if the app is not found.
+     */
+    fetchAppInfo(bundleId: string, returnAttributes?: string | string[]): Promise<Record<string, any> | undefined>;
+    terminateApp(bundleId: string, platformVersion: string): Promise<boolean>;
+    /**
+     * @param bundleName The name of CFBundleName in Info.plist
+     *
+     * @returns A list of User level apps' bundle ids which has
+     *                          'CFBundleName' attribute as 'bundleName'.
+     */
+    getUserInstalledBundleIdsByBundleName(bundleName: string): Promise<string[]>;
+    getPlatformVersion(): Promise<string>;
+    reset(opts: {
+        bundleId?: string;
+        fullReset?: boolean;
+    }): Promise<void>;
+}
+/**
+ * Install app to real device
+ */
+export declare function installToRealDevice(this: XCUITestDriver, app: string, bundleId?: string, opts?: ManagementInstallOptions): Promise<void>;
+/**
+ * Run real device reset
+ */
+export declare function runRealDeviceReset(this: XCUITestDriver): Promise<void>;
+/**
+ * Configures Safari startup options based on the given session capabilities.
+ *
+ * !!! This method mutates driver options.
+ *
+ * @returns true if process arguments have been modified
+ */
+export declare function applySafariStartupArgs(this: XCUITestDriver): boolean;
+/**
+ * Auto-detect device UDID
+ */
+export declare function detectUdid(this: XCUITestDriver): Promise<string>;
+export interface PushFileOptions {
+    /** The maximum count of milliceconds to wait until file push is completed. Cannot be lower than 60000ms */
+    timeoutMs?: number;
+}
+export interface PushFolderOptions {
+    /** The maximum timeout to wait until a single file is copied */
+    timeoutMs?: number;
+    /** Whether to push files in parallel. This usually gives better performance, but might sometimes be less stable. */
+    enableParallelPush?: boolean;
+}
+export interface RealDeviceInstallOptions {
+    /** Application installation timeout in milliseconds */
+    timeoutMs?: number;
+}
+export interface InstallOrUpgradeOptions {
+    /** Install/upgrade timeout in milliseconds */
+    timeout: number;
+    /** Whether it is an app upgrade or a new install */
+    isUpgrade: boolean;
+}
+export interface ManagementInstallOptions {
+    /** Whether to skip app uninstall before installing it */
+    skipUninstall?: boolean;
+    /** App install timeout */
+    timeout?: number;
+    /** Whether to enforce the app uninstallation. e.g. fullReset, or enforceAppInstall is true */
+    shouldEnforceUninstall?: boolean;
+}
+//# sourceMappingURL=real-device-management.d.ts.map

package/build/lib/device/real-device-management.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"real-device-management.d.ts","sourceRoot":"","sources":["../../../lib/device/real-device-management.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAGhD,eAAO,MAAM,aAAa,QAAgB,CAAC;AAU3C;;;;;;;GAOG;AACH,wBAAsB,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAUnF;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAAC,UAAU,EAAE,GAAG,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAwEzF;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,QAAQ,CAC5B,UAAU,EAAE,GAAG,EACf,kBAAkB,EAAE,MAAM,GAAG,MAAM,EACnC,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,eAAoB,GACzB,OAAO,CAAC,IAAI,CAAC,CA8Cf;AAED;;;;;;;;;GASG;AACH,wBAAsB,UAAU,CAC9B,UAAU,EAAE,GAAG,EACf,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,IAAI,GAAE,iBAAsB,GAC3B,OAAO,CAAC,IAAI,CAAC,CAqHf;AAMD;;GAEG;AACH,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAO7D;AAMD,qBAAa,UAAU;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAe;IACpC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;gBAElB,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY;IAM/C,IAAI,GAAG,IAAI,YAAY,CAEtB;IAEK,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASvC,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1C,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,GAAE,wBAA6B,GAAG,OAAO,CAAC,IAAI,CAAC;IA4C9F,2BAA2B,CAAC,iBAAiB,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuC1G;;OAEG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,GAAE,wBAA6B,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvG;;;;;;OAMG;IACG,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxD;;;;;;;;;;OAUG;IACG,YAAY,CAChB,QAAQ,EAAE,MAAM,EAChB,gBAAgB,GAAE,MAAM,GAAG,MAAM,EAA8C,GAC9E,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC;IAerC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA+D/E;;;;;OAKG;IACG,qCAAqC,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAqB5E,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIrC,KAAK,CAAC,IAAI,EAAE;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAuB3E;AAMD;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,cAAc,EACpB,GAAG,EAAE,MAAM,EACX,QAAQ,CAAC,EAAE,MAAM,EACjB,IAAI,GAAE,wBAA6B,GAClC,OAAO,CAAC,IAAI,CAAC,CAgDf;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAS5E;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAgBpE;AAED;;GAEG;AACH,wBAAsB,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAatE;AAiDD,MAAM,WAAW,eAAe;IAC9B,2GAA2G;IAC3G,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,gEAAgE;IAChE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oHAAoH;IACpH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,wBAAwB;IACvC,uDAAuD;IACvD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,oDAAoD;IACpD,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,0BAA0B;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8FAA8F;IAC9F,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC"}