@testing-library/react-native 12.1.3 → 12.2.1

package/build/user-event/event-builder/text-input.d.ts

@@ -0,0 +1,91 @@
+import { ContentSize } from '../utils/content-size';
+import { TextRange } from '../utils/text-range';
+export declare const TextInputEventBuilder: {
+    /**
+     * Experimental values:
+     * - iOS: `{"eventCount": 4, "target": 75, "text": "Test"}`
+     * - Android: `{"eventCount": 6, "target": 53, "text": "Tes"}`
+     */
+    change: (text: string) => {
+        nativeEvent: {
+            text: string;
+            target: number;
+            eventCount: number;
+        };
+    };
+    /**
+     * Experimental values:
+     * - iOS: `{"eventCount": 3, "key": "a", "target": 75}`
+     * - Android: `{"key": "a"}`
+     */
+    keyPress: (key: string) => {
+        nativeEvent: {
+            key: string;
+        };
+    };
+    /**
+     * Experimental values:
+     * - iOS: `{"eventCount": 4, "target": 75, "text": "Test"}`
+     * - Android: `{"target": 53, "text": "Test"}`
+     */
+    submitEditing: (text: string) => {
+        nativeEvent: {
+            text: string;
+            target: number;
+        };
+    };
+    /**
+     * Experimental values:
+     * - iOS: `{"eventCount": 4, "target": 75, "text": "Test"}`
+     * - Android: `{"target": 53, "text": "Test"}`
+     */
+    endEditing: (text: string) => {
+        nativeEvent: {
+            text: string;
+            target: number;
+        };
+    };
+    /**
+     * Experimental values:
+     * - iOS: `{"selection": {"end": 4, "start": 4}, "target": 75}`
+     * - Android: `{"selection": {"end": 4, "start": 4}}`
+     */
+    selectionChange: ({ start, end }: TextRange) => {
+        nativeEvent: {
+            selection: {
+                start: number;
+                end: number;
+            };
+        };
+    };
+    /**
+     * Experimental values:
+     * - iOS: `{"eventCount": 2, "previousText": "Te", "range": {"end": 2, "start": 2}, "target": 75, "text": "s"}`
+     * - Android: `{"previousText": "Te", "range": {"end": 2, "start": 0}, "target": 53, "text": "Tes"}`
+     */
+    textInput: (text: string, previousText: string) => {
+        nativeEvent: {
+            text: string;
+            previousText: string;
+            range: {
+                start: number;
+                end: number;
+            };
+            target: number;
+        };
+    };
+    /**
+     * Experimental values:
+     * - iOS: `{"contentSize": {"height": 21.666666666666668, "width": 11.666666666666666}, "target": 75}`
+     * - Android: `{"contentSize": {"height": 61.45454406738281, "width": 352.7272644042969}, "target": 53}`
+     */
+    contentSizeChange: ({ width, height }: ContentSize) => {
+        nativeEvent: {
+            contentSize: {
+                width: number;
+                height: number;
+            };
+            target: number;
+        };
+    };
+};

package/build/user-event/event-builder/text-input.js

@@ -0,0 +1,117 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TextInputEventBuilder = void 0;
+const TextInputEventBuilder = {
+  /**
+   * Experimental values:
+   * - iOS: `{"eventCount": 4, "target": 75, "text": "Test"}`
+   * - Android: `{"eventCount": 6, "target": 53, "text": "Tes"}`
+   */
+  change: text => {
+    return {
+      nativeEvent: {
+        text,
+        target: 0,
+        eventCount: 0
+      }
+    };
+  },
+  /**
+   * Experimental values:
+   * - iOS: `{"eventCount": 3, "key": "a", "target": 75}`
+   * - Android: `{"key": "a"}`
+   */
+  keyPress: key => {
+    return {
+      nativeEvent: {
+        key
+      }
+    };
+  },
+  /**
+   * Experimental values:
+   * - iOS: `{"eventCount": 4, "target": 75, "text": "Test"}`
+   * - Android: `{"target": 53, "text": "Test"}`
+   */
+  submitEditing: text => {
+    return {
+      nativeEvent: {
+        text,
+        target: 0
+      }
+    };
+  },
+  /**
+   * Experimental values:
+   * - iOS: `{"eventCount": 4, "target": 75, "text": "Test"}`
+   * - Android: `{"target": 53, "text": "Test"}`
+   */
+  endEditing: text => {
+    return {
+      nativeEvent: {
+        text,
+        target: 0
+      }
+    };
+  },
+  /**
+   * Experimental values:
+   * - iOS: `{"selection": {"end": 4, "start": 4}, "target": 75}`
+   * - Android: `{"selection": {"end": 4, "start": 4}}`
+   */
+  selectionChange: ({
+    start,
+    end
+  }) => {
+    return {
+      nativeEvent: {
+        selection: {
+          start,
+          end
+        }
+      }
+    };
+  },
+  /**
+   * Experimental values:
+   * - iOS: `{"eventCount": 2, "previousText": "Te", "range": {"end": 2, "start": 2}, "target": 75, "text": "s"}`
+   * - Android: `{"previousText": "Te", "range": {"end": 2, "start": 0}, "target": 53, "text": "Tes"}`
+   */
+  textInput: (text, previousText) => {
+    return {
+      nativeEvent: {
+        text,
+        previousText,
+        range: {
+          start: text.length,
+          end: text.length
+        },
+        target: 0
+      }
+    };
+  },
+  /**
+   * Experimental values:
+   * - iOS: `{"contentSize": {"height": 21.666666666666668, "width": 11.666666666666666}, "target": 75}`
+   * - Android: `{"contentSize": {"height": 61.45454406738281, "width": 352.7272644042969}, "target": 53}`
+   */
+  contentSizeChange: ({
+    width,
+    height
+  }) => {
+    return {
+      nativeEvent: {
+        contentSize: {
+          width,
+          height
+        },
+        target: 0
+      }
+    };
+  }
+};
+exports.TextInputEventBuilder = TextInputEventBuilder;
+//# sourceMappingURL=text-input.js.map

