@unisphere/genie-types 1.24.1 → 1.25.0

package/index.esm.js

@@ -1238,17 +1238,29 @@ const getSourceUrlSchema = {
   type: 'function',
   optional: true
 };
+const schemaVersionSchema = {
+  type: 'literal',
+  value: '1',
+  optional: true
+};
 
 /** Runtime name constant for chat experiences */
 const ChatRuntimeName = 'chat';
+const agentModeSchema = {
+  type: 'primitive',
+  value: 'boolean',
+  optional: true
+};
+const avatarContainerModeSchema = {
+  type: 'enum',
+  values: ['dialog', 'contained'],
+  optional: true,
+  deprecationMessage: 'This field is no longer required and will be ignored if provided'
+};
 const chatRuntimeSettingsSchema = {
   type: 'object',
   properties: {
-    schemaVersion: {
-      type: 'literal',
-      value: '1',
-      optional: true
-    },
+    schemaVersion: schemaVersionSchema,
     genieServerUrl: {
       type: 'primitive',
       value: 'string',
@@ -1363,16 +1375,36 @@ const chatRuntimeSettingsSchema = {
       optional: true,
       deprecationMessage: 'Use context instead: { type: "entry", id: "your-entry-id" }'
     },
-    agentMode: {
-      type: 'primitive',
-      value: 'boolean',
-      optional: true
-    },
+    agentMode: agentModeSchema,
     // @deprecated - no longer supported
-    avatarContainerMode: {
-      type: 'enum',
-      values: ['dialog', 'contained'],
-      optional: true
+    avatarContainerMode: avatarContainerModeSchema,
+    initialThread: {
+      type: 'orByType',
+      optional: true,
+      schemas: {
+        threadId: {
+          type: 'object',
+          properties: {
+            type: {
+              type: 'literal',
+              value: 'threadId'
+            },
+            threadId: {
+              type: 'primitive',
+              value: 'string'
+            }
+          }
+        },
+        lastThreadByContext: {
+          type: 'object',
+          properties: {
+            type: {
+              type: 'literal',
+              value: 'lastThreadByContext'
+            }
+          }
+        }
+      }
     }
   }
 };
@@ -1385,11 +1417,7 @@ const chatRuntimePlayerPluginSettingsSchema = {
       value: 'string',
       optional: true
     },
-    schemaVersion: {
-      type: 'literal',
-      value: '1',
-      optional: true
-    },
+    schemaVersion: schemaVersionSchema,
     kalturaServerURI: {
       type: 'primitive',
       value: 'string',
@@ -1411,16 +1439,8 @@ const chatRuntimePlayerPluginSettingsSchema = {
     },
     integrations: integrationsSchema,
     shareUrl: shareUrlSchema,
-    agentMode: {
-      type: 'primitive',
-      value: 'boolean',
-      optional: true
-    },
-    avatarContainerMode: {
-      type: 'enum',
-      values: ['dialog', 'contained'],
-      optional: true
-    }
+    agentMode: agentModeSchema,
+    avatarContainerMode: avatarContainerModeSchema
   }
 };
 
@@ -1550,7 +1570,7 @@ const chatCustomizationSchema = {
       properties: {
         type: {
           type: 'enum',
-          values: ['default', 'banner'],
+          values: ['default', 'banner', 'chatThread'],
           optional: true
         },
         title: {
@@ -1589,25 +1609,49 @@ const chatCustomizationSchema = {
               value: 'string'
             }
           }
+        },
+        openingSystemMessage: {
+          type: 'primitive',
+          value: 'string',
+          optional: true
         }
       }
     }
   }
 };
 
