@paramms/chat-widget 1.0.41 → 1.0.42

package/README.md

@@ -158,12 +158,32 @@ Drop that before `</body>` and you have a working floating bubble — no other J
 | `data-relay-target` | `el` | CSS selector for an existing element to mount into. Ignored in launcher mode |
 | `data-relay-height` | `height` | Inline container height. Ignored in launcher mode |
 | `data-relay-inbox` | `inbox` | `"true"` adds a back-chevron → full conversation list. Requires `data-relay-launcher="false"` — see the note below the table |
+| `data-relay-inbox-start` | `inboxStart` | `"true"` opens **directly on the conversation list** instead of a single thread — for a dedicated "Messages" page. Implies `inbox`. Requires `data-relay-launcher="false"` |
 | `data-relay-inbox-scope` | `inboxScope` | `tenant` (default) \| `profile` |
+| `data-relay-tenant-id` | `tenantId` | Your business id. Lists threads across **all** your chatrooms without naming one — use instead of `data-relay-app` on an inbox page |
 
 **What's NOT available as an attribute:** `user`/`subject` as nested objects, `quickReplies`, `i18n`, and `refreshToken` — an HTML attribute can only hold a string, so these need the JS-object form below. (`launcherMessage`'s two attributes are a workaround for exactly this: the React prop takes one `{ title, subtitle }` object, which an attribute can't express, so it's split into two flat attributes that get recombined.)
 
 **`inbox` requires `data-relay-launcher="false"`** — same limit React has (a launcher+inbox combination needs a different component there, `ChatAppLauncher`); with the default floating launcher, `data-relay-inbox` is silently ignored.
 
+**A whole "Messages" page, zero JavaScript.** `data-relay-inbox` alone only puts the list *behind* a back-chevron — the widget still lands on one thread, which is right for a product page and wrong for a page whose entire job is the inbox. `data-relay-inbox-start` makes the list the landing view, and `data-relay-tenant-id` spans every chatroom you run:
+
+```html
+<div id="relay-inbox" style="height:600px"></div>
+
+<script
+  async
+  src="https://relay.paramms.com/embed.js"
+  data-relay-tenant-id="acme"
+  data-relay-inbox-start="true"
+  data-relay-launcher="false"
+  data-relay-target="#relay-inbox"
+  data-relay-user="user_123"
+></script>
+```
+
+Tapping a row opens that conversation against **its own** chatroom; its back-chevron returns to the list. There's no ✕ in this mode — the list is the root view, so there'd be nothing behind it to close to. ✎ compose opens against your default chatroom (the server reports which). This is the script-tag equivalent of React's `<ChatApp tenantId={...} />`.
+
 ### Full config — JS object
 
 Same field names, all in one place, same object whether it's set on page load or reacts to something happening later:
@@ -389,6 +409,8 @@ RTL is detected automatically for Arabic, Hebrew, Persian and Urdu browsers.
 | `i18n` | `I18nStrings` | English | UI string overrides |
 | `inbox` | `boolean` | `false` | Add a ‹ back in the chatroom header that opens the full `ChatApp` conversation list (inline widgets only) |
 | `inboxScope` | `'tenant' \| 'profile'` | `'tenant'` | With `inbox`: list threads across all chatrooms (`tenant`) or just this one (`profile`) |
+| `inboxStart` | `boolean` | `false` | Land ON the conversation list instead of a single thread (a dedicated "Messages" page). Implies `inbox`; requires `launcher: false`. Script-tag/embed only — in React use `<ChatApp/>` directly |
+| `tenantId` | `string` | — | Script-tag/embed only. Your business id: lists threads across ALL your chatrooms with no chatroom named. Only meaningful with `inboxStart` — a single thread still needs a `profileId` |
 
 ## Development
 

package/dist/connection.d.ts

@@ -43,11 +43,24 @@ export declare class ConnectionManager {
      *  The outbox is bounded so a prolonged outage can't grow memory without limit
      *  — oldest queued frames are dropped past the cap. */
     send(frame: ClientFrame): void;
+    /** How many frames are waiting to go out. Useful for a host that wants to
+     *  show "message pending" state, and for asserting the outbox stays bounded. */
+    pendingCount(): number;
     close(): void;
     private handle;
     private refreshing;
     private fatal;
+    /** Release queued frames. When called from 'opened' we know the canonical
+     *  conversation id the server just resolved us to, and queued `send` frames
+     *  are retargeted to it. A manager only ever opens ONE conversation (its
+     *  `opts.open`), so every queued send belongs to that thread by
+     *  construction — but the id it was queued with can be STALE (queued against
+     *  the previous session's conversation before a reconnect). Retargeting is a
+     *  no-op in the normal case and rescues the message in the stale one. */
     private flush;
+    /** Bounded enqueue — the cap lives here so EVERY path that queues respects
+     *  it (a failed `raw` used to push straight onto the array, bypassing it). */
+    private queue;
     private raw;
     private onClosed;
 }

package/dist/embed.d.ts

@@ -130,9 +130,31 @@ export interface RelaySettings {
      *  ✕ in the list view returns to this widget's original single-thread
      *  view. Requires `launcher: false`. */
     inbox?: boolean;
+    /** Open DIRECTLY on the conversation list instead of a single thread —
+     *  what you want for a dedicated "Messages" page. `inbox: true` alone only
+     *  adds a back-chevron to a single thread, so the list is reachable but
+     *  never the landing view; that is the right default for a widget bolted
+     *  onto a product page, and the wrong one for a page whose whole job is the
+     *  inbox. Implies `inbox`. Requires `launcher: false` (same restriction as
+     *  `inbox`), and `profileId` OR `tenantId`.
+     *
+     *  With `inboxStart`, tapping a row opens that conversation and its own
+     *  back-chevron returns to the list. There is no ✕ — the list IS the root
+     *  view here, so there is nothing behind it to close back to. */
+    inboxStart?: boolean;
     /** Inbox scope when `inbox` is set: `'tenant'` (default) lists the user's
      *  threads across ALL your chatrooms; `'profile'` limits it to this one. */
     inboxScope?: 'tenant' | 'profile';
+    /** Your business id — lists the visitor's threads across ALL your chatrooms
+     *  without naming one, and lets "new conversation" open against your default
+     *  chatroom (the server reports it). This is the vanilla equivalent of
+     *  React's `<ChatApp tenantId=… />`, which has always accepted a tenant with
+     *  no profile; the script tag previously could not express that at all and
+     *  hard-required a `profileId`.
+     *
+     *  Only meaningful with `inboxStart` — a single-thread widget still needs a
+     *  `profileId`, because a lone thread has to belong to a specific chatroom. */
+    tenantId?: string;
 }
 export type RelayCommand = 'boot' | 'update' | 'identify' | 'shutdown';
 /** The public command dispatcher exposed as `window.Relay`. */