@unisphere/genie-types 1.13.0 → 1.13.2

package/src/lib/gtc-agenda-list-tool-runtime/runtime-types.d.ts

@@ -1,12 +1,27 @@
 import { ValidatorSchema } from '@unisphere/core';
 import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
 import { widgetName } from '../widget-types';
+/** Runtime name constant for GTC agenda list tool */
 export declare const GtcAgendaListToolRuntimeName: "gtc-agenda-list-tool";
+/**
+ * GTC agenda list tool runtime for displaying multiple agenda items.
+ *
+ * Provides list view of conference sessions and events.
+ */
 export type GtcAgendaListToolRuntime = UnisphereRuntimeBaseType<GtcAgendaListToolRuntimeSettings> & {
     readonly widgetName: typeof widgetName;
     readonly runtimeName: typeof GtcAgendaListToolRuntimeName;
 };
+/**
+ * Configuration settings for the GTC agenda list tool runtime.
+ *
+ * @example
+ * ```typescript
+ * const settings: GtcAgendaListToolRuntimeSettings = {};
+ * ```
+ */
 export interface GtcAgendaListToolRuntimeSettings {
+    /** Settings schema version */
     schemaVersion?: string;
 }
 export declare const gtcAgendaListToolRuntimeSettingsSchema: ValidatorSchema;

package/src/lib/gtc-agenda-tool-runtime/genie-answer-visual-types.d.ts

@@ -1,5 +1,16 @@
 import { ValidatorSchema } from '@unisphere/core';
+/**
+ * Visual settings for GTC agenda displayed in Genie answers.
+ *
+ * @example
+ * ```typescript
+ * const visualSettings: GtcAgendaToolRuntimeGenieAnswerVisualSettings = {
+ *   id: 'session_123'
+ * };
+ * ```
+ */
 export interface GtcAgendaToolRuntimeGenieAnswerVisualSettings {
+    /** Unique identifier for the agenda session */
     id: string;
 }
 export declare const gtcAgendaToolRuntimeGenieAnswerVisualSettingsSchema: ValidatorSchema;

package/src/lib/gtc-agenda-tool-runtime/runtime-types.d.ts

@@ -1,12 +1,27 @@
 import { ValidatorSchema } from '@unisphere/core';
 import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
 import { widgetName } from '../widget-types';
+/** Runtime name constant for GTC agenda tool */
 export declare const GtcAgendaToolRuntimeName: "gtc-agenda-tool";
+/**
+ * GTC (GPU Technology Conference) agenda tool runtime.
+ *
+ * Provides conference agenda and schedule functionality.
+ */
 export type GtcAgendaToolRuntime = UnisphereRuntimeBaseType<GtcAgendaToolRuntimeSettings> & {
     readonly widgetName: typeof widgetName;
     readonly runtimeName: typeof GtcAgendaToolRuntimeName;
 };
+/**
+ * Configuration settings for the GTC agenda tool runtime.
+ *
+ * @example
+ * ```typescript
+ * const settings: GtcAgendaToolRuntimeSettings = {};
+ * ```
+ */
 export interface GtcAgendaToolRuntimeSettings {
+    /** Settings schema version */
     schemaVersion?: string;
 }
 export declare const gtcAgendaToolRuntimeSettingsSchema: ValidatorSchema;

package/src/lib/kaltura-video-player-tool-runtime/genie-answer-visual-types.d.ts

@@ -1,5 +1,16 @@
 import { ValidatorSchema } from '@unisphere/core';
+/**
+ * Visual settings for Kaltura video player displayed in Genie answers.
+ *
+ * @example
+ * ```typescript
+ * const visualSettings: KalturaVideoPlayerToolRuntimeGenieAnswerVisualSettings = {
+ *   id: 'player_123'
+ * };
+ * ```
+ */
 export interface KalturaVideoPlayerToolRuntimeGenieAnswerVisualSettings {
+    /** Unique identifier for the player instance */
     id: string;
 }
 export declare const kalturaVideoPlayerToolRuntimeGenieAnswerVisualSettingsSchema: ValidatorSchema;

package/src/lib/kaltura-video-player-tool-runtime/runtime-types.d.ts

