rerender-lens 0.2.0 → 0.3.0

package/dist/devtools-BHGUUo-p.d.ts

@@ -0,0 +1,244 @@
+import { N as Notifier, O as Options } from './types-BzUEVkxJ.js';
+
+/**
+ * Fiber-tree inspection. Runs after every React commit via the DevTools global
+ * hook, exactly like React DevTools itself. Element types are never touched, so
+ * Fast Refresh, memo comparators and component identity all stay intact.
+ */
+
+interface ContextDependency {
+    context: {
+        displayName?: string;
+        _currentValue?: unknown;
+    };
+    memoizedValue: unknown;
+    next: ContextDependency | null;
+}
+interface Fiber {
+    tag: number;
+    key: unknown;
+    type: unknown;
+    elementType: unknown;
+    stateNode: unknown;
+    memoizedProps: Record<string, unknown> | null;
+    memoizedState: unknown;
+    alternate: Fiber | null;
+    child: Fiber | null;
+    sibling: Fiber | null;
+    return: Fiber | null;
+    flags?: number;
+    /** React 16 name for `flags`. */
+    effectTag?: number;
+    dependencies?: {
+        firstContext: ContextDependency | null;
+    } | null;
+    _debugOwner?: {
+        type?: unknown;
+        name?: string;
+    } | null;
+    _debugHookTypes?: string[] | null;
+    /** React <= 18 with the JSX dev transform. */
+    _debugSource?: {
+        fileName?: string;
+        lineNumber?: number;
+        columnNumber?: number;
+    } | null;
+    /** React 19: an Error captured where the element was created. */
+    _debugStack?: {
+        stack?: string;
+    } | string | null;
+    actualDuration?: number;
+}
+interface FiberRoot {
+    current: Fiber;
+    /** Dev builds with a DevTools hook present: fibers that scheduled the update being committed. */
+    memoizedUpdaters?: Set<Fiber>;
+}
+/** What `react-dom` passes to `hook.inject`. */
+interface RendererInfo {
+    version?: string;
+    /** 1 = development build, 0 = production build. */
+    bundleType?: number;
+    rendererPackageName?: string;
+}
+interface DevtoolsHook {
+    renderers: Map<number, unknown>;
+    supportsFiber: boolean;
+    inject(renderer: unknown): number;
+    onCommitFiberRoot?: (id: number, root: FiberRoot, priority?: unknown, didError?: boolean) => void;
+    onCommitFiberUnmount?: (id: number, fiber: Fiber) => void;
+    onScheduleFiberRoot?: (id: number, root: FiberRoot, children: unknown) => void;
+    onPostCommitFiberRoot?: (id: number, root: FiberRoot) => void;
+    isDisabled?: boolean;
+}
+/**
+ * Make sure `window.__REACT_DEVTOOLS_GLOBAL_HOOK__` exists. React DOM only looks
+ * for it once, when the `react-dom` module is evaluated, so this must run before
+ * that unless the React DevTools extension or Fast Refresh already created it.
+ */
+declare function ensureDevtoolsHook(): DevtoolsHook;
+/** The renderers React registered on the hook (version and dev/prod bundle type). */
+declare function getRenderers(): RendererInfo[];
+/** True when every registered React renderer is a production build (names minified, no hook labels). */
+declare function isProductionReact(): boolean;
+
+declare const DEVTOOLS_MARKER: "__rerenderLens";
+/** Bumped when the message shape or bridge API changes in a way the panel must know about. */
+declare const PROTOCOL_VERSION = 2;
+interface DevtoolsMessage {
+    [DEVTOOLS_MARKER]: true;
+    version: number;
+    type: 'report' | 'clear' | 'hello';
+    payload?: unknown;
+}
+/** Payload of a `hello` message. */
+interface HelloPayload {
+    /** Buffered reports available for `replay()` / `pull()`. */
+    count: number;
+    /** Library version. */
+    library: string;
+    protocol: number;
+    react: RendererInfo[];
+    /** True when every React renderer on the page is a production build. */
+    production: boolean;
+    enabled: boolean;
+    options: SerializableOptions;
+    /** Who created this bridge: the page's own `init` call, or the extension's injected copy. */
+    source: 'page' | 'extension';
+    /** True when the extension injected a copy of the library into this page (whether or not it is the active one). */
+    injected: boolean;
+    /** Roots React scheduled (dev builds) and commits observed since `init`; the gap is work that never committed. */
+    scheduled: number;
+    commits: number;
+    /** The library's own cost: total and worst-case time spent inspecting commits, in ms. */
+    overhead: {
+        totalMs: number;
+        maxCommitMs: number;
+    };
+}
+/** Command sent by a panel over the BroadcastChannel; answered with a `ChannelReply` of the same id. */
+interface ChannelCommand {
+    __rerenderLensCmd: true;
+    id: string;
+    cmd: 'info' | 'pull' | 'replay' | 'clear' | 'configure' | 'highlight' | 'flash';
+    arg?: unknown;
+}
+interface ChannelReply {
+    __rerenderLensReply: true;
+    id: string;
+    result?: unknown;
+    error?: string;
+}
+/** Default channel name for `createDevtoolsNotifier({ channel: true })` and the panel served by the Vite plugin. */
+declare const DEFAULT_CHANNEL = "rerender-lens";
+declare global {
+    interface Window {
+        /** Set by the extension's inject script: version of the injected library. */
+        __RERENDER_LENS_INJECTED__?: string;
+        /** Relay URL (`npx rerender-lens panel`) picked up by `createDevtoolsNotifier` when no `relay` option is given. */
+        __RERENDER_LENS_RELAY__?: string;
+    }
+}
+/** `Options` with matchers as strings (`"Name"` or `"/regex/flags"`) and no functions. */
+interface SerializableOptions {
+    trackAllMemoized?: boolean;
+    trackAllComponents?: boolean;
+    include?: string[];
+    exclude?: string[];
+    trackHooks?: boolean;
+    includeState?: boolean;
+    resolveHookNames?: boolean;
+    logAll?: boolean;
+    silent?: boolean;
+    collapse?: boolean;
+    ignoreHotReload?: boolean;
+    maxReportsPerComponent?: number;
+}
+interface DevtoolsNotifierOptions {
+    /** How many reports to keep for `replay()`. Default 300. */
+    bufferSize?: number;
+    /** Where to post. Default `window`. */
+    target?: Pick<Window, 'postMessage'>;
+    /** Max serialization depth. Default 6. */
+    maxDepth?: number;
+    /** Flash the DOM of components that re-rendered avoidably. Default false; toggle later with `flashAvoidable`. */
+    flashAvoidable?: boolean;
+    /** Reported in `info()`. The extension's inject script passes `'extension'`. Default `'page'`. */
+    source?: 'page' | 'extension';
+    /**
+     * Also publish on a `BroadcastChannel`, so a panel in another same-origin tab (the one the Vite plugin
+     * serves at `/__rerender-lens/`) receives reports and can send commands. `true` uses `DEFAULT_CHANNEL`.
+     * Off by default.
+     */
+    channel?: boolean | string;
+    /**
+     * Forward everything to a relay started with `npx rerender-lens panel` (its URL), so the panel works for
+     * any app on any origin. Also read from `window.__RERENDER_LENS_RELAY__` when set before the app loads.
+     */
+    relay?: string;
+    /** `EventSource` implementation for the relay (tests, Node). Default: the global one. */
+    eventSource?: EventSourceCtor;
+}
+/** The subset of `EventSource` the relay client needs. */
+interface EventSourceLike {
+    onmessage: ((event: {
+        data: string;
+    }) => void) | null;
+    onerror: ((event: unknown) => void) | null;
+    close(): void;
+}
+type EventSourceCtor = new (url: string) => EventSourceLike;
+interface InspectResult {
+    component: string;
+    instanceId: number | null;
+    tracked: boolean;
+    path: string[];
+    /** Serialized reports for this instance, oldest first. */
+    reports: unknown[];
+}
+interface PullResult {
+    /** Sequence number of the newest report included; pass it back as `since`. */
+    seq: number;
+    reports: unknown[];
+    /** True when the caller missed reports that fell out of the buffer. */
+    dropped: boolean;
+}
+interface DevtoolsBridge {
+    /** Re-post every buffered report (a panel that opened late calls this). */
+    replay(): void;
+    clear(): void;
+    readonly size: number;
+    readonly version: number;
+    /** Library version. */
+    readonly library: string;
+    /** Everything the panel shows in its status line. */
+    info(): HelloPayload;
+    /** Reports newer than `since`. Lets a panel poll without any content script. */
+    pull(since?: number): PullResult;
+    /** Merge options at runtime; matchers are strings (`"/^Grid/"` becomes a RegExp). */
+    configure(options: SerializableOptions): SerializableOptions;
+    getOptions(): SerializableOptions;
+    /** Outline the DOM of an instance in the page; `null` clears. */
+    highlight(instanceId: number | null): boolean;
+    /** Turn the avoidable-render flash on or off. */
+    flashAvoidable(on: boolean): void;
+    /** Re-render details for a DOM node (DevTools' `$0`). */
+    inspect(node: unknown): InspectResult | null;
+}
+declare global {
+    interface Window {
+        __RERENDER_LENS_DEVTOOLS__?: DevtoolsBridge;
+    }
+}
+/** Convert a report into a structured-clone-safe value (functions, elements, cycles removed). */
+declare function serialize(value: unknown, maxDepth?: number, seen?: WeakSet<object>, depth?: number): unknown;
+/** The current options in a JSON-safe form (function matchers and custom consoles are dropped). */
+declare function serializeOptions(o: Options): SerializableOptions;
+declare function deserializeOptions(o: SerializableOptions): Options;
+/**
+ * A notifier that posts every report on `window` for a DevTools extension to pick up.
+ * Also installs `window.__RERENDER_LENS_DEVTOOLS__` with `replay()` / `clear()` / `pull()` and friends.
+ */
+declare function createDevtoolsNotifier(options?: DevtoolsNotifierOptions): Notifier;
+
+export { type ChannelCommand as C, DEFAULT_CHANNEL as D, type Fiber as F, type HelloPayload as H, type InspectResult as I, PROTOCOL_VERSION as P, type RendererInfo as R, type SerializableOptions as S, type ChannelReply as a, DEVTOOLS_MARKER as b, type DevtoolsBridge as c, type DevtoolsMessage as d, type DevtoolsNotifierOptions as e, type PullResult as f, createDevtoolsNotifier as g, deserializeOptions as h, ensureDevtoolsHook as i, getRenderers as j, isProductionReact as k, serializeOptions as l, serialize as s };

