@kaltura-sdk/avatars 1.15.4 → 1.15.5

package/index.esm.js

@@ -2,10 +2,10 @@ import { UnisphereLoggerFactory, TinyDataStore, TinyPubSub, performanceMonitor }
 import { getPartnerIdFromKs } from '@unisphere/runtime-js';
 import { DisconnectReasons, getAvatarDefaultCapabilities, resolveActiveContextType, AvatarConnectionStatus } from '@unisphere/genie-types';
 import { z as z$1 } from 'zod/mini';
+import { AlertIconEnum } from '@unisphere/notifications-core';
 import { initializeLogsCollector, EselfSession, MediaTrackState, sendLogs } from '@kaltura-sdk/rtc-avatar';
 import { produce } from 'immer';
 import * as yaml from 'js-yaml';
-import { AlertIconEnum, NotificationTypes } from '@unisphere/notifications-core';
 import { ApplicationPageTypes, ApplicationEventTypes, AnalyticsBucket } from '@unisphere/runtime';
 import { executeClientToolCall, sendClientToolResponse } from '@local/genie-shared-utils';
 
@@ -6260,6 +6260,48 @@ const stvSpeechChunkSchema = z$1.object({
   durationMs: z$1.number(),
   speechId: z$1.string()
 });
+const unsupportedClientSchema = z$1.object({
+  code: z$1.optional(z$1.string())
+});
+
+// Codes for notifications that are not tied to a connection disconnect reason.
+// Keep these string-stable: consumers of `externalActions.showNotification`
+// match on `code` to look up their own localized copy.
+var AvatarNotificationCode;
+(function (AvatarNotificationCode) {
+  AvatarNotificationCode["ScreenShareError"] = "ScreenShareError";
+  AvatarNotificationCode["AgentRecoveryExhausted"] = "AgentRecoveryExhausted";
+  AvatarNotificationCode["ConversationTimeWarning"] = "ConversationTimeWarning";
+})(AvatarNotificationCode || (AvatarNotificationCode = {}));
+const disconnectReasonVariantMap = {
+  [DisconnectReasons.ConnectionError]: AlertIconEnum.Error,
+  [DisconnectReasons.ExceededTierLimits]: AlertIconEnum.Warning,
+  [DisconnectReasons.NoAgentsAvailable]: AlertIconEnum.Warning,
+  [DisconnectReasons.UserMediaInitializationFailed]: AlertIconEnum.Error,
+  [DisconnectReasons.UserRequested]: AlertIconEnum.Success,
+  [DisconnectReasons.WebsocketConnectionFailed]: AlertIconEnum.Error,
+  [DisconnectReasons.WebsocketDisconnected]: AlertIconEnum.Warning,
+  [DisconnectReasons.PeerRemoved]: AlertIconEnum.Warning,
+  [DisconnectReasons.BadRequest]: AlertIconEnum.Error,
+  [DisconnectReasons.ASRConnectionFailed]: AlertIconEnum.Warning,
+  [DisconnectReasons.DestroyFailed]: AlertIconEnum.Error,
+  [DisconnectReasons.ConversationEnded]: AlertIconEnum.Warning,
+  [DisconnectReasons.UnknownReason]: AlertIconEnum.Error,
+  [DisconnectReasons.DevicesPermissionDenied]: AlertIconEnum.Warning,
+  [DisconnectReasons.AgentResponseTimeout]: AlertIconEnum.Warning,
+  [DisconnectReasons.UnsupportedClient]: AlertIconEnum.Error,
+  [DisconnectReasons.JoinRoomTimeout]: AlertIconEnum.Warning,
+  [DisconnectReasons.ConnectionTimeout]: AlertIconEnum.Warning,
+  [DisconnectReasons.PlayerConnectionFailed]: AlertIconEnum.Error
+};
+const defaultDisconnectVariant = AlertIconEnum.Error;
+function isMappedAvatarDisconnectReason(reason) {
+  return !!disconnectReasonVariantMap[reason];
+}
+function getAvatarDisconnectNotificationVariant(reason) {
+  var _a;
+  return (_a = disconnectReasonVariantMap[reason]) !== null && _a !== void 0 ? _a : defaultDisconnectVariant;
+}
 
 const AvatarConnectionMachineId = 'AvatarClient';
 
@@ -19259,97 +19301,6 @@ const setDisconnectData = assign$1(({
   });
 });
 
