@appium/types - npm Package Compare versions

Comparing version 1.2.1 to 1.3.0

build/lib/command-maps.d.ts

@@ -80,3 +80,3 @@ import type { ConditionalPick, MultidimensionalReadonlyArray } from 'type-fest';
      */
-    readonly command?: keyof ConditionalPick<Required<T>, DriverCommand>;
+    readonly command?: keyof ConditionalPick<Required<T>, PluginCommand>;
 }
@@ -83,0 +83,0 @@ /**

build/lib/driver.d.ts

@@ -118,8 +118,43 @@ import type { EventEmitter } from 'node:events';
     /**
-     * The set of command line arguments set for this driver
+     * The set of command line arguments set for this driver.
+     *
+     * These are derived from the Appium server configuration for this
+     * particular driver (CLI flags and/or config files). They are **not**
+     * user capabilities and cannot be influenced by test code.
      */
     cliArgs: CArgs;
+    /**
+     * The underlying HTTP server instance hosting this driver.
+     *
+     * This is assigned by the Appium server when a session is created.
+     * It is primarily useful for advanced integrations (for example,
+     * when a driver or plugin needs direct access to the web server).
+     */
     server?: AppiumServer;
+    /**
+     * The hostname or IP address on which the Appium server is listening.
+     *
+     * This is assigned by the Appium server when a session is created,
+     * based on the `--address` (or equivalent config) used to start the
+     * server. It can be used by drivers which need to construct URLs that
+     * point back to the Appium server.
+     */
     serverHost?: string;
+    /**
+     * The TCP port on which the Appium server is listening.
+     *
+     * This is assigned by the Appium server when a session is created,
+     * based on the `--port` (or equivalent config) used to start the
+     * server. It is often used together with {@link Driver.serverHost}
+     * and {@link Driver.serverPath} to build callback or proxy URLs.
+     */
     serverPort?: number;
+    /**
+     * The base path under which WebDriver routes are exposed.
+     *
+     * This is assigned by the Appium server when a session is created,
+     * based on the `--base-path` (or equivalent config) used to start the
+     * server. For example, this might be an empty string (`''`) or
+     * `'/wd/hub'`.
+     */
     serverPath?: string;
