@limrun/appium-xcuitest-driver 10.11.0-lim.4 → 10.14.6-lim.1

package/lib/commands/{source.js → source.ts}

@@ -1,12 +1,16 @@
 import _ from 'lodash';
 import js2xml from 'js2xmlparser2';
+import type {XCUITestDriver} from '../driver';
+import type {SourceFormat} from './types';
 
 const APPIUM_AUT_TAG = 'AppiumAUT';
 
 /**
- * @this {XCUITestDriver}
+ * Retrieves the page source of the current application.
+ *
+ * @returns The page source as XML or HTML string
  */
-export async function getPageSource() {
+export async function getPageSource(this: XCUITestDriver): Promise<string> {
   if (this.isWebContext()) {
     const script = 'return document.documentElement.outerHTML';
     return await this.executeAtom('execute_script', [script, []]);
@@ -28,14 +32,17 @@ export async function getPageSource() {
 /**
  * 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`.
+ * @param format - Page tree source representation format.
+ * @param 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}
+ * @returns The source tree of the current page in the given format.
  */
-export async function mobileGetSource(format = 'xml', excludedAttributes) {
-  const paramsMap = {
+export async function mobileGetSource(
+  this: XCUITestDriver,
+  format: SourceFormat = 'xml',
+  excludedAttributes?: string,
+): Promise<string> {
+  const paramsMap: Record<string, string> = {
     format,
     scope: APPIUM_AUT_TAG,
   };
@@ -45,7 +52,7 @@ export async function mobileGetSource(format = 'xml', excludedAttributes) {
   const query = Object.entries(paramsMap)
     .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`)
     .join('&');
-  return /** @type {string} */ (await this.proxyCommand(`/source?${query}`, 'GET'));
+  return await this.proxyCommand(`/source?${query}`, 'GET') as string;
 }
 
 /**
@@ -76,15 +83,14 @@ export async function mobileGetSource(format = 'xml', excludedAttributes) {
  *     rawIdentifier: null }
  * ```
  */
-function getTreeForXML(srcTree) {
-  function getTree(element, elementIndex, parentPath) {
-    let curPath = `${parentPath}/${elementIndex}`;
-    let rect = element.rect || {};
+function getTreeForXML(srcTree: any): any {
+  function getTree(element: any, elementIndex: number, parentPath: string): any {
+    const curPath = `${parentPath}/${elementIndex}`;
+    const rect = element.rect || {};
     /**
      * @privateRemarks I don't even want to try to type this right now
-     * @type {any}
      */
-    let subtree = {
+    const subtree: any = {
       '@': {
         type: `XCUIElementType${element.type}`,
         enabled: parseInt(element.isEnabled, 10) === 1,
@@ -114,11 +120,11 @@ function getTreeForXML(srcTree) {
       [`XCUIElementType${element.type}`]: subtree,
     };
   }
-  let tree = getTree(srcTree, 0, '');
+  const tree = getTree(srcTree, 0, '');
   return tree;
 }
 
-function getSourceXml(jsonSource) {
+function getSourceXml(jsonSource: any): string {
   return js2xml('AppiumAUT', jsonSource, {
     wrapArray: {enabled: false, elementName: 'element'},
     declaration: {include: true},
@@ -126,6 +132,3 @@ function getSourceXml(jsonSource) {
   });
 }
 
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */

package/lib/commands/timeouts.ts

@@ -0,0 +1,95 @@
+import type {XCUITestDriver} from '../driver';
+
+/**
+ * Sets the page load timeout using W3C protocol.
+ *
+ * @param ms - Timeout in milliseconds
+ */
+export async function pageLoadTimeoutW3C(
+  this: XCUITestDriver,
+  ms: number,
+): Promise<void> {
+  await this.setPageLoadTimeout(this.parseTimeoutArgument(ms));
+}
+
+/**
+ * Sets the page load timeout using MJSONWP protocol.
+ *
+ * @param ms - Timeout in milliseconds
+ */
+export async function pageLoadTimeoutMJSONWP(
+  this: XCUITestDriver,
+  ms: number,
+): Promise<void> {
+  await this.setPageLoadTimeout(this.parseTimeoutArgument(ms));
+}
+
+/**
+ * Sets the async script timeout using W3C protocol.
+ *
+ * @param ms - Timeout in milliseconds
+ */
+export async function scriptTimeoutW3C(
+  this: XCUITestDriver,
+  ms: number,
+): Promise<void> {
+  // XXX: this is synchronous
+  await this.setAsyncScriptTimeout(this.parseTimeoutArgument(ms));
+}
+
+/**
+ * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
+ *
+ * @param ms - The timeout in milliseconds
+ * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
+ */
+export async function scriptTimeoutMJSONWP(
+  this: XCUITestDriver,
+  ms: number,
+): Promise<void> {
+  await this.asyncScriptTimeout(ms);
+}
+
+/**
+ * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
+ *
+ * @param ms - The timeout in milliseconds
+ * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
+ */
+export async function asyncScriptTimeout(
+  this: XCUITestDriver,
+  ms: number,
+): Promise<void> {
+  await this.scriptTimeoutW3C(ms);
+}
+
+/**
+ * Sets the page load timeout.
+ *
+ * @param ms - Timeout in milliseconds
+ */
+export function setPageLoadTimeout(
+  this: XCUITestDriver,
+  ms: number,
+): void {
+  ms = parseInt(String(ms), 10);
+  this.pageLoadMs = ms;
+  if (this._remote) {
+    this.remote.pageLoadMs = ms;
+  }
+  this.log.debug(`Set page load timeout to ${ms}ms`);
+}
+
+/**
+ * Sets the async script timeout.
+ *
+ * @param ms - Timeout in milliseconds
+ */
+export function setAsyncScriptTimeout(
+  this: XCUITestDriver,
+  ms: number,
+): void {
+  this.asyncWaitMs = ms;
+  this.log.debug(`Set async script timeout to ${ms}ms`);
+}
+

package/lib/commands/types.ts

@@ -334,6 +334,29 @@ export interface ProcessArguments {
   args: string[];
 }
 
+/**
+ * Accessibility audit item returned by the audit command.
+ */
+export interface AccessibilityAuditItem {
+  /**
+   * The detailed description of the found accessibility issue.
+   */
+  detailedDescription: string;
+  /**
+   * The compact description of the found accessibility issue.
+   */
+  compactDescription: string;
+  /**
+   * The name of the audit type this issue belongs to. Could be
+   * a number if the type name is unknown.
+   */
+  auditType: string | number;
+  /**
+   * The description of the element this issue was found for.
+   */
+  element: string;
+}
+
 /**
  * Pressable button names; used by the {@linkcode XCUITest.mobilePressButton mobile: pressButton} command.
  */
@@ -646,3 +669,66 @@ export interface LogEntry {
 }
 
 export type LogListener = (logEntry: LogEntry) => any;
+
+/**
+ * Condition inducer profile configuration
+ */
+export interface Profile {
+  name: string;
+  /** The property is profileID used in {@linkcode XCUITestDriver.enableConditionInducer} */
+  identifier: string;
+  /** Configuration details */
+  description: string;
+}
+
+/**
+ * We can use the returned data to determine whether the Condition is enabled and the currently enabled configuration information
+ */
+export interface Condition {
+  profiles: Profile[];
+  /** The property is conditionID used in {@linkcode XCUITestDriver.enableConditionInducer} */
+  identifier: string;
+  profilesSorted: boolean;
+  isDestructive: boolean;
+  isInternal: boolean;
+  /** `true` if this condition identifier is enabled */
+  isActive: boolean;
+  /** Enabled profiles identifier */
+  activeProfile: string;
+}
+
+/**
+ * Information about an XCTest screen recording session
+ */
+export interface XcTestScreenRecordingInfo {
+  /** Unique identifier of the video being recorded */
+  uuid: string;
+  /** FPS value */
+  fps: number;
+  /** Video codec, where 0 is h264 */
+  codec: number;
+  /** The timestamp when the screen recording has started in float Unix seconds */
+  startedAt: number;
+}
+
+/**
+ * XCTest screen recording result with payload
+ */
+export interface XcTestScreenRecording extends XcTestScreenRecordingInfo {
+  /**
+   * Base64-encoded content of the recorded media file if `remotePath` parameter is empty or null or an empty string otherwise.
+   * The media is expected to a be a valid QuickTime movie (.mov).
+   */
+  payload: string;
+}
+
+/**
+ * Options for AudioRecorder
+ */
+export interface AudioRecorderOptions {
+  audioSource: string;
+  audioCodec: string;
+  audioBitrate: string;
+  audioChannels: number;
+  audioRate: number;
+}