@webex/calling 0.0.1-next.7 → 0.0.1-next.8

package/README.md

@@ -1,52 +1,74 @@
-# @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
 cd web-js-sdk/
 yarn install
 ```
 
-### Building
+## Building
 
 If your project needs some additional steps for the developer to build the
 project after some code changes, state them here:
 
-```shell
+```bash
 yarn workspaces foreach --parallel --verbose run build:src
 
 yarn build:local
 ```
 
-### 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
-
-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.
+## 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)
 
+```javascript
+  yarn add @webex/calling
+```
 
-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
+```javascript
+  import Calling from '@webex/calling'
 ```
-(or)
-```shell 
-yarn add @webex/web-calling-sdk
-```
+# CDN
+```javascript
+  <script src="../calling.min.js"></script>
+```
+
+### Kitchen Sink App
+To test Calling SDK API, use this Kitchen Sink app: https://webex.github.io/webex-js-sdk/samples/calling/ 
+
+
+
+

package/dist/module/CallHistory/CallHistory.js

@@ -70,9 +70,6 @@ export class CallHistory extends Eventing {
             return errorStatus;
         }
     }
-    getSDKConnector() {
-        return this.sdkConnector;
-    }
     registerSessionsListener() {
         this.sdkConnector.registerListener(MOBIUS_EVENT_KEYS.CALL_SESSION_EVENT_INCLUSIVE, async (event) => {
             if (event && event.data.userSessions.userSessions) {

package/dist/module/Contacts/ContactsClient.js

@@ -24,9 +24,6 @@ export class ContactsClient {
         this.defaultGroupId = '';
         log.setLogger(logger.level, CONTACTS_FILE);
     }
-    getSDKConnector() {
-        return this.sdkConnector;
-    }
     async decryptContactDetail(encryptionKeyUrl, contactDetails) {
         const decryptedContactDetail = [...contactDetails];
         const decryptedValues = await Promise.all(decryptedContactDetail.map((detail) => this.webex.internal.encryption.decryptText(encryptionKeyUrl, detail.value)));

package/dist/module/api.js

@@ -0,0 +1,6 @@
+import { CallHistory } from './CallHistory/CallHistory';
+import { CallSettings } from './CallSettings/CallSettings';
+import { CallingClient } from './CallingClient/CallingClient';
+import { ContactsClient } from './Contacts/ContactsClient';
+import { Voicemail } from './Voicemail/Voicemail';
+export { CallHistory, CallSettings, CallingClient, ContactsClient, Voicemail };

package/package.json

@@ -31,7 +31,7 @@
     "test:style": "eslint 'src/**/*.ts'",
     "fix:lint": "eslint 'src/**/*.ts' --fix",
     "fix:prettier": "prettier \"src/**/*.ts\" --write",
-    "build:docs": "typedoc --out docs/",
+    "build:docs": "typedoc --out ../../docs/calling",
     "docs": "typedoc --emit none",
     "deploy:npm": "npm publish"
   },
@@ -97,7 +97,7 @@
     "sinon": "12.0.1",
     "ts-jest": "27.1.4",
     "typed-emitter": "2.1.0",
-    "typedoc": "0.22.13",
+    "typedoc": "0.23.26",
     "typescript": "4.9.5"
   },
   "commitlint": {
@@ -129,5 +129,5 @@
     "staticpath": "docs",
     "noprompt": true
   },
-  "version": "0.0.1-next.7"
+  "version": "0.0.1-next.8"
 }