@unisphere/genie-types 1.20.0 → 1.21.0

package/index.esm.js

@@ -1098,6 +1098,71 @@ const getAvatarDefaultCapabilities = context => {
   }
   return AVATAR_DEFAULT_CAPABILITIES;
 };
+const chatContextSchema = {
+  type: 'orByType',
+  optional: true,
+  schemas: {
+    entry: {
+      type: 'object',
+      properties: {
+        type: {
+          type: 'literal',
+          value: 'entry'
+        },
+        id: {
+          type: 'primitive',
+          value: 'string'
+        },
+        imageUrl: {
+          type: 'primitive',
+          value: 'string',
+          optional: true
+        },
+        title: {
+          type: 'primitive',
+          value: 'string',
+          optional: true
+        }
+      }
+    },
+    category: {
+      type: 'object',
+      properties: {
+        type: {
+          type: 'literal',
+          value: 'category'
+        },
+        id: {
+          type: 'primitive',
+          value: 'string'
+        },
+        title: {
+          type: 'primitive',
+          value: 'string',
+          optional: true
+        }
+      }
+    },
+    'ancestor-category': {
+      type: 'object',
+      properties: {
+        type: {
+          type: 'literal',
+          value: 'ancestor-category'
+        },
+        id: {
+          type: 'primitive',
+          value: 'string'
+        },
+        title: {
+          type: 'primitive',
+          value: 'string',
+          optional: true
+        }
+      }
+    }
+  }
+};
 const integrationsSchema = {
   type: 'object',
   properties: {
@@ -1264,20 +1329,7 @@ const chatRuntimeSettingsSchema = {
       },
       optional: true
     },
-    context: {
-      type: 'object',
-      optional: true,
-      properties: {
-        type: {
-          type: 'enum',
-          values: ['entry', 'category']
-        },
-        id: {
-          type: 'primitive',
-          value: 'string'
-        }
-      }
-    },
+    context: chatContextSchema,
     // @deprecated - kept for backward compatibility
     entryId: {
       type: 'primitive',
@@ -1322,20 +1374,7 @@ const chatRuntimePlayerPluginSettingsSchema = {
       value: 'string',
       optional: true
     },
-    context: {
-      type: 'object',
-      optional: true,
-      properties: {
-        type: {
-          type: 'enum',
-          values: ['entry', 'category']
-        },
-        id: {
-          type: 'primitive',
-          value: 'string'
-        }
-      }
-    },
+    context: chatContextSchema,
     // @deprecated - kept for backward compatibility
     entryId: {
       type: 'primitive',
@@ -1529,7 +1568,8 @@ const floaterVisualSettingsSchema = {
       type: 'enum',
       values: ['chat', 'everywhere'],
       optional: true
-    }
+    },
+    context: chatContextSchema
   }
 };
 const floaterCTAVisualSettingsSchema = {
@@ -1555,6 +1595,7 @@ const floaterCTAVisualSettingsSchema = {
       value: 'boolean',
       optional: true
     },
+    context: chatContextSchema,
     type: {
       type: 'literal',
       value: 'button',
@@ -1604,13 +1645,24 @@ const containedVisualSettingsSchema = {
       values: ['body', 'container', 'modal'],
       optional: true
     },
-    context: {
+    context: chatContextSchema,
+    closeButtonType: {
+      type: 'enum',
+      values: ['none', 'drawer', 'close'],
+      optional: true
+    }
+  }
+};
+const pageContextSchema = {
+  type: 'orByType',
+  optional: true,
+  schemas: {
+    entry: {
       type: 'object',
-      optional: true,
       properties: {
         type: {
-          type: 'enum',
-          values: ['entry', 'category', 'ancestor-category']
+          type: 'literal',
+          value: 'entry'
         },
         id: {
           type: 'primitive',
@@ -1618,10 +1670,31 @@ const containedVisualSettingsSchema = {
         }
       }
     },
-    closeButtonType: {
-      type: 'enum',
-      values: ['none', 'drawer', 'close'],
-      optional: true
+    category: {
+      type: 'object',
+      properties: {
+        type: {
+          type: 'literal',
+          value: 'category'
+        },
+        id: {
+          type: 'primitive',
+          value: 'string'
+        }
+      }
+    },
+    'ancestor-category': {
+      type: 'object',
+      properties: {
+        type: {
+          type: 'literal',
+          value: 'ancestor-category'
+        },
+        id: {
+          type: 'primitive',
+          value: 'string'
+        }
+      }
     }
   }
 };
@@ -1639,6 +1712,7 @@ const pageVisualSettingsSchema = {
       optional: true
     },
     customization: chatCustomizationSchema,
+    context: pageContextSchema,
     initialQuestion: {
       type: 'object',
       optional: true,
@@ -2111,20 +2185,7 @@ const avatarRuntimeSettingsSchema = {
           type: 'primitive',
           value: 'string'
         },
-        context: {
-          type: 'object',
-          optional: true,
-          properties: {
-            type: {
-              type: 'enum',
-              values: ['entry', 'category']
-            },
-            id: {
-              type: 'primitive',
-              value: 'string'
-            }
-          }
-        },
+        context: chatContextSchema,
         capabilities: {
           type: 'object',
           optional: true,
@@ -2285,12 +2346,7 @@ const avatarRuntimeLobbyVisualSettingsSchema = {
     },
     variant: {
       type: 'enum',
-      values: ['default', 'mini', 'buttonOnly', 'agent'],
-      optional: true
-    },
-    isTranslucent: {
-      type: 'primitive',
-      value: 'boolean',
+      values: ['agent'],
       optional: true
     },
     threadId: {
@@ -2331,11 +2387,6 @@ const avatarRuntimeLobbyVisualSettingsSchema = {
       },
       optional: true
     },
-    hideStartButton: {
-      type: 'primitive',
-      value: 'boolean',
-      optional: true
-    },
     onOpen: {
       type: 'function',
       optional: true
@@ -3235,4 +3286,4 @@ const contentGalleryToolRuntimeGenieAnswerVisualSettingsSchema = {
   }
 };
 
-export { AVATAR_DEFAULT_CAPABILITIES, AdminDemoRuntimeName, AdminRuntimeName, AgentUnavailabilityReasons, AnswerModelEnum, AnswerTypeEnum, ApplicationRuntimeName, AvatarConnectionStatus, AvatarRuntimeName, AvatarStatus, CHAT_DEFAULT_CAPABILITIES, ChatRuntimeName, ContentGalleryToolRuntimeName, DeviceType, DisconnectReasons, FlashcardsToolRuntimeName, FollowupsToolRuntimeName, GenUiComponentsToolRuntimeName, GenUiComposerToolRuntimeName, GtcAgendaListToolRuntimeName, GtcAgendaToolRuntimeName, KalturaVideoPlayerToolRuntimeName, Nvidia2026EventToolRuntimeName, SourcesToolRuntimeName, SummaryToolRuntimeName, adminDemoRuntimeSettingsSchema, adminRuntimeSettingsSchema, applicationRuntimeSettingsSchema, avatarRuntimeAgentVisualSettingsSchema, avatarRuntimeChatVisualSettingsSchema, avatarRuntimeContainedVisualSettingsSchema, avatarRuntimeLobbyVisualSettingsSchema, avatarRuntimeSettingsSchema, bannerVisualSettingsSchema, blockVisualContextSchema, chatCustomizationSchema, chatRuntimePlayerPluginSettingsSchema, chatRuntimeSettingsSchema, containedVisualSettingsSchema, contentGalleryToolRuntimeAvatarVisualSettingsSchema, contentGalleryToolRuntimeGenieAnswerVisualSettingsSchema, contentGalleryToolRuntimeSettingsSchema, flashcardsToolRuntimeSettingsSchema, floaterCTAVisualSettingsSchema, floaterVisualSettingsSchema, followupsToolRuntimeAvatarVisualSettingsSchema, followupsToolRuntimeGenieAnswerVisualSettingsSchema, followupsToolRuntimeSettingsSchema, genUiComponentsToolRuntimeCardVisualSettingsSchema, genUiComponentsToolRuntimeLoginVisualSettingsSchema, genUiComponentsToolRuntimeMarkdownVisualSettingsSchema, genUiComponentsToolRuntimePlayerVisualSettingsSchema, genUiComponentsToolRuntimeQuestionsPresetsVisualSettingsSchema, genUiComponentsToolRuntimeSettingsSchema, genUiComposerToolRuntimeAvatarVisualSettingsSchema, genUiComposerToolRuntimeSettingsSchema, genieAnswerVisualSettingsSchema, getAvatarDefaultCapabilities, getChatDefaultCapabilities, getSourceUrlSchema, gtcAgendaListToolRuntimeAvatarVisualSettingsSchema, gtcAgendaListToolRuntimeSettingsSchema, gtcAgendaToolRuntimeAvatarVisualSettingsSchema, gtcAgendaToolRuntimeSettingsSchema, integrationsSchema, isAvatarConnectionProxyInternalType, kalturaVideoPlayerToolRuntimeAvatarVisualSettingsSchema, kalturaVideoPlayerToolRuntimeSettingsSchema, nvidia2026EventToolRuntimeSettingsSchema, pageVisualSettingsSchema, popupVisualSettingsSchema, shareUrlSchema, slideSchema, sourcesToolRuntimeGenieAnswerVisualSettingsSchema, sourcesToolRuntimeSettingsSchema, summaryToolRuntimeGenieAnswerVisualSettingsSchema, summaryToolRuntimeSettingsSchema, widgetName };
+export { AVATAR_DEFAULT_CAPABILITIES, AdminDemoRuntimeName, AdminRuntimeName, AgentUnavailabilityReasons, AnswerModelEnum, AnswerTypeEnum, ApplicationRuntimeName, AvatarConnectionStatus, AvatarRuntimeName, AvatarStatus, CHAT_DEFAULT_CAPABILITIES, ChatRuntimeName, ContentGalleryToolRuntimeName, DeviceType, DisconnectReasons, FlashcardsToolRuntimeName, FollowupsToolRuntimeName, GenUiComponentsToolRuntimeName, GenUiComposerToolRuntimeName, GtcAgendaListToolRuntimeName, GtcAgendaToolRuntimeName, KalturaVideoPlayerToolRuntimeName, Nvidia2026EventToolRuntimeName, SourcesToolRuntimeName, SummaryToolRuntimeName, adminDemoRuntimeSettingsSchema, adminRuntimeSettingsSchema, applicationRuntimeSettingsSchema, avatarRuntimeAgentVisualSettingsSchema, avatarRuntimeChatVisualSettingsSchema, avatarRuntimeContainedVisualSettingsSchema, avatarRuntimeLobbyVisualSettingsSchema, avatarRuntimeSettingsSchema, bannerVisualSettingsSchema, blockVisualContextSchema, chatContextSchema, chatCustomizationSchema, chatRuntimePlayerPluginSettingsSchema, chatRuntimeSettingsSchema, containedVisualSettingsSchema, contentGalleryToolRuntimeAvatarVisualSettingsSchema, contentGalleryToolRuntimeGenieAnswerVisualSettingsSchema, contentGalleryToolRuntimeSettingsSchema, flashcardsToolRuntimeSettingsSchema, floaterCTAVisualSettingsSchema, floaterVisualSettingsSchema, followupsToolRuntimeAvatarVisualSettingsSchema, followupsToolRuntimeGenieAnswerVisualSettingsSchema, followupsToolRuntimeSettingsSchema, genUiComponentsToolRuntimeCardVisualSettingsSchema, genUiComponentsToolRuntimeLoginVisualSettingsSchema, genUiComponentsToolRuntimeMarkdownVisualSettingsSchema, genUiComponentsToolRuntimePlayerVisualSettingsSchema, genUiComponentsToolRuntimeQuestionsPresetsVisualSettingsSchema, genUiComponentsToolRuntimeSettingsSchema, genUiComposerToolRuntimeAvatarVisualSettingsSchema, genUiComposerToolRuntimeSettingsSchema, genieAnswerVisualSettingsSchema, getAvatarDefaultCapabilities, getChatDefaultCapabilities, getSourceUrlSchema, gtcAgendaListToolRuntimeAvatarVisualSettingsSchema, gtcAgendaListToolRuntimeSettingsSchema, gtcAgendaToolRuntimeAvatarVisualSettingsSchema, gtcAgendaToolRuntimeSettingsSchema, integrationsSchema, isAvatarConnectionProxyInternalType, kalturaVideoPlayerToolRuntimeAvatarVisualSettingsSchema, kalturaVideoPlayerToolRuntimeSettingsSchema, nvidia2026EventToolRuntimeSettingsSchema, pageVisualSettingsSchema, popupVisualSettingsSchema, shareUrlSchema, slideSchema, sourcesToolRuntimeGenieAnswerVisualSettingsSchema, sourcesToolRuntimeSettingsSchema, summaryToolRuntimeGenieAnswerVisualSettingsSchema, summaryToolRuntimeSettingsSchema, widgetName };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unisphere/genie-types",
-  "version": "1.20.0",
+  "version": "1.21.0",
   "author": "kaltura",
   "license": "AGPL-3.0",
   "repository": {
@@ -10,7 +10,7 @@
   "types": "./src/index.d.ts",
   "dependencies": {
     "@kaltura-sdk/rtc-core": "^1.25.12",
-    "@unisphere/core": "^1.98.0",
+    "@unisphere/core": "^1.99.0",
     "@unisphere/runtime": "^1.97.0"
   },
   "module": "./index.esm.js",

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

@@ -37,8 +37,12 @@ export interface ApplicationRuntimeSettings {
     ks: string;
     /** Kaltura server URI */
     kalturaServerURI: string;
-    /** Callback function to generate source URLs with entry ID and optional start time */
-    getSourceUrl?: ({ entryId, startTime, }: {
+    /** Callback function to generate source URLs for an entry or category */
+    getSourceUrl?: (params: {
+        type: 'category';
+        categoryId: string;
+    } | {
+        type?: 'entry';
         entryId: string;
         startTime?: number;
     }) => string;

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

@@ -25,10 +25,8 @@ import { ValidatorSchema } from '@unisphere/core';
 export interface AvatarRuntimeLobbyVisualSettings {
     /** Settings schema version */
     schemaVersion?: string;
-    /** 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;
+    /** Display variant: 'agent' for agent-specific UI */
+    variant?: 'agent';
     /** Thread identifier for resuming conversations */
     threadId?: string;
     /** Message identifier for context */
@@ -44,8 +42,6 @@ export interface AvatarRuntimeLobbyVisualSettings {
         /** Styles applied to the outer wrapper (mini variant only) */
         wrapper?: Record<string, string | number>;
     };
-    /** Hide the start conversation button (e.g. when interaction limit is exceeded) */
-    hideStartButton?: boolean;
     /** When provided, overrides the default avatar launch behavior on click */
     onOpen?: () => void;
 }

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

@@ -14,7 +14,10 @@ export type AvatarRuntime = UnisphereRuntimeBaseType<AvatarRuntimeSettings> & {
     readonly widgetName: typeof widgetName;
     readonly runtimeName: typeof AvatarRuntimeName;
     /** Establish connection to the avatar service */
-    connect(): void;
+    connect(params?: {
+        threadId?: string;
+        messageId?: string;
+    }): void;
     /** Disconnect from the avatar service */
     disconnect(): void;
     /** Observable connection status */

package/src/lib/chat-runtime/runtime-player-plugin-types.d.ts

@@ -44,12 +44,7 @@ export interface ChatRuntimePlayerPlugin extends UnisphereRuntimeBaseType<ChatRu
  */
 export interface ChatRuntimePlayerPluginSettings {
     /** Context for the chat session */
-    context?: {
-        /** Context type - 'entry' for media entries, 'category' for content categories */
-        type: 'entry' | 'category';
-        /** Media entry ID or category ID for context-aware conversations */
-        id: string;
-    };
+    context?: GlobalChatSettings['context'];
     /** Kaltura session token for authentication */
     ks?: string;
     /** Kaltura partner ID */

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

@@ -1,7 +1,7 @@
 import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
 import { ValidatorSchema } from '@unisphere/core';
 import { widgetName } from '../widget-types';
-import { GlobalChatSettings } from './shared-settings';
+import { ChatContext, GlobalChatSettings } from './shared-settings';
 /** Runtime name constant for chat experiences */
 export declare const ChatRuntimeName: "chat";
 /**
@@ -65,12 +65,7 @@ export interface ChatRuntimeSettings {
     /** Kaltura partner ID */
     partnerId?: string;
     /** Context for the chat session */
-    context?: {
-        /** Context type - 'entry' for media entries, 'category' for content categories */
-        type: 'entry' | 'category';
-        /** Media entry ID or category ID for context-aware conversations */
-        id: string;
-    };
+    context?: ChatContext;
     /** Enable agent mode for advanced AI features */
     agentMode?: boolean;
     /** Avatar display mode: 'dialog' for modal or 'contained' for embedded */

package/src/lib/chat-runtime/shared-settings.d.ts

@@ -13,10 +13,16 @@ export declare const CHAT_DEFAULT_CAPABILITIES: GenieCapabilities;
 export declare const AVATAR_DEFAULT_CAPABILITIES: GenieCapabilities;
 export declare const getChatDefaultCapabilities: (context?: ChatContext) => GenieCapabilities;
 export declare const getAvatarDefaultCapabilities: (context?: ChatContext) => GenieCapabilities;
-export interface ChatContext {
-    type: 'entry' | 'category';
+export type ChatContext = {
+    type: 'entry';
     id: string;
-}
+    imageUrl?: string;
+    title?: string;
+} | {
+    type: 'category' | 'ancestor-category';
+    id: string;
+    title?: string;
+};
 /**
  * Branding configuration for chat UI.
  */
@@ -72,6 +78,8 @@ export type AvatarIntegration = {
 } | {
     /** Configuration type: 'byKS' for automatic setup using Kaltura session */
     type: 'byKS';
+    /** Loading video URL displayed during initialization */
+    loadingVideoURL?: string;
     /** Preview image URL displayed before avatar loads */
     previewImageUrl?: string;
 };
@@ -119,8 +127,12 @@ export interface GlobalChatSettings {
     context?: ChatContext;
     /** Genie capability overrides — defaults applied per API if absent */
     capabilities?: GenieCapabilities;
-    /** Callback function to generate source URLs with entry ID and optional start time */
+    /** Callback function to generate source URLs for an entry or category */
     getSourceUrl?: (params: {
+        type: 'category';
+        categoryId: string;
+    } | {
+        type?: 'entry';
         entryId: string;
         startTime?: number;
     }) => string;
@@ -143,6 +155,7 @@ export interface GlobalChatSettings {
         kaltura?: KalturaIntegration;
     };
 }
+export declare const chatContextSchema: ValidatorSchema;
 export declare const integrationsSchema: ValidatorSchema;
 export declare const shareUrlSchema: ValidatorSchema;
 export declare const getSourceUrlSchema: ValidatorSchema;

package/src/lib/chat-runtime/visuals-types.d.ts

@@ -1,5 +1,6 @@
 import { ValidatorSchema } from '@unisphere/core';
 import { ChatCustomization } from '../shared/chat-customizations-types';
+import { ChatContext } from './shared-settings';
 import { AnswerTypeEnum } from '../types';
 /**
  * Visual settings for page-embedded chat experiences.
@@ -21,6 +22,8 @@ export interface PageVisualSettings {
     scroll?: 'body' | 'container' | 'modal';
     /** Custom UI styling and behavior options */
     customization?: ChatCustomization;
+    /** Context for the chat session — host-provided, not user-controllable */
+    context?: Pick<ChatContext, 'type' | 'id'>;
 }
 /**
  * Visual settings for banner/hero-style chat landing pages.
@@ -110,12 +113,7 @@ export interface ContainedVisualSettings {
     /** Scroll container mode: 'body' for page scroll, 'container' for internal scroll, 'modal' for modal dialog */
     scroll?: 'body' | 'container' | 'modal';
     /** Context for the chat session */
-    context?: {
-        /** Context type - 'entry' for media entries, 'category' for content categories */
-        type: 'entry' | 'category' | 'ancestor-category';
-        /** Media entry ID or category ID for context-aware conversations */
-        id: string;
-    };
+    context?: ChatContext;
     /** Type of close button to display in the header */
     closeButtonType?: 'none' | 'drawer' | 'close';
 }
@@ -124,6 +122,7 @@ export type FloaterCTAVisualSettings = {
     position?: 'bottom-right' | 'bottom-center' | 'bottom-left';
     mode?: 'chat' | 'everywhere';
     openByDefault?: boolean;
+    context?: ChatContext;
 } & {
     type?: 'button';
     text?: string;
@@ -132,6 +131,7 @@ export type FloaterCTAVisualSettings = {
 export interface FloaterVisualSettings {
     schemaVersion?: '1';
     mode?: 'chat' | 'everywhere';
+    context?: ChatContext;
 }
 export declare const floaterVisualSettingsSchema: ValidatorSchema;
 export declare const floaterCTAVisualSettingsSchema: ValidatorSchema;