@buoy-gg/events 7.0.36 → 7.0.39

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +27 -5
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -2,9 +2,9 @@
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/@buoy-gg/events?style=flat-square&labelColor=1c1c1c&color=10B981)](https://www.npmjs.com/package/@buoy-gg/events) [![npm downloads](https://img.shields.io/npm/dm/@buoy-gg/events?style=flat-square&labelColor=1c1c1c&color=10B981)](https://www.npmjs.com/package/@buoy-gg/events)
4
4
 
5
- **One chronological timeline across every tool — network, storage, Redux, React Query, routes — so you can watch a whole user flow unfold in order.**
5
+ Review events from configured Buoy tools in one timeline. Filter by source, inspect an event, and export a selection for debugging.
6
6
 
7
- 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).
7
+ Part of [Buoy](https://github.com/Buoy-gg/buoy). Install the package, complete account setup, and follow the integration steps below.
8
8
 
9
9
  ## Install
10
10
 
@@ -12,6 +12,24 @@ Part of [Buoy](https://github.com/Buoy-gg/buoy) — devtools that live inside yo
12
12
  npm install @buoy-gg/core @buoy-gg/events
13
13
  ```
14
14
 
15
+ ## Before you start
16
+
17
+ Use a development build with `@buoy-gg/core` and a Free or Pro Buoy account key. From your app’s directory, sign in:
18
+
19
+ ```bash
20
+ npx --package=@buoy-gg/core buoy login
21
+ ```
22
+
23
+ For Expo, initialize Buoy before rendering the menu:
24
+
25
+ ```tsx
26
+ import { Buoy } from "@buoy-gg/core";
27
+
28
+ Buoy.init({ licenseKey: process.env.EXPO_PUBLIC_BUOY_KEY });
29
+ ```
30
+
31
+ 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.
32
+
15
33
  ## Quick start
16
34
 
17
35
  ```tsx
@@ -29,6 +47,10 @@ export default function App() {
29
47
 
30
48
  That's it. The EVENTS tool appears in the menu and automatically captures from every Buoy tool you have installed — no per-source setup.
31
49
 
50
+ ## Check the integration
51
+
52
+ Enable a configured source, trigger a known event in your app, and filter the timeline to that source. Capture settings and history limits determine what the timeline and exports contain.
53
+
32
54
  ## What you get
33
55
 
34
56
  - **One timeline, every source** — network requests, AsyncStorage/MMKV writes, Redux actions, React Query queries and mutations, Zustand, Jotai, and navigation events, interleaved chronologically
@@ -41,11 +63,11 @@ That's it. The EVENTS tool appears in the menu and automatically captures from e
41
63
 
42
64
  ## Desktop & AI
43
65
 
44
- 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).
66
+ 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.
45
67
 
46
- ## Free vs Pro
68
+ ## Account and plan requirements
47
69
 
48
- 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`).
70
+ 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.
49
71
 
50
72
  ---
51
73
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@buoy-gg/events",
3
- "version": "7.0.36",
4
- "description": "One timeline across every Buoy devtool, with LLM-ready export presets. Part of Buoy devtools.",
3
+ "version": "7.0.39",
4
+ "description": "Review retained events from connected Buoy tools and export timeline data for investigation.",
5
5
  "main": "lib/commonjs/index.js",
6
6
  "module": "lib/module/index.js",
7
7
  "types": "lib/typescript/index.d.ts",
@@ -26,8 +26,8 @@
26
26
  ],
27
27
  "sideEffects": false,
28
28
  "dependencies": {
29
- "@buoy-gg/floating-tools-core": "^7.0.36",
30
- "@buoy-gg/shared-ui": "^7.0.36"
29
+ "@buoy-gg/floating-tools-core": "^7.0.39",
30
+ "@buoy-gg/shared-ui": "^7.0.39"
31
31
  },
32
32
  "peerDependencies": {
33
33
  "react": "*",