rerender-lens 0.4.0 → 0.7.0

package/dist/{types-BzUEVkxJ.d.cts → types-DwNN5cWe.d.cts}

@@ -32,7 +32,7 @@ type RenderTrigger =
 /** More than one of the above. */
  | 'mixed';
 interface HookChange extends Change {
-    /** `useState`, `useReducer`, `useContext`, `useSyncExternalStore`, or `state` when the exact hook is unknown. */
+    /** `useState`, `useReducer`, `useContext`, `useSyncExternalStore`, `useDeferredValue` (dev builds), or `state` when the exact hook is unknown. */
     hook: string;
     /** Position of the hook in call order (0-based). */
     index: number;
@@ -124,6 +124,12 @@ interface RenderReport {
     path: string[];
     /** True for `React.memo` components and `PureComponent` classes: props alone decide whether they re-render. */
     memoized: boolean;
+    /**
+     * True when React Compiler compiled the component (its fiber carries a `useMemoCache` cache). React still
+     * calls it when the parent renders, but its output is memoized per input, so a `parent` render with
+     * identical props is cheap and not reported as avoidable.
+     */
+    compiled?: boolean;
     /** Time spent in this component's own render (children excluded), in ms, when React exposes it (dev/profiling builds). */
     selfDuration?: number;
     /** Time spent rendering this component and everything below it that rendered in the same commit, in ms. */
@@ -135,6 +141,53 @@ interface RenderReport {
     /** `performance.now()` (or `Date.now()`) when the report was produced. */
     time: number;
 }
+/**
+ * The fields the analysis helpers (`fixesFor`, `rankFixes`, `analyzeCommit`, `rankRootCauses`, `summarizeReports`, `summarize`) read,
+ * as a structural type: both a live `RenderReport` and the DevTools panel's serialized report satisfy
+ * it, so the panel and the library share one implementation without casts.
+ */
+interface ChangeLike {
+    path: string;
+    kind: ChangeKind;
+    prev?: unknown;
+    next?: unknown;
+    hook?: string;
+    index?: number;
+    provider?: {
+        component: string | null;
+        path: string[];
+    };
+    changedKeys?: string[];
+    totalKeys?: number;
+    custom?: string[];
+}
+interface ReportLike {
+    component: string;
+    avoidable: boolean;
+    trigger: string;
+    memoized?: boolean;
+    compiled?: boolean;
+    propChanges: ChangeLike[];
+    stateChanges: ChangeLike[];
+    hookChanges: ChangeLike[];
+    parent: {
+        name: string;
+        trigger: string;
+    } | null;
+    owner: string | null;
+    path: string[];
+    selfDuration?: number;
+    time: number;
+    /** Shared by every report of one React commit; the root-cause analysis groups by it. 0/absent = unknown. */
+    commitId?: number;
+    updaters?: string[];
+    commitCause?: string;
+    afterCommit?: number;
+    contexts?: {
+        name: string;
+        value: unknown;
+    }[];
+}
 type Notifier = (report: RenderReport) => void;
 type ComponentMatcher = string | RegExp | ((displayName: string) => boolean);
 interface Options {
@@ -171,7 +224,34 @@ interface Options {
     /** Stop printing a component after this many reports (0 = unlimited). The notifier still receives them. Default 0. */
     maxReportsPerComponent?: number;
 }
+/**
+ * Why one component type is or is not tracked under the current options, in words a user can act on.
+ * Produced by `explainTracking`; `tracked` always agrees with `shouldTrack`.
+ */
+interface TrackingVerdict {
+    tracked: boolean;
+    /** One sentence: the rule that decided it. */
+    reason: string;
+    /** What to change to track it, when it is not tracked and something can be changed. */
+    fix?: string;
+    /** Display name, or `Anonymous` when the type has none. */
+    name: string;
+    /** `React.memo` component or `PureComponent` class. */
+    memoized: boolean;
+}
+/** What the current options select, plus how much of the page they actually cover. In `info().tracking`. */
+interface TrackingSummary {
+    /** `all` = every component, `memoized` = `React.memo`/`PureComponent` only, `marked` = only `track()` and `include`. */
+    mode: 'all' | 'memoized' | 'marked';
+    include: string[];
+    exclude: string[];
+    /** Distinct component names that rendered since `init`, and how many of those were tracked. */
+    renderedCount: number;
+    trackedCount: number;
+    /** True when more distinct names rendered than the counter keeps (`MAX_SEEN_COMPONENTS`); the counts are a floor. */
+    overflow: boolean;
+}
 /** Marker static: `MyComponent.rerenderLens = true` opts a component in. */
 declare const MARKER: "rerenderLens";
 
-export { type ChangeKind as C, type HookChange as H, MARKER as M, type Notifier as N, type Options as O, type ParentInfo as P, type RenderReport as R, type SourceLocation as S, type Change as a, type HookSnapshot as b, type CommitPriority as c, type CommitCause as d, type ComponentMatcher as e, type RenderTrigger as f };
+export { type ChangeKind as C, type HookChange as H, MARKER as M, type Notifier as N, type Options as O, type ParentInfo as P, type RenderReport as R, type SourceLocation as S, type TrackingSummary as T, type TrackingVerdict as a, type ReportLike as b, type Change as c, type HookSnapshot as d, type CommitPriority as e, type CommitCause as f, type ChangeLike as g, type ComponentMatcher as h, type RenderTrigger as i };

package/dist/{types-BzUEVkxJ.d.ts → types-DwNN5cWe.d.ts}

@@ -32,7 +32,7 @@ type RenderTrigger =
 /** More than one of the above. */
  | 'mixed';
 interface HookChange extends Change {
-    /** `useState`, `useReducer`, `useContext`, `useSyncExternalStore`, or `state` when the exact hook is unknown. */
+    /** `useState`, `useReducer`, `useContext`, `useSyncExternalStore`, `useDeferredValue` (dev builds), or `state` when the exact hook is unknown. */
     hook: string;
     /** Position of the hook in call order (0-based). */
     index: number;
@@ -124,6 +124,12 @@ interface RenderReport {
     path: string[];
     /** True for `React.memo` components and `PureComponent` classes: props alone decide whether they re-render. */
     memoized: boolean;
+    /**
+     * True when React Compiler compiled the component (its fiber carries a `useMemoCache` cache). React still
+     * calls it when the parent renders, but its output is memoized per input, so a `parent` render with
+     * identical props is cheap and not reported as avoidable.
+     */
+    compiled?: boolean;
     /** Time spent in this component's own render (children excluded), in ms, when React exposes it (dev/profiling builds). */
     selfDuration?: number;
     /** Time spent rendering this component and everything below it that rendered in the same commit, in ms. */
@@ -135,6 +141,53 @@ interface RenderReport {
     /** `performance.now()` (or `Date.now()`) when the report was produced. */
     time: number;
 }
+/**
+ * The fields the analysis helpers (`fixesFor`, `rankFixes`, `analyzeCommit`, `rankRootCauses`, `summarizeReports`, `summarize`) read,
+ * as a structural type: both a live `RenderReport` and the DevTools panel's serialized report satisfy
+ * it, so the panel and the library share one implementation without casts.
+ */
+interface ChangeLike {
+    path: string;
+    kind: ChangeKind;
+    prev?: unknown;
+    next?: unknown;
+    hook?: string;
+    index?: number;
+    provider?: {
+        component: string | null;
+        path: string[];
+    };
+    changedKeys?: string[];
+    totalKeys?: number;
+    custom?: string[];
+}
+interface ReportLike {
+    component: string;
+    avoidable: boolean;
+    trigger: string;
+    memoized?: boolean;
+    compiled?: boolean;
+    propChanges: ChangeLike[];
+    stateChanges: ChangeLike[];
+    hookChanges: ChangeLike[];
+    parent: {
+        name: string;
+        trigger: string;
+    } | null;
+    owner: string | null;
+    path: string[];
+    selfDuration?: number;
+    time: number;
+    /** Shared by every report of one React commit; the root-cause analysis groups by it. 0/absent = unknown. */
+    commitId?: number;
+    updaters?: string[];
+    commitCause?: string;
+    afterCommit?: number;
+    contexts?: {
+        name: string;
+        value: unknown;
+    }[];
+}
 type Notifier = (report: RenderReport) => void;
 type ComponentMatcher = string | RegExp | ((displayName: string) => boolean);
 interface Options {
@@ -171,7 +224,34 @@ interface Options {
     /** Stop printing a component after this many reports (0 = unlimited). The notifier still receives them. Default 0. */
     maxReportsPerComponent?: number;
 }
+/**
+ * Why one component type is or is not tracked under the current options, in words a user can act on.
+ * Produced by `explainTracking`; `tracked` always agrees with `shouldTrack`.
+ */
+interface TrackingVerdict {
+    tracked: boolean;
+    /** One sentence: the rule that decided it. */
+    reason: string;
+    /** What to change to track it, when it is not tracked and something can be changed. */
+    fix?: string;
+    /** Display name, or `Anonymous` when the type has none. */
+    name: string;
+    /** `React.memo` component or `PureComponent` class. */
+    memoized: boolean;
+}
+/** What the current options select, plus how much of the page they actually cover. In `info().tracking`. */
+interface TrackingSummary {
+    /** `all` = every component, `memoized` = `React.memo`/`PureComponent` only, `marked` = only `track()` and `include`. */
+    mode: 'all' | 'memoized' | 'marked';
+    include: string[];
+    exclude: string[];
+    /** Distinct component names that rendered since `init`, and how many of those were tracked. */
+    renderedCount: number;
+    trackedCount: number;
+    /** True when more distinct names rendered than the counter keeps (`MAX_SEEN_COMPONENTS`); the counts are a floor. */
+    overflow: boolean;
+}
 /** Marker static: `MyComponent.rerenderLens = true` opts a component in. */
 declare const MARKER: "rerenderLens";
 
-export { type ChangeKind as C, type HookChange as H, MARKER as M, type Notifier as N, type Options as O, type ParentInfo as P, type RenderReport as R, type SourceLocation as S, type Change as a, type HookSnapshot as b, type CommitPriority as c, type CommitCause as d, type ComponentMatcher as e, type RenderTrigger as f };
+export { type ChangeKind as C, type HookChange as H, MARKER as M, type Notifier as N, type Options as O, type ParentInfo as P, type RenderReport as R, type SourceLocation as S, type TrackingSummary as T, type TrackingVerdict as a, type ReportLike as b, type Change as c, type HookSnapshot as d, type CommitPriority as e, type CommitCause as f, type ChangeLike as g, type ComponentMatcher as h, type RenderTrigger as i };

package/dist/vite.d.cts

@@ -1,4 +1,4 @@
-import { O as Options } from './types-BzUEVkxJ.cjs';
+import { O as Options } from './types-DwNN5cWe.cjs';
 
 /** `Options` minus the parts that cannot be serialized into a module (functions). Matchers may be strings or RegExps. */
 type VitePluginOptions = Omit<Options, 'notifier' | 'console' | 'include' | 'exclude'> & {

package/dist/vite.d.ts

@@ -1,4 +1,4 @@
-import { O as Options } from './types-BzUEVkxJ.js';
+import { O as Options } from './types-DwNN5cWe.js';
 
 /** `Options` minus the parts that cannot be serialized into a module (functions). Matchers may be strings or RegExps. */
 type VitePluginOptions = Omit<Options, 'notifier' | 'console' | 'include' | 'exclude'> & {