@kaltura-sdk/avatars 1.16.2 → 1.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaltura-sdk/avatars",
-  "version": "1.16.2",
+  "version": "1.17.0",
   "author": "kaltura",
   "license": "AGPL-3.0",
   "repository": {
@@ -9,14 +9,14 @@
   },
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@kaltura-sdk/rtc-avatar": "^1.33.1",
-    "@kaltura-sdk/rtc-core": "^1.26.1",
+    "@kaltura-sdk/rtc-avatar": "^1.33.4",
+    "@kaltura-sdk/rtc-core": "^1.26.2",
     "@local/genie-shared-utils": "^1.0.0",
     "@unisphere/core": "^1.99.0",
-    "@unisphere/genie-types": "^1.39.6",
+    "@unisphere/genie-types": "^1.42.0",
     "@unisphere/notifications-core": "^1.25.0",
     "@unisphere/runtime": "^1.98.0",
-    "@unisphere/runtime-js": "^1.96.0",
+    "@unisphere/runtime-js": "^1.98.0",
     "immer": "^10.1.1",
     "js-yaml": "^4.1.0",
     "socket.io-client": "^4.8.1",

package/src/lib/avatar-client-manager/avatar-client-manager.d.ts

@@ -1,6 +1,6 @@
 import { UnisphereLoggerType } from '@unisphere/core';
 import { KalturaAnalyticsServiceType, PubSubServiceType } from '@unisphere/runtime';
-import { AgentData, AgentKalturaContextData, AgentScreenShareInfo, AgentTapToTalkInfo, AvatarClientManagerType, AvatarConnectionProxInternalType, AvatarConnectionProxyType, AvatarConnectionStatus, AvatarContentData, AvatarRuntimeSettings, CaptionConfig, Captions, ChatEntry, ClientToolCallLogEntry, DisconnectReasons } from '@unisphere/genie-types';
+import { AgentData, AgentKalturaContextData, AgentProgressBar, AgentScreenShareInfo, AgentTapToTalkInfo, AvatarClientManagerType, AvatarConnectionProxInternalType, AvatarConnectionProxyType, AvatarConnectionStatus, AvatarContentData, AvatarRuntimeSettings, CaptionConfig, Captions, ChatEntry, ClientToolCallLogEntry, DisconnectReasons } from '@unisphere/genie-types';
 import { type AvatarClientToolsInput, type AvatarConnectionActor } from './machines/avatar-connection';
 import { AvatarClientManagerActions } from './types';
 import { DeviceType } from '@kaltura-sdk/rtc-core';
@@ -39,6 +39,7 @@ export declare class AvatarClientManager extends ActorManager<AvatarConnectionAc
     private readonly _chatLog;
     private readonly _clientToolCallLog;
     private readonly _screenShareInfo;
+    private readonly _progressBar;
     private readonly _tapToTalkInfo;
     private readonly _captions;
     private readonly _kalturaContext;
@@ -122,6 +123,7 @@ export declare class AvatarClientManager extends ActorManager<AvatarConnectionAc
     sendAgentTurnRecoveryRequest(speechId: string, messageId: string): void;
     clearContent(): void;
     setLocalContent(content: AvatarContentData): void;
+    get progressBar(): import("@unisphere/core").TinyDataStoreConsumer<AgentProgressBar | null>;
     get screenShareInfo(): import("@unisphere/core").TinyDataStoreConsumer<AgentScreenShareInfo | null>;
     startScreenShare(): void;
     stopScreenShare(): void;
@@ -155,6 +157,7 @@ export declare class AvatarClientManager extends ActorManager<AvatarConnectionAc
         captions?: boolean | CaptionConfig | undefined;
         kickOffPhrase?: string | undefined;
         dynamicVariables?: Record<string, unknown> | undefined;
+        persistentContent?: boolean | undefined;
     } | undefined>;
     get agentPreviewUrl(): import("@unisphere/core").TinyDataStoreConsumer<string | null>;
     get agentPreviewImageUrl(): import("@unisphere/core").TinyDataStoreConsumer<string | null>;

package/src/lib/avatar-client-manager/machines/avatar-connection/actions/context/set-progress-bar-data.d.ts

@@ -0,0 +1,2 @@
+import { AvatarConnectionMachineAction } from '../../types';
+export declare const setProgressBarData: AvatarConnectionMachineAction;

package/src/lib/avatar-client-manager/machines/avatar-connection/actions/context/track-pushed-progress-bar.d.ts

@@ -0,0 +1,2 @@
+import { AvatarConnectionMachineAction } from '../../types';
+export declare const trackPushedProgressBar: AvatarConnectionMachineAction;

package/src/lib/avatar-client-manager/machines/avatar-connection/actions/context/track-pushed-stage-content.d.ts

