@testing-library/react-native 11.3.0 → 11.5.0

package/typings/index.flow.js

@@ -8,6 +8,10 @@ type QueryAllReturn = Array<ReactTestInstance> | [];
 type FindReturn = Promise<ReactTestInstance>;
 type FindAllReturn = Promise<ReactTestInstance[]>;
 
+type CommonQueryOptions = {
+  includeHiddenElements?: boolean,
+  hidden?: boolean,
+};
 type TextMatch = string | RegExp;
 
 declare type NormalizerFn = (textToNormalize: string) => string;
@@ -60,7 +64,7 @@ declare type A11yValue = {
   min?: number,
   max?: number,
   now?: number,
-  text?: string,
+  text?: TextMatch,
 };
 
 type WaitForOptions = {
@@ -74,109 +78,123 @@ type WaitForFunction = <T = any>(
   options?: WaitForOptions
 ) => Promise<T>;
 
+type ByTextOptions = CommonQueryOptions & TextMatchOptions;
+
 interface ByTextQueries {
-  getByText: (text: TextMatch, options?: TextMatchOptions) => ReactTestInstance;
+  getByText: (text: TextMatch, options?: ByTextOptions) => ReactTestInstance;
   getAllByText: (
     text: TextMatch,
-    options?: TextMatchOptions
+    options?: ByTextOptions
   ) => Array<ReactTestInstance>;
   queryByText: (
     name: TextMatch,
-    options?: TextMatchOptions
+    options?: ByTextOptions
   ) => ReactTestInstance | null;
   queryAllByText: (
     text: TextMatch,
-    options?: TextMatchOptions
+    options?: ByTextOptions
   ) => Array<ReactTestInstance> | [];
   findByText: (
     text: TextMatch,
-    queryOptions?: TextMatchOptions,
+    queryOptions?: ByTextOptions,
     waitForOptions?: WaitForOptions
   ) => FindReturn;
   findAllByText: (
     text: TextMatch,
-    queryOptions?: TextMatchOptions,
+    queryOptions?: ByTextOptions,
     waitForOptions?: WaitForOptions
   ) => FindAllReturn;
 }
 
+type ByTestIdOptions = CommonQueryOptions & TextMatchOptions;
+
 interface ByTestIdQueries {
   getByTestId: (
     testID: TextMatch,
-    options?: TextMatchOptions
+    options?: ByTestIdOptions
   ) => ReactTestInstance;
   getAllByTestId: (
     testID: TextMatch,
-    options?: TextMatchOptions
+    options?: ByTestIdOptions
   ) => Array<ReactTestInstance>;
-  queryByTestId: (testID: TextMatch) => ReactTestInstance | null;
-  queryAllByTestId: (testID: TextMatch) => Array<ReactTestInstance> | [];
+  queryByTestId: (
+    testID: TextMatch,
+    options?: ByTestIdOptions
+  ) => ReactTestInstance | null;
+  queryAllByTestId: (
+    testID: TextMatch,
+    options?: ByTestIdOptions
+  ) => Array<ReactTestInstance> | [];
   findByTestId: (
     testID: TextMatch,
-    queryOptions?: TextMatchOptions,
+    queryOptions?: ByTestIdOptions,
     waitForOptions?: WaitForOptions
   ) => FindReturn;
   findAllByTestId: (
     testID: TextMatch,
-    queryOptions?: TextMatchOptions,
+    queryOptions?: ByTestIdOptions,
     waitForOptions?: WaitForOptions
   ) => FindAllReturn;
 }
 
+type ByDisplayValueOptions = CommonQueryOptions & TextMatchOptions;
+
 interface ByDisplayValueQueries {
   getByDisplayValue: (
     value: TextMatch,
-    options?: TextMatchOptions
+    options?: ByDisplayValueOptions
   ) => ReactTestInstance;
   getAllByDisplayValue: (
     value: TextMatch,
-    options?: TextMatchOptions
+    options?: ByDisplayValueOptions
   ) => Array<ReactTestInstance>;
   queryByDisplayValue: (
     value: TextMatch,
-    options?: TextMatchOptions
+    options?: ByDisplayValueOptions
   ) => ReactTestInstance | null;
   queryAllByDisplayValue: (
     value: TextMatch,
-    options?: TextMatchOptions
+    options?: ByDisplayValueOptions
   ) => Array<ReactTestInstance> | [];
   findByDisplayValue: (
     value: TextMatch,
-    queryOptions?: TextMatchOptions,
+    queryOptions?: ByDisplayValueOptions,
     waitForOptions?: WaitForOptions
   ) => FindReturn;
   findAllByDisplayValue: (
     value: TextMatch,
-    queryOptions?: TextMatchOptions,
+    queryOptions?: ByDisplayValueOptions,
     waitForOptions?: WaitForOptions
   ) => FindAllReturn;
 }
 
+type ByPlaceholderTextOptions = CommonQueryOptions & TextMatchOptions;
+
 interface ByPlaceholderTextQueries {
   getByPlaceholderText: (
     placeholder: TextMatch,
-    options?: TextMatchOptions
+    options?: ByPlaceholderTextOptions
   ) => ReactTestInstance;
   getAllByPlaceholderText: (
     placeholder: TextMatch,
-    options?: TextMatchOptions
+    options?: ByPlaceholderTextOptions
   ) => Array<ReactTestInstance>;
   queryByPlaceholderText: (
     placeholder: TextMatch,
-    options?: TextMatchOptions
+    options?: ByPlaceholderTextOptions
   ) => ReactTestInstance | null;
   queryAllByPlaceholderText: (
     placeholder: TextMatch,
-    options?: TextMatchOptions
+    options?: ByPlaceholderTextOptions
   ) => Array<ReactTestInstance> | [];
   findByPlaceholderText: (
     placeholder: TextMatch,
-    queryOptions?: TextMatchOptions,
+    queryOptions?: ByPlaceholderTextOptions,
     waitForOptions?: WaitForOptions
   ) => FindReturn;
   findAllByPlaceholderText: (
     placeholder: TextMatch,
-    queryOptions?: TextMatchOptions,
+    queryOptions?: ByPlaceholderTextOptions,
     waitForOptions?: WaitForOptions
   ) => FindAllReturn;
 }
@@ -203,48 +221,89 @@ interface UnsafeByPropsQueries {
     | [];
 }
 
-interface ByRoleOptions {
-  name?: string;
-}
+type ByRoleOptions = CommonQueryOptions & {
+  ...A11yState,
+  name?: string,
+  value?: A11yValue,
+};
+
+type ByLabelTextOptions = CommonQueryOptions & TextMatchOptions;
+type ByHintTextOptions = CommonQueryOptions & TextMatchOptions;
 
 interface A11yAPI {
   // Label
-  getByLabelText: (matcher: TextMatch) => GetReturn;
-  getAllByLabelText: (matcher: TextMatch) => GetAllReturn;
-  queryByLabelText: (matcher: TextMatch) => QueryReturn;
-  queryAllByLabelText: (matcher: TextMatch) => QueryAllReturn;
+  getByLabelText: (
+    matcher: TextMatch,
+    options?: ByLabelTextOptions
+  ) => GetReturn;
+  getAllByLabelText: (
+    matcher: TextMatch,
+    options?: ByLabelTextOptions
+  ) => GetAllReturn;
+  queryByLabelText: (
+    matcher: TextMatch,
+    options?: ByLabelTextOptions
+  ) => QueryReturn;
+  queryAllByLabelText: (
+    matcher: TextMatch,
+    options?: ByLabelTextOptions
+  ) => QueryAllReturn;
   findByLabelText: (
     matcher: TextMatch,
+    queryOptions?: ByLabelTextOptions,
     waitForOptions?: WaitForOptions
   ) => FindReturn;
   findAllByLabelText: (
     matcher: TextMatch,
+    queryOptions?: ByLabelTextOptions,
     waitForOptions?: WaitForOptions
   ) => FindAllReturn;
 
   // Hint
-  getByA11yHint: (matcher: TextMatch) => GetReturn;
-  getByHintText: (matcher: TextMatch) => GetReturn;
-  getAllByA11yHint: (matcher: TextMatch) => GetAllReturn;
-  getAllByHintText: (matcher: TextMatch) => GetAllReturn;
-  queryByA11yHint: (matcher: TextMatch) => QueryReturn;
-  queryByHintText: (matcher: TextMatch) => QueryReturn;
-  queryAllByA11yHint: (matcher: TextMatch) => QueryAllReturn;
-  queryAllByHintText: (matcher: TextMatch) => QueryAllReturn;
+  getByA11yHint: (matcher: TextMatch, options?: ByHintTextOptions) => GetReturn;
+  getByHintText: (matcher: TextMatch, options?: ByHintTextOptions) => GetReturn;
+  getAllByA11yHint: (
+    matcher: TextMatch,
+    options?: ByHintTextOptions
+  ) => GetAllReturn;
+  getAllByHintText: (
+    matcher: TextMatch,
+    options?: ByHintTextOptions
+  ) => GetAllReturn;
+  queryByA11yHint: (
+    matcher: TextMatch,
+    options?: ByHintTextOptions
+  ) => QueryReturn;
+  queryByHintText: (
+    matcher: TextMatch,
+    options?: ByHintTextOptions
+  ) => QueryReturn;
+  queryAllByA11yHint: (
+    matcher: TextMatch,
+    options?: ByHintTextOptions
+  ) => QueryAllReturn;
+  queryAllByHintText: (
+    matcher: TextMatch,
+    options?: ByHintTextOptions
+  ) => QueryAllReturn;
   findByA11yHint: (
     matcher: TextMatch,
+    queryOptions?: ByHintTextOptions,
     waitForOptions?: WaitForOptions
   ) => FindReturn;
   findByHintText: (
     matcher: TextMatch,
+    queryOptions?: ByHintTextOptions,
     waitForOptions?: WaitForOptions
   ) => FindReturn;
   findAllByA11yHint: (
     matcher: TextMatch,
+    queryOptions?: ByHintTextOptions,
     waitForOptions?: WaitForOptions
   ) => FindAllReturn;
   findAllByHintText: (
     matcher: TextMatch,
+    queryOptions?: ByHintTextOptions,
     waitForOptions?: WaitForOptions
   ) => FindAllReturn;
 
@@ -252,52 +311,80 @@ interface A11yAPI {
   getByRole: (matcher: A11yRole | RegExp, role?: ByRoleOptions) => GetReturn;
   getAllByRole: (
     matcher: A11yRole | RegExp,
-    role?: ByRoleOptions
+    options?: ByRoleOptions
   ) => GetAllReturn;
   queryByRole: (
     matcher: A11yRole | RegExp,
-    role?: ByRoleOptions
+    options?: ByRoleOptions
   ) => QueryReturn;
   queryAllByRole: (
     matcher: A11yRole | RegExp,
-    role?: ByRoleOptions
+    options?: ByRoleOptions
   ) => QueryAllReturn;
   findByRole: (
     matcher: A11yRole | RegExp,
-    role?: ByRoleOptions,
+    queryOptions?: ByRoleOptions,
     waitForOptions?: WaitForOptions
   ) => FindReturn;
   findAllByRole: (
     matcher: A11yRole | RegExp,
-    role?: ByRoleOptions,
+    queryOptions?: ByRoleOptions,
     waitForOptions?: WaitForOptions
   ) => FindAllReturn;
 
   // State
-  getByA11yState: (matcher: A11yState) => GetReturn;
-  getAllByA11yState: (matcher: A11yState) => GetAllReturn;
-  queryByA11yState: (matcher: A11yState) => QueryReturn;
-  queryAllByA11yState: (matcher: A11yState) => QueryAllReturn;
+  getByA11yState: (
+    matcher: A11yState,
+    options?: CommonQueryOptions
+  ) => GetReturn;
+  getAllByA11yState: (
+    matcher: A11yState,
+    options?: CommonQueryOptions
+  ) => GetAllReturn;
+  queryByA11yState: (
+    matcher: A11yState,
+    options?: CommonQueryOptions
+  ) => QueryReturn;
+  queryAllByA11yState: (
+    matcher: A11yState,
+    options?: CommonQueryOptions
+  ) => QueryAllReturn;
   findByA11yState: (
     matcher: A11yState,
+    queryOptions?: CommonQueryOptions,
     waitForOptions?: WaitForOptions
   ) => FindReturn;
   findAllByA11yState: (
     matcher: A11yState,
+    queryOptions?: CommonQueryOptions,
     waitForOptions?: WaitForOptions
   ) => FindAllReturn;
 
   // Value
-  getByA11yValue: (matcher: A11yValue) => GetReturn;
-  getAllByA11yValue: (matcher: A11yValue) => GetAllReturn;
-  queryByA11yValue: (matcher: A11yValue) => QueryReturn;
-  queryAllByA11yValue: (matcher: A11yValue) => QueryAllReturn;
+  getByA11yValue: (
+    matcher: A11yValue,
+    options?: CommonQueryOptions
+  ) => GetReturn;
+  getAllByA11yValue: (
+    matcher: A11yValue,
+    options?: CommonQueryOptions
+  ) => GetAllReturn;
+  queryByA11yValue: (
+    matcher: A11yValue,
+    options?: CommonQueryOptions
+  ) => QueryReturn;
+  queryAllByA11yValue: (
+    matcher: A11yValue,
+    options?: CommonQueryOptions
+  ) => QueryAllReturn;
   findByA11yValue: (
     matcher: A11yValue,
+    queryOptions?: CommonQueryOptions,
     waitForOptions?: WaitForOptions
   ) => FindReturn;
   findAllByA11yValue: (
     matcher: A11yValue,
+    queryOptions?: CommonQueryOptions,
     waitForOptions?: WaitForOptions
   ) => FindAllReturn;
 }
@@ -306,8 +393,18 @@ interface Thenable {
   then: (resolve: () => any, reject?: () => any) => any;
 }
 
+type MapPropsFunction = (
+  props: { [string]: mixed },
+  node: ReactTestRendererJSON
+) => { [string]: mixed };
+
+type DebugOptions = {
+  message?: string,
+  mapProps?: MapPropsFunction,
+};
+
 type Debug = {
-  (message?: string): void,
+  (options?: DebugOptions | string): void,
   shallow: (message?: string) => void,
 };
 
@@ -370,21 +467,37 @@ declare module '@testing-library/react-native' {
 
   declare interface Config {
     asyncUtilTimeout: number;
+    defaultIncludeHiddenElements: boolean;
+    defaultDebugOptions?: $Shape<DebugOptions>;
   }
 
-  declare export var configure: (options: $Shape<Config>) => void;
+  declare interface ConfigAliasOptions {
+    /** Alias to `defaultIncludeHiddenElements` for RTL compatibility */
+    defaultHidden: boolean;
+  }
+
+  declare export var configure: (
+    options: $Shape<Config & ConfigAliasOptions>
+  ) => void;
   declare export var resetToDefaults: () => void;
 
   declare export var act: (callback: () => void) => Thenable;
   declare export var within: (instance: ReactTestInstance) => Queries;
   declare export var getQueriesForElement: (
-    instance: ReactTestInstance
+    element: ReactTestInstance
   ) => Queries;
 
   declare export var getDefaultNormalizer: (
     normalizerConfig?: NormalizerConfig
   ) => NormalizerFn;
 
+  declare export var isHiddenFromAccessibility: (
+    element: ReactTestInstance | null
+  ) => boolean;
+  declare export var isInaccessible: (
+    element: ReactTestInstance | null
+  ) => boolean;
+
   declare type RenderHookResult<Result, Props> = {
     rerender: (props: Props) => void,
     result: { current: Result },