@testing-library/react-native 7.1.0 → 8.0.0

package/build/helpers/getByAPI.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getByAPI = exports.UNSAFE_getAllByProps = exports.UNSAFE_getAllByType = exports.UNSAFE_getByProps = exports.UNSAFE_getByType = exports.getAllByTestId = exports.getAllByDisplayValue = exports.getAllByPlaceholderText = exports.getAllByText = exports.getByTestId = exports.getByDisplayValue = exports.getByPlaceholderText = exports.getByText = void 0;
+exports.getByAPI = exports.UNSAFE_getAllByProps = exports.UNSAFE_getAllByType = exports.UNSAFE_getByProps = exports.UNSAFE_getByType = void 0;
 
 var React = _interopRequireWildcard(require("react"));
 
@@ -11,187 +11,19 @@ var _prettyFormat = _interopRequireDefault(require("pretty-format"));
 
 var _errors = require("./errors");
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
-
-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; }
-
-const filterNodeByType = (node, type) => node.type === type;
+var _byTestId = require("./byTestId");
 
-const getNodeByText = (node, text) => {
-  try {
-    const {
-      Text
-    } = require('react-native');
-
-    const isTextComponent = filterNodeByType(node, Text);
-
-    if (isTextComponent) {
-      const textChildren = getChildrenAsText(node.props.children, Text);
+var _byText = require("./byText");
 
-      if (textChildren) {
-        const textToTest = textChildren.join('');
-        return typeof text === 'string' ? text === textToTest : text.test(textToTest);
-      }
-    }
+var _byPlaceholderText = require("./byPlaceholderText");
 
-    return false;
-  } catch (error) {
-    throw (0, _errors.createLibraryNotSupportedError)(error);
-  }
-};
+var _byDisplayValue = require("./byDisplayValue");
 
-const getChildrenAsText = (children, TextComponent, textContent = []) => {
-  React.Children.forEach(children, child => {
-    var _child$props;
-
-    if (typeof child === 'string') {
-      textContent.push(child);
-      return;
-    }
-
-    if (typeof child === 'number') {
-      textContent.push(child.toString());
-      return;
-    }
-
-    if (child === null || child === void 0 ? void 0 : (_child$props = child.props) === null || _child$props === void 0 ? void 0 : _child$props.children) {
-      // Bail on traversing text children down the tree if current node (child)
-      // has no text. In such situations, react-test-renderer will traverse down
-      // this tree in a separate call and run this query again. As a result, the
-      // query will match the deepest text node that matches requested text.
-      if (filterNodeByType(child, TextComponent) && textContent.length === 0) {
-        return;
-      }
-
-      getChildrenAsText(child.props.children, TextComponent, textContent);
-    }
-  });
-  return textContent;
-};
-
-const getTextInputNodeByPlaceholderText = (node, placeholder) => {
-  try {
-    const {
-      TextInput
-    } = require('react-native');
-
-    return filterNodeByType(node, TextInput) && (typeof placeholder === 'string' ? placeholder === node.props.placeholder : placeholder.test(node.props.placeholder));
-  } catch (error) {
-    throw (0, _errors.createLibraryNotSupportedError)(error);
-  }
-};
-
-const getTextInputNodeByDisplayValue = (node, value) => {
-  try {
-    const {
-      TextInput
-    } = require('react-native');
-
-    return filterNodeByType(node, TextInput) && (typeof value === 'string' ? value === node.props.value : value.test(node.props.value));
-  } catch (error) {
-    throw (0, _errors.createLibraryNotSupportedError)(error);
-  }
-};
-
-const getNodeByTestId = (node, testID) => {
-  return typeof testID === 'string' ? testID === node.props.testID : testID.test(node.props.testID);
-};
-
-const getByText = instance => function getByTextFn(text) {
-  try {
-    return instance.find(node => getNodeByText(node, text));
-  } catch (error) {
-    throw new _errors.ErrorWithStack((0, _errors.prepareErrorMessage)(error, 'text', text), getByTextFn);
-  }
-};
-
-exports.getByText = getByText;
-
-const getByPlaceholderText = instance => function getByPlaceholderTextFn(placeholder) {
-  try {
-    return instance.find(node => getTextInputNodeByPlaceholderText(node, placeholder));
-  } catch (error) {
-    throw new _errors.ErrorWithStack((0, _errors.prepareErrorMessage)(error, 'placeholder', placeholder), getByPlaceholderTextFn);
-  }
-};
-
-exports.getByPlaceholderText = getByPlaceholderText;
-
-const getByDisplayValue = instance => function getByDisplayValueFn(displayValue) {
-  try {
-    return instance.find(node => getTextInputNodeByDisplayValue(node, displayValue));
-  } catch (error) {
-    throw new _errors.ErrorWithStack((0, _errors.prepareErrorMessage)(error, 'display value', displayValue), getByDisplayValueFn);
-  }
-};
-
-exports.getByDisplayValue = getByDisplayValue;
-
-const getByTestId = instance => function getByTestIdFn(testID) {
-  try {
-    const results = getAllByTestId(instance)(testID);
-
-    if (results.length === 1) {
-      return results[0];
-    } else {
-      throw new _errors.ErrorWithStack(` Expected 1 but found ${results.length} instances with testID: ${String(testID)}`, getByTestIdFn);
-    }
-  } catch (error) {
-    throw new _errors.ErrorWithStack((0, _errors.prepareErrorMessage)(error), getByTestIdFn);
-  }
-};
-
-exports.getByTestId = getByTestId;
-
-const getAllByText = instance => function getAllByTextFn(text) {
-  const results = instance.findAll(node => getNodeByText(node, text));
-
-  if (results.length === 0) {
-    throw new _errors.ErrorWithStack(`No instances found with text: ${String(text)}`, getAllByTextFn);
-  }
-
-  return results;
-};
-
-exports.getAllByText = getAllByText;
-
-const getAllByPlaceholderText = instance => function getAllByPlaceholderTextFn(placeholder) {
-  const results = instance.findAll(node => getTextInputNodeByPlaceholderText(node, placeholder));
-
-  if (results.length === 0) {
-    throw new _errors.ErrorWithStack(`No instances found with placeholder: ${String(placeholder)}`, getAllByPlaceholderTextFn);
-  }
-
-  return results;
-};
-
-exports.getAllByPlaceholderText = getAllByPlaceholderText;
-
-const getAllByDisplayValue = instance => function getAllByDisplayValueFn(value) {
-  const results = instance.findAll(node => getTextInputNodeByDisplayValue(node, value));
-
-  if (results.length === 0) {
-    throw new _errors.ErrorWithStack(`No instances found with display value: ${String(value)}`, getAllByDisplayValueFn);
-  }
-
-  return results;
-};
-
-exports.getAllByDisplayValue = getAllByDisplayValue;
-
-const getAllByTestId = instance => function getAllByTestIdFn(testID) {
-  const results = instance.findAll(node => getNodeByTestId(node, testID)).filter(element => typeof element.type === 'string');
-
-  if (results.length === 0) {
-    throw new _errors.ErrorWithStack(`No instances found with testID: ${String(testID)}`, getAllByTestIdFn);
-  }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-  return results;
-};
+function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
 
