@unisphere/genie-types 1.20.0 → 1.22.0-tools.0

package/package.json

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

package/src/index.d.ts

@@ -1,19 +1,12 @@
 export * from './lib/widget-types';
 export * from './lib/chat-runtime';
-export * from './lib/flashcards-tool-runtime';
-export * from './lib/followups-tool-runtime';
-export * from './lib/sources-tool-runtime';
 export * from './lib/shared';
 export * from './lib/types';
 export * from './lib/avatar-runtime';
 export * from './lib/admin-runtime';
 export * from './lib/admin-demo-runtime';
 export * from './lib/application-runtime';
-export * from './lib/summary-tool-runtime';
-export * from './lib/nvidia-2026-event-tool-runtime';
 export * from './lib/kaltura-video-player-tool-runtime';
-export * from './lib/gtc-agenda-tool-runtime';
-export * from './lib/gtc-agenda-list-tool-runtime';
-export * from './lib/gen-ui-composer-tool-runtime';
-export * from './lib/gen-ui-components-tool-runtime';
 export * from './lib/content-gallery-tool-runtime';
+export * from './lib/chat-customizations-types';
+export * from './lib/general-visual-types';

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/{shared/chat-customizations-types.d.ts → chat-customizations-types.d.ts}

@@ -1,6 +1,6 @@
 import { ValidatorSchema } from '@unisphere/core';
-import { ChatBranding } from '../chat-runtime';
-import { AnswerTypeEnum } from '../types';
+import { ChatBranding } from './chat-runtime';
+import { AnswerTypeEnum } from './types';
 /**
  * Chat UI customization options.
  *

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 { ChatCustomization } from '../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;

package/src/lib/content-gallery-tool-runtime/genie-answer-visual-types.d.ts

@@ -1,5 +1,5 @@
 import { ValidatorSchema } from '@unisphere/core';
-import { BlockVisualContext } from '../shared/general-visual-types';
+import { BlockVisualContext } from '../general-visual-types';
 import { Slide } from './shared-visual-types';
 export interface ContentGalleryToolRuntimeGenieAnswerVisualSettings {
     schemaVersion?: string;

package/src/lib/shared/index.d.ts

@@ -1,3 +1 @@
 export * from './chat-tools-service-types';
-export * from './general-visual-types';
-export * from './chat-customizations-types';

package/src/lib/types.d.ts

@@ -1,4 +1,3 @@
-import { BlockVisualContext } from './shared/general-visual-types';
 type SourceItemBaseType = {
     entry_id: string;
     title: string;
@@ -33,58 +32,6 @@ export type SourcesItemType = VideoSourceItemType | DocumentSourceItemType | Web
  * Status values for Unisphere tools.
  */
 export type UnisphereToolStatuses = 'loading' | 'ready' | 'error';
-/**
- * Content data structure for responses.
- */
-export type ContentDataType = {
-    /** Block visual context */
-    blockContext?: BlockVisualContext;
-    /** Content title */
-    title?: string;
-    /** Content summary */
-    summary?: string;
-    /** Follow-up questions */
-    followups?: string[];
-    /** Key points with citations */
-    keypoints?: CardsDataType[];
-};
-/**
- * Video clip data with timestamps and metadata.
- */
-export type CardsVideoDataType = {
-    /** End time in seconds */
-    end_time?: number;
-    /** Kaltura entry ID */
-    entry_id?: string;
-    /** Source type */
-    type?: 'CAPTION' | 'OCR' | 'DOCUMENT' | 'EXTERNAL';
-    /** Last index */
-    last_index?: number;
-    /** Start index */
-    start_index?: number;
-    /** Start time in seconds */
-    start_time?: number;
-    /** Thumbnail URL */
-    thumbnail?: string;
-    /** Video link */
-    video_link?: string;
-    /** Clip title */
-    title?: string;
-};
-/**
- * Card data with title, summary, and citations.
- */
-export type CardsDataType = {
-    /** Card title */
-    title?: string;
-    /** Card summary */
-    summary?: string;
-    /** Citation information */
-    citation?: {
-        /** Video clips */
-        clips?: CardsVideoDataType[];
-    };
-};
 /**
  * Answer type options for Genie responses.
  */

