@unisphere/genie-types 1.17.0 → 1.18.0-avatar-chat.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unisphere/genie-types",
-  "version": "1.17.0",
+  "version": "1.18.0-avatar-chat.1",
   "author": "kaltura",
   "license": "AGPL-3.0",
   "repository": {
@@ -10,8 +10,8 @@
   "types": "./src/index.d.ts",
   "dependencies": {
     "@kaltura-sdk/rtc-core": "^1.25.2",
-    "@unisphere/core": "^1.95.0",
-    "@unisphere/runtime": "^1.91.0"
+    "@unisphere/core": "^1.97.1",
+    "@unisphere/runtime": "^1.97.0"
   },
   "module": "./index.esm.js",
   "type": "module",

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

@@ -1,6 +1,7 @@
 import { UnisphereService } from '@unisphere/runtime';
 import { TinyDataStoreConsumer } from '@unisphere/core';
 import { DeviceEnumerationResult } from '@kaltura-sdk/rtc-core';
+import type { ChatEntry } from './chat-types';
 /**
  * Avatar service configuration.
  */
@@ -196,6 +197,8 @@ export interface AvatarConnectionProxyType {
     } | null>;
     /** Observable thread identifier */
     readonly threadId: TinyDataStoreConsumer<string | null>;
+    /** Observable chat log entries */
+    readonly chatLog: TinyDataStoreConsumer<ChatEntry[]>;
     /** Unique connection identifier */
     readonly id: string;
     /** Send text message to avatar */

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

@@ -0,0 +1,7 @@
+export type ChatEntryRole = 'user' | 'avatar';
+export type ChatEntry = {
+    id: string;
+    role: ChatEntryRole;
+    text: string;
+    turnId?: string;
+};

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

@@ -1,5 +1,6 @@
 export * from './runtime-types';
 export * from './chat-visual-types';
+export * from './chat-types';
 export * from './avatar-service-types';
 export * from './contained-visual-types';
 export * from './lobby-visual-types';

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

@@ -1,6 +1,7 @@
 import { TinyDataStoreConsumer, ValidatorSchema } from '@unisphere/core';
 import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
 import { widgetName } from '../widget-types';
+import { ChatContext, GenieCapabilities } from '../chat-runtime/shared-settings';
 /** Runtime name constant for avatar experiences */
 export declare const AvatarRuntimeName: "avatar";
 /**
@@ -56,7 +57,8 @@ export type AvatarRuntime = UnisphereRuntimeBaseType<AvatarRuntimeSettings> & {
  *   kaltura: {
  *     ks: 'your-kaltura-session-token',
  *     partnerId: '12345',
- *     entryId: 'entry_xyz'
+ *     context: { type: 'entry', id: 'entry_xyz' },
+ *     capabilities: { use_knowledge_base: 'on' }
  *   }
  * };
  * ```
@@ -92,8 +94,10 @@ export interface AvatarRuntimeSettings {
     kaltura: {
         /** Kaltura session token for authentication */
         ks: string;
-        /** Media entry ID for context */
-        entryId?: string;
+        /** Context for the avatar session */
+        context?: ChatContext;
+        /** Genie capability overrides — defaults applied per API if absent */
+        capabilities?: GenieCapabilities;
         /** Kaltura server URI */
         kalturaServerURI?: string;
         /** Kaltura partner ID */

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

@@ -1,5 +1,4 @@
-export * from './runtime-flavors/runtime-types';
-export * from './runtime-flavors/runtime-player-plugin-types';
+export * from './runtime-types';
+export * from './runtime-player-plugin-types';
 export * from './visuals-types';
-export * from './types';
 export * from './shared-settings';

package/src/lib/chat-runtime/{runtime-flavors/runtime-player-plugin-types.d.ts → runtime-player-plugin-types.d.ts}

@@ -1,8 +1,8 @@
 import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
 import { ValidatorSchema } from '@unisphere/core';
-import { widgetName } from '../../widget-types';
-import { ChatRuntimeName } from '../types';
-import { GlobalChatSettings } from '../shared-settings';
+import { widgetName } from '../widget-types';
+import { ChatRuntimeName } from './runtime-types';
+import { GlobalChatSettings } from './shared-settings';
 /**
  * Chat runtime interface for player plugin integration.
  *
@@ -20,7 +20,7 @@ export interface ChatRuntimePlayerPlugin extends UnisphereRuntimeBaseType<ChatRu
  * Basic player plugin setup:
  * ```typescript
  * const settings: ChatRuntimePlayerPluginSettings = {
- *   entryId: 'video_123',
+ *   context: { type: 'entry', id: 'video_123' },
  *   ks: 'your-kaltura-session-token'
  * };
  * ```
@@ -29,7 +29,7 @@ export interface ChatRuntimePlayerPlugin extends UnisphereRuntimeBaseType<ChatRu
  * With integrations:
  * ```typescript
  * const settings: ChatRuntimePlayerPluginSettings = {
- *   entryId: 'video_123',
+ *   context: { type: 'entry', id: 'video_123' },
  *   ks: 'your-kaltura-session-token',
  *   partnerId: '12345',
  *   agentMode: true,
@@ -43,8 +43,13 @@ export interface ChatRuntimePlayerPlugin extends UnisphereRuntimeBaseType<ChatRu
  * ```
  */
 export interface ChatRuntimePlayerPluginSettings {
-    /** Media entry ID for the video being played */
-    entryId: 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;
+    };
     /** Kaltura session token for authentication */
     ks?: string;
     /** Kaltura partner ID */

package/src/lib/chat-runtime/{runtime-flavors/runtime-types.d.ts → runtime-types.d.ts}

@@ -1,8 +1,9 @@
 import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
 import { ValidatorSchema } from '@unisphere/core';
-import { widgetName } from '../../widget-types';
-import { ChatRuntimeName } from '../types';
-import { GlobalChatSettings } from '../shared-settings';
+import { widgetName } from '../widget-types';
+import { GlobalChatSettings } from './shared-settings';
+/** Runtime name constant for chat experiences */
+export declare const ChatRuntimeName: "chat";
 /**
  * Chat runtime interface for Genie conversational AI experiences.
  *
@@ -31,7 +32,7 @@ export interface ChatRuntime extends UnisphereRuntimeBaseType<ChatRuntimeSetting
  * const settings: ChatRuntimeSettings = {
  *   ks: 'your-kaltura-session-token',
  *   partnerId: '12345',
- *   entryId: 'entry_xyz',
+ *   context: { type: 'entry', id: 'entry_xyz' },
  *   initialQuestion: 'Hello! How can I help?',
  *   integrations: {
  *     kaltura: {
@@ -63,8 +64,13 @@ export interface ChatRuntimeSettings {
     agenticServerUrl?: string;
     /** Kaltura partner ID */
     partnerId?: string;
-    /** Media entry ID for context-aware chat */
-    entryId?: 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;
+    };
     /** 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

@@ -1,4 +1,22 @@
 import { ValidatorSchema } from '@unisphere/core';
+export type CapabilityToggle = 'on' | 'off';
+export interface GenieCapabilities {
+    use_knowledge_base?: CapabilityToggle;
+    use_content_search?: CapabilityToggle;
+    use_get_entry_content?: CapabilityToggle;
+    generate_followup_questions?: CapabilityToggle;
+    include_sources?: CapabilityToggle;
+    use_related_files?: CapabilityToggle;
+    avatar?: CapabilityToggle;
+}
+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';
+    id: string;
+}
 /**
  * Branding configuration for chat UI.
  */