@@ -1,15 +1,38 @@
 import { ValidatorSchema } from '@unisphere/core';
 import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
 import { widgetName } from '../widget-types';
+/** Runtime name constant for Kaltura video player tool */
 export declare const KalturaVideoPlayerToolRuntimeName: "kaltura-video-player-tool";
+/**
+ * Kaltura video player tool runtime for embedded media playback.
+ *
+ * Provides Kaltura player integration within Genie experiences.
+ */
 export type KalturaVideoPlayerToolRuntime = UnisphereRuntimeBaseType<KalturaVideoPlayerToolRuntimeSettings> & {
     readonly widgetName: typeof widgetName;
     readonly runtimeName: typeof KalturaVideoPlayerToolRuntimeName;
 };
+/**
+ * Configuration settings for the Kaltura video player tool runtime.
+ *
+ * @example
+ * ```typescript
+ * const settings: KalturaVideoPlayerToolRuntimeSettings = {
+ *   kalturaServerURI: 'https://www.kaltura.com',
+ *   partnerId: '12345',
+ *   uiConfId: '54321',
+ *   ks: 'your-kaltura-session-token'
+ * };
+ * ```
+ */
 export interface KalturaVideoPlayerToolRuntimeSettings {
+    /** Kaltura server URI */
     kalturaServerURI: string;
+    /** Kaltura partner ID */
     partnerId: string;
+    /** UI configuration ID */
     uiConfId: string;
+    /** Kaltura session token for authentication */
     ks: string;
 }
 export declare const kalturaVideoPlayerToolRuntimeSettingsSchema: ValidatorSchema;

package/src/lib/nvidia-2026-event-tool-runtime/runtime-types.d.ts

@@ -1,37 +1,82 @@
 import { ValidatorSchema } from '@unisphere/core';
 import { UnisphereRuntimeBaseType, UnisphereService } from '@unisphere/runtime';
 import { widgetName } from '../widget-types';
+/** Runtime name constant for NVIDIA 2026 event tool */
 export declare const Nvidia2026EventToolRuntimeName: "nvidia-2026-event-tool";
+/**
+ * NVIDIA 2026 event tool runtime for event session management.
+ *
+ * Provides access to event session information and schedules.
+ */
 export type Nvidia2026EventToolRuntime = UnisphereRuntimeBaseType<Nvidia2026EventToolRuntimeSettings> & {
     readonly widgetName: typeof widgetName;
     readonly runtimeName: typeof Nvidia2026EventToolRuntimeName;
 };
+/**
+ * Configuration settings for the NVIDIA 2026 event tool runtime.
+ *
+ * @example
+ * ```typescript
+ * const settings: Nvidia2026EventToolRuntimeSettings = {};
+ * ```
+ */
 export interface Nvidia2026EventToolRuntimeSettings {
+    /** Settings schema version */
     schemaVersion?: '1';
 }
 export declare const nvidia2026EventToolRuntimeSettingsSchema: ValidatorSchema;
+/**
+ * NVIDIA event session information.
+ *
+ * Contains complete details about a conference session including schedule,
+ * speakers, and content metadata.
+ */
 export interface NvidiaSession {
+    /** Unique session identifier */
     sessionId: string;
+    /** Session title */
     title: string;
+    /** Session description/abstract */
     summary: string;
+    /** Session start date/time */
     startDate: string;
+    /** Session end date/time */
     endDate: string;
+    /** Session topic category */
     topic: string;
+    /** Target industry */
     industry: string;
+    /** Technical difficulty level */
     technicalLevel: string;
+    /** Intended audience description */
     intendedAudience: string;
+    /** NVIDIA technologies covered */
     nvidiaTechnology: string;
+    /** Key learning outcomes */
     keyTakeaways: string;
+    /** Speaker names */
     speakers: string;
+    /** Presentation language */
     language: string;
+    /** Physical location */
     location: string;
+    /** Session type (e.g., keynote, workshop) */
     type: string;
+    /** Room/venue name */
     room: string;
+    /** Associated media entry ID */
     entryId: string;
 }