package/src/lib/flashcards-tool-runtime/index.d.ts

@@ -1,2 +0,0 @@
-export * from './runtime-types';
-export * from './visuals-types';

package/src/lib/flashcards-tool-runtime/runtime-types.d.ts

@@ -1,41 +0,0 @@
-import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
-import { ValidatorSchema } from '@unisphere/core';
-import { widgetName } from '../widget-types';
-import { ChatCustomization } from '../shared/chat-customizations-types';
-/** Runtime name constant for flashcards tool */
-export declare const FlashcardsToolRuntimeName: "flashcards-tool";
-/**
- * Flashcards tool runtime interface for educational study aids.
- *
- * Provides interactive flashcard experiences for learning and knowledge reinforcement.
- */
-export interface FlashcardsToolRuntime extends UnisphereRuntimeBaseType<FlashcardsToolRuntimeSettings> {
-    readonly widgetName: typeof widgetName;
-    readonly runtimeName: typeof FlashcardsToolRuntimeName;
-}
-/**
- * Configuration settings for the flashcards tool runtime.
- *
- * @example
- * Basic flashcards setup:
- * ```typescript
- * const settings: FlashcardsToolRuntimeSettings = {};
- * ```
- *
- * @example
- * With custom UI styling:
- * ```typescript
- * const settings: FlashcardsToolRuntimeSettings = {
- *   customization: {
- *     // Custom chat UI settings
- *   }
- * };
- * ```
- */
-export interface FlashcardsToolRuntimeSettings {
-    /** Settings schema version, defaults to '1' */
-    schemaVersion?: '1';
-    /** Custom UI styling and behavior options */
-    customization?: ChatCustomization;
-}
-export declare const flashcardsToolRuntimeSettingsSchema: ValidatorSchema;

package/src/lib/flashcards-tool-runtime/visuals-types.d.ts

@@ -1,52 +0,0 @@
-import { ValidatorSchema } from '@unisphere/core';
-import { CardsVideoDataType } from '../types';
-import { BlockVisualContext } from '../shared/general-visual-types';
-/**
- * Visual settings for flashcard Genie answer display.
- *
- * Configures how flashcard answers are rendered, including title, summary,
- * and key points with video citations.
- *
- * @example
- * ```typescript
- * const visualSettings: GenieAnswerVisualSettings = {
- *   title: 'Key Concepts',
- *   summary: 'Main ideas from the lesson',
- *   keypoints: [
- *     {
- *       title: 'Introduction',
- *       summary: 'Overview of the topic',
- *       citation: {
- *         clips: [{
- *           entry_id: 'video_123',
- *           start_time: 10,
- *           end_time: 30,
- *           thumbnail: 'https://example.com/thumb.jpg'
- *         }]
- *       }
- *     }
- *   ]
- * };
- * ```
- */
-export interface GenieAnswerVisualSettings {
-    /** Visual block context for rendering */
-    blockContext?: BlockVisualContext;
-    /** Title for the answer display */
-    title?: string;
-    /** Summary text for the answer */
-    summary?: string;
-    /** Array of key points with optional video citations */
-    keypoints?: {
-        /** Title of the key point */
-        title?: string;
-        /** Summary text for the key point */
-        summary?: string;
-        /** Video citations supporting this key point */
-        citation?: {
-            /** Array of video clip references */
-            clips?: CardsVideoDataType[];
-        };
-    }[];
-}
-export declare const genieAnswerVisualSettingsSchema: ValidatorSchema;

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

