@wildix/xbees-connect 1.1.2 → 1.1.4-y.0

package/dist-es/package.json

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

@@ -35,6 +35,7 @@ export class Client {
     userEmail;
     referrer;
     needAuthorize;
+    isParentReactNativeWebView;
     iframeId;
     variant = null;
     localStorageManager = LocalStorageManager.getInstance();
@@ -47,7 +48,8 @@ export class Client {
         this.referrer = (params.get(UrlParams.REFERRER) ?? params.get(DeprecatedUrlParams.REFERRER));
         this.needAuthorize = (params.has(UrlParams.AUTHORIZE) ?? params.has(DeprecatedUrlParams.AUTHORIZE));
         // @ts-expect-error window.ReactNativeWebView will be provided by ReactNative WebView
-        this.worker = window.ReactNativeWebView
+        this.isParentReactNativeWebView = !!window.ReactNativeWebView;
+        this.worker = this.isParentReactNativeWebView
             ? new PostMessageControllerNative()
             : new PostMessageControllerWeb();
         this.addEventListener(EventType.PBX_TOKEN, (token) => this.userToken = token);
@@ -102,15 +104,30 @@ export class Client {
     version() {
         return packageJson.version;
     }
+    isPlatformNative() {
+        return this.isParentReactNativeWebView;
+    }
+    isPlatformWeb() {
+        return !this.isParentReactNativeWebView;
+    }
     getUserPbxToken() {
         return this.userToken;
     }
     getUserEmail() {
         return this.userEmail;
     }
+    getReferrer() {
+        return this.referrer;
+    }
+    getBackToAppUrl() {
+        return `${this.referrer}/integrations/${this.iframeId}`;
+    }
     isDataOnly() {
         return this.variant === 'no-ui' || this.variant === 'daemon';
     }
+    isSetupDialog() {
+        return this.variant === 'd' || this.variant === 'dialog';
+    }
     showsUi() {
         return !this.isDataOnly();
     }
@@ -252,6 +269,6 @@ export class Client {
         this.localStorageManager.delete(key);
     }
     onStorage(listener) {
-        this.localStorageManager.onStorage(listener);
+        return this.localStorageManager.onStorage(listener);
     }
 }

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
@@ -64,6 +63,7 @@ class LocalStorageManager {
     }
     onStorage(listener) {
         this.listeners.add(listener);
+        return () => this.removeOnStorage(listener);
     }
     removeOnStorage(listener) {
         this.listeners.delete(listener);

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

@@ -15,6 +15,7 @@ export declare class Client implements ConnectClient {
     private readonly userEmail;
     private readonly referrer;
     private readonly needAuthorize;
+    private readonly isParentReactNativeWebView;
     private readonly iframeId;
     private readonly variant;
     private readonly localStorageManager;
@@ -24,9 +25,14 @@ export declare class Client implements ConnectClient {
     private onMessage;
     ready(): Promise<ResponseMessage<ClientEventType.READY>>;
     version(): string;
+    isPlatformNative(): boolean;
+    isPlatformWeb(): boolean;
     getUserPbxToken(): string;
     getUserEmail(): string;
+    getReferrer(): string;
+    getBackToAppUrl(): string;
     isDataOnly(): boolean;
+    isSetupDialog(): boolean;
     showsUi(): boolean;
     isActivationOnly(): boolean;
     getContext(): Promise<Message<ClientEventType.CONTEXT>>;
@@ -54,5 +60,5 @@ export declare class Client implements ConnectClient {
     getFromStorage<Type>(key: string): Type | null;
     saveToStorage<SavingType>(key: string, value: SavingType): void;
     deleteFromStorage(key: string): void;
-    onStorage(listener: StorageEventCallback): void;
+    onStorage(listener: StorageEventCallback): () => void;
 }

package/dist-types/src/helpers/LocalStorageManager.d.ts

@@ -13,7 +13,7 @@ declare class LocalStorageManager {
     delete(key: string): void;
     retrieve(key: string): any;
     get(key: string): any;
-    onStorage(listener: StorageEventCallback): void;
+    onStorage(listener: StorageEventCallback): () => void;
     removeOnStorage(listener: StorageEventCallback): void;
 }
 export default LocalStorageManager;

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

@@ -57,7 +57,7 @@ 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_CREATE_OR_UPDATE ? IPayloadContactMatchResult : T extends ClientEventType.CONTEXT ? IPayloadContextResult : 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 EventType.PBX_TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : never;
+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_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 EventType.PBX_TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : never;
 export type Message<T extends MessageType = MessageType> = {
     type: T;
     payload?: EventPayload<T>;
@@ -110,12 +110,27 @@ 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;
+    /**
+     * Determines x-bees is running on mobile native platform */
+    isPlatformNative: () => boolean;
+    /**
+     * Determines x-bees is running on web browser platform */
+    isPlatformWeb: () => boolean;
     /**
      * Determines x-bees is using this connect for messages only and this integration will not be shown on UI */
     isDataOnly: () => boolean;
+    /**
+     * Determines x-bees is using this connect for show dialog of setup flow */
+    isSetupDialog: () => boolean;
     /**
      * Determines x-bees is using this connect for representation on UI and this integration will be shown on UI
      * this opposite to {@link isDataOnly} */
@@ -202,6 +217,6 @@ export interface ConnectClient {
     deleteFromStorage: (key: string) => void;
     /**
      * listens on localStorage */
-    onStorage: (listener: StorageEventCallback) => void;
+    onStorage: (listener: StorageEventCallback) => () => void;
 }
 export {};

package/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": "",
@@ -42,5 +42,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "0d40f71e6014974505807a152e9bc638ee927101"
+  "gitHead": "25634a49d107ae0911bcd1d41ad29e292db2f4e1"
 }