package/dist/devtools-DmhWiWcN.d.cts

@@ -0,0 +1,244 @@
+import { N as Notifier, O as Options } from './types-BzUEVkxJ.cjs';
+
+/**
+ * Fiber-tree inspection. Runs after every React commit via the DevTools global
+ * hook, exactly like React DevTools itself. Element types are never touched, so
+ * Fast Refresh, memo comparators and component identity all stay intact.
+ */
+
+interface ContextDependency {
+    context: {
+        displayName?: string;
+        _currentValue?: unknown;
+    };
+    memoizedValue: unknown;
+    next: ContextDependency | null;
+}
+interface Fiber {
+    tag: number;
+    key: unknown;
+    type: unknown;
+    elementType: unknown;
+    stateNode: unknown;
+    memoizedProps: Record<string, unknown> | null;
+    memoizedState: unknown;
+    alternate: Fiber | null;
+    child: Fiber | null;
+    sibling: Fiber | null;
+    return: Fiber | null;
+    flags?: number;
+    /** React 16 name for `flags`. */
+    effectTag?: number;
+    dependencies?: {
+        firstContext: ContextDependency | null;
+    } | null;
+    _debugOwner?: {
+        type?: unknown;
+        name?: string;
+    } | null;
+    _debugHookTypes?: string[] | null;
+    /** React <= 18 with the JSX dev transform. */
+    _debugSource?: {
+        fileName?: string;
+        lineNumber?: number;
+        columnNumber?: number;
+    } | null;
+    /** React 19: an Error captured where the element was created. */
+    _debugStack?: {
+        stack?: string;
+    } | string | null;
+    actualDuration?: number;
+}
+interface FiberRoot {
+    current: Fiber;
+    /** Dev builds with a DevTools hook present: fibers that scheduled the update being committed. */
+    memoizedUpdaters?: Set<Fiber>;
+}
+/** What `react-dom` passes to `hook.inject`. */
+interface RendererInfo {
+    version?: string;
+    /** 1 = development build, 0 = production build. */
+    bundleType?: number;
+    rendererPackageName?: string;
+}
+interface DevtoolsHook {
+    renderers: Map<number, unknown>;
+    supportsFiber: boolean;
+    inject(renderer: unknown): number;
+    onCommitFiberRoot?: (id: number, root: FiberRoot, priority?: unknown, didError?: boolean) => void;
+    onCommitFiberUnmount?: (id: number, fiber: Fiber) => void;
+    onScheduleFiberRoot?: (id: number, root: FiberRoot, children: unknown) => void;
+    onPostCommitFiberRoot?: (id: number, root: FiberRoot) => void;
+    isDisabled?: boolean;
+}
+/**
+ * Make sure `window.__REACT_DEVTOOLS_GLOBAL_HOOK__` exists. React DOM only looks
+ * for it once, when the `react-dom` module is evaluated, so this must run before
+ * that unless the React DevTools extension or Fast Refresh already created it.
+ */
+declare function ensureDevtoolsHook(): DevtoolsHook;
+/** The renderers React registered on the hook (version and dev/prod bundle type). */
+declare function getRenderers(): RendererInfo[];
+/** True when every registered React renderer is a production build (names minified, no hook labels). */
+declare function isProductionReact(): boolean;
+
+declare const DEVTOOLS_MARKER: "__rerenderLens";
+/** Bumped when the message shape or bridge API changes in a way the panel must know about. */
+declare const PROTOCOL_VERSION = 2;
+interface DevtoolsMessage {
+    [DEVTOOLS_MARKER]: true;
+    version: number;
+    type: 'report' | 'clear' | 'hello';
+    payload?: unknown;
+}
+/** Payload of a `hello` message. */
+interface HelloPayload {
+    /** Buffered reports available for `replay()` / `pull()`. */
+    count: number;
+    /** Library version. */
+    library: string;
+    protocol: number;
+    react: RendererInfo[];
+    /** True when every React renderer on the page is a production build. */
+    production: boolean;
+    enabled: boolean;
+    options: SerializableOptions;
+    /** Who created this bridge: the page's own `init` call, or the extension's injected copy. */
+    source: 'page' | 'extension';
+    /** True when the extension injected a copy of the library into this page (whether or not it is the active one). */
+    injected: boolean;
+    /** Roots React scheduled (dev builds) and commits observed since `init`; the gap is work that never committed. */
+    scheduled: number;
+    commits: number;
+    /** The library's own cost: total and worst-case time spent inspecting commits, in ms. */
+    overhead: {
+        totalMs: number;
+        maxCommitMs: number;
+    };
+}
+/** Command sent by a panel over the BroadcastChannel; answered with a `ChannelReply` of the same id. */
+interface ChannelCommand {
+    __rerenderLensCmd: true;
+    id: string;
+    cmd: 'info' | 'pull' | 'replay' | 'clear' | 'configure' | 'highlight' | 'flash';
+    arg?: unknown;
+}
+interface ChannelReply {
+    __rerenderLensReply: true;
+    id: string;
+    result?: unknown;
+    error?: string;
+}
+/** Default channel name for `createDevtoolsNotifier({ channel: true })` and the panel served by the Vite plugin. */
+declare const DEFAULT_CHANNEL = "rerender-lens";
+declare global {
+    interface Window {
+        /** Set by the extension's inject script: version of the injected library. */
+        __RERENDER_LENS_INJECTED__?: string;
+        /** Relay URL (`npx rerender-lens panel`) picked up by `createDevtoolsNotifier` when no `relay` option is given. */
+        __RERENDER_LENS_RELAY__?: string;
+    }
+}
+/** `Options` with matchers as strings (`"Name"` or `"/regex/flags"`) and no functions. */
+interface SerializableOptions {
+    trackAllMemoized?: boolean;
+    trackAllComponents?: boolean;
+    include?: string[];
+    exclude?: string[];
+    trackHooks?: boolean;
+    includeState?: boolean;
+    resolveHookNames?: boolean;
+    logAll?: boolean;
+    silent?: boolean;
+    collapse?: boolean;
+    ignoreHotReload?: boolean;
+    maxReportsPerComponent?: number;
+}
+interface DevtoolsNotifierOptions {
+    /** How many reports to keep for `replay()`. Default 300. */
+    bufferSize?: number;
+    /** Where to post. Default `window`. */
+    target?: Pick<Window, 'postMessage'>;
+    /** Max serialization depth. Default 6. */
+    maxDepth?: number;
+    /** Flash the DOM of components that re-rendered avoidably. Default false; toggle later with `flashAvoidable`. */
+    flashAvoidable?: boolean;
+    /** Reported in `info()`. The extension's inject script passes `'extension'`. Default `'page'`. */
+    source?: 'page' | 'extension';
+    /**
+     * Also publish on a `BroadcastChannel`, so a panel in another same-origin tab (the one the Vite plugin
+     * serves at `/__rerender-lens/`) receives reports and can send commands. `true` uses `DEFAULT_CHANNEL`.
+     * Off by default.
+     */
+    channel?: boolean | string;
+    /**
+     * Forward everything to a relay started with `npx rerender-lens panel` (its URL), so the panel works for
+     * any app on any origin. Also read from `window.__RERENDER_LENS_RELAY__` when set before the app loads.
+     */
+    relay?: string;
+    /** `EventSource` implementation for the relay (tests, Node). Default: the global one. */
+    eventSource?: EventSourceCtor;
+}
+/** The subset of `EventSource` the relay client needs. */
+interface EventSourceLike {
+    onmessage: ((event: {
+        data: string;
+    }) => void) | null;
+    onerror: ((event: unknown) => void) | null;
+    close(): void;
+}
+type EventSourceCtor = new (url: string) => EventSourceLike;
+interface InspectResult {
+    component: string;
+    instanceId: number | null;
+    tracked: boolean;
+    path: string[];
+    /** Serialized reports for this instance, oldest first. */
+    reports: unknown[];
+}
+interface PullResult {
+    /** Sequence number of the newest report included; pass it back as `since`. */
+    seq: number;
+    reports: unknown[];
+    /** True when the caller missed reports that fell out of the buffer. */
+    dropped: boolean;
+}
+interface DevtoolsBridge {
+    /** Re-post every buffered report (a panel that opened late calls this). */
+    replay(): void;
+    clear(): void;
+    readonly size: number;
+    readonly version: number;
+    /** Library version. */
+    readonly library: string;
+    /** Everything the panel shows in its status line. */
+    info(): HelloPayload;
+    /** Reports newer than `since`. Lets a panel poll without any content script. */
+    pull(since?: number): PullResult;
+    /** Merge options at runtime; matchers are strings (`"/^Grid/"` becomes a RegExp). */
+    configure(options: SerializableOptions): SerializableOptions;
+    getOptions(): SerializableOptions;
+    /** Outline the DOM of an instance in the page; `null` clears. */
+    highlight(instanceId: number | null): boolean;
+    /** Turn the avoidable-render flash on or off. */
+    flashAvoidable(on: boolean): void;
+    /** Re-render details for a DOM node (DevTools' `$0`). */
+    inspect(node: unknown): InspectResult | null;
+}
+declare global {
+    interface Window {
+        __RERENDER_LENS_DEVTOOLS__?: DevtoolsBridge;
+    }
+}
+/** Convert a report into a structured-clone-safe value (functions, elements, cycles removed). */
+declare function serialize(value: unknown, maxDepth?: number, seen?: WeakSet<object>, depth?: number): unknown;
+/** The current options in a JSON-safe form (function matchers and custom consoles are dropped). */
+declare function serializeOptions(o: Options): SerializableOptions;
+declare function deserializeOptions(o: SerializableOptions): Options;
+/**
+ * A notifier that posts every report on `window` for a DevTools extension to pick up.
+ * Also installs `window.__RERENDER_LENS_DEVTOOLS__` with `replay()` / `clear()` / `pull()` and friends.
+ */
+declare function createDevtoolsNotifier(options?: DevtoolsNotifierOptions): Notifier;
+
+export { type ChannelCommand as C, DEFAULT_CHANNEL as D, type Fiber as F, type HelloPayload as H, type InspectResult as I, PROTOCOL_VERSION as P, type RendererInfo as R, type SerializableOptions as S, type ChannelReply as a, DEVTOOLS_MARKER as b, type DevtoolsBridge as c, type DevtoolsMessage as d, type DevtoolsNotifierOptions as e, type PullResult as f, createDevtoolsNotifier as g, deserializeOptions as h, ensureDevtoolsHook as i, getRenderers as j, isProductionReact as k, serializeOptions as l, serialize as s };