@d-id/client-sdk 1.1.0-beta.1 → 1.1.0-beta.3

package/dist/src/services/streaming-manager/index.d.ts

@@ -1,5 +1,5 @@
-import { CreateStreamOptions, PayloadType, StreamingManagerOptions } from '../../types/index';
-export declare function createStreamingManager<T extends CreateStreamOptions>(agentId: string, agent: T, { debug, callbacks, auth, baseURL, warmup }: StreamingManagerOptions): Promise<{
+import { CreateStreamOptions, PayloadType, StreamType, StreamingManagerOptions } from '../../types/index';
+export declare function createStreamingManager<T extends CreateStreamOptions>(agentId: string, agent: T, { debug, callbacks, auth, baseURL }: StreamingManagerOptions): Promise<{
     /**
      * Method to send request to server to get clip or talk depend on you payload
      * @param payload
@@ -17,5 +17,6 @@ export declare function createStreamingManager<T extends CreateStreamOptions>(ag
      * Id of current RTC stream
      */
     streamId: string;
+    streamType: StreamType;
 }>;
 export type StreamingManager<T extends CreateStreamOptions> = Awaited<ReturnType<typeof createStreamingManager<T>>>;

package/dist/src/services/streaming-manager/stats/poll.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="node" />
-import { StreamingState } from '../../../types';
+import { StreamingState, ConnectivityState } from '../../../types';
 import { VideoRTCStatsReport } from './report';
-export declare function pollStats(peerConnection: RTCPeerConnection, getIsConnected: () => boolean, onConnected: () => void, onVideoStateChange?: (state: StreamingState, statsReport?: VideoRTCStatsReport) => void, warmup?: boolean, shouldWaitForGreeting?: boolean): NodeJS.Timeout;
+export declare function pollStats(peerConnection: RTCPeerConnection, getIsConnected: () => boolean, onConnected: () => void, onVideoStateChange?: (state: StreamingState, statsReport?: VideoRTCStatsReport) => void, onConnectivityStateChange?: (state: ConnectivityState) => void, warmup?: boolean, shouldWaitForGreeting?: boolean): NodeJS.Timeout;

package/dist/src/services/streaming-manager/stats/report.d.ts

@@ -3,6 +3,9 @@ export interface VideoRTCStatsReport {
     webRTCStats: {
         anomalies: AnalyticsRTCStatsReport[];
         aggregateReport: AnalyticsRTCStatsReport;
+        minJitterDelayInInterval: number;
+        maxJitterDelayInInterval: number;
+        avgJitterDelayInInterval: number;
     };
     codec: string;
     resolution: string;

package/dist/src/types/entities/agents/manager.d.ts

@@ -1,7 +1,7 @@
 import { STTTokenResponse } from '../..';
-import { SupportedStreamScipt } from '../../stream-script';
 import { Auth } from '../../auth';
-import { CompatibilityMode, ConnectionState, SendStreamPayloadResponse, StreamEvents, StreamingState } from '../../stream';
+import { AgentActivityState, CompatibilityMode, ConnectionState, ConnectivityState, SendStreamPayloadResponse, StreamEvents, StreamType, StreamingState } from '../../stream';
+import { SupportedStreamScript } from '../../stream-script';
 import { Agent } from './agent';
 import { ChatMode, ChatResponse, Message, RatingEntity } from './chat';
 /**
@@ -67,10 +67,20 @@ interface ManagerCallbacks {
      * @param mode - ChatMode
      */
     onModeChange?(mode: ChatMode): void;
+    /**
+     * Optional callback function that will be triggered each time the user internet connectivity state change by realtime estimated bitrate
+     * @param state - ConnectivityState
+     */
+    onConnectivityStateChange?(state: ConnectivityState): void;
     /**
      * Optional callback function that will be triggered on fetch request errors
      */
     onError?: (error: Error, errorData?: object) => void;
+    /**
+     * Optional callback function that will be triggered each time the agent activity state changes
+     * @param state - AgentActivityState
+     */
+    onAgentActivityStateChange?(state: AgentActivityState): void;
 }
 interface StreamOptions {
     /**
@@ -130,6 +140,10 @@ export interface AgentManager {
      * To know more about agents go to https://docs.d-id.com/reference/agents
      */
     agent: Agent;
+    /**
+     * Get the current stream type of the agent
+     */
+    getStreamType: () => StreamType;
     /**
      * Array of starter messages that will be sent to the agent when the chat starts
      */
@@ -172,7 +186,7 @@ export interface AgentManager {
      * Method to make your agent read the text you provide or reproduce sound
      * @param payload
      */
-    speak: (payload: SupportedStreamScipt | string) => Promise<SendStreamPayloadResponse>;
+    speak: (payload: SupportedStreamScript | string) => Promise<SendStreamPayloadResponse>;
     /**
      * Method to change the mode of the chat
      * @param mode - ChatMode

package/dist/src/types/stream/api/clip.d.ts

@@ -117,5 +117,6 @@ export interface SendClipStreamPayload extends StickyRequest {
      * @example "https://path.to.directory/"
      */
     raw_result_url?: string;
+    metadata: Record<string, any>;
 }
 export {};

package/dist/src/types/stream/rtc.d.ts

@@ -33,6 +33,7 @@ export interface ICreateStreamRequestResponse extends StickyRequest {
     jsep: Jsep;
     offer: any;
     ice_servers: IceServer[];
+    fluent?: boolean;
 }
 export interface IceCandidate {
     /**

package/dist/src/types/stream/stream.d.ts

@@ -9,6 +9,16 @@ export declare enum StreamingState {
     Start = "START",
     Stop = "STOP"
 }
+export declare enum ConnectivityState {
+    Strong = "STRONG",
+    Weak = "WEAK",
+    Unknown = "UNKNOWN"
+}
+export declare enum AgentActivityState {
+    Idle = "IDLE",
+    Talking = "TALKING"
+}
+export declare const DataChannelSignalMap: Record<string, StreamingState>;
 export declare enum StreamEvents {
     ChatAnswer = "chat/answer",
     ChatPartial = "chat/partial",
@@ -31,12 +41,18 @@ export declare enum ConnectionState {
     Completed = "completed",
     Disconnected = "disconnected"
 }
+export declare enum StreamType {
+    Legacy = "legacy",
+    Fluent = "fluent"
+}
 export interface ManagerCallbacks {
     onMessage?: (event: string, data: string) => void;
     onConnectionStateChange?: (state: ConnectionState) => void;
     onVideoStateChange?: (state: StreamingState, report?: VideoRTCStatsReport) => void;
     onSrcObjectReady?: (value: MediaStream) => void;
     onError?: (error: Error, errorData: object) => void;
+    onConnectivityStateChange?: (state: ConnectivityState) => void;
+    onAgentActivityStateChange?: (state: AgentActivityState) => void;
 }
 export type ManagerCallbackKeys = keyof ManagerCallbacks;
 export interface TalkStreamOptions extends CreateTalkStreamRequest {
@@ -60,7 +76,6 @@ export interface StreamingManagerOptions {
     callbacks: ManagerCallbacks;
     baseURL?: string;
     debug?: boolean;
-    warmup?: boolean;
     auth: Auth;
     analytics: Analytics;
 }
@@ -77,6 +92,8 @@ export interface SlimRTCStatsReport {
     framesDecoded: any;
     jitter: any;
     jitterBufferDelay: number;
+    jitterBufferEmittedCount: number;
+    avgJitterDelayInInterval: number;
     frameWidth: any;
     frameHeight: any;
     framesPerSecond: any;
@@ -94,6 +111,8 @@ export interface AnalyticsRTCStatsReport {
     framesDecoded: number;
     jitter: number;
     jitterBufferDelay: number;
+    jitterBufferEmittedCount: number;
+    avgJitterDelayInInterval: number;
     framesPerSecond: number;
     freezeCount: number;
     freezeDuration: number;

package/dist/src/types/stream-script.d.ts

@@ -50,4 +50,4 @@ export interface Stream_LLM_Script {
     stream_audio?: boolean;
 }
 export type StreamScript = Stream_Text_Script | Stream_Audio_Script | Stream_LLM_Script;
-export type SupportedStreamScipt = Stream_Text_Script | Stream_Audio_Script;
+export type SupportedStreamScript = Stream_Text_Script | Stream_Audio_Script;

package/dist/src/utils/analytics.d.ts

@@ -10,4 +10,6 @@ export declare function getAnalyticsInfo(agent: Agent): {
         provider: import('../types/index').Providers | undefined;
     };
 };
+export declare const sumFunc: (numbers: number[]) => number;
+export declare const average: (numbers: number[]) => number;
 export declare function getStreamAnalyticsProps(data: any, agent: Agent, additionalProps: Record<string, any>): any;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@d-id/client-sdk",
     "private": false,
-    "version": "1.1.0-beta.1",
+    "version": "1.1.0-beta.3",
     "type": "module",
     "description": "d-id client sdk",
     "repository": {
@@ -45,4 +45,4 @@
         "vite": "^5.1.4",
         "vite-plugin-dts": "^3.7.3"
     }
-}
+}