@mhosaic/feedback 0.26.1 → 0.27.0

package/README.md

@@ -79,6 +79,30 @@ import { FeedbackProvider } from '@mhosaic/feedback/react'
 
 The CLI auto-wires this for Vite + React apps on `init`. For Next/Remix/Vue/SvelteKit/Astro/Nuxt, see the framework-specific reference docs at `packages/cli/skills/integrate-feedback/references/` (or `~/.claude/skills/integrate-feedback/references/` after `install-skill`).
 
+## Configuration
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `apiKey` | string | — | **Required.** Public key for this project (e.g. `pk_proj_…`). Obtained during `mhosaic-feedback provision`. |
+| `endpoint` | string | — | **Required.** Base URL of your mhosaic-feedback backend (e.g. `https://feedback.example.com`). The widget POSTs reports to `${endpoint}/api/feedback/v1/reports/`. |
+| `env` | string | `prod` | Environment tag (e.g. `prod`, `staging`, `dev`). Sent with every report; falls back to `prod` when unset. Useful for filtering backend reports by deployment. |
+| `user` | `UserIdentity` | `undefined` | Host-supplied user identity (`id`, `email`, `name`). Set via `fb.identify(…)` after auth resolves; the FAB stays hidden until then. |
+| `metadata` | object | `undefined` | Free-form key-value metadata sent with each report. Updated via `fb.setMetadata(…)`. |
+| `getCurrentPage` | function | `() => window.location.pathname` | Router-aware page-path resolver. Return the current page path (e.g. `/dashboard`) or null to fall back to `pathname`. Enables "feedback on this page" grouping when the Board is scoped. |
+| `openToCurrentPageFeedback` | boolean | `false` | When true, opening the FAB jumps to the Board scoped to the current page (if that page has feedback), else the Send form. Default false — the FAB opens to Send by default so the primary submit flow is uninterrupted. The "This page" chip on the Send tab and the Board's page-scope toggle are always available. Note: the Send-tab strip now passively surfaces the same "feedback on this page" info regardless of this flag. |
+| `showPageActivity` | boolean | `true` | Ambient page-activity surfaces: FAB count badge, hover peek panel, and the Send-tab "open reports on this page" strip. Identified users only. Set `false` to hide all three. The Board's This page / All pages control is always available. |
+| `showFAB` | boolean | `true` | Show/hide the main feedback FAB. Set `false` to hide; call `fb.show()` / `fb.hide()` to toggle at runtime. |
+| `theme` | string | `auto` | `light` \| `dark` \| `auto` \| `none` accepted by the type, but not yet wired to a resolver — the widget always follows the host's `prefers-color-scheme` (i.e. `auto` behavior) regardless of this setting. |
+| `locale` | string | auto-detected from `navigator.language` | Language code for UI text. Falls back to English for any locale other than `fr`, which ships built-in. |
+| `maskAllInputs` | boolean | `false` | Accepted by the type but not currently wired to screenshot capture — setting it has no effect today. Screenshots are user-attached only (dropzone/paste/file picker/annotator); nothing in the current submit flow auto-captures or masks the DOM. |
+| `sanitizeUrl` | function | — | Optional hook to redact sensitive URL segments before sending (e.g. tokens, session IDs). Receives the report's `page_url`; return the sanitized version. |
+| `beforeSend` | function | — | Optional hook to intercept/modify a report before submission. Receives the payload; return modified payload, `false` to cancel, or a promise. Useful for adding custom fields or blocking reports by type/severity. |
+| `onSubmitSuccess` | function | — | Optional callback on successful submission. Receives the `SubmittedReport` object (id, status, created_at). |
+| `onError` | function | — | Optional callback on widget errors (e.g. network failures, validation errors). Receives the `Error` object. |
+| `attachTo` | string \| Element | — | CSS selector or DOM element for widget mount point. Defaults to document body. |
+| `translations` | object | — | Override UI text strings. Merges with built-in locale strings. |
+| `qaMeter` | `QaMeterConfig` | `undefined` | Opt-in QA Meter (second FAB). Set `qaMeter.source` to enable (URL, inline artifact, or async loader). See [QA Meter integration](https://github.com/mhosaic-technologies/feedback-tool-mhosaic/blob/main/docs/qa-meter/INTEGRATING.md). |
+
 ## Opt-in modules
 
 | Subpath | What it does | Approx gzip |