@testing-library/react-native 9.1.0 → 9.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/README.md +2 -2
  2. package/build/act.d.ts +3 -0
  3. package/build/act.js +2 -1
  4. package/build/act.js.map +1 -0
  5. package/build/cleanup.d.ts +5 -0
  6. package/build/cleanup.js +3 -2
  7. package/build/cleanup.js.map +1 -0
  8. package/build/fireEvent.d.ts +8 -0
  9. package/build/fireEvent.js +2 -1
  10. package/build/fireEvent.js.map +1 -0
  11. package/build/flushMicroTasks.d.ts +5 -0
  12. package/build/flushMicroTasks.js +2 -12
  13. package/build/flushMicroTasks.js.map +1 -0
  14. package/build/helpers/a11yAPI.d.ts +66 -0
  15. package/build/helpers/a11yAPI.js +16 -15
  16. package/build/helpers/a11yAPI.js.map +1 -0
  17. package/build/helpers/byDisplayValue.d.ts +6 -0
  18. package/build/helpers/byDisplayValue.js +2 -1
  19. package/build/helpers/byDisplayValue.js.map +1 -0
  20. package/build/helpers/byPlaceholderText.d.ts +6 -0
  21. package/build/helpers/byPlaceholderText.js +2 -1
  22. package/build/helpers/byPlaceholderText.js.map +1 -0
  23. package/build/helpers/byTestId.d.ts +6 -0
  24. package/build/helpers/byTestId.js +2 -1
  25. package/build/helpers/byTestId.js.map +1 -0
  26. package/build/helpers/byText.d.ts +10 -0
  27. package/build/helpers/byText.js +4 -3
  28. package/build/helpers/byText.js.map +1 -0
  29. package/build/helpers/debugDeep.d.ts +5 -0
  30. package/build/helpers/debugDeep.js +4 -1
  31. package/build/helpers/debugDeep.js.map +1 -0
  32. package/build/helpers/debugShallow.d.ts +6 -0
  33. package/build/helpers/debugShallow.js +4 -7
  34. package/build/helpers/debugShallow.js.map +1 -0
  35. package/build/helpers/errors.d.ts +10 -0
  36. package/build/helpers/errors.js +29 -9
  37. package/build/helpers/errors.js.map +1 -0
  38. package/build/helpers/filterNodeByType.d.ts +3 -0
  39. package/build/helpers/filterNodeByType.js +2 -1
  40. package/build/helpers/filterNodeByType.js.map +1 -0
  41. package/build/helpers/findByAPI.d.ts +17 -0
  42. package/build/helpers/findByAPI.js +2 -1
  43. package/build/helpers/findByAPI.js.map +1 -0
  44. package/build/helpers/format.d.ts +3 -0
  45. package/build/helpers/format.js +4 -3
  46. package/build/helpers/format.js.map +1 -0
  47. package/build/helpers/getByAPI.d.ts +31 -0
  48. package/build/helpers/getByAPI.js +4 -19
  49. package/build/helpers/getByAPI.js.map +1 -0
  50. package/build/helpers/makeA11yQuery.d.ts +13 -0
  51. package/build/helpers/makeA11yQuery.js +2 -1
  52. package/build/helpers/makeA11yQuery.js.map +1 -0
  53. package/build/helpers/makeQueries.d.ts +20 -0
  54. package/build/helpers/makeQueries.js +6 -3
  55. package/build/helpers/makeQueries.js.map +1 -0
  56. package/build/helpers/queryByAPI.d.ts +39 -0
  57. package/build/helpers/queryByAPI.js +3 -8
  58. package/build/helpers/queryByAPI.js.map +1 -0
  59. package/build/helpers/timers.d.ts +6 -0
  60. package/build/helpers/timers.js +9 -6
  61. package/build/helpers/timers.js.map +1 -0
  62. package/build/index.d.ts +1 -0
  63. package/build/index.flow.js +384 -0
  64. package/build/index.js +2 -1
  65. package/build/index.js.map +1 -0
  66. package/build/matches.d.ts +9 -0
  67. package/build/matches.js +3 -2
  68. package/build/matches.js.map +1 -0
  69. package/build/{pure.js.flow → pure.d.ts} +4 -8
  70. package/build/pure.js +14 -31
  71. package/build/pure.js.map +1 -0
  72. package/build/render.d.ts +145 -0
  73. package/build/render.js +14 -10
  74. package/build/render.js.map +1 -0
  75. package/build/renderHook.d.ts +17 -0
  76. package/build/renderHook.js +57 -0
  77. package/build/renderHook.js.map +1 -0
  78. package/build/shallow.d.ts +8 -0
  79. package/build/shallow.js +3 -9
  80. package/build/shallow.js.map +1 -0
  81. package/build/waitFor.d.ts +8 -0
  82. package/build/waitFor.js +26 -22
  83. package/build/waitFor.js.map +1 -0
  84. package/build/waitForElementToBeRemoved.d.ts +2 -0
  85. package/build/waitForElementToBeRemoved.js +2 -1
  86. package/build/waitForElementToBeRemoved.js.map +1 -0
  87. package/build/within.d.ts +127 -0
  88. package/build/within.js +3 -2
  89. package/build/within.js.map +1 -0
  90. package/package.json +24 -14
  91. package/typings/index.flow.js +384 -0
  92. package/build/act.js.flow +0 -9
  93. package/build/cleanup.js.flow +0 -13
  94. package/build/fireEvent.js.flow +0 -127
  95. package/build/flushMicroTasks.js.flow +0 -23
  96. package/build/helpers/a11yAPI.js.flow +0 -241
  97. package/build/helpers/byDisplayValue.js.flow +0 -66
  98. package/build/helpers/byPlaceholderText.js.flow +0 -62
  99. package/build/helpers/byTestId.js.flow +0 -50
  100. package/build/helpers/byText.js.flow +0 -108
  101. package/build/helpers/debugDeep.js.flow +0 -16
  102. package/build/helpers/debugShallow.js.flow +0 -20
  103. package/build/helpers/errors.js.flow +0 -82
  104. package/build/helpers/filterNodeByType.js.flow +0 -1
  105. package/build/helpers/findByAPI.js.flow +0 -76
  106. package/build/helpers/format.js.flow +0 -10
  107. package/build/helpers/getByAPI.js.flow +0 -157
  108. package/build/helpers/makeA11yQuery.js.flow +0 -98
  109. package/build/helpers/makeQueries.js.flow +0 -165
  110. package/build/helpers/queryByAPI.js.flow +0 -166
  111. package/build/helpers/timers.js.flow +0 -88
  112. package/build/index.js.flow +0 -18
  113. package/build/matches.js.flow +0 -41
  114. package/build/render.js.flow +0 -109
  115. package/build/shallow.js.flow +0 -26
  116. package/build/types.flow.js +0 -1
  117. package/build/types.flow.js.flow +0 -59
  118. package/build/waitFor.js.flow +0 -226
  119. package/build/waitForElementToBeRemoved.js.flow +0 -42
  120. package/build/within.js.flow +0 -18
  121. package/typings/index.d.ts +0 -433
