@vonage/client-sdk 1.2.1-alpha.0 → 1.2.1-beta.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,68 +139,55 @@ Below are several typical scenarios where the SDK is commonly utilized.
 ### Make an Outbound Call
 
 ```ts
-const call = await client.serverCall({
-  customData: {
-    callee: 'bob',
-    type: 'app'
-  }
-});
-console.log(call);
+const context = {
+  callee: 'user1'
+};
+
+const callId = await client.serverCall(context);
 ```
 
 ### Answer/Reject an Inbound Call
 
 ```ts
-// Answer Call
-client.on(
-  'callInvite',
-  async (callId: string, from: string, channelType: string) => {
-    client.answer(callId);
-    console.log(callId, from, channelType);
-  }
-);
+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);
+});
 
-// Reject Call
-client.on(
-  'callInvite',
-  async (callId: string, from: string, channelType: string) => {
-    client.reject(callId);
-    console.log(callId, from, channelType);
+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
-// await client.hangup(call);
-await client.hangup(call, 'reason-text', 'reason-code');
-
 client.on('callHangup', (callId, callQuality, reason) => {
-  if (callId == call) {
-    console.log('The call has finished');
-  }
-  console.log(`This was your call MOS score: `, callQuality.mos_score);
-  const reason_name = reason.name;
-  if (reason_name === 'LOCAL_HANGUP') {
-    console.log('You hung up the call');
-    return;
-  } else if (reason_name === 'REMOTE_HANGUP') {
-    console.log('Call was hung up remotely');
-    return;
-  } else if (reason_name === 'REMOTE_REJECT') {
-    console.log('Call was rejected');
-    return;
-  } else if (reason_name === 'MEDIA_TIMEOUT') {
-    console.log('Timeout due to media failure');
-    return;
-  } else if (reason_name === 'REMOTE_NO_ANSWER_TIMEOUT') {
-    console.log('Timeout due to missing remote answer');
-    return;
+  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 {
-    return exhaustiveCheck(reason_name);
+    exhaustiveCheck(reason.name);
   }
 });
 ```
