@d-id/client-sdk 3.0.0-staging.414 → 3.0.0-staging.415

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

@@ -1,64 +0,0 @@
-import { AgentManager, AgentManagerOptions, Chat, ChatMode, CreateStreamOptions, Message } from '../../types';
-import { SocketManager } from '../socket-manager';
-import { StreamingManager } from '../streaming-manager';
-
-/**
- * Mutable state shared between the agent manager's connect/chat/stream helpers.
- * @internal Implementation type; not part of the public SDK surface.
- */
-export interface AgentManagerItems {
-    chat?: Chat;
-    streamingManager?: StreamingManager<CreateStreamOptions>;
-    socketManager?: SocketManager;
-    messages: Message[];
-    chatMode: ChatMode;
-}
-/**
- * Creates an {@link AgentManager} for one agent: its chat, its video stream and its connections.
- *
- * Fetches the agent from the Agents API before it resolves, so the returned manager already has
- * {@link AgentManager.agent | agent} and {@link AgentManager.starterMessages | starterMessages}
- * filled in. No stream is opened until {@link AgentManager.connect | connect()} is called.
- * {@link AgentManagerOptions.callbacks | callbacks} must include
- * {@link AgentManagerCallbacks.onSrcObjectReady | onSrcObjectReady}, which is what attaches the
- * streamed media to a video element.
- *
- * One option is checked here: an Expressive (V4) agent asked for {@link ChatMode.Off} or
- * {@link ChatMode.DirectPlayback}, which only Talks (V2) and Clips (V3) agents support, rejects
- * with a {@link ValidationError}. Every other bad argument surfaces later, as a
- * {@link ValidationError} rejected by the method that was called on the returned manager, such as
- * {@link AgentManager.chat | chat()} or {@link AgentManager.speak | speak()}.
- *
- * @param agent - Id of the agent to talk to: the `data-agent-id` from its Embed snippet, or the `id`
- * returned by the Agents API.
- * @param options - Credentials, callbacks and everything else the manager needs. See
- * {@link AgentManagerOptions}.
- * @returns A manager for that agent, ready to {@link AgentManager.connect | connect()}.
- * @throws {@link ValidationError} When an Expressive (V4) agent is created with
- * {@link ChatMode.Off} or {@link ChatMode.DirectPlayback}.
- * @throws {@link HttpError} When the agent cannot be fetched — an unknown id, or a client key that
- * is not authorized for the agent or the calling domain.
- * @throws {@link NetworkError} When the request for the agent never reaches the server: the browser
- * is offline, DNS or TLS fails, or the request is blocked.
- *
- * @example
- * ```ts
- * import * as sdk from '@d-id/client-sdk';
- *
- * const agentManager = await sdk.createAgentManager('agt_fumf1234', {
- *     auth: { type: 'key', clientKey: 'YOUR_CLIENT_KEY' },
- *     callbacks: {
- *         // Required: hand the streamed media to your video element.
- *         onSrcObjectReady(value) {
- *             videoElement.srcObject = value;
- *         },
- *     },
- * });
- *
- * await agentManager.connect();
- * await agentManager.chat('What is the distance to the moon?');
- * ```
- *
- * @category Agent Manager
- */
-export declare function createAgentManager(agent: string, options: AgentManagerOptions): Promise<AgentManager>;

package/dist/src/services/agent-manager/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/services/analytics/mixpanel.d.ts

@@ -1,22 +0,0 @@
-export interface AnalyticsOptions {
-    token: string;
-    agentId: string;
-    isEnabled?: boolean;
-    externalId?: string;
-    mixpanelAdditionalProperties?: Record<string, any>;
-}
-export interface Analytics {
-    token: string;
-    distinct_id?: string;
-    isEnabled: boolean;
-    chatId?: string;
-    agentId: string;
-    owner_id?: string;
-    getRandom(): string;
-    track(event: string, props?: Record<string, any>, eventTimestamp?: number): Promise<any>;
-    linkTrack(mixpanelEvent: string, props: Record<string, any>, event: string, dependencies: string[]): any;
-    enrich(props: Record<string, any>): void;
-    additionalProperties: Record<string, any>;
-}
-export declare function _resetOfflineBufferForTests(): void;
-export declare function initializeAnalytics(config: AnalyticsOptions): Analytics;

