@appium/types 0.7.0 → 0.9.0

package/lib/index.ts

@@ -5,6 +5,8 @@ import type {Logger} from 'npmlog';
 import type {Class as _Class, ConditionalPick, MultidimensionalReadonlyArray} 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 './action';
 export * from './appium-config';
@@ -82,11 +84,14 @@ export interface AppiumServerSocket extends Socket {
  * The definition of an extension method, which will be provided via Appium's API.
  *
  */
-export interface MethodDef<Ext> {
+export interface MethodDef<Ext extends Plugin | Driver> {
   /**
    * Name of the command.
    */
-  readonly command?: keyof ConditionalPick<Required<Ext>, DriverCommand>;
+  readonly command?: keyof ConditionalPick<
+    Required<Ext>,
+    Ext extends Plugin ? PluginCommand : Ext extends Driver ? DriverCommand : never
+  >;
   /**
    * If true, this `Method` will never proxy.
    */
@@ -97,6 +102,20 @@ export interface MethodDef<Ext> {
   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.
  *
@@ -118,7 +137,7 @@ export interface PayloadParams {
 /**
  * A mapping of URL paths to HTTP methods to {@linkcode MethodDef}s.
  */
-export type MethodMap<Ext = any> = Readonly<
+export type MethodMap<Ext extends Plugin | Driver> = Readonly<
   Record<
     string,
     {

package/lib/plugin.ts

@@ -1,5 +1,5 @@
-import {MethodMap, UpdateServerCallback, Class, AppiumLogger, PluginType} from '.';
-import {Driver, ExternalDriver} from './driver';
+import {AppiumLogger, Class, ExecuteMethodMap, MethodMap, UpdateServerCallback} from '.';
+import {ExternalDriver} from './driver';
 
 /**
  * The interface describing the constructor and static properties of a Plugin.
@@ -21,6 +21,7 @@ export interface PluginStatic<P extends Plugin> {
    * }
    */
   newMethodMap?: MethodMap<P>;
+  executeMethodMap?: ExecuteMethodMap<P>;
 }
 
 /**
@@ -44,17 +45,12 @@ export interface Plugin {
   /**
    * Listener for unexpected server shutdown, which allows a plugin to do cleanup or take custom actions.
    */
-  onUnexpectedShutdown?: (driver: Driver, cause: Error | string) => Promise<void>;
+  onUnexpectedShutdown?: (driver: ExternalDriver, cause: Error | string) => Promise<void>;
   /**
    * Handle an Appium command, optionally running and using or throwing away the value of the
    * original Appium behavior (or the behavior of the next plugin in a plugin chain).
    */
-  handle?: (
-    next: NextPluginCallback,
-    driver: Driver,
-    cmdName: string,
-    ...args: any[]
-  ) => Promise<void>;
+  handle?: PluginCommand<ExternalDriver, [cmdName: string, ...args: any[]], void>;
 }
 
 /**
@@ -70,19 +66,21 @@ export interface Plugin {
  * for managing new command timeouts and command logging, for example:
  * `driver.stopNewCommandTimeout()` -- before running plugin logic
  * `driver.startNewCommandTimeout()` -- after running plugin logic
- * `driver._eventHistory.commands.push({cmd: cmdName, startTime, endTime}) --
+ * `driver._eventHistory.commands.push({cmd: cmdName, startTime, endTime})` --
  * after running plugin logic
  */
 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 type PluginCommand<TArgs = any> = (
-  next: NextPluginCallback,
-  driver: ExternalDriver,
-  ...args: TArgs[]
-) => Promise<void>;
+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.

package/lib/standard-caps.ts

@@ -0,0 +1,65 @@
+export type PageLoadingStrategy = 'none' | 'eager' | 'normal';
+export type ProxyTypes = 'pac' | 'noproxy' | 'autodetect' | 'system' | 'manual';
+export interface ProxyObject {
+  proxyType?: ProxyTypes;
+  proxyAutoconfigUrl?: string;
+  ftpProxy?: string;
+  ftpProxyPort?: number;
+  httpProxy?: string;
+  httpProxyPort?: number;
+  sslProxy?: string;
+  sslProxyPort?: number;
+  socksProxy?: string;
+  socksProxyPort?: number;
+  socksVersion?: string;
+  socksUsername?: string;
+  socksPassword?: string;
+}
+export type Timeouts = Record<'script' | 'pageLoad' | 'implicit', number>;
+
+export interface StandardCapabilities {
+  /**
+   * Identifies the user agent.
+   */
+  browserName?: string;
+  /**
+   * Identifies the version of the user agent.
+   */
+  browserVersion?: string;
+  /**
+   * Identifies the operating system of the endpoint node.
+   */
+  platformName?: string;
+  /**
+   * Indicates whether untrusted and self-signed TLS certificates are implicitly trusted on navigation for the duration of the session.
+   */
+  acceptInsecureCerts?: boolean;
+  /**
+   * Defines the current session’s page load strategy.
+   */
+  pageLoadStrategy?: PageLoadingStrategy;
+  /**
+   * Defines the current session’s proxy configuration.
+   */
+  proxy?: ProxyObject;
+  /**
+   * Indicates whether the remote end supports all of the resizing and repositioning commands.
+   */
+  setWindowRect?: boolean;
+  /**
+   * Describes the timeouts imposed on certain session operations.
+   */
+  timeouts?: Timeouts;
+  /**
+   * Defines the current session’s strict file interactability.
+   */
+  strictFileInteractability?: boolean;
+  /**
+   * Describes the current session’s user prompt handler. Defaults to the dismiss and notify state.
+   */
+  unhandledPromptBehavior?: string;
+  /**
+   * WebDriver clients opt in to a bidirectional connection by requesting a capability with the name "webSocketUrl" and value true.
+   */
+  webSocketUrl?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/types",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Various type declarations used across Appium",
   "keywords": [
     "automation",
@@ -27,7 +27,8 @@
   "files": [
     "build",
     "lib",
-    "index.js"
+    "index.js",
+    "tsconfig.json"
   ],
   "scripts": {
     "build": "node ./scripts/generate-schema-types.js",
@@ -35,12 +36,12 @@
     "test:smoke": "node ./index.js"
   },
   "dependencies": {
-    "@appium/schema": "^0.1.0",
+    "@appium/schema": "^0.2.3",
+    "@appium/tsconfig": "^0.2.3",
     "@types/express": "4.17.15",
     "@types/npmlog": "4.1.4",
-    "@types/ws": "8.5.3",
-    "@wdio/types": "7.26.0",
-    "type-fest": "3.4.0"
+    "@types/ws": "8.5.4",
+    "type-fest": "3.5.3"
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -49,7 +50,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2e76ba9607729f59ca967e47c2cba738e90a57b8",
+  "gitHead": "f1e0a46712b76564cd44c37657882308a7bac706",
   "typedoc": {
     "entryPoint": "./lib/index.ts"
   }

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "@appium/tsconfig/tsconfig.json",
+  "compilerOptions": {
+    "outDir": "build",
+    "checkJs": true,
+    "strict": true,
+    "paths": {
+      "@appium/schema": ["../schema"]
+    }
+  },
+  "include": ["lib"],
+  "references": [{"path": "../schema"}]
+}