@qaiddev/thumbs-embed 1.1.1 → 1.2.0

package/README.md

@@ -173,6 +173,29 @@ new QaidEmbed({
 
 Screenshots use the browser's Screen Capture API. The user will see a permission dialog. If they decline or the API is unavailable, the feedback is still submitted without a screenshot.
 
+### Linking buttons to quests
+
+Instead of the optional message box, a button can open a **quest** — a short questionnaire powered by [`@qaiddev/quests-embed`](https://www.npmjs.com/package/@qaiddev/quests-embed). You can ask one set of questions after a thumbs-up, a different set after a thumbs-down, and another after a video recording is sent. The quest widget is loaded on demand from a CDN the first time it's needed, so the thumbs bundle stays zero-dependency; if it can't load, the classic message box is shown instead.
+
+```typescript
+new QaidEmbed({
+  endpoint: 'https://qaid.dev/api/feedback',
+  apiKey: 'YOUR_API_KEY',
+  captureVideo: true,
+  quests: {
+    // Base URL of the quest service. Required to enable the feature.
+    base: 'https://qaid.dev/api/quests',
+    up: 'QUEST_ID_FOR_THUMBS_UP',     // optional, per button
+    down: 'QUEST_ID_FOR_THUMBS_DOWN',
+    video: 'QUEST_ID_AFTER_VIDEO',
+    // apiKey defaults to the top-level apiKey; override only if different.
+    // moduleUrl overrides where the quests widget is loaded from.
+  },
+});
+```
+
+`base` is the only required field — omit a button's id to keep the normal message box for that button. The embed derives the quest definition URL (`{base}/{questId}/definition`) and the response endpoint (`{base}/responses`) from it, and passes the created feedback record's id to the quest so its answers are joined back to that feedback on the server.
+
 ## Script Tag Data Attributes
 
 When using the script tag method, all config options are available as `data-*` attributes:
@@ -207,6 +230,12 @@ When using the script tag method, all config options are available as `data-*` a
 | `data-skip-button` | `text.skipButton` |
 | `data-positive-icon` | `positiveIcon` |
 | `data-negative-icon` | `negativeIcon` |
+| `data-quest-base` | `quests.base` |
+| `data-quest-up` | `quests.up` |
+| `data-quest-down` | `quests.down` |
+| `data-quest-video` | `quests.video` |
+| `data-quest-api-key` | `quests.apiKey` |
+| `data-quest-module-url` | `quests.moduleUrl` |
 
 ## Custom Button Container
 

package/dist/embed.d.ts

@@ -14,6 +14,7 @@ export declare class QaidFeedback {
     private feedbackData;
     private selectedBounds;
     private feedbackId;
+    private activeQuest;
     private mousePos;
     private isMobile;
     private visitorId;
@@ -120,6 +121,25 @@ export declare class QaidFeedback {
     private showSelectedMarker;
     private hideSelectedMarker;
     private submitFeedback;
+    /**
+     * Quest id linked to `type`, or "" when quest launching is disabled
+     * (no `base`) or this button has no quest configured.
+     */
+    private questIdFor;
+    /**
+     * Launch the quest linked to `type`, if any. Resolves `true` when a quest
+     * was configured and the widget launched; `false` when no quest is
+     * configured or the widget failed to load (caller falls back to its
+     * normal UI). The created feedback record id is passed through so the
+     * quest response can be joined back to it server-side.
+     */
+    private tryLaunchQuest;
+    /**
+     * Reset the thumbs targeting/marker UI back to idle without opening or
+     * closing the message modal. Shared by closeModal() and the quest-launch
+     * path (which bypasses the modal entirely).
+     */
+    private resetFeedbackUi;
     private showModal;
     private showBottomSheet;
     private showPositionedModal;

package/dist/index.d.ts

@@ -29,7 +29,7 @@
  */
 import { QaidFeedback } from "./embed";
 export { QaidFeedback };
-export type { FeedbackConfig, ResolvedFeedbackConfig, ConsoleError, NetworkError, FeedbackData, SelectedBounds, FeedbackPayload, FeedbackResponse, FeedbackMessagePayload, } from "./types";
+export type { FeedbackConfig, QuestsLaunchConfig, ResolvedFeedbackConfig, ConsoleError, NetworkError, FeedbackData, SelectedBounds, FeedbackPayload, FeedbackResponse, FeedbackMessagePayload, } from "./types";
 export { captureNetworkErrors } from "./network-capture";
 export type { NetworkCapture } from "./network-capture";
 export { createVideoRecorder, isVideoRecordingSupported, getSupportedMimeType } from "./video-capture";