feat: use named export for Chromedriver

this avoids having to write stuff like `@type {import("appium-chromedriver").default}` when referring to the class.
also exports more types.
now depends on `appium-adb`, as the type is needed for `ChromedriverOpts`.

Author: boneskull

index.js

@@ -32,7 +32,7 @@ const WEBDRIVER_VERSION_PATTERN = /Starting (ChromeDriver|Microsoft Edge WebDriv
 
 const CD_VERSION_TIMEOUT = 5000;
 
-class Chromedriver extends events.EventEmitter {
+export class Chromedriver extends events.EventEmitter {
   /**
    *
    * @param {import('./types').ChromedriverOpts} args
@@ -864,9 +864,6 @@ Chromedriver.STATE_ONLINE = 'online';
 Chromedriver.STATE_STOPPING = 'stopping';
 Chromedriver.STATE_RESTARTING = 'restarting';
 
-export {Chromedriver};
-export default Chromedriver;
-
 /**
  * @typedef {import('./types').ChromedriverVersionMapping} ChromedriverVersionMapping
  */

lib/chromedriver.js

@@ -0,0 +1,5 @@
+import {Chromedriver} from './chromedriver';
+export {ChromedriverStorageClient} from './storage-client';
+export default Chromedriver;
+
+export type * from './types';

lib/index.ts

@@ -80,7 +80,7 @@ function extractNodeText(node) {
     : node.firstChild.nodeValue;
 }
 
-class ChromedriverStorageClient {
+export class ChromedriverStorageClient {
   /**
    *
    * @param {import('./types').ChromedriverStorageClientOpts} args
@@ -93,20 +93,12 @@ class ChromedriverStorageClient {
     this.mapping = {};
   }
 
-  /**
-   * @typedef {Object} AdditionalDriverDetails
-   * @property {string?} version - Chromedriver version
-   * or `null` if it cannot be found
-   * @property {string?} minBrowserVersion - The minimum browser version
-   * supported by chromedriver or `null` if it cannot be found
-   */
-
   /**
    * Gets additional chromedriver details from chromedriver
    * release notes
    *
    * @param {string} content - Release notes of the corresponding chromedriver
-   * @returns {AdditionalDriverDetails}
+   * @returns {import('./types').AdditionalDriverDetails}
    */
   parseNotes(content) {
     const result = {};

lib/storage-client.js

@@ -1,3 +1,5 @@
+import type ADB from 'appium-adb';
+
 export interface ChromedriverOpts {
   host?: string;
   port?: string;
@@ -7,7 +9,7 @@ export interface ChromedriverOpts {
   bundleId?: string;
   mappingPath?: string;
   cmdArgs?: string[];
-  adb?: AdbStub;
+  adb?: ADB;
   verbose?: boolean;
   logPath?: string;
   disableBuildCheck?: boolean;
@@ -84,18 +86,13 @@ export interface ChromedriverStorageClientOpts {
   timeout?: number;
 }
 
-/**
- * This is an instance of the `ADB` class from the `appium-adb` package.
- * Remove this definition if/when `appium-adb` gets typed properly
- * @see https://github.com/appium/appium-adb
- */
-export type AdbStub = {
-  getApiLevel: () => Promise<number>;
-  adbPort?: number;
-  executable: {
-    defaultArgs: string[];
-  };
-  getForwardList: () => Promise<string[]>;
-  removePortForward: (systemPort: string) => Promise<void>;
-  getPackageInfo: (pkg: string) => Promise<{versionName: string}>;
-};
+export interface AdditionalDriverDetails {
+  /**
+   * Chromedriver version or `null` if it cannot be found
+   */
+  version?: string | null;
+  /**
+   * The minimum browser version supported by chromedriver or `null` if it cannot be found
+   */
+  minBrowserVersion?: string | null;
+}

lib/types.ts

@@ -57,7 +57,7 @@ const CD_VER =
 
 /**
  *
- * @param {import('./types').AdbStub} adb
+ * @param {import('appium-adb').ADB} adb
  * @param {string} bundleId
  * @returns
  */

lib/utils.js

@@ -31,13 +31,12 @@
     "printWidth": 100,
     "singleQuote": true
   },
-  "main": "./build/index.js",
+  "main": "./build/lib/index.js",
   "directories": {
     "lib": "lib"
   },
   "files": [
     "config",
-    "index.js",
     "install-npm.js",
     "lib",
     "build",
@@ -47,12 +46,13 @@
     "CHANGELOG.md",
     "tsconfig.json"
   ],
-  "types": "./build/index.d.ts",
+  "types": "./build/lib/index.d.ts",
   "dependencies": {
     "@appium/base-driver": "^9.1.0",
     "@appium/support": "^4.0.0",
     "@babel/runtime": "^7.0.0",
     "@xmldom/xmldom": "^0.x",
+    "appium-adb": "^9.14.1",
     "asyncbox": "^2.0.2",
     "axios": "^1.x",
     "bluebird": "^3.5.1",
@@ -106,6 +106,6 @@
     "semantic-release": "^20.0.2",
     "sinon": "^15.0.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.2"
+    "typescript": "~5.0.4"
   }
 }

package.json

@@ -1,34 +1,34 @@
 // transpile:mocha
 
-import Chromedriver from '../../lib/chromedriver';
-import { install } from '../../lib/install';
+import {Chromedriver} from '../../lib/chromedriver';
+import {install} from '../../lib/install';
 import chai from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import B from 'bluebird';
-import { exec } from 'teen_process';
+import {exec} from 'teen_process';
 import _ from 'lodash';
 
-
 let should = chai.should();
 chai.use(chaiAsPromised);
 
-function nextState (cd) {
+function nextState(cd) {
   return new B((resolve) => {
     cd.on(Chromedriver.EVENT_CHANGED, (msg) => {
       resolve(msg.state);
     });
   });
 }
 
-function nextError (cd) {
+function nextError(cd) {
   return new B((resolve) => {
-    cd.on(Chromedriver.EVENT_ERROR, (err) => { // eslint-disable-line promise/prefer-await-to-callbacks
+    cd.on(Chromedriver.EVENT_ERROR, (err) => {
+      // eslint-disable-line promise/prefer-await-to-callbacks
       resolve(err);
     });
   });
 }
 
-async function assertNoRunningChromedrivers () {
+async function assertNoRunningChromedrivers() {
   let {stdout} = await exec('ps', ['aux']);
   let count = 0;
   for (let line of stdout.split('\n')) {
@@ -40,11 +40,13 @@ async function assertNoRunningChromedrivers () {
   count.should.eql(0);
 }
 
-function buildReqRes (url, method, body) {
+function buildReqRes(url, method, body) {
   let req = {originalUrl: url, method, body};
   let res = {};
   res.headers = {};
-  res.set = (k, v) => { res[k] = v; };
+  res.set = (k, v) => {
+    res[k] = v;
+  };
   res.status = (code) => {
     res.sentCode = code;
     return {
@@ -53,7 +55,7 @@ function buildReqRes (url, method, body) {
           body = JSON.parse(body);
         } catch (e) {}
         res.sentBody = body;
-      }
+      },
     };
   };
   return [req, res];
@@ -189,12 +191,15 @@ describe('chromedriver with async/await', function () {
     let badCd = new Chromedriver({
       port: 1,
     });
-    await badCd.start(caps).should.eventually.be.rejectedWith('ChromeDriver crashed during startup');
+    await badCd
+      .start(caps)
+      .should.eventually.be.rejectedWith('ChromeDriver crashed during startup');
     await assertNoRunningChromedrivers();
   });
   it('should throw an error during start if session does not work', async function () {
     let badCd = new Chromedriver({});
-    await badCd.start({chromeOptions: {badCap: 'foo'}})
+    await badCd
+      .start({chromeOptions: {badCap: 'foo'}})
       .should.eventually.be.rejectedWith('cannot parse capability');
     await assertNoRunningChromedrivers();
   });

test/functional/chromedriver-e2e-specs.js

@@ -2,18 +2,15 @@
 
 import chai from 'chai';
 import chaiAsPromised from 'chai-as-promised';
-import { fs } from '@appium/support';
-import { install } from '../../lib/install';
-import {
-  CD_BASE_DIR, getChromedriverBinaryPath, getOsName
-} from '../../lib/utils';
-import Chromedriver from '../../lib/chromedriver';
-
+import {fs} from '@appium/support';
+import {install} from '../../lib/install';
+import {CD_BASE_DIR, getChromedriverBinaryPath, getOsName} from '../../lib/utils';
+import {Chromedriver} from '../../lib/chromedriver';
 
 let should = chai.should();
 chai.use(chaiAsPromised);
 
-async function assertNoPreviousDirs () {
+async function assertNoPreviousDirs() {
   let err;
   try {
     await fs.stat(CD_BASE_DIR);

test/functional/install-e2e-specs.js

@@ -7,5 +7,5 @@
     "checkJs": true,
     "lib": ["es2020", "dom"]
   },
-  "include": ["index.js", "lib"]
+  "include": ["lib"]
 }