+/**
+ * Service interface for NVIDIA 2026 event data access.
+ */
 export interface Nvidia2026EventServiceType extends UnisphereService {
+    /** Service identifier */
     id: 'unisphere.widgets.genie.nvidia-2026-event';
+    /** Get media entry ID for a session */
     getEntryId(sessionId: string): string | null;
+    /** Get full session details by ID */
     getSession(sessionId: string): NvidiaSession | null;
+    /** Get multiple sessions by ID list */
     getSessionsList(sessionIds: string[]): NvidiaSession[];
 }

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

@@ -1,36 +1,116 @@
 import { ValidatorSchema } from '@unisphere/core';
 import { ChatBranding } from '../chat-runtime';
 import { AnswerTypeEnum } from '../types';
+/**
+ * Chat UI customization options.
+ *
+ * @example
+ * Basic customization:
+ * ```typescript
+ * const customization: ChatCustomization = {
+ *   theme: {
+ *     translucent: true
+ *   },
+ *   scroll: 'container'
+ * };
+ * ```
+ *
+ * @example
+ * Advanced customization with initial page:
+ * ```typescript
+ * const customization: ChatCustomization = {
+ *   context: {
+ *     type: 'entry',
+ *     entryId: 'video_123'
+ *   },
+ *   initialPage: {
+ *     type: 'banner',
+ *     title: 'Welcome to AI Chat',
+ *     initialQuestions: [
+ *       { text: 'What is this about?', answerType: AnswerTypeEnum.GENERAL },
+ *       { text: 'Summarize this video' }
+ *     ],
+ *     background: {
+ *       type: 'url',
+ *       url: 'https://example.com/bg.jpg'
+ *     }
+ *   }
+ * };
+ * ```
+ */
 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 */
         translucent?: boolean;
     };
+    /** General behavior settings */
     general?: {
+        /** Use external player for media playback instead of embedded */
         useExternalPlayer?: boolean;
     };
+    /** New conversation thread settings */
     newThread?: {
+        /** Show/hide the new thread button */
         buttonVisible?: boolean;
     };
+    /** Default tool to select when chat starts */
     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 */
         type?: 'default' | 'banner';
+        /** Page title text */
         title?: string;
+        /** Suggested questions to display on landing page */
         initialQuestions?: InitialQuestion[];
+        /** Background image configuration */
         background?: Background;
     };
 }
+/**
+ * Suggested question for initial chat page.
+ *
+ * @example
+ * ```typescript
+ * const question: InitialQuestion = {
+ *   text: 'What topics are covered?',
+ *   answerType: AnswerTypeEnum.GENERAL
+ * };
+ * ```
+ */
 export type InitialQuestion = {
+    /** Question text to display */
     text: string;
+    /** Preferred answer type for this question */
     answerType?: AnswerTypeEnum;
 };
+/**
+ * Background image configuration.
+ *
+ * @example
+ * ```typescript
+ * const bg: Background = {
+ *   type: 'url',
+ *   url: 'https://example.com/image.jpg'
+ * };
+ * ```
+ */
 export type Background = {
+    /** Background type - currently only 'url' is supported */
     type: 'url';
+    /** Image URL */
     url: string;
 };
 export declare const chatCustomizationSchema: ValidatorSchema;

package/src/lib/shared/chat-tools-service-types.d.ts

@@ -2,43 +2,95 @@ import { UnisphereService } from '@unisphere/runtime';
 import { TinyPubSub } from '@unisphere/core';
 import { AnswerModel, AnswerType } from '../types';
 import { GlobalChatSettings } from '../chat-runtime';
+/**
+ * Parameters for generating clip player URLs.
+ */
 type ClassGenieGetClipPlayerUrlData = {
+    /** Media entry ID */
     entryId: string;
+    /** Clip start time in seconds */
     startTime?: number;
+    /** Clip end time in seconds */
     endTime?: number;
+    /** Initial playback position in seconds */
     playFrom?: number;
 };
+/**
+ * Parameters for generating clip poster/thumbnail URLs.
+ */
 type ClassGenieGetClipPlayerPosterUrlData = {
+    /** Media entry ID */
     entryId: string;
+    /** Thumbnail timestamp in seconds */
     startTime?: number;
 };
