@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
@@ -1,226 +0,0 @@
1
- // @flow
2
- /* globals jest */
3
-
4
- import * as React from 'react';
5
- import act from './act';
6
- import {
7
- ErrorWithStack,
8
- throwRemovedFunctionError,
9
- copyStackTrace,
10
- } from './helpers/errors';
11
- import {
12
- setTimeout,
13
- clearTimeout,
14
- setImmediate,
15
- jestFakeTimersAreEnabled,
16
- } from './helpers/timers';
17
-
18
- const DEFAULT_TIMEOUT = 1000;
19
- const DEFAULT_INTERVAL = 50;
20
-
21
- function checkReactVersionAtLeast(major: number, minor: number): boolean {
22
- if (React.version === undefined) return false;
23
- const [actualMajor, actualMinor] = React.version.split('.').map(Number);
24
-
25
- return actualMajor > major || (actualMajor === major && actualMinor >= minor);
26
- }
27
-
28
- export type WaitForOptions = {
29
- timeout?: number,
30
- interval?: number,
31
- stackTraceError?: ErrorWithStack,
32
- onTimeout?: (error: Error) => Error,
33
- };
34
-
35
- function waitForInternal<T>(
36
- expectation: () => T,
37
- {
38
- timeout = DEFAULT_TIMEOUT,
39
- interval = DEFAULT_INTERVAL,
40
- stackTraceError,
41
- onTimeout,
42
- }: WaitForOptions
43
- ): Promise<T> {
44
- if (typeof expectation !== 'function') {
45
- throw new TypeError('Received `expectation` arg must be a function');
46
- }
47
-
48
- // eslint-disable-next-line no-async-promise-executor
49
- return new Promise(async (resolve, reject) => {
50
- let lastError, intervalId;
51
- let finished = false;
52
- let promiseStatus = 'idle';
53
-
54
- const overallTimeoutTimer = setTimeout(handleTimeout, timeout);
55
-
56
- const usingFakeTimers = jestFakeTimersAreEnabled();
57
-
58
- if (usingFakeTimers) {
59
- checkExpectation();
60
- // this is a dangerous rule to disable because it could lead to an
61
- // infinite loop. However, eslint isn't smart enough to know that we're
62
- // setting finished inside `onDone` which will be called when we're done
63
- // waiting or when we've timed out.
64
- // eslint-disable-next-line no-unmodified-loop-condition
65
- let fakeTimeRemaining = timeout;
66
- while (!finished) {
67
- if (!jestFakeTimersAreEnabled()) {
68
- const error = new Error(
69
- `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`
70
- );
71
- if (stackTraceError) {
72
- copyStackTrace(error, stackTraceError);
73
- }
74
- reject(error);
75
- return;
76
- }
77
-
78
- // when fake timers are used we want to simulate the interval time passing
79
- if (fakeTimeRemaining <= 0) {
80
- return;
81
- } else {
82
- fakeTimeRemaining -= interval;
83
- }
84
-
85
- // we *could* (maybe should?) use `advanceTimersToNextTimer` but it's
86
- // possible that could make this loop go on forever if someone is using
87
- // third party code that's setting up recursive timers so rapidly that
88
- // the user's timer's don't get a chance to resolve. So we'll advance
89
- // by an interval instead. (We have a test for this case).
90
- jest.advanceTimersByTime(interval);
91
-
92
- // It's really important that checkExpectation is run *before* we flush
93
- // in-flight promises. To be honest, I'm not sure why, and I can't quite
94
- // think of a way to reproduce the problem in a test, but I spent
95
- // an entire day banging my head against a wall on this.
96
- checkExpectation();
97
-
98
- // In this rare case, we *need* to wait for in-flight promises
99
- // to resolve before continuing. We don't need to take advantage
100
- // of parallelization so we're fine.
101
- // https://stackoverflow.com/a/59243586/971592
102
- // eslint-disable-next-line no-await-in-loop
103
- await new Promise((resolve) => setImmediate(resolve));
104
- }
105
- } else {
106
- intervalId = setInterval(checkRealTimersCallback, interval);
107
- checkExpectation();
108
- }
109
-
110
- function onDone(error, result) {
111
- finished = true;
112
- clearTimeout(overallTimeoutTimer);
113
-
114
- if (!usingFakeTimers) {
115
- clearInterval(intervalId);
116
- }
117
-
118
- if (error) {
119
- reject(error);
120
- } else {
121
- // $FlowIgnore[incompatible-return] error and result are mutually exclusive
122
- resolve(result);
123
- }
124
- }
125
-
126
- function checkRealTimersCallback() {
127
- if (jestFakeTimersAreEnabled()) {
128
- const error = new Error(
129
- `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`
130
- );
131
- if (stackTraceError) {
132
- copyStackTrace(error, stackTraceError);
133
- }
134
- return reject(error);
135
- } else {
136
- return checkExpectation();
137
- }
138
- }
139
-
140
- function checkExpectation() {
141
- if (promiseStatus === 'pending') return;
142
- try {
143
- const result = expectation();
144
-
145
- // $FlowIgnore[incompatible-type]
146
- if (typeof result?.then === 'function') {
147
- promiseStatus = 'pending';
148
- // eslint-disable-next-line promise/catch-or-return
149
- result.then(
150
- (resolvedValue) => {
151
- promiseStatus = 'resolved';
152
- onDone(null, resolvedValue);
153
- return;
154
- },
155
- (rejectedValue) => {
156
- promiseStatus = 'rejected';
157
- lastError = rejectedValue;
158
- return;
159
- }
160
- );
161
- } else {
162
- onDone(null, result);
163
- }
164
- // If `callback` throws, wait for the next mutation, interval, or timeout.
165
- } catch (error) {
166
- // Save the most recent callback error to reject the promise with it in the event of a timeout
167
- lastError = error;
168
- }
169
- }
170
-
171
- function handleTimeout() {
172
- let error;
173
- if (lastError) {
174
- error = lastError;
175
- if (stackTraceError) {
176
- copyStackTrace(error, stackTraceError);
177
- }
178
- } else {
179
- error = new Error('Timed out in waitFor.');
180
- if (stackTraceError) {
181
- copyStackTrace(error, stackTraceError);
182
- }
183
- }
184
- if (typeof onTimeout === 'function') {
185
- onTimeout(error);
186
- }
187
- onDone(error, null);
188
- }
189
- });
190
- }
191
-
192
- export default async function waitFor<T>(
193
- expectation: () => T,
194
- options?: WaitForOptions
195
- ): Promise<T> {
196
- // Being able to display a useful stack trace requires generating it before doing anything async
197
- const stackTraceError = new ErrorWithStack('STACK_TRACE_ERROR', waitFor);
198
- const optionsWithStackTrace = { stackTraceError, ...options };
199
-
200
- if (!checkReactVersionAtLeast(16, 9)) {
201
- return waitForInternal(expectation, optionsWithStackTrace);
202
- }
203
-
204
- let result: T;
205
-
206
- //$FlowFixMe: `act` has incorrect flow typing
207
- await act(async () => {
208
- result = await waitForInternal(expectation, optionsWithStackTrace);
209
- });
210
-
211
- //$FlowFixMe: either we have result or `waitFor` threw error
212
- return result;
213
- }
214
-
215
- export function waitForElement<T>(
216
- expectation: () => T,
217
- _timeout: number = 4500,
218
- _interval: number = 50
219
- ): Promise<T> {
220
- throwRemovedFunctionError(
221
- 'waitForElement',
222
- 'migration-v2#waitfor-api-changes'
223
- );
224
-
225
- return Promise.reject();
226
- }
@@ -1,42 +0,0 @@
1
- // @flow
2
- import waitFor, { type WaitForOptions } from './waitFor';
3
- import { ErrorWithStack } from './helpers/errors';
4
-
5
- function isRemoved<T>(result: T): boolean {
6
- return !result || (Array.isArray(result) && !result.length);
7
- }
8
-
9
- export default async function waitForElementToBeRemoved<T>(
10
- expectation: () => T,
11
- options?: WaitForOptions
12
- ): Promise<T> {
13
- // Created here so we get a nice stacktrace
14
- const timeoutError = new ErrorWithStack(
15
- 'Timed out in waitForElementToBeRemoved.',
16
- waitForElementToBeRemoved
17
- );
18
-
19
- // Elements have to be present initally and then removed.
20
- const initialElements = expectation();
21
- if (isRemoved(initialElements)) {
22
- throw new ErrorWithStack(
23
- 'The element(s) given to waitForElementToBeRemoved are already removed. waitForElementToBeRemoved requires that the element(s) exist(s) before waiting for removal.',
24
- waitForElementToBeRemoved
25
- );
26
- }
27
-
28
- return waitFor(() => {
29
- let result;
30
- try {
31
- result = expectation();
32
- } catch (error) {
33
- return initialElements;
34
- }
35
-
36
- if (!isRemoved(result)) {
37
- throw timeoutError;
38
- }
39
-
40
- return initialElements;
41
- }, options);
42
- }
@@ -1,18 +0,0 @@
1
- // @flow
2
- import { getByAPI, type GetByAPI } from './helpers/getByAPI';
3
- import { queryByAPI, type QueryByAPI } from './helpers/queryByAPI';
4
- import { findByAPI, type FindByAPI } from './helpers/findByAPI';
5
- import { a11yAPI, type A11yAPI } from './helpers/a11yAPI';
6
-
7
- export function within(
8
- instance: ReactTestInstance
9
- ): { ...FindByAPI, ...QueryByAPI, ...GetByAPI, ...A11yAPI } {
10
- return {
11
- ...getByAPI(instance),
12
- ...queryByAPI(instance),
13
- ...findByAPI(instance),
14
- ...a11yAPI(instance),
15
- };
16
- }
17
-
18
- export const getQueriesForElement = within;