lumely-react 0.1.0 → 0.1.1
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.
- package/README.md +24 -20
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
#
|
|
1
|
+
# lumely-react
|
|
2
2
|
|
|
3
3
|
AI-powered error handling for React applications. Automatically catches errors, explains them to users in plain language, and provides developers with AI-generated fix suggestions.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install
|
|
8
|
+
npm install lumely-react
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Quick Start
|
|
12
12
|
|
|
13
13
|
```tsx
|
|
14
|
-
import { LumelyProvider } from '
|
|
14
|
+
import { LumelyProvider } from 'lumely-react';
|
|
15
15
|
|
|
16
16
|
function App() {
|
|
17
17
|
return (
|
|
@@ -25,34 +25,38 @@ function App() {
|
|
|
25
25
|
}
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
That's it
|
|
28
|
+
That's it. Lumely will automatically catch errors and display a user-friendly overlay.
|
|
29
29
|
|
|
30
30
|
## Features
|
|
31
31
|
|
|
32
|
-
-
|
|
33
|
-
-
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
-
|
|
32
|
+
- **AI-Powered Explanations** - Errors are explained in plain language
|
|
33
|
+
- **User Feedback** - Collect context about what users were doing
|
|
34
|
+
- **Modern Glassmorphism UI** - Beautiful, customizable overlay
|
|
35
|
+
- **Fast Response** - User message appears in ~2s, detailed analysis runs in background
|
|
36
|
+
- **Secure** - API keys stay on your server
|
|
37
37
|
|
|
38
38
|
## Props
|
|
39
39
|
|
|
40
40
|
| Prop | Type | Required | Description |
|
|
41
41
|
|------|------|----------|-------------|
|
|
42
|
-
| `apiKey` | `string` |
|
|
43
|
-
| `apiEndpoint` | `string` |
|
|
44
|
-
| `environment` | `'development' \| 'production'` |
|
|
45
|
-
| `userId` | `string` |
|
|
46
|
-
| `sessionId` | `string` |
|
|
47
|
-
| `onError` | `(report) => void` |
|
|
42
|
+
| `apiKey` | `string` | Yes | Your Lumely API key |
|
|
43
|
+
| `apiEndpoint` | `string` | Yes | URL to your Lumely API |
|
|
44
|
+
| `environment` | `'development' \| 'production'` | No | Environment name |
|
|
45
|
+
| `userId` | `string` | No | Current user's ID |
|
|
46
|
+
| `sessionId` | `string` | No | Session ID (auto-generated if not provided) |
|
|
47
|
+
| `onError` | `(report) => void` | No | Callback when error is caught |
|
|
48
48
|
|
|
49
49
|
## How It Works
|
|
50
50
|
|
|
51
|
-
1. **Error Caught**
|
|
52
|
-
2. **Reported**
|
|
53
|
-
3. **AI Analysis**
|
|
54
|
-
4. **Overlay Shown**
|
|
55
|
-
5. **Saved**
|
|
51
|
+
1. **Error Caught** - React Error Boundary catches the crash
|
|
52
|
+
2. **Reported** - Error details sent to your Lumely API
|
|
53
|
+
3. **AI Analysis** - Gemini analyzes and generates user-friendly message
|
|
54
|
+
4. **Overlay Shown** - User sees explanation and can provide feedback
|
|
55
|
+
5. **Saved** - Everything stored in your database
|
|
56
|
+
|
|
57
|
+
## Documentation
|
|
58
|
+
|
|
59
|
+
Visit [lumely.vercel.app](https://lumely.vercel.app) for full documentation.
|
|
56
60
|
|
|
57
61
|
## License
|
|
58
62
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "lumely-react",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "AI-powered error handling for React applications",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -47,8 +47,8 @@
|
|
|
47
47
|
"type": "git",
|
|
48
48
|
"url": "https://github.com/lumely/lumely-react"
|
|
49
49
|
},
|
|
50
|
-
"homepage": "https://lumely.
|
|
50
|
+
"homepage": "https://lumely.vercel.app",
|
|
51
51
|
"bugs": {
|
|
52
52
|
"url": "https://github.com/lumely/lumely-react/issues"
|
|
53
53
|
}
|
|
54
|
-
}
|
|
54
|
+
}
|