@myapihq/cli 2.15.0 → 2.15.1
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.
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: my-feedback-api
|
|
3
|
-
version: 1.5.
|
|
3
|
+
version: 1.5.1
|
|
4
4
|
description: >
|
|
5
5
|
Collect feedback from the people using what you built. A public widget key lets a page submit without a credential; you list, filter and resolve the results. Kind is chosen by the person reporting, not inferred from their wording.
|
|
6
6
|
triggers: [feedback, bug report, user feedback, feature request, widget, support, complaints, praise]
|
|
7
|
-
checksum: sha256-
|
|
7
|
+
checksum: sha256-b1aba273d6d32b4145dcee85fb59fec35f50b257fc41fb8da9f649a0b519e909
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
# MyFeedbackAPI
|
|
@@ -42,13 +42,18 @@ theme baked in. This is the intended way in — you do not build a UI:
|
|
|
42
42
|
<script src="https://api.myapihq.com/feedback/in/<widget_key>/widget.js" async></script>
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
It renders a button
|
|
46
|
-
for
|
|
47
|
-
browsers within ~5 minutes with no redeploy of your site
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
45
|
+
It renders a button and shows itself only on the routes the widget is
|
|
46
|
+
configured for — set them with `widget update <id> --routes /app,/app/**`, and
|
|
47
|
+
the change reaches browsers within ~5 minutes with no redeploy of your site.
|
|
48
|
+
|
|
49
|
+
The person points at an element or drags a region, and it sends:
|
|
50
|
+
|
|
51
|
+
- `kind`, `body`, `page_url`, `route`, `viewport`
|
|
52
|
+
- `target_selector` and `target_region` `{x,y,w,h}` — the region is on **every**
|
|
53
|
+
report now: the element's bounding rectangle for a click, the dragged box for
|
|
54
|
+
a drag
|
|
55
|
+
- `target_context` — what the element *was*: its text, role, the heading above it
|
|
56
|
+
- `trace` — the last events before the report
|
|
52
57
|
|
|
53
58
|
A wrong key does not break the page: the response is `application/javascript`
|
|
54
59
|
carrying a JS comment that names the fix, so a typo cannot throw a syntax error
|
|
@@ -79,7 +84,9 @@ await fetch(`https://api.myapihq.com/feedback/in/${WIDGET_KEY}`, {
|
|
|
79
84
|
|
|
80
85
|
Errors: `WIDGET_NOT_FOUND` (a revoked key reads like an invented one, so keys
|
|
81
86
|
cannot be probed), `ORIGIN_NOT_ALLOWED`, `RATE_LIMITED`, `INVALID_KIND`,
|
|
82
|
-
`BODY_REQUIRED`, `BODY_TOO_LONG
|
|
87
|
+
`BODY_REQUIRED`, `BODY_TOO_LONG` (the text is over 8000 chars) and
|
|
88
|
+
`BODY_TOO_LARGE` (the whole request is over 64 KB, usually an oversized
|
|
89
|
+
`trace`). Nothing is saved in either case. The key only ever writes.
|
|
83
90
|
|
|
84
91
|
### Kind is a claim, not a guess
|
|
85
92
|
|
|
@@ -123,7 +130,7 @@ that is deliberate, so ids cannot be probed across orgs.
|
|
|
123
130
|
| Command | What it does |
|
|
124
131
|
|---|---|
|
|
125
132
|
| `myapi feedback create "<text>" --kind <k>` | Record one item (`--page-url`, `--route` for context) |
|
|
126
|
-
| `myapi feedback list [--kind bug\|issue\|suggestion] [--status open\|resolved] [--limit N] [--offset N]` | List feedback, newest first |
|
|
133
|
+
| `myapi feedback list [--kind bug\|issue\|suggestion] [--status open\|resolved] [--limit N] [--offset N] [--trace]` | List feedback, newest first. Each report summarises what was pointed at, what happened before, and whether a screenshot exists; `--trace` expands the events |
|
|
127
134
|
| `myapi feedback resolve <id>` | Close an item, keeping it |
|
|
128
135
|
| `myapi feedback delete <id>` | Erase an item — for spam, or personal details typed into the box |
|
|
129
136
|
| `myapi feedback widget create <name> [--origins a.com,b.com]` | Mint a PUBLIC widget key for a site |
|
|
@@ -149,12 +156,13 @@ myapi feedback widget update <id> --routes /app,/app/**
|
|
|
149
156
|
myapi feedback list --status open
|
|
150
157
|
myapi feedback list --kind bug --limit 20
|
|
151
158
|
|
|
152
|
-
#
|
|
159
|
+
# 5. Record something yourself (support call, your own testing)
|
|
153
160
|
myapi feedback create "checkout 500s on the second attempt" --kind bug \
|
|
154
161
|
--route /checkout
|
|
155
162
|
|
|
156
|
-
#
|
|
163
|
+
# 6. Close it — or delete it, which also removes its screenshot
|
|
157
164
|
myapi feedback resolve <id>
|
|
165
|
+
myapi feedback delete <id> --yes
|
|
158
166
|
```
|
|
159
167
|
<!-- llm:end -->
|
|
160
168
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@myapihq/cli",
|
|
3
3
|
"license": "Apache-2.0",
|
|
4
|
-
"version": "2.15.
|
|
4
|
+
"version": "2.15.1",
|
|
5
5
|
"description": "MyAPI command-line interface",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"lint:skills:strict": "node scripts/copy-skills.js && node scripts/lint-skills.js --strict"
|
|
47
47
|
},
|
|
48
48
|
"dependencies": {
|
|
49
|
-
"@myapihq/sdk": "^2.15.
|
|
49
|
+
"@myapihq/sdk": "^2.15.1"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
52
|
"@types/node": "^25.6.0",
|