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

package/dist/src/types/entities/avatar.d.ts

@@ -1,21 +0,0 @@
-/**
- * The kind of avatar an agent is built on, which is what decides how its video is produced.
- *
- * It is the `type` of the agent's avatar ({@link Agent.avatar}) and so determines which SDK
- * features a session has: {@link AvatarType.Talk | talk} is Talks (V2),
- * {@link AvatarType.Clip | clip} is Clips (V3), and {@link AvatarType.Expressive | expressive} is
- * Expressive (V4).
- *
- * @category Agent Manager
- */
-export declare enum AvatarType {
-    /** A Clips (V3) agent: a pre-recorded presenter, driven by the D-ID Clips pipeline. */
-    Clip = "clip",
-    /** A Talks (V2) agent: a still photo animated to speak. */
-    Talk = "talk",
-    /**
-     * An Expressive (V4) avatar: a real-time avatar that also supports microphone and camera
-     * publishing, client tools and interruption.
-     */
-    Expressive = "expressive"
-}

package/dist/src/types/entities/index.d.ts

@@ -1,3 +0,0 @@
-export * from './agents';
-export * from './avatar';
-export * from './knowledge';

package/dist/src/types/entities/knowledge/document.d.ts

@@ -1,31 +0,0 @@
-import { DocumentType, KnowledgeType } from './knowledge';
-
-/**
- * Lifecycle status of a document, as served by the knowledge API. The API stores the
- * status as a prefixed event subject (`document/done`) but strips the prefix on read,
- * so the wire value is always bare.
- * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
- */
-export type DocumentStatus = 'created' | 'processed' | 'done' | 'rejected' | 'error';
-/**
- * A document as returned by the Knowledge API.
- * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
- */
-export interface DocumentData {
-    created_at: string;
-    modified_at: string;
-    owner_id: string;
-    id: string;
-    created_by: string;
-    status: DocumentStatus;
-    documentType: DocumentType;
-    type: KnowledgeType;
-    source_url: string;
-    parsed_url: string;
-    title: string;
-}
-/**
- * Request payload for creating a document, derived from `DocumentData`.
- * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
- */
-export type CreateDocumentPayload = Omit<DocumentData, 'created_by' | 'parsed_url' | 'status' | 'type' | 'created_at' | 'modified_at' | 'id' | 'owner_id'>;

package/dist/src/types/entities/knowledge/index.d.ts

@@ -1,4 +0,0 @@
-export * from './document';
-export * from './knowledge';
-export * from './record';
-export * from './retrival';

package/dist/src/types/entities/knowledge/knowledge.d.ts

@@ -1,56 +0,0 @@
-/**
- * Kind of a knowledge entity as stored by the Knowledge API.
- * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
- */
-export declare enum KnowledgeType {
-    Knowledge = "knowledge",
-    Document = "document",
-    Record = "record"
-}
-/**
- * File format of a document ingested into the Knowledge API.
- * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
- */
-export declare enum DocumentType {
-    Pdf = "pdf",
-    Text = "text",
-    Html = "html",
-    Word = "word",
-    Json = "json",
-    Markdown = "markdown",
-    Csv = "csv",
-    Excel = "excel",
-    Powerpoint = "powerpoint",
-    Archive = "archive",
-    Image = "image",
-    Audio = "audio",
-    Video = "video"
-}
-/**
- * Result of parsing a document's raw content for the Knowledge API.
- * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
- */
-export interface IParserResult {
-    data: string;
-}
-/**
- * A knowledge entity as returned by the Knowledge API.
- * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
- */
-export interface KnowledgeData {
-    created_at: string;
-    modified_at: string;
-    owner_id: string;
-    id: string;
-    created_by: string;
-    type: KnowledgeType;
-    vector_store: string;
-    description: string;
-    name: string;
-    starter_message?: string[];
-}
-/**
- * Request payload for creating a knowledge entity, derived from `KnowledgeData`.
- * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
- */
-export type KnowledgePayload = Omit<KnowledgeData, 'created_by' | 'type' | 'created_at' | 'modified_at' | 'id' | 'owner_id'>;

package/dist/src/types/entities/knowledge/record.d.ts

