@appium/types 0.9.1 → 0.10.1

package/build/lib/plugin.d.ts

@@ -1,4 +1,5 @@
-import { AppiumLogger, Class, ExecuteMethodMap, MethodMap, UpdateServerCallback } from '.';
+import { AppiumLogger, Class, UpdateServerCallback } from '.';
+import { ExecuteMethodMap, MethodMap } from './command';
 import { ExternalDriver } from './driver';
 /**
  * The interface describing the constructor and static properties of a Plugin.
@@ -66,19 +67,19 @@ export interface Plugin {
  * `driver._eventHistory.commands.push({cmd: cmdName, startTime, endTime})` --
  * after running plugin logic
  */
-export declare type NextPluginCallback = () => Promise<void>;
+export type NextPluginCallback = () => Promise<void>;
 /**
  * Implementation of a command within a plugin
  *
  * At minimum, `D` must be `ExternalDriver`, but a plugin can be more narrow about which drivers it supports.
  */
-export declare type PluginCommand<D extends ExternalDriver = ExternalDriver, TArgs extends readonly any[] = any[], TReturn = any> = (next: NextPluginCallback, driver: D, ...args: TArgs) => Promise<TReturn>;
+export type PluginCommand<D extends ExternalDriver = ExternalDriver, TArgs extends readonly any[] = any[], TReturn = any> = (next: NextPluginCallback, driver: D, ...args: TArgs) => Promise<TReturn>;
 /**
  * Mainly for internal use.
  *
  * The third parameter is the possible constructor signatures for the plugin class.
  */
-export declare type PluginClass<P extends Plugin = Plugin> = Class<P, PluginStatic<P>, [
+export type PluginClass<P extends Plugin = Plugin> = Class<P, PluginStatic<P>, [
     pluginName: string,
     cliArgs: Record<string, unknown>
 ]>;

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

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../lib/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,oBAAoB,EAAC,MAAM,GAAG,CAAC;AACzF,OAAO,EAAC,cAAc,EAAC,MAAM,UAAU,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM;IAC5C;;OAEG;IACH,YAAY,CAAC,EAAE,oBAAoB,CAAC;IACpC;;;;;;;;;;OAUG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAC5B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxF;;;OAGG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC,cAAc,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;CACjF;AAED;;;;;;;;;;;;;;;GAeG;AACH,oBAAY,kBAAkB,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AAErD;;;;GAIG;AACH,oBAAY,aAAa,CACvB,CAAC,SAAS,cAAc,GAAG,cAAc,EACzC,KAAK,SAAS,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,EACpC,OAAO,GAAG,GAAG,IACX,CAAC,IAAI,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAE9E;;;;GAIG;AACH,oBAAY,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,KAAK,CACxD,CAAC,EACD,YAAY,CAAC,CAAC,CAAC,EACf;IAAC,UAAU,EAAE,MAAM;IAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAAC,CACvD,CAAC"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../lib/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,KAAK,EAAE,oBAAoB,EAAC,MAAM,GAAG,CAAC;AAC5D,OAAO,EAAC,gBAAgB,EAAE,SAAS,EAAC,MAAM,WAAW,CAAC;AACtD,OAAO,EAAC,cAAc,EAAC,MAAM,UAAU,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM;IAC5C;;OAEG;IACH,YAAY,CAAC,EAAE,oBAAoB,CAAC;IACpC;;;;;;;;;;OAUG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAC5B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxF;;;OAGG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC,cAAc,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;CACjF;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AAErD;;;;GAIG;AACH,MAAM,MAAM,aAAa,CACvB,CAAC,SAAS,cAAc,GAAG,cAAc,EACzC,KAAK,SAAS,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,EACpC,OAAO,GAAG,GAAG,IACX,CAAC,IAAI,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAE9E;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,KAAK,CACxD,CAAC,EACD,YAAY,CAAC,CAAC,CAAC,EACf;IAAC,UAAU,EAAE,MAAM;IAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAAC,CACvD,CAAC"}

