@wildix/xbees-connect 1.1.3 → 1.1.4

package/dist-es/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wildix/xbees-connect",
-    "version": "1.1.2",
+    "version": "1.1.4-y.0",
     "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

@@ -116,6 +116,12 @@ export class Client {
     getUserEmail() {
         return this.userEmail;
     }
+    getReferrer() {
+        return this.referrer;
+    }
+    getBackToAppUrl() {
+        return `${this.referrer}/integrations/${this.iframeId}`;
+    }
     isDataOnly() {
         return this.variant === 'no-ui' || this.variant === 'daemon';
     }
@@ -201,14 +207,17 @@ export class Client {
         this.localStorageManager.removeOnStorage(callback);
         this.removeEventListener(null, callback);
     }
+    onRedirectQuery(callback) {
+        return this.addEventListener(EventType.REDIRECT_QUERY, callback);
+    }
     onCallEnded(callback) {
-        this.addEventListener(EventType.TERMINATE_CALL, callback);
+        return this.addEventListener(EventType.TERMINATE_CALL, callback);
     }
     onCallStarted(callback) {
-        this.addEventListener(EventType.ADD_CALL, callback);
+        return this.addEventListener(EventType.ADD_CALL, callback);
     }
     onPbxTokenChange(callback) {
-        this.addEventListener(EventType.PBX_TOKEN, callback);
+        return this.addEventListener(EventType.PBX_TOKEN, callback);
     }
     onSuggestContacts(callback) {
         return this.addEventListener(EventType.GET_CONTACTS_AUTO_SUGGEST, (query) => {
@@ -251,7 +260,7 @@ export class Client {
         });
     }
     onThemeChange(callback) {
-        this.addEventListener(EventType.USE_THEME, callback);
+        return this.addEventListener(EventType.USE_THEME, callback);
     }
     getFromStorage(key) {
         return this.localStorageManager.retrieve(key);

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

@@ -6,6 +6,7 @@ export var EventType;
     EventType["TERMINATE_CALL"] = "xBeesTerminateCall";
     EventType["USE_THEME"] = "xBeesUseTheme";
     EventType["PBX_TOKEN"] = "xBeesPbxToken";
+    EventType["REDIRECT_QUERY"] = "xBeesRedirectQuery";
 })(EventType || (EventType = {}));
 export var ClientEventType;
 (function (ClientEventType) {

package/dist-es/src/helpers/LocalStorageManager.js

@@ -37,8 +37,7 @@ class LocalStorageManager {
         return '';
     }
     shouldUseIntegrationKey() {
-        return (window.location.host.endsWith('integrations.x-bees.com') ||
-            window.location.pathname.endsWith('/index.html'));
+        return window.location.host.endsWith('integrations.x-bees.com');
     }
     save(key, value) {
         // Save data to localStorage

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

@@ -29,6 +29,8 @@ export declare class Client implements ConnectClient {
     isPlatformWeb(): boolean;
     getUserPbxToken(): string;
     getUserEmail(): string;
+    getReferrer(): string;
+    getBackToAppUrl(): string;
     isDataOnly(): boolean;
     isSetupDialog(): boolean;
     showsUi(): boolean;
@@ -49,12 +51,13 @@ export declare class Client implements ConnectClient {
     addEventListener<T extends EventType = EventType>(eventName: T, callback: Callback<T>): RemoveEventListener;
     removeEventListener<T extends EventType = EventType>(eventName: T | null, callback: Callback<T>): void;
     off(callback: Callback | StorageEventCallback): void;
-    onCallEnded(callback: Callback<EventType.TERMINATE_CALL>): void;
-    onCallStarted(callback: Callback<EventType.ADD_CALL>): void;
-    onPbxTokenChange(callback: Callback<EventType.PBX_TOKEN>): void;
+    onRedirectQuery(callback: Callback<EventType.REDIRECT_QUERY>): RemoveEventListener;
+    onCallEnded(callback: Callback<EventType.TERMINATE_CALL>): RemoveEventListener;
+    onCallStarted(callback: Callback<EventType.ADD_CALL>): RemoveEventListener;
+    onPbxTokenChange(callback: Callback<EventType.PBX_TOKEN>): RemoveEventListener;
     onSuggestContacts(callback: (query: string, resolve: SuggestContactsResolver, reject: Reject) => void): RemoveEventListener;
     onLookupAndMatchContact(callback: (query: ContactQuery, resolve: LookupAndMatchContactsResolver, reject: Reject) => void): RemoveEventListener;
-    onThemeChange(callback: Callback<EventType.USE_THEME>): void;
+    onThemeChange(callback: Callback<EventType.USE_THEME>): RemoveEventListener;
     getFromStorage<Type>(key: string): Type | null;
     saveToStorage<SavingType>(key: string, value: SavingType): void;
     deleteFromStorage(key: string): void;

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

@@ -4,7 +4,8 @@ export declare enum EventType {
     ADD_CALL = "xBeesAddCall",
     TERMINATE_CALL = "xBeesTerminateCall",
     USE_THEME = "xBeesUseTheme",
-    PBX_TOKEN = "xBeesPbxToken"
+    PBX_TOKEN = "xBeesPbxToken",
+    REDIRECT_QUERY = "xBeesRedirectQuery"
 }
 export declare enum ClientEventType {
     READY = "xBeesReady",

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

@@ -77,6 +77,7 @@ export type EventPayloadMap = {
     [EventType.ADD_CALL]: IPayloadCallStartedInfo;
     [EventType.USE_THEME]: IPayloadThemeChange;
     [EventType.PBX_TOKEN]: string;
+    [EventType.REDIRECT_QUERY]: string;
 };
 export type EventCallbackMap = {
     [EventType.GET_CONTACTS_AUTO_SUGGEST]: (query: EventPayloadMap[EventType.GET_CONTACTS_AUTO_SUGGEST]) => void;
@@ -84,6 +85,7 @@ export type EventCallbackMap = {
     [EventType.ADD_CALL]: (callStartInfo: EventPayloadMap[EventType.ADD_CALL]) => void;
     [EventType.USE_THEME]: (theme: EventPayloadMap[EventType.USE_THEME]) => void;
     [EventType.PBX_TOKEN]: (token: EventPayloadMap[EventType.PBX_TOKEN]) => void;
+    [EventType.REDIRECT_QUERY]: (query: EventPayloadMap[EventType.REDIRECT_QUERY]) => void;
 };
 export type StorageEventCallback = (event: StorageEvent) => void;
 export type Callback<T extends EventType = EventType> = T extends keyof EventCallbackMap ? EventCallbackMap[T] : DefaultCallback;
@@ -110,6 +112,12 @@ export interface ConnectClient {
     /**
      * Retrieves current user's email */
     getUserEmail: () => string;
+    /**
+     * Retrieves url for x-bees app which uses integration */
+    getReferrer: () => string;
+    /**
+     * Retrieves url to get back to x-bees app integration */
+    getBackToAppUrl: () => string;
     /**
      * Retrieves the version of xBeesConnect */
     version: () => string;
@@ -181,10 +189,10 @@ export interface ConnectClient {
     removeEventListener: <T extends EventType = EventType>(eventName: T, callback: Callback<T>) => void;
     /**
      * Starts listen for the events of changing theme and handle with the provided callback */
-    onThemeChange: (callback: Callback<EventType.USE_THEME>) => void;
+    onThemeChange: (callback: Callback<EventType.USE_THEME>) => RemoveEventListener;
     /**
      * Starts listen for the events of changing pbx token and handle with the provided callback */
-    onPbxTokenChange: (callback: Callback<EventType.PBX_TOKEN>) => void;
+    onPbxTokenChange: (callback: Callback<EventType.PBX_TOKEN>) => RemoveEventListener;
     /**
      * Starts listen for the events of searching contacts and handle autosuggestion with the provided callback */
     onSuggestContacts: (callback: (query: string, resolve: SuggestContactsResolver, reject: Reject) => void) => RemoveEventListener;
@@ -193,10 +201,13 @@ export interface ConnectClient {
     onLookupAndMatchContact: (callback: (query: ContactQuery, resolve: LookupAndMatchContactsResolver, reject: Reject) => void) => RemoveEventListener;
     /**
      * Starts listen for the events of starting the call and handle with the provided callback */
-    onCallStarted: (callback: Callback<EventType.ADD_CALL>) => void;
+    onCallStarted: (callback: Callback<EventType.ADD_CALL>) => RemoveEventListener;
     /**
      * Starts listen for the events of ending the call and handle with the provided callback */
-    onCallEnded: (callback: Callback<EventType.TERMINATE_CALL>) => void;
+    onCallEnded: (callback: Callback<EventType.TERMINATE_CALL>) => RemoveEventListener;
+    /**
+     * Starts listen for redirect query message which fires when user opens app with deeplink to integration */
+    onRedirectQuery: (callback: Callback<EventType.REDIRECT_QUERY>) => RemoveEventListener;
     /**
      * Removes particular callback from handling events */
     off: (callback: Callback | StorageEventCallback) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wildix/xbees-connect",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "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": "435537928a3ad44f978eb4ab850d66d5729f06dc"
+  "gitHead": "485f83d2aa614de28b039aaa7c3bc788e10cbbb9"
 }