@wildix/xbees-connect 1.1.5 → 1.1.7

package/dist-es/package.json

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

@@ -3,6 +3,7 @@ import { ClientEventType, DeprecatedUrlParams, EventType, UrlParams } from './en
 import LocalStorageManager from './helpers/LocalStorageManager';
 import PostMessageControllerNative from './helpers/PostMessageControllerNative';
 import PostMessageControllerWeb from './helpers/PostMessageControllerWeb';
+import { getUrlSearchParamsMap } from './utils/url/getUrlSearchParamsMap';
 /**
  * Client provides functionality of communication between xBees and integrated web applications via iFrame or ReactNative WebView
  * integration creates na instance with new Client()
@@ -40,7 +41,7 @@ export class Client {
     variant = null;
     localStorageManager = LocalStorageManager.getInstance();
     constructor() {
-        const params = new URLSearchParams(window.location.search);
+        const params = getUrlSearchParamsMap();
         this.iframeId = (params.get(UrlParams.ID) ?? params.get(DeprecatedUrlParams.ID));
         this.variant = (params.get(UrlParams.VARIANT) ?? params.get(DeprecatedUrlParams.VARIANT));
         this.userEmail = (params.get(UrlParams.USER) ?? params.get(DeprecatedUrlParams.USER));
@@ -95,10 +96,10 @@ export class Client {
             }
         });
     }
-    ready() {
+    ready(platform = 'all') {
         return this.sendAsync({
             type: ClientEventType.READY,
-            payload: { version: this.version() },
+            payload: { version: this.version(), platform },
         });
     }
     version() {
@@ -120,11 +121,10 @@ export class Client {
         return this.referrer;
     }
     getBackToAppUrl() {
-        const url = new URL(`${this.referrer}/integrations/${this.iframeId}`);
         if (Client.getInstance().isPlatformNative()) {
-            url.protocol = 'com.wildix.rnc:';
+            return `com.wildix.rnc://integrations/${this.iframeId}`;
         }
-        return url.toString();
+        return `${this.referrer}/integrations/${this.iframeId}`;
     }
     isDataOnly() {
         return this.variant === 'no-ui' || this.variant === 'daemon';
@@ -168,6 +168,9 @@ export class Client {
     toClipboard(payload) {
         return this.sendAsync({ type: ClientEventType.TO_CLIPBOARD, payload });
     }
+    showToast(message, severity = 'INFO') {
+        return this.sendAsync({ type: ClientEventType.TOAST, payload: { message, severity } });
+    }
     isNotAuthorized() {
         return this.sendAsync({ type: ClientEventType.NOT_AUTHORIZED });
     }
@@ -223,6 +226,9 @@ export class Client {
     onPbxTokenChange(callback) {
         return this.addEventListener(EventType.PBX_TOKEN, callback);
     }
+    getXBeesToken() {
+        return this.sendAsync({ type: ClientEventType.TOKEN });
+    }
     onSuggestContacts(callback) {
         return this.addEventListener(EventType.GET_CONTACTS_AUTO_SUGGEST, (query) => {
             const resolve = (contacts) => this.sendAsync({

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

@@ -19,8 +19,10 @@ export var ClientEventType;
     ClientEventType["VIEW_PORT"] = "xBeesViewPort";
     ClientEventType["REBOOT"] = "xBeesReboot";
     ClientEventType["TO_CLIPBOARD"] = "xBeesToClipboard";
+    ClientEventType["TOAST"] = "xBeesShowToast";
     ClientEventType["NOT_AUTHORIZED"] = "xBeesNotAuthorized";
     ClientEventType["AUTHORIZED"] = "xBeesAuthorized";
+    ClientEventType["TOKEN"] = "xBeesToken";
     ClientEventType["CONTACTS_AUTO_SUGGEST"] = "xBeesContactsAutoSuggest";
     ClientEventType["CONTACT_LOOKUP_AND_MATCH"] = "xBeesContactLookupAndMatch";
     ClientEventType["CONTACT_CREATE_OR_UPDATE"] = "xBeesContactCreateOrUpdate";

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

@@ -54,7 +54,6 @@ class LocalStorageManager {
             return !data ? data : JSON.parse(data);
         }
         catch (error) {
-            console.debug('parse data error', error);
             return data;
         }
     }

package/dist-es/src/utils/url/getUrlSearchParamsMap.js

@@ -0,0 +1,3 @@
+export function getUrlSearchParamsMap() {
+    return new URLSearchParams(window.location.search);
+}

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

@@ -1,4 +1,4 @@
-import { Callback, ConnectClient, Contact, ContactQuery, IPayloadAutoSuggestResult, IPayloadContactMatchResult, IPayloadViewPort, LookupAndMatchContactsResolver, Message, Reject, RemoveEventListener, ResponseMessage, StorageEventCallback, SuggestContactsResolver } from '../types';
+import { Callback, ConnectClient, Contact, ContactQuery, IPayloadAutoSuggestResult, IPayloadContactMatchResult, IPayloadViewPort, LookupAndMatchContactsResolver, Message, Reject, RemoveEventListener, ResponseMessage, StorageEventCallback, SuggestContactsResolver, SupportedPlatformVariant, ToastSeverity } from '../types';
 import { ClientEventType, EventType } from './enums';
 /**
  * Client provides functionality of communication between xBees and integrated web applications via iFrame or ReactNative WebView
@@ -23,7 +23,7 @@ export declare class Client implements ConnectClient {
     private sendAsync;
     private parseMessage;
     private onMessage;
-    ready(): Promise<ResponseMessage<ClientEventType.READY>>;
+    ready(platform?: SupportedPlatformVariant | undefined): Promise<ResponseMessage>;
     version(): string;
     isPlatformNative(): boolean;
     isPlatformWeb(): boolean;
@@ -44,6 +44,7 @@ export declare class Client implements ConnectClient {
     reboot(): Promise<ResponseMessage>;
     setViewport(payload: IPayloadViewPort): Promise<ResponseMessage>;
     toClipboard(payload: string): Promise<ResponseMessage>;
+    showToast(message: string, severity?: ToastSeverity | undefined): Promise<ResponseMessage>;
     isNotAuthorized(): Promise<ResponseMessage>;
     isAuthorized(): Promise<ResponseMessage>;
     sendContactsAutoSuggest(payload: IPayloadAutoSuggestResult): Promise<Message<ClientEventType.CONTACTS_AUTO_SUGGEST>>;
@@ -55,6 +56,7 @@ export declare class Client implements ConnectClient {
     onCallEnded(callback: Callback<EventType.TERMINATE_CALL>): RemoveEventListener;
     onCallStarted(callback: Callback<EventType.ADD_CALL>): RemoveEventListener;
     onPbxTokenChange(callback: Callback<EventType.PBX_TOKEN>): RemoveEventListener;
+    getXBeesToken(): Promise<Message<ClientEventType.TOKEN>>;
     onSuggestContacts(callback: (query: string, resolve: SuggestContactsResolver, reject: Reject) => void): RemoveEventListener;
     onLookupAndMatchContact(callback: (query: ContactQuery, resolve: LookupAndMatchContactsResolver, reject: Reject) => void): RemoveEventListener;
     onThemeChange(callback: Callback<EventType.USE_THEME>): RemoveEventListener;

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

@@ -17,8 +17,10 @@ export declare enum ClientEventType {
     VIEW_PORT = "xBeesViewPort",
     REBOOT = "xBeesReboot",
     TO_CLIPBOARD = "xBeesToClipboard",
+    TOAST = "xBeesShowToast",
     NOT_AUTHORIZED = "xBeesNotAuthorized",
     AUTHORIZED = "xBeesAuthorized",
+    TOKEN = "xBeesToken",
     CONTACTS_AUTO_SUGGEST = "xBeesContactsAutoSuggest",
     CONTACT_LOOKUP_AND_MATCH = "xBeesContactLookupAndMatch",
     CONTACT_CREATE_OR_UPDATE = "xBeesContactCreateOrUpdate"

package/dist-types/src/utils/url/getUrlSearchParamsMap.d.ts

@@ -0,0 +1 @@
+export declare function getUrlSearchParamsMap(): URLSearchParams;

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

@@ -29,6 +29,12 @@ export interface IPayloadViewPort {
 }
 export interface IPayloadVersion {
     version: string;
+    platform?: SupportedPlatformVariant;
+}
+export type ToastSeverity = 'INFO' | 'WARNING' | 'ERROR' | 'SUCCESS' | 'NOTICE';
+export interface IPayloadToast {
+    severity: ToastSeverity;
+    message: string;
 }
 export interface IPayloadThemeChange {
     mode: 'light' | 'dark';
@@ -57,7 +63,7 @@ export interface IPayloadContactResult {
 }
 export interface IPayloadContextResult extends IPayloadContactResult {
 }
-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 ? IPayloadContactMatchResult : T extends ClientEventType.CONTACT_CREATE_OR_UPDATE ? IPayloadContactMatchResult : T extends ClientEventType.CONTEXT ? IPayloadContextResult : T extends ClientEventType.CURRENT_CONTACT ? IPayloadContactResult : 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 EventType.PBX_TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : never;
+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 ? IPayloadContactMatchResult : T extends ClientEventType.CONTACT_CREATE_OR_UPDATE ? IPayloadContactMatchResult : T extends ClientEventType.CONTEXT ? IPayloadContextResult : T extends ClientEventType.CURRENT_CONTACT ? IPayloadContactResult : 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 EventType.PBX_TOKEN ? string : T extends ClientEventType.TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : never;
 export type Message<T extends MessageType = MessageType> = {
     type: T;
     payload?: EventPayload<T>;
@@ -102,10 +108,11 @@ export type SuggestContactsResolver = (contacts: Contact[]) => void;
 export type LookupAndMatchContactsResolver = (contact: Contact) => void;
 export type Reject = (reason: string) => void;
 export type RemoveEventListener = () => void;
+export type SupportedPlatformVariant = 'all' | 'web' | 'mobile';
 export interface ConnectClient {
     /**
      * Sends to x-bees signal that iFrame is ready to be shown. iFrame should send it when the application starts and ready */
