@vonage/client-sdk 0.1.3 → 0.1.4-alpha.3

package/README.md

@@ -1,24 +1,54 @@
 # Vonage Voice SDK
 
-## Install
+The Client SDK is intended to provide a ready solution for developers to build Programmable Conversation applications across multiple Channels including: Messages, Voice, SIP, websockets, and App.
 
-### 1. Create a Personal Access Token
+## Installation
 
-- generate token, see [here](https://docs.github.com/en/enterprise-server@3.4/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token ), you will need a PAT with `packages:read` scope enabled 
-- enable SSO for new token, see [here](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)
-
-### 2. Authenticate with Github packages
+The SDK can be installed using the npm install command
 
 ```
-$ npm login --scope=@nexmoinc --registry=https://npm.pkg.github.com
-
-> Username: USERNAME //github user
-> Password: TOKEN // Personal access token
-> Email: github email 
+npm i @vonage/client-sdk
 ```
 
-### 3. Add dependency 
+## SDK setup
+
+To use the client SDK in a Webpack or Vite project:
 
 ```
-npm install @nexmoinc/voice-sdk
+import './App.css';
+import VoiceClient, { ClientConfig, ConfigRegion } from '@vonage/client-sdk';
+
+const client = new VoiceClient();
+
+// Config is optional but recomended, default region is US
+const config = new ClientConfig(ConfigRegion.US)
+client.setConfig(config)
+
+function App() {
+
+  const createSession = async () => {
+    const token = "my-token"
+    await client.createSession(token)
+  }
+
+  return (
+    <button onClick={createSession}> create session </button>
+  );
+}
+
+export default App;
 ```
+
+## Documentation and examples
+
+Visit [vonage website] (https://developer.vonage.com/tools)
+
+## License
+
+Copyright (c) 2023 Vonage, Inc. All rights reserved. Licensed only under the Vonage Client SDK License Agreement (the "License") located at [LICENCE](https://github.com/nexmoinc/conversation-js-sdk/blob/master/LICENSE).
+
+By downloading or otherwise using our software or services, you acknowledge that you have read, understand and agree to be bound by the Vonage Client SDK License Agreement and Privacy Policy.
+
+You may not use, exercise any rights with respect to or exploit this SDK, or any modifications or derivative works thereof, except in accordance with the License.
+
+[<img src="https://developer.nexmo.com/images/logos/vbc-logo.svg" width="30%">](https://www.vonage.com/communications-apis/)

package/dist/MediaClient.d.ts

@@ -6,10 +6,13 @@ declare class MediaClient implements vonage.MediaClientJS {
     private audio;
     private stream;
     constructor();
-    enableMedia(id: string, remoteDescription?: string): Promise<void>;
+    enableMediaInbound(closure: (err: unknown, offerSDP: KMPPackage.Nullable<string>) => void, offerSDP: string, rtcId: string): Promise<void>;
+    enableMediaOutbound(closure: (err: unknown, offerSDP: KMPPackage.Nullable<string>, callback: (legId: string) => void) => void): Promise<void>;
+    private getNewPC;
     mute(id: string): Promise<void>;
     unmute(id: string): Promise<void>;
-    processAnswer(id: string, sdp: string, streamId: string, legId: string): void;
+    getPeerConnection(id: string): RTCPeerConnection | undefined;
+    processAnswer(id: string, sdp: string): void;
     disableMedia(id: string): void;
     private setMediaTracksEnabled;
 }

package/dist/MediaClient.js

@@ -15,39 +15,58 @@ class MediaClient {
         this.pcs = new Map();
         this.audio = undefined;
     }
-    enableMedia(id, remoteDescription) {
-        var _a, _b;
+    enableMediaInbound(closure, offerSDP, rtcId) {
         return __awaiter(this, void 0, void 0, function* () {
+            let sdp;
+            let error;
             try {
-                const pc = yield (0, createRtcAudioConnection_1.createRtcAudioConnection)();
-                this.pcs.set(id, pc);
-                pc.ontrack = (evt) => {
-                    const stream = evt.streams[0];
-                    if (stream) {
-                        const audio = new Audio();
-                        audio.srcObject = stream;
-                        audio.autoplay = true;
-                        this.audio = audio;
-                        this.stream = stream;
-                    }
-                };
-                if (remoteDescription) {
-                    const sdp = yield (0, createRtcAudioConnection_1.createAnswer)(pc, remoteDescription);
-                    // eslint-disable-next-line @typescript-eslint/no-empty-function
-                    (_a = this.delegate) === null || _a === void 0 ? void 0 : _a.onAnswer(id, '', sdp, () => { });
-                }
-                else {
-                    const sdp = yield (0, createRtcAudioConnection_1.createOffer)(pc);
-                    (_b = this.delegate) === null || _b === void 0 ? void 0 : _b.onOffer(id, '', sdp, () => {
-                        // Do we need to save the leg id for later?
-                    });
-                }
+                const pc = yield this.getNewPC();
+                this.pcs.set(rtcId, pc);
+                sdp = yield (0, createRtcAudioConnection_1.createAnswer)(pc, offerSDP);
+            }
+            catch (err) {
+                error = err;
+            }
+            finally {
+                closure(error, sdp);
+            }
+        });
+    }
+    enableMediaOutbound(closure) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let error;
+            let pc;
+            let sdp;
+            try {
+                pc = yield this.getNewPC();
+                sdp = yield (0, createRtcAudioConnection_1.createOffer)(pc);
+            }
+            catch (err) {
+                error = err;
             }
-            catch (error) {
-                // TODO
+            finally {
+                closure(error, sdp, (legId) => {
+                    this.pcs.set(legId, pc);
+                });
             }
         });
     }
+    getNewPC() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const pc = yield (0, createRtcAudioConnection_1.createRtcAudioConnection)();
+            pc.ontrack = (evt) => {
+                const stream = evt.streams[0];
+                if (stream) {
+                    const audio = new Audio();
+                    audio.srcObject = stream;
+                    audio.autoplay = true;
+                    this.audio = audio;
+                    this.stream = stream;
+                }
+            };
+            return pc;
+        });
+    }
     mute(id) {
         return __awaiter(this, void 0, void 0, function* () {
             this.setMediaTracksEnabled(id, false);
@@ -58,17 +77,17 @@ class MediaClient {
             this.setMediaTracksEnabled(id, true);
         });
     }
+    getPeerConnection(id) {
+        const pc = this.pcs.get(id);
+        return pc;
+    }
     // async getLocalStream(): Promise<MediaStream> {
     //   return await navigator.mediaDevices.getUserMedia({
     //     video: false,
     //     audio: true
     //   });
     // }
-    processAnswer(id, sdp, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    streamId, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    legId) {
+    processAnswer(id, sdp) {
         const remoteDescription = new RTCSessionDescription({
             type: 'answer',
             sdp

package/dist/coreExtend.d.ts

@@ -6,5 +6,8 @@ declare module './kotlin/clientsdk-clientcore_js' {
                 text: string;
             }): Promise<unknown>;
         }
+        interface CoreClientJS {
+            getPeerConnection(id: string): RTCPeerConnection;
+        }
     }
 }

package/dist/kotlin/Kermit-kermit-js-ir.js

@@ -12,14 +12,14 @@
 }(this, function (_, kotlin_kotlin) {
   'use strict';
   //region block: imports
-  var classMeta = kotlin_kotlin.$_$.h5;
-  var objectMeta = kotlin_kotlin.$_$.h6;
-  var listOf = kotlin_kotlin.$_$.g4;
-  var interfaceMeta = kotlin_kotlin.$_$.o5;
-  var THROW_ISE = kotlin_kotlin.$_$.w7;
-  var Unit_getInstance = kotlin_kotlin.$_$.o2;
-  var Enum = kotlin_kotlin.$_$.q7;
-  var stackTraceToString = kotlin_kotlin.$_$.m8;
+  var classMeta = kotlin_kotlin.$_$.j5;
+  var objectMeta = kotlin_kotlin.$_$.j6;
+  var listOf = kotlin_kotlin.$_$.h4;
+  var interfaceMeta = kotlin_kotlin.$_$.q5;
+  var THROW_ISE = kotlin_kotlin.$_$.z7;
+  var Unit_getInstance = kotlin_kotlin.$_$.p2;
+  var Enum = kotlin_kotlin.$_$.s7;
+  var stackTraceToString = kotlin_kotlin.$_$.p8;
   //endregion
   //region block: pre-declaration
   Companion.prototype = Object.create(Logger.prototype);
@@ -31,7 +31,7 @@
   //endregion
   function LogWriter() {
   }
-  LogWriter.prototype.y19 = function (severity) {
+  LogWriter.prototype.a1a = function (severity) {
     return true;
   };
   LogWriter.$metadata$ = classMeta('LogWriter');
@@ -52,16 +52,16 @@
   }
   function Companion() {
     Companion_instance = this;
-    var tmp = LoggerGlobal_getInstance().a1a_1;
+    var tmp = LoggerGlobal_getInstance().c1a_1;
     Logger_init_$Init$(tmp, null, 2, null, this);
   }
-  Companion.prototype.d1a = function () {
+  Companion.prototype.f1a = function () {
     return get_defaultTag();
   };
-  Companion.prototype.e1a = function (severity) {
-    LoggerGlobal_getInstance().a1a_1.f1a(severity);
+  Companion.prototype.g1a = function (severity) {
+    LoggerGlobal_getInstance().c1a_1.h1a(severity);
   };
-  Companion.prototype.g1a = function (tag) {
+  Companion.prototype.i1a = function (tag) {
     set_defaultTag(tag);
   };
   Companion.$metadata$ = objectMeta('Companion', undefined, undefined, undefined, undefined, Logger.prototype);
@@ -73,51 +73,51 @@
   }
   function Logger(config, tag) {
     Companion_getInstance();
-    this.h1a_1 = config;
-    this.i1a_1 = tag;
+    this.j1a_1 = config;
+    this.k1a_1 = tag;
   }
-  Logger.prototype.j1a = function () {
-    return this.h1a_1;
+  Logger.prototype.l1a = function () {
+    return this.j1a_1;
   };
-  Logger.prototype.d1a = function () {
-    return this.i1a_1;
+  Logger.prototype.f1a = function () {
+    return this.k1a_1;
   };
-  Logger.prototype.k1a = function (tag) {
-    return new Logger(this.h1a_1, tag);
+  Logger.prototype.m1a = function (tag) {
+    return new Logger(this.j1a_1, tag);
   };
-  Logger.prototype.l1a = function (message) {
-    if (this.h1a_1.p1a().r3(Severity_Info_getInstance()) <= 0) {
-      this.o1a(Severity_Info_getInstance(), this.d1a(), null, message());
+  Logger.prototype.n1a = function (message) {
+    if (this.j1a_1.r1a().s3(Severity_Info_getInstance()) <= 0) {
+      this.q1a(Severity_Info_getInstance(), this.f1a(), null, message());
     }
   };
-  Logger.prototype.m1a = function (message) {
-    if (this.h1a_1.p1a().r3(Severity_Error_getInstance()) <= 0) {
-      this.o1a(Severity_Error_getInstance(), this.d1a(), null, message());
+  Logger.prototype.o1a = function (message) {
+    if (this.j1a_1.r1a().s3(Severity_Error_getInstance()) <= 0) {
+      this.q1a(Severity_Error_getInstance(), this.f1a(), null, message());
     }
   };
-  Logger.prototype.n1a = function (message) {
-    if (this.h1a_1.p1a().r3(Severity_Error_getInstance()) <= 0) {
-      this.o1a(Severity_Error_getInstance(), this.d1a(), null, message);
+  Logger.prototype.p1a = function (message) {
+    if (this.j1a_1.r1a().s3(Severity_Error_getInstance()) <= 0) {
+      this.q1a(Severity_Error_getInstance(), this.f1a(), null, message);
     }
   };
-  Logger.prototype.o1a = function (severity, tag, throwable, message) {
+  Logger.prototype.q1a = function (severity, tag, throwable, message) {
     // Inline function 'co.touchlab.kermit.Logger.processLog' call
     // Inline function 'kotlin.collections.forEach' call
-    var tmp0_forEach = this.h1a_1.q1a();
+    var tmp0_forEach = this.j1a_1.s1a();
     var tmp0_iterator = tmp0_forEach.g();
     while (tmp0_iterator.h()) {
       var element = tmp0_iterator.i();
       // Inline function 'co.touchlab.kermit.Logger.processLog.<anonymous>' call
-      if (element.y19(severity)) {
+      if (element.a1a(severity)) {
         // Inline function 'co.touchlab.kermit.Logger.log.<anonymous>' call
-        element.z19(severity, message, tag, throwable);
+        element.b1a(severity, message, tag, throwable);
       }
     }
   };
   Logger.$metadata$ = classMeta('Logger');
   function LoggerGlobal() {
     LoggerGlobal_instance = this;
-    this.a1a_1 = mutableKermitConfigInit(listOf(platformLogWriter()));
+    this.c1a_1 = mutableKermitConfigInit(listOf(platformLogWriter()));
   }
   LoggerGlobal.$metadata$ = objectMeta('LoggerGlobal');
   var LoggerGlobal_instance;
@@ -209,7 +209,7 @@
   function ConsoleWriter() {
     LogWriter.call(this);
   }
-  ConsoleWriter.prototype.z19 = function (severity, message, tag, throwable) {
+  ConsoleWriter.prototype.b1a = function (severity, message, tag, throwable) {
     var output = '[' + tag + '] ' + message;
     var tmp0_safe_receiver = throwable;
     if (tmp0_safe_receiver == null)
@@ -222,7 +222,7 @@
       tmp$ret$0 = Unit_getInstance();
     }
     var tmp1_subject = severity;
-    var tmp0 = tmp1_subject.p3_1;
+    var tmp0 = tmp1_subject.q3_1;
     switch (tmp0) {
       case 5:
       case 4:
@@ -246,17 +246,17 @@
   };
   ConsoleWriter.$metadata$ = classMeta('ConsoleWriter', undefined, undefined, undefined, undefined, LogWriter.prototype);
   function JsMutableLoggerConfig(logWriters) {
-    this.r1a_1 = get_DEFAULT_MIN_SEVERITY();
-    this.s1a_1 = logWriters;
+    this.t1a_1 = get_DEFAULT_MIN_SEVERITY();
+    this.u1a_1 = logWriters;
   }
-  JsMutableLoggerConfig.prototype.f1a = function (_set____db54di) {
-    this.r1a_1 = _set____db54di;
+  JsMutableLoggerConfig.prototype.h1a = function (_set____db54di) {
+    this.t1a_1 = _set____db54di;
   };
-  JsMutableLoggerConfig.prototype.p1a = function () {
-    return this.r1a_1;
+  JsMutableLoggerConfig.prototype.r1a = function () {
+    return this.t1a_1;
   };
-  JsMutableLoggerConfig.prototype.q1a = function () {
-    return this.s1a_1;
+  JsMutableLoggerConfig.prototype.s1a = function () {
+    return this.u1a_1;
   };
   JsMutableLoggerConfig.$metadata$ = classMeta('JsMutableLoggerConfig', [MutableLoggerConfig]);
   function set_defaultTag(_set____db54di) {