@types/react-dom 18.3.2 → 19.0.0

react-dom v18.3/README.md → react-dom/README.md

@@ -5,7 +5,7 @@
 This package contains type definitions for react-dom (https://reactjs.org).
 
 # Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-dom/v18.
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-dom.
 
 ### Additional Details
  * Last updated: Thu, 05 Dec 2024 19:32:25 GMT

react-dom/canary.d.ts

@@ -0,0 +1,32 @@
+/**
+ * These are types for things that are present in the upcoming React 18 release.
+ *
+ * Once React 18 is released they can just be moved to the main index file.
+ *
+ * To load the types declared here in an actual project, there are three ways. The easiest one,
+ * if your `tsconfig.json` already has a `"types"` array in the `"compilerOptions"` section,
+ * is to add `"react-dom/canary"` to the `"types"` array.
+ *
+ * Alternatively, a specific import syntax can to be used from a typescript file.
+ * This module does not exist in reality, which is why the {} is important:
+ *
+ * ```ts
+ * import {} from 'react-dom/canary'
+ * ```
+ *
+ * It is also possible to include it through a triple-slash reference:
+ *
+ * ```ts
+ * /// <reference types="react-dom/canary" />
+ * ```
+ *
+ * Either the import or the reference only needs to appear once, anywhere in the project.
+ */
+
+// See https://github.com/facebook/react/blob/main/packages/react-dom/index.js to see how the exports are declared,
+// but confirm with published source code (e.g. https://unpkg.com/react-dom@canary) that these exports end up in the published code
+
+import React = require("react");
+import ReactDOM = require(".");
+
+export {};

react-dom v18.3/client.d.ts → react-dom/client.d.ts

@@ -5,12 +5,33 @@
 // See https://github.com/facebook/react/blob/main/packages/react-dom/client.js to see how the exports are declared,
 
 import React = require("react");
+
+export {};
+
+declare const REACT_FORM_STATE_SIGIL: unique symbol;
+export interface ReactFormState {
+    [REACT_FORM_STATE_SIGIL]: never;
+}
+
 export interface HydrationOptions {
+    formState?: ReactFormState | null;
     /**
      * Prefix for `useId`.
      */
     identifierPrefix?: string;
+    onUncaughtError?:
+        | ((error: unknown, errorInfo: { componentStack?: string | undefined }) => void)
+        | undefined;
     onRecoverableError?: (error: unknown, errorInfo: ErrorInfo) => void;
+    onCaughtError?:
+        | ((
+            error: unknown,
+            errorInfo: {
+                componentStack?: string | undefined;
+                errorBoundary?: React.Component<unknown> | undefined;
+            },
+        ) => void)
+        | undefined;
 }
 
 export interface RootOptions {
@@ -18,11 +39,22 @@ export interface RootOptions {
      * Prefix for `useId`.
      */
     identifierPrefix?: string;
+    onUncaughtError?:
+        | ((error: unknown, errorInfo: { componentStack?: string | undefined }) => void)
+        | undefined;
     onRecoverableError?: (error: unknown, errorInfo: ErrorInfo) => void;
+    onCaughtError?:
+        | ((
+            error: unknown,
+            errorInfo: {
+                componentStack?: string | undefined;
+                errorBoundary?: React.Component<unknown> | undefined;
+            },
+        ) => void)
+        | undefined;
 }
 
 export interface ErrorInfo {
-    digest?: string;
     componentStack?: string;
 }
 
@@ -41,6 +73,7 @@ export interface DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_CREATE_ROOT_CONTAI
 export type Container =
     | Element
     | DocumentFragment
+    | Document
     | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_CREATE_ROOT_CONTAINERS[
         keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_CREATE_ROOT_CONTAINERS
     ];

react-dom/experimental.d.ts

@@ -0,0 +1,36 @@
+/**
+ * These are types for things that are present in the `experimental` builds of React but not yet
+ * on a stable build.
+ *
+ * Once they are promoted to stable they can just be moved to the main index file.
+ *
+ * To load the types declared here in an actual project, there are three ways. The easiest one,
+ * if your `tsconfig.json` already has a `"types"` array in the `"compilerOptions"` section,
+ * is to add `"react-dom/experimental"` to the `"types"` array.
+ *
+ * Alternatively, a specific import syntax can to be used from a typescript file.
+ * This module does not exist in reality, which is why the {} is important:
+ *
+ * ```ts
+ * import {} from 'react-dom/experimental'
+ * ```
+ *
+ * It is also possible to include it through a triple-slash reference:
+ *
+ * ```ts
+ * /// <reference types="react-dom/experimental" />
+ * ```
+ *
+ * Either the import or the reference only needs to appear once, anywhere in the project.
+ */
+
+// See https://github.com/facebook/react/blob/main/packages/react-dom/index.experimental.js to see how the exports are declared,
+// but confirm with published source code (e.g. https://unpkg.com/react-dom@experimental) that these exports end up in the published code
+
+import React = require("react");
+import ReactDOM = require("./canary");
+
+export {};
+
+declare module "." {
+}

react-dom/index.d.ts

@@ -0,0 +1,127 @@
+// NOTE: Users of the `experimental` builds of React should add a reference
+// to 'react-dom/experimental' in their project. See experimental.d.ts's top comment
+// for reference and documentation on how exactly to do it.
+
+export as namespace ReactDOM;
+
+import { Key, ReactNode, ReactPortal } from "react";
+
+export function createPortal(
+    children: ReactNode,
+    container: Element | DocumentFragment,
+    key?: Key | null,
+): ReactPortal;
+
+export const version: string;
+
+export function flushSync<R>(fn: () => R): R;
+
+export function unstable_batchedUpdates<A, R>(callback: (a: A) => R, a: A): R;
+export function unstable_batchedUpdates<R>(callback: () => R): R;
+
+export interface FormStatusNotPending {
+    pending: false;
+    data: null;
+    method: null;
+    action: null;
+}
+
+export interface FormStatusPending {
+    pending: true;
+    data: FormData;
+    method: string;
+    action: string | ((formData: FormData) => void | Promise<void>);
+}
+
+export type FormStatus = FormStatusPending | FormStatusNotPending;
+
+export function useFormStatus(): FormStatus;
+
+export function useFormState<State>(
+    action: (state: Awaited<State>) => State | Promise<State>,
+    initialState: Awaited<State>,
+    permalink?: string,
+): [state: Awaited<State>, dispatch: () => void, isPending: boolean];
+export function useFormState<State, Payload>(
+    action: (state: Awaited<State>, payload: Payload) => State | Promise<State>,
+    initialState: Awaited<State>,
+    permalink?: string,
+): [state: Awaited<State>, dispatch: (payload: Payload) => void, isPending: boolean];
+
+export function prefetchDNS(href: string): void;
+
+export interface PreconnectOptions {
+    // Don't create a helper type.
+    // It would have to be in module scope to be inlined in TS tooltips.
+    // But then it becomes part of the public API.
+    // TODO: Upstream to microsoft/TypeScript-DOM-lib-generator -> w3c/webref
+    // since the spec has a notion of a dedicated type: https://html.spec.whatwg.org/multipage/urls-and-fetching.html#cors-settings-attribute
+    crossOrigin?: "anonymous" | "use-credentials" | "" | undefined;
+}
+export function preconnect(href: string, options?: PreconnectOptions): void;
+
+export type PreloadAs =
+    | "audio"
+    | "document"
+    | "embed"
+    | "fetch"
+    | "font"
+    | "image"
+    | "object"
+    | "track"
+    | "script"
+    | "style"
+    | "video"
+    | "worker";
+export interface PreloadOptions {
+    as: PreloadAs;
+    crossOrigin?: "anonymous" | "use-credentials" | "" | undefined;
+    fetchPriority?: "high" | "low" | "auto" | undefined;
+    // TODO: These should only be allowed with `as: 'image'` but it's not trivial to write tests against the full TS support matrix.
+    imageSizes?: string | undefined;
+    imageSrcSet?: string | undefined;
+    integrity?: string | undefined;
+    type?: string | undefined;
+    nonce?: string | undefined;
+    referrerPolicy?: ReferrerPolicy | undefined;
+}
+export function preload(href: string, options?: PreloadOptions): void;
+
+// https://html.spec.whatwg.org/multipage/links.html#link-type-modulepreload
+export type PreloadModuleAs = RequestDestination;
+export interface PreloadModuleOptions {
+    /**
+     * @default "script"
+     */
+    as: PreloadModuleAs;
+    crossOrigin?: "anonymous" | "use-credentials" | "" | undefined;
+    integrity?: string | undefined;
+    nonce?: string | undefined;
+}
+export function preloadModule(href: string, options?: PreloadModuleOptions): void;
+
+export type PreinitAs = "script" | "style";
+export interface PreinitOptions {
+    as: PreinitAs;
+    crossOrigin?: "anonymous" | "use-credentials" | "" | undefined;
+    fetchPriority?: "high" | "low" | "auto" | undefined;
+    precedence?: string | undefined;
+    integrity?: string | undefined;
+    nonce?: string | undefined;
+}
+export function preinit(href: string, options?: PreinitOptions): void;
+
+// Will be expanded to include all of https://github.com/tc39/proposal-import-attributes
+export type PreinitModuleAs = "script";
+export interface PreinitModuleOptions {
+    /**
+     * @default "script"
+     */
+    as?: PreinitModuleAs;
+    crossOrigin?: "anonymous" | "use-credentials" | "" | undefined;
+    integrity?: string | undefined;
+    nonce?: string | undefined;
+}
+export function preinitModule(href: string, options?: PreinitModuleOptions): void;
+
+export function requestFormReset(form: HTMLFormElement): void;

react-dom v18.3/package.json → react-dom/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/react-dom",
-    "version": "18.3.2",
+    "version": "19.0.0",
     "description": "TypeScript definitions for react-dom",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-dom",
     "license": "MIT",
@@ -51,11 +51,21 @@
                 "default": "./client.d.ts"
             }
         },
