@aginies/embed 0.2.0

package/README.md

@@ -0,0 +1,49 @@
+# @aginies/embed
+
+One script tag that puts an Aginies agent on any page. No build step, no framework: the
+file bundles the UI kit and its styles and exposes a small `Aginies` global.
+
+```html
+<script
+  src="https://cdn.jsdelivr.net/npm/@aginies/embed/dist/aginies.js"
+  data-base-url="https://app.your-aginies.example"
+  data-token="agn_…"
+  data-chat="support"
+  data-mode="bubble"
+  data-locale="tr"
+  defer
+></script>
+```
+
+With the `data-chat` attribute the widget mounts on its own. Without it, drive it from code:
+
+```html
+<script src="…/aginies.js"></script>
+<script>
+  Aginies.init({ baseUrl: 'https://app.your-aginies.example', token: 'agn_…' })
+  const handle = Aginies.chat({ identifier: 'support', mode: 'inline', container: '#chat' })
+  // later: handle.unmount()
+</script>
+```
+
+Nothing renders until the platform accepts the token and the page's origin
+(`UI_PACKAGE_ACTIVATION_KEY`, `UI_PACKAGE_ALLOWED_ORIGINS`); a refused activation logs one
+warning and leaves the page untouched.
+
+## API
+
+- `Aginies.init({ baseUrl, token, locale? })` — runs the activation handshake; call once.
+- `Aginies.chat({ identifier, mode?, position?, launcherLabel?, theme?, container? })` — mounts a
+  chat widget; returns `{ unmount() }`. `mode` is `bubble` (default), `inline` or `full`.
+  `container` is a selector or element for `inline` / `full`; bubble mode creates its own root.
+- `Aginies.version`
+
+## Approvals
+
+```html
+<div id="approval"></div>
+<script src="https://cdn.example/aginies.js" data-base-url="https://app.example" data-token="agn_pk_…" data-approval="WORKFLOW_ID/EXECUTION_ID" data-container="#approval"></script>
+```
+
+Or from code: `Aginies.approval({ workflowId, executionId, contextId?, container: '#approval', onResumed })`.
+The ids come from the resume link a "Human in the Loop" block sends to the approver.