react-perf-recorder 0.1.0

package/dist/node/vite.d.cts

@@ -0,0 +1,103 @@
+import { P as PerfRecorderPlugin, V as VitePluginLike } from './plugin-api-zXFxjYba.cjs';
+export { B as BuildContext, d as definePerfRecorderPlugin } from './plugin-api-zXFxjYba.cjs';
+
+interface ComponentNamesOptions {
+    include?: string[];
+    exclude?: string[];
+    /** Calls whose result gets a `displayName`: memo and forwardRef components, contexts. */
+    wrappers?: string[];
+}
+/**
+ * `const Row = memo(...)` → `if (!Row.displayName) Row.displayName = "Row";`, so a memo over an arrow function is not
+ * `Memo`/`Anonymous`. `export default memo(...)` is named after its file.
+ */
+declare function addComponentNames(code: string, wrappers?: string[], file?: string): string | null;
+
+interface ProxyModuleOptions {
+    /** The bare specifier to replace, e.g. `proxy-memoize` or `zustand/react/shallow`. */
+    source: string;
+    /** Only these importers get the proxy; the proxy itself, node_modules and virtual modules keep the original. */
+    importer: (importer: string | undefined) => boolean;
+    /** Body of the proxy module; it imports the original by the same specifier. */
+    code: () => string;
+}
+interface ProxyHooks {
+    /** The id of the proxy module, for a transform that wants to import it by name rather than wait to be asked. */
+    readonly id: string;
+    resolveId(source: string, importer?: string): string | null;
+    load(id: string): string | null;
+    /** Points a module's imports of the source at the proxy, whatever the resolver would have done with them. */
+    rewrite(code: string): string | null;
+}
+declare function proxyModule(pluginName: string, options: ProxyModuleOptions): ProxyHooks;
+/** Several proxies as one pair of hooks. */
+declare function combineProxies(proxies: ProxyHooks[]): ProxyHooks;
+
+interface ScanOptions {
+    /** `React.memo(…)` counts as `memo(…)`. */
+    allowReactPrefix?: boolean;
+    /** The module's id: its extension says whether it is TypeScript and whether it has JSX. */
+    file?: string;
+}
+/**
+ * Top-level `const X = callee(…)` / `export const X = callee<T>(…)` declarations. Nested calls and anything written
+ * inside a string, a template literal or a comment are not named.
+ */
+declare function findDeclarations(code: string, callees: string[], options?: ScanOptions): string[];
+/** Appends generated lines at the end of the module: line numbers stay the same, so no source map is needed. */
+declare function appendLines(code: string, lines: string[]): string | null;
+
+/**
+ * Include/exclude globs relative to the project root. Virtual modules and node_modules never match: only the app's
+ * own code gets transformed or proxied.
+ */
+declare function createFilter(root: () => string, include: string[], exclude?: string[]): (id: string | undefined) => boolean;
+
+interface PerfRecorderOptions {
+    /** Defaults to the dev server only: never in `vite build`, never under Vitest. */
+    enabled?: boolean;
+    /**
+     * Whether recordings are sent to the dev server to be kept; true when it serves the page. A build made with
+     * `enabled: true` (a demo) has no server, and its recordings stay in the tab.
+     */
+    save?: boolean;
+    /** Where sessions are written: relative to the root or absolute. Falls back to REACT_PERF_RECORDER_DIR, then `.agent-artifacts/perf-recorder`. */
+    outDir?: string;
+    /** Largest request body, the final recording included. */
+    maxBytes?: number;
+    retain?: {
+        sessions?: number;
+        bytes?: number;
+    };
+    actions?: {
+        values?: boolean;
+        secretSelector?: string;
+    };
+    components?: false | (ComponentNamesOptions & {
+        wrapperPattern?: string;
+    });
+    panel?: false | {
+        corner?: 'bottom-left' | 'bottom-right' | 'top-left' | 'top-right';
+        highlight?: boolean;
+        shortcuts?: {
+            record?: string;
+            pick?: string;
+        };
+    };
+    /** `timers: false` leaves setTimeout, setInterval and requestAnimationFrame unwrapped: no timer causes. */
+    engine?: {
+        bigCommit?: number;
+        timelineLimit?: number;
+        maxDurationMs?: number;
+        timers?: boolean;
+    };
+    plugins?: PerfRecorderPlugin[];
+}
+declare function resolveOutDir(root: string, outDir: string | undefined): string;
+/**
+ * Records React re-renders from the page: injects the recorder into the dev page, names memo components and
+ * contexts, runs the plugins' build halves and stores sessions for the MCP server. Returns several Vite plugins.
+ */
+declare function perfRecorder(options?: PerfRecorderOptions): VitePluginLike[];
+
+export { type PerfRecorderOptions, PerfRecorderPlugin, type ProxyModuleOptions, VitePluginLike, addComponentNames, appendLines, combineProxies, createFilter, findDeclarations, perfRecorder, proxyModule, resolveOutDir };