+        "./canary": {
+            "types": {
+                "default": "./canary.d.ts"
+            }
+        },
         "./server": {
             "types": {
                 "default": "./server.d.ts"
             }
         },
+        "./experimental": {
+            "types": {
+                "default": "./experimental.d.ts"
+            }
+        },
         "./test-utils": {
             "types": {
                 "default": "./test-utils/index.d.ts"
@@ -70,9 +80,9 @@
     },
     "scripts": {},
     "dependencies": {
-        "@types/react": "^18"
+        "@types/react": "*"
     },
     "peerDependencies": {},
-    "typesPublisherContentHash": "8e184bd84487f6335f6c45860cd342168c33ed13ff6ed977390561f025c4346d",
+    "typesPublisherContentHash": "bfa192efe4d902904df093f5cf45f5bfb86784036b0a929810713bb9fbd1c78c",
     "typeScriptVersion": "5.0"
 }

react-dom v18.3/server.d.ts → react-dom/server.d.ts

@@ -69,15 +69,6 @@ export function renderToPipeableStream(children: ReactNode, options?: RenderToPi
  */
 export function renderToString(element: ReactNode, options?: ServerOptions): string;
 
-/**
- * Render a React element to its initial HTML. Returns a Readable stream that outputs
- * an HTML string. The HTML output by this stream is exactly equal to what
- * `ReactDOMServer.renderToString()` would return.
- *
- * @deprecated
- */
-export function renderToNodeStream(element: ReactNode, options?: ServerOptions): NodeJS.ReadableStream;
-
 /**
  * Similar to `renderToString`, except this doesn't create extra DOM attributes
  * such as `data-reactid`, that React uses internally. This is useful if you want
@@ -86,15 +77,6 @@ export function renderToNodeStream(element: ReactNode, options?: ServerOptions):
  */
 export function renderToStaticMarkup(element: ReactNode, options?: ServerOptions): string;
 
-/**
- * Similar to `renderToNodeStream`, except this doesn't create extra DOM attributes
- * such as `data-reactid`, that React uses internally. The HTML output by this stream
- * is exactly equal to what `ReactDOMServer.renderToStaticMarkup()` would return.
- *
- * @deprecated
- */
-export function renderToStaticNodeStream(element: ReactNode, options?: ServerOptions): NodeJS.ReadableStream;
-
 export interface RenderToReadableStreamOptions {
     identifierPrefix?: string;
     namespaceURI?: string;

react-dom/test-utils/index.d.ts

@@ -0,0 +1,7 @@
+export {};
+
+export {
+    /**
+     * @deprecated Import `act` from `react` instead.
+     */ act,
+} from "react";

react-dom v18.3/index.d.ts

@@ -1,150 +0,0 @@
-// NOTE: Users of the `experimental` builds of React should add a reference
-// to 'react-dom/experimental' in their project. See experimental.d.ts's top comment
-// for reference and documentation on how exactly to do it.
-
-export as namespace ReactDOM;
-
-import {
-    CElement,
-    Component,
-    ComponentState,
-    DOMAttributes,
-    DOMElement,
-    FunctionComponentElement,
-    Key,
-    ReactElement,
-    ReactInstance,
-    ReactNode,
-    ReactPortal,
-} from "react";
-
-/**
- * @deprecated See https://react.dev/reference/react-dom/findDOMNode#alternatives
- */
-export function findDOMNode(instance: ReactInstance | null | undefined): Element | null | Text;
-/**
- * @deprecated See https://react.dev/blog/2022/03/08/react-18-upgrade-guide#updates-to-client-rendering-apis
- */
-export function unmountComponentAtNode(container: Element | DocumentFragment): boolean;
-
-export function createPortal(
-    children: ReactNode,
-    container: Element | DocumentFragment,
-    key?: Key | null,
-): ReactPortal;
-
-export const version: string;
-/**
- * @deprecated See https://react.dev/blog/2022/03/08/react-18-upgrade-guide#updates-to-client-rendering-apis
- */
-export const render: Renderer;
-/**
- * @deprecated See https://react.dev/blog/2022/03/08/react-18-upgrade-guide#updates-to-client-rendering-apis
- */
-export const hydrate: Renderer;
-
-export function flushSync<R>(fn: () => R): R;
-
-export function unstable_batchedUpdates<A, R>(callback: (a: A) => R, a: A): R;
-export function unstable_batchedUpdates<R>(callback: () => R): R;
-
-/**
- * @deprecated
- */
-export function unstable_renderSubtreeIntoContainer<T extends Element>(
-    parentComponent: Component<any>,
-    element: DOMElement<DOMAttributes<T>, T>,
-    container: Element,
-    callback?: (element: T) => any,
-): T;
-/**
- * @deprecated
- */
-export function unstable_renderSubtreeIntoContainer<P, T extends Component<P, ComponentState>>(
-    parentComponent: Component<any>,
-    element: CElement<P, T>,
-    container: Element,
-    callback?: (component: T) => any,
-): T;
-/**
- * @deprecated
- */
-export function unstable_renderSubtreeIntoContainer<P>(
-    parentComponent: Component<any>,
-    element: ReactElement<P>,
-    container: Element,
-    callback?: (component?: Component<P, ComponentState> | Element) => any,
-    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-): Component<P, ComponentState> | Element | void;
-
-export type Container = Element | Document | DocumentFragment;
-
-export interface Renderer {
-    // Deprecated(render): The return value is deprecated.
-    // In future releases the render function's return type will be void.
-
-    /**
-     * @deprecated See https://react.dev/blog/2022/03/08/react-18-upgrade-guide#updates-to-client-rendering-apis
-     */
-    <T extends Element>(
-        element: DOMElement<DOMAttributes<T>, T>,
-        container: Container | null,
-        callback?: () => void,
-    ): T;
-
-    /**
-     * @deprecated See https://react.dev/blog/2022/03/08/react-18-upgrade-guide#updates-to-client-rendering-apis
-     */
-    (
-        element: Array<DOMElement<DOMAttributes<any>, any>>,
-        container: Container | null,
-        callback?: () => void,
-    ): Element;
-
-    /**
-     * @deprecated See https://react.dev/blog/2022/03/08/react-18-upgrade-guide#updates-to-client-rendering-apis
-     */
-    (
-        element: FunctionComponentElement<any> | Array<FunctionComponentElement<any>>,
-        container: Container | null,
-        callback?: () => void,
-    ): void;
-
-    /**
-     * @deprecated See https://react.dev/blog/2022/03/08/react-18-upgrade-guide#updates-to-client-rendering-apis
-     */
-    <P, T extends Component<P, ComponentState>>(
-        element: CElement<P, T>,
-        container: Container | null,
-        callback?: () => void,
-    ): T;
-
-    /**
-     * @deprecated See https://react.dev/blog/2022/03/08/react-18-upgrade-guide#updates-to-client-rendering-apis
-     */
-    (
-        element: Array<CElement<any, Component<any, ComponentState>>>,
-        container: Container | null,
-        callback?: () => void,
-    ): Component<any, ComponentState>;
-
-    /**
-     * @deprecated See https://react.dev/blog/2022/03/08/react-18-upgrade-guide#updates-to-client-rendering-apis
-     */
-    <P>(
-        element: ReactElement<P>,
-        container: Container | null,
-        callback?: () => void,
-        // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-    ): Component<P, ComponentState> | Element | void;
-
-    /**
-     * @deprecated See https://react.dev/blog/2022/03/08/react-18-upgrade-guide#updates-to-client-rendering-apis
-     */
-    (
-        element: ReactElement[],
-        container: Container | null,
-        callback?: () => void,
-        // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-    ): Component<any, ComponentState> | Element | void;
-}

react-dom v18.3/test-utils/index.d.ts

@@ -1,402 +0,0 @@
-import {
-    AbstractView,
-    CElement,
-    ClassType,
-    Component,
-    ComponentClass,
-    DOMAttributes,
-    DOMElement,
-    FC,
-    FunctionComponentElement,
-    ReactElement,
-    ReactHTMLElement,
-    ReactInstance,
-} from "react";
-
-import * as ReactTestUtils from ".";
-
-export {};
-
-export interface OptionalEventProperties {
-    bubbles?: boolean | undefined;
-    cancelable?: boolean | undefined;
-    currentTarget?: EventTarget | undefined;
-    defaultPrevented?: boolean | undefined;
-    eventPhase?: number | undefined;
-    isTrusted?: boolean | undefined;
-    nativeEvent?: Event | undefined;
-    preventDefault?(): void;
-    stopPropagation?(): void;
-    target?: EventTarget | undefined;
-    timeStamp?: Date | undefined;
-    type?: string | undefined;
-}
-
-export type ModifierKey =
-    | "Alt"
-    | "AltGraph"
-    | "CapsLock"
-    | "Control"
-    | "Fn"
-    | "FnLock"
-    | "Hyper"
-    | "Meta"
-    | "NumLock"
-    | "ScrollLock"
-    | "Shift"
-    | "Super"
-    | "Symbol"
-    | "SymbolLock";
-
-export interface SyntheticEventData extends OptionalEventProperties {
-    altKey?: boolean | undefined;
-    button?: number | undefined;
-    buttons?: number | undefined;
-    clientX?: number | undefined;
-    clientY?: number | undefined;
-    changedTouches?: TouchList | undefined;
-    charCode?: number | undefined;
-    clipboardData?: DataTransfer | undefined;
-    ctrlKey?: boolean | undefined;
-    deltaMode?: number | undefined;
-    deltaX?: number | undefined;
-    deltaY?: number | undefined;
-    deltaZ?: number | undefined;
-    detail?: number | undefined;
-    getModifierState?(key: ModifierKey): boolean;
-    key?: string | undefined;
-    keyCode?: number | undefined;
-    locale?: string | undefined;
-    location?: number | undefined;
-    metaKey?: boolean | undefined;
-    pageX?: number | undefined;
-    pageY?: number | undefined;
-    relatedTarget?: EventTarget | undefined;
-    repeat?: boolean | undefined;
-    screenX?: number | undefined;
-    screenY?: number | undefined;
-    shiftKey?: boolean | undefined;
-    targetTouches?: TouchList | undefined;
-    touches?: TouchList | undefined;
-    view?: AbstractView | undefined;
-    which?: number | undefined;
-}
-
-export type EventSimulator = (element: Element | Component<any>, eventData?: SyntheticEventData) => void;
-
-export interface MockedComponentClass {
-    new(props: any): any;
-}
-
-export interface ShallowRenderer {
-    /**
-     * After `shallowRenderer.render()` has been called, returns shallowly rendered output.
-     */
-    getRenderOutput<E extends ReactElement>(): E;
-    /**
-     * Similar to `ReactDOM.render` but it doesn't require DOM and only renders a single level deep.
-     */
-    render(element: ReactElement, context?: any): void;
-    unmount(): void;
-}
-
-/**
- * Simulate an event dispatch on a DOM node with optional `eventData` event data.
- * `Simulate` has a method for every event that React understands.
- */
-export namespace Simulate {
-    const abort: EventSimulator;
-    const animationEnd: EventSimulator;
-    const animationIteration: EventSimulator;
-    const animationStart: EventSimulator;
-    const blur: EventSimulator;
-    const cancel: EventSimulator;
-    const canPlay: EventSimulator;
-    const canPlayThrough: EventSimulator;
-    const change: EventSimulator;
-    const click: EventSimulator;
-    const close: EventSimulator;
-    const compositionEnd: EventSimulator;
-    const compositionStart: EventSimulator;
-    const compositionUpdate: EventSimulator;
-    const contextMenu: EventSimulator;
-    const copy: EventSimulator;
-    const cut: EventSimulator;
-    const auxClick: EventSimulator;
-    const doubleClick: EventSimulator;
-    const drag: EventSimulator;
-    const dragEnd: EventSimulator;
-    const dragEnter: EventSimulator;
-    const dragExit: EventSimulator;
-    const dragLeave: EventSimulator;
-    const dragOver: EventSimulator;
-    const dragStart: EventSimulator;
-    const drop: EventSimulator;
-    const durationChange: EventSimulator;
-    const emptied: EventSimulator;
-    const encrypted: EventSimulator;
-    const ended: EventSimulator;
-    const error: EventSimulator;
-    const focus: EventSimulator;
-    const input: EventSimulator;
-    const invalid: EventSimulator;
-    const keyDown: EventSimulator;
-    const keyPress: EventSimulator;
-    const keyUp: EventSimulator;
-    const load: EventSimulator;
-    const loadStart: EventSimulator;
-    const loadedData: EventSimulator;
-    const loadedMetadata: EventSimulator;
-    const mouseDown: EventSimulator;
-    const mouseEnter: EventSimulator;
-    const mouseLeave: EventSimulator;
-    const mouseMove: EventSimulator;
-    const mouseOut: EventSimulator;
-    const mouseOver: EventSimulator;
-    const mouseUp: EventSimulator;
-    const paste: EventSimulator;
-    const pause: EventSimulator;
-    const play: EventSimulator;
-    const playing: EventSimulator;
-    const progress: EventSimulator;
-    const pointerCancel: EventSimulator;
-    const pointerDown: EventSimulator;
-    const pointerUp: EventSimulator;
-    const pointerMove: EventSimulator;
-    const pointerOut: EventSimulator;
-    const pointerOver: EventSimulator;
-    const pointerEnter: EventSimulator;
-    const pointerLeave: EventSimulator;
-    const gotPointerCapture: EventSimulator;
-    const lostPointerCapture: EventSimulator;
-    const rateChange: EventSimulator;
-    const reset: EventSimulator;
-    const resize: EventSimulator;
-    const scroll: EventSimulator;
-    const toggle: EventSimulator;
-    const seeked: EventSimulator;
-    const seeking: EventSimulator;
-    const select: EventSimulator;
-    const beforeInput: EventSimulator;
-    const stalled: EventSimulator;
-    const submit: EventSimulator;
-    const suspend: EventSimulator;
-    const timeUpdate: EventSimulator;
-    const touchCancel: EventSimulator;
-    const touchEnd: EventSimulator;
-    const touchMove: EventSimulator;
-    const touchStart: EventSimulator;
-    const transitionEnd: EventSimulator;
-    const volumeChange: EventSimulator;
-    const waiting: EventSimulator;
-    const wheel: EventSimulator;
-}
-
-/**
- * Render a React element into a detached DOM node in the document. __This function requires a DOM__.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function renderIntoDocument<T extends Element>(
-    element: DOMElement<any, T>,
-): T;
-/** @deprecated https://react.dev/warnings/react-dom-test-utils */
-export function renderIntoDocument(
-    element: FunctionComponentElement<any>,
-): void;
-// If we replace `P` with `any` in this overload, then some tests fail because
-// calls to `renderIntoDocument` choose the last overload on the
-// subtype-relation pass and get an undesirably broad return type.  Using `P`
-// allows this overload to match on the subtype-relation pass.
-/**
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function renderIntoDocument<P, T extends Component<P>>(
-    element: CElement<P, T>,
-): T;
-/**
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function renderIntoDocument<P>(
-    element: ReactElement<P>,
-): Component<P> | Element | void;
-
-/**
- * Pass a mocked component module to this method to augment it with useful methods that allow it to
- * be used as a dummy React component. Instead of rendering as usual, the component will become
- * a simple `<div>` (or other tag if `mockTagName` is provided) containing any provided children.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function mockComponent(
-    mocked: MockedComponentClass,
-    mockTagName?: string,
-): typeof ReactTestUtils;
-
-/**
- * Returns `true` if `element` is any React element.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function isElement(element: any): boolean;
-
-/**
- * Returns `true` if `element` is a React element whose type is of a React `componentClass`.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function isElementOfType<T extends HTMLElement>(
-    element: ReactElement,
-    type: string,
-): element is ReactHTMLElement<T>;
-/**
- * Returns `true` if `element` is a React element whose type is of a React `componentClass`.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function isElementOfType<P extends DOMAttributes<{}>, T extends Element>(
-    element: ReactElement,
-    type: string,
-): element is DOMElement<P, T>;
-/**
- * Returns `true` if `element` is a React element whose type is of a React `componentClass`.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function isElementOfType<P>(
-    element: ReactElement,
-    type: FC<P>,
-): element is FunctionComponentElement<P>;
-/**
- * Returns `true` if `element` is a React element whose type is of a React `componentClass`.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function isElementOfType<P, T extends Component<P>, C extends ComponentClass<P>>(
-    element: ReactElement,
-    type: ClassType<P, T, C>,
-): element is CElement<P, T>;
-
-/**
- * Returns `true` if `instance` is a DOM component (such as a `<div>` or `<span>`).
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function isDOMComponent(instance: ReactInstance): instance is Element;
-/**
- * Returns `true` if `instance` is a user-defined component, such as a class or a function.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function isCompositeComponent(instance: ReactInstance): instance is Component<any>;
-/**
- * Returns `true` if `instance` is a component whose type is of a React `componentClass`.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function isCompositeComponentWithType<T extends Component<any>, C extends ComponentClass<any>>(
-    instance: ReactInstance,
-    type: ClassType<any, T, C>,
-): boolean;
-
-/**
- * Traverse all components in `tree` and accumulate all components where
- * `test(component)` is `true`. This is not that useful on its own, but it's used
- * as a primitive for other test utils.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function findAllInRenderedTree(
-    root: Component<any>,
-    fn: (i: ReactInstance) => boolean,
-): ReactInstance[];
-
-/**
- * Finds all DOM elements of components in the rendered tree that are
- * DOM components with the class name matching `className`.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function scryRenderedDOMComponentsWithClass(
-    root: Component<any>,
-    className: string,
-): Element[];
-/**
- * Like `scryRenderedDOMComponentsWithClass()` but expects there to be one result,
- * and returns that one result, or throws exception if there is any other
- * number of matches besides one.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function findRenderedDOMComponentWithClass(
-    root: Component<any>,
-    className: string,
-): Element;
-
-/**
- * Finds all DOM elements of components in the rendered tree that are
- * DOM components with the tag name matching `tagName`.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function scryRenderedDOMComponentsWithTag(
-    root: Component<any>,
-    tagName: string,
-): Element[];
-/**
- * Like `scryRenderedDOMComponentsWithTag()` but expects there to be one result,
- * and returns that one result, or throws exception if there is any other
- * number of matches besides one.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function findRenderedDOMComponentWithTag(
-    root: Component<any>,
-    tagName: string,
-): Element;
-
-/**
- * Finds all instances of components with type equal to `componentClass`.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function scryRenderedComponentsWithType<T extends Component<any>, C extends ComponentClass<any>>(
-    root: Component<any>,
-    type: ClassType<any, T, C>,
-): T[];
-
-/**
- * Same as `scryRenderedComponentsWithType()` but expects there to be one result
- * and returns that one result, or throws exception if there is any other
- * number of matches besides one.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function findRenderedComponentWithType<T extends Component<any>, C extends ComponentClass<any>>(
-    root: Component<any>,
-    type: ClassType<any, T, C>,
-): T;
-
-/**
- * Call this in your tests to create a shallow renderer.
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function createRenderer(): ShallowRenderer;
-
-// NOTES
-// - the order of these signatures matters - typescript will check the signatures in source order.
-//   If the `() => VoidOrUndefinedOnly` signature is first, it'll erroneously match a Promise returning function for users with
-//   `strictNullChecks: false`.
-// - VoidOrUndefinedOnly is there to forbid any non-void return values for users with `strictNullChecks: true`
-declare const UNDEFINED_VOID_ONLY: unique symbol;
-// eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-type VoidOrUndefinedOnly = void | { [UNDEFINED_VOID_ONLY]: never };
-/**
- * Wrap any code rendering and triggering updates to your components into `act()` calls.
- *
- * Ensures that the behavior in your tests matches what happens in the browser
- * more closely by executing pending `useEffect`s before returning. This also
- * reduces the amount of re-renders done.
- *
- * @param callback A synchronous, void callback that will execute as a single, complete React commit.
- *
- * @see https://reactjs.org/blog/2019/02/06/react-v16.8.0.html#testing-hooks
- *
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-// While act does always return Thenable, if a void function is passed, we pretend the return value is also void to not trigger dangling Promise lint rules.
-export function act(callback: () => VoidOrUndefinedOnly): void;
-/**
- * @deprecated https://react.dev/warnings/react-dom-test-utils
- */
-export function act<T>(callback: () => T | Promise<T>): Promise<T>;
-
-// Intentionally doesn't extend PromiseLike<never>.
-// Ideally this should be as hard to accidentally use as possible.
-export interface DebugPromiseLike {
-    // the actual then() in here is 0-ary, but that doesn't count as a PromiseLike.
-    then(onfulfilled: (value: never) => never, onrejected: (reason: never) => never): never;
-}