@callembed/elements 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sealby
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,85 @@
-# Temporary Holding Version
+# `@callembed/elements`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Framework-agnostic [Web Component](https://developer.mozilla.org/en-US/docs/Web/API/Web_components) for [CallEmbed](https://callembed.sealby.me) — a **thin wrapper** over [`@callembed/sdk`](../sdk).
+
+**Product model:** customer-service queue only. An end user on a web page clicks “talk to a human” → rings a project queue → an agent answers. This package does **not** implement person-to-person calling.
+
+## Install (ESM)
+
+```bash
+npm install @callembed/elements @callembed/sdk livekit-client
+```
+
+```html
+<script type="module">
+  import "@callembed/elements";
+</script>
+
+<callembed-button
+  publishable-key="pk_…"
+  api-base-url=""
+  locale="en"
+  queue="onboarding"
+></callembed-button>
+```
+
+## CDN (IIFE)
+
+Single file — no bundler. Registers `<callembed-button>` and exposes `window.CallEmbedElements`.
+
+```html
+<script src="https://unpkg.com/@callembed/elements/dist/callembed-elements.iife.js"></script>
+
+<callembed-button
+  publishable-key="pk_…"
+  api-base-url="https://api.example.com"
+  locale="zh-TW"
+  queue="onboarding"
+></callembed-button>
+
+<script>
+  const el = document.querySelector("callembed-button");
+  el.addEventListener("callembed:state", (e) => console.log(e.detail));
+  el.addEventListener("callembed:error", (e) => console.error(e.detail));
+</script>
+```
+
+> Before the first npm publish, load the built file from `packages/elements/dist/callembed-elements.iife.js` after `npm run build -w @callembed/elements`.
+
+## Attributes
+
+| Attribute | Notes |
+|-----------|--------|
+| `publishable-key` | Required (`pk_…`) |
+| `api-base-url` | Required (`""` for same-origin) |
+| `locale` | `en` \| `zh-TW` |
+| `queue` | Project queue to ring |
+| `label` | Optional idle label override |
+| `show-status` / `show-mute` | `"false"` to hide |
+| `branding` | `"false"` to hide brand line in SDK panel (headless by default) |
+| `debug` | `"true"` for SDK debug |
+
+## Events
+
+| Event | `detail` |
+|-------|----------|
+| `callembed:state` | `{ uiState, status, callId, muted, error }` |
+| `callembed:error` | `{ code, message }` |
+
+`uiState`: `idle` \| `ringing` \| `connected` \| `ended` \| `error`.
+
+Programmatic API on the element: `start()`, `end()`, `setMuted(boolean)`.
+
+Disconnect or changing `publishable-key` / `api-base-url` hangs up any active/ringing call.
+
+## SSR
+
+Importing the package is safe under Node / Nuxt: `customElements.define` is guarded when `customElements` is undefined.
+
+## Builds
+
+ESM + CJS + `.d.ts`, plus `dist/callembed-elements.iife.js` for CDN.
+
+## Publishing
+
+Published via the multi-package tag workflow (see [`docs/RELEASING.md`](../../docs/RELEASING.md)). The npm tarball includes `dist/callembed-elements.iife.js` (CDN). Local allowlist check: `npm run pack:verify -w @callembed/elements`.