@wildix/xbees-connect 1.0.4-alpha.10 → 1.0.5-alpha.0

package/README.md

@@ -1,4 +1,4 @@
-# xbees connect client
+# x-bees-connect client
 
 This package is the Community plan edition of the client for UI integration applications.
 
@@ -6,41 +6,130 @@ This package is the Community plan edition of the client for UI integration appl
 
 Install the package in your project directory with:
 
-yarn
-
 ```bash
 yarn add @wildix/xbees-connect
 ```
-
-npm
-
 ```bash
 npm install @wildix/xbees-connect
 ```
 
 ## Usage
 
-```
+```ts
 import Client from "@wildix/xbees-connect";
 
 const xBeesClient = Client.getInstance();
+
 console.log(xBeesClient.version());
 
 ```
 
-This component has the following peer dependencies that you will need to install as well.
+## API
 
-```json
-{
-  "peerDependencies": {
-    "@mui/material": "^5.4.1",
-    "@mui/system": "^5.4.1",
-    "react": "^17.0.0 || ^18.0.0",
-    "react-dom": "^17.0.0 || ^18.0.0"
-  }
-}
+### Initialization
+
+#### `ready()`
+
+Sends the signal to x-bees that iFrame is ready to be shown. iFrame should send it when the application starts and is ready.
+
+#### `isAuthorized: (payload: string) => Promise<ResponseFromChannel>`
+
+Sends the message to x-bees that the user is authorized and no more actions are required.
+
+#### `isNotAuthorized: (payload: string) => Promise<ResponseFromChannel>`
+
+Sends the message to x-bees that user actions are required:
+
+### Contacts search
+
+#### `onSuggestContacts: ((query: string, resolve: Resolve, reject: Reject) => void) => RemoveEventListener`
+
+Starts listen for the events of searching contacts and handle autosuggestion with the provided callback */
+
+```jsx
+Client.getInstance().onSuggestContacts(async (query, resolve) => {
+    try {
+        const contacts = await fetchContacts(query);
+        resolve(contacts);
+    } catch (error) {
+        console.log('catch', error);
+    }
+});
 ```
 
-## Documentation
+### Context
+#### `getContext(): Promise<Response>`
+
+Retrieves current x-bees context data. The data may be different depending on context.
+
+#### `getCurrentContact(): Promise<Response>`
+
+Retrieves contact data currently opened in x-bees.
+
+#### `getThemeMode(): Promise<Response>`
+
+Retrieves current theme mode (light or dark)
+
+#### `getTheme(): Promise<Response>`
+
+Retrieves current theme mode and theme options
+
+#### `onThemeChange: (callback: ThemeChangeListenerCallback) => void;`
+
+Starts to listen for the events of changing theme and returns the provided callback
+
+#### `onPbxTokenChange: (callback: ListenerCallback) => void;`
 