package/dist/src/services/analytics/mixpanel.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/services/analytics/timestamp-tracker.d.ts

@@ -1,15 +0,0 @@
-export declare const latencyTimestampTracker: {
-    reset: () => number;
-    update: () => number;
-    get: (delta?: boolean) => number;
-};
-export declare const interruptTimestampTracker: {
-    reset: () => number;
-    update: () => number;
-    get: (delta?: boolean) => number;
-};
-export declare const streamReadyTimestampTracker: {
-    reset: () => number;
-    update: () => number;
-    get: (delta?: boolean) => number;
-};

package/dist/src/services/chat/index.d.ts

@@ -1,10 +0,0 @@
-import { Agent, AgentsAPI, Chat, ChatMode } from '../../types';
-import { Analytics } from '../analytics/mixpanel';
-
-export declare function getRequestHeaders(chatMode?: ChatMode): {
-    headers?: Record<string, string>;
-};
-export declare function createChat(agent: Agent, agentsApi: AgentsAPI, analytics: Analytics, chatMode?: ChatMode, persist?: boolean, chat?: Chat): Promise<{
-    chat: Chat | undefined;
-    chatMode: ChatMode | undefined;
-}>;

package/dist/src/services/chat/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/services/chat/intial-messages.d.ts

@@ -1,3 +0,0 @@
-import { Message } from '../../types';
-
-export declare function getInitialMessages(initialMessages?: Message[]): Message[];

package/dist/src/services/chat/intial-messages.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,12 +0,0 @@
-import { ChatProgressCallback } from '../../types';
-import { Auth } from '../../types/auth';
-
-export interface SocketManager {
-    socket?: WebSocket;
-    disconnect: () => void;
-    subscribeToEvents: (data: any) => void;
-}
-export declare function createSocketManager(auth: Auth, host: string, callbacks: {
-    onMessage: ChatProgressCallback;
-    onError?: (error: Error) => void;
-}, externalId?: string): Promise<SocketManager>;

package/dist/src/services/socket-manager/message-queue.d.ts

@@ -1,12 +0,0 @@
-import { Agent, AgentManagerOptions, ChatProgress, StreamEvents } from '../../types';
-import { AgentManagerItems } from '../agent-manager';
-import { Analytics } from '../analytics/mixpanel';
-
-export interface ChatEventQueue {
-    [sequence: number]: string;
-    answer?: string;
-}
-export declare function createMessageEventQueue(analytics: Analytics, items: AgentManagerItems, options: AgentManagerOptions, agentEntity: Agent, onStreamDone: (reason?: string) => void): {
-    clearQueue: () => void;
-    onMessage: (event: ChatProgress | StreamEvents, data: any) => void;
-};

package/dist/src/services/socket-manager/message-queue.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/services/streaming-manager/advanced.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/services/streaming-manager/business-flows.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Business flow tests for streaming manager
- * Tests critical end-to-end workflows and configurations
- */
-export {};

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