-const avatarConnectionNotificationsMap = {
-  [DisconnectReasons.ConnectionError]: {
-    text: 'There was a problem connecting to the server. Please try again later.',
-    variant: AlertIconEnum.Error
-  },
-  [DisconnectReasons.ExceededTierLimits]: {
-    text: 'You have exceeded your usage limits. Please upgrade your plan or try again later.',
-    variant: AlertIconEnum.Warning
-  },
-  [DisconnectReasons.NoAgentsAvailable]: {
-    text: 'No agents are currently available. Please try again later.',
-    variant: AlertIconEnum.Warning
-  },
-  [DisconnectReasons.UserMediaInitializationFailed]: {
-    text: 'Unable to access your microphone or camera. Please check your device settings.',
-    variant: AlertIconEnum.Error
-  },
-  [DisconnectReasons.UserRequested]: {
-    text: 'You have ended the session.',
-    variant: AlertIconEnum.Success
-  },
-  [DisconnectReasons.WebsocketConnectionFailed]: {
-    text: 'WebSocket connection failed. Please check your internet connection and try again.',
-    variant: AlertIconEnum.Error
-  },
-  [DisconnectReasons.WebsocketDisconnected]: {
-    text: 'The connection was lost. Please try reconnecting.',
-    variant: AlertIconEnum.Warning
-  },
-  [DisconnectReasons.PeerRemoved]: {
-    text: 'The session has ended as the peer has disconnected.',
-    variant: AlertIconEnum.Warning
-  },
-  [DisconnectReasons.BadRequest]: {
-    text: 'There was a bad request error. Please verify your settings and try again.',
-    variant: AlertIconEnum.Error
-  },
-  [DisconnectReasons.ASRConnectionFailed]: {
-    text: 'Voice Activity Detection connection failed. Some features may not work properly.',
-    variant: AlertIconEnum.Warning
-  },
-  [DisconnectReasons.DestroyFailed]: {
-    text: 'An error occurred while ending the session. Please try again later.',
-    variant: AlertIconEnum.Error
-  },
-  [DisconnectReasons.ConversationEnded]: {
-    text: 'The conversation has ended.',
-    variant: AlertIconEnum.Warning
-  },
-  [DisconnectReasons.UnknownReason]: {
-    text: 'An unknown error occurred. Please try again later or contact support.',
-    variant: AlertIconEnum.Error
-  },
-  [DisconnectReasons.DevicesPermissionDenied]: {
-    text: 'Microphone access was denied. Please allow microphone permissions and try again.',
-    variant: AlertIconEnum.Warning
-  },
-  [DisconnectReasons.AgentResponseTimeout]: {
-    text: 'The agent took too long to respond. Please try again later.',
-    variant: AlertIconEnum.Warning
-  },
-  [DisconnectReasons.UnsupportedClient]: {
-    text: 'The client you are using is not supported. Please contact support.',
-    variant: AlertIconEnum.Error
-  },
-  [DisconnectReasons.JoinRoomTimeout]: {
-    text: 'Joining the room timed out. Please check your connection and try again.',
-    variant: AlertIconEnum.Warning
-  },
-  [DisconnectReasons.ConnectionTimeout]: {
-    text: 'The connection timed out. Please check your internet connection and try again.',
-    variant: AlertIconEnum.Warning
-  },
-  [DisconnectReasons.PlayerConnectionFailed]: {
-    text: 'A playback error occurred while connecting to the avatar. Please try again.',
-    variant: AlertIconEnum.Error
-  }
-};
-const defaultDisconnectNotification = {
-  text: 'An unknown error occurred. Please try again later or contact support.',
-  variant: AlertIconEnum.Error
-};
-function isMappedAvatarDisconnectReason(reason) {
-  return !!avatarConnectionNotificationsMap[reason];
-}
-function getAvatarConnectionNotification(reason) {
-  return Object.assign({
-    type: NotificationTypes.Alert
-  }, avatarConnectionNotificationsMap[reason] || defaultDisconnectNotification);
-}
-
 const showDisconnectNotification = ({
   context
 }) => {
@@ -19377,7 +19328,10 @@ const showDisconnectNotification = ({
         }
       });
     }
-    const notification = getAvatarConnectionNotification(context.disconnectData.reason);
+    const notification = {
+      code: context.disconnectData.reason,
+      variant: getAvatarDisconnectNotificationVariant(context.disconnectData.reason)
+    };
     try {
       context.externalActions.showNotification(notification);
     } catch (error) {
@@ -19428,6 +19382,7 @@ const onConversationEnded = fromCallback(({
   });
 });
 
