@appium/types - npm Package Compare versions

Comparing version 0.2.3 to 0.2.4

build/index.d.ts

 /// <reference types="node" />
 import type { Method as _Method } from 'axios';
-import type { EventEmitter } from 'events';
 import type { Server } from 'http';
-import type { Logger } from 'npmlog';
-import type { Class as _Class, MultidimensionalReadonlyArray } from 'type-fest';
+import type { Class as _Class, ConditionalPick, MultidimensionalReadonlyArray } from 'type-fest';
 import { ServerArgs } from './config';
 import { Capabilities, W3CCapabilities } from './capabilities';
+import type { Express } from 'express';
+import { ExternalDriver } from './driver';
+import type { Logger } from 'npmlog';
+export * from './driver';
+export * from './plugin';
 export { AppiumW3CCapabilities } from './capabilities';
@@ -14,346 +17,29 @@ export { AppiumConfig, NormalizedAppiumConfig } from './config';
 /**
- * Methods and properties which both `AppiumDriver` and `BaseDriver` inherit.
+ * A log prefix for {@linkcode AppiumLogger}
+ *
+ * If a function, the function will return the prefix.  Log messages will be prefixed with this value.
  */
-export interface Core {
-    sessionId: string | null;
-    opts: ServerArgs;
-    initialOpts: ServerArgs;
-    caps?: Capabilities;
-    originalCaps?: W3CCapabilities;
-    protocol?: string;
-    helpers: DriverHelpers;
-    basePath: string;
-    relaxedSecurityEnabled: boolean;
-    allowInsecure: string[];
-    denyInsecure: string[];
-    newCommandTimeoutMs: number;
-    implicitWaitMs: number;
-    locatorStrategies: string[];
-    webLocatorStrategies: string[];
-    eventEmitter: EventEmitter;
-    settings: DeviceSettings;
-    log: AppiumLogger;
-    driverData?: DriverData;
-    isCommandsQueueEnabled: boolean;
-    eventHistory: EventHistory;
-    desiredCapConstraints: Constraints;
-    onUnexpectedShutdown(handler: () => any): void;
-    getStatus(): Promise<unknown>;
-    logExtraCaps(caps: Capabilities): void;
-    sessionExists(sessionId: string): boolean;
-    validateDesiredCaps(caps: Capabilities): boolean;
-    isW3CProtocol(): boolean;
-    isMjsonwpProtocol(): boolean;
-    isFeatureEnabled(name: string): boolean;
-    ensureFeatureEnabled(name: string): void;
-    validateLocatorStrategy(strategy: string, webContext?: boolean): void;
-    proxyActive(sessionId?: string): boolean;
-    getProxyAvoidList(sessionId?: string): [string, RegExp][];
-    canProxy(sessionId?: string): boolean;
-    proxyRouteIsAvoided(sessionId: string, method: string, url: string): boolean;
-    addManagedDriver(driver: Driver): void;
-    getManagedDrivers(): Driver[];
-    clearNewCommandTimeout(): Promise<void>;
-    logEvent(eventName: string): void;
-}
-export interface Driver extends SessionCommands, LogCommands, FindCommands, SettingsCommands, TimeoutCommands, EventCommands, SessionHandler<[string, any], void>, Core {
-    executeCommand(cmd: string, ...args: any[]): Promise<any>;
-    startUnexpectedShutdown(err?: Error): Promise<void>;
-    startNewCommandTimeout(): Promise<void>;
-    reset(): Promise<void>;
-    assignServer?(server: AppiumServer, host: string, port: number, path: string): void;
-}
+export declare type AppiumLoggerPrefix = string | (() => string);
 /**
- * External drivers must subclass `BaseDriver`, and can implement any of these methods.
- * None of these are implemented within Appium itself.
+ * Possible "log levels" for {@linkcode AppiumLogger}.
+ *
+ * Extracted from `npmlog`.
  */
