@testing-library/react - npm Package Compare versions

Comparing version 15.0.4 to 15.0.5

package.json

 {
   "name": "@testing-library/react",
-  "version": "15.0.4",
+  "version": "15.0.5",
   "description": "Simple and complete React DOM testing utilities that encourage good testing practices.",
@@ -59,4 +59,4 @@ "main": "dist/index.js",
     "npm-run-all": "^4.1.5",
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0",
+    "react": "^18.3.0",
+    "react-dom": "^18.3.0",
     "rimraf": "^3.0.2",
@@ -63,0 +63,0 @@ "typescript": "^4.1.2"

types/index.d.ts

@@ -28,4 +28,4 @@ // TypeScript Version: 3.8
   Q extends Queries = typeof queries,
-  Container extends Element | DocumentFragment = HTMLElement,
-  BaseElement extends Element | DocumentFragment = Container,
+  Container extends RendererableContainer | HydrateableContainer = HTMLElement,
+  BaseElement extends RendererableContainer | HydrateableContainer = Container,
 > = {
@@ -36,5 +36,5 @@ container: Container
     baseElement?:
-      | Element
-      | DocumentFragment
-      | Array<Element | DocumentFragment>,
+      | RendererableContainer
+      | HydrateableContainer
+      | Array<RendererableContainer | HydrateableContainer>,
     maxLength?: number,
@@ -48,6 +48,44 @@ options?: prettyFormat.OptionsReceived,
 
-export interface BaseRenderOptions<
+/** @deprecated */
+export type BaseRenderOptions<
   Q extends Queries,
   Container extends RendererableContainer | HydrateableContainer,
-  BaseElement extends Element | DocumentFragment,
+  BaseElement extends RendererableContainer | HydrateableContainer,
+> = RenderOptions<Q, Container, BaseElement>
+
+type RendererableContainer = ReactDOMClient.Container
+type HydrateableContainer = Parameters<typeof ReactDOMClient['hydrateRoot']>[0]
+/** @deprecated */
+export interface ClientRenderOptions<
+  Q extends Queries,
+  Container extends RendererableContainer,
+  BaseElement extends RendererableContainer = Container,
+> extends BaseRenderOptions<Q, Container, BaseElement> {
+  /**
+   * If `hydrate` is set to `true`, then it will render with `ReactDOM.hydrate`. This may be useful if you are using server-side
+   *  rendering and use ReactDOM.hydrate to mount your components.
+   *
+   *  @see https://testing-library.com/docs/react-testing-library/api/#hydrate)
+   */
+  hydrate?: false | undefined
+}
+/** @deprecated */
+export interface HydrateOptions<
+  Q extends Queries,
+  Container extends HydrateableContainer,
+  BaseElement extends HydrateableContainer = Container,
+> extends BaseRenderOptions<Q, Container, BaseElement> {
+  /**
+   * If `hydrate` is set to `true`, then it will render with `ReactDOM.hydrate`. This may be useful if you are using server-side
+   *  rendering and use ReactDOM.hydrate to mount your components.
+   *
+   *  @see https://testing-library.com/docs/react-testing-library/api/#hydrate)
+   */
+  hydrate: true
+}
+
+export interface RenderOptions<
+  Q extends Queries = typeof queries,
+  Container extends RendererableContainer | HydrateableContainer = HTMLElement,
+  BaseElement extends RendererableContainer | HydrateableContainer = Container,
 > {
@@ -99,40 +137,2 @@ /**
 
-type RendererableContainer = ReactDOMClient.Container
-type HydrateableContainer = Parameters<typeof ReactDOMClient['hydrateRoot']>[0]
-export interface ClientRenderOptions<
-  Q extends Queries,
-  Container extends Element | DocumentFragment,
-  BaseElement extends Element | DocumentFragment = Container,
-> extends BaseRenderOptions<Q, Container, BaseElement> {
-  /**
-   * If `hydrate` is set to `true`, then it will render with `ReactDOM.hydrate`. This may be useful if you are using server-side
-   *  rendering and use ReactDOM.hydrate to mount your components.
-   *
-   *  @see https://testing-library.com/docs/react-testing-library/api/#hydrate)
-   */
-  hydrate?: false | undefined
-}
-
-export interface HydrateOptions<
-  Q extends Queries,
-  Container extends Element | DocumentFragment,
-  BaseElement extends Element | DocumentFragment = Container,
-> extends BaseRenderOptions<Q, Container, BaseElement> {
-  /**
-   * If `hydrate` is set to `true`, then it will render with `ReactDOM.hydrate`. This may be useful if you are using server-side
-   *  rendering and use ReactDOM.hydrate to mount your components.
-   *
-   *  @see https://testing-library.com/docs/react-testing-library/api/#hydrate)
-   */
-  hydrate: true
-}
-
-export type RenderOptions<
-  Q extends Queries = typeof queries,
-  Container extends RendererableContainer | HydrateableContainer = HTMLElement,
-  BaseElement extends Element | DocumentFragment = Container,
-> =
-  | ClientRenderOptions<Q, Container, BaseElement>
-  | HydrateOptions<Q, Container, BaseElement>
-
 type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>
@@ -145,16 +145,8 @@
   Q extends Queries = typeof queries,
-  Container extends RendererableContainer = HTMLElement,
-  BaseElement extends Element | DocumentFragment = Container,
+  Container extends RendererableContainer | HydrateableContainer = HTMLElement,
+  BaseElement extends RendererableContainer | HydrateableContainer = Container,
 >(
   ui: React.ReactNode,
-  options: ClientRenderOptions<Q, Container, BaseElement>,
+  options: RenderOptions<Q, Container, BaseElement>,
 ): RenderResult<Q, Container, BaseElement>
-export function render<
-  Q extends Queries = typeof queries,
-  Container extends HydrateableContainer = HTMLElement,
-  BaseElement extends Element | DocumentFragment = Container,
->(
-  ui: React.ReactNode,
-  options: HydrateOptions<Q, Container, BaseElement>,
-): RenderResult<Q, Container, BaseElement>
 export function render(
@@ -187,3 +179,4 @@ ui: React.ReactNode,
 
-export interface BaseRenderHookOptions<
+/** @deprecated */
+export type BaseRenderHookOptions<
   Props,
@@ -193,10 +186,5 @@ Q extends Queries,
   BaseElement extends Element | DocumentFragment,
-> extends BaseRenderOptions<Q, Container, BaseElement> {
-  /**
-   * The argument passed to the renderHook callback. Can be useful if you plan
-   * to use the rerender utility to change the values passed to your hook.
-   */
-  initialProps?: Props
-}
+> = RenderHookOptions<Props, Q, Container, BaseElement>
 
+/** @deprecated */
 export interface ClientRenderHookOptions<
@@ -217,2 +205,3 @@ Props,
 
+/** @deprecated */
 export interface HydrateHookOptions<
@@ -233,10 +222,14 @@ Props,
 
-export type RenderHookOptions<
+export interface RenderHookOptions<
   Props,
   Q extends Queries = typeof queries,
-  Container extends Element | DocumentFragment = HTMLElement,
-  BaseElement extends Element | DocumentFragment = Container,
-> =
-  | ClientRenderHookOptions<Props, Q, Container, BaseElement>
-  | HydrateHookOptions<Props, Q, Container, BaseElement>
+  Container extends RendererableContainer | HydrateableContainer = HTMLElement,
+  BaseElement extends RendererableContainer | HydrateableContainer = Container,
+> extends BaseRenderOptions<Q, Container, BaseElement> {
+  /**
+   * The argument passed to the renderHook callback. Can be useful if you plan
+   * to use the rerender utility to change the values passed to your hook.
+   */
+  initialProps?: Props
+}
 
@@ -251,18 +244,8 @@ /**
   Q extends Queries = typeof queries,
-  Container extends RendererableContainer = HTMLElement,
-  BaseElement extends Element | DocumentFragment = Container,
+  Container extends RendererableContainer | HydrateableContainer = HTMLElement,
+  BaseElement extends RendererableContainer | HydrateableContainer = Container,
 >(
   render: (initialProps: Props) => Result,
-  options?: ClientRenderHookOptions<Props, Q, Container, BaseElement>,
+  options?: RenderHookOptions<Props, Q, Container, BaseElement>,
 ): RenderHookResult<Result, Props>
-export function renderHook<
-  Result,
-  Props,
-  Q extends Queries = typeof queries,
-  Container extends HydrateableContainer = HTMLElement,
-  BaseElement extends Element | DocumentFragment = Container,
->(
-  render: (initialProps: Props) => Result,
-  options?: HydrateHookOptions<Props, Q, Container, BaseElement>,
-): RenderHookResult<Result, Props>
 
@@ -269,0 +252,0 @@ /**

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

4302895

decreased by-0.01%

Lines of code

29228

decreased by-0.05%

No dependency changes