@buoy-gg/images 7.0.36 → 7.0.39

package/README.md

@@ -2,11 +2,11 @@
 
 [![npm version](https://img.shields.io/npm/v/@buoy-gg/images?style=flat-square&labelColor=1c1c1c&color=10B981)](https://www.npmjs.com/package/@buoy-gg/images) [![npm downloads](https://img.shields.io/npm/dm/@buoy-gg/images?style=flat-square&labelColor=1c1c1c&color=10B981)](https://www.npmjs.com/package/@buoy-gg/images)
 
-**See every image your app loads — where it came from, how long it took, what it cost, and why it failed.**
+Inspect image loads observed by Buoy’s supported image hooks, including timing, dimensions, and estimated decoded memory.
 
-Part of [Buoy](https://github.com/Buoy-gg/buoy) — devtools that live inside your React Native app. Install it and it auto-appears in the floating menu from [`@buoy-gg/core`](https://www.npmjs.com/package/@buoy-gg/core).
+Part of [Buoy](https://github.com/Buoy-gg/buoy). Install the package, complete account setup, and follow the integration steps below.
 
-Image HTTP requests never touch the JS network stack — network devtools are permanently blind to them. This tool is the visibility layer: a live registry of every RN `<Image>` and [`expo-image`](https://docs.expo.dev/versions/latest/sdk/image/) load, with cache verdicts, timings, and size auditing. Pure JS — works in Expo Go and release builds.
+Native image loading can bypass JavaScript network capture. This package instruments supported React Native `Image` and `expo-image` paths to provide image-specific details.
 
 ## Install
 
@@ -22,6 +22,24 @@ import "@buoy-gg/images/register";
 
 > Why first? RN core's `<Image>` instrumentation uses React Native's official component-decorator hook, which must be installed before the Image module first evaluates. expo-image capture has no such constraint — it works no matter when the tool loads. If you skip the import, the tool tells you what it's missing instead of sitting silently empty.
 
+## Before you start
+
+Use a development build with `@buoy-gg/core` and a Free or Pro Buoy account key. From your app’s directory, sign in:
+
+```bash
+npx --package=@buoy-gg/core buoy login
+```
+
+For Expo, initialize Buoy before rendering the menu:
+
+```tsx
+import { Buoy } from "@buoy-gg/core";
+
+Buoy.init({ licenseKey: process.env.EXPO_PUBLIC_BUOY_KEY });
+```
+
+The login command writes the Expo key to `.env.local`. For React Native CLI, pass the key from your app’s environment configuration; React Native does not load `.env.local` automatically. Mount `FloatingDevTools` inside the same providers as your screens and restart the development server after installation. The [Quick Start](https://buoy.gg/buoy/latest/docs/quick-start) shows the complete root component setup.
+
 ## Quick start
 
 ```tsx
@@ -37,22 +55,26 @@ export default function App() {
 }
 ```
 
-The IMAGES tool appears in the menu. Open it and browse every image the session has loaded.
+The IMAGES tool appears in the menu. Open it and browse image loads observed during the session.
+
+## Check the integration
+
+Load a supported image after the capture hook is installed and inspect the entry. Treat cache results according to the image library’s available signals and decoded memory as an estimate. Native image paths outside those hooks may not appear.
 
 ## What you get
 
-- **Live image registry** — every RN `<Image>` and expo-image load: thumbnail, source, status, load time, decoded dimensions
+- **Live image registry** — observed RN `<Image>` and expo-image loads: thumbnail, source, status, load time, decoded dimensions
 - **Cache verdicts** — memory / disk / network per load (expo-image reports it directly; RN core is classified via `Image.queryCache`)
 - **Oversize auditing** — decoded size vs displayed size × device pixel ratio, Lighthouse-style: green within 10%, red beyond 50%, with estimated wasted decoded memory and the exact size you should serve
 - **Memory accounting** — estimated decoded-bitmap bytes per image and totals across the session (catch ballooning before the OOM)
-- **Failure log** — every `onError` with the message, and on iOS the HTTP status code + response headers
+- **Failure log** — captured `onError` events with the message, and on iOS the HTTP status code + response headers
 - **Cache actions** — clear expo-image memory/disk caches from the detail view
 - **Upscale detection** — tiny sources stretched into big boxes (blurry images) get flagged too
 
 ## Desktop & AI
 
-The same live session streams to [Buoy Desktop](https://github.com/Buoy-gg/Buoy-Desktop) (free, macOS/Windows/Linux) and to Claude Code or Cursor via the [Buoy MCP server](https://buoy.gg/buoy/latest/docs/mcp).
+To connect a React Native app to [Buoy Desktop](https://github.com/Buoy-gg/Buoy-Desktop) or MCP, install `@buoy-gg/external-sync` and follow the [Desktop connection guide](https://buoy.gg/buoy/latest/docs/desktop). Sign in to Desktop separately. [MCP setup](https://buoy.gg/buoy/latest/docs/mcp) also requires a process account and Pro access. Available remote actions depend on the tool and app integration.
 
-## Free vs Pro
+## Account and plan requirements
 
-Every tool is free. [Pro](https://buoy.gg/pricing) unlocks production builds, the MCP server, and unlimited capture. Every weekend, Pro features unlock free for anyone holding a key — including a free one (`npx buoy login`).
+Use a Free or Pro Buoy account. History limits and paid features vary by tool; see [pricing](https://buoy.gg/pricing). Production access requires Pro where supported. Development-only hooks and actions remain unavailable in release builds.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@buoy-gg/images",
-  "version": "7.0.36",
-  "description": "Debug every image in your React Native app — live load registry, cache verdicts (memory/disk/network), timings, oversize + wasted-memory checks, and failure diagnosis for RN <Image> and expo-image. Part of Buoy devtools.",
+  "version": "7.0.39",
+  "description": "Inspect instrumented React Native Image and expo-image loads, available cache and timing data, failures, and image-size estimates.",
   "main": "lib/commonjs/index.js",
   "module": "lib/module/index.js",
   "types": "lib/typescript/index.d.ts",
@@ -17,7 +17,7 @@
     "**/index.*"
   ],
   "dependencies": {
-    "@buoy-gg/shared-ui": "^7.0.36"
+    "@buoy-gg/shared-ui": "^7.0.39"
   },
   "peerDependencies": {
     "expo-image": "*",

package/register.js

@@ -6,10 +6,10 @@
  * module evaluates. Works with and without package `exports` resolution
  * (e.g. Metro `unstable_enablePackageExports: false`).
  *
- * Resolves to src (Metro transpiles TS in node_modules) so it shares ONE
- * module instance with the package root import, which also resolves to src
- * via the "react-native" main field — a lib-pointing shim would create a
- * second copy of the capture layer and split the decorator from the store.
- * Capture state is additionally globalThis-keyed as a second line of defense.
+ * Resolves to lib/module, the same tree the package root resolves to through
+ * the "react-native" field, so it shares ONE module instance with the root
+ * import. (`src/` is not published; a src-pointing shim would fail to resolve
+ * in an installed app.) Capture state is additionally globalThis-keyed as a
+ * second line of defense.
  */
-module.exports = require("./src/register");
+module.exports = require("./lib/module/register");