appium 2.5.3 → 2.6.0

package/lib/utils.js

@@ -4,7 +4,7 @@ import {processCapabilities, PROTOCOLS, STANDARD_CAPS, errors} from '@appium/bas
 import {inspect as dump} from 'util';
 import {node, fs} from '@appium/support';
 import path from 'path';
-import {SERVER_SUBCOMMAND, DRIVER_TYPE, PLUGIN_TYPE} from './constants';
+import {SERVER_SUBCOMMAND, DRIVER_TYPE, PLUGIN_TYPE, SETUP_SUBCOMMAND} from './constants';
 import os from 'node:os';
 
 const W3C_APPIUM_PREFIX = 'appium';
@@ -330,6 +330,16 @@ export function isServerCommandArgs(args) {
   return args.subcommand === SERVER_SUBCOMMAND;
 }
 
+/**
+ * @template {CliCommand} Cmd
+ * @template {CliExtensionSubcommand|CliCommandSetupSubcommand|void} [SubCmd=void]
+ * @param {Args<Cmd, SubCmd>} args
+ * @returns {args is Args<SetupCommand>}
+ */
+export function isSetupCommandArgs(args) {
+  return args.subcommand === SETUP_SUBCOMMAND;
+}
+
 /**
  * @template {CliCommand} [Cmd=ServerCommand]
  * @template {CliExtensionSubcommand|void} [SubCmd=void]
@@ -451,19 +461,21 @@ export {
  * @typedef {import('appium/types').CliCommand} CliCommand
  * @typedef {import('appium/types').CliExtensionSubcommand} CliExtensionSubcommand
  * @typedef {import('appium/types').CliExtensionCommand} CliExtensionCommand
+ * @typedef {import('appium/types').CliCommandSetupSubcommand} CliCommandSetupSubcommand
  * @typedef {import('appium/types').CliCommandServer} ServerCommand
  * @typedef {import('appium/types').CliCommandDriver} DriverCommand
  * @typedef {import('appium/types').CliCommandPlugin} PluginCommand
+ * @typedef {import('appium/types').CliCommandSetup} SetupCommand
  */
 
 /**
  * @template {CliCommand} [Cmd=ServerCommand]
- * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @template {CliExtensionSubcommand|CliCommandSetupSubcommand|void} [SubCmd=void]
  * @typedef {import('appium/types').Args<Cmd, SubCmd>} Args
  */
 
 /**
  * @template {CliCommand} [Cmd=ServerCommand]
- * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @template {CliExtensionSubcommand|CliCommandSetupSubcommand|void} [SubCmd=void]
  * @typedef {import('appium/types').ParsedArgs<Cmd, SubCmd>} ParsedArgs
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "2.5.3",
+  "version": "2.6.0",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -60,12 +60,12 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^9.5.4",
-    "@appium/base-plugin": "^2.2.30",
-    "@appium/docutils": "^1.0.6",
+    "@appium/base-driver": "^9.7.0",
+    "@appium/base-plugin": "^2.2.32",
+    "@appium/docutils": "^1.0.8",
     "@appium/schema": "~0.5.0",
-    "@appium/support": "^4.2.4",
-    "@appium/types": "^0.16.2",
+    "@appium/support": "^4.2.6",
+    "@appium/types": "^0.18.0",
     "@sidvind/better-ajv-errors": "2.1.3",
     "@types/argparse": "2.0.16",
     "@types/bluebird": "3.5.42",
@@ -73,12 +73,12 @@
     "@types/semver": "7.5.8",
     "@types/teen_process": "2.0.4",
     "@types/wrap-ansi": "3.0.0",
-    "ajv": "8.12.0",
+    "ajv": "8.14.0",
     "ajv-formats": "3.0.1",
     "argparse": "2.0.1",
     "async-lock": "1.4.1",
     "asyncbox": "3.0.0",
-    "axios": "1.6.8",
+    "axios": "1.7.2",
     "bluebird": "3.7.2",
     "cross-env": "7.0.3",
     "lilconfig": "3.1.1",
@@ -87,14 +87,14 @@
     "ora": "5.4.1",
     "package-changed": "3.0.0",
     "resolve-from": "5.0.0",
-    "semver": "7.6.0",
+    "semver": "7.6.2",
     "source-map-support": "0.5.21",
-    "teen_process": "2.1.1",
-    "type-fest": "4.10.1",
+    "teen_process": "2.1.3",
+    "type-fest": "4.18.3",
     "winston": "3.13.0",
     "wrap-ansi": "7.0.0",
-    "ws": "8.16.0",
-    "yaml": "2.4.1"
+    "ws": "8.17.0",
+    "yaml": "2.4.2"
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -103,5 +103,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "407706cf5e28d3471decde8b56c780d40952e8d5"
+  "gitHead": "a4138c6ec9524594519f29938008500b7cdcc0b8"
 }

package/types/cli.ts

@@ -2,6 +2,7 @@ import {DriverType, PluginType, ServerArgs} from '@appium/types';
 import {SetOptional} from 'type-fest';
 import {InstallType} from './manifest';
 export type CliCommandServer = 'server';
+export type CliCommandSetup = 'setup';
 export type CliCommandDriver = DriverType;
 export type CliCommandPlugin = PluginType;
 
@@ -13,7 +14,13 @@ export type CliExtensionCommand = CliCommandDriver | CliCommandPlugin;
 /**
  * Possible commands for the `appium` CLI.
  */
