@digitalsamba/embedded-sdk 0.0.4 → 0.0.6

package/LICENSE

@@ -1,22 +1,25 @@
+BSD 2-Clause License
 
-MIT License
+Copyright (c) 2022, Digital Samba
+All rights reserved.
 
-Copyright (c) 2022 Digital Samba
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -21,7 +21,7 @@ const DigitalSambaEmbedded = require('@digitalsamba/embedded-sdk')
 import DigitalSambaEmbedded from '@digitalsamba/embedded-sdk'
 ```
 
-This package is written in TypeScript, so type defintitions are also available:
+This package is written in TypeScript, so type definitions are also available:
 
 ```ts 
 import { SendMessageType, ReceiveMessageType, /* ...etc */} from '@digitalsamba/embedded-sdk'
@@ -56,9 +56,9 @@ api.load(InstanceProperties /* optional */)
 * `url` - full URL to be applied as frame src. Must include protocol and `token` query param for private rooms;
 * `team` - team name string
 * `room` - room identifier string
-* `token` - optional string, for private rooms
+* `token` - optional string for authentication, mainly for private rooms
 
-To successfuly initialize an instance of the wrapper one of following combinations needs to be used:
+To successfully initialize an instance of the wrapper one of following combinations needs to be used:
 
 * `root + team + room` - will create a controlled frame inside `root` element
 * `frame + team + room` - will attach to existing frame
@@ -77,14 +77,19 @@ Remember to always specify `allow="camera; microphone; display-capture; autoplay
 To listen for events, attach listener for any of supported events:
 
 ```js
-api.on('*', (data) => {
-  console.log(data)
+api.on('userJoined', (data) => {
+  // ...
 });
 
-
-api.on('userJoined', (data) => {
+api.on('userLeft', (data) => {
   // ...
 });
+
+// you can also listen to all events simultaneously 
+api.on('*', (data) => {
+  console.log(data)
+});
+
 ```
 Also see `dist/index.html` for more examples.
 

package/dist/index.html

@@ -5,16 +5,16 @@
   <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
   <meta http-equiv="X-UA-Compatible" content="ie=edge">
   <title>Document</title>
-  <script src="https://unpkg.com/@digitalsamba/embedded-sdk@0.0.1"></script>
+  <script src="https://unpkg.com/@digitalsamba/embedded-sdk@0.0.5"></script>
 </head>
 <body>
 <div class="ifp" style="display: flex">
 
-<!--<iframe allow="camera; microphone; display-capture; autoplay;" src="https://localhost:3000/Public" class="if"></iframe>-->
+<!--<iframe allow="camera; microphone; display-capture; autoplay;" src="<>" class="if"></iframe>-->
 
-  <div class="log">
+<div class="log">
 
-  </div>
+</div>
 
 </div>
 <div class="div" style=" border: 1px solid yellow">
@@ -29,7 +29,7 @@
   <button class="c8">stopScreenshare</button>
 </div>
 <script async defer>
-  const parent = document.querySelector('.isfp');
+  const parent = document.querySelector('.ifp');
   const frame = document.querySelector('.if');
   const btn0 = document.querySelector('.c0');
   const btn1 = document.querySelector('.c1');
@@ -40,17 +40,22 @@
   const btn6 = document.querySelector('.c6');
   const btn7 = document.querySelector('.c7');
   const btn8 = document.querySelector('.c8');
-
-   const api = new DigitalSambaEmbedded({ root: parent, team: 'alex.dev.monza', room: 'Public' });
-//const api = new DigitalSambaEmbedded({ frame});
-//const api = new DigitalSambaEmbedded({ url: 'https://localhost:3000/Public'}, {reportErrors: true});
-
-//const api = DigitalSambaEmbedded.createControl({ url: 'https://localhost:3000/Public'});
+  
+  // change these values to connect to your room
+  const TEAM = 'some-team';
+  const ROOM = 'some-room';
+  const ROOM_URL = 'https://localhost:3000/Public'
+
+  //const api = new DigitalSambaEmbedded({ root: parent, team: TEAM, room: ROOM});
+  //const api = new DigitalSambaEmbedded({ frame});
+  //const api = new DigitalSambaEmbedded({ url: ROOM_URL}, {reportErrors: true});
+  
+  const api = DigitalSambaEmbedded.createControl({ url: ROOM_URL});
 
   const log = document.querySelector('.log');
 
-  api.frame.width = 700;
-  api.frame.height = 500;
+  api.frame.width = 900;
+  api.frame.height = 700;
 
   btn0.onclick = () => {api.load({ frameAttributes: {style: "border: 5px solid red"}, reportErrors: true })}
   btn1.onclick = () => {api.toggleVideo()}
@@ -72,11 +77,9 @@
   });
 
   api.on('userLeft', (data) => {
-    log.innerHTML += `<p>${Number(new Date)}: USER JOINED: ${JSON.stringify(data)}</p>`
+    log.innerHTML += `<p>${Number(new Date)}: USER LEFT: ${JSON.stringify(data)}</p>`
   });
 
-
-
 </script>
 
 </body>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@digitalsamba/embedded-sdk",
   "packageManager": "yarn@3.1.0",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "license" : "BSD-2-Clause",
   "scripts": {
     "build": "npm run build:cjs && npm run build:esm && npm run build:umd && npm run build:types",