-Visit [https://mui.com/x/react-data-grid/](https://mui.com/x/react-data-grid/) to view the full documentation.
+Starts to listen for the events of changing PBX token and returns the provided callback
+
+#### `onCallStarted: (callback: ListenerCallback) => void;`
+
+Starts to listen for the events of starting the call and returns the provided callback
+
+#### `onCallEnded: (callback: ListenerCallback) => void;`
+
+Starts to listen for the events of ending the call and returns the provided callback
+
+#### `off: (callback: ListenerCallback) => void;`
+
+Removes particular callback from handling events
+
+
+### Other
+#### `version(): string`
+
+Retrieves the version of xBeesConnect
+
+#### `startCall(phoneNumber: string)`
+
+Sends a request to x-bees to start a call with a number
+
+#### `reboot()`
+
+Sends a request to x-bees to restart the iFrame, reload with actual parameters and token
+
+#### `setViewport({height: number; width: number})`
+
+Sends a request to x-bees about changes of the current frame size
+
+#### `toClipboard(payload: string)`
+
+Sends a request to x-bees to put a string to the user's clipboard
+
+#### `addEventListener()`
+
+Starts listening for one of the x-bees events and returns the provided callback
+
+#### `removeEventListener()`
+
+Stops listening for one of the x-bees events with the particular callback
+
+## Known issues
+
+The below function can fix cases when `String.replaceAll()` does not work in the mobile version. Most likely, this is some kind of WebView bug.
+
+```ts
+function replaceAll(str: string, search: string, replace: string) {
+    return str.split(search).join(replace);
+}
+```

package/dist-es/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wildix/xbees-connect",
-    "version": "1.0.4-alpha.1",
+    "version": "1.0.4-alpha.10",
     "description": "This library provides easy communication between x-bees and integrated web applications",
     "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
     "homepage": "",
@@ -23,7 +23,7 @@
     ],
     "repository": {
         "type": "git",
-        "url": "git@git.wildix.com:dimitri.chernykh/sdk-ui.git"
+        "url": "git@git.wildix.com:xbs/sdk-ui.git"
     },
     "publishConfig": {
         "access": "public"
@@ -34,7 +34,9 @@
         "typescript": "^5.2.2"
     },
     "parserOptions": {
-        "project": ["./tsconfig.json"]
+        "project": [
+            "./tsconfig.json"
+        ]
     },
     "engines": {
         "node": ">=16"

package/dist-es/src/Client.js

@@ -14,6 +14,20 @@ export class Client {
         }
         return this.instance;
     }
+    static initialize(renderer) {
+        if (this.getInstance().showsUi()) {
+            try {
+                void renderer();
+            }
+            catch (error) {
+                console.error('Error on init rendering widget:', error);
+            }
+        }
+        else {
+            console.log('run daemon');
+            void this.getInstance().ready();
+        }
+    }
     worker;
     listeners = [];
     useSubscription = false;
