appium-chromedriver 8.1.0 → 8.2.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [8.2.0](https://github.com/appium/appium-chromedriver/compare/v8.1.0...v8.2.0) (2025-12-25)
+
+### Features
+
+* Migrate the rest of files to typescript ([#533](https://github.com/appium/appium-chromedriver/issues/533)) ([fbe186f](https://github.com/appium/appium-chromedriver/commit/fbe186f80901f76cd1b4458aca5dd059dceae268))
+
 ## [8.1.0](https://github.com/appium/appium-chromedriver/compare/v8.0.31...v8.1.0) (2025-12-22)
 
 ### Features

package/build/lib/chromedriver.d.ts

@@ -1,143 +1,114 @@
-export class Chromedriver extends events<any> {
-    /**
-     *
-     * @param {import('./types').ChromedriverOpts} args
-     */
-    constructor(args?: import("./types").ChromedriverOpts);
-    _log: import("@appium/types").AppiumLogger;
-    proxyHost: string;
-    proxyPort: string | number;
-    adb: import("appium-adb").default | undefined;
-    cmdArgs: string[] | undefined;
-    proc: SubProcess<import("teen_process").SubProcessOptions> | null;
-    useSystemExecutable: boolean;
-    chromedriver: string | undefined;
-    executableDir: string;
-    mappingPath: string | undefined;
-    bundleId: string | undefined;
-    executableVerified: boolean;
+import events from 'events';
+import { JWProxy } from '@appium/base-driver';
+import type { HTTPMethod, HTTPBody } from '@appium/types';
+import type { Request, Response } from 'express';
+import type { ChromedriverOpts } from './types';
+type SessionCapabilities = Record<string, any>;
+export declare class Chromedriver extends events.EventEmitter {
+    static readonly EVENT_ERROR = "chromedriver_error";
+    static readonly EVENT_CHANGED = "stateChanged";
+    static readonly STATE_STOPPED = "stopped";
+    static readonly STATE_STARTING = "starting";
+    static readonly STATE_ONLINE = "online";
+    static readonly STATE_STOPPING = "stopping";
+    static readonly STATE_RESTARTING = "restarting";
+    private readonly _log;
+    private readonly proxyHost;
+    private readonly proxyPort;
+    private readonly adb?;
+    private readonly cmdArgs?;
+    private proc;
+    private readonly useSystemExecutable;
+    private chromedriver?;
+    private readonly executableDir;
+    private readonly mappingPath?;
+    private bundleId?;
+    private executableVerified;
     state: string;
-    _execFunc: typeof exec;
+    private readonly _execFunc;
     jwproxy: JWProxy;
-    isCustomExecutableDir: boolean;
-    verbose: boolean | undefined;
-    logPath: string | undefined;
-    disableBuildCheck: boolean;
-    storageClient: ChromedriverStorageClient | null;
-    details: {
-        info?: {
-            Browser: string;
-        };
-    } | undefined;
-    /** @type {any} */
-    capabilities: any;
-    /** @type {keyof PROTOCOLS | null} */
-    _desiredProtocol: ("W3C" | "MJSONWP") | null;
-    /** @type {string|null} */
-    _driverVersion: string | null;
-    /** @type {Record<string, any> | null} */
-    _onlineStatus: Record<string, any> | null;
-    get log(): import("@appium/types").AppiumLogger;
-    /**
-     * @returns {string | null}
-     */
-    get driverVersion(): string | null;
-    getDriversMapping(): Promise<any>;
-    /**
-     * @param {ChromedriverVersionMapping} mapping
-     */
-    getChromedrivers(mapping: ChromedriverVersionMapping): Promise<{
-        executable: string;
-        version: string;
-        minChromeVersion: string | null;
-    }[]>;
-    getChromeVersion(): Promise<semver.SemVer | null>;
+    private readonly isCustomExecutableDir;
+    private readonly verbose?;
+    private readonly logPath?;
+    private readonly disableBuildCheck;
+    private readonly storageClient;
+    private readonly details?;
+    private capabilities;
+    private _desiredProtocol;
+    private _driverVersion;
+    private _onlineStatus;
+    constructor(args?: ChromedriverOpts);
     /**
-     *
-     * @param {ChromedriverVersionMapping} newMapping
-     * @returns {Promise<void>}
+     * Gets the logger instance for this Chromedriver instance.
+     * @returns The logger instance.
      */
-    updateDriversMapping(newMapping: ChromedriverVersionMapping): Promise<void>;
+    get log(): any;
     /**
-     * When executableDir is given explicitly for non-adb environment,
-     * this method will respect the executableDir rather than the system installed binary.
-     * @returns {Promise<string>}
+     * Gets the version of the currently running Chromedriver.
+     * @returns The driver version string, or null if not yet determined.
      */
-    getCompatibleChromedriver(): Promise<string>;
-    initChromedriverPath(): Promise<string>;
+    get driverVersion(): string | null;
     /**
-     * Determines the driver communication protocol
-     * based on various validation rules.
-     *
-     * @returns {keyof PROTOCOLS}
+     * Starts a new Chromedriver session with the given capabilities.
+     * @param caps - The session capabilities to use.
+     * @param emitStartingState - Whether to emit the starting state event (default: true).
+     * @returns A promise that resolves to the session capabilities returned by Chromedriver.
+     * @throws {Error} If Chromedriver fails to start or crashes during startup.
      */
-    syncProtocol(): "W3C" | "MJSONWP";
+    start(caps: SessionCapabilities, emitStartingState?: boolean): Promise<SessionCapabilities>;
     /**
-     *
-     * @param {SessionCapabilities} caps
-     * @param {boolean} emitStartingState
-     * @returns {Promise<SessionCapabilities>}
+     * Gets the current session ID if the driver is online.
+     * @returns The session ID string, or null if the driver is not online.
      */
-    start(caps: SessionCapabilities, emitStartingState?: boolean): Promise<SessionCapabilities>;
     sessionId(): string | null;
     /**
-     * Restarts the chromedriver session
-     *
-     * @returns {Promise<SessionCapabilities>}
+     * Restarts the Chromedriver session.
+     * The session will be stopped and then started again with the same capabilities.
+     * @returns A promise that resolves to the session capabilities returned by Chromedriver.
+     * @throws {Error} If the driver is not online or if restart fails.
      */
     restart(): Promise<SessionCapabilities>;
-    waitForOnline(): Promise<void>;
-    getStatus(): Promise<any>;
     /**
-     * Starts a new session
-     *
-     * @returns {Promise<SessionCapabilities>}
+     * Stops the Chromedriver session and terminates the process.
+     * @param emitStates - Whether to emit state change events during shutdown (default: true).
+     * @returns A promise that resolves when the session has been stopped.
      */
-    startSession(): Promise<SessionCapabilities>;
     stop(emitStates?: boolean): Promise<void>;
     /**
-     *
-     * @param {string} state
-     */
-    changeState(state: string): void;
-    /**
-     *
-     * @param {string} url
-     * @param {'POST'|'GET'|'DELETE'} method
-     * @param {any} body
-     * @returns
+     * Sends a command to the Chromedriver server.
+     * @param url - The endpoint URL (e.g., '/url', '/session').
+     * @param method - The HTTP method to use ('POST', 'GET', or 'DELETE').
+     * @param body - Optional request body for POST requests.
+     * @returns A promise that resolves to the response from Chromedriver.
      */
-    sendCommand(url: string, method: "POST" | "GET" | "DELETE", body: any): Promise<any>;
+    sendCommand(url: string, method: HTTPMethod, body?: HTTPBody): Promise<HTTPBody>;
     /**
-     *
-     * @param {any} req
-     * @param {any} res
+     * Proxies an HTTP request/response to the Chromedriver server.
+     * @param req - The incoming HTTP request object.
+     * @param res - The outgoing HTTP response object.
+     * @returns A promise that resolves when the proxying is complete.
      */
-    proxyReq(req: any, res: any): Promise<void>;
-    killAll(): Promise<void>;
+    proxyReq(req: Request, res: Response): Promise<void>;
     /**
-     * @returns {Promise<boolean>}
+     * Checks if Chromedriver is currently able to automate webviews.
+     * Sometimes Chromedriver stops automating webviews; this method runs a simple
+     * command to determine the current state.
+     * @returns A promise that resolves to true if webviews are working, false otherwise.
      */
     hasWorkingWebview(): Promise<boolean>;
+    private buildChromedriverArgs;
+    private getDriversMapping;
+    private getChromedrivers;
+    private getChromeVersion;
+    private updateDriversMapping;
+    private getCompatibleChromedriver;
+    private initChromedriverPath;
+    private syncProtocol;
+    private waitForOnline;
+    private getStatus;
+    private startSession;
+    private changeState;
+    private killAll;
 }
-export namespace Chromedriver {
-    let EVENT_ERROR: string;
-    let EVENT_CHANGED: string;
-    let STATE_STOPPED: string;
-    let STATE_STARTING: string;
-    let STATE_ONLINE: string;
-    let STATE_STOPPING: string;
-    let STATE_RESTARTING: string;
-}
-export type ChromedriverVersionMapping = import("./types").ChromedriverVersionMapping;
-export type NewSessionResponse = {
-    capabilities: Record<string, any>;
-};
-export type SessionCapabilities = Record<string, any>;
-import events from 'events';
-import { SubProcess } from 'teen_process';
-import { exec } from 'teen_process';
-import { JWProxy } from '@appium/base-driver';
-import { ChromedriverStorageClient } from './storage-client/storage-client';
-import * as semver from 'semver';
+export {};
 //# sourceMappingURL=chromedriver.d.ts.map

package/build/lib/chromedriver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chromedriver.d.ts","sourceRoot":"","sources":["../../lib/chromedriver.js"],"names":[],"mappings":"AAgCA;IACE;;;OAGG;IACH,mBAFW,OAAO,SAAS,EAAE,gBAAgB,EA2E5C;IArDC,2CAAqD;IAErD,kBAAqB;IACrB,2BAAqB;IACrB,8CAAc;IACd,8BAAsB;IACtB,kEAAgB;IAChB,6BAA8C;IAC9C,iCAA8B;IAC9B,sBAAkC;IAClC,gCAA8B;IAC9B,6BAAwB;IACxB,4BAA+B;IAC/B,cAAuC;IAGvC,uBAAqB;IAWrB,iBAAqC;IAGnC,+BAAiC;IAMnC,6BAAsB;IACtB,4BAAsB;IACtB,2BAA4C;IAC5C,gDAEQ;IACR;;;;kBAAsB;IACtB,kBAAkB;IAClB,cADW,GAAG,CACQ;IACtB,qCAAqC;IACrC,kBADW,sBAAkB,IAAI,CACL;IAG5B,0BAA0B;IAC1B,gBADW,MAAM,GAAC,IAAI,CACI;IAC1B,yCAAyC;IACzC,eADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CACZ;IAG3B,gDAEC;IAED;;OAEG;IACH,qBAFa,MAAM,GAAG,IAAI,CAIzB;IAED,kCA8BC;IAED;;OAEG;IACH,0BAFW,0BAA0B;;;;SAgGpC;IAED,kDAmEC;IAED;;;;OAIG;IACH,iCAHW,0BAA0B,GACxB,OAAO,CAAC,IAAI,CAAC,CAuBzB;IAED;;;;OAIG;IACH,6BAFa,OAAO,CAAC,MAAM,CAAC,CAqJ3B;IAED,wCAwBC;IAED;;;;;OAKG;IACH,kCAkCC;IAED;;;;;OAKG;IACH,YAJW,mBAAmB,sBACnB,OAAO,GACL,OAAO,CAAC,mBAAmB,CAAC,CA8HxC;IAED,2BAEC;IAED;;;;OAIG;IACH,WAFa,OAAO,CAAC,mBAAmB,CAAC,CAUxC;IAED,+BA0BC;IAED,0BAEC;IAED;;;;OAIG;IACH,gBAFa,OAAO,CAAC,mBAAmB,CAAC,CAiBxC;IAED,0CA2BC;IAED;;;OAGG;IACH,mBAFW,MAAM,QAMhB;IAED;;;;;;OAMG;IACH,iBALW,MAAM,UACN,MAAM,GAAC,KAAK,GAAC,QAAQ,QACrB,GAAG,gBAKb;IAED;;;;OAIG;IACH,cAHW,GAAG,OACH,GAAG,iBAIb;IAED,yBAuCC;IAED;;OAEG;IACH,qBAFa,OAAO,CAAC,OAAO,CAAC,CAW5B;CACF;;;;;;;;;;yCAWY,OAAO,SAAS,EAAE,0BAA0B;iCAI5C;IAAC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAAC;kCACnC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;mBA34Bb,QAAQ;2BAKI,cAAc;qBAAd,cAAc;wBAJZ,qBAAqB;0CAiBd,iCAAiC;wBAJjD,QAAQ"}
+{"version":3,"file":"chromedriver.d.ts","sourceRoot":"","sources":["../../lib/chromedriver.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAC,OAAO,EAAY,MAAM,qBAAqB,CAAC;AAoBvD,OAAO,KAAK,EAAe,UAAU,EAAE,QAAQ,EAAC,MAAM,eAAe,CAAC;AACtE,OAAO,KAAK,EAAC,OAAO,EAAE,QAAQ,EAAC,MAAM,SAAS,CAAC;AAC/C,OAAO,KAAK,EAAC,gBAAgB,EAA6B,MAAM,SAAS,CAAC;AAwB1E,KAAK,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE/C,qBAAa,YAAa,SAAQ,MAAM,CAAC,YAAY;IACnD,MAAM,CAAC,QAAQ,CAAC,WAAW,wBAAwB;IACnD,MAAM,CAAC,QAAQ,CAAC,aAAa,kBAAkB;IAC/C,MAAM,CAAC,QAAQ,CAAC,aAAa,aAAa;IAC1C,MAAM,CAAC,QAAQ,CAAC,cAAc,cAAc;IAC5C,MAAM,CAAC,QAAQ,CAAC,YAAY,YAAY;IACxC,MAAM,CAAC,QAAQ,CAAC,cAAc,cAAc;IAC5C,MAAM,CAAC,QAAQ,CAAC,gBAAgB,gBAAgB;IAEhD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAM;IAC3B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAM;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAW;IACpC,OAAO,CAAC,IAAI,CAAoB;IAChC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAU;IAC9C,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,kBAAkB,CAAU;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAc;IACxC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAU;IAChD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAU;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAU;IAC5C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAmC;IACjE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAA8B;IACvD,OAAO,CAAC,YAAY,CAAsB;IAC1C,OAAO,CAAC,gBAAgB,CAAgC;IACxD,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,aAAa,CAA6B;gBAEtC,IAAI,GAAE,gBAAqB;IAsEvC;;;OAGG;IACH,IAAI,GAAG,QAEN;IAED;;;OAGG;IACH,IAAI,aAAa,IAAI,MAAM,GAAG,IAAI,CAEjC;IAED;;;;;;OAMG;IACG,KAAK,CAAC,IAAI,EAAE,mBAAmB,EAAE,iBAAiB,UAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAgH9F;;;OAGG;IACH,SAAS,IAAI,MAAM,GAAG,IAAI;IAI1B;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAU7C;;;;OAIG;IACG,IAAI,CAAC,UAAU,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAyB5C;;;;;;OAMG;IACG,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,GAAE,QAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5F;;;;;OAKG;IACG,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1D;;;;;OAKG;IACG,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC;IAW3C,OAAO,CAAC,qBAAqB;YAkBf,iBAAiB;YAgCjB,gBAAgB;YAmGhB,gBAAgB;YAqEhB,oBAAoB;YAuBpB,yBAAyB;YA+IzB,oBAAoB;IA0BlC,OAAO,CAAC,YAAY;YAoCN,aAAa;YA2Bb,SAAS;YAIT,YAAY;IAe1B,OAAO,CAAC,WAAW;YAML,OAAO;CAwCtB"}