@wildix/xbees-connect 1.3.11 → 1.3.12

package/README.md

@@ -494,6 +494,18 @@ Notifies x-bees when a dropdown inside the integration opens or closes, which al
 
 ---
 
+### Chat connections
+
+#### `setChatToOpen(chatId: string): void`
+
+Tells x-bees which chat or conversation should be opened (brought into focus). The integration sends `ClientEventType.SET_CHAT_TO_OPEN` (`xBeesSetChatToOpen`) with payload `{ chatId }`. The call returns immediately; x-bees applies the navigation when it handles the message.
+
+```ts
+client.setChatToOpen('chat_id');
+```
+
+---
+
 ### Technical support
 
 #### `getTechnicalSupport(): TechnicalSupport`

package/dist-cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wildix/xbees-connect",
-    "version": "1.3.11",
+    "version": "1.3.12",
     "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

@@ -536,6 +536,16 @@ class Client {
             payload: { type, payload },
         });
     }
+    /**
+     * Asks x-bees to open (focus) the chat or conversation identified by `chatId`.
+     * @param chatId - Conversation or chat identifier in x-bees.
+     */
+    setChatToOpen(chatId) {
+        void this.sendAsync({
+            type: enums_1.ClientEventType.SET_CHAT_TO_OPEN,
+            payload: { chatId },
+        });
+    }
     onContactWeightUpdate(callback) {
         return this.addEventListener(enums_1.EventType.CONTACT_WEIGHT_UPDATE, callback);
     }

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

@@ -55,6 +55,7 @@ var ClientEventType;
     ClientEventType["AVAILABLE_CONTACT_DATA"] = "xBeesAvailableContactData";
     ClientEventType["DROPDOWN_VISIBILITY"] = "xBeesDropdownVisibility";
     ClientEventType["CUSTOM_EVENT"] = "xBeesCustomEvent";
+    ClientEventType["SET_CHAT_TO_OPEN"] = "xBeesSetChatToOpen";
     ClientEventType["CREATE_CONTACT_IS_SUPPORTED"] = "xBeesCreateContactIsSupported";
     ClientEventType["CREATE_CONTACT_HAS_NO_PERMISSION"] = "xBeesCreateContactHasNoPermission";
     ClientEventType["INTEGRATION_PROXY_RESPONSE"] = "xBeesIntegrationProxyResponse";

package/dist-es/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wildix/xbees-connect",
-    "version": "1.3.11",
+    "version": "1.3.12",
     "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

@@ -530,6 +530,16 @@ export class Client {
             payload: { type, payload },
         });
     }
+    /**
+     * Asks x-bees to open (focus) the chat or conversation identified by `chatId`.
+     * @param chatId - Conversation or chat identifier in x-bees.
+     */
+    setChatToOpen(chatId) {
+        void this.sendAsync({
+            type: ClientEventType.SET_CHAT_TO_OPEN,
+            payload: { chatId },
+        });
+    }
     onContactWeightUpdate(callback) {
         return this.addEventListener(EventType.CONTACT_WEIGHT_UPDATE, callback);
     }

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

@@ -52,6 +52,7 @@ export var ClientEventType;
     ClientEventType["AVAILABLE_CONTACT_DATA"] = "xBeesAvailableContactData";
     ClientEventType["DROPDOWN_VISIBILITY"] = "xBeesDropdownVisibility";
     ClientEventType["CUSTOM_EVENT"] = "xBeesCustomEvent";
+    ClientEventType["SET_CHAT_TO_OPEN"] = "xBeesSetChatToOpen";
     ClientEventType["CREATE_CONTACT_IS_SUPPORTED"] = "xBeesCreateContactIsSupported";
     ClientEventType["CREATE_CONTACT_HAS_NO_PERMISSION"] = "xBeesCreateContactHasNoPermission";
     ClientEventType["INTEGRATION_PROXY_RESPONSE"] = "xBeesIntegrationProxyResponse";

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

@@ -115,6 +115,11 @@ export declare class Client implements ConnectClient {
         type: string;
         payload?: JSONValue;
     }): void;
+    /**
+     * Asks x-bees to open (focus) the chat or conversation identified by `chatId`.
+     * @param chatId - Conversation or chat identifier in x-bees.
+     */
+    setChatToOpen(chatId: string): void;
     onContactWeightUpdate(callback: Callback<EventType.CONTACT_WEIGHT_UPDATE>): RemoveEventListener;
     onContactRefresh(callback: Callback<EventType.CONTACT_REFRESH>): RemoveEventListener;
     onStartRedirectToEntityPage(callback: Callback<EventType.START_REDIRECT_TO_ENTITY_PAGE>): RemoveEventListener;

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

@@ -50,6 +50,7 @@ export declare enum ClientEventType {
     AVAILABLE_CONTACT_DATA = "xBeesAvailableContactData",
     DROPDOWN_VISIBILITY = "xBeesDropdownVisibility",
     CUSTOM_EVENT = "xBeesCustomEvent",
+    SET_CHAT_TO_OPEN = "xBeesSetChatToOpen",
     CREATE_CONTACT_IS_SUPPORTED = "xBeesCreateContactIsSupported",
     CREATE_CONTACT_HAS_NO_PERMISSION = "xBeesCreateContactHasNoPermission",
     INTEGRATION_PROXY_RESPONSE = "xBeesIntegrationProxyResponse",

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

@@ -220,6 +220,14 @@ export interface ConnectClient {
         type: string;
         payload?: JSONValue;
     }) => void;
+    /**
+     * Asks x-bees to open (focus) the chat or conversation identified by `chatId`.
+     * Fire-and-forget: sends `ClientEventType.SET_CHAT_TO_OPEN` to the parent; no response is surfaced to the integration.
+     * When the app is not embedded in x-bees, this is a no-op (same as other outbound client messages).
+     *
+     * @param chatId - Conversation or chat identifier in x-bees.
+     */
+    setChatToOpen: (chatId: string) => void;
     /**
      * Starts listen for the events of contact weight update and handle with the provided callback
      */

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, IPayloadDropdownVisibility, IPayloadGetFromStorage, IPayloadSaveToStorage, IPayloadSendAnalytics, IPayloadStartRedirectToEntityPage, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort } from './Payload';
+import { IntegrationProxyRequest, IntegrationProxyResponse, IPayloadAutoSuggestResult, IPayloadBatchContactsMatchResult, IPayloadBatchContactsMatchResultError, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContactWeightUpdate, IPayloadContextResult, IPayloadConversationResult, IPayloadCustomEvent, IPayloadSetChatToOpen, IPayloadDropdownVisibility, IPayloadGetFromStorage, IPayloadSaveToStorage, IPayloadSendAnalytics, 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 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 : 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 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 : never;
 export type EventPayloadMap = {
     [EventType.GET_CONTACTS_AUTO_SUGGEST]: string;
     [EventType.GET_LOOK_UP_AND_MATCH]: ContactQuery;

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

@@ -87,6 +87,10 @@ export interface IPayloadCustomEvent {
     type: string;
     payload?: JSONValue;
 }
+/** Payload for the integration → x-bees message that requests opening a chat by id (`ClientEventType.SET_CHAT_TO_OPEN`). */
+export interface IPayloadSetChatToOpen {
+    chatId: string;
+}
 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, IPayloadSendAnalytics, IPayloadStartRedirectToEntityPage, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort, } from './Payload';
+export type { IntegrationProxyErrorCode, IntegrationProxyRequest, IntegrationProxyResponse, IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadSendAnalytics, 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.11",
+  "version": "1.3.12",
   "description": "This library provides easy communication between x-bees and integrated web applications",
   "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
   "homepage": "",