+/**
+ * Genie chat service interface providing chat functionality and media integration.
+ *
+ * This service enables AI chat interactions, manages conversation state,
+ * and integrates with Kaltura media players.
+ */
 export interface GenieChatServiceType extends UnisphereService {
+    /** Service identifier */
     id: 'unisphere.widgets.genie.chat';
+    /** Generate URL for video clip player with time range */
     getClipPlayerUrl?: (source: ClassGenieGetClipPlayerUrlData) => string | null;
+    /** Generate poster/thumbnail URL for video clip */
     getClipPlayerPosterUrl: (source: ClassGenieGetClipPlayerPosterUrlData) => string;
+    /** Generate source URL for media entry with optional start time */
     getEntrySourceUrl: (entryId: string, startTime?: number) => string;
+    /** Observable for submitting questions and getting AI answers */
     getAnswer: TinyPubSub<{
+        /** Question text to ask */
         question: string;
+        /** Clear chat history before answering */
         clearPreviousChat?: boolean;
+        /** Preferred answer type */
         answerType?: AnswerType;
+        /** Preferred answer model */
         answerModel?: AnswerModel;
+        /** Block ID for retry operations */
+        retryBlockId?: string;
     }>;
+    /** Observable for fetching thread messages */
+    getThreadMessages: TinyPubSub<{
+        /** Optional thread ID to fetch messages from */
+        threadId?: string;
+        /** Block ID for retry operations */
+        retryBlockId?: string;
+    }>;
+    /** Observable for stopping active answer generation */
     stopAnswer: TinyPubSub<void>;
+    /** Observable that fires when answer type changes */
     answerTypeChanged: TinyPubSub<AnswerType>;
+    /** Set the preferred answer type */
     setAnswerType(type: AnswerType): void;
+    /** Get the current answer type */
     getAnswerType(): AnswerType;
+    /** Observable that fires when answer model changes */
     answerModelChanged: TinyPubSub<AnswerModel | undefined>;
+    /** Set the preferred answer model */
     setAnswerModel(model: AnswerModel | undefined): void;
+    /** Get the current answer model */
     getAnswerModel(): AnswerModel | undefined;
+    /** Get UI configuration ID */
     getUiconfId(): string | null;
+    /** Get Kaltura player initialization parameters */
     getKalturaPlayerParams(): {
+        /** Kaltura server URI */
         kalturaServerURI: string;
+        /** Partner ID */
         partnerId: string;
+        /** UI configuration ID */
         uiConfId: string;
+        /** Kaltura session token */
         ks: string;
     };
+    /** Set reference to the container DOM element */
     setContainerRef(ref: HTMLDivElement | null): void;
+    /** Get reference to the container DOM element */
     getContainerRef(): HTMLDivElement | null;
+    /** Global chat configuration settings */
     get globalChatSettings(): GlobalChatSettings;
 }
 export {};

package/src/lib/shared/general-visual-types.d.ts

@@ -1,11 +1,30 @@
 import { ValidatorSchema } from '@unisphere/core';
 import { ChatCustomization } from './chat-customizations-types';
+/** Visual block loading and status states */
 type UnisphereToolStatuses = 'loading' | 'ready' | 'error';
+/**
+ * Context information for rendering visual blocks in chat.
+ *
+ * @example
+ * ```typescript
+ * const context: BlockVisualContext = {
+ *   threadId: 'thread-123',
+ *   messageId: 'msg-456',
+ *   status: 'ready',
+ *   groupIndex: 0
+ * };
+ * ```
+ */
 export interface BlockVisualContext {
+    /** Thread identifier for the conversation */
     threadId?: string;
+    /** Message identifier within the thread */
     messageId?: string;
+    /** Current loading/display status */
     status: UnisphereToolStatuses;
+    /** Index within a group of related blocks */
     groupIndex?: number;
+    /** Custom UI styling and behavior options */
     customization?: ChatCustomization;
 }
 export declare const blockVisualContextSchema: ValidatorSchema;

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

@@ -3,17 +3,55 @@ import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
 import { widgetName } from '../widget-types';
 import { SourcesItemType } from '../types';
 import { BlockVisualContext } from '../shared/general-visual-types';
+/** Runtime name constant for sources tool */
 export declare const SourcesToolRuntimeName: "sources-tool";
