@wildix/xbees-connect 1.1.8 → 1.1.12

package/dist-es/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wildix/xbees-connect",
-    "version": "1.1.7",
+    "version": "1.1.9",
     "description": "This library provides easy communication between x-bees and integrated web applications",
     "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
     "homepage": "",

package/dist-es/src/Client.js

@@ -291,4 +291,20 @@ export class Client {
     onStorage(listener) {
         return this.localStorageManager.onStorage(listener);
     }
+    onLogout(callback) {
+        // send event to x-bees
+        void this.sendAsync({
+            type: ClientEventType.LOGOUT_IS_SUPPORTED,
+        });
+        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

@@ -7,6 +7,7 @@ export var EventType;
     EventType["USE_THEME"] = "xBeesUseTheme";
     EventType["PBX_TOKEN"] = "xBeesPbxToken";
     EventType["REDIRECT_QUERY"] = "xBeesRedirectQuery";
+    EventType["LOGOUT"] = "xBeesLogout";
 })(EventType || (EventType = {}));
 export var ClientEventType;
 (function (ClientEventType) {
@@ -27,6 +28,8 @@ export var ClientEventType;
     ClientEventType["CONTACT_LOOKUP_AND_MATCH"] = "xBeesContactLookupAndMatch";
     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

@@ -65,4 +65,6 @@ export declare class Client implements ConnectClient {
     saveToStorage<SavingType>(key: string, value: SavingType): void;
     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

@@ -5,7 +5,8 @@ export declare enum EventType {
     TERMINATE_CALL = "xBeesTerminateCall",
     USE_THEME = "xBeesUseTheme",
     PBX_TOKEN = "xBeesPbxToken",
-    REDIRECT_QUERY = "xBeesRedirectQuery"
+    REDIRECT_QUERY = "xBeesRedirectQuery",
+    LOGOUT = "xBeesLogout"
 }
 export declare enum ClientEventType {
     READY = "xBeesReady",
@@ -24,7 +25,9 @@ export declare enum ClientEventType {
     CONTACTS_AUTO_SUGGEST = "xBeesContactsAutoSuggest",
     CONTACT_LOOKUP_AND_MATCH = "xBeesContactLookupAndMatch",
     CONTACT_LOOKUP_AND_MATCH_NOT_FOUND = "xBeesContactLookupAndMatchNotFound",
-    CONTACT_CREATE_OR_UPDATE = "xBeesContactCreateOrUpdate"
+    CONTACT_CREATE_OR_UPDATE = "xBeesContactCreateOrUpdate",
+    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>;
@@ -242,5 +246,11 @@ export interface ConnectClient {
     /**
      * listens on localStorage */
     onStorage: (listener: StorageEventCallback) => () => void;
+    /**
+     * 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.8",
+  "version": "1.1.12",
   "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": "8d88b055be175fb25e9e1f6cb1d4ce3878013564"
+  "gitHead": "1a59bfec423258c28f82805d2c5719a9e3b1ea76"
 }