bippy 0.6.1-dev.d7876ea → 0.6.1-dev.f9a65c0

package/README.md

@@ -1,639 +1,405 @@
-> [!WARNING]
-> ⚠️⚠️⚠️ **this project may break production apps and cause unexpected behavior** ⚠️⚠️⚠️
->
-> this project uses react internals, which can change at any time. we don't recommend depending on internals unless you really, _really_ have to. by proceeding, you acknowledge the risk of breaking your own code or apps that use your code.
-
-# <img src="https://github.com/aidenybai/bippy/blob/main/.github/public/bippy.png?raw=true" width="60" align="center" /> bippy
+<h1>
+  <img src="./.github/public/bippy.png" width="48" alt="" valign="middle" />
+  bippy
+</h1>
 
 [![version](https://img.shields.io/npm/v/bippy?style=flat&colorA=000000&colorB=000000)](https://npmjs.com/package/bippy)
 [![downloads](https://img.shields.io/npm/dt/bippy.svg?style=flat&colorA=000000&colorB=000000)](https://npmjs.com/package/bippy)
 
-bippy is a toolkit to **hack into react internals**
-
-by default, you cannot access react internals. bippy bypasses this by “pretending” to be react devtools, giving you access to the fiber tree and other internals.
-
-- works outside of react: no react code modification needed
-- utility functions that work across modern react (v17-19)
-- no prior react source code knowledge required
-
-```jsx
-import { instrument, traverseFiber } from "bippy"; // must be imported BEFORE react
-
-instrument({
-  onCommitFiberRoot(rendererID, root) {
-    traverseFiber(root.current, (fiber) => {
-      // prints every fiber in the current React tree
-      console.log("fiber:", fiber);
-    });
-  },
-});
-```
-
-## how it works & motivation
-
-bippy allows you to **access** and **use** react fibers **outside** of react components.
-
-a react fiber is a “unit of execution.” this means react will do something based on the data in a fiber. each fiber either represents a composite (function/class component) or a host (dom element).
-
-> here is a [live visualization](https://jser.pro/ddir/rie?reactVersion=18.3.1&snippetKey=hq8jm2ylzb9u8eh468) of what the fiber tree looks like, and here is a [deep dive article](https://jser.dev/2023-07-18-how-react-rerenders/).
+bippy hacks into React internals.
 
-fibers are useful because they contain information about the react app (component props, state, contexts, etc.). a simplified version of a fiber looks roughly like this:
+React keeps its internals out of reach. bippy opens them up for metaprogramming, letting you inspect the [Fiber](https://youtu.be/ZCuYPiUIONs) tree, track renders, and access the renderer directly.
 
-```typescript
-interface Fiber {
-  // component type (function/class)
-  type: any;
-
-  child: Fiber | null;
-  sibling: Fiber | null;
-
-  // stateNode is the host fiber (e.g. DOM element)
-  stateNode: Node | null;
-
-  // parent fiber
-  return: Fiber | null;
+> [!WARNING]
+> ⚠️⚠️⚠️ **This project may break production apps and cause unexpected behavior.** ⚠️⚠️⚠️
+>
+> This project uses React internals, which can change at any time. We don’t recommend depending on them unless you have to. By proceeding, you acknowledge the risk of breaking your own code or apps that use your code.
 
-  // the previous or current version of the fiber
-  alternate: Fiber | null;
+## How Fiber works
 
-  // saved props input
-  memoizedProps: any;
+React turns the elements returned by your components into a Fiber tree. Each Fiber is a mutable object representing one unit of work, such as a component, host element, text node, or internal boundary. It stores the node’s props, state, position in the tree, and pending work.
 
-  // state (useState, useReducer, useSES, etc.)
-  memoizedState: any;
+Consider this component tree:
 
-  // contexts (useContext)
-  dependencies: Dependencies | null;
+```tsx
+const Button = () => <button>Save</button>;
 
-  // effects (useEffect, useLayoutEffect, etc.)
-  updateQueue: any;
-}
+const App = () => (
+  <main>
+    <Button />
+  </main>
+);
 ```
 
-here, the `child`, `sibling`, and `return` properties are pointers to other fibers in the tree.
-
-additionally, `memoizedProps`, `memoizedState`, and `dependencies` are the fiber's props, state, and contexts.
-
-while all of the information is there, it's awkward to work with, and changes frequently across different versions of react. bippy simplifies this by providing utility functions like:
+React represents it with Fibers similar to these:
 
-- `traverseRenderedFibers` to detect renders and `traverseFiber` to traverse the overall fiber tree
-  - _(instead of `child`, `sibling`, and `return` pointers)_
-- `traverseProps`, `traverseState`, and `traverseContexts` to traverse the fiber's props, state, and contexts
-  - _(instead of `memoizedProps`, `memoizedState`, and `dependencies`)_
-
-however, react doesn't expose fibers to you directly. so, we have to hack our way around to access them.
-
-luckily, react [reads from a property](https://github.com/facebook/react/blob/6a4b46cd70d2672bc4be59dcb5b8dede22ed0cef/packages/react-reconciler/src/ReactFiberDevToolsHook.js#L48) in the window object: `window.__REACT_DEVTOOLS_GLOBAL_HOOK__` and runs handlers on it when certain events happen. this property must exist before react's bundle is executed. this is intended for react devtools, but we can use it to our advantage.
-
-here's what it roughly looks like:
-
-```typescript
-interface __REACT_DEVTOOLS_GLOBAL_HOOK__ {
-  // list of renderers (react-dom, react-native, etc.)
-  renderers: Map<RendererID, reactRenderer>;
-
-  // called when react has rendered everything for an update and the fiber tree is fully built and ready to
-  // apply changes to the host tree (e.g. DOM mutations)
-  onCommitFiberRoot: (rendererID: RendererID, root: FiberRoot, commitPriority?: number) => void;
-
-  // called when effects run
-  onPostCommitFiberRoot: (rendererID: RendererID, root: FiberRoot) => void;
+```text
+HostRoot
+└── App                FunctionComponent
+    └── main           HostComponent
+        └── Button     FunctionComponent
+            └── button HostComponent
+```
 
-  // called when a specific fiber unmounts
-  onCommitFiberUnmount: (rendererID: RendererID, fiber: Fiber) => void;
+Fibers are actual linked objects. The host Fiber for `<button>` contains the fields that connect React’s component tree to the rendered element:
+
+```text
+FiberNode {
+  tag: 5,
+  type: "button",
+  stateNode: HTMLButtonElement {},
+  return: FiberNode { … },
+  child: null,
+  sibling: null,
+  memoizedProps: { children: "Save" },
+  flags: 0,
+  alternate: null
 }
 ```
 
-bippy works by monkey-patching `window.__REACT_DEVTOOLS_GLOBAL_HOOK__` with our own custom handlers. bippy simplifies this by providing utility functions like:
+`return`, `child`, and `sibling` form the tree. For a host Fiber, `stateNode` points to the renderer-owned instance, such as a DOM element or native view.
 
-- `instrument` to safely patch `window.__REACT_DEVTOOLS_GLOBAL_HOOK__`
-  - _(instead of directly mutating `onCommitFiberRoot`, …)_
-- `traverseRenderedFibers` to traverse the fiber tree and determine which fibers have actually rendered
-  - _(instead of `child`, `sibling`, and `return` pointers)_
-- `traverseFiber` to traverse the fiber tree, regardless of whether it has rendered
-  - _(instead of `child`, `sibling`, and `return` pointers)_
-- `setFiberId` / `getFiberId` to set and get a fiber's id
-  - _(instead of anonymous fibers with no identity)_
+During an update, React builds a work-in-progress tree beside the current tree. The `alternate` field links the corresponding Fibers in both trees. React can pause or discard the work-in-progress tree; after a commit, the finished tree becomes current.
 
-## how to use
+React does not expose Fiber as a public API. bippy “hacks into React” by accessing it anyway, giving you a consistent way to inspect Fiber trees across React versions and renderers.
 
-we recommend installing via npm.
+## Install bippy
 
-import this package before your react app runs. it adds a special object to the global scope that react reports its internals to (react devtools uses the same mechanism). as soon as react loads and attaches, bippy starts collecting data about what is going on in react's internals.
+Install bippy:
 
 ```shell
 npm install bippy
 ```
 
-since bippy must load before react, some bundlers need specific configuration to get the import order right.
+Import bippy before React or any React renderer.
 
-### next.js
+### Next.js
 
-in next.js 15.3+, use the [`instrumentation-client.js`](https://nextjs.org/docs/app/api-reference/file-conventions/instrumentation-client) file to ensure bippy loads before react. create this file at the root of your application (or inside the `src` folder if you're using the src directory structure):
+Next.js 15.3 and later can load bippy through [`instrumentation-client.ts`](https://nextjs.org/docs/app/api-reference/file-conventions/instrumentation-client). Create the file at the project root or in `src`:
 
 ```typescript
-// instrumentation-client.ts
 import "bippy";
 ```
 
-this file executes before react hydration, making it the ideal place to initialize bippy.
+### Vite
 
-### vite
-
-in vite, import bippy at the very top of your main entry point (typically `src/main.tsx` or `src/main.ts`) before any react imports:
+Import bippy at the top of your Vite entry point, before any React imports:
 
 ```typescript
-// src/main.tsx
 import "bippy";
 import { StrictMode } from "react";
 import { createRoot } from "react-dom/client";
+```
+
+## API Reference
+
+### `getFiber`
+
+Returns the Fiber associated with a renderer host instance, such as an element from the Document Object Model (DOM). The result is `null` when no registered renderer recognizes the instance.
 
-// ... rest of your code
+```typescript
+import { getFiber } from "bippy";
+
+const element = document.querySelector("button");
+const fiber = getFiber(element);
 ```
 
-the import order is critical: import bippy before any react packages.
+`getFiberFromHostInstance` is an alias for `getFiber`.
 
-> **note for library maintainers**: if you're building a library and want to define your own utility functions while minimizing bundle size, you can use `bippy/install-hook-only` (~90 bytes) instead of the main `bippy` export. this only installs the react devtools hook without importing any utility functions, allowing you to import only what you need from `bippy/core` or define your own fiber utilities. that said, the full `bippy` package is only ~4 KB gzipped, so bundle size is rarely a concern.
+### `useFiber`
 
-> ```typescript
-> import "bippy/install-hook-only"; // only installs the hook
-> import { getRDTHook, traverseFiber } from "bippy/core"; // import only what you need
-> import * as React from "react"; // import react AFTER the hook is installed
->
-> const hook = getRDTHook();
-> // define your own utilities or use only specific ones
-> ```
+Returns the calling component’s Fiber. During server rendering it returns `undefined` because there is no client Fiber for the component.
 
-## API reference
+```tsx
+import { useFiber } from "bippy";
 
-### instrument
+const Component = () => {
+  const fiber = useFiber();
+  console.log(fiber?.type);
+  return null;
+};
+```
+
+### `instrument`
 
-patches `window.__REACT_DEVTOOLS_GLOBAL_HOOK__` with your handlers. import bippy before react, and call `instrument` before any other methods.
+Registers lifecycle handlers and returns an unsubscribe function.
 
-bippy patches each hook event once and dispatches it to a set of listeners, so multiple `instrument` calls compose instead of replacing each other. `instrument` returns an unsubscribe function that removes exactly the handlers you registered (also a `Disposable`, so it works with `using`).
+Available handlers include:
+
+- `onActive`: runs when instrumentation becomes active
+- `onScheduleFiberRoot`: runs when React schedules a root
+- `onCommitFiberRoot`: runs when React commits a root
+- `onPostCommitFiberRoot`: runs after commit effects
+- `onCommitFiberUnmount`: runs when React unmounts a Fiber
 
 ```typescript
-import { instrument } from "bippy"; // must be imported BEFORE react
-import * as React from "react";
+import { instrument } from "bippy";
 
 const unsubscribe = instrument({
-  onCommitFiberRoot(rendererID, root) {
-    console.log("root ready to commit", root);
-  },
-  onPostCommitFiberRoot(rendererID, root) {
-    console.log("root with effects committed", root);
-  },
   onCommitFiberUnmount(rendererID, fiber) {
-    console.log("fiber unmounted", fiber);
+    console.log(rendererID, fiber);
   },
 });
 
-// later, stop listening (other instrument() subscribers keep working)
 unsubscribe();
 ```
 
-instrumentation, React DevTools, and hook-listener failures propagate synchronously as `BippyInstrumentationError`, `BippyReactDevToolsError`, or `BippyHookListenerError`. each error preserves the original failure in `cause`, and callback dispatch stops at the failure so the caller controls error handling. existing Bippy errors propagate without redundant wrapping. React DevTools hook installation, React build, hook-inspection, and source-map failures use the other exported `BippyError` subclasses.
+Call the returned function to unsubscribe those handlers.
 
-### getRDTHook
+### `getRDTHook`
 
-returns the `window.__REACT_DEVTOOLS_GLOBAL_HOOK__` object. great for advanced use cases, such as accessing or modifying the `renderers` property.
+Returns the React DevTools global hook at `globalThis.__REACT_DEVTOOLS_GLOBAL_HOOK__`. Use it to access registered renderers and Fiber roots directly.
 
 ```typescript
 import { getRDTHook } from "bippy";
 
 const hook = getRDTHook();
-console.log(hook);
+console.log(hook.renderers);
 ```
 
-### traverseRenderedFibers
+### `traverseRenderedFibers`
 
-not every fiber in the fiber tree renders. `traverseRenderedFibers` allows you to traverse the fiber tree and determine which fibers have actually rendered.
+Visits Fibers that mounted, updated, or unmounted in a commit. The callback receives the Fiber and its `mount`, `update`, or `unmount` phase.
 
 ```typescript
-import { instrument, traverseRenderedFibers } from "bippy"; // must be imported BEFORE react
-import * as React from "react";
+import { instrument, traverseRenderedFibers } from "bippy";
 
 instrument({
   onCommitFiberRoot(rendererID, root) {
-    traverseRenderedFibers(root, (fiber) => {
-      console.log("fiber rendered", fiber);
+    traverseRenderedFibers(root, (fiber, phase) => {
+      console.log(rendererID, phase, fiber);
     });
   },
 });
 ```
 
-### traverseFiber
-
-calls a callback on every fiber in the fiber tree.
-
-```typescript
-import { instrument, traverseFiber } from "bippy"; // must be imported BEFORE react
-import * as React from "react";
+Call it with the same root across commits so bippy can compare the current and previous trees.
 
-instrument({
-  onCommitFiberRoot(rendererID, root) {
-    traverseFiber(root.current, (fiber) => {
-      console.log(fiber);
-    });
-  },
-});
-```
+### `traverseFiber`
 
-### traverseProps
-
-traverses the props of a fiber.
+Walks down from a Fiber and calls a selector for each node. Return `true` to stop and return the selected Fiber. Pass `true` as the third argument to walk toward the root instead.
 
 ```typescript
-import { traverseProps } from "bippy";
-
-// ...
+import { isHostFiber, traverseFiber } from "bippy";
 
-traverseProps(fiber, (propName, next, prev) => {
-  console.log(propName, next, prev);
+const buttonFiber = traverseFiber(fiber, (candidateFiber) => {
+  return isHostFiber(candidateFiber) && candidateFiber.type === "button";
 });
 ```
 
-### traverseState
+The selector can also return a promise. In that case, `traverseFiber` returns a promise for the selected Fiber.
 
-traverses the state (`useState`, `useReducer`, etc.) and effects that set state of a fiber.
+### `didFiberRender`
 
-```typescript
-import { traverseState } from "bippy";
-
-// ...
-
-traverseState(fiber, (next, prev) => {
-  console.log(next, prev);
-});
-```
-
-### traverseContexts
-
-traverses the contexts (`useContext`) of a fiber.
+Returns whether a Fiber has rendered. It does not identify whether the render happened during a specific commit.
 
 ```typescript
-import { traverseContexts } from "bippy";
-
-// ...
+import { didFiberRender } from "bippy";
 
-traverseContexts(fiber, (next, prev) => {
-  console.log(next, prev);
-});
+console.log(didFiberRender(fiber));
 ```
 
-### setFiberId / getFiberId
-
-set and get a persistent identity for a fiber. by default, fibers are anonymous and have no identity.
+Use `traverseRenderedFibers` to inspect renders from a specific commit.
 
-```typescript
-import { setFiberId, getFiberId } from "bippy";
+### `didFiberCommit`
 
-// ...
-
-setFiberId(fiber);
-console.log("unique id for fiber:", getFiberId(fiber));
-```
-
-### isHostFiber
-
-returns `true` if the fiber is a host fiber (e.g., a DOM node in react-dom).
+Returns whether a Fiber or its subtree has committed work. It does not identify a specific commit.
 
 ```typescript
-import { isHostFiber } from "bippy";
+import { didFiberCommit } from "bippy";
 
-if (isHostFiber(fiber)) {
-  console.log("fiber is a host fiber");
-}
+console.log(didFiberCommit(fiber));
 ```
 
-### isCompositeFiber
+### `setFiberId`
 
-returns `true` if the fiber is a composite fiber. composite fibers represent class components, function components, memoized components, and so on (anything that can actually render output).
+Assigns a numeric ID to a Fiber.
 
 ```typescript
-import { isCompositeFiber } from "bippy";
+import { setFiberId } from "bippy";
 
-if (isCompositeFiber(fiber)) {
-  console.log("fiber is a composite fiber");
-}
+setFiberId(fiber, 123);
 ```
 
-### getDisplayName
+### `getFiberId`
 
-returns the display name of the fiber's component, falling back to the component's function or class name if available.
+Returns a stable numeric ID across Fiber updates. It creates an ID when none has been assigned.
 
 ```typescript
-import { getDisplayName } from "bippy";
+import { getFiberId } from "bippy";
 
-console.log(getDisplayName(fiber));
+const fiberId = getFiberId(fiber);
 ```
 
-### getType
+### `isFiber`
 
-returns the underlying type (the component definition) for a given fiber. for example, this could be a function component or class component.
+Returns whether a value contains the core fields required by a Fiber.
 
-```jsx
-import { getType } from "bippy";
-import { memo } from "react";
-
-const RealComponent = () => {
-  return <div>hello</div>;
-};
-const MemoizedComponent = memo(RealComponent);
+```typescript
+import { isFiber } from "bippy";
 
-console.log(getType(fiberForMemoizedComponent) === RealComponent);
+console.log(isFiber(value));
 ```
 
-### getNearestHostFiber / getNearestHostFibers
+### `isHostFiber`
 
-`getNearestHostFiber` returns the closest host fiber above or below a given fiber. `getNearestHostFibers` returns all host fibers associated with the provided fiber and its subtree.
+Returns whether a Fiber represents a renderer host instance, such as a DOM element or React Native view.
 
-```jsx
-import { getNearestHostFiber, getNearestHostFibers } from "bippy";
-
-// ...
+```typescript
+import { isHostFiber } from "bippy";
 
-function Component() {
-  return (
-    <>
-      <div>hello</div>
-      <div>world</div>
-    </>
-  );
+if (isHostFiber(fiber)) {
+  console.log(fiber.stateNode);
 }
-
-console.log(getNearestHostFiber(fiberForComponent)); // <div>hello</div>
-console.log(getNearestHostFibers(fiberForComponent)); // [<div>hello</div>, <div>world</div>]
 ```
 
-### getTimings
+### `isCompositeFiber`
 
-returns the self and total render times for the fiber.
+Returns whether a Fiber represents a function, class, memo, or forward-ref component.
 
 ```typescript
-// timings don't exist in react production builds
-if (fiber.actualDuration !== undefined) {
-  const { selfTime, totalTime } = getTimings(fiber);
-  console.log(selfTime, totalTime);
-}
-```
-
-### getFiberStack
-
-returns an array representing the stack of fibers from the current fiber up to the root.
+import { isCompositeFiber } from "bippy";
 
-```typescript
-[fiber, fiber.return, fiber.return.return, ...]
+console.log(isCompositeFiber(fiber));
 ```
 
-### getMutatedHostFibers
+### `hasMemoCache`
 
-returns an array of all host fibers that have committed and rendered in the provided fiber's subtree.
+Returns whether a Fiber uses a React Compiler memo cache.
 
 ```typescript
-import { getMutatedHostFibers } from "bippy";
+import { hasMemoCache } from "bippy";
 
-console.log(getMutatedHostFibers(fiber));
+console.log(hasMemoCache(fiber));
 ```
 
-### isValidFiber
+### `getDisplayName`
 
-returns `true` if the given object is a valid React Fiber (i.e., has a tag, stateNode, return, child, sibling, etc.).
+Returns the display name of a Fiber type.
 
 ```typescript
-import { isValidFiber } from "bippy";
+import { getDisplayName } from "bippy";
 
-console.log(isValidFiber(fiber));
+console.log(getDisplayName(fiber.type));
 ```
 
-### getFiberFromHostInstance
+### `getType`
 
-returns the fiber associated with a given host instance (e.g., a DOM element).
+Unwraps memo and forward-ref wrappers and returns the underlying component definition.
 
 ```typescript
-import { getFiberFromHostInstance } from "bippy";
+import { getType } from "bippy";
 
-const fiber = getFiberFromHostInstance(document.querySelector("div"));
-console.log(fiber);
+console.log(getType(fiber.type));
 ```
 
-### getLatestFiber
+### `getLatestFiber`
 
-returns the latest fiber (since it may be double-buffered). usually use this in combination with `getFiberFromHostInstance`.
+Returns the latest version of a Fiber. Use it when you retain a Fiber across renders.
 
 ```typescript
-import { getLatestFiber } from "bippy";
-
-const latestFiber = getLatestFiber(getFiberFromHostInstance(document.querySelector("div")));
-console.log(latestFiber);
-```
-
-### overrideProps
-
-overrides component props at runtime by modifying the fiber's props.
+import { getFiber, getLatestFiber } from "bippy";
 
-```typescript
-import { overrideProps } from "bippy";
-
-// override props on a fiber
-overrideProps(fiber, {
-  title: "new title",
-  config: {
-    enabled: true,
-    count: 42,
-  },
-});
+const fiber = getFiber(document.body);
+const latestFiber = fiber ? getLatestFiber(fiber) : null;
 ```
 
-the function accepts a fiber and a partial object containing the props to override. bippy automatically flattens nested objects into property paths.
+### `getRenderer`
 
-### overrideHookState
-
-overrides hook state (`useState`, `useReducer`, etc.) at runtime by hook id.
+Returns the React renderer that owns a Fiber, or `null` when the renderer is unavailable.
 
 ```typescript
-import { overrideHookState } from "bippy";
-
-// override the first hook (id: 0) with a new value
-overrideHookState(fiber, 0, "new state value");
+import { getRenderer } from "bippy";
 
-// override nested state object
-overrideHookState(fiber, 1, {
-  user: {
-    name: "john",
-    age: 30,
-  },
-});
+const renderer = getRenderer(fiber);
+renderer?.overrideProps?.(fiber, ["title"], "new title");
+renderer?.scheduleUpdate?.(fiber);
 ```
 
-the hook id parameter corresponds to the order of hooks in the component (0-indexed). pass either a primitive value or an object for nested state updates.
+Renderer capabilities are optional and vary by renderer version.
 
-### overrideContext
+### React internals
 
-overrides react context values at runtime by finding the appropriate context provider.
+The main `bippy` entry point exports the React internals used by its APIs.
 
 ```typescript
-import { overrideContext } from "bippy";
-
-// override context value
-overrideContext(fiber, MyContext, {
-  theme: "dark",
-  user: {
-    id: 123,
-    name: "jane",
-  },
-});
-
-// override with primitive value
-overrideContext(fiber, ThemeContext, "dark");
+import {
+  MutationMask,
+  ReactBuildType,
+  ReactFiberFlags,
+  ReactSymbols,
+  getReactWorkTags,
+  getReactWorkTagsForFiber,
+  getReactWorkTagsForRenderer,
+} from "bippy";
+import type {
+  Fiber,
+  FiberRoot,
+  ReactDevToolsGlobalHook,
+  ReactRenderer,
+  RendererDispatcherRef,
+} from "bippy";
 ```
 
-the function traverses up the fiber tree to find the context provider matching the provided context type and overrides its value.
+These definitions follow React’s private implementation and may change between React versions.
+
+### `getSource`
 
-### getSource
+Returns the source location for a Fiber from these renderers:
 
-gets the source code location of any fiber with development source metadata. resolution is based on fiber debug data and source maps, so it is independent of the renderer's host instances and works with DOM, native, terminal, canvas, PDF, and custom reconcilers.
+- DOM
+- Native
+- Terminal
+- Canvas
+- PDF
+- Custom
 
 ```typescript
 import { getSource } from "bippy/source";
 
-const fiber = getFiberFromHostInstance(hostInstance);
 const source = await getSource(fiber);
-// {
-//   columnNumber: 12,
-//   fileName: 'path/to/file.tsx',
-//   lineNumber: 12,
-// }
+console.log(source);
 ```
 
-> **caveats:**
->
-> - only available in dev mode
-> - source availability is controlled by react and the renderer; production builds normally remove debug metadata
-> - captures the location where the element is _used_; definition locations are recovered when react exposes an owned child debug stack
-> - react 18 requires `_debugSource` from the JSX source transform (see [react#31981](https://github.com/facebook/react/issues/31981))
-> - react 19 uses `_debugStack` and works for both composite and host fibers
-> - source-map fetching is optional; runtimes without `fetch` still receive the unsymbolicated source location
-
-`getSourceMap` accepts an optional fetch implementation plus request limits, an abort signal, and a timeout. its cache is scoped to the fetch implementation so credentials or virtual file systems cannot leak results into each other.
+Production builds may omit source information. Runtimes without `fetch` receive unsymbolicated locations.
 
-### getOwnerStack / getParentStack
-
-returns a symbolicated stack of components above a fiber.
-
-`getOwnerStack` walks the chain of components that _created_ this fiber's JSX (react's `_debugOwner` chain), with exact creation-site locations on react 19, including server component owners. wrappers that merely render `{children}` don't appear. it automatically falls back to `getParentStack` when no usable owner frames exist (e.g. react <19).
-
-`getParentStack` walks _all_ ancestors in the render tree (the fiber's `return` chain), including `{children}` wrappers. works on every react version.
+Pass a custom `SourceFetch` for packaged bundles, virtual filesystems, or renderer-specific URLs:
 
 ```typescript
-import { getOwnerStack, getParentStack } from "bippy/source";
-
-const ownerFrames = await getOwnerStack(fiber);
-// [{ functionName: "Button", fileName: "src/button.tsx", lineNumber: 12, ... }, ...]
+import { getSource, type SourceFetch } from "bippy/source";
 
-const parentFrames = await getParentStack(fiber);
-// includes every wrapper between the fiber and the root
-```
+const sourceFetch: SourceFetch = async (url, init) => {
+  const artifact = sourceArtifacts.get(url);
+  if (!artifact) return fetch(url, init);
 
-## example
-
-here's a mini toy version of [`react-scan`](https://github.com/aidenybai/react-scan) that highlights renders in your app.
-
-```javascript
-import { instrument, getNearestHostFiber, traverseRenderedFibers } from "bippy"; // must be imported BEFORE react
-
-const highlightFiber = (fiber) => {
-  if (!(fiber.stateNode instanceof HTMLElement)) return;
-  // fiber.stateNode is a DOM element
-  const rect = fiber.stateNode.getBoundingClientRect();
-  const highlight = document.createElement("div");
-  highlight.style.border = "1px solid red";
-  highlight.style.position = "fixed";
-  highlight.style.top = `${rect.top}px`;
-  highlight.style.left = `${rect.left}px`;
-  highlight.style.width = `${rect.width}px`;
-  highlight.style.height = `${rect.height}px`;
-  highlight.style.zIndex = "999999999";
-  document.documentElement.appendChild(highlight);
-  setTimeout(() => {
-    document.documentElement.removeChild(highlight);
-  }, 100);
+  const sourceMapUrl = artifact.sourceMapUrl;
+  const headers = sourceMapUrl ? { SourceMap: sourceMapUrl } : undefined;
+  return new Response(artifact.content, { headers });
 };
 
-/**
- * `instrument` is a function that installs the react DevTools global
- * hook and allows you to set up custom handlers for react fiber events.
- */
-instrument({
-  /**
-   * `onCommitFiberRoot` is a handler that is called when react is
-   * ready to commit a fiber root. this means that react is has
-   * rendered your entire app and is ready to apply changes to
-   * the host tree (e.g. via DOM mutations).
-   */
-  onCommitFiberRoot(rendererID, root) {
-    /**
-     * `traverseRenderedFibers` traverses the fiber tree and determines which
-     * fibers have actually rendered.
-     *
-     * A fiber tree contains many fibers that may have not rendered. this
-     * can be because it bailed out (e.g. `useMemo`) or because it wasn't
-     * actually rendered (if <Child> re-rendered, then <Parent> didn't
-     * actually render, but exists in the fiber tree).
-     */
-    traverseRenderedFibers(root, (fiber) => {
-      /**
-       * `getNearestHostFiber` is a utility function that finds the
-       * nearest host fiber to a given fiber.
-       *
-       * a host fiber for `react-dom` is a fiber that has a DOM element
-       * as its `stateNode`.
-       */
-      const hostFiber = getNearestHostFiber(fiber);
-      highlightFiber(hostFiber);
-    });
-  },
-});
+const source = await getSource(fiber, true, sourceFetch);
 ```
 
-## renderer support
-
-bippy observes renderers through the React DevTools global hook. a renderer is automatically supported when it injects its reconciler and forwards commits to that hook.
+### `getOwnerStack`
 
-| level         | renderers                                        | coverage                                                                                                                |
-| ------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
-| automatic     | React DOM, Remotion                              | unit matrix and browser e2e                                                                                             |
-| automatic     | React Native Fabric, React Native Skia           | iOS and Android Detox e2e                                                                                               |
-| automatic     | React Three Fiber, Ink, react-nil                | unit matrix                                                                                                             |
-| automatic     | `@opentui/react`, `@pixi/react`, React BabylonJS | unit matrix with non-DOM host instances                                                                                 |
-| compatibility | `@react-pdf/renderer`                            | its real reconciler root is forwarded through a synthetic DevTools hook bridge because react-pdf does not inject itself |
-| compatibility | React Konva                                      | its exported reconciler is injected by a test bridge because upstream automatic injection is disabled                   |
+Returns the symbolicated stack of components that created a Fiber’s JSX. It falls back to the parent stack when owner information is unavailable.
 
-compatibility entries are not zero-config support claims. the bridge implementations in [`packages/bippy/tests/renderer-adapters.tsx`](packages/bippy/tests/renderer-adapters.tsx) verify bippy's fiber APIs against the real host trees while keeping the missing upstream DevTools integration explicit. React Native Windows, macOS, and NativeScript are not currently asserted.
-
-terminal renderers must load bippy before their reconciler initializes. importing `bippy` first works in Node and Bun; `bippy/install-hook-only` is also available as a minimal prelude when application import order is controlled elsewhere. the test suite verifies OpenTUI in clean Node and Bun processes and verifies that Ink can replace the hook with full React DevTools without losing either renderer.
-
-`@testing-library/react` is a React DOM testing utility, not a renderer. bippy uses it throughout the test suite, including hydration, event-driven updates, portals, unmounts, and error-boundary recovery.
+```typescript
+import { getOwnerStack } from "bippy/source";
 
-## glossary
+const ownerFrames = await getOwnerStack(fiber);
+```
 
-- fiber: a “unit of execution” in react, representing a component or dom element
-- commit: the process of applying changes to the host tree (e.g. DOM mutations)
-- render: the process of building the fiber tree by executing component function/classes
-- host tree: the tree of UI elements that react mutates (e.g. DOM elements)
-- reconciler (or “renderer”): custom bindings for react, e.g. react-dom, react-native, react-three-fiber, etc to mutate the host tree
-- `rendererID`: the id of the reconciler, starting at 1 (can be from multiple reconciler instances)
-- `root`: a special `FiberRoot` type that contains the container fiber (the one you pass to `ReactDOM.createRoot`) in the `current` property
-- `onCommitFiberRoot`: called when react is ready to commit a fiber root
-- `onPostCommitFiberRoot`: called when react has committed a fiber root and effects have run
-- `onCommitFiberUnmount`: called when a fiber unmounts
+### `getParentStack`
 
-## misc
+Returns the symbolicated stack of every ancestor in a Fiber’s return chain.
 
-we initially created bippy for [react-scan](https://github.com/aidenybai/react-scan), which ships with safeguards so it only runs in development or error-guarded in production.
+```typescript
+import { getParentStack } from "bippy/source";
 
-if you're seeking more robust solutions, you might consider [its-fine](https://github.com/pmndrs/its-fine) for accessing fibers within react using hooks, or [react-devtools-inline](https://www.npmjs.com/package/react-devtools-inline) for a headful interface.
+const parentFrames = await getParentStack(fiber);
+```
 
-if you plan to use this project beyond experimentation, please review [react-scan's source code](https://github.com/aidenybai/react-scan) to understand our safeguarding practices.
+## Acknowledgements
 
-the original bippy character is owned and created by [@dairyfreerice](https://www.instagram.com/dairyfreerice). this project is not related to the bippy brand, i just think the character is cute.
+[@dairyfreerice](https://www.instagram.com/dairyfreerice) created and owns the original bippy character. this project has nothing to do with the bippy brand, i think the character is cute.