@appium/base-driver 10.2.1 → 10.3.0

package/build/lib/jsonwp-proxy/proxy.d.ts

@@ -1,128 +1,83 @@
-export class JWProxy {
-    /**
-     * @param {import('@appium/types').ProxyOptions} [opts={}]
-     */
-    constructor(opts?: import("@appium/types").ProxyOptions);
-    /** @type {string} */
-    scheme: string;
-    /** @type {string} */
-    server: string;
-    /** @type {number} */
-    port: number;
-    /** @type {string} */
-    base: string;
-    /** @type {string} */
-    reqBasePath: string;
-    /** @type {string?} */
+import type { AppiumLogger, HTTPBody, HTTPHeaders, HTTPMethod, ProxyOptions, ProxyResponse } from '@appium/types';
+import { PROTOCOLS } from '../constants';
+import { ProtocolConverter } from './protocol-converter';
+import http from 'node:http';
+import https from 'node:https';
+import type { Request, Response } from 'express';
+type Protocol = (typeof PROTOCOLS)[keyof typeof PROTOCOLS];
+export declare class JWProxy {
+    readonly scheme: string;
+    readonly server: string;
+    readonly port: number;
+    readonly base: string;
+    readonly reqBasePath: string;
     sessionId: string | null;
-    /** @type {number} */
-    timeout: number;
-    /** @type {import('@appium/types').HTTPHeaders | undefined} */
-    headers: import("@appium/types").HTTPHeaders | undefined;
-    /** @type {Protocol | null | undefined} */
-    _downstreamProtocol: Protocol | null | undefined;
-    /** @type {ProxyRequest[]} */
-    _activeRequests: ProxyRequest[];
-    httpAgent: http.Agent;
-    httpsAgent: https.Agent;
-    protocolConverter: ProtocolConverter;
-    _log: import("@appium/types").AppiumLogger | undefined;
-    get log(): import("@appium/types").AppiumLogger;
+    readonly timeout: number;
+    readonly headers: HTTPHeaders | undefined;
+    readonly httpAgent: http.Agent;
+    readonly httpsAgent: https.Agent;
+    readonly protocolConverter: ProtocolConverter;
+    private _downstreamProtocol;
+    private _activeRequests;
+    private readonly _log;
+    constructor(opts?: ProxyOptions);
+    get log(): AppiumLogger;
     /**
-     * Performs requests to the downstream server
-     *
-     * @private - Do not call this method directly,
-     * it uses client-specific arguments and responses!
-     *
-     * @param {import('axios').RawAxiosRequestConfig} requestConfig
-     * @returns {Promise<import('axios').AxiosResponse>}
+     * Returns the number of active downstream HTTP requests.
      */
-    private request;
+    getActiveRequestsCount(): number;
     /**
-     * @returns {number}
+     * Cancels all currently active downstream HTTP requests.
      */
-    getActiveRequestsCount(): number;
     cancelActiveRequests(): void;
     /**
-     * @param {Protocol | null | undefined} value
+     * Sets the protocol used by the downstream server (W3C or MJSONWP).
      */
     set downstreamProtocol(value: Protocol | null | undefined);
-    get downstreamProtocol(): Protocol | null | undefined;
     /**
-     *
-     * @param {string} url
-     * @param {string} [method]
-     * @returns {string}
+     * Gets the protocol used by the downstream server (W3C or MJSONWP).
      */
-    getUrlForProxy(url: string, method?: string): string;
+    get downstreamProtocol(): Protocol | null | undefined;
     /**
-     *
-     * @param {string} url
-     * @param {string} method
-     * @param {import('@appium/types').HTTPBody} [body=null]
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
+     * Builds a full downstream URL (including base path and session) for a given upstream URL.
      */
-    proxy(url: string, method: string, body?: import("@appium/types").HTTPBody): Promise<[import("@appium/types").ProxyResponse, import("@appium/types").HTTPBody]>;
+    getUrlForProxy(url: string, method?: HTTPMethod): string;
     /**
-     *
-     * @param {Record<string, any>} resObj
-     * @returns {Protocol | undefined}
+     * Proxies a raw WebDriver command to the downstream server.
      */
-    getProtocolFromResBody(resObj: Record<string, any>): Protocol | undefined;
+    proxy(url: string, method: string, body?: HTTPBody): Promise<[ProxyResponse, HTTPBody]>;
     /**
-     *
-     * @param {string} url
-     * @param {import('@appium/types').HTTPMethod} method
-     * @param {import('@appium/types').HTTPBody} [body=null]
-     * @returns {Promise<[import('@appium/types').ProxyResponse, import('@appium/types').HTTPBody]>}
+     * Detects the downstream protocol from a response body.
      */
-    proxyCommand(url: string, method: import("@appium/types").HTTPMethod, body?: import("@appium/types").HTTPBody): Promise<[import("@appium/types").ProxyResponse, import("@appium/types").HTTPBody]>;
+    getProtocolFromResBody(resObj: Record<string, unknown>): Protocol | undefined;
     /**
-     *
-     * @param {string} url
-     * @param {import('@appium/types').HTTPMethod} method
-     * @param {import('@appium/types').HTTPBody} [body=null]
-     * @returns {Promise<import('@appium/types').HTTPBody>}
+     * Proxies a command identified by its HTTP method and URL to the downstream server.
      */
-    command(url: string, method: import("@appium/types").HTTPMethod, body?: import("@appium/types").HTTPBody): Promise<import("@appium/types").HTTPBody>;
+    proxyCommand(url: string, method: HTTPMethod, body?: HTTPBody): Promise<[ProxyResponse, HTTPBody]>;
     /**
-     *
-     * @param {string} url
-     * @returns {string | null}
+     * Executes a WebDriver command and returns the unwrapped `value` field (or throws).
      */
-    getSessionIdFromUrl(url: string): string | null;
+    command(url: string, method: HTTPMethod, body?: HTTPBody): Promise<HTTPBody>;
     /**
-     *
-     * @param {import('express').Request} req
-     * @param {import('express').Response} res
+     * Extracts a session id from a WebDriver-style URL.
      */
-    proxyReqRes(req: import("express").Request, res: import("express").Response): Promise<void>;
+    getSessionIdFromUrl(url: string): string | null;
     /**
+     * Proxies an Express `Request`/`Response` pair to the downstream server,
+     * converting any downstream errors into a proper W3C HTTP response.
      *
-     * @param {string} url
-     * @returns {ParsedUrl}
+     * This method must not throw; it always writes a response.
      */
-    _parseUrl(url: string): ParsedUrl;
+    proxyReqRes(req: Request, res: Response): Promise<void>;
     /**
+     * Performs requests to the downstream server
      *
-     * @param {ParsedUrl} parsedUrl
-     * @returns {string}
+     * @private - Do not call this method directly,
+     * it uses client-specific arguments and responses!
      */
-    _toNormalizedPathname(parsedUrl: ParsedUrl): string;
+    private request;
+    private _parseUrl;
+    private _toNormalizedPathname;
 }
-export default JWProxy;
-export type ProxyError = Error & {
-    response: {
-        data: import("type-fest").JsonObject;
-        status: import("http-status-codes").StatusCodes;
-    };
-};
-export type ParsedUrl = nodeUrl.UrlWithStringQuery;
-export type Protocol = (typeof PROTOCOLS)[keyof typeof PROTOCOLS];
-import { ProxyRequest } from './proxy-request';
-import http from 'node:http';
-import https from 'node:https';
-import ProtocolConverter from './protocol-converter';
-import nodeUrl from 'node:url';
-import { PROTOCOLS } from '../constants';
+export {};
 //# sourceMappingURL=proxy.d.ts.map

package/build/lib/jsonwp-proxy/proxy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../../../lib/jsonwp-proxy/proxy.js"],"names":[],"mappings":"AAuCA;IAsBE;;OAEG;IACH,mBAFW,OAAO,eAAe,EAAE,YAAY,EAgC9C;IAtDD,qBAAqB;IACrB,QADW,MAAM,CACV;IACP,qBAAqB;IACrB,QADW,MAAM,CACV;IACP,qBAAqB;IACrB,MADW,MAAM,CACZ;IACL,qBAAqB;IACrB,MADW,MAAM,CACZ;IACL,qBAAqB;IACrB,aADW,MAAM,CACL;IACZ,sBAAsB;IACtB,WADW,MAAM,OAAC,CACR;IACV,qBAAqB;IACrB,SADW,MAAM,CACT;IACR,8DAA8D;IAC9D,SADW,OAAO,eAAe,EAAE,WAAW,GAAG,SAAS,CAClD;IACR,0CAA0C;IAC1C,qBADW,QAAQ,GAAG,IAAI,GAAG,SAAS,CAClB;IACpB,6BAA6B;IAC7B,iBADW,YAAY,EAAE,CACT;IA6Bd,sBAA0C;IAC1C,wBAA4C;IAC5C,qCAA+E;IAC/E,uDAAoB;IAKtB,gDAEC;IAED;;;;;;;;OAQG;IACH,gBAQC;IAED;;OAEG;IACH,0BAFa,MAAM,CAIlB;IAED,6BAKC;IAED;;OAEG;IACH,8BAFW,QAAQ,GAAG,IAAI,GAAG,SAAS,EAKrC;IAED,0BAPW,QAAQ,GAAG,IAAI,GAAG,SAAS,CASrC;IAED;;;;;OAKG;IACH,oBAJW,MAAM,WACN,MAAM,GACJ,MAAM,CAwBlB;IAED;;;;;;OAMG;IACH,WALW,MAAM,UACN,MAAM,SACN,OAAO,eAAe,EAAE,QAAQ,GAC9B,OAAO,CAAC,CAAC,OAAO,eAAe,EAAE,aAAa,EAAE,OAAO,eAAe,EAAE,QAAQ,CAAC,CAAC,CAwG9F;IAED;;;;OAIG;IACH,+BAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,QAAQ,GAAG,SAAS,CAShC;IAED;;;;;;OAMG;IACH,kBALW,MAAM,UACN,OAAO,eAAe,EAAE,UAAU,SAClC,OAAO,eAAe,EAAE,QAAQ,GAC9B,OAAO,CAAC,CAAC,OAAO,eAAe,EAAE,aAAa,EAAE,OAAO,eAAe,EAAE,QAAQ,CAAC,CAAC,CAY9F;IAED;;;;;;OAMG;IACH,aALW,MAAM,UACN,OAAO,eAAe,EAAE,UAAU,SAClC,OAAO,eAAe,EAAE,QAAQ,GAC9B,OAAO,CAAC,OAAO,eAAe,EAAE,QAAQ,CAAC,CAoDrD;IAED;;;;OAIG;IACH,yBAHW,MAAM,GACJ,MAAM,GAAG,IAAI,CAKzB;IAED;;;;OAIG;IACH,iBAHW,OAAO,SAAS,EAAE,OAAO,OACzB,OAAO,SAAS,EAAE,QAAQ,iBA8CpC;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,SAAS,CAYrB;IAED;;;;OAIG;IACH,iCAHW,SAAS,GACP,MAAM,CAwBlB;CACF;;yBAKY,KAAK,GAAG;IAAC,QAAQ,EAAE;QAAC,IAAI,EAAE,OAAO,WAAW,EAAE,UAAU,CAAC;QAAC,MAAM,EAAE,OAAO,mBAAmB,EAAE,WAAW,CAAA;KAAC,CAAA;CAAC;wBAC3G,OAAO,CAAC,kBAAkB;uBAC1B,CAAA,OAAO,SAAS,EAAC,MAAM,OAAO,SAAS,CAAC;6BAzdxB,iBAAiB;iBAJ7B,WAAW;kBACV,YAAY;8BAHA,sBAAsB;oBAKhC,UAAU;0BANkC,cAAc"}
+{"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../../../lib/jsonwp-proxy/proxy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,QAAQ,EACR,WAAW,EACX,UAAU,EACV,YAAY,EACZ,aAAa,EACd,MAAM,eAAe,CAAC;AAYvB,OAAO,EAAyC,SAAS,EAAC,MAAM,cAAc,CAAC;AAC/E,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,MAAM,YAAY,CAAC;AAI/B,OAAO,KAAK,EAAC,OAAO,EAAE,QAAQ,EAAC,MAAM,SAAS,CAAC;AAW/C,KAAK,QAAQ,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,OAAO,SAAS,CAAC,CAAC;AAe3D,qBAAa,OAAO;IAClB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,WAAW,GAAG,SAAS,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC;IAC/B,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC;IACjC,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAE9C,OAAO,CAAC,mBAAmB,CAA8B;IACzD,OAAO,CAAC,eAAe,CAAiB;IACxC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA2B;gBAEpC,IAAI,GAAE,YAAiB;IAqCnC,IAAI,GAAG,IAAI,YAAY,CAEtB;IAED;;OAEG;IACH,sBAAsB,IAAI,MAAM;IAIhC;;OAEG;IACH,oBAAoB,IAAI,IAAI;IAO5B;;OAEG;IACH,IAAI,kBAAkB,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,GAAG,SAAS,EAGxD;IAED;;OAEG;IACH,IAAI,kBAAkB,IAAI,QAAQ,GAAG,IAAI,GAAG,SAAS,CAEpD;IAED;;OAEG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM;IAwBxD;;OAEG;IACG,KAAK,CACT,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,IAAI,GAAE,QAAe,GACpB,OAAO,CAAC,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IA+HrC;;OAEG;IACH,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,QAAQ,GAAG,SAAS;IAS7E;;OAEG;IACG,YAAY,CAChB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,UAAU,EAClB,IAAI,GAAE,QAAe,GACpB,OAAO,CAAC,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IAcrC;;OAEG;IACG,OAAO,CACX,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,UAAU,EAClB,IAAI,GAAE,QAAe,GACpB,OAAO,CAAC,QAAQ,CAAC;IAkDpB;;OAEG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAK/C;;;;;OAKG;IACG,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAwC7D;;;;;OAKG;YACW,OAAO;IAUrB,OAAO,CAAC,SAAS;IAajB,OAAO,CAAC,qBAAqB;CA4B9B"}