@paramms/chat-widget 1.0.33 → 1.0.35

package/dist/protocol/frames.d.ts

@@ -1,6 +1,15 @@
 import type { ConnectionId, ConversationId, MessageId, ProfileId, SubjectId, UserId } from './ids.js';
 import type { Channel, Conversation, Message, MessageContent, Subject, AnnotationStroke } from './entities.js';
 import type { ManifestAction } from './actions.js';
+/** Dashboard-configured pre-chat qualification form, delivered in the manifest. */
+export interface PreChatConfig {
+    enabled: boolean;
+    showWhen?: 'always' | 'offline';
+    fields?: ('name' | 'email' | 'phone')[];
+    topics?: string[];
+    callbackOption?: boolean;
+    title?: string;
+}
 export type ErrorCode = 'UNAUTHORIZED' | 'FORBIDDEN' | 'NOT_FOUND' | 'BAD_REQUEST' | 'RATE_LIMITED' | 'PAYLOAD_TOO_LARGE' | 'CONFLICT' | 'INTERNAL';
 export type ClientFrame = {
     type: 'auth';
@@ -137,6 +146,7 @@ export type ServerFrame = {
     offline?: boolean;
     offlineMessage?: string;
     whiteLabel?: boolean;
+    preChat?: PreChatConfig;
 } | {
     type: 'message';
     message: Message;

package/dist/react.d.ts

@@ -139,8 +139,18 @@ export interface ChatAppProps {
      *  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 chatroom id. Provide `profileId` OR `tenantId` (see below). When both
+     *  are given, profileId also fixes where the ✎ "new conversation" opens. */
+    profileId?: string;
+    /** Tenant-level identification — the natural fit for a chat app: lists
+     *  EVERY conversation this user has with your business across ALL of its
+     *  chatrooms, without naming one. Use this when the platform runs several
+     *  chatrooms under one tenant (e.g. a marketplace chatroom for
+     *  `<MarketplaceChat/>` pages PLUS a general-support chatroom) — the inbox
+     *  shows both, and each row opens against its own chatroom. The ✎ compose
+     *  button opens the tenant's default chatroom (its oldest, as reported by
+     *  the server). */
+    tenantId?: string;
     /** A signed identity token (ES256 JWT) for chatrooms with signed identity
      *  enabled — the production tier. Wins over `userId`. */
     token?: string;
@@ -152,7 +162,9 @@ export interface ChatAppProps {
     userName?: string;
     /** Optional: shown to agents in the dashboard */
     userEmail?: string;
-    /** Which conversations the list shows (default 'tenant'):
+    /** Which conversations the list shows when configured with a profileId
+     *  (default 'tenant'; irrelevant with `tenantId`, which is always
+     *  tenant-wide):
      *    '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.
@@ -165,6 +177,13 @@ export interface ChatAppProps {
     accent?: string;
     /** Container height. Default: '100%' */
     height?: string;
+    /** When provided, ChatApp renders an always-visible close (✕) control in the
+     *  top-right corner of its container. Pass this whenever ChatApp is shown in
+     *  an overlay/panel or as a mobile-fullscreen surface (ChatAppLauncher wires
+     *  it automatically) so there is a reliable way OUT — without it, an inline
+     *  fullscreen panel on a phone (no Escape key, no reachable backdrop) traps
+     *  the user. Omit for a bare inline embed the host chromes itself. */
+    onClose?: () => void;
     /** i18n overrides */
     i18n?: import('./chatlist.js').ChatListOptions['i18n'];
 }
@@ -179,6 +198,16 @@ export interface ChatAppProps {
  * and each row opens against its own chatroom. Pass `scope="profile"` to
  * limit it to one chatroom's threads.
  *
+ * Identify at either level:
+ *   • `tenantId`  — the natural fit for a chat app. A platform often runs
+ *     SEVERAL chatrooms under one business (a marketplace chatroom for
+ *     `<MarketplaceChat/>` pages plus a general-support chatroom, …); with
+ *     `tenantId` the inbox shows the user's chats with all of them, no
+ *     profileId needed. Compose opens the tenant's default chatroom.
+ *   • `profileId` — any one of the business's chatrooms; still lists
+ *     tenant-wide by default (`scope="tenant"`), and fixes where compose
+ *     opens.
+ *
  * @example
  * ```tsx
  * 'use client'
@@ -189,7 +218,7 @@ export interface ChatAppProps {
  *     <div style={{ height: '100vh' }}>
  *       <ChatApp
  *         url={process.env.NEXT_PUBLIC_RELAY_URL}
- *         profileId={process.env.NEXT_PUBLIC_RELAY_PROFILE_ID}
+ *         tenantId={process.env.NEXT_PUBLIC_RELAY_TENANT_ID}   // or profileId={…}
  *         userId={session?.user.id}
  *         userName={session?.user.name}
  *         userEmail={session?.user.email}
@@ -199,7 +228,7 @@ export interface ChatAppProps {
  * }
  * ```
  */
-export declare function ChatApp({ url, apiUrl, profileId, token, refreshToken, userId, userName, userEmail, accent, height, i18n, scope, }: ChatAppProps): JSX.Element;
+export declare function ChatApp({ url, apiUrl, profileId, tenantId, token, refreshToken, userId, userName, userEmail, accent, height, i18n, onClose, scope, }: ChatAppProps): JSX.Element;
 export interface ChatAppLauncherProps {
     /** 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. */
@@ -207,8 +236,13 @@ export interface ChatAppLauncherProps {
     /** 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 chatroom id. Provide `profileId` OR `tenantId`. */
+    profileId?: string;
+    /** Tenant-level identification — the panel lists EVERY conversation this
+     *  user has with your business across ALL of its chatrooms (see
+     *  ChatAppProps.tenantId). The ✎ compose opens the tenant's default
+     *  chatroom. */
+    tenantId?: string;
     /** A signed identity token (ES256 JWT) for chatrooms with signed identity
      *  enabled — the production tier. Wins over `userId`. */
     token?: string;
@@ -266,5 +300,5 @@ export interface ChatAppLauncherProps {
  * />
  * ```
  */
-export declare function ChatAppLauncher({ url, apiUrl, profileId, token, refreshToken, userId, userName, userEmail, scope, accent, floating, position, label, panelWidth, panelHeight, }: ChatAppLauncherProps): JSX.Element;
+export declare function ChatAppLauncher({ url, apiUrl, profileId, tenantId, token, refreshToken, userId, userName, userEmail, scope, accent, floating, position, label, panelWidth, panelHeight, }: ChatAppLauncherProps): JSX.Element;
 export {};