@picked/sentry 0.0.101-next.2 → 0.0.101

package/README.md

@@ -1,37 +1,42 @@
-# Sentry Plugin
+# @picked/sentry
 
-This plugin is responsible for listening for the Picked Client `eventBus` and interacting with a Sentry instance by adding tags and triggering `captureMessage` and `captureException`.
+Reports the errors of the Picked client to Sentry, and tags Sentry events with the Picked
+session, feature flags and user decision.
 
-This are the events listened by the Plugin:
+## Install
 
-- `exception`: When an `exception` event is added to the `eventBus` the plugin will automatically check the `level` and based on that call `captureException` when the `level` is `error` and `captureMessage` when the `level` is `info`.
-- `session`: When the `session` event happens, the Plugin will add the tag `picked.id` to the Sentry global scope with the session id as value. Example: `picked.id: 000000000`
-- `feature_decide`: When the `feature_decide` event happens, the Plugin will add the tag `picked.feature.[FEATURE_ID]` to the Sentry global scope with the bucket as value. Example: `picked.feature.my_feature: true`
-- `user_decide`: When the `user_decide` event happens, the Plugin will add the tag `picked.is_user` with the `user_decide` value. Example: `picked.is_user: true`
-
-## ⚠️ Version Compatibility
-
-This plugin depends on Sentry's internal carrier implementation. **Version mismatches between your application's Sentry SDK and the version used by `@picked/sentry` plugin will cause the plugin to stop working.**
-
-**Requirements:**
-
-- **Sentry SDK Version**: This plugin requires Sentry SDK version `^10.0.0`
-- **Peer Dependencies**: This plugin requires `@sentry/browser` to be installed in the client, as it is a peerdepency in this package. This ensures version compatibility between the client and the plugin
-- **Package Compatibility**: All Sentry packages (`@sentry/browser`, `@sentry/svelte`, `@sentry/node`, etc.) must use the same major version to ensure proper functionality
-
-**Note**: Install the appropriate Sentry package for your framework alongside this plugin. The plugin will use the same Sentry instance from the client, preventing version conflicts.
+```bash
+npm install picked @picked/sentry @sentry/browser
+```
 
-## 🚀 Quick Start
+Requires Sentry SDK 10. Every Sentry package in your application must be on the same major
+version, or the plugin and your application see different Sentry scopes.
 
-Here's a basic example of how to use the `Sentry` Plugin:
+## Usage
 
 ```typescript
-// app.ts file
-import { getClient } from '@sentry/svelte'
+import * as Sentry from '@sentry/browser'
+import { createClient } from 'picked'
 import { sentryPlugin } from '@picked/sentry'
 
-const client = createClient({
-  // ... values
-  plugin: [sentryPlugin(getClient())], // Usually the array of plugins are defined earlier, so you can add the sentry plugin there
+Sentry.init({ dsn: 'your-sentry-dsn' })
+
+export const picked = createClient({
+  projectId: 'your-project-id',
+  plugins: [sentryPlugin()],
 })
 ```
+
+| Client event     | In Sentry                                                                             |
+| ---------------- | ------------------------------------------------------------------------------------- |
+| `exception`      | `captureMessage` at `info` level, otherwise `captureException`; tagged `picked: true` |
+| `session`        | Tag `picked.id`: the session ID                                                       |
+| `feature_decide` | Tag `picked.feature.<feature ID>`: the bucket                                         |
+| `user_decide`    | Tag `picked.is_user`                                                                  |
+
+## Docs
+
+- **Web:** [Sentry](https://docs.picked.app/reference/sdk/plugins/sentry)
+- **Local:** `node_modules/picked/docs/reference/sdk/plugins/sentry.md`. The `picked` package carries every page under `node_modules/picked/docs/`.
+- **CLI:** `npx picked docs read /reference/sdk/plugins/sentry`. `npx picked docs list [words]` lists the pages.
+- **MCP:** call `read_picked_doc` with `{ "path": "/reference/sdk/plugins/sentry" }`; `list_picked_docs` lists the pages. Add the server with `claude mcp add --transport http picked https://api.picked.app/mcp`, or see [How to connect the MCP server](https://docs.picked.app/how-to/connect-the-mcp-server) for other tools.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@picked/sentry",
   "description": "Sentry plugin",
-  "version": "0.0.101-next.2",
+  "version": "0.0.101",
   "devDependencies": {
     "@picked/client": "workspace:*",
     "@picked/svelte": "workspace:*",
@@ -47,7 +47,7 @@
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "peerDependencies": {
-    "@picked/client": "0.0.101-next.2",
+    "@picked/client": "0.0.101",
     "@sentry/browser": "^10"
   },
   "private": false,