@wildix/xbees-connect 1.0.4 → 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wildix/xbees-connect",
-  "version": "1.0.4",
+  "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"
   },
@@ -41,5 +41,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "e98842e62bf2e122084d24b473c266f314df1a1c"
+  "gitHead": "feeea3ba3e36abc8ac978906e83ba8015d57a3ba"
 }