package/dist/node/vite.d.ts

@@ -0,0 +1,103 @@
+import { P as PerfRecorderPlugin, V as VitePluginLike } from './plugin-api-zXFxjYba.js';
+export { B as BuildContext, d as definePerfRecorderPlugin } from './plugin-api-zXFxjYba.js';
+
+interface ComponentNamesOptions {
+    include?: string[];
+    exclude?: string[];
+    /** Calls whose result gets a `displayName`: memo and forwardRef components, contexts. */
+    wrappers?: string[];
+}
+/**
+ * `const Row = memo(...)` → `if (!Row.displayName) Row.displayName = "Row";`, so a memo over an arrow function is not
+ * `Memo`/`Anonymous`. `export default memo(...)` is named after its file.
+ */
+declare function addComponentNames(code: string, wrappers?: string[], file?: string): string | null;
+
+interface ProxyModuleOptions {
+    /** The bare specifier to replace, e.g. `proxy-memoize` or `zustand/react/shallow`. */
+    source: string;
+    /** Only these importers get the proxy; the proxy itself, node_modules and virtual modules keep the original. */
+    importer: (importer: string | undefined) => boolean;
+    /** Body of the proxy module; it imports the original by the same specifier. */
+    code: () => string;
+}
+interface ProxyHooks {
+    /** The id of the proxy module, for a transform that wants to import it by name rather than wait to be asked. */
+    readonly id: string;
+    resolveId(source: string, importer?: string): string | null;
+    load(id: string): string | null;
+    /** Points a module's imports of the source at the proxy, whatever the resolver would have done with them. */
+    rewrite(code: string): string | null;
+}
+declare function proxyModule(pluginName: string, options: ProxyModuleOptions): ProxyHooks;
+/** Several proxies as one pair of hooks. */
+declare function combineProxies(proxies: ProxyHooks[]): ProxyHooks;
+
+interface ScanOptions {
+    /** `React.memo(…)` counts as `memo(…)`. */
+    allowReactPrefix?: boolean;
+    /** The module's id: its extension says whether it is TypeScript and whether it has JSX. */
+    file?: string;
+}
+/**
+ * Top-level `const X = callee(…)` / `export const X = callee<T>(…)` declarations. Nested calls and anything written
+ * inside a string, a template literal or a comment are not named.
+ */
+declare function findDeclarations(code: string, callees: string[], options?: ScanOptions): string[];
+/** Appends generated lines at the end of the module: line numbers stay the same, so no source map is needed. */
+declare function appendLines(code: string, lines: string[]): string | null;
+
+/**
+ * Include/exclude globs relative to the project root. Virtual modules and node_modules never match: only the app's
+ * own code gets transformed or proxied.
+ */
+declare function createFilter(root: () => string, include: string[], exclude?: string[]): (id: string | undefined) => boolean;
+
+interface PerfRecorderOptions {
+    /** Defaults to the dev server only: never in `vite build`, never under Vitest. */
+    enabled?: boolean;
+    /**
+     * Whether recordings are sent to the dev server to be kept; true when it serves the page. A build made with
+     * `enabled: true` (a demo) has no server, and its recordings stay in the tab.
+     */
+    save?: boolean;
+    /** Where sessions are written: relative to the root or absolute. Falls back to REACT_PERF_RECORDER_DIR, then `.agent-artifacts/perf-recorder`. */
+    outDir?: string;
+    /** Largest request body, the final recording included. */
+    maxBytes?: number;
+    retain?: {
+        sessions?: number;
+        bytes?: number;
+    };
+    actions?: {
+        values?: boolean;
+        secretSelector?: string;
+    };
+    components?: false | (ComponentNamesOptions & {
+        wrapperPattern?: string;
+    });
+    panel?: false | {
+        corner?: 'bottom-left' | 'bottom-right' | 'top-left' | 'top-right';
+        highlight?: boolean;
+        shortcuts?: {
+            record?: string;
+            pick?: string;
+        };
+    };
+    /** `timers: false` leaves setTimeout, setInterval and requestAnimationFrame unwrapped: no timer causes. */
+    engine?: {
+        bigCommit?: number;
+        timelineLimit?: number;
+        maxDurationMs?: number;
+        timers?: boolean;
+    };
+    plugins?: PerfRecorderPlugin[];
+}
+declare function resolveOutDir(root: string, outDir: string | undefined): string;
+/**
+ * Records React re-renders from the page: injects the recorder into the dev page, names memo components and
+ * contexts, runs the plugins' build halves and stores sessions for the MCP server. Returns several Vite plugins.
+ */
+declare function perfRecorder(options?: PerfRecorderOptions): VitePluginLike[];
+
+export { type PerfRecorderOptions, PerfRecorderPlugin, type ProxyModuleOptions, VitePluginLike, addComponentNames, appendLines, combineProxies, createFilter, findDeclarations, perfRecorder, proxyModule, resolveOutDir };