@mushi-mushi/web 0.4.0 → 0.5.0
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.
- package/CODE_OF_CONDUCT.md +1 -1
- package/README.md +25 -2
- package/SECURITY.md +1 -1
- package/dist/index.cjs +625 -217
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +46 -0
- package/dist/index.d.ts +46 -0
- package/dist/index.js +625 -217
- package/dist/index.js.map +1 -1
- package/package.json +10 -3
package/CODE_OF_CONDUCT.md
CHANGED
|
@@ -40,7 +40,7 @@ Examples of unacceptable behavior:
|
|
|
40
40
|
## Enforcement
|
|
41
41
|
|
|
42
42
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
43
|
-
reported to the project team at **
|
|
43
|
+
reported to the project team at **kensaurus@gmail.com**.
|
|
44
44
|
|
|
45
45
|
All complaints will be reviewed and investigated promptly and fairly.
|
|
46
46
|
|
package/README.md
CHANGED
|
@@ -16,9 +16,32 @@ Browser SDK for Mushi Mushi — embeddable bug reporting widget with Shadow DOM
|
|
|
16
16
|
- IndexedDB offline queue with auto-sync
|
|
17
17
|
- On-device pre-filter (blocks spam before server submission)
|
|
18
18
|
- Client-side rate limiting (token bucket self-throttle)
|
|
19
|
-
- Light/dark theme with auto-detection
|
|
19
|
+
- Light/dark theme with auto-detection (`prefers-color-scheme`)
|
|
20
20
|
- **Proactive triggers** — rage click, long task, API cascade failure detection
|
|
21
21
|
- **Report fatigue prevention** — session limits, cooldowns, permanent suppression
|
|
22
|
+
- Keyboard-first: `Esc` to close, `⌘/Ctrl + Enter` to submit, focus-trapped panel
|
|
23
|
+
- Honours `prefers-reduced-motion` (animations collapse to instant)
|
|
24
|
+
|
|
25
|
+
## Design language — "Mushi Mushi Editorial"
|
|
26
|
+
|
|
27
|
+
The widget is intentionally not a generic SaaS chatbot. The visual system is
|
|
28
|
+
defined in [`src/styles.ts`](./src/styles.ts) and uses:
|
|
29
|
+
|
|
30
|
+
- **Paper + sumi ink** — warm washi cream surface (`#F8F4ED`), deep ink type
|
|
31
|
+
(`#0E0D0B`), and a subtle paper grain. No flat white modal.
|
|
32
|
+
- **Vermillion 朱** (`#E03C2C`) — single signature accent, used as a hanko
|
|
33
|
+
stamp colour for the active state, focus underline, submit button, and the
|
|
34
|
+
success-step 朱印 ring.
|
|
35
|
+
- **System serif display** — Iowan Old Style → Palatino → Georgia stack for
|
|
36
|
+
headings. Pure system fonts: zero web-font fetch, zero FOUT.
|
|
37
|
+
- **Mono metadata** — `ui-monospace` for the `01 / 03` step ledger and
|
|
38
|
+
receipt timestamp, evoking a printer's contents page.
|
|
39
|
+
- **Rule lines, not boxes** — categories render as an editorial contents
|
|
40
|
+
list with 1px hairline separators.
|
|
41
|
+
|
|
42
|
+
All design tokens are named by **material** (`paper`, `ink`, `rule`,
|
|
43
|
+
`vermillion`) rather than role (`primary`, `secondary`) so the palette is
|
|
44
|
+
hard to dilute via a generic rename later.
|
|
22
45
|
|
|
23
46
|
## Contents
|
|
24
47
|
|
|
@@ -46,7 +69,7 @@ Each trigger respects its config flag — set `rageClick: false` to disable rage
|
|
|
46
69
|
|
|
47
70
|
## Bundle Size
|
|
48
71
|
|
|
49
|
-
~
|
|
72
|
+
~7 KB brotli, enforced at **22 KB gzipped** via `size-limit` in CI (budget raised for the 2026 editorial widget refresh — still a single-digit-kilobyte footprint). Requires `@mushi-mushi/core` as a dependency (not bundled inline). The `./test-utils` entry is a separate artifact and is never pulled into production bundles.
|
|
50
73
|
|
|
51
74
|
## Quick Start
|
|
52
75
|
|
package/SECURITY.md
CHANGED
|
@@ -19,7 +19,7 @@ If you discover a security vulnerability, please report it responsibly.
|
|
|
19
19
|
|
|
20
20
|
**Do NOT open a public GitHub issue.**
|
|
21
21
|
|
|
22
|
-
Instead, email: **
|
|
22
|
+
Instead, email: **kensaurus@gmail.com**
|
|
23
23
|
|
|
24
24
|
Include:
|
|
25
25
|
- Description of the vulnerability
|