@wildix/xbees-connect 1.3.17-alpha.1 → 1.3.17-beta.2

package/README.md

@@ -182,6 +182,10 @@ Returns `true` when the integration is launched in fullsize mode (`f`).
 
 Returns `true` when the integration is opened for activation/authorization purposes only (URL contains the `authorize` parameter).
 
+#### `isCloudBackendEnabled(): boolean`
+
+Returns `true` when cloud backend is enabled for this integration. Reads the `cbi` URL parameter at construction time (`cbi=1` → `true`, `cbi=0` or missing → `false`).
+
 ---
 
 ### Context
@@ -518,10 +522,10 @@ client.setChatToOpen('chat_id');
 
 #### `getChannelsByEmailOrPhone(payload: IPayloadGetChannelsByEmailOrPhone): Promise<ResponseMessage>`
 
-Asks x-bees to look up chat channels for an email address or phone number. The integration sends `ClientEventType.GET_CHANNELS_BY_EMAIL_OR_PHONE` (`xBeesGetChannelsByEmailOrPhone`) with payload `{ id, type }`, where `type` is `'email'` or `'phone'`. Resolves with a `ResponseMessage` whose payload contains the matching channels returned by x-bees.
+Asks x-bees to look up chat channels for an email address or phone number. The integration sends `ClientEventType.GET_CHANNELS_BY_EMAIL_OR_PHONE` (`xBeesGetChannelsByEmailOrPhone`) with payload `{ value, type }`, where `type` is `'email'` or `'phone'`. Resolves with a `ResponseMessage` whose payload contains the matching channels returned by x-bees.
 
 ```ts
-const { payload } = await client.getChannelsByEmailOrPhone({ id: 'user@example.com', type: 'email' });
+const { payload } = await client.getChannelsByEmailOrPhone({ value: 'user@example.com', type: 'email' });
 ```
 
 ---

package/dist-cjs/package.json

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

package/dist-cjs/src/Client.js