@@ -126,0 +161,0 @@ /**

build/lib/driver.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../lib/driver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,EAAC,YAAY,EAAE,UAAU,EAAE,eAAe,EAAC,MAAM,gBAAgB,CAAC;AAC9E,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,SAAS,EACV,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EACV,0BAA0B,EAC1B,0BAA0B,EAC1B,UAAU,EACV,YAAY,EACZ,oBAAoB,EACpB,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAC,WAAW,EAAE,UAAU,EAAC,MAAM,QAAQ,CAAC;AACpD,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,EAAC,YAAY,EAAE,oBAAoB,EAAC,MAAM,UAAU,CAAC;AACjE,OAAO,KAAK,EAAC,KAAK,EAAE,YAAY,EAAC,MAAM,QAAQ,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,YAAY;IACrD,MAAM,CAAC,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,WAAW,IAAI,CAAC,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,YAAY,EAAE,CACZ,GAAG,EAAE,MAAM,EACX,sBAAsB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,mBAAmB,KAC7D,OAAO,CAAC,MAAM,CAAC,CAAC;IACrB,iBAAiB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;IAC5C,aAAa,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC,CAAC;IACvE,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IACrD,uBAAuB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;CACtE;AAED,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAChG,IAAI,EAAE,MAAM,CAAC,EACb,QAAQ,EAAE,OAAO,EACjB,QAAQ,EAAE,OAAO,KACd,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,MAAM,MAAM,QAAQ,GAAG,SAAS,GAAG,KAAK,CAAC;AAEzC;;;;GAIG;AACH,MAAM,WAAW,IAAI,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,SAAS,YAAY,GAAG,YAAY;IACvF,kBAAkB,EAAE,OAAO,CAAC;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,0BAA0B,EAAE,MAAM,CAAC;IACnC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,OAAO,EAAE,aAAa,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB,EAAE,OAAO,CAAC;IAChC,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;IACpC,GAAG,EAAE,YAAY,CAAC;IAClB,UAAU,EAAE,UAAU,CAAC;IACvB,sBAAsB,EAAE,OAAO,CAAC;IAChC,YAAY,EAAE,YAAY,CAAC;IAC3B,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACxC,kBAAkB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;IAC9C,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,IAAI,CAAC;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1B,aAAa,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3C,aAAa,IAAI,OAAO,CAAC;IACzB,iBAAiB,IAAI,OAAO,CAAC;IAC7B,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IACxC,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,uBAAuB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACtE,WAAW,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACzC,IAAI,YAAY,IAAI,MAAM,GAAG,IAAI,CAAC;IAClC,iBAAiB,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,YAAY,EAAE,CAAC;IACtD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACtC,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC;IACzF,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,iBAAiB,IAAI,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;IAC3C,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;CAC/D;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,MAAM,CACrB,CAAC,SAAS,WAAW,GAAG,WAAW,EACnC,KAAK,SAAS,YAAY,GAAG,YAAY,EACzC,QAAQ,SAAS,YAAY,GAAG,YAAY,EAC5C,YAAY,GAAG,0BAA0B,CAAC,CAAC,CAAC,EAC5C,YAAY,GAAG,0BAA0B,EACzC,WAAW,SAAS,YAAY,GAAG,YAAY,CAC/C,SAAQ,oBAAoB,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,EAChF,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC;IAEf,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IAIpB;;;;;;;OAOG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAG1D;;;;;;;;;OASG;IACH,kBAAkB,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAEzD;;;OAGG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE7E;;;;;OAKG;IACH,uBAAuB,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;OAGG;IACH,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAElC;;OAEG;IACH,qBAAqB,EAAE,CAAC,CAAC;IAsBzB;;;;;;;;OAQG;IACH,YAAY,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrF;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc,CAC7B,CAAC,SAAS,WAAW,GAAG,WAAW,EACnC,GAAG,GAAG,MAAM,EACZ,KAAK,SAAS,YAAY,GAAG,YAAY,EACzC,QAAQ,SAAS,YAAY,GAAG,YAAY,EAC5C,YAAY,GAAG,0BAA0B,CAAC,CAAC,CAAC,EAC5C,YAAY,GAAG,0BAA0B,EACzC,WAAW,SAAS,YAAY,GAAG,YAAY,CAC/C,SAAQ,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,EACzE,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,gBAAgB,CAAC,GAAG,CAAC,EACrB,sBAAsB;IACxB;;;;;;;;;;OAUG;IACH,YAAY,CAAC,CAAC,IAAI,GAAG,GAAG,EAAE,IAAI,GAAG,OAAO,EACtC,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,UAAU,EAClB,IAAI,CAAC,EAAE,IAAI,GACV,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM;IAC5C,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,oBAAoB,CAAC;IACpC,YAAY,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAC5B;;;;;;;;;;;;;;;QAeI;IACJ,eAAe,CAAC,EAAE,aAAa,CAAC;IAChC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,KAAK,CACxD,CAAC,EACD,YAAY,CAAC,CAAC,CAAC,EACf;CAAE,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,CAC5D,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AACD;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,WAAW,IAAI,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AAE7D;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,EAAE,OAAO,GAAG,OAAO,IAAI,CACnF,GAAG,IAAI,EAAE,KAAK,KACX,OAAO,CAAC,OAAO,CAAC,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAC3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,OAAO,GAAG,WAAW;IACvD;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB,CAAC,OAAO,GAAG,WAAW;IACvD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;OAUG;IACH,aAAa,CAAC,EAAE,CACd,GAAG,EAAE,kBAAkB,KACpB,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,GAAG,iBAAiB,GAAG,SAAS,CAAC;IAC5E;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,CACX,GAAG,EAAE,kBAAkB,KACpB,OAAO,CAAC,MAAM,CAAC,CAAC;IACrB,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B"}
+{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../lib/driver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,EAAC,YAAY,EAAE,UAAU,EAAE,eAAe,EAAC,MAAM,gBAAgB,CAAC;AAC9E,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,SAAS,EACV,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EACV,0BAA0B,EAC1B,0BAA0B,EAC1B,UAAU,EACV,YAAY,EACZ,oBAAoB,EACpB,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAC,WAAW,EAAE,UAAU,EAAC,MAAM,QAAQ,CAAC;AACpD,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,EAAC,YAAY,EAAE,oBAAoB,EAAC,MAAM,UAAU,CAAC;AACjE,OAAO,KAAK,EAAC,KAAK,EAAE,YAAY,EAAC,MAAM,QAAQ,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,YAAY;IACrD,MAAM,CAAC,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,WAAW,IAAI,CAAC,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,YAAY,EAAE,CACZ,GAAG,EAAE,MAAM,EACX,sBAAsB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,mBAAmB,KAC7D,OAAO,CAAC,MAAM,CAAC,CAAC;IACrB,iBAAiB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;IAC5C,aAAa,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC,CAAC;IACvE,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IACrD,uBAAuB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;CACtE;AAED,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAChG,IAAI,EAAE,MAAM,CAAC,EACb,QAAQ,EAAE,OAAO,EACjB,QAAQ,EAAE,OAAO,KACd,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,MAAM,MAAM,QAAQ,GAAG,SAAS,GAAG,KAAK,CAAC;AAEzC;;;;GAIG;AACH,MAAM,WAAW,IAAI,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,SAAS,YAAY,GAAG,YAAY;IACvF,kBAAkB,EAAE,OAAO,CAAC;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,0BAA0B,EAAE,MAAM,CAAC;IACnC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,OAAO,EAAE,aAAa,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB,EAAE,OAAO,CAAC;IAChC,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;IACpC,GAAG,EAAE,YAAY,CAAC;IAClB,UAAU,EAAE,UAAU,CAAC;IACvB,sBAAsB,EAAE,OAAO,CAAC;IAChC,YAAY,EAAE,YAAY,CAAC;IAC3B,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACxC,kBAAkB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;IAC9C,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,IAAI,CAAC;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1B,aAAa,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3C,aAAa,IAAI,OAAO,CAAC;IACzB,iBAAiB,IAAI,OAAO,CAAC;IAC7B,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IACxC,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,uBAAuB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACtE,WAAW,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACzC,IAAI,YAAY,IAAI,MAAM,GAAG,IAAI,CAAC;IAClC,iBAAiB,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,YAAY,EAAE,CAAC;IACtD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACtC,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC;IACzF,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,iBAAiB,IAAI,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;IAC3C,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;CAC/D;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,MAAM,CACrB,CAAC,SAAS,WAAW,GAAG,WAAW,EACnC,KAAK,SAAS,YAAY,GAAG,YAAY,EACzC,QAAQ,SAAS,YAAY,GAAG,YAAY,EAC5C,YAAY,GAAG,0BAA0B,CAAC,CAAC,CAAC,EAC5C,YAAY,GAAG,0BAA0B,EACzC,WAAW,SAAS,YAAY,GAAG,YAAY,CAC/C,SAAQ,oBAAoB,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,EAChF,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC;IACnB;;;;;;OAMG;IACH,OAAO,EAAE,KAAK,CAAC;IACf;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAIpB;;;;;;;OAOG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAG1D;;;;;;;;;OASG;IACH,kBAAkB,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAEzD;;;OAGG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE7E;;;;;OAKG;IACH,uBAAuB,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;OAGG;IACH,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAElC;;OAEG;IACH,qBAAqB,EAAE,CAAC,CAAC;IAsBzB;;;;;;;;OAQG;IACH,YAAY,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrF;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc,CAC7B,CAAC,SAAS,WAAW,GAAG,WAAW,EACnC,GAAG,GAAG,MAAM,EACZ,KAAK,SAAS,YAAY,GAAG,YAAY,EACzC,QAAQ,SAAS,YAAY,GAAG,YAAY,EAC5C,YAAY,GAAG,0BAA0B,CAAC,CAAC,CAAC,EAC5C,YAAY,GAAG,0BAA0B,EACzC,WAAW,SAAS,YAAY,GAAG,YAAY,CAC/C,SAAQ,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,EACzE,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,gBAAgB,CAAC,GAAG,CAAC,EACrB,sBAAsB;IACxB;;;;;;;;;;OAUG;IACH,YAAY,CAAC,CAAC,IAAI,GAAG,GAAG,EAAE,IAAI,GAAG,OAAO,EACtC,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,UAAU,EAClB,IAAI,CAAC,EAAE,IAAI,GACV,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM;IAC5C,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,oBAAoB,CAAC;IACpC,YAAY,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAC5B;;;;;;;;;;;;;;;QAeI;IACJ,eAAe,CAAC,EAAE,aAAa,CAAC;IAChC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;CACxC;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,KAAK,CACxD,CAAC,EACD,YAAY,CAAC,CAAC,CAAC,EACf;CAAE,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,CAC5D,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AACD;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,WAAW,IAAI,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AAE7D;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,EAAE,OAAO,GAAG,OAAO,IAAI,CACnF,GAAG,IAAI,EAAE,KAAK,KACX,OAAO,CAAC,OAAO,CAAC,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAC3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,OAAO,GAAG,WAAW;IACvD;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB,CAAC,OAAO,GAAG,WAAW;IACvD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;OAUG;IACH,aAAa,CAAC,EAAE,CACd,GAAG,EAAE,kBAAkB,KACpB,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,GAAG,iBAAiB,GAAG,SAAS,CAAC;IAC5E;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,CACX,GAAG,EAAE,kBAAkB,KACpB,OAAO,CAAC,MAAM,CAAC,CAAC;IACrB,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B"}

lib/command-maps.ts

@@ -90,3 +90,3 @@ import type {ConditionalPick, MultidimensionalReadonlyArray} from 'type-fest';
    */