-    ready: () => Promise<ResponseMessage>;
+    ready: (platform?: SupportedPlatformVariant) => Promise<ResponseMessage>;
     /**
      * Retrieves current pbx token */
     getUserPbxToken: () => string;
@@ -169,6 +176,9 @@ export interface ConnectClient {
     /**
      * Sends request to x-bees to put string to the users clipboard */
     toClipboard: (payload: string) => Promise<ResponseMessage>;
+    /**
+     * Sends message to x-bees to be shown as a toast with specified severity level */
+    showToast: (message: string, severity?: ToastSeverity) => Promise<ResponseMessage>;
     /**
      * Sends a response to x-bees for contacts autoSuggest */
     sendContactsAutoSuggest: (payload: IPayloadAutoSuggestResult) => Promise<Message<ClientEventType.CONTACTS_AUTO_SUGGEST>>;
@@ -193,6 +203,9 @@ export interface ConnectClient {
     /**
      * Starts listen for the events of changing pbx token and handle with the provided callback */
     onPbxTokenChange: (callback: Callback<EventType.PBX_TOKEN>) => RemoveEventListener;
+    /**
+     * Retrieves current x-bees token */
+    getXBeesToken: () => Promise<Message<ClientEventType.TOKEN>>;
     /**
      * Starts listen for the events of searching contacts and handle autosuggestion with the provided callback */
     onSuggestContacts: (callback: (query: string, resolve: SuggestContactsResolver, reject: Reject) => void) => RemoveEventListener;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wildix/xbees-connect",
-  "version": "1.1.5",
+  "version": "1.1.7",
   "description": "This library provides easy communication between x-bees and integrated web applications",
   "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
   "homepage": "",
@@ -42,5 +42,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "c22c0f1e9bfe829e236308481ecf587bee397578"
+  "gitHead": "0f4783eaf917b09c70b65745fc2a264331d4c721"
 }