@paramms/chat-widget 1.0.31 → 1.0.32

package/dist/react.d.ts

@@ -9,6 +9,13 @@ interface BaseProps {
     apiUrl?: string;
     /** Your Relay profile ID — set as NEXT_PUBLIC_RELAY_PROFILE_ID in .env — required */
     profileId: string;
+    /** A signed identity token — an ES256 JWT `{sub,iat,exp}` minted by YOUR
+     *  backend for chatrooms with signed identity (guestPublicKey) enabled.
+     *  This is the production identity tier; wins over `userId`. */
+    token?: string;
+    /** Called when a signed token expires: return a fresh token from your
+     *  backend to renew the session without a reload. */
+    refreshToken?: () => Promise<string | null>;
     /** Your logged-in user's stable ID. When omitted the widget automatically
      *  assigns a persistent anonymous ID from localStorage — no login required. */
     userId?: string;
@@ -49,7 +56,7 @@ export interface ChatWidgetProps extends BaseProps {
  * @example Basic support chat
  * ```tsx
  * <ChatWidget
- *   url={process.env.NEXT_PUBLIC_RELAY_WS_URL}
+ *   url={process.env.NEXT_PUBLIC_RELAY_URL}
  *   profileId={process.env.NEXT_PUBLIC_RELAY_PROFILE_ID}
  *   userId={session?.user.id}
  *   userName={session?.user.name}
@@ -57,19 +64,22 @@ export interface ChatWidgetProps extends BaseProps {
  * />
  * ```
  *
- * @example Multi-thread (tickets, bookings, orders)
+ * @example Multi-thread (tickets, bookings, orders) — one thread per subjectId
  * ```tsx
  * <ChatWidget
  *   url={...} profileId={...}
- *   showChatList
  *   subjectId={`ticket_${ticket.id}`}
  *   contextTitle={ticket.title}
  *   contextStatus={ticket.status}
  *   userId={session?.user.id}
  * />
  * ```
+ *
+ * Need a list of the user's threads with tap-to-open? That's `<ChatApp />`
+ * (inline) or `<ChatAppLauncher />` (floating bubble) — this component renders
+ * a single conversation.
  */
-export declare function ChatWidget({ url, apiUrl, profileId, userId, userName, userEmail, userAvatar, contextTitle, contextSubtitle, contextStatus, subjectId, accent, launcher, position, quickReplies, height, i18n, translateLang, }: ChatWidgetProps): JSX.Element;
+export declare function ChatWidget({ url, apiUrl, profileId, token, refreshToken, userId, userName, userEmail, userAvatar, contextTitle, contextSubtitle, contextStatus, subjectId, accent, launcher, position, quickReplies, height, i18n, translateLang, }: ChatWidgetProps): JSX.Element;
 export interface MarketplaceChatProps extends BaseProps {
     /** Unique ID for this listing — each listing gets its own thread.
      *  Omit for a general (non-item-specific) conversation. */
@@ -91,7 +101,7 @@ export interface MarketplaceChatProps extends BaseProps {
  * ```tsx
  * // On your listing detail page:
  * <MarketplaceChat
- *   url={process.env.NEXT_PUBLIC_RELAY_WS_URL}
+ *   url={process.env.NEXT_PUBLIC_RELAY_URL}
  *   profileId={process.env.NEXT_PUBLIC_RELAY_PROFILE_ID}
  *   listingId={car.id}
  *   listingTitle={car.title}
@@ -104,35 +114,53 @@ export interface MarketplaceChatProps extends BaseProps {
  * />
  * ```
  *
- * **Without `listingId` (My Messages / inbox page)** — shows the WhatsApp-style
- * thread list as the home screen. No conversation is opened until the user taps one.
- * Use this on a dedicated `/messages` or `/inbox` page.
+ * **Without `listingId`** — opens the buyer's single general (non-listing)
+ * thread with this chatroom. For a "My Messages" / inbox page with the
+ * WhatsApp-style thread list and tap-to-open, use `<ChatApp />` (or
+ * `<ChatAppLauncher />` for a floating bubble):
  * ```tsx
  * // On your /messages page:
- * <MarketplaceChat
- *   url={process.env.NEXT_PUBLIC_RELAY_WS_URL}
+ * <ChatApp
+ *   url={process.env.NEXT_PUBLIC_RELAY_URL}
  *   profileId={process.env.NEXT_PUBLIC_RELAY_PROFILE_ID}
  *   userId={session?.user.id}
- *   userName={session?.user.name}
  * />
  * ```
  *
  * Only `url` and `profileId` are required. All other props are optional.
  */
-export declare function MarketplaceChat({ url, apiUrl, profileId, listingId, listingTitle, listingMeta, listingPrice, listingStatus, userId, userName, userEmail, userAvatar, accent, launcher, position, quickReplies, height, i18n, translateLang, }: MarketplaceChatProps): JSX.Element;
+export declare function MarketplaceChat({ url, apiUrl, profileId, token, refreshToken, listingId, listingTitle, listingMeta, listingPrice, listingStatus, userId, userName, userEmail, userAvatar, accent, launcher, position, quickReplies, height, i18n, translateLang, }: MarketplaceChatProps): JSX.Element;
 export interface ChatAppProps {
-    /** Relay WebSocket URL — required */
+    /** Relay URL — ONE url, any scheme; `https://api.relay.paramms.com` is the
+     *  recommended form. The WebSocket URL and REST base are derived from it —
+     *  you do NOT need to pass `wss://` or `/ws`. */
     url: string;
-    /** HTTP(S) base for REST calls. Defaults to the WS origin. */
+    /** HTTP(S) base for REST calls — only when the REST API is on a different
+     *  origin than the socket. Normally omit.
+     *  @deprecated pass a single `url`; kept for back-compat. */
     apiUrl?: string;
     /** Your Relay profile ID — required */
     profileId: string;
+    /** A signed identity token (ES256 JWT) for chatrooms with signed identity
+     *  enabled — the production tier. Wins over `userId`. */
+    token?: string;
+    /** Return a fresh token when a signed token expires. */
+    refreshToken?: () => Promise<string | null>;
     /** Your logged-in user's stable ID. Omit for anonymous (uses localStorage UID) */
     userId?: string;
     /** Optional: shown to agents in the dashboard */
     userName?: string;
     /** Optional: shown to agents in the dashboard */
     userEmail?: string;
+    /** Which conversations the list shows (default 'tenant'):
+     *    'tenant'  — every conversation this user has with the business that
+     *      owns `profileId`, across ALL of its chatrooms — like a real
+     *      messaging app. Each row opens against its own chatroom.
+     *    'profile' — only this chatroom's threads (the pre-1.0.30 behaviour).
+     *  Tenancy note: guests never see or send tenant ids — the server resolves
+     *  the tenant FROM the profileId, so `profileId` stays the only id you
+     *  configure. */
+    scope?: 'profile' | 'tenant';
     /** Brand colour hex — default '#4F63F5' */
     accent?: string;
     /** Container height. Default: '100%' */
@@ -142,21 +170,25 @@ export interface ChatAppProps {
 }
 /**
  * Full chat-app component: conversation list on the left (or full screen on
- * mobile), chat room on the right when a thread is selected.
+ * mobile), chat room on the right when a thread is selected — like a
+ * standalone messaging app. Tapping a thread opens the chat inline; the ✎
+ * button starts a new conversation with the business.
  *
- * Works like a standalone messaging app — tapping a thread opens the chat
- * inline without navigating away from the page.
+ * By default (`scope="tenant"`) the list shows EVERY conversation this user
+ * has with the business that owns `profileId` — across all of its chatrooms —
+ * and each row opens against its own chatroom. Pass `scope="profile"` to
+ * limit it to one chatroom's threads.
  *
  * @example
  * ```tsx
  * 'use client'
- * import { ChatList } from '@paramms/chat-widget/react'
+ * import { ChatApp } from '@paramms/chat-widget/react'
  *
  * export default function MessagesPage({ session }) {
  *   return (
  *     <div style={{ height: '100vh' }}>
- *       <ChatList
- *         url={process.env.NEXT_PUBLIC_RELAY_WS_URL}
+ *       <ChatApp
+ *         url={process.env.NEXT_PUBLIC_RELAY_URL}
  *         profileId={process.env.NEXT_PUBLIC_RELAY_PROFILE_ID}
  *         userId={session?.user.id}
  *         userName={session?.user.name}
@@ -167,18 +199,28 @@ export interface ChatAppProps {
  * }
  * ```
  */
-export declare function ChatApp({ url, apiUrl, profileId, userId, userName, userEmail, accent, height, i18n, }: ChatAppProps): JSX.Element;
+export declare function ChatApp({ url, apiUrl, profileId, token, refreshToken, userId, userName, userEmail, accent, height, i18n, scope, }: ChatAppProps): JSX.Element;
 export interface ChatAppLauncherProps {
-    /** Relay WebSocket URL — required */
+    /** Relay URL — ONE url, any scheme; `https://api.relay.paramms.com` is the
+     *  recommended form. The WebSocket URL and REST base are derived from it. */
     url: string;
-    /** HTTP(S) base for REST calls. Defaults to the WS origin. */
+    /** HTTP(S) base for REST calls — only when REST is on a different origin.
+     *  @deprecated pass a single `url`; kept for back-compat. */
     apiUrl?: string;
     /** Your Relay profile ID — required */
     profileId: string;
+    /** A signed identity token (ES256 JWT) for chatrooms with signed identity
+     *  enabled — the production tier. Wins over `userId`. */
+    token?: string;
+    /** Return a fresh token when a signed token expires. */
+    refreshToken?: () => Promise<string | null>;
     /** Your logged-in user's stable ID */
     userId?: string;
     userName?: string;
     userEmail?: string;
+    /** Which conversations the panel's list shows — see ChatAppProps.scope.
+     *  Default 'tenant': every conversation this user has with the business. */
+    scope?: 'profile' | 'tenant';
     /** Brand colour hex — default '#4F63F5' */
     accent?: string;
     /** true  → floating bubble fixed to the corner of the screen (like Intercom)
@@ -205,7 +247,7 @@ export interface ChatAppLauncherProps {
  * @example Floating bubble (bottom-right)
  * ```tsx
  * <ChatAppLauncher
- *   url={process.env.NEXT_PUBLIC_RELAY_WS_URL}
+ *   url={process.env.NEXT_PUBLIC_RELAY_URL}
  *   profileId={process.env.NEXT_PUBLIC_RELAY_PROFILE_ID}
  *   userId={session?.user.id}
  *   floating
@@ -216,7 +258,7 @@ export interface ChatAppLauncherProps {
  * @example Inline nav button
  * ```tsx
  * <ChatAppLauncher
- *   url={process.env.NEXT_PUBLIC_RELAY_WS_URL}
+ *   url={process.env.NEXT_PUBLIC_RELAY_URL}
  *   profileId={process.env.NEXT_PUBLIC_RELAY_PROFILE_ID}
  *   userId={session?.user.id}
  *   floating={false}
@@ -224,5 +266,5 @@ export interface ChatAppLauncherProps {
  * />
  * ```
  */
-export declare function ChatAppLauncher({ url, apiUrl, profileId, userId, userName, userEmail, accent, floating, position, label, panelWidth, panelHeight, }: ChatAppLauncherProps): JSX.Element;
+export declare function ChatAppLauncher({ url, apiUrl, profileId, token, refreshToken, userId, userName, userEmail, scope, accent, floating, position, label, panelWidth, panelHeight, }: ChatAppLauncherProps): JSX.Element;
 export {};