@@ -0,0 +1,2 @@
+import { AvatarConnectionMachineAction } from '../../types';
+export declare const trackPushedStageContent: AvatarConnectionMachineAction;

package/src/lib/avatar-client-manager/machines/avatar-connection/avatar-connection-machine.d.ts

@@ -347,6 +347,15 @@ export declare const avatarConnectionMachine: import("xstate").StateMachine<Avat
 } | {
     type: "setContentData";
     params: unknown;
+} | {
+    type: "setProgressBarData";
+    params: unknown;
+} | {
+    type: "trackPushedStageContent";
+    params: unknown;
+} | {
+    type: "trackPushedProgressBar";
+    params: unknown;
 } | {
     type: "sendAskViaText";
     params: {
@@ -544,6 +553,9 @@ export declare const avatarConnectionMachine: import("xstate").StateMachine<Avat
 } | {
     type: "hadAvatarTypeInTurn";
     params: unknown;
+} | {
+    type: "isRequestVariablesStale";
+    params: unknown;
 } | {
     type: "hasMoreRecoveryRetries";
     params: unknown;

package/src/lib/avatar-client-manager/machines/avatar-connection/guards/is-request-variables-stale.d.ts

@@ -0,0 +1,4 @@
+import { AvatarConnectionMachineContext } from '../types';
+export declare const isRequestVariablesStale: ({ context, }: {
+    context: AvatarConnectionMachineContext;
+}) => boolean;

package/src/lib/avatar-client-manager/machines/avatar-connection/guards/is-stage-variable-stale.d.ts

@@ -0,0 +1,4 @@
+import { AvatarConnectionMachineContext } from '../types';
+export declare const isStageVariableStale: ({ context, }: {
+    context: AvatarConnectionMachineContext;
+}) => boolean;

package/src/lib/avatar-client-manager/machines/avatar-connection/states/connected-state.d.ts

@@ -82,12 +82,16 @@ export declare const connectedState: {
                     logger: import("@unisphere/core").UnisphereLoggerType;
                 };
             }[];
+            always: {
+                guard: "isRequestVariablesStale";
+                actions: readonly ["sendUpdateGenieContext", "trackPushedStageContent", "trackPushedProgressBar"];
+            };
             on: {
                 SetContent: {
                     actions: readonly ["setContentData"];
                 };
                 AgentRawTextMessageCompleted: {
-                    actions: readonly ["setContentData"];
+                    actions: readonly ["setContentData", "setProgressBarData"];
                 };
             };
         };

package/src/lib/avatar-client-manager/machines/avatar-connection/states/connected-states/content-state.d.ts

@@ -10,12 +10,16 @@ export declare const contentState: {
             logger: import("@unisphere/core").UnisphereLoggerType;
         };
     }[];
+    always: {
+        guard: "isRequestVariablesStale";
+        actions: readonly ["sendUpdateGenieContext", "trackPushedStageContent", "trackPushedProgressBar"];
+    };
     on: {
         SetContent: {
             actions: readonly ["setContentData"];
         };
         AgentRawTextMessageCompleted: {
-            actions: readonly ["setContentData"];
+            actions: readonly ["setContentData", "setProgressBarData"];
         };
     };
 };

package/src/lib/avatar-client-manager/machines/avatar-connection/types/context.d.ts

@@ -4,7 +4,7 @@ import { clientConfigurationSchema } from './schemas';
 import { z } from 'zod/mini';
 import { KalturaAnalyticsServiceType, PubSubServiceType } from '@unisphere/runtime';
 import { AvatarRuntimeSettings, CaptionConfig, CaptionState, ClientToolCallLogEntry, DisconnectReasons, GenieCapabilities, ChatContext } from '@unisphere/genie-types';
