@vonage/client-sdk 1.2.1 → 1.3.0-alpha.1

package/dist/coreExtend.d.ts

@@ -6,7 +6,7 @@ declare module './kotlin/clientsdk-clientcore_js' {
              * Mute your leg of a call
              *
              * @example
-             * [[include: snippet_CallMute.txt]]
+             * [[include: snippet_Mute.txt]]
              *
              * @param callId - Call ID
              * @returns void
@@ -24,7 +24,7 @@ declare module './kotlin/clientsdk-clientcore_js' {
              * Earmuff your leg of a call
              *
              * @example
-             * [[include: snippet_EarmuffEvent.txt]]
+             * [[include: snippet_EnableEarmuff.txt]]
              *
              * @param callId - Call ID
              * @returns void
@@ -33,6 +33,10 @@ declare module './kotlin/clientsdk-clientcore_js' {
             enableEarmuff(callId: string): Promise<void>;
             /**
              * Unearmuff your leg of a call
+             *
+             * @example
+             * [[include: snippet_DisableEarmuff.txt]]
+             *
              * @param callId - Call ID
              * @returns void
              * @group Voice
@@ -42,7 +46,7 @@ declare module './kotlin/clientsdk-clientcore_js' {
              * Send a string of digits to a call via DTMF
              *
              * @example
-             * [[include: snippet_SendDtmfDigits.txt]]
+             * [[include: snippet_Dtmf.txt]]
              *
              * @param callId - Call ID
              * @param digits - DTMF digits

package/dist/kotlin/clientsdk-clientcore_js.d.ts

@@ -12,6 +12,7 @@ export declare namespace vonage {
         callMediaReconnecting(callId: string): void;
         callMediaReconnection(callId: string): void;
         callMediaDisconnect(callId: string, reason: vonage.CallDisconnectReasonJS): void;
+        rtcStatsUpdate(rtcStats: vonage.RTCStatsJS, legId: string): void;
         reconnecting(): void;
         reconnection(): void;
         sessionError(reason: vonage.SessionErrorReasonJS): void;
@@ -20,12 +21,12 @@ export declare namespace vonage {
 }
 export declare namespace vonage {
     class CombinedClientJS implements vonage.IChatClientJS, vonage.IVoiceClientJS {
-        constructor(http: vonage.HttpClientJS, socket: vonage.SocketClientJS, media: vonage.MediaClientJS);
+        constructor(config: vonage.InitConfigObjectJS, http: vonage.HttpClientJS, socket: vonage.SocketClientJS, media: vonage.MediaClientJS);
         get media(): vonage.MediaClientJS;
         get core(): any/* com.vonage.clientcore.core.CoreClientWithMedia */;
         get emitter(): Nullable<vonage.CombinedEvents>;
         set emitter(value: Nullable<vonage.CombinedEvents>);
-        createConversation(name: Nullable<string>, displayName: Nullable<string>): Promise<string>;
+        createConversation(parameters: Nullable<vonage.CreateConversationParametersJS>): Promise<string>;
         joinConversation(cid: string): Promise<string>;
         inviteToConversation(cid: string, username: string): Promise<string>;
         leaveConversation(cid: string): Promise<any>;
@@ -36,7 +37,8 @@ export declare namespace vonage {
         getConversationMember(cid: string, mid: string): Promise<vonage.MemberJS>;
         sendMessageTextEvent(cid: string, text: string): Promise<string>;
         sendMessageCustomEvent(cid: string, customData: string): Promise<string>;
-        sendEphemeralEvent(cid: string, customBody: string): Promise<string>;
+        sendMessageImageEvent(cid: string, imageURL: URL): Promise<string>;
+        sendEphemeralEvent(cid: string, customData: string): Promise<string>;
         deleteEvent(id: number, conversationId: string): Promise<any>;
         setConfig(config: vonage.ConfigObjectJS): void;
         createSession(token: string, sessionId: Nullable<string>): Promise<string>;
@@ -424,8 +426,15 @@ export declare namespace vonage {
         get displayName(): Nullable<string>;
         get imageUrl(): Nullable<string>;
         get state(): Nullable<string>;
-        get customData(): Nullable<string>;
-        get customSortKey(): Nullable<string>;
+        get properties(): vonage.ConversationJS.Properties;
+    }
+    namespace ConversationJS {
+        class Properties {
+            private constructor();
+            get ttl(): Nullable<number>;
+            get customSortKey(): Nullable<string>;
+            get customData(): Nullable<string>;
+        }
     }
     const ConversationStateJS: {
         get ACTIVE(): string;
@@ -660,11 +669,19 @@ export declare namespace vonage {
         reconnection(): void;
         sessionError(reason: vonage.SessionErrorReasonJS): void;
     }
+    interface CreateConversationParametersJS {
+        readonly name?: Nullable<string>;
+        readonly displayName?: Nullable<string>;
+        readonly imageUrl?: Nullable<string>;
+        readonly ttl?: Nullable<any>/* Nullable<kotlin.Number> */;
+        readonly customSortKey?: Nullable<string>;
+        readonly customData?: Nullable<string>;
+    }
 }
 export declare namespace vonage {
     interface IChatClientJS extends vonage.ICoreClientJS {
         readonly core: any/* com.vonage.clientcore.core.CoreClient */;
-        createConversation(name: Nullable<string>, displayName: Nullable<string>): Promise<string>;
+        createConversation(parameters: Nullable<vonage.CreateConversationParametersJS>): Promise<string>;
         joinConversation(cid: string): Promise<string>;
         inviteToConversation(cid: string, username: string): Promise<string>;
         leaveConversation(cid: string): Promise<any>;
@@ -675,7 +692,8 @@ export declare namespace vonage {
         getConversationMember(cid: string, mid: string): Promise<vonage.MemberJS>;
         sendMessageTextEvent(cid: string, text: string): Promise<string>;
         sendMessageCustomEvent(cid: string, customData: string): Promise<string>;
-        sendEphemeralEvent(cid: string, customBody: string): Promise<string>;
+        sendMessageImageEvent(cid: string, imageURL: URL): Promise<string>;
+        sendEphemeralEvent(cid: string, customData: string): Promise<string>;
         deleteEvent(id: number, conversationId: string): Promise<any>;
         setConfig(config: vonage.ConfigObjectJS): void;
         createSession(token: string, sessionId: Nullable<string>): Promise<string>;
@@ -694,23 +712,34 @@ export declare namespace vonage {
         reconnection(): void;
         sessionError(reason: vonage.SessionErrorReasonJS): void;
     }
+    interface VonageLoggerJS {
+        readonly name: string;
+        readonly minLogLevel?: Nullable<vonage.LoggingLevelJS>;
+        readonly topics?: Nullable<Array<vonage.Topics>>;
+        onLog(logLevel: string, topic: vonage.TopicJS, message: string): void;
+    }
     interface ConfigObjectJS {
         readonly region?: Nullable<vonage.CoreClientConfigRegionJS>;
         readonly apiUrl?: Nullable<string>;
         readonly websocketUrl?: Nullable<string>;
         readonly websocketPath?: Nullable<string>;
         readonly autoMediaReoffer?: Nullable<boolean>;
+        readonly rtcStatsTelemetry?: Nullable<boolean>;
     }
     interface InitConfigObjectJS extends vonage.ConfigObjectJS {
         readonly loggingLevel?: Nullable<vonage.LoggingLevelJS>;
+        readonly customLoggers?: Nullable<Array<vonage.VonageLoggerJS>>;
+        readonly disableInternalLogger?: Nullable<boolean>;
         readonly region?: Nullable<vonage.CoreClientConfigRegionJS>;
         readonly apiUrl?: Nullable<string>;
         readonly websocketUrl?: Nullable<string>;
         readonly websocketPath?: Nullable<string>;
         readonly autoMediaReoffer?: Nullable<boolean>;
+        readonly rtcStatsTelemetry?: Nullable<boolean>;
     }
 }
 export declare namespace vonage {
+    const DEFAULT_REGION: vonage.CoreClientConfigRegionJS;
     abstract class CoreClientConfigRegionJS {
         private constructor();
         get coreRegion(): any/* com.vonage.clientcore.core.api.ClientConfigRegion */;
@@ -742,12 +771,54 @@ export declare namespace vonage {
         set websocketPath(value: string);
         get autoMediaReoffer(): boolean;
         set autoMediaReoffer(value: boolean);
+        get rtcStatsTelemetry(): boolean;
+        set rtcStatsTelemetry(value: boolean);
     }
-    class CoreClientInitConfigJS extends vonage.CoreClientConfigJS implements vonage.InitConfigObjectJS {
-        constructor(loggingLevel?: vonage.LoggingLevelJS, region?: vonage.CoreClientConfigRegionJS);
-        get loggingLevel(): vonage.LoggingLevelJS;
-        set loggingLevel(value: vonage.LoggingLevelJS);
+    class TopicJS {
+        constructor(name: string, tag: string);
+        get name(): string;
+        get tag(): string;
+        copy(name?: string, tag?: string): vonage.TopicJS;
+        toString(): string;
+        hashCode(): number;
+        equals(other: Nullable<any>): boolean;
     }
+    abstract class Topics {
+        private constructor();
+        static get HTTP(): vonage.Topics & {
+            get name(): "HTTP";
+            get ordinal(): 0;
+        };
+        static get WS(): vonage.Topics & {
+            get name(): "WS";
+            get ordinal(): 1;
+        };
+        static get MEDIA(): vonage.Topics & {
+            get name(): "MEDIA";
+            get ordinal(): 2;
+        };
+        static get API(): vonage.Topics & {
+            get name(): "API";
+            get ordinal(): 3;
+        };
+        static get STORE(): vonage.Topics & {
+            get name(): "STORE";
+            get ordinal(): 4;
+        };
+        static get REDUCER(): vonage.Topics & {
+            get name(): "REDUCER";
+            get ordinal(): 5;
+        };
+        static get DEFAULT(): vonage.Topics & {
+            get name(): "DEFAULT";
+            get ordinal(): 6;
+        };
+        static values(): Array<vonage.Topics>;
+        static valueOf(value: string): vonage.Topics;
+        get name(): "HTTP" | "WS" | "MEDIA" | "API" | "STORE" | "REDUCER" | "DEFAULT";
+        get ordinal(): 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    }
+    function createVonageLoggerJS(name: string, minLogLevel: vonage.LoggingLevelJS | undefined, topics: Array<vonage.Topics> | undefined, onLog: (p0: string, p1: vonage.TopicJS, p2: string) => void): vonage.VonageLoggerJS;
     abstract class LoggingLevelJS {
         private constructor();
         static get Verbose(): vonage.LoggingLevelJS & {
@@ -779,6 +850,8 @@ export declare namespace vonage {
         get name(): "Verbose" | "Debug" | "Info" | "Warn" | "Error" | "Assert";
         get ordinal(): 0 | 1 | 2 | 3 | 4 | 5;
     }
+    const DEFAULT_LOGGING_LEVEL: vonage.LoggingLevelJS;
+    function setDefaultLoggingLevel(level: vonage.LoggingLevelJS): void;
     abstract class SessionErrorReasonJS {
         private constructor();
         get reason(): any/* com.vonage.clientcore.core.api.SessionErrorReason */;
@@ -799,7 +872,6 @@ export declare namespace vonage {
         get name(): "EXPIRED_TOKEN" | "TRANSPORT_CLOSED" | "PING_TIMEOUT";
         get ordinal(): 0 | 1 | 2;
     }
-    function setDefaultLoggingLevel(level: vonage.LoggingLevelJS): void;
     interface ICoreClientJS {
         readonly core: any/* com.vonage.clientcore.core.CoreClient */;
         setConfig(config: vonage.ConfigObjectJS): void;
@@ -826,6 +898,7 @@ export declare namespace vonage {
         callMediaReconnecting(callId: string): void;
         callMediaReconnection(callId: string): void;
         callMediaDisconnect(callId: string, reason: vonage.CallDisconnectReasonJS): void;
+        rtcStatsUpdate(rtcStats: vonage.RTCStatsJS, legId: string): void;
         reconnecting(): void;
         reconnection(): void;
         sessionError(reason: vonage.SessionErrorReasonJS): void;
@@ -961,7 +1034,7 @@ export declare namespace vonage {
         enableRtcStatsCollection(interval: any/* kotlin.Number */, mediaId: string): void;
     }
     interface MediaClientDelegateJS {
-        onRtcStats(rtcStats: vonage.RTCStatsJS): void;
+        onRtcStats(rtcStats: vonage.RTCStatsJS, legId: string): void;
         onConnectionChange(id: string, status: string): void;
         onNetworkChange(legId: string, status: string): void;
     }
@@ -1032,21 +1105,22 @@ export declare namespace vonage {
         equals(other: Nullable<any>): boolean;
     }
     class RTCStatsJS {
-        constructor(audioRecvPackets: Nullable<any>/* Nullable<kotlin.Number> */, audioRecvPacketsLost: Nullable<any>/* Nullable<kotlin.Number> */, audioRecvBytes: Nullable<any>/* Nullable<kotlin.Number> */, audioRecvJitter: Nullable<any>/* Nullable<kotlin.Number> */, audioSentPackets: Nullable<any>/* Nullable<kotlin.Number> */, audioSentBytes: Nullable<any>/* Nullable<kotlin.Number> */, audioSentPacketsLost: Nullable<any>/* Nullable<kotlin.Number> */, audioRtt: Nullable<any>/* Nullable<kotlin.Number> */, audioSentJitter: Nullable<any>/* Nullable<kotlin.Number> */, legId: string);
-        get audioRecvPackets(): Nullable<any>/* Nullable<kotlin.Number> */;
-        get audioRecvPacketsLost(): Nullable<any>/* Nullable<kotlin.Number> */;
-        get audioRecvBytes(): Nullable<any>/* Nullable<kotlin.Number> */;
-        get audioRecvJitter(): Nullable<any>/* Nullable<kotlin.Number> */;
-        get audioSentPackets(): Nullable<any>/* Nullable<kotlin.Number> */;
-        get audioSentBytes(): Nullable<any>/* Nullable<kotlin.Number> */;
-        get audioSentPacketsLost(): Nullable<any>/* Nullable<kotlin.Number> */;
-        get audioRtt(): Nullable<any>/* Nullable<kotlin.Number> */;
-        get audioSentJitter(): Nullable<any>/* Nullable<kotlin.Number> */;
-        get legId(): string;
-        copy(audioRecvPackets?: Nullable<any>/* Nullable<kotlin.Number> */, audioRecvPacketsLost?: Nullable<any>/* Nullable<kotlin.Number> */, audioRecvBytes?: Nullable<any>/* Nullable<kotlin.Number> */, audioRecvJitter?: Nullable<any>/* Nullable<kotlin.Number> */, audioSentPackets?: Nullable<any>/* Nullable<kotlin.Number> */, audioSentBytes?: Nullable<any>/* Nullable<kotlin.Number> */, audioSentPacketsLost?: Nullable<any>/* Nullable<kotlin.Number> */, audioRtt?: Nullable<any>/* Nullable<kotlin.Number> */, audioSentJitter?: Nullable<any>/* Nullable<kotlin.Number> */, legId?: string): vonage.RTCStatsJS;
+        constructor(audioRecvPackets: any/* kotlin.Number */, audioRecvPacketsLost: any/* kotlin.Number */, audioRecvBytes: any/* kotlin.Number */, audioRecvJitter: any/* kotlin.Number */, audioSentPackets: any/* kotlin.Number */, audioSentBytes: any/* kotlin.Number */, audioSentPacketsLost: any/* kotlin.Number */, audioRtt: any/* kotlin.Number */, audioSentJitter: any/* kotlin.Number */);
+        get audioRecvPackets(): any/* kotlin.Number */;
+        get audioRecvPacketsLost(): any/* kotlin.Number */;
+        get audioRecvBytes(): any/* kotlin.Number */;
+        get audioRecvJitter(): any/* kotlin.Number */;
+        get audioSentPackets(): any/* kotlin.Number */;
+        get audioSentBytes(): any/* kotlin.Number */;
+        get audioSentPacketsLost(): any/* kotlin.Number */;
+        get audioRtt(): any/* kotlin.Number */;
+        get audioSentJitter(): any/* kotlin.Number */;
+        copy(audioRecvPackets?: any/* kotlin.Number */, audioRecvPacketsLost?: any/* kotlin.Number */, audioRecvBytes?: any/* kotlin.Number */, audioRecvJitter?: any/* kotlin.Number */, audioSentPackets?: any/* kotlin.Number */, audioSentBytes?: any/* kotlin.Number */, audioSentPacketsLost?: any/* kotlin.Number */, audioRtt?: any/* kotlin.Number */, audioSentJitter?: any/* kotlin.Number */): vonage.RTCStatsJS;
         toString(): string;
         hashCode(): number;
         equals(other: Nullable<any>): boolean;
+        static get Companion(): {
+        };
     }
 }
 export as namespace clientsdk_clientcore_js;

package/dist/lib/MediaClient.d.ts

@@ -1,5 +1,6 @@
 import * as KMPPackage from '../kotlin/clientsdk-clientcore_js';
 import vonage from '../utils/vonage';
+import 'webrtc-adapter';
 declare class MediaClient implements vonage.MediaClientJS {
     delegate: KMPPackage.Nullable<vonage.MediaClientDelegateJS>;
     private pcs;

package/dist/utils/ClientConfig.d.ts

@@ -1,22 +1,28 @@
 import { Nullable } from '../kotlin/clientsdk-clientcore_js';
 import vonage from '../utils/vonage';
+import { LoggingLevel, VonageLogger, VonageLoggerJS } from './logging';
+export type ConfigRegion = vonage.CoreClientConfigRegionJS | typeof vonage.CoreClientConfigRegionJS.prototype.name;
 export declare const ConfigRegion: typeof vonage.CoreClientConfigRegionJS;
 export type ClientConfigObject = ConfigObjectJS | ({
-    region?: typeof vonage.CoreClientConfigRegionJS.prototype.name;
+    region?: ConfigRegion;
 } & Omit<ConfigObjectJS, 'region'>);
 export type ClientInitConfigObject = InitConfigObjectJS | ({
-    region?: typeof vonage.CoreClientConfigRegionJS.prototype.name;
-    loggingLevel?: typeof vonage.LoggingLevelJS.prototype.name;
-} & Omit<InitConfigObjectJS, 'region' | 'loggingLevel'>);
+    region?: ConfigRegion;
+    loggingLevel?: LoggingLevel;
+    customLoggers?: VonageLogger[];
+} & Omit<InitConfigObjectJS, 'region' | 'loggingLevel' | 'customLoggers'>);
 export interface ConfigObjectJS {
     region?: Nullable<vonage.CoreClientConfigRegionJS>;
     apiUrl?: Nullable<string>;
     websocketUrl?: Nullable<string>;
     websocketPath?: Nullable<string>;
     autoMediaReoffer?: Nullable<boolean>;
+    rtcStatsTelemetry?: Nullable<boolean>;
 }
 export interface InitConfigObjectJS extends ConfigObjectJS {
     loggingLevel?: Nullable<vonage.LoggingLevelJS>;
+    customLoggers?: Nullable<VonageLoggerJS[]>;
+    disableInternalLogger?: Nullable<boolean>;
 }
 /**
  * Represents the configuration object for the client.
@@ -25,7 +31,7 @@ export interface InitConfigObjectJS extends ConfigObjectJS {
  * These properties control different aspects of the client's behavior, such as API URLs, media reoffer, and WebSocket settings.
  *
  * @example
- * [[include:set_client_config.txt]]
+ * [[include:snippet_setClientConfig.txt]]
  */
 export declare class ClientConfig extends vonage.CoreClientConfigJS {
     /**
@@ -36,17 +42,20 @@ export declare class ClientConfig extends vonage.CoreClientConfigJS {
      *                        The URLs will be automatically set based on the selected region.
      *                        Defaults to "US" if no region is specified.
      */
-    constructor(region?: vonage.CoreClientConfigRegionJS | typeof vonage.CoreClientConfigRegionJS.prototype.name);
+    constructor(region?: ConfigRegion);
 }
-export declare class ClientInitConfig extends vonage.CoreClientInitConfigJS {
+export declare class ClientInitConfig implements InitConfigObjectJS {
+    loggingLevel: vonage.LoggingLevelJS;
+    region: vonage.CoreClientConfigRegionJS;
+    customLoggers: VonageLoggerJS[];
+    disableInternalLogger: boolean;
+    apiUrl?: Nullable<string>;
+    websocketUrl?: Nullable<string>;
+    websocketPath?: Nullable<string>;
+    autoMediaReoffer?: Nullable<boolean>;
     /**
      * Constructs a new instance of the class.
-     *
-     * @param loggingLevel The logging level to set for the SDK. Default is Error.
-     * @param region The region where the API and WebSocket URLs should be configured.
-     *                        Valid values are "EU" (Europe), "US" (United States), or "AP" (Asia Pacific).
-     *                        The URLs will be automatically set based on the selected region.
-     *                        Defaults to "US" if no region is specified.
      */
-    constructor(loggingLevel?: vonage.LoggingLevelJS | typeof vonage.LoggingLevelJS.prototype.name, region?: vonage.CoreClientConfigRegionJS | typeof vonage.CoreClientConfigRegionJS.prototype.name);
+    constructor(loggingLevel?: LoggingLevel, region?: ConfigRegion, customLoggers?: Array<VonageLogger | VonageLoggerJS>);
 }
+export declare const convertInitConfig: (config: ClientInitConfigObject) => InitConfigObjectJS;

package/dist/utils/JsonUtils.d.ts

@@ -0,0 +1,9 @@
+export type JsonValue = object | null | boolean | string | number;
+export type Json = {
+    [property: string]: Json | JsonValue;
+} | Json[];
+/**
+ * Represents custom data, which can be a JSON object or a JSON-formatted string.
+ * There is a 2MB limit on the size of the custom data object.
+ */
+export type CustomData = Json | string;

package/dist/utils/index.d.ts

@@ -1,5 +1,6 @@
-export * from './ClientConfig';
-export * from './logging';
+export { ClientConfig, ClientInitConfig, ClientConfigObject, ClientInitConfigObject, ConfigRegion, convertInitConfig } from './ClientConfig';
+export { type Topic, type VonageLogger, LoggingLevel, Topics, createVonageLogger, setDefaultLoggingLevel, setVonageClientLoggingLevel } from './logging';
+export * from './JsonUtils';
 export * from './ConversationModels';
 export * from '../kotlin/JsUnions';
 export * from './ErrorModels';

package/dist/utils/logging.d.ts

@@ -1,3 +1,31 @@
+import { Nullable } from '../kotlin/clientsdk-clientcore_js';
 import vonage from '../utils/vonage';
+export type Topics = vonage.Topics | typeof Topics.prototype.name;
+export declare const Topics: typeof vonage.Topics;
+export type Topic = vonage.TopicJS;
+export declare const Topic: typeof vonage.TopicJS;
+export type LoggingLevelName = typeof vonage.LoggingLevelJS.prototype.name;
+export type LoggingLevel = vonage.LoggingLevelJS | LoggingLevelName;
 export declare const LoggingLevel: typeof vonage.LoggingLevelJS;
-export declare const setDefaultLoggingLevel: typeof vonage.setDefaultLoggingLevel;
+/**
+ * @deprecated Use {@link ClientInitConfig.loggingLevel} instead.
+ * @param level - The logging level to set.
+ */
+export declare const setDefaultLoggingLevel: (level: LoggingLevel) => void;
+/**
+ * @deprecated Use {@link ClientInitConfig.loggingLevel} instead.
+ * @param level - The logging level to set.
+ */
+export declare const setVonageClientLoggingLevel: (level: LoggingLevel) => void;
+export type VonageLogger = VonageLoggerJS | ({
+    minLogLevel?: LoggingLevel;
+    topics?: Topics[];
+} & Omit<VonageLoggerJS, 'minLogLevel' | 'topics'>);
+export declare const convertLogger: (logger: VonageLogger) => VonageLoggerJS;
+export interface VonageLoggerJS {
+    name: string;
+    minLogLevel?: Nullable<vonage.LoggingLevelJS>;
+    topics?: Nullable<vonage.Topics[]>;
+    onLog(level: LoggingLevelName, topic: Topic, message: string): void;
+}
+export declare const createVonageLogger: (name: string, onLog: (level: LoggingLevelName, topic: Topic, message: string) => void, minLogLevel?: LoggingLevel, topics?: Topics[]) => VonageLogger;