@unisphere/genie-types 1.13.0 → 1.13.2

package/index.esm.js

@@ -1,31 +1,9 @@
+/** Widget name constant for all Genie experiences */
 const widgetName = 'unisphere.widget.genie';
 
 const integrationsSchema = {
   type: 'object',
   properties: {
-    marketo: {
-      type: 'object',
-      properties: {
-        type: {
-          type: 'primitive',
-          value: 'string'
-        },
-        quota: {
-          type: 'primitive',
-          value: 'number'
-        },
-        formId: {
-          type: 'primitive',
-          value: 'string'
-        },
-        blocker: {
-          type: 'primitive',
-          value: 'boolean'
-        }
-      },
-      deprecationMessage: 'Marketo integration is no longer supported and this field will be ignored if provided',
-      optional: true
-    },
     avatar: {
       type: 'orByType',
       schemas: {
@@ -238,12 +216,18 @@ const chatRuntimePlayerPluginSettingsSchema = {
   }
 };
 
+/**
+ * Answer type options for Genie responses.
+ */
 var AnswerTypeEnum;
 (function (AnswerTypeEnum) {
   AnswerTypeEnum["Flashcards"] = "flashcards";
   AnswerTypeEnum["Markdown"] = "markdown";
   AnswerTypeEnum["Summary"] = "summarization";
 })(AnswerTypeEnum || (AnswerTypeEnum = {}));
+/**
+ * Answer model performance options.
+ */
 var AnswerModelEnum;
 (function (AnswerModelEnum) {
   AnswerModelEnum["Fast"] = "fast";
@@ -471,8 +455,10 @@ const popupVisualSettingsSchema = {
   }
 };
 
+/** Runtime name constant for chat experiences */
 const ChatRuntimeName = 'chat';
 
+/** Runtime name constant for flashcards tool */
 const FlashcardsToolRuntimeName = 'flashcards-tool';
 const flashcardsToolRuntimeSettingsSchema = {
   type: 'object',
@@ -619,6 +605,7 @@ const genieAnswerVisualSettingsSchema = {
   }
 };
 
+/** Runtime name constant for followups tool */
 const FollowupsToolRuntimeName = 'followups-tool';
 const followupsToolRuntimeSettingsSchema = {
   type: 'object',
@@ -668,6 +655,7 @@ const followupsToolRuntimeAvatarVisualSettingsSchema = {
   }
 };
 
+/** Runtime name constant for sources tool */
 const SourcesToolRuntimeName = 'sources-tool';
 const sourcesToolRuntimeSettingsSchema = {
   type: 'object',
@@ -683,6 +671,11 @@ const sourcesToolRuntimeGenieAnswerVisualSettingsSchema = {
   type: 'object',
   properties: {
     blockContext: blockVisualContextSchema,
+    variant: {
+      type: 'enum',
+      values: ['default', 'compact'],
+      optional: true
+    },
     sources: {
       type: 'array',
       optional: true,
@@ -743,6 +736,7 @@ const sourcesToolRuntimeGenieAnswerVisualSettingsSchema = {
   }
 };
 
+/** Runtime name constant for avatar experiences */
 const AvatarRuntimeName = 'avatar';
 const avatarRuntimeSettingsSchema = {
   type: 'object',
@@ -848,29 +842,56 @@ const avatarRuntimeChatVisualSettingsSchema = {
   }
 };
 
+/**
+ * Audio device types for avatar connections.
+ */
 var DeviceType;
 (function (DeviceType) {
+  /** Microphone input device */
   DeviceType["AudioInput"] = "audioinput";
+  /** Speaker/headphone output device */
   DeviceType["AudioOutput"] = "audiooutput";
 })(DeviceType || (DeviceType = {}));
+/**
+ * Avatar connection status states.
+ *
+ * @deprecated Use AvatarConnectionStatus instead
+ */
 var AvatarStatus;
 (function (AvatarStatus) {
+  /** Establishing connection */
   AvatarStatus["Connecting"] = "connecting";
+  /** Successfully connected */
   AvatarStatus["Connected"] = "connected";
+  /** Not connected */
   AvatarStatus["Disconnected"] = "disconnected";
+  /** Connection error occurred */
   AvatarStatus["Error"] = "error";
 })(AvatarStatus || (AvatarStatus = {}));
+/**
+ * Avatar connection lifecycle states.
+ */
 var AvatarConnectionStatus;
 (function (AvatarConnectionStatus) {
+  /** Establishing connection */
   AvatarConnectionStatus["Connecting"] = "connecting";
+  /** Successfully connected */
   AvatarConnectionStatus["Connected"] = "connected";
+  /** Not connected */
   AvatarConnectionStatus["Disconnected"] = "disconnected";
+  /** Closing connection */
   AvatarConnectionStatus["Disconnecting"] = "disconnecting";
+  /** Connection error occurred */
   AvatarConnectionStatus["Error"] = "error";
 })(AvatarConnectionStatus || (AvatarConnectionStatus = {}));
+/**
+ * Reasons why avatar agent may be unavailable.
+ */
 var AgentUnavailabilityReasons;
 (function (AgentUnavailabilityReasons) {
+  /** No agents are currently available */
   AgentUnavailabilityReasons["NoAgents"] = "NoAgents";
+  /** Maximum concurrent connections reached */
   AgentUnavailabilityReasons["CapacityReached"] = "CapacityReached";
 })(AgentUnavailabilityReasons || (AgentUnavailabilityReasons = {}));
 var DisconnectReasons;
@@ -921,7 +942,7 @@ const avatarRuntimeLobbyVisualSettingsSchema = {
     },
     variant: {
       type: 'enum',
-      values: ['default', 'mini', 'buttonOnly'],
+      values: ['default', 'mini', 'buttonOnly', 'agent'],
       optional: true
     },
     isTranslucent: {
@@ -938,6 +959,32 @@ const avatarRuntimeLobbyVisualSettingsSchema = {
       type: 'primitive',
       value: 'string',
       optional: true
+    },
+    agentButtonLabel: {
+      type: 'primitive',
+      value: 'string',
+      optional: true
+    },
+    agentSize: {
+      type: 'primitive',
+      value: 'string',
+      optional: true
+    }
+  }
+};
+
+const avatarRuntimeAgentVisualSettingsSchema = {
+  type: 'object',
+  properties: {
+    schemaVersion: {
+      type: 'literal',
+      value: '1',
+      optional: true
+    },
+    panelSide: {
+      type: 'enum',
+      values: ['left', 'right'],
+      optional: true
     }
   }
 };
@@ -961,12 +1008,14 @@ const adminRuntimeSettingsSchema = {
     }
   }
 };
+/** Runtime name constant for admin experiences */
 const AdminRuntimeName = 'admin';
 
 const adminDemoRuntimeSettingsSchema = {
   type: 'object',
   properties: {}
 };
+/** Runtime name constant for admin demo experiences */
 const AdminDemoRuntimeName = 'admin-demo';
 
 const applicationRuntimeSettingsSchema = {
@@ -1042,8 +1091,10 @@ const applicationRuntimeSettingsSchema = {
     }
   }
 };
+/** Runtime name constant for application-level experiences */
 const ApplicationRuntimeName = 'application';
 
+/** Runtime name constant for summary tool */
 const SummaryToolRuntimeName = 'summary-tool';
 const summaryToolRuntimeSettingsSchema = {
   type: 'object',
@@ -1090,6 +1141,7 @@ const summaryToolRuntimeGenieAnswerVisualSettingsSchema = {
   }
 };
 
+/** Runtime name constant for NVIDIA 2026 event tool */
 const Nvidia2026EventToolRuntimeName = 'nvidia-2026-event-tool';
 const nvidia2026EventToolRuntimeSettingsSchema = {
   type: 'object',
@@ -1102,6 +1154,7 @@ const nvidia2026EventToolRuntimeSettingsSchema = {
   }
 };
 
+/** Runtime name constant for Kaltura video player tool */
 const KalturaVideoPlayerToolRuntimeName = 'kaltura-video-player-tool';
 const kalturaVideoPlayerToolRuntimeSettingsSchema = {
   type: 'object',
@@ -1135,6 +1188,7 @@ const kalturaVideoPlayerToolRuntimeGenieAnswerVisualSettingsSchema = {
   }
 };
 
+/** Runtime name constant for GTC agenda tool */
 const GtcAgendaToolRuntimeName = 'gtc-agenda-tool';
 const gtcAgendaToolRuntimeSettingsSchema = {
   type: 'object',
@@ -1157,6 +1211,7 @@ const gtcAgendaToolRuntimeGenieAnswerVisualSettingsSchema = {
   }
 };
 
+/** Runtime name constant for GTC agenda list tool */
 const GtcAgendaListToolRuntimeName = 'gtc-agenda-list-tool';
 const gtcAgendaListToolRuntimeSettingsSchema = {
   type: 'object',
@@ -1192,4 +1247,4 @@ const gtcAgendaListToolRuntimeGenieAnswerVisualSettingsSchema = {
   }
 };
 
-export { AdminDemoRuntimeName, AdminRuntimeName, AgentUnavailabilityReasons, AnswerModelEnum, AnswerTypeEnum, ApplicationRuntimeName, AvatarConnectionStatus, AvatarRuntimeName, AvatarStatus, ChatRuntimeName, DeviceType, DisconnectReasons, FlashcardsToolRuntimeName, FollowupsToolRuntimeName, GtcAgendaListToolRuntimeName, GtcAgendaToolRuntimeName, KalturaVideoPlayerToolRuntimeName, Nvidia2026EventToolRuntimeName, SourcesToolRuntimeName, SummaryToolRuntimeName, adminDemoRuntimeSettingsSchema, adminRuntimeSettingsSchema, applicationRuntimeSettingsSchema, avatarRuntimeChatVisualSettingsSchema, avatarRuntimeContainedVisualSettingsSchema, avatarRuntimeLobbyVisualSettingsSchema, avatarRuntimeSettingsSchema, bannerVisualSettingsSchema, blockVisualContextSchema, chatCustomizationSchema, chatRuntimePlayerPluginSettingsSchema, chatRuntimeSettingsSchema, flashcardsToolRuntimeSettingsSchema, followupsToolRuntimeAvatarVisualSettingsSchema, followupsToolRuntimeGenieAnswerVisualSettingsSchema, followupsToolRuntimeSettingsSchema, genieAnswerVisualSettingsSchema, getSourceUrlSchema, gtcAgendaListToolRuntimeGenieAnswerVisualSettingsSchema, gtcAgendaListToolRuntimeSettingsSchema, gtcAgendaToolRuntimeGenieAnswerVisualSettingsSchema, gtcAgendaToolRuntimeSettingsSchema, integrationsSchema, isAvatarConnectionProxyInternalType, kalturaVideoPlayerToolRuntimeGenieAnswerVisualSettingsSchema, kalturaVideoPlayerToolRuntimeSettingsSchema, nvidia2026EventToolRuntimeSettingsSchema, pageVisualSettingsSchema, popupVisualSettingsSchema, shareUrlSchema, sourcesToolRuntimeGenieAnswerVisualSettingsSchema, sourcesToolRuntimeSettingsSchema, summaryToolRuntimeGenieAnswerVisualSettingsSchema, summaryToolRuntimeSettingsSchema, widgetName };
+export { AdminDemoRuntimeName, AdminRuntimeName, AgentUnavailabilityReasons, AnswerModelEnum, AnswerTypeEnum, ApplicationRuntimeName, AvatarConnectionStatus, AvatarRuntimeName, AvatarStatus, ChatRuntimeName, DeviceType, DisconnectReasons, FlashcardsToolRuntimeName, FollowupsToolRuntimeName, GtcAgendaListToolRuntimeName, GtcAgendaToolRuntimeName, KalturaVideoPlayerToolRuntimeName, Nvidia2026EventToolRuntimeName, SourcesToolRuntimeName, SummaryToolRuntimeName, adminDemoRuntimeSettingsSchema, adminRuntimeSettingsSchema, applicationRuntimeSettingsSchema, avatarRuntimeAgentVisualSettingsSchema, avatarRuntimeChatVisualSettingsSchema, avatarRuntimeContainedVisualSettingsSchema, avatarRuntimeLobbyVisualSettingsSchema, avatarRuntimeSettingsSchema, bannerVisualSettingsSchema, blockVisualContextSchema, chatCustomizationSchema, chatRuntimePlayerPluginSettingsSchema, chatRuntimeSettingsSchema, flashcardsToolRuntimeSettingsSchema, followupsToolRuntimeAvatarVisualSettingsSchema, followupsToolRuntimeGenieAnswerVisualSettingsSchema, followupsToolRuntimeSettingsSchema, genieAnswerVisualSettingsSchema, getSourceUrlSchema, gtcAgendaListToolRuntimeGenieAnswerVisualSettingsSchema, gtcAgendaListToolRuntimeSettingsSchema, gtcAgendaToolRuntimeGenieAnswerVisualSettingsSchema, gtcAgendaToolRuntimeSettingsSchema, integrationsSchema, isAvatarConnectionProxyInternalType, kalturaVideoPlayerToolRuntimeGenieAnswerVisualSettingsSchema, kalturaVideoPlayerToolRuntimeSettingsSchema, nvidia2026EventToolRuntimeSettingsSchema, pageVisualSettingsSchema, popupVisualSettingsSchema, shareUrlSchema, sourcesToolRuntimeGenieAnswerVisualSettingsSchema, sourcesToolRuntimeSettingsSchema, summaryToolRuntimeGenieAnswerVisualSettingsSchema, summaryToolRuntimeSettingsSchema, widgetName };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unisphere/genie-types",
-  "version": "1.13.0",
+  "version": "1.13.2",
   "author": "kaltura",
   "license": "AGPL-3.0",
   "repository": {
@@ -10,8 +10,8 @@
   "types": "./src/index.d.ts",
   "dependencies": {
     "@kaltura-corp/unisphere-rtc-core": "^1.22.1",
-    "@unisphere/core": "^1.91.1",
-    "@unisphere/runtime": "^1.90.1"
+    "@unisphere/core": "^1.94.1",
+    "@unisphere/runtime": "^1.91.0"
   },
   "module": "./index.esm.js",
   "type": "module",

package/src/lib/admin-demo-runtime/runtime-types.d.ts

@@ -1,5 +1,14 @@
 import { ValidatorSchema } from '@unisphere/core';
+/**
+ * Configuration settings for the admin demo runtime.
+ *
+ * @example
+ * ```typescript
+ * const settings: AdminDemoRuntimeSettings = {};
+ * ```
+ */
 export interface AdminDemoRuntimeSettings {
 }
 export declare const adminDemoRuntimeSettingsSchema: ValidatorSchema;
+/** Runtime name constant for admin demo experiences */
 export declare const AdminDemoRuntimeName: "admin-demo";

package/src/lib/admin-runtime/runtime-types.d.ts

@@ -1,8 +1,33 @@
 import { ValidatorSchema } from '@unisphere/core';
+/**
+ * Configuration settings for the admin runtime.
+ *
+ * @example
+ * Basic admin setup:
+ * ```typescript
+ * const settings: AdminRuntimeSettings = {
+ *   ks: 'your-kaltura-session-token'
+ * };
+ * ```
+ *
+ * @example
+ * With partner configuration:
+ * ```typescript
+ * const settings: AdminRuntimeSettings = {
+ *   ks: 'your-kaltura-session-token',
+ *   partnerId: '12345',
+ *   uiConfId: '54321'
+ * };
+ * ```
+ */
 export interface AdminRuntimeSettings {
+    /** Kaltura session token for authentication */
     ks: string;
+    /** UI configuration ID */
     uiConfId?: string;
+    /** Kaltura partner ID */
     partnerId?: string;
 }
 export declare const adminRuntimeSettingsSchema: ValidatorSchema;
+/** Runtime name constant for admin experiences */
 export declare const AdminRuntimeName: "admin";

package/src/lib/application-runtime/runtime-types.d.ts

@@ -1,17 +1,53 @@
 import { ValidatorSchema } from '@unisphere/core';
+/**
+ * Configuration settings for the application runtime.
+ *
+ * @example
+ * Basic application setup:
+ * ```typescript
+ * const settings: ApplicationRuntimeSettings = {
+ *   pid: 'partner-12345',
+ *   ks: 'your-kaltura-session-token',
+ *   kalturaServerURI: 'https://www.kaltura.com'
+ * };
+ * ```
+ *
+ * @example
+ * With custom source URL generation:
+ * ```typescript
+ * const settings: ApplicationRuntimeSettings = {
+ *   pid: 'partner-12345',
+ *   ks: 'your-kaltura-session-token',
+ *   kalturaServerURI: 'https://www.kaltura.com',
+ *   widgetId: 'widget_abc',
+ *   genieServerUrl: 'https://genie.example.com',
+ *   getSourceUrl: ({ entryId, startTime }) =>
+ *     `https://example.com/media/${entryId}${startTime ? `?t=${startTime}` : ''}`
+ * };
+ * ```
+ */
 export interface ApplicationRuntimeSettings {
+    /** Partner ID in the format `partner-{id}` */
     pid: string;
+    /** Widget identifier */
     widgetId?: string;
+    /** Genie server URL for API requests */
     genieServerUrl?: string;
+    /** Kaltura session token for authentication */
     ks: string;
+    /** Kaltura server URI */
     kalturaServerURI: string;
+    /** Callback function to generate source URLs with entry ID and optional start time */
     getSourceUrl?: ({ entryId, startTime, }: {
         entryId: string;
         startTime?: number;
     }) => string;
+    /** Branding options */
     branding?: {
+        /** Display Kaltura logo in the interface */
         kalturaLogo?: boolean;
     };
 }
 export declare const applicationRuntimeSettingsSchema: ValidatorSchema;
+/** Runtime name constant for application-level experiences */
 export declare const ApplicationRuntimeName: "application";

package/src/lib/avatar-runtime/agent-visual-types.d.ts

@@ -0,0 +1,18 @@
+import { ValidatorSchema } from '@unisphere/core';
+/**
+ * Visual settings for avatar agent display mode.
+ *
+ * @example
+ * ```typescript
+ * const settings: AvatarRuntimeAgentVisualSettings = {
+ *   panelSide: 'right'
+ * };
+ * ```
+ */
+export interface AvatarRuntimeAgentVisualSettings {
+    /** Settings schema version */
+    schemaVersion?: string;
+    /** Side of screen where agent panel appears */
+    panelSide?: 'left' | 'right';
+}
+export declare const avatarRuntimeAgentVisualSettingsSchema: ValidatorSchema;

package/src/lib/avatar-runtime/avatar-service-types.d.ts

@@ -1,30 +1,65 @@
 import { UnisphereService } from '@unisphere/runtime';
 import { TinyDataStoreConsumer } from '@unisphere/core';
 import { DeviceEnumerationResult } from '@kaltura-corp/unisphere-rtc-core';
+/**
+ * Avatar service configuration.
+ */
 export type AvatarConfig = {
+    /** Avatar server URL */
     serverUrl: string;
+    /** Avatar player URL */
     playerUrl: string;
 };
+/**
+ * Audio device types for avatar connections.
+ */
 export declare enum DeviceType {
+    /** Microphone input device */
     AudioInput = "audioinput",
+    /** Speaker/headphone output device */
     AudioOutput = "audiooutput"
 }
+/**
+ * Avatar connection status states.
+ *
+ * @deprecated Use AvatarConnectionStatus instead
+ */
 export declare enum AvatarStatus {
+    /** Establishing connection */
     Connecting = "connecting",
+    /** Successfully connected */
     Connected = "connected",
+    /** Not connected */
     Disconnected = "disconnected",
+    /** Connection error occurred */
     Error = "error"
 }
+/**
+ * Avatar connection lifecycle states.
+ */
 export declare enum AvatarConnectionStatus {
+    /** Establishing connection */
     Connecting = "connecting",
+    /** Successfully connected */
     Connected = "connected",
+    /** Not connected */
     Disconnected = "disconnected",
+    /** Closing connection */
     Disconnecting = "disconnecting",
+    /** Connection error occurred */
     Error = "error"
 }
+/**
+ * Avatar client initialization status.
+ */
 export type AvatarClientStatus = 'loading' | 'ready';
+/**
+ * Reasons why avatar agent may be unavailable.
+ */
 export declare enum AgentUnavailabilityReasons {
+    /** No agents are currently available */
     NoAgents = "NoAgents",
+    /** Maximum concurrent connections reached */
     CapacityReached = "CapacityReached"
 }
 export type UserDevicesList = Pick<DeviceEnumerationResult, 'availableDevices'> & {
@@ -33,38 +68,78 @@ export type UserDevicesList = Pick<DeviceEnumerationResult, 'availableDevices'>
         audioOutputDevice: string | null;
     };
 };
+/**
+ * Simplified WebSocket interface for avatar communication.
+ */
 export interface SimplifiedSocket {
+    /** Register event listener */
     on: (event: string, callback: (data: any) => void) => void;
+    /** Remove event listener */
     off: (event: string) => void;
+    /** Emit event with data */
     emit: (event: string, data: any) => void;
 }
+/**
+ * Agent state and analytics data.
+ */
 export type AgentData = {
+    /** Whether the agent is currently speaking */
     isTalking: boolean;
+    /** Number of answers provided in this session */
     answersCount: number;
+    /** Optional analytics tracking information */
     analyticsInfo?: {
+        /** Thread identifier */
         threadId?: string;
+        /** Message identifier */
         messageId?: string;
     };
 };
+/**
+ * Content data for avatar tool integrations.
+ *
+ * Represents tool content displayed within avatar experiences, with different
+ * states for loading, ready, and error conditions.
+ */
 export type AvatarContentData = {
+    /** Unique content identifier */
     id: string;
+    /** Associated thread ID */
     threadId?: string;
+    /** Associated message ID */
     messageId?: string;
+    /** Optional new title for the content */
     newTitle?: string;
+    /** Content type identifier */
     type: 'unisphere-tool';
+    /** Widget name for the tool */
     widgetName: string;
+    /** Runtime name for the tool */
     runtimeName: string;
 } & ({
+    /** Content status: loading or ready */
     status: 'loading' | 'ready';
+    /** Tool settings configuration */
     settings: any;
+    /** Optional thread ID */
     threadId?: string;
 } | {
+    /** Content status: error occurred */
     status: 'error';
 });
+/**
+ * Internal avatar connection proxy interface for advanced operations.
+ *
+ * @internal
+ */
 export interface AvatarConnectionProxInternalType {
+    /** Send direct event to server */
     _directEventToServer(message: string, data: any): void;
+    /** Set local content state */
     _setLocalContent(content: any): void;
+    /** Handle player errors */
     onPlayerError(error: Error): void;
+    /** WebSocket connection observable */
     webSocket: TinyDataStoreConsumer<SimplifiedSocket | null>;
 }
 export declare enum DisconnectReasons {
@@ -88,27 +163,46 @@ export declare enum DisconnectReasons {
     ConnectionTimeout = "ConnectionTimeout",
     PlayerConnectionFailed = "PlayerConnectionFailed"
 }
+/**
+ * Avatar connection proxy for managing avatar session state and interactions.
+ *
+ * Provides observable properties for connection state and methods for
+ * sending messages and managing the avatar connection lifecycle.
+ */
 export interface AvatarConnectionProxyType {
+    /** Observable connection status */
     readonly status: TinyDataStoreConsumer<AvatarConnectionStatus>;
+    /** Observable player URL */
     readonly playerUrl: TinyDataStoreConsumer<string | null>;
+    /** Observable session identifier */
     readonly sessionId: TinyDataStoreConsumer<string | null>;
+    /** Observable TURN server URL */
     readonly turnServerURL: TinyDataStoreConsumer<string | null>;
+    /** Observable content data */
     readonly content: TinyDataStoreConsumer<AvatarContentData | null>;
+    /** Observable agent state and analytics */
     readonly agentData: TinyDataStoreConsumer<AgentData | null>;
+    /** Observable available audio devices */
     readonly devicesList: TinyDataStoreConsumer<{
         audioInput: MediaDeviceInfo[];
         audioOutput: MediaDeviceInfo[];
     } | null>;
+    /** Observable disconnect information */
     readonly disconnectData: TinyDataStoreConsumer<{
         reason: DisconnectReasons;
         error?: Error;
         suppressNotification?: boolean;
         skipDisconnect?: boolean;
     } | null>;
+    /** Observable thread identifier */
     readonly threadId: TinyDataStoreConsumer<string | null>;
+    /** Unique connection identifier */
     readonly id: string;
+    /** Send text message to avatar */
     sendAskViaText(text: string): void;
+    /** Send custom event to avatar */
     sendDirectEvent(message: string, data: unknown): void;
+    /** Terminate the avatar connection */
     destroy(): void;
 }
 export declare const isAvatarConnectionProxyInternalType: (x: any) => x is AvatarConnectionProxInternalType;
@@ -133,6 +227,7 @@ export interface AvatarServiceType extends UnisphereService {
         threadId?: string;
         messageId?: string;
     }): void;
+    disconnect(): void;
     onPlayerReady(): void;
     onPlayerError(error: Error): void;
     getKalturaPlayerParams(): {

package/src/lib/avatar-runtime/chat-visual-types.d.ts

@@ -1,5 +1,14 @@
 import { ValidatorSchema } from '@unisphere/core';
+/**
+ * Visual settings for avatar runtime chat display.
+ *
+ * @example
+ * ```typescript
+ * const settings: AvatarRuntimeChatVisualSettings = {};
+ * ```
+ */
 export interface AvatarRuntimeChatVisualSettings {
+    /** Settings schema version */
     schemaVersion?: string;
 }
 export declare const avatarRuntimeChatVisualSettingsSchema: ValidatorSchema;

package/src/lib/avatar-runtime/contained-visual-types.d.ts

@@ -1,5 +1,14 @@
 import { ValidatorSchema } from '@unisphere/core';
+/**
+ * Visual settings for contained/embedded avatar display mode.
+ *
+ * @example
+ * ```typescript
+ * const settings: AvatarRuntimeContainedVisualSettings = {};
+ * ```
+ */
 export interface AvatarRuntimeContainedVisualSettings {
+    /** Settings schema version */
     schemaVersion?: string;
 }
 export declare const avatarRuntimeContainedVisualSettingsSchema: ValidatorSchema;

package/src/lib/avatar-runtime/index.d.ts

@@ -3,3 +3,4 @@ export * from './chat-visual-types';
 export * from './avatar-service-types';
 export * from './contained-visual-types';
 export * from './lobby-visual-types';
+export * from './agent-visual-types';

package/src/lib/avatar-runtime/lobby-visual-types.d.ts

@@ -1,9 +1,41 @@
 import { ValidatorSchema } from '@unisphere/core';
+/**
+ * Visual settings for avatar lobby/waiting room display.
+ *
+ * @example
+ * Default lobby:
+ * ```typescript
+ * const settings: AvatarRuntimeLobbyVisualSettings = {
+ *   variant: 'default'
+ * };
+ * ```
+ *
+ * @example
+ * Agent variant with customization:
+ * ```typescript
+ * const settings: AvatarRuntimeLobbyVisualSettings = {
+ *   variant: 'agent',
+ *   agentButtonLabel: 'Start Conversation',
+ *   agentSize: '20rem',
+ *   isTranslucent: true,
+ *   threadId: 'thread-123'
+ * };
+ * ```
+ */
 export interface AvatarRuntimeLobbyVisualSettings {
+    /** Settings schema version */
     schemaVersion?: string;
-    variant?: 'default' | 'mini' | 'buttonOnly';
+    /** Display variant: 'default' for full lobby, 'mini' for compact, 'buttonOnly' for minimal, 'agent' for agent-specific UI */
+    variant?: 'default' | 'mini' | 'buttonOnly' | 'agent';
+    /** Enable translucent/semi-transparent UI elements */
     isTranslucent?: boolean;
+    /** Thread identifier for resuming conversations */
     threadId?: string;
+    /** Message identifier for context */
     messageId?: string;
+    /** Agent variant only: label for the start button */
+    agentButtonLabel?: string;
+    /** Agent variant only: size (width and height) of the card, e.g. '15rem' */
+    agentSize?: string;
 }
 export declare const avatarRuntimeLobbyVisualSettingsSchema: ValidatorSchema;