package/build/user-event/event-builder/text-input.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text-input.js","names":["TextInputEventBuilder","change","text","nativeEvent","target","eventCount","keyPress","key","submitEditing","endEditing","selectionChange","start","end","selection","textInput","previousText","range","length","contentSizeChange","width","height","contentSize","exports"],"sources":["../../../src/user-event/event-builder/text-input.ts"],"sourcesContent":["import { ContentSize } from '../utils/content-size';\nimport { TextRange } from '../utils/text-range';\n\nexport const TextInputEventBuilder = {\n  /**\n   * Experimental values:\n   * - iOS: `{\"eventCount\": 4, \"target\": 75, \"text\": \"Test\"}`\n   * - Android: `{\"eventCount\": 6, \"target\": 53, \"text\": \"Tes\"}`\n   */\n  change: (text: string) => {\n    return {\n      nativeEvent: { text, target: 0, eventCount: 0 },\n    };\n  },\n\n  /**\n   * Experimental values:\n   * - iOS: `{\"eventCount\": 3, \"key\": \"a\", \"target\": 75}`\n   * - Android: `{\"key\": \"a\"}`\n   */\n  keyPress: (key: string) => {\n    return {\n      nativeEvent: { key },\n    };\n  },\n\n  /**\n   * Experimental values:\n   * - iOS: `{\"eventCount\": 4, \"target\": 75, \"text\": \"Test\"}`\n   * - Android: `{\"target\": 53, \"text\": \"Test\"}`\n   */\n  submitEditing: (text: string) => {\n    return {\n      nativeEvent: { text, target: 0 },\n    };\n  },\n\n  /**\n   * Experimental values:\n   * - iOS: `{\"eventCount\": 4, \"target\": 75, \"text\": \"Test\"}`\n   * - Android: `{\"target\": 53, \"text\": \"Test\"}`\n   */\n  endEditing: (text: string) => {\n    return {\n      nativeEvent: { text, target: 0 },\n    };\n  },\n\n  /**\n   * Experimental values:\n   * - iOS: `{\"selection\": {\"end\": 4, \"start\": 4}, \"target\": 75}`\n   * - Android: `{\"selection\": {\"end\": 4, \"start\": 4}}`\n   */\n  selectionChange: ({ start, end }: TextRange) => {\n    return {\n      nativeEvent: { selection: { start, end } },\n    };\n  },\n\n  /**\n   * Experimental values:\n   * - iOS: `{\"eventCount\": 2, \"previousText\": \"Te\", \"range\": {\"end\": 2, \"start\": 2}, \"target\": 75, \"text\": \"s\"}`\n   * - Android: `{\"previousText\": \"Te\", \"range\": {\"end\": 2, \"start\": 0}, \"target\": 53, \"text\": \"Tes\"}`\n   */\n  textInput: (text: string, previousText: string) => {\n    return {\n      nativeEvent: {\n        text,\n        previousText,\n        range: { start: text.length, end: text.length },\n        target: 0,\n      },\n    };\n  },\n\n  /**\n   * Experimental values:\n   * - iOS: `{\"contentSize\": {\"height\": 21.666666666666668, \"width\": 11.666666666666666}, \"target\": 75}`\n   * - Android: `{\"contentSize\": {\"height\": 61.45454406738281, \"width\": 352.7272644042969}, \"target\": 53}`\n   */\n  contentSizeChange: ({ width, height }: ContentSize) => {\n    return {\n      nativeEvent: { contentSize: { width, height }, target: 0 },\n    };\n  },\n};\n"],"mappings":";;;;;;AAGO,MAAMA,qBAAqB,GAAG;EACnC;AACF;AACA;AACA;AACA;EACEC,MAAM,EAAGC,IAAY,IAAK;IACxB,OAAO;MACLC,WAAW,EAAE;QAAED,IAAI;QAAEE,MAAM,EAAE,CAAC;QAAEC,UAAU,EAAE;MAAE;IAChD,CAAC;EACH,CAAC;EAED;AACF;AACA;AACA;AACA;EACEC,QAAQ,EAAGC,GAAW,IAAK;IACzB,OAAO;MACLJ,WAAW,EAAE;QAAEI;MAAI;IACrB,CAAC;EACH,CAAC;EAED;AACF;AACA;AACA;AACA;EACEC,aAAa,EAAGN,IAAY,IAAK;IAC/B,OAAO;MACLC,WAAW,EAAE;QAAED,IAAI;QAAEE,MAAM,EAAE;MAAE;IACjC,CAAC;EACH,CAAC;EAED;AACF;AACA;AACA;AACA;EACEK,UAAU,EAAGP,IAAY,IAAK;IAC5B,OAAO;MACLC,WAAW,EAAE;QAAED,IAAI;QAAEE,MAAM,EAAE;MAAE;IACjC,CAAC;EACH,CAAC;EAED;AACF;AACA;AACA;AACA;EACEM,eAAe,EAAEA,CAAC;IAAEC,KAAK;IAAEC;EAAe,CAAC,KAAK;IAC9C,OAAO;MACLT,WAAW,EAAE;QAAEU,SAAS,EAAE;UAAEF,KAAK;UAAEC;QAAI;MAAE;IAC3C,CAAC;EACH,CAAC;EAED;AACF;AACA;AACA;AACA;EACEE,SAAS,EAAEA,CAACZ,IAAY,EAAEa,YAAoB,KAAK;IACjD,OAAO;MACLZ,WAAW,EAAE;QACXD,IAAI;QACJa,YAAY;QACZC,KAAK,EAAE;UAAEL,KAAK,EAAET,IAAI,CAACe,MAAM;UAAEL,GAAG,EAAEV,IAAI,CAACe;QAAO,CAAC;QAC/Cb,MAAM,EAAE;MACV;IACF,CAAC;EACH,CAAC;EAED;AACF;AACA;AACA;AACA;EACEc,iBAAiB,EAAEA,CAAC;IAAEC,KAAK;IAAEC;EAAoB,CAAC,KAAK;IACrD,OAAO;MACLjB,WAAW,EAAE;QAAEkB,WAAW,EAAE;UAAEF,KAAK;UAAEC;QAAO,CAAC;QAAEhB,MAAM,EAAE;MAAE;IAC3D,CAAC;EACH;AACF,CAAC;AAACkB,OAAA,CAAAtB,qBAAA,GAAAA,qBAAA"}

package/build/user-event/index.d.ts

@@ -1,9 +1,12 @@
 import { ReactTestInstance } from 'react-test-renderer';
 import { setup } from './setup';
-import { PressOptions } from './press/press';
+import { PressOptions } from './press';
+import { TypeOptions } from './type';
+export { UserEventConfig } from './setup';
 export declare const userEvent: {
     setup: typeof setup;
     press: (element: ReactTestInstance) => Promise<void>;
     longPress: (element: ReactTestInstance, options?: PressOptions) => Promise<void>;
-    type: (element: ReactTestInstance, text: string) => Promise<void>;
+    type: (element: ReactTestInstance, text: string, options?: TypeOptions) => Promise<void>;
+    clear: (element: ReactTestInstance) => Promise<void>;
 };

package/build/user-event/index.js

