@testing-library/react-native 11.1.0 → 11.3.0

package/build/render.d.ts

@@ -3,13 +3,14 @@ import * as React from 'react';
 export declare type RenderOptions = {
     wrapper?: React.ComponentType<any>;
     createNodeMock?: (element: React.ReactElement) => any;
+    unstable_validateStringsRenderedWithinText?: boolean;
 };
 export declare type RenderResult = ReturnType<typeof render>;
 /**
  * Renders test component deeply using react-test-renderer and exposes helpers
  * to assert on the output.
  */
-export default function render<T>(component: React.ReactElement<T>, { wrapper: Wrapper, createNodeMock }?: RenderOptions): {
+export default function render<T>(component: React.ReactElement<T>, { wrapper: Wrapper, createNodeMock, unstable_validateStringsRenderedWithinText, }?: RenderOptions): {
     update: (component: React.ReactElement<any, string | React.JSXElementConstructor<any>>) => void;
     unmount: () => void;
     container: TestRenderer.ReactTestInstance;
@@ -116,12 +117,24 @@ export default function render<T>(component: React.ReactElement<T>, { wrapper: W
     queryAllByAccessibilityState: import("./queries/makeQueries").QueryAllByQuery<import("react-native").AccessibilityState, void>;
     findByAccessibilityState: import("./queries/makeQueries").FindByQuery<import("react-native").AccessibilityState, void>;
     findAllByAccessibilityState: import("./queries/makeQueries").FindAllByQuery<import("react-native").AccessibilityState, void>;
-    getByRole: import("./queries/makeQueries").GetByQuery<import("./matches").TextMatch, void>;
-    getAllByRole: import("./queries/makeQueries").GetAllByQuery<import("./matches").TextMatch, void>;
-    queryByRole: import("./queries/makeQueries").QueryByQuery<import("./matches").TextMatch, void>;
-    queryAllByRole: import("./queries/makeQueries").QueryAllByQuery<import("./matches").TextMatch, void>;
-    findByRole: import("./queries/makeQueries").FindByQuery<import("./matches").TextMatch, void>;
-    findAllByRole: import("./queries/makeQueries").FindAllByQuery<import("./matches").TextMatch, void>;
+    getByRole: import("./queries/makeQueries").GetByQuery<import("./matches").TextMatch, {
+        name?: import("./matches").TextMatch | undefined;
+    }>;
+    getAllByRole: import("./queries/makeQueries").GetAllByQuery<import("./matches").TextMatch, {
+        name?: import("./matches").TextMatch | undefined;
+    }>;
+    queryByRole: import("./queries/makeQueries").QueryByQuery<import("./matches").TextMatch, {
+        name?: import("./matches").TextMatch | undefined;
+    }>;
+    queryAllByRole: import("./queries/makeQueries").QueryAllByQuery<import("./matches").TextMatch, {
+        name?: import("./matches").TextMatch | undefined;
+    }>;
+    findByRole: import("./queries/makeQueries").FindByQuery<import("./matches").TextMatch, {
+        name?: import("./matches").TextMatch | undefined;
+    }>;
+    findAllByRole: import("./queries/makeQueries").FindAllByQuery<import("./matches").TextMatch, {
+        name?: import("./matches").TextMatch | undefined;
+    }>;
     getByHintText: import("./queries/makeQueries").GetByQuery<import("./matches").TextMatch, void>;
     getAllByHintText: import("./queries/makeQueries").GetAllByQuery<import("./matches").TextMatch, void>;
     queryByHintText: import("./queries/makeQueries").QueryByQuery<import("./matches").TextMatch, void>;

package/build/render.js

@@ -21,6 +21,8 @@ var _within = require("./within");
 
 var _screen = require("./screen");
 
+var _stringValidation = require("./helpers/stringValidation");
+
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -32,14 +34,48 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * to assert on the output.
  */
 function render(component, {
+  wrapper: Wrapper,
+  createNodeMock,
+  unstable_validateStringsRenderedWithinText
+} = {}) {
+  if (unstable_validateStringsRenderedWithinText) {
+    return renderWithStringValidation(component, {
+      wrapper: Wrapper,
+      createNodeMock
+    });
+  }
+
+  const wrap = element => Wrapper ? /*#__PURE__*/React.createElement(Wrapper, null, element) : element;
+
+  const renderer = renderWithAct(wrap(component), createNodeMock ? {
+    createNodeMock
+  } : undefined);
+  return buildRenderResult(renderer, wrap);
+}
+
+function renderWithStringValidation(component, {
   wrapper: Wrapper,
   createNodeMock
 } = {}) {
-  const wrap = innerElement => Wrapper ? /*#__PURE__*/React.createElement(Wrapper, null, innerElement) : innerElement;
+  const handleRender = (_, phase) => {
+    if (phase === 'update') {
+      (0, _stringValidation.validateStringsRenderedWithinText)(_screen.screen.toJSON());
+    }
+  };
+
+  const wrap = element => /*#__PURE__*/React.createElement(React.Profiler, {
+    id: "renderProfiler",
+    onRender: handleRender
+  }, Wrapper ? /*#__PURE__*/React.createElement(Wrapper, null, element) : element);
 
   const renderer = renderWithAct(wrap(component), createNodeMock ? {
     createNodeMock
   } : undefined);
+  (0, _stringValidation.validateStringsRenderedWithinText)(renderer.toJSON());
+  return buildRenderResult(renderer, wrap);
+}
+
+function buildRenderResult(renderer, wrap) {
   const update = updateWithAct(renderer, wrap);
   const instance = renderer.root;
 

package/build/render.js.map

@@ -1 +1 @@
-{"version":3,"file":"render.js","names":["render","component","wrapper","Wrapper","createNodeMock","wrap","innerElement","renderer","renderWithAct","undefined","update","updateWithAct","instance","root","unmount","act","addToCleanupQueue","result","getQueriesForElement","container","rerender","toJSON","debug","setRenderResult","options","TestRenderer","create","debugImpl","message","json","debugDeep","shallow","debugShallow"],"sources":["../src/render.tsx"],"sourcesContent":["import TestRenderer from 'react-test-renderer';\nimport type { ReactTestInstance, ReactTestRenderer } from 'react-test-renderer';\nimport * as React from 'react';\nimport act from './act';\nimport { addToCleanupQueue } from './cleanup';\nimport debugShallow from './helpers/debugShallow';\nimport debugDeep from './helpers/debugDeep';\nimport { getQueriesForElement } from './within';\nimport { setRenderResult } from './screen';\n\nexport type RenderOptions = {\n  wrapper?: React.ComponentType<any>;\n  createNodeMock?: (element: React.ReactElement) => any;\n};\n\ntype TestRendererOptions = {\n  createNodeMock: (element: React.ReactElement) => any;\n};\n\nexport type RenderResult = ReturnType<typeof render>;\n\n/**\n * Renders test component deeply using react-test-renderer and exposes helpers\n * to assert on the output.\n */\nexport default function render<T>(\n  component: React.ReactElement<T>,\n  { wrapper: Wrapper, createNodeMock }: RenderOptions = {}\n) {\n  const wrap = (innerElement: React.ReactElement) =>\n    Wrapper ? <Wrapper>{innerElement}</Wrapper> : innerElement;\n\n  const renderer = renderWithAct(\n    wrap(component),\n    createNodeMock ? { createNodeMock } : undefined\n  );\n  const update = updateWithAct(renderer, wrap);\n  const instance = renderer.root;\n  const unmount = () => {\n    act(() => {\n      renderer.unmount();\n    });\n  };\n\n  addToCleanupQueue(unmount);\n\n  const result = {\n    ...getQueriesForElement(instance),\n    update,\n    unmount,\n    container: instance,\n    rerender: update, // alias for `update`\n    toJSON: renderer.toJSON,\n    debug: debug(instance, renderer),\n  };\n\n  setRenderResult(result);\n  return result;\n}\n\nfunction renderWithAct(\n  component: React.ReactElement,\n  options?: TestRendererOptions\n): ReactTestRenderer {\n  let renderer: ReactTestRenderer;\n\n  act(() => {\n    renderer = TestRenderer.create(component, options);\n  });\n\n  // @ts-ignore act is sync, so renderer is always initialised here\n  return renderer;\n}\n\nfunction updateWithAct(\n  renderer: ReactTestRenderer,\n  wrap: (innerElement: React.ReactElement) => React.ReactElement\n) {\n  return function (component: React.ReactElement) {\n    act(() => {\n      renderer.update(wrap(component));\n    });\n  };\n}\n\ninterface DebugFunction {\n  (message?: string): void;\n  shallow: (message?: string) => void;\n}\n\nfunction debug(\n  instance: ReactTestInstance,\n  renderer: ReactTestRenderer\n): DebugFunction {\n  function debugImpl(message?: string) {\n    const json = renderer.toJSON();\n    if (json) {\n      return debugDeep(json, message);\n    }\n  }\n  debugImpl.shallow = (message?: string) => debugShallow(instance, message);\n  return debugImpl;\n}\n"],"mappings":";;;;;;;AAAA;;AAEA;;AACA;;AACA;;AACA;;AACA;;AACA;;AACA;;;;;;;;AAaA;AACA;AACA;AACA;AACe,SAASA,MAAT,CACbC,SADa,EAEb;EAAEC,OAAO,EAAEC,OAAX;EAAoBC;AAApB,IAAsD,EAFzC,EAGb;EACA,MAAMC,IAAI,GAAIC,YAAD,IACXH,OAAO,gBAAG,oBAAC,OAAD,QAAUG,YAAV,CAAH,GAAuCA,YADhD;;EAGA,MAAMC,QAAQ,GAAGC,aAAa,CAC5BH,IAAI,CAACJ,SAAD,CADwB,EAE5BG,cAAc,GAAG;IAAEA;EAAF,CAAH,GAAwBK,SAFV,CAA9B;EAIA,MAAMC,MAAM,GAAGC,aAAa,CAACJ,QAAD,EAAWF,IAAX,CAA5B;EACA,MAAMO,QAAQ,GAAGL,QAAQ,CAACM,IAA1B;;EACA,MAAMC,OAAO,GAAG,MAAM;IACpB,IAAAC,YAAA,EAAI,MAAM;MACRR,QAAQ,CAACO,OAAT;IACD,CAFD;EAGD,CAJD;;EAMA,IAAAE,0BAAA,EAAkBF,OAAlB;EAEA,MAAMG,MAAM,GAAG,EACb,GAAG,IAAAC,4BAAA,EAAqBN,QAArB,CADU;IAEbF,MAFa;IAGbI,OAHa;IAIbK,SAAS,EAAEP,QAJE;IAKbQ,QAAQ,EAAEV,MALG;IAKK;IAClBW,MAAM,EAAEd,QAAQ,CAACc,MANJ;IAObC,KAAK,EAAEA,KAAK,CAACV,QAAD,EAAWL,QAAX;EAPC,CAAf;EAUA,IAAAgB,uBAAA,EAAgBN,MAAhB;EACA,OAAOA,MAAP;AACD;;AAED,SAAST,aAAT,CACEP,SADF,EAEEuB,OAFF,EAGqB;EACnB,IAAIjB,QAAJ;EAEA,IAAAQ,YAAA,EAAI,MAAM;IACRR,QAAQ,GAAGkB,0BAAA,CAAaC,MAAb,CAAoBzB,SAApB,EAA+BuB,OAA/B,CAAX;EACD,CAFD,EAHmB,CAOnB;;EACA,OAAOjB,QAAP;AACD;;AAED,SAASI,aAAT,CACEJ,QADF,EAEEF,IAFF,EAGE;EACA,OAAO,UAAUJ,SAAV,EAAyC;IAC9C,IAAAc,YAAA,EAAI,MAAM;MACRR,QAAQ,CAACG,MAAT,CAAgBL,IAAI,CAACJ,SAAD,CAApB;IACD,CAFD;EAGD,CAJD;AAKD;;AAOD,SAASqB,KAAT,CACEV,QADF,EAEEL,QAFF,EAGiB;EACf,SAASoB,SAAT,CAAmBC,OAAnB,EAAqC;IACnC,MAAMC,IAAI,GAAGtB,QAAQ,CAACc,MAAT,EAAb;;IACA,IAAIQ,IAAJ,EAAU;MACR,OAAO,IAAAC,kBAAA,EAAUD,IAAV,EAAgBD,OAAhB,CAAP;IACD;EACF;;EACDD,SAAS,CAACI,OAAV,GAAqBH,OAAD,IAAsB,IAAAI,qBAAA,EAAapB,QAAb,EAAuBgB,OAAvB,CAA1C;;EACA,OAAOD,SAAP;AACD"}
+{"version":3,"file":"render.js","names":["render","component","wrapper","Wrapper","createNodeMock","unstable_validateStringsRenderedWithinText","renderWithStringValidation","wrap","element","renderer","renderWithAct","undefined","buildRenderResult","handleRender","_","phase","validateStringsRenderedWithinText","screen","toJSON","update","updateWithAct","instance","root","unmount","act","addToCleanupQueue","result","getQueriesForElement","container","rerender","debug","setRenderResult","options","TestRenderer","create","debugImpl","message","json","debugDeep","shallow","debugShallow"],"sources":["../src/render.tsx"],"sourcesContent":["import TestRenderer from 'react-test-renderer';\nimport type { ReactTestInstance, ReactTestRenderer } from 'react-test-renderer';\nimport * as React from 'react';\nimport { Profiler } from 'react';\nimport act from './act';\nimport { addToCleanupQueue } from './cleanup';\nimport debugShallow from './helpers/debugShallow';\nimport debugDeep from './helpers/debugDeep';\nimport { getQueriesForElement } from './within';\nimport { setRenderResult, screen } from './screen';\nimport { validateStringsRenderedWithinText } from './helpers/stringValidation';\n\nexport type RenderOptions = {\n  wrapper?: React.ComponentType<any>;\n  createNodeMock?: (element: React.ReactElement) => any;\n  unstable_validateStringsRenderedWithinText?: boolean;\n};\n\ntype TestRendererOptions = {\n  createNodeMock: (element: React.ReactElement) => any;\n};\n\nexport type RenderResult = ReturnType<typeof render>;\n\n/**\n * Renders test component deeply using react-test-renderer and exposes helpers\n * to assert on the output.\n */\nexport default function render<T>(\n  component: React.ReactElement<T>,\n  {\n    wrapper: Wrapper,\n    createNodeMock,\n    unstable_validateStringsRenderedWithinText,\n  }: RenderOptions = {}\n) {\n  if (unstable_validateStringsRenderedWithinText) {\n    return renderWithStringValidation(component, {\n      wrapper: Wrapper,\n      createNodeMock,\n    });\n  }\n\n  const wrap = (element: React.ReactElement) =>\n    Wrapper ? <Wrapper>{element}</Wrapper> : element;\n\n  const renderer = renderWithAct(\n    wrap(component),\n    createNodeMock ? { createNodeMock } : undefined\n  );\n\n  return buildRenderResult(renderer, wrap);\n}\n\nfunction renderWithStringValidation<T>(\n  component: React.ReactElement<T>,\n  {\n    wrapper: Wrapper,\n    createNodeMock,\n  }: Omit<RenderOptions, 'unstable_validateStringsRenderedWithinText'> = {}\n) {\n  const handleRender: React.ProfilerProps['onRender'] = (_, phase) => {\n    if (phase === 'update') {\n      validateStringsRenderedWithinText(screen.toJSON());\n    }\n  };\n\n  const wrap = (element: React.ReactElement) => (\n    <Profiler id=\"renderProfiler\" onRender={handleRender}>\n      {Wrapper ? <Wrapper>{element}</Wrapper> : element}\n    </Profiler>\n  );\n\n  const renderer = renderWithAct(\n    wrap(component),\n    createNodeMock ? { createNodeMock } : undefined\n  );\n  validateStringsRenderedWithinText(renderer.toJSON());\n\n  return buildRenderResult(renderer, wrap);\n}\n\nfunction buildRenderResult(\n  renderer: ReactTestRenderer,\n  wrap: (element: React.ReactElement) => JSX.Element\n) {\n  const update = updateWithAct(renderer, wrap);\n  const instance = renderer.root;\n\n  const unmount = () => {\n    act(() => {\n      renderer.unmount();\n    });\n  };\n\n  addToCleanupQueue(unmount);\n\n  const result = {\n    ...getQueriesForElement(instance),\n    update,\n    unmount,\n    container: instance,\n    rerender: update, // alias for `update`\n    toJSON: renderer.toJSON,\n    debug: debug(instance, renderer),\n  };\n\n  setRenderResult(result);\n  return result;\n}\n\nfunction renderWithAct(\n  component: React.ReactElement,\n  options?: TestRendererOptions\n): ReactTestRenderer {\n  let renderer: ReactTestRenderer;\n\n  act(() => {\n    renderer = TestRenderer.create(component, options);\n  });\n\n  // @ts-ignore act is sync, so renderer is always initialised here\n  return renderer;\n}\n\nfunction updateWithAct(\n  renderer: ReactTestRenderer,\n  wrap: (innerElement: React.ReactElement) => React.ReactElement\n) {\n  return function (component: React.ReactElement) {\n    act(() => {\n      renderer.update(wrap(component));\n    });\n  };\n}\n\ninterface DebugFunction {\n  (message?: string): void;\n  shallow: (message?: string) => void;\n}\n\nfunction debug(\n  instance: ReactTestInstance,\n  renderer: ReactTestRenderer\n): DebugFunction {\n  function debugImpl(message?: string) {\n    const json = renderer.toJSON();\n    if (json) {\n      return debugDeep(json, message);\n    }\n  }\n  debugImpl.shallow = (message?: string) => debugShallow(instance, message);\n  return debugImpl;\n}\n"],"mappings":";;;;;;;AAAA;;AAEA;;AAEA;;AACA;;AACA;;AACA;;AACA;;AACA;;AACA;;;;;;;;AAcA;AACA;AACA;AACA;AACe,SAASA,MAAT,CACbC,SADa,EAEb;EACEC,OAAO,EAAEC,OADX;EAEEC,cAFF;EAGEC;AAHF,IAImB,EANN,EAOb;EACA,IAAIA,0CAAJ,EAAgD;IAC9C,OAAOC,0BAA0B,CAACL,SAAD,EAAY;MAC3CC,OAAO,EAAEC,OADkC;MAE3CC;IAF2C,CAAZ,CAAjC;EAID;;EAED,MAAMG,IAAI,GAAIC,OAAD,IACXL,OAAO,gBAAG,oBAAC,OAAD,QAAUK,OAAV,CAAH,GAAkCA,OAD3C;;EAGA,MAAMC,QAAQ,GAAGC,aAAa,CAC5BH,IAAI,CAACN,SAAD,CADwB,EAE5BG,cAAc,GAAG;IAAEA;EAAF,CAAH,GAAwBO,SAFV,CAA9B;EAKA,OAAOC,iBAAiB,CAACH,QAAD,EAAWF,IAAX,CAAxB;AACD;;AAED,SAASD,0BAAT,CACEL,SADF,EAEE;EACEC,OAAO,EAAEC,OADX;EAEEC;AAFF,IAGuE,EALzE,EAME;EACA,MAAMS,YAA6C,GAAG,CAACC,CAAD,EAAIC,KAAJ,KAAc;IAClE,IAAIA,KAAK,KAAK,QAAd,EAAwB;MACtB,IAAAC,mDAAA,EAAkCC,cAAA,CAAOC,MAAP,EAAlC;IACD;EACF,CAJD;;EAMA,MAAMX,IAAI,GAAIC,OAAD,iBACX,oBAAC,cAAD;IAAU,EAAE,EAAC,gBAAb;IAA8B,QAAQ,EAAEK;EAAxC,GACGV,OAAO,gBAAG,oBAAC,OAAD,QAAUK,OAAV,CAAH,GAAkCA,OAD5C,CADF;;EAMA,MAAMC,QAAQ,GAAGC,aAAa,CAC5BH,IAAI,CAACN,SAAD,CADwB,EAE5BG,cAAc,GAAG;IAAEA;EAAF,CAAH,GAAwBO,SAFV,CAA9B;EAIA,IAAAK,mDAAA,EAAkCP,QAAQ,CAACS,MAAT,EAAlC;EAEA,OAAON,iBAAiB,CAACH,QAAD,EAAWF,IAAX,CAAxB;AACD;;AAED,SAASK,iBAAT,CACEH,QADF,EAEEF,IAFF,EAGE;EACA,MAAMY,MAAM,GAAGC,aAAa,CAACX,QAAD,EAAWF,IAAX,CAA5B;EACA,MAAMc,QAAQ,GAAGZ,QAAQ,CAACa,IAA1B;;EAEA,MAAMC,OAAO,GAAG,MAAM;IACpB,IAAAC,YAAA,EAAI,MAAM;MACRf,QAAQ,CAACc,OAAT;IACD,CAFD;EAGD,CAJD;;EAMA,IAAAE,0BAAA,EAAkBF,OAAlB;EAEA,MAAMG,MAAM,GAAG,EACb,GAAG,IAAAC,4BAAA,EAAqBN,QAArB,CADU;IAEbF,MAFa;IAGbI,OAHa;IAIbK,SAAS,EAAEP,QAJE;IAKbQ,QAAQ,EAAEV,MALG;IAKK;IAClBD,MAAM,EAAET,QAAQ,CAACS,MANJ;IAObY,KAAK,EAAEA,KAAK,CAACT,QAAD,EAAWZ,QAAX;EAPC,CAAf;EAUA,IAAAsB,uBAAA,EAAgBL,MAAhB;EACA,OAAOA,MAAP;AACD;;AAED,SAAShB,aAAT,CACET,SADF,EAEE+B,OAFF,EAGqB;EACnB,IAAIvB,QAAJ;EAEA,IAAAe,YAAA,EAAI,MAAM;IACRf,QAAQ,GAAGwB,0BAAA,CAAaC,MAAb,CAAoBjC,SAApB,EAA+B+B,OAA/B,CAAX;EACD,CAFD,EAHmB,CAOnB;;EACA,OAAOvB,QAAP;AACD;;AAED,SAASW,aAAT,CACEX,QADF,EAEEF,IAFF,EAGE;EACA,OAAO,UAAUN,SAAV,EAAyC;IAC9C,IAAAuB,YAAA,EAAI,MAAM;MACRf,QAAQ,CAACU,MAAT,CAAgBZ,IAAI,CAACN,SAAD,CAApB;IACD,CAFD;EAGD,CAJD;AAKD;;AAOD,SAAS6B,KAAT,CACET,QADF,EAEEZ,QAFF,EAGiB;EACf,SAAS0B,SAAT,CAAmBC,OAAnB,EAAqC;IACnC,MAAMC,IAAI,GAAG5B,QAAQ,CAACS,MAAT,EAAb;;IACA,IAAImB,IAAJ,EAAU;MACR,OAAO,IAAAC,kBAAA,EAAUD,IAAV,EAAgBD,OAAhB,CAAP;IACD;EACF;;EACDD,SAAS,CAACI,OAAV,GAAqBH,OAAD,IAAsB,IAAAI,qBAAA,EAAanB,QAAb,EAAuBe,OAAvB,CAA1C;;EACA,OAAOD,SAAP;AACD"}

package/build/waitFor.js

@@ -5,32 +5,25 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = waitFor;
 
-var React = _interopRequireWildcard(require("react"));
+var _act = _interopRequireWildcard(require("./act"));
 
-var _act = _interopRequireDefault(require("./act"));
+var _config = require("./config");
 
 var _errors = require("./helpers/errors");
 
 var _timers = require("./helpers/timers");
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+var _reactVersions = require("./react-versions");
 
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
 /* globals jest */
-const DEFAULT_TIMEOUT = 1000;
 const DEFAULT_INTERVAL = 50;
 
-function checkReactVersionAtLeast(major, minor) {
-  if (React.version === undefined) return false;
-  const [actualMajor, actualMinor] = React.version.split('.').map(Number);
-  return actualMajor > major || actualMajor === major && actualMinor >= minor;
-}
-
 function waitForInternal(expectation, {
-  timeout = DEFAULT_TIMEOUT,
+  timeout = (0, _config.getConfig)().asyncUtilTimeout,
   interval = DEFAULT_INTERVAL,
   stackTraceError,
   onTimeout
@@ -200,7 +193,18 @@ async function waitFor(expectation, options) {
     ...options
   };
 
-  if (!checkReactVersionAtLeast(16, 9)) {
+  if ((0, _reactVersions.checkReactVersionAtLeast)(18, 0)) {
+    const previousActEnvironment = (0, _act.getIsReactActEnvironment)();
+    (0, _act.setReactActEnvironment)(false);
+
+    try {
+      return await waitForInternal(expectation, optionsWithStackTrace);
+    } finally {
+      (0, _act.setReactActEnvironment)(previousActEnvironment);
+    }
+  }
+
+  if (!(0, _reactVersions.checkReactVersionAtLeast)(16, 9)) {
     return waitForInternal(expectation, optionsWithStackTrace);
   }
 

package/build/waitFor.js.map

@@ -1 +1 @@
-{"version":3,"file":"waitFor.js","names":["DEFAULT_TIMEOUT","DEFAULT_INTERVAL","checkReactVersionAtLeast","major","minor","React","version","undefined","actualMajor","actualMinor","split","map","Number","waitForInternal","expectation","timeout","interval","stackTraceError","onTimeout","TypeError","Promise","resolve","reject","lastError","intervalId","finished","promiseStatus","overallTimeoutTimer","setTimeout","handleTimeout","usingFakeTimers","jestFakeTimersAreEnabled","checkExpectation","fakeTimeRemaining","error","Error","copyStackTrace","jest","advanceTimersByTime","setImmediate","setInterval","checkRealTimersCallback","onDone","done","clearTimeout","clearInterval","type","result","then","promiseResult","resolvedValue","rejectedValue","waitFor","options","ErrorWithStack","optionsWithStackTrace","act"],"sources":["../src/waitFor.ts"],"sourcesContent":["/* globals jest */\nimport * as React from 'react';\nimport act from './act';\nimport { ErrorWithStack, copyStackTrace } from './helpers/errors';\nimport {\n  setTimeout,\n  clearTimeout,\n  setImmediate,\n  jestFakeTimersAreEnabled,\n} from './helpers/timers';\n\nconst DEFAULT_TIMEOUT = 1000;\nconst DEFAULT_INTERVAL = 50;\n\nfunction checkReactVersionAtLeast(major: number, minor: number): boolean {\n  if (React.version === undefined) return false;\n  const [actualMajor, actualMinor] = React.version.split('.').map(Number);\n\n  return actualMajor > major || (actualMajor === major && actualMinor >= minor);\n}\n\nexport type WaitForOptions = {\n  timeout?: number;\n  interval?: number;\n  stackTraceError?: ErrorWithStack;\n  onTimeout?: (error: unknown) => Error;\n};\n\nfunction waitForInternal<T>(\n  expectation: () => T,\n  {\n    timeout = DEFAULT_TIMEOUT,\n    interval = DEFAULT_INTERVAL,\n    stackTraceError,\n    onTimeout,\n  }: WaitForOptions\n): Promise<T> {\n  if (typeof expectation !== 'function') {\n    throw new TypeError('Received `expectation` arg must be a function');\n  }\n\n  // eslint-disable-next-line no-async-promise-executor\n  return new Promise(async (resolve, reject) => {\n    let lastError: unknown, intervalId: ReturnType<typeof setTimeout>;\n    let finished = false;\n    let promiseStatus = 'idle';\n\n    const overallTimeoutTimer = setTimeout(handleTimeout, timeout);\n\n    const usingFakeTimers = jestFakeTimersAreEnabled();\n\n    if (usingFakeTimers) {\n      checkExpectation();\n      // this is a dangerous rule to disable because it could lead to an\n      // infinite loop. However, eslint isn't smart enough to know that we're\n      // setting finished inside `onDone` which will be called when we're done\n      // waiting or when we've timed out.\n      // eslint-disable-next-line no-unmodified-loop-condition\n      let fakeTimeRemaining = timeout;\n      while (!finished) {\n        if (!jestFakeTimersAreEnabled()) {\n          const error = new Error(\n            `Changed from using fake timers to real timers while using waitFor. This is not allowed and will result in very strange behavior. Please ensure you're awaiting all async things your test is doing before changing to real timers. For more info, please go to https://github.com/testing-library/dom-testing-library/issues/830`\n          );\n          if (stackTraceError) {\n            copyStackTrace(error, stackTraceError);\n          }\n          reject(error);\n          return;\n        }\n\n        // when fake timers are used we want to simulate the interval time passing\n        if (fakeTimeRemaining <= 0) {\n          return;\n        } else {\n          fakeTimeRemaining -= interval;\n        }\n\n        // we *could* (maybe should?) use `advanceTimersToNextTimer` but it's\n        // possible that could make this loop go on forever if someone is using\n        // third party code that's setting up recursive timers so rapidly that\n        // the user's timer's don't get a chance to resolve. So we'll advance\n        // by an interval instead. (We have a test for this case).\n        jest.advanceTimersByTime(interval);\n\n        // It's really important that checkExpectation is run *before* we flush\n        // in-flight promises. To be honest, I'm not sure why, and I can't quite\n        // think of a way to reproduce the problem in a test, but I spent\n        // an entire day banging my head against a wall on this.\n        checkExpectation();\n\n        // In this rare case, we *need* to wait for in-flight promises\n        // to resolve before continuing. We don't need to take advantage\n        // of parallelization so we're fine.\n        // https://stackoverflow.com/a/59243586/971592\n        // eslint-disable-next-line no-await-in-loop\n        await new Promise((resolve) => setImmediate(resolve));\n      }\n    } else {\n      intervalId = setInterval(checkRealTimersCallback, interval);\n      checkExpectation();\n    }\n\n    function onDone(\n      done: { type: 'result'; result: T } | { type: 'error'; error: unknown }\n    ) {\n      finished = true;\n      clearTimeout(overallTimeoutTimer);\n\n      if (!usingFakeTimers) {\n        clearInterval(intervalId);\n      }\n\n      if (done.type === 'error') {\n        reject(done.error);\n      } else {\n        resolve(done.result);\n      }\n    }\n\n    function checkRealTimersCallback() {\n      if (jestFakeTimersAreEnabled()) {\n        const error = new Error(\n          `Changed from using real timers to fake timers while using waitFor. This is not allowed and will result in very strange behavior. Please ensure you're awaiting all async things your test is doing before changing to fake timers. For more info, please go to https://github.com/testing-library/dom-testing-library/issues/830`\n        );\n        if (stackTraceError) {\n          copyStackTrace(error, stackTraceError);\n        }\n        return reject(error);\n      } else {\n        return checkExpectation();\n      }\n    }\n\n    function checkExpectation() {\n      if (promiseStatus === 'pending') return;\n      try {\n        const result = expectation();\n\n        // @ts-ignore result can be a promise\n        // eslint-disable-next-line promise/prefer-await-to-then\n        if (typeof result?.then === 'function') {\n          const promiseResult: Promise<T> = result as any;\n          promiseStatus = 'pending';\n          // eslint-disable-next-line promise/catch-or-return, promise/prefer-await-to-then\n          promiseResult.then(\n            (resolvedValue) => {\n              promiseStatus = 'resolved';\n              onDone({ type: 'result', result: resolvedValue });\n              return;\n            },\n            (rejectedValue) => {\n              promiseStatus = 'rejected';\n              lastError = rejectedValue;\n              return;\n            }\n          );\n        } else {\n          onDone({ type: 'result', result: result });\n        }\n        // If `callback` throws, wait for the next mutation, interval, or timeout.\n      } catch (error) {\n        // Save the most recent callback error to reject the promise with it in the event of a timeout\n        lastError = error;\n      }\n    }\n\n    function handleTimeout() {\n      let error;\n      if (lastError) {\n        error = lastError;\n        if (stackTraceError) {\n          copyStackTrace(error, stackTraceError);\n        }\n      } else {\n        error = new Error('Timed out in waitFor.');\n        if (stackTraceError) {\n          copyStackTrace(error, stackTraceError);\n        }\n      }\n      if (typeof onTimeout === 'function') {\n        onTimeout(error);\n      }\n      onDone({ type: 'error', error });\n    }\n  });\n}\n\nexport default async function waitFor<T>(\n  expectation: () => T,\n  options?: WaitForOptions\n): Promise<T> {\n  // Being able to display a useful stack trace requires generating it before doing anything async\n  const stackTraceError = new ErrorWithStack('STACK_TRACE_ERROR', waitFor);\n  const optionsWithStackTrace = { stackTraceError, ...options };\n\n  if (!checkReactVersionAtLeast(16, 9)) {\n    return waitForInternal(expectation, optionsWithStackTrace);\n  }\n\n  let result: T;\n\n  await act(async () => {\n    result = await waitForInternal(expectation, optionsWithStackTrace);\n  });\n\n  // Either we have result or `waitFor` threw error\n  return result!;\n}\n"],"mappings":";;;;;;;AACA;;AACA;;AACA;;AACA;;;;;;;;AAJA;AAWA,MAAMA,eAAe,GAAG,IAAxB;AACA,MAAMC,gBAAgB,GAAG,EAAzB;;AAEA,SAASC,wBAAT,CAAkCC,KAAlC,EAAiDC,KAAjD,EAAyE;EACvE,IAAIC,KAAK,CAACC,OAAN,KAAkBC,SAAtB,EAAiC,OAAO,KAAP;EACjC,MAAM,CAACC,WAAD,EAAcC,WAAd,IAA6BJ,KAAK,CAACC,OAAN,CAAcI,KAAd,CAAoB,GAApB,EAAyBC,GAAzB,CAA6BC,MAA7B,CAAnC;EAEA,OAAOJ,WAAW,GAAGL,KAAd,IAAwBK,WAAW,KAAKL,KAAhB,IAAyBM,WAAW,IAAIL,KAAvE;AACD;;AASD,SAASS,eAAT,CACEC,WADF,EAEE;EACEC,OAAO,GAAGf,eADZ;EAEEgB,QAAQ,GAAGf,gBAFb;EAGEgB,eAHF;EAIEC;AAJF,CAFF,EAQc;EACZ,IAAI,OAAOJ,WAAP,KAAuB,UAA3B,EAAuC;IACrC,MAAM,IAAIK,SAAJ,CAAc,+CAAd,CAAN;EACD,CAHW,CAKZ;;;EACA,OAAO,IAAIC,OAAJ,CAAY,OAAOC,OAAP,EAAgBC,MAAhB,KAA2B;IAC5C,IAAIC,SAAJ,EAAwBC,UAAxB;IACA,IAAIC,QAAQ,GAAG,KAAf;IACA,IAAIC,aAAa,GAAG,MAApB;IAEA,MAAMC,mBAAmB,GAAG,IAAAC,kBAAA,EAAWC,aAAX,EAA0Bd,OAA1B,CAA5B;IAEA,MAAMe,eAAe,GAAG,IAAAC,gCAAA,GAAxB;;IAEA,IAAID,eAAJ,EAAqB;MACnBE,gBAAgB,GADG,CAEnB;MACA;MACA;MACA;MACA;;MACA,IAAIC,iBAAiB,GAAGlB,OAAxB;;MACA,OAAO,CAACU,QAAR,EAAkB;QAChB,IAAI,CAAC,IAAAM,gCAAA,GAAL,EAAiC;UAC/B,MAAMG,KAAK,GAAG,IAAIC,KAAJ,CACX,kUADW,CAAd;;UAGA,IAAIlB,eAAJ,EAAqB;YACnB,IAAAmB,sBAAA,EAAeF,KAAf,EAAsBjB,eAAtB;UACD;;UACDK,MAAM,CAACY,KAAD,CAAN;UACA;QACD,CAVe,CAYhB;;;QACA,IAAID,iBAAiB,IAAI,CAAzB,EAA4B;UAC1B;QACD,CAFD,MAEO;UACLA,iBAAiB,IAAIjB,QAArB;QACD,CAjBe,CAmBhB;QACA;QACA;QACA;QACA;;;QACAqB,IAAI,CAACC,mBAAL,CAAyBtB,QAAzB,EAxBgB,CA0BhB;QACA;QACA;QACA;;QACAgB,gBAAgB,GA9BA,CAgChB;QACA;QACA;QACA;QACA;;QACA,MAAM,IAAIZ,OAAJ,CAAaC,OAAD,IAAa,IAAAkB,oBAAA,EAAalB,OAAb,CAAzB,CAAN;MACD;IACF,CA/CD,MA+CO;MACLG,UAAU,GAAGgB,WAAW,CAACC,uBAAD,EAA0BzB,QAA1B,CAAxB;MACAgB,gBAAgB;IACjB;;IAED,SAASU,MAAT,CACEC,IADF,EAEE;MACAlB,QAAQ,GAAG,IAAX;MACA,IAAAmB,oBAAA,EAAajB,mBAAb;;MAEA,IAAI,CAACG,eAAL,EAAsB;QACpBe,aAAa,CAACrB,UAAD,CAAb;MACD;;MAED,IAAImB,IAAI,CAACG,IAAL,KAAc,OAAlB,EAA2B;QACzBxB,MAAM,CAACqB,IAAI,CAACT,KAAN,CAAN;MACD,CAFD,MAEO;QACLb,OAAO,CAACsB,IAAI,CAACI,MAAN,CAAP;MACD;IACF;;IAED,SAASN,uBAAT,GAAmC;MACjC,IAAI,IAAAV,gCAAA,GAAJ,EAAgC;QAC9B,MAAMG,KAAK,GAAG,IAAIC,KAAJ,CACX,kUADW,CAAd;;QAGA,IAAIlB,eAAJ,EAAqB;UACnB,IAAAmB,sBAAA,EAAeF,KAAf,EAAsBjB,eAAtB;QACD;;QACD,OAAOK,MAAM,CAACY,KAAD,CAAb;MACD,CARD,MAQO;QACL,OAAOF,gBAAgB,EAAvB;MACD;IACF;;IAED,SAASA,gBAAT,GAA4B;MAC1B,IAAIN,aAAa,KAAK,SAAtB,EAAiC;;MACjC,IAAI;QACF,MAAMqB,MAAM,GAAGjC,WAAW,EAA1B,CADE,CAGF;QACA;;QACA,IAAI,OAAOiC,MAAM,EAAEC,IAAf,KAAwB,UAA5B,EAAwC;UACtC,MAAMC,aAAyB,GAAGF,MAAlC;UACArB,aAAa,GAAG,SAAhB,CAFsC,CAGtC;;UACAuB,aAAa,CAACD,IAAd,CACGE,aAAD,IAAmB;YACjBxB,aAAa,GAAG,UAAhB;YACAgB,MAAM,CAAC;cAAEI,IAAI,EAAE,QAAR;cAAkBC,MAAM,EAAEG;YAA1B,CAAD,CAAN;YACA;UACD,CALH,EAMGC,aAAD,IAAmB;YACjBzB,aAAa,GAAG,UAAhB;YACAH,SAAS,GAAG4B,aAAZ;YACA;UACD,CAVH;QAYD,CAhBD,MAgBO;UACLT,MAAM,CAAC;YAAEI,IAAI,EAAE,QAAR;YAAkBC,MAAM,EAAEA;UAA1B,CAAD,CAAN;QACD,CAvBC,CAwBF;;MACD,CAzBD,CAyBE,OAAOb,KAAP,EAAc;QACd;QACAX,SAAS,GAAGW,KAAZ;MACD;IACF;;IAED,SAASL,aAAT,GAAyB;MACvB,IAAIK,KAAJ;;MACA,IAAIX,SAAJ,EAAe;QACbW,KAAK,GAAGX,SAAR;;QACA,IAAIN,eAAJ,EAAqB;UACnB,IAAAmB,sBAAA,EAAeF,KAAf,EAAsBjB,eAAtB;QACD;MACF,CALD,MAKO;QACLiB,KAAK,GAAG,IAAIC,KAAJ,CAAU,uBAAV,CAAR;;QACA,IAAIlB,eAAJ,EAAqB;UACnB,IAAAmB,sBAAA,EAAeF,KAAf,EAAsBjB,eAAtB;QACD;MACF;;MACD,IAAI,OAAOC,SAAP,KAAqB,UAAzB,EAAqC;QACnCA,SAAS,CAACgB,KAAD,CAAT;MACD;;MACDQ,MAAM,CAAC;QAAEI,IAAI,EAAE,OAAR;QAAiBZ;MAAjB,CAAD,CAAN;IACD;EACF,CA/IM,CAAP;AAgJD;;AAEc,eAAekB,OAAf,CACbtC,WADa,EAEbuC,OAFa,EAGD;EACZ;EACA,MAAMpC,eAAe,GAAG,IAAIqC,sBAAJ,CAAmB,mBAAnB,EAAwCF,OAAxC,CAAxB;EACA,MAAMG,qBAAqB,GAAG;IAAEtC,eAAF;IAAmB,GAAGoC;EAAtB,CAA9B;;EAEA,IAAI,CAACnD,wBAAwB,CAAC,EAAD,EAAK,CAAL,CAA7B,EAAsC;IACpC,OAAOW,eAAe,CAACC,WAAD,EAAcyC,qBAAd,CAAtB;EACD;;EAED,IAAIR,MAAJ;EAEA,MAAM,IAAAS,YAAA,EAAI,YAAY;IACpBT,MAAM,GAAG,MAAMlC,eAAe,CAACC,WAAD,EAAcyC,qBAAd,CAA9B;EACD,CAFK,CAAN,CAXY,CAeZ;;EACA,OAAOR,MAAP;AACD"}
+{"version":3,"file":"waitFor.js","names":["DEFAULT_INTERVAL","waitForInternal","expectation","timeout","getConfig","asyncUtilTimeout","interval","stackTraceError","onTimeout","TypeError","Promise","resolve","reject","lastError","intervalId","finished","promiseStatus","overallTimeoutTimer","setTimeout","handleTimeout","usingFakeTimers","jestFakeTimersAreEnabled","checkExpectation","fakeTimeRemaining","error","Error","copyStackTrace","jest","advanceTimersByTime","setImmediate","setInterval","checkRealTimersCallback","onDone","done","clearTimeout","clearInterval","type","result","then","promiseResult","resolvedValue","rejectedValue","waitFor","options","ErrorWithStack","optionsWithStackTrace","checkReactVersionAtLeast","previousActEnvironment","getIsReactActEnvironment","setReactActEnvironment","act"],"sources":["../src/waitFor.ts"],"sourcesContent":["/* globals jest */\nimport act, { setReactActEnvironment, getIsReactActEnvironment } from './act';\nimport { getConfig } from './config';\nimport { ErrorWithStack, copyStackTrace } from './helpers/errors';\nimport {\n  setTimeout,\n  clearTimeout,\n  setImmediate,\n  jestFakeTimersAreEnabled,\n} from './helpers/timers';\nimport { checkReactVersionAtLeast } from './react-versions';\n\nconst DEFAULT_INTERVAL = 50;\n\nexport type WaitForOptions = {\n  timeout?: number;\n  interval?: number;\n  stackTraceError?: ErrorWithStack;\n  onTimeout?: (error: unknown) => Error;\n};\n\nfunction waitForInternal<T>(\n  expectation: () => T,\n  {\n    timeout = getConfig().asyncUtilTimeout,\n    interval = DEFAULT_INTERVAL,\n    stackTraceError,\n    onTimeout,\n  }: WaitForOptions\n): Promise<T> {\n  if (typeof expectation !== 'function') {\n    throw new TypeError('Received `expectation` arg must be a function');\n  }\n\n  // eslint-disable-next-line no-async-promise-executor\n  return new Promise(async (resolve, reject) => {\n    let lastError: unknown, intervalId: ReturnType<typeof setTimeout>;\n    let finished = false;\n    let promiseStatus = 'idle';\n\n    const overallTimeoutTimer = setTimeout(handleTimeout, timeout);\n\n    const usingFakeTimers = jestFakeTimersAreEnabled();\n\n    if (usingFakeTimers) {\n      checkExpectation();\n      // this is a dangerous rule to disable because it could lead to an\n      // infinite loop. However, eslint isn't smart enough to know that we're\n      // setting finished inside `onDone` which will be called when we're done\n      // waiting or when we've timed out.\n      // eslint-disable-next-line no-unmodified-loop-condition\n      let fakeTimeRemaining = timeout;\n      while (!finished) {\n        if (!jestFakeTimersAreEnabled()) {\n          const error = new Error(\n            `Changed from using fake timers to real timers while using waitFor. This is not allowed and will result in very strange behavior. Please ensure you're awaiting all async things your test is doing before changing to real timers. For more info, please go to https://github.com/testing-library/dom-testing-library/issues/830`\n          );\n          if (stackTraceError) {\n            copyStackTrace(error, stackTraceError);\n          }\n          reject(error);\n          return;\n        }\n\n        // when fake timers are used we want to simulate the interval time passing\n        if (fakeTimeRemaining <= 0) {\n          return;\n        } else {\n          fakeTimeRemaining -= interval;\n        }\n\n        // we *could* (maybe should?) use `advanceTimersToNextTimer` but it's\n        // possible that could make this loop go on forever if someone is using\n        // third party code that's setting up recursive timers so rapidly that\n        // the user's timer's don't get a chance to resolve. So we'll advance\n        // by an interval instead. (We have a test for this case).\n        jest.advanceTimersByTime(interval);\n\n        // It's really important that checkExpectation is run *before* we flush\n        // in-flight promises. To be honest, I'm not sure why, and I can't quite\n        // think of a way to reproduce the problem in a test, but I spent\n        // an entire day banging my head against a wall on this.\n        checkExpectation();\n\n        // In this rare case, we *need* to wait for in-flight promises\n        // to resolve before continuing. We don't need to take advantage\n        // of parallelization so we're fine.\n        // https://stackoverflow.com/a/59243586/971592\n        // eslint-disable-next-line no-await-in-loop\n        await new Promise((resolve) => setImmediate(resolve));\n      }\n    } else {\n      intervalId = setInterval(checkRealTimersCallback, interval);\n      checkExpectation();\n    }\n\n    function onDone(\n      done: { type: 'result'; result: T } | { type: 'error'; error: unknown }\n    ) {\n      finished = true;\n      clearTimeout(overallTimeoutTimer);\n\n      if (!usingFakeTimers) {\n        clearInterval(intervalId);\n      }\n\n      if (done.type === 'error') {\n        reject(done.error);\n      } else {\n        resolve(done.result);\n      }\n    }\n\n    function checkRealTimersCallback() {\n      if (jestFakeTimersAreEnabled()) {\n        const error = new Error(\n          `Changed from using real timers to fake timers while using waitFor. This is not allowed and will result in very strange behavior. Please ensure you're awaiting all async things your test is doing before changing to fake timers. For more info, please go to https://github.com/testing-library/dom-testing-library/issues/830`\n        );\n        if (stackTraceError) {\n          copyStackTrace(error, stackTraceError);\n        }\n        return reject(error);\n      } else {\n        return checkExpectation();\n      }\n    }\n\n    function checkExpectation() {\n      if (promiseStatus === 'pending') return;\n      try {\n        const result = expectation();\n\n        // @ts-ignore result can be a promise\n        // eslint-disable-next-line promise/prefer-await-to-then\n        if (typeof result?.then === 'function') {\n          const promiseResult: Promise<T> = result as any;\n          promiseStatus = 'pending';\n          // eslint-disable-next-line promise/catch-or-return, promise/prefer-await-to-then\n          promiseResult.then(\n            (resolvedValue) => {\n              promiseStatus = 'resolved';\n              onDone({ type: 'result', result: resolvedValue });\n              return;\n            },\n            (rejectedValue) => {\n              promiseStatus = 'rejected';\n              lastError = rejectedValue;\n              return;\n            }\n          );\n        } else {\n          onDone({ type: 'result', result: result });\n        }\n        // If `callback` throws, wait for the next mutation, interval, or timeout.\n      } catch (error) {\n        // Save the most recent callback error to reject the promise with it in the event of a timeout\n        lastError = error;\n      }\n    }\n\n    function handleTimeout() {\n      let error;\n      if (lastError) {\n        error = lastError;\n        if (stackTraceError) {\n          copyStackTrace(error, stackTraceError);\n        }\n      } else {\n        error = new Error('Timed out in waitFor.');\n        if (stackTraceError) {\n          copyStackTrace(error, stackTraceError);\n        }\n      }\n      if (typeof onTimeout === 'function') {\n        onTimeout(error);\n      }\n      onDone({ type: 'error', error });\n    }\n  });\n}\n\nexport default async function waitFor<T>(\n  expectation: () => T,\n  options?: WaitForOptions\n): Promise<T> {\n  // Being able to display a useful stack trace requires generating it before doing anything async\n  const stackTraceError = new ErrorWithStack('STACK_TRACE_ERROR', waitFor);\n  const optionsWithStackTrace = { stackTraceError, ...options };\n\n  if (checkReactVersionAtLeast(18, 0)) {\n    const previousActEnvironment = getIsReactActEnvironment();\n    setReactActEnvironment(false);\n\n    try {\n      return await waitForInternal(expectation, optionsWithStackTrace);\n    } finally {\n      setReactActEnvironment(previousActEnvironment);\n    }\n  }\n\n  if (!checkReactVersionAtLeast(16, 9)) {\n    return waitForInternal(expectation, optionsWithStackTrace);\n  }\n\n  let result: T;\n\n  await act(async () => {\n    result = await waitForInternal(expectation, optionsWithStackTrace);\n  });\n\n  // Either we have result or `waitFor` threw error\n  return result!;\n}\n"],"mappings":";;;;;;;AACA;;AACA;;AACA;;AACA;;AAMA;;;;;;AAVA;AAYA,MAAMA,gBAAgB,GAAG,EAAzB;;AASA,SAASC,eAAT,CACEC,WADF,EAEE;EACEC,OAAO,GAAG,IAAAC,iBAAA,IAAYC,gBADxB;EAEEC,QAAQ,GAAGN,gBAFb;EAGEO,eAHF;EAIEC;AAJF,CAFF,EAQc;EACZ,IAAI,OAAON,WAAP,KAAuB,UAA3B,EAAuC;IACrC,MAAM,IAAIO,SAAJ,CAAc,+CAAd,CAAN;EACD,CAHW,CAKZ;;;EACA,OAAO,IAAIC,OAAJ,CAAY,OAAOC,OAAP,EAAgBC,MAAhB,KAA2B;IAC5C,IAAIC,SAAJ,EAAwBC,UAAxB;IACA,IAAIC,QAAQ,GAAG,KAAf;IACA,IAAIC,aAAa,GAAG,MAApB;IAEA,MAAMC,mBAAmB,GAAG,IAAAC,kBAAA,EAAWC,aAAX,EAA0BhB,OAA1B,CAA5B;IAEA,MAAMiB,eAAe,GAAG,IAAAC,gCAAA,GAAxB;;IAEA,IAAID,eAAJ,EAAqB;MACnBE,gBAAgB,GADG,CAEnB;MACA;MACA;MACA;MACA;;MACA,IAAIC,iBAAiB,GAAGpB,OAAxB;;MACA,OAAO,CAACY,QAAR,EAAkB;QAChB,IAAI,CAAC,IAAAM,gCAAA,GAAL,EAAiC;UAC/B,MAAMG,KAAK,GAAG,IAAIC,KAAJ,CACX,kUADW,CAAd;;UAGA,IAAIlB,eAAJ,EAAqB;YACnB,IAAAmB,sBAAA,EAAeF,KAAf,EAAsBjB,eAAtB;UACD;;UACDK,MAAM,CAACY,KAAD,CAAN;UACA;QACD,CAVe,CAYhB;;;QACA,IAAID,iBAAiB,IAAI,CAAzB,EAA4B;UAC1B;QACD,CAFD,MAEO;UACLA,iBAAiB,IAAIjB,QAArB;QACD,CAjBe,CAmBhB;QACA;QACA;QACA;QACA;;;QACAqB,IAAI,CAACC,mBAAL,CAAyBtB,QAAzB,EAxBgB,CA0BhB;QACA;QACA;QACA;;QACAgB,gBAAgB,GA9BA,CAgChB;QACA;QACA;QACA;QACA;;QACA,MAAM,IAAIZ,OAAJ,CAAaC,OAAD,IAAa,IAAAkB,oBAAA,EAAalB,OAAb,CAAzB,CAAN;MACD;IACF,CA/CD,MA+CO;MACLG,UAAU,GAAGgB,WAAW,CAACC,uBAAD,EAA0BzB,QAA1B,CAAxB;MACAgB,gBAAgB;IACjB;;IAED,SAASU,MAAT,CACEC,IADF,EAEE;MACAlB,QAAQ,GAAG,IAAX;MACA,IAAAmB,oBAAA,EAAajB,mBAAb;;MAEA,IAAI,CAACG,eAAL,EAAsB;QACpBe,aAAa,CAACrB,UAAD,CAAb;MACD;;MAED,IAAImB,IAAI,CAACG,IAAL,KAAc,OAAlB,EAA2B;QACzBxB,MAAM,CAACqB,IAAI,CAACT,KAAN,CAAN;MACD,CAFD,MAEO;QACLb,OAAO,CAACsB,IAAI,CAACI,MAAN,CAAP;MACD;IACF;;IAED,SAASN,uBAAT,GAAmC;MACjC,IAAI,IAAAV,gCAAA,GAAJ,EAAgC;QAC9B,MAAMG,KAAK,GAAG,IAAIC,KAAJ,CACX,kUADW,CAAd;;QAGA,IAAIlB,eAAJ,EAAqB;UACnB,IAAAmB,sBAAA,EAAeF,KAAf,EAAsBjB,eAAtB;QACD;;QACD,OAAOK,MAAM,CAACY,KAAD,CAAb;MACD,CARD,MAQO;QACL,OAAOF,gBAAgB,EAAvB;MACD;IACF;;IAED,SAASA,gBAAT,GAA4B;MAC1B,IAAIN,aAAa,KAAK,SAAtB,EAAiC;;MACjC,IAAI;QACF,MAAMqB,MAAM,GAAGnC,WAAW,EAA1B,CADE,CAGF;QACA;;QACA,IAAI,OAAOmC,MAAM,EAAEC,IAAf,KAAwB,UAA5B,EAAwC;UACtC,MAAMC,aAAyB,GAAGF,MAAlC;UACArB,aAAa,GAAG,SAAhB,CAFsC,CAGtC;;UACAuB,aAAa,CAACD,IAAd,CACGE,aAAD,IAAmB;YACjBxB,aAAa,GAAG,UAAhB;YACAgB,MAAM,CAAC;cAAEI,IAAI,EAAE,QAAR;cAAkBC,MAAM,EAAEG;YAA1B,CAAD,CAAN;YACA;UACD,CALH,EAMGC,aAAD,IAAmB;YACjBzB,aAAa,GAAG,UAAhB;YACAH,SAAS,GAAG4B,aAAZ;YACA;UACD,CAVH;QAYD,CAhBD,MAgBO;UACLT,MAAM,CAAC;YAAEI,IAAI,EAAE,QAAR;YAAkBC,MAAM,EAAEA;UAA1B,CAAD,CAAN;QACD,CAvBC,CAwBF;;MACD,CAzBD,CAyBE,OAAOb,KAAP,EAAc;QACd;QACAX,SAAS,GAAGW,KAAZ;MACD;IACF;;IAED,SAASL,aAAT,GAAyB;MACvB,IAAIK,KAAJ;;MACA,IAAIX,SAAJ,EAAe;QACbW,KAAK,GAAGX,SAAR;;QACA,IAAIN,eAAJ,EAAqB;UACnB,IAAAmB,sBAAA,EAAeF,KAAf,EAAsBjB,eAAtB;QACD;MACF,CALD,MAKO;QACLiB,KAAK,GAAG,IAAIC,KAAJ,CAAU,uBAAV,CAAR;;QACA,IAAIlB,eAAJ,EAAqB;UACnB,IAAAmB,sBAAA,EAAeF,KAAf,EAAsBjB,eAAtB;QACD;MACF;;MACD,IAAI,OAAOC,SAAP,KAAqB,UAAzB,EAAqC;QACnCA,SAAS,CAACgB,KAAD,CAAT;MACD;;MACDQ,MAAM,CAAC;QAAEI,IAAI,EAAE,OAAR;QAAiBZ;MAAjB,CAAD,CAAN;IACD;EACF,CA/IM,CAAP;AAgJD;;AAEc,eAAekB,OAAf,CACbxC,WADa,EAEbyC,OAFa,EAGD;EACZ;EACA,MAAMpC,eAAe,GAAG,IAAIqC,sBAAJ,CAAmB,mBAAnB,EAAwCF,OAAxC,CAAxB;EACA,MAAMG,qBAAqB,GAAG;IAAEtC,eAAF;IAAmB,GAAGoC;EAAtB,CAA9B;;EAEA,IAAI,IAAAG,uCAAA,EAAyB,EAAzB,EAA6B,CAA7B,CAAJ,EAAqC;IACnC,MAAMC,sBAAsB,GAAG,IAAAC,6BAAA,GAA/B;IACA,IAAAC,2BAAA,EAAuB,KAAvB;;IAEA,IAAI;MACF,OAAO,MAAMhD,eAAe,CAACC,WAAD,EAAc2C,qBAAd,CAA5B;IACD,CAFD,SAEU;MACR,IAAAI,2BAAA,EAAuBF,sBAAvB;IACD;EACF;;EAED,IAAI,CAAC,IAAAD,uCAAA,EAAyB,EAAzB,EAA6B,CAA7B,CAAL,EAAsC;IACpC,OAAO7C,eAAe,CAACC,WAAD,EAAc2C,qBAAd,CAAtB;EACD;;EAED,IAAIR,MAAJ;EAEA,MAAM,IAAAa,YAAA,EAAI,YAAY;IACpBb,MAAM,GAAG,MAAMpC,eAAe,CAACC,WAAD,EAAc2C,qBAAd,CAA9B;EACD,CAFK,CAAN,CAtBY,CA0BZ;;EACA,OAAOR,MAAP;AACD"}

package/build/within.d.ts

@@ -101,12 +101,24 @@ export declare function within(instance: ReactTestInstance): {
     queryAllByAccessibilityState: import("./queries/makeQueries").QueryAllByQuery<import("react-native").AccessibilityState, void>;
     findByAccessibilityState: import("./queries/makeQueries").FindByQuery<import("react-native").AccessibilityState, void>;
     findAllByAccessibilityState: import("./queries/makeQueries").FindAllByQuery<import("react-native").AccessibilityState, void>;
-    getByRole: import("./queries/makeQueries").GetByQuery<import("./matches").TextMatch, void>;
-    getAllByRole: import("./queries/makeQueries").GetAllByQuery<import("./matches").TextMatch, void>;
-    queryByRole: import("./queries/makeQueries").QueryByQuery<import("./matches").TextMatch, void>;
-    queryAllByRole: import("./queries/makeQueries").QueryAllByQuery<import("./matches").TextMatch, void>;
-    findByRole: import("./queries/makeQueries").FindByQuery<import("./matches").TextMatch, void>;
-    findAllByRole: import("./queries/makeQueries").FindAllByQuery<import("./matches").TextMatch, void>;
+    getByRole: import("./queries/makeQueries").GetByQuery<import("./matches").TextMatch, {
+        name?: import("./matches").TextMatch | undefined;
+    }>;
+    getAllByRole: import("./queries/makeQueries").GetAllByQuery<import("./matches").TextMatch, {
+        name?: import("./matches").TextMatch | undefined;
+    }>;
+    queryByRole: import("./queries/makeQueries").QueryByQuery<import("./matches").TextMatch, {
+        name?: import("./matches").TextMatch | undefined;
+    }>;
+    queryAllByRole: import("./queries/makeQueries").QueryAllByQuery<import("./matches").TextMatch, {
+        name?: import("./matches").TextMatch | undefined;
+    }>;
+    findByRole: import("./queries/makeQueries").FindByQuery<import("./matches").TextMatch, {
+        name?: import("./matches").TextMatch | undefined;
+    }>;
+    findAllByRole: import("./queries/makeQueries").FindAllByQuery<import("./matches").TextMatch, {
+        name?: import("./matches").TextMatch | undefined;
+    }>;
     getByHintText: import("./queries/makeQueries").GetByQuery<import("./matches").TextMatch, void>;
     getAllByHintText: import("./queries/makeQueries").GetAllByQuery<import("./matches").TextMatch, void>;
     queryByHintText: import("./queries/makeQueries").QueryByQuery<import("./matches").TextMatch, void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testing-library/react-native",
-  "version": "11.1.0",
+  "version": "11.3.0",
   "description": "Simple and complete React Native testing utilities that encourage good testing practices.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -26,16 +26,16 @@
     "dont-cleanup-after-each.js"
   ],
   "devDependencies": {
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.9.0",
-    "@babel/plugin-proposal-class-properties": "^7.8.3",
-    "@babel/plugin-transform-flow-strip-types": "^7.18.0",
-    "@babel/preset-env": "^7.9.6",
-    "@babel/preset-flow": "^7.9.0",
-    "@babel/preset-react": "^7.9.4",
-    "@babel/preset-typescript": "^7.16.0",
+    "@babel/cli": "^7.18.10",
+    "@babel/core": "^7.19.1",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-transform-flow-strip-types": "^7.19.0",
+    "@babel/preset-env": "^7.19.1",
+    "@babel/preset-flow": "^7.18.6",
+    "@babel/preset-react": "^7.18.6",
+    "@babel/preset-typescript": "^7.18.6",
     "@callstack/eslint-config": "^13.0.1",
-    "@testing-library/jest-native": "~4.0.2",
+    "@testing-library/jest-native": "^5.0.0",
     "@types/jest": "^29.0.2",
     "@types/react": "~18.0.18",
     "@types/react-native": "~0.70.0",
@@ -49,7 +49,7 @@
     "flow-copy-source": "^2.0.9",
     "jest": "^29.0.3",
     "react": "18.1.0",
-    "react-native": "0.70.0",
+    "react-native": "0.70.3",
     "react-test-renderer": "18.1.0",
     "strip-ansi": "^6.0.0",
     "typescript": "^4.0.2"
@@ -72,6 +72,7 @@
     "clean": "del build",
     "test": "jest",
     "test:ci": "jest --maxWorkers=2",
+    "test:ci:react:17": "scripts/test_react_17",
     "typecheck": "tsc",
     "flow": "flow",
     "copy-flowtypes": "cp typings/index.flow.js build",

package/typings/index.flow.js

@@ -202,6 +202,11 @@ interface UnsafeByPropsQueries {
     | Array<ReactTestInstance>
     | [];
 }
+
+interface ByRoleOptions {
+  name?: string;
+}
+
 interface A11yAPI {
   // Label
   getByLabelText: (matcher: TextMatch) => GetReturn;
@@ -244,16 +249,27 @@ interface A11yAPI {
   ) => FindAllReturn;
 
   // Role
-  getByRole: (matcher: A11yRole | RegExp) => GetReturn;
-  getAllByRole: (matcher: A11yRole | RegExp) => GetAllReturn;
-  queryByRole: (matcher: A11yRole | RegExp) => QueryReturn;
-  queryAllByRole: (matcher: A11yRole | RegExp) => QueryAllReturn;
+  getByRole: (matcher: A11yRole | RegExp, role?: ByRoleOptions) => GetReturn;
+  getAllByRole: (
+    matcher: A11yRole | RegExp,
+    role?: ByRoleOptions
+  ) => GetAllReturn;
+  queryByRole: (
+    matcher: A11yRole | RegExp,
+    role?: ByRoleOptions
+  ) => QueryReturn;
+  queryAllByRole: (
+    matcher: A11yRole | RegExp,
+    role?: ByRoleOptions
+  ) => QueryAllReturn;
   findByRole: (
     matcher: A11yRole | RegExp,
+    role?: ByRoleOptions,
     waitForOptions?: WaitForOptions
   ) => FindReturn;
   findAllByRole: (
     matcher: A11yRole | RegExp,
+    role?: ByRoleOptions,
     waitForOptions?: WaitForOptions
   ) => FindAllReturn;
 
@@ -330,6 +346,7 @@ declare module '@testing-library/react-native' {
   declare interface RenderOptions {
     wrapper?: React.ComponentType<any>;
     createNodeMock?: (element: React.Element<any>) => any;
+    unstable_validateStringsRenderedWithinText?: boolean;
   }
 
   declare export var render: (
@@ -351,6 +368,13 @@ declare module '@testing-library/react-native' {
 
   declare export var waitForElementToBeRemoved: WaitForElementToBeRemovedFunction;
 
+  declare interface Config {
+    asyncUtilTimeout: number;
+  }
+
+  declare export var configure: (options: $Shape<Config>) => void;
+  declare export var resetToDefaults: () => void;
+
   declare export var act: (callback: () => void) => Thenable;
   declare export var within: (instance: ReactTestInstance) => Queries;
   declare export var getQueriesForElement: (