@wildix/xbees-connect 1.1.11 → 1.1.13

package/README.md

@@ -81,6 +81,11 @@ Retrieves current x-bees context data. The data may be different depending on co
 
 Retrieves contact data currently opened in x-bees.
 
+#### `getCurrentConversation(): Promise<Response>`
+
+Retrieves conversation data ({id, type}) currently opened in x-bees.
+If the conversation is temporary - retrieves undefined
+
 #### `getThemeMode(): Promise<Response>`
 
 Retrieves current theme mode (light or dark)
@@ -139,6 +144,14 @@ Starts listening for one of the x-bees events and returns the provided callback
 
 Stops listening for one of the x-bees events with the particular callback
 
+#### `onLogout()`
+
+Starts listen on logout event and send event to the xbees about logout able
+
+#### `sendAnalytics()`
+
+Sends analytics data to xbees for track into analytics data
+
 ## Known issues
 
 The below function can fix cases when `String.replaceAll()` does not work in the mobile version. Most likely, this is some kind of WebView bug.

package/dist-es/src/Client.js

@@ -298,4 +298,13 @@ export class Client {
         });
         return this.addEventListener(EventType.LOGOUT, callback);
     }
+    sendAnalytics(eventName, params) {
+        void this.sendAsync({
+            type: ClientEventType.SEND_ANALYTICS,
+            payload: {
+                eventName,
+                params,
+            },
+        });
+    }
 }

package/dist-es/src/enums/index.js

@@ -29,6 +29,7 @@ export var ClientEventType;
     ClientEventType["CONTACT_LOOKUP_AND_MATCH_NOT_FOUND"] = "xBeesContactLookupAndMatchNotFound";
     ClientEventType["CONTACT_CREATE_OR_UPDATE"] = "xBeesContactCreateOrUpdate";
     ClientEventType["LOGOUT_IS_SUPPORTED"] = "xBeesLogoutIsSupported";
+    ClientEventType["SEND_ANALYTICS"] = "xBeesSendAnalytics";
 })(ClientEventType || (ClientEventType = {}));
 export var DeprecatedUrlParams;
 (function (DeprecatedUrlParams) {

package/dist-types/src/Client.d.ts

@@ -66,4 +66,5 @@ export declare class Client implements ConnectClient {
     deleteFromStorage(key: string): void;
     onStorage(listener: StorageEventCallback): () => void;
     onLogout(callback: Callback<EventType.LOGOUT>): RemoveEventListener;
+    sendAnalytics(eventName: string, params?: Record<string, string>): void;
 }

package/dist-types/src/enums/index.d.ts

@@ -26,7 +26,8 @@ export declare enum ClientEventType {
     CONTACT_LOOKUP_AND_MATCH = "xBeesContactLookupAndMatch",
     CONTACT_LOOKUP_AND_MATCH_NOT_FOUND = "xBeesContactLookupAndMatchNotFound",
     CONTACT_CREATE_OR_UPDATE = "xBeesContactCreateOrUpdate",
-    LOGOUT_IS_SUPPORTED = "xBeesLogoutIsSupported"
+    LOGOUT_IS_SUPPORTED = "xBeesLogoutIsSupported",
+    SEND_ANALYTICS = "xBeesSendAnalytics"
 }
 export declare enum DeprecatedUrlParams {
     TOKEN = "token",

package/dist-types/types/index.d.ts

@@ -66,7 +66,11 @@ export interface IPayloadContactResult {
 }
 export interface IPayloadContextResult extends IPayloadContactResult {
 }
-type EventPayload<T extends MessageType> = T extends EventType.GET_CONTACTS_AUTO_SUGGEST ? string : T extends ClientEventType.CONTACTS_AUTO_SUGGEST ? IPayloadAutoSuggestResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH ? IPayloadContactMatchResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH_NOT_FOUND ? IPayloadContactMatchResultNotFound : T extends ClientEventType.CONTACT_CREATE_OR_UPDATE ? IPayloadContactMatchResult : T extends ClientEventType.CONTEXT ? IPayloadContextResult : T extends ClientEventType.CURRENT_CONTACT ? IPayloadContactResult : T extends EventType.ADD_CALL ? IPayloadCallStartedInfo : T extends ClientEventType.START_CALL ? IPayloadCallStart : T extends ClientEventType.READY ? IPayloadVersion : T extends ClientEventType.VIEW_PORT ? IPayloadViewPort : T extends ClientEventType.THEME ? IPayloadThemeChange : T extends EventType.USE_THEME ? IPayloadThemeChange : T extends ClientEventType.TOAST ? IPayloadToast : T extends EventType.PBX_TOKEN ? string : T extends ClientEventType.TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : never;
+export interface IPayloadSendAnalytics {
+    eventName: string;
+    params?: Record<string, string>;
+}
+type EventPayload<T extends MessageType> = T extends EventType.GET_CONTACTS_AUTO_SUGGEST ? string : T extends ClientEventType.CONTACTS_AUTO_SUGGEST ? IPayloadAutoSuggestResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH ? IPayloadContactMatchResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH_NOT_FOUND ? IPayloadContactMatchResultNotFound : T extends ClientEventType.CONTACT_CREATE_OR_UPDATE ? IPayloadContactMatchResult : T extends ClientEventType.CONTEXT ? IPayloadContextResult : T extends ClientEventType.CURRENT_CONTACT ? IPayloadContactResult : T extends EventType.ADD_CALL ? IPayloadCallStartedInfo : T extends ClientEventType.START_CALL ? IPayloadCallStart : T extends ClientEventType.READY ? IPayloadVersion : T extends ClientEventType.VIEW_PORT ? IPayloadViewPort : T extends ClientEventType.THEME ? IPayloadThemeChange : T extends EventType.USE_THEME ? IPayloadThemeChange : T extends ClientEventType.TOAST ? IPayloadToast : T extends ClientEventType.SEND_ANALYTICS ? IPayloadSendAnalytics : T extends EventType.PBX_TOKEN ? string : T extends ClientEventType.TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : never;
 export type Message<T extends MessageType = MessageType> = {
     type: T;
     payload?: EventPayload<T>;
@@ -245,5 +249,8 @@ export interface ConnectClient {
     /**
      * starts listen on logout event and send event to the xbees about logout able */
     onLogout: (callback: Callback<EventType.LOGOUT>) => RemoveEventListener;
+    /**
+     * send analytics data to xbees for track into analytics data */
+    sendAnalytics: (eventName: string, params?: Record<string, string>) => void;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wildix/xbees-connect",
-  "version": "1.1.11",
+  "version": "1.1.13",
   "description": "This library provides easy communication between x-bees and integrated web applications",
   "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
   "homepage": "",
@@ -42,5 +42,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "106c5ae830969189ce148276124aca70c8be3325"
+  "gitHead": "f61ad8eeaa80bcaf32fb3a897c1aeca47d09ba9a"
 }