@@ -3,6 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "UserEventConfig", {
+  enumerable: true,
+  get: function () {
+    return _setup.UserEventConfig;
+  }
+});
 exports.userEvent = void 0;
 var _setup = require("./setup");
 const userEvent = {
@@ -10,7 +16,8 @@ const userEvent = {
   // Direct access for User Event v13 compatibility
   press: element => (0, _setup.setup)().press(element),
   longPress: (element, options) => (0, _setup.setup)().longPress(element, options),
-  type: (element, text) => (0, _setup.setup)().type(element, text)
+  type: (element, text, options) => (0, _setup.setup)().type(element, text, options),
+  clear: element => (0, _setup.setup)().clear(element)
 };
 exports.userEvent = userEvent;
 //# sourceMappingURL=index.js.map

package/build/user-event/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["_setup","require","userEvent","setup","press","element","longPress","options","type","text","exports"],"sources":["../../src/user-event/index.ts"],"sourcesContent":["import { ReactTestInstance } from 'react-test-renderer';\nimport { setup } from './setup';\nimport { PressOptions } from './press/press';\n\nexport const userEvent = {\n  setup,\n\n  // Direct access for User Event v13 compatibility\n  press: (element: ReactTestInstance) => setup().press(element),\n  longPress: (element: ReactTestInstance, options?: PressOptions) =>\n    setup().longPress(element, options),\n  type: (element: ReactTestInstance, text: string) =>\n    setup().type(element, text),\n};\n"],"mappings":";;;;;;AACA,IAAAA,MAAA,GAAAC,OAAA;AAGO,MAAMC,SAAS,GAAG;EACvBC,KAAK,EAALA,YAAK;EAEL;EACAC,KAAK,EAAGC,OAA0B,IAAK,IAAAF,YAAK,EAAC,CAAC,CAACC,KAAK,CAACC,OAAO,CAAC;EAC7DC,SAAS,EAAEA,CAACD,OAA0B,EAAEE,OAAsB,KAC5D,IAAAJ,YAAK,EAAC,CAAC,CAACG,SAAS,CAACD,OAAO,EAAEE,OAAO,CAAC;EACrCC,IAAI,EAAEA,CAACH,OAA0B,EAAEI,IAAY,KAC7C,IAAAN,YAAK,EAAC,CAAC,CAACK,IAAI,CAACH,OAAO,EAAEI,IAAI;AAC9B,CAAC;AAACC,OAAA,CAAAR,SAAA,GAAAA,SAAA"}
+{"version":3,"file":"index.js","names":["_setup","require","userEvent","setup","press","element","longPress","options","type","text","clear","exports"],"sources":["../../src/user-event/index.ts"],"sourcesContent":["import { ReactTestInstance } from 'react-test-renderer';\nimport { setup } from './setup';\nimport { PressOptions } from './press';\nimport { TypeOptions } from './type';\n\nexport { UserEventConfig } from './setup';\n\nexport const userEvent = {\n  setup,\n\n  // Direct access for User Event v13 compatibility\n  press: (element: ReactTestInstance) => setup().press(element),\n  longPress: (element: ReactTestInstance, options?: PressOptions) =>\n    setup().longPress(element, options),\n  type: (element: ReactTestInstance, text: string, options?: TypeOptions) =>\n    setup().type(element, text, options),\n  clear: (element: ReactTestInstance) => setup().clear(element),\n};\n"],"mappings":";;;;;;;;;;;;AACA,IAAAA,MAAA,GAAAC,OAAA;AAMO,MAAMC,SAAS,GAAG;EACvBC,KAAK,EAALA,YAAK;EAEL;EACAC,KAAK,EAAGC,OAA0B,IAAK,IAAAF,YAAK,EAAC,CAAC,CAACC,KAAK,CAACC,OAAO,CAAC;EAC7DC,SAAS,EAAEA,CAACD,OAA0B,EAAEE,OAAsB,KAC5D,IAAAJ,YAAK,EAAC,CAAC,CAACG,SAAS,CAACD,OAAO,EAAEE,OAAO,CAAC;EACrCC,IAAI,EAAEA,CAACH,OAA0B,EAAEI,IAAY,EAAEF,OAAqB,KACpE,IAAAJ,YAAK,EAAC,CAAC,CAACK,IAAI,CAACH,OAAO,EAAEI,IAAI,EAAEF,OAAO,CAAC;EACtCG,KAAK,EAAGL,OAA0B,IAAK,IAAAF,YAAK,EAAC,CAAC,CAACO,KAAK,CAACL,OAAO;AAC9D,CAAC;AAACM,OAAA,CAAAT,SAAA,GAAAA,SAAA"}

package/build/user-event/press/index.d.ts

@@ -1 +1 @@
-export { press, longPress } from './press';
+export { PressOptions, press, longPress } from './press';

package/build/user-event/press/index.js

