@wildix/xbees-connect 1.3.19 → 1.3.20-beta.2

package/README.md

@@ -404,6 +404,15 @@ Displays a toast notification inside the x-bees UI. `severity` defaults to `'INF
 client.showToast('Contact saved', 'SUCCESS');
 ```
 
+#### `setSidebarBadgeCount(count: number): void`
+
+Sets the numeric badge on the integration icon in the x-bees sidebar. Pass `0` to hide the badge.
+
+```ts
+client.setSidebarBadgeCount(3);
+client.setSidebarBadgeCount(0); // hide
+```
+
 #### `setViewport(payload: { height: number | string; width: number | string }): Promise<ResponseMessage>`
 
 Sends a request to x-bees to resize the iFrame to the specified dimensions.

package/dist-cjs/package.json

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

package/dist-cjs/src/Client.js

@@ -498,6 +498,16 @@ class Client {
             },
         });
     }
+    /**
+     * Sets the numeric badge on the integration icon in the x-bees sidebar.
+     * Pass `0` to hide the badge.
+     */
+    setSidebarBadgeCount(count) {
+        void this.sendAsyncErrorSafe({
+            type: enums_1.ClientEventType.SIDEBAR_BADGE_COUNT,
+            payload: { count },
+        });
+    }
     setIntegrationStorageKey(integrationKey) {
         this.localStorageManager.setIntegrationKey(integrationKey);
     }

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

@@ -65,6 +65,7 @@ var ClientEventType;
     ClientEventType["INTEGRATION_PROXY_RESPONSE"] = "xBeesIntegrationProxyResponse";
     ClientEventType["INTEGRATION_PROXY_REQUEST_IS_SUPPORTED"] = "xBeesIntegrationProxyRequestIsSupported";
     ClientEventType["EXTERNAL_ROUTE_CHANGE"] = "xBeesExternalRouteChange";
+    ClientEventType["SIDEBAR_BADGE_COUNT"] = "xBeesSidebarBadgeCount";
 })(ClientEventType || (exports.ClientEventType = ClientEventType = {}));
 var UrlParams;
 (function (UrlParams) {

package/dist-es/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wildix/xbees-connect",
-    "version": "1.3.19",
+    "version": "1.3.20-beta.2",
     "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

@@ -492,6 +492,16 @@ export class Client {
             },
         });
     }
+    /**
+     * Sets the numeric badge on the integration icon in the x-bees sidebar.
+     * Pass `0` to hide the badge.
+     */
+    setSidebarBadgeCount(count) {
+        void this.sendAsyncErrorSafe({
+            type: ClientEventType.SIDEBAR_BADGE_COUNT,
+            payload: { count },
+        });
+    }
     setIntegrationStorageKey(integrationKey) {
         this.localStorageManager.setIntegrationKey(integrationKey);
     }

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

@@ -62,6 +62,7 @@ export var ClientEventType;
     ClientEventType["INTEGRATION_PROXY_RESPONSE"] = "xBeesIntegrationProxyResponse";
     ClientEventType["INTEGRATION_PROXY_REQUEST_IS_SUPPORTED"] = "xBeesIntegrationProxyRequestIsSupported";
     ClientEventType["EXTERNAL_ROUTE_CHANGE"] = "xBeesExternalRouteChange";