@@ -0,0 +1,145 @@
1
+ import TestRenderer from 'react-test-renderer';
2
+ import * as React from 'react';
3
+ declare type Options = {
4
+ wrapper?: React.ComponentType<any>;
5
+ createNodeMock?: (element: React.ReactElement) => any;
6
+ };
7
+ /**
8
+ * Renders test component deeply using react-test-renderer and exposes helpers
9
+ * to assert on the output.
10
+ */
11
+ export default function render<T>(component: React.ReactElement<T>, { wrapper: Wrapper, createNodeMock }?: Options): {
12
+ update: (component: React.ReactElement<any, string | React.JSXElementConstructor<any>>) => void;
13
+ unmount: () => void;
14
+ container: TestRenderer.ReactTestInstance;
15
+ rerender: (component: React.ReactElement<any, string | React.JSXElementConstructor<any>>) => void;
16
+ toJSON: () => TestRenderer.ReactTestRendererJSON | TestRenderer.ReactTestRendererJSON[] | null;
17
+ debug: DebugFunction;
18
+ getByLabelText: (label: import("./matches").TextMatch) => TestRenderer.ReactTestInstance;
19
+ getAllByLabelText: (label: import("./matches").TextMatch) => TestRenderer.ReactTestInstance[];
20
+ queryByLabelText: (label: import("./matches").TextMatch) => TestRenderer.ReactTestInstance | null;
21
+ queryAllByLabelText: (label: import("./matches").TextMatch) => TestRenderer.ReactTestInstance[];
22
+ findByLabelText: (label: import("./matches").TextMatch, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance>;
23
+ findAllByLabelText: (label: import("./matches").TextMatch, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance[]>;
24
+ getByA11yHint: (a11yHint: import("./matches").TextMatch) => TestRenderer.ReactTestInstance;
25
+ getByHintText: (a11yHint: import("./matches").TextMatch) => TestRenderer.ReactTestInstance;
26
+ getAllByA11yHint: (a11yHint: import("./matches").TextMatch) => TestRenderer.ReactTestInstance[];
27
+ getAllByHintText: (a11yHint: import("./matches").TextMatch) => TestRenderer.ReactTestInstance[];
28
+ queryByA11yHint: (a11yHint: import("./matches").TextMatch) => TestRenderer.ReactTestInstance | null;
29
+ queryByHintText: (a11yHint: import("./matches").TextMatch) => TestRenderer.ReactTestInstance | null;
30
+ queryAllByA11yHint: (a11yHint: import("./matches").TextMatch) => TestRenderer.ReactTestInstance[];
31
+ queryAllByHintText: (a11yHint: import("./matches").TextMatch) => TestRenderer.ReactTestInstance[];
32
+ findByA11yHint: (a11yHint: import("./matches").TextMatch, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance>;
33
+ findByHintText: (a11yHint: import("./matches").TextMatch, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance>;
34
+ findAllByA11yHint: (a11yHint: import("./matches").TextMatch, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance[]>;
35
+ findAllByHintText: (a11yHint: import("./matches").TextMatch, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance[]>;
36
+ getByRole: (role: RegExp | import("react-native").AccessibilityRole) => TestRenderer.ReactTestInstance;
37
+ getAllByRole: (role: RegExp | import("react-native").AccessibilityRole) => TestRenderer.ReactTestInstance[];
38
+ queryByRole: (role: RegExp | import("react-native").AccessibilityRole) => TestRenderer.ReactTestInstance | null;
39
+ queryAllByRole: (role: RegExp | import("react-native").AccessibilityRole) => TestRenderer.ReactTestInstance[];
40
+ findByRole: (role: import("react-native").AccessibilityRole, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance>;
41
+ findAllByRole: (role: import("react-native").AccessibilityRole, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance[]>;
42
+ getByA11yStates: (accessibilityStateKey: keyof import("react-native").AccessibilityState | (keyof import("react-native").AccessibilityState)[]) => TestRenderer.ReactTestInstance;
43
+ getAllByA11yStates: (accessibilityStateKey: keyof import("react-native").AccessibilityState | (keyof import("react-native").AccessibilityState)[]) => TestRenderer.ReactTestInstance[];
44
+ queryByA11yStates: (accessibilityStateKey: keyof import("react-native").AccessibilityState | (keyof import("react-native").AccessibilityState)[]) => TestRenderer.ReactTestInstance | null;
45
+ queryAllByA11yStates: (accessibilityStateKey: keyof import("react-native").AccessibilityState | (keyof import("react-native").AccessibilityState)[]) => TestRenderer.ReactTestInstance[];
46
+ findByA11yStates: (accessibilityStateKey: keyof import("react-native").AccessibilityState, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance>;
47
+ findAllByA11yStates: (accessibilityStateKey: keyof import("react-native").AccessibilityState, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance[]>;
48
+ getByA11yState: (accessibilityState: import("react-native").AccessibilityState) => TestRenderer.ReactTestInstance;
49
+ getAllByA11yState: (accessibilityState: import("react-native").AccessibilityState) => TestRenderer.ReactTestInstance[];
50
+ queryByA11yState: (accessibilityState: import("react-native").AccessibilityState) => TestRenderer.ReactTestInstance | null;
51
+ queryAllByA11yState: (accessibilityState: import("react-native").AccessibilityState) => TestRenderer.ReactTestInstance[];
52
+ findByA11yState: (accessibilityState: import("react-native").AccessibilityState, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance>;
53
+ findAllByA11yState: (accessibilityState: import("react-native").AccessibilityState, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance[]>;
54
+ getByA11yValue: (a11yValue: {
55
+ min?: number | undefined;
56
+ max?: number | undefined;
57
+ now?: number | undefined;
58
+ text?: string | undefined;
59
+ }) => TestRenderer.ReactTestInstance;
60
+ getAllByA11yValue: (a11yValue: {
61
+ min?: number | undefined;
62
+ max?: number | undefined;
63
+ now?: number | undefined;
64
+ text?: string | undefined;
65
+ }) => TestRenderer.ReactTestInstance[];
66
+ queryByA11yValue: (a11yValue: {
67
+ min?: number | undefined;
68
+ max?: number | undefined;
69
+ now?: number | undefined;
70
+ text?: string | undefined;
71
+ }) => TestRenderer.ReactTestInstance | null;
72
+ queryAllByA11yValue: (a11yValue: {
73
+ min?: number | undefined;
74
+ max?: number | undefined;
75
+ now?: number | undefined;
76
+ text?: string | undefined;
77
+ }) => TestRenderer.ReactTestInstance[];
78
+ findByA11yValue: (a11yValue: {
79
+ min?: number | undefined;
80
+ max?: number | undefined;
81
+ now?: number | undefined;
82
+ text?: string | undefined;
83
+ }, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance>;
84
+ findAllByA11yValue: (a11yValue: {
85
+ min?: number | undefined;
86
+ max?: number | undefined;
87
+ now?: number | undefined;
88
+ text?: string | undefined;
89
+ }, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance[]>;
90
+ findAllByDisplayValue: (value: import("./matches").TextMatch, queryOptions?: (import("./helpers/byText").TextMatchOptions & import("./waitFor").WaitForOptions) | undefined, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance[]>;
91
+ findAllByPlaceholder: () => void;
92
+ findAllByPlaceholderText: (placeholder: import("./matches").TextMatch, queryOptions?: (import("./helpers/byText").TextMatchOptions & import("./waitFor").WaitForOptions) | undefined, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance[]>;
93
+ findAllByTestId: (testId: import("./matches").TextMatch, queryOptions?: (import("./helpers/byText").TextMatchOptions & import("./waitFor").WaitForOptions) | undefined, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance[]>;
94
+ findAllByText: (text: import("./matches").TextMatch, queryOptions?: (import("./helpers/byText").TextMatchOptions & import("./waitFor").WaitForOptions) | undefined, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance[]>;
95
+ findByDisplayValue: (value: import("./matches").TextMatch, queryOptions?: (import("./helpers/byText").TextMatchOptions & import("./waitFor").WaitForOptions) | undefined, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance>;
96
+ findByPlaceholder: () => void;
97
+ findByPlaceholderText: (placeholder: import("./matches").TextMatch, queryOptions?: (import("./helpers/byText").TextMatchOptions & import("./waitFor").WaitForOptions) | undefined, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance>;
98
+ findByTestId: (testId: import("./matches").TextMatch, queryOptions?: (import("./helpers/byText").TextMatchOptions & import("./waitFor").WaitForOptions) | undefined, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance>;
99
+ findByText: (text: import("./matches").TextMatch, queryOptions?: (import("./helpers/byText").TextMatchOptions & import("./waitFor").WaitForOptions) | undefined, waitForOptions?: import("./waitFor").WaitForOptions | undefined) => Promise<TestRenderer.ReactTestInstance>;
100
+ queryByText: (name: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance | null;
101
+ queryAllByText: (text: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance[];
102
+ queryByPlaceholderText: (placeholder: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance | null;
103
+ queryAllByPlaceholderText: (placeholder: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance[];
104
+ queryByDisplayValue: (value: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance | null;
105
+ queryAllByDisplayValue: (value: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance[];
106
+ queryByTestId: (testID: import("./matches").TextMatch) => TestRenderer.ReactTestInstance | null;
107
+ queryAllByTestId: (testID: import("./matches").TextMatch) => TestRenderer.ReactTestInstance[];
108
+ UNSAFE_queryByType: <P>(type: React.ComponentType<P>) => TestRenderer.ReactTestInstance | null;
109
+ UNSAFE_queryAllByType: <P_1>(type: React.ComponentType<P_1>) => TestRenderer.ReactTestInstance[];
110
+ UNSAFE_queryByProps: (props: {
111
+ [key: string]: any;
112
+ }) => TestRenderer.ReactTestInstance | null;
113
+ UNSAFE_queryAllByProps: (props: {
114
+ [key: string]: any;
115
+ }) => TestRenderer.ReactTestInstance[];
116
+ queryByName: () => void;
117
+ queryByType: () => void;
118
+ queryByProps: () => void;
119
+ queryAllByName: () => void;
120
+ queryAllByType: () => void;
121
+ queryAllByProps: () => void;
122
+ queryByPlaceholder: () => void;
123
+ queryAllByPlaceholder: () => void;
124
+ getByText: (text: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance;
125
+ getByPlaceholderText: (placeholder: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance;
126
+ getByDisplayValue: (value: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance;
127
+ getByTestId: (testID: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance;
128
+ getAllByTestId: (testID: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance[];
129
+ getAllByText: (text: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance[];
130
+ getAllByPlaceholderText: (placeholder: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance[];
131
+ getAllByDisplayValue: (value: import("./matches").TextMatch, queryOptions?: import("./helpers/byText").TextMatchOptions | undefined) => TestRenderer.ReactTestInstance[];
132
+ UNSAFE_getByType: <P_2>(type: React.ComponentType<P_2>) => TestRenderer.ReactTestInstance;
133
+ UNSAFE_getAllByType: <P_3>(type: React.ComponentType<P_3>) => TestRenderer.ReactTestInstance[];
134
+ UNSAFE_getByProps: (props: {
135
+ [key: string]: any;
136
+ }) => TestRenderer.ReactTestInstance;
137
+ UNSAFE_getAllByProps: (props: {
138
+ [key: string]: any;
139
+ }) => TestRenderer.ReactTestInstance[];
140
+ };
141
+ interface DebugFunction {
142
+ (message?: string): void;
143
+ shallow: (message?: string) => void;
144
+ }
145
+ export {};
package/build/render.js CHANGED
@@ -5,10 +5,10 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports.default = render;
7
7
 
8
- var React = _interopRequireWildcard(require("react"));
9
-
10
8
  var _reactTestRenderer = _interopRequireDefault(require("react-test-renderer"));
11
9
 
10
+ var React = _interopRequireWildcard(require("react"));
11
+
12
12
  var _act = _interopRequireDefault(require("./act"));
13
13
 
14
14
  var _cleanup = require("./cleanup");
@@ -25,13 +25,11 @@ var _debugShallow = _interopRequireDefault(require("./helpers/debugShallow"));
25
25
 
26
26
  var _debugDeep = _interopRequireDefault(require("./helpers/debugDeep"));
27
27
 
28
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
29
-
30
- function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
28
+ 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); }
31
29
 
32
- function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (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; }
30
+ 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; }
33
31
 
34
- // eslint-disable-line import/no-extraneous-dependencies
32
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
35
33
 
36
34
  /**
37
35
  * Renders test component deeply using react-test-renderer and exposes helpers
@@ -74,7 +72,8 @@ function renderWithAct(component, options) {
74
72
  let renderer;
75
73
  (0, _act.default)(() => {
76
74
  renderer = _reactTestRenderer.default.create(component, options);
77
- });
75
+ }); // @ts-ignore act is sync, so renderer is always initialised here
76
+
78
77
  return renderer;
79
78
  }
80
79
 
@@ -88,10 +87,15 @@ function updateWithAct(renderer, wrap) {
88
87
 
89
88
  function debug(instance, renderer) {
90
89
  function debugImpl(message) {
91
- return (0, _debugDeep.default)(renderer.toJSON(), message);
90
+ const json = renderer.toJSON();
91
+
92
+ if (json) {
93
+ return (0, _debugDeep.default)(json, message);
94
+ }
92
95
  }
93
96
 
94
97
  debugImpl.shallow = message => (0, _debugShallow.default)(instance, message);
95
98
 
96
99
  return debugImpl;
97
- }
100
+ }
101
+ //# sourceMappingURL=render.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/render.tsx"],"names":["render","component","wrapper","Wrapper","createNodeMock","wrap","innerElement","renderer","renderWithAct","undefined","update","updateWithAct","instance","root","unmount","container","rerender","toJSON","debug","options","TestRenderer","create","debugImpl","message","json","shallow"],"mappings":";;;;;;;AAAA;;AAEA;;AACA;;AACA;;AACA;;AACA;;AACA;;AACA;;AACA;;AACA;;;;;;;;AAUA;AACA;AACA;AACA;AACe,SAASA,MAAT,CACbC,SADa,EAEb;AAAEC,EAAAA,OAAO,EAAEC,OAAX;AAAoBC,EAAAA;AAApB,IAAgD,EAFnC,EAGb;AACA,QAAMC,IAAI,GAAIC,YAAD,IACXH,OAAO,gBAAG,oBAAC,OAAD,QAAUG,YAAV,CAAH,GAAuCA,YADhD;;AAGA,QAAMC,QAAQ,GAAGC,aAAa,CAC5BH,IAAI,CAACJ,SAAD,CADwB,EAE5BG,cAAc,GAAG;AAAEA,IAAAA;AAAF,GAAH,GAAwBK,SAFV,CAA9B;AAIA,QAAMC,MAAM,GAAGC,aAAa,CAACJ,QAAD,EAAWF,IAAX,CAA5B;AACA,QAAMO,QAAQ,GAAGL,QAAQ,CAACM,IAA1B;;AACA,QAAMC,OAAO,GAAG,MAAM;AACpB,sBAAI,MAAM;AACRP,MAAAA,QAAQ,CAACO,OAAT;AACD,KAFD;AAGD,GAJD;;AAMA,kCAAkBA,OAAlB;AAEA,SAAO,EACL,GAAG,wBAASF,QAAT,CADE;AAEL,OAAG,4BAAWA,QAAX,CAFE;AAGL,OAAG,0BAAUA,QAAV,CAHE;AAIL,OAAG,sBAAQA,QAAR,CAJE;AAKLF,IAAAA,MALK;AAMLI,IAAAA,OANK;AAOLC,IAAAA,SAAS,EAAEH,QAPN;AAQLI,IAAAA,QAAQ,EAAEN,MARL;AAQa;AAClBO,IAAAA,MAAM,EAAEV,QAAQ,CAACU,MATZ;AAULC,IAAAA,KAAK,EAAEA,KAAK,CAACN,QAAD,EAAWL,QAAX;AAVP,GAAP;AAYD;;AAED,SAASC,aAAT,CACEP,SADF,EAEEkB,OAFF,EAGqB;AACnB,MAAIZ,QAAJ;AAEA,oBAAI,MAAM;AACRA,IAAAA,QAAQ,GAAGa,2BAAaC,MAAb,CAAoBpB,SAApB,EAA+BkB,OAA/B,CAAX;AACD,GAFD,EAHmB,CAOnB;;AACA,SAAOZ,QAAP;AACD;;AAED,SAASI,aAAT,CACEJ,QADF,EAEEF,IAFF,EAGE;AACA,SAAO,UAAUJ,SAAV,EAAyC;AAC9C,sBAAI,MAAM;AACRM,MAAAA,QAAQ,CAACG,MAAT,CAAgBL,IAAI,CAACJ,SAAD,CAApB;AACD,KAFD;AAGD,GAJD;AAKD;;AAOD,SAASiB,KAAT,CACEN,QADF,EAEEL,QAFF,EAGiB;AACf,WAASe,SAAT,CAAmBC,OAAnB,EAAqC;AACnC,UAAMC,IAAI,GAAGjB,QAAQ,CAACU,MAAT,EAAb;;AACA,QAAIO,IAAJ,EAAU;AACR,aAAO,wBAAUA,IAAV,EAAgBD,OAAhB,CAAP;AACD;AACF;;AACDD,EAAAA,SAAS,CAACG,OAAV,GAAqBF,OAAD,IAAsB,2BAAaX,QAAb,EAAuBW,OAAvB,CAA1C;;AACA,SAAOD,SAAP;AACD","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 { getByAPI } from './helpers/getByAPI';\nimport { queryByAPI } from './helpers/queryByAPI';\nimport { findByAPI } from './helpers/findByAPI';\nimport { a11yAPI } from './helpers/a11yAPI';\nimport debugShallow from './helpers/debugShallow';\nimport debugDeep from './helpers/debugDeep';\n\ntype Options = {\n wrapper?: React.ComponentType<any>;\n createNodeMock?: (element: React.ReactElement) => any;\n};\ntype TestRendererOptions = {\n createNodeMock: (element: React.ReactElement) => any;\n};\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 }: Options = {}\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 return {\n ...getByAPI(instance),\n ...queryByAPI(instance),\n ...findByAPI(instance),\n ...a11yAPI(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\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"],"file":"render.js"}
@@ -0,0 +1,17 @@
1
+ import type { ComponentType } from 'react';
2
+ interface RenderHookResult<Result, Props> {
3
+ rerender: (props: Props) => void;
4
+ result: {
5
+ current: Result;
6
+ };
7
+ unmount: () => void;
8
+ }
9
+ declare type RenderHookOptions<Props> = Props extends object | string | number | boolean ? {
10
+ initialProps: Props;
11
+ wrapper?: ComponentType<any>;
12
+ } : {
13
+ wrapper?: ComponentType<any>;
14
+ initialProps?: never;
15
+ } | undefined;
16
+ export declare function renderHook<Result, Props>(renderCallback: (props: Props) => Result, options?: RenderHookOptions<Props>): RenderHookResult<Result, Props>;
17
+ export {};
@@ -0,0 +1,57 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.renderHook = renderHook;
7
+
8
+ var _react = _interopRequireDefault(require("react"));
9
+
10
+ var _render = _interopRequireDefault(require("./render"));
11
+
12
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
13
+
14
+ function renderHook(renderCallback, options) {
15
+ const initialProps = options === null || options === void 0 ? void 0 : options.initialProps;
16
+ const wrapper = options === null || options === void 0 ? void 0 : options.wrapper;
17
+
18
+ const result = /*#__PURE__*/_react.default.createRef();
19
+
20
+ function TestComponent({
21
+ renderCallbackProps
22
+ }) {
23
+ const renderResult = renderCallback(renderCallbackProps);
24
+
25
+ _react.default.useEffect(() => {
26
+ result.current = renderResult;
27
+ });
28
+
29
+ return null;
30
+ }
31
+
32
+ const {
33
+ rerender: baseRerender,
34
+ unmount
35
+ } = (0, _render.default)(
36
+ /*#__PURE__*/
37
+ // @ts-expect-error since option can be undefined, initialProps can be undefined when it should'nt
38
+ _react.default.createElement(TestComponent, {
39
+ renderCallbackProps: initialProps
40
+ }), {
41
+ wrapper
42
+ });
43
+
44
+ function rerender(rerenderCallbackProps) {
45
+ return baseRerender( /*#__PURE__*/_react.default.createElement(TestComponent, {
46
+ renderCallbackProps: rerenderCallbackProps
47
+ }));
48
+ } // @ts-expect-error result is ill typed because ref is initialized to null
49
+
50
+
51
+ return {
52
+ result,
53
+ rerender,
54
+ unmount
55
+ };
56
+ }
57
+ //# sourceMappingURL=renderHook.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/renderHook.tsx"],"names":["renderHook","renderCallback","options","initialProps","wrapper","result","React","createRef","TestComponent","renderCallbackProps","renderResult","useEffect","current","rerender","baseRerender","unmount","rerenderCallbackProps"],"mappings":";;;;;;;AAAA;;AAEA;;;;AAeO,SAASA,UAAT,CACLC,cADK,EAELC,OAFK,EAG4B;AACjC,QAAMC,YAAY,GAAGD,OAAH,aAAGA,OAAH,uBAAGA,OAAO,CAAEC,YAA9B;AACA,QAAMC,OAAO,GAAGF,OAAH,aAAGA,OAAH,uBAAGA,OAAO,CAAEE,OAAzB;;AAEA,QAAMC,MAA6C,gBAAGC,eAAMC,SAAN,EAAtD;;AAEA,WAASC,aAAT,CAAuB;AACrBC,IAAAA;AADqB,GAAvB,EAIG;AACD,UAAMC,YAAY,GAAGT,cAAc,CAACQ,mBAAD,CAAnC;;AAEAH,mBAAMK,SAAN,CAAgB,MAAM;AACpBN,MAAAA,MAAM,CAACO,OAAP,GAAiBF,YAAjB;AACD,KAFD;;AAIA,WAAO,IAAP;AACD;;AAED,QAAM;AAAEG,IAAAA,QAAQ,EAAEC,YAAZ;AAA0BC,IAAAA;AAA1B,MAAsC;AAAA;AAC1C;AACA,+BAAC,aAAD;AAAe,IAAA,mBAAmB,EAAEZ;AAApC,IAF0C,EAG1C;AAAEC,IAAAA;AAAF,GAH0C,CAA5C;;AAMA,WAASS,QAAT,CAAkBG,qBAAlB,EAAgD;AAC9C,WAAOF,YAAY,eACjB,6BAAC,aAAD;AAAe,MAAA,mBAAmB,EAAEE;AAApC,MADiB,CAAnB;AAGD,GA9BgC,CAgCjC;;;AACA,SAAO;AAAEX,IAAAA,MAAF;AAAUQ,IAAAA,QAAV;AAAoBE,IAAAA;AAApB,GAAP;AACD","sourcesContent":["import React from 'react';\nimport type { ComponentType } from 'react';\nimport render from './render';\n\ninterface RenderHookResult<Result, Props> {\n rerender: (props: Props) => void;\n result: { current: Result };\n unmount: () => void;\n}\n\ntype RenderHookOptions<Props> = Props extends object | string | number | boolean\n ? {\n initialProps: Props;\n wrapper?: ComponentType<any>;\n }\n : { wrapper?: ComponentType<any>; initialProps?: never } | undefined;\n\nexport function renderHook<Result, Props>(\n renderCallback: (props: Props) => Result,\n options?: RenderHookOptions<Props>\n): RenderHookResult<Result, Props> {\n const initialProps = options?.initialProps;\n const wrapper = options?.wrapper;\n\n const result: React.MutableRefObject<Result | null> = React.createRef();\n\n function TestComponent({\n renderCallbackProps,\n }: {\n renderCallbackProps: Props;\n }) {\n const renderResult = renderCallback(renderCallbackProps);\n\n React.useEffect(() => {\n result.current = renderResult;\n });\n\n return null;\n }\n\n const { rerender: baseRerender, unmount } = render(\n // @ts-expect-error since option can be undefined, initialProps can be undefined when it should'nt\n <TestComponent renderCallbackProps={initialProps} />,\n { wrapper }\n );\n\n function rerender(rerenderCallbackProps: Props) {\n return baseRerender(\n <TestComponent renderCallbackProps={rerenderCallbackProps} />\n );\n }\n\n // @ts-expect-error result is ill typed because ref is initialized to null\n return { result, rerender, unmount };\n}\n"],"file":"renderHook.js"}
@@ -0,0 +1,8 @@
1
+ import * as React from 'react';
2
+ import { ReactTestInstance } from 'react-test-renderer';
3
+ /**
4
+ * Renders test component shallowly using react-test-renderer/shallow
5
+ */
6
+ export declare function shallowInternal(instance: ReactTestInstance | React.ReactElement<any>): {
7
+ output: any;
8
+ };
package/build/shallow.js CHANGED
@@ -4,19 +4,16 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.shallowInternal = shallowInternal;
7
- exports.default = shallow;
8
7
 
9
8
  var React = _interopRequireWildcard(require("react"));
10
9
 
11
10
  var _shallow = _interopRequireDefault(require("react-test-renderer/shallow"));
12
11
 
13
- var _errors = require("./helpers/errors");
14
-
15
12
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
16
13
 
17
- function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
14
+ 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); }
18
15
 
19
- function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (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; }
16
+ 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; }
20
17
 
21
18
  // eslint-disable-line import/no-extraneous-dependencies
22
19
 
@@ -30,7 +27,4 @@ function shallowInternal(instance) {
30
27
  output: renderer.getRenderOutput()
31
28
  };
32
29
  }
33
-
34
- function shallow(_) {
35
- (0, _errors.throwRemovedFunctionError)('shallow', 'migration-v2#removed-global-shallow-function');
36
- }
30
+ //# sourceMappingURL=shallow.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/shallow.ts"],"names":["shallowInternal","instance","renderer","ShallowRenderer","render","React","createElement","type","props","output","getRenderOutput"],"mappings":";;;;;;;AAAA;;AAEA;;;;;;;;AAA2D;;AAE3D;AACA;AACA;AACO,SAASA,eAAT,CACLC,QADK,EAEY;AACjB,QAAMC,QAAQ,GAAG,IAAKC,gBAAL,EAAjB;AAEAD,EAAAA,QAAQ,CAACE,MAAT,eAAgBC,KAAK,CAACC,aAAN,CAAoBL,QAAQ,CAACM,IAA7B,EAAmCN,QAAQ,CAACO,KAA5C,CAAhB;AAEA,SAAO;AACLC,IAAAA,MAAM,EAAEP,QAAQ,CAACQ,eAAT;AADH,GAAP;AAGD","sourcesContent":["import * as React from 'react';\nimport { ReactTestInstance } from 'react-test-renderer';\nimport ShallowRenderer from 'react-test-renderer/shallow'; // eslint-disable-line import/no-extraneous-dependencies\n\n/**\n * Renders test component shallowly using react-test-renderer/shallow\n */\nexport function shallowInternal(\n instance: ReactTestInstance | React.ReactElement<any>\n): { output: any } {\n const renderer = new (ShallowRenderer as any)();\n\n renderer.render(React.createElement(instance.type, instance.props));\n\n return {\n output: renderer.getRenderOutput(),\n };\n}\n"],"file":"shallow.js"}
@@ -0,0 +1,8 @@
1
+ import { ErrorWithStack } from './helpers/errors';
2
+ export declare type WaitForOptions = {
3
+ timeout?: number;
4
+ interval?: number;
5
+ stackTraceError?: ErrorWithStack;
6
+ onTimeout?: (error: unknown) => Error;
7
+ };
8
+ export default function waitFor<T>(expectation: () => T, options?: WaitForOptions): Promise<T>;
package/build/waitFor.js CHANGED
@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.default = waitFor;
7
- exports.waitForElement = waitForElement;
8
7
 
9
8
  var React = _interopRequireWildcard(require("react"));
10
9
 
@@ -16,9 +15,9 @@ var _timers = require("./helpers/timers");
16
15
 
17
16
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
18
17
 
19
- function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
18
+ 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); }
20
19
 
21
- function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (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; }
20
+ 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; }
22
21
 
23
22
  /* globals jest */
24
23
  const DEFAULT_TIMEOUT = 1000;
@@ -99,7 +98,7 @@ function waitForInternal(expectation, {
99
98
  checkExpectation();
100
99
  }
101
100
 
102
- function onDone(error, result) {
101
+ function onDone(done) {
103
102
  finished = true;
104
103
  (0, _timers.clearTimeout)(overallTimeoutTimer);
105
104
 
@@ -107,11 +106,10 @@ function waitForInternal(expectation, {
107
106
  clearInterval(intervalId);
108
107
  }
109
108
 
110
- if (error) {
111
- reject(error);
109
+ if (done.type === 'error') {
110
+ reject(done.error);
112
111
  } else {
113
- // $FlowIgnore[incompatible-return] error and result are mutually exclusive
114
- resolve(result);
112
+ resolve(done.result);
115
113
  }
116
114
  }
117
115
 
@@ -133,14 +131,19 @@ function waitForInternal(expectation, {
133
131
  if (promiseStatus === 'pending') return;
134
132
 
135
133
  try {
136
- const result = expectation(); // $FlowIgnore[incompatible-type]
134
+ const result = expectation(); // @ts-ignore result can be a promise
135
+ // eslint-disable-next-line promise/prefer-await-to-then
137
136
 
138
137
  if (typeof (result === null || result === void 0 ? void 0 : result.then) === 'function') {
139
- promiseStatus = 'pending'; // eslint-disable-next-line promise/catch-or-return
138
+ const promiseResult = result;
139
+ promiseStatus = 'pending'; // eslint-disable-next-line promise/catch-or-return, promise/prefer-await-to-then
140
140
 
141
- result.then(resolvedValue => {
141
+ promiseResult.then(resolvedValue => {
142
142
  promiseStatus = 'resolved';
143
- onDone(null, resolvedValue);
143
+ onDone({
144
+ type: 'result',
145
+ result: resolvedValue
146
+ });
144
147
  return;
145
148
  }, rejectedValue => {
146
149
  promiseStatus = 'rejected';
@@ -148,7 +151,10 @@ function waitForInternal(expectation, {
148
151
  return;
149
152
  });
150
153
  } else {
151
- onDone(null, result);
154
+ onDone({
155
+ type: 'result',
156
+ result: result
157
+ });
152
158
  } // If `callback` throws, wait for the next mutation, interval, or timeout.
153
159
 
154
160
  } catch (error) {
@@ -178,7 +184,10 @@ function waitForInternal(expectation, {
178
184
  onTimeout(error);
179
185
  }
180
186
 
181
- onDone(error, null);
187
+ onDone({
188
+ type: 'error',
189
+ error
190
+ });
182
191
  }
183
192
  });
184
193
  }
@@ -195,16 +204,11 @@ async function waitFor(expectation, options) {
195
204
  return waitForInternal(expectation, optionsWithStackTrace);
196
205
  }
197
206
 
198
- let result; //$FlowFixMe: `act` has incorrect flow typing
199
-
207
+ let result;
200
208
  await (0, _act.default)(async () => {
201
209
  result = await waitForInternal(expectation, optionsWithStackTrace);
202
- }); //$FlowFixMe: either we have result or `waitFor` threw error
210
+ }); // Either we have result or `waitFor` threw error
203
211
 
204
212
  return result;
205
213
  }
206
-
207
- function waitForElement(expectation, _timeout = 4500, _interval = 50) {
208
- (0, _errors.throwRemovedFunctionError)('waitForElement', 'migration-v2#waitfor-api-changes');
209
- return Promise.reject();
210
- }
214
+ //# sourceMappingURL=waitFor.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/waitFor.ts"],"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","handleTimeout","usingFakeTimers","checkExpectation","fakeTimeRemaining","error","Error","jest","advanceTimersByTime","setInterval","checkRealTimersCallback","onDone","done","clearInterval","type","result","then","promiseResult","resolvedValue","rejectedValue","waitFor","options","ErrorWithStack","optionsWithStackTrace"],"mappings":";;;;;;;AACA;;AACA;;AACA;;AACA;;;;;;;;AAJA;AAWA,MAAMA,eAAe,GAAG,IAAxB;AACA,MAAMC,gBAAgB,GAAG,EAAzB;;AAEA,SAASC,wBAAT,CAAkCC,KAAlC,EAAiDC,KAAjD,EAAyE;AACvE,MAAIC,KAAK,CAACC,OAAN,KAAkBC,SAAtB,EAAiC,OAAO,KAAP;AACjC,QAAM,CAACC,WAAD,EAAcC,WAAd,IAA6BJ,KAAK,CAACC,OAAN,CAAcI,KAAd,CAAoB,GAApB,EAAyBC,GAAzB,CAA6BC,MAA7B,CAAnC;AAEA,SAAOJ,WAAW,GAAGL,KAAd,IAAwBK,WAAW,KAAKL,KAAhB,IAAyBM,WAAW,IAAIL,KAAvE;AACD;;AASD,SAASS,eAAT,CACEC,WADF,EAEE;AACEC,EAAAA,OAAO,GAAGf,eADZ;AAEEgB,EAAAA,QAAQ,GAAGf,gBAFb;AAGEgB,EAAAA,eAHF;AAIEC,EAAAA;AAJF,CAFF,EAQc;AACZ,MAAI,OAAOJ,WAAP,KAAuB,UAA3B,EAAuC;AACrC,UAAM,IAAIK,SAAJ,CAAc,+CAAd,CAAN;AACD,GAHW,CAKZ;;;AACA,SAAO,IAAIC,OAAJ,CAAY,OAAOC,OAAP,EAAgBC,MAAhB,KAA2B;AAC5C,QAAIC,SAAJ,EAAwBC,UAAxB;AACA,QAAIC,QAAQ,GAAG,KAAf;AACA,QAAIC,aAAa,GAAG,MAApB;AAEA,UAAMC,mBAAmB,GAAG,wBAAWC,aAAX,EAA0Bb,OAA1B,CAA5B;AAEA,UAAMc,eAAe,GAAG,uCAAxB;;AAEA,QAAIA,eAAJ,EAAqB;AACnBC,MAAAA,gBAAgB,GADG,CAEnB;AACA;AACA;AACA;AACA;;AACA,UAAIC,iBAAiB,GAAGhB,OAAxB;;AACA,aAAO,CAACU,QAAR,EAAkB;AAChB,YAAI,CAAC,uCAAL,EAAiC;AAC/B,gBAAMO,KAAK,GAAG,IAAIC,KAAJ,CACX,kUADW,CAAd;;AAGA,cAAIhB,eAAJ,EAAqB;AACnB,wCAAee,KAAf,EAAsBf,eAAtB;AACD;;AACDK,UAAAA,MAAM,CAACU,KAAD,CAAN;AACA;AACD,SAVe,CAYhB;;;AACA,YAAID,iBAAiB,IAAI,CAAzB,EAA4B;AAC1B;AACD,SAFD,MAEO;AACLA,UAAAA,iBAAiB,IAAIf,QAArB;AACD,SAjBe,CAmBhB;AACA;AACA;AACA;AACA;;;AACAkB,QAAAA,IAAI,CAACC,mBAAL,CAAyBnB,QAAzB,EAxBgB,CA0BhB;AACA;AACA;AACA;;AACAc,QAAAA,gBAAgB,GA9BA,CAgChB;AACA;AACA;AACA;AACA;;AACA,cAAM,IAAIV,OAAJ,CAAaC,OAAD,IAAa,0BAAaA,OAAb,CAAzB,CAAN;AACD;AACF,KA/CD,MA+CO;AACLG,MAAAA,UAAU,GAAGY,WAAW,CAACC,uBAAD,EAA0BrB,QAA1B,CAAxB;AACAc,MAAAA,gBAAgB;AACjB;;AAED,aAASQ,MAAT,CACEC,IADF,EAEE;AACAd,MAAAA,QAAQ,GAAG,IAAX;AACA,gCAAaE,mBAAb;;AAEA,UAAI,CAACE,eAAL,EAAsB;AACpBW,QAAAA,aAAa,CAAChB,UAAD,CAAb;AACD;;AAED,UAAIe,IAAI,CAACE,IAAL,KAAc,OAAlB,EAA2B;AACzBnB,QAAAA,MAAM,CAACiB,IAAI,CAACP,KAAN,CAAN;AACD,OAFD,MAEO;AACLX,QAAAA,OAAO,CAACkB,IAAI,CAACG,MAAN,CAAP;AACD;AACF;;AAED,aAASL,uBAAT,GAAmC;AACjC,UAAI,uCAAJ,EAAgC;AAC9B,cAAML,KAAK,GAAG,IAAIC,KAAJ,CACX,kUADW,CAAd;;AAGA,YAAIhB,eAAJ,EAAqB;AACnB,sCAAee,KAAf,EAAsBf,eAAtB;AACD;;AACD,eAAOK,MAAM,CAACU,KAAD,CAAb;AACD,OARD,MAQO;AACL,eAAOF,gBAAgB,EAAvB;AACD;AACF;;AAED,aAASA,gBAAT,GAA4B;AAC1B,UAAIJ,aAAa,KAAK,SAAtB,EAAiC;;AACjC,UAAI;AACF,cAAMgB,MAAM,GAAG5B,WAAW,EAA1B,CADE,CAGF;AACA;;AACA,YAAI,QAAO4B,MAAP,aAAOA,MAAP,uBAAOA,MAAM,CAAEC,IAAf,MAAwB,UAA5B,EAAwC;AACtC,gBAAMC,aAAyB,GAAGF,MAAlC;AACAhB,UAAAA,aAAa,GAAG,SAAhB,CAFsC,CAGtC;;AACAkB,UAAAA,aAAa,CAACD,IAAd,CACGE,aAAD,IAAmB;AACjBnB,YAAAA,aAAa,GAAG,UAAhB;AACAY,YAAAA,MAAM,CAAC;AAAEG,cAAAA,IAAI,EAAE,QAAR;AAAkBC,cAAAA,MAAM,EAAEG;AAA1B,aAAD,CAAN;AACA;AACD,WALH,EAMGC,aAAD,IAAmB;AACjBpB,YAAAA,aAAa,GAAG,UAAhB;AACAH,YAAAA,SAAS,GAAGuB,aAAZ;AACA;AACD,WAVH;AAYD,SAhBD,MAgBO;AACLR,UAAAA,MAAM,CAAC;AAAEG,YAAAA,IAAI,EAAE,QAAR;AAAkBC,YAAAA,MAAM,EAAEA;AAA1B,WAAD,CAAN;AACD,SAvBC,CAwBF;;AACD,OAzBD,CAyBE,OAAOV,KAAP,EAAc;AACd;AACAT,QAAAA,SAAS,GAAGS,KAAZ;AACD;AACF;;AAED,aAASJ,aAAT,GAAyB;AACvB,UAAII,KAAJ;;AACA,UAAIT,SAAJ,EAAe;AACbS,QAAAA,KAAK,GAAGT,SAAR;;AACA,YAAIN,eAAJ,EAAqB;AACnB,sCAAee,KAAf,EAAsBf,eAAtB;AACD;AACF,OALD,MAKO;AACLe,QAAAA,KAAK,GAAG,IAAIC,KAAJ,CAAU,uBAAV,CAAR;;AACA,YAAIhB,eAAJ,EAAqB;AACnB,sCAAee,KAAf,EAAsBf,eAAtB;AACD;AACF;;AACD,UAAI,OAAOC,SAAP,KAAqB,UAAzB,EAAqC;AACnCA,QAAAA,SAAS,CAACc,KAAD,CAAT;AACD;;AACDM,MAAAA,MAAM,CAAC;AAAEG,QAAAA,IAAI,EAAE,OAAR;AAAiBT,QAAAA;AAAjB,OAAD,CAAN;AACD;AACF,GA/IM,CAAP;AAgJD;;AAEc,eAAee,OAAf,CACbjC,WADa,EAEbkC,OAFa,EAGD;AACZ;AACA,QAAM/B,eAAe,GAAG,IAAIgC,sBAAJ,CAAmB,mBAAnB,EAAwCF,OAAxC,CAAxB;AACA,QAAMG,qBAAqB,GAAG;AAAEjC,IAAAA,eAAF;AAAmB,OAAG+B;AAAtB,GAA9B;;AAEA,MAAI,CAAC9C,wBAAwB,CAAC,EAAD,EAAK,CAAL,CAA7B,EAAsC;AACpC,WAAOW,eAAe,CAACC,WAAD,EAAcoC,qBAAd,CAAtB;AACD;;AAED,MAAIR,MAAJ;AAEA,QAAM,kBAAI,YAAY;AACpBA,IAAAA,MAAM,GAAG,MAAM7B,eAAe,CAACC,WAAD,EAAcoC,qBAAd,CAA9B;AACD,GAFK,CAAN,CAXY,CAeZ;;AACA,SAAOR,MAAP;AACD","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"],"file":"waitFor.js"}
@@ -0,0 +1,2 @@
1
+ import type { WaitForOptions } from './waitFor';
2
+ export default function waitForElementToBeRemoved<T>(expectation: () => T, options?: WaitForOptions): Promise<T>;
@@ -40,4 +40,5 @@ async function waitForElementToBeRemoved(expectation, options) {
40
40
 
41
41
  return initialElements;
42
42
  }, options);
43
- }
43
+ }
44
+ //# sourceMappingURL=waitForElementToBeRemoved.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/waitForElementToBeRemoved.ts"],"names":["isRemoved","result","Array","isArray","length","waitForElementToBeRemoved","expectation","options","timeoutError","ErrorWithStack","initialElements","error"],"mappings":";;;;;;;AAAA;;AAEA;;;;AAEA,SAASA,SAAT,CAAsBC,MAAtB,EAA0C;AACxC,SAAO,CAACA,MAAD,IAAYC,KAAK,CAACC,OAAN,CAAcF,MAAd,KAAyB,CAACA,MAAM,CAACG,MAApD;AACD;;AAEc,eAAeC,yBAAf,CACbC,WADa,EAEbC,OAFa,EAGD;AACZ;AACA,QAAMC,YAAY,GAAG,IAAIC,sBAAJ,CACnB,yCADmB,EAEnBJ,yBAFmB,CAArB,CAFY,CAOZ;;AACA,QAAMK,eAAe,GAAGJ,WAAW,EAAnC;;AACA,MAAIN,SAAS,CAACU,eAAD,CAAb,EAAgC;AAC9B,UAAM,IAAID,sBAAJ,CACJ,oKADI,EAEJJ,yBAFI,CAAN;AAID;;AAED,SAAO,sBAAQ,MAAM;AACnB,QAAIJ,MAAJ;;AACA,QAAI;AACFA,MAAAA,MAAM,GAAGK,WAAW,EAApB;AACD,KAFD,CAEE,OAAOK,KAAP,EAAc;AACd,aAAOD,eAAP;AACD;;AAED,QAAI,CAACV,SAAS,CAACC,MAAD,CAAd,EAAwB;AACtB,YAAMO,YAAN;AACD;;AAED,WAAOE,eAAP;AACD,GAbM,EAaJH,OAbI,CAAP;AAcD","sourcesContent":["import waitFor from './waitFor';\nimport type { WaitForOptions } from './waitFor';\nimport { ErrorWithStack } from './helpers/errors';\n\nfunction isRemoved<T>(result: T): boolean {\n return !result || (Array.isArray(result) && !result.length);\n}\n\nexport default async function waitForElementToBeRemoved<T>(\n expectation: () => T,\n options?: WaitForOptions\n): Promise<T> {\n // Created here so we get a nice stacktrace\n const timeoutError = new ErrorWithStack(\n 'Timed out in waitForElementToBeRemoved.',\n waitForElementToBeRemoved\n );\n\n // Elements have to be present initally and then removed.\n const initialElements = expectation();\n if (isRemoved(initialElements)) {\n throw new ErrorWithStack(\n 'The element(s) given to waitForElementToBeRemoved are already removed. waitForElementToBeRemoved requires that the element(s) exist(s) before waiting for removal.',\n waitForElementToBeRemoved\n );\n }\n\n return waitFor(() => {\n let result;\n try {\n result = expectation();\n } catch (error) {\n return initialElements;\n }\n\n if (!isRemoved(result)) {\n throw timeoutError;\n }\n\n return initialElements;\n }, options);\n}\n"],"file":"waitForElementToBeRemoved.js"}