@kaltura-sdk/avatars 1.17.1 → 1.19.0

package/README.md

@@ -34,7 +34,7 @@ manager.stop(); // full teardown, unsubscribes everything
 - **Pause/resume**: `pause()`, `resume()`, `pauseAfterSpeaking()`, `isPaused`
 - **Chat & content**: `askViaText()`, `chatLog`, `content`, `setLocalContent()`, `clearContent()`, `agentData`
 - **Screen share**: `startScreenShare()`, `stopScreenShare()`, `screenShareInfo`
-- **Tap-to-talk**: `tapToTalkStart()`, `tapToTalkEnd()`, `toggleTapToTalkMode()`, `tapToTalkInfo`
+- **Tap-to-talk**: `tapToTalkStart(options?)` (`options.enrichAudio` asks the server to analyze the recording), `tapToTalkEnd()`, `toggleTapToTalkMode()`, `tapToTalkInfo`
 - **Captions**: `captions` (state + `toggle`/`setReplacements`/`setFilter`)
 - **Kaltura context**: `kalturaContext`, `toggleKalturaContext()`, `updateDynamicVariables()`
 - **Client tools**: `registerClientTools()`, `unregisterClientTools()`, `registeredClientTools`, `clientToolCallLog`

package/index.esm.js

@@ -18914,6 +18914,7 @@ const parseStageDirective = text => {
 
 const MIN_STEPS = 2;
 const MAX_STEPS = 12;
+const MIN_SUB_STEPS = 2;
 const MAX_TOOLTIP_LENGTH = 200;
 // Tooltips are optional decoration: bad entries are dropped, never a reason to reject the bar.
 const parseTooltips = (value, totalSteps) => {
@@ -18921,6 +18922,19 @@ const parseTooltips = (value, totalSteps) => {
   const tooltips = value.slice(0, totalSteps).map(entry => typeof entry === 'string' ? entry.trim().slice(0, MAX_TOOLTIP_LENGTH) : '');
   return tooltips.some(Boolean) ? tooltips : null;
 };
+// Sub-steps are optional decoration like tooltips: invalid values drop them, never the bar.
+// The last step has no line to split, so it never carries them.
+const parseSubSteps = (subSteps, currentSubStep, currentStep, totalSteps) => {
+  if (!Number.isInteger(subSteps) || subSteps < MIN_SUB_STEPS || currentStep >= totalSteps) {
+    return null;
+  }
+  const total = subSteps;
+  const current = Number.isInteger(currentSubStep) ? Math.min(total, Math.max(1, currentSubStep)) : 1;
+  return {
+    subSteps: total,
+    currentSubStep: current
+  };
+};
 const parseVisible = value => {
   if (typeof value === 'boolean') return value;
   if (typeof value !== 'string') return null;
@@ -18945,7 +18959,9 @@ const parseProgressBar = text => {
     currentStep,
     type,
     variant,
-    tooltips
+    tooltips,
+    subSteps,
+    currentSubStep
   } = parsed;
   const isVisible = parseVisible(visible);
   if (isVisible === null) return null;
@@ -18957,7 +18973,8 @@ const parseProgressBar = text => {
     return null;
   }
   const stepTooltips = parseTooltips(tooltips, totalSteps);
-  return Object.assign(Object.assign({
+  const parts = parseSubSteps(subSteps, currentSubStep, currentStep, totalSteps);
+  return Object.assign(Object.assign(Object.assign({
     visible: isVisible,
     totalSteps: totalSteps,
     currentStep: currentStep,
@@ -18966,7 +18983,7 @@ const parseProgressBar = text => {
     variant
   } : {}), stepTooltips ? {
     tooltips: stepTooltips
-  } : {});
+  } : {}), parts !== null && parts !== void 0 ? parts : {});
 };
 
 var $$b = _export;
@@ -19089,11 +19106,14 @@ const buildProgressBarVariable = progressBar => {
       status: 'hidden'
     });
   }
-  return JSON.stringify({
+  return JSON.stringify(Object.assign({
     status: 'shown',
     currentStep: progressBar.currentStep,
     totalSteps: progressBar.totalSteps
-  });
+  }, progressBar.subSteps ? {
+    subSteps: progressBar.subSteps,
+    currentSubStep: progressBar.currentSubStep
+  } : {}));
 };
 
 const sendJoinRoom = ({
@@ -23083,13 +23103,24 @@ const isTapToTalkEnabled = ({
 };
 
 const sendTapToTalkStart = ({
-  context
+  context,
+  event
 }) => {
+  var _a;
+  assertEvent(event, AvatarConnectionMachineEventTypes.RequestTapToTalkStart);
   const client = websocketClientManager.getClient(context.externalInfo.serverUrl);
   if (!client) {
     throw new Error('WebSocket client not found');
   }
-  client.emit('tapToTalkStart');
+  const enrichAudio = (_a = event.options) === null || _a === void 0 ? void 0 : _a.enrichAudio;
+  // No payload without options keeps the event identical for servers that predate the flag
+  if (enrichAudio === undefined) {
+    client.emit('tapToTalkStart');
+    return;
+  }
+  client.emit('tapToTalkStart', {
+    enrichAudio
+  });
 };
 
 const sendTapToTalkEnd = ({
@@ -24218,7 +24249,7 @@ class AvatarClientManager extends ActorManager {
       pauseAvatar: () => this.pause(),
       resumeAvatar: () => this.resume(),
       pauseAvatarAfterSpeaking: () => this.pauseAfterSpeaking(),
-      tapToTalkStart: () => this.tapToTalkStart(),
+      tapToTalkStart: options => this.tapToTalkStart(options),
       tapToTalkEnd: () => this.tapToTalkEnd(),
       clearContent: () => this.clearContent(),
       toggleCaptions: () => this.toggleCaptions(),
@@ -24437,10 +24468,11 @@ class AvatarClientManager extends ActorManager {
   get tapToTalkInfo() {
     return this._tapToTalkInfo.consumer;
   }
-  tapToTalkStart() {
+  tapToTalkStart(options) {
     var _a;
     (_a = this._actor) === null || _a === void 0 ? void 0 : _a.send({
-      type: AvatarConnectionMachineEventTypes.RequestTapToTalkStart
+      type: AvatarConnectionMachineEventTypes.RequestTapToTalkStart,
+      options
     });
   }
   tapToTalkEnd() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaltura-sdk/avatars",
-  "version": "1.17.1",
+  "version": "1.19.0",
   "author": "kaltura",
   "license": "AGPL-3.0",
   "repository": {
@@ -13,7 +13,7 @@
     "@kaltura-sdk/rtc-core": "^1.26.2",
     "@local/genie-shared-utils": "^1.0.0",
     "@unisphere/core": "^1.99.0",
-    "@unisphere/genie-types": "^1.42.1",
+    "@unisphere/genie-types": "^1.44.0",
     "@unisphere/notifications-core": "^1.25.0",
     "@unisphere/runtime": "^1.98.0",
     "@unisphere/runtime-js": "^1.98.0",

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, AgentProgressBar, 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, TapToTalkStartOptions } from '@unisphere/genie-types';
 import { type AvatarClientToolsInput, type AvatarConnectionActor } from './machines/avatar-connection';
 import { AvatarClientManagerActions } from './types';
 import { DeviceType } from '@kaltura-sdk/rtc-core';
@@ -128,7 +128,7 @@ export declare class AvatarClientManager extends ActorManager<AvatarConnectionAc
     startScreenShare(): void;
     stopScreenShare(): void;
     get tapToTalkInfo(): import("@unisphere/core").TinyDataStoreConsumer<AgentTapToTalkInfo | null>;
-    tapToTalkStart(): void;
+    tapToTalkStart(options?: TapToTalkStartOptions): void;
     tapToTalkEnd(): void;
     toggleTapToTalkMode(enabled: boolean): void;
     get captions(): Captions;

package/src/lib/avatar-client-manager/machines/avatar-connection/actions/server/send-tap-to-talk-start.d.ts

@@ -1,4 +1,2 @@
-import { AvatarConnectionMachineContext } from '../../types';
-export declare const sendTapToTalkStart: ({ context, }: {
-    context: AvatarConnectionMachineContext;
-}) => void;
+import { AvatarConnectionMachineAction } from '../../types';
+export declare const sendTapToTalkStart: AvatarConnectionMachineAction;

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 { AgentProgressBar, CaptionState, ClientToolCallLogEntry, DisconnectReasons } from '@unisphere/genie-types';
+import { AgentProgressBar, CaptionState, ClientToolCallLogEntry, DisconnectReasons, TapToTalkStartOptions } from '@unisphere/genie-types';
 export declare enum AvatarConnectionMachineEventTypes {
     Disconnect = "Disconnect",
     WebsocketReconnected = "WebsocketReconnected",
@@ -212,6 +212,7 @@ export type SetDynamicVariablesEvent = {
 };
 export type RequestTapToTalkStartEvent = {
     type: AvatarConnectionMachineEventTypes.RequestTapToTalkStart;
+    options?: TapToTalkStartOptions;
 };
 export type RequestTapToTalkEndEvent = {
     type: AvatarConnectionMachineEventTypes.RequestTapToTalkEnd;