@onlive.ai/common-121 0.2.163 → 0.2.184

package/services/conversation/conversation.types.d.cts

@@ -1,6 +1,6 @@
-/*! @onlive.ai/common-121 v0.2.163 | © 2026 Onlive.ai */
+/*! @onlive.ai/common-121 v0.2.184 | © 2026 Onlive.ai */
 import { ReceivedChatMessage } from '@livekit/components-core';
-import { Participant, RoomOptions as RoomOptions$1, Room } from 'livekit-client';
+import { Participant, Room, RoomOptions as RoomOptions$1 } from 'livekit-client';
 import { FirebaseConfig } from '../firebase/firebase-api.cjs';
 import 'firebase/database';
 
@@ -34,6 +34,7 @@ interface ExtendedRoom extends Room {
  * @property {string} token - Authentication token for room access.
  * @property {string} wsURL - WebSocket URL for real-time connection.
  * @property {string} createdAt - ISO timestamp of room creation.
+ * @property {Record<string, unknown>} [affinity] - Affinity data echoed back from the server.
  */
 type RoomApiResponse = {
     id: string;
@@ -41,6 +42,7 @@ type RoomApiResponse = {
     token: string;
     wsURL: string;
     createdAt: string;
+    affinity?: Record<string, unknown>;
 };
 /**
  * Room list item structure for room listings.
@@ -197,6 +199,7 @@ interface ReportInfo {
  * @property {Array<MediaAttachment>} [media] - Attached media files.
  * @property {Array<Assets>} [assets] - Attached assets.
  * @property {Array<ReportInfo>} [reports] - Message reports/flags.
+ * @property {Record<string, unknown>} [metadata] - Additional custom metadata.
  */
 type ApiMessage = Omit<ReceivedChatMessage, "type"> & {
     type?: "standard" | "system";
@@ -206,6 +209,7 @@ type ApiMessage = Omit<ReceivedChatMessage, "type"> & {
     media?: MediaAttachment[];
     assets?: Assets[];
     reports?: ReportInfo[];
+    metadata?: Record<string, unknown>;
 };
 /**
  * Paginated response for messages.
@@ -270,7 +274,7 @@ interface Call {
 /**
  * Request status for call/room requests.
  */
-type RequestStatus = "pending" | "accepted" | "cancelled" | "not_response" | "disconnected";
+type RequestStatus = "pending" | "accepted" | "cancelled" | "not_response" | "disconnected" | "failed";
 /**
  * Call request structure for real-time request handling.
  *
@@ -332,6 +336,7 @@ interface NewRoomRequestData {
  * @property {boolean} [disablePersistence] - Disable message persistence.
  * @property {Record<string, unknown>} [metadata] - Additional room metadata.
  * @property {ContextualEvent[]} [contextualEvents] - Initial contextual events.
+ * @property {string} [initialMessage] - Initial message to send when room is created.
  */
 type CreateRoomOptions = {
     language: string;
@@ -341,6 +346,117 @@ type CreateRoomOptions = {
     metadata?: Record<string, unknown>;
     contextualEvents?: ContextualEvent[];
     userGroupId?: string;
+    initialMessage?: string;
+};
+/**
+ * Options for the unified quick-start endpoint that combines user registration
+ * and room creation in a single HTTP call.
+ *
+ * @property {Object} user - User registration data.
+ * @property {string} user.externalId - External user identifier.
+ * @property {string} user.secret - User authentication secret.
+ * @property {string} [user.name] - User display name.
+ * @property {string} [user.email] - User email address.
+ * @property {string} [user.phone] - User phone number.
+ * @property {string} [user.avatar] - URL of the user's avatar.
+ * @property {Record<string, unknown>} [user.metadata] - Additional user metadata.
+ * @property {string | null} [user.userGroupId] - User group identifier.
+ * @property {string} [user.sessionId] - External session identifier.
+ * @property {Object} room - Room creation data.
+ * @property {string} room.language - Preferred language code (e.g., "en", "es").
+ * @property {string} room.timezone - IANA timezone identifier.
+ * @property {Record<string, unknown>} [room.affinity] - Agent affinity preferences.
+ * @property {string} [room.name] - Room display name.
+ * @property {string} [room.platformType] - Platform type (default: "web").
+ * @property {Record<string, unknown>} [room.metadata] - Additional room metadata.
+ * @property {string | null} [room.userGroupId] - Room user group identifier.
+ * @property {boolean} [room.disablePersistence] - Disable message persistence.
+ * @property {ContextualEvent[]} [room.contextualEvents] - Initial contextual events.
+ * @property {{ content: string; assets?: unknown[] }} [room.initialMessage] - Initial message to include in the room.
+ */
+type QuickStartOptions = {
+    user: {
+        externalId: string;
+        secret: string;
+        name?: string;
+        email?: string;
+        phone?: string;
+        avatar?: string;
+        metadata?: Record<string, unknown>;
+        userGroupId?: string | null;
+        sessionId?: string;
+    };
+    room: {
+        language: string;
+        timezone: string;
+        affinity?: Record<string, unknown>;
+        name?: string;
+        platformType?: string;
+        metadata?: Record<string, unknown>;
+        userGroupId?: string | null;
+        disablePersistence?: boolean;
+        contextualEvents?: ContextualEvent[];
+        initialMessage?: {
+            content: string;
+            assets?: unknown[];
+        };
+    };
+};
+/**
+ * API response from the unified quick-start endpoint.
+ *
+ * @property {Object} user - Registered user data with authentication token.
+ * @property {string} user.id - Internal user identifier.
+ * @property {string} user.externalId - External user identifier.
+ * @property {string} user.organizationId - Associated organization ID.
+ * @property {string} [user.name] - User display name.
+ * @property {string} [user.email] - User email address.
+ * @property {string} [user.phone] - User phone number.
+ * @property {string} user.role - Assigned user role.
+ * @property {string} [user.avatar] - URL of the user's avatar.
+ * @property {Record<string, unknown>} [user.metadata] - User metadata.
+ * @property {string | null} [user.userGroupId] - User group identifier.
+ * @property {string} user.token - JWT authentication token.
+ * @property {Object} room - Created/reused room data with LiveKit credentials.
+ * @property {string} room.id - Room unique identifier.
+ * @property {string} [room.organizationId] - Organization that owns the room.
+ * @property {string} [room.name] - Room display name.
+ * @property {string} [room.groupId] - Group identifier for room categorization.
+ * @property {string} [room.status] - Current room status.
+ * @property {string} [room.createdAt] - ISO timestamp of room creation.
+ * @property {string} [room.updatedAt] - Last update timestamp.
+ * @property {Record<string, unknown>} [room.metadata] - Room metadata.
+ * @property {Record<string, unknown>} [room.affinity] - Affinity data from the server.
+ * @property {string} room.token - LiveKit token for WebSocket connection.
+ * @property {string} room.wsURL - LiveKit WebSocket URL.
+ */
+type QuickStartApiResponse = {
+    user: {
+        id: string;
+        externalId: string;
+        organizationId: string;
+        name?: string;
+        email?: string;
+        phone?: string;
+        role: string;
+        avatar?: string;
+        metadata?: Record<string, unknown>;
+        userGroupId?: string | null;
+        token: string;
+    };
+    room: {
+        id: string;
+        organizationId?: string;
+        name?: string;
+        groupId?: string;
+        status?: string;
+        createdAt?: string;
+        updatedAt?: string;
+        metadata?: Record<string, unknown>;
+        affinity?: Record<string, unknown>;
+        token: string;
+        wsURL: string;
+    };
 };
 /**
  * Options for fetching messages.
@@ -516,4 +632,4 @@ declare const EVENTS_TOPIC: "lk.events";
 /** Topic for typing indicator messages */
 declare const TYPING_INDICATOR_TOPIC: "typing-indicator";
 
-export { type AgentData, type ApiMessage, type Assets, CHAT_TOPIC, type Call, type CallRequest, type CallRequestListener, type ContextualEvent, type ContextualEventNames, type ConversationServiceOptions, type CreateRoomOptions, EVENTS_TOPIC, type EvaluateRoomOptions, type ExtendedRoom, type GetMessagesOptions, type GetRoomsOptions, type MediaAttachment, type MessageListener, type MessageReactionOptions, type MessageReportOptions, type MessagesApiResponse, type NewRoomRequestData, type PersistMessageOptions, type ReportInfo, type RequestNewRoomOptions, type RequestStatus, type RoomApiResponse, type RoomListItem, type RoomOptions, type RoomSyncData, type RoomsApiResponse, TRANSCRIPTION_TOPIC, TYPING_INDICATOR_TOPIC, type TypingIndicator, type TypingListener, type UserApiResponse, type UserFrom };
+export { type AgentData, type ApiMessage, type Assets, CHAT_TOPIC, type Call, type CallRequest, type CallRequestListener, type ContextualEvent, type ContextualEventNames, type ConversationServiceOptions, type CreateRoomOptions, EVENTS_TOPIC, type EvaluateRoomOptions, type ExtendedRoom, type GetMessagesOptions, type GetRoomsOptions, type MediaAttachment, type MessageListener, type MessageReactionOptions, type MessageReportOptions, type MessagesApiResponse, type NewRoomRequestData, type PersistMessageOptions, type QuickStartApiResponse, type QuickStartOptions, type ReportInfo, type RequestNewRoomOptions, type RequestStatus, type RoomApiResponse, type RoomListItem, type RoomOptions, type RoomSyncData, type RoomsApiResponse, TRANSCRIPTION_TOPIC, TYPING_INDICATOR_TOPIC, type TypingIndicator, type TypingListener, type UserApiResponse, type UserFrom };

package/services/conversation/conversation.types.d.ts

@@ -1,6 +1,6 @@
-/*! @onlive.ai/common-121 v0.2.163 | © 2026 Onlive.ai */
+/*! @onlive.ai/common-121 v0.2.184 | © 2026 Onlive.ai */
 import { ReceivedChatMessage } from '@livekit/components-core';
-import { Participant, RoomOptions as RoomOptions$1, Room } from 'livekit-client';
+import { Participant, Room, RoomOptions as RoomOptions$1 } from 'livekit-client';
 import { FirebaseConfig } from '../firebase/firebase-api.js';
 import 'firebase/database';
 
@@ -34,6 +34,7 @@ interface ExtendedRoom extends Room {
  * @property {string} token - Authentication token for room access.
  * @property {string} wsURL - WebSocket URL for real-time connection.
  * @property {string} createdAt - ISO timestamp of room creation.
+ * @property {Record<string, unknown>} [affinity] - Affinity data echoed back from the server.
  */
 type RoomApiResponse = {
     id: string;
@@ -41,6 +42,7 @@ type RoomApiResponse = {
     token: string;
     wsURL: string;
     createdAt: string;
+    affinity?: Record<string, unknown>;
 };
 /**
  * Room list item structure for room listings.
@@ -197,6 +199,7 @@ interface ReportInfo {
  * @property {Array<MediaAttachment>} [media] - Attached media files.
  * @property {Array<Assets>} [assets] - Attached assets.
  * @property {Array<ReportInfo>} [reports] - Message reports/flags.
+ * @property {Record<string, unknown>} [metadata] - Additional custom metadata.
  */
 type ApiMessage = Omit<ReceivedChatMessage, "type"> & {
     type?: "standard" | "system";
@@ -206,6 +209,7 @@ type ApiMessage = Omit<ReceivedChatMessage, "type"> & {
     media?: MediaAttachment[];
     assets?: Assets[];
     reports?: ReportInfo[];
+    metadata?: Record<string, unknown>;
 };
 /**
  * Paginated response for messages.
@@ -270,7 +274,7 @@ interface Call {
 /**
  * Request status for call/room requests.
  */
-type RequestStatus = "pending" | "accepted" | "cancelled" | "not_response" | "disconnected";
+type RequestStatus = "pending" | "accepted" | "cancelled" | "not_response" | "disconnected" | "failed";
 /**
  * Call request structure for real-time request handling.
  *
@@ -332,6 +336,7 @@ interface NewRoomRequestData {
  * @property {boolean} [disablePersistence] - Disable message persistence.
  * @property {Record<string, unknown>} [metadata] - Additional room metadata.
  * @property {ContextualEvent[]} [contextualEvents] - Initial contextual events.
+ * @property {string} [initialMessage] - Initial message to send when room is created.
  */
 type CreateRoomOptions = {
     language: string;
@@ -341,6 +346,117 @@ type CreateRoomOptions = {
     metadata?: Record<string, unknown>;
     contextualEvents?: ContextualEvent[];
     userGroupId?: string;
+    initialMessage?: string;
+};
+/**
+ * Options for the unified quick-start endpoint that combines user registration
+ * and room creation in a single HTTP call.
+ *
+ * @property {Object} user - User registration data.
+ * @property {string} user.externalId - External user identifier.
+ * @property {string} user.secret - User authentication secret.
+ * @property {string} [user.name] - User display name.
+ * @property {string} [user.email] - User email address.
+ * @property {string} [user.phone] - User phone number.
+ * @property {string} [user.avatar] - URL of the user's avatar.
+ * @property {Record<string, unknown>} [user.metadata] - Additional user metadata.
+ * @property {string | null} [user.userGroupId] - User group identifier.
+ * @property {string} [user.sessionId] - External session identifier.
+ * @property {Object} room - Room creation data.
+ * @property {string} room.language - Preferred language code (e.g., "en", "es").
+ * @property {string} room.timezone - IANA timezone identifier.
+ * @property {Record<string, unknown>} [room.affinity] - Agent affinity preferences.
+ * @property {string} [room.name] - Room display name.
+ * @property {string} [room.platformType] - Platform type (default: "web").
+ * @property {Record<string, unknown>} [room.metadata] - Additional room metadata.
+ * @property {string | null} [room.userGroupId] - Room user group identifier.
+ * @property {boolean} [room.disablePersistence] - Disable message persistence.
+ * @property {ContextualEvent[]} [room.contextualEvents] - Initial contextual events.
+ * @property {{ content: string; assets?: unknown[] }} [room.initialMessage] - Initial message to include in the room.
+ */
+type QuickStartOptions = {
+    user: {
+        externalId: string;
+        secret: string;
+        name?: string;
+        email?: string;
+        phone?: string;
+        avatar?: string;
+        metadata?: Record<string, unknown>;
+        userGroupId?: string | null;
+        sessionId?: string;
+    };
+    room: {
+        language: string;
+        timezone: string;
+        affinity?: Record<string, unknown>;
+        name?: string;
+        platformType?: string;
+        metadata?: Record<string, unknown>;
+        userGroupId?: string | null;
+        disablePersistence?: boolean;
+        contextualEvents?: ContextualEvent[];
+        initialMessage?: {
+            content: string;
+            assets?: unknown[];
+        };
+    };
+};
+/**
+ * API response from the unified quick-start endpoint.
+ *
+ * @property {Object} user - Registered user data with authentication token.
+ * @property {string} user.id - Internal user identifier.
+ * @property {string} user.externalId - External user identifier.
+ * @property {string} user.organizationId - Associated organization ID.
+ * @property {string} [user.name] - User display name.
+ * @property {string} [user.email] - User email address.
+ * @property {string} [user.phone] - User phone number.
+ * @property {string} user.role - Assigned user role.
+ * @property {string} [user.avatar] - URL of the user's avatar.
+ * @property {Record<string, unknown>} [user.metadata] - User metadata.
+ * @property {string | null} [user.userGroupId] - User group identifier.
+ * @property {string} user.token - JWT authentication token.
+ * @property {Object} room - Created/reused room data with LiveKit credentials.
+ * @property {string} room.id - Room unique identifier.
+ * @property {string} [room.organizationId] - Organization that owns the room.
+ * @property {string} [room.name] - Room display name.
+ * @property {string} [room.groupId] - Group identifier for room categorization.
+ * @property {string} [room.status] - Current room status.
+ * @property {string} [room.createdAt] - ISO timestamp of room creation.
+ * @property {string} [room.updatedAt] - Last update timestamp.
+ * @property {Record<string, unknown>} [room.metadata] - Room metadata.
+ * @property {Record<string, unknown>} [room.affinity] - Affinity data from the server.
+ * @property {string} room.token - LiveKit token for WebSocket connection.
+ * @property {string} room.wsURL - LiveKit WebSocket URL.
+ */
+type QuickStartApiResponse = {
+    user: {
+        id: string;
+        externalId: string;
+        organizationId: string;
+        name?: string;
+        email?: string;
+        phone?: string;
+        role: string;
+        avatar?: string;
+        metadata?: Record<string, unknown>;
+        userGroupId?: string | null;
+        token: string;
+    };
+    room: {
+        id: string;
+        organizationId?: string;
+        name?: string;
+        groupId?: string;
+        status?: string;
+        createdAt?: string;
+        updatedAt?: string;
+        metadata?: Record<string, unknown>;
+        affinity?: Record<string, unknown>;
+        token: string;
+        wsURL: string;
+    };
 };
 /**
  * Options for fetching messages.
@@ -516,4 +632,4 @@ declare const EVENTS_TOPIC: "lk.events";
 /** Topic for typing indicator messages */
 declare const TYPING_INDICATOR_TOPIC: "typing-indicator";
 
-export { type AgentData, type ApiMessage, type Assets, CHAT_TOPIC, type Call, type CallRequest, type CallRequestListener, type ContextualEvent, type ContextualEventNames, type ConversationServiceOptions, type CreateRoomOptions, EVENTS_TOPIC, type EvaluateRoomOptions, type ExtendedRoom, type GetMessagesOptions, type GetRoomsOptions, type MediaAttachment, type MessageListener, type MessageReactionOptions, type MessageReportOptions, type MessagesApiResponse, type NewRoomRequestData, type PersistMessageOptions, type ReportInfo, type RequestNewRoomOptions, type RequestStatus, type RoomApiResponse, type RoomListItem, type RoomOptions, type RoomSyncData, type RoomsApiResponse, TRANSCRIPTION_TOPIC, TYPING_INDICATOR_TOPIC, type TypingIndicator, type TypingListener, type UserApiResponse, type UserFrom };
+export { type AgentData, type ApiMessage, type Assets, CHAT_TOPIC, type Call, type CallRequest, type CallRequestListener, type ContextualEvent, type ContextualEventNames, type ConversationServiceOptions, type CreateRoomOptions, EVENTS_TOPIC, type EvaluateRoomOptions, type ExtendedRoom, type GetMessagesOptions, type GetRoomsOptions, type MediaAttachment, type MessageListener, type MessageReactionOptions, type MessageReportOptions, type MessagesApiResponse, type NewRoomRequestData, type PersistMessageOptions, type QuickStartApiResponse, type QuickStartOptions, type ReportInfo, type RequestNewRoomOptions, type RequestStatus, type RoomApiResponse, type RoomListItem, type RoomOptions, type RoomSyncData, type RoomsApiResponse, TRANSCRIPTION_TOPIC, TYPING_INDICATOR_TOPIC, type TypingIndicator, type TypingListener, type UserApiResponse, type UserFrom };

package/services/conversation/conversation.types.js

@@ -1,2 +1,2 @@
-/*! @onlive.ai/common-121 v0.2.163 | © 2026 Onlive.ai */
-var t="lk.chat",e="lk.transcription",n="lk.events",s="typing-indicator";export{t as CHAT_TOPIC,n as EVENTS_TOPIC,e as TRANSCRIPTION_TOPIC,s as TYPING_INDICATOR_TOPIC};
+/*! @onlive.ai/common-121 v0.2.184 | © 2026 Onlive.ai */
+var t="lk.chat",e="lk.transcription",n="lk.events",r="typing-indicator";export{t as CHAT_TOPIC,n as EVENTS_TOPIC,e as TRANSCRIPTION_TOPIC,r as TYPING_INDICATOR_TOPIC};