@@ -1,24 +0,0 @@
-import { KnowledgeType } from './knowledge';
-
-/**
- * A record (chunk of a document) as returned by the Knowledge API.
- * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
- */
-export interface RecordData {
-    created_at: string;
-    modified_at: string;
-    owner_id: string;
-    id: string;
-    created_by: string;
-    type: KnowledgeType;
-    embedding_id: string;
-    start_index: number;
-    source_url: string;
-    title: string;
-    data: string;
-}
-/**
- * Request payload for creating a record, derived from `RecordData`.
- * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
- */
-export type CreateRecordPayload = Omit<RecordData, 'created_by' | 'type' | 'created_at' | 'modified_at' | 'id' | 'owner_id'>;

package/dist/src/types/entities/knowledge/retrival.d.ts

@@ -1,9 +0,0 @@
-/**
- * Result of a knowledge-base query against the Knowledge API.
- * @internal The SDK exposes no knowledge methods; manage knowledge through the D-ID API.
- */
-export interface QueryResult {
-    documentIds: string[];
-    result: any;
-    matches: any;
-}

package/dist/src/types/face-rect.d.ts

@@ -1,6 +0,0 @@
-export interface Rect {
-    top: number;
-    left: number;
-    bottom: number;
-    right: number;
-}

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

@@ -1,6 +0,0 @@
-export * from './auth';
-export * from './entities';
-export * from './stream';
-export * from './stream-script';
-export * from './voice/stt';
-export * from './voice/tts';

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

@@ -1,122 +0,0 @@
-import { StickyRequest, StreamScript } from '../..';
-import { CompatibilityMode } from '../stream';
-
-interface Logo {
-    /**
-     * https url to an ARGB jpg/png image, a default logo is used otherwise
-     * @pattern ((https|s3):\/\/.+) must be a valid https URL
-     * @example https://url.to/image.png
-     */
-    url: string;
-    /**
-     * position of the logo in pixels from the top left corner (w,h) negative values are subtracted from last pixel
-     * @example [0, 500]
-     * @minItems 2
-     * @maxItems 2
-     * @isInt
-     */
-    position: number[];
-}
-interface ClipConfig {
-    logo?: Logo | boolean;
-    /** File format of the animated result
-     * @default mp4
-     */
-    result_format?: 'mp4' | 'gif' | 'mov' | 'webm';
-}
-/**
- * Wire request body for creating a clip stream.
- * @internal Wire type of the streaming transport; not part of the public SDK surface.
- */
-export interface CreateClipStreamRequest {
-    /**
-     * Defines the video codec to be used in the stream.
-     * When set to on: VP8 will be used.
-     * When set to off: H264 will be used
-     * When set to auto the codec will be selected according to the browser.
-     * @default auto
-     */
-    compatibility_mode?: CompatibilityMode;
-    /**
-     * Whether to stream wamrup video on the connection.
-     * If set to true, will stream a warmup video when connection is established.
-     * At the end of the warmup video, a message containing "stream/ready" will be sent on the data channel.
-     */
-    stream_warmup?: boolean;
-    /**
-     * Maximum duration (in seconds) between messages before session times out.
-     * Can only be used with proper permissions
-     * @maximum 300
-     * @example 180
-     */
-    session_timeout?: number;
-}
-/**
- * Wire payload sent to advance a clip stream with a new script.
- * @internal Wire type of the streaming transport; not part of the public SDK surface.
- */
-export interface SendClipStreamPayload extends StickyRequest {
-    script: StreamScript;
-    /**
-     * Advanced configuration options.
-     */
-    config?: ClipConfig;
-    /**
-     * The user created the clip.
-     */
-    created_by?: string;
-    /**
-     * Advanced presenter configuration options.
-     */
-    presenter_config?: {
-        crop?: {
-            /**
-             * The type of the crop.
-             */
-            type: 'rectangle';
-            /**
-             * A set of numbers between 0 and 1 representing the top, left, right and bottom of the crop.
-             * Each number correlates to the distance from the top left corner of the image, relative the the image width.
-             * For example, right: 0.75 means that the right side of the crop is 75% of the image width from the left side.
-             */
-            rectangle: {
-                top: number;
-                left: number;
-                right: number;
-                bottom: number;
-            };
-        };
-    };
-    /**
-     * Background color of the clip result
-     */
-    background?: {
-        /**
-         * Background color of the animated result, or false to use transparent background in-case of webm result format.
-         * @example "#47ffff"
-         * @pattern ^#[a-fA-F0-9]{6}$ must be a valid 6-characters long color css code
-         */
-        color?: string | false;
-    };
-    /**
-     * Non-sensitive custom data that will be added to the clip response and webhook.
-     */
-    user_data?: string;
-    /**
-     * The name of the clip
-     */
-    name?: string;
-    /**
-     * The URL of the clip video, if not provided use default destination.
-     * @example "https://path.to.directory/"
-     */
-    result_url?: string;
-    /**
-     * The URL of the raw clip video, if not provided use default destination.
-     * @hidden
-     * @example "https://path.to.directory/"
-     */
-    raw_result_url?: string;
-    metadata: Record<string, any>;
-}
-export {};

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

