@unisphere/genie-types 1.9.0 → 1.11.0

package/index.esm.js

@@ -23,6 +23,7 @@ const integrationsSchema = {
           value: 'boolean'
         }
       },
+      deprecationMessage: 'Marketo integration is no longer supported and this field will be ignored if provided',
       optional: true
     },
     avatar: {
@@ -87,21 +88,25 @@ const chatRuntimeSettingsSchema = {
     },
     partnerId: {
       type: 'primitive',
-      value: 'any'
+      value: 'any',
+      optional: true
     },
-    kalturaServerURI: {
+    ks: {
       type: 'primitive',
       value: 'string'
     },
-    ks: {
+    kalturaServerURI: {
       type: 'primitive',
-      value: 'string'
+      value: 'string',
+      deprecationMessage: 'This field is no longer required and will be ignored if provided',
+      optional: true
     },
     // depracated - kept for backward compatibility
     uiconfId: {
       type: 'primitive',
       value: 'string',
-      optional: true
+      optional: true,
+      deprecationMessage: 'This field is no longer required and will be ignored if provided'
     },
     // depracated - kept for backward compatibility
     analytics: {
@@ -125,7 +130,8 @@ const chatRuntimeSettingsSchema = {
           type: 'primitive',
           value: 'string'
         }
-      }
+      },
+      deprecationMessage: 'This field is no longer required and will be ignored if provided'
     },
     customization: {
       type: 'object',
@@ -177,6 +183,16 @@ const chatRuntimeSettingsSchema = {
       type: 'primitive',
       value: 'string',
       optional: true
+    },
+    agentMode: {
+      type: 'primitive',
+      value: 'boolean',
+      optional: true
+    },
+    avatarContainerMode: {
+      type: 'enum',
+      values: ['dialog', 'contained'],
+      optional: true
     }
   }
 };
@@ -195,7 +211,8 @@ const chatRuntimePlayerPluginSettingsSchema = {
     },
     kalturaServerURI: {
       type: 'primitive',
-      value: 'string'
+      value: 'string',
+      deprecationMessage: 'This field is no longer required and will be ignored if provided'
     },
     partnerId: {
       type: 'primitive',
@@ -206,7 +223,12 @@ const chatRuntimePlayerPluginSettingsSchema = {
       value: 'string'
     },
     integrations: integrationsSchema,
-    shareUrl: shareUrlSchema
+    shareUrl: shareUrlSchema,
+    avatarContainerMode: {
+      type: 'enum',
+      values: ['dialog', 'contained'],
+      optional: true
+    }
   }
 };
 
@@ -728,31 +750,50 @@ const avatarRuntimeSettingsSchema = {
       type: 'primitive',
       value: 'string'
     },
-    serverUrl: {
+    srsBaseUrl: {
       type: 'primitive',
       value: 'string'
     },
-    srsBaseUrl: {
+    serverUrl: {
       type: 'primitive',
-      value: 'string'
+      value: 'string',
+      optional: true
     },
     clientId: {
       type: 'primitive',
-      value: 'string'
+      value: 'string',
+      optional: true
     },
     roomId: {
       type: 'primitive',
-      value: 'string'
+      value: 'string',
+      optional: true
     },
     flowId: {
       type: 'primitive',
-      value: 'string'
+      value: 'string',
+      optional: true
     },
     loadingVideoURL: {
       type: 'primitive',
       value: 'string',
       optional: true
     },
+    avatarId: {
+      type: 'primitive',
+      value: 'string',
+      optional: true
+    },
+    previewImageUrl: {
+      type: 'primitive',
+      value: 'string',
+      optional: true
+    },
+    agentMode: {
+      type: 'primitive',
+      value: 'boolean',
+      optional: true
+    },
     noiseReductionEnabled: {
       type: 'primitive',
       value: 'boolean',

package/package.json

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

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

@@ -119,6 +119,7 @@ export interface AvatarServiceType extends UnisphereService {
     }>;
     devicesList: TinyDataStoreConsumer<UserDevicesList | null>;
     agentPreviewUrl: TinyDataStoreConsumer<string | null>;
+    agentPreviewImageUrl: TinyDataStoreConsumer<string | null>;
     agentStatus: TinyDataStoreConsumer<{
         available: boolean;
         reason?: AgentUnavailabilityReasons;

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

@@ -20,6 +20,9 @@ export interface AvatarRuntimeSettings {
     roomId: string;
     flowId: string;
     loadingVideoURL?: string;
+    avatarId?: string;
+    previewImageUrl?: string;
+    agentMode?: boolean;
     noiseReductionEnabled?: boolean;
     kaltura: {
         ks: string;

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

@@ -13,8 +13,8 @@ export interface ChatRuntimePlayerPluginSettings {
     ks: string;
     partnerId: string;
     schemaVersion?: '1';
-    kalturaServerURI: string;
     integrations?: GlobalChatSettings['integrations'];
     shareUrl?: GlobalChatSettings['shareUrl'];
+    avatarContainerMode?: 'dialog' | 'contained';
 }
 export declare const chatRuntimePlayerPluginSettingsSchema: ValidatorSchema;

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

@@ -9,13 +9,14 @@ export interface ChatRuntime extends UnisphereRuntimeBaseType<ChatRuntimeSetting
     readonly flavor: '';
 }
 export interface ChatRuntimeSettings {
+    ks: string;
     initialQuestion?: string;
     schemaVersion?: '1';
     genieServerUrl?: string;
-    partnerId: string;
-    kalturaServerURI: string;
-    ks: string;
+    partnerId?: string;
     entryId?: string;
+    agentMode?: boolean;
+    avatarContainerMode?: 'dialog' | 'contained';
     getSourceUrl?: GlobalChatSettings['getSourceUrl'];
     shareUrl?: GlobalChatSettings['shareUrl'];
     branding?: {

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

@@ -1,10 +1,4 @@
 import { ValidatorSchema } from '@unisphere/core';
-export interface MarketoIntegration {
-    type: 'form';
-    quota: number;
-    formId: string;
-    blocker: boolean;
-}
 export interface ChatBranding {
     kalturaLogo?: boolean;
 }
@@ -35,11 +29,10 @@ export interface GlobalChatSettings {
             messageId: string;
         }) => string;
     };
-    initialAvatar: 'dialog' | 'contained' | null;
+    avatarContainerMode: 'dialog' | 'contained' | null;
     integrations?: {
         avatar?: AvatarIntegration;
         kaltura?: KalturaIntegration;
-        marketo?: MarketoIntegration;
     };
 }
 export declare const integrationsSchema: ValidatorSchema;

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

@@ -14,8 +14,6 @@ type ClassGenieGetClipPlayerPosterUrlData = {
 };
 export interface GenieChatServiceType extends UnisphereService {
     id: 'unisphere.widgets.genie.chat';
-    canPlayVideo?: () => Promise<boolean>;
-    canGetAnswer?: (() => Promise<boolean>) | undefined;
     getClipPlayerUrl?: (source: ClassGenieGetClipPlayerUrlData) => string | null;
     getClipPlayerPosterUrl: (source: ClassGenieGetClipPlayerPosterUrlData) => string;
     getEntrySourceUrl: (entryId: string, startTime?: number) => string;