+/**
+ * Sources tool runtime interface for displaying content references.
+ *
+ * Provides visual display of source materials (videos, documents) referenced in AI answers.
+ */
 export type SourcesToolRuntime = UnisphereRuntimeBaseType<SourcesToolRuntimeSettings> & {
     readonly widgetName: typeof widgetName;
     readonly runtimeName: typeof SourcesToolRuntimeName;
 };
+/**
+ * Configuration settings for the sources tool runtime.
+ *
+ * @example
+ * ```typescript
+ * const settings: SourcesToolRuntimeSettings = {};
+ * ```
+ */
 export interface SourcesToolRuntimeSettings {
+    /** Settings schema version */
     schemaVersion?: string;
 }
 export declare const sourcesToolRuntimeSettingsSchema: ValidatorSchema;
+/**
+ * Visual settings for source citations displayed in Genie answers.
+ *
+ * @example
+ * ```typescript
+ * const visualSettings: SourcesToolRuntimeGenieAnswerVisualSettings = {
+ *   variant: 'compact',
+ *   sources: [
+ *     {
+ *       type: 'video',
+ *       title: 'Introduction to AI',
+ *       entry_id: 'video_123',
+ *       duration: 600,
+ *       has_short: true
+ *     }
+ *   ]
+ * };
+ * ```
+ */
 export type SourcesToolRuntimeGenieAnswerVisualSettings = {
+    /** Visual block context for rendering */
     blockContext?: BlockVisualContext;
+    /** Array of source items to display */
     sources?: SourcesItemType[];
+    /** Display variant: 'default' for full display, 'compact' for condensed view */
+    variant?: 'default' | 'compact';
 };
 export declare const sourcesToolRuntimeGenieAnswerVisualSettingsSchema: ValidatorSchema;

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

@@ -2,23 +2,78 @@ 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 summary tool */
 export declare const SummaryToolRuntimeName: "summary-tool";
+/**
+ * Summary tool runtime interface for content summarization.
+ *
+ * Provides AI-generated summaries and chapter breakdowns for media content.
+ */
 export type SummaryToolRuntime = UnisphereRuntimeBaseType<SummaryToolRuntimeSettings> & {
     readonly widgetName: typeof widgetName;
     readonly runtimeName: typeof SummaryToolRuntimeName;
 };
+/**
+ * Configuration settings for the summary tool runtime.
+ *
+ * @example
+ * ```typescript
+ * const settings: SummaryToolRuntimeSettings = {};
+ * ```
+ */
 export interface SummaryToolRuntimeSettings {
+    /** Settings schema version */
     schemaVersion?: string;
 }
 export declare const summaryToolRuntimeSettingsSchema: ValidatorSchema;
+/**
+ * Chapter information for content navigation.
+ *
+ * @example
+ * ```typescript
+ * const chapter: Chapter = {
+ *   start_time: '120',
+ *   title: 'Introduction to Machine Learning',
+ *   description: 'Basic concepts and definitions'
+ * };
+ * ```
+ */
 export interface Chapter {
+    /** Chapter start time in seconds (as string) */
     start_time: string;
+    /** Chapter title */
     title: string;
+    /** Optional chapter description */
     description?: string;
 }
+/**
+ * Visual settings for content summaries displayed in Genie answers.
+ *
+ * @example
+ * ```typescript
+ * const visualSettings: summaryToolRuntimeGenieAnswerVisualSettings = {
+ *   summary: 'This video covers the fundamentals of AI...',
+ *   chapters: [
+ *     {
+ *       start_time: '0',
+ *       title: 'Introduction',
+ *       description: 'Course overview'
+ *     },
+ *     {
+ *       start_time: '120',
+ *       title: 'Core Concepts',
+ *       description: 'Key terminology'
+ *     }
+ *   ]
+ * };
+ * ```
+ */
 export interface summaryToolRuntimeGenieAnswerVisualSettings {
+    /** Visual block context for rendering */
     blockContext?: BlockVisualContext;
+    /** Text summary of the content */
     summary?: string;
+    /** Array of chapter markers with timestamps */
     chapters?: Chapter[];
 }
 export declare const summaryToolRuntimeGenieAnswerVisualSettingsSchema: ValidatorSchema;