-const floaterVisualSettingsSchema = {
+// ---------- Schema constants ----------
+const scrollSchema = {
+  type: 'enum',
+  values: ['body', 'container', 'modal'],
+  optional: true
+};
+const modeSchema = {
+  type: 'enum',
+  values: ['chat', 'everywhere'],
+  optional: true
+};
+const initialQuestionSchema = {
   type: 'object',
+  optional: true,
   properties: {
-    schemaVersion: {
-      type: 'literal',
-      value: '1',
-      optional: true
+    question: {
+      type: 'primitive',
+      value: 'string'
     },
-    mode: {
+    answerType: {
       type: 'enum',
-      values: ['chat', 'everywhere'],
+      values: Object.values(AnswerTypeEnum),
       optional: true
-    },
+    }
+  }
+};
+// ---------- Schemas ----------
+const floaterVisualSettingsSchema = {
+  type: 'object',
+  properties: {
+    schemaVersion: schemaVersionSchema,
+    mode: modeSchema,
     context: chatContextSchema,
     customization: chatCustomizationSchema
   }
@@ -1615,21 +1659,13 @@ const floaterVisualSettingsSchema = {
 const floaterCTAVisualSettingsSchema = {
   type: 'object',
   properties: {
-    schemaVersion: {
-      type: 'literal',
-      value: '1',
-      optional: true
-    },
+    schemaVersion: schemaVersionSchema,
     position: {
       type: 'enum',
       values: ['bottom-right', 'bottom-center', 'bottom-left'],
       optional: true
     },
-    mode: {
-      type: 'enum',
-      values: ['chat', 'everywhere'],
-      optional: true
-    },
+    mode: modeSchema,
     openByDefault: {
       type: 'primitive',
       value: 'boolean',
@@ -1657,16 +1693,8 @@ const floaterCTAVisualSettingsSchema = {
 const containedVisualSettingsSchema = {
   type: 'object',
   properties: {
-    schemaVersion: {
-      type: 'literal',
-      value: '1',
-      optional: true
-    },
-    mode: {
-      type: 'enum',
-      values: ['chat', 'everywhere'],
-      optional: true
-    },
+    schemaVersion: schemaVersionSchema,
+    mode: modeSchema,
     customization: chatCustomizationSchema,
     onRequestClose: {
       type: 'function',
@@ -1681,11 +1709,7 @@ const containedVisualSettingsSchema = {
       value: 'boolean',
       optional: true
     },
-    scroll: {
-      type: 'enum',
-      values: ['body', 'container', 'modal'],
-      optional: true
-    },
+    scroll: scrollSchema,
     context: chatContextSchema,
     closeButtonType: {
       type: 'enum',
@@ -1742,43 +1766,17 @@ const pageContextSchema = {
 const pageVisualSettingsSchema = {
   type: 'object',
   properties: {
-    schemaVersion: {
-      type: 'literal',
-      value: '1',
-      optional: true
-    },
-    scroll: {
-      type: 'enum',
-      values: ['body', 'container', 'modal'],
-      optional: true
-    },
+    schemaVersion: schemaVersionSchema,
+    scroll: scrollSchema,
     customization: chatCustomizationSchema,
     context: pageContextSchema,
-    initialQuestion: {
-      type: 'object',
-      optional: true,
-      properties: {
-        question: {
-          type: 'primitive',
-          value: 'string'
-        },
-        answerType: {
-          type: 'enum',
-          values: Object.values(AnswerTypeEnum),
-          optional: true
-        }
-      }
-    }
+    initialQuestion: initialQuestionSchema
   }
 };
 const bannerVisualSettingsSchema = {
   type: 'object',
   properties: {
-    schemaVersion: {
-      type: 'literal',
-      value: '1',
-      optional: true
-    },
+    schemaVersion: schemaVersionSchema,
     title: {
       type: 'primitive',
       value: 'string',
@@ -1825,32 +1823,10 @@ const bannerVisualSettingsSchema = {
 const popupVisualSettingsSchema = {
   type: 'object',
   properties: {
-    schemaVersion: {
-      type: 'literal',
-      value: '1',
-      optional: true
-    },
-    scroll: {
-      type: 'enum',
-      values: ['body', 'container', 'modal'],
-      optional: true
-    },
+    schemaVersion: schemaVersionSchema,
+    scroll: scrollSchema,
     customization: chatCustomizationSchema,
-    initialQuestion: {
-      type: 'object',
-      optional: true,
-      properties: {
-        question: {
-          type: 'primitive',
-          value: 'string'
-        },
-        answerType: {
-          type: 'enum',
-          values: Object.values(AnswerTypeEnum),
-          optional: true
-        }
-      }
-    }
+    initialQuestion: initialQuestionSchema
   }
 };
 
@@ -3212,4 +3188,4 @@ const blockVisualContextSchema = {
   }
 };
 
-export { AVATAR_DEFAULT_CAPABILITIES, AnswerModelEnum, AnswerTypeEnum, AvatarConnectionStatus, AvatarRuntimeName, CHAT_CONTEXT_TYPE, CHAT_CONTEXT_TYPE_GLOBAL, CHAT_DEFAULT_CAPABILITIES, ChatRuntimeName, DeviceType, DisconnectReasons, SUPPORTED_LAYOUT_TYPES, avatarRuntimeChatVisualSettingsSchema, avatarRuntimeContainedVisualSettingsSchema, avatarRuntimeFloaterVisualSettingsSchema, avatarRuntimeSettingsSchema, bannerVisualSettingsSchema, blockVisualContextSchema, chatContextSchema, chatCustomizationSchema, chatRuntimePlayerPluginSettingsSchema, chatRuntimeSettingsSchema, containedVisualSettingsSchema, floaterCTAVisualSettingsSchema, floaterVisualSettingsSchema, getAvatarDefaultCapabilities, getChatDefaultCapabilities, getResolvedRuntimeName, getResolvedWidgetName, getSourceUrlSchema, integrationsSchema, isAvatarConnectionProxyInternalType, pageVisualSettingsSchema, popupVisualSettingsSchema, shareUrlSchema, widgetName };
+export { AVATAR_DEFAULT_CAPABILITIES, AnswerModelEnum, AnswerTypeEnum, AvatarConnectionStatus, AvatarRuntimeName, CHAT_CONTEXT_TYPE, CHAT_CONTEXT_TYPE_GLOBAL, CHAT_DEFAULT_CAPABILITIES, ChatRuntimeName, DeviceType, DisconnectReasons, SUPPORTED_LAYOUT_TYPES, agentModeSchema, avatarContainerModeSchema, avatarRuntimeChatVisualSettingsSchema, avatarRuntimeContainedVisualSettingsSchema, avatarRuntimeFloaterVisualSettingsSchema, avatarRuntimeSettingsSchema, bannerVisualSettingsSchema, blockVisualContextSchema, chatContextSchema, chatCustomizationSchema, chatRuntimePlayerPluginSettingsSchema, chatRuntimeSettingsSchema, containedVisualSettingsSchema, floaterCTAVisualSettingsSchema, floaterVisualSettingsSchema, getAvatarDefaultCapabilities, getChatDefaultCapabilities, getResolvedRuntimeName, getResolvedWidgetName, getSourceUrlSchema, integrationsSchema, isAvatarConnectionProxyInternalType, pageVisualSettingsSchema, popupVisualSettingsSchema, schemaVersionSchema, shareUrlSchema, widgetName };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unisphere/genie-types",
-  "version": "1.24.1",
+  "version": "1.25.0",
   "author": "kaltura",
   "license": "AGPL-3.0",
   "repository": {

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

@@ -59,13 +59,15 @@ export interface ChatCustomization {
     /** Initial landing page configuration */
     initialPage?: {
         /** Page layout type: 'default' for standard, 'banner' for hero-style */
-        type?: 'default' | 'banner';
+        type?: 'default' | 'banner' | 'chatThread';
         /** Page title text */
         title?: string;
         /** Suggested questions to display on landing page */
         initialQuestions?: InitialQuestion[];
         /** Background image configuration */
         background?: Background;
+        /** Opening system message that will appear in the beginning of all threads */
+        openingSystemMessage?: string;
     };
     /** Layout options for the chat interface */
     layouts?: {

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

@@ -1,8 +1,7 @@
 import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
 import { ValidatorSchema } from '@unisphere/core';
 import { widgetName } from '../widget-types';
-import { ChatRuntimeName } from './runtime-types';
-import { GlobalChatSettings } from './shared-settings';
+import { ChatRuntimeName, BaseChatRuntimeSettings } from './runtime-types';
 /**
  * Chat runtime interface for player plugin integration.
  *
@@ -42,22 +41,10 @@ export interface ChatRuntimePlayerPlugin extends UnisphereRuntimeBaseType<ChatRu
  * };
  * ```
  */
-export interface ChatRuntimePlayerPluginSettings {
-    /** Context for the chat session */
-    context?: GlobalChatSettings['context'];
-    /** Kaltura session token for authentication */
-    ks?: string;
-    /** Kaltura partner ID */
-    partnerId?: string;
-    /** Settings schema version */
-    schemaVersion?: '1';
-    /** External service integrations */
-    integrations?: GlobalChatSettings['integrations'];
-    /** Configuration for conversation sharing */
-    shareUrl?: GlobalChatSettings['shareUrl'];
-    /** Enable agent mode for advanced AI capabilities */
-    agentMode?: boolean;
-    /** @deprecated Use customization.avatar.stage instead */
-    avatarContainerMode?: 'dialog' | 'contained';
+export interface ChatRuntimePlayerPluginSettings extends BaseChatRuntimeSettings {
+    /** @deprecated This field is no longer required and will be ignored if provided */
+    kalturaServerURI?: string;
+    /** @deprecated Use context instead: { type: "entry", id: "your-entry-id" } */
+    entryId?: string;
 }
 export declare const chatRuntimePlayerPluginSettingsSchema: ValidatorSchema;

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

@@ -15,6 +15,32 @@ export interface ChatRuntime extends UnisphereRuntimeBaseType<ChatRuntimeSetting
     readonly runtimeName: typeof ChatRuntimeName;
     readonly flavor: '';
 }
+/** Shared settings fields between ChatRuntimeSettings and ChatRuntimePlayerPluginSettings. */
+export interface BaseChatRuntimeSettings {
+    /** Kaltura session token for authentication */
+    ks?: string;
+    /** Kaltura partner ID */
+    partnerId?: string;
+    /** Settings schema version, defaults to '1' */
+    schemaVersion?: '1';
+    /** Context for the chat session */
+    context?: ChatContext;
+    /** Enable agent mode for advanced AI features */
+    agentMode?: boolean;
+    /** @deprecated Use customization.avatar.stage instead */
+    avatarContainerMode?: 'dialog' | 'contained';
+    /** External service integrations (Kaltura player, avatar) */
+    integrations?: GlobalChatSettings['integrations'];
+    /** Configuration for conversation sharing functionality */
+    shareUrl?: GlobalChatSettings['shareUrl'];
+}
+/** Initial thread configuration */
+export type InitialThread = {
+    type: 'threadId';
+    threadId: string;
+} | {
+    type: 'lastThreadByContext';
+};
 /**
  * Configuration settings for the chat runtime.
  *
@@ -51,36 +77,20 @@ export interface ChatRuntime extends UnisphereRuntimeBaseType<ChatRuntimeSetting
  * };
  * ```
  */
-export interface ChatRuntimeSettings {
-    /** Kaltura session token for authentication */
-    ks?: string;
+export interface ChatRuntimeSettings extends BaseChatRuntimeSettings {
     /** Optional initial question to display when chat starts */
     initialQuestion?: string;
-    /** Settings schema version, defaults to '1' */
-    schemaVersion?: '1';
     /** Genie server URL for API requests */
     genieServerUrl?: string;
     /** Agentic server URL for appInit */
     agenticServerUrl?: string;
-    /** Kaltura partner ID */
-    partnerId?: string;
-    /** Context for the chat session */
-    context?: ChatContext;
-    /** Enable agent mode for advanced AI features */
-    agentMode?: boolean;
     /** Callback function to generate source URLs with entry ID and optional start time */
     getSourceUrl?: GlobalChatSettings['getSourceUrl'];
-    /** Configuration for conversation sharing functionality */
-    shareUrl?: GlobalChatSettings['shareUrl'];
     /** @deprecated Use visual settings or customization settings instead */
     branding?: {
         /** Display Kaltura logo in the chat interface */
         kalturaLogo?: boolean;
     };
-    /** External service integrations (Kaltura player, avatar) */
-    integrations?: GlobalChatSettings['integrations'];
-    /** @deprecated Use customization.avatar.stage instead */
-    avatarContainerMode?: 'dialog' | 'contained';
     /** UI customization options */
     customization?: {
         /** Breadcrumb navigation configuration */
@@ -94,5 +104,8 @@ export interface ChatRuntimeSettings {
             };
         };
     };
+    initialThread?: InitialThread;
 }
+export declare const agentModeSchema: ValidatorSchema;
+export declare const avatarContainerModeSchema: ValidatorSchema;
 export declare const chatRuntimeSettingsSchema: ValidatorSchema;

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

@@ -125,6 +125,8 @@ export interface KalturaIntegration {
 export interface GlobalChatSettings {
     /** Kaltura session token for authentication */
     ks: string;
+    /** Server url for genie services */
+    serverUrl: string;
     /** Context for the chat session */
     context?: ChatContext;
     /** Whether running in everywhere mode */
@@ -163,3 +165,4 @@ export declare const chatContextSchema: ValidatorSchema;
 export declare const integrationsSchema: ValidatorSchema;
 export declare const shareUrlSchema: ValidatorSchema;
 export declare const getSourceUrlSchema: ValidatorSchema;
+export declare const schemaVersionSchema: ValidatorSchema;

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

@@ -2,6 +2,39 @@ import { ValidatorSchema } from '@unisphere/core';
 import { ChatCustomization } from '../chat-customizations-types';
 import { ChatContext } from './shared-settings';
 import { AnswerTypeEnum } from '../types';
+interface BaseVisualSettings {
+    /** Settings schema version */
+    schemaVersion?: '1';
+}
+/**
+ * Visual settings with scroll and customization support.
+ * Base for page, popup, and contained layouts.
+ */
+interface ScrollableVisualSettings extends BaseVisualSettings {
+    /** 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;
+}
+/**
+ * Visual settings with mode and context support.
+ * Base for floater, floaterCTA, and contained layouts.
+ */
+interface ModeContextVisualSettings extends BaseVisualSettings {
+    /** Chat mode: 'chat' for chat-only, 'everywhere' for all pages */
+    mode?: 'chat' | 'everywhere';
+    /** Context for the chat session */
+    context?: ChatContext;
+    /** Custom UI styling and behavior options */
+    customization?: ChatCustomization;
+}
+/** Initial question shape shared between popup and page visual settings. */
+type InitialQuestion = {
+    /** Question text */
+    question: string;
+    /** Preferred answer type */
+    answerType?: AnswerTypeEnum;
+};
 /**
  * Visual settings for page-embedded chat experiences.
  *
@@ -15,13 +48,7 @@ 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;
+export interface PageVisualSettings extends ScrollableVisualSettings {
     /** Context for the chat session — host-provided, not user-controllable */
     context?: Pick<ChatContext, 'type' | 'id'>;
 }
@@ -46,9 +73,7 @@ export interface PageVisualSettings {
  * };
  * ```
  */
-export interface BannerVisualSettings {
-    /** Settings schema version */
-    schemaVersion?: '1';
+export interface BannerVisualSettings extends BaseVisualSettings {
     /** Banner title text */
     title?: string;
     /** Background image configuration */
@@ -82,62 +107,32 @@ 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;
+export interface PopupVisualSettings extends ScrollableVisualSettings {
     /** Optional question to ask automatically when popup opens */
-    initialQuestion?: {
-        /** Question text */
-        question: string;
-        /** Preferred answer type */
-        answerType?: AnswerTypeEnum;
-    };
+    initialQuestion?: InitialQuestion;
 }
-export interface ContainedVisualSettings {
-    /** Settings schema version */
-    schemaVersion?: '1';
-    /** Contained type */
-    mode?: 'chat' | 'everywhere';
-    /** Custom UI styling and behavior options */
-    customization?: ChatCustomization;
+export interface ContainedVisualSettings extends ScrollableVisualSettings, ModeContextVisualSettings {
     /** 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?: ChatContext;
     /** Type of close button to display in the header */
     closeButtonType?: 'none' | 'drawer' | 'close';
 }
-export type FloaterCTAVisualSettings = {
-    schemaVersion?: '1';
+export interface FloaterCTAVisualSettings extends ModeContextVisualSettings {
     position?: 'bottom-right' | 'bottom-center' | 'bottom-left';
-    mode?: 'chat' | 'everywhere';
     openByDefault?: boolean;
-    context?: ChatContext;
-    customization?: ChatCustomization;
-} & {
     type?: 'button';
     text?: string;
     showIcon?: boolean;
-};
-export interface FloaterVisualSettings {
-    schemaVersion?: '1';
-    mode?: 'chat' | 'everywhere';
-    context?: ChatContext;
-    customization?: ChatCustomization;
 }
+export type FloaterVisualSettings = ModeContextVisualSettings;
 export declare const floaterVisualSettingsSchema: ValidatorSchema;
 export declare const floaterCTAVisualSettingsSchema: ValidatorSchema;
 export declare const containedVisualSettingsSchema: ValidatorSchema;
 export declare const pageVisualSettingsSchema: ValidatorSchema;
 export declare const bannerVisualSettingsSchema: ValidatorSchema;
 export declare const popupVisualSettingsSchema: ValidatorSchema;
+export {};