@@ -1,2 +0,0 @@
-export * from './clip';
-export * from './talk';

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

@@ -1,77 +0,0 @@
-import { StreamScript } from '../..';
-import { CompatibilityMode } from '../stream';
-
-/**
- * Wire request body for creating a legacy (talk) stream.
- * @internal Wire type of the streaming transport; not part of the public SDK surface.
- */
-export interface CreateTalkStreamRequest {
-    driver_url?: string;
-    face?: {
-        size: number;
-        top_left: [number, number];
-        overlap?: 'NO' | 'YES' | 'PARTIAL' | 'UNKNOWN';
-        face_id?: string;
-        detect_confidence?: number;
-        detection?: {
-            top: number;
-            left: number;
-            right: number;
-            bottom: number;
-        };
-    };
-    config?: {
-        motion_factor?: number;
-        align_expand_factor?: number;
-        stitch?: boolean;
-    };
-    /**
-     * Defines the video codec to be used in the stream.
-     * When set to on: VP8 will be used.
-     * When set to off: H264 will be used
-     * When set to auto the codec will be selected according to the browser.
-     * @default auto
-     */
-    compatibility_mode?: CompatibilityMode;
-    /**
-     * Whether to stream wamrup video on the connection.
-     * If set to true, will stream a warmup video when connection is established.
-     * At the end of the warmup video, a message containing "stream/ready" will be sent on the data channel.
-     */
-    stream_warmup?: boolean;
-    /**
-     * Maximum duration (in seconds) between messages before session times out.
-     * Can only be used with proper permissions
-     * @maximum 300
-     * @example 180
-     */
-    session_timeout?: number;
-}
-/**
- * Wire payload sent to advance a talk stream with a new script.
- * @internal Wire type of the streaming transport; not part of the public SDK surface.
- */
-export interface SendTalkStreamPayload {
-    script: StreamScript;
-    resultUrl?: string;
-    config?: {
-        align_driver?: boolean;
-        auto_match?: boolean;
-        normalization_factor?: number;
-        sharpen?: boolean;
-        result_format?: 'mp4' | 'gif' | 'mov';
-        fluent?: boolean;
-        driver_expressions?: {
-            expressions: {
-                start_frame: number;
-                expression: string;
-                intensity: number;
-            };
-            transition_frames?: number;
-        };
-    };
-    user_data?: Record<string, any>;
-    name?: string;
-    audio_optimization?: number;
-    metadata: Record<string, any>;
-}

package/dist/src/types/stream/data-channel.d.ts

@@ -1,16 +0,0 @@
-/**
- * Data-channel topics messages can be sent on.
- * V2 (LiveKit) routes by topic; V1 (WebRTC) has no topic concept and ignores it.
- *
- * Internal on purpose: this module is deliberately left out of the `stream`
- * barrel so the topics driven by dedicated methods (`chat`, `speak`,
- * `interrupt`, `setSttLanguage`) never reach the package's public API.
- * Customers get the public `DataChannelTopic` enum instead.
- */
-export declare enum InternalDataChannelTopic {
-    Chat = "lk.chat",
-    Speak = "did.speak",
-    Interrupt = "did.interrupt",
-    SttLanguage = "did.stt-language",
-    Presentation = "did.presentation"
-}

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

@@ -1,4 +0,0 @@
-export * from './api';
-export * from './rtc';
-export * from './stream';
-export * from './streams-v2';

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

