@vonage/client-sdk 1.2.1-snapshot.17.0 → 1.2.1-snapshot.36.0

package/README.md

@@ -19,14 +19,23 @@ npm i @vonage/client-sdk
 ### With bundler (Webpack, Vite, etc.) and React
 
 ```js
-import { VonageClient, ClientConfig, ConfigRegion } from '@vonage/client-sdk';
+import {
+  VonageClient,
+  ClientConfig,
+  ConfigRegion,
+  LoggingLevel
+} from '@vonage/client-sdk';
 import { useState, useEffect } from 'react';
 
 function App() {
-  // Config is optional but recomended, default region is US
-  const [config] = useState(() => new ClientConfig(ConfigRegion.US));
+  const [config] = useState(() => new ClientConfig(ConfigRegion.AP));
   const [client] = useState(() => {
-    const client = new VonageClient();
+    // Initialize client with optional config (default: ERROR logging, US region).
+    const client = new VonageClient({
+      loggingLevel: LoggingLevel.DEBUG,
+      region: ConfigRegion.EU
+    });
+    // Or update some options after initialization.
     client.setConfig(config);
     return client;
   });
@@ -70,11 +79,15 @@ export default App;
 <script src="./node_modules/@vonage/client-sdk/dist/vonageClientSDK.min.js"></script>
 <script>
   const token = 'my-token';
-  const client = new vonageClientSDK.VoiceClient();
-  const config = new vonageClientSDK.ClientConfig(
-    vonageClientSDK.ConfigRegion.EU
-  );
-  client.setConfig(config);
+  // Initialize client with optional config (default: ERROR logging, US region).
+  const client = new vonageClientSDK.VoiceClient({
+    loggingLevel: LoggingLevel.DEBUG, 
+    region: ConfigRegion.EU
+  });
+  // Or update some options after initialization.
+  client.setConfig({
+    region: ConfigRegion.AP
+  });
 
   client.createSession(token).then((Session) => {});
 </script>
@@ -85,15 +98,20 @@ export default App;
 ```js
 import {
   VonageClient,
-  ClientConfig,
-  ConfigRegion
+  ConfigRegion,
+  LoggingLevel
 } from 'https://cdn.jsdelivr.net/npm/@vonage/client-sdk@1.0.0/dist/vonageClientSDK.esm.min.js';
 
-const client = new VonageClient();
+// Initialize client with optional config (default: ERROR logging, US region).
+const client = new VonageClient({
+  loggingLevel: LoggingLevel.DEBUG,
+  region: ConfigRegion.EU
+});
 
