@mushi-mushi/web 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kenji Sakuramoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,71 @@
+# @mushi-mushi/web
+
+Browser SDK for Mushi Mushi — embeddable bug reporting widget with Shadow DOM isolation.
+
+## Features
+
+- Shadow DOM widget with full CSS isolation from host page
+- Console log capture (ring buffer)
+- Network request capture (fetch interceptor)
+- Screenshot capture (canvas-based)
+- Web Vitals / performance metrics
+- IndexedDB offline queue with auto-sync
+- On-device pre-filter (blocks spam before server submission)
+- Client-side rate limiting (token bucket self-throttle)
+- Light/dark theme with auto-detection
+- **Proactive triggers** — rage click, long task, API cascade failure detection
+- **Report fatigue prevention** — session limits, cooldowns, permanent suppression
+
+## Contents
+
+### Proactive Manager (`proactive-manager.ts`)
+
+Controls report prompt frequency to prevent fatigue:
+- `maxProactivePerSession` (default 2) — cap per browser session
+- `dismissCooldownHours` (default 24) — suppress after dismissal
+- `suppressAfterDismissals` (default 3) — permanently disable after N consecutive dismissals
+- Smart dedup — same trigger type not shown twice per session
+
+### Proactive Triggers (`proactive-triggers.ts`)
+
+Auto-detects conditions that should prompt the user:
+- **Rage click** — 3+ clicks in < 500ms on same element
+- **Long task** — > 5s main thread block (PerformanceObserver)
+- **API cascade** — 3+ failed requests in 10s window
+
+## Bundle Size
+
+~6 KB brotli (limit: 30 KB). Requires `@mushi-mushi/core` as a dependency (not bundled inline).
+
+## Quick Start
+
+```typescript
+import { Mushi } from '@mushi-mushi/web';
+
+Mushi.init({
+  projectId: 'proj_xxx',
+  apiKey: 'your-api-key',
+  widget: { position: 'bottom-right', theme: 'auto' },
+  capture: { console: true, network: true, screenshot: 'on-report' },
+});
+```
+
+### With Proactive Triggers
+
+```typescript
+import { createProactiveManager, setupProactiveTriggers } from '@mushi-mushi/web';
+
+const manager = createProactiveManager({ maxProactivePerSession: 2 });
+
+setupProactiveTriggers({
+  onTrigger: (type, context) => {
+    if (manager.shouldShow(type)) {
+      // Open widget with pre-filled context
+    }
+  },
+});
+```
+
+## License
+
+MIT