@kaltura-sdk/avatars 1.15.0 → 1.15.1

package/README.md

@@ -1 +1,47 @@
-# Unisphere Genie - Package Avatars
+# @kaltura-sdk/avatars
+
+Core implementation of `AvatarClientManager` — the state machine-driven client for Kaltura's conversational avatar. Runs on `xstate` + `@unisphere/core` reactive stores; owns the whole connection lifecycle (RTC session, chat, captions, screen share, tap-to-talk, client tools, Kaltura context).
+
+For a framework-free, CDN-loadable build, use [`@kaltura-sdk/avatars-esm`](../avatars-esm) — it re-exports this package.
+
+## Usage
+
+```ts
+import { AvatarClientManager } from '@kaltura-sdk/avatars';
+
+const manager = new AvatarClientManager({
+  actions: { showNotification }, // optional, defaults to a noop
+  debugMode: true, // optional, default false
+  logger, // optional — UnisphereLoggerType, defaults to an internal 'avatar-client' logger
+  runtimeSettings, // AvatarRuntimeSettings
+  kalturaAnalyticsService, // optional, no-ops if omitted
+  pubSubService, // optional, no-ops if omitted
+  registerDeveloperTools: (actor) => {}, // optional, e.g. xstate inspector
+  videoContainerId: 'avatar-video', // optional — auto-joins STV once castMode is "webrtc"
+});
+
+manager.connectionStatus.onChanges((status) => console.log(status));
+manager.connect({ dynamicVariables, kickOffPhrase });
+manager.disconnect();
+manager.stop(); // full teardown, unsubscribes everything
+```
+
+`connect()`/`disconnect()` are sync (fire-and-forget) — read outcomes off the reactive stores (`connectionStatus`, `castMode`, `disconnectData`, etc).
+
+## API surface
+
+- **Lifecycle**: `connect()`, `disconnect()`, `reconnect()`, `stop()`, `connectionStatus`, `playerUrl`, `sessionId`, `castMode`, `turnServerURL`, `disconnectData`
+- **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`
+- **Captions**: `captions` (state + `toggle`/`setReplacements`/`setFilter`)
+- **Kaltura context**: `kalturaContext`, `toggleKalturaContext()`, `updateDynamicVariables()`
+- **Client tools**: `registerClientTools()`, `unregisterClientTools()`, `registeredClientTools`, `clientToolCallLog`
+- **Session metadata**: `threadId`, `setExternalThreadId()`, `isPreviewMode`, `contextSelectorVisible`, `features`, `agentPreviewUrl`, `agentPreviewImageUrl`, `serverUrl`
+- **RTC/device passthrough**: `audioState`, `audioVolumeLevel`, `devicesList`, `joinSTV()`, `leaveSTV()`, `changeDevice()`, `toggleMuteAudio()`
+- **Player events**: `onPlayerReady()`, `onPlayerError()`
+
+All getters return `@unisphere/core` reactive stores (`.consumer`, subscribe via `.onChanges`).
+
+`connection` is a deprecated back-compat facade kept only for consumers not yet migrated to the manager's own getters/methods.

package/index.esm.js

@@ -23630,6 +23630,11 @@ const noopPubSubService = {
     // noop
   }
 };
+const noopAvatarClientManagerActions = {
+  showNotification: () => {
+    // noop
+  }
+};
 /**
  * Avatar-domain manager on top of the generic `ActorManager` engine: owns
  * the `avatarConnectionMachine` actor and exposes it as reactive stores +
@@ -23640,6 +23645,7 @@ const noopPubSubService = {
  */
 class AvatarClientManager extends ActorManager {
   constructor(_config) {
+    var _a;
     super();
     this._config = _config;
     // keep separate from other subscriptions since we don't want to stop when disconnect only when stop called
@@ -23790,7 +23796,7 @@ class AvatarClientManager extends ActorManager {
     this._contextSelectorVisible = new TinyDataStore({
       initialValue: true
     });
-    this._logger = this._config.logger;
+    this._logger = (_a = this._config.logger) !== null && _a !== void 0 ? _a : avatarClientLoggerFactory.getOrCreateLogger('service', 'avatar-client');
     if (this._config.runtimeSettings.features) {
       this._features.setData(() => this._config.runtimeSettings.features);
     }
@@ -24002,7 +24008,7 @@ class AvatarClientManager extends ActorManager {
     return this._agentData.consumer;
   }
   connect(options) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f, _g;
     this._lastConnectOptions = options;
     this._onThreadIdChange = options === null || options === void 0 ? void 0 : options.onThreadIdChange;
     if (this._connection.getData()) {
@@ -24020,11 +24026,11 @@ class AvatarClientManager extends ActorManager {
       input: Object.assign({
         connectionId,
         logger: this._logger,
-        debugMode: this._config.debugMode,
-        kalturaAnalyticsService: (_a = this._config.kalturaAnalyticsService) !== null && _a !== void 0 ? _a : noopKalturaAnalyticsService,
-        pubSubService: (_b = this._config.pubSubService) !== null && _b !== void 0 ? _b : noopPubSubService,
+        debugMode: (_a = this._config.debugMode) !== null && _a !== void 0 ? _a : false,
+        kalturaAnalyticsService: (_b = this._config.kalturaAnalyticsService) !== null && _b !== void 0 ? _b : noopKalturaAnalyticsService,
+        pubSubService: (_c = this._config.pubSubService) !== null && _c !== void 0 ? _c : noopPubSubService,
         externalActions: {
-          showNotification: this._config.actions.showNotification
+          showNotification: ((_d = this._config.actions) !== null && _d !== void 0 ? _d : noopAvatarClientManagerActions).showNotification
         },
         runtimeSettings: this._config.runtimeSettings,
         videoContainerId: this._config.videoContainerId,
@@ -24033,14 +24039,14 @@ class AvatarClientManager extends ActorManager {
         kickOffPhrase: options === null || options === void 0 ? void 0 : options.kickOffPhrase,
         clientToolsRegistry: this._clientToolsRegistry,
         getClientToolHandler: this._getClientToolHandler
-      }, ((_c = options === null || options === void 0 ? void 0 : options.context) === null || _c === void 0 ? void 0 : _c.type) === 'thread' && {
+      }, ((_e = options === null || options === void 0 ? void 0 : options.context) === null || _e === void 0 ? void 0 : _e.type) === 'thread' && {
         threadId: options.context.threadId,
         messageId: options.context.messageId
       })
     });
     this._logsInitialized = false;
     this._setupActorSync(actor);
-    (_e = (_d = this._config).registerDeveloperTools) === null || _e === void 0 ? void 0 : _e.call(_d, actor);
+    (_g = (_f = this._config).registerDeveloperTools) === null || _g === void 0 ? void 0 : _g.call(_f, actor);
     actor.start();
   }
   disconnect() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaltura-sdk/avatars",
-  "version": "1.15.0",
+  "version": "1.15.1",
   "author": "kaltura",
   "license": "AGPL-3.0",
   "repository": {

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

@@ -58,9 +58,9 @@ export declare class AvatarClientManager extends ActorManager<AvatarConnectionAc
     private readonly _isPreviewMode;
     private readonly _contextSelectorVisible;
     constructor(_config: {
-        actions: AvatarClientManagerActions;
-        debugMode: boolean;
-        logger: UnisphereLoggerType;
+        actions?: AvatarClientManagerActions;
+        debugMode?: boolean;
+        logger?: UnisphereLoggerType;
         kalturaAnalyticsService?: KalturaAnalyticsServiceType;
         pubSubService?: PubSubServiceType;
         runtimeSettings: AvatarRuntimeSettings;