@@ -1,101 +0,0 @@
-import { CreateSessionV2Options, CreateStreamOptions, InterruptOptions, PayloadType, StreamType } from '../../types';
-import { InternalDataChannelTopic } from '../../types/stream/data-channel';
-
-export declare const createStreamingLogger: (debug: boolean, prefix: string) => (message: string, extra?: any) => false | void;
-/**
- * Shared type for all streaming managers (LiveKit, WebRTC, etc.)
- * This type represents the return value of any streaming manager implementation
- */
-export type StreamingManager<T extends CreateStreamOptions | CreateSessionV2Options> = {
-    /**
-     * Method to send request to server to get clip or talk depending on payload
-     * @param payload The payload to send to the streaming service
-     */
-    speak(payload: PayloadType<T>): Promise<any>;
-    /**
-     * Method to close the streaming connection
-     */
-    disconnect(): Promise<void>;
-    /**
-     * The single send primitive: every message leaving the client goes out through here.
-     * V2 routes on the topic; V1 has no topic concept and ignores it.
-     * The promise tracks the send attempt and never rejects - failures go to `callbacks.onError`.
-     * @param topic Data-channel topic to send on
-     * @param payload The message payload to send, already serialized
-     */
-    sendDataChannelMessage(topic: InternalDataChannelTopic, payload: string): Promise<void>;
-    /**
-     * Publish a microphone stream to the DataChannel
-     * Can be called after connection to add microphone input
-     * @param stream The MediaStream containing the microphone audio track
-     * supported only for livekit manager
-     */
-    publishMicrophoneStream?(stream: MediaStream): Promise<void>;
-    /**
-     * Unpublish the currently published microphone stream
-     * Can be called after connection to remove microphone input
-     * supported only for livekit manager
-     */
-    unpublishMicrophoneStream?(): Promise<void>;
-    /**
-     * Replace the currently published microphone MediaStreamTrack without
-     * unpublishing. Preserves the LiveKit publication (SSRC, trackSid) so the
-     * server sees continuous audio. Resolves once LiveKit has switched the
-     * underlying RTCRtpSender's track. Rejects if no publication exists —
-     * caller should fall back to `publishMicrophoneStream` in that case.
-     * supported only for livekit manager
-     */
-    replaceMicrophoneTrack?(track: MediaStreamTrack): Promise<void>;
-    /**
-     * Publish a camera video stream to the LiveKit room.
-     * Can be called after connection to enable vision.
-     * supported only for livekit manager
-     */
-    publishCameraStream?(stream: MediaStream): Promise<void>;
-    /**
-     * Unpublish the currently published camera stream.
-     * Can be called after connection to disable vision.
-     * supported only for livekit manager
-     */
-    unpublishCameraStream?(): Promise<void>;
-    /**
-     * Session identifier information, should be returned in the body of all streaming requests
-     */
-    sessionId: string;
-    /**
-     * Id of current streaming session
-     */
-    streamId: string;
-    /**
-     * Type of streaming implementation being used
-     */
-    streamType: StreamType;
-    /**
-     * Whether interrupt functionality is available for this stream
-     */
-    interruptAvailable: boolean;
-    /**
-     * Whether the current stream segment can be interrupted by the user
-     */
-    isInterruptible: boolean;
-    /**
-     * Send an interrupt for the current stream segment.
-     *
-     * Returns whether an interrupt was actually sent: `false` when there is nothing to interrupt
-     * (the stream does not support it, it is not a Fluent stream, no video is playing, or the
-     * interrupt type is one this transport drops), and `false` when the transport could not carry
-     * it because the connection or the data channel is not up.
-     */
-    interrupt(type: InterruptOptions['type']): boolean;
-    /**
-     * Register an RPC method handler on the LiveKit room.
-     * Used internally by the agent-manager for client tool delegation.
-     * supported only for livekit manager
-     */
-    registerRpcMethod?(method: string, handler: (data: any) => Promise<string>): void;
-    /**
-     * Unregister a previously registered RPC method.
-     * supported only for livekit manager
-     */
-    unregisterRpcMethod?(method: string): void;
-};

package/dist/src/services/streaming-manager/data-channel-handlers.d.ts

@@ -1,3 +0,0 @@
-import { ChatProgress } from '../../types/entities/agents/manager';
-
-export declare const chatEventMap: Record<string, ChatProgress>;

