@appium/fake-driver 5.1.5 → 5.2.1

package/build/lib/commands/general.js

@@ -1,93 +1,52 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const driver_1 = require("appium/driver");
+const mixin_1 = require("./mixin");
 const ORIENTATIONS = new Set(['LANDSCAPE', 'PORTRAIT']);
-exports.default = {
-    /**
-     * @this {FakeDriver}
-     */
+const GeneralMixin = {
     async title() {
         this.assertWebviewContext();
         return this.appModel.title;
     },
-    /**
-     * @this {FakeDriver}
-     */
     async keys(value) {
         if (!this.focusedElId) {
             throw new driver_1.errors.InvalidElementStateError();
         }
         await this.setValue(value, this.focusedElId);
     },
-    /**
-     * @this {FakeDriver}
-     */
     async setGeoLocation(location) {
         // TODO test this adequately once WD bug is fixed
         this.appModel.lat = location.latitude;
         this.appModel.long = location.longitude;
     },
-    /**
-     * @this {FakeDriver}
-     */
     async getGeoLocation() {
         return this.appModel.currentGeoLocation;
     },
-    /**
-     * @this {FakeDriver}
-     */
     async getPageSource() {
         return this.appModel.rawXml;
     },
-    /**
-     * @this {FakeDriver}
-     */
     async getOrientation() {
         return this.appModel.orientation;
     },
-    /**
-     *
-     * @param {import('../types').FakeDriverCaps['orientation']} o
-     * @this {FakeDriver}
-     */
     async setOrientation(o) {
         if (!ORIENTATIONS.has(o)) {
             throw new driver_1.errors.UnknownError('Orientation must be LANDSCAPE or PORTRAIT');
         }
         this.appModel.orientation = o;
     },
-    /**
-     * @this {FakeDriver}
-     */
     async getScreenshot() {
         return this.appModel.getScreenshot();
     },
-    /**
-     * @this {FakeDriver}
-     */
     async getWindowSize() {
         return { width: this.appModel.width, height: this.appModel.height };
     },
-    /**
-     * @this {FakeDriver}
-     */
     async getWindowRect() {
         return { width: this.appModel.width, height: this.appModel.height, x: 0, y: 0 };
     },
-    /**
-     *
-     * @this {FakeDriver}
-     */
     async performActions(actions) {
         this.appModel.actionLog.push(actions);
     },
-    /**
-     * @this {FakeDriver}
-     */
     async releaseActions() { },
-    /**
-     * @this {FakeDriver}
-     */
     async getLog(type) {
         switch (type) {
             case 'actions':
@@ -96,36 +55,19 @@ exports.default = {
                 throw new Error(`Don't understand log type '${type}'`);
         }
     },
-    /**
-     * @this {FakeDriver}
-     */
     async mobileShake() {
         this.shook = true;
     },
-    /**
-     * @this {FakeDriver}
-     */
     async doubleClick() { },
-    /**
-     * @this {FakeDriver}
-     */
     async execute(script, args) {
         return await this.executeMethod(script, args);
     },
     /**
      * Add two or maybe even three numbers
-     *
-     * @param {number} num1
-     * @param {number} num2
-     * @param {number} [num3]
-     * @returns {Promise<number>}
-     * @this {FakeDriver}
      */
     async fakeAddition(num1, num2, num3 = 0) {
         return num1 + num2 + (num3 ?? 0);
     },
 };
-/**
- * @typedef {import('../driver').FakeDriver} FakeDriver
- */
+(0, mixin_1.mixin)(GeneralMixin);
 //# sourceMappingURL=general.js.map

package/build/lib/commands/general.js.map

@@ -1 +1 @@
-{"version":3,"file":"general.js","sourceRoot":"","sources":["../../../lib/commands/general.js"],"names":[],"mappings":";;AAAA,0CAAqC;AAErC,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;AAExD,kBAAe;IACb;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,KAAK;QACd,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrB,MAAM,IAAI,eAAM,CAAC,wBAAwB,EAAE,CAAC;SAC7C;QACD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,QAAQ;QAC3B,iDAAiD;QACjD,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACtC,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAAC,CAAC;QACpB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACxB,MAAM,IAAI,eAAM,CAAC,YAAY,CAAC,2CAA2C,CAAC,CAAC;SAC5E;QACD,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa;QACjB,OAAO,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa;QACjB,OAAO,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,OAAO;QAC1B,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,KAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,IAAI;QACf,QAAQ,IAAI,EAAE;YACZ,KAAK,SAAS;gBACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;YACjC;gBACE,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,GAAG,CAAC,CAAC;SAC1D;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW;QACf,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,KAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI;QACxB,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,CAAC;QACrC,OAAO,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;IACnC,CAAC;CACF,CAAC;AAEF;;GAEG"}
+{"version":3,"file":"general.js","sourceRoot":"","sources":["../../../lib/commands/general.ts"],"names":[],"mappings":";;AACA,0CAAqC;AAErC,mCAA8B;AAE9B,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;AA0BxD,MAAM,YAAY,GAA2B;IAC3C,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,IAAI,CAAmB,KAAwB;QACnD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrB,MAAM,IAAI,eAAM,CAAC,wBAAwB,EAAE,CAAC;SAC7C;QACD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,cAAc,CAAmB,QAAkB;QACvD,iDAAiD;QACjD,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACtC,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,cAAc,CAAmB,CAAc;QACnD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACxB,MAAM,IAAI,eAAM,CAAC,YAAY,CAAC,2CAA2C,CAAC,CAAC;SAC5E;QACD,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,OAAO,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,OAAO,EAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAC,CAAC;IAChF,CAAC;IAED,KAAK,CAAC,cAAc,CAAmB,OAAyB;QAC9D,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,cAAc,KAAoB,CAAC;IAEzC,KAAK,CAAC,MAAM,CAAmB,IAAY;QACzC,QAAQ,IAAI,EAAE;YACZ,KAAK,SAAS;gBACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;YACjC;gBACE,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,GAAG,CAAC,CAAC;SAC1D;IACH,CAAC;IAED,KAAK,CAAC,WAAW;QACf,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,WAAW,KAAoB,CAAC;IAEtC,KAAK,CAAC,OAAO,CAAmB,MAAc,EAAE,IAAW;QACzD,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAmB,IAAY,EAAE,IAAY,EAAE,IAAI,GAAG,CAAC;QACvE,OAAO,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;IACnC,CAAC;CACF,CAAC;AAEF,IAAA,aAAK,EAAC,YAAY,CAAC,CAAC"}

package/build/lib/commands/index.d.ts

@@ -1,6 +1,14 @@
-export { default as alert } from "./alert";
-export { default as contexts } from "./contexts";
-export { default as element } from "./element";
-export { default as find } from "./find";
-export { default as general } from "./general";
+/**
+ * Export all of the "stuff" from these mixin files.  The mixins themselves are not exported,
+ * but any types/interfaces that they export (e.g., options objects for some command) are exported.
+ *
+ * Mixins must not use `Object.assign()` and are expected to use the `mixin` function in the sibling
+ * `mixin` module.
+ * @module
+ */
+export * from './alert';
+export * from './contexts';
+export * from './element';
+export * from './find';
+export * from './general';
 //# sourceMappingURL=index.d.ts.map

package/build/lib/commands/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/commands/index.js"],"names":[],"mappings":""}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/commands/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC"}

package/build/lib/commands/index.js

@@ -1,19 +1,32 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+/**
+ * Export all of the "stuff" from these mixin files.  The mixins themselves are not exported,
+ * but any types/interfaces that they export (e.g., options objects for some command) are exported.
+ *
+ * Mixins must not use `Object.assign()` and are expected to use the `mixin` function in the sibling
+ * `mixin` module.
+ * @module
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.general = exports.find = exports.element = exports.contexts = exports.alert = void 0;
-var alert_1 = require("./alert");
-Object.defineProperty(exports, "alert", { enumerable: true, get: function () { return __importDefault(alert_1).default; } });
-var contexts_1 = require("./contexts");
-Object.defineProperty(exports, "contexts", { enumerable: true, get: function () { return __importDefault(contexts_1).default; } });
-var element_1 = require("./element");
-Object.defineProperty(exports, "element", { enumerable: true, get: function () { return __importDefault(element_1).default; } });
-var find_1 = require("./find");
-Object.defineProperty(exports, "find", { enumerable: true, get: function () { return __importDefault(find_1).default; } });
-var general_1 = require("./general");
-Object.defineProperty(exports, "general", { enumerable: true, get: function () { return __importDefault(general_1).default; } });
+__exportStar(require("./alert"), exports);
+__exportStar(require("./contexts"), exports);
+__exportStar(require("./element"), exports);
+__exportStar(require("./find"), exports);
+__exportStar(require("./general"), exports);
 /* // TODO:
   //rest.post('/wd/hub/session/:sessionId?/touch/click', controller.doClick);
   //rest.post('/wd/hub/session/:sessionId?/touch/longclick', controller.touchLongClick);

package/build/lib/commands/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/commands/index.js"],"names":[],"mappings":";;;;;;AAAA,iCAAyC;AAAjC,+GAAA,OAAO,OAAS;AACxB,uCAA+C;AAAvC,qHAAA,OAAO,OAAY;AAC3B,qCAA6C;AAArC,mHAAA,OAAO,OAAW;AAC1B,+BAAuC;AAA/B,6GAAA,OAAO,OAAQ;AACvB,qCAA6C;AAArC,mHAAA,OAAO,OAAW;AAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsFE"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/commands/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;;;;;;;;;;;;;;AAEH,0CAAwB;AACxB,6CAA2B;AAC3B,4CAA0B;AAC1B,yCAAuB;AACvB,4CAA0B;AAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsFE"}

package/build/lib/commands/mixin.d.ts

@@ -0,0 +1,11 @@
+import { FakeDriver } from '../driver';
+/**
+ * This function assigns a mixin `T` to the `FakeDriver` class' prototype.
+ * While each mixin has its own interface which is (in isolation) unrelated to `FakeDriver`, the constraint
+ * on this generic type `T` is that it must be a partial of `FakeDriver`'s interface. This enforces
+ * that it does not conflict with the existing interface of `FakeDriver`.  In that way, you can
+ * think of it as a type guard.
+ * @param mixin Mixin implementation
+ */
+export declare function mixin<T extends Partial<FakeDriver>>(mixin: T): void;
+//# sourceMappingURL=mixin.d.ts.map

package/build/lib/commands/mixin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mixin.d.ts","sourceRoot":"","sources":["../../../lib/commands/mixin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,WAAW,CAAC;AAErC;;;;;;;GAOG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,OAAO,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAEnE"}

package/build/lib/commands/mixin.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mixin = void 0;
+const driver_1 = require("../driver");
+/**
+ * This function assigns a mixin `T` to the `FakeDriver` class' prototype.
+ * While each mixin has its own interface which is (in isolation) unrelated to `FakeDriver`, the constraint
+ * on this generic type `T` is that it must be a partial of `FakeDriver`'s interface. This enforces
+ * that it does not conflict with the existing interface of `FakeDriver`.  In that way, you can
+ * think of it as a type guard.
+ * @param mixin Mixin implementation
+ */
+function mixin(mixin) {
+    Object.assign(driver_1.FakeDriver.prototype, mixin);
+}
+exports.mixin = mixin;
+//# sourceMappingURL=mixin.js.map

package/build/lib/commands/mixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mixin.js","sourceRoot":"","sources":["../../../lib/commands/mixin.ts"],"names":[],"mappings":";;;AAAA,sCAAqC;AAErC;;;;;;;GAOG;AACH,SAAgB,KAAK,CAAgC,KAAQ;IAC3D,MAAM,CAAC,MAAM,CAAC,mBAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AAC7C,CAAC;AAFD,sBAEC"}

package/build/lib/driver.d.ts

@@ -1,11 +1,18 @@
+declare const FakeDriver_base: typeof BaseDriver;
+declare const FakeDriver_base_1: typeof BaseDriver;
+declare const FakeDriver_base_2: typeof BaseDriver;
+declare const FakeDriver_base_3: typeof BaseDriver;
+declare const FakeDriver_base_4: typeof BaseDriver;
 /**
+ * Constraints for {@linkcode FakeDriver}'s capabilites
  * @typedef {typeof FAKE_DRIVER_CONSTRAINTS} FakeDriverConstraints
  */
 /**
+ * @template [Thing=any]
  * @extends {BaseDriver<FakeDriverConstraints>}
  * @implements {ExternalDriver<FakeDriverConstraints>}
  */
-export class FakeDriver extends BaseDriver<{
+export class FakeDriver<Thing = any> extends BaseDriver<{
     readonly app: {
         readonly presence: true;
         readonly isString: true;
@@ -13,7 +20,7 @@ export class FakeDriver extends BaseDriver<{
     readonly uniqueApp: {
         readonly isBoolean: true;
     };
-}> implements ExternalDriver<FakeDriverConstraints> {
+}, import("@appium/types").StringRecord>, FakeDriver_base, FakeDriver_base_1, FakeDriver_base_2, FakeDriver_base_3, FakeDriver_base_4 implements ExternalDriver<FakeDriverConstraints> {
     static newMethodMap: {
         readonly '/session/:sessionId/fakedriver': {
             readonly GET: {
@@ -72,8 +79,7 @@ export class FakeDriver extends BaseDriver<{
     };
     static fakeRoute(req: any, res: any): void;
     static updateServer(expressApp: any, httpServer: any, cliArgs: any): Promise<void>;
-    constructor(opts?: {}, shouldValidateCaps?: boolean);
-    desiredCapConstraints: {
+    constructor(opts?: import("@appium/types").DriverOpts<{
         readonly app: {
             readonly presence: true;
             readonly isString: true;
@@ -81,16 +87,28 @@ export class FakeDriver extends BaseDriver<{
         readonly uniqueApp: {
             readonly isBoolean: true;
         };
-    };
+    }>, shouldValidateCaps?: boolean);
+    /**
+     * @type {FakeDriverConstraints}
+     * @readonly
+     */
+    readonly desiredCapConstraints: FakeDriverConstraints;
     /** @type {string} */
     curContext: string;
+    /** @type {FakeApp} */
     appModel: FakeApp;
-    elMap: {};
-    focusedElId: any;
-    maxElId: number;
-    fakeThing: any;
+    /** @type {boolean} */
     _proxyActive: boolean;
+    /** @type {boolean} */
     shook: boolean;
+    /** @type {string?} */
+    focusedElId: string | null;
+    /** @type {Thing?} */
+    fakeThing: Thing | null;
+    /** @type {number} */
+    maxElId: number;
+    /** @type {Record<string,import('./fake-element').FakeElement>} */
+    elMap: Record<string, import('./fake-element').FakeElement>;
     proxyActive(): boolean;
     canProxy(): boolean;
     proxyReqRes(req: any, res: any): void;
@@ -106,7 +124,7 @@ export class FakeDriver extends BaseDriver<{
      * @param {W3CFakeDriverCaps} [w3cCapabilities3] W3C Capabilities
      * @param {import('@appium/types').DriverData[]} [driverData] Other session data
      * @override
-     * @returns {Promise<[string,FakeDriverCaps]>} Session ID and normalized capabilities
+     * @returns {Promise<[string,FakeDriverCaps]>}
      */
     override createSession(w3cCapabilities1: W3CFakeDriverCaps, w3cCapabilities2?: import("./types").W3CFakeDriverCaps | undefined, w3cCapabilities3?: import("./types").W3CFakeDriverCaps | undefined, driverData?: import("@appium/types").DriverData[] | undefined): Promise<[string, Partial<import("@appium/types").ConstraintsToCaps<typeof import("@appium/types").BASE_DESIRED_CAP_CONSTRAINTS & {
         readonly app: {
@@ -120,14 +138,14 @@ export class FakeDriver extends BaseDriver<{
     get driverData(): {
         isUnique: boolean;
     };
-    getFakeThing(): Promise<any>;
+    getFakeThing(): Promise<Thing | null>;
     /**
      * Set the 'thing' value (so that it can be retrieved later)
      *
-     * @param {any} thing
+     * @param {Thing} thing
      * @returns {Promise<null>}
      */
-    setFakeThing(thing: any): Promise<null>;
+    setFakeThing(thing: Thing): Promise<null>;
     /**
      * Get the driver args that were sent in via the CLI
      *
@@ -146,92 +164,19 @@ export class FakeDriver extends BaseDriver<{
      * @returns {Promise<void>}
      */
     callDeprecatedCommand(): Promise<void>;
-    /*********
-     * ALERT *
-     *********/
-    assertNoAlert: (this: FakeDriver) => void;
-    assertAlert: (this: FakeDriver) => void;
-    getAlertText: (this: FakeDriver) => Promise<string>;
-    setAlertText: (this: FakeDriver, text: string) => Promise<void>;
-    postAcceptAlert: (this: FakeDriver) => Promise<void>;
-    postDismissAlert: (this: FakeDriver) => Promise<void>;
-    /************
-     * CONTEXTS *
-     ************/
-    getRawContexts: (this: FakeDriver) => {
-        NATIVE_APP: null;
-        PROXY: null;
-    };
-    assertWebviewContext: (this: FakeDriver) => void;
-    getCurrentContext: (this: FakeDriver) => Promise<string>;
-    getContexts: (this: FakeDriver) => Promise<string[]>;
-    setContext: (this: FakeDriver, context: string) => Promise<void>;
-    setFrame: (this: FakeDriver, frameId: number) => Promise<void>;
-    /************
-     * ELEMENTS *
-     ************/
-    getElements: (this: FakeDriver, elIds: any) => any;
-    getElement: (this: FakeDriver, elId: any) => any;
-    getName: (this: FakeDriver, elementId: any) => Promise<any>;
-    elementDisplayed: (this: FakeDriver, elementId: any) => Promise<any>;
-    elementEnabled: (this: FakeDriver, elementId: any) => Promise<any>;
-    elementSelected: (this: FakeDriver, elementId: any) => Promise<any>;
-    setValue: (this: FakeDriver, keys: any, elementId: any) => Promise<void>;
-    getText: (this: FakeDriver, elementId: any) => Promise<any>;
-    clear: (this: FakeDriver, elementId: any) => Promise<void>;
-    click: (this: FakeDriver, elementId: string) => Promise<void>;
-    getAttribute: (this: FakeDriver, attr: any, elementId: any) => Promise<any>;
-    getElementRect: (this: FakeDriver, elementId: any) => any;
-    getSize: (this: FakeDriver, elementId: any) => any;
-    equalsElement: (this: FakeDriver, el1Id: any, el2Id: any) => any;
-    getCssProperty: (this: FakeDriver, prop: any, elementId: any) => Promise<any>;
-    getLocation: (this: FakeDriver, elementId: string) => Promise<any>;
-    getLocationInView: (this: FakeDriver, elementId: any) => Promise<any>;
-    /********
-     * FIND *
-     ********/
-    getExistingElementForNode: (this: FakeDriver, node: any) => string | null;
-    wrapNewEl: (this: FakeDriver, obj: any) => {
-        ELEMENT: string;
-    };
-    findElOrEls: <Mult extends boolean, Ctx = any>(this: FakeDriver, strategy: string, selector: string, mult: Mult, context?: Ctx | undefined) => Promise<Mult extends true ? import("@appium/types").Element[] : import("@appium/types").Element>;
-    findElements: (this: FakeDriver, strategy: any, selector: any) => Promise<import("@appium/types").Element[]>;
-    findElementFromElement: (this: FakeDriver, strategy: any, selector: any, elementId: any) => Promise<import("@appium/types").Element>;
-    findElementsFromElement: (this: FakeDriver, strategy: any, selector: any, elementId: any) => Promise<import("@appium/types").Element[]>;
-    /***********
-     * GENERAL *
-     ***********/
-    title: (this: FakeDriver) => Promise<any>;
-    keys: (this: FakeDriver, value: any) => Promise<void>;
-    setGeoLocation: (this: FakeDriver, location: any) => Promise<void>;
-    getGeoLocation: (this: FakeDriver) => Promise<import("@appium/types").Location>;
-    getOrientation: (this: FakeDriver) => Promise<string>;
-    setOrientation: (this: FakeDriver, o: any) => Promise<void>;
-    getScreenshot: (this: FakeDriver) => Promise<string>;
-    getWindowSize: (this: FakeDriver) => Promise<{
-        width: number;
-        height: number;
-    }>;
-    getWindowRect: (this: FakeDriver) => Promise<{
-        width: number;
-        height: number;
-        x: number;
-        y: number;
-    }>;
-    performActions: (this: FakeDriver, actions: any) => Promise<void>;
-    getLog: (this: FakeDriver, type: any) => Promise<any[]>;
-    mobileShake: (this: FakeDriver) => Promise<void>;
-    doubleClick: (this: FakeDriver) => Promise<void>;
-    execute: (this: FakeDriver, script: any, args: any) => Promise<any>;
-    fakeAddition: (this: FakeDriver, num1: number, num2: number, num3?: number | undefined) => Promise<number>;
-    releaseActions: (this: FakeDriver) => Promise<void>;
 }
+export * from "./commands";
 export default FakeDriver;
+/**
+ * Constraints for {@linkcode FakeDriver }'s capabilites
+ */
 export type FakeDriverConstraints = typeof FAKE_DRIVER_CONSTRAINTS;
 export type FakeDriverCaps = import('./types').FakeDriverCaps;
 export type W3CFakeDriverCaps = import('./types').W3CFakeDriverCaps;
-export type DriverClass<D extends import("@appium/types").Driver<typeof import("@appium/types").BASE_DESIRED_CAP_CONSTRAINTS, import("@appium/types").StringRecord, any>> = import('@appium/types').DriverClass<D>;
+export type Element = import('@appium/types').Element;
+export type DriverClass<D extends import("@appium/types").Driver<Readonly<Record<string, import("@appium/types").Constraint>>, import("@appium/types").StringRecord>> = import('@appium/types').DriverClass<D>;
 export type ExternalDriver<C extends Readonly<Record<string, import("@appium/types").Constraint>>> = import('@appium/types').ExternalDriver<C>;
+export type Orientation = import('@appium/types').Orientation;
 import { BaseDriver } from "@appium/base-driver";
 import { FakeApp } from "./fake-app";
 declare namespace FAKE_DRIVER_CONSTRAINTS {

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

@@ -1 +1 @@
-{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../lib/driver.js"],"names":[],"mappings":"AAgBA;;GAEG;AAEH;;;GAGG;AACH;;;;;;;;6BAF+B,qBAAqB;IAkIlD;;;;;YAGI;;eAEG;;;;;;;;;;;;;;;;;;;;;;;;MAaJ;IAEH;;;;;;;;QAKE;;WAEG;;;;;;;;;;;;;MAWF;IAEH,2CAEC;IAED,mFAMC;IA1KD,qDASC;IAhBD;;;;;;;;MAAgD;IAEhD,qBAAqB;IACrB,YADW,MAAM,CACN;IAEX,kBAAyB;IAKvB,UAAe;IACf,iBAAuB;IACvB,gBAAgB;IAChB,eAAqB;IACrB,sBAAyB;IACzB,eAAkB;IAGpB,uBAEC;IAED,oBAEC;IAED,sCAOC;IAED;;;OAGG;IACH,oCAEC;IAED;;;;;;;;OAQG;IACH,yCAPW,iBAAiB;;;;;;;;iBA4B3B;IAED;;MAIC;IAED,6BAGC;IAED;;;;;OAKG;IACH,oBAHW,GAAG,GACD,QAAQ,IAAI,CAAC,CAMzB;IAED;;;;OAIG;IACH,qBAFa,QAAQ,OAAO,IAAI,CAAC,OAAO,CAAC,CAKxC;IAED;;;;OAIG;IACH,+BAFa,QAAQ,MAAM,EAAE,CAAC,CAK7B;IAED;;;;OAIG;IACH,yBAFa,QAAQ,IAAI,CAAC,CAIzB;IAsDD;;eAEW;IACX,0CAAoC;IACpC,wCAAgC;IAChC,oDAAkC;IAClC,gEAAkC;IAClC,qDAAwC;IACxC,sDAA0C;IAE1C;;kBAEc;IACd;;;MAAyC;IACzC,iDAAqD;IACrD,yDAA+C;IAC/C,qDAAmC;IACnC,iEAAiC;IACjC,+DAA6B;IAE7B;;kBAEc;IACd,mDAAkC;IAClC,iDAAgC;IAChC,4DAA0B;IAC1B,qEAA4C;IAC5C,mEAAwC;IACxC,oEAA0C;IAC1C,yEAA4B;IAC5B,4DAA0B;IAC1B,2DAAsB;IACtB,8DAAsB;IACtB,4EAAoC;IACpC,0DAAwC;IACxC,mDAA0B;IAC1B,iEAAsC;IACtC,8EAAwC;IACxC,mEAAkC;IAClC,sEAA8C;IAE9C;;cAEU;IACV,0EAA2D;IAC3D;;MAA2B;IAC3B,gPAA+B;IAE/B,6GAAiC;IACjC,qIAAqD;IACrD,wIAAuD;IAEvD;;iBAEa;IACb,0CAAsB;IACtB,sDAAoB;IACpB,mEAAwC;IACxC,gFAAwC;IAExC,sDAAwC;IACxC,4DAAwC;IACxC,qDAAsC;IACtC;;;OAAsC;IACtC;;;;;OAAsC;IACtC,kEAAwC;IACxC,wDAAwB;IACxB,iDAAkC;IAClC,iDAAkC;IAClC,oEAA0B;IAC1B,2GAAoC;IACpC,oDAAwC;CACzC;;oCAnQY,8BAA8B;6BAwQ9B,OAAO,SAAS,EAAE,cAAc;gCAChC,OAAO,SAAS,EAAE,iBAAiB;4KAKnC,OAAO,eAAe,EAAE,WAAW,CAAC,CAAC,CAAC;qGAKtC,OAAO,eAAe,EAAE,cAAc,CAAC,CAAC,CAAC"}
+{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../lib/driver.js"],"names":[],"mappings":";;;;;AAeA;;;GAGG;AAEH;;;;GAIG;AACH;;;;;;;;gKAF+B,qBAAqB;IA8JlD;;;;;YAGI;;eAEG;;;;;;;;;;;;;;;;;;;;;;;;MAaJ;IAEH;;;;;;;;QAKE;;WAEG;;;;;;;;;;;;;MAWF;IAEH,2CAEC;IAED,mFAMC;IA/KD;;;;;;;;sCAcC;IA5CD;;;OAGG;IACH,gCAHU,qBAAqB,CAGT;IAEtB,qBAAqB;IACrB,YADW,MAAM,CACN;IAEX,sBAAsB;IACtB,UADW,OAAO,CACT;IAET,sBAAsB;IACtB,cADW,OAAO,CACL;IAEb,sBAAsB;IACtB,OADW,OAAO,CACZ;IAEN,sBAAsB;IACtB,aADW,MAAM,QACL;IAEZ,qBAAqB;IACrB,WADW,KAAK,QACN;IAEV,qBAAqB;IACrB,SADW,MAAM,CACT;IAER,kEAAkE;IAClE,OADW,OAAO,MAAM,EAAC,OAAO,gBAAgB,EAAE,WAAW,CAAC,CACxD;IAkBN,uBAEC;IAED,oBAEC;IAED,sCAOC;IAED;;;OAGG;IACH,oCAEC;IAED;;;;;;;;OAQG;IACH,yCAPW,iBAAiB;;;;;;;;iBA4B3B;IAED;;MAIC;IAED,sCAGC;IAED;;;;;OAKG;IACH,oBAHW,KAAK,GACH,QAAQ,IAAI,CAAC,CAMzB;IAED;;;;OAIG;IACH,qBAFa,QAAQ,OAAO,IAAI,CAAC,OAAO,CAAC,CAKxC;IAED;;;;OAIG;IACH,+BAFa,QAAQ,MAAM,EAAE,CAAC,CAK7B;IAED;;;;OAIG;IACH,yBAFa,QAAQ,IAAI,CAAC,CAIzB;CAqDF;;;;;;oCAvNY,8BAA8B;6BA+N9B,OAAO,SAAS,EAAE,cAAc;gCAChC,OAAO,SAAS,EAAE,iBAAiB;sBACnC,OAAO,eAAe,EAAE,OAAO;wKAK/B,OAAO,eAAe,EAAE,WAAW,CAAC,CAAC,CAAC;qGAKtC,OAAO,eAAe,EAAE,cAAc,CAAC,CAAC,CAAC;0BAIzC,OAAO,eAAe,EAAE,WAAW"}

package/build/lib/driver.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -8,7 +22,6 @@ const bluebird_1 = __importDefault(require("bluebird"));
 const driver_1 = require("appium/driver");
 const protocol_1 = require("@appium/base-driver/build/lib/protocol/protocol");
 const fake_app_1 = require("./fake-app");
-const commands_1 = require("./commands");
 const FAKE_DRIVER_CONSTRAINTS = /** @type {const} */ ({
     app: {
         presence: true,
@@ -19,85 +32,17 @@ const FAKE_DRIVER_CONSTRAINTS = /** @type {const} */ ({
     },
 });
 /**
+ * Constraints for {@linkcode FakeDriver}'s capabilites
  * @typedef {typeof FAKE_DRIVER_CONSTRAINTS} FakeDriverConstraints
  */
 /**
+ * @template [Thing=any]
  * @extends {BaseDriver<FakeDriverConstraints>}
  * @implements {ExternalDriver<FakeDriverConstraints>}
  */
 class FakeDriver extends driver_1.BaseDriver {
-    constructor(opts = {}, shouldValidateCaps = true) {
+    constructor(opts = /** @type {import('@appium/types').DriverOpts<FakeDriverConstraints>} */ ({}), shouldValidateCaps = true) {
         super(opts, shouldValidateCaps);
-        this.desiredCapConstraints = FAKE_DRIVER_CONSTRAINTS;
-        this.appModel = new fake_app_1.FakeApp();
-        /*********
-         * ALERT *
-         *********/
-        this.assertNoAlert = commands_1.alert.assertNoAlert;
-        this.assertAlert = commands_1.alert.assertAlert;
-        this.getAlertText = commands_1.alert.getAlertText;
-        this.setAlertText = commands_1.alert.setAlertText;
-        this.postAcceptAlert = commands_1.alert.postAcceptAlert;
-        this.postDismissAlert = commands_1.alert.postDismissAlert;
-        /************
-         * CONTEXTS *
-         ************/
-        this.getRawContexts = commands_1.contexts.getRawContexts;
-        this.assertWebviewContext = commands_1.contexts.assertWebviewContext;
-        this.getCurrentContext = commands_1.contexts.getCurrentContext;
-        this.getContexts = commands_1.contexts.getContexts;
-        this.setContext = commands_1.contexts.setContext;
-        this.setFrame = commands_1.contexts.setFrame;
-        /************
-         * ELEMENTS *
-         ************/
-        this.getElements = commands_1.element.getElements;
-        this.getElement = commands_1.element.getElement;
-        this.getName = commands_1.element.getName;
-        this.elementDisplayed = commands_1.element.elementDisplayed;
-        this.elementEnabled = commands_1.element.elementEnabled;
-        this.elementSelected = commands_1.element.elementSelected;
-        this.setValue = commands_1.element.setValue;
-        this.getText = commands_1.element.getText;
-        this.clear = commands_1.element.clear;
-        this.click = commands_1.element.click;
-        this.getAttribute = commands_1.element.getAttribute;
-        this.getElementRect = commands_1.element.getElementRect;
-        this.getSize = commands_1.element.getSize;
-        this.equalsElement = commands_1.element.equalsElement;
-        this.getCssProperty = commands_1.element.getCssProperty;
-        this.getLocation = commands_1.element.getLocation;
-        this.getLocationInView = commands_1.element.getLocationInView;
-        /********
-         * FIND *
-         ********/
-        this.getExistingElementForNode = commands_1.find.getExistingElementForNode;
-        this.wrapNewEl = commands_1.find.wrapNewEl;
-        this.findElOrEls = commands_1.find.findElOrEls;
-        this.findElement = commands_1.find.findElement;
-        this.findElements = commands_1.find.findElements;
-        this.findElementFromElement = commands_1.find.findElementFromElement;
-        this.findElementsFromElement = commands_1.find.findElementsFromElement;
-        /***********
-         * GENERAL *
-         ***********/
-        this.title = commands_1.general.title;
-        this.keys = commands_1.general.keys;
-        this.setGeoLocation = commands_1.general.setGeoLocation;
-        this.getGeoLocation = commands_1.general.getGeoLocation;
-        this.getPageSource = commands_1.general.getPageSource;
-        this.getOrientation = commands_1.general.getOrientation;
-        this.setOrientation = commands_1.general.setOrientation;
-        this.getScreenshot = commands_1.general.getScreenshot;
-        this.getWindowSize = commands_1.general.getWindowSize;
-        this.getWindowRect = commands_1.general.getWindowRect;
-        this.performActions = commands_1.general.performActions;
-        this.getLog = commands_1.general.getLog;
-        this.mobileShake = commands_1.general.mobileShake;
-        this.doubleClick = commands_1.general.doubleClick;
-        this.execute = commands_1.general.execute;
-        this.fakeAddition = commands_1.general.fakeAddition;
-        this.releaseActions = commands_1.general.releaseActions;
         this.curContext = 'NATIVE_APP';
         this.elMap = {};
         this.focusedElId = null;
@@ -105,6 +50,8 @@ class FakeDriver extends driver_1.BaseDriver {
         this.fakeThing = null;
         this._proxyActive = false;
         this.shook = false;
+        this.appModel = new fake_app_1.FakeApp();
+        this.desiredCapConstraints = FAKE_DRIVER_CONSTRAINTS;
     }
     proxyActive() {
         return this._proxyActive;
@@ -134,7 +81,7 @@ class FakeDriver extends driver_1.BaseDriver {
      * @param {W3CFakeDriverCaps} [w3cCapabilities3] W3C Capabilities
      * @param {import('@appium/types').DriverData[]} [driverData] Other session data
      * @override
-     * @returns {Promise<[string,FakeDriverCaps]>} Session ID and normalized capabilities
+     * @returns {Promise<[string,FakeDriverCaps]>}
      */
     async createSession(w3cCapabilities1, w3cCapabilities2, w3cCapabilities3, driverData = []) {
         // TODO add validation on caps.app that we will get for free from
@@ -164,7 +111,7 @@ class FakeDriver extends driver_1.BaseDriver {
     /**
      * Set the 'thing' value (so that it can be retrieved later)
      *
-     * @param {any} thing
+     * @param {Thing} thing
      * @returns {Promise<null>}
      */
     async setFakeThing(thing) {
@@ -248,10 +195,13 @@ FakeDriver.executeMethodMap = ({
         command: 'getDeprecatedCommandsCalled',
     },
 });
+// eslint-disable-next-line import/no-unresolved
+__exportStar(require("./commands"), exports);
 exports.default = FakeDriver;
 /**
  * @typedef {import('./types').FakeDriverCaps} FakeDriverCaps
  * @typedef {import('./types').W3CFakeDriverCaps} W3CFakeDriverCaps
+ * @typedef {import('@appium/types').Element} Element
  */
 /**
  * @template {import('@appium/types').Driver} D
@@ -261,4 +211,7 @@ exports.default = FakeDriver;
  * @template {import('@appium/types').Constraints} C
  * @typedef {import('@appium/types').ExternalDriver<C>} ExternalDriver
  */
+/**
+ * @typedef {import('@appium/types').Orientation} Orientation
+ */
 //# sourceMappingURL=driver.js.map