@vonage/client-sdk 0.1.4-alpha.6 → 0.1.4-rc.1

package/README.md

@@ -12,36 +12,76 @@ npm i @vonage/client-sdk
 
 ## SDK setup
 
-To use the client SDK in a Webpack or Vite project:
+### With budler (webpack or vite)
 
-```
+```js
 import './App.css';
-import VoiceClient, { ClientConfig, ConfigRegion } from '@vonage/client-sdk';
+import { VoiceClient, ClientConfig, ConfigRegion } from '@vonage/client-sdk';
+import VoiceClient, { ClientConfig, ConfigRegion } from '@vonage/client-sdk/voice'; // NextJS/Webpack users see note below
 
 const client = new VoiceClient();
 
 // Config is optional but recomended, default region is US
-const config = new ClientConfig(ConfigRegion.US)
-client.setConfig(config)
+const config = new ClientConfig(ConfigRegion.US);
+client.setConfig(config);
 
 function App() {
-
   const createSession = async () => {
-    const token = "my-token"
-    await client.createSession(token)
-  }
+    const token = 'my-token';
+    await client.createSession(token);
+  };
 
-  return (
-    <button onClick={createSession}> create session </button>
-  );
+  return <button onClick={createSession}> create session </button>;
 }
 
 export default App;
 ```
 
+- **Node**: We have a known issue with NextJS / Webpack that means the main import from `@vonage/client-sdk` doesn't work, however if you import from `@vonage/client-sdk/voice` the voice client successfully imports. we are working on a fix.
+
+### With script tag (UMD)
+
+```html
+<!-- <script src="./node_modules/@vonage/client-sdk/dist/vonageClientSDK.js"></script> -->
+<!-- <script src="https://cdn.jsdelivr.net/npm/@vonage/client-sdk@0.1.4/dist/vonageClientSDK.min.js"></script> -->
+<script src="./node_modules/@vonage/client-sdk/dist/vonageClientSDK.min.js"></script>
+<script>
+  const token = 'some-token';
+  const client = new vonageClientSDK.VoiceClient();
+  const config = new vonageClientSDK.ClientConfig(
+    vonageClientSDK.ConfigRegion.EU
+  );
+  client.setConfig(config);
+
+  client.createSession(token).then((Session) => {});
+</script>
+```
+
+### With CDN (ES)
+
+```js
+import {
+  VoiceClient,
+  ClientConfig,
+  ConfigRegion
+} from 'https://cdn.jsdelivr.net/npm/@vonage/client-sdk@0.1.4/dist/vonageClientSDK.esm.min.js';
+
+const client = new VoiceClient();
+
+// Config is optional but recomended, default region is US
+const config = new ClientConfig(ConfigRegion.US);
+client.setConfig(config);
+
+const token = 'my-token';
+client
+  .createSession(token)
+  .then((sessionId) => console.log(sessionId))
+  .catch((err) => console.log(err));
+```
+
 ## Documentation and examples
 
-Visit [vonage website] (https://developer.vonage.com/tools)
+Visit [vonage website] (<https://developer.vonage.com/tools>)
 
 ## License
 

package/dist/index.cjs

@@ -0,0 +1,23 @@
+'use strict';
+
+var voice = require('./voice');
+
+
+
+Object.defineProperty(exports, 'ClientConfig', {
+  enumerable: true,
+  get: function () { return voice.ClientConfig; }
+});
+Object.defineProperty(exports, 'ConfigRegion', {
+  enumerable: true,
+  get: function () { return voice.ConfigRegion; }
+});
+Object.defineProperty(exports, 'LoggingLevel', {
+  enumerable: true,
+  get: function () { return voice.LoggingLevel; }
+});
+exports.VoiceClient = voice;
+Object.defineProperty(exports, 'setDefaultLoggingLevel', {
+  enumerable: true,
+  get: function () { return voice.setDefaultLoggingLevel; }
+});

package/dist/index.d.ts

@@ -1,4 +1 @@
-import './coreExtend';
-export type { Invite, VoiceCall, Conversation, RTCQuality } from './Client';
-export { default as VoiceClient, ClientConfig, ConfigRegion, setDefaultLoggingLevel, LoggingLevel } from './Client';
-export {} from './coreExtend';
+export { default as VoiceClient, ClientConfig, ConfigRegion, setDefaultLoggingLevel, LoggingLevel, Invite, VoiceCall, Conversation, RTCQuality } from './voice';

package/dist/index.mjs

@@ -0,0 +1 @@
+export { ClientConfig, ConfigRegion, LoggingLevel, default as VoiceClient, setDefaultLoggingLevel } from './voice';

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

@@ -6,13 +6,13 @@ export namespace vonage {
         reconnecting(): void;
         reconnection(): void;
         sessionError(reason: string): void;
-        callInvite(invite: vonage.VoiceInviteJS): void;
-        callTransfer(call: vonage.VoiceCallJS, cid: vonage.ConversationJS, prevConversation: vonage.ConversationJS): void;
-        mute(call: vonage.VoiceCallJS, legId: string, isMuted: boolean): void;
-        earmuff(call: vonage.VoiceCallJS, legId: string, earmuffStatus: boolean): void;
-        dtmf(call: vonage.VoiceCallJS, legId: string, digits: string): void;
-        rtcHangup(call: vonage.VoiceCallJS, legId: string, callQuality: vonage.RTCQualityJS): void;
-        legStatusUpdate(call: vonage.VoiceCallJS, legId: string, status: string): void;
+        callInvite(callId: string, invite: vonage.VoiceInviteJS): void;
+        callTransfer(callId: string, cid: vonage.ConversationJS, prevConversation: vonage.ConversationJS): void;
+        mute(callId: string, legId: string, isMuted: boolean): void;
+        earmuff(callId: string, legId: string, earmuffStatus: boolean): void;
+        dtmf(callId: string, legId: string, digits: string): void;
+        rtcHangup(callId: string, legId: string, callQuality: vonage.RTCQualityJS): void;
+        legStatusUpdate(callId: string, legId: string, status: string): void;
     }
     interface CallSayParams {
         readonly text: string;

package/dist/{HttpClient.d.ts → lib/HttpClient.d.ts}

@@ -1,5 +1,5 @@
-import * as KMPPackage from './kotlin/clientsdk-clientcore_js';
-import { vonage } from './kotlin/clientsdk-clientcore_js';
+import * as KMPPackage from '../kotlin/clientsdk-clientcore_js';
+import { vonage } from '../kotlin/clientsdk-clientcore_js';
 type HttpHeaders = Record<string, string | number | boolean>;
 declare class HttpClient implements vonage.HttpClientJS {
     private stringToVerb;

package/dist/{MediaClient.d.ts → lib/MediaClient.d.ts}

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

package/dist/{SocketClient.d.ts → lib/SocketClient.d.ts}

@@ -1,5 +1,5 @@
-import * as KMPPackage from './kotlin/clientsdk-clientcore_js';
-import { vonage } from './kotlin/clientsdk-clientcore_js';
+import * as KMPPackage from '../kotlin/clientsdk-clientcore_js';
+import { vonage } from '../kotlin/clientsdk-clientcore_js';
 declare class SocketClient implements vonage.SocketClientJS {
     delegate: KMPPackage.Nullable<vonage.SocketClientDelegateJS>;
     private socket;

package/dist/{Client.d.ts → voice/VoiceClient.d.ts}

@@ -1,6 +1,6 @@
-import { vonage } from './kotlin/clientsdk-clientcore_js';
-import './coreExtend';
-import './global';
+import { vonage } from '../kotlin/clientsdk-clientcore_js';
+import '../coreExtend';
+import '../global';
 /**
  * Minimal Interface built on top of KMP export
  * DO NOT ADD CODE HERE UNLESS REALLY NEEDEED!!111!
@@ -16,7 +16,7 @@ export declare const setDefaultLoggingLevel: typeof vonage.setDefaultLoggingLeve
 export declare class ClientConfig extends vonage.CoreClientConfigJS {
     constructor(region?: vonage.CoreClientConfigRegionJS);
 }
-declare class VoiceClient extends vonage.CoreClientJS {
+export declare class VoiceClient extends vonage.CoreClientJS {
     private callbacks;
     constructor();
     on<T extends keyof VonageEvent, Fn extends VonageEvent[T]>(event: T, callback: Fn): void;