@wildix/xbees-connect 1.2.1 → 1.2.5

package/dist-es/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wildix/xbees-connect",
-    "version": "1.2.0",
+    "version": "1.2.5",
     "description": "This library provides easy communication between x-bees and integrated web applications",
     "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
     "homepage": "",
@@ -30,6 +30,7 @@
         "access": "public"
     },
     "devDependencies": {
+        "@wildix/eslint-config-style-guide": "^1.2.2",
         "eslint": "^8.55.0",
         "rimraf": "^5.0.5",
         "typescript": "^5.3.3"

package/dist-es/src/Client.js

@@ -35,6 +35,7 @@ export class Client {
     listeners = [];
     useSubscription = false;
     userToken;
+    visible = false;
     userEmail;
     referrer;
     needAuthorize;
@@ -42,11 +43,13 @@ export class Client {
     iframeId;
     variant = null;
     localStorageManager = LocalStorageManager.getInstance();
+    userExtension;
     constructor() {
         const params = getUrlSearchParamsMap();
         this.iframeId = (params.get(UrlParams.ID) ?? params.get(DeprecatedUrlParams.ID));
         this.variant = (params.get(UrlParams.VARIANT) ?? params.get(DeprecatedUrlParams.VARIANT));
         this.userEmail = (params.get(UrlParams.USER) ?? params.get(DeprecatedUrlParams.USER));
+        this.userExtension = params.get(UrlParams.EXTENSION);
         this.userToken = (params.get(UrlParams.TOKEN) ?? params.get(DeprecatedUrlParams.TOKEN));
         this.referrer = (params.get(UrlParams.REFERRER) ?? params.get(DeprecatedUrlParams.REFERRER));
         this.needAuthorize = params.has(UrlParams.AUTHORIZE) ?? params.has(DeprecatedUrlParams.AUTHORIZE);
@@ -54,6 +57,7 @@ export class Client {
         this.isParentReactNativeWebView = !!window.ReactNativeWebView;
         this.worker = this.isParentReactNativeWebView ? new PostMessageControllerNative() : new PostMessageControllerWeb();
         this.addEventListener(EventType.PBX_TOKEN, (token) => (this.userToken = token));
+        this.addEventListener(EventType.VISIBILITY, (isActive) => (this.visible = isActive));
     }
     sendAsync(data) {
         return this.worker.sendAsync({
@@ -126,9 +130,15 @@ export class Client {
     getUserEmail() {
         return this.userEmail;
     }
+    getUserExtension() {
+        return this.userExtension;
+    }
     getReferrer() {
         return this.referrer;
     }
+    isVisible() {
+        return this.visible;
+    }
     getBackToAppUrl() {
         if (Client.getInstance().isPlatformNative()) {
             return `com.wildix.rnc://integrations/${this.iframeId}`;
@@ -320,4 +330,7 @@ export class Client {
     getTechnicalSupport() {
         return TechnicalSupport.getInstance();
     }
+    onVisibilityChange(callback) {
+        return this.addEventListener(EventType.VISIBILITY, callback);
+    }
 }

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

@@ -8,6 +8,7 @@ export var EventType;
     EventType["PBX_TOKEN"] = "xBeesPbxToken";
     EventType["REDIRECT_QUERY"] = "xBeesRedirectQuery";
     EventType["LOGOUT"] = "xBeesLogout";
+    EventType["VISIBILITY"] = "xBeesVisibility";
 })(EventType || (EventType = {}));
 export var ClientEventType;
 (function (ClientEventType) {
@@ -51,6 +52,7 @@ export var UrlParams;
     UrlParams["ID"] = "i";
     UrlParams["VARIANT"] = "v";
     UrlParams["USER"] = "u";
+    UrlParams["EXTENSION"] = "e";
     UrlParams["REFERRER"] = "r";
     UrlParams["AUTHORIZE"] = "a";
 })(UrlParams || (UrlParams = {}));

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

@@ -14,11 +14,13 @@ export default class ClientParams {
     needAuthorize;
     iframeId;
     variant = null;
+    userExtension = null;
     constructor() {
         const params = getUrlSearchParamsMap();
         this.iframeId = (params.get(UrlParams.ID) ?? params.get(DeprecatedUrlParams.ID));
         this.variant = (params.get(UrlParams.VARIANT) ?? params.get(DeprecatedUrlParams.VARIANT));
         this.userEmail = (params.get(UrlParams.USER) ?? params.get(DeprecatedUrlParams.USER));
+        this.userExtension = params.get(UrlParams.EXTENSION);
         this.userToken = (params.get(UrlParams.TOKEN) ?? params.get(DeprecatedUrlParams.TOKEN));
         this.referrer = (params.get(UrlParams.REFERRER) ?? params.get(DeprecatedUrlParams.REFERRER));
         this.needAuthorize = params.has(UrlParams.AUTHORIZE) ?? params.has(DeprecatedUrlParams.AUTHORIZE);

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

@@ -13,6 +13,7 @@ export declare class Client implements ConnectClient {
     private listeners;
     private useSubscription;
     private userToken;
+    private visible;
     private readonly userEmail;
     private readonly referrer;
     private readonly needAuthorize;
@@ -20,6 +21,7 @@ export declare class Client implements ConnectClient {
     private readonly iframeId;
     private readonly variant;
     private readonly localStorageManager;
+    private readonly userExtension;
     constructor();
     private sendAsync;
     private sendAsyncErrorSafe;
@@ -32,7 +34,9 @@ export declare class Client implements ConnectClient {
     isOpenedFromXBees(): boolean;
     getUserPbxToken(): string;
     getUserEmail(): string;
+    getUserExtension(): string | null;
     getReferrer(): string;
+    isVisible(): boolean;
     getBackToAppUrl(): string;
     isDataOnly(): boolean;
     isSetupDialog(): boolean;
@@ -71,4 +75,5 @@ export declare class Client implements ConnectClient {
     sendAnalytics(eventName: string, params?: Record<string, string>): void;
     setIntegrationStorageKey(integrationKey: string): void;
     getTechnicalSupport(): TechnicalSupport;
+    onVisibilityChange(callback: Callback<EventType.VISIBILITY>): RemoveEventListener;
 }

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

@@ -6,7 +6,8 @@ export declare enum EventType {
     USE_THEME = "xBeesUseTheme",
     PBX_TOKEN = "xBeesPbxToken",
     REDIRECT_QUERY = "xBeesRedirectQuery",
-    LOGOUT = "xBeesLogout"
+    LOGOUT = "xBeesLogout",
+    VISIBILITY = "xBeesVisibility"
 }
 export declare enum ClientEventType {
     READY = "xBeesReady",
@@ -47,6 +48,7 @@ export declare enum UrlParams {
     ID = "i",
     VARIANT = "v",
     USER = "u",
+    EXTENSION = "e",
     REFERRER = "r",
     AUTHORIZE = "a"
 }

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

@@ -8,6 +8,7 @@ export default class ClientParams {
     readonly needAuthorize: boolean;
     readonly iframeId: string;
     readonly variant: WorkVariants | null;
+    readonly userExtension: string | null;
     constructor();
     toString(): string;
 }

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

@@ -19,6 +19,9 @@ export interface ConnectClient {
     /**
      * Retrieves current user's email */
     getUserEmail: () => string;
+    /**
+     * Retrieves current user's extension */
+    getUserExtension: () => string | null;
     /**
      * Retrieves url for x-bees app which uses integration */
     getReferrer: () => string;
@@ -28,6 +31,9 @@ export interface ConnectClient {
     /**
      * Retrieves the version of xBeesConnect */
     version: () => string;
+    /**
+     * Indicates whether the UI iframe with the integration is currently active */
+    isVisible: () => boolean;
     /**
      * Determines x-bees is running on mobile native platform */
     isPlatformNative: () => boolean;
@@ -151,4 +157,7 @@ export interface ConnectClient {
     /**
      * special object to provide x-bees technical support */
     getTechnicalSupport: () => TechnicalSupport;
+    /**
+     * Starts listen for the events of changing iframe activity and handle with the provided callback */
+    onVisibilityChange: (callback: Callback<EventType.VISIBILITY>) => RemoveEventListener;
 }

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

@@ -9,6 +9,7 @@ export type EventPayloadMap = {
     [EventType.ADD_CALL]: IPayloadCallStartedInfo;
     [EventType.USE_THEME]: IPayloadThemeChange;
     [EventType.PBX_TOKEN]: string;
+    [EventType.VISIBILITY]: boolean;
     [EventType.REDIRECT_QUERY]: string;
 };
 export type EventCallbackMap = {
@@ -17,6 +18,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.VISIBILITY]: (isActive: EventPayloadMap[EventType.VISIBILITY]) => void;
     [EventType.REDIRECT_QUERY]: (query: EventPayloadMap[EventType.REDIRECT_QUERY]) => void;
 };
 export type RawMessageEvent = MessageEvent<string | Message>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wildix/xbees-connect",
-  "version": "1.2.1",
+  "version": "1.2.5",
   "description": "This library provides easy communication between x-bees and integrated web applications",
   "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
   "homepage": "",
@@ -30,6 +30,7 @@
     "access": "public"
   },
   "devDependencies": {
+    "@wildix/eslint-config-style-guide": "^1.2.2",
     "eslint": "^8.55.0",
     "rimraf": "^5.0.5",
     "typescript": "^5.3.3"
@@ -42,5 +43,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "a2732739df49717b258c3a6b97a5cce3f333f43a"
+  "gitHead": "56d5acf92d57e033678929fcb9927126bc54a39c"
 }