@zabbu/chat-widget 0.10.0 → 0.10.1

package/CHANGELOG.md

@@ -0,0 +1,146 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this
+project adheres to [Semantic Versioning](https://semver.org/). Versions before `0.1.0`
+below were not formally tracked; `0.1.0` is the baseline this file starts from.
+
+## [0.10.1] - 2026-08-26
+
+### Added
+- This changelog now ships with the package (was backfilled through 0.10.0 but hadn't
+  been republished yet), and a README exists for the first time — the npm package page
+  was blank before this.
+
+## [0.10.0] - 2026-08-26
+
+### Added
+- `window.Zabbu`, a programmatic API (`init`, `open`, `close`, `toggle`, `on`/`off`) for
+  host pages that want to control the widget from their own code instead of only through
+  data-* attributes read once at auto-init.
+- `primaryColor`, `position`, `welcomeText`, and `colorScheme` overrides — via data-*
+  attributes or the `init()` config object — that take precedence over the Site's own
+  saved config, so customizing the widget no longer requires portal-web access.
+- `ready`, `open`, `close`, and `message` events via `Zabbu.on()`.
+- Bottom-left placement (`data-position="bottom-left"` / `position: "bottom-left"`) —
+  `widgetPosition` was already returned by the public config endpoint but never applied
+  by the loader.
+
+### Changed
+- A script tag with no `data-site-key` no longer throws on load — it stays inert until
+  something calls `Zabbu.init()`.
+
+## [0.9.2] - 2026-08-26
+
+### Fixed
+- The iframe's own files (`index.html`, `chat-ui.js`/`.css`) now resolve relative to the
+  script's actual directory instead of just its origin. On a shared CDN like
+  jsDelivr/unpkg, where every package lives under the same domain, resolving by origin
+  alone pointed at a file that doesn't exist there.
+
+## [0.9.1] - 2026-08-26
+
+### Fixed
+- Republished pointing at the production backend — the previous publish's `npm run
+  build` hook ran without `API_BASE_URL` set and picked up the localhost default
+  instead.
+
+## [0.9.0] - 2026-08-25
+
+### Added
+- Per-site shadow style (soft, elevated, brand-glow) and a brand-color glow option for
+  the launcher.
+- An unread-message badge on the launcher.
+- A live agent-presence indicator, a CTA-button opening style, a dark color scheme, and
+  slash/at-command autocomplete in the chat panel.
+
+### Changed
+- Rebranded from `conex-chat-widget` to `zabbu-chat-widget` — DOM ids, CSS
+  classes/custom properties, and the localStorage key prefix.
+
+## [0.8.0] - 2026-08-24
+
+### Added
+- Gradient backgrounds, configurable opening styles, and a proactive teaser bubble.
+- An SVG icon set for the floating launcher button, selectable per site.
+
+## [0.7.0] - 2026-08-22
+
+### Added
+- The loader now notifies the backend once per session (`chat-opened`) when the visitor
+  opens the panel, so an event-triggered rule/command can respond proactively — the
+  reply arrives as a normal bot message, no typing required.
+- Sound config is now per-event (5 events: chat opened, bot reply, agent message, rule
+  triggered, command executed) instead of one style for 3 hardcoded triggers — the two
+  new events (rule/command) get their own distinct tones per style.
+
+### Changed
+- **BREAKING:** `ChatSoundPlayer.playOpen/playReply/playAgent` replaced by a single
+  `play(event)`; `bot-reply` payloads now carry an `event` field the sound engine reads
+  to pick the right style.
+
+## [0.6.0] - 2026-08-22
+
+### Added
+- Three notification sound styles — Suave, Clásico, Campanita — each with its own
+  waveform, gain, and tone set for the open/reply/agent triggers, selected via the
+  site's `soundStyle` config.
+
+## [0.5.0] - 2026-08-22
+
+### Added
+- Notification sounds, synthesized via Web Audio (no audio assets): a chime when the
+  chat opens, a shorter tone on a bot reply, and a distinct two-note tone when a human
+  agent's message arrives. Gated by the site's `soundEnabled` config; playback lives in
+  the loader, not the iframe, since only its launcher click carries a genuine user
+  gesture the autoplay policy will accept.
+
+## [0.4.0] - 2026-08-22
+
+### Added
+- The visitor's own typing activity is now relayed to the admin portal (debounced the
+  same way the admin's own typing signal already was), so an agent can see someone is
+  drafting a reply.
+
+## [0.3.2] - 2026-08-22
+
+### Fixed
+- `server.mjs` now serves `fixtures/` under `/fixtures/` too, not just `dist/` at the
+  root — the demo fixtures need to be opened from this server's own origin for the
+  backend's Origin check to pass, so opening them as `file://` (or 404ing) silently
+  dropped every message: no bot reply, nothing saved, nothing visible from any admin view.
+
+## [0.3.1] - 2026-08-22
+
+### Fixed
+- `fixtures/demo-sites/*.html` had stale API keys and mismatched business names from
+  before the backend's realistic-10-tenant reseed — each now points at its real,
+  currently-valid counterpart.
+
+## [0.3.0] - 2026-08-22
+
+### Added
+- Launcher icon, send-button label, and emoji picker visibility now come from the site's
+  own config instead of being fixed.
+- Visitors can attach a file to their own message when the site enables it — relayed
+  through loader.ts (the only context with the api key and a real Origin) via a new
+  postMessage exchange, not made directly from the sandboxed iframe.
+
+## [0.2.0] - 2026-08-21
+
+### Added
+- Admin replies rendered as a distinct bubble from automated bot replies, with their
+  attachment (image thumbnail or file link) when present.
+- A typing-dots indicator while the admin is drafting a reply.
+- A self-contained emoji picker in the composer (no new dependency).
+
+### Fixed
+- The iframe's CSP `img-src` now allows the API's own origin, so admin-attachment
+  images actually load instead of being blocked.
+
+## [0.1.0] - 2026-08-20
+
+Baseline — formal versioning and changelog tracking starts here. Prior history (chat
+history restore on reload, demo site fixtures) is available via `git log` but not
+itemized in this file.

package/README.md

@@ -0,0 +1,90 @@
+# @zabbu/chat-widget
+
+Embeddable chat widget — loader script + sandboxed chat UI — for a site backed by
+[Zabbu](https://github.com/zabbu-app/zabbu-chat-portal). Ships as a single
+self-contained script; no build step or framework required on the host page.
+
+## Install
+
+Add the script tag anywhere on your page, with the site key from your Zabbu admin panel:
+
+```html
+<script
+  async
+  src="https://unpkg.com/@zabbu/chat-widget/dist/loader.js"
+  data-site-key="YOUR_SITE_KEY"
+></script>
+```
+
+That's it — the launcher appears bottom-right, styled with whatever your site's admin
+panel has configured (color, welcome text, shadow style, etc).
+
+> Use unpkg, not jsDelivr, for this package — jsDelivr serves `.html` as `text/plain`
+> (an anti-phishing measure on their end, not something this package can opt out of),
+> which breaks the widget's iframe. unpkg serves it correctly.
+
+## Configuring without the admin panel
+
+Every `data-*` attribute below overrides the site's saved config for visitors of *this*
+particular embed, without touching the admin panel:
+
+| Attribute | Values | |
+|---|---|---|
+| `data-primary-color` | any CSS color, e.g. `#16a34a` | Launcher, panel, and header accent |
+| `data-position` | `bottom-right` (default) \| `bottom-left` | Which corner the widget docks to |
+| `data-welcome-text` | any string | First message shown to a new visitor |
+| `data-color-scheme` | `light` (default) \| `dark` | Panel theme |
+| `data-api-base` | a URL | Overrides the backend this build was published against (rarely needed) |
+
+## Programmatic API
+
+For host pages that want to control the widget from their own code — open it from a
+custom button, wait for it to be ready, react to a reply arriving — a script tag with no
+`data-site-key` stays inert until you call `init()` yourself:
+
+```html
+<script async src="https://unpkg.com/@zabbu/chat-widget/dist/loader.js"></script>
+<script>
+  window.addEventListener("load", () => {
+    const widget = Zabbu.init({
+      siteKey: "YOUR_SITE_KEY",
+      primaryColor: "#16a34a",
+      position: "bottom-left",
+      welcomeText: "Hey, need a hand?",
+    });
+
+    widget.on("message", ({ text }) => console.log("new reply:", text));
+  });
+</script>
+```
+
+`Zabbu.init()` is idempotent — safe to call again later (e.g. once you know a logged-in
+user's preferred color); it returns the existing widget instead of creating a second one.
+
+### Methods
+
+| | |
+|---|---|
+| `Zabbu.init(config)` | Creates the widget if it doesn't exist yet; returns it either way. `config.siteKey` is required. |
+| `Zabbu.open()` / `.close()` / `.toggle()` | Control the panel. No-ops (with a console warning) before `init()`. |
+| `Zabbu.on(event, handler)` / `.off(event, handler)` | Subscribe/unsubscribe. |
+
+### Events
+
+| Event | Payload | Fires when |
+|---|---|---|
+| `ready` | — | The widget's DOM and appearance are set up. Replays immediately if you subscribe after it already fired. |
+| `open` / `close` | — | The panel is toggled — by the visitor, or by `Zabbu.open()`/`.close()`. |
+| `message` | `{ text: string }` | A bot or admin reply arrives. |
+
+If the widget auto-inited via `data-site-key` and you need to call a method on it later
+from unrelated code, call `Zabbu.init()` again with the same `siteKey` — it's idempotent
+and returns the existing instance rather than creating a second one.
+
+## Version history
+
+See [CHANGELOG.md](./CHANGELOG.md).
+
+## License
+
+MIT

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@zabbu/chat-widget",
-  "version": "0.10.0",
-  "description": "Embeddable chat widget (loader.js + chat UI) for the chat portal backend (zabbu-chat-portal). Served standalone — see server.mjs and Dockerfile.",
+  "version": "0.10.1",
+  "description": "Embeddable, multi-tenant chat widget — a single <script> tag, with a programmatic JS API and per-embed config overrides.",
   "private": false,
   "publishConfig": {
     "access": "public"
   },
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
   "main": "dist/loader.js",
   "license": "MIT",