@wildix/xbees-connect 1.3.7 → 1.3.8-alpha.2

package/dist-cjs/package.json

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

@@ -48,6 +48,7 @@ class Client {
     needAuthorize;
     isParentReactNativeWebView;
     iframeId;
+    integrationId;
     variant = null;
     startPage = null;
     product = null;
@@ -61,6 +62,7 @@ class Client {
         this.needAuthorize = params.has(enums_1.UrlParams.AUTHORIZE);
         this.startPage = params.get(enums_1.UrlParams.START_PAGE);
         this.product = params.get(enums_1.UrlParams.PRODUCT);
+        this.integrationId = params.get(enums_1.UrlParams.ID)?.split('-')[0] ?? '';
         // @ts-expect-error window.ReactNativeWebView will be provided by ReactNative WebView
         this.isParentReactNativeWebView = !!window.ReactNativeWebView;
         this.worker = this.isParentReactNativeWebView ? new PostMessageControllerNative_1.default() : new PostMessageControllerWeb_1.default();
@@ -131,7 +133,11 @@ class Client {
     ready(props = types_1.SupportedPlatformVariant.ALL) {
         const payload = typeof props === 'string'
             ? { version: this.version(), platform: props }
-            : { version: this.version(), ...props, platform: props.platform ?? types_1.SupportedPlatformVariant.ALL };
+            : {
+                version: this.version(),
+                ...props,
+                platform: props.platform ?? types_1.SupportedPlatformVariant.ALL,
+            };
         this.getXBeesUser();
         return this.sendAsync({
             type: enums_1.ClientEventType.READY,
@@ -139,10 +145,15 @@ class Client {
         });
     }
     async requestXbeesUser() {
-        const responseMessageUser = await this.sendAsync({ type: enums_1.ClientEventType.USER });
+        const responseMessageUser = await this.sendAsync({
+            type: enums_1.ClientEventType.USER,
+        });
         if (responseMessageUser.payload) {
             const { extension, domain } = responseMessageUser.payload;
-            this.user = { ...responseMessageUser.payload, email: this.getUserEmail() };
+            this.user = {
+                ...responseMessageUser.payload,
+                email: this.getUserEmail(),
+            };
             if (extension) {
                 this.userExtension = extension;
             }
@@ -241,10 +252,16 @@ class Client {
         return this.sendAsync({ type: enums_1.ClientEventType.AVAILABLE_CONTACT_DATA });
     }
     contactUpdated(query, contact) {
-        return this.sendAsync({ type: enums_1.ClientEventType.CONTACT_CREATE_OR_UPDATE, payload: { query, contact } });
+        return this.sendAsync({
+            type: enums_1.ClientEventType.CONTACT_CREATE_OR_UPDATE,
+            payload: { query, contact },
+        });
     }
     contactMatchUpdated(query, contact) {
-        return this.sendAsync({ type: enums_1.ClientEventType.CONTACT_MATCH_UPDATE, payload: { query, contact } });
+        return this.sendAsync({
+            type: enums_1.ClientEventType.CONTACT_MATCH_UPDATE,
+            payload: { query, contact },
+        });
     }
     getThemeMode() {
         return this.sendAsync({ type: enums_1.ClientEventType.THEME_MODE });
@@ -252,6 +269,9 @@ class Client {
     getTheme() {
         return this.sendAsync({ type: enums_1.ClientEventType.THEME });
     }
+    getIntegrationId() {
+        return this.integrationId;
+    }
     startCall(phoneNumber) {
         return this.sendAsync({
             type: enums_1.ClientEventType.START_CALL,
@@ -268,7 +288,10 @@ class Client {
         return this.sendAsync({ type: enums_1.ClientEventType.TO_CLIPBOARD, payload });
     }
     showToast(message, severity = 'INFO') {
-        return this.sendAsync({ type: enums_1.ClientEventType.TOAST, payload: { message, severity } });
+        return this.sendAsync({
+            type: enums_1.ClientEventType.TOAST,
+            payload: { message, severity },
+        });
     }
     isNotAuthorized() {
         return this.sendAsync({ type: enums_1.ClientEventType.NOT_AUTHORIZED });
@@ -493,5 +516,43 @@ class Client {
     onCancelRedirectToEntityPage(callback) {
         return this.addEventListener(enums_1.EventType.CANCEL_REDIRECT_TO_ENTITY_PAGE, callback);
     }
+    onGetSupportedIntegrationContextKeys(callback) {
+        // send event to x-bees
+        void this.sendAsyncErrorSafe({
+            type: enums_1.ClientEventType.SUPPORTED_INTEGRATION_CONTEXT_KEYS_IS_SUPPORTED,
+        });
+        return this.addEventListener(enums_1.EventType.GET_SUPPORTED_INTEGRATION_CONTEXT_KEYS, () => {
+            const resolve = (keys) => this.sendAsync({
+                type: enums_1.ClientEventType.SUPPORTED_INTEGRATION_CONTEXT_KEYS,
+                payload: { keys },
+            });
+            const reject = (reason) => {
+                console.debug(reason);
+            };
+            try {
+                callback(resolve, reject);
+            }
+            catch (error) {
+                reject(`${error}`);
+            }
+        });
+    }
+    onRequestIntegrationContext(callback) {
+        return this.addEventListener(enums_1.EventType.REQUEST_INTEGRATION_CONTEXT, (payload) => {
+            const resolve = (response) => this.sendAsync({
+                type: enums_1.ClientEventType.INTEGRATION_CONTEXT_RESPONSE,
+                payload: response,
+            });
+            const reject = (reason) => {
+                console.debug(reason);
+            };
+            try {
+                callback(payload, resolve, reject);
+            }
+            catch (error) {
+                reject(`${error}`);
+            }
+        });
+    }
 }
 exports.Client = Client;

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

@@ -17,6 +17,8 @@ var EventType;
     EventType["CONTACT_REFRESH"] = "xBeesContactRefresh";
     EventType["START_REDIRECT_TO_ENTITY_PAGE"] = "xBeesStartRedirectToEntityPage";
     EventType["CANCEL_REDIRECT_TO_ENTITY_PAGE"] = "xBeesCancelRedirectToEntityPage";
+    EventType["GET_SUPPORTED_INTEGRATION_CONTEXT_KEYS"] = "xBeesGetSupportedIntegrationContextKeys";
+    EventType["REQUEST_INTEGRATION_CONTEXT"] = "xBeesRequestIntegrationContext";
 })(EventType || (exports.EventType = EventType = {}));
 var ClientEventType;
 (function (ClientEventType) {
@@ -56,6 +58,9 @@ var ClientEventType;
     ClientEventType["CUSTOM_EVENT"] = "xBeesCustomEvent";
     ClientEventType["CREATE_CONTACT_IS_SUPPORTED"] = "xBeesCreateContactIsSupported";
     ClientEventType["CREATE_CONTACT_HAS_NO_PERMISSION"] = "xBeesCreateContactHasNoPermission";
+    ClientEventType["SUPPORTED_INTEGRATION_CONTEXT_KEYS_IS_SUPPORTED"] = "xBeesSupportedIntegrationContextKeysIsSupported";
+    ClientEventType["SUPPORTED_INTEGRATION_CONTEXT_KEYS"] = "xBeesSupportedIntegrationContextKeys";
+    ClientEventType["INTEGRATION_CONTEXT_RESPONSE"] = "xBeesIntegrationContextResponse";
 })(ClientEventType || (exports.ClientEventType = ClientEventType = {}));
 var UrlParams;
 (function (UrlParams) {

package/dist-es/package.json

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

@@ -42,6 +42,7 @@ export class Client {
     needAuthorize;
     isParentReactNativeWebView;
     iframeId;
+    integrationId;
     variant = null;
     startPage = null;
     product = null;
@@ -55,6 +56,7 @@ export class Client {
         this.needAuthorize = params.has(UrlParams.AUTHORIZE);
         this.startPage = params.get(UrlParams.START_PAGE);
         this.product = params.get(UrlParams.PRODUCT);
+        this.integrationId = params.get(UrlParams.ID)?.split('-')[0] ?? '';
         // @ts-expect-error window.ReactNativeWebView will be provided by ReactNative WebView
         this.isParentReactNativeWebView = !!window.ReactNativeWebView;
         this.worker = this.isParentReactNativeWebView ? new PostMessageControllerNative() : new PostMessageControllerWeb();
@@ -125,7 +127,11 @@ export class Client {
     ready(props = SupportedPlatformVariant.ALL) {
         const payload = typeof props === 'string'
             ? { version: this.version(), platform: props }
-            : { version: this.version(), ...props, platform: props.platform ?? SupportedPlatformVariant.ALL };
+            : {
+                version: this.version(),
+                ...props,
+                platform: props.platform ?? SupportedPlatformVariant.ALL,
+            };
         this.getXBeesUser();
         return this.sendAsync({
             type: ClientEventType.READY,
@@ -133,10 +139,15 @@ export class Client {
         });
     }
     async requestXbeesUser() {
-        const responseMessageUser = await this.sendAsync({ type: ClientEventType.USER });
+        const responseMessageUser = await this.sendAsync({
+            type: ClientEventType.USER,
+        });
         if (responseMessageUser.payload) {
             const { extension, domain } = responseMessageUser.payload;
-            this.user = { ...responseMessageUser.payload, email: this.getUserEmail() };
+            this.user = {
+                ...responseMessageUser.payload,
+                email: this.getUserEmail(),
+            };
             if (extension) {
                 this.userExtension = extension;
             }
@@ -235,10 +246,16 @@ export class Client {
         return this.sendAsync({ type: ClientEventType.AVAILABLE_CONTACT_DATA });
     }
     contactUpdated(query, contact) {
-        return this.sendAsync({ type: ClientEventType.CONTACT_CREATE_OR_UPDATE, payload: { query, contact } });
+        return this.sendAsync({
+            type: ClientEventType.CONTACT_CREATE_OR_UPDATE,
+            payload: { query, contact },
+        });
     }
     contactMatchUpdated(query, contact) {
-        return this.sendAsync({ type: ClientEventType.CONTACT_MATCH_UPDATE, payload: { query, contact } });
+        return this.sendAsync({
+            type: ClientEventType.CONTACT_MATCH_UPDATE,
+            payload: { query, contact },
+        });
     }
     getThemeMode() {
         return this.sendAsync({ type: ClientEventType.THEME_MODE });
@@ -246,6 +263,9 @@ export class Client {
     getTheme() {
         return this.sendAsync({ type: ClientEventType.THEME });
     }
+    getIntegrationId() {
+        return this.integrationId;
+    }
     startCall(phoneNumber) {
         return this.sendAsync({
             type: ClientEventType.START_CALL,
@@ -262,7 +282,10 @@ export class Client {
         return this.sendAsync({ type: ClientEventType.TO_CLIPBOARD, payload });
     }
     showToast(message, severity = 'INFO') {
-        return this.sendAsync({ type: ClientEventType.TOAST, payload: { message, severity } });
+        return this.sendAsync({
+            type: ClientEventType.TOAST,
+            payload: { message, severity },
+        });
     }
     isNotAuthorized() {
         return this.sendAsync({ type: ClientEventType.NOT_AUTHORIZED });
@@ -487,4 +510,42 @@ export class Client {
     onCancelRedirectToEntityPage(callback) {
         return this.addEventListener(EventType.CANCEL_REDIRECT_TO_ENTITY_PAGE, callback);
     }
+    onGetSupportedIntegrationContextKeys(callback) {
+        // send event to x-bees
+        void this.sendAsyncErrorSafe({
+            type: ClientEventType.SUPPORTED_INTEGRATION_CONTEXT_KEYS_IS_SUPPORTED,
+        });
+        return this.addEventListener(EventType.GET_SUPPORTED_INTEGRATION_CONTEXT_KEYS, () => {
+            const resolve = (keys) => this.sendAsync({
+                type: ClientEventType.SUPPORTED_INTEGRATION_CONTEXT_KEYS,
+                payload: { keys },
+            });
+            const reject = (reason) => {
+                console.debug(reason);
+            };
+            try {
+                callback(resolve, reject);
+            }
+            catch (error) {
+                reject(`${error}`);
+            }
+        });
+    }
+    onRequestIntegrationContext(callback) {
+        return this.addEventListener(EventType.REQUEST_INTEGRATION_CONTEXT, (payload) => {
+            const resolve = (response) => this.sendAsync({
+                type: ClientEventType.INTEGRATION_CONTEXT_RESPONSE,
+                payload: response,
+            });
+            const reject = (reason) => {
+                console.debug(reason);
+            };
+            try {
+                callback(payload, resolve, reject);
+            }
+            catch (error) {
+                reject(`${error}`);
+            }
+        });
+    }
 }

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

@@ -14,6 +14,8 @@ export var EventType;
     EventType["CONTACT_REFRESH"] = "xBeesContactRefresh";
     EventType["START_REDIRECT_TO_ENTITY_PAGE"] = "xBeesStartRedirectToEntityPage";
     EventType["CANCEL_REDIRECT_TO_ENTITY_PAGE"] = "xBeesCancelRedirectToEntityPage";
+    EventType["GET_SUPPORTED_INTEGRATION_CONTEXT_KEYS"] = "xBeesGetSupportedIntegrationContextKeys";
+    EventType["REQUEST_INTEGRATION_CONTEXT"] = "xBeesRequestIntegrationContext";
 })(EventType || (EventType = {}));
 export var ClientEventType;
 (function (ClientEventType) {
@@ -53,6 +55,9 @@ export var ClientEventType;
     ClientEventType["CUSTOM_EVENT"] = "xBeesCustomEvent";
     ClientEventType["CREATE_CONTACT_IS_SUPPORTED"] = "xBeesCreateContactIsSupported";
     ClientEventType["CREATE_CONTACT_HAS_NO_PERMISSION"] = "xBeesCreateContactHasNoPermission";
+    ClientEventType["SUPPORTED_INTEGRATION_CONTEXT_KEYS_IS_SUPPORTED"] = "xBeesSupportedIntegrationContextKeysIsSupported";
+    ClientEventType["SUPPORTED_INTEGRATION_CONTEXT_KEYS"] = "xBeesSupportedIntegrationContextKeys";
+    ClientEventType["INTEGRATION_CONTEXT_RESPONSE"] = "xBeesIntegrationContextResponse";
 })(ClientEventType || (ClientEventType = {}));
 export var UrlParams;
 (function (UrlParams) {

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

@@ -1,7 +1,7 @@
-import { Callback, ConnectClient, Contact, ContactQuery, IPayloadViewPort, LookupAndMatchContactsResolver, Message, Reject, RemoveEventListener, ResponseMessage, StorageEventCallback, SuggestContactsResolver, SupportedPlatformVariant, ToastSeverity, XBeesUser } from '../types';
+import { Callback, ConnectClient, Contact, ContactQuery, IPayloadRequestIntegrationContext, IPayloadViewPort, LookupAndMatchContactsResolver, Message, Reject, RemoveEventListener, ResponseMessage, StorageEventCallback, SuggestContactsResolver, SupportedPlatformVariant, ToastSeverity, XBeesUser } from '../types';
 import { ReadyExtendedProps } from '../types/Event';
 import { JSONValue } from '../types/Json';
-import { LookupAndMatchBatchContactsResolver } from '../types/Resolver';
+import { GetSupportedIntegrationContextKeysResolver, LookupAndMatchBatchContactsResolver, RequestIntegrationContextResolver } from '../types/Resolver';
 import { ClientEventType, EventType, Product, StartPage } from './enums';
 import TechnicalSupport from './helpers/TechnicalSupport';
 /**
@@ -25,6 +25,7 @@ export declare class Client implements ConnectClient {
     private readonly needAuthorize;
     private readonly isParentReactNativeWebView;
     private readonly iframeId;
+    private readonly integrationId;
     private readonly variant;
     private readonly startPage;
     private readonly product;
@@ -73,6 +74,7 @@ export declare class Client implements ConnectClient {
     contactMatchUpdated(query: ContactQuery, contact: Contact): Promise<ResponseMessage<ClientEventType.CONTACT_MATCH_UPDATE>>;
     getThemeMode(): Promise<Message<ClientEventType.THEME_MODE>>;
     getTheme(): Promise<Message<ClientEventType.THEME>>;
+    getIntegrationId(): string;
     startCall(phoneNumber: string): Promise<Message<ClientEventType.START_CALL>>;
     reboot(): Promise<ResponseMessage>;
     setViewport(payload: IPayloadViewPort): Promise<ResponseMessage>;
@@ -116,4 +118,6 @@ export declare class Client implements ConnectClient {
     onContactRefresh(callback: Callback<EventType.CONTACT_REFRESH>): RemoveEventListener;
     onStartRedirectToEntityPage(callback: Callback<EventType.START_REDIRECT_TO_ENTITY_PAGE>): RemoveEventListener;
     onCancelRedirectToEntityPage(callback: Callback<EventType.CANCEL_REDIRECT_TO_ENTITY_PAGE>): RemoveEventListener;
+    onGetSupportedIntegrationContextKeys(callback: (resolve: GetSupportedIntegrationContextKeysResolver, reject: Reject) => void): RemoveEventListener;
+    onRequestIntegrationContext(callback: (payload: IPayloadRequestIntegrationContext, resolve: RequestIntegrationContextResolver, reject: Reject) => void): RemoveEventListener;
 }

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

@@ -12,7 +12,9 @@ export declare enum EventType {
     CONTACT_WEIGHT_UPDATE = "xBeesContactWeightUpdate",
     CONTACT_REFRESH = "xBeesContactRefresh",
     START_REDIRECT_TO_ENTITY_PAGE = "xBeesStartRedirectToEntityPage",
-    CANCEL_REDIRECT_TO_ENTITY_PAGE = "xBeesCancelRedirectToEntityPage"
+    CANCEL_REDIRECT_TO_ENTITY_PAGE = "xBeesCancelRedirectToEntityPage",
+    GET_SUPPORTED_INTEGRATION_CONTEXT_KEYS = "xBeesGetSupportedIntegrationContextKeys",
+    REQUEST_INTEGRATION_CONTEXT = "xBeesRequestIntegrationContext"
 }
 export declare enum ClientEventType {
     READY = "xBeesReady",
@@ -50,7 +52,10 @@ export declare enum ClientEventType {
     DROPDOWN_VISIBILITY = "xBeesDropdownVisibility",
     CUSTOM_EVENT = "xBeesCustomEvent",
     CREATE_CONTACT_IS_SUPPORTED = "xBeesCreateContactIsSupported",
-    CREATE_CONTACT_HAS_NO_PERMISSION = "xBeesCreateContactHasNoPermission"
+    CREATE_CONTACT_HAS_NO_PERMISSION = "xBeesCreateContactHasNoPermission",
+    SUPPORTED_INTEGRATION_CONTEXT_KEYS_IS_SUPPORTED = "xBeesSupportedIntegrationContextKeysIsSupported",
+    SUPPORTED_INTEGRATION_CONTEXT_KEYS = "xBeesSupportedIntegrationContextKeys",
+    INTEGRATION_CONTEXT_RESPONSE = "xBeesIntegrationContextResponse"
 }
 export declare enum UrlParams {
     TOKEN = "t",

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

@@ -6,9 +6,9 @@ import { ReadyExtendedProps } from './Event';
 import { JSONValue } from './Json';
 import { RemoveEventListener } from './Listener';
 import { ResponseMessage } from './Message';
-import { IPayloadViewPort } from './Payload';
+import { IPayloadRequestIntegrationContext, IPayloadViewPort } from './Payload';
 import { SupportedPlatformVariant } from './Platform';
-import { LookupAndMatchBatchContactsResolver, LookupAndMatchContactsResolver, Reject, SuggestContactsResolver } from './Resolver';
+import { GetSupportedIntegrationContextKeysResolver, LookupAndMatchBatchContactsResolver, LookupAndMatchContactsResolver, Reject, RequestIntegrationContextResolver, SuggestContactsResolver } from './Resolver';
 import { StorageEventCallback } from './Storage';
 import { ToastSeverity } from './Toast';
 import { XBeesUser } from './XBeesUser';
@@ -43,6 +43,9 @@ export interface ConnectClient {
     /**
      * Retrieves the product type from which the integration is opened */
     getProduct: () => Product | null;
+    /**
+     * Retrieves the integration id from url */
+    getIntegrationId: () => string;
     /**
      * Retrieves the version of xBeesConnect */
     version: () => string;
@@ -226,4 +229,18 @@ export interface ConnectClient {
      * Removes data about redirect to entity page from integration storage
      */
     onCancelRedirectToEntityPage: (callback: Callback<EventType.CANCEL_REDIRECT_TO_ENTITY_PAGE>) => RemoveEventListener;
+    /**
+     * Registers a handler that returns the list of integration context keys this integration supports.
+     * Announces integration context capability to xBees on registration.
+     * Suitable for headless/daemon integrations.
+     * Use resolve(keys) to respond. Use reject(reason) only for fatal/initialization errors.
+     */
+    onGetSupportedIntegrationContextKeys: (callback: (resolve: GetSupportedIntegrationContextKeysResolver, reject: Reject) => void) => RemoveEventListener;
+    /**
+     * Registers a handler for integration context requests from xBees.
+     * xBees provides a query and a set of requested keys; the integration should return aggregated data.
+     * For partial success, use resolve({ data, errors }) instead of reject.
+     * Use reject(reason) only for invalid payload or fatal errors.
+     */
+    onRequestIntegrationContext: (callback: (payload: IPayloadRequestIntegrationContext, resolve: RequestIntegrationContextResolver, reject: Reject) => void) => RemoveEventListener;
 }

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 { 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 { IPayloadAutoSuggestResult, IPayloadBatchContactsMatchResult, IPayloadBatchContactsMatchResultError, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContactWeightUpdate, IPayloadContextResult, IPayloadConversationResult, IPayloadCustomEvent, IPayloadDropdownVisibility, IPayloadGetFromStorage, IPayloadIntegrationContextResponse, IPayloadRequestIntegrationContext, IPayloadSaveToStorage, IPayloadSendAnalytics, IPayloadStartRedirectToEntityPage, IPayloadSupportedIntegrationContextKeys, 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 : 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 EventType.START_REDIRECT_TO_ENTITY_PAGE ? IPayloadStartRedirectToEntityPage : T extends EventType.CANCEL_REDIRECT_TO_ENTITY_PAGE ? IPayloadCancelRedirectToEntityPage : T extends EventType.GET_SUPPORTED_INTEGRATION_CONTEXT_KEYS ? undefined : T extends EventType.REQUEST_INTEGRATION_CONTEXT ? IPayloadRequestIntegrationContext : T extends ClientEventType.SUPPORTED_INTEGRATION_CONTEXT_KEYS ? IPayloadSupportedIntegrationContextKeys : T extends ClientEventType.INTEGRATION_CONTEXT_RESPONSE ? IPayloadIntegrationContextResponse : never;
 export type EventPayloadMap = {
     [EventType.GET_CONTACTS_AUTO_SUGGEST]: string;
     [EventType.GET_LOOK_UP_AND_MATCH]: ContactQuery;
@@ -19,6 +19,8 @@ export type EventPayloadMap = {
     [EventType.CONTACT_REFRESH]: string;
     [EventType.START_REDIRECT_TO_ENTITY_PAGE]: IPayloadStartRedirectToEntityPage;
     [EventType.CANCEL_REDIRECT_TO_ENTITY_PAGE]: IPayloadCancelRedirectToEntityPage;
+    [EventType.GET_SUPPORTED_INTEGRATION_CONTEXT_KEYS]: undefined;
+    [EventType.REQUEST_INTEGRATION_CONTEXT]: IPayloadRequestIntegrationContext;
 };
 export type EventCallbackMap = {
     [EventType.GET_CONTACTS_AUTO_SUGGEST]: (query: EventPayloadMap[EventType.GET_CONTACTS_AUTO_SUGGEST]) => void;
@@ -33,6 +35,8 @@ export type EventCallbackMap = {
     [EventType.CONTACT_REFRESH]: (id: EventPayloadMap[EventType.CONTACT_REFRESH]) => void;
     [EventType.START_REDIRECT_TO_ENTITY_PAGE]: (params: EventPayloadMap[EventType.START_REDIRECT_TO_ENTITY_PAGE]) => void;
     [EventType.CANCEL_REDIRECT_TO_ENTITY_PAGE]: (params: EventPayloadMap[EventType.CANCEL_REDIRECT_TO_ENTITY_PAGE]) => void;
+    [EventType.GET_SUPPORTED_INTEGRATION_CONTEXT_KEYS]: (_?: undefined) => void;
+    [EventType.REQUEST_INTEGRATION_CONTEXT]: (payload: EventPayloadMap[EventType.REQUEST_INTEGRATION_CONTEXT]) => void;
 };
 export type RawMessageEvent = MessageEvent<string | Message>;
 export type ReadyExtendedProps = {

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

@@ -95,4 +95,28 @@ export interface IPayloadStartRedirectToEntityPage {
 export interface IPayloadCancelRedirectToEntityPage {
     conversationId: string;
 }
+export interface IntegrationContextKey {
+    key: string;
+    description: string;
+}
+export interface IPayloadSupportedIntegrationContextKeys {
+    keys: IntegrationContextKey[];
+}
+export interface IPayloadRequestIntegrationContext {
+    query: ContactQuery;
+    keys: IntegrationContextKey[];
+}
+export interface IResolvedIntegrationEntity {
+    id: string;
+    type: string;
+    name?: string;
+}
+export interface IPayloadIntegrationContextResponse {
+    query: ContactQuery;
+    requestedKeys: IntegrationContextKey[];
+    supportedKeys: IntegrationContextKey[];
+    resolvedEntity?: IResolvedIntegrationEntity;
+    data: Partial<Record<string, unknown>>;
+    errors?: Partial<Record<string, string>>;
+}
 export {};

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

@@ -1,5 +1,8 @@
 import { Contact, ContactQuery } from './Contact';
+import { IntegrationContextKey, IPayloadIntegrationContextResponse } from './Payload';
 export type SuggestContactsResolver = (contacts: Contact[]) => void;
 export type LookupAndMatchContactsResolver = (contact: Contact) => void;
 export type LookupAndMatchBatchContactsResolver = (contactResultsMap: Map<ContactQuery, Contact | null | undefined>) => void;
 export type Reject = (reason: string) => void;
+export type GetSupportedIntegrationContextKeysResolver = (keys: IntegrationContextKey[]) => void;
+export type RequestIntegrationContextResolver = (response: IPayloadIntegrationContextResponse) => void;

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

@@ -7,9 +7,9 @@ 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 { IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadSendAnalytics, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort, IPayloadStartRedirectToEntityPage, IPayloadCancelRedirectToEntityPage, } from './Payload';
+export type { IntegrationContextKey, IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadIntegrationContextResponse, IPayloadRequestIntegrationContext, IPayloadSendAnalytics, IPayloadStartRedirectToEntityPage, IPayloadSupportedIntegrationContextKeys, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort, IResolvedIntegrationEntity, } from './Payload';
 export { SupportedPlatformVariant } from './Platform';
-export type { LookupAndMatchBatchContactsResolver, LookupAndMatchContactsResolver, Reject, SuggestContactsResolver, } from './Resolver';
+export type { GetSupportedIntegrationContextKeysResolver, LookupAndMatchBatchContactsResolver, LookupAndMatchContactsResolver, Reject, RequestIntegrationContextResolver, SuggestContactsResolver, } from './Resolver';
 export type { StorageEventCallback } from './Storage';
 export type { ToastSeverity } from './Toast';
 export type { WorkVariants } from './WorkVariant';

package/package.json

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