feature: export options types and renderHook result type (#1091)

Author: mdjastrzebski

src/pure.ts

@@ -1,16 +1,20 @@
 import act from './act';
 import cleanup from './cleanup';
 import fireEvent from './fireEvent';
-import render, { RenderResult } from './render';
+import render from './render';
 import waitFor from './waitFor';
 import waitForElementToBeRemoved from './waitForElementToBeRemoved';
 import { within, getQueriesForElement } from './within';
 import { getDefaultNormalizer } from './matches';
 import { renderHook } from './renderHook';
 import { screen } from './screen';
 
-export type { RenderResult };
-export type RenderAPI = RenderResult;
+export type {
+  RenderOptions,
+  RenderResult,
+  RenderResult as RenderAPI,
+} from './render';
+export type { RenderHookOptions, RenderHookResult } from './renderHook';
 
 export { act };
 export { cleanup };

src/render.tsx

@@ -8,10 +8,11 @@ import debugDeep from './helpers/debugDeep';
 import { getQueriesForElement } from './within';
 import { setRenderResult } from './screen';
 
-type Options = {
+export type RenderOptions = {
   wrapper?: React.ComponentType<any>;
   createNodeMock?: (element: React.ReactElement) => any;
 };
+
 type TestRendererOptions = {
   createNodeMock: (element: React.ReactElement) => any;
 };
@@ -24,7 +25,7 @@ export type RenderResult = ReturnType<typeof render>;
  */
 export default function render<T>(
   component: React.ReactElement<T>,
-  { wrapper: Wrapper, createNodeMock }: Options = {}
+  { wrapper: Wrapper, createNodeMock }: RenderOptions = {}
 ) {
   const wrap = (innerElement: React.ReactElement) =>
     Wrapper ? <Wrapper>{innerElement}</Wrapper> : innerElement;

src/renderHook.tsx

@@ -2,13 +2,17 @@ import React from 'react';
 import type { ComponentType } from 'react';
 import render from './render';
 
-interface RenderHookResult<Result, Props> {
+export type RenderHookResult<Result, Props> = {
   rerender: (props: Props) => void;
   result: { current: Result };
   unmount: () => void;
-}
+};
 
-type RenderHookOptions<Props> = Props extends object | string | number | boolean
+export type RenderHookOptions<Props> = Props extends
+  | object
+  | string
+  | number
+  | boolean
   ? {
       initialProps: Props;
       wrapper?: ComponentType<any>;

typings/index.flow.js

@@ -68,6 +68,7 @@ type WaitForOptions = {
   interval?: number,
   onTimeout?: (error: mixed) => Error,
 };
+
 type WaitForFunction = <T = any>(
   expectation: () => T,
   options?: WaitForOptions
@@ -289,11 +290,6 @@ interface Thenable {
   then: (resolve: () => any, reject?: () => any) => any;
 }
 
-interface RenderOptions {
-  wrapper?: React.ComponentType<any>;
-  createNodeMock?: (element: React.Element<any>) => any;
-}
-
 type Debug = {
   (message?: string): void,
   shallow: (message?: string) => void,
@@ -307,15 +303,6 @@ type Queries = ByTextQueries &
   UnsafeByPropsQueries &
   A11yAPI;
 
-interface RenderAPI extends Queries {
-  update(nextElement: React.Element<any>): void;
-  rerender(nextElement: React.Element<any>): void;
-  unmount(nextElement?: React.Element<any>): void;
-  toJSON(): ReactTestRendererJSON[] | ReactTestRendererJSON | null;
-  debug: Debug;
-  container: ReactTestInstance;
-}
-
 type FireEventFunction = (
   element: ReactTestInstance,
   eventName: string,
@@ -328,24 +315,29 @@ type FireEventAPI = FireEventFunction & {
   scroll: (element: ReactTestInstance, ...data: Array<any>) => any,
 };
 
-type RenderHookResult<Result, Props> = {
-  rerender: (props: Props) => void,
-  result: { current: Result },
-  unmount: () => void,
-};
-
-type RenderHookOptions<Props> = {
-  initialProps?: Props,
-  wrapper?: React.ComponentType<any>,
-};
-
 declare module '@testing-library/react-native' {
+  declare interface RenderResult extends Queries {
+    update(nextElement: React.Element<any>): void;
+    rerender(nextElement: React.Element<any>): void;
+    unmount(nextElement?: React.Element<any>): void;
+    toJSON(): ReactTestRendererJSON[] | ReactTestRendererJSON | null;
+    debug: Debug;
+    container: ReactTestInstance;
+  }
+
+  declare type RenderAPI = RenderResult;
+
+  declare interface RenderOptions {
+    wrapper?: React.ComponentType<any>;
+    createNodeMock?: (element: React.Element<any>) => any;
+  }
+
   declare export var render: (
     component: React.Element<any>,
     options?: RenderOptions
-  ) => RenderAPI;
+  ) => RenderResult;
 
-  declare export var screen: RenderAPI;
+  declare export var screen: RenderResult;
 
   declare export var cleanup: () => void;
   declare export var fireEvent: FireEventAPI;
@@ -369,6 +361,17 @@ declare module '@testing-library/react-native' {
     normalizerConfig?: NormalizerConfig
   ) => NormalizerFn;
 
+  declare type RenderHookResult<Result, Props> = {
+    rerender: (props: Props) => void,
+    result: { current: Result },
+    unmount: () => void,
+  };
+
+  declare type RenderHookOptions<Props> = {
+    initialProps?: Props,
+    wrapper?: React.ComponentType<any>,
+  };
+
   declare type RenderHookFunction = <Result, Props>(
     renderCallback: (props: Props) => Result,
     options?: RenderHookOptions<Props>