@@ -3,6 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "PressOptions", {
+  enumerable: true,
+  get: function () {
+    return _press.PressOptions;
+  }
+});
 Object.defineProperty(exports, "longPress", {
   enumerable: true,
   get: function () {

package/build/user-event/press/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["_press","require"],"sources":["../../../src/user-event/press/index.ts"],"sourcesContent":["export { press, longPress } from './press';\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA"}
+{"version":3,"file":"index.js","names":["_press","require"],"sources":["../../../src/user-event/press/index.ts"],"sourcesContent":["export { PressOptions, press, longPress } from './press';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA"}

package/build/user-event/press/press.d.ts

@@ -1,7 +1,7 @@
 import { ReactTestInstance } from 'react-test-renderer';
 import { UserEventInstance } from '../setup';
-export type PressOptions = {
-    duration: number;
-};
+export interface PressOptions {
+    duration?: number;
+}
 export declare function press(this: UserEventInstance, element: ReactTestInstance): Promise<void>;
 export declare function longPress(this: UserEventInstance, element: ReactTestInstance, options?: PressOptions): Promise<void>;

package/build/user-event/press/press.js

@@ -5,37 +5,37 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.longPress = longPress;
 exports.press = press;
-var _eventBuilder = require("../event-builder");
-var _utils = require("../utils");
 var _act = _interopRequireDefault(require("../../act"));
 var _componentTree = require("../../helpers/component-tree");
-var _filterNodeByType = require("../../helpers/filterNodeByType");
 var _pointerEvents = require("../../helpers/pointer-events");
 var _hostComponentNames = require("../../helpers/host-component-names");
-var _timers = require("../../helpers/timers");
+var _eventBuilder = require("../event-builder");
+var _utils = require("../utils");
 var _constants = require("./constants");
-var _warnAboutRealTimers = require("./utils/warnAboutRealTimers");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 async function press(element) {
-  await basePress(this.config, element);
+  await basePress(this.config, element, {
+    type: 'press',
+    duration: 0
+  });
 }
-async function longPress(element, options = {
-  duration: 500
-}) {
-  await basePress(this.config, element, options);
+async function longPress(element, options) {
+  await basePress(this.config, element, {
+    type: 'longPress',
+    duration: options?.duration ?? 500
+  });
 }
-const basePress = async (config, element, options = {
-  duration: 0
-}) => {
-  // Text and TextInput components are mocked in React Native preset so the mock
-  // doesn't implement the pressability class
-  // Thus we need to call the props directly on the host component
-  if (isEnabledHostText(element) || isEnabledTextInput(element)) {
-    await triggerMockPressEvent(config, element, options);
+const basePress = async (config, element, options) => {
+  if (isPressableText(element)) {
+    await emitTextPressEvents(config, element, options);
+    return;
+  }
+  if ((0, _utils.isEditableTextInput)(element) && (0, _pointerEvents.isPointerEventEnabled)(element)) {
+    await emitTextInputPressEvents(config, element, options);
     return;
   }
   if (isEnabledTouchResponder(element)) {
-    await triggerPressEvent(config, element, options);
+    await emitPressablePressEvents(config, element, options);
     return;
   }
   const hostParentElement = (0, _componentTree.getHostParent)(element);
@@ -44,28 +44,17 @@ const basePress = async (config, element, options = {
   }
   await basePress(config, hostParentElement, options);
 };
-const triggerPressEvent = async (config, element, options = {
-  duration: 0
-}) => {
-  const areFakeTimersEnabled = (0, _timers.jestFakeTimersAreEnabled)();
-  if (!areFakeTimersEnabled) {
-    (0, _warnAboutRealTimers.warnAboutRealTimers)();
-  }
+const emitPressablePressEvents = async (config, element, options) => {
+  (0, _utils.warnAboutRealTimersIfNeeded)();
   await (0, _utils.wait)(config);
   await (0, _act.default)(async () => {
-    element.props.onResponderGrant({
-      ..._eventBuilder.EventBuilder.Common.touch(),
-      dispatchConfig: {
-        registrationName: 'onResponderGrant'
-      }
-    });
+    (0, _utils.dispatchEvent)(element, 'responderGrant', _eventBuilder.EventBuilder.Common.responderGrant());
     await (0, _utils.wait)(config, options.duration);
-    element.props.onResponderRelease({
-      ..._eventBuilder.EventBuilder.Common.touch(),
-      dispatchConfig: {
-        registrationName: 'onResponderRelease'
-      }
-    });
+    (0, _utils.dispatchEvent)(element, 'responderRelease', _eventBuilder.EventBuilder.Common.responderRelease());
+
+    // React Native will wait for minimal delay of DEFAULT_MIN_PRESS_DURATION
+    // before emitting the `pressOut` event. We need to wait here, so that
+    // `press()` function does not return before that.
     if (_constants.DEFAULT_MIN_PRESS_DURATION - options.duration > 0) {
       await (0, _utils.wait)(config, _constants.DEFAULT_MIN_PRESS_DURATION - options.duration);
     }
@@ -74,33 +63,34 @@ const triggerPressEvent = async (config, element, options = {
 const isEnabledTouchResponder = element => {
   return (0, _pointerEvents.isPointerEventEnabled)(element) && element.props.onStartShouldSetResponder?.();
 };
-const isEnabledHostText = element => {
-  return (0, _filterNodeByType.filterNodeByType)(element, (0, _hostComponentNames.getHostComponentNames)().text) && (0, _pointerEvents.isPointerEventEnabled)(element) && !element.props.disabled && element.props.onPress;
-};
-const isEnabledTextInput = element => {
-  return (0, _filterNodeByType.filterNodeByType)(element, (0, _hostComponentNames.getHostComponentNames)().textInput) && (0, _pointerEvents.isPointerEventEnabled)(element) && element.props.editable !== false;
+const isPressableText = element => {
+  const hasPressEventHandler = Boolean(element.props.onPress || element.props.onLongPress || element.props.onPressIn || element.props.onPressOut);
+  return (0, _hostComponentNames.isHostText)(element) && (0, _pointerEvents.isPointerEventEnabled)(element) && !element.props.disabled && hasPressEventHandler;
 };
-const triggerMockPressEvent = async (config, element, options = {
-  duration: 0
-}) => {
-  const {
-    onPressIn,
-    onPress,
-    onPressOut
-  } = element.props;
+
+/**
+ * Dispatches a press event sequence for Text.
+ */
+async function emitTextPressEvents(config, element, options) {
   await (0, _utils.wait)(config);
-  if (onPressIn) {
-    onPressIn(_eventBuilder.EventBuilder.Common.touch());
-  }
-  if (onPress) {
-    onPress(_eventBuilder.EventBuilder.Common.touch());
-  }
+  (0, _utils.dispatchEvent)(element, 'pressIn', _eventBuilder.EventBuilder.Common.touch());
+
+  // Emit either `press` or `longPress`.
+  (0, _utils.dispatchEvent)(element, options.type, _eventBuilder.EventBuilder.Common.touch());
   await (0, _utils.wait)(config, options.duration);
-  if (onPressOut) {
-    if (_constants.DEFAULT_MIN_PRESS_DURATION - options.duration > 0) {
-      await (0, _utils.wait)(config, _constants.DEFAULT_MIN_PRESS_DURATION - options.duration);
-    }
-    onPressOut(_eventBuilder.EventBuilder.Common.touch());
-  }
-};
+  (0, _utils.dispatchEvent)(element, 'pressOut', _eventBuilder.EventBuilder.Common.touch());
+}
+
+/**
+ * Dispatches a press event sequence for TextInput.
+ */
+async function emitTextInputPressEvents(config, element, options) {
+  await (0, _utils.wait)(config);
+  (0, _utils.dispatchEvent)(element, 'pressIn', _eventBuilder.EventBuilder.Common.touch());
+
+  // Note: TextInput does not have `onPress`/`onLongPress` props.
+
+  await (0, _utils.wait)(config, options.duration);
+  (0, _utils.dispatchEvent)(element, 'pressOut', _eventBuilder.EventBuilder.Common.touch());
+}
 //# sourceMappingURL=press.js.map

package/build/user-event/press/press.js.map

@@ -1 +1 @@
-{"version":3,"file":"press.js","names":["_eventBuilder","require","_utils","_act","_interopRequireDefault","_componentTree","_filterNodeByType","_pointerEvents","_hostComponentNames","_timers","_constants","_warnAboutRealTimers","obj","__esModule","default","press","element","basePress","config","longPress","options","duration","isEnabledHostText","isEnabledTextInput","triggerMockPressEvent","isEnabledTouchResponder","triggerPressEvent","hostParentElement","getHostParent","areFakeTimersEnabled","jestFakeTimersAreEnabled","warnAboutRealTimers","wait","act","props","onResponderGrant","EventBuilder","Common","touch","dispatchConfig","registrationName","onResponderRelease","DEFAULT_MIN_PRESS_DURATION","isPointerEventEnabled","onStartShouldSetResponder","filterNodeByType","getHostComponentNames","text","disabled","onPress","textInput","editable","onPressIn","onPressOut"],"sources":["../../../src/user-event/press/press.ts"],"sourcesContent":["import { ReactTestInstance } from 'react-test-renderer';\nimport { EventBuilder } from '../event-builder';\nimport { UserEventInstance } from '../setup';\nimport { wait } from '../utils';\nimport act from '../../act';\nimport { getHostParent } from '../../helpers/component-tree';\nimport { filterNodeByType } from '../../helpers/filterNodeByType';\nimport { isPointerEventEnabled } from '../../helpers/pointer-events';\nimport { getHostComponentNames } from '../../helpers/host-component-names';\nimport { jestFakeTimersAreEnabled } from '../../helpers/timers';\nimport { DEFAULT_MIN_PRESS_DURATION } from './constants';\nimport { warnAboutRealTimers } from './utils/warnAboutRealTimers';\n\nexport type PressOptions = {\n  duration: number;\n};\n\nexport async function press(\n  this: UserEventInstance,\n  element: ReactTestInstance\n): Promise<void> {\n  await basePress(this.config, element);\n}\n\nexport async function longPress(\n  this: UserEventInstance,\n  element: ReactTestInstance,\n  options: PressOptions = { duration: 500 }\n): Promise<void> {\n  await basePress(this.config, element, options);\n}\n\nconst basePress = async (\n  config: UserEventInstance['config'],\n  element: ReactTestInstance,\n  options: PressOptions = { duration: 0 }\n): Promise<void> => {\n  // Text and TextInput components are mocked in React Native preset so the mock\n  // doesn't implement the pressability class\n  // Thus we need to call the props directly on the host component\n  if (isEnabledHostText(element) || isEnabledTextInput(element)) {\n    await triggerMockPressEvent(config, element, options);\n    return;\n  }\n\n  if (isEnabledTouchResponder(element)) {\n    await triggerPressEvent(config, element, options);\n    return;\n  }\n\n  const hostParentElement = getHostParent(element);\n  if (!hostParentElement) {\n    return;\n  }\n\n  await basePress(config, hostParentElement, options);\n};\n\nconst triggerPressEvent = async (\n  config: UserEventInstance['config'],\n  element: ReactTestInstance,\n  options: PressOptions = { duration: 0 }\n) => {\n  const areFakeTimersEnabled = jestFakeTimersAreEnabled();\n  if (!areFakeTimersEnabled) {\n    warnAboutRealTimers();\n  }\n\n  await wait(config);\n\n  await act(async () => {\n    element.props.onResponderGrant({\n      ...EventBuilder.Common.touch(),\n      dispatchConfig: { registrationName: 'onResponderGrant' },\n    });\n\n    await wait(config, options.duration);\n\n    element.props.onResponderRelease({\n      ...EventBuilder.Common.touch(),\n      dispatchConfig: { registrationName: 'onResponderRelease' },\n    });\n\n    if (DEFAULT_MIN_PRESS_DURATION - options.duration > 0) {\n      await wait(config, DEFAULT_MIN_PRESS_DURATION - options.duration);\n    }\n  });\n};\n\nconst isEnabledTouchResponder = (element: ReactTestInstance) => {\n  return (\n    isPointerEventEnabled(element) &&\n    element.props.onStartShouldSetResponder?.()\n  );\n};\n\nconst isEnabledHostText = (element: ReactTestInstance) => {\n  return (\n    filterNodeByType(element, getHostComponentNames().text) &&\n    isPointerEventEnabled(element) &&\n    !element.props.disabled &&\n    element.props.onPress\n  );\n};\n\nconst isEnabledTextInput = (element: ReactTestInstance) => {\n  return (\n    filterNodeByType(element, getHostComponentNames().textInput) &&\n    isPointerEventEnabled(element) &&\n    element.props.editable !== false\n  );\n};\n\nconst triggerMockPressEvent = async (\n  config: UserEventInstance['config'],\n  element: ReactTestInstance,\n  options: PressOptions = { duration: 0 }\n) => {\n  const { onPressIn, onPress, onPressOut } = element.props;\n  await wait(config);\n  if (onPressIn) {\n    onPressIn(EventBuilder.Common.touch());\n  }\n  if (onPress) {\n    onPress(EventBuilder.Common.touch());\n  }\n  await wait(config, options.duration);\n  if (onPressOut) {\n    if (DEFAULT_MIN_PRESS_DURATION - options.duration > 0) {\n      await wait(config, DEFAULT_MIN_PRESS_DURATION - options.duration);\n    }\n    onPressOut(EventBuilder.Common.touch());\n  }\n};\n"],"mappings":";;;;;;;AACA,IAAAA,aAAA,GAAAC,OAAA;AAEA,IAAAC,MAAA,GAAAD,OAAA;AACA,IAAAE,IAAA,GAAAC,sBAAA,CAAAH,OAAA;AACA,IAAAI,cAAA,GAAAJ,OAAA;AACA,IAAAK,iBAAA,GAAAL,OAAA;AACA,IAAAM,cAAA,GAAAN,OAAA;AACA,IAAAO,mBAAA,GAAAP,OAAA;AACA,IAAAQ,OAAA,GAAAR,OAAA;AACA,IAAAS,UAAA,GAAAT,OAAA;AACA,IAAAU,oBAAA,GAAAV,OAAA;AAAkE,SAAAG,uBAAAQ,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAM3D,eAAeG,KAAKA,CAEzBC,OAA0B,EACX;EACf,MAAMC,SAAS,CAAC,IAAI,CAACC,MAAM,EAAEF,OAAO,CAAC;AACvC;AAEO,eAAeG,SAASA,CAE7BH,OAA0B,EAC1BI,OAAqB,GAAG;EAAEC,QAAQ,EAAE;AAAI,CAAC,EAC1B;EACf,MAAMJ,SAAS,CAAC,IAAI,CAACC,MAAM,EAAEF,OAAO,EAAEI,OAAO,CAAC;AAChD;AAEA,MAAMH,SAAS,GAAG,MAAAA,CAChBC,MAAmC,EACnCF,OAA0B,EAC1BI,OAAqB,GAAG;EAAEC,QAAQ,EAAE;AAAE,CAAC,KACrB;EAClB;EACA;EACA;EACA,IAAIC,iBAAiB,CAACN,OAAO,CAAC,IAAIO,kBAAkB,CAACP,OAAO,CAAC,EAAE;IAC7D,MAAMQ,qBAAqB,CAACN,MAAM,EAAEF,OAAO,EAAEI,OAAO,CAAC;IACrD;EACF;EAEA,IAAIK,uBAAuB,CAACT,OAAO,CAAC,EAAE;IACpC,MAAMU,iBAAiB,CAACR,MAAM,EAAEF,OAAO,EAAEI,OAAO,CAAC;IACjD;EACF;EAEA,MAAMO,iBAAiB,GAAG,IAAAC,4BAAa,EAACZ,OAAO,CAAC;EAChD,IAAI,CAACW,iBAAiB,EAAE;IACtB;EACF;EAEA,MAAMV,SAAS,CAACC,MAAM,EAAES,iBAAiB,EAAEP,OAAO,CAAC;AACrD,CAAC;AAED,MAAMM,iBAAiB,GAAG,MAAAA,CACxBR,MAAmC,EACnCF,OAA0B,EAC1BI,OAAqB,GAAG;EAAEC,QAAQ,EAAE;AAAE,CAAC,KACpC;EACH,MAAMQ,oBAAoB,GAAG,IAAAC,gCAAwB,EAAC,CAAC;EACvD,IAAI,CAACD,oBAAoB,EAAE;IACzB,IAAAE,wCAAmB,EAAC,CAAC;EACvB;EAEA,MAAM,IAAAC,WAAI,EAACd,MAAM,CAAC;EAElB,MAAM,IAAAe,YAAG,EAAC,YAAY;IACpBjB,OAAO,CAACkB,KAAK,CAACC,gBAAgB,CAAC;MAC7B,GAAGC,0BAAY,CAACC,MAAM,CAACC,KAAK,CAAC,CAAC;MAC9BC,cAAc,EAAE;QAAEC,gBAAgB,EAAE;MAAmB;IACzD,CAAC,CAAC;IAEF,MAAM,IAAAR,WAAI,EAACd,MAAM,EAAEE,OAAO,CAACC,QAAQ,CAAC;IAEpCL,OAAO,CAACkB,KAAK,CAACO,kBAAkB,CAAC;MAC/B,GAAGL,0BAAY,CAACC,MAAM,CAACC,KAAK,CAAC,CAAC;MAC9BC,cAAc,EAAE;QAAEC,gBAAgB,EAAE;MAAqB;IAC3D,CAAC,CAAC;IAEF,IAAIE,qCAA0B,GAAGtB,OAAO,CAACC,QAAQ,GAAG,CAAC,EAAE;MACrD,MAAM,IAAAW,WAAI,EAACd,MAAM,EAAEwB,qCAA0B,GAAGtB,OAAO,CAACC,QAAQ,CAAC;IACnE;EACF,CAAC,CAAC;AACJ,CAAC;AAED,MAAMI,uBAAuB,GAAIT,OAA0B,IAAK;EAC9D,OACE,IAAA2B,oCAAqB,EAAC3B,OAAO,CAAC,IAC9BA,OAAO,CAACkB,KAAK,CAACU,yBAAyB,GAAG,CAAC;AAE/C,CAAC;AAED,MAAMtB,iBAAiB,GAAIN,OAA0B,IAAK;EACxD,OACE,IAAA6B,kCAAgB,EAAC7B,OAAO,EAAE,IAAA8B,yCAAqB,EAAC,CAAC,CAACC,IAAI,CAAC,IACvD,IAAAJ,oCAAqB,EAAC3B,OAAO,CAAC,IAC9B,CAACA,OAAO,CAACkB,KAAK,CAACc,QAAQ,IACvBhC,OAAO,CAACkB,KAAK,CAACe,OAAO;AAEzB,CAAC;AAED,MAAM1B,kBAAkB,GAAIP,OAA0B,IAAK;EACzD,OACE,IAAA6B,kCAAgB,EAAC7B,OAAO,EAAE,IAAA8B,yCAAqB,EAAC,CAAC,CAACI,SAAS,CAAC,IAC5D,IAAAP,oCAAqB,EAAC3B,OAAO,CAAC,IAC9BA,OAAO,CAACkB,KAAK,CAACiB,QAAQ,KAAK,KAAK;AAEpC,CAAC;AAED,MAAM3B,qBAAqB,GAAG,MAAAA,CAC5BN,MAAmC,EACnCF,OAA0B,EAC1BI,OAAqB,GAAG;EAAEC,QAAQ,EAAE;AAAE,CAAC,KACpC;EACH,MAAM;IAAE+B,SAAS;IAAEH,OAAO;IAAEI;EAAW,CAAC,GAAGrC,OAAO,CAACkB,KAAK;EACxD,MAAM,IAAAF,WAAI,EAACd,MAAM,CAAC;EAClB,IAAIkC,SAAS,EAAE;IACbA,SAAS,CAAChB,0BAAY,CAACC,MAAM,CAACC,KAAK,CAAC,CAAC,CAAC;EACxC;EACA,IAAIW,OAAO,EAAE;IACXA,OAAO,CAACb,0BAAY,CAACC,MAAM,CAACC,KAAK,CAAC,CAAC,CAAC;EACtC;EACA,MAAM,IAAAN,WAAI,EAACd,MAAM,EAAEE,OAAO,CAACC,QAAQ,CAAC;EACpC,IAAIgC,UAAU,EAAE;IACd,IAAIX,qCAA0B,GAAGtB,OAAO,CAACC,QAAQ,GAAG,CAAC,EAAE;MACrD,MAAM,IAAAW,WAAI,EAACd,MAAM,EAAEwB,qCAA0B,GAAGtB,OAAO,CAACC,QAAQ,CAAC;IACnE;IACAgC,UAAU,CAACjB,0BAAY,CAACC,MAAM,CAACC,KAAK,CAAC,CAAC,CAAC;EACzC;AACF,CAAC"}
+{"version":3,"file":"press.js","names":["_act","_interopRequireDefault","require","_componentTree","_pointerEvents","_hostComponentNames","_eventBuilder","_utils","_constants","obj","__esModule","default","press","element","basePress","config","type","duration","longPress","options","isPressableText","emitTextPressEvents","isEditableTextInput","isPointerEventEnabled","emitTextInputPressEvents","isEnabledTouchResponder","emitPressablePressEvents","hostParentElement","getHostParent","warnAboutRealTimersIfNeeded","wait","act","dispatchEvent","EventBuilder","Common","responderGrant","responderRelease","DEFAULT_MIN_PRESS_DURATION","props","onStartShouldSetResponder","hasPressEventHandler","Boolean","onPress","onLongPress","onPressIn","onPressOut","isHostText","disabled","touch"],"sources":["../../../src/user-event/press/press.ts"],"sourcesContent":["import { ReactTestInstance } from 'react-test-renderer';\nimport act from '../../act';\nimport { getHostParent } from '../../helpers/component-tree';\nimport { isPointerEventEnabled } from '../../helpers/pointer-events';\nimport { isHostText } from '../../helpers/host-component-names';\nimport { EventBuilder } from '../event-builder';\nimport { UserEventConfig, UserEventInstance } from '../setup';\nimport {\n  dispatchEvent,\n  isEditableTextInput,\n  wait,\n  warnAboutRealTimersIfNeeded,\n} from '../utils';\nimport { DEFAULT_MIN_PRESS_DURATION } from './constants';\n\nexport interface PressOptions {\n  duration?: number;\n}\n\nexport async function press(\n  this: UserEventInstance,\n  element: ReactTestInstance\n): Promise<void> {\n  await basePress(this.config, element, {\n    type: 'press',\n    duration: 0,\n  });\n}\n\nexport async function longPress(\n  this: UserEventInstance,\n  element: ReactTestInstance,\n  options?: PressOptions\n): Promise<void> {\n  await basePress(this.config, element, {\n    type: 'longPress',\n    duration: options?.duration ?? 500,\n  });\n}\n\ninterface BasePressOptions {\n  type: 'press' | 'longPress';\n  duration: number;\n}\n\nconst basePress = async (\n  config: UserEventConfig,\n  element: ReactTestInstance,\n  options: BasePressOptions\n): Promise<void> => {\n  if (isPressableText(element)) {\n    await emitTextPressEvents(config, element, options);\n    return;\n  }\n\n  if (isEditableTextInput(element) && isPointerEventEnabled(element)) {\n    await emitTextInputPressEvents(config, element, options);\n    return;\n  }\n\n  if (isEnabledTouchResponder(element)) {\n    await emitPressablePressEvents(config, element, options);\n    return;\n  }\n\n  const hostParentElement = getHostParent(element);\n  if (!hostParentElement) {\n    return;\n  }\n\n  await basePress(config, hostParentElement, options);\n};\n\nconst emitPressablePressEvents = async (\n  config: UserEventConfig,\n  element: ReactTestInstance,\n  options: BasePressOptions\n) => {\n  warnAboutRealTimersIfNeeded();\n\n  await wait(config);\n\n  await act(async () => {\n    dispatchEvent(\n      element,\n      'responderGrant',\n      EventBuilder.Common.responderGrant()\n    );\n\n    await wait(config, options.duration);\n\n    dispatchEvent(\n      element,\n      'responderRelease',\n      EventBuilder.Common.responderRelease()\n    );\n\n    // React Native will wait for minimal delay of DEFAULT_MIN_PRESS_DURATION\n    // before emitting the `pressOut` event. We need to wait here, so that\n    // `press()` function does not return before that.\n    if (DEFAULT_MIN_PRESS_DURATION - options.duration > 0) {\n      await wait(config, DEFAULT_MIN_PRESS_DURATION - options.duration);\n    }\n  });\n};\n\nconst isEnabledTouchResponder = (element: ReactTestInstance) => {\n  return (\n    isPointerEventEnabled(element) &&\n    element.props.onStartShouldSetResponder?.()\n  );\n};\n\nconst isPressableText = (element: ReactTestInstance) => {\n  const hasPressEventHandler = Boolean(\n    element.props.onPress ||\n      element.props.onLongPress ||\n      element.props.onPressIn ||\n      element.props.onPressOut\n  );\n\n  return (\n    isHostText(element) &&\n    isPointerEventEnabled(element) &&\n    !element.props.disabled &&\n    hasPressEventHandler\n  );\n};\n\n/**\n * Dispatches a press event sequence for Text.\n */\nasync function emitTextPressEvents(\n  config: UserEventConfig,\n  element: ReactTestInstance,\n  options: BasePressOptions\n) {\n  await wait(config);\n  dispatchEvent(element, 'pressIn', EventBuilder.Common.touch());\n\n  // Emit either `press` or `longPress`.\n  dispatchEvent(element, options.type, EventBuilder.Common.touch());\n\n  await wait(config, options.duration);\n  dispatchEvent(element, 'pressOut', EventBuilder.Common.touch());\n}\n\n/**\n * Dispatches a press event sequence for TextInput.\n */\nasync function emitTextInputPressEvents(\n  config: UserEventConfig,\n  element: ReactTestInstance,\n  options: BasePressOptions\n) {\n  await wait(config);\n  dispatchEvent(element, 'pressIn', EventBuilder.Common.touch());\n\n  // Note: TextInput does not have `onPress`/`onLongPress` props.\n\n  await wait(config, options.duration);\n  dispatchEvent(element, 'pressOut', EventBuilder.Common.touch());\n}\n"],"mappings":";;;;;;;AACA,IAAAA,IAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,cAAA,GAAAD,OAAA;AACA,IAAAE,cAAA,GAAAF,OAAA;AACA,IAAAG,mBAAA,GAAAH,OAAA;AACA,IAAAI,aAAA,GAAAJ,OAAA;AAEA,IAAAK,MAAA,GAAAL,OAAA;AAMA,IAAAM,UAAA,GAAAN,OAAA;AAAyD,SAAAD,uBAAAQ,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAMlD,eAAeG,KAAKA,CAEzBC,OAA0B,EACX;EACf,MAAMC,SAAS,CAAC,IAAI,CAACC,MAAM,EAAEF,OAAO,EAAE;IACpCG,IAAI,EAAE,OAAO;IACbC,QAAQ,EAAE;EACZ,CAAC,CAAC;AACJ;AAEO,eAAeC,SAASA,CAE7BL,OAA0B,EAC1BM,OAAsB,EACP;EACf,MAAML,SAAS,CAAC,IAAI,CAACC,MAAM,EAAEF,OAAO,EAAE;IACpCG,IAAI,EAAE,WAAW;IACjBC,QAAQ,EAAEE,OAAO,EAAEF,QAAQ,IAAI;EACjC,CAAC,CAAC;AACJ;AAOA,MAAMH,SAAS,GAAG,MAAAA,CAChBC,MAAuB,EACvBF,OAA0B,EAC1BM,OAAyB,KACP;EAClB,IAAIC,eAAe,CAACP,OAAO,CAAC,EAAE;IAC5B,MAAMQ,mBAAmB,CAACN,MAAM,EAAEF,OAAO,EAAEM,OAAO,CAAC;IACnD;EACF;EAEA,IAAI,IAAAG,0BAAmB,EAACT,OAAO,CAAC,IAAI,IAAAU,oCAAqB,EAACV,OAAO,CAAC,EAAE;IAClE,MAAMW,wBAAwB,CAACT,MAAM,EAAEF,OAAO,EAAEM,OAAO,CAAC;IACxD;EACF;EAEA,IAAIM,uBAAuB,CAACZ,OAAO,CAAC,EAAE;IACpC,MAAMa,wBAAwB,CAACX,MAAM,EAAEF,OAAO,EAAEM,OAAO,CAAC;IACxD;EACF;EAEA,MAAMQ,iBAAiB,GAAG,IAAAC,4BAAa,EAACf,OAAO,CAAC;EAChD,IAAI,CAACc,iBAAiB,EAAE;IACtB;EACF;EAEA,MAAMb,SAAS,CAACC,MAAM,EAAEY,iBAAiB,EAAER,OAAO,CAAC;AACrD,CAAC;AAED,MAAMO,wBAAwB,GAAG,MAAAA,CAC/BX,MAAuB,EACvBF,OAA0B,EAC1BM,OAAyB,KACtB;EACH,IAAAU,kCAA2B,EAAC,CAAC;EAE7B,MAAM,IAAAC,WAAI,EAACf,MAAM,CAAC;EAElB,MAAM,IAAAgB,YAAG,EAAC,YAAY;IACpB,IAAAC,oBAAa,EACXnB,OAAO,EACP,gBAAgB,EAChBoB,0BAAY,CAACC,MAAM,CAACC,cAAc,CAAC,CACrC,CAAC;IAED,MAAM,IAAAL,WAAI,EAACf,MAAM,EAAEI,OAAO,CAACF,QAAQ,CAAC;IAEpC,IAAAe,oBAAa,EACXnB,OAAO,EACP,kBAAkB,EAClBoB,0BAAY,CAACC,MAAM,CAACE,gBAAgB,CAAC,CACvC,CAAC;;IAED;IACA;IACA;IACA,IAAIC,qCAA0B,GAAGlB,OAAO,CAACF,QAAQ,GAAG,CAAC,EAAE;MACrD,MAAM,IAAAa,WAAI,EAACf,MAAM,EAAEsB,qCAA0B,GAAGlB,OAAO,CAACF,QAAQ,CAAC;IACnE;EACF,CAAC,CAAC;AACJ,CAAC;AAED,MAAMQ,uBAAuB,GAAIZ,OAA0B,IAAK;EAC9D,OACE,IAAAU,oCAAqB,EAACV,OAAO,CAAC,IAC9BA,OAAO,CAACyB,KAAK,CAACC,yBAAyB,GAAG,CAAC;AAE/C,CAAC;AAED,MAAMnB,eAAe,GAAIP,OAA0B,IAAK;EACtD,MAAM2B,oBAAoB,GAAGC,OAAO,CAClC5B,OAAO,CAACyB,KAAK,CAACI,OAAO,IACnB7B,OAAO,CAACyB,KAAK,CAACK,WAAW,IACzB9B,OAAO,CAACyB,KAAK,CAACM,SAAS,IACvB/B,OAAO,CAACyB,KAAK,CAACO,UAClB,CAAC;EAED,OACE,IAAAC,8BAAU,EAACjC,OAAO,CAAC,IACnB,IAAAU,oCAAqB,EAACV,OAAO,CAAC,IAC9B,CAACA,OAAO,CAACyB,KAAK,CAACS,QAAQ,IACvBP,oBAAoB;AAExB,CAAC;;AAED;AACA;AACA;AACA,eAAenB,mBAAmBA,CAChCN,MAAuB,EACvBF,OAA0B,EAC1BM,OAAyB,EACzB;EACA,MAAM,IAAAW,WAAI,EAACf,MAAM,CAAC;EAClB,IAAAiB,oBAAa,EAACnB,OAAO,EAAE,SAAS,EAAEoB,0BAAY,CAACC,MAAM,CAACc,KAAK,CAAC,CAAC,CAAC;;EAE9D;EACA,IAAAhB,oBAAa,EAACnB,OAAO,EAAEM,OAAO,CAACH,IAAI,EAAEiB,0BAAY,CAACC,MAAM,CAACc,KAAK,CAAC,CAAC,CAAC;EAEjE,MAAM,IAAAlB,WAAI,EAACf,MAAM,EAAEI,OAAO,CAACF,QAAQ,CAAC;EACpC,IAAAe,oBAAa,EAACnB,OAAO,EAAE,UAAU,EAAEoB,0BAAY,CAACC,MAAM,CAACc,KAAK,CAAC,CAAC,CAAC;AACjE;;AAEA;AACA;AACA;AACA,eAAexB,wBAAwBA,CACrCT,MAAuB,EACvBF,OAA0B,EAC1BM,OAAyB,EACzB;EACA,MAAM,IAAAW,WAAI,EAACf,MAAM,CAAC;EAClB,IAAAiB,oBAAa,EAACnB,OAAO,EAAE,SAAS,EAAEoB,0BAAY,CAACC,MAAM,CAACc,KAAK,CAAC,CAAC,CAAC;;EAE9D;;EAEA,MAAM,IAAAlB,WAAI,EAACf,MAAM,EAAEI,OAAO,CAACF,QAAQ,CAAC;EACpC,IAAAe,oBAAa,EAACnB,OAAO,EAAE,UAAU,EAAEoB,0BAAY,CAACC,MAAM,CAACc,KAAK,CAAC,CAAC,CAAC;AACjE"}

package/build/user-event/setup/setup.d.ts

@@ -1,5 +1,6 @@
 import { ReactTestInstance } from 'react-test-renderer';
-import { PressOptions } from '../press/press';
+import { PressOptions } from '../press';
+import { TypeOptions } from '../type';
 export interface UserEventSetupOptions {
     /**
      * Between some subsequent inputs like typing a series of characters
@@ -24,16 +25,57 @@ export interface UserEventSetupOptions {
  * Creates a new instance of user event instance with the given options.
  *
  * @param options
- * @returns
+ * @returns UserEvent instance
  */
 export declare function setup(options?: UserEventSetupOptions): UserEventInstance;
+/**
+ * Options affecting all user event interactions.
+ *
+ * @param delay between some subsequent inputs like typing a series of characters
+ * @param advanceTimers function to be called to advance fake timers
+ */
 export interface UserEventConfig {
     delay: number;
     advanceTimers: (delay: number) => Promise<void> | void;
 }
+/**
+ * UserEvent instance used to invoke user interaction functions.
+ */
 export interface UserEventInstance {
     config: UserEventConfig;
     press: (element: ReactTestInstance) => Promise<void>;
     longPress: (element: ReactTestInstance, options?: PressOptions) => Promise<void>;
-    type: (element: ReactTestInstance, text: string) => Promise<void>;
+    /**
+     * Simulate user pressing on a given `TextInput` element and typing given text.
+     *
+     * This method will trigger the events for each character of the text:
+     * `keyPress`, `change`, `changeText`, `endEditing`, etc.
+     *
+     * It will also trigger events connected with entering and leaving the text
+     * input.
+     *
+     * The exact events sent depend on the props of the TextInput (`editable`,
+     * `multiline`, value, defaultValue, etc) and passed options.
+     *
+     * @param element TextInput element to type on
+     * @param text Text to type
+     * @param options Options affecting typing behavior:
+     *  - `skipPress` - if true, `pressIn` and `pressOut` events will not be
+     *   triggered.
+     * - `submitEditing` - if true, `submitEditing` event will be triggered after
+     * typing the text.
+     */
+    type: (element: ReactTestInstance, text: string, options?: TypeOptions) => Promise<void>;
+    /**
+     * Simulate user clearing the text of a given `TextInput` element.
+     *
+     * This method will simulate:
+     * 1. entering TextInput
+     * 2. selecting all text
+     * 3. pressing backspace to delete all text
+     * 4. leaving TextInput
+     *
+     * @param element TextInput element to clear
+     */
+    clear: (element: ReactTestInstance) => Promise<void>;
 }

package/build/user-event/setup/setup.js

@@ -7,6 +7,7 @@ exports.setup = setup;
 var _timers = require("../../helpers/timers");
 var _press = require("../press");
 var _type = require("../type");
+var _clear = require("../clear");
 /**
  * This functions allow wait to work correctly under both real and fake Jest timers.
  */
@@ -26,19 +27,32 @@ const defaultOptions = {
  * Creates a new instance of user event instance with the given options.
  *
  * @param options
- * @returns
+ * @returns UserEvent instance
  */
 function setup(options) {
   const config = createConfig(options);
   const instance = createInstance(config);
   return instance;
 }
+
+/**
+ * Options affecting all user event interactions.
+ *
+ * @param delay between some subsequent inputs like typing a series of characters
+ * @param advanceTimers function to be called to advance fake timers
+ */
+
 function createConfig(options) {
   return {
     ...defaultOptions,
     ...options
   };
 }
+
+/**
+ * UserEvent instance used to invoke user interaction functions.
+ */
+
 function createInstance(config) {
   const instance = {
     config
@@ -48,7 +62,8 @@ function createInstance(config) {
   const api = {
     press: _press.press.bind(instance),
     longPress: _press.longPress.bind(instance),
-    type: _type.type.bind(instance)
+    type: _type.type.bind(instance),
+    clear: _clear.clear.bind(instance)
   };
   Object.assign(instance, api);
   return instance;