-exports.getAllByTestId = getAllByTestId;
+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; }
 
 const UNSAFE_getByType = instance => function getByTypeFn(type) {
   try {
@@ -238,14 +70,14 @@ const UNSAFE_getAllByProps = instance => function getAllByPropsFn(props) {
 exports.UNSAFE_getAllByProps = UNSAFE_getAllByProps;
 
 const getByAPI = instance => ({
-  getByText: getByText(instance),
-  getByPlaceholderText: getByPlaceholderText(instance),
-  getByDisplayValue: getByDisplayValue(instance),
-  getByTestId: getByTestId(instance),
-  getAllByText: getAllByText(instance),
-  getAllByPlaceholderText: getAllByPlaceholderText(instance),
-  getAllByDisplayValue: getAllByDisplayValue(instance),
-  getAllByTestId: getAllByTestId(instance),
+  getByText: (0, _byText.getByText)(instance),
+  getByPlaceholderText: (0, _byPlaceholderText.getByPlaceholderText)(instance),
+  getByDisplayValue: (0, _byDisplayValue.getByDisplayValue)(instance),
+  getByTestId: (0, _byTestId.getByTestId)(instance),
+  getAllByText: (0, _byText.getAllByText)(instance),
+  getAllByPlaceholderText: (0, _byPlaceholderText.getAllByPlaceholderText)(instance),
+  getAllByDisplayValue: (0, _byDisplayValue.getAllByDisplayValue)(instance),
+  getAllByTestId: (0, _byTestId.getAllByTestId)(instance),
   // Unsafe
   UNSAFE_getByType: UNSAFE_getByType(instance),
   UNSAFE_getAllByType: UNSAFE_getAllByType(instance),

package/build/helpers/getByAPI.js.flow

@@ -3,210 +3,52 @@ import * as React from 'react';
 import prettyFormat from 'pretty-format';
 import {
   ErrorWithStack,
-  createLibraryNotSupportedError,
   prepareErrorMessage,
   throwRemovedFunctionError,
   throwRenamedFunctionError,
 } from './errors';
-
-const filterNodeByType = (node, type) => node.type === type;
-
-const getNodeByText = (node, text) => {
-  try {
-    const { Text } = require('react-native');
-    const isTextComponent = filterNodeByType(node, Text);
-    if (isTextComponent) {
-      const textChildren = getChildrenAsText(node.props.children, Text);
-      if (textChildren) {
-        const textToTest = textChildren.join('');
-        return typeof text === 'string'
-          ? text === textToTest
-          : text.test(textToTest);
-      }
-    }
-    return false;
-  } catch (error) {
-    throw createLibraryNotSupportedError(error);
-  }
-};
-
-const getChildrenAsText = (children, TextComponent, textContent = []) => {
-  React.Children.forEach(children, (child) => {
-    if (typeof child === 'string') {
-      textContent.push(child);
-      return;
-    }
-
-    if (typeof child === 'number') {
-      textContent.push(child.toString());
-      return;
-    }
-
-    if (child?.props?.children) {
-      // Bail on traversing text children down the tree if current node (child)
-      // has no text. In such situations, react-test-renderer will traverse down
-      // this tree in a separate call and run this query again. As a result, the
-      // query will match the deepest text node that matches requested text.
-      if (filterNodeByType(child, TextComponent) && textContent.length === 0) {
-        return;
-      }
-
-      getChildrenAsText(child.props.children, TextComponent, textContent);
-    }
-  });
-
-  return textContent;
-};
-
-const getTextInputNodeByPlaceholderText = (node, placeholder) => {
-  try {
-    const { TextInput } = require('react-native');
-    return (
-      filterNodeByType(node, TextInput) &&
-      (typeof placeholder === 'string'
-        ? placeholder === node.props.placeholder
-        : placeholder.test(node.props.placeholder))
-    );
-  } catch (error) {
-    throw createLibraryNotSupportedError(error);
-  }
-};
-
-const getTextInputNodeByDisplayValue = (node, value) => {
-  try {
-    const { TextInput } = require('react-native');
-    return (
-      filterNodeByType(node, TextInput) &&
-      (typeof value === 'string'
-        ? value === node.props.value
-        : value.test(node.props.value))
-    );
-  } catch (error) {
-    throw createLibraryNotSupportedError(error);
-  }
-};
-
-const getNodeByTestId = (node, testID) => {
-  return typeof testID === 'string'
-    ? testID === node.props.testID
-    : testID.test(node.props.testID);
-};
-
-export const getByText = (instance: ReactTestInstance) =>
-  function getByTextFn(text: string | RegExp) {
-    try {
-      return instance.find((node) => getNodeByText(node, text));
-    } catch (error) {
-      throw new ErrorWithStack(
-        prepareErrorMessage(error, 'text', text),
-        getByTextFn
-      );
-    }
-  };
-
-export const getByPlaceholderText = (instance: ReactTestInstance) =>
-  function getByPlaceholderTextFn(placeholder: string | RegExp) {
-    try {
-      return instance.find((node) =>
-        getTextInputNodeByPlaceholderText(node, placeholder)
-      );
-    } catch (error) {
-      throw new ErrorWithStack(
-        prepareErrorMessage(error, 'placeholder', placeholder),
-        getByPlaceholderTextFn
-      );
-    }
-  };
-
-export const getByDisplayValue = (instance: ReactTestInstance) =>
-  function getByDisplayValueFn(displayValue: string | RegExp) {
-    try {
-      return instance.find((node) =>
-        getTextInputNodeByDisplayValue(node, displayValue)
-      );
-    } catch (error) {
-      throw new ErrorWithStack(
-        prepareErrorMessage(error, 'display value', displayValue),
-        getByDisplayValueFn
-      );
-    }
-  };
-
-export const getByTestId = (instance: ReactTestInstance) =>
-  function getByTestIdFn(testID: string | RegExp) {
-    try {
-      const results = getAllByTestId(instance)(testID);
-      if (results.length === 1) {
-        return results[0];
-      } else {
-        throw new ErrorWithStack(
-          ` Expected 1 but found ${
-            results.length
-          } instances with testID: ${String(testID)}`,
-          getByTestIdFn
-        );
-      }
-    } catch (error) {
-      throw new ErrorWithStack(prepareErrorMessage(error), getByTestIdFn);
-    }
-  };
-
-export const getAllByText = (instance: ReactTestInstance) =>
-  function getAllByTextFn(text: string | RegExp) {
-    const results = instance.findAll((node) => getNodeByText(node, text));
-    if (results.length === 0) {
-      throw new ErrorWithStack(
-        `No instances found with text: ${String(text)}`,
-        getAllByTextFn
-      );
-    }
-    return results;
-  };
-
-export const getAllByPlaceholderText = (instance: ReactTestInstance) =>
-  function getAllByPlaceholderTextFn(placeholder: string | RegExp) {
-    const results = instance.findAll((node) =>
-      getTextInputNodeByPlaceholderText(node, placeholder)
-    );
-    if (results.length === 0) {
-      throw new ErrorWithStack(
-        `No instances found with placeholder: ${String(placeholder)}`,
-        getAllByPlaceholderTextFn
-      );
-    }
-    return results;
-  };
-
-export const getAllByDisplayValue = (instance: ReactTestInstance) =>
-  function getAllByDisplayValueFn(value: string | RegExp) {
-    const results = instance.findAll((node) =>
-      getTextInputNodeByDisplayValue(node, value)
-    );
-    if (results.length === 0) {
-      throw new ErrorWithStack(
-        `No instances found with display value: ${String(value)}`,
-        getAllByDisplayValueFn
-      );
-    }
-    return results;
-  };
-
-export const getAllByTestId = (instance: ReactTestInstance) =>
-  function getAllByTestIdFn(testID: string | RegExp): ReactTestInstance[] {
-    const results = instance
-      .findAll((node) => getNodeByTestId(node, testID))
-      .filter((element) => typeof element.type === 'string');
-
-    if (results.length === 0) {
-      throw new ErrorWithStack(
-        `No instances found with testID: ${String(testID)}`,
-        getAllByTestIdFn
-      );
-    }
-    return results;
-  };
-
-export const UNSAFE_getByType = (instance: ReactTestInstance) =>
+import { getAllByTestId, getByTestId } from './byTestId';
+import { getAllByText, getByText } from './byText';
+import {
+  getAllByPlaceholderText,
+  getByPlaceholderText,
+} from './byPlaceholderText';
+import { getAllByDisplayValue, getByDisplayValue } from './byDisplayValue';
+
+export type GetByAPI = {|
+  getByText: (text: string | RegExp) => ReactTestInstance,
+  getByPlaceholderText: (placeholder: string | RegExp) => ReactTestInstance,
+  getByDisplayValue: (value: string | RegExp) => ReactTestInstance,
+  getByTestId: (testID: string | RegExp) => ReactTestInstance,
+  getAllByTestId: (testID: string | RegExp) => Array<ReactTestInstance>,
+  getAllByText: (text: string | RegExp) => Array<ReactTestInstance>,
+  getAllByPlaceholderText: (
+    placeholder: string | RegExp
+  ) => Array<ReactTestInstance>,
+  getAllByDisplayValue: (value: string | RegExp) => Array<ReactTestInstance>,
+
+  // Unsafe aliases
+  UNSAFE_getByType: <P>(type: React.ComponentType<P>) => ReactTestInstance,
+  UNSAFE_getAllByType: <P>(
+    type: React.ComponentType<P>
+  ) => Array<ReactTestInstance>,
+  UNSAFE_getByProps: (props: { [string]: any }) => ReactTestInstance,
+  UNSAFE_getAllByProps: (props: { [string]: any }) => Array<ReactTestInstance>,
+
+  getByName: () => void,
+  getByType: () => void,
+  getByProps: () => void,
+  getAllByName: () => void,
+  getAllByType: () => void,
+  getAllByProps: () => void,
+
+  getByPlaceholder: () => void,
+  getAllByPlaceholder: () => void,
+|};
+
+export const UNSAFE_getByType = (
+  instance: ReactTestInstance
+): ((type: React.ComponentType<any>) => ReactTestInstance) =>
   function getByTypeFn(type: React.ComponentType<any>) {
     try {
       return instance.findByType(type);
@@ -215,7 +57,9 @@ export const UNSAFE_getByType = (instance: ReactTestInstance) =>
     }
   };
 
-export const UNSAFE_getByProps = (instance: ReactTestInstance) =>
+export const UNSAFE_getByProps = (
+  instance: ReactTestInstance
+): ((props: { [propName: string]: any }) => ReactTestInstance) =>
   function getByPropsFn(props: { [propName: string]: any }) {
     try {
       return instance.findByProps(props);
@@ -224,7 +68,9 @@ export const UNSAFE_getByProps = (instance: ReactTestInstance) =>
     }
   };
 
-export const UNSAFE_getAllByType = (instance: ReactTestInstance) =>
+export const UNSAFE_getAllByType = (
+  instance: ReactTestInstance
+): ((type: React.ComponentType<any>) => Array<ReactTestInstance>) =>
   function getAllByTypeFn(type: React.ComponentType<any>) {
     const results = instance.findAllByType(type);
     if (results.length === 0) {
@@ -233,7 +79,9 @@ export const UNSAFE_getAllByType = (instance: ReactTestInstance) =>
     return results;
   };
 
-export const UNSAFE_getAllByProps = (instance: ReactTestInstance) =>
+export const UNSAFE_getAllByProps = (
+  instance: ReactTestInstance
+): ((props: { [propName: string]: any }) => Array<ReactTestInstance>) =>
   function getAllByPropsFn(props: { [propName: string]: any }) {
     const results = instance.findAllByProps(props);
     if (results.length === 0) {
@@ -245,7 +93,7 @@ export const UNSAFE_getAllByProps = (instance: ReactTestInstance) =>
     return results;
   };
 
-export const getByAPI = (instance: ReactTestInstance) => ({
+export const getByAPI = (instance: ReactTestInstance): GetByAPI => ({
   getByText: getByText(instance),
   getByPlaceholderText: getByPlaceholderText(instance),
   getByDisplayValue: getByDisplayValue(instance),

package/build/helpers/{makeQuery.js → makeA11yQuery.js}

@@ -23,7 +23,7 @@ function makeAliases(aliases, query) {
   }), {});
 }
 
-const makeQuery = (name, queryNames, matcherFn) => instance => {
+const makeA11yQuery = (name, queryNames, matcherFn) => instance => {
   const getBy = matcher => {
     try {
       return instance.find(node => isNodeValid(node) && matcherFn(node.props[name], matcher));
@@ -75,5 +75,5 @@ const makeQuery = (name, queryNames, matcherFn) => instance => {
   };
 };
 
-var _default = makeQuery;
+var _default = makeA11yQuery;
 exports.default = _default;

package/build/helpers/{makeQuery.js.flow → makeA11yQuery.js.flow}

@@ -26,11 +26,13 @@ type QueryNames = {
   findAllBy: Array<string>,
 };
 
-const makeQuery = <P: mixed, M: mixed>(
+const makeA11yQuery = <P: mixed, M: mixed>(
   name: string,
   queryNames: QueryNames,
   matcherFn: (prop: P, value: M) => boolean
-) => (instance: ReactTestInstance) => {
+): ((instance: ReactTestInstance) => { ... }) => (
+  instance: ReactTestInstance
+) => {
   const getBy = (matcher: M) => {
     try {
       return instance.find(
@@ -93,4 +95,4 @@ const makeQuery = <P: mixed, M: mixed>(
   };
 };
 
-export default makeQuery;
+export default makeA11yQuery;

package/build/helpers/makeQueries.js

@@ -0,0 +1,78 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.makeQueries = makeQueries;
+
+var _waitFor = _interopRequireDefault(require("../waitFor"));
+
+var _errors = require("./errors");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function makeQueries(queryAllByQuery, getMissingError, getMultipleError) {
+  function getAllByQuery(instance) {
+    return function getAllFn(args) {
+      const results = queryAllByQuery(instance)(args);
+
+      if (results.length === 0) {
+        throw new _errors.ErrorWithStack(getMissingError(args), getAllFn);
+      }
+
+      return results;
+    };
+  }
+
+  function queryByQuery(instance) {
+    return function singleQueryFn(args) {
+      const results = queryAllByQuery(instance)(args);
+
+      if (results.length > 1) {
+        throw new _errors.ErrorWithStack(getMultipleError(args), singleQueryFn);
+      }
+
+      if (results.length === 0) {
+        return null;
+      }
+
+      return results[0];
+    };
+  }
+
+  function getByQuery(instance) {
+    return function getFn(args) {
+      const results = queryAllByQuery(instance)(args);
+
+      if (results.length > 1) {
+        throw new _errors.ErrorWithStack(getMultipleError(args), getFn);
+      }
+
+      if (results.length === 0) {
+        throw new _errors.ErrorWithStack(getMissingError(args), getFn);
+      }
+
+      return results[0];
+    };
+  }
+
+  function findAllByQuery(instance) {
+    return function findAllFn(args, waitForOptions = {}) {
+      return (0, _waitFor.default)(() => getAllByQuery(instance)(args), waitForOptions);
+    };
+  }
+
+  function findByQuery(instance) {
+    return function findFn(args, waitForOptions = {}) {
+      return (0, _waitFor.default)(() => getByQuery(instance)(args), waitForOptions);
+    };
+  }
+
+  return {
+    getBy: getByQuery,
+    getAllBy: getAllByQuery,
+    queryBy: queryByQuery,
+    findBy: findByQuery,
+    findAllBy: findAllByQuery
+  };
+}