-  readonly command?: keyof ConditionalPick<Required<T>, DriverCommand>;
+  readonly command?: keyof ConditionalPick<Required<T>, PluginCommand>;
 }
@@ -93,0 +93,0 @@

lib/driver.ts

@@ -155,9 +155,43 @@ import type {EventEmitter} from 'node:events';
   /**
-   * The set of command line arguments set for this driver
+   * The set of command line arguments set for this driver.
+   *
+   * These are derived from the Appium server configuration for this
+   * particular driver (CLI flags and/or config files). They are **not**
+   * user capabilities and cannot be influenced by test code.
    */
   cliArgs: CArgs;
-  // The following properties are assigned by appium */
+  /**
+   * The underlying HTTP server instance hosting this driver.
+   *
+   * This is assigned by the Appium server when a session is created.
+   * It is primarily useful for advanced integrations (for example,
+   * when a driver or plugin needs direct access to the web server).
+   */
   server?: AppiumServer;
+  /**
+   * The hostname or IP address on which the Appium server is listening.
+   *
+   * This is assigned by the Appium server when a session is created,
+   * based on the `--address` (or equivalent config) used to start the
+   * server. It can be used by drivers which need to construct URLs that
+   * point back to the Appium server.
+   */
   serverHost?: string;
+  /**
+   * The TCP port on which the Appium server is listening.
+   *
+   * This is assigned by the Appium server when a session is created,
+   * based on the `--port` (or equivalent config) used to start the
+   * server. It is often used together with {@link Driver.serverHost}
+   * and {@link Driver.serverPath} to build callback or proxy URLs.
+   */
   serverPort?: number;