+const USAGE_LIMIT_EXCEEDED_CODE = 'USAGE_LIMIT_EXCEEDED';
 const source$g = createTinyPubsubEventsSource(websocketMessage, {
   disconnect: {
     schema: null
@@ -19451,7 +19406,7 @@ const source$g = createTinyPubsubEventsSource(websocketMessage, {
     schema: null
   },
   unsupportedClient: {
-    schema: null
+    schema: unsupportedClientSchema
   }
 }, {
   queueWhilePending: true
@@ -19480,7 +19435,10 @@ const onError = fromCallback(({
       throwToNoAgent: createHandler(DisconnectReasons.NoAgentsAvailable),
       throwToExceededTier: createHandler(DisconnectReasons.ExceededTierLimits),
       throwToBadRequest: createHandler(DisconnectReasons.BadRequest),
-      unsupportedClient: createHandler(DisconnectReasons.UnsupportedClient)
+      unsupportedClient: event => {
+        const reason = (event === null || event === void 0 ? void 0 : event.code) === USAGE_LIMIT_EXCEEDED_CODE ? DisconnectReasons.ExceededTierLimits : DisconnectReasons.UnsupportedClient;
+        createHandler(reason)(event);
+      }
     }
   });
 });
@@ -20407,9 +20365,11 @@ const showTimeWarningNotification = ({
 }) => {
   assertEvent(event, AvatarConnectionMachineEventTypes.ConversationTimeWarningReceived);
   const notification = {
-    type: NotificationTypes.Alert,
-    text: `Your conversation will end in ${event.payload.remainingTime} seconds.`,
+    code: AvatarNotificationCode.ConversationTimeWarning,
     variant: AlertIconEnum.Warning,
+    params: {
+      remainingTime: event.payload.remainingTime
+    },
     options: {
       duration: event.payload.remainingTime,
       showClose: true
@@ -21423,8 +21383,7 @@ const showScreenShareErrorNotification = ({
 }) => {
   try {
     context.externalActions.showNotification({
-      type: NotificationTypes.Alert,
-      text: 'Screen sharing encountered an error. Please try again.',
+      code: AvatarNotificationCode.ScreenShareError,
       variant: AlertIconEnum.Error
     });
   } catch (error) {
@@ -23287,8 +23246,7 @@ const showAgentRecoveryExhaustedNotification = ({
   context
 }) => {
   const notification = {
-    type: NotificationTypes.Alert,
-    text: "We're having trouble getting a response. Please try asking again.",
+    code: AvatarNotificationCode.AgentRecoveryExhausted,
     variant: AlertIconEnum.Warning,
     options: {
       showClose: true
@@ -24390,4 +24348,4 @@ class AvatarClientManager extends ActorManager {
   }
 }
 
-export { ApplicationFeatures, AvatarClientManager, AvatarConnectionMachineEventTypes, AvatarConnectionMachineId, ButtonNames, PageNames, agentRawTextClientToolDeltaSchema, agentRawTextDeltaSchema, agentRawTextSchema, agentTurnToTalkSchema, askPermissionsSchema, avatarClientLoggerFactory, avatarConnectionMachine, avatarRTCClientManager, clientConfigurationSchema, conversationEndedSchema, conversationTimeWarningSchema, createTinyPubsubEventsHandler, createTinyPubsubEventsSource, generatingSpeechSchema, getQueryParam, initializeLogsCollectionIfNeeded, isMobileDevice, joinCompleteSchema, noAgentSchema, onServerConnectedSchema, pauseExpiryWarningSchema, resetWebsocketClientTeardownState, showAgentSchema, showStartSpeechSchema, stvFinishedTalkingSchema, stvNewSessionSchema, stvSpeechChunkSchema, stvStartedTalkingSchema, timingTracker, websocketClientManager, websocketDebugInfo, websocketMessage, websocketNonRecoveredReconnect, websocketRecoveryState, websocketSystemMessage };
+export { ApplicationFeatures, AvatarClientManager, AvatarConnectionMachineEventTypes, AvatarConnectionMachineId, AvatarNotificationCode, ButtonNames, PageNames, agentRawTextClientToolDeltaSchema, agentRawTextDeltaSchema, agentRawTextSchema, agentTurnToTalkSchema, askPermissionsSchema, avatarClientLoggerFactory, avatarConnectionMachine, avatarRTCClientManager, clientConfigurationSchema, conversationEndedSchema, conversationTimeWarningSchema, createTinyPubsubEventsHandler, createTinyPubsubEventsSource, generatingSpeechSchema, getAvatarDisconnectNotificationVariant, getQueryParam, initializeLogsCollectionIfNeeded, isMappedAvatarDisconnectReason, isMobileDevice, joinCompleteSchema, noAgentSchema, onServerConnectedSchema, pauseExpiryWarningSchema, resetWebsocketClientTeardownState, showAgentSchema, showStartSpeechSchema, stvFinishedTalkingSchema, stvNewSessionSchema, stvSpeechChunkSchema, stvStartedTalkingSchema, timingTracker, unsupportedClientSchema, websocketClientManager, websocketDebugInfo, websocketMessage, websocketNonRecoveredReconnect, websocketRecoveryState, websocketSystemMessage };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaltura-sdk/avatars",
-  "version": "1.15.4",
+  "version": "1.15.5",
   "author": "kaltura",
   "license": "AGPL-3.0",
   "repository": {
@@ -9,8 +9,8 @@
   },
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@kaltura-sdk/rtc-avatar": "^1.32.28",
-    "@kaltura-sdk/rtc-core": "^1.25.17",
+    "@kaltura-sdk/rtc-avatar": "^1.32.34",
+    "@kaltura-sdk/rtc-core": "^1.25.21",
     "@local/genie-shared-utils": "^1.0.0",
     "@unisphere/core": "^1.99.0",
     "@unisphere/genie-types": "^1.39.1",

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

@@ -1,5 +1,5 @@
 import { UnisphereLoggerType } from '@unisphere/core';
-import { Notifications } from '@unisphere/notifications-core';
+import { AvatarNotificationRequest } from './notifications';
 import { clientConfigurationSchema } from './schemas';
 import { z } from 'zod/mini';
 import { KalturaAnalyticsServiceType, PubSubServiceType } from '@unisphere/runtime';
@@ -53,7 +53,7 @@ export interface AvatarConnectionMachineContext {
     /** @deprecated TODO sk consider to avoid saving entire service object inside the machine's context */
     pubSubService: PubSubServiceType;
     externalActions: {
-        showNotification: (notification: Notifications) => void;
+        showNotification: (notification: AvatarNotificationRequest) => void;
     };
     connectionId: string;
     clientConfiguration: z.infer<typeof clientConfigurationSchema>['clientConfiguration'] | null;

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

@@ -6,6 +6,7 @@ export * from './events';
 export * from './context';
 export * from './input';
 export * from './schemas';
+export * from './notifications';
 export declare const AvatarConnectionMachineId = "AvatarClient";
 export type AvatarConnectionActor = ActorRefFrom<typeof avatarConnectionMachine>;
 export type AvatarConnectionMachineState = SnapshotFrom<typeof avatarConnectionMachine>;

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

@@ -1,5 +1,5 @@
 import { UnisphereLoggerType } from '@unisphere/core';
-import { Notifications } from '@unisphere/notifications-core';
+import { AvatarNotificationRequest } from './notifications';
 import { KalturaAnalyticsServiceType, PubSubServiceType } from '@unisphere/runtime';
 import { AvatarRuntimeSettings } from '@unisphere/genie-types';
 import type { ClientToolHandler, ClientToolsInput, ClientToolsRegistry, GetClientToolHandler } from '@local/genie-shared-utils';
@@ -14,7 +14,7 @@ export interface AvatarConnectionMachineInput {
     kalturaAnalyticsService: KalturaAnalyticsServiceType;
     pubSubService: PubSubServiceType;
     externalActions: {
-        showNotification: (notification: Notifications) => void;
+        showNotification: (notification: AvatarNotificationRequest) => void;
     };
     runtimeSettings: AvatarRuntimeSettings;
     stickyId?: string;

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

@@ -1,4 +1,21 @@
-import { Notifications } from '@unisphere/notifications-core';
+import { AlertIconEnum } from '@unisphere/notifications-core';
 import { DisconnectReasons } from '@unisphere/genie-types';
+export declare enum AvatarNotificationCode {
+    ScreenShareError = "ScreenShareError",
+    AgentRecoveryExhausted = "AgentRecoveryExhausted",
+    ConversationTimeWarning = "ConversationTimeWarning"
+}
+export type AvatarNotificationReasonCode = DisconnectReasons | AvatarNotificationCode;
+export interface AvatarNotificationRequest {
+    code: AvatarNotificationReasonCode;
+    variant: AlertIconEnum;
+    /** Interpolation values the host's translation for `code` may reference. */
+    params?: Record<string, string | number>;
+    options?: {
+        duration?: number;
+        isPermanent?: boolean;
+        showClose?: boolean;
+    };
+}
 export declare function isMappedAvatarDisconnectReason(reason: DisconnectReasons): boolean;
-export declare function getAvatarConnectionNotification(reason: DisconnectReasons): Notifications;
+export declare function getAvatarDisconnectNotificationVariant(reason: DisconnectReasons): AlertIconEnum;

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

@@ -103,3 +103,6 @@ export declare const stvSpeechChunkSchema: z.ZodMiniObject<{
     durationMs: z.ZodMiniNumber<number>;
     speechId: z.ZodMiniString<string>;
 }, z.core.$strip>;
+export declare const unsupportedClientSchema: z.ZodMiniObject<{
+    code: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$strip>;

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

@@ -1,4 +1,4 @@
-import { Notifications } from '@unisphere/notifications-core';
+import { AvatarNotificationRequest } from './machines/avatar-connection/types/notifications';
 export type AvatarClientManagerActions = {
-    showNotification: (notification: Notifications) => void;
+    showNotification: (notification: AvatarNotificationRequest) => void;
 };