appium 2.0.0-beta.46 → 2.0.0-beta.48

package/build/types/cli.d.ts

@@ -1,25 +1,42 @@
-import { ServerArgs } from '@appium/types';
-export declare type ServerSubcommand = 'server';
-export declare type DriverSubcommand = 'driver';
-export declare type PluginSubcommand = 'plugin';
+import { DriverType, PluginType, ServerArgs } from '@appium/types';
+import { SetOptional } from 'type-fest';
+import { InstallType } from './manifest';
+export declare type ServerCommand = 'server';
+export declare type DriverCommand = DriverType;
+export declare type PluginCommand = PluginType;
 /**
- * Possible subcommands for the `appium` CLI.
+ * Extension-specific commands
  */
-export declare type CliSubcommand = ServerSubcommand | DriverSubcommand | PluginSubcommand;
+export declare type CliExtensionCommand = DriverCommand | PluginCommand;
 /**
- * Possible subcommands of {@linkcode DriverSubcommand} or
- * {@linkcode PluginSubcommand}.
+ * Possible commands for the `appium` CLI.
+ */
+export declare type CliCommand = ServerCommand | CliExtensionCommand;
+/**
+ * Possible subcommands of {@linkcode DriverCommand} or
+ * {@linkcode PluginCommand}.
  */
 export declare type CliExtensionSubcommand = 'install' | 'list' | 'run' | 'uninstall' | 'update';