-export type CliCommand = CliCommandServer | CliExtensionCommand;
+export type CliCommand = CliCommandServer | CliExtensionCommand | CliCommandSetup;
+
+/**
+ * Possible subcommands of {@linkcode CliCommandSetup}.
+ * The command name will be preset name to get drivers/plugins to be installed.
+ */
+export type CliCommandSetupSubcommand = 'mobile' | 'browser' | 'desktop';
 
 /**
  * Possible subcommands of {@linkcode CliCommandDriver} or
@@ -55,6 +62,11 @@ export interface MoreArgs {
    */
   showConfig?: boolean;
 
+  /**
+   * If true, show the server debug info and exit
+   */
+  showDebugInfo?: boolean;
+
   /**
    * If true, open a REPL
    */
@@ -62,7 +74,7 @@ export interface MoreArgs {
 }
 
 /**
- * These arguments are _not_ supported by the CLI, but only via programmatic usage / tests.
+ * These arguments are not necessarily supported by the CLI, but via programmatic usage / tests.
  */
 export interface ProgrammaticArgs {
   /**
@@ -93,6 +105,11 @@ export interface ProgrammaticArgs {
    * If true, show config and exit
    */
   showConfig?: boolean;
+
+  /**
+   * If true, show debug info and exit
+   */
+  showDebugInfo?: boolean;
 }
 
 export interface DriverExtArgs {
@@ -105,6 +122,10 @@ export interface PluginExtArgs {
   plugin?: string;
 }
 
+export interface SetupArgs {
+  setupCommand?: CliCommandSetupSubcommand;
+}
+
 /**
  * These are args which the user will specify if using an extension command
  */
@@ -132,9 +153,11 @@ export interface BaseExtArgs<Cmd extends CliExtensionCommand> {
  */
 export type ExtArgs<
   Cmd extends CliExtensionCommand,
-  SubCmd extends CliExtensionSubcommand
+  SubCmd extends CliExtensionSubcommand | CliCommandSetupSubcommand
 > = BaseExtArgs<Cmd> &
-  (Cmd extends CliCommandDriver
+  (Cmd extends CliCommandSetup
+    ? SetupArgs
+    : Cmd extends CliCommandDriver
     ? DriverExtArgs
     : Cmd extends CliCommandPlugin
     ? PluginExtArgs
@@ -152,13 +175,15 @@ export type ExtArgs<
  */
 export type CommonArgs<
   Cmd extends CliCommand = CliCommandServer,
-  SubCmd extends CliExtensionSubcommand | void = void
+  SubCmd extends CliExtensionSubcommand | CliCommandSetupSubcommand | void = void
 > = MoreArgs &
   ProgrammaticArgs &
   (Cmd extends CliCommandServer
     ? ServerArgs
+    : Cmd extends CliCommandSetup
+    ? SetupArgs
     : Cmd extends CliExtensionCommand
-    ? SubCmd extends CliExtensionSubcommand
+    ? SubCmd extends CliExtensionSubcommand | CliCommandSetupSubcommand
       ? ExtArgs<Cmd, SubCmd>
       : never
     : never);
@@ -168,7 +193,7 @@ export type CommonArgs<
  */
 export type ParsedArgs<
   Cmd extends CliCommand = CliCommandServer,
-  SubCmd extends CliExtensionSubcommand | void = void
+  SubCmd extends CliExtensionSubcommand | CliCommandSetupSubcommand | void = void
 > = CommonArgs<Cmd, SubCmd>;
 
 /**
@@ -178,7 +203,7 @@ export type ParsedArgs<
  */
 export type Args<
   Cmd extends CliCommand = CliCommandServer,
-  SubCmd extends CliExtensionSubcommand | void = void
+  SubCmd extends CliExtensionSubcommand | CliCommandSetupSubcommand | void = void
 > = Cmd extends CliCommandServer
   ? SetOptional<CommonArgs<Cmd>, keyof ServerArgs>
   : ParsedArgs<Cmd, SubCmd>;