@appium/fake-driver 6.0.2 → 6.1.0

package/build/lib/server.js

@@ -1,12 +1,10 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.startServer = startServer;
-const logger_1 = __importDefault(require("./logger"));
+const logger_1 = require("./logger");
 const driver_1 = require("appium/driver");
 const driver_2 = require("./driver");
+/** Start HTTP server with FakeDriver and default WebDriver routes. */
 async function startServer(port, hostname) {
     const d = new driver_2.FakeDriver();
     const server = await (0, driver_1.server)({
@@ -14,7 +12,7 @@ async function startServer(port, hostname) {
         port,
         hostname,
     });
-    logger_1.default.info(`FakeDriver server listening on http://${hostname}:${port}`);
+    logger_1.log.info(`FakeDriver server listening on http://${hostname}:${port}`);
     return server;
 }
 //# sourceMappingURL=server.js.map

package/build/lib/server.js.map

@@ -1 +1 @@
-{"version":3,"file":"server.js","sourceRoot":"","sources":["../../lib/server.js"],"names":[],"mappings":";;;;;AAeQ,kCAAW;AAfnB,sDAA2B;AAC3B,0CAA6E;AAC7E,qCAAoC;AAEpC,KAAK,UAAU,WAAW,CAAC,IAAI,EAAE,QAAQ;IACvC,MAAM,CAAC,GAAG,IAAI,mBAAU,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAG,MAAM,IAAA,eAAU,EAAC;QAC9B,wBAAwB,EAAE,IAAA,iCAAwB,EAAC,CAAC,CAAC;QACrD,IAAI;QACJ,QAAQ;KACT,CAAC,CAAC;IACH,gBAAG,CAAC,IAAI,CAAC,yCAAyC,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC;IACtE,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../../lib/server.ts"],"names":[],"mappings":";;AAKA,kCASC;AAdD,qCAA6B;AAC7B,0CAA6E;AAC7E,qCAAoC;AAEpC,sEAAsE;AAC/D,KAAK,UAAU,WAAW,CAAC,IAAY,EAAE,QAAgB;IAC9D,MAAM,CAAC,GAAG,IAAI,mBAAU,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAG,MAAM,IAAA,eAAU,EAAC;QAC9B,wBAAwB,EAAE,IAAA,iCAAwB,EAAC,CAAC,CAAC;QACrD,IAAI;QACJ,QAAQ;KACT,CAAC,CAAC;IACH,YAAG,CAAC,IAAI,CAAC,yCAAyC,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC;IACtE,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/build/lib/types.d.ts

@@ -1,5 +1,5 @@
 import type { DriverCaps, W3CDriverCaps } from '@appium/types';
-import type { FakeDriverConstraints } from './driver';
+import type { FakeDriverConstraints } from './desired-caps';
 /**
  * W3C-style caps for {@link FakeDriver}
  * @public

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAE,aAAa,EAAC,MAAM,eAAe,CAAC;AAC7D,OAAO,KAAK,EAAC,qBAAqB,EAAC,MAAM,UAAU,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAErE;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAE,aAAa,EAAC,MAAM,eAAe,CAAC;AAC7D,OAAO,KAAK,EAAC,qBAAqB,EAAC,MAAM,gBAAgB,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAErE;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC"}

package/lib/commands/alert.ts

@@ -1,70 +1,40 @@
-import {FakeDriver} from '../driver';
+import type {FakeDriver} from '../driver';
 import {errors} from 'appium/driver';
-import {mixin} from './mixin';
 
-interface FakeDriverAlertMixin {
-  assertNoAlert(): void;
-  assertAlert(): void;
-
-  getAlertText(): Promise<string>;
-
-  setAlertText(text: string): Promise<void>;
-
-  postAcceptAlert(): Promise<void>;
-  postDismissAlert(): Promise<void>;
+/** Throw if an alert is currently open (blocks other commands). */
+export function assertNoAlert(this: FakeDriver): void {
+  if (this.appModel.hasAlert()) {
+    throw new errors.UnexpectedAlertOpenError();
+  }
 }
 
-declare module '../driver' {
-  interface FakeDriver extends FakeDriverAlertMixin {}
+/** Throw if no alert is open (required before get/set alert text, accept, etc.). */
+export function assertAlert(this: FakeDriver): void {
+  if (!this.appModel.hasAlert()) {
+    throw new errors.NoAlertOpenError();
+  }
 }
 
-const AlertMixin: FakeDriverAlertMixin = {
-  assertNoAlert(this: FakeDriver) {
-    if (this.appModel.hasAlert()) {
-      throw new errors.UnexpectedAlertOpenError();
-    }
-  },
-
-  assertAlert(this: FakeDriver) {
-    if (!this.appModel.hasAlert()) {
-      throw new errors.NoAlertOpenError();
-    }
-  },
-
-  /**
-   * Get the text of an alert
-   */
-  async getAlertText(this: FakeDriver) {
-    this.assertAlert();
-    return this.appModel.alertText();
-  },
-
-  /**
-   * Set the text of an alert
-   */
-  async setAlertText(this: FakeDriver, text: string) {
-    this.assertAlert();
-    try {
-      this.appModel.setAlertText(text);
-    } catch {
-      throw new errors.InvalidElementStateError();
-    }
-  },
+export async function getAlertText(this: FakeDriver): Promise<string> {
+  this.assertAlert();
+  return this.appModel.alertText();
+}
 
-  /**
-   * Accept an alert
-   */
-  async postAcceptAlert(this: FakeDriver) {
-    this.assertAlert();
-    this.appModel.handleAlert();
-  },
+export async function setAlertText(this: FakeDriver, text: string): Promise<void> {
+  this.assertAlert();
+  try {
+    this.appModel.setAlertText(text);
+  } catch {
+    throw new errors.InvalidElementStateError();
+  }
+}
 
-  /**
-   * Dismiss an alert
-   */
-  async postDismissAlert(this: FakeDriver) {
-    return this.postAcceptAlert();
-  },
-};
+export async function postAcceptAlert(this: FakeDriver): Promise<void> {
+  this.assertAlert();
+  this.appModel.handleAlert();
+}
 
-mixin(AlertMixin);
+/** In this fake, dismiss is the same as accept. */
+export async function postDismissAlert(this: FakeDriver): Promise<void> {
+  return this.postAcceptAlert();
+}

package/lib/commands/contexts.ts

@@ -1,84 +1,61 @@
 import _ from 'lodash';
-import {FakeDriver} from '../driver';
+import type {Document as XMLDocument} from '@xmldom/xmldom';
+import type {FakeDriver} from '../driver';
+import type {FakeWebView} from '../fake-app';
 import {errors} from 'appium/driver';
-import {mixin} from './mixin';
-interface FakeDriverContextsMixin {
-  getRawContexts(): Record<string, any>;
-  assertWebviewContext(): void;
-  getCurrentContext(): Promise<string>;
-  getContexts(): Promise<string[]>;
-  setContext(context: string): Promise<void>;
-  setFrame(frame: number | null): Promise<void>;
-}
-declare module '../driver' {
-  interface FakeDriver extends FakeDriverContextsMixin {}
-}
 
-const ContextsMixin: FakeDriverContextsMixin = {
-  getRawContexts(this: FakeDriver) {
-    const contexts = {NATIVE_APP: null, PROXY: null};
-    const wvs = this.appModel.getWebviews() ?? [];
-    for (let i = 1; i < wvs.length + 1; i++) {
-      contexts[`WEBVIEW_${i}`] = wvs[i - 1];
-    }
-    return contexts;
-  },
+/** NATIVE_APP, PROXY, and WEBVIEW_1, WEBVIEW_2, ... from app model. */
+export function getRawContexts(this: FakeDriver): Record<string, unknown> {
+  const contexts: Record<string, unknown> = {NATIVE_APP: null, PROXY: null};
+  const wvs = this.appModel.getWebviews() ?? [];
+  for (let i = 1; i < wvs.length + 1; i++) {
+    contexts[`WEBVIEW_${i}`] = wvs[i - 1];
+  }
+  return contexts;
+}
 
-  assertWebviewContext(this: FakeDriver) {
-    if (this.curContext === 'NATIVE_APP') {
-      throw new errors.InvalidContextError();
-    }
-  },
+/** Throw if current context is NATIVE_APP (e.g. CSS/title require a webview). */
+export function assertWebviewContext(this: FakeDriver): void {
+  if (this.curContext === 'NATIVE_APP') {
+    throw new errors.InvalidContextError();
+  }
+}
 
-  async getCurrentContext(this: FakeDriver): Promise<string> {
-    return this.curContext;
-  },
+export async function getCurrentContext(this: FakeDriver): Promise<string> {
+  return this.curContext;
+}
 
-  /**
-   * Get the list of available contexts
-   */
-  async getContexts(this: FakeDriver) {
-    return _.keys(this.getRawContexts());
-  },
+export async function getContexts(this: FakeDriver): Promise<string[]> {
+  return _.keys(this.getRawContexts());
+}
 
-  /**
-   * Set the current context
-   *
-   * @param context - name of the context
-   */
-  async setContext(this: FakeDriver, context: string) {
-    const contexts = this.getRawContexts();
-    if (context in contexts) {
-      this.curContext = context;
-      if (context === 'NATIVE_APP') {
-        this.appModel.deactivateWebview();
-        this._proxyActive = false;
-      } else if (context === 'PROXY') {
-        this._proxyActive = true;
-      } else {
-        this.appModel.activateWebview(contexts[context]);
-        this._proxyActive = false;
-      }
+export async function setContext(this: FakeDriver, context: string): Promise<void> {
+  const contexts = this.getRawContexts();
+  if (context in contexts) {
+    this.curContext = context;
+    if (context === 'NATIVE_APP') {
+      this.appModel.deactivateWebview();
+      this._proxyActive = false;
+    } else if (context === 'PROXY') {
+      this._proxyActive = true;
     } else {
-      throw new errors.NoSuchContextError();
+      this.appModel.activateWebview(contexts[context] as FakeWebView);
+      this._proxyActive = false;
     }
-  },
+  } else {
+    throw new errors.NoSuchContextError();
+  }
+}
 
-  /**
-   * Set the active frame
-   */
-  async setFrame(this: FakeDriver, frameId: number | null) {
-    this.assertWebviewContext();
-    if (frameId === null) {
-      this.appModel.deactivateFrame();
-    } else {
-      const nodes = this.appModel.xpathQuery(`//iframe[@id="${frameId}"]`);
-      if (!_.isArray(nodes) || _.isEmpty(nodes)) {
-        throw new errors.NoSuchFrameError();
-      }
-      this.appModel.activateFrame(nodes[0]);
+export async function setFrame(this: FakeDriver, frameId: number | null): Promise<void> {
+  this.assertWebviewContext();
+  if (frameId === null) {
+    this.appModel.deactivateFrame();
+  } else {
+    const nodes = this.appModel.xpathQuery(`//iframe[@id="${frameId}"]`);
+    if (!_.isArray(nodes) || _.isEmpty(nodes)) {
+      throw new errors.NoSuchFrameError();
     }
-  },
-};
-
-mixin(ContextsMixin);
+    this.appModel.activateFrame(nodes[0] as XMLDocument);
+  }
+}

package/lib/commands/element.ts

@@ -1,138 +1,125 @@
 import _ from 'lodash';
 import {errors} from 'appium/driver';
-import {FakeDriver} from '../driver';
-import {Position, Rect, Size} from '@appium/types';
-import {FakeElement} from '../fake-element';
-import {mixin} from './mixin';
-
-interface FakeDriverElementsMixin {
-  getElements(elementIds: string[]): FakeElement[];
-  getElement(elementId: string): FakeElement;
-  getName(elementId: string): Promise<string>;
-  elementDisplayed(elementId: string): Promise<boolean>;
-  elementEnabled(elementId: string): Promise<boolean>;
-  elementSelected(elementId: string): Promise<boolean>;
-  setValue(keys: string | string[], value: string): Promise<void>;
-  getText(elementId: string): Promise<string>;
-  clear(elementId: string): Promise<void>;
-  click(elementId: string): Promise<void>;
-
-  getAttribute(elementId: string, attributeName: string): Promise<string>;
-  getElementRect(elementId: string): Promise<Rect>;
-  getSize(elementId: string): Promise<Size>;
-  equalsElement(elementId: string, otherElementId: string): Promise<boolean>;
-  getCssProperty(elementId: string, propertyName: string): Promise<string>;
-  getLocation(elementId: string): Promise<Position>;
-  getLocationInView(elementId: string): Promise<Position>;
-}
-
-declare module '../driver' {
-  interface FakeDriver extends FakeDriverElementsMixin {}
-}
-
-const ElementsMixin: FakeDriverElementsMixin = {
-  getElements(this: FakeDriver, elementIds: string[]) {
-    for (const elId of elementIds) {
-      if (!_.has(this.elMap, elId)) {
-        throw new errors.StaleElementReferenceError();
-      }
+import type {FakeDriver} from '../driver';
+import type {Position, Rect, Size} from '@appium/types';
+import type {FakeElement} from '../fake-element';
+
+/** Resolve element ids to FakeElements; throws StaleElementReferenceError if any id is missing. */
+export function getElements(this: FakeDriver, elementIds: string[]): FakeElement[] {
+  for (const elId of elementIds) {
+    if (!_.has(this.elMap, elId)) {
+      throw new errors.StaleElementReferenceError();
     }
-    return elementIds.map((e) => this.elMap[e]);
-  },
-
-  getElement(this: FakeDriver, elementId: string) {
-    return this.getElements([elementId])[0];
-  },
-
-  async getName(this: FakeDriver, elementId: string) {
-    const el = this.getElement(elementId);
-    return el.tagName;
-  },
-
-  async elementDisplayed(this: FakeDriver, elementId: string) {
-    const el = this.getElement(elementId);
-    return el.isVisible();
-  },
-
-  async elementEnabled(this: FakeDriver, elementId: string) {
-    const el = this.getElement(elementId);
-    return el.isEnabled();
-  },
-
-  async elementSelected(this: FakeDriver, elementId: string) {
-    const el = this.getElement(elementId);
-    return el.isSelected();
-  },
-
-  async setValue(this: FakeDriver, keys: string | string[], elementId: string) {
-    let value = keys;
-    if (keys instanceof Array) {
-      value = keys.join('');
-    }
-    const el = this.getElement(elementId);
-    if (el.type !== 'MockInputField') {
-      throw new errors.InvalidElementStateError();
-    }
-    el.setAttr('value', value);
-  },
-
-  async getText(this: FakeDriver, elementId: string) {
-    const el = this.getElement(elementId);
-    return el.getAttr('value');
-  },
-
-  async clear(this: FakeDriver, elementId: string) {
-    await this.setValue('', elementId);
-  },
-
-  /**
-   * This comment should be displayed instead of the one from ExternalDriver
-   */
-  async click(this: FakeDriver, elementId: string) {
-    this.assertNoAlert();
-    const el = this.getElement(elementId);
-    if (!el.isVisible()) {
-      throw new errors.InvalidElementStateError();
-    }
-    el.click();
-    this.focusedElId = elementId;
-  },
-
-  async getAttribute(this: FakeDriver, attr: string, elementId: string) {
-    const el = this.getElement(elementId);
-    return el.getAttr(attr);
-  },
-
-  async getElementRect(this: FakeDriver, elementId: string) {
-    const el = this.getElement(elementId);
-    return el.getElementRect();
-  },
-
-  async getSize(this: FakeDriver, elementId: string) {
-    const el = this.getElement(elementId);
-    return el.getSize();
-  },
-
-  async equalsElement(this: FakeDriver, elementIdA: string, elementIdB: string) {
-    const el1 = this.getElement(elementIdA);
-    const el2 = this.getElement(elementIdB);
-    return el1.equals(el2);
-  },
-
-  async getCssProperty(this: FakeDriver, prop: string, elementId: string) {
-    this.assertWebviewContext();
-    const el = this.getElement(elementId);
-    return el.getCss(prop) ?? '';
-  },
-
-  async getLocation(this: FakeDriver, elementId: string) {
-    const el = this.getElement(elementId);
-    return el.getLocation();
-  },
-
-  async getLocationInView(this: FakeDriver, elementId: string) {
-    return this.getLocation(elementId);
-  },
-};
-
-mixin(ElementsMixin);
+  }
+  return elementIds.map((e) => this.elMap[e]);
+}
+
+export function getElement(this: FakeDriver, elementId: string): FakeElement {
+  return this.getElements([elementId])[0];
+}
+
+export async function getName(this: FakeDriver, elementId: string): Promise<string> {
+  const el = this.getElement(elementId);
+  return el.tagName;
+}
+
+export async function elementDisplayed(this: FakeDriver, elementId: string): Promise<boolean> {
+  const el = this.getElement(elementId);
+  return el.isVisible();
+}
+
+export async function elementEnabled(this: FakeDriver, elementId: string): Promise<boolean> {
+  const el = this.getElement(elementId);
+  return el.isEnabled();
+}
+
+export async function elementSelected(this: FakeDriver, elementId: string): Promise<boolean> {
+  const el = this.getElement(elementId);
+  return el.isSelected();
+}
+
+export async function setValue(
+  this: FakeDriver,
+  keys: string | string[],
+  elementId: string
+): Promise<void> {
+  const value = _.isArray(keys) ? keys.join('') : keys;
+  const el = this.getElement(elementId);
+  // Only MockInputField supports value in the fake app XML.
+  if (el.type !== 'MockInputField') {
+    throw new errors.InvalidElementStateError();
+  }
+  el.setAttr('value', value);
+}
+
+export async function getText(this: FakeDriver, elementId: string): Promise<string> {
+  const el = this.getElement(elementId);
+  return el.getAttr('value');
+}
+
+export async function clear(this: FakeDriver, elementId: string): Promise<void> {
+  await this.setValue('', elementId);
+}
+
+export async function click(this: FakeDriver, elementId: string): Promise<void> {
+  this.assertNoAlert();
+  const el = this.getElement(elementId);
+  if (!el.isVisible()) {
+    throw new errors.InvalidElementStateError();
+  }
+  el.click();
+  this.focusedElId = elementId;
+}
+
+/** Protocol order: attribute name, then element id (from route /attribute/:name). */
+export async function getAttribute(
+  this: FakeDriver,
+  attributeName: string,
+  elementId: string
+): Promise<string> {
+  const el = this.getElement(elementId);
+  return el.getAttr(attributeName);
+}
+
+export async function getElementRect(this: FakeDriver, elementId: string): Promise<Rect> {
+  const el = this.getElement(elementId);
+  return el.getElementRect();
+}
+
+export async function getSize(this: FakeDriver, elementId: string): Promise<Size> {
+  const el = this.getElement(elementId);
+  return el.getSize();
+}
+
+export async function equalsElement(
+  this: FakeDriver,
+  elementIdA: string,
+  elementIdB: string
+): Promise<boolean> {
+  const el1 = this.getElement(elementIdA);
+  const el2 = this.getElement(elementIdB);
+  return el1.equals(el2);
+}
+
+/** Protocol order: property name, then element id. Requires webview context. */
+export async function getCssProperty(
+  this: FakeDriver,
+  propertyName: string,
+  elementId: string
+): Promise<string> {
+  this.assertWebviewContext();
+  const el = this.getElement(elementId);
+  return el.getCss(propertyName) ?? '';
+}
+
+export async function getLocation(this: FakeDriver, elementId: string): Promise<Position> {
+  const el = this.getElement(elementId);
+  return el.getLocation();
+}
+
+export async function getLocationInView(
+  this: FakeDriver,
+  elementId: string
+): Promise<Position> {
+  return this.getLocation(elementId);
+}