@@ -1,125 +0,0 @@
-/**
- * Carrier of the `session_id` that keeps successive streaming requests on the same server session.
- * @internal Wire type of the streaming transport; not part of the public SDK surface.
- */
-export interface StickyRequest {
-    session_id?: string;
-}
-interface Jsep {
-    /**
-     * The type of the message - should normally be `answer` when replying to the offer
-     */
-    type: 'offer' | 'answer';
-    /**
-     * Describe the media communication sessions to accept the session the is being negotiated
-     */
-    sdp: string;
-}
-/**
- * STUN/TURN server credentials returned by the Agents API for establishing the WebRTC connection.
- * @internal Wire type of the streaming transport; not part of the public SDK surface.
- */
-export interface IceServer {
-    /**
-     * URL of the server - can be multiple addresses
-     */
-    urls: string[] | string;
-    /**
-     * Username for authentication
-     */
-    username?: string;
-    /**
-     * Credintials for secure connection to the server
-     */
-    credential?: string;
-}
-/**
- * Response of `POST /agents/{id}/streams`: the SDP offer and ICE servers for the WebRTC handshake.
- * @internal Wire type of the streaming transport; not part of the public SDK surface.
- */
-export interface ICreateStreamRequestResponse extends StickyRequest {
-    id: string;
-    jsep: Jsep;
-    offer: any;
-    ice_servers: IceServer[];
-    fluent?: boolean;
-    interrupt_enabled?: boolean;
-}
-/**
- * A single ICE candidate exchanged during the WebRTC connection handshake.
- * @internal Wire type of the streaming transport; not part of the public SDK surface.
- */
-export interface IceCandidate {
-    /**
-     * A string representing the transport address for the candidate that can be used for connectivity checks.
-     * The format of this address is a candidate-attribute as defined in RFC 5245. This string is empty ("") if the
-     * RTCIceCandidate is an "end of candidates" indicator.
-     */
-    candidate: string | null;
-    /**
-     * A string specifying the candidate's media stream identification tag which uniquely identifies the media stream
-     * within the component with which the candidate is associated, or null if no such association exists.
-     */
-    sdpMid?: string;
-    /**
-     * If not null, sdpMLineIndex indicates the zero-based index number of the media description (as defined in RFC
-     * 4566) in the SDP with which the candidate is associated.
-     */
-    sdpMLineIndex?: number;
-}
-/**
- * Bare `{ status }` envelope returned by the streaming endpoints that report only success or failure.
- * @internal Wire type of the streaming transport; not part of the public SDK surface.
- */
-export interface Status {
-    status: string;
-}
-/**
- * What {@link AgentManager.speak | speak()} resolves with: the video the agent is about to stream.
- *
- * The fields come from the Talks (V2) and Clips (V3) API, which generates a discrete video while
- * answering the request. Where no such video exists the call still resolves, with the same stub —
- * `status` `'success'`, `duration` `0` and an empty `videoId`: on Expressive (V4) agents, whose
- * speech is streamed over the data channel rather than rendered as a separate video, and in a
- * text-only chat mode ({@link ChatMode.TextOnly}, {@link ChatMode.Playground} or
- * {@link ChatMode.Maintenance}), which produces no video at all.
- *
- * @category Speak & Scripts
- */
-export interface SpeakResponse {
-    /**
-     * Whether the server accepted the speak request — `'success'` when it did.
-     */
-    status: string;
-    /**
-     * Id of the session this call was made on; the SDK sends it back on later streaming requests.
-     */
-    sessionId?: string;
-    /**
-     * Duration of the generated video as reported by the Agents API for Talks (V2) and Clips (V3)
-     * agents. `0` when the call produced no discrete video — on Expressive (V4) agents, and in a
-     * text-only chat mode.
-     */
-    duration: number;
-    /**
-     * Id of the generated video.
-     *
-     * Use it to correlate this call with the video the agent then plays, which
-     * {@link AgentManagerCallbacks.onVideoStateChange | onVideoStateChange} reports the start and
-     * end of, and which {@link AgentManager.interrupt | interrupt()} cancels. Empty when the call
-     * produced no discrete video — on Expressive (V4) agents, and in a text-only chat mode.
-     */
-    videoId: string;
-}
-/**
- * What the Agents API answers a speak request with, converted to {@link SpeakResponse} before it
- * reaches the application.
- * @internal Wire type of the streaming transport; not part of the public SDK surface.
- */
-export interface SpeakWireResponse {
-    status: string;
-    session_id?: string;
-    duration: number;
-    video_id: string;
-}
-export {};