@webex/calling - npm Package Compare versions

Comparing version 0.0.1-next.7 to 0.0.1-next.8

dist/module/CallHistory/CallHistory.js

@@ -73,5 +73,2 @@ import SDKConnector from '../SDKConnector';
     }
-    getSDKConnector() {
-        return this.sdkConnector;
-    }
     registerSessionsListener() {
@@ -78,0 +75,0 @@ this.sdkConnector.registerListener(MOBIUS_EVENT_KEYS.CALL_SESSION_EVENT_INCLUSIVE, async (event) => {

dist/module/Contacts/ContactsClient.js

@@ -27,5 +27,2 @@ import { FAILURE_MESSAGE, STATUS_CODE, SUCCESS_MESSAGE } from '../common/constants';
     }
-    getSDKConnector() {
-        return this.sdkConnector;
-    }
     async decryptContactDetail(encryptionKeyUrl, contactDetails) {
@@ -32,0 +29,0 @@ const decryptedContactDetail = [...contactDetails];

package.json

@@ -34,3 +34,3 @@ {
     "fix:prettier": "prettier \"src/**/*.ts\" --write",
-    "build:docs": "typedoc --out docs/",
+    "build:docs": "typedoc --out ../../docs/calling",
     "docs": "typedoc --emit none",
@@ -101,3 +101,3 @@ "deploy:npm": "npm publish"
     "typed-emitter": "2.1.0",
-    "typedoc": "0.22.13",
+    "typedoc": "0.23.26",
     "typescript": "4.9.5"
@@ -134,3 +134,3 @@ },
   },
-  "version": "0.0.1-next.7"
+  "version": "0.0.1-next.8"
 }

README.md

@@ -1,13 +0,22 @@
-# @webex/calling
+### Table of Contents
+- [Getting Started](#getting-started)
+- [Developing](#developing)
+- [Building](#building) 
+- [Testing](#testing)
+- [Samples](#samples) 
+- [Consuming SDK](#consuming-sdk)
+  - [NPM](#npm)
+  - [CDN](#cdn)
+- [Kitchen Sink App](#kitchen-sink-app)
+---
 
+## Getting Started
 With the Webex Calling SDK, you can effortlessly integrate fundamental audio calling capabilities into your solutions, enhancing the way your users connect.
 
-> [Introduction to the Webex Web Calling SDK](https://github.com/webex/webex-js-sdk/wiki/Introducing-the-Webex-Web-Calling-SDK)
-> [Quickstart guide](https://github.com/webex/webex-js-sdk/wiki/Quickstart-Guide-(Calling))
-> API guide - TBD
-
+- [Introduction to the Webex Web Calling SDK](https://github.com/webex/webex-js-sdk/wiki/Introducing-the-Webex-Web-Calling-SDK)
+- [Quickstart guide](https://github.com/webex/webex-js-sdk/wiki/Quickstart-Guide-(Calling)).
  
 ## Developing
 
-```shell
+```bash
 git clone https://github.com/\<your-fork\>/webex-js-sdk.git
@@ -18,3 +27,3 @@ cd web-js-sdk/
 
-### Building
+## Building
 
@@ -24,3 +33,3 @@ If your project needs some additional steps for the developer to build the
 
-```shell
+```bash
 yarn workspaces foreach --parallel --verbose run build:src
@@ -31,25 +40,38 @@
 
-### Testing
+## Testing
 
-```shell
+```bash
  yarn workspace @webex/calling run test
 ```
 
-### Testing on samples
-```shell
- yarn run samples:serve
+## Samples 
+```bash
+  yarn run samples:serve
 ```
 
-### Consuming the SDK
+## Consuming SDK
+To consume the latest stable version of the Calling SDK one can use NPM or CDN.
+# NPM
+```javascript
+  npm install @webex/calling
+```
+(or)
 
-The Calling package can be incorporated into an existing project by updating the package.json. Add the line pasted below to get access to the calling-sdk package located in the artifactory.
+```javascript
+  yarn add @webex/calling
+```
 
+```javascript
+  import Calling from '@webex/calling'
+```
+# CDN
+```javascript
+  <script src="../calling.min.js"></script>
+```
 
-Use the following commands to update the package.json and package.lock/yarn.lock with the latest version of the calling-sdk package.
-```shell
-npm install @webex/web-calling-sdk
-```
-(or)
-```shell 
-yarn add @webex/web-calling-sdk
-```
+### Kitchen Sink App
+To test Calling SDK API, use this Kitchen Sink app: https://webex.github.io/webex-js-sdk/samples/calling/ 
+
+
+
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

389921

increased by0.13%

Number of package files

62

increased by1.64%

Number of lines in readme file

75

increased by44.23%

No dependency changes