@@ -190,72 +195,64 @@ client.on('callHangup', (callId, callQuality, reason) => {
 ### Get Conversations
 
 ```ts
-try {
-  let cursor: string | undefined | null = undefined;
-  const pageSize = 10;
-  const conversations: Conversation[] = [];
-  const includeCustomData = false;
-  const orderBy = OrderBy.CREATED;
-  do {
-    const response: ConversationsPage = await client.getConversations(
-      PresentingOrder.ASC,
-      pageSize,
-      cursor,
-      includeCustomData,
-      orderBy
-    );
-    conversations.push(...response.conversations);
-    cursor = response.nextCursor;
-  } while (cursor !== null);
-  console.log(`Conversations successfully fetched: ${conversations}`);
-} catch (e) {
-  console.log(`Error in fetching Conversations: ${e}`);
-}
+const { conversations, nextCursor, previousCursor } =
+  await client.getConversations(
+    PresentingOrder.ASC,
+    10, // page size
+    undefined, // cursor
+    true // include custom data
+  );
 ```
 
 ### Send Text Messages
 
 ```ts
-try {
-  const timestamp = await client.sendMessageTextEvent(
-    'conversationId',
-    'Hello there'
-  );
-  console.log(`Message successfully sent with timestamp ${timestamp}`);
-} catch (e) {
-  console.log(`Error in sending Message: ${e}`);
-}
+const timestamp = await client.sendMessageTextEvent(
+  'CONVERSATION_ID',
+  'Hello World!'
+);
 ```
 
 ### Listen for Conversation Events
 
 ```ts
-client.on('conversationEvent', (event) => {
-  switch (event.kind) {
-    case 'member:invited':
-    case 'member:joined':
-    case 'member:left':
-    case 'message:text':
-    case 'message:custom':
-    case 'message:audio':
-    case 'message:video':
-    case 'message:image':
-    case 'message:file':
-    case 'message:vcard':
-    case 'message:location':
-    case 'message:template':
-    case 'custom':
-    case 'ephemeral':
-      break;
-    default:
-      exhaustiveCheck(event);
+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 sender =
-    event.from.kind == 'embeddedInfo' ? event.from.user.name : 'System';
-  console.log(
-    `${sender} sent ${event.kind} event to Conversation ${event.conversationId}`
-  );
-});
+};
+
+const listener = client.on('conversationEvent', eventHandler);
+
+client.off('conversationEvent', listener);
 ```
 
 ## Documentation and examples

package/dist/client/VonageClient.d.ts

@@ -1,5 +1,5 @@
 import vonage from '../utils/vonage';
-import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder, ConversationEvent, PersistentConversationEvent, OrderBy } from '../utils';
+import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder, ConversationEvent, PersistentConversationEvent, OrderBy, ClientInitConfigObject } from '../utils';
 /**
  * The Vonage Client SDK for JS/TS provides a simple interface
  * For the Vonage Voice and Messaging APIs.
@@ -39,6 +39,10 @@ export declare const CallDisconnectReason: typeof vonage.CallDisconnectReasonJS;
 type JSONValue = string | number | boolean | {
     [x: string]: JSONValue;
 } | JSONValue[];
+/**
+ * @deprecated Use {@link ClientInitConfig.loggingLevel} instead.
+ * @param level - The logging level to set.
+ */
 export declare const setVonageClientLoggingLevel: typeof vonage.setDefaultLoggingLevel;
 /**
  * VonageClient is the main entry point for the Vonage Client SDK.
@@ -52,12 +56,12 @@ export declare const setVonageClientLoggingLevel: typeof vonage.setDefaultLoggin
  * DO NOT ADD CODE HERE UNLESS REALLY NEEDEED!!111!
  */
 export declare class VonageClient extends vonage.CombinedClientJS {
-    constructor();
+    constructor(config?: ClientInitConfigObject);
     /**
      * Register a callback for an event.
      *
      * @example
-     * [[include:register_listener.txt]]
+     * [[include: snippet_RegisterListener.txt]]
      *
      * @param event - the event to register for (e.g. 'legStatusUpdate')
      * @param callback - the callback to register for the event
@@ -71,7 +75,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Unregister a callback for an event.
      *
      * @example
-     * [[include:unregister_listener.txt]]
+     * [[include: snippet_UnregisterListener.txt]]
      *
      * @param event - the event to register for (e.g. 'legStatusUpdate')
      * @param callbackSymbol - the callback symbol to unregister
@@ -84,7 +88,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Clear all callbacks for an event.
      *
      * @example
-     * [[include: clear_callbacks.txt]]
+     * [[include: snippet_Clear_Callbacks.txt]]
      *
      * @param event - the event to unregister from (e.g. 'legStatusUpdate')
      * @returns void
@@ -101,7 +105,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * to resume an existing session.
      *
      * @example
-     * [[include:create_session.txt]]
+     * [[include: snippet_SessionCreate.txt]]
      *
      * @param token
      * @param sessionId - optional sessionId to use
@@ -128,7 +132,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * This is used to initiate a call using the Voice API and NCCO.
      *
      * @example
-     * [[include:outbound_call.txt]]
+     * [[include: snippet_OutboundCall.txt]]
      *
      * @group Voice
      * @param context - the context to send to the server passed as Custom data to the voice answer webhook
@@ -139,7 +143,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Hangup a call.
      *
      * @example
-     * [[include:call_hangup.txt]]
+     * [[include: snippet_CallHangup.txt]]
      *
      * @group Voice
      * @param callId - the `callId` of the call to hangup
@@ -161,7 +165,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Sends a TTS message to the Call
      *
      * @example
-     * [[include:call_say.txt]]
+     * [[include: snippet_CallSay.txt]]
      *
      * @group Voice
      * @param callId - the `callId` of the call to send the message to
@@ -173,7 +177,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Get a list of Conversations for the user.
      *
      * @example
-     * [[include:get_conversations.txt]]
+     * [[include: snippet_GetConversations.txt]]
      *
      * @group Chat
      * @beta
@@ -187,7 +191,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Get a Conversation's Events
      *
      * @example
-     * [[include:get_conversation_events.txt]]
+     * [[include: snippet_GetConversationEvents.txt]]
      *
      * @group Chat
      * @beta
@@ -196,18 +200,19 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @param pageSize - the number of events to return per page (default: 100)
      * @param cursor - the cursor to use for pagination (default: null)
      * @param eventFilter - the event types to filter by (default: null)
+     * @param includeDeletedEvents - A boolean, which when sent as true, will include `deletedEvents` in the list, default is false
      * @returns a `EventsPage` containing the events
      *
      * @privateRemarks
      * * This is a workaround for the to ensure exhaustiveness of the `ConversationEvent` type
      * * the kotlin core does not support union types
      */
-    getConversationEvents(id: string, order?: PresentingOrder, pageSize?: number, cursor?: string | null, eventFilter?: string[] | null): Promise<EventPage>;
+    getConversationEvents(id: string, order?: PresentingOrder, pageSize?: number, cursor?: string | null, eventFilter?: string[] | null, includeDeletedEvents?: boolean): Promise<EventPage>;
     /**
      * Get a Conversation's Members
      *
      * @example
-     * [[include:get_conversation_members.txt]]
+     * [[include: snippet_GetConversationMembers.txt]]
      *
      * @group Chat
      * @beta
@@ -222,7 +227,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Create a conversation
      *
      * @example
-     * [[include:create_conversation.txt]]
+     * [[include: snippet_CreateConversation.txt]]
      *
      * @group Chat
      * @beta
@@ -235,7 +240,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Get a Conversation
      *
      * @example
-     * [[include:get_conversation.txt]]
+     * [[include: snippet_GetConversation.txt]]
      *
      * @param id - the Conversation's id
      * @returns the `Conversation`
@@ -245,7 +250,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Leave a Conversation
      *
      * @example
-     * [[include:leave_conversation.txt]]
+     * [[include: snippet_LeaveConversation.txt]]
      *
      * @group Chat
      * @beta
@@ -257,7 +262,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Join a Conversation
      *
      * @example
-     * [[include:join_conversation.txt]]
+     * [[include: snippet_JoinConversation.txt]]
      *
      * @group Chat
      * @beta
@@ -269,7 +274,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Delete a Conversation
      *
      * @example
-     * [[include:delete_conversation.txt]]
+     * [[include: snippet_DeleteConversation.txt]]
      *
      * @group Chat
      * @beta
@@ -281,7 +286,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Invite a user to a Conversation by user's `name`
      *
      * @example
-     * [[include:invite_to_conversation.txt]]
+     * [[include: snippet_InviteToConversation.txt]]
      *
      * @group Chat
      * @beta
@@ -294,7 +299,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Send a text message to a Conversation
      *
      * @example
-     * [[include:send_text_message.txt]]
+     * [[include: snippet_SendTextMessage.txt]]
      *
      * @group Chat
      * @beta
@@ -307,7 +312,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Send a custom message to a Conversation
      *
      * @example
-     * [[include:send_custom_message.txt]]
+     * [[include: snippet_SendCustomMessage.txt]]
      *
      * @group Chat
      * @beta
@@ -320,7 +325,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Send an ephemeral event to a Conversation
      *
      * @example
-     * [[include:send_ephemeral_event.txt]]
+     * [[include: snippet_SendEphemeralEvent.txt]]
      *
      * @group Chat
      * @beta
@@ -346,7 +351,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * Get a Member of a Conversation
      *
      * @example
-     * [[include:get_conversation_member.txt]]
+     * [[include: snippet_GetConversationMember.txt]]
      *
      * @group Chat
      * @beta