-export interface ExternalDriver extends Driver {
-    readonly server: AppiumServer;
-    readonly serverHost: string;
-    readonly serverPort: number;
-    readonly serverPath: string;
-    setUrl?(url: string): Promise<void>;
-    getUrl?(): Promise<string>;
-    back?(): Promise<void>;
-    forward?(): Promise<void>;
-    refresh?(): Promise<void>;
-    title?(): Promise<string>;
-    getWindowHandle?(): Promise<string>;
-    closeWindow?(): Promise<string[]>;
-    setWindow?(handle: string): Promise<void>;
-    getWindowHandles?(): Promise<string[]>;
-    setFrame?(id: null | number | string): Promise<void>;
-    getWindowRect?(): Promise<Rect>;
-    setWindowRect?(x: number, y: number, width: number, height: number): Promise<Rect>;
-    maximizeWindow?(): Promise<Rect>;
-    minimizeWindow?(): Promise<Rect>;
-    fullScreenWindow?(): Promise<Rect>;
-    createNewWindow?(type?: NewWindowType): Promise<NewWindow>;
-    active?(): Promise<Element>;
-    elementSelected?(elementId: string): Promise<boolean>;
-    getAttribute?(name: string, elementId: string): Promise<string | null>;
-    getProperty?(name: string, elementId: string): Promise<string | null>;
-    getCssProperty?(name: string, elementId: string): Promise<string>;
-    getText?(elementId: string): Promise<string>;
-    getName?(elementId: string): Promise<string>;
-    getElementRect?(elementId: string): Promise<Rect>;
-    elementEnabled?(elementId: string): Promise<boolean>;
-    elementDisplayed?(elementId: string): Promise<boolean>;
-    click?(elementId: string): Promise<void>;
-    clear?(elementId: string): Promise<void>;
-    setValue?(text: string, elementId: string): Promise<void>;
-    execute?(script: string, args: unknown[]): Promise<unknown>;
-    executeAsync?(script: string, args: unknown[]): Promise<unknown>;
-    getCookies?(): Promise<Cookie[]>;
-    getCookie?(name: string): Promise<Cookie>;
-    setCookie?(cookie: Cookie): Promise<void>;
-    deleteCookie?(name: string): Promise<void>;
-    deleteCookies?(): Promise<void>;
-    performActions?(actions: Actions[]): Promise<void>;
-    releaseActions?(): Promise<void>;
-    postDismissAlert?(): Promise<void>;
-    postAcceptAlert?(): Promise<void>;
-    getAlertText?(): Promise<string | null>;
-    setAlertText?(text: string): Promise<void>;
-    getScreenshot?(): Promise<string>;
-    getElementScreenshot?(elementId: string): Promise<string>;
-    mobileShake?(): Promise<void>;
-    getDeviceTime?(format?: string): Promise<string>;
-    lock?(seconds?: number): Promise<void>;
-    unlock?(): Promise<void>;
-    isLocked?(): Promise<boolean>;
-    startRecordingScreen?(options?: ScreenRecordOptions): Promise<void>;
-    stopRecordingScreen?(options?: ScreenRecordOptions): Promise<string>;
-    getPerformanceDataTypes?(): Promise<string[]>;
-    getPerformanceData?(packageName: string, dataType: string, dataReadTimeout?: number): Promise<string[]>;
-    pressKeyCode?(keycode: number, metastate?: number, flags?: number): Promise<void>;
-    longPressKeyCode?(keycode: number, metastate?: number, flags?: number): Promise<void>;
-    fingerprint?(fingerprintId: number): Promise<void>;
-    sendSMS?(phoneNumber: string, message: string): Promise<void>;
-    gsmCall?(phoneNumber: string, action: string): Promise<void>;
-    gsmSignal?(signalStrength: string): Promise<void>;
-    gsmVoice?(state: string): Promise<void>;
-    powerCapacity?(percent: number): Promise<void>;
-    powerAC?(state: string): Promise<void>;
-    networkSpeed?(netspeed: string): Promise<void>;
-    keyevent?(keycode: string, metastate?: string): Promise<void>;
-    mobileRotation?(x: number, y: number, radius: number, rotation: number, touchCount: number, duration: string, elementId?: string): Promise<void>;
-    getCurrentActivity?(): Promise<string>;
-    getCurrentPackage?(): Promise<string>;
-    installApp?(appPath: string, options?: unknown): Promise<void>;
-    activateApp?(appId: string, options?: unknown): Promise<void>;
-    removeApp?(appId: string, options?: unknown): Promise<void>;
-    terminateApp?(appId: string, options?: unknown): Promise<void>;
-    isAppInstalled?(appId: string): Promise<boolean>;
-    queryAppState?(appId: string): Promise<number>;
-    hideKeyboard?(strategy?: string, key?: string, keyCode?: string, keyName?: string): Promise<void>;
-    isKeyboardShown?(): Promise<boolean>;
-    pushFile?(path: string, data: string): Promise<void>;
-    pullFile?(path: string): Promise<string>;
-    pullFolder?(path: string): Promise<string>;
-    toggleFlightMode?(): Promise<void>;
-    toggleData?(): Promise<void>;
-    toggleWiFi?(): Promise<void>;
-    toggleLocationServices?(): Promise<void>;
-    openNotifications?(): Promise<void>;
-    startActivity?(appPackage: string, appActivity: string, appWaitPackage?: string, appWaitActivity?: string, intentAction?: string, intentCategory?: string, intentFlags?: string, optionalIntentArguments?: string, dontStopAppOnReset?: boolean): Promise<void>;
-    getSystemBars?(): Promise<unknown[]>;
-    getDisplayDensity?(): Promise<number>;
-    touchId?(match: boolean): Promise<void>;
-    toggleEnrollTouchId?(enabled: boolean): Promise<void>;
-    launchApp?(): Promise<void>;
-    closeApp?(): Promise<void>;
-    background?(seconds: null | number): Promise<void>;
-    endCoverage?(intent: string, path: string): Promise<void>;
-    getStrings?(language?: string, stringFile?: string): Promise<Record<string, unknown>>;
-    setValueImmediate?(value: string, elementId: string): Promise<void>;
-    replaceValue?(value: string, elementId: string): Promise<void>;
-    receiveAsyncResponse?(response: unknown): Promise<void>;
-    setClipboard?(content: string, contentType?: string, label?: string): Promise<void>;
-    getClipboard?(contentType?: string): Promise<string>;
-    asyncScriptTimeout?(ms: number): Promise<void>;
-    getWindowSize?(): Promise<Size>;
-    getLocation?(elementId: string): Promise<Position>;
-    getLocationInView?(elementId: string): Promise<Position>;
-    getSize?(elementId: string): Promise<Size>;
-    elementShadowRoot?(elementId: string): Promise<Element>;
-    findElementFromShadowRoot?(strategy: string, selector: string, shadowId: string): Promise<Element>;
-    findElementsFromShadowRoot?(strategy: string, selector: string, shadowId: string): Promise<Element[]>;
-    equalsElement?(elementId: string, otherElementId: string): Promise<boolean>;
-    submit?(elementId: string): Promise<void>;
-    keys?(value: string[]): Promise<void>;
-    availableIMEEngines?(): Promise<string[]>;
-    getActiveIMEEngine?(): Promise<string>;
-    isIMEActivated?(): Promise<boolean>;
-    deactivateIMEEngine?(): Promise<void>;
-    activateIMEEngine?(engine: string): Promise<void>;
-    getOrientation?(): Promise<string>;
-    setOrientation?(orientation: string): Promise<void>;
-    moveTo?(element?: null | string, xOffset?: number, yOffset?: number): Promise<void>;
-    buttonDown?(button?: number): Promise<void>;
-    buttonUp?(button?: number): Promise<void>;
-    clickCurrent?(button?: number): Promise<void>;
-    doubleClick?(): Promise<void>;
-    touchDown?(x: number, y: number): Promise<void>;
-    touchUp?(x: number, y: number): Promise<void>;
-    touchMove?(x: number, y: number): Promise<void>;
-    touchLongClick?(elementId: string): Promise<void>;
-    flick?(element?: string, xSpeed?: number, ySpeed?: number, xOffset?: number, yOffset?: number, speed?: number): Promise<void>;
-    getGeoLocation?(): Promise<Location>;
-    setGeoLocation?(location: Partial<Location>): Promise<void>;
-    getCurrentContext?(): Promise<string | null>;
-    setContext?(name: string): Promise<void>;
-    getContexts?(): Promise<string[]>;
-    getPageIndex?(elementId: string): Promise<string>;
-    getNetworkConnection?(): Promise<number>;
-    setNetworkConnection?(type: number): Promise<void>;
-    performTouch?(actions: unknown): Promise<void>;
-    performMultiAction?(actions: unknown, elementId: string): Promise<void>;
-    getRotation?(): Promise<Rotation>;
-    setRotation?(x: number, y: number, z: number): Promise<void>;
-    executeCdp?(cmd: string, params: unknown): Promise<unknown>;
-    addVirtualAuthenticator?(protocol: string, transport: string, hasResidentKey?: boolean, hasUserVerification?: boolean, isUserConsenting?: boolean, isUserVerified?: boolean): Promise<void>;
-    removeVirtualAuthenticator?(): Promise<void>;
-    addAuthCredential?(credentialId: string, isResidentCredential: boolean, rpId: string, privateKey: string, userHandle?: string, signCount?: number): Promise<void>;
-    getAuthCredential?(): Promise<Credential[]>;
-    removeAllAuthCredentials?(): Promise<void>;
-    removeAuthCredential?(): Promise<void>;
-    setUserAuthVerified?(isUserVerified: boolean): Promise<void>;
-    proxyCommand?(url: string, method: HTTPMethod, body?: string): Promise<unknown>;
-}
-export interface Method<T extends ExternalDriver = ExternalDriver> {
-    command?: keyof T;
-    neverProxy?: boolean;
-    payloadParams?: PayloadParams;
-}
-export interface PayloadParams {
-    wrap?: string;
-    unwrap?: string;
-    required?: Readonly<string[]> | MultidimensionalReadonlyArray<string, 2>;
-    optional?: Readonly<string[]> | MultidimensionalReadonlyArray<string, 2>;
-    validate?: (obj: any, protocol: string) => boolean | string | undefined;
-    makeArgs?: (obj: any) => any;
-}
-export declare type MethodMap<T extends ExternalDriver = ExternalDriver> = Record<string, Record<string, Method<T>>>;
-export interface Constraint {
-    presence?: boolean | {
-        allowEmpty: boolean;
-    };
-    isString?: boolean;
-    isNumber?: boolean;
-    isBoolean?: boolean;
-    isObject?: boolean;
-    isArray?: boolean;
-    deprecated?: boolean;
-    inclusion?: any[];
-}
-export declare type Constraints = Record<string, Constraint>;
-export interface Element {
-    'element-6066-11e4-a52e-4f735466cecf': string;
-}
-export interface DriverHelpers {
-    configureApp: (app: string, supportedAppExtensions: string[]) => Promise<string>;
-    isPackageOrBundle: (app: string) => boolean;
-    duplicateKeys: <T>(input: T, firstKey: string, secondKey: string) => T;
-    parseCapsArray: (cap: string | string[]) => string[];
-    generateDriverLogPrefix: (obj: Core, sessionId?: string) => string;
-}
-export declare type SettingsUpdateListener<T extends Record<string, unknown> = Record<string, unknown>> = (prop: keyof T, newValue: unknown, curValue: unknown) => Promise<void>;
-export interface DeviceSettings<T extends Record<string, unknown> = Record<string, unknown>> {
-    update(newSettings: T): Promise<void>;
-    getSettings(): T;
-}
-export interface LogType<TDriver, LogEntry = string> {
-    description: string;
-    getter: (driver: TDriver) => Promise<LogEntry[]>;
-}
-export interface Rect {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
-export declare type NewWindowType = 'tab' | 'window';
-export interface NewWindow {
-    handle: string;
-    type: NewWindowType;
-}
-export interface Cookie {
-    name: string;
-    value: string;
-    path?: string;
-    domain?: string;
-    secure?: boolean;
-    httpOnly?: boolean;
-    expiry?: number;
-    sameSite?: 'Lax' | 'Strict';
-}
-export interface Actions {
-    type?: string;
-    actions: Action[];
-    parameters?: {
-        pointerType?: string;
-    };
-}
-export interface Action {
-    duration?: number;
-    type: string;
-    value?: string;
-    x?: number;
-    y?: number;
-    button?: number;
-    origin?: string;
-}
-export interface ScreenRecordOptions {
-    remotePath?: string;
-    username?: string;
-    password?: string;
-    method?: string;
-    forceRestart?: boolean;
-    timeLimit?: string;
-    videoType?: string;
-    videoQuality?: string;
-    videoFps?: string;
-    videoScale?: string;
-    bitRate?: string;
-    videoSize?: string;
-    bugReport?: string;
-}
-export declare type Size = Pick<Rect, 'width' | 'height'>;
-export declare type Position = Pick<Rect, 'x' | 'y'>;
-export interface Location {
-    latitude: number;
-    longitude: number;
-    altitude: number;
-}
-export interface Rotation {
-    x: number;
-    y: number;
-    z: number;
-}
-export interface Credential {
-    credentialId: string;
-    isResidentCredential: boolean;
-    rpId: string;
-    privateKey: string;
-    userHandle?: string;
-    signCount: number;
-    largeBlob?: string;
-}
-export interface EventHistory {
-    commands: EventHistoryCommand[];
-    [key: string]: any;
-}
-export interface EventHistoryCommand {
-    cmd: string;
-    startTime: number;
-    endTime: number;
-}
-export declare type HTTPMethod = _Method;
-export declare type Prefix = string | (() => string);
+export declare type AppiumLoggerLevel = 'silly' | 'verbose' | 'debug' | 'info' | 'http' | 'warn' | 'error';
+/**
+ * Describes the `npmlog`-based internal logger.
+ *
+ * @see https://npm.im/npmlog
+ */
 export interface AppiumLogger {
+    /**
+     * Returns the underlying `npmlog` {@link Logger}.
+     */
     unwrap(): Logger;
-    level: string;
-    levels: string[];
-    prefix?: Prefix;
+    level: AppiumLoggerLevel;
+    levels: AppiumLoggerLevel[];
+    /**
+     * Log prefix, if applicable.
+     */
+    prefix?: AppiumLoggerPrefix;
     debug: (...args: any[]) => void;
@@ -368,70 +54,85 @@ info: (...args: any[]) => void;
 }
+/**
+ * Appium's slightly-modified {@linkcode Server http.Server}.
+ */
 export declare type AppiumServer = Omit<Server, 'close'> & {
     close: () => Promise<void>;
 };
-export interface TimeoutCommands {
-    timeouts(type: string, ms: number | string, script?: number, pageLoad?: number, implicit?: number | string): Promise<void>;
-    setNewCommandTimeout(ms: number): void;
-    implicitWait(ms: number | string): Promise<void>;
-    setImplicitWait(ms: number): void;
-    implicitWaitForCondition(condition: () => Promise<any>): Promise<unknown>;
-    getTimeouts(): Promise<Record<string, number>>;
-    implicitWaitW3C(ms: number): Promise<void>;
-    implicitWaitMJSONWP(ms: number): Promise<void>;
-    pageLoadTimeoutW3C(ms: number): Promise<void>;
-    pageLoadTimeoutMJSONWP(ms: number): Promise<void>;
-    scriptTimeoutW3C(ms: number): Promise<void>;
-    scriptTimeoutMJSONWP(ms: number): Promise<void>;
-    newCommandTimeout(ms: number): Promise<void>;
-    parseTimeoutArgument(ms: number | string): number;
-}
-export interface EventCommands {
-    logCustomEvent(vendor: string, event: string): Promise<void>;
-    getLogEvents(type?: string | string[]): Promise<EventHistory | Record<string, number>>;
-}
-export interface SessionCommands {
-    getSessions(): Promise<MultiSessionData[]>;
-    getSession(): Promise<SingularSessionData>;
-}
-export interface MultiSessionData {
-    id: string;
-    capabilities: Capabilities;
-}
-export declare type SingularSessionData = Capabilities & {
-    events?: EventHistory;
-};
-export interface FindCommands {
-    findElement(strategy: string, selector: string): Promise<Element>;
-    findElements(strategy: string, selector: string): Promise<Element[]>;
-    findElementFromElement(strategy: string, selector: string, elementId: string): Promise<Element>;
-    findElementsFromElement(strategy: string, selector: string, elementId: string): Promise<Element[]>;
-    findElOrEls<Mult extends boolean>(strategy: string, selector: string, mult: Mult, context?: string): Promise<Mult extends true ? Element[] : Element>;
-    findElOrElsWithProcessing<Mult extends boolean>(strategy: string, selector: string, mult: Mult, context?: string): Promise<Mult extends true ? Element[] : Element>;
-    getPageSource(): Promise<string>;
-}
-export interface LogCommands {
-    supportedLogTypes: Record<string, LogType<Driver>>;
-    getLogTypes(): Promise<string[]>;
+/**
+ * The definition of an extension method, which will be provided via Appium's API.
+ *
+ */
+export interface Method<T> {
     /**
-     * Gets logs
-     *
-     * TODO: `logType` should be a key in `supportedLogTypes`, and the return value of this function
-     * should be the associated `LogType` object's `LogEntry` parameterized type.
-     * @param logType - Name/key of log type as defined in {@linkcode LogCommands.supportedLogTypes}.
+     * Name of the command.
      */
-    getLog(logType: string): Promise<any[]>;
+    command?: keyof ConditionalPick<Required<T>, DriverCommand>;
+    /**
+     * If true, this `Method` will never proxy.
+     */
+    neverProxy?: boolean;
+    /**
+     * Specifies shape of payload
+     */
+    payloadParams?: PayloadParams;
 }
-export interface SettingsCommands {
-    updateSettings: (settings: Record<string, any>) => Promise<void>;
-    getSettings(): Promise<Record<string, any>>;
+/**
+ * An instance method of a driver class, whose name may be referenced by {@linkcode Method.command}, and serves as an Appium command.
+ *
+ * Note that this signature differs from a `PluginCommand`.
+ */
+export declare type DriverCommand<TArgs = any, TRetval = unknown> = (...args: TArgs[]) => Promise<TRetval>;
+/**
+ * Defines the shape of a payload for a {@linkcode Method}.
+ */
+export interface PayloadParams {
+    wrap?: string;
+    unwrap?: string;
+    required?: Readonly<string[]> | MultidimensionalReadonlyArray<string, 2>;
+    optional?: Readonly<string[]> | MultidimensionalReadonlyArray<string, 2>;
+    validate?: (obj: any, protocol: string) => boolean | string | undefined;
+    makeArgs?: (obj: any) => any;
 }
-export interface SessionHandler<CreateResult, DeleteResult> {
-    createSession(w3cCaps1: W3CCapabilities, w3cCaps2?: W3CCapabilities, w3cCaps?: W3CCapabilities, driverData?: DriverData[]): Promise<CreateResult>;
-    deleteSession(sessionId?: string, driverData?: DriverData[]): Promise<DeleteResult>;
-}
-export declare type DriverData = Record<string, unknown>;
 /**
+ * A mapping of URL paths to HTTP methods to {@linkcode Method}s.
+ *
+ * @todo Should use {@linkcode HTTPMethod} here
+ */
+export declare type MethodMap<Extension = ExternalDriver> = Record<string, Record<string, Method<Extension & ExternalDriver>>>;
+/**
  * Wraps {@linkcode _Class `type-fest`'s `Class`} to include static members.
  */
 export declare type Class<Proto, StaticMembers extends object = {}, Args extends unknown[] = any[]> = _Class<Proto, Args> & StaticMembers;
+/**
+ * The string referring to a "driver"-type extension
+ */
+export declare type DriverType = 'driver';
+/**
+ * The string referring to a "plugin"-type extension
+ *
+ */
+export declare type PluginType = 'plugin';
+/**
+ * The strings referring to all extension types.
+ */
+export declare type ExtensionType = DriverType | PluginType;
+/**
+ * Optionally updates an Appium express app and http server, by calling
+ * methods that may mutate those objects. For example, you could call:
+ *
+ * `expressApp.get('/foo', handler)`
+ *
+ * In order to add a new route to Appium with this plugin. Or, you could add
+ * new listeners to the httpServer object.
+ *
+ * @param expressApp - the Express 'app' object used by Appium for route handling
+ * @param httpServer - the node HTTP server that hosts the app
+ */
+export declare type UpdateServerCallback = (expressApp: Express, httpServer: AppiumServer) => Promise<void>;
+/**
+ * Possible HTTP methods, as stolen from `axios`.
+ *
+ * @see https://npm.im/axios
+ */
+export declare type HTTPMethod = _Method;
 //# sourceMappingURL=index.d.ts.map

lib/capabilities.ts

@@ -1,2 +0,2 @@
-import type { Capabilities as WdioCaps } from '@wdio/types';
+import type {Capabilities as WdioCaps} from '@wdio/types';
 
@@ -22,12 +22,14 @@ /**
  */
-type BaseCapabilities<OptionalCaps extends StringRecord = StringRecord> =
-  Partial<WdioCaps.Capabilities & OptionalCaps>;
+type BaseCapabilities<OptionalCaps extends StringRecord = StringRecord> = Partial<
+  WdioCaps.Capabilities & OptionalCaps
+>;
 
 /**
  * All known capabilities derived from wdio's {@linkcode WdioCaps.Capabilities Capabilities} type and wdio's {@linkcode WdioCaps.AppiumCapabilities} type, accepting additional optional caps.
- * 
+ *
  * In practice, the properties `platformName` and `automationName` are required by Appium.
  */
-export type Capabilities<OptionalCaps extends StringRecord = StringRecord> =
-  BaseCapabilities<WdioCaps.AppiumCapabilities & OptionalCaps>;
+export type Capabilities<OptionalCaps extends StringRecord = StringRecord> = BaseCapabilities<
+  WdioCaps.AppiumCapabilities & OptionalCaps
+>;
 
@@ -38,3 +40,3 @@ /**
 export type AppiumW3CCapabilities<
-  OptionalNamespacedCaps extends NamespacedRecord = NamespacedRecord,
+  OptionalNamespacedCaps extends NamespacedRecord = NamespacedRecord
 > = BaseCapabilities<WdioCaps.AppiumW3CCapabilities & OptionalNamespacedCaps>;
@@ -46,5 +48,3 @@
  */
-export type W3CCapabilities<
-  OptionalNamespacedCaps extends NamespacedRecord = NamespacedRecord,
-> = {
+export type W3CCapabilities<OptionalNamespacedCaps extends NamespacedRecord = NamespacedRecord> = {
   alwaysMatch: AppiumW3CCapabilities<OptionalNamespacedCaps>;
@@ -61,4 +61,3 @@ firstMatch: AppiumW3CCapabilities<OptionalNamespacedCaps>[];
 export type AppiumXCUIProcessArguments = WdioCaps.AppiumXCUIProcessArguments;
-export type AppiumXCUISafariGlobalPreferences =
-  WdioCaps.AppiumXCUISafariGlobalPreferences;
+export type AppiumXCUISafariGlobalPreferences = WdioCaps.AppiumXCUISafariGlobalPreferences;
 export type AppiumXCUITestCapabilities = WdioCaps.AppiumXCUITestCapabilities;

lib/config.ts

@@ -1,3 +0,3 @@
-import type { AppiumConfigJsonSchema } from '@appium/schema';
-import { AppiumConfiguration, ServerConfig } from './appium-config';
+import type {AppiumConfigJsonSchema} from '@appium/schema';
+import {AppiumConfiguration, ServerConfig} from './appium-config';
 
@@ -12,4 +12,3 @@ /**
  */
- type AppiumServerJsonSchema =
- typeof AppiumConfigJsonSchema['properties']['server']['properties'];
+type AppiumServerJsonSchema = typeof AppiumConfigJsonSchema['properties']['server']['properties'];
 
@@ -71,31 +70,30 @@ /**
  */
- type KebabToCamel<S extends string> =
- S extends `${infer P1}-${infer P2}${infer P3}`
-   ? `${Lowercase<P1>}${Uppercase<P2>}${KebabToCamel<P3>}`
-   : Lowercase<S>;
+type KebabToCamel<S extends string> = S extends `${infer P1}-${infer P2}${infer P3}`
+  ? `${Lowercase<P1>}${Uppercase<P2>}${KebabToCamel<P3>}`
+  : Lowercase<S>;
 
 /**
-* Converts an object with kebab-cased keys into camel-cased keys.
-*/
+ * Converts an object with kebab-cased keys into camel-cased keys.
+ */
 type ObjectToCamel<T> = {
- [K in keyof T as KebabToCamel<string & K>]: T[K] extends Record<string, any>
-   ? KeysToCamelCase<T[K]>
-   : T[K];
+  [K in keyof T as KebabToCamel<string & K>]: T[K] extends Record<string, any>
+    ? KeysToCamelCase<T[K]>
+    : T[K];
 };
 
 /**
-* Converts an object or array to have camel-cased keys.
-*/
+ * Converts an object or array to have camel-cased keys.
+ */
 type KeysToCamelCase<T> = {
- [K in keyof T as KebabToCamel<string & K>]: T[K] extends Array<any>
-   ? KeysToCamelCase<T[K][number]>[]
-   : ObjectToCamel<T[K]>;
+  [K in keyof T as KebabToCamel<string & K>]: T[K] extends Array<any>
+    ? KeysToCamelCase<T[K][number]>[]
+    : ObjectToCamel<T[K]>;
 };
 
 /**
- * Object `B` has all the keys as object `A` (even if those keys in `A` are otherwise optional). 
+ * Object `B` has all the keys as object `A` (even if those keys in `A` are otherwise optional).
  */
-type Associated<A extends object, B extends { [key in keyof Required<A>]: unknown }> = {
+type Associated<A extends object, B extends {[key in keyof Required<A>]: unknown}> = {
   [Prop in keyof Required<A>]: B[Prop];
-}
+};
 
@@ -114,3 +112,3 @@ // end utils
  */
- interface WithDest {
+interface WithDest {
   appiumCliDest: string;
@@ -131,2 +129,1 @@ }
 // end conditionals
-

lib/index.ts

@@ -1,512 +0,47 @@
-import type { Method as _Method } from 'axios';
-import type { EventEmitter } from 'events';
-import type { Server } from 'http';
-import type { Logger } from 'npmlog';
-import type { Class as _Class, MultidimensionalReadonlyArray } from 'type-fest';
-import { ServerArgs } from './config';
-import { Capabilities, W3CCapabilities } from './capabilities';
+import type {Method as _Method} from 'axios';
+import type {Server} from 'http';
+import type {Class as _Class, ConditionalPick, MultidimensionalReadonlyArray} from 'type-fest';
+import {ServerArgs} from './config';
+import {Capabilities, W3CCapabilities} from './capabilities';
+import type {Express} from 'express';
+import {ExternalDriver} from './driver';
+import type {Logger} from 'npmlog';
 
-export { AppiumW3CCapabilities } from './capabilities';
-export { AppiumConfig, NormalizedAppiumConfig } from './config';
+export * from './driver';
+export * from './plugin';
+export {AppiumW3CCapabilities} from './capabilities';
+export {AppiumConfig, NormalizedAppiumConfig} from './config';
 export * from './appium-config';
-export { ServerArgs, Capabilities, W3CCapabilities };
+export {ServerArgs, Capabilities, W3CCapabilities};
 
 /**
- * Methods and properties which both `AppiumDriver` and `BaseDriver` inherit.
+ * A log prefix for {@linkcode AppiumLogger}
+ *
+ * If a function, the function will return the prefix.  Log messages will be prefixed with this value.
  */
-export interface Core {
-  sessionId: string | null;
-  opts: ServerArgs;
-  initialOpts: ServerArgs;
-  caps?: Capabilities;
-  originalCaps?: W3CCapabilities;
-  protocol?: string;
-  helpers: DriverHelpers;
-  basePath: string;
-  relaxedSecurityEnabled: boolean;
-  allowInsecure: string[];
-  denyInsecure: string[];
-  newCommandTimeoutMs: number;
-  implicitWaitMs: number;
-  locatorStrategies: string[];
-  webLocatorStrategies: string[];
-  eventEmitter: EventEmitter;
-  settings: DeviceSettings;
-  log: AppiumLogger;
-  driverData?: DriverData;
-  isCommandsQueueEnabled: boolean;
-  eventHistory: EventHistory;
-  desiredCapConstraints: Constraints;
-  onUnexpectedShutdown(handler: () => any): void;
-  getStatus(): Promise<unknown>;
-  logExtraCaps(caps: Capabilities): void;
-  sessionExists(sessionId: string): boolean;
-  validateDesiredCaps(caps: Capabilities): boolean;
-  isW3CProtocol(): boolean;
-  isMjsonwpProtocol(): boolean;
-  isFeatureEnabled(name: string): boolean;
-  ensureFeatureEnabled(name: string): void;
-  validateLocatorStrategy(strategy: string, webContext?: boolean): void;
-  proxyActive(sessionId?: string): boolean;
-  getProxyAvoidList(sessionId?: string): [string, RegExp][];
-  canProxy(sessionId?: string): boolean;
-  proxyRouteIsAvoided(sessionId: string, method: string, url: string): boolean;
-  addManagedDriver(driver: Driver): void;
-  getManagedDrivers(): Driver[];
-  clearNewCommandTimeout(): Promise<void>;
-  logEvent(eventName: string): void;
-}
+export type AppiumLoggerPrefix = string | (() => string);
 
-export interface Driver
-  extends SessionCommands,
-    LogCommands,
-    FindCommands,
-    SettingsCommands,
-    TimeoutCommands,
-    EventCommands,
-    SessionHandler<[string, any], void>,
-    Core {
-  // The following methods are implemented by `BaseDriver`.
-  executeCommand(cmd: string, ...args: any[]): Promise<any>;
-  startUnexpectedShutdown(err?: Error): Promise<void>;
-  startNewCommandTimeout(): Promise<void>;
-  reset(): Promise<void>;
+/**
+ * Possible "log levels" for {@linkcode AppiumLogger}.
+ *
+ * Extracted from `npmlog`.
+ */
+export type AppiumLoggerLevel = 'silly' | 'verbose' | 'debug' | 'info' | 'http' | 'warn' | 'error';
 
-  assignServer?(
-    server: AppiumServer,
-    host: string,
-    port: number,
-    path: string,
-  ): void;
-}
-
 /**
- * External drivers must subclass `BaseDriver`, and can implement any of these methods.
- * None of these are implemented within Appium itself.
+ * Describes the `npmlog`-based internal logger.
+ *
+ * @see https://npm.im/npmlog
  */
-export interface ExternalDriver extends Driver {
-  // The following properties are assigned by appium */
-  readonly server: AppiumServer;
-  readonly serverHost: string;
-  readonly serverPort: number;
-  readonly serverPath: string;
-
-  // WebDriver
-  setUrl?(url: string): Promise<void>;
-  getUrl?(): Promise<string>;
-  back?(): Promise<void>;
-  forward?(): Promise<void>;
-  refresh?(): Promise<void>;
-  title?(): Promise<string>;
-  getWindowHandle?(): Promise<string>;
-  closeWindow?(): Promise<string[]>;
-  setWindow?(handle: string): Promise<void>;
-  getWindowHandles?(): Promise<string[]>;
-  setFrame?(id: null | number | string): Promise<void>;
-  getWindowRect?(): Promise<Rect>;
-  setWindowRect?(
-    x: number,
-    y: number,
-    width: number,
-    height: number,
-  ): Promise<Rect>;
-  maximizeWindow?(): Promise<Rect>;
-  minimizeWindow?(): Promise<Rect>;
-  fullScreenWindow?(): Promise<Rect>;
-  createNewWindow?(type?: NewWindowType): Promise<NewWindow>;
-  active?(): Promise<Element>;
-  elementSelected?(elementId: string): Promise<boolean>;
-  getAttribute?(name: string, elementId: string): Promise<string | null>;
-  getProperty?(name: string, elementId: string): Promise<string | null>;
-  getCssProperty?(name: string, elementId: string): Promise<string>;
-  getText?(elementId: string): Promise<string>;
-  getName?(elementId: string): Promise<string>;
-  getElementRect?(elementId: string): Promise<Rect>;
-  elementEnabled?(elementId: string): Promise<boolean>;
-  elementDisplayed?(elementId: string): Promise<boolean>;
-  click?(elementId: string): Promise<void>;
-  clear?(elementId: string): Promise<void>;
-  setValue?(text: string, elementId: string): Promise<void>;
-  execute?(script: string, args: unknown[]): Promise<unknown>;
-  executeAsync?(script: string, args: unknown[]): Promise<unknown>;
-  getCookies?(): Promise<Cookie[]>;
-  getCookie?(name: string): Promise<Cookie>;
-  setCookie?(cookie: Cookie): Promise<void>;
-  deleteCookie?(name: string): Promise<void>;
-  deleteCookies?(): Promise<void>;
-  performActions?(actions: Actions[]): Promise<void>;
-  releaseActions?(): Promise<void>;
-  postDismissAlert?(): Promise<void>;
-  postAcceptAlert?(): Promise<void>;
-  getAlertText?(): Promise<string | null>;
-  setAlertText?(text: string): Promise<void>;
-  getScreenshot?(): Promise<string>;
-  getElementScreenshot?(elementId: string): Promise<string>;
-
-  // Appium W3C WebDriver Extension
-  mobileShake?(): Promise<void>;
-  getDeviceTime?(format?: string): Promise<string>;
-  lock?(seconds?: number): Promise<void>;
-  unlock?(): Promise<void>;
-  isLocked?(): Promise<boolean>;
-  startRecordingScreen?(options?: ScreenRecordOptions): Promise<void>;
-  stopRecordingScreen?(options?: ScreenRecordOptions): Promise<string>;
-  getPerformanceDataTypes?(): Promise<string[]>;
-  getPerformanceData?(
-    packageName: string,
-    dataType: string,
-    dataReadTimeout?: number,
-  ): Promise<string[]>;
-  pressKeyCode?(
-    keycode: number,
-    metastate?: number,
-    flags?: number,
-  ): Promise<void>;
-  longPressKeyCode?(
-    keycode: number,
-    metastate?: number,
-    flags?: number,
-  ): Promise<void>;
-  fingerprint?(fingerprintId: number): Promise<void>;
-  sendSMS?(phoneNumber: string, message: string): Promise<void>;
-  gsmCall?(phoneNumber: string, action: string): Promise<void>;
-  gsmSignal?(signalStrength: string): Promise<void>;
-  gsmVoice?(state: string): Promise<void>;
-  powerCapacity?(percent: number): Promise<void>;
-  powerAC?(state: string): Promise<void>;
-  networkSpeed?(netspeed: string): Promise<void>;
-  keyevent?(keycode: string, metastate?: string): Promise<void>;
-  mobileRotation?(
-    x: number,
-    y: number,
-    radius: number,
-    rotation: number,
-    touchCount: number,
-    duration: string,
-    elementId?: string,
-  ): Promise<void>;
-  getCurrentActivity?(): Promise<string>;
-  getCurrentPackage?(): Promise<string>;
-  installApp?(appPath: string, options?: unknown): Promise<void>;
-  activateApp?(appId: string, options?: unknown): Promise<void>;
-  removeApp?(appId: string, options?: unknown): Promise<void>;
-  terminateApp?(appId: string, options?: unknown): Promise<void>;
-  isAppInstalled?(appId: string): Promise<boolean>;
-  queryAppState?(appId: string): Promise<number>;
-  hideKeyboard?(
-    strategy?: string,
-    key?: string,
-    keyCode?: string,
-    keyName?: string,
-  ): Promise<void>;
-  isKeyboardShown?(): Promise<boolean>;
-  pushFile?(path: string, data: string): Promise<void>;
-  pullFile?(path: string): Promise<string>;
-  pullFolder?(path: string): Promise<string>;
-  toggleFlightMode?(): Promise<void>;
-  toggleData?(): Promise<void>;
-  toggleWiFi?(): Promise<void>;
-  toggleLocationServices?(): Promise<void>;
-  openNotifications?(): Promise<void>;
-  startActivity?(
-    appPackage: string,
-    appActivity: string,
-    appWaitPackage?: string,
-    appWaitActivity?: string,
-    intentAction?: string,
-    intentCategory?: string,
-    intentFlags?: string,
-    optionalIntentArguments?: string,
-    dontStopAppOnReset?: boolean,
-  ): Promise<void>;
-  getSystemBars?(): Promise<unknown[]>;
-  getDisplayDensity?(): Promise<number>;
-  touchId?(match: boolean): Promise<void>;
-  toggleEnrollTouchId?(enabled: boolean): Promise<void>;
-  launchApp?(): Promise<void>;
-  closeApp?(): Promise<void>;
-  background?(seconds: null | number): Promise<void>;
-  endCoverage?(intent: string, path: string): Promise<void>;
-  getStrings?(
-    language?: string,
-    stringFile?: string,
-  ): Promise<Record<string, unknown>>;
-  setValueImmediate?(value: string, elementId: string): Promise<void>;
-  replaceValue?(value: string, elementId: string): Promise<void>;
-  receiveAsyncResponse?(response: unknown): Promise<void>;
-  setClipboard?(
-    content: string,
-    contentType?: string,
-    label?: string,
-  ): Promise<void>;
-  getClipboard?(contentType?: string): Promise<string>;
-
-  // JSONWP
-  asyncScriptTimeout?(ms: number): Promise<void>;
-  getWindowSize?(): Promise<Size>;
-  getLocation?(elementId: string): Promise<Position>;
-  getLocationInView?(elementId: string): Promise<Position>;
-  getSize?(elementId: string): Promise<Size>;
-  elementShadowRoot?(elementId: string): Promise<Element>;
-  findElementFromShadowRoot?(
-    strategy: string,
-    selector: string,
-    shadowId: string
-  ): Promise<Element>;
-  findElementsFromShadowRoot?(
-    strategy: string,
-    selector: string,
-    shadowId: string
-  ): Promise<Element[]>;
-  equalsElement?(elementId: string, otherElementId: string): Promise<boolean>;
-  submit?(elementId: string): Promise<void>;
-  keys?(value: string[]): Promise<void>;
-  availableIMEEngines?(): Promise<string[]>;
-  getActiveIMEEngine?(): Promise<string>;
-  isIMEActivated?(): Promise<boolean>;
-  deactivateIMEEngine?(): Promise<void>;
-  activateIMEEngine?(engine: string): Promise<void>;
-  getOrientation?(): Promise<string>;
-  setOrientation?(orientation: string): Promise<void>;
-  moveTo?(
-    element?: null | string,
-    xOffset?: number,
-    yOffset?: number,
-  ): Promise<void>;
-  buttonDown?(button?: number): Promise<void>;
-  buttonUp?(button?: number): Promise<void>;
-  clickCurrent?(button?: number): Promise<void>;
-  doubleClick?(): Promise<void>;
-  touchDown?(x: number, y: number): Promise<void>;
-  touchUp?(x: number, y: number): Promise<void>;
-  touchMove?(x: number, y: number): Promise<void>;
-  touchLongClick?(elementId: string): Promise<void>;
-  flick?(
-    element?: string,
-    xSpeed?: number,
-    ySpeed?: number,
-    xOffset?: number,
-    yOffset?: number,
-    speed?: number,
-  ): Promise<void>;
-  getGeoLocation?(): Promise<Location>;
-  setGeoLocation?(location: Partial<Location>): Promise<void>;
-
-  // MJSONWIRE
-  getCurrentContext?(): Promise<string | null>;
-  setContext?(name: string): Promise<void>;
-  getContexts?(): Promise<string[]>;
-  getPageIndex?(elementId: string): Promise<string>;
-  getNetworkConnection?(): Promise<number>;
-  setNetworkConnection?(type: number): Promise<void>;
-  performTouch?(actions: unknown): Promise<void>;
-  performMultiAction?(actions: unknown, elementId: string): Promise<void>;
-  getRotation?(): Promise<Rotation>;
-  setRotation?(x: number, y: number, z: number): Promise<void>;
-
-  // Chromium DevTools
-  executeCdp?(cmd: string, params: unknown): Promise<unknown>;
-
-  // Web Authentication
-  addVirtualAuthenticator?(
-    protocol: string,
-    transport: string,
-    hasResidentKey?: boolean,
-    hasUserVerification?: boolean,
-    isUserConsenting?: boolean,
-    isUserVerified?: boolean,
-  ): Promise<void>;
-  removeVirtualAuthenticator?(): Promise<void>;
-  addAuthCredential?(
-    credentialId: string,
-    isResidentCredential: boolean,
-    rpId: string,
-    privateKey: string,
-    userHandle?: string,
-    signCount?: number,
-  ): Promise<void>;
-  getAuthCredential?(): Promise<Credential[]>;
-  removeAllAuthCredentials?(): Promise<void>;
-  removeAuthCredential?(): Promise<void>;
-  setUserAuthVerified?(isUserVerified: boolean): Promise<void>;
-
-  proxyCommand?(
-    url: string,
-    method: HTTPMethod,
-    body?: string,
-  ): Promise<unknown>;
-}
-
-export interface Method<T extends ExternalDriver = ExternalDriver> {
-  command?: keyof T; // T[keyof T] needs to return a Promise.
-  neverProxy?: boolean;
-  payloadParams?: PayloadParams;
-}
-
-export interface PayloadParams {
-  wrap?: string;
-  unwrap?: string;
-  required?: Readonly<string[]> | MultidimensionalReadonlyArray<string, 2>;
-  optional?: Readonly<string[]> | MultidimensionalReadonlyArray<string, 2>;
-  validate?: (obj: any, protocol: string) => boolean | string | undefined;
-  makeArgs?: (obj: any) => any;
-}
-
-export type MethodMap<T extends ExternalDriver = ExternalDriver> = Record<string, Record<string, Method<T>>>;
-
-export interface Constraint {
-  presence?: boolean | {allowEmpty: boolean};
-  isString?: boolean;
-  isNumber?: boolean;
-  isBoolean?: boolean;
-  isObject?: boolean;
-  isArray?: boolean;
-  deprecated?: boolean;
-  inclusion?: any[];
-}
-export type Constraints = Record<string, Constraint>;
-
-export interface Element {
-  'element-6066-11e4-a52e-4f735466cecf': string;
-}
-
-export interface DriverHelpers {
-  configureApp: (
-    app: string,
-    supportedAppExtensions: string[],
-  ) => Promise<string>;
-  isPackageOrBundle: (app: string) => boolean;
-  duplicateKeys: <T>(input: T, firstKey: string, secondKey: string) => T;
-  parseCapsArray: (cap: string | string[]) => string[];
-  generateDriverLogPrefix: (obj: Core, sessionId?: string) => string;
-}
-
-export type SettingsUpdateListener<
-  T extends Record<string, unknown> = Record<string, unknown>,
-> = (prop: keyof T, newValue: unknown, curValue: unknown) => Promise<void>;
-
-export interface DeviceSettings<
-  T extends Record<string, unknown> = Record<string, unknown>,
-> {
-  update(newSettings: T): Promise<void>;
-  getSettings(): T;
-}
-
-export interface LogType<TDriver, LogEntry = string> {
-  description: string;
-  getter: (driver: TDriver) => Promise<LogEntry[]>;
-}
-
-// WebDriver
-
-export interface Rect {
-  x: number;
-  y: number;
-  width: number;
-  height: number;
-}
-
-export type NewWindowType = 'tab' | 'window';
-
-export interface NewWindow {
-  handle: string;
-  type: NewWindowType;
-}
-
-export interface Cookie {
-  name: string;
-  value: string;
-  path?: string;
-  domain?: string;
-  secure?: boolean;
-  httpOnly?: boolean;
-  expiry?: number;
-  sameSite?: 'Lax' | 'Strict';
-}
-
-export interface Actions {
-  type?: string;
-  actions: Action[];
-  parameters?: {
-    pointerType?: string;
-  };
-}
-
-export interface Action {
-  duration?: number;
-  type: string;
-  value?: string;
-  x?: number;
-  y?: number;
-  button?: number;
-  origin?: string;
-}
-
-// Appium W3C WebDriver Extension
-
-export interface ScreenRecordOptions {
-  remotePath?: string;
-  username?: string;
-  password?: string;
-  method?: string;
-  forceRestart?: boolean;
-  timeLimit?: string;
-  videoType?: string;
-  videoQuality?: string;
-  videoFps?: string;
-  videoScale?: string;
-  bitRate?: string;
-  videoSize?: string;
-  bugReport?: string;
-}
-
-// JSONWP
-
-export type Size = Pick<Rect, 'width' | 'height'>;
-
-export type Position = Pick<Rect, 'x' | 'y'>;
-
-export interface Location {
-  latitude: number;
-  longitude: number;
-  altitude: number;
-}
-
-export interface Rotation {
-  x: number;
-  y: number;
-  z: number;
-}
-
-// Web Authentication
-
-export interface Credential {
-  credentialId: string;
-  isResidentCredential: boolean;
-  rpId: string;
-  privateKey: string;
-  userHandle?: string;
-  signCount: number;
-  largeBlob?: string;
-}
-
-export interface EventHistory {
-  commands: EventHistoryCommand[];
-  [key: string]: any;
-}
-
-export interface EventHistoryCommand {
-  cmd: string;
-  startTime: number;
-  endTime: number;
-}
-export type HTTPMethod = _Method;
-
-export type Prefix = string|(() => string);
-
 export interface AppiumLogger {
+  /**
+   * Returns the underlying `npmlog` {@link Logger}.
+   */
   unwrap(): Logger;
-  level: string;
-  levels: string[];
-  prefix?: Prefix,
+  level: AppiumLoggerLevel;
+  levels: AppiumLoggerLevel[];
+  /**
+   * Log prefix, if applicable.
+   */
+  prefix?: AppiumLoggerPrefix;
   debug: (...args: any[]) => void;
@@ -522,2 +57,5 @@ info: (...args: any[]) => void;
 
+/**
+ * Appium's slightly-modified {@linkcode Server http.Server}.
+ */
 export type AppiumServer = Omit<Server, 'close'> & {
@@ -527,107 +65,49 @@ close: () => Promise<void>;
 
-export interface TimeoutCommands {
-  timeouts(
-    type: string,
-    ms: number | string,
-    script?: number,
-    pageLoad?: number,
-    implicit?: number | string,
-  ): Promise<void>;
-  setNewCommandTimeout(ms: number): void;
-  implicitWait(ms: number | string): Promise<void>;
-  setImplicitWait(ms: number): void;
-  implicitWaitForCondition(condition: () => Promise<any>): Promise<unknown>;
-  getTimeouts(): Promise<Record<string, number>>;
-  implicitWaitW3C(ms: number): Promise<void>;
-  implicitWaitMJSONWP(ms: number): Promise<void>;
-  pageLoadTimeoutW3C(ms: number): Promise<void>;
-  pageLoadTimeoutMJSONWP(ms: number): Promise<void>;
-  scriptTimeoutW3C(ms: number): Promise<void>;
-  scriptTimeoutMJSONWP(ms: number): Promise<void>;
-  newCommandTimeout(ms: number): Promise<void>;
-  parseTimeoutArgument(ms: number | string): number;
-}
-
-export interface EventCommands {
-  logCustomEvent(vendor: string, event: string): Promise<void>;
-  getLogEvents(type?: string | string[]): Promise<EventHistory | Record<string, number>>;
-}
-
-export interface SessionCommands {
-  getSessions(): Promise<MultiSessionData[]>;
-  getSession(): Promise<SingularSessionData>;
-}
-
-export interface MultiSessionData {
-  id: string;
-  capabilities: Capabilities;
-}
-
-export type SingularSessionData = Capabilities & {events?: EventHistory};
-
-export interface FindCommands {
-  findElement(strategy: string, selector: string): Promise<Element>;
-  findElements(strategy: string, selector: string): Promise<Element[]>;
-  findElementFromElement(
-    strategy: string,
-    selector: string,
-    elementId: string,
-  ): Promise<Element>;
-  findElementsFromElement(
-    strategy: string,
-    selector: string,
-    elementId: string,
-  ): Promise<Element[]>;
-
-  findElOrEls<Mult extends boolean>(
-    strategy: string,
-    selector: string,
-    mult: Mult,
-    context?: string,
-  ): Promise<Mult extends true ? Element[] : Element>;
-
-  findElOrElsWithProcessing<Mult extends boolean>(
-    strategy: string,
-    selector: string,
-    mult: Mult,
-    context?: string,
-  ): Promise<Mult extends true ? Element[] : Element>;
-
-  getPageSource(): Promise<string>;
-}
-
-export interface LogCommands {
-  supportedLogTypes: Record<string, LogType<Driver>>;
-  getLogTypes(): Promise<string[]>;
+/**
+ * The definition of an extension method, which will be provided via Appium's API.
+ *
+ */
+export interface Method<T> {
   /**
-   * Gets logs
-   * 
-   * TODO: `logType` should be a key in `supportedLogTypes`, and the return value of this function
-   * should be the associated `LogType` object's `LogEntry` parameterized type.
-   * @param logType - Name/key of log type as defined in {@linkcode LogCommands.supportedLogTypes}.
+   * Name of the command.
    */
-  getLog(logType: string): Promise<any[]>;
+  command?: keyof ConditionalPick<Required<T>, DriverCommand>;
+  /**
+   * If true, this `Method` will never proxy.
+   */
+  neverProxy?: boolean;
+  /**
+   * Specifies shape of payload
+   */
+  payloadParams?: PayloadParams;
 }
 
-export interface SettingsCommands {
-  updateSettings: (settings: Record<string, any>) => Promise<void>;
-  getSettings(): Promise<Record<string, any>>;
-}
+/**
+ * An instance method of a driver class, whose name may be referenced by {@linkcode Method.command}, and serves as an Appium command.
+ *
+ * Note that this signature differs from a `PluginCommand`.
+ */
+export type DriverCommand<TArgs = any, TRetval = unknown> = (...args: TArgs[]) => Promise<TRetval>;
 
-export interface SessionHandler<CreateResult, DeleteResult> {
-  createSession(
-    w3cCaps1: W3CCapabilities,
-    w3cCaps2?: W3CCapabilities,
-    w3cCaps?: W3CCapabilities,
-    driverData?: DriverData[],
-  ): Promise<CreateResult>;
-
-  deleteSession(
-    sessionId?: string,
-    driverData?: DriverData[],
-  ): Promise<DeleteResult>;
+/**
+ * Defines the shape of a payload for a {@linkcode Method}.
+ */
+export interface PayloadParams {
+  wrap?: string;
+  unwrap?: string;
+  required?: Readonly<string[]> | MultidimensionalReadonlyArray<string, 2>;
+  optional?: Readonly<string[]> | MultidimensionalReadonlyArray<string, 2>;
+  validate?: (obj: any, protocol: string) => boolean | string | undefined;
+  makeArgs?: (obj: any) => any;
 }
+/**
+ * A mapping of URL paths to HTTP methods to {@linkcode Method}s.
+ *
+ * @todo Should use {@linkcode HTTPMethod} here
+ */
+export type MethodMap<Extension = ExternalDriver> = Record<
+  string,
+  Record<string, Method<Extension & ExternalDriver>>
+>;
 
-export type DriverData = Record<string, unknown>;
-
 /**
@@ -639,3 +119,40 @@ * Wraps {@linkcode _Class `type-fest`'s `Class`} to include static members.
   StaticMembers extends object = {},
-  Args extends unknown[] = any[],
+  Args extends unknown[] = any[]
 > = _Class<Proto, Args> & StaticMembers;
+
+/**
+ * The string referring to a "driver"-type extension
+ */
+export type DriverType = 'driver';
+
+/**
+ * The string referring to a "plugin"-type extension
+ *
+ */
+export type PluginType = 'plugin';
+
+/**
+ * The strings referring to all extension types.
+ */
+export type ExtensionType = DriverType | PluginType;
+
+/**
+ * Optionally updates an Appium express app and http server, by calling
+ * methods that may mutate those objects. For example, you could call:
+ *
+ * `expressApp.get('/foo', handler)`
+ *
+ * In order to add a new route to Appium with this plugin. Or, you could add
+ * new listeners to the httpServer object.
+ *
+ * @param expressApp - the Express 'app' object used by Appium for route handling
+ * @param httpServer - the node HTTP server that hosts the app
+ */
+export type UpdateServerCallback = (expressApp: Express, httpServer: AppiumServer) => Promise<void>;
+
+/**
+ * Possible HTTP methods, as stolen from `axios`.
+ *
+ * @see https://npm.im/axios
+ */
+export type HTTPMethod = _Method;

package.json

 {
   "name": "@appium/types",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "Various type declarations used across Appium",
@@ -21,2 +21,3 @@ "keywords": [
   "author": "https://github.com/appium",
+  "types": "./build/index.d.ts",
   "files": [
@@ -30,16 +31,16 @@ "build",
     "fix": "npm run lint -- --fix",
-    "lint": "eslint -c ../../.eslintrc --ignore-path ../../.eslintignore ."
+    "lint": "eslint -c ../../.eslintrc --ignore-path ../../.eslintignore .",
+    "prepare": "npm run build"
   },
+  "dependencies": {
+    "@appium/schema": "^0.0.6"
+  },
   "engines": {
-    "node": ">=12",
+    "node": ">=14",
     "npm": ">=6"
   },
-  "types": "./build/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5482c921bc187ed8807922c00bd2355585f4971a",
-  "dependencies": {
-    "@appium/schema": "^0.0.5"
-  }
+  "gitHead": "5c7af8ee73078018e4ec52fccf19fe3f77249d72"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

123842

increased by17.38%

Number of package files

21

increased by40%

Lines of code

2087

increased by24.45%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@appium/schema@0.0.6(transitive)

• - Removed@appium/schema@0.0.5(transitive)

• Updated@appium/schema@^0.0.6