@vonage/client-sdk 1.1.0 → 1.1.1-alpha.0

package/README.md

@@ -165,6 +165,32 @@ client.on('callHangup', async (callId: string, callQuality: RTCQuality) => {
     console.log(`Call ${callId} has hanged up, callQuality:${callQuality}`);
   }
 });
+
+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 hangup the call');
+    return;
+  } else if (reason_name === 'REMOTE_HANGUP') {
+    console.log('call was hanged up remotly');
+    return;
+  } else if (reason_name === 'REMOTE_REJECT') {
+    console.log('call was rejected');
+    return;
+  } else if (reason_name === 'MEDIA_TIMEOUT') {
+    console.log('media timeout');
+    return;
+  } else if (reason_name === 'REMOTE_NO_ANSWER_TIMEOUT') {
+    console.log('remote no answer timeout');
+    return;
+  } else {
+    return exhaustiveCheck(reason_name);
+  }
+});
 ```
 
 ### Get Conversations
@@ -206,27 +232,21 @@ try {
 ### Listen for Conversation Events
 
 ```ts
-client.on('conversationEvent', async (event) => {
-  if (event instanceof MemberInvitedEvent) {
-    console.log(
-      `User ${event.body.invitee.name} invited by ${event.body.inviter?.name} to Conversation ${event.conversationId}`
-    );
-  } else if (event instanceof MemberJoinedEvent) {
-    console.log(
-      `User ${event.body.user.name} joined Conversation ${event.conversationId}`
-    );
-  } else if (event instanceof MemberLeftEvent) {
-    console.log(
-      `User ${event.body.user.name} left Conversation ${event.conversationId}`
-    );
-  } else if (event instanceof TextMessageEvent) {
-    console.log(
-      `User ${event.body.sender.name} sent Text Message '${event.body.text}' in Conversation ${event.conversationId}`
-    );
-  } else if (event instanceof CustomMessageEvent) {
-    console.log(
-      `User ${event.body.sender} sent Custom Message '${event.body.customData}' in Conversation ${event.conversationId}`
-    );
+client.on('conversationEvent', (event) => {
+  if (event.kind == 'member:invited') {
+    return;
+  }
+  if (event.kind == 'member:joined') {
+    return;
+  }
+  if (event.kind == 'member:left') {
+    return;
+  }
+  if (event.kind == 'message:text') {
+    return;
+  }
+  if (event.kind == 'message:custom') {
+    return;
   }
 });
 ```

package/dist/client/VonageClient.d.ts

@@ -1,4 +1,5 @@
 import vonage from '../utils/vonage';
+import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder, ConversationEvent } from '../utils';
 /**
  * The Vonage Client SDK for JS/TS provides a simple interface
  * For the Vonage Voice and Messaging APIs.
@@ -11,7 +12,12 @@ import vonage from '../utils/vonage';
  * @packageDocumentation
  */
 export * from '../utils';
-export type VonageEvent = vonage.CombinedEvents;
+export interface EventsPage extends vonage.EventsPageJS {
+    events: ConversationEvent[];
+}
+interface VonageEvent extends vonage.CombinedEvents {
+    conversationEvent: (event: ConversationEvent) => void;
+}
 export type RTCQuality = vonage.RTCQualityJS;
 export type CancelReason = vonage.CancelReasonJS;
 export declare const CancelReason: typeof vonage.CancelReasonJS;
@@ -28,7 +34,6 @@ export type CallSayParams = Partial<vonage.CallSayParams> & {
 type JSONValue = string | number | boolean | {
     [x: string]: JSONValue;
 } | JSONValue[];
-import { Conversation, ConversationsPage, EventsPage, Member, MembersPage, PresentingOrder } from '../utils';
 export declare const setVonageClientLoggingLevel: typeof vonage.setDefaultLoggingLevel;
 /**
  * VonageClient is the main entry point for the Vonage Client SDK.
@@ -186,6 +191,10 @@ 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)
      * @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): Promise<EventsPage>;
     /**