@wildix/xbees-connect 1.0.4-alpha.0 → 1.0.4-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Wildix Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,11 +1,41 @@
-# `xbees-connect`
+# xbees connect client
 
-> TODO: description
+This package is the Community plan edition of the client for UI integration applications.
 
+## Installation
+
+Install the package in your project directory with:
+
+yarn
+```bash
+yarn add @wildix/xbees-connect
+```
+npm
+```bash
+npm install @wildix/xbees-connect
+```
 ## Usage
+```
+import Client from "@wildix/xbees-connect";
+
+const xBeesClient = Client.getInstance();
+console.log(xBeesClient.version());
 
 ```
-const xbeesConnect = require('xbees-connect');
 
-// TODO: DEMONSTRATE API....
+This component has the following peer dependencies that you will need to install as well.
+
+```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"
+  }
+}
 ```
+
+## Documentation
+
+Visit [https://mui.com/x/react-data-grid/](https://mui.com/x/react-data-grid/) to view the full documentation.

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

@@ -1,9 +1,9 @@
-import { AutoSuggestResult, Callback, ClientConnect, EventType, Reject, RemoveEventListener, Resolve, Response } from './types';
+import { AutoSuggestResult, Callback, ConnectClient, EventType, Reject, RemoveEventListener, Resolve, Response } from './types';
 /**
  * Client provides functionality of communication between xBees and integrated web applications via iFrame or ReactNative WebView
  * integration creates na instance with new Client()
  * */
-export declare class Client implements ClientConnect {
+export declare class Client implements ConnectClient {
     private static instance;
     static getInstance(): Client;
     private worker;

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

@@ -55,7 +55,6 @@ export type ThemeChangePayload = {
         palette?: unknown;
     };
 };
-export type ThemeChangeListenerCallback = (payload: ThemeChangePayload | unknown) => void;
 export type ListenerCallback = (payload: unknown) => void;
 export type DefaultCallback = (...args: unknown[]) => void;
 type CallStartInfo = {
@@ -66,7 +65,7 @@ type EventPayload<T extends EventType> = T extends EventType.GET_CONTACTS_AUTO_S
 export type EventPayloadMap = {
     [EventType.GET_CONTACTS_AUTO_SUGGEST]: string;
     [EventType.ADD_CALL]: CallStartInfo;
-    [EventType.USE_THEME]: string;
+    [EventType.USE_THEME]: string | ThemeChangePayload;
     [EventType.PBX_TOKEN]: string;
 };
 export type EventCallbackMap = {
@@ -105,7 +104,7 @@ export type Resolve = (contacts: Contact[]) => void;
 export type Reject = (reason: string) => void;
 export type Callback<T extends EventType = EventType> = T extends keyof EventCallbackMap ? EventCallbackMap[T] : DefaultCallback;
 export type RemoveEventListener = () => void;
-export interface ClientConnect {
+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<Response>;

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@wildix/xbees-connect",
-  "version": "1.0.4-alpha.0",
+  "version": "1.0.4-alpha.1",
   "description": "This library provides easy communication between x-bees and integrated web applications",
   "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
   "homepage": "",
+  "sideEffects": false,
   "license": "MIT",
   "main": "./dist-cjs/index.js",
   "types": "./dist-types/index.d.ts",
@@ -25,14 +26,9 @@
   "publishConfig": {
     "access": "public"
   },
-  "engines": {
-    "node": ">=18"
-  },
-  "dependencies": {
-    "typescript": "^5.2.2"
-  },
   "devDependencies": {
-    "rimraf": "^5.0.5"
+    "rimraf": "^5.0.5",
+    "typescript": "^5.2.2"
   },
-  "gitHead": "88d4593f7ab0adcff767df0f6297531a632558aa"
+  "gitHead": "b64d0bff60d65c22da252f2656c35d96507f4c16"
 }