-// Config is optional but recomended, default region is US
-const config = new ClientConfig(ConfigRegion.US);
-client.setConfig(config);
+// Or update some options after initialization.
+client.setConfig({
+  region: ConfigRegion.AP
+});
 
 (async () => {
   const token = 'my-token';
@@ -121,37 +139,120 @@ Below are several typical scenarios where the SDK is commonly utilized.
 ### Make an Outbound Call
 
 ```ts
+const context = {
+  callee: 'user1'
+};
 
+const callId = await client.serverCall(context);
 ```
 
 ### Answer/Reject an Inbound Call
 
 ```ts
-
+client.on('callInvite', async (callId, from, channleType) => {
+  console.log(`Received call invite from ${from} on ${channleType}`);
+
+  // Accept the call
+  await client.answer(callId);
+
+  // Reject the call
+  await client.reject(callId);
+});
+
+client.on('callInviteCancel', (callId, reason) => {
+  if (reason === CancelReason.AnsweredElsewhere) {
+    console.log(`Call ${callId} was answered elsewhere`);
+  } else if (reason === CancelReason.RejectedElsewhere) {
+    console.log(`Call ${callId} was rejected elsewhere`);
+  } else if (reason === CancelReason.RemoteCancel) {
+    console.log(`Call ${callId} was cancelled by the caller`);
+  } else if (reason === CancelReason.RemoteTimeout) {
+    console.log(`Call ${callId} timed out`);
+  }
+});
 ```  
 
 ### Hang-up and Collect Stats
 
 ```ts
-
+client.on('callHangup', (callId, callQuality, reason) => {
+  if (reason.name == 'LOCAL_HANGUP') {
+    console.log(`Call ${callId} was hung up locally`);
+  } else if (reason.name == 'REMOTE_HANGUP') {
+    console.log(`Call ${callId} was hung up remotely`);
+  } else if (reason.name == 'REMOTE_REJECT') {
+    console.log(`Call ${callId} was rejected remotely`);
+  } else if (reason.name == 'REMOTE_NO_ANSWER_TIMEOUT') {
+    console.log(`Call ${callId} timed out`);
+  } else if (reason.name == 'MEDIA_TIMEOUT') {
+    console.log(`Call ${callId} timed out`);
+  } else {
+    exhaustiveCheck(reason.name);
+  }
+});
 ```
 
 ### Get Conversations
 
 ```ts
-
+const { conversations, nextCursor, previousCursor } =
+  await client.getConversations(
+    PresentingOrder.ASC,
+    10, // page size
+    undefined, // cursor
+    true // include custom data
+  );
 ```
 
 ### Send Text Messages
 
 ```ts
-
+const timestamp = await client.sendMessageTextEvent(
+  'CONVERSATION_ID',
+  'Hello World!'
+);
 ```
 
 ### Listen for Conversation Events
 
 ```ts
+const eventHandler = (event: ConversationEvent) => {
+  if (event.kind == 'member:invited') {
+    console.log(`Member invited: ${event.body.memberId}`);
+  } else if (event.kind == 'member:joined') {
+    console.log(`Member joined: ${event.body.memberId}`);
+  } else if (event.kind == 'member:left') {
+    console.log(`Member left: ${event.body.memberId}`);
+  } else if (event.kind == 'ephemeral') {
+    console.log(`Ephemeral event: ${event.body}`);
+  } else if (event.kind == 'custom') {
+    console.log(`Custom event: ${event.body}`);
+  } else if (event.kind == 'message:text') {
+    console.log(`Text message: ${event.body.text}`);
+  } else if (event.kind == 'message:custom') {
+    console.log(`Custom message: ${event.body.customData}`);
+  } else if (event.kind == 'message:image') {
+    console.log(`Image message: ${event.body.imageUrl}`);
+  } else if (event.kind == 'message:video') {
+    console.log(`Video message: ${event.body.videoUrl}`);
+  } else if (event.kind == 'message:audio') {
+    console.log(`Audio message: ${event.body.audioUrl}`);
+  } else if (event.kind == 'message:file') {
+    console.log(`File message: ${event.body.fileUrl}`);
+  } else if (event.kind == 'message:vcard') {
+    console.log(`Vcard message: ${event.body.vcardUrl}`);
+  } else if (event.kind == 'message:location') {
+    console.log(`Location message: ${event.body.location}`);
+  } else if (event.kind == 'message:template') {
+    console.log(`Template message: ${event.body.template}`);
+  } else {
+    exhaustiveCheck(event);
+  }
+};
+
+const listener = client.on('conversationEvent', eventHandler);
 
+client.off('conversationEvent', listener);
 ```
 
 ## Documentation and examples

package/dist/client/VonageClient.d.ts

@@ -1,5 +1,6 @@
 import vonage from '../utils/vonage';
-import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder, ConversationEvent, PersistentConversationEvent, OrderBy, ClientInitConfigObject } from '../utils';
+import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder, OrderBy, ClientInitConfigObject, ClientConfigObject } from '../utils';
+import { ConversationEvent, PersistentConversationEvent } from '../kotlin/JsUnions';
 /**
  * The Vonage Client SDK for JS/TS provides a simple interface
  * For the Vonage Voice and Messaging APIs.
@@ -36,6 +37,7 @@ export type CallSayParams = Partial<vonage.CallSayParams> & {
 };
 export type CallDisconnectReason = vonage.CallDisconnectReasonJS;
 export declare const CallDisconnectReason: typeof vonage.CallDisconnectReasonJS;
+export type RtcStats = vonage.RTCStatsJS;
 type JSONValue = string | number | boolean | {
     [x: string]: JSONValue;
 } | JSONValue[];
@@ -57,6 +59,16 @@ export declare const setVonageClientLoggingLevel: typeof vonage.setDefaultLoggin
  */
 export declare class VonageClient extends vonage.CombinedClientJS {
     constructor(config?: ClientInitConfigObject);
+    /**
+     * Set a configuration for the client SDK
+     *
+     * @example
+     * [[include: snippet_SetClientConfig.txt]]
+     *
+     * @param config - A configuration object
+     * @returns void
+     */
+    setConfig(config: ClientConfigObject): void;
     /**
      * Register a callback for an event.
      *
@@ -321,6 +333,19 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @returns the `timestamp` of the message
      */
     sendMessageCustomEvent(id: string, customData: JSONValue): Promise<string>;
+    /**
+     * Send a Image message to a Conversation.
+     *
+     * @example
+     * [[include: snippet_SendImageMessage.txt]]
+     *
+     * @group Chat
+     * @beta
+     * @param id - the Conversation's id
+     * @param imageUrl - the url of the image resource.
+     * @returns the `timestamp` of the message
+     */
+    sendMessageImageEvent(id: string, imageUrl: URL): Promise<string>;
     /**
      * Send an ephemeral event to a Conversation
      *