@appium/types 0.26.0 → 1.0.0

package/lib/driver.ts

@@ -35,8 +35,8 @@ export interface ITimeoutCommands {
    * @param implicit - the number in ms for the implicit wait timeout, used for the W3C command
    */
   timeouts(
-    type: string,
-    ms: number | string,
+    type?: string,
+    ms?: number | string,
     script?: number,
     pageLoad?: number,
     implicit?: number | string,
@@ -49,16 +49,6 @@ export interface ITimeoutCommands {
    */
   setNewCommandTimeout(ms: number): void;
 
-  /**
-   * Set the implicit wait timeout
-   *
-   * @param ms - the timeout in ms
-   *
-   * @deprecated Use `timeouts` instead
-   *
-   */
-  implicitWait(ms: number | string): Promise<void>;
-
   /**
    * A helper method (not a command) used to set the implicit wait value
    *
@@ -90,14 +80,6 @@ export interface ITimeoutCommands {
    */
   implicitWaitW3C(ms: number): Promise<void>;
 
-  /**
-   * Set the implicit wait value that was sent in via the JSONWP
-   *
-   * @param ms - the timeout in ms
-   * @deprecated
-   */
-  implicitWaitMJSONWP(ms: number): Promise<void>;
-
   /**
    * Set the page load timeout value that was sent in via the W3C protocol
    *
@@ -105,14 +87,6 @@ export interface ITimeoutCommands {
    */
   pageLoadTimeoutW3C(ms: number): Promise<void>;
 
-  /**
-   * Set the page load timeout value that was sent in via the JSONWP
-   *
-   * @param ms - the timeout in ms
-   * @deprecated
-   */
-  pageLoadTimeoutMJSONWP(ms: number): Promise<void>;
-
   /**
    * Set the script timeout value that was sent in via the W3C protocol
    *
@@ -120,14 +94,6 @@ export interface ITimeoutCommands {
    */
   scriptTimeoutW3C(ms: number): Promise<void>;
 
-  /**
-   * Set the script timeout value that was sent in via the JSONWP
-   *
-   * @param ms - the timeout in ms
-   * @deprecated
-   */
-  scriptTimeoutMJSONWP(ms: number): Promise<void>;
-
   /**
    * Set Appium's new command timeout
    *
@@ -183,16 +149,6 @@ export interface IExecuteCommands {
   ): Promise<TReturn>;
 }
 
-/**
- * Data returned by {@linkcode ISessionHandler.getSessions}.
- *
- * @typeParam C - The driver's constraints
- */
-export interface MultiSessionData<C extends Constraints = Constraints> {
-  id: string;
-  capabilities: DriverCaps<C>;
-}
-
 /**
  * Data returned by `AppiumDriver.getAppiumSessions`
  *
@@ -485,13 +441,6 @@ export interface ISessionHandler<
    */
   deleteSession(sessionId?: string, driverData?: DriverData[]): Promise<DeleteResult | void>;
 
-  /**
-   * Get data for all sessions running on an Appium server
-   *
-   * @returns A list of session data objects
-   */
-  getSessions(): Promise<MultiSessionData[]>;
-
   /**
    * Get the data for the current session
    *
@@ -646,10 +595,6 @@ export interface Core<C extends Constraints, Settings extends StringRecord = Str
   isCommandsQueueEnabled: boolean;
   eventHistory: EventHistory;
   bidiEventSubs: Record<string, string[]>;
-  /**
-   * @deprecated Drivers no longer need to opt into BiDi support explicitly
-   */
-  doesSupportBidi?: boolean;
   updateBidiCommands(cmds: BidiModuleMap): void;
   onUnexpectedShutdown(handler: () => any): void;
   /**
@@ -747,6 +692,19 @@ export interface Driver<
    */
   executeCommand(cmd: string, ...args: any[]): Promise<any>;
 
+
+  /**
+   * A helper method to modify the command name before it's logged.
+   *
+   * Useful for resolving generic commands like 'execute' to a more specific
+   * name based on arguments (e.g., identifying custom extensions).
+   *
+   * @param cmd - The original command name
+   * @param args - Arguments passed to the command
+   * @returns A potentially updated command name
+   */
+  clarifyCommandName?(cmd: string, args: string[]): string;
+
   /** Execute a driver (WebDriver Bidi protocol) command by its name as defined in the bidi commands file
    * @param bidiCmd - the name of the command in the bidi spec
    * @param args - arguments to pass to the command
@@ -767,14 +725,6 @@ export interface Driver<
    */
   startNewCommandTimeout(): Promise<void>;
 
-  /**
-   * Reset the current session (run the delete session and create session subroutines)
-   *
-   * @deprecated Use explicit session management commands instead
-   * @privateRemarks This is implemented by `BaseDriver` and is used within `@appium/driver-test-support`
-   */
-  reset(): Promise<void>;
-
   /**
    * The processed capabilities used to start the session represented by the current driver instance
    */
@@ -1284,163 +1234,6 @@ export interface ExternalDriver<
    */
   getDeviceTime?(format?: string): Promise<string>;
 
-  /**
-   * List the performance data types supported by this driver, which can be used in a call to get
-   * the performance data by type.
-   *
-   * @returns The list of types
-   *
-   * @deprecated
-   */
-  getPerformanceDataTypes?(): Promise<string[]>;
-
-  /**
-   * Get the list of performance data associated with a given type
-   *
-   * @param packageName - the package name / id of the app to retrieve data for
-   * @param dataType - the performance data type; one of those retrieved in a call to
-   * getPerformanceDataTypes
-   * @param dataReadTimeout - how long to wait for data before timing out
-   *
-   * @returns A list of performance data strings
-   *
-   * @deprecated
-   */
-  getPerformanceData?(
-    packageName: string,
-    dataType: string,
-    dataReadTimeout?: number,
-  ): Promise<any>;
-
-  /**
-   * Press a device hardware key by its code for the default duration
-   *
-   * @param keycode - the keycode
-   * @param metastate - the code denoting the simultaneous pressing of any meta keys (shift etc)
-   * @param flags - the code denoting the combination of extra flags
-   *
-   * @deprecated
-   */
-  pressKeyCode?(keycode: number, metastate?: number, flags?: number): Promise<void>;
-
-  /**
-   * Press a device hardware key by its code for a longer duration
-   *
-   * @param keycode - the keycode
-   * @param metastate - the code denoting the simultaneous pressing of any meta keys (shift etc)
-   * @param flags - the code denoting the combination of extra flags
-   *
-   * @deprecated
-   *
-   */
-  longPressKeyCode?(keycode: number, metastate?: number, flags?: number): Promise<void>;
-
-  /**
-   * Apply a synthetic fingerprint to the fingerprint detector of the device
-   *
-   * @param fingerprintId - the numeric ID of the fingerprint to use
-   *
-   * @deprecated
-   */
-  fingerprint?(fingerprintId: number): Promise<void>;
-
-  /**
-   * Simulate sending an SMS message from a certain phone number to the device
-   *
-   * @param phoneNumber - the number to pretend the message is from
-   * @param message - the SMS text
-   *
-   * @deprecated
-   */
-  sendSMS?(phoneNumber: string, message: string): Promise<void>;
-
-  /**
-   * Simulate triggering a phone call from a phone number and having the device take an action in
-   * response
-   *
-   * @param phoneNumber - the number to pretend the call is from
-   * @param action - the action to take in response (accept, reject, etc...)
-   *
-   * @deprecated
-   */
-  gsmCall?(phoneNumber: string, action: string): Promise<void>;
-
-  /**
-   * Simulate setting the GSM signal strength for a cell phone
-   *
-   * @param singalStrength - the strength in a driver-appropriate string
-   *
-   * @deprecated
-   */
-  gsmSignal?(signalStrength: string | number): Promise<void>;
-
-  /**
-   * Do something with GSM voice (unclear; this should not be implemented anywhere)
-   *
-   * @param state - the state
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  gsmVoice?(state: string): Promise<void>;
-
-  /**
-   * Set the simulated power capacity of the device
-   *
-   * @param percent - how full the battery should become
-   *
-   * @deprecated
-   */
-  powerCapacity?(percent: number): Promise<void>;
-
-  /**
-   * Set the AC-connected power state of the device
-   *
-   * @param state - whether the device is connected to power or not
-   *
-   * @deprecated
-   */
-  powerAC?(state: string): Promise<void>;
-
-  /**
-   * Set the network speed of the device
-   *
-   * @param netspeed - the speed as a string, like '3G'
-   *
-   * @deprecated
-   */
-  networkSpeed?(netspeed: string): Promise<void>;
-
-  /**
-   * Simulate a keyevent on the device
-   *
-   * @param keycode - the manufacturer defined keycode
-   * @param metastate - the combination of meta startUnexpectedShutdown
-   *
-   * @deprecated
-   */
-  keyevent?(keycode: string | number, metastate?: string | number): Promise<void>;
-
-  /**
-   * Get the current activity name
-   *
-   * @returns The activity name
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  getCurrentActivity?(): Promise<string>;
-
-  /**
-   * Get the current active app package name/id
-   *
-   * @returns The package name
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  getCurrentPackage?(): Promise<string>;
-
   /**
    * Install an app on a device
    *
@@ -1543,174 +1336,6 @@ export interface ExternalDriver<
    */
   pullFolder?(path: string): Promise<string>;
 
-  /**
-   * Toggle airplane/flight mode for the device
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  toggleFlightMode?(): Promise<void>;
-
-  /**
-   * Toggle cell network data
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  toggleData?(): Promise<void>;
-
-  /**
-   * Toggle WiFi radio status
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  toggleWiFi?(): Promise<void>;
-
-  /**
-   * Toggle location services for the device
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  toggleLocationServices?(): Promise<void>;
-
-  /**
-   * Open the notifications shade/screen
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  openNotifications?(): Promise<void>;
-
-  /**
-   * Start an Android activity within an app
-   *
-   * @param appPackage - the app package id
-   * @param appActivity - the activity name
-   * @param appWaitPackage - the package id to wait for if different from the app package
-   * @param appWaitActivity - the activity name to wait for being active if different from
-   * appActivity
-   * @param intentAction - the action for the intent to use to start the activity
-   * @param intentCategory - the category for the intent
-   * @param flags - the flags for the intent
-   * @param optionalIntentArguments - additional arguments to be passed to launching the intent
-   * @param dontStopAppOnReset - set to true to not stop the current app before launching the
-   * activity
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  startActivity?(
-    appPackage: string,
-    appActivity: string,
-    appWaitPackage?: string,
-    appWaitActivity?: string,
-    intentAction?: string,
-    intentCategory?: string,
-    intentFlags?: string,
-    optionalIntentArguments?: string,
-    dontStopAppOnReset?: boolean,
-  ): Promise<void>;
-
-  /**
-   * Get information from the system bars of a device
-   *
-   * @returns An array of information objects of driver-specific shape
-   *
-   * @deprecated
-   */
-  getSystemBars?(): Promise<unknown>;
-
-  /**
-   * Get the display's pixel density
-   *
-   * @returns The density
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  getDisplayDensity?(): Promise<number>;
-
-  /**
-   * End platform-specific code coverage tracing
-   *
-   * @param intent - the Android intent for the coverage activity
-   * @param path - the path to place the results
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  endCoverage?(intent: string, path: string): Promise<void>;
-
-  /**
-   * Set the value of a text field but ensure the current value is replace and not appended
-   *
-   * @param value - the text to set
-   * @param elementId - the element to set it in
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  replaceValue?(value: string, elementId: string): Promise<void>;
-
-  // JSONWP
-  /**
-   * Check whether two elements are identical
-   *
-   * @param elementId - the first element's ID
-   * @param otherElementId - the second element's ID
-   *
-   * @returns True if the elements are equal, false otherwise
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  equalsElement?(elementId: string, otherElementId: string): Promise<boolean>;
-  /**
-   * Get the list of IME engines
-   *
-   * @returns The list of IME engines
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  availableIMEEngines?(): Promise<string[]>;
-
-  /**
-   * Get the active IME engine
-   *
-   * @returns The name of the active engine
-   *
-   * @deprecated
-   */
-  getActiveIMEEngine?(): Promise<string>;
-
-  /**
-   * Determine whether an IME is active
-   *
-   * @returns True if the IME is activated
-   *
-   * @deprecated
-   */
-  isIMEActivated?(): Promise<boolean>;
-
-  /**
-   * Deactivate an IME engine
-   *
-   * @deprecated
-   */
-  deactivateIMEEngine?(): Promise<void>;
-
-  /**
-   * Activate an IME engine
-   *
-   * @param engine - the name of the engine
-   *
-   * @deprecated
-   */
-  activateIMEEngine?(engine: string): Promise<void>;
-
   /**
    * Get the device orientation
    *
@@ -1725,105 +1350,6 @@ export interface ExternalDriver<
    */
   setOrientation?(orientation: string): Promise<void>;
 
-  /**
-   * Trigger a mouse button down
-   *
-   * @param button - the button ID
-   *
-   * @deprecated Use the Actions API instead
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  buttonDown?(button?: number): Promise<void>;
-
-  /**
-   * Trigger a mouse button up
-   *
-   * @param button - the button ID
-   *
-   * @deprecated Use the Actions API instead
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  buttonUp?(button?: number): Promise<void>;
-
-  /**
-   * Click the current mouse location
-   *
-   * @param button - the button ID
-   *
-   * @deprecated Use the Actions API instead
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  clickCurrent?(button?: number): Promise<void>;
-
-  /**
-   * Double-click the current mouse location
-   *
-   * @deprecated Use the Actions API instead
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  doubleClick?(): Promise<void>;
-
-  /**
-   * Perform a touch down event at the location specified
-   *
-   * @param x - the x coordinate
-   * @param y - the y coordinate
-   *
-   * @deprecated Use the Actions API instead
-   */
-  touchDown?(element: string, x: number, y: number): Promise<void>;
-
-  /**
-   * Perform a touch up event at the location specified
-   *
-   * @param x - the x coordinate
-   * @param y - the y coordinate
-   *
-   * @deprecated Use the Actions API instead
-   */
-  touchUp?(element: string, x: number, y: number): Promise<void>;
-
-  /**
-   * Perform a touch move event at the location specified
-   *
-   * @param x - the x coordinate
-   * @param y - the y coordinate
-   *
-   * @deprecated Use the Actions API instead
-   */
-  touchMove?(element: string, x: number, y: number): Promise<void>;
-
-  /**
-   * Perform a long touch down event at the location specified
-   *
-   * @param elementId - the id of the element to long touch
-   *
-   * @deprecated Use the Actions API instead
-   */
-  touchLongClick?(element: string, x: number, y: number, duration: number): Promise<void>;
-
-  /**
-   * Perform a flick event at the location specified
-   *
-   * @param element - the element to make coordinates relative to
-   * @param xSpeed - the horizontal flick speed (in driver-specific units)
-   * @param ySpeed - the vertical flick speed (in driver-specific units)
-   * @param xOffset - the x coordinate
-   * @param yOffset - the y coordinate
-   * @param speed - the speed (unclear how this relates to xSpeed and ySpeed)
-   *
-   * @deprecated Use the Actions API instead
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  flick?(
-    element?: string,
-    xSpeed?: number,
-    ySpeed?: number,
-    xOffset?: number,
-    yOffset?: number,
-    speed?: number,
-  ): Promise<void>;
-
   /**
    * Get the virtual or real geographical location of a device
    *
@@ -1865,18 +1391,6 @@ export interface ExternalDriver<
    */
   getContexts?(): Promise<Ctx[]>;
 
-  /**
-   * Get the index of an element on the page
-   *
-   * @param elementId - the element id
-   *
-   * @returns The page index
-   *
-   * @deprecated
-   * @privateRemarks Not implemented in `appium-xcuitest-driver`
-   */
-  getPageIndex?(elementId: string): Promise<string>;
-
   /**
    * Get the network connection state of a device
    * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes}

package/lib/server.ts

@@ -1,7 +1,6 @@
 import type {Express} from 'express';
 import type {Server as WSServer} from 'ws';
 import type {Server as HTTPServer} from 'node:http';
-import type {Socket} from 'node:net';
 import {ServerArgs} from './config';
 
 /**
@@ -49,13 +48,6 @@ export interface AppiumServerExtension {
   isSecure(): boolean;
 }
 
-/**
- * @deprecated This interface will be removed
- */
-export interface AppiumServerSocket extends Socket {
-  _openReqCount: number;
-}
-
 export {WSServer};
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/types",
-  "version": "0.26.0",
+  "version": "1.0.0",
   "description": "Various type declarations used across Appium",
   "keywords": [
     "automation",
@@ -38,17 +38,17 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@appium/logger": "^1.7.1",
-    "@appium/schema": "^0.8.1",
-    "@appium/tsconfig": "^0.3.5",
+    "@appium/logger": "^2.0.0",
+    "@appium/schema": "^1.0.0",
+    "@appium/tsconfig": "^1.0.0",
     "type-fest": "4.41.0"
   },
   "engines": {
-    "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
-    "npm": ">=8"
+    "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
+    "npm": ">=10"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c8fe4412525f7e1fa237813cf83fe7d98f0125eb"
+  "gitHead": "284da50353921343fa5a7f82574e64ce0c146db7"
 }