detox 20.27.7-smoke.0 → 20.28.0

package/src/copilot/detoxCopilotFrameworkDriver.js

@@ -18,7 +18,7 @@ const detoxCopilotFrameworkDriver = {
           },
           {
             signature: 'by.text(text: string)',
-            description: 'Matches elements by their text.',
+            description: 'Matches elements by their text (value).',
             example: "element(by.text('Login'))",
             guidelines: ['Prefer test IDs over text matchers when possible.'],
           },
@@ -34,6 +34,12 @@ const detoxCopilotFrameworkDriver = {
             example: "element(by.id('listItem')).atIndex(2)",
             guidelines: ['Use when multiple elements match the same matcher.'],
           },
+          {
+            signature: 'by.label(label: string)',
+            description: 'Match elements with the specified label.',
+            example: "element(by.label('Tuesday, 1 October'));",
+            guidelines: ['Use when there are no other identifiers, such as for date pickers to select specific days.'],
+          },
         ],
       },
       {
@@ -106,7 +112,7 @@ const detoxCopilotFrameworkDriver = {
             ],
           },
           {
-            signature: 'waitFor(element: Matcher)..toBeVisible().whileElement(element: Matcher).scroll(offset: number, direction: string)',
+            signature: 'waitFor(element: Matcher).toBeVisible(percent?: number).whileElement(element: Matcher).scroll(offset: number, direction: string)',
             description: 'Continuously performs an action while waiting for an expectation to be fulfilled.',
             example: `
 await waitFor(element(by.text('Load More')))
@@ -185,9 +191,13 @@ jestExpect(attributes.text).toBe('Tap Me');`,
         title: 'Assertions',
         items: [
           {
-            signature: 'toBeVisible()',
-            description: 'Asserts that the element is visible.',
-            example: "await expect(element(by.id('loginButton'))).toBeVisible();",
+            signature: 'toBeVisible(percent?: number)',
+            description: 'Asserts that the element is visible with at-least the specified percentage. Default percent is 75%.',
+            example: "await expect(element(by.id('loginButton'))).toBeVisible(38);",
+            guidelines: [
+              'Use the default visibility percent unless a different percentage is required.',
+              'If a percentage value is provided, use the exact percentage required for the test.',
+            ],
           },
           {
             signature: 'toExist()',
@@ -377,8 +387,8 @@ await device.launchApp({ launchArgs: { someLaunchArg: 1234 } });`,
         items: [
           {
             signature: 'web.element(matcher: Matcher)',
-            description: 'Selects an element within a web view. Use when there is only one web view on the screen.',
-            example: `    
+            description: 'Selects an element within a web view (`WKWebView` or `RNCWebView`). Use when there is only one web view on the screen.',
+            example: `
 await web.element(by.web.id('email')).typeText('test@example.com');
 await web.element(by.web.id('password')).typeText('password123');
 await web.element(by.web.id('login-button')).tap();
@@ -387,19 +397,20 @@ await web.element(by.web.id('login-button')).tap();
               'The web view may take time to load; add a delay using `await new Promise(resolve => setTimeout(resolve, milliseconds));` before the first interaction. This wait should happen only once.',
               'After the initial wait, you can interact with web elements without additional delays.',
               'Use `by.web.id` matcher when possible for matching web elements, as it is the most reliable.',
-              'Web APIs can only be used with web elements (within web views). Avoid using web APIs for native elements or native APIs for web elements.',
+              'Web APIs can only be used with web elements (within web views). Do not use web APIs for native elements or native APIs for web elements!',
+              'Confirm that you are targeting a web view before using this method.'
             ],
           },
           {
             signature: 'web(nativeMatcher: NativeMatcher).element(matcher: Matcher)',
-            description: 'Selects an element within a specific web view matched by a native matcher. Use when there are multiple web views on the screen.',
+            description: 'Selects an element within a specific web view (`WKWebView` or `RNCWebView`) matched by a native matcher. Use when there are multiple web views on the screen.',
             example: `
 // Wait for the specific web view to appear and load (only once before interacting)
 await expect(element(by.id('checkout-webview'))).toBeVisible();
 
 // Interact with elements within a specific web view
 const specificWebView = web(by.id('checkout-webview'));
-    
+
 await specificWebView.element(by.web.id('credit-card-number')).typeText('4111111111111111');
 await specificWebView.element(by.web.id('expiration-date')).typeText('12/25');
 await specificWebView.element(by.web.id('cvv')).typeText('123');
@@ -411,6 +422,7 @@ await specificWebView.element(by.web.id('pay-button')).tap();
               'After the initial wait, you can interact with elements within the web view without additional delays.',
               'Webview must be matched with `web(nativeMatcher)` (e.g., `web(by.id(..))` instead of `element(by.id(..))`).',
               'Prefer the basic `web.element()` if only one web view is present on the screen.',
+              'Confirm that you are targeting a web view before using this method.'
             ],
           },
           {
@@ -485,8 +497,8 @@ await secondWebView.element(by.web.id('search-button')).tap();
             example: `await web.element(by.web.label('Next')).tap();`,
             guidelines: [
               'Available on iOS only.',
-              'Use when the element has a unique label or aria-label.',
-              'Can be used to match buttons and input elements by their inner text content.',
+              'Use when the inner web element has a unique label or aria-label.',
+              'Can be used to match buttons and input elements inside a web view, by their inner text content.',
             ],
           },
           {
@@ -567,13 +579,13 @@ await web.element(by.web.id('email-input')).focus();
 await web.element(by.web.id('email-input')).typeText('user@example.com');
             `,
             guidelines: [
-              'Useful for input fields that require focus before typing.',
+              'Useful for input fields in a web view that require focus before typing.',
               'No need for secured interactions on iOS.',
             ]
           },
           {
             signature: 'moveCursorToEnd()',
-            description: 'Moves the input cursor to the end of the element\'s content.',
+            description: 'Moves the input cursor in a web view to the end of the element\'s content.',
             example: `
 await web.element(by.web.id('message-box')).moveCursorToEnd();
 await web.element(by.web.id('message-box')).typeText(' Adding more text.');
@@ -581,7 +593,7 @@ await web.element(by.web.id('message-box')).typeText(' Adding more text.');
           },
           {
             signature: 'runScript(script: string, args?: any[])',
-            description: 'Runs a JavaScript function on the element.',
+            description: 'Runs a JavaScript function on the web view element.',
             example: `
 // Click an element using a custom script
 await web.element(by.web.id('hidden-button')).runScript('el => el.click()');

package/src/devices/runtime/RuntimeDevice.js

@@ -1,6 +1,7 @@
 const DetoxRuntimeError = require('../../errors/DetoxRuntimeError');
 const debug = require('../../utils/debug'); // debug utils, leave here even if unused
 const log = require('../../utils/logger').child({ cat: 'device' });
+const mapDeviceLongPressArguments = require('../../utils/mapDeviceLongPressArguments');
 const traceMethods = require('../../utils/traceMethods');
 const wrapWithStackTraceCutter = require('../../utils/wrapWithStackTraceCutter');
 
@@ -283,6 +284,16 @@ class RuntimeDevice {
     await this.deviceDriver.setOrientation(orientation);
   }
 
+  async tap(point, shouldIgnoreStatusBar) {
+    await this.deviceDriver.tap(point, shouldIgnoreStatusBar, this._bundleId);
+  }
+
+  async longPress(arg1, arg2, arg3) {
+    let { point, duration, shouldIgnoreStatusBar } = mapDeviceLongPressArguments(arg1, arg2, arg3);
+
+    await this.deviceDriver.longPress(point, duration, shouldIgnoreStatusBar, this._bundleId);
+  }
+
   async setLocation(lat, lon) {
     lat = String(lat);
     lon = String(lon);

package/src/devices/runtime/drivers/DeviceDriverBase.js

@@ -51,6 +51,14 @@ class DeviceDriverBase {
     return '';
   }
 
+  async tap(_bundleId) {
+    return '';
+  }
+
+  async longPress(_bundleId) {
+    return '';
+  }
+
   async sendToHome() {
     return '';
   }

package/src/devices/runtime/drivers/android/AndroidDriver.js

@@ -245,6 +245,22 @@ class AndroidDriver extends DeviceDriverBase {
     await this.invocationManager.execute(call);
   }
 
+  async tap(point, shouldIgnoreStatusBar) {
+    let x = point?.x ?? 100;
+    let y = point?.y ?? 100;
+    let _shouldIgnoreStatusBar = shouldIgnoreStatusBar ?? true;
+    const call = EspressoDetoxApi.tap(x, y, _shouldIgnoreStatusBar);
+    await this.invocationManager.execute(call);
+  }
+
+  async longPress(point, duration, shouldIgnoreStatusBar) {
+    let x = point?.x ?? 100;
+    let y = point?.y ?? 100;
+    let _shouldIgnoreStatusBar = shouldIgnoreStatusBar ?? true;
+    const call = duration ? EspressoDetoxApi.longPress(x, y, duration, _shouldIgnoreStatusBar): EspressoDetoxApi.longPress(x, y, _shouldIgnoreStatusBar);
+    await this.invocationManager.execute(call);
+  }
+  
   async generateViewHierarchyXml(shouldInjectTestIds) {
     const hierarchy = await this.invocationManager.execute(DetoxApi.generateViewHierarchyXml(shouldInjectTestIds));
     return hierarchy.result;

package/src/devices/runtime/drivers/ios/SimulatorDriver.js

@@ -6,12 +6,17 @@ const _ = require('lodash');
 
 const temporaryPath = require('../../../../artifacts/utils/temporaryPath');
 const DetoxRuntimeError = require('../../../../errors/DetoxRuntimeError');
+const XCUITestRunner = require('../../../../ios/XCUITestRunner');
+const { assertTraceDescription } = require('../../../../utils/assertArgument');
 const getAbsoluteBinaryPath = require('../../../../utils/getAbsoluteBinaryPath');
+const { actionDescription } = require('../../../../utils/invocationTraceDescriptions');
 const log = require('../../../../utils/logger').child({ cat: 'device' });
 const pressAnyKey = require('../../../../utils/pressAnyKey');
+const traceInvocationCall = require('../../../../utils/traceInvocationCall').bind(null, log);
 
 const IosDriver = require('./IosDriver');
 
+
 /**
  * @typedef SimulatorDriverDeps { DeviceDriverDeps }
  * @property applesimutils { AppleSimUtils }
@@ -40,6 +45,19 @@ class SimulatorDriver extends IosDriver {
     this._applesimutils = deps.applesimutils;
   }
 
+  withAction(xcuitestRunner, action, traceDescription, ...params) {
+    assertTraceDescription(traceDescription);
+
+    const invocation = {
+      ...(params.length !== 0 && { params }),
+      type: 'systemAction',
+      ...(this.index !== undefined && { systemAtIndex: this.index }),
+      systemAction: action
+    };
+
+    return traceInvocationCall(traceDescription, invocation, xcuitestRunner.execute(invocation));
+  }
+
   getExternalId() {
     return this.udid;
   }
@@ -111,6 +129,23 @@ class SimulatorDriver extends IosDriver {
     await this.emitter.emit('terminateApp', { deviceId: udid, bundleId });
   }
 
+  async tap(point, shouldIgnoreStatusBar, _bundleId) {
+    const xcuitestRunner = new XCUITestRunner({ runtimeDevice: { id: this.getExternalId(), _bundleId } });
+    let x = point?.x ?? 100;
+    let y = point?.y ?? 100;
+    const traceDescription = actionDescription.tap({ x, y });
+    return this.withAction(xcuitestRunner, 'coordinateTap', traceDescription, x.toString(), y.toString());
+  }
+
+  async longPress(point, pressDuration, shouldIgnoreStatusBar, _bundleId) {
+    const xcuitestRunner = new XCUITestRunner({ runtimeDevice: { id: this.getExternalId(), _bundleId } });
+    let x = point?.x ?? 100;
+    let y = point?.y ?? 100;
+    let _pressDuration = pressDuration ? (pressDuration / 1000) : 1;
+    const traceDescription = actionDescription.longPress({ x, y }, _pressDuration);
+    return this.withAction(xcuitestRunner, 'coordinateLongPress', traceDescription, x.toString(), y.toString(), _pressDuration.toString());
+  }
+
   async setBiometricEnrollment(yesOrNo) {
     await this._applesimutils.setBiometricEnrollment(this.udid, yesOrNo);
   }

package/src/utils/assertArgument.js

@@ -52,6 +52,14 @@ function assertPoint(point) {
   throw new DetoxRuntimeError(`point should be an object with x and y properties, but got ${JSON.stringify(point)}`);
 }
 
+function assertShouldIgnoreStatusBar(shouldIgnoreStatusBar) {
+  if (typeof shouldIgnoreStatusBar === 'boolean') {
+    return true;
+  }
+
+  throw new DetoxRuntimeError('shouldIgnoreStatusBar should be a boolean, but got ' + (shouldIgnoreStatusBar + (' (' + (typeof shouldIgnoreStatusBar + ')'))));
+}
+
 function assertUndefined(arg) {
   if (arg === undefined) {
     return true;
@@ -76,6 +84,7 @@ module.exports = {
   assertString,
   assertDuration,
   assertPoint,
+  assertShouldIgnoreStatusBar,
   assertUndefined,
   assertTraceDescription
 };

package/src/utils/invocationTraceDescriptions.js

@@ -3,6 +3,7 @@ module.exports = {
     adjustSliderToPosition: (newPosition) => `adjust slider to position ${newPosition}`,
     clearText: () => 'clear input text',
     getAttributes: () => 'get element attributes',
+    tap: (point) => `tap at ${JSON.stringify(point)}`,
     longPress: (point, duration) => `long press${duration !== null ? ` for ${duration}ms` : ''}${point !== null ? ` at ${JSON.stringify(point)}` : ''}`,
     longPressAndDrag: (duration, startX, startY, targetElement, endX, endY, speed, holdDuration) =>
       `long press and drag from ${startX}, ${startY} to ${endX}, ${endY} with speed ${speed} and hold duration ${holdDuration}`,

package/src/utils/mapDeviceLongPressArguments.js

@@ -0,0 +1,56 @@
+const { DetoxRuntimeError } = require('../errors');
+
+const { assertPoint, assertDuration, assertUndefined, assertShouldIgnoreStatusBar } = require('./assertArgument');
+
+function mapDeviceLongPressArguments(optionalAllParams, optionalDurationOrIgnoreStatusBar, optionalIgnoreStatusBar) {
+    let point = null;
+    let duration = null;
+    let shouldIgnoreStatusBar = null;
+
+    try {
+      if (optionalAllParams === undefined) {
+        // Do nothing.
+      } else if (typeof optionalAllParams === 'number') {
+        duration = optionalAllParams;
+        if (typeof optionalDurationOrIgnoreStatusBar === 'boolean') {
+            shouldIgnoreStatusBar = optionalDurationOrIgnoreStatusBar;
+        } else {
+            assertUndefined(optionalDurationOrIgnoreStatusBar);
+        }
+        assertUndefined(optionalIgnoreStatusBar);
+      } else if (typeof optionalAllParams === 'boolean') {
+        shouldIgnoreStatusBar = optionalAllParams;
+        assertUndefined(optionalDurationOrIgnoreStatusBar);
+        assertUndefined(optionalIgnoreStatusBar);
+      } else {
+        assertPoint(optionalAllParams);
+        point = optionalAllParams;
+
+        if (typeof optionalDurationOrIgnoreStatusBar === 'number') {
+          assertDuration(optionalDurationOrIgnoreStatusBar);
+          duration = optionalDurationOrIgnoreStatusBar;
+        } else if (typeof optionalDurationOrIgnoreStatusBar === 'boolean') {
+          assertShouldIgnoreStatusBar(optionalDurationOrIgnoreStatusBar);
+          shouldIgnoreStatusBar = optionalDurationOrIgnoreStatusBar;
+          assertUndefined(optionalIgnoreStatusBar);
+        } else if (optionalDurationOrIgnoreStatusBar !== undefined) {
+            assertDuration(optionalDurationOrIgnoreStatusBar);
+        } else {
+          assertUndefined(optionalDurationOrIgnoreStatusBar);
+          assertUndefined(optionalIgnoreStatusBar);
+        }
+
+        if (optionalIgnoreStatusBar !== undefined) {
+          assertShouldIgnoreStatusBar(optionalIgnoreStatusBar);
+          shouldIgnoreStatusBar = optionalIgnoreStatusBar;
+        }
+      }
+    } catch (e) {
+      throw new DetoxRuntimeError(`longPress accepts either a duration (number) or a point ({x: number, y: number}) as ` +
+        `its first argument, optionally a duration (number) as its second argument, and optionally a ignoreStatusBar (boolean) as its third argument. Error: ${e.message}`);
+    }
+
+    return { point, duration, shouldIgnoreStatusBar };
+  }
+
+module.exports = mapDeviceLongPressArguments;

package/Detox-android/com/wix/detox/20.27.7-smoke.0/detox-20.27.7-smoke.0-sources.jar.md5

@@ -1 +0,0 @@
-390f49d71c399592a5a12dae4d0ba89a

package/Detox-android/com/wix/detox/20.27.7-smoke.0/detox-20.27.7-smoke.0-sources.jar.sha1

@@ -1 +0,0 @@
-bb30d23b09a201006a4d923dffb96a4cb0b44458

package/Detox-android/com/wix/detox/20.27.7-smoke.0/detox-20.27.7-smoke.0-sources.jar.sha256

@@ -1 +0,0 @@
-b3095ae31971d13a41e9225c401066365a7c5c54c0a7313797b7c8818251d569

package/Detox-android/com/wix/detox/20.27.7-smoke.0/detox-20.27.7-smoke.0-sources.jar.sha512

@@ -1 +0,0 @@
-1ca8d245b20bbe78438bbbfc06ac95123dffcaf759d816d6f49a0a4d23989c945686db119fb08967799e7e994e78a7192e7df185d4888e6b5b242a1d0bcd7c8e

package/Detox-android/com/wix/detox/20.27.7-smoke.0/detox-20.27.7-smoke.0.aar.md5

@@ -1 +0,0 @@
-1a5f2740c1c03528f2d9611aaa4634b6

package/Detox-android/com/wix/detox/20.27.7-smoke.0/detox-20.27.7-smoke.0.aar.sha1

@@ -1 +0,0 @@
-d752c96158c3984c8dfe1cde9ee0b14fbe2ab641

package/Detox-android/com/wix/detox/20.27.7-smoke.0/detox-20.27.7-smoke.0.aar.sha256

@@ -1 +0,0 @@
-3bd563b4fe588be1d4cc5877a0b8464f31a5da309029a4e5703bf5465ee6df2d

package/Detox-android/com/wix/detox/20.27.7-smoke.0/detox-20.27.7-smoke.0.aar.sha512

@@ -1 +0,0 @@
-1682f1d10b78729ebd15fc548860893b9c9585447777ed09e6bf7d5000e85745db9722e2f2d15bee539a2230d8714526d293bb669218e17578cd9461a9dd2446

package/Detox-android/com/wix/detox/20.27.7-smoke.0/detox-20.27.7-smoke.0.pom.md5

@@ -1 +0,0 @@
-e88738f8b748e72b3381a6e14f7915da

package/Detox-android/com/wix/detox/20.27.7-smoke.0/detox-20.27.7-smoke.0.pom.sha1

@@ -1 +0,0 @@
-75d405e7af82b69cd73b9d990c9b24fb6d909e4a

package/Detox-android/com/wix/detox/20.27.7-smoke.0/detox-20.27.7-smoke.0.pom.sha256

@@ -1 +0,0 @@
-294b1c7cd9cc5eb44f6846594477c422a0fc25e758d3741d61ce85c9c11898a9

package/Detox-android/com/wix/detox/20.27.7-smoke.0/detox-20.27.7-smoke.0.pom.sha512

@@ -1 +0,0 @@
-ab28dbb7a126bdd7cd139f675d1bbe7633555af7e8d73b8449d1532031cbfe331db7e0f56377a6caa09c880b35723d90011c3d1b40890188761461137cc87b15

package/Detox-android/com/wix/detox-legacy/20.27.7-smoke.0/detox-legacy-20.27.7-smoke.0-sources.jar.md5

@@ -1 +0,0 @@
-cbd254abb70b675f0929c0b3722940d2

package/Detox-android/com/wix/detox-legacy/20.27.7-smoke.0/detox-legacy-20.27.7-smoke.0-sources.jar.sha1

@@ -1 +0,0 @@
-a781f7f228f72a617c266dc471ae38fe4f83125a

package/Detox-android/com/wix/detox-legacy/20.27.7-smoke.0/detox-legacy-20.27.7-smoke.0-sources.jar.sha256

@@ -1 +0,0 @@
-f451d882399883eb599d10bd8c59f27f3f48f7b5d9d8b0b64544efcecd2f7e2c

package/Detox-android/com/wix/detox-legacy/20.27.7-smoke.0/detox-legacy-20.27.7-smoke.0-sources.jar.sha512

@@ -1 +0,0 @@
-a382597f97218664630944f9f014ffbf5dbe2de4a79eec96fb3370c0b418a2fb034b311439b50dc142e38bb2ddce32d049328db0651ae1ccf6316d1afbe7be25

package/Detox-android/com/wix/detox-legacy/20.27.7-smoke.0/detox-legacy-20.27.7-smoke.0.aar.md5

@@ -1 +0,0 @@
-0bf142d5f16367aa729a059a0157014e

package/Detox-android/com/wix/detox-legacy/20.27.7-smoke.0/detox-legacy-20.27.7-smoke.0.aar.sha1

@@ -1 +0,0 @@
-f97c69229516588039e2b4377ce427609242db16

package/Detox-android/com/wix/detox-legacy/20.27.7-smoke.0/detox-legacy-20.27.7-smoke.0.aar.sha256

@@ -1 +0,0 @@
-464e93f88371093a2323125b79f3a2a9e97a908614909ff959d2505b971a1150

package/Detox-android/com/wix/detox-legacy/20.27.7-smoke.0/detox-legacy-20.27.7-smoke.0.aar.sha512

@@ -1 +0,0 @@
-b96a1d21679c252bcf9e8afb71a067eae95fe0716fe9b8e04dd703da9a119f57572f2bf92281f330e301d8683f4cd1ae3ab52a91aec92778ec61514725994b83

package/Detox-android/com/wix/detox-legacy/20.27.7-smoke.0/detox-legacy-20.27.7-smoke.0.pom.md5

@@ -1 +0,0 @@
-86d4c22e728a891a3bd18a58447e720b

package/Detox-android/com/wix/detox-legacy/20.27.7-smoke.0/detox-legacy-20.27.7-smoke.0.pom.sha1

@@ -1 +0,0 @@
-fffa571b874d723aa306265eb76fc13d65722655

package/Detox-android/com/wix/detox-legacy/20.27.7-smoke.0/detox-legacy-20.27.7-smoke.0.pom.sha256

@@ -1 +0,0 @@
-eca27e544ff60053827726d933d18a00a1cd6d06a24b47a67204b598e3a495b5

package/Detox-android/com/wix/detox-legacy/20.27.7-smoke.0/detox-legacy-20.27.7-smoke.0.pom.sha512

@@ -1 +0,0 @@
-93aab0e7f56de89d603faafdef30daa99761673ff1aeeb65b3aa968e768ecf8cd82f4867171503044b725f5e47daba016ce50be7156c8c5608abe8253ef2bb30