@@ -1,27 +0,0 @@
-import { ValidatorSchema } from '@unisphere/core';
-import { BlockVisualContext } from '../shared';
-/**
- * Visual settings for follow-up questions in avatar mode.
- *
- * @example
- * ```typescript
- * const visualSettings: FollowupsToolRuntimeAvatarVisualSettings = {
- *   questions: [
- *     'Can you explain more?',
- *     'What are the next steps?'
- *   ],
- *   onAction: (data) => console.log('Action triggered:', data)
- * };
- * ```
- */
-export interface FollowupsToolRuntimeAvatarVisualSettings {
-    /** Settings schema version */
-    schemaVersion?: string;
-    /** Visual block context for rendering */
-    blockContext?: BlockVisualContext;
-    /** Array of suggested follow-up questions */
-    questions?: string[];
-    /** Callback function triggered when user selects a question */
-    onAction: (data: any) => void;
-}
-export declare const followupsToolRuntimeAvatarVisualSettingsSchema: ValidatorSchema;

package/src/lib/followups-tool-runtime/index.d.ts

@@ -1,2 +0,0 @@
-export * from './runtime-types';
-export * from './avatar-visual-types';

package/src/lib/followups-tool-runtime/runtime-types.d.ts

@@ -1,49 +0,0 @@
-import { ValidatorSchema } from '@unisphere/core';
-import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
-import { widgetName } from '../widget-types';
-import { BlockVisualContext } from '../shared/general-visual-types';
-/** Runtime name constant for followups tool */
-export declare const FollowupsToolRuntimeName: "followups-tool";
-/**
- * Followups tool runtime interface for suggested conversation continuations.
- *
- * Provides AI-generated follow-up questions to guide users deeper into topics.
- */
-export type FollowupsToolRuntime = UnisphereRuntimeBaseType<FollowupsToolRuntimeSettings> & {
-    readonly widgetName: typeof widgetName;
-    readonly runtimeName: typeof FollowupsToolRuntimeName;
-};
-/**
- * Configuration settings for the followups tool runtime.
- *
- * @example
- * ```typescript
- * const settings: FollowupsToolRuntimeSettings = {};
- * ```
- */
-export interface FollowupsToolRuntimeSettings {
-    /** Settings schema version */
-    schemaVersion?: string;
-}
-export declare const followupsToolRuntimeSettingsSchema: ValidatorSchema;
-/**
- * Visual settings for followup questions displayed in Genie answers.
- *
- * @example
- * ```typescript
- * const visualSettings: FollowupsToolRuntimeGenieAnswerVisualSettings = {
- *   questions: [
- *     'Tell me more about this topic',
- *     'What are some related concepts?',
- *     'Can you provide an example?'
- *   ]
- * };
- * ```
- */
-export interface FollowupsToolRuntimeGenieAnswerVisualSettings {
-    /** Visual block context for rendering */
-    blockContext?: BlockVisualContext;
-    /** Array of suggested follow-up questions */
-    questions?: string[];
-}
-export declare const followupsToolRuntimeGenieAnswerVisualSettingsSchema: ValidatorSchema;

package/src/lib/gen-ui-components-tool-runtime/card-visual-types.d.ts

@@ -1,39 +0,0 @@
-/// <reference types="react" />
-import { ValidatorSchema } from '@unisphere/core';
-export interface CardAction {
-    label: string;
-    icon?: React.ReactNode;
-    onClick: React.MouseEventHandler<HTMLButtonElement>;
-}
-export type CardMedia = {
-    type: 'image';
-    src: string;
-    alt: string;
-    placement?: 'left' | 'right';
-} | {
-    type: 'video';
-    src: string;
-    placement?: 'left' | 'right';
-    startTime?: number;
-    endTime?: number;
-} | {
-    type: 'kaltura';
-    entryId: string;
-    kalturaServerURI?: string;
-    partnerId?: string;
-    uiConfId?: string;
-    ks?: string;
-    placement?: 'left' | 'right';
-    startTime?: number;
-    endTime?: number;
-};
-export interface GenUiComponentsToolRuntimeCardVisualSettings {
-    schemaVersion?: string;
-    title?: string;
-    body?: string;
-    action?: CardAction;
-    media?: CardMedia;
-    loading?: boolean;
-    isTranslucent?: boolean;
-}
-export declare const genUiComponentsToolRuntimeCardVisualSettingsSchema: ValidatorSchema;

