@tavus/embed 0.17.0 → 0.18.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/dist/index.d.ts CHANGED
@@ -22,9 +22,10 @@ interface TavusEmbedAttributes {
22
22
  /** API base origin override (defaults to the production API). */
23
23
  "base-url"?: string;
24
24
  /**
25
- * @experimental Undocumented JSON escape hatch for tuning the expanded card
26
- * (`enabled`, `aspect`, `custom_aspect`, `max_width`, `max_height`). Not part
27
- * of the supported surface — it may change or disappear without notice.
25
+ * JSON `ExpandOptions`. With `enabled: true` the card lifts out of the page
26
+ * into a modal overlay while a start is underway and during the call, then
27
+ * returns inline. `aspect`, `custom_aspect`, `max_width`, `max_height` and
28
+ * `fullscreen` size the expanded card. See README "Embed".
28
29
  */
29
30
  "expand-options"?: string;
30
31
  /** Preview/auth token forwarded to `/init` and `/start`. */