@qaiddev/thumbs-embed 1.12.0 → 1.12.2

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.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +37 -13
  3. package/package.json +2 -2
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 QAid
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -3,7 +3,11 @@
3
3
  [![npm version](https://img.shields.io/npm/v/@qaiddev/thumbs-embed)](https://www.npmjs.com/package/@qaiddev/thumbs-embed)
4
4
  [![coverage](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fqaiddev%2Fthumbs-embed%2Fprod%2Fcoverage-badge.json)](https://github.com/qaiddev/thumbs-embed)
5
5
 
6
- A zero-dependency, lightweight feedback embed that adds thumbs up/down buttons to any website. Users can optionally target specific page elements, leave messages, and capture screenshots — all submitted to your API endpoint or the [QAid.dev hosted dashboard](https://qaid.dev).
6
+ A zero-dependency, lightweight feedback embed that adds thumbs up/down buttons to any website. Users can optionally target specific page elements, leave messages, capture screenshots, mark them up and record short videos — all submitted to your API endpoint or the [QAid.dev hosted dashboard](https://qaid.dev).
7
+
8
+ It needs 11.5 KB (gzipped) to draw its buttons. The rest loads later, and only when needed — see [What loads when](#what-loads-when).
9
+
10
+ ![Thumbs up and down buttons in the corner of a shop page](https://raw.githubusercontent.com/qaiddev/thumbs-embed/prod/docs/screenshots/buttons.png)
7
11
 
8
12
  ## Install
9
13
 
@@ -34,14 +38,27 @@ const feedback = new QaidFeedback({
34
38
 
35
39
  `embed.js` is a tiny classic loader that works in every browser: it feature-detects
36
40
  ES-module support and pulls in the right build automatically — the **progressive
37
- loader** (`loader.js`, a small core with screenshot/video/annotation/targeting loading
38
- on demand) on modern browsers, or the all-in-one UMD bundle (`qaid.umd.cjs`) on older
39
- ones. The injected build auto-initializes when it detects a `data-endpoint` attribute.
41
+ loader** (`loader.js`, a small core that only draws the buttons) on modern browsers,
42
+ or the all-in-one UMD bundle (`qaid.umd.cjs`) on older ones. The injected build
43
+ auto-initializes when it detects a `data-endpoint` attribute.
40
44
 
41
45
  > Prefer to skip the loader's feature-detect hop? Point straight at
42
46
  > `dist/loader.js` with `type="module"` (modern browsers only), or
43
47
  > `dist/qaid.umd.cjs` as a classic script (works everywhere, no code-splitting).
44
48
 
49
+ ### What loads when
50
+
51
+ Sizes are gzipped, for 1.12.
52
+
53
+ | When | Size | What it brings |
54
+ |------|------|----------------|
55
+ | Before paint | 0 KB | nothing; the tag waits (`defer`) |
56
+ | After paint | 11.5 KB | `embed.js`, `loader.js` and the core: draws the buttons |
57
+ | Pointer near the buttons, or browser idle | +11 KB | the message box, targeting and send code, so a click opens at once |
58
+ | Screenshot, as needed | +1 KB | the capture |
59
+ | Markup, as needed | +4.3 KB | the markup editor |
60
+ | Video, as needed | +6.9 KB | the recorder |
61
+
45
62
  ### JSON Config (Script Tag)
46
63
 
47
64
  For complex configurations, use a separate JSON config element:
@@ -74,6 +91,14 @@ For complex configurations, use a separate JSON config element:
74
91
  4. Optional permission to save a screenshot of the current tab.
75
92
  5. Feedback is submitted to your endpoint as a JSON POST, and a modal opens at the same moment where the user can leave a more detailed message. The modal does not wait for the POST to answer; a message the user sends goes out as a PATCH once the POST has returned its id.
76
93
 
94
+ Step 3, picking the part of the page the feedback is about:
95
+
96
+ ![Targeting overlay with crosshairs on the Add to cart button](https://raw.githubusercontent.com/qaiddev/thumbs-embed/prod/docs/screenshots/targeting.png)
97
+
98
+ Step 5, the message box, pointing at the picked element:
99
+
100
+ ![Message box above the circled Add to cart button](https://raw.githubusercontent.com/qaiddev/thumbs-embed/prod/docs/screenshots/message.png)
101
+
77
102
  If `skipTargeting` is `true`, step 3 is skipped and the modal opens immediately.
78
103
 
79
104
  If `captureScreenshot` is `false`, we skip step 4.
@@ -437,16 +462,15 @@ The embed also supports dark mode automatically via the `light-dark()` CSS funct
437
462
 
438
463
  ### Plans
439
464
 
440
- | | Cadet (Free) | Commander ($9/mo) | Admiral (Enterprise) |
465
+ | | Cadet (Free) | Commander ($9/seat/mo) | Admiral (Enterprise) |
441
466
  |---|---|---|---|
442
- | Projects | 1 | Unlimited | Unlimited |
443
- | Messages | 100/mo | Unlimited | Unlimited |
444
- | Data retention | 7 days | 1 year | Unlimited |
445
- | Screenshots | - | Yes | Yes |
446
- | Notifications | - | Email/Text | Email/Text |
447
- | Integrations | - | GitHub + more | Custom |
448
-
449
- Sign up at [qaid.dev](https://qaid.dev). You can also self-host — the embed works with any endpoint that accepts the payload format described above.
467
+ | Projects | 1 | 10 | Unlimited |
468
+ | Feedback | 100/mo per project | 10,000/mo per project | Unlimited |
469
+ | Screenshots, console errors, video | - | Yes | Yes |
470
+ | Notifications | Email | Email, webhooks, Slack | Email, webhooks, Slack |
471
+ | Issues | GitHub, Linear, Jira | Plus AI PR fixes | Custom |
472
+
473
+ Full details at [qaid.dev/pricing](https://qaid.dev/pricing). Sign up at [qaid.dev](https://qaid.dev). You can also self-host — the embed works with any endpoint that accepts the payload format described above.
450
474
 
451
475
  ## Self-Hosting
452
476
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@qaiddev/thumbs-embed",
3
- "version": "1.12.0",
3
+ "version": "1.12.2",
4
4
  "description": "Precision User Feedback",
5
5
  "type": "module",
6
6
  "main": "./dist/qaid.umd.cjs",
@@ -43,7 +43,7 @@
43
43
  "devDependencies": {
44
44
  "@vitest/coverage-v8": "^5.0.3",
45
45
  "axe-core": "^4.12.1",
46
- "happy-dom": "^20.5.1",
46
+ "happy-dom": "^21.0.4",
47
47
  "typescript": "^5.3.3",
48
48
  "vite": "^7.3.1",
49
49
  "vitest": "^5.0.3"