package/build/lib/standard-caps.d.ts

@@ -1,5 +1,5 @@
-export declare type PageLoadingStrategy = 'none' | 'eager' | 'normal';
-export declare type ProxyTypes = 'pac' | 'noproxy' | 'autodetect' | 'system' | 'manual';
+export type PageLoadingStrategy = 'none' | 'eager' | 'normal';
+export type ProxyTypes = 'pac' | 'noproxy' | 'autodetect' | 'system' | 'manual';
 export interface ProxyObject {
     proxyType?: ProxyTypes;
     proxyAutoconfigUrl?: string;
@@ -15,7 +15,7 @@ export interface ProxyObject {
     socksUsername?: string;
     socksPassword?: string;
 }
-export declare type Timeouts = Record<'script' | 'pageLoad' | 'implicit', number>;
+export type Timeouts = Record<'script' | 'pageLoad' | 'implicit', number>;
 export interface StandardCapabilities {
     /**
      * Identifies the user agent.

package/build/lib/standard-caps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"standard-caps.d.ts","sourceRoot":"","sources":["../../lib/standard-caps.ts"],"names":[],"mappings":"AAAA,oBAAY,mBAAmB,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;AAC9D,oBAAY,UAAU,GAAG,KAAK,GAAG,SAAS,GAAG,YAAY,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAChF,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AACD,oBAAY,QAAQ,GAAG,MAAM,CAAC,QAAQ,GAAG,UAAU,GAAG,UAAU,EAAE,MAAM,CAAC,CAAC;AAE1E,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB"}
+{"version":3,"file":"standard-caps.d.ts","sourceRoot":"","sources":["../../lib/standard-caps.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;AAC9D,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,SAAS,GAAG,YAAY,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAChF,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AACD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,GAAG,UAAU,GAAG,UAAU,EAAE,MAAM,CAAC,CAAC;AAE1E,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB"}

package/lib/action.ts

@@ -1,11 +1,15 @@
 /**
- * @module
  * Portions Copyright (c) 2017 Igor Muchychka
  * @see https://github.com/w3c-webdriver/w3c-webdriver
+ * @module
  */
 
-export interface Element {
-  'element-6066-11e4-a52e-4f735466cecf': string;
+/**
+ * A W3C or JSONWP element.
+ */
+export interface Element<Id extends string = string> {
+  ELEMENT?: Id;
+  'element-6066-11e4-a52e-4f735466cecf': Id;
 }
 
 /**
@@ -72,11 +76,7 @@ export type KeyAction = PauseAction | KeyDownAction | KeyUpAction;
 /**
  * @group Actions
  */
-export type PointerAction =
-  | PauseAction
-  | PointerMoveAction
-  | PointerUpAction
-  | PointerDownAction;
+export type PointerAction = PauseAction | PointerMoveAction | PointerUpAction | PointerDownAction;
 
 /**
  * @group Actions
@@ -116,10 +116,7 @@ export type PointerActionSequence = {
 /**
  * @group Actions
  */
-export type ActionSequence =
-  | NullActionSequence
-  | KeyActionSequence
-  | PointerActionSequence;
+export type ActionSequence = NullActionSequence | KeyActionSequence | PointerActionSequence;
 
 /**
  * @group Actions
@@ -194,5 +191,5 @@ export enum Key {
   R_ARROWRIGHT = '\uE05A',
   R_ARROWDOWN = '\uE05B',
   R_INSERT = '\uE05C',
-  R_DELETE = '\uE05D'
+  R_DELETE = '\uE05D',
 }

package/lib/command.ts

@@ -0,0 +1,119 @@
+import {ConditionalPick, MultidimensionalReadonlyArray} from 'type-fest';
+import {Driver, DriverCommand} from './driver';
+import {Plugin, PluginCommand} from './plugin';
+
+/**
+ * Defines the shape of a payload for a {@linkcode MethodDef}.
+ */
+export interface PayloadParams {
+  wrap?: string;
+  unwrap?: string;
+  required?: ReadonlyArray<string> | MultidimensionalReadonlyArray<string, 2>;
+  optional?: ReadonlyArray<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 either a {@linkcode DriverMethodDef} or {@linkcode PluginMethodDef}.
+ */
+export type MethodMap<T extends Plugin | Driver> = T extends Plugin
+  ? Readonly<PluginMethodMap<T>>
+  : T extends Driver
+  ? Readonly<DriverMethodMap<T>>
+  : never;
+
+/**
+ * A {@linkcode MethodMap} for a {@linkcode Driver}.
+ */
+export interface DriverMethodMap<T extends Driver> {
+  [key: string]: {
+    GET?: DriverMethodDef<T>;
+    POST?: DriverMethodDef<T>;
+    DELETE?: DriverMethodDef<T>;
+  };
+}
+
+/**
+ * Both {@linkcode DriverMethodDef} and {@linkcode PluginMethodDef} share these properties.
+ */
+export interface BaseMethodDef {
+  /**
+   * If true, this `Method` will never proxy.
+   */
+  readonly neverProxy?: boolean;
+  /**
+   * Specifies shape of payload
+   */
+  readonly payloadParams?: PayloadParams;
+}
+
+/**
+ * A definition of an exposed API command in a {@linkcode Driver}.
+ */
+export interface DriverMethodDef<T extends Driver> extends BaseMethodDef {
+  /**
+   * Name of the command.
+   */
+  readonly command?: keyof ConditionalPick<Required<T>, DriverCommand>;
+}
+
+/**
+ * A definition of an exposed API command in a {@linkcode Plugin}.
+ */
+export interface PluginMethodDef<T extends Plugin> extends BaseMethodDef {
+  /**
+   * Name of the command.
+   */
+  readonly command?: keyof ConditionalPick<Required<T>, DriverCommand>;
+}
+
+/**
+ * A mapping of URL paths to HTTP methods to {@linkcode PluginMethodDef}.
+ */
+export interface PluginMethodMap<T extends Plugin> {
+  [key: string]: {
+    GET?: PluginMethodDef<T>;
+    POST?: PluginMethodDef<T>;
+    DELETE?: PluginMethodDef<T>;
+  };
+}
+
+export interface ExecuteMethodDef<Ext extends Plugin | Driver> {
+  command: keyof ConditionalPick<
+    Required<Ext>,
+    Ext extends Plugin ? PluginCommand : Ext extends Driver ? DriverCommand : never
+  >;
+}
+
+/**
+ * Properties shared by execute method definitions in both plugins and drivers
+ */
+export interface BaseExecuteMethodDef {
+  params?: {
+    required?: ReadonlyArray<string>;
+    optional?: ReadonlyArray<string>;
+  };
+}
+
+/**
+ * A definition of an execute method in a {@linkcode Driver}.
+ */
+export interface DriverExecuteMethodDef<T extends Driver> extends BaseExecuteMethodDef {
+  command: keyof ConditionalPick<T, DriverCommand>;
+}
+
+/**
+ * A definition of an execute method in a {@linkcode Plugin}.
+ */
+export interface PluginExecuteMethodDef<T extends Plugin> extends BaseExecuteMethodDef {
+  command: keyof ConditionalPick<T, PluginCommand>;
+}
+
+/**
+ * Definition of an execute method (which overloads the behavior of the `execute` command) in a {@linkcode Driver} or {@linkcode Plugin}.
+ */
+export type ExecuteMethodMap<T extends Plugin | Driver> = T extends Plugin
+  ? Readonly<Record<string, PluginExecuteMethodDef<T>>>
+  : T extends Driver
+  ? Readonly<Record<string, DriverExecuteMethodDef<T>>>
+  : never;

package/lib/constraints.js

@@ -13,7 +13,7 @@ export const BASE_DESIRED_CAP_CONSTRAINTS = /** @type {const} */ ({
     isString: true,
   },
   webSocketUrl: {
-    isString: true,
+    isBoolean: true,
   },
   newCommandTimeout: {
     isNumber: true,

package/lib/driver.ts

@@ -5,17 +5,16 @@ import {
   AppiumServer,
   UpdateServerCallback,
   Class,
-  MethodMap,
   AppiumLogger,
   StringRecord,
   ConstraintsToCaps,
   BaseDriverCapConstraints,
   W3CCapabilities,
   Capabilities,
-  ExecuteMethodMap,
 } from '.';
 import {ServerArgs} from './config';
 import {AsyncReturnType, Entries} from 'type-fest';
+import {MethodMap, ExecuteMethodMap} from './command';
 
 export interface ITimeoutCommands {
   /**
@@ -66,7 +65,7 @@ export interface ITimeoutCommands {
    *
    * @returns The return value of the condition
    */
-  implicitWaitForCondition(condition: () => Promise<any>): Promise<unknown>;
+  implicitWaitForCondition(condition: (...args: any[]) => Promise<any>): Promise<unknown>;
 
   /**
    * Get the current timeouts
@@ -183,7 +182,7 @@ export interface IExecuteCommands {
    *
    * @returns The result of calling the Execute Method
    */
-  executeMethod(script: string, args: [StringRecord] | []): Promise<any>;
+  executeMethod<TReturn = any>(script: string, args: [StringRecord] | any[]): Promise<TReturn>;
 }
 
 export interface MultiSessionData<
@@ -199,7 +198,7 @@ export type SingularSessionData<
   Extra extends StringRecord | void = void
 > = Capabilities<C, Extra> & {events?: EventHistory; error?: string};
 
-export interface IFindCommands<Ctx = any> {
+export interface IFindCommands {
   /**
    * Find a UI element given a locator strategy and a selector, erroring if it can't be found
    * @see {@link https://w3c.github.io/webdriver/#find-element}
@@ -294,7 +293,7 @@ export interface IFindCommands<Ctx = any> {
    *
    * @returns A single element or list of elements
    */
-  findElOrEls<Mult extends boolean>(
+  findElOrEls<Mult extends boolean, Ctx = any>(
     strategy: string,
     selector: string,
     mult: Mult,
@@ -312,7 +311,7 @@ export interface IFindCommands<Ctx = any> {
    *
    * @returns A single element or list of elements
    */
-  findElOrElsWithProcessing<Mult extends boolean>(
+  findElOrElsWithProcessing<Mult extends boolean, Ctx = any>(
     strategy: string,
     selector: string,
     mult: Mult,
@@ -328,41 +327,35 @@ export interface IFindCommands<Ctx = any> {
   getPageSource(): Promise<string>;
 }
 
-export interface ILogCommands<C extends Constraints> {
+export interface ILogCommands {
   /**
    * Definition of the available log types
    */
-  supportedLogTypes: Readonly<LogDefRecord<C>>;
+  supportedLogTypes: Readonly<LogDefRecord>;
 
   /**
    * Get available log types as a list of strings
    */
-  getLogTypes(): Promise<(keyof ILogCommands<C>['supportedLogTypes'])[]>;
+  getLogTypes(): Promise<string[]>;
 
   /**
    * Get the log for a given log type.
    *
    * @param logType - Name/key of log type as defined in {@linkcode ILogCommands.supportedLogTypes}.
    */
-  getLog(
-    logType: keyof ILogCommands<C>['supportedLogTypes']
-  ): Promise<
-    AsyncReturnType<
-      ILogCommands<C>['supportedLogTypes'][keyof ILogCommands<C>['supportedLogTypes']]['getter']
-    >
-  >;
+  getLog(logType: string): Promise<any[]>;
 }
 
 /**
  * A record of {@linkcode LogDef} objects, keyed by the log type name.
  * Used in {@linkcode ILogCommands.supportedLogTypes}
  */
-export type LogDefRecord<C extends Constraints> = Record<string, LogDef<C>>;
+export type LogDefRecord = Record<string, LogDef>;
 
 /**
  * A definition of a log type
  */
-export interface LogDef<C extends Constraints, T = unknown> {
+export interface LogDef {
   /**
    * Description of the log type.
    *
@@ -375,7 +368,7 @@ export interface LogDef<C extends Constraints, T = unknown> {
    *
    * This implementation *should* drain, truncate or otherwise reset the log buffer.
    */
-  getter: (driver: Driver<C>) => Promise<T[]>;
+  getter: <C extends Constraints, T = any>(driver: Driver<C>) => Promise<T[]>;
 }
 
 export interface ISettingsCommands {
@@ -570,6 +563,8 @@ export interface Credential {
   largeBlob?: string;
 }
 
+export type Orientation = 'LANDSCAPE' | 'PORTRAIT';
+
 export interface EventHistory {
   commands: EventHistoryCommand[];
   [key: string]: any;
@@ -651,7 +646,7 @@ export interface Core<C extends Constraints = BaseDriverCapConstraints> {
   canProxy(sessionId?: string): boolean;
   proxyRouteIsAvoided(sessionId: string, method: string, url: string): boolean;
   addManagedDriver(driver: Driver): void;
-  getManagedDrivers(): Driver[];
+  getManagedDrivers(): Driver<Constraints>[];
   clearNewCommandTimeout(): Promise<void>;
   logEvent(eventName: string): void;
   driverForSession(sessionId: string): Core<C> | null;
@@ -666,12 +661,11 @@ export interface Core<C extends Constraints = BaseDriverCapConstraints> {
  * `Ctx` would be the type of the element context (e.g., string, dictionary of some sort, etc.)
  */
 export interface Driver<
-  C extends Constraints = BaseDriverCapConstraints,
-  CArgs extends StringRecord = StringRecord,
-  Ctx = any
+  C extends Constraints = Constraints,
+  CArgs extends StringRecord = StringRecord
 > extends ISessionCommands,
-    ILogCommands<C>,
-    IFindCommands<Ctx>,
+    ILogCommands,
+    IFindCommands,
     ISettingsCommands,
     ITimeoutCommands,
     IEventCommands,
@@ -767,8 +761,7 @@ export interface Driver<
  * External drivers must subclass `BaseDriver`, and can implement any of these methods.
  * None of these are implemented within Appium itself.
  */
-export interface ExternalDriver<C extends Constraints = BaseDriverCapConstraints>
-  extends Driver<C> {
+export interface ExternalDriver<C extends Constraints = Constraints> extends Driver<C> {
   // The following properties are assigned by appium */
   server?: AppiumServer;
   serverHost?: string;
@@ -2205,11 +2198,11 @@ export interface ExternalDriver<C extends Constraints = BaseDriverCapConstraints
  *
  * This is likely unusable by external consumers, but YMMV!
  */
-export interface DriverStatic<D extends Driver> {
+export interface DriverStatic<T extends Driver> {
   baseVersion: string;
   updateServer?: UpdateServerCallback;
-  newMethodMap?: MethodMap<D>;
-  executeMethodMap?: ExecuteMethodMap<D>;
+  newMethodMap?: MethodMap<T>;
+  executeMethodMap?: ExecuteMethodMap<T>;
 }
 
 /**
@@ -2217,9 +2210,9 @@ export interface DriverStatic<D extends Driver> {
  *
  * This is likely unusable by external consumers, but YMMV!
  */
-export type DriverClass<D extends Driver = ExternalDriver> = Class<
-  D,
-  DriverStatic<D>,
+export type DriverClass<T extends Driver = Driver> = Class<
+  T,
+  DriverStatic<T>,
   [] | [Partial<ServerArgs>] | [Partial<ServerArgs>, boolean]
 >;
 
@@ -2236,7 +2229,12 @@ export type DriverOpts<C extends Constraints = BaseDriverCapConstraints> = Serve
   ExtraDriverOpts &
   Partial<ConstraintsToCaps<C>>;
 
-export type DriverCommand<TArgs = any, TReturn = unknown> = (...args: TArgs[]) => Promise<TReturn>;
+/**
+ * An instance method of a driver class, whose name may be referenced by {@linkcode MethodDef.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 type DriverCommands<TArgs = any, TReturn = unknown> = Record<
   string,

package/lib/index.ts

@@ -2,12 +2,10 @@ import type {Express} from 'express';
 import type {Server} from 'http';
 import type {Socket} from 'net';
 import type {Logger} from 'npmlog';
-import type {Class as _Class, ConditionalPick, MultidimensionalReadonlyArray} from 'type-fest';
+import type {Class as _Class} from 'type-fest';
 import type {Server as WSServer} from 'ws';
 import {ServerArgs} from './config';
-import {Driver} from './driver';
-import {Plugin, PluginCommand} from './plugin';
-
+export * from './command';
 export * from './action';
 export * from './appium-config';
 export * from './capabilities';
@@ -80,80 +78,12 @@ export interface AppiumServerSocket extends Socket {
   _openReqCount: number;
 }
 
-/**
- * The definition of an extension method, which will be provided via Appium's API.
- *
- */
-export interface MethodDef<Ext extends Plugin | Driver> {
-  /**
-   * Name of the command.
-   */
-  readonly command?: keyof ConditionalPick<
-    Required<Ext>,
-    Ext extends Plugin ? PluginCommand : Ext extends Driver ? DriverCommand : never
-  >;
-  /**
-   * If true, this `Method` will never proxy.
-   */
-  readonly neverProxy?: boolean;
-  /**
-   * Specifies shape of payload
-   */
-  readonly payloadParams?: PayloadParams;
-}
-
-export interface ExecuteMethodDef<Ext extends Driver | Plugin> {
-  command: keyof ConditionalPick<
-    Required<Ext>,
-    Ext extends Plugin ? PluginCommand : Ext extends Driver ? DriverCommand : never
-  >;
-  params?: {
-    required?: ReadonlyArray<string>;
-    optional?: ReadonlyArray<string>;
-  };
-}
-export type ExecuteMethodMap<Ext extends Driver | Plugin> = Readonly<
-  Record<string, Readonly<ExecuteMethodDef<Ext>>>
->;
-
-/**
- * An instance method of a driver class, whose name may be referenced by {@linkcode MethodDef.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>;
-
-/**
- * Defines the shape of a payload for a {@linkcode MethodDef}.
- */
-export interface PayloadParams {
-  wrap?: string;
-  unwrap?: string;
-  required?: ReadonlyArray<string> | MultidimensionalReadonlyArray<string, 2>;
-  optional?: ReadonlyArray<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 MethodDef}s.
- */
-export type MethodMap<Ext extends Plugin | Driver> = Readonly<
-  Record<
-    string,
-    {
-      GET?: MethodDef<Ext>;
-      POST?: MethodDef<Ext>;
-      DELETE?: MethodDef<Ext>;
-    }
-  >
->;
-
 /**
  * Wraps {@linkcode _Class `type-fest`'s `Class`} to include static members.
  */
 export type Class<
   Proto,
-  StaticMembers extends object = {},
+  StaticMembers extends object = object,
   Args extends unknown[] = any[]
 > = _Class<Proto, Args> & StaticMembers;
 

package/lib/plugin.ts

@@ -1,4 +1,5 @@
-import {AppiumLogger, Class, ExecuteMethodMap, MethodMap, UpdateServerCallback} from '.';
+import {AppiumLogger, Class, UpdateServerCallback} from '.';
+import {ExecuteMethodMap, MethodMap} from './command';
 import {ExternalDriver} from './driver';
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/types",
-  "version": "0.9.1",
+  "version": "0.10.1",
   "description": "Various type declarations used across Appium",
   "keywords": [
     "automation",
@@ -37,12 +37,12 @@
     "test:smoke": "node ./index.js"
   },
   "dependencies": {
-    "@appium/schema": "^0.2.4",
+    "@appium/schema": "^0.2.6",
     "@appium/tsconfig": "^0.2.4",
     "@types/express": "4.17.17",
     "@types/npmlog": "4.1.4",
     "@types/ws": "8.5.4",
-    "type-fest": "3.5.6"
+    "type-fest": "3.6.1"
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -51,7 +51,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "322363b8876a7ea7b630d538e22965f7bab0ea06",
+  "gitHead": "872b924a97c13142bdb8bf4218a4db324f309ce4",
   "typedoc": {
     "entryPoint": "./lib/index.ts"
   }

package/build/lib/extension.d.ts

@@ -1,71 +0,0 @@
-import type { Express } from 'express';
-import { ConditionalPick, MultidimensionalReadonlyArray } from 'type-fest';
-import { ServerArgs } from './config';
-import { DriverCommand } from './driver';
-import { PluginCommand } from './plugin';
-import { AppiumServer } from './server';
-/**
- * The definition of an extension method, which will be provided via Appium's API.
- *
- */
-export interface MethodDef<Ext> {
-    /**
-     * Name of the command.
-     */
-    readonly command?: keyof ConditionalPick<Required<Ext>, DriverCommand | PluginCommand>;
-    /**
-     * If true, this `Method` will never proxy.
-     */
-    readonly neverProxy?: boolean;
-    /**
-     * Specifies shape of payload
-     */
-    readonly payloadParams?: PayloadParams;
-}
-/**
- * Defines the shape of a payload for a {@linkcode MethodDef}.
- */
-export interface PayloadParams {
-    wrap?: string;
-    unwrap?: string;
-    required?: ReadonlyArray<string> | MultidimensionalReadonlyArray<string, 2>;
-    optional?: ReadonlyArray<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 MethodDef}s.
- */
-export declare type MethodMap<Ext = any> = Readonly<Record<string, {
-    GET?: MethodDef<Ext>;
-    POST?: MethodDef<Ext>;
-    DELETE?: MethodDef<Ext>;
-}>>;
-/**
- * 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
- * @param cliArgs - Arguments from config files, CLI, etc.
- */
-export declare type UpdateServerCallback = (expressApp: Express, httpServer: AppiumServer, cliArgs: Partial<ServerArgs>) => Promise<void>;
-//# sourceMappingURL=extension.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"extension.d.ts","sourceRoot":"","sources":["../../lib/extension.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AACrC,OAAO,EAAC,eAAe,EAAE,6BAA6B,EAAC,MAAM,WAAW,CAAC;AACzE,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACpC,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AACvC,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AACvC,OAAO,EAAC,YAAY,EAAC,MAAM,UAAU,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,GAAG;IAC5B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,aAAa,GAAG,aAAa,CAAC,CAAC;IACvF;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,6BAA6B,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5E,QAAQ,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,6BAA6B,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5E,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;IACxE,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAC;CAC9B;AACD;;GAEG;AACH,oBAAY,SAAS,CAAC,GAAG,GAAG,GAAG,IAAI,QAAQ,CACzC,MAAM,CACJ,MAAM,EACN;IACE,GAAG,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;IACrB,IAAI,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;IACtB,MAAM,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;CACzB,CACF,CACF,CAAC;AAEF;;GAEG;AACH,oBAAY,UAAU,GAAG,QAAQ,CAAC;AAElC;;;GAGG;AACH,oBAAY,UAAU,GAAG,QAAQ,CAAC;AAElC;;GAEG;AACH,oBAAY,aAAa,GAAG,UAAU,GAAG,UAAU,CAAC;AAEpD;;;;;;;;;;;;GAYG;AACH,oBAAY,oBAAoB,GAAG,CACjC,UAAU,EAAE,OAAO,EACnB,UAAU,EAAE,YAAY,EACxB,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,KACzB,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/build/lib/extension.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=extension.js.map

package/build/lib/extension.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"extension.js","sourceRoot":"","sources":["../../lib/extension.ts"],"names":[],"mappings":""}