@wildix/xbees-connect 1.3.8-alpha.1 → 1.3.8-alpha.3

package/README.md

@@ -302,6 +302,28 @@ Client.getInstance().onLookupAndMatchBatchContacts(async (queries, returnResults
 });
 ```
 
+#### `onIntegrationProxyRequest(callback: (request, resolve, reject) => void): RemoveEventListener`
+
+Registers a handler for **read-only** Salesforce REST proxy requests from x-bees. Subscribe during app startup (same pattern as contact flows). On registration, x-bees is notified that the integration supports this flow (`INTEGRATION_PROXY_REQUEST_IS_SUPPORTED`).
+
+- **Request** (`IntegrationProxyRequest`): `path` (relative Salesforce URL only), optional `query`, optional `requestId`.
+- **Resolve** (`IntegrationProxyRequestResolver`): pass `IntegrationProxyResponse` with `ok`, `path`, optional `requestId` / `data` / `error`, and required `meta: { source: 'salesforce', validated, validationWarnings? }`. Structured domain errors use `error.code` (e.g. `NOT_AUTHORIZED`, `INVALID_PATH`, `PATH_NOT_ALLOWED`, `MISSING_QUERY_PARAM`, `INVALID_QUERY_PARAM`, `EXECUTION_FAILED`).
+- If `response.error?.code === 'NOT_AUTHORIZED'`, the client calls `isNotAuthorized()` before sending the proxy response to x-bees.
+- **Reject** (`Reject`): use only for unexpected runtime exceptions (string reason).
+
+**Scope (first iteration):** read-only calls only. Use relative paths such as `/services/data/v59.0/sobjects/Contact/003...` or `/services/data/v59.0/query` with `query: { q: 'SELECT ...' }`. No composite, tooling, OAuth, create, update, or delete.
+
+```ts
+Client.getInstance().onIntegrationProxyRequest(async (request, resolve, reject) => {
+  try {
+    const response = await handleIntegrationProxyRequest(request);
+    resolve(response);
+  } catch (error) {
+    reject(String(error));
+  }
+});
+```
+
 #### `createContactIsSupported(): Promise<ResponseMessage>`
 
 Sends a signal to x-bees indicating that this integration supports creating contacts. Call once during initialization if your integration handles contact creation.

package/dist-cjs/package.json

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

@@ -420,6 +420,38 @@ class Client {
             }
         });
     }
+    onIntegrationProxyRequest(callback) {
+        void this.sendAsyncErrorSafe({
+            type: enums_1.ClientEventType.INTEGRATION_PROXY_REQUEST_IS_SUPPORTED,
+        });
+        return this.addEventListener(enums_1.EventType.GET_INTEGRATION_PROXY_REQUEST, (request) => {
+            const resolve = (response) => {
+                void (async () => {
+                    try {
+                        if (response.error?.code === 'NOT_AUTHORIZED') {
+                            await this.isNotAuthorized();
+                        }
+                        await this.sendAsync({
+                            type: enums_1.ClientEventType.INTEGRATION_PROXY_RESPONSE,
+                            payload: response,
+                        });
+                    }
+                    catch (error) {
+                        console.debug('integration proxy response send error', error);
+                    }
+                })();
+            };
+            const reject = (reason) => {
+                console.debug(reason);
+            };
+            try {
+                callback(request, resolve, reject);
+            }
+            catch (error) {
+                reject(`${error}`);
+            }
+        });
+    }
     createContactIsSupported() {
         return this.sendAsync({
             type: enums_1.ClientEventType.CREATE_CONTACT_IS_SUPPORTED,
@@ -516,43 +548,5 @@ 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,8 +17,7 @@ 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["GET_INTEGRATION_PROXY_REQUEST"] = "xBeesGetIntegrationProxyRequest";
 })(EventType || (exports.EventType = EventType = {}));
 var ClientEventType;
 (function (ClientEventType) {
@@ -58,9 +57,8 @@ 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["INTEGRATION_PROXY_RESPONSE"] = "xBeesIntegrationProxyResponse";
+    ClientEventType["INTEGRATION_PROXY_REQUEST_IS_SUPPORTED"] = "xBeesIntegrationProxyRequestIsSupported";
 })(ClientEventType || (exports.ClientEventType = ClientEventType = {}));
 var UrlParams;
 (function (UrlParams) {

package/dist-es/package.json

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

@@ -414,6 +414,38 @@ export class Client {
             }
         });
     }
+    onIntegrationProxyRequest(callback) {
+        void this.sendAsyncErrorSafe({
+            type: ClientEventType.INTEGRATION_PROXY_REQUEST_IS_SUPPORTED,
+        });
+        return this.addEventListener(EventType.GET_INTEGRATION_PROXY_REQUEST, (request) => {
+            const resolve = (response) => {
+                void (async () => {
+                    try {
+                        if (response.error?.code === 'NOT_AUTHORIZED') {
+                            await this.isNotAuthorized();
+                        }
+                        await this.sendAsync({
+                            type: ClientEventType.INTEGRATION_PROXY_RESPONSE,
+                            payload: response,
+                        });
+                    }
+                    catch (error) {
+                        console.debug('integration proxy response send error', error);
+                    }
+                })();
+            };
+            const reject = (reason) => {
+                console.debug(reason);
+            };
+            try {
+                callback(request, resolve, reject);
+            }
+            catch (error) {
+                reject(`${error}`);
+            }
+        });
+    }
     createContactIsSupported() {
         return this.sendAsync({
             type: ClientEventType.CREATE_CONTACT_IS_SUPPORTED,
@@ -510,42 +542,4 @@ 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,8 +14,7 @@ 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["GET_INTEGRATION_PROXY_REQUEST"] = "xBeesGetIntegrationProxyRequest";
 })(EventType || (EventType = {}));
 export var ClientEventType;
 (function (ClientEventType) {
@@ -55,9 +54,8 @@ 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["INTEGRATION_PROXY_RESPONSE"] = "xBeesIntegrationProxyResponse";
+    ClientEventType["INTEGRATION_PROXY_REQUEST_IS_SUPPORTED"] = "xBeesIntegrationProxyRequestIsSupported";
 })(ClientEventType || (ClientEventType = {}));
 export var UrlParams;
 (function (UrlParams) {

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

@@ -1,7 +1,7 @@
-import { Callback, ConnectClient, Contact, ContactQuery, IPayloadRequestIntegrationContext, IPayloadViewPort, LookupAndMatchContactsResolver, Message, Reject, RemoveEventListener, ResponseMessage, StorageEventCallback, SuggestContactsResolver, SupportedPlatformVariant, ToastSeverity, XBeesUser } from '../types';
+import { Callback, ConnectClient, Contact, ContactQuery, IntegrationProxyRequest, IPayloadViewPort, LookupAndMatchContactsResolver, Message, Reject, RemoveEventListener, ResponseMessage, StorageEventCallback, SuggestContactsResolver, SupportedPlatformVariant, ToastSeverity, XBeesUser } from '../types';
 import { ReadyExtendedProps } from '../types/Event';
 import { JSONValue } from '../types/Json';
-import { GetSupportedIntegrationContextKeysResolver, LookupAndMatchBatchContactsResolver, RequestIntegrationContextResolver } from '../types/Resolver';
+import { IntegrationProxyRequestResolver, LookupAndMatchBatchContactsResolver } from '../types/Resolver';
 import { ClientEventType, EventType, Product, StartPage } from './enums';
 import TechnicalSupport from './helpers/TechnicalSupport';
 /**
@@ -93,6 +93,7 @@ export declare class Client implements ConnectClient {
     onSuggestContacts(callback: (query: string, resolve: SuggestContactsResolver, reject: Reject) => void): RemoveEventListener;
     onLookupAndMatchContact(callback: (query: ContactQuery, resolve: LookupAndMatchContactsResolver, reject: Reject) => void): RemoveEventListener;
     onLookupAndMatchBatchContacts(callback: (query: ContactQuery[], returnResults: LookupAndMatchBatchContactsResolver) => void): RemoveEventListener;
+    onIntegrationProxyRequest(callback: (request: IntegrationProxyRequest, resolve: IntegrationProxyRequestResolver, reject: Reject) => void): RemoveEventListener;
     createContactIsSupported(): Promise<ResponseMessage>;
     createContactHasNoPermission(): Promise<ResponseMessage>;
     onThemeChange(callback: Callback<EventType.USE_THEME>): RemoveEventListener;
@@ -118,6 +119,4 @@ 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

@@ -13,8 +13,7 @@ export declare enum EventType {
     CONTACT_REFRESH = "xBeesContactRefresh",
     START_REDIRECT_TO_ENTITY_PAGE = "xBeesStartRedirectToEntityPage",
     CANCEL_REDIRECT_TO_ENTITY_PAGE = "xBeesCancelRedirectToEntityPage",
-    GET_SUPPORTED_INTEGRATION_CONTEXT_KEYS = "xBeesGetSupportedIntegrationContextKeys",
-    REQUEST_INTEGRATION_CONTEXT = "xBeesRequestIntegrationContext"
+    GET_INTEGRATION_PROXY_REQUEST = "xBeesGetIntegrationProxyRequest"
 }
 export declare enum ClientEventType {
     READY = "xBeesReady",
@@ -53,9 +52,8 @@ export declare enum ClientEventType {
     CUSTOM_EVENT = "xBeesCustomEvent",
     CREATE_CONTACT_IS_SUPPORTED = "xBeesCreateContactIsSupported",
     CREATE_CONTACT_HAS_NO_PERMISSION = "xBeesCreateContactHasNoPermission",
-    SUPPORTED_INTEGRATION_CONTEXT_KEYS_IS_SUPPORTED = "xBeesSupportedIntegrationContextKeysIsSupported",
-    SUPPORTED_INTEGRATION_CONTEXT_KEYS = "xBeesSupportedIntegrationContextKeys",
-    INTEGRATION_CONTEXT_RESPONSE = "xBeesIntegrationContextResponse"
+    INTEGRATION_PROXY_RESPONSE = "xBeesIntegrationProxyResponse",
+    INTEGRATION_PROXY_REQUEST_IS_SUPPORTED = "xBeesIntegrationProxyRequestIsSupported"
 }
 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 { IPayloadRequestIntegrationContext, IPayloadViewPort } from './Payload';
+import { IntegrationProxyRequest, IPayloadViewPort } from './Payload';
 import { SupportedPlatformVariant } from './Platform';
-import { GetSupportedIntegrationContextKeysResolver, LookupAndMatchBatchContactsResolver, LookupAndMatchContactsResolver, Reject, RequestIntegrationContextResolver, SuggestContactsResolver } from './Resolver';
+import { IntegrationProxyRequestResolver, LookupAndMatchBatchContactsResolver, LookupAndMatchContactsResolver, Reject, SuggestContactsResolver } from './Resolver';
 import { StorageEventCallback } from './Storage';
 import { ToastSeverity } from './Toast';
 import { XBeesUser } from './XBeesUser';
@@ -148,6 +148,13 @@ export interface ConnectClient {
     /**
      * Starts listen for the events of searching batch contacts info and handle match with the provided callback */
     onLookupAndMatchBatchContacts: (callback: (queries: ContactQuery[], returnResults: LookupAndMatchBatchContactsResolver) => void) => RemoveEventListener;
+    /**
+     * Listens for read-only Salesforce REST proxy requests from x-bees.
+     * On registration, notifies x-bees that this integration supports the proxy flow.
+     * Call `resolve(response)` with structured success or error; use `reject(reason)` only for unexpected runtime failures.
+     * When `response.error?.code === 'NOT_AUTHORIZED'`, the client notifies x-bees via `isNotAuthorized()` before sending the proxy response.
+     */
+    onIntegrationProxyRequest: (callback: (request: IntegrationProxyRequest, resolve: IntegrationProxyRequestResolver, reject: Reject) => void) => RemoveEventListener;
     /**
      * Send event for indicate if create contact functionality is supported */
     createContactIsSupported: () => Promise<ResponseMessage>;
@@ -229,18 +236,4 @@ 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, IPayloadIntegrationContextResponse, IPayloadRequestIntegrationContext, IPayloadSaveToStorage, IPayloadSendAnalytics, IPayloadStartRedirectToEntityPage, IPayloadSupportedIntegrationContextKeys, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort } from './Payload';
+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 { 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_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 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 EventPayloadMap = {
     [EventType.GET_CONTACTS_AUTO_SUGGEST]: string;
     [EventType.GET_LOOK_UP_AND_MATCH]: ContactQuery;
@@ -19,8 +19,7 @@ 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;
+    [EventType.GET_INTEGRATION_PROXY_REQUEST]: IntegrationProxyRequest;
 };
 export type EventCallbackMap = {
     [EventType.GET_CONTACTS_AUTO_SUGGEST]: (query: EventPayloadMap[EventType.GET_CONTACTS_AUTO_SUGGEST]) => void;
@@ -35,8 +34,7 @@ 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;
+    [EventType.GET_INTEGRATION_PROXY_REQUEST]: (request: EventPayloadMap[EventType.GET_INTEGRATION_PROXY_REQUEST]) => void;
 };
 export type RawMessageEvent = MessageEvent<string | Message>;
 export type ReadyExtendedProps = {

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

@@ -1,9 +1,9 @@
-import ClientParams from '../src/helpers/ClientParams';
-import { Contact, ContactQuery } from './Contact';
-import { Conversation } from './Conversation';
-import { JSONArray, JSONObject, JSONValue } from './Json';
-import { SupportedPlatformVariant } from './Platform';
-import { ToastSeverity } from './Toast';
+import ClientParams from "../src/helpers/ClientParams";
+import { Contact, ContactQuery } from "./Contact";
+import { Conversation } from "./Conversation";
+import { JSONArray, JSONObject, JSONValue } from "./Json";
+import { SupportedPlatformVariant } from "./Platform";
+import { ToastSeverity } from "./Toast";
 export interface IPayloadViewPort {
     height: number | string;
     width: number | string;
@@ -23,7 +23,7 @@ interface ThemeOptions {
     palette?: unknown;
 }
 export interface IPayloadThemeChange {
-    mode: 'light' | 'dark';
+    mode: "light" | "dark";
     themeOptions?: ThemeOptions;
 }
 export interface IPayloadCallStartedInfo {
@@ -73,7 +73,7 @@ export interface IPayloadGetFromStorage {
     key: string;
 }
 export interface IPayloadTechSupport {
-    'x-iframe-params': ClientParams;
+    "x-iframe-params": ClientParams;
     message: string;
     data?: JSONObject | JSONArray;
 }
@@ -95,25 +95,33 @@ export interface IPayloadStartRedirectToEntityPage {
 export interface IPayloadCancelRedirectToEntityPage {
     conversationId: string;
 }
-export type IntegrationContextKey = 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<IntegrationContextKey, unknown>>;
-    errors?: Partial<Record<IntegrationContextKey, string>>;
+/**
+ * Error codes for Salesforce read-only integration proxy responses.
+ */
+export type IntegrationProxyErrorCode = "INVALID_PATH" | "PATH_NOT_ALLOWED" | "MISSING_QUERY_PARAM" | "INVALID_QUERY_PARAM" | "NOT_AUTHORIZED" | "EXECUTION_FAILED";
+/**
+ * Request from x-bees to perform a read-only Salesforce REST call via the integration.
+ */
+export interface IntegrationProxyRequest {
+    path: string;
+    query?: Record<string, string | number | boolean | null | undefined>;
+    requestId?: string;
+}
+/**
+ * Result sent back to x-bees after handling a proxy request (success or structured error).
+ */
+export interface IntegrationProxyResponse {
+    ok: boolean;
+    requestId?: string;
+    path: string;
+    data?: unknown;
+    error?: {
+        code: IntegrationProxyErrorCode;
+        message: string;
+    };
+    meta: {
+        validated: boolean;
+        validationWarnings?: string[];
+    };
 }
 export {};

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

@@ -1,8 +1,7 @@
 import { Contact, ContactQuery } from './Contact';
-import { IntegrationContextKey, IPayloadIntegrationContextResponse } from './Payload';
+import { IntegrationProxyResponse } 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;
+export type IntegrationProxyRequestResolver = (response: IntegrationProxyResponse) => 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 { IntegrationContextKey, IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadIntegrationContextResponse, IPayloadRequestIntegrationContext, IPayloadSendAnalytics, IPayloadStartRedirectToEntityPage, IPayloadSupportedIntegrationContextKeys, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort, IResolvedIntegrationEntity, } from './Payload';
+export type { IntegrationProxyErrorCode, IntegrationProxyRequest, IntegrationProxyResponse, IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadCancelRedirectToEntityPage, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadSendAnalytics, IPayloadStartRedirectToEntityPage, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort, } from './Payload';
 export { SupportedPlatformVariant } from './Platform';
-export type { GetSupportedIntegrationContextKeysResolver, LookupAndMatchBatchContactsResolver, LookupAndMatchContactsResolver, Reject, RequestIntegrationContextResolver, SuggestContactsResolver, } from './Resolver';
+export type { IntegrationProxyRequestResolver, LookupAndMatchBatchContactsResolver, LookupAndMatchContactsResolver, Reject, 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.8-alpha.1",
+  "version": "1.3.8-alpha.3",
   "description": "This library provides easy communication between x-bees and integrated web applications",
   "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
   "homepage": "",