appium 2.0.0-beta.48 → 2.0.0-beta.52

package/lib/cli/driver-command.js

@@ -8,6 +8,7 @@ const REQ_DRIVER_FIELDS = ['driverName', 'automationName', 'platformNames', 'mai
 /**
  * @extends {ExtensionCommand<DriverType>}
  */
+
 export default class DriverCommand extends ExtensionCommand {
   /**
    * @param {import('./extension-command').ExtensionCommandOptions<DriverType>} opts
@@ -21,6 +22,7 @@ export default class DriverCommand extends ExtensionCommand {
    * Install a driver
    *
    * @param {DriverInstallOpts} opts
+   * @return {Promise<ExtRecord<DriverType>>}
    */
   async install({driver, installType, packageName}) {
     return await super._install({
@@ -30,18 +32,40 @@ export default class DriverCommand extends ExtensionCommand {
     });
   }
 
+  /**
+   * Uninstall a driver
+   *
+   * @param {DriverUninstallOpts} opts
+   * @return {Promise<ExtRecord<DriverType>>}
+   */
   async uninstall({driver}) {
     return await super._uninstall({installSpec: driver});
   }
 
+  /**
+   * Update a driver
+   *
+   * @param {DriverUpdateOpts} opts
+   * @return {Promise<import('./extension-command').ExtensionUpdateResult>}
+   */
   async update({driver, unsafe}) {
     return await super._update({installSpec: driver, unsafe});
   }
 
+  /**
+   *
+   * @param {DriverRunOptions} opts
+   * @return {Promise<import('./extension-command').RunOutput>}
+   */
   async run({driver, scriptName, extraArgs}) {
     return await super._run({installSpec: driver, scriptName, extraArgs});
   }
 
+  /**
+   *
+   * @param {import('./extension-command').ExtensionArgs} opts
+   * @returns {string}
+   */
   getPostInstallText({extName, extData}) {
     return (
       `Driver ${extName}@${extData.version} successfully installed\n`.green +
@@ -75,17 +99,23 @@ export default class DriverCommand extends ExtensionCommand {
 }
 
 /**
- * @typedef DriverCommandOptions
- * @property {import('../extension/extension-config').ExtensionConfig<DriverType>} config
- * @property {boolean} json
+ * @typedef {import('@appium/types').ExtensionType} ExtensionType
+ * @typedef {import('@appium/types').DriverType} DriverType
  */
 
 /**
- * @typedef {import('@appium/types').DriverType} DriverType
+ * @template {ExtensionType} ExtType
+ * @typedef {import('appium/types').ExtRecord<ExtType>} ExtRecord
+ */
+
+/**
+ * @typedef DriverCommandOptions
+ * @property {import('../extension/extension-config').ExtensionConfig<DriverType>} config
+ * @property {boolean} json
  */
 
 /**
- * Options for {@linkcode ExtensionCommand._install}
+ * Options for {@linkcode DriverCommand.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
@@ -95,3 +125,24 @@ export default class DriverCommand extends ExtensionCommand {
 /**
  * @typedef {import('appium/types').InstallType} InstallType
  */
+
+/**
+ * Options for {@linkcode DriverCommand.uninstall}
+ * @typedef DriverUninstallOpts
+ * @property {string} driver - the name or spec of a driver to uninstall
+ */
+
+/**
+ * Options for {@linkcode DriverCommand.update}
+ * @typedef DriverUpdateOpts
+ * @property {string} driver - the name of the driver to update
+ * @property {boolean} unsafe - if true, will perform unsafe updates past major revision boundaries
+ */
+
+/**
+ * Options for {@linkcode DriverCommand.run}.
+ * @typedef DriverRunOptions
+ * @property {string} driver - name of the driver to run a script from
+ * @property {string} scriptName - name of the script to run
+ * @property {string[]} [extraArgs] - arguments to pass to the script
+ */

package/lib/cli/extension-command.js

@@ -75,7 +75,7 @@ class ExtensionCommand {
    * nor is something like `@returns {never}` which does not imply a thrown exception.
    * @param {string} message
    * @protected
-   * @returns {Error}
+   * @throws {Error}
    */
   _createFatalError(message) {
     return new Error(this.log.decorate(message, 'error'));

package/lib/cli/plugin-command.js

@@ -17,6 +17,12 @@ export default class PluginCommand extends ExtensionCommand {
     this.knownExtensions = KNOWN_PLUGINS;
   }
 
+  /**
+   * Install a plugin
+   *
+   * @param {PluginInstallOpts} opts
+   * @returns {Promise<ExtRecord<PluginType>>}
+   */
   async install({plugin, installType, packageName}) {
     return await super._install({
       installSpec: plugin,
@@ -25,26 +31,48 @@ export default class PluginCommand extends ExtensionCommand {
     });
   }
 
+  /**
+   * Uninstall a plugin
+   *
+   * @param {PluginUninstallOpts} opts
+   * @returns {Promise<ExtRecord<PluginType>>}
+   */
   async uninstall({plugin}) {
     return await super._uninstall({installSpec: plugin});
   }
 
+  /**
+   * Update a plugin
+   *
+   * @param {PluginUpdateOpts} opts
+   * @returns {Promise<import('./extension-command').ExtensionUpdateResult>}
+   */
   async update({plugin, unsafe}) {
     return await super._update({installSpec: plugin, unsafe});
   }
 
+  /**
+   *
+   * @param {PluginRunOptions} opts
+   * @returns {Promise<import('./extension-command').RunOutput>}
+   */
   async run({plugin, scriptName, extraArgs}) {
     return await super._run({installSpec: plugin, scriptName, extraArgs});
   }
 
+  /**
+   *
+   * @param {import('./extension-command').ExtensionArgs} opts
+   * @returns {string}
+   */
   getPostInstallText({extName, extData}) {
     return `Plugin ${extName}@${extData.version} successfully installed`.green;
   }
 
   /**
-   * Validates fields in `appium` field of `driverMetadata`
+   * Validates fields in `appium` field of `pluginMetadata`
    *
-   * For any `package.json` fields which a driver requires, validate the type of
+   * For any `package.json` fields which a plugin requires, validate the type of
    * those fields on the `package.json` data, throwing an error if anything is
    * amiss.
    * @param {import('appium/types').ExtMetadata<PluginType>} pluginMetadata
@@ -67,5 +95,44 @@ export default class PluginCommand extends ExtensionCommand {
 }
 
 /**
+ * @typedef {import('@appium/types').ExtensionType} ExtensionType
  * @typedef {import('@appium/types').PluginType} PluginType
  */
+
+/**
+ * @template {ExtensionType} ExtType
+ * @typedef {import('appium/types').ExtRecord<ExtType>} ExtRecord
+ */
+
+/**
+ * Options for {@linkcode PluginCommand.install}
+ * @typedef PluginInstallOpts
+ * @property {string} plugin - the name or spec of a plugin to install
+ * @property {InstallType} installType - how to install this plugin. One of the INSTALL_TYPES
+ * @property {string} [packageName] - for git/github installs, the plugin node package name
+ */
+
+/**
+ * @typedef {import('appium/types').InstallType} InstallType
+ */
+
+/**
+ * Options for {@linkcode PluginCommand.uninstall}
+ * @typedef PluginUninstallOpts
+ * @property {string} plugin - the name or spec of a plugin to uninstall
+ */
+
+/**
+ * Options for {@linkcode PluginCommand.update}
+ * @typedef PluginUpdateOpts
+ * @property {string} plugin - the name of the plugin to update
+ * @property {boolean} unsafe - if true, will perform unsafe updates past major revision boundaries
+ */
+
+/**
+ * Options for {@linkcode PluginCommand.run}.
+ * @typedef PluginRunOptions
+ * @property {string} plugin - name of the plugin to run a script from
+ * @property {string} scriptName - name of the script to run
+ * @property {string[]} [extraArgs] - arguments to pass to the script
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "2.0.0-beta.48",
+  "version": "2.0.0-beta.52",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -38,7 +38,8 @@
     "support.*",
     "plugin.*",
     "scripts/autoinstall-extensions.js",
-    "types"
+    "types",
+    "tsconfig.json"
   ],
   "scripts": {
     "build:docs": "node docs/scripts/build-docs.js",
@@ -57,12 +58,12 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^9.1.0",
-    "@appium/base-plugin": "^2.0.1",
-    "@appium/docutils": "^0.1.1",
-    "@appium/schema": "^0.1.0",
-    "@appium/support": "^3.0.1",
-    "@appium/types": "^0.7.0",
+    "@appium/base-driver": "^9.2.3",
+    "@appium/base-plugin": "^2.1.3",
+    "@appium/docutils": "^0.1.5",
+    "@appium/schema": "^0.2.3",
+    "@appium/support": "^3.1.3",
+    "@appium/types": "^0.8.3",
     "@sidvind/better-ajv-errors": "2.1.0",
     "@types/argparse": "2.0.10",
     "@types/bluebird": "3.5.38",
@@ -70,12 +71,12 @@
     "@types/semver": "7.3.13",
     "@types/teen_process": "2.0.0",
     "@types/wrap-ansi": "3.0.0",
-    "ajv": "8.11.2",
+    "ajv": "8.12.0",
     "ajv-formats": "2.1.1",
     "argparse": "2.0.1",
     "async-lock": "1.4.0",
     "asyncbox": "2.9.4",
-    "axios": "1.2.1",
+    "axios": "1.2.2",
     "bluebird": "3.7.2",
     "cross-env": "7.0.3",
     "find-up": "5.0.0",
@@ -90,10 +91,10 @@
     "semver": "7.3.8",
     "source-map-support": "0.5.21",
     "teen_process": "2.0.2",
-    "type-fest": "3.4.0",
+    "type-fest": "3.5.1",
     "winston": "3.8.2",
     "wrap-ansi": "7.0.0",
-    "yaml": "2.1.3"
+    "yaml": "2.2.1"
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -103,8 +104,8 @@
     "access": "public",
     "tag": "next"
   },
-  "gitHead": "2e76ba9607729f59ca967e47c2cba738e90a57b8",
+  "gitHead": "67c9bdfbceeb049aa134bf1d9b107543ff0a80b0",
   "typedoc": {
-    "entryPoint": "./build/lib/main.js"
+    "entryPoint": "./lib/main.js"
   }
 }

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "extends": "@appium/tsconfig/tsconfig.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "build",
+    "paths": {
+      "@appium/support": ["../support"],
+      "@appium/base-driver": ["../base-driver"],
+      "@appium/base-plugin": ["../base-plugin"],
+      "@appium/types": ["../types"],
+      "@appium/schema": ["../schema"],
+      "appium": ["."]
+    },
+    "checkJs": true
+  },
+  "include": ["lib", "types"],
+  "references": [
+    {"path": "../schema"},
+    {"path": "../types"},
+    {"path": "../support"},
+    {"path": "../base-driver"},
+    {"path": "../base-plugin"},
+    {"path": "../test-support"}
+  ]
+}