@limrun/appium-xcuitest-driver 10.4.3-lim.1

package/build/lib/commands/source.js

@@ -0,0 +1,128 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPageSource = getPageSource;
+exports.mobileGetSource = mobileGetSource;
+const lodash_1 = __importDefault(require("lodash"));
+const js2xmlparser2_1 = __importDefault(require("js2xmlparser2"));
+const APPIUM_AUT_TAG = 'AppiumAUT';
+/**
+ * @this {XCUITestDriver}
+ */
+async function getPageSource() {
+    if (this.isWebContext()) {
+        const script = 'return document.documentElement.outerHTML';
+        return await this.executeAtom('execute_script', [script, []]);
+    }
+    const { pageSourceExcludedAttributes: excludedAttributes, useJSONSource } = await this.settings.getSettings();
+    const hasExcludedAttributes = lodash_1.default.isString(excludedAttributes) && !lodash_1.default.isEmpty(excludedAttributes);
+    if (useJSONSource) {
+        const srcTree = await this.mobileGetSource('json', hasExcludedAttributes ? excludedAttributes : undefined);
+        return getSourceXml(getTreeForXML(srcTree));
+    }
+    return await this.mobileGetSource('xml', hasExcludedAttributes ? excludedAttributes : undefined);
+}
+/**
+ * Retrieve the source tree of the current page in XML or JSON format.
+ *
+ * @param {import('./types').SourceFormat} format - Page tree source representation format.
+ * @param {string} [excludedAttributes] A comma-separated string of attribute names to exclude from the output. Only works if `format` is `xml`.
+ * @privateRemarks Why isn't `excludedAttributes` an array?
+ * @returns {Promise<string>} The source tree of the current page in the given format.
+ * @this {XCUITestDriver}
+ */
+async function mobileGetSource(format = 'xml', excludedAttributes) {
+    const paramsMap = {
+        format,
+        scope: APPIUM_AUT_TAG,
+    };
+    if (excludedAttributes) {
+        paramsMap.excluded_attributes = excludedAttributes;
+    }
+    const query = Object.entries(paramsMap)
+        .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`)
+        .join('&');
+    return /** @type {string} */ (await this.proxyCommand(`/source?${query}`, 'GET'));
+}
+/**
+ * Will get JSON of the form:
+ *
+ * ```js
+ *   { isEnabled: '1',
+ *     isVisible: '1',
+ *     isAccessible: '1',
+ *     frame: '{{0, 0}, {375, 667}}',
+ *     children:
+ *      [ { isEnabled: '1',
+ *          isVisible: '1',
+ *          isAccessible: '1',
+ *          frame: '{{0, 0}, {375, 667}}',
+ *          children: [],
+ *          rect: { x: 0, y: 0, width: 375, height: 667 },
+ *          value: null,
+ *          label: null,
+ *          type: 'Other',
+ *          name: null,
+ *          rawIdentifier: null },
+ *     rect: { origin: { x: 0, y: 0 }, size: { width: 375, height: 667 } },
+ *     value: null,
+ *     label: 'UICatalog',
+ *     type: 'Application',
+ *     name: 'UICatalog',
+ *     rawIdentifier: null }
+ * ```
+ */
+function getTreeForXML(srcTree) {
+    function getTree(element, elementIndex, parentPath) {
+        let curPath = `${parentPath}/${elementIndex}`;
+        let rect = element.rect || {};
+        /**
+         * @privateRemarks I don't even want to try to type this right now
+         * @type {any}
+         */
+        let subtree = {
+            '@': {
+                type: `XCUIElementType${element.type}`,
+                enabled: parseInt(element.isEnabled, 10) === 1,
+                visible: parseInt(element.isVisible, 10) === 1,
+                accessible: parseInt(element.isAccessible, 10) === 1,
+                focused: parseInt(element.isFocused, 10) === 1,
+                x: rect.x,
+                y: rect.y,
+                width: rect.width,
+                height: rect.height,
+            },
+            '>': [],
+        };
+        if (element.name !== null) {
+            subtree['@'].name = element.name;
+        }
+        if (element.label !== null) {
+            subtree['@'].label = element.label;
+        }
+        if (element.value !== null) {
+            subtree['@'].value = element.value;
+        }
+        for (let i = 0; i < (element.children || []).length; i++) {
+            subtree['>'].push(getTree(element.children[i], i, curPath));
+        }
+        return {
+            [`XCUIElementType${element.type}`]: subtree,
+        };
+    }
+    let tree = getTree(srcTree, 0, '');
+    return tree;
+}
+function getSourceXml(jsonSource) {
+    return (0, js2xmlparser2_1.default)('AppiumAUT', jsonSource, {
+        wrapArray: { enabled: false, elementName: 'element' },
+        declaration: { include: true },
+        prettyPrinting: { indentString: '  ' },
+    });
+}
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ */
+//# sourceMappingURL=source.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"source.js","sourceRoot":"","sources":["../../../lib/commands/source.js"],"names":[],"mappings":";;;;;AAQA,sCAiBC;AAWD,0CAYC;AAhDD,oDAAuB;AACvB,kEAAmC;AAEnC,MAAM,cAAc,GAAG,WAAW,CAAC;AAEnC;;GAEG;AACI,KAAK,UAAU,aAAa;IACjC,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,MAAM,MAAM,GAAG,2CAA2C,CAAC;QAC3D,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,EACJ,4BAA4B,EAAE,kBAAkB,EAChD,aAAa,EACd,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IACtC,MAAM,qBAAqB,GAAG,gBAAC,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC/F,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC3G,OAAO,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AACnG,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,eAAe,CAAC,MAAM,GAAG,KAAK,EAAE,kBAAkB;IACtE,MAAM,SAAS,GAAG;QAChB,MAAM;QACN,KAAK,EAAE,cAAc;KACtB,CAAC;IACF,IAAI,kBAAkB,EAAE,CAAC;QACvB,SAAS,CAAC,mBAAmB,GAAG,kBAAkB,CAAC;IACrD,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;SACpC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC;SACpE,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,OAAO,qBAAqB,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;AACpF,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAS,aAAa,CAAC,OAAO;IAC5B,SAAS,OAAO,CAAC,OAAO,EAAE,YAAY,EAAE,UAAU;QAChD,IAAI,OAAO,GAAG,GAAG,UAAU,IAAI,YAAY,EAAE,CAAC;QAC9C,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;QAC9B;;;WAGG;QACH,IAAI,OAAO,GAAG;YACZ,GAAG,EAAE;gBACH,IAAI,EAAE,kBAAkB,OAAO,CAAC,IAAI,EAAE;gBACtC,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,KAAK,CAAC;gBAC9C,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,KAAK,CAAC;gBAC9C,UAAU,EAAE,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,KAAK,CAAC;gBACpD,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,KAAK,CAAC;gBAC9C,CAAC,EAAE,IAAI,CAAC,CAAC;gBACT,CAAC,EAAE,IAAI,CAAC,CAAC;gBACT,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB;YACD,GAAG,EAAE,EAAE;SACR,CAAC;QACF,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YAC1B,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACnC,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;YAC3B,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QACrC,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;YAC3B,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QACrC,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACzD,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO;YACL,CAAC,kBAAkB,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO;SAC5C,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACnC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,YAAY,CAAC,UAAU;IAC9B,OAAO,IAAA,uBAAM,EAAC,WAAW,EAAE,UAAU,EAAE;QACrC,SAAS,EAAE,EAAC,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,EAAC;QACnD,WAAW,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC;QAC5B,cAAc,EAAE,EAAC,YAAY,EAAE,IAAI,EAAC;KACrC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG"}

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

@@ -0,0 +1,53 @@
+/**
+ * @this {XCUITestDriver}
+ */
+export function pageLoadTimeoutW3C(this: import("../driver").XCUITestDriver, ms: any): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ */
+export function pageLoadTimeoutMJSONWP(this: import("../driver").XCUITestDriver, ms: any): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ */
+export function scriptTimeoutW3C(this: import("../driver").XCUITestDriver, ms: any): Promise<void>;
+/**
+ * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
+ *
+ * @param {number} ms - the timeout
+ * @this {XCUITestDriver}
+ * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
+ */
+export function scriptTimeoutMJSONWP(this: import("../driver").XCUITestDriver, ms: number): Promise<void>;
+/**
+ * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
+ *
+ * @param {number} ms - the timeout
+ *
+ * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
+ * @this {XCUITestDriver}
+ */
+export function asyncScriptTimeout(this: import("../driver").XCUITestDriver, ms: number): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ */
+export function setPageLoadTimeout(this: import("../driver").XCUITestDriver, ms: any): void;
+export class setPageLoadTimeout {
+    /**
+     * @this {XCUITestDriver}
+     */
+    constructor(this: import("../driver").XCUITestDriver, ms: any);
+    pageLoadMs: any;
+}
+/**
+ * @this {XCUITestDriver}
+ */
+export function setAsyncScriptTimeout(this: import("../driver").XCUITestDriver, ms: any): void;
+export class setAsyncScriptTimeout {
+    /**
+     * @this {XCUITestDriver}
+     */
+    constructor(this: import("../driver").XCUITestDriver, ms: any);
+    asyncWaitMs: any;
+}
+export type XCUITestDriver = import("../driver").XCUITestDriver;
+//# sourceMappingURL=timeouts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"timeouts.d.ts","sourceRoot":"","sources":["../../../lib/commands/timeouts.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,qGAEC;AAED;;GAEG;AACH,yGAEC;AAED;;GAEG;AACH,mGAGC;AAED;;;;;;GAMG;AACH,mFAJW,MAAM,iBAMhB;AAED;;;;;;;GAOG;AACH,iFALW,MAAM,iBAOhB;AAED;;GAEG;AACH,4FAOC;;IAVD;;OAEG;IACH,+DAOC;IALC,gBAAoB;;AAOtB;;GAEG;AACH,+FAGC;;IAND;;OAEG;IACH,+DAGC;IAFC,iBAAqB;;6BAKV,OAAO,WAAW,EAAE,cAAc"}

package/build/lib/commands/timeouts.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pageLoadTimeoutW3C = pageLoadTimeoutW3C;
+exports.pageLoadTimeoutMJSONWP = pageLoadTimeoutMJSONWP;
+exports.scriptTimeoutW3C = scriptTimeoutW3C;
+exports.scriptTimeoutMJSONWP = scriptTimeoutMJSONWP;
+exports.asyncScriptTimeout = asyncScriptTimeout;
+exports.setPageLoadTimeout = setPageLoadTimeout;
+exports.setAsyncScriptTimeout = setAsyncScriptTimeout;
+/**
+ * @this {XCUITestDriver}
+ */
+async function pageLoadTimeoutW3C(ms) {
+    await this.setPageLoadTimeout(this.parseTimeoutArgument(ms));
+}
+/**
+ * @this {XCUITestDriver}
+ */
+async function pageLoadTimeoutMJSONWP(ms) {
+    await this.setPageLoadTimeout(this.parseTimeoutArgument(ms));
+}
+/**
+ * @this {XCUITestDriver}
+ */
+async function scriptTimeoutW3C(ms) {
+    // XXX: this is synchronous
+    await this.setAsyncScriptTimeout(this.parseTimeoutArgument(ms));
+}
+/**
+ * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
+ *
+ * @param {number} ms - the timeout
+ * @this {XCUITestDriver}
+ * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
+ */
+async function scriptTimeoutMJSONWP(ms) {
+    await this.asyncScriptTimeout(ms);
+}
+/**
+ * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
+ *
+ * @param {number} ms - the timeout
+ *
+ * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
+ * @this {XCUITestDriver}
+ */
+async function asyncScriptTimeout(ms) {
+    await this.scriptTimeoutW3C(ms);
+}
+/**
+ * @this {XCUITestDriver}
+ */
+function setPageLoadTimeout(ms) {
+    ms = parseInt(ms, 10);
+    this.pageLoadMs = ms;
+    if (this.remote) {
+        this.remote.pageLoadMs = ms;
+    }
+    this.log.debug(`Set page load timeout to ${ms}ms`);
+}
+/**
+ * @this {XCUITestDriver}
+ */
+function setAsyncScriptTimeout(ms) {
+    this.asyncWaitMs = ms;
+    this.log.debug(`Set async script timeout to ${ms}ms`);
+}
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ */
+//# sourceMappingURL=timeouts.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"timeouts.js","sourceRoot":"","sources":["../../../lib/commands/timeouts.js"],"names":[],"mappings":";;AAGA,gDAEC;AAKD,wDAEC;AAKD,4CAGC;AASD,oDAEC;AAUD,gDAEC;AAKD,gDAOC;AAKD,sDAGC;AA/DD;;GAEG;AACI,KAAK,UAAU,kBAAkB,CAAC,EAAE;IACzC,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,sBAAsB,CAAC,EAAE;IAC7C,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,gBAAgB,CAAC,EAAE;IACvC,2BAA2B;IAC3B,MAAM,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC;AAClE,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,oBAAoB,CAAC,EAAE;IAC3C,MAAM,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,kBAAkB,CAAC,EAAE;IACzC,MAAM,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,EAAE;IACnC,EAAE,GAAG,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACtB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;IACrB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,EAAE,CAAC;IAC9B,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,IAAI,CAAC,CAAC;AACrD,CAAC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CAAC,EAAE;IACtC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACtB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,EAAE,IAAI,CAAC,CAAC;AACxD,CAAC;AAED;;GAEG"}