appium 2.0.0-beta.30 → 2.0.0-beta.33

package/types/{cli.d.ts → cli.ts}

@@ -1,5 +1,5 @@
-import { DriverOpts } from '@appium/types';
-import {
+import {ServerArgs} from '@appium/types';
+import type {
   DRIVER_TYPE as DRIVER_SUBCOMMAND,
   EXT_SUBCOMMAND_INSTALL,
   EXT_SUBCOMMAND_LIST,
@@ -10,17 +10,21 @@ import {
   SERVER_SUBCOMMAND,
 } from '../lib/constants';
 
+export type ServerSubcommand = typeof SERVER_SUBCOMMAND;
+export type DriverSubcommand = typeof DRIVER_SUBCOMMAND;
+export type PluginSubcommand = typeof PLUGIN_SUBCOMMAND;
+
 /**
  * Possible subcommands for the `appium` CLI.
  */
-type CliSubcommand =
-  | typeof SERVER_SUBCOMMAND
-  | typeof DRIVER_SUBCOMMAND
-  | typeof PLUGIN_SUBCOMMAND;
+export type CliSubcommand =
+  | ServerSubcommand
+  | DriverSubcommand
+  | PluginSubcommand;
 
 /**
- * Possible subcommands of {@link DRIVER_SUBCOMMAND} or
- * {@link PLUGIN_SUBCOMMAND}.
+ * Possible subcommands of {@linkcode DriverSubcommand} or
+ * {@linkcode PluginSubcommand}.
  */
 export type CliExtensionSubcommand =
   | typeof EXT_SUBCOMMAND_INSTALL
@@ -33,7 +37,12 @@ export type CliExtensionSubcommand =
  * Random stuff that may appear in the parsed args which has no equivalent in a
  * config file.
  */
-interface MoreArgs {
+export interface MoreArgs {
+  /**
+   * Possible subcommands. If empty, defaults to {@linkcode ServerSubcommand}.
+   */
+  subcommand?: CliSubcommand;
+
   /**
    * Path to config file, if any. Does not make sense for this to be allowed in a config file!
    */
@@ -53,7 +62,7 @@ interface MoreArgs {
 /**
  * These arguments are _not_ supported by the CLI, but only via programmatic usage / tests.
  */
-interface ProgrammaticArgs {
+export interface ProgrammaticArgs {
   /**
    * If `true`, throw on error instead of exit.
    */
@@ -85,9 +94,9 @@ interface ProgrammaticArgs {
 }
 
 /**
- * These are args that Appium assigns while parsing the args.
+ * These are args which the user will specify if using an extension command
  */
-interface InternalArgs {
+export interface ExtArgs extends WithExtSubcommand {
   /**
    * Subcommands of `driver` subcommand
    */
@@ -97,32 +106,42 @@ interface InternalArgs {
    * Subcommands of `plugin` subcommand
    */
   pluginCommand?: CliExtensionSubcommand;
+}
 
-  /**
-   * Possible subcommands
-   */
-  subcommand: CliSubcommand;
+/**
+ * Args having the `server` subcommand
+ */
+export interface WithServerSubcommand {
+  subcommand?: ServerSubcommand;
 }
 
 /**
- * The same as {@link ParsedArgs} but with a nullable `subcommand`.
- * This is _not_ the same as `Partial<ParsedArgs>`.
+ * Args having the `driver` or `plugin` subcommand
  */
-export type PartialArgs = DriverOpts &
-  MoreArgs &
-  ProgrammaticArgs &
-  Partial<InternalArgs>;
+export interface WithExtSubcommand {
+  subcommand: DriverSubcommand | PluginSubcommand;
+}
 
 /**
- * The Appium configuration as a flattened object, parsed via CLI args _and_ any
- * CLI args unsupported by the config file.
- * @todo Does not make any assumptions about property names derived from
- * extensions.
+ * Some generic bits of arguments; should not be used outside this declaration
  */
-export type ParsedArgs = DriverOpts &
-  MoreArgs &
+type CommonArgs<SArgs, T = WithServerSubcommand> = MoreArgs &
   ProgrammaticArgs &
-  InternalArgs;
+  (T extends WithServerSubcommand
+    ? SArgs
+    : T extends WithExtSubcommand
+    ? ExtArgs
+    : never);
+
+/**
+ * Fully-parsed arguments, containing defaults, computed args, and config file values.
+ */
+export type ParsedArgs<T = WithServerSubcommand> = CommonArgs<ServerArgs, T>;
+
+/**
+ * Partial arguments, as supplied by a user. _May_ have defaults applied; _may_ contain config values; _may_ contain computed args.
+ */
+export type Args<T = WithServerSubcommand> = CommonArgs<Partial<ServerArgs>, T>;
 
 /**
  * Shown by `appium --build-info`

package/types/{extension.d.ts → extension.ts}

@@ -1,4 +1,4 @@
-import { BaseDriverBase } from '@appium/base-driver/lib/basedriver/driver';
+import type { BaseDriverBase } from '@appium/base-driver/lib/basedriver/driver';
 import { Class, Driver, ExternalDriver } from '@appium/types';
 import { DriverType, ExtensionType, PluginType } from '.';
 
@@ -8,7 +8,7 @@ export type DriverClass = BaseDriverBase<ExternalDriver,
 /**
  * Additional static props for external driver classes
  */
-interface ExternalDriverStatic {
+export interface ExternalDriverStatic {
   driverName: string;
 }
 
@@ -20,7 +20,7 @@ export type PluginClass = Class<PluginProto, ExternalPluginStatic>;
 /**
  * Static props for plugin classes
  */
-interface ExternalPluginStatic {
+export interface ExternalPluginStatic {
   pluginName: string;
 }
 
@@ -28,7 +28,7 @@ interface ExternalPluginStatic {
  * A plugin must have this shape.
  * @todo Use base plugin instead of this
  */
-interface PluginProto {
+export interface PluginProto {
   /**
    * I'm not sure why `plugin.name` is required, but it is.
    */

package/types/{external-manifest.d.ts → external-manifest.ts}

@@ -2,8 +2,8 @@
  * These types describe information about external extensions and the contents of their `package.json` files
  */
 
-import { SchemaObject } from 'ajv';
-import { PackageJson, SetRequired } from 'type-fest';
+import type { SchemaObject } from 'ajv';
+import type { PackageJson, SetRequired } from 'type-fest';
 import { DriverType, ExtensionType, PluginType } from './index';
 
 /**

package/types/{index.d.ts → index.ts}

@@ -5,3 +5,10 @@ export * from './cli';
 export type DriverType = 'driver';
 export type PluginType = 'plugin';
 export type ExtensionType = DriverType | PluginType;
+
+/**
+ * Known environment variables concerning Appium
+ */
+export interface AppiumEnv extends NodeJS.ProcessEnv {
+  APPIUM_HOME?: string;
+}