appium-xcuitest-driver/lib/commands/bidi/types.ts

Appium driver for iOS using XCUITest for backend

export type BiDiLogLevel = 'debug' | 'info' | 'warn' | 'error';

// https://w3c.github.io/webdriver-bidi/#event-log-entryAdded
export interface LogEntryAddedEvent extends BiDiEvent<LogEntryAddedEventParams> {
  context: string;
}

// https://github.com/appium/appium/issues/20741
export interface ContextUpdatedEvent extends BiDiEvent<ContentUpdatedParams> {}

export interface NetworkMonitorEventParams {
  /** DVT networking instrument payload (interface / connection detection / connection update). */
  event: Record<string, unknown>;
}

/**
 * BiDi event emitted for each DVT NetworkMonitor sample while `mobile: startNetworkMonitor` is active.
 *
 * @see https://github.com/appium/appium-ios-remotexpc
 */
export interface NetworkMonitorBiDiEvent extends BiDiEvent<NetworkMonitorEventParams> {
  context: string;
}

interface BiDiEvent<TParams> {
  method: string;
  params: TParams;
}

interface LogEntrySource {
  realm: string;
  context?: string;
}

interface LogEntryAddedEventParams {
  type: string;
  level: BiDiLogLevel;
  source: LogEntrySource;
  text: string;
  timestamp: number;
}

interface ContentUpdatedParams {
  name: string;
  type: 'NATIVE' | 'WEB';
}