@appium/base-driver 8.7.2 → 9.0.0

package/build/lib/basedriver/driver.d.ts

@@ -1,66 +1,20 @@
 /**
  * @implements {SessionHandler<C>}
  * @template {Constraints} C
- * @template {StringRecord} [A=StringRecord]
+ * @template {StringRecord} [CArgs=StringRecord]
  * @extends {DriverCore<C>}
  */
-export class BaseDriverCore<C extends Readonly<Record<string, import("@appium/types").Constraint>>, A extends import("@appium/types").StringRecord = import("@appium/types").StringRecord> extends DriverCore<C> implements SessionHandler<C> {
-    static BASE_DESIRED_CAP_CONSTRAINTS: {
-        readonly platformName: {
-            readonly presence: true;
-            readonly isString: true;
-        };
-        readonly app: {
-            readonly isString: true;
-        };
-        readonly deviceName: {
-            readonly isString: true;
-        };
-        readonly platformVersion: {
-            readonly isString: true;
-        };
-        readonly newCommandTimeout: {
-            readonly isNumber: true;
-        };
-        readonly automationName: {
-            readonly isString: true;
-        };
-        readonly autoLaunch: {
-            readonly isBoolean: true;
-        };
-        readonly udid: {
-            readonly isString: true;
-        };
-        readonly orientation: {
-            readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"];
-        };
-        readonly autoWebview: {
-            readonly isBoolean: true;
-        };
-        readonly noReset: {
-            readonly isBoolean: true;
-        };
-        readonly fullReset: {
-            readonly isBoolean: true;
-        };
-        readonly language: {
-            readonly isString: true;
-        };
-        readonly locale: {
-            readonly isString: true;
-        };
-        readonly eventTimings: {
-            readonly isBoolean: true;
-        };
-        readonly printPageSourceOnFindFailure: {
-            readonly isBoolean: true;
-        };
-    };
-    constructor(opts?: import("./core").DriverOpts<C>, shouldValidateCaps?: boolean | undefined);
+export class BaseDriverCore<C extends Readonly<Record<string, import("@appium/types").Constraint>>, CArgs extends import("@appium/types").StringRecord = import("@appium/types").StringRecord> extends DriverCore<C> implements SessionHandler<C> {
     /**
-     * @type {A & ServerArgs}
+     *
+     * @param {DriverOpts<C>} opts
+     * @param {boolean} shouldValidateCaps
+     */
+    constructor(opts?: DriverOpts<C>, shouldValidateCaps?: boolean);
+    /**
+     * @type {CArgs & ServerArgs}
      */
-    cliArgs: A & ServerArgs;
+    cliArgs: CArgs & ServerArgs;
     /**
      * @type {Capabilities<C>}
      */
@@ -86,57 +40,7 @@ export class BaseDriverCore<C extends Readonly<Record<string, import("@appium/ty
      * @type {Readonly<BaseDriverCapConstraints & C>}
      * @protected
      */
-    protected get _desiredCapConstraints(): Readonly<{
-        readonly platformName: {
-            readonly presence: true;
-            readonly isString: true;
-        };
-        readonly app: {
-            readonly isString: true;
-        };
-        readonly deviceName: {
-            readonly isString: true;
-        };
-        readonly platformVersion: {
-            readonly isString: true;
-        };
-        readonly newCommandTimeout: {
-            readonly isNumber: true;
-        };
-        readonly automationName: {
-            readonly isString: true;
-        };
-        readonly autoLaunch: {
-            readonly isBoolean: true;
-        };
-        readonly udid: {
-            readonly isString: true;
-        };
-        readonly orientation: {
-            readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"];
-        };
-        readonly autoWebview: {
-            readonly isBoolean: true;
-        };
-        readonly noReset: {
-            readonly isBoolean: true;
-        };
-        readonly fullReset: {
-            readonly isBoolean: true;
-        };
-        readonly language: {
-            readonly isString: true;
-        };
-        readonly locale: {
-            readonly isString: true;
-        };
-        readonly eventTimings: {
-            readonly isBoolean: true;
-        };
-        readonly printPageSourceOnFindFailure: {
-            readonly isBoolean: true;
-        };
-    } & C>;
+    protected get _desiredCapConstraints(): Readonly<typeof BASE_DESIRED_CAP_CONSTRAINTS & C>;
     /**
      * @param {string} cmd
      * @param  {...any} args
@@ -185,9 +89,9 @@ export class BaseDriverCore<C extends Readonly<Record<string, import("@appium/ty
     deleteSession(sessionId?: string | undefined, driverData?: import("@appium/types").DriverData[] | undefined): Promise<void>;
     /**
      *
-     * @param {Capabilities} caps
+     * @param {Capabilities<C>} caps
      */
-    logExtraCaps(caps: Capabilities): void;
+    logExtraCaps(caps: Capabilities<C>): void;
     /**
      *
      * @param {Capabilities<C>} caps
@@ -195,7 +99,7 @@ export class BaseDriverCore<C extends Readonly<Record<string, import("@appium/ty
      */
     validateDesiredCaps(caps: Capabilities<C>): boolean;
 }
-declare const BaseDriver_base: import("./commands/execute").ExecuteBase;
+declare const BaseDriver_base: import("./commands/execute").ExecuteBase<any>;
 /**
  * This ensures that all of the mixins correctly implement the interface described in {@linkcode Driver}.
  * @template {Constraints} [C={}]
@@ -206,7 +110,6 @@ export class BaseDriver<C extends Readonly<Record<string, import("@appium/types"
 }
 export default BaseDriver;
 export type HTTPMethod = import('@appium/types').HTTPMethod;
-export type ExternalDriver = import('@appium/types').ExternalDriver;
 export type DriverData = import('@appium/types').DriverData;
 export type Constraints = import('@appium/types').Constraints;
 export type Constraint = import('@appium/types').Constraint;
@@ -217,162 +120,13 @@ export type UpdateServerCallback = (app: import('express').Express, httpServer:
 /**
  * This is used to extend {@linkcode BaseDriverCore } by the mixins and also external drivers.
  */
-export type BaseDriverBase<Proto = {}, Static = {}> = import('@appium/types').Class<BaseDriverCore<any, import("@appium/types").StringRecord> & Proto, import('@appium/types').DriverStatic & Static>;
-export type SessionHandler<C extends Readonly<Record<string, import("@appium/types").Constraint>> = {
-    readonly platformName: {
-        readonly presence: true;
-        readonly isString: true;
-    };
-    readonly app: {
-        readonly isString: true;
-    };
-    readonly deviceName: {
-        readonly isString: true;
-    };
-    readonly platformVersion: {
-        readonly isString: true;
-    };
-    readonly newCommandTimeout: {
-        readonly isNumber: true;
-    };
-    readonly automationName: {
-        readonly isString: true;
-    };
-    readonly autoLaunch: {
-        readonly isBoolean: true;
-    };
-    readonly udid: {
-        readonly isString: true;
-    };
-    readonly orientation: {
-        readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"];
-    };
-    readonly autoWebview: {
-        readonly isBoolean: true;
-    };
-    readonly noReset: {
-        readonly isBoolean: true;
-    };
-    readonly fullReset: {
-        readonly isBoolean: true;
-    };
-    readonly language: {
-        readonly isString: true;
-    };
-    readonly locale: {
-        readonly isString: true;
-    };
-    readonly eventTimings: {
-        readonly isBoolean: true;
-    };
-    readonly printPageSourceOnFindFailure: {
-        readonly isBoolean: true;
-    };
-}> = import('@appium/types').SessionHandler<[string, object], void, C>;
-export type Capabilities<C extends Readonly<Record<string, import("@appium/types").Constraint>> = {
-    readonly platformName: {
-        readonly presence: true;
-        readonly isString: true;
-    };
-    readonly app: {
-        readonly isString: true;
-    };
-    readonly deviceName: {
-        readonly isString: true;
-    };
-    readonly platformVersion: {
-        readonly isString: true;
-    };
-    readonly newCommandTimeout: {
-        readonly isNumber: true;
-    };
-    readonly automationName: {
-        readonly isString: true;
-    };
-    readonly autoLaunch: {
-        readonly isBoolean: true;
-    };
-    readonly udid: {
-        readonly isString: true;
-    };
-    readonly orientation: {
-        readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"];
-    };
-    readonly autoWebview: {
-        readonly isBoolean: true;
-    };
-    readonly noReset: {
-        readonly isBoolean: true;
-    };
-    readonly fullReset: {
-        readonly isBoolean: true;
-    };
-    readonly language: {
-        readonly isString: true;
-    };
-    readonly locale: {
-        readonly isString: true;
-    };
-    readonly eventTimings: {
-        readonly isBoolean: true;
-    };
-    readonly printPageSourceOnFindFailure: {
-        readonly isBoolean: true;
-    };
-}, Extra extends void | import("@appium/types").StringRecord = void> = import('@appium/types').Capabilities<C, Extra>;
-export type W3CCapabilities<C extends Readonly<Record<string, import("@appium/types").Constraint>> = {
-    readonly platformName: {
-        readonly presence: true;
-        readonly isString: true;
-    };
-    readonly app: {
-        readonly isString: true;
-    };
-    readonly deviceName: {
-        readonly isString: true;
-    };
-    readonly platformVersion: {
-        readonly isString: true;
-    };
-    readonly newCommandTimeout: {
-        readonly isNumber: true;
-    };
-    readonly automationName: {
-        readonly isString: true;
-    };
-    readonly autoLaunch: {
-        readonly isBoolean: true;
-    };
-    readonly udid: {
-        readonly isString: true;
-    };
-    readonly orientation: {
-        readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"];
-    };
-    readonly autoWebview: {
-        readonly isBoolean: true;
-    };
-    readonly noReset: {
-        readonly isBoolean: true;
-    };
-    readonly fullReset: {
-        readonly isBoolean: true;
-    };
-    readonly language: {
-        readonly isString: true;
-    };
-    readonly locale: {
-        readonly isString: true;
-    };
-    readonly eventTimings: {
-        readonly isBoolean: true;
-    };
-    readonly printPageSourceOnFindFailure: {
-        readonly isBoolean: true;
-    };
-}, Extra extends void | import("@appium/types").StringRecord = void> = import('@appium/types').W3CCapabilities<C, Extra>;
-export type ConstraintsToCaps<C extends Readonly<Record<string, import("@appium/types").Constraint>>> = import('@appium/types').ConstraintsToCaps<C>;
-export type Driver<C extends Readonly<Record<string, import("@appium/types").Constraint>>> = import('@appium/types').Driver<C>;
+export type BaseDriverBase<C extends Readonly<Record<string, import("@appium/types").Constraint>>, Proto = {}, Static = {}> = import('@appium/types').Class<BaseDriverCore<C> & Proto, import("@appium/types").DriverStatic<any> & Static>;
+export type SessionHandler<C extends Readonly<Record<string, import("@appium/types").Constraint>> = typeof BASE_DESIRED_CAP_CONSTRAINTS> = import('@appium/types').SessionHandler<[string, object], void, C>;
+export type Capabilities<C extends Readonly<Record<string, import("@appium/types").Constraint>> = typeof BASE_DESIRED_CAP_CONSTRAINTS, Extra extends void | import("@appium/types").StringRecord = void> = import('@appium/types').Capabilities<C, Extra>;
+export type W3CCapabilities<C extends Readonly<Record<string, import("@appium/types").Constraint>> = typeof BASE_DESIRED_CAP_CONSTRAINTS, Extra extends void | import("@appium/types").StringRecord = void> = import('@appium/types').W3CCapabilities<C, Extra>;
+export type Driver<C extends Readonly<Record<string, import("@appium/types").Constraint>> = typeof BASE_DESIRED_CAP_CONSTRAINTS, CArgs extends import("@appium/types").StringRecord = import("@appium/types").StringRecord> = import('@appium/types').Driver<C, CArgs>;
+export type ExternalDriver<C extends Readonly<Record<string, import("@appium/types").Constraint>>> = import('@appium/types').ExternalDriver<C>;
 export type DriverOpts<C extends Readonly<Record<string, import("@appium/types").Constraint>>> = import('@appium/types').DriverOpts<C>;
 import { DriverCore } from "./core";
+import { BASE_DESIRED_CAP_CONSTRAINTS } from "@appium/types";
 //# sourceMappingURL=driver.d.ts.map

package/build/lib/basedriver/driver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../../lib/basedriver/driver.js"],"names":[],"mappings":"AA0BA;;;;;GAKG;AACH,2OAL+B,CAAC;IA4C9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAmE;IAwBxD,6FAmBL;IAjFN;;OAEG;IACH,SAFU,CAAC,GAAG,UAAU,CAEhB;IAER;;OAEG;IACH,MAFU,aAAa,CAAC,CAAC,CAEpB;IAEL;;OAEG;IACH,cAFU,gBAAgB,CAAC,CAAC,CAEf;IAEb;;OAEG;IACH,uBAFU,CAAC,CAEW;IAEtB;;OAEG;IACH,MAFU,WAAW,CAAC,CAAC,GAAG,WAAW,wBAAwB,CAAC,CAEzD;IAEL;;;;;;;;OAQG;IACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAEC;IAQD;;;;OAIG;IACH,oBAJW,MAAM,WACF,GAAG,KACL,QAAQ,GAAG,CAAC,CAsExB;IAED;;;OAGG;IACH,8BAFW,KAAK,GAAC,OAAO,oBAAoB,EAAE,iBAAiB,iBAc9D;IAED,wCAmBC;IAED;;;;;;OAMG;IACH,qBALW,OAAO,eAAe,EAAE,YAAY,QACpC,MAAM,QACN,MAAM,QACN,MAAM,QAOhB;IAJC,yDAAoB;IACpB,+BAAsB;IACtB,+BAAsB;IACtB,+BAAsB;IAOxB,uBA+BC;IAfC,oDAAyC;IAiB3C;;;;;;;;;;;OAWG;IACH,gCANW,gBAAgB,CAAC,CAAC,mLAIhB,QAAQ,CAAC,MAAM,EAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAuF7C;IAED;;;;;OAKG;IACH,8GAFa,QAAQ,IAAI,CAAC,CAczB;IAED;;;OAGG;IACH,mBAFW,YAAY,QAYtB;IAED;;;;OAIG;IACH,0BAHW,aAAa,CAAC,CAAC,GACb,OAAO,CAqBnB;CACF;;AAED;;;;GAIG;AACH,+IAFuB,CAAC;IAxYD,kCAAmC;CA0Yc;;yBAI3D,OAAO,eAAe,EAAE,UAAU;6BAClC,OAAO,eAAe,EAAE,cAAc;yBACtC,OAAO,eAAe,EAAE,UAAU;0BAClC,OAAO,eAAe,EAAE,WAAW;yBACnC,OAAO,eAAe,EAAE,UAAU;2BAClC,OAAO,eAAe,EAAE,YAAY;uCACpC,OAAO,eAAe,EAAE,wBAAwB;yBAChD,OAAO,eAAe,EAAE,UAAU;yCAKpC,OAAO,SAAS,EAAE,OAAO,cACzB,OAAO,eAAe,EAAE,YAAY,KAClC,OAAO,WAAW,EAAE,UAAU,CAAC,IAAI,CAAC;;;;sDAOpC,OAAO,eAAe,EAAE,KAAK,CAAC,4DAAiB,KAAK,EAAC,OAAO,eAAe,EAAE,YAAY,GAAG,MAAM,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAKnG,OAAO,eAAe,EAAE,cAAc,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAC,IAAI,EAAE,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uEAMhE,OAAO,eAAe,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uEAM9C,OAAO,eAAe,EAAE,eAAe,CAAC,CAAC,EAAE,KAAK,CAAC;wGAKjD,OAAO,eAAe,EAAE,iBAAiB,CAAC,CAAC,CAAC;6FAK5C,OAAO,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;iGAKjC,OAAO,eAAe,EAAE,UAAU,CAAC,CAAC,CAAC"}
+{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../../lib/basedriver/driver.js"],"names":[],"mappings":"AAyBA;;;;;GAKG;AACH,+OAL+B,CAAC;IA+B9B;;;;OAIG;IACH,mBAHW,WAAW,CAAC,CAAC,uBACb,OAAO,EAcjB;IA1CD;;OAEG;IACH,SAFU,KAAK,GAAG,UAAU,CAEpB;IAER;;OAEG;IACH,MAFU,aAAa,CAAC,CAAC,CAEpB;IAEL;;OAEG;IACH,cAFU,gBAAgB,CAAC,CAAC,CAEf;IAEb;;OAEG;IACH,uBAFU,CAAC,CAEW;IAEtB;;OAEG;IACH,MAFU,WAAW,CAAC,CAAC,GAAG,WAAW,wBAAwB,CAAC,CAEzD;IAqBL;;;;;;;;OAQG;IACH,0FAEC;IAMD;;;;OAIG;IACH,oBAJW,MAAM,WACF,GAAG,KACL,QAAQ,GAAG,CAAC,CAsExB;IAED;;;OAGG;IACH,8BAFW,KAAK,GAAC,OAAO,oBAAoB,EAAE,iBAAiB,iBAc9D;IAED,wCAmBC;IAED;;;;;;OAMG;IACH,qBALW,OAAO,eAAe,EAAE,YAAY,QACpC,MAAM,QACN,MAAM,QACN,MAAM,QAOhB;IAJC,yDAAoB;IACpB,+BAAsB;IACtB,+BAAsB;IACtB,+BAAsB;IAOxB,uBA+BC;IAfC,oDAAyC;IAiB3C;;;;;;;;;;;OAWG;IACH,gCANW,gBAAgB,CAAC,CAAC,mLAIhB,QAAQ,CAAC,MAAM,EAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAiF7C;IAED;;;;;OAKG;IACH,8GAFa,QAAQ,IAAI,CAAC,CAczB;IAED;;;OAGG;IACH,mBAFW,aAAa,CAAC,CAAC,QAYzB;IAED;;;;OAIG;IACH,0BAHW,aAAa,CAAC,CAAC,GACb,OAAO,CAqBnB;CACF;;AAED;;;;GAIG;AACH,+IAFuB,CAAC;IAnZkB,kCAAmC;CAqZL;;yBAI3D,OAAO,eAAe,EAAE,UAAU;yBAClC,OAAO,eAAe,EAAE,UAAU;0BAClC,OAAO,eAAe,EAAE,WAAW;yBACnC,OAAO,eAAe,EAAE,UAAU;2BAClC,OAAO,eAAe,EAAE,YAAY;uCACpC,OAAO,eAAe,EAAE,wBAAwB;yBAChD,OAAO,eAAe,EAAE,UAAU;yCAKpC,OAAO,SAAS,EAAE,OAAO,cACzB,OAAO,eAAe,EAAE,YAAY,KAClC,OAAO,WAAW,EAAE,UAAU,CAAC,IAAI,CAAC;;;;8HAQpC,OAAO,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC,GAAG,KAAK,EAAC,4CAAuC,MAAM,CAAC;2IAKtG,OAAO,eAAe,EAAE,cAAc,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAC,IAAI,EAAE,CAAC,CAAC;2MAMhE,OAAO,eAAe,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC;8MAM9C,OAAO,eAAe,EAAE,eAAe,CAAC,CAAC,EAAE,KAAK,CAAC;8NAMjD,OAAO,eAAe,EAAE,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC;qGAKxC,OAAO,eAAe,EAAE,cAAc,CAAC,CAAC,CAAC;iGAKzC,OAAO,eAAe,EAAE,UAAU,CAAC,CAAC,CAAC"}