@wildix/xbees-connect 1.2.0-alpha.2 → 1.2.0-alpha.4

package/dist-es/package.json

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

@@ -2,7 +2,9 @@ import packageJson from '../package.json';
 import { ClientEventType, EventType } from './enums';
 import ClientParams from './helpers/ClientParams';
 import LocalStorageManager from './helpers/LocalStorageManager';
+import { MessageListener } from './helpers/MessageListener';
 import PostMessageController from './helpers/PostMessageController';
+import TechnicalSupport from './helpers/TechnicalSupport';
 /**
  * Client provides functionality of communication between xBees and integrated web applications via iFrame or ReactNative WebView
  * integration creates na instance with new Client()
@@ -28,52 +30,14 @@ export class Client {
             void this.getInstance().ready();
         }
     }
-    listeners = [];
-    useSubscription = false;
     localStorageManager = LocalStorageManager.getInstance();
+    messageListener = MessageListener.getInstance();
     constructor() {
         this.addEventListener(EventType.PBX_TOKEN, (token) => (ClientParams.getInstance().userToken = token));
     }
     sendAsync(data) {
         return PostMessageController.getInstance().sendAsync(data);
     }
-    parseMessage(message) {
-        try {
-            const data = typeof message.data === 'string' ? JSON.parse(message.data) : message.data;
-            if (!data?.type) {
-                return null;
-            }
-            return data;
-        }
-        catch (error) {
-            console.error('parse message error', error);
-            return null;
-        }
-    }
-    onMessage(message) {
-        if (window.location.host === message.origin || window === message.source) {
-            // skip events started from integration itself if any
-            return;
-        }
-        const data = this.parseMessage(message);
-        if (!data) {
-            return;
-        }
-        const { type, payload } = data;
-        this.listeners.forEach(({ eventName, callback }) => {
-            if (eventName === type) {
-                if (type === EventType.ADD_CALL) {
-                    const callbackFn = callback;
-                    callbackFn(payload);
-                }
-                else {
-                    // @ts-expect-error TODO: check the type for Callback<?>
-                    const callbackFn = callback;
-                    callbackFn(payload);
-                }
-            }
-        });
-    }
     ready(platform = 'all') {
         return this.sendAsync({
             type: ClientEventType.READY,
@@ -165,24 +129,10 @@ export class Client {
         return this.sendAsync({ type: ClientEventType.AUTHORIZED });
     }
     addEventListener(eventName, callback) {
-        if (!this.useSubscription) {
-            this.useSubscription = true;
-            window.addEventListener('message', this.onMessage.bind(this));
-        }
-        const foundThisEvent = this.listeners.find(({ eventName: _eventName, callback: _callback }) => eventName === _eventName && Object.is(callback, _callback));
-        if (!foundThisEvent) {
-            this.listeners.push({ eventName, callback });
-        }
-        return () => {
-            this.removeEventListener(eventName, callback);
-        };
+        return this.messageListener.addEventListener(eventName, callback);
     }
     removeEventListener(eventName, callback) {
-        this.listeners = this.listeners.filter(({ eventName: _eventName, callback: _callback }) => !(Object.is(callback, _callback) && (!eventName ? true : eventName === _eventName)));
-        if (this.useSubscription && !this.listeners.length) {
-            this.useSubscription = false;
-            window.removeEventListener('message', this.onMessage.bind(this));
-        }
+        this.messageListener.removeEventListener(eventName, callback);
     }
     off(callback) {
         this.localStorageManager.removeOnStorage(callback);
@@ -289,4 +239,7 @@ export class Client {
     setIntegrationStorageKey(integrationKey) {
         this.localStorageManager.setIntegrationKey(integrationKey);
     }
+    getTechnicalSupport() {
+        return TechnicalSupport.getInstance();
+    }
 }

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

@@ -23,4 +23,7 @@ export default class ClientParams {
         this.referrer = (params.get(UrlParams.REFERRER) ?? params.get(DeprecatedUrlParams.REFERRER));
         this.needAuthorize = params.has(UrlParams.AUTHORIZE) ?? params.has(DeprecatedUrlParams.AUTHORIZE);
     }
+    toString() {
+        return JSON.stringify(this);
+    }
 }

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

@@ -0,0 +1,78 @@
+import { EventType } from '../enums';
+export class MessageListener {
+    static instance = null;
+    static getInstance() {
+        if (!this.instance) {
+            this.instance = new MessageListener();
+        }
+        return this.instance;
+    }
+    listeners = [];
+    useSubscription = false;
+    // eslint-disable-next-line
+    constructor() { }
+    parseMessage(message) {
+        try {
+            const data = typeof message.data === 'string' ? this.parseJSON(message.data) : message.data;
+            if (!data?.type) {
+                return null;
+            }
+            return data;
+        }
+        catch (error) {
+            console.error('parse message error', error);
+            return null;
+        }
+    }
+    parseJSON(messageData) {
+        const trimmedData = messageData.trim();
+        if (!trimmedData || !trimmedData.startsWith('{') || !trimmedData.endsWith('}')) {
+            return null;
+        }
+        return JSON.parse(trimmedData);
+    }
+    onMessage = (message) => {
+        if (window.location.host === message.origin || window === message.source) {
+            // skip events started from integration itself if any
+            return;
+        }
+        const data = this.parseMessage(message);
+        if (!data) {
+            return;
+        }
+        const { type, payload } = data;
+        this.listeners.forEach(({ eventName, callback }) => {
+            if (eventName === type) {
+                if (type === EventType.ADD_CALL) {
+                    const callbackFn = callback;
+                    callbackFn(payload);
+                }
+                else {
+                    // @ts-expect-error TODO: check the type for Callback<?>
+                    const callbackFn = callback;
+                    callbackFn(payload);
+                }
+            }
+        });
+    };
+    addEventListener(eventName, callback) {
+        if (!this.useSubscription) {
+            this.useSubscription = true;
+            window.addEventListener('message', this.onMessage);
+        }
+        const foundThisEvent = this.listeners.find(({ eventName: _eventName, callback: _callback }) => eventName === _eventName && Object.is(callback, _callback));
+        if (!foundThisEvent) {
+            this.listeners.push({ eventName, callback });
+        }
+        return () => {
+            this.removeEventListener(eventName, callback);
+        };
+    }
+    removeEventListener(eventName, callback) {
+        this.listeners = this.listeners.filter(({ eventName: _eventName, callback: _callback }) => !(Object.is(callback, _callback) && (!eventName ? true : eventName === _eventName)));
+        if (this.useSubscription && !this.listeners.length) {
+            this.useSubscription = false;
+            window.removeEventListener('message', this.onMessage);
+        }
+    }
+}

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

@@ -0,0 +1,25 @@
+import { ClientEventType } from '../enums';
+import ClientParams from './ClientParams';
+import PostMessageController from './PostMessageController';
+class TechnicalSupport {
+    static instance = null;
+    static getInstance() {
+        if (!this.instance) {
+            this.instance = new TechnicalSupport();
+        }
+        return this.instance;
+    }
+    // eslint-disable-next-line
+    constructor() { }
+    sendTechnicalInformation(message, data) {
+        return PostMessageController.getInstance().sendAsyncErrorSafe({
+            type: ClientEventType.SEND_TECHNICAL_SUPPORT_INFORMATION,
+            payload: {
+                'x-iframe-params': ClientParams.getInstance(),
+                message,
+                data,
+            },
+        });
+    }
+}
+export default TechnicalSupport;

package/dist-es/types/Json.js

@@ -0,0 +1 @@
+export {};

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

@@ -8,6 +8,7 @@ import { LookupAndMatchContactsResolver, Reject, SuggestContactsResolver } from
 import { StorageEventCallback } from '../types/Storage';
 import { ToastSeverity } from '../types/Toast';
 import { ClientEventType, EventType } from './enums';
+import TechnicalSupport from './helpers/TechnicalSupport';
 /**
  * Client provides functionality of communication between xBees and integrated web applications via iFrame or ReactNative WebView
  * integration creates na instance with new Client()
@@ -16,13 +17,10 @@ export declare class Client implements ConnectClient {
     private static instance;
     static getInstance(): ConnectClient;
     static initialize(renderer: () => Promise<void>): void;
-    private listeners;
-    private useSubscription;
     private readonly localStorageManager;
-    constructor();
+    private readonly messageListener;
+    private constructor();
     private sendAsync;
-    private parseMessage;
-    private onMessage;
     ready(platform?: SupportedPlatformVariant | undefined): Promise<ResponseMessage>;
     version(): string;
     isPlatformNative(): boolean;
@@ -68,4 +66,5 @@ export declare class Client implements ConnectClient {
     onLogout(callback: Callback<EventType.LOGOUT>): RemoveEventListener;
     sendAnalytics(eventName: string, params?: Record<string, string>): void;
     setIntegrationStorageKey(integrationKey: string): void;
+    getTechnicalSupport(): TechnicalSupport;
 }

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

@@ -9,4 +9,5 @@ export default class ClientParams {
     readonly iframeId: string;
     readonly variant: WorkVariants | null;
     constructor();
+    toString(): string;
 }

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

@@ -0,0 +1,15 @@
+import { Callback } from '../../types/Callback';
+import { RemoveEventListener } from '../../types/Listener';
+import { EventType } from '../enums';
+export declare class MessageListener {
+    private static instance;
+    static getInstance(): MessageListener;
+    private listeners;
+    private useSubscription;
+    private constructor();
+    private parseMessage;
+    private parseJSON;
+    private onMessage;
+    addEventListener<T extends EventType = EventType>(eventName: T, callback: Callback<T>): RemoveEventListener;
+    removeEventListener<T extends EventType = EventType>(eventName: T | null, callback: Callback<T>): void;
+}

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

@@ -0,0 +1,9 @@
+import { JSONArray, JSONObject } from '../../types';
+import { ClientEventType } from '../enums';
+declare class TechnicalSupport {
+    private static instance;
+    static getInstance(): TechnicalSupport;
+    private constructor();
+    sendTechnicalInformation(message: string, data?: JSONObject | JSONArray): Promise<import("../../types/Message").ResponseMessage<ClientEventType.SEND_TECHNICAL_SUPPORT_INFORMATION> | undefined>;
+}
+export default TechnicalSupport;

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

@@ -1,4 +1,5 @@
 import { ClientEventType, EventType } from '../src/enums';
+import TechnicalSupport from '../src/helpers/TechnicalSupport';
 import { Callback } from './Callback';
 import { Contact, ContactQuery } from './Contact';
 import { RemoveEventListener } from './Listener';
@@ -147,4 +148,7 @@ export interface ConnectClient {
     /**
      * send analytics data to x-bees for track into analytics data */
     sendAnalytics: (eventName: string, params?: Record<string, string>) => void;