package/dist/src/services/streaming-manager/disconnect.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Disconnect and cleanup tests for streaming manager
- * Tests disconnection workflows, cleanup, and error handling
- */
-export {};

package/dist/src/services/streaming-manager/edge-cases.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,13 +0,0 @@
-import { Agent, CreateSessionV2Options, CreateStreamOptions, StreamingManagerOptions } from '../../types';
-import { StreamingManager } from './common';
-
-export declare enum StreamApiVersion {
-    V1 = "v1",
-    V2 = "v2"
-}
-export type ExtendedStreamOptions = ({
-    version: StreamApiVersion.V1;
-} & CreateStreamOptions) | ({
-    version: StreamApiVersion.V2;
-} & CreateSessionV2Options);
-export declare function createStreamingManager(agent: Agent, streamOptions: ExtendedStreamOptions, options: StreamingManagerOptions, signal?: AbortSignal): Promise<StreamingManager<CreateStreamOptions | CreateSessionV2Options>>;

package/dist/src/services/streaming-manager/factory.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,5 +0,0 @@
-export { StreamApiVersion as StreamApiVersion, createStreamingManager } from './factory';
-export type { ExtendedStreamOptions } from './factory';
-export type { StreamingManager } from './common';
-export type { LiveKitStreamingManager } from './livekit-manager';
-export * from './webrtc-manager';

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

@@ -1,10 +0,0 @@
-import { CreateSessionV2Options, CreateStreamOptions, StreamingManagerOptions } from '../../types';
-import { StreamingManager } from './common';
-
-export declare function handleInitError(error: unknown, log: (message?: any, ...optionalParams: any[]) => void, callbacks: StreamingManagerOptions['callbacks']): void;
-export declare function createLiveKitStreamingManager<T extends CreateSessionV2Options>(agentId: string, sessionOptions: CreateSessionV2Options, options: StreamingManagerOptions): Promise<StreamingManager<T> & {
-    reconnect(): Promise<void>;
-}>;
-export type LiveKitStreamingManager<T extends CreateStreamOptions> = StreamingManager<T> & {
-    reconnect(): Promise<void>;
-};

package/dist/src/services/streaming-manager/livekit-manager.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,3 +0,0 @@
-import { AvSyncReport, SlimRTCStatsReport } from '../../../types';
-
-export declare function buildAvSyncReport(stats: SlimRTCStatsReport[]): AvSyncReport | null;

package/dist/src/services/streaming-manager/stats/av-sync.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,16 +0,0 @@
-import { ConnectivityState, StreamingState } from '../../../types';
-import { VideoRTCStatsReport } from './report';
-
-export interface AudioArmContext {
-    sttLatency?: number;
-    serviceLatency?: number;
-}
-export declare function createAudioStatsDetector(getStats: () => Promise<RTCStatsReport | undefined>, onFirstAudioDetected: (context: AudioArmContext) => void): {
-    arm(context?: AudioArmContext): void;
-    destroy(): void;
-};
-export declare function createVideoStatsMonitor(getStats: () => Promise<RTCStatsReport | undefined>, getIsConnected: () => boolean, onConnected: () => void, onVideoStateChange?: (state: StreamingState, statsReport?: VideoRTCStatsReport) => void, onConnectivityStateChange?: (state: ConnectivityState) => void): {
-    start: () => void;
-    stop: () => void;
-    getReport: () => VideoRTCStatsReport | null;
-};

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

@@ -1,19 +0,0 @@
-import { AnalyticsRTCStatsReport, AvSyncReport, SlimRTCStatsReport } from '../../../types';
-
-export interface VideoRTCStatsReport {
-    webRTCStats: {
-        anomalies: AnalyticsRTCStatsReport[];
-        avSync: AvSyncReport | null;
-        aggregateReport: AnalyticsRTCStatsReport;
-        minRtt: number;
-        maxRtt: number;
-        avgRtt: number;
-        minJitterDelayInInterval: number;
-        maxJitterDelayInInterval: number;
-        avgJitterDelayInInterval: number;
-    };
-    codec: string;
-    resolution: string;
-}
-export declare function formatStats(stats: RTCStatsReport): SlimRTCStatsReport;
-export declare function createVideoStatsReport(stats: SlimRTCStatsReport[], interval: number, previousStats?: SlimRTCStatsReport): VideoRTCStatsReport | null;

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