+  /**
+   * The base path under which WebDriver routes are exposed.
+   *
+   * This is assigned by the Appium server when a session is created,
+   * based on the `--base-path` (or equivalent config) used to start the
+   * server. For example, this might be an empty string (`''`) or
+   * `'/wd/hub'`.
+   */
   serverPath?: string;
@@ -164,0 +198,0 @@

package.json

 {
   "name": "@appium/types",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Various type declarations used across Appium",
@@ -40,6 +40,6 @@ "keywords": [
   "dependencies": {
-    "@appium/logger": "^2.0.5",
-    "@appium/schema": "^1.1.0",
-    "@appium/tsconfig": "^1.1.2",
-    "type-fest": "5.4.4"
+    "@appium/logger": "2.0.6",
+    "@appium/schema": "1.1.0",
+    "@appium/tsconfig": "1.1.2",
+    "type-fest": "5.5.0"
   },
@@ -53,3 +53,3 @@ "engines": {
   },
-  "gitHead": "980a121804ae006db879fb6860f627ac36174c15"
+  "gitHead": "7a8965f5c30ffec2ad04ce75903b3960537cef06"
 }

No alert changes

Improved metrics

Total package byte prevSize

311084

1%

Lines of code

7015

0.99%

Dependency changes

• + Added

  @appium/logger@2.0.6
  (transitive)

• + Added

  @appium/schema@1.1.0
  (transitive)

• + Added

  @appium/tsconfig@1.1.2
  (transitive)

• + Added

  @tsconfig/node20@20.1.9
  (transitive)

• + Added

  console-control-strings@1.1.0
  (transitive)

• + Added

  lodash@4.18.1
  (transitive)

• + Added

  lru-cache@11.3.3
  (transitive)

• + Added

  set-blocking@2.0.0
  (transitive)

• + Added

  type-fest@5.5.0
  (transitive)

• - Removed

  @appium/logger@2.0.11
  (transitive)

• - Removed

  @appium/schema@1.3.0
  (transitive)

• - Removed

  @appium/tsconfig@1.2.1
  (transitive)

• - Removed

  @tsconfig/node20@20.1.10
  (transitive)

• - Removed

  lru-cache@11.5.2
  (transitive)

• - Removed

  type-fest@5.4.4
  (transitive)

• - Removed

  typescript@6.0.3
  (transitive)

• Updated

  @appium/logger@2.0.6

• Updated

  @appium/schema@1.1.0

• Updated

  @appium/tsconfig@1.1.2

• Updated

  type-fest@5.5.0