appium-xcuitest-driver
Version:
Appium driver for iOS using XCUITest for backend
35 lines • 1.94 kB
TypeScript
import type * as RemoteXPCModule from 'appium-ios-remotexpc';
export type RemoteXPCEsmModule = typeof RemoteXPCModule;
export type RemoteXPCServices = RemoteXPCEsmModule['Services'];
export type RemoteXPCTestRunner = RemoteXPCEsmModule['XCTestRunner'];
export type RemoteXPCTestAttachment = RemoteXPCEsmModule['XCTestAttachment'];
/** Published driver guide for Remote XPC tunnel setup on real devices (iOS/tvOS 18+). */
export declare const REMOTE_XPC_TUNNEL_SETUP_DOC_LINK = "https://appium.github.io/appium-xcuitest-driver/latest/guides/remotexpc-tunnels-real-devices/";
/** Driver script that starts the tunnel registry (must run with sudo/root). */
export declare const TUNNEL_CREATION_COMMAND = "sudo appium driver run xcuitest tunnel-creation";
/**
* RemoteXPC cannot satisfy the request in a way the caller may handle without treating it as
* a hard tunnel/connectivity failure (for example module missing or session ineligible).
*/
export declare class RemoteXPCUnavailableError extends Error {
constructor(message?: string);
}
/** Whether `err` is a {@link RemoteXPCUnavailableError}. */
export declare function isRemoteXPCUnavailableError(err: unknown): boolean;
/**
* Whether the given error means RemoteXPC tunnel infrastructure is unavailable.
*/
export declare function isTunnelAvailabilityError(err: unknown): boolean;
/**
* User-facing message for tunnel registry / tunnel-entry failures from appium-ios-remotexpc.
*/
export declare function formatTunnelAvailabilityMessage(err: unknown): string;
/**
* Wraps a RemoteXPC connection error with tunnel setup guidance when the cause is tunnel-related.
*/
export declare function wrapRemoteXPCConnectionError(err: unknown, context: string): Error;
/**
* Log line when an optional RemoteXPC feature falls back after a connection failure.
*/
export declare function formatRemoteXPCFallbackLog(feature: string, err: unknown): string;
//# sourceMappingURL=utils.d.ts.map