@@ -1 +0,0 @@
-export {};

package/dist/src/services/streaming-manager/webrtc-core.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,12 +0,0 @@
-import { ConnectionState, CreateStreamOptions, StreamEvents, StreamingManagerOptions } from '../../types';
-import { createStreamingLogger, StreamingManager } from './common';
-
-type DataChannelPayload = string | Record<string, unknown>;
-export declare function mapConnectionState(state: RTCIceConnectionState): ConnectionState;
-export declare const createParseDataChannelMessage: (log: ReturnType<typeof createStreamingLogger>) => (message: string) => {
-    subject: StreamEvents;
-    data: DataChannelPayload;
-};
-export declare function createWebRTCStreamingManager<T extends CreateStreamOptions>(agentId: string, streamOptions: T, { debug, callbacks, auth, baseURL, analytics }: StreamingManagerOptions, signal?: AbortSignal): Promise<StreamingManager<T>>;
-export type WebRTCStreamingManager<T extends CreateStreamOptions> = StreamingManager<T>;
-export {};

package/dist/src/services/streaming-manager/webrtc-utils.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Utility function tests for streaming manager
- * Tests helper functions like mapConnectionState and parseDataChannelMessage
- */
-export {};

package/dist/src/test-utils/factories/agent-manager.factory.d.ts

@@ -1,3 +0,0 @@
-import { AgentManagerOptions } from '../../types';
-
-export declare const AgentManagerOptionsFactory: import('rosie').IFactory<AgentManagerOptions>;

package/dist/src/test-utils/factories/agent.factory.d.ts

@@ -1,4 +0,0 @@
-import { Agent } from '../../types';
-
-export declare const AgentFactory: import('rosie').IFactory<Agent>;
-export declare const StreamingAgentFactory: import('rosie').IFactory<any>;

package/dist/src/test-utils/factories/agents-api.factory.d.ts

@@ -1 +0,0 @@
-export declare const AgentsApiFactory: import('rosie').IFactory<any>;

package/dist/src/test-utils/factories/analytics.factory.d.ts

@@ -1 +0,0 @@
-export declare const AnalyticsFactory: import('rosie').IFactory<any>;

package/dist/src/test-utils/factories/chat.factory.d.ts

@@ -1 +0,0 @@
-export declare const ChatFactory: import('rosie').IFactory<any>;

package/dist/src/test-utils/factories/index.d.ts

@@ -1,8 +0,0 @@
-export { AgentManagerOptionsFactory } from './agent-manager.factory';
-export { AgentFactory, StreamingAgentFactory } from './agent.factory';
-export { AgentsApiFactory } from './agents-api.factory';
-export { AnalyticsFactory } from './analytics.factory';
-export { ChatFactory } from './chat.factory';
-export { SocketManagerFactory } from './socket-manager.factory';
-export { StreamApiFactory } from './stream-api.factory';
-export { StreamingManagerFactory, StreamingManagerOptionsFactory } from './streaming-manager.factory';

package/dist/src/test-utils/factories/socket-manager.factory.d.ts

@@ -1 +0,0 @@
-export declare const SocketManagerFactory: import('rosie').IFactory<any>;

package/dist/src/test-utils/factories/stream-api.factory.d.ts

@@ -1 +0,0 @@
-export declare const StreamApiFactory: import('rosie').IFactory<any>;

package/dist/src/test-utils/factories/streaming-manager.factory.d.ts