-import { ChatEntry, UnisphereChatBlock } from '@unisphere/genie-types';
+import { AgentProgressBar, ChatEntry, UnisphereChatBlock } from '@unisphere/genie-types';
 import { AvatarClientToolsRegistry, GetAvatarClientToolHandler } from './input';
 export interface AvatarConnectionMachineContext {
     logger: UnisphereLoggerType;
@@ -33,6 +33,7 @@ export interface AvatarConnectionMachineContext {
             chat?: boolean;
             captions?: boolean | CaptionConfig;
             kickOffPhrase?: string;
+            persistentContent?: boolean;
         };
         serverUrl: string;
         turnServerUrl: string;
@@ -64,6 +65,9 @@ export interface AvatarConnectionMachineContext {
     webrtcUrl: string | null;
     threadId: string | null;
     content: UnisphereChatBlock | null;
+    pushedStageContent: UnisphereChatBlock | null;
+    progressBar: AgentProgressBar | null;
+    pushedProgressBar: AgentProgressBar | null;
     chatLog: ChatEntry[];
     clientToolCallLog: ClientToolCallLogEntry[];
     awaitingInternalAskEcho: boolean;

package/src/lib/avatar-client-manager/machines/avatar-connection/types/events.d.ts

@@ -2,7 +2,7 @@ import { DoneActorEvent, ErrorActorEvent } from 'xstate';
 import { ChatEntry, UnisphereChatBlock } from '@unisphere/genie-types';
 import { askPermissionsSchema, clientConfigurationSchema, conversationEndedSchema, conversationTimeWarningSchema, joinCompleteSchema, noAgentSchema, onServerConnectedSchema, showAgentSchema, showStartSpeechSchema, stvFinishedTalkingSchema, stvNewSessionSchema, stvStartedTalkingSchema } from './schemas';
 import z from 'zod';
-import { CaptionState, ClientToolCallLogEntry, DisconnectReasons } from '@unisphere/genie-types';
+import { AgentProgressBar, CaptionState, ClientToolCallLogEntry, DisconnectReasons } from '@unisphere/genie-types';
 export declare enum AvatarConnectionMachineEventTypes {
     Disconnect = "Disconnect",
     WebsocketReconnected = "WebsocketReconnected",
@@ -130,11 +130,16 @@ export type AgentThreadIdReceivedEvent = {
     type: AvatarConnectionMachineEventTypes.AgentThreadIdReceived;
     payload: string;
 };
+export type StageDirective = 'clear';
 export type AgentRawTextMessageCompletedEvent = {
     type: AvatarConnectionMachineEventTypes.AgentRawTextMessageCompleted;
     messageId: string;
     speechId: string;
     blocks: UnisphereChatBlock[];
+    /** Set when the message carried a ```stage``` control fence */
+    stageDirective?: StageDirective;
+    /** Set when the message carried a valid ```ui-progress-bar``` fence */
+    progressBar?: AgentProgressBar;
 };
 export type AgentRecoveryTurnCompletedEvent = {
     type: AvatarConnectionMachineEventTypes.AgentRecoveryTurnCompleted;

package/src/lib/avatar-client-manager/machines/avatar-connection/utils/build-progress-bar-variable.d.ts

@@ -0,0 +1,3 @@
+import { AgentProgressBar } from '@unisphere/genie-types';
+export declare const PROGRESS_BAR_VARIABLE_NAME = "progress_bar";
+export declare const buildProgressBarVariable: (progressBar: AgentProgressBar | null) => string;

package/src/lib/avatar-client-manager/machines/avatar-connection/utils/build-stage-variable.d.ts

@@ -0,0 +1,3 @@
+import { UnisphereChatBlock } from '@unisphere/genie-types';
+export declare const STAGE_VARIABLE_NAME = "avatar_stage";
+export declare const buildStageVariable: (content: UnisphereChatBlock | null) => string;

package/src/lib/avatar-client-manager/machines/avatar-connection/utils/index.d.ts

@@ -1,2 +1,7 @@
 export * from './resolve-capabilities';
 export * from './agent-raw-text-blocks-creator';
+export * from './parse-stage-directive';
+export * from './parse-progress-bar';
+export * from './is-deep-equal';
+export * from './build-stage-variable';
+export * from './resolve-persistent-content';

package/src/lib/avatar-client-manager/machines/avatar-connection/utils/is-deep-equal.d.ts

@@ -0,0 +1 @@
+export declare const isDeepEqual: (a: unknown, b: unknown) => boolean;

package/src/lib/avatar-client-manager/machines/avatar-connection/utils/parse-progress-bar.d.ts

@@ -0,0 +1,2 @@
+import { AgentProgressBar } from '@unisphere/genie-types';
+export declare const parseProgressBar: (text: string) => AgentProgressBar | null;

package/src/lib/avatar-client-manager/machines/avatar-connection/utils/parse-stage-directive.d.ts

@@ -0,0 +1,2 @@
+import { StageDirective } from '../types/events';
+export declare const parseStageDirective: (text: string) => StageDirective | null;

package/src/lib/avatar-client-manager/machines/avatar-connection/utils/resolve-persistent-content.d.ts

@@ -0,0 +1,13 @@
+import { UnisphereChatBlock } from '@unisphere/genie-types';
+import { StageDirective } from '../types/events';
+/**
+ * Persistent-stage reducer for a completed agent message. Returns the current
+ * reference when nothing should change so downstream stores skip the update.
+ * Same tool re-emitted keeps the current block id (React key), so the visual is
+ * updated in place rather than remounted.
+ */
+export declare const resolvePersistentContent: ({ current, incoming, stageDirective, }: {
+    current: UnisphereChatBlock | null;
+    incoming: UnisphereChatBlock | undefined;
+    stageDirective?: StageDirective;
+}) => UnisphereChatBlock | null;