@wxcc-desktop/sdk 1.3.16 → 2.0.0

package/README.md

@@ -1,7 +1,9 @@
 # WxCC Agent Desktop JS-API
+
 WxCC Agent Desktop JS API modules set
 
 ## Root module (`Desktop`) includes:
+
 - Config module
 - I18N module
 - Actions module
@@ -13,9 +15,10 @@ WxCC Agent Desktop JS API modules set
 - AQM/Notifs **screenpop** service layer API module for WxCC Agent Desktop.
 
 ### `Desktop` module
+
 Desktop module contains sub-modules:
 
-```Javascript
+````Javascript
 import { Desktop } from "@wxcc-desktop/sdk";
 
 const {
@@ -31,22 +34,27 @@ const {
   dialer,
   screenpop
 } = Desktop;
-```
+
+###`Desktop config` sub-module
+```Javascript
+import { Desktop } from "@wxcc-desktop/sdk";
+
+Desktop.config.init({widgetName: "widgetName", widgetProvider: "widgetProvider"});
 
 ### `Desktop.logger` sub-module
-`Desktop.logger` sub-module is intended to create & maintain client-side logger's instances for third-party widgets.   
+`Desktop.logger` sub-module is intended to create & maintain client-side logger's instances for third-party widgets.
 ```Javascript
 import { Desktop } from "@wxcc-desktop/sdk";
 
 //...
 
-/* 
+/*
   Supposing Desktop.config.init() was called
 */
 
 const logerOne = Desktop.logger.createLogger("for-service-one");
 const logerTwo = Desktop.logger.createLogger("for-service-two");
-    
+
 logerOne.info("Info test"); // console.log => "for-service-one: Info:test"
 logerTwo.warn("Warn test"); // console.log => "for-service-two: Warn:test"
 logerOne.error("Error test"); // console.log => "for-service-one: Error:test"
@@ -70,12 +78,13 @@ Desktop.logger.getLogsTextUrl("for-service-one");
 Desktop.logger.cleanupPrefixedLogs("for-service-one");
 
 //...
-```
+````
 
 ### `Desktop.i18n` sub-module
-`Desktop.i18n` sub-module is intended to create & maintain client-side i18n & lit-element i18nMixin instances for third-party widgets.   
 
-Desktop.i18n instantinating object is described in:  https://www.i18next.com/overview/api#instance-creation
+`Desktop.i18n` sub-module is intended to create & maintain client-side i18n & lit-element i18nMixin instances for third-party widgets.
+
+Desktop.i18n instantinating object is described in: https://www.i18next.com/overview/api#instance-creation
 
 i18n instance backend configuration described in: https://github.com/i18next/i18next-http-backend
 
@@ -91,13 +100,13 @@ import { html } from "lit-html";
 
 //...
 
-/* 
+/*
   Desktop.i18n service MAY NOT NEED to wait for Desktop.config.init({...}) was called for proper work
 */
 
 // All CreateOotions for i18n are optional
 type CreateOptions = {
-  logger?: 
+  logger?:
       |  {
            log(...args: any[]): void;
            warn(...args: any[]): void;
@@ -142,6 +151,7 @@ export class MyAwesomeComponent extends i18nMixin(LitElement) {
 ```
 
 ### `Desktop.actions` sub-module
+
 `Desktop.actions` sub-module is intended to make a calls into and/or get data from AgentX store.
 
 ```Javascript
@@ -149,7 +159,7 @@ import { Desktop } from "@wxcc-desktop/sdk";
 
 //...
 
-/* 
+/*
   Supposing Desktop.config.init() was called
 */
 
@@ -157,8 +167,8 @@ import { Desktop } from "@wxcc-desktop/sdk";
 // AgentX General Notifications:
 Desktop.actions.fireGeneralSilentNotification({...}) // => Fires silent notification in AgentX. One way
 
-// Unlike silent notification, autodismiss and acknowledge can have controlled responses, that may reflect in status, e.g.: 
-const [ status, reason, mode ]: [ Notifications.ItemMeta.Status, Notifications.ItemMeta.StatusChangeEventReason, Notifications.ItemMeta.Mode ] = await Desktop.actions.fireGeneralAutoDismissNotification({...}) // => Fires autudismiss notification in AgentX. Returns notification resolved status, reason, mode. NOTE: if AgentX notifications disabled - it will be converted into silent and reflected in "mode"  
+// Unlike silent notification, autodismiss and acknowledge can have controlled responses, that may reflect in status, e.g.:
+const [ status, reason, mode ]: [ Notifications.ItemMeta.Status, Notifications.ItemMeta.StatusChangeEventReason, Notifications.ItemMeta.Mode ] = await Desktop.actions.fireGeneralAutoDismissNotification({...}) // => Fires autudismiss notification in AgentX. Returns notification resolved status, reason, mode. NOTE: if AgentX notifications disabled - it will be converted into silent and reflected in "mode"
 const [ status, reason, mode ]: [ Notifications.ItemMeta.Status, Notifications.ItemMeta.StatusChangeEventReason, Notifications.ItemMeta.Mode ] = await Desktop.actions.fireGeneralAcknowledgeNotification({...}) // => Fires acknowledge notification in AgentX. Returns notification resolved status, reason, mode. NOTE: if AgentX notifications disabled - it will be converted into silent and reflected in "mode"
 
 
@@ -187,13 +197,15 @@ const toggle = Desktop.actions.toggleMiximizeRestore(e: Event) // => maximize/re
 ```
 
 ### `Desktop.shortcutKey` sub-module
