@sphoro/bugcatch-web-sdk 0.18.0 → 0.19.0

package/README.md

@@ -55,7 +55,7 @@ BugCatch.init({
 ```html
 <!-- Pin the version. Without one the CDN serves whatever is latest, so a
      future release changes behaviour on a site nobody redeployed. -->
-<script src="https://unpkg.com/@sphoro/bugcatch-web-sdk@0.18.0/dist/bugcatch.umd.js"></script>
+<script src="https://unpkg.com/@sphoro/bugcatch-web-sdk@0.19.0/dist/bugcatch.umd.js"></script>
 <script>
   BugCatch.init({ apiBase: '…', apiKey: 'bc_live_…', projectId: '…' });
 </script>
@@ -372,8 +372,8 @@ On top of that:
 | `onError` | — | See [Events](#events). |
 | `widget` | `true` | Floating launcher and panel. `false` to drive everything from your own UI. |
 | `widgetPosition` | `'bottom-right'` | `bottom-left`, `top-right`, `top-left`. |
-| `theme` | `'auto'` | `auto` follows the system; `light` / `dark` pin it. A visitor's own choice in the widget wins on later visits. |
-| `accent` | `'#4F46E5'` | Any CSS colour. |
+| `theme` | `'auto'` | `auto` follows the system; `light` / `dark` pin it. Visitors can change it from the panel's header, and their choice wins on later visits. |
+| `accent` | `null` | Any CSS colour, for the launcher, buttons and the assistant's orb. Text on it is white or near-black, whichever reads. `null` is ink: black on light, white on dark. |
 | `captureConsole` / `captureNetwork` / `captureErrors` | `true` | Each capture can be switched off. |
 | `consoleLimit` / `networkLimit` | `100` / `50` | Entries retained. |
 | `attachments` | `true` | Offer screenshot, recording and file attach. |
@@ -414,6 +414,8 @@ BugCatch.off(event, handler);
 await BugCatch.myReports();               // everything filed from this browser
 await BugCatch.myReport(bugId);           // one report, with timeline and assistant phase
 await BugCatch.replyToReport(bugId, { body, attachments });
+await BugCatch.verifyFix(bugId, { result, resolvedAt, note }); // 'CONFIRMED' | 'STILL_HAPPENING'
+await BugCatch.rate(bugId, { score, comment });                 // 1–5, once it is settled
 BugCatch.unreadUpdates(); BugCatch.markUpdateRead(id); BugCatch.markReportRead(bugId); BugCatch.markUpdatesRead();
 BugCatch.hasReports(); BugCatch.forgetReports();
 
@@ -716,6 +718,37 @@ attachments stay images and video, because they are typed `SCREENSHOT` or
 `report.canReply` says whether this reader can write back; the widget hides its
 composer when it is false rather than offering a box that would fail on send.
 
+### Asking how it went
+
+Once a report is resolved or closed, the widget asks the reporter **How did we
+do?** under it: five stars, one tap to send, and a box for a note after the
+tap rather than before — a form that asks for a sentence first is a form people
+close. Their list of reports says **Rate it** against the settled ones still
+waiting for a rating, and shows the score on the ones that have one.
+
+The same rating is asked for on the reporter's own page and in the email that
+tells them it was fixed, so whichever they answer is the one that counts.
+Rating again replaces the earlier score. Whether a project asks at all is
+**Project Settings → Resolutions → Ask the reporter to rate it**, on by default.
+
+To drive it from your own UI:
+
+```js
+const report = await BugCatch.myReport(id);
+
+if (report.ratingAsked) {
+  // report.rating is null until they rate, then
+  // { score: 4, comment: 'Quick, thanks', ratedAt, via: 'widget', current: true }
+  await BugCatch.rate(id, { score: 4, comment: 'Quick, thanks' });
+}
+```
+
+`ratingAsked` is true only for a settled report on a project that asks; `rate()`
+rejects otherwise. `rating.current` is false when the report was reopened and
+fixed again after the rating was given — the rating stands, but it was about an
+earlier fix. In `myReports()`, each row carries `rating` (the score, or null)
+and `ratingAsked`.
+
 ### Reporting from your own UI
 
 ```js