@@ -1,4 +0,0 @@
-import { StreamingManagerOptions } from '../../types';
-
-export declare const StreamingManagerFactory: import('rosie').IFactory<any>;
-export declare const StreamingManagerOptionsFactory: import('rosie').IFactory<StreamingManagerOptions>;

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

@@ -1,95 +0,0 @@
-/**
- * A bearer token for the Agents API.
- *
- * Account-wide, so it is meant for a trusted environment — a server, a build step, an internal
- * tool. Anyone who reads the token can spend the account's credits, so do not ship one in a page
- * you serve to users; use {@link ClientKeyAuth} there. The SDK sends it as
- * `Authorization: Bearer <token>~<connectionId>`, appending a per-connection id the D-ID
- * authorizer strips before it validates the token.
- *
- * @category Authentication
- */
-export interface BearerToken {
-    /**
-     * Discriminator selecting this variant of {@link Auth}.
-     */
-    type: 'bearer';
-    /**
-     * The bearer token itself, sent in the `Authorization` header.
-     */
-    token: string;
-}
-/**
- * HTTP basic credentials for the Agents API, given either pre-encoded or as a username and
- * password.
- *
- * Like {@link BearerToken} these are account-wide and belong in a trusted environment, never in a
- * client bundle. The SDK sends them as `Authorization: Basic <credentials>~<connectionId>`, where
- * the `token` form is used as the credentials as-is and the `username`/`password` form is
- * base64-encoded as `username:password` first; the trailing per-connection id is stripped by the
- * D-ID authorizer before the credentials are validated.
- *
- * @category Authentication
- */
-export type BasicAuth = {
-    /**
-     * Discriminator selecting this variant of {@link Auth}.
-     */
-    type: 'basic';
-    /**
-     * Credentials that are already base64-encoded, as `username:password`. Used as they
-     * are, so they are not encoded a second time.
-     */
-    token: string;
-} | {
-    /**
-     * Discriminator selecting this variant of {@link Auth}.
-     */
-    type: 'basic';
-    /**
-     * The account's user name; base64-encoded with the password before it is sent.
-     */
-    username: string;
-    /**
-     * The account's password; base64-encoded with the user name before it is sent.
-     */
-    password: string;
-};
-/**
- * A client key for the Agents API — the credential to use in a browser.
- *
- * This is the one shape that is safe to ship in a page: a client key is scoped to a single agent
- * and only works from the domains allowed for it, so it cannot be reused elsewhere. Copy it from the
- * agent's Embed snippet, where it appears as `data-client-key`, or create one with the Agents API
- * (see the link below). The SDK sends it
- * as `Authorization: Client-Key <clientKey>.<externalId>_<connectionId>`, where the external id is
- * either {@link AgentManagerOptions.externalId | externalId} or a per-browser id the SDK keeps in
- * `localStorage`.
- *
- * @see [Create a client key](https://docs.d-id.com/reference/createclientkey)
- * @category Authentication
- */
-export interface ClientKeyAuth {
-    /**
-     * Discriminator selecting this variant of {@link Auth}.
-     */
-    type: 'key';
-    /**
-     * The client key: the `data-client-key` value from the agent's Embed snippet, or a key created with
-     * the Agents API.
-     */
-    clientKey: string;
-}
-/**
- * The credentials {@link createAgentManager} accepts, as
- * {@link AgentManagerOptions.auth | options.auth}.
- *
- * Pick {@link ClientKeyAuth} (`{ type: 'key', clientKey }`) for anything that runs in a browser: it
- * is the only variant scoped to one agent and to the domains you allowed. {@link BearerToken} and
- * {@link BasicAuth} carry account-wide credentials and belong in a trusted environment. Whichever
- * you pass is used for every request the SDK makes — the REST calls, the video stream and the
- * notifications web socket.
- *
- * @category Authentication
- */
-export type Auth = BearerToken | BasicAuth | ClientKeyAuth;