@wildix/xbees-connect 1.3.8 → 1.3.10

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",
+    "version": "1.3.10",
     "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

@@ -133,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,
@@ -141,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;
             }
@@ -243,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 });
@@ -273,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 });
@@ -402,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,

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

@@ -17,6 +17,7 @@ var EventType;
     EventType["CONTACT_REFRESH"] = "xBeesContactRefresh";
     EventType["START_REDIRECT_TO_ENTITY_PAGE"] = "xBeesStartRedirectToEntityPage";
     EventType["CANCEL_REDIRECT_TO_ENTITY_PAGE"] = "xBeesCancelRedirectToEntityPage";
+    EventType["GET_INTEGRATION_PROXY_REQUEST"] = "xBeesGetIntegrationProxyRequest";
 })(EventType || (exports.EventType = EventType = {}));
 var ClientEventType;
 (function (ClientEventType) {
@@ -56,6 +57,8 @@ var ClientEventType;
     ClientEventType["CUSTOM_EVENT"] = "xBeesCustomEvent";
     ClientEventType["CREATE_CONTACT_IS_SUPPORTED"] = "xBeesCreateContactIsSupported";
     ClientEventType["CREATE_CONTACT_HAS_NO_PERMISSION"] = "xBeesCreateContactHasNoPermission";
+    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",
+    "version": "1.3.10",
     "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

@@ -127,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,
@@ -135,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;
             }
@@ -237,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 });
@@ -267,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 });
@@ -396,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,

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

@@ -14,6 +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_INTEGRATION_PROXY_REQUEST"] = "xBeesGetIntegrationProxyRequest";
 })(EventType || (EventType = {}));
 export var ClientEventType;
 (function (ClientEventType) {
@@ -53,6 +54,8 @@ export var ClientEventType;
     ClientEventType["CUSTOM_EVENT"] = "xBeesCustomEvent";
     ClientEventType["CREATE_CONTACT_IS_SUPPORTED"] = "xBeesCreateContactIsSupported";
     ClientEventType["CREATE_CONTACT_HAS_NO_PERMISSION"] = "xBeesCreateContactHasNoPermission";
+    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, 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 { LookupAndMatchBatchContactsResolver } 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;

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

@@ -12,7 +12,8 @@ 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_INTEGRATION_PROXY_REQUEST = "xBeesGetIntegrationProxyRequest"
 }
 export declare enum ClientEventType {
     READY = "xBeesReady",
@@ -50,7 +51,9 @@ 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",
+    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 { IPayloadViewPort } from './Payload';
+import { IntegrationProxyRequest, IPayloadViewPort } from './Payload';
 import { SupportedPlatformVariant } from './Platform';
-import { LookupAndMatchBatchContactsResolver, LookupAndMatchContactsResolver, Reject, 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>;

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 { 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 : 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,6 +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_INTEGRATION_PROXY_REQUEST]: IntegrationProxyRequest;
 };
 export type EventCallbackMap = {
     [EventType.GET_CONTACTS_AUTO_SUGGEST]: (query: EventPayloadMap[EventType.GET_CONTACTS_AUTO_SUGGEST]) => void;
@@ -33,6 +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_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

@@ -89,10 +89,41 @@ export interface IPayloadContactWeightUpdate {
     query: ContactQuery;
 }
 export interface IPayloadStartRedirectToEntityPage {
-    conversationId: string;
+    callId?: string;
+    conversationId?: string;
     pageName: string;
 }
 export interface IPayloadCancelRedirectToEntityPage {
-    conversationId: string;
+    conversationId?: string;
+    callId?: 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,5 +1,7 @@
 import { Contact, ContactQuery } from './Contact';
+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 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 { IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadSendAnalytics, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort, IPayloadStartRedirectToEntityPage, IPayloadCancelRedirectToEntityPage, } 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 { LookupAndMatchBatchContactsResolver, LookupAndMatchContactsResolver, Reject, 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",
+  "version": "1.3.10",
   "description": "This library provides easy communication between x-bees and integrated web applications",
   "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
   "homepage": "",