+export interface CliExtensionSubcommandListArgs {
+    showInstalled?: boolean;
+    showUpdates?: boolean;
+}
+export interface CliExtensionSubcommandInstallArgs {
+    installType: InstallType;
+    packageName?: string;
+}
+export interface CliExtensionSubcommandUpdateArgs {
+    unsafe?: boolean;
+}
 /**
  * Random stuff that may appear in the parsed args which has no equivalent in a
  * config file.
  */
 export interface MoreArgs {
     /**
-     * Possible subcommands. If empty, defaults to {@linkcode ServerSubcommand}.
+     * Possible subcommands. If empty, defaults to {@linkcode ServerCommand}.
      */
-    subcommand?: CliSubcommand;
+    subcommand?: CliCommand;
     /**
      * Path to config file, if any. Does not make sense for this to be allowed in a config file!
      */
@@ -62,18 +79,19 @@ export interface ProgrammaticArgs {
      */
     showConfig?: boolean;
 }
+export interface DriverExtArgs {
+    driverCommand: CliExtensionSubcommand;
+    driver?: string;
+}
+export interface PluginExtArgs {
+    pluginCommand: CliExtensionSubcommand;
+    plugin?: string;
+}
 /**
  * These are args which the user will specify if using an extension command
  */
-export interface ExtArgs extends WithExtSubcommand {
-    /**
-     * Subcommands of `driver` subcommand
-     */
-    driverCommand?: CliExtensionSubcommand;
-    /**
-     * Subcommands of `plugin` subcommand
-     */
-    pluginCommand?: CliExtensionSubcommand;
+export interface BaseExtArgs<Cmd extends CliExtensionCommand> {
+    subcommand: Cmd;
     /**
      * Output JSON instead of human-readable text
      */
@@ -88,29 +106,23 @@ export interface ExtArgs extends WithExtSubcommand {
     extraArgs?: string[];
 }
 /**
- * Args having the `server` subcommand
+ * Args for extension commands; includes a subcommand
  */
-export interface WithServerSubcommand {
-    subcommand?: ServerSubcommand;
-}
-/**
- * Args having the `driver` or `plugin` subcommand
- */
-export interface WithExtSubcommand {
-    subcommand: DriverSubcommand | PluginSubcommand;
-}
+export declare type ExtArgs<Cmd extends CliExtensionCommand, SubCmd extends CliExtensionSubcommand> = BaseExtArgs<Cmd> & (Cmd extends DriverCommand ? DriverExtArgs : Cmd extends PluginCommand ? PluginExtArgs : never) & (SubCmd extends 'install' ? CliExtensionSubcommandInstallArgs : SubCmd extends 'list' ? CliExtensionSubcommandListArgs : SubCmd extends 'update' ? CliExtensionSubcommandUpdateArgs : never);
 /**
  * Some generic bits of arguments; should not be used outside this declaration
  */
-declare type CommonArgs<SArgs, T = WithServerSubcommand> = MoreArgs & ProgrammaticArgs & (T extends WithServerSubcommand ? SArgs : T extends WithExtSubcommand ? ExtArgs : never);
+export declare type CommonArgs<Cmd extends CliCommand = ServerCommand, SubCmd extends CliExtensionSubcommand | void = void> = MoreArgs & ProgrammaticArgs & (Cmd extends ServerCommand ? ServerArgs : Cmd extends CliExtensionCommand ? SubCmd extends CliExtensionSubcommand ? ExtArgs<Cmd, SubCmd> : never : never);
 /**
  * Fully-parsed arguments, containing defaults, computed args, and config file values.
  */
-export declare type ParsedArgs<T = WithServerSubcommand> = CommonArgs<ServerArgs, T>;
+export declare type ParsedArgs<Cmd extends CliCommand = ServerCommand, SubCmd extends CliExtensionSubcommand | void = void> = CommonArgs<Cmd, SubCmd>;
 /**
- * Partial arguments, as supplied by a user. _May_ have defaults applied; _may_ contain config values; _may_ contain computed args.
+ * Like {@linkcode ParsedArgs} except server arguments are all optional.
+ *
+ * _May_ have defaults applied; _may_ contain config values; _may_ contain computed args.
  */
-export declare type Args<T = WithServerSubcommand> = CommonArgs<Partial<ServerArgs>, T>;
+export declare type Args<Cmd extends CliCommand = ServerCommand, SubCmd extends CliExtensionSubcommand | void = void> = Cmd extends ServerCommand ? SetOptional<CommonArgs<Cmd>, keyof ServerArgs> : ParsedArgs<Cmd, SubCmd>;
 /**
  * Shown by `appium --build-info`
  */
@@ -119,5 +131,4 @@ export declare type BuildInfo = {
     'git-sha'?: string;
     built?: string;
 };
-export {};
 //# sourceMappingURL=cli.d.ts.map

package/build/types/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../types/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AACzC,oBAAY,gBAAgB,GAAG,QAAQ,CAAC;AACxC,oBAAY,gBAAgB,GAAG,QAAQ,CAAC;AACxC,oBAAY,gBAAgB,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACH,oBAAY,aAAa,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEnF;;;GAGG;AACH,oBAAY,sBAAsB,GAC9B,SAAS,GACT,MAAM,GACN,KAAK,GACL,WAAW,GACX,QAAQ,CAAC;AAEb;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;IAE3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAEtC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,iBAAiB;IAChD;;OAEG;IACH,aAAa,CAAC,EAAE,sBAAsB,CAAC;IAEvC;;OAEG;IACH,aAAa,CAAC,EAAE,sBAAsB,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,gBAAgB,GAAG,gBAAgB,CAAC;CACjD;AAED;;GAEG;AACH,aAAK,UAAU,CAAC,KAAK,EAAE,CAAC,GAAG,oBAAoB,IAAI,QAAQ,GACzD,gBAAgB,GAChB,CAAC,CAAC,SAAS,oBAAoB,GAAG,KAAK,GAAG,CAAC,SAAS,iBAAiB,GAAG,OAAO,GAAG,KAAK,CAAC,CAAC;AAE3F;;GAEG;AACH,oBAAY,UAAU,CAAC,CAAC,GAAG,oBAAoB,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;AAE7E;;GAEG;AACH,oBAAY,IAAI,CAAC,CAAC,GAAG,oBAAoB,IAAI,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;AAEhF;;GAEG;AACH,oBAAY,SAAS,GAAG;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../types/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,UAAU,EAAE,UAAU,EAAC,MAAM,eAAe,CAAC;AACjE,OAAO,EAAC,WAAW,EAAC,MAAM,WAAW,CAAC;AACtC,OAAO,EAAC,WAAW,EAAC,MAAM,YAAY,CAAC;AACvC,oBAAY,aAAa,GAAG,QAAQ,CAAC;AACrC,oBAAY,aAAa,GAAG,UAAU,CAAC;AACvC,oBAAY,aAAa,GAAG,UAAU,CAAC;AAEvC;;GAEG;AACH,oBAAY,mBAAmB,GAAG,aAAa,GAAG,aAAa,CAAC;AAEhE;;GAEG;AACH,oBAAY,UAAU,GAAG,aAAa,GAAG,mBAAmB,CAAC;AAE7D;;;GAGG;AACH,oBAAY,sBAAsB,GAAG,SAAS,GAAG,MAAM,GAAG,KAAK,GAAG,WAAW,GAAG,QAAQ,CAAC;AAEzF,MAAM,WAAW,8BAA8B;IAC7C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,iCAAiC;IAChD,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gCAAgC;IAC/C,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAEtC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,sBAAsB,CAAC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,sBAAsB,CAAC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,GAAG,SAAS,mBAAmB;IAC1D,UAAU,EAAE,GAAG,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,oBAAY,OAAO,CACjB,GAAG,SAAS,mBAAmB,EAC/B,MAAM,SAAS,sBAAsB,IACnC,WAAW,CAAC,GAAG,CAAC,GAClB,CAAC,GAAG,SAAS,aAAa,GAAG,aAAa,GAAG,GAAG,SAAS,aAAa,GAAG,aAAa,GAAG,KAAK,CAAC,GAC/F,CAAC,MAAM,SAAS,SAAS,GACrB,iCAAiC,GACjC,MAAM,SAAS,MAAM,GACrB,8BAA8B,GAC9B,MAAM,SAAS,QAAQ,GACvB,gCAAgC,GAChC,KAAK,CAAC,CAAC;AAEb;;GAEG;AACH,oBAAY,UAAU,CACpB,GAAG,SAAS,UAAU,GAAG,aAAa,EACtC,MAAM,SAAS,sBAAsB,GAAG,IAAI,GAAG,IAAI,IACjD,QAAQ,GACV,gBAAgB,GAChB,CAAC,GAAG,SAAS,aAAa,GACtB,UAAU,GACV,GAAG,SAAS,mBAAmB,GAC/B,MAAM,SAAS,sBAAsB,GACnC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,GACpB,KAAK,GACP,KAAK,CAAC,CAAC;AAEb;;GAEG;AACH,oBAAY,UAAU,CACpB,GAAG,SAAS,UAAU,GAAG,aAAa,EACtC,MAAM,SAAS,sBAAsB,GAAG,IAAI,GAAG,IAAI,IACjD,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;AAE5B;;;;GAIG;AACH,oBAAY,IAAI,CACd,GAAG,SAAS,UAAU,GAAG,aAAa,EACtC,MAAM,SAAS,sBAAsB,GAAG,IAAI,GAAG,IAAI,IACjD,GAAG,SAAS,aAAa,GACzB,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,MAAM,UAAU,CAAC,GAC9C,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;AAE5B;;GAEG;AACH,oBAAY,SAAS,GAAG;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/build/types/cli.js

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

package/build/types/cli.js.map

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

package/build/types/index.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 import { ExtensionType, DriverType, DriverClass, PluginType, PluginClass } from '@appium/types';
-export * from './appium-manifest';
-export * from './extension-manifest';
+export * from './manifest';
 export * from './cli';
 /**
  * Known environment variables concerning Appium

package/build/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../types/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAC,MAAM,eAAe,CAAC;AAE9F,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,OAAO,CAAC;AAEtB;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,MAAM,CAAC,UAAU;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,oBAAY,QAAQ,CAAC,OAAO,SAAS,aAAa,IAAI,OAAO,SAAS,UAAU,GAC5E,WAAW,GACX,OAAO,SAAS,UAAU,GAC1B,WAAW,GACX,KAAK,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../types/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAC,MAAM,eAAe,CAAC;AAE9F,cAAc,YAAY,CAAC;AAC3B,cAAc,OAAO,CAAC;AAEtB;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,MAAM,CAAC,UAAU;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,oBAAY,QAAQ,CAAC,OAAO,SAAS,aAAa,IAAI,OAAO,SAAS,UAAU,GAC5E,WAAW,GACX,OAAO,SAAS,UAAU,GAC1B,WAAW,GACX,KAAK,CAAC"}

package/build/types/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./manifest"), exports);
+__exportStar(require("./cli"), exports);
+//# sourceMappingURL=index.js.map

package/build/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAEA,6CAA2B;AAC3B,wCAAsB"}

package/build/types/manifest/base.d.ts

@@ -0,0 +1,135 @@
+import { DriverType, ExtensionType, PluginType } from '@appium/types';
+import { SchemaObject } from 'ajv';
+import { PackageJson, SetRequired } from 'type-fest';
+/**
+ * One of the possible extension installation stratgies
+ */
+export declare type InstallType = 'npm' | 'git' | 'local' | 'github';
+export interface InternalMetadata {
+    /**
+     * Package name of extension
+     *
+     * `name` from its `package.json`
+     */
+    pkgName: string;
+    /**
+     * Version of extension
+     *
+     * `version` from its `package.json`
+     */
+    version: string;
+    /**
+     * The method in which the user installed the extension (the `source` CLI arg)
+     */
+    installType: InstallType;
+    /**
+     * Whatever the user typed as the extension to install. May be derived from `package.json`
+     */
+    installSpec: string;
+    /**
+     * Maximum version of Appium that this extension is compatible with.
+     *
+     * If `undefined`, we'll try anyway.
+     */
+    appiumVersion?: string;
+}
+/**
+ * Shape of the `appium.schema` property in an extension's `package.json` (if it exists)
+ */
+export declare type ExtSchemaMetadata = string | (SchemaObject & {
+    [key: number]: never;
+});
+/**
+ * Manifest data shared by all extensions, as contained in `package.json`
+ */
+export interface CommonExtMetadata {
+    /**
+     * The main class of the extension.
+     *
+     * The extension must export this class by name.
+     */
+    mainClass: string;
+    /**
+     * Lookup table of scripts to run via `appium <driver|plugin> run <script>` keyed by name.
+     */
+    scripts?: Record<string, string>;
+    /**
+     * Schema describing configuration options (and CLI args) for the extension.
+     *
+     * Can also just be a path (relative to the extension root) to an external JSON schema file.
+     */
+    schema?: ExtSchemaMetadata;
+}
+/**
+ * Driver-specific manifest data as stored in a driver's `package.json`
+ */
+export interface DriverMetadata {
+    /**
+     * Automation name of the driver
+     */
+    automationName: string;
+    /**
+     * Platforms the driver supports
+     */
+    platformNames: string[];
+    /**
+     * Short name of the driver (displayed in `appium list`, etc.)
+     */
+    driverName: string;
+}
+/**
+ * Plugin-specific manifest data as stored in a plugin's `package.json`
+ */
+export interface PluginMetadata {
+    /**
+     * Short name of the plugin (displayed in `appium list`, etc.)
+     */
+    pluginName: string;
+}
+/**
+ * Generic extension metadata as stored in the `appium` prop of an extension's `package.json`.
+ */
+export declare type ExtMetadata<ExtType extends ExtensionType> = (ExtType extends DriverType ? DriverMetadata : ExtType extends PluginType ? PluginMetadata : never) & CommonExtMetadata;
+/**
+ * Combination of external + internal extension data with `driverName`/`pluginName` removed (it becomes a key in an {@linkcode ExtRecord} object).
+ * Part of `extensions.yaml`.
+ */
+export declare type ExtManifest<ExtType extends ExtensionType> = Omit<ExtMetadata<ExtType>, 'driverName' | 'pluginName'> & InternalMetadata;
+/**
+ * Lookup of extension name to {@linkcode ExtManifest}.
+ * @see {ManifestData}
+ */
+export declare type ExtRecord<ExtType extends ExtensionType> = Record<string, ExtManifest<ExtType>>;
+/**
+ * The shape of the `extensions.yaml` file
+ */
+export interface ManifestData {
+    drivers: ExtRecord<DriverType>;
+    plugins: ExtRecord<PluginType>;
+    schemaRev?: number;
+}
+/**
+ * The name of an installed extension, as it appears in `extensions.yaml`
+ * (as a property name under `drivers` or `plugins`)
+ */
+export declare type ExtName<ExtType extends ExtensionType> = keyof ExtRecord<ExtType>;
+/**
+ * A `package.json` containing extension metadata.
+ * Must have the following properties:
+ * - `name`: the name of the extension
+ * - `version`: the version of the extension
+ * - `appium`: the metadata for the extension
+ * - `peerDependencies.appium`: the maximum compatible version of Appium
+ */
+export declare type ExtPackageJson<ExtType extends ExtensionType> = SetRequired<PackageJson, 'name' | 'version'> & {
+    appium: ExtMetadata<ExtType>;
+    peerDependencies: {
+        appium: string;
+        [key: string]: string;
+    };
+};
+/**
+ * A transient format between installation and insertion of extension metadata into the manifest.
+ */
+export declare type ExtInstallReceipt<ExtType extends ExtensionType> = ExtMetadata<ExtType> & InternalMetadata;
+//# sourceMappingURL=base.d.ts.map

package/build/types/manifest/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../types/manifest/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,aAAa,EAAE,UAAU,EAAC,MAAM,eAAe,CAAC;AACpE,OAAO,EAAC,YAAY,EAAC,MAAM,KAAK,CAAC;AACjC,OAAO,EAAC,WAAW,EAAE,WAAW,EAAC,MAAM,WAAW,CAAC;AAEnD;;GAEG;AACH,oBAAY,WAAW,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE7D,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,oBAAY,iBAAiB,GAAG,MAAM,GAAG,CAAC,YAAY,GAAG;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAA;CAAC,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;;OAIG;IAEH,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,oBAAY,WAAW,CAAC,OAAO,SAAS,aAAa,IAAI,CAAC,OAAO,SAAS,UAAU,GAChF,cAAc,GACd,OAAO,SAAS,UAAU,GAC1B,cAAc,GACd,KAAK,CAAC,GACR,iBAAiB,CAAC;AAEpB;;;GAGG;AACH,oBAAY,WAAW,CAAC,OAAO,SAAS,aAAa,IAAI,IAAI,CAC3D,WAAW,CAAC,OAAO,CAAC,EACpB,YAAY,GAAG,YAAY,CAC5B,GACC,gBAAgB,CAAC;AAEnB;;;GAGG;AACH,oBAAY,SAAS,CAAC,OAAO,SAAS,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;IAC/B,OAAO,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,OAAO,CAAC,OAAO,SAAS,aAAa,IAAI,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;AAE9E;;;;;;;GAOG;AACH,oBAAY,cAAc,CAAC,OAAO,SAAS,aAAa,IAAI,WAAW,CACrE,WAAW,EACX,MAAM,GAAG,SAAS,CACnB,GAAG;IACF,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IAC7B,gBAAgB,EAAE;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAC;CAC3D,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB,CAAC,OAAO,SAAS,aAAa,IAAI,WAAW,CAAC,OAAO,CAAC,GACjF,gBAAgB,CAAC"}

package/build/types/manifest/base.js

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

package/build/types/manifest/base.js.map

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

package/build/types/manifest/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * See `README.md` for information on how to add a new version of the schema.
+ * @module
+ */
+import * as ManifestV2 from './base';
+import * as ManifestV3 from './v3';
+export * from './v3';
+export { ManifestV2, ManifestV3 };
+export interface ManifestDataVersions {
+    2: ManifestV2.ManifestData;
+    3: ManifestV3.ManifestData;
+}
+/**
+ * One of the known versions of the `extensions.yaml` schema.
+ *
+ * @privateRemarks You probably don't need to edit this.
+ */
+export declare type AnyManifestDataVersion = ManifestDataVersions[keyof ManifestDataVersions];
+//# sourceMappingURL=index.d.ts.map

package/build/types/manifest/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../types/manifest/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,UAAU,MAAM,QAAQ,CAAC;AACrC,OAAO,KAAK,UAAU,MAAM,MAAM,CAAC;AAInC,cAAc,MAAM,CAAC;AAGrB,OAAO,EAAC,UAAU,EAAE,UAAU,EAAC,CAAC;AAEhC,MAAM,WAAW,oBAAoB;IACnC,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC;IAC3B,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC;CAC5B;AAGD;;;;GAIG;AACH,oBAAY,sBAAsB,GAAG,oBAAoB,CAAC,MAAM,oBAAoB,CAAC,CAAC"}

package/build/types/manifest/index.js

@@ -0,0 +1,40 @@
+"use strict";
+/**
+ * See `README.md` for information on how to add a new version of the schema.
+ * @module
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestV3 = exports.ManifestV2 = void 0;
+const ManifestV2 = __importStar(require("./base"));
+exports.ManifestV2 = ManifestV2;
+const ManifestV3 = __importStar(require("./v3"));
+exports.ManifestV3 = ManifestV3;
+// add `import * as ManifestV<new-version> from './v<new-version>';` above
+__exportStar(require("./v3"), exports);
+//# sourceMappingURL=index.js.map

package/build/types/manifest/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../types/manifest/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,mDAAqC;AAQ7B,gCAAU;AAPlB,iDAAmC;AAOf,gCAAU;AAL9B,0EAA0E;AAE1E,uCAAqB"}

package/build/types/manifest/v3.d.ts

@@ -0,0 +1,139 @@
+import { DriverType, ExtensionType, PluginType } from '@appium/types';
+import { SchemaObject } from 'ajv';
+import { PackageJson, SetRequired } from 'type-fest';
+/**
+ * One of the possible extension installation stratgies
+ */
+export declare type InstallType = 'npm' | 'git' | 'local' | 'github';
+export interface InternalMetadata {
+    /**
+     * Package name of extension
+     *
+     * `name` from its `package.json`
+     */
+    pkgName: string;
+    /**
+     * Version of extension
+     *
+     * `version` from its `package.json`
+     */
+    version: string;
+    /**
+     * The method in which the user installed the extension (the `source` CLI arg)
+     */
+    installType: InstallType;
+    /**
+     * Whatever the user typed as the extension to install. May be derived from `package.json`
+     */
+    installSpec: string;
+    /**
+     * Maximum version of Appium that this extension is compatible with.
+     *
+     * If `undefined`, we'll try anyway.
+     */
+    appiumVersion?: string;
+    /**
+     * Path to the extension's root directory
+     */
+    installPath: string;
+}
+/**
+ * Shape of the `appium.schema` property in an extension's `package.json` (if it exists)
+ */
+export declare type ExtSchemaMetadata = string | (SchemaObject & {
+    [key: number]: never;
+});
+/**
+ * Manifest data shared by all extensions, as contained in `package.json`
+ */
+export interface CommonExtMetadata {
+    /**
+     * The main class of the extension.
+     *
+     * The extension must export this class by name.
+     */
+    mainClass: string;
+    /**
+     * Lookup table of scripts to run via `appium <driver|plugin> run <script>` keyed by name.
+     */
+    scripts?: Record<string, string>;
+    /**
+     * Schema describing configuration options (and CLI args) for the extension.
+     *
+     * Can also just be a path (relative to the extension root) to an external JSON schema file.
+     */
+    schema?: ExtSchemaMetadata;
+}
+/**
+ * Driver-specific manifest data as stored in a driver's `package.json`
+ */
+export interface DriverMetadata {
+    /**
+     * Automation name of the driver
+     */
+    automationName: string;
+    /**
+     * Platforms the driver supports
+     */
+    platformNames: string[];
+    /**
+     * Short name of the driver (displayed in `appium list`, etc.)
+     */
+    driverName: string;
+}
+/**
+ * Plugin-specific manifest data as stored in a plugin's `package.json`
+ */
+export interface PluginMetadata {
+    /**
+     * Short name of the plugin (displayed in `appium list`, etc.)
+     */
+    pluginName: string;
+}
+/**
+ * Generic extension metadata as stored in the `appium` prop of an extension's `package.json`.
+ */
+export declare type ExtMetadata<ExtType extends ExtensionType> = (ExtType extends DriverType ? DriverMetadata : ExtType extends PluginType ? PluginMetadata : never) & CommonExtMetadata;
+/**
+ * Combination of external + internal extension data with `driverName`/`pluginName` removed (it becomes a key in an {@linkcode ExtRecord} object).
+ * Part of `extensions.yaml`.
+ */
+export declare type ExtManifest<ExtType extends ExtensionType> = Omit<ExtMetadata<ExtType>, 'driverName' | 'pluginName'> & InternalMetadata;
+/**
+ * Lookup of extension name to {@linkcode ExtManifest}.
+ * @see {ManifestData}
+ */
+export declare type ExtRecord<ExtType extends ExtensionType> = Record<string, ExtManifest<ExtType>>;
+/**
+ * The shape of the `extensions.yaml` file
+ */
+export interface ManifestData {
+    drivers: ExtRecord<DriverType>;
+    plugins: ExtRecord<PluginType>;
+    schemaRev: number;
+}
+/**
+ * The name of an installed extension, as it appears in `extensions.yaml`
+ * (as a property name under `drivers` or `plugins`)
+ */
+export declare type ExtName<ExtType extends ExtensionType> = keyof ExtRecord<ExtType>;
+/**
+ * A `package.json` containing extension metadata.
+ * Must have the following properties:
+ * - `name`: the name of the extension
+ * - `version`: the version of the extension
+ * - `appium`: the metadata for the extension
+ * - `peerDependencies.appium`: the maximum compatible version of Appium
+ */
+export declare type ExtPackageJson<ExtType extends ExtensionType> = SetRequired<PackageJson, 'name' | 'version'> & {
+    appium: ExtMetadata<ExtType>;
+    peerDependencies: {
+        appium: string;
+        [key: string]: string;
+    };
+};
+/**
+ * A transient format between installation and insertion of extension metadata into the manifest.
+ */
+export declare type ExtInstallReceipt<ExtType extends ExtensionType> = ExtMetadata<ExtType> & InternalMetadata;
+//# sourceMappingURL=v3.d.ts.map

package/build/types/manifest/v3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v3.d.ts","sourceRoot":"","sources":["../../../types/manifest/v3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,aAAa,EAAE,UAAU,EAAC,MAAM,eAAe,CAAC;AACpE,OAAO,EAAC,YAAY,EAAC,MAAM,KAAK,CAAC;AACjC,OAAO,EAAC,WAAW,EAAE,WAAW,EAAC,MAAM,WAAW,CAAC;AAEnD;;GAEG;AACH,oBAAY,WAAW,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE7D,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,oBAAY,iBAAiB,GAAG,MAAM,GAAG,CAAC,YAAY,GAAG;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAA;CAAC,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;;OAIG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,oBAAY,WAAW,CAAC,OAAO,SAAS,aAAa,IAAI,CAAC,OAAO,SAAS,UAAU,GAChF,cAAc,GACd,OAAO,SAAS,UAAU,GAC1B,cAAc,GACd,KAAK,CAAC,GACR,iBAAiB,CAAC;AAEpB;;;GAGG;AACH,oBAAY,WAAW,CAAC,OAAO,SAAS,aAAa,IAAI,IAAI,CAC3D,WAAW,CAAC,OAAO,CAAC,EACpB,YAAY,GAAG,YAAY,CAC5B,GACC,gBAAgB,CAAC;AAEnB;;;GAGG;AACH,oBAAY,SAAS,CAAC,OAAO,SAAS,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;IAC/B,OAAO,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,oBAAY,OAAO,CAAC,OAAO,SAAS,aAAa,IAAI,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;AAE9E;;;;;;;GAOG;AACH,oBAAY,cAAc,CAAC,OAAO,SAAS,aAAa,IAAI,WAAW,CACrE,WAAW,EACX,MAAM,GAAG,SAAS,CACnB,GAAG;IACF,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IAC7B,gBAAgB,EAAE;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAC;CAC3D,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB,CAAC,OAAO,SAAS,aAAa,IAAI,WAAW,CAAC,OAAO,CAAC,GACjF,gBAAgB,CAAC"}

package/build/types/manifest/v3.js

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

package/build/types/manifest/v3.js.map

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

package/lib/appium.js

@@ -306,7 +306,7 @@ class AppiumDriver extends DriverCore {
       // Likewise, any driver-specific CLI args that were passed in should be assigned directly to
       // the driver so that they cannot be mimicked by a malicious user sending in capabilities
       const cliArgs = this.getCliArgsForDriver(driverName);
-      if (!_.isEmpty(cliArgs)) {
+      if (!_.isUndefined(cliArgs)) {
         driverInstance.cliArgs = cliArgs;
       }
 

package/lib/cli/args.js

@@ -269,7 +269,7 @@ const serverArgsDisallowedInConfig = new Map([
     ['--config'],
     {
       dest: 'configFile',
-      type: 'string',
+      type: 'str',
       required: false,
       help: 'Explicit path to Appium configuration file',
     },

package/lib/cli/driver-command.js

@@ -17,6 +17,11 @@ export default class DriverCommand extends ExtensionCommand {
     this.knownExtensions = KNOWN_DRIVERS;
   }
 
+  /**
+   * Install a driver
+   *
+   * @param {DriverInstallOpts} opts
+   */
   async install({driver, installType, packageName}) {
     return await super._install({
       installSpec: driver,
@@ -78,3 +83,15 @@ export default class DriverCommand extends ExtensionCommand {
 /**
  * @typedef {import('@appium/types').DriverType} DriverType
  */
+
+/**
+ * Options for {@linkcode ExtensionCommand._install}
+ * @typedef DriverInstallOpts
+ * @property {string} driver - the name or spec of a driver to install
+ * @property {InstallType} installType - how to install this driver. One of the INSTALL_TYPES
+ * @property {string} [packageName] - for git/github installs, the driver node package name
+ */
+
+/**
+ * @typedef {import('appium/types').InstallType} InstallType
+ */