package/src/lib/gen-ui-components-tool-runtime/index.d.ts

@@ -1,6 +0,0 @@
-export * from './runtime-types';
-export * from './card-visual-types';
-export * from './markdown-visual-types';
-export * from './player-visual-types';
-export * from './login-visual-types';
-export * from './questions-presets-visual-types';

package/src/lib/gen-ui-components-tool-runtime/login-visual-types.d.ts

@@ -1,10 +0,0 @@
-import { ValidatorSchema } from '@unisphere/core';
-export interface GenUiComponentsToolRuntimeLoginVisualSettings {
-    schemaVersion?: string;
-    title?: string;
-    subtitle?: string;
-    isTranslucent?: boolean;
-    onLogin?: (username: string) => void;
-    onCancel?: () => void;
-}
-export declare const genUiComponentsToolRuntimeLoginVisualSettingsSchema: ValidatorSchema;

package/src/lib/gen-ui-components-tool-runtime/markdown-visual-types.d.ts

@@ -1,7 +0,0 @@
-import { ValidatorSchema } from '@unisphere/core';
-export interface GenUiComponentsToolRuntimeMarkdownVisualSettings {
-    schemaVersion?: string;
-    content: string;
-    isTranslucent?: boolean;
-}
-export declare const genUiComponentsToolRuntimeMarkdownVisualSettingsSchema: ValidatorSchema;

package/src/lib/gen-ui-components-tool-runtime/player-visual-types.d.ts

@@ -1,25 +0,0 @@
-import { ValidatorSchema } from '@unisphere/core';
-export type PlayerSource = {
-    type: 'native';
-    src: string;
-    poster?: string;
-    startTime?: number;
-    endTime?: number;
-} | {
-    type: 'kaltura';
-    entryId: string;
-    kalturaServerURI?: string;
-    partnerId?: string;
-    uiConfId?: string;
-    ks?: string;
-    startTime?: number;
-    endTime?: number;
-};
-export interface GenUiComponentsToolRuntimePlayerVisualSettings {
-    schemaVersion?: string;
-    source: PlayerSource;
-    title?: string;
-    loading?: boolean;
-    isTranslucent?: boolean;
-}
-export declare const genUiComponentsToolRuntimePlayerVisualSettingsSchema: ValidatorSchema;

package/src/lib/gen-ui-components-tool-runtime/questions-presets-visual-types.d.ts

@@ -1,9 +0,0 @@
-import { ValidatorSchema } from '@unisphere/core';
-export interface GenUiComponentsToolRuntimeQuestionsPresetsVisualSettings {
-    schemaVersion?: string;
-    questions?: string[];
-    isTranslucent?: boolean;
-    /** Injected at render time by the runtime — not provided by the LLM. */
-    onSelect?: (question: string) => void;
-}
-export declare const genUiComponentsToolRuntimeQuestionsPresetsVisualSettingsSchema: ValidatorSchema;

package/src/lib/gen-ui-components-tool-runtime/runtime-types.d.ts

@@ -1,13 +0,0 @@
-import { ValidatorSchema } from '@unisphere/core';
-import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
-import { widgetName } from '../widget-types';
-export declare const GenUiComponentsToolRuntimeName: "gen-ui-components-tool";
-export type GenUiComponentsToolRuntime = UnisphereRuntimeBaseType<GenUiComponentsToolRuntimeSettings> & {
-    readonly widgetName: typeof widgetName;
-    readonly runtimeName: typeof GenUiComponentsToolRuntimeName;
-};
-export interface GenUiComponentsToolRuntimeSettings {
-    schemaVersion?: string;
-    baseVisualSettings?: Record<string, unknown>;
-}
-export declare const genUiComponentsToolRuntimeSettingsSchema: ValidatorSchema;