+    /**
+     * special object to provide x-bees technical support */
+    getTechnicalSupport: () => TechnicalSupport;
 }

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

@@ -0,0 +1,7 @@
+type JSONValue = string | number | boolean | null | JSONObject | JSONArray;
+export interface JSONObject {
+    [key: string]: JSONValue;
+}
+export interface JSONArray extends Array<JSONValue> {
+}
+export {};

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

@@ -1,5 +1,7 @@
+import ClientParams from '../src/helpers/ClientParams';
 import { Contact, ContactQuery } from './Contact';
 import { Conversation } from './conversation';
+import { JSONArray, JSONObject } from './Json';
 import { SupportedPlatformVariant } from './Platform';
 import { ToastSeverity } from './Toast';
 export interface IPayloadViewPort {
@@ -52,5 +54,7 @@ export interface IPayloadSendAnalytics {
     params?: Record<string, string>;
 }
 export interface IPayloadTechSupport {
+    'x-iframe-params': ClientParams;
     message: string;
+    data?: JSONObject | JSONArray;
 }

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

@@ -1,3 +1,4 @@
 import { Contact, ContactQuery } from './Contact';
+import { JSONArray, JSONObject } from './Json';
 import { IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadSendAnalytics, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort } from './Payload';
-export type { Contact, ContactQuery, IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadSendAnalytics, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort, };
+export type { Contact, ContactQuery, IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadSendAnalytics, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort, JSONArray, JSONObject, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wildix/xbees-connect",
-  "version": "1.2.0-alpha.2",
+  "version": "1.2.0-alpha.4",
   "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": "e18b94393f098d28bdcdf727173e765802584692"
+  "gitHead": "9b2373d5205d394e554be89f5001d14105322995"
 }