-`Desktop.shortcutKey` sub-module is intended to register and call shortcut keys actions from widgets.   
+
+`Desktop.shortcutKey` sub-module is intended to register and call shortcut keys actions from widgets.
+
 ```Javascript
 import { Desktop } from "@wxcc-desktop/sdk";
 
 //...
 
-/* 
+/*
   Supposing Desktop.config.init() was called
 */
 
@@ -219,13 +231,15 @@ Desktop.shortcutKey.unregisterKeys('widget-one-example'); //=> used to unregiste
 ```
 
 ### `Desktop.agentContact` sub-module
+
 `Desktop.agentContact` sub-module is intended to make aqm requests and listen to notifs events related to agent-contact entity.
+
 ```Javascript
 import { Desktop } from "@wxcc-desktop/sdk";
 
 //...
 
-/* 
+/*
   Supposing Desktop.config.init() was called
 */
 
@@ -290,7 +304,9 @@ Desktop.agentContact.removeAllEventListeners();
 ```
 
 ### `Desktop.agentStateInfo` sub-module
+
 `Desktop.agentStateInfo` sub-module is intended to listen for latest data updates for data:
+
 ```Javascript
 type LatestInfoData = {
   teamId?: string;
@@ -311,18 +327,18 @@ import { Desktop } from "@wxcc-desktop/sdk";
 
 //...
 
-/* 
+/*
   Supposing Desktop.config.init() was called
 */
 
-// latestData inludes latest data fields 
+// latestData inludes latest data fields
 const latestData: LatestInfoData = Desktop.agentStateInfo.latestData;
 
 //...
 // Cumulative update event supported
 Desktop.agentStateInfo.addEventListener("updated", updatedList =>
-  console.log(updatedList) 
- /* will log (in case of "dn", "status", "subStatus" fields were updated 
+  console.log(updatedList)
+ /* will log (in case of "dn", "status", "subStatus" fields were updated
   [
     {
       "name": "dn",
@@ -339,7 +355,7 @@ Desktop.agentStateInfo.addEventListener("updated", updatedList =>
       "value": "Available",
       "oldValue": ""
     }
-  ] 
+  ]
 */
 );
 
@@ -351,13 +367,15 @@ await Desktop.agentStateInfo.fetchAddressBooks({ ... });
 ```
 
 ### `Desktop.dialer` sub-module
+
 `Desktop.dialer` sub-module is intended to make aqm requests and listen to notifs events related to dialer entity.
+
 ```Javascript
 import { Desktop } from "@wxcc-desktop/sdk";
 
 //...
 
-/* 
+/*
   Supposing Desktop.config.init() was called
 */
 
@@ -382,13 +400,15 @@ Desktop.dialer.removeAllEventListeners();
 ```
 
 ### `Desktop.monitoring` sub-module
+
 `Desktop.monitoring` sub-module is intended to make aqm requests and listen to notifs events related to call monitoring entity.
+
 ```Javascript
 import { Desktop } from "@wxcc-desktop/sdk";
 
 //...
 
-/* 
+/*
   Supposing Desktop.config.init() was called
 */
 
@@ -468,13 +488,15 @@ Desktop.monitoring.removeAllEventListeners();
 ```
 
 ### `Desktop.screenpop` sub-module
+
 `Desktop.screenpop` sub-module is intended to make aqm requests and listen to notifs events related to screenpop entity.
+
 ```Javascript
 import { Desktop } from "@wxcc-desktop/sdk";
 
 //...
 
-/* 
+/*
   Supposing Desktop.config.init() was called
 */
 
@@ -495,10 +517,12 @@ Desktop.screenpop.removeAllEventListeners();
 
 ```
 
-###  `Desktop.postInteraction` sub-module
+### `Desktop.postInteraction` sub-module
+
 `Desktop.postInteraction` sub-module is intended to fetch lists of audio recordings and a specific captured audio recording for supervisors.
+
 ```Javascript
-/* 
+/*
   Supposing Desktop.config.init() was called
 */
 
@@ -510,8 +534,9 @@ await Desktop.postInteraction.fetchCapture({taskId});
 
 ```
 
-### Publishing the wxcc-desktop/js-api	
-For publishing internally to Internal Cisco Repository: `yarn npm:publish:internal`	
-For publishing to both Internal and public Repo : `yarn publish:external`	
+### Publishing the wxcc-desktop/js-api
+
+For publishing internally to Internal Cisco Repository: `yarn npm:publish:internal`
+For publishing to both Internal and public Repo : `yarn publish:external`
 
 `publish:all` responsible for publishing in both first internal repository and then to the external public repository npmjs