@@ -21,7 +35,7 @@ export class Client {
     variant = null;
     constructor() {
         const params = new URLSearchParams(window.location.search);
-        this.iframeId = params.get('iframeId') ?? undefined;
+        this.iframeId = params.get('iframeId');
         this.variant = params.get('variant');
         // @ts-expect-error window.ReactNativeWebView will be provided by ReactNative WebView
         this.worker = window.ReactNativeWebView
@@ -109,11 +123,11 @@ export class Client {
     toClipboard(payload) {
         return this.sendAsync({ type: ClientEventType.TO_CLIPBOARD, payload });
     }
-    isNotAuthorized(payload) {
-        return this.sendAsync({ type: ClientEventType.NOT_AUTHORIZED, payload });
+    isNotAuthorized() {
+        return this.sendAsync({ type: ClientEventType.NOT_AUTHORIZED });
     }
-    isAuthorized(payload) {
-        return this.sendAsync({ type: ClientEventType.AUTHORIZED, payload });
+    isAuthorized() {
+        return this.sendAsync({ type: ClientEventType.AUTHORIZED });
     }
     getContactsAutoSuggest(payload) {
         return this.sendAsync({
@@ -126,9 +140,7 @@ export class Client {
             this.useSubscription = true;
             window.addEventListener('message', this.onMessage.bind(this));
         }
-        const foundThisEvent = this.listeners.find(({ eventName: _eventName, callback: _callback }) => {
-            return eventName === _eventName && Object.is(callback, _callback);
-        });
+        const foundThisEvent = this.listeners.find(({ eventName: _eventName, callback: _callback }) => eventName === _eventName && Object.is(callback, _callback));
         if (!foundThisEvent) {
             this.listeners.push({ eventName, callback });
         }
@@ -137,10 +149,8 @@ export class Client {
         };
     }
     removeEventListener(eventName, callback) {
-        this.listeners = this.listeners.filter(({ eventName: _eventName, callback: _callback }) => {
-            return !(Object.is(callback, _callback) &&
-                (!eventName ? true : eventName === _eventName));
-        });
+        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));
@@ -160,15 +170,13 @@ export class Client {
     }
     onSuggestContacts(callback) {
         return this.addEventListener(EventType.GET_CONTACTS_AUTO_SUGGEST, (query) => {
-            const resolve = (contacts) => {
-                return this.sendAsync({
-                    type: ClientEventType.CONTACTS_AUTO_SUGGEST,
-                    payload: {
-                        contacts,
-                        query,
-                    },
-                });
-            };
+            const resolve = (contacts) => this.sendAsync({
+                type: ClientEventType.CONTACTS_AUTO_SUGGEST,
+                payload: {
+                    contacts,
+                    query,
+                },
+            });
             const reject = (reason) => {
                 console.debug(reason);
             };

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

@@ -5,11 +5,12 @@ import { AutoSuggestResult, Callback, ConnectClient, EventType, Reject, RemoveEv
  * */
 export declare class Client implements ConnectClient {
     private static instance;
-    static getInstance(): ConnectClient;
+    static getInstance(): Client;
+    static initialize(renderer: () => Promise<void>): void;
     private worker;
     private listeners;
     private useSubscription;
-    private readonly iframeId?;
+    private readonly iframeId;
     private readonly variant;
     constructor();
     private sendAsync;
@@ -27,8 +28,8 @@ export declare class Client implements ConnectClient {
     reboot(): Promise<Response>;
     setViewport(payload: ViewPortSize): Promise<Response>;
     toClipboard(payload: string): Promise<Response>;
-    isNotAuthorized(payload: string): Promise<Response>;
-    isAuthorized(payload: string): Promise<Response>;
+    isNotAuthorized(): Promise<Response>;
+    isAuthorized(): Promise<Response>;
     getContactsAutoSuggest(payload: AutoSuggestResult): Promise<Response>;
     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/types.d.ts

@@ -50,7 +50,7 @@ export type Message<T extends MessageType = MessageType> = {
     payload?: EventPayload<T>;
 };
 export type MessageResponse<T extends MessageType = MessageType> = Message<T> & {
-    iframeId?: string;
+    iframeId: string;
 };
 export type Payload = string | Record<string, string> | ThemeChangePayload;
 export type Response<T extends Payload = Payload> = {
@@ -167,10 +167,10 @@ export interface ConnectClient {
     getContactsAutoSuggest: (payload: AutoSuggestResult) => Promise<Response>;
     /**
      * pushes to x-bees message that user is authorized and no more actions required */
-    isAuthorized: (payload: string) => Promise<Response>;
+    isAuthorized: () => Promise<Response>;
     /**
      * pushes to x-bees message that user actions required */
-    isNotAuthorized: (payload: string) => Promise<Response>;
+    isNotAuthorized: () => Promise<Response>;
     /**
      * Starts listen for one of the events of the x-bees and handle with the provided callback */
     addEventListener: <T extends EventType = EventType>(eventName: T, callback: Callback<T>) => RemoveEventListener;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wildix/xbees-connect",
-  "version": "1.0.4-alpha.10",
+  "version": "1.0.5-alpha.0",
   "description": "This library provides easy communication between x-bees and integrated web applications",
   "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
   "homepage": "",
@@ -14,7 +14,7 @@
     "build:es": "tsc -p tsconfig.es.json",
     "build:types": "tsc -p tsconfig.types.json",
     "build:docs": "typedoc",
-    "lint": "eslint .",
+    "lint": "eslint . && tsc --noEmit",
     "lint:fix": "eslint . --fix",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo"
   },
@@ -23,7 +23,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git@git.wildix.com:dimitri.chernykh/sdk-ui.git"
+    "url": "git@git.wildix.com:xbs/sdk-ui.git"
   },
   "publishConfig": {
     "access": "public"
@@ -41,5 +41,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "2a4305e68084729846257fbee0d565c4beb0272c"
+  "gitHead": "feeea3ba3e36abc8ac978906e83ba8015d57a3ba"
 }