@@ -52,6 +52,7 @@ class Client {
     variant = null;
     startPage = null;
     product = null;
+    cloudBackendEnabled;
     localStorageManager = LocalStorageManager_1.default.getInstance();
     constructor() {
         const params = (0, getUrlSearchParamsMap_1.getUrlSearchParamsMap)();
@@ -62,6 +63,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.cloudBackendEnabled = params.get(enums_1.UrlParams.CLOUD_BACKEND_ENABLED) === '1';
         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;
@@ -239,6 +241,9 @@ class Client {
     isActivationOnly() {
         return this.needAuthorize;
     }
+    isCloudBackendEnabled() {
+        return this.cloudBackendEnabled;
+    }
     getContext() {
         return this.sendAsync({ type: enums_1.ClientEventType.CONTEXT });
     }
@@ -547,6 +552,12 @@ class Client {
         });
     }
     getChannelsByEmailOrPhone(payload) {
+        if (!payload?.value?.trim()) {
+            return Promise.reject(new Error('`value` is required'));
+        }
+        if (payload.type !== 'email' && payload.type !== 'phone') {
+            return Promise.reject(new Error('`type` must be "email" or "phone"'));
+        }
         return this.sendAsync({
             type: enums_1.ClientEventType.GET_CHANNELS_BY_EMAIL_OR_PHONE,
             payload,

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

@@ -75,6 +75,7 @@ var UrlParams;
     UrlParams["AUTHORIZE"] = "a";
     UrlParams["START_PAGE"] = "sp";
     UrlParams["PRODUCT"] = "p";
+    UrlParams["CLOUD_BACKEND_ENABLED"] = "cbi";
 })(UrlParams || (exports.UrlParams = UrlParams = {}));
 var StartPage;
 (function (StartPage) {

package/dist-cjs/src/helpers/ClientParams.js

@@ -19,6 +19,7 @@ class ClientParams {
     userExtension = null;
     startPage = null;
     product = null;
+    cloudBackendEnabled;
     constructor() {
         const params = (0, getUrlSearchParamsMap_1.getUrlSearchParamsMap)();
         this.iframeId = params.get(enums_1.UrlParams.ID);
@@ -30,6 +31,7 @@ class ClientParams {
         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.cloudBackendEnabled = params.get(enums_1.UrlParams.CLOUD_BACKEND_ENABLED) === '1';
     }
     toString() {
         const { userToken, ...props } = this;

package/dist-es/package.json

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

package/dist-es/src/Client.js

@@ -46,6 +46,7 @@ export class Client {
     variant = null;
     startPage = null;
     product = null;
+    cloudBackendEnabled;
     localStorageManager = LocalStorageManager.getInstance();
     constructor() {
         const params = getUrlSearchParamsMap();
@@ -56,6 +57,7 @@ export class Client {
         this.needAuthorize = params.has(UrlParams.AUTHORIZE);
         this.startPage = params.get(UrlParams.START_PAGE);
         this.product = params.get(UrlParams.PRODUCT);
+        this.cloudBackendEnabled = params.get(UrlParams.CLOUD_BACKEND_ENABLED) === '1';
         this.integrationId = params.get(UrlParams.ID)?.split('-')[0] ?? '';
         // @ts-expect-error window.ReactNativeWebView will be provided by ReactNative WebView
         this.isParentReactNativeWebView = !!window.ReactNativeWebView;
@@ -233,6 +235,9 @@ export class Client {
     isActivationOnly() {
         return this.needAuthorize;
     }
+    isCloudBackendEnabled() {
+        return this.cloudBackendEnabled;
+    }
     getContext() {
         return this.sendAsync({ type: ClientEventType.CONTEXT });
     }
@@ -541,6 +546,12 @@ export class Client {
         });
     }
     getChannelsByEmailOrPhone(payload) {
+        if (!payload?.value?.trim()) {
+            return Promise.reject(new Error('`value` is required'));
+        }
+        if (payload.type !== 'email' && payload.type !== 'phone') {
+            return Promise.reject(new Error('`type` must be "email" or "phone"'));
+        }
         return this.sendAsync({
             type: ClientEventType.GET_CHANNELS_BY_EMAIL_OR_PHONE,
             payload,

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

@@ -72,6 +72,7 @@ export var UrlParams;
     UrlParams["AUTHORIZE"] = "a";
     UrlParams["START_PAGE"] = "sp";
     UrlParams["PRODUCT"] = "p";
+    UrlParams["CLOUD_BACKEND_ENABLED"] = "cbi";
 })(UrlParams || (UrlParams = {}));
 export var StartPage;
 (function (StartPage) {

package/dist-es/src/helpers/ClientParams.js

@@ -17,6 +17,7 @@ export default class ClientParams {
     userExtension = null;
     startPage = null;
     product = null;
+    cloudBackendEnabled;
     constructor() {
         const params = getUrlSearchParamsMap();
         this.iframeId = params.get(UrlParams.ID);
@@ -28,6 +29,7 @@ export default class ClientParams {
         this.needAuthorize = params.has(UrlParams.AUTHORIZE);
         this.startPage = params.get(UrlParams.START_PAGE);
         this.product = params.get(UrlParams.PRODUCT);
+        this.cloudBackendEnabled = params.get(UrlParams.CLOUD_BACKEND_ENABLED) === '1';
     }
     toString() {
         const { userToken, ...props } = this;

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

@@ -29,6 +29,7 @@ export declare class Client implements ConnectClient {
     private readonly variant;
     private readonly startPage;
     private readonly product;
+    private readonly cloudBackendEnabled;
     private readonly localStorageManager;
     constructor();
     private sendAsync;
@@ -66,6 +67,7 @@ export declare class Client implements ConnectClient {
     showsUi(): boolean;
     isFullsize(): boolean;
     isActivationOnly(): boolean;
+    isCloudBackendEnabled(): boolean;
     getContext(): Promise<Message<ClientEventType.CONTEXT>>;
     getCurrentContact(): Promise<Message<ClientEventType.CURRENT_CONTACT>>;
     getCurrentConversation(): Promise<Message<ClientEventType.CURRENT_CONVERSATION>>;

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

@@ -68,7 +68,8 @@ export declare enum UrlParams {
     REFERRER = "r",
     AUTHORIZE = "a",
     START_PAGE = "sp",
-    PRODUCT = "p"
+    PRODUCT = "p",
+    CLOUD_BACKEND_ENABLED = "cbi"
 }
 export declare enum StartPage {
     CREATE_CONTACT = "createContact"

package/dist-types/src/helpers/ClientParams.d.ts

@@ -12,6 +12,7 @@ export default class ClientParams {
     readonly userExtension: string | null;
     readonly startPage: StartPage | null;
     readonly product: Product | null;
+    readonly cloudBackendEnabled: boolean;
     constructor();
     toString(): string;
 }

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

@@ -79,6 +79,9 @@ export interface ConnectClient {
      * dialog which leads to integration be activated
      * */
     isActivationOnly: () => boolean;
+    /**
+     * Determines whether cloud backend is enabled for this integration (URL parameter `cbi=1`). */
+    isCloudBackendEnabled: () => boolean;
     /**
      * Retrieves current x-bees context data */
     getContext: () => Promise<ResponseMessage<ClientEventType.CONTEXT>>;
@@ -236,7 +239,7 @@ export interface ConnectClient {
     setChatToOpen: (chatId: string) => void;
     /**
      * Asks x-bees to look up chat channels for an email address or phone number.
-     * @param payload - Contact identifier: `id` (email or phone value) and `type` (`'email'` or `'phone'`).
+     * @param payload - Contact identifier: `value` (email or phone value) and `type` (`'email'` or `'phone'`).
      */
     getChannelsByEmailOrPhone: (payload: IPayloadGetChannelsByEmailOrPhone) => Promise<ResponseMessage>;
     /**

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

@@ -101,7 +101,7 @@ export interface IPayloadSetChatToOpen {
     chatId: string;
 }
 export interface IPayloadGetChannelsByEmailOrPhone {
-    id: string;
+    value: string;
     type: 'email' | 'phone';
 }
 export interface IPayloadContactWeightUpdate {

package/package.json

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