+    ClientEventType["SIDEBAR_BADGE_COUNT"] = "xBeesSidebarBadgeCount";
 })(ClientEventType || (ClientEventType = {}));
 export var UrlParams;
 (function (UrlParams) {

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

@@ -105,6 +105,11 @@ export declare class Client implements ConnectClient {
     onStorage(listener: StorageEventCallback): () => void;
     onLogout(callback: Callback<EventType.LOGOUT>): RemoveEventListener;
     sendAnalytics(eventName: string, params?: Record<string, string>): void;
+    /**
+     * Sets the numeric badge on the integration icon in the x-bees sidebar.
+     * Pass `0` to hide the badge.
+     */
+    setSidebarBadgeCount(count: number): void;
     setIntegrationStorageKey(integrationKey: string): void;
     getTechnicalSupport(): TechnicalSupport;
     onVisibilityChange(callback: Callback<EventType.VISIBILITY>): RemoveEventListener;

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

@@ -59,7 +59,8 @@ export declare enum ClientEventType {
     CREATE_CONTACT_HAS_NO_PERMISSION = "xBeesCreateContactHasNoPermission",
     INTEGRATION_PROXY_RESPONSE = "xBeesIntegrationProxyResponse",
     INTEGRATION_PROXY_REQUEST_IS_SUPPORTED = "xBeesIntegrationProxyRequestIsSupported",
-    EXTERNAL_ROUTE_CHANGE = "xBeesExternalRouteChange"
+    EXTERNAL_ROUTE_CHANGE = "xBeesExternalRouteChange",
+    SIDEBAR_BADGE_COUNT = "xBeesSidebarBadgeCount"
 }
 export declare enum UrlParams {
     TOKEN = "t",

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

@@ -203,6 +203,11 @@ export interface ConnectClient {
     /**
      * send analytics data to x-bees for track into analytics data */
     sendAnalytics: (eventName: string, params?: Record<string, string>) => void;
+    /**
+     * Sets the numeric badge on the integration icon in the x-bees sidebar.
+     * Pass `0` to hide the badge.
+     */
+    setSidebarBadgeCount: (count: number) => void;
     /**
      * special object to provide x-bees technical support */
     getTechnicalSupport: () => TechnicalSupport;

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

@@ -2,10 +2,10 @@ import { ClientEventType, EventType } from '../src/enums';
 import { AvailableContactData } from './AvailableContactData';
 import { ContactQuery } from './Contact';
 import { Message, MessageType } from './Message';
-import { IntegrationProxyRequest, IntegrationProxyResponse, IPayloadAutoSuggestResult, IPayloadBatchContactsMatchResult, IPayloadBatchContactsMatchResultError, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContactWeightUpdate, IPayloadContextResult, IPayloadConversationResult, IPayloadCustomEvent, IPayloadDaemonCallFinished, IPayloadDaemonCallStarted, IPayloadDropdownVisibility, IPayloadGetChannelsByEmailOrPhone, IPayloadGetFromStorage, IPayloadRouteChange, IPayloadSaveToStorage, IPayloadSendAnalytics, IPayloadSetChatToOpen, IPayloadStartRedirectToEntityPage, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort } from './Payload';
+import { IntegrationProxyRequest, IntegrationProxyResponse, IPayloadAutoSuggestResult, IPayloadBatchContactsMatchResult, IPayloadBatchContactsMatchResultError, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContactWeightUpdate, IPayloadContextResult, IPayloadConversationResult, IPayloadCustomEvent, IPayloadDaemonCallFinished, IPayloadDaemonCallStarted, IPayloadDropdownVisibility, IPayloadGetChannelsByEmailOrPhone, IPayloadGetFromStorage, IPayloadRouteChange, IPayloadSaveToStorage, IPayloadSendAnalytics, IPayloadSetChatToOpen, IPayloadSidebarBadgeCount, IPayloadStartRedirectToEntityPage, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort } from './Payload';
 import { SupportedPlatformVariant } from './Platform';
 import { XBeesUser } from './XBeesUser';
-export 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 | ClientEventType.CONTACT_CREATE_OR_UPDATE | ClientEventType.CONTACT_MATCH_UPDATE ? IPayloadContactMatchResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH_NOT_FOUND ? IPayloadContactMatchResultNotFound : T extends ClientEventType.LOOKUP_AND_MATCH_BATCH_ERROR ? IPayloadBatchContactsMatchResultError : T extends ClientEventType.CONTEXT ? IPayloadContextResult : T extends ClientEventType.CURRENT_CONTACT ? IPayloadContactResult : T extends ClientEventType.CURRENT_CONVERSATION ? IPayloadConversationResult : 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 ClientEventType.SEND_TECHNICAL_SUPPORT_INFORMATION ? IPayloadTechSupport : T extends EventType.PBX_TOKEN ? string : T extends ClientEventType.TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : T extends EventType.GET_LOOK_UP_AND_MATCH ? ContactQuery : T extends EventType.GET_LOOK_UP_AND_MATCH_BATCH ? ContactQuery[] : T extends EventType.VISIBILITY ? boolean : T extends ClientEventType.USER ? XBeesUser : T extends ClientEventType.SAVE_TO_STORAGE ? IPayloadSaveToStorage : T extends ClientEventType.GET_FROM_STORAGE ? IPayloadGetFromStorage : T extends ClientEventType.REMOVE_FROM_STORAGE ? IPayloadGetFromStorage : T extends ClientEventType.AVAILABLE_CONTACT_DATA ? AvailableContactData | null : T extends ClientEventType.LOOK_UP_AND_MATCH_BATCH_CONTACTS ? IPayloadBatchContactsMatchResult : T extends ClientEventType.DROPDOWN_VISIBILITY ? IPayloadDropdownVisibility : T extends ClientEventType.CUSTOM_EVENT ? IPayloadCustomEvent : T extends ClientEventType.SET_CHAT_TO_OPEN ? IPayloadSetChatToOpen : T extends ClientEventType.GET_CHANNELS_BY_EMAIL_OR_PHONE ? IPayloadGetChannelsByEmailOrPhone : T extends ClientEventType.EXTERNAL_ROUTE_CHANGE ? IPayloadRouteChange : T extends EventType.START_REDIRECT_TO_ENTITY_PAGE ? IPayloadStartRedirectToEntityPage : T extends EventType.CANCEL_REDIRECT_TO_ENTITY_PAGE ? IPayloadCancelRedirectToEntityPage : T extends EventType.GET_INTEGRATION_PROXY_REQUEST ? IntegrationProxyRequest : T extends ClientEventType.INTEGRATION_PROXY_RESPONSE ? IntegrationProxyResponse : T extends ClientEventType.INTEGRATION_PROXY_REQUEST_IS_SUPPORTED ? undefined : T extends EventType.EXTERNAL_ROUTE_CHANGE ? IPayloadRouteChange : T extends EventType.DAEMON_CALL_SESSION_STARTED ? IPayloadDaemonCallStarted : T extends EventType.DAEMON_CALL_SESSION_FINISHED ? IPayloadDaemonCallFinished : never;
+export 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 | ClientEventType.CONTACT_CREATE_OR_UPDATE | ClientEventType.CONTACT_MATCH_UPDATE ? IPayloadContactMatchResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH_NOT_FOUND ? IPayloadContactMatchResultNotFound : T extends ClientEventType.LOOKUP_AND_MATCH_BATCH_ERROR ? IPayloadBatchContactsMatchResultError : T extends ClientEventType.CONTEXT ? IPayloadContextResult : T extends ClientEventType.CURRENT_CONTACT ? IPayloadContactResult : T extends ClientEventType.CURRENT_CONVERSATION ? IPayloadConversationResult : 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 ClientEventType.SEND_TECHNICAL_SUPPORT_INFORMATION ? IPayloadTechSupport : T extends EventType.PBX_TOKEN ? string : T extends ClientEventType.TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : T extends EventType.GET_LOOK_UP_AND_MATCH ? ContactQuery : T extends EventType.GET_LOOK_UP_AND_MATCH_BATCH ? ContactQuery[] : T extends EventType.VISIBILITY ? boolean : T extends ClientEventType.USER ? XBeesUser : T extends ClientEventType.SAVE_TO_STORAGE ? IPayloadSaveToStorage : T extends ClientEventType.GET_FROM_STORAGE ? IPayloadGetFromStorage : T extends ClientEventType.REMOVE_FROM_STORAGE ? IPayloadGetFromStorage : T extends ClientEventType.AVAILABLE_CONTACT_DATA ? AvailableContactData | null : T extends ClientEventType.LOOK_UP_AND_MATCH_BATCH_CONTACTS ? IPayloadBatchContactsMatchResult : T extends ClientEventType.DROPDOWN_VISIBILITY ? IPayloadDropdownVisibility : T extends ClientEventType.CUSTOM_EVENT ? IPayloadCustomEvent : T extends ClientEventType.SET_CHAT_TO_OPEN ? IPayloadSetChatToOpen : T extends ClientEventType.GET_CHANNELS_BY_EMAIL_OR_PHONE ? IPayloadGetChannelsByEmailOrPhone : T extends ClientEventType.EXTERNAL_ROUTE_CHANGE ? IPayloadRouteChange : T extends ClientEventType.SIDEBAR_BADGE_COUNT ? IPayloadSidebarBadgeCount : T extends EventType.START_REDIRECT_TO_ENTITY_PAGE ? IPayloadStartRedirectToEntityPage : T extends EventType.CANCEL_REDIRECT_TO_ENTITY_PAGE ? IPayloadCancelRedirectToEntityPage : T extends EventType.GET_INTEGRATION_PROXY_REQUEST ? IntegrationProxyRequest : T extends ClientEventType.INTEGRATION_PROXY_RESPONSE ? IntegrationProxyResponse : T extends ClientEventType.INTEGRATION_PROXY_REQUEST_IS_SUPPORTED ? undefined : T extends EventType.EXTERNAL_ROUTE_CHANGE ? IPayloadRouteChange : T extends EventType.DAEMON_CALL_SESSION_STARTED ? IPayloadDaemonCallStarted : T extends EventType.DAEMON_CALL_SESSION_FINISHED ? IPayloadDaemonCallFinished : never;
 export type EventPayloadMap = {
     [EventType.GET_CONTACTS_AUTO_SUGGEST]: string;
     [EventType.GET_LOOK_UP_AND_MATCH]: ContactQuery;

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

@@ -112,6 +112,13 @@ export interface IPayloadRouteChange {
      */
     replace?: boolean;
 }
+/**
+ * Badge count for the integration icon in the x-bees sidebar.
+ * `0` hides the badge.
+ */
+export interface IPayloadSidebarBadgeCount {
+    count: number;
+}
 export interface IPayloadContactWeightUpdate {
     id: string;
     query: ContactQuery;

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

@@ -7,7 +7,7 @@ export type { JSONArray, JSONObject } from './Json';
 export type { Listener, RemoveEventListener } from './Listener';
 export type { Message, MessageIFrameResponse, MessageType, ResponseMessage } from './Message';
 export type { MessageSender } from './MessageSender';
-export type { IntegrationProxyErrorCode, IntegrationProxyRequest, IntegrationProxyResponse, IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadDaemonCallFinished, IPayloadDaemonCallStarted, IPayloadGetChannelsByEmailOrPhone, IPayloadRouteChange, IPayloadSendAnalytics, IPayloadSetChatToOpen, IPayloadStartRedirectToEntityPage, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort, } from './Payload';
+export type { IntegrationProxyErrorCode, IntegrationProxyRequest, IntegrationProxyResponse, IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadDaemonCallFinished, IPayloadDaemonCallStarted, IPayloadGetChannelsByEmailOrPhone, IPayloadRouteChange, IPayloadSendAnalytics, IPayloadSidebarBadgeCount, IPayloadSetChatToOpen, IPayloadStartRedirectToEntityPage, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort, } from './Payload';
 export { SupportedPlatformVariant } from './Platform';
 export type { IntegrationProxyRequestResolver, LookupAndMatchBatchContactsResolver, LookupAndMatchContactsResolver, Reject, SuggestContactsResolver, } from './Resolver';
 export type { StorageEventCallback } from './Storage';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wildix/xbees-connect",
-  "version": "1.3.19",
+  "version": "1.3.20-beta.2",
   "description": "This library provides easy communication between x-bees and integrated web applications",
   "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
   "homepage": "",
@@ -9,6 +9,17 @@
   "main": "./dist-cjs/index.js",
   "types": "./dist-types/index.d.ts",
   "module": "./dist-es/index.js",
+  "scripts": {
+    "build": "pnpm run clean && pnpm run build:es && pnpm run build:cjs && pnpm run build:types",
+    "build:es": "tsc -p tsconfig.es.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "build:docs": "typedoc",
+    "lint": "eslint . && tsc --noEmit",
+    "lint:fix": "eslint . --fix",
+    "clean": "rimraf --glob './dist-*' '*.tsbuildinfo'",
+    "build:api-extractor": "api-extractor run --local"
+  },
   "files": [
     "dist-*/**"
   ],
@@ -33,16 +44,5 @@
   },
   "engines": {
     "node": ">=16"
-  },
-  "scripts": {
-    "build": "pnpm run clean && pnpm run build:es && pnpm run build:cjs && pnpm run build:types",
-    "build:es": "tsc -p tsconfig.es.json",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:types": "tsc -p tsconfig.types.json",
-    "build:docs": "typedoc",
-    "lint": "eslint . && tsc --noEmit",
-    "lint:fix": "eslint . --fix",
-    "clean": "rimraf --glob './dist-*' '*.tsbuildinfo'",
-    "build:api-extractor": "api-extractor run --local"
   }
-}
+}