@@ -97,8 +115,10 @@ export interface KalturaIntegration {
 export interface GlobalChatSettings {
     /** Kaltura session token for authentication */
     ks: string;
-    /** Entry ID for context-aware features */
-    entryId?: string;
+    /** Context for the chat session */
+    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 */
     getSourceUrl?: (params: {
         entryId: string;

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

@@ -7,8 +7,8 @@ import { AnswerTypeEnum } from '../types';
  * @example
  * ```typescript
  * const settings: PageVisualSettings = {
+ *   scroll: 'container',
  *   customization: {
- *     scroll: 'container',
  *     theme: { translucent: true }
  *   }
  * };
@@ -17,6 +17,8 @@ import { AnswerTypeEnum } from '../types';
 export interface PageVisualSettings {
     /** Settings schema version */
     schemaVersion?: '1';
+    /** Scroll container mode: 'body' for page scroll, 'container' for internal scroll, 'modal' for modal dialog */
+    scroll?: 'body' | 'container' | 'modal';
     /** Custom UI styling and behavior options */
     customization?: ChatCustomization;
 }
@@ -69,9 +71,7 @@ export interface BannerVisualSettings {
  * @example
  * ```typescript
  * const settings: PopupVisualSettings = {
- *   customization: {
- *     scroll: 'modal'
- *   },
+ *   scroll: 'modal',
  *   initialQuestion: {
  *     question: 'Tell me about this topic',
  *     answerType: AnswerTypeEnum.GENERAL
@@ -82,6 +82,8 @@ export interface BannerVisualSettings {
 export interface PopupVisualSettings {
     /** Settings schema version */
     schemaVersion?: '1';
+    /** Scroll container mode: 'body' for page scroll, 'container' for internal scroll, 'modal' for modal dialog */
+    scroll?: 'body' | 'container' | 'modal';
     /** Custom UI styling and behavior options */
     customization?: ChatCustomization;
     /** Optional question to ask automatically when popup opens */
@@ -92,6 +94,28 @@ export interface PopupVisualSettings {
         answerType?: AnswerTypeEnum;
     };
 }
+export interface EverywhereVisualSettings {
+    /** Settings schema version */
+    schemaVersion?: '1';
+    /** Custom UI styling and behavior options */
+    customization?: ChatCustomization;
+    /** Callback invoked when the widget requests to be closed */
+    onRequestClose?: () => void;
+    /** Callback invoked when the user clicks the expand button */
+    onExpand?: () => void;
+    /** Whether the host has expanded the widget; drives the expand/collapse icon in the header */
+    isExpanded?: boolean;
+    /** 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;
+    };
+}
+export declare const everywhereVisualSettingsSchema: ValidatorSchema;
 export declare const pageVisualSettingsSchema: ValidatorSchema;
 export declare const bannerVisualSettingsSchema: ValidatorSchema;
 export declare const popupVisualSettingsSchema: ValidatorSchema;

package/src/lib/shared/chat-customizations-types.d.ts

@@ -11,8 +11,7 @@ import { AnswerTypeEnum } from '../types';
  * const customization: ChatCustomization = {
  *   theme: {
  *     translucent: true
- *   },
- *   scroll: 'container'
+ *   }
  * };
  * ```
  *
@@ -20,10 +19,6 @@ import { AnswerTypeEnum } from '../types';
  * Advanced customization with initial page:
  * ```typescript
  * const customization: ChatCustomization = {
- *   context: {
- *     type: 'entry',
- *     entryId: 'video_123'
- *   },
  *   initialPage: {
  *     type: 'banner',
  *     title: 'Welcome to AI Chat',
@@ -40,13 +35,6 @@ import { AnswerTypeEnum } from '../types';
  * ```
  */
 export interface ChatCustomization {
-    /** Context for the chat session (e.g., specific media entry) */
-    context?: {
-        /** Context type - currently only 'entry' is supported */
-        type: 'entry';
-        /** Media entry ID for context-aware conversations */
-        entryId: string;
-    };
     /** Visual theme customization */
     theme?: {
         /** Enable translucent/semi-transparent UI elements */
@@ -68,8 +56,6 @@ export interface ChatCustomization {
     initialPreferredTool?: string;
     /** Branding options (logo display, etc.) */
     branding?: ChatBranding;
-    /** Scroll container mode: 'body' for page scroll, 'container' for internal scroll, 'modal' for modal dialog */
-    scroll?: 'body' | 'container' | 'modal';
     /** Initial landing page configuration */
     initialPage?: {
         /** Page layout type: 'default' for standard, 'banner' for hero-style */

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

@@ -1,2 +0,0 @@
-/** Runtime name constant for chat experiences */
-export declare const ChatRuntimeName: "chat";