react-native-altibbi 0.1.0 → 0.1.2

package/README.md

@@ -1,36 +1,52 @@
-This Flutter SDK provides integration for the Altibbi services, including video consultation, text consultation, push
-notification, and many other features. This guide will walk you through the steps to integrate it into your Flutter
+This React native SDK provides integration for the Altibbi services, including video consultation, text consultation, push
+Welcome to the React Native SDK for Altibbi services, your comprehensive solution for integrating health consultation services into your React Native applications. This SDK enables video and text consultations, push notifications, and many other features to provide a seamless healthcare experience.
 project.
 
+
+## Features
+- **Video and VOIP Consultation:** Facilitate live video and VOIP sessions between patients and healthcare professionals.
+- **GSM Consultation:** Facilitate GSM(Phone calls) sessions between patients and healthcare professionals.
+- **Text Consultation:** Offer real-time text messaging for healthcare inquiries.
+- **User Management:** Easily manage user information with our comprehensive API.
+- **Real-time Notifications:** Keep users updated with push notifications and server to server real time callbacks.
+
+## Prerequisites
+- React Native 0.60 or higher
+- Node.js 16 or higher
+
 ## Installation
+Install the SDK with npm:
 
 ```sh
 npm install react-native-altibbi
 ```
+Or with yarn:
 
 ```sh
 yarn add react-native-altibbi
 ```
 
-## Usage
 
-### initlizetion
+## Initialization
+Initialize the Altibbi SDK with the following parameters:
+- **PARTNER_ENDPOINT:** Your partner endpoint (will be shared with you upon request).
+- **token:** Authentication token from your backend.
+- **language:** Preferred language for responses either Arabic (default) or English.
 
-Initialize the Altibbi service with the user token and partner endpoint as follows:
-Note: Be sure to replace placeholders "USER_TOKEN" and "PARTNER_ENDPOINT" with your actual values.
-language refer for the response language
-
-#### import init function to initialize Altibbi service
 
 ```js
 import { init } from 'react-native-altibbi';
-```
 
-```js
-init('PARTNER_ENDPOINT', 'LANGUAGE', 'USER_TOKEN');
+init('TOKEN', 'PARTNER_ENDPOINT', 'LANGUAGE');
 ```
 
-note that the USER_TOKEN should be retrieved from your backend
+
+## Detailed Usage
+
+
+### User API
+Manage users with functions like `createUser`, `updateUser`,`getUser`, `getUsers`, and `deleteUser`. Below are examples of how to use these functions:
+
 
 ### USER API
 
@@ -42,63 +58,60 @@ note that the USER_TOKEN should be retrieved from your backend
 | updateUser | userId             |
 | deleteUser | userId             |
 
-#### getUser
 
-```js
-import { getUser } from 'react-native-altibbi';
-```
+#### createUser Example
 
 ```js
-const response = await getUser(user_id)
-```
-
-#### getUsers
+import { createUser } from 'react-native-altibbi';
 
-```js
-import { getUsers } from 'react-native-altibbi';
+const params = {
+  name: "Altibbi",
+}
+const response = await createUser(params)
 ```
 
-```js
-const response = await getUsers(page, per_page)
-```
 
-#### createUser
+#### updateUser Example
 
 ```js
-import { createUser } from 'react-native-altibbi';
-```
+import { updateUser } from 'react-native-altibbi';
 
-```js
 const params = {
   name: "Altibbi",
 }
-const response = await createUser(params)
+const response = await updateUser(params)
 ```
 
-#### updateUser
 
+#### getUser Example
 ```js
-import { updateUser } from 'react-native-altibbi';
+import { getUser } from 'react-native-altibbi';
+
+const response = await getUser(user_id)
 ```
 
+
+#### getUsers Example
+
 ```js
-const params = {
-  name: "Altibbi",
-}
-const response = await updateUser(params)
+import { getUsers } from 'react-native-altibbi';
+const response = await getUsers(page, per_page)
 ```
 
 #### deleteUser
 
 ```js
 import { deleteUser } from 'react-native-altibbi';
-```
 
-```js
 const response = await updateUser(user_id)
 ```
 
+
+
+
 ### Consultation API
+Create and manage consultations using our suite of functions:
+
 
 | APi                 | params                                                                               |
 |---------------------|--------------------------------------------------------------------------------------|
@@ -113,9 +126,7 @@ const response = await updateUser(user_id)
 
 ```js
 import { createConsultation } from 'react-native-altibbi';
-```
 
-```js
 const params = {
   question,
   medium,
@@ -128,63 +139,212 @@ const response = await createConsultation(params)
 
 ```js
 import { getConsultationInfo } from 'react-native-altibbi';
+
+const response = await getConsultationInfo(consultation_id)
 ```
 
+#### getConsultationList
+
 ```js
-const response = await getConsultationInfo(consultation_id)
+import { getConsultationList } from 'react-native-altibbi';
+
+const response = await getConsultationList(user_id, page, per_page)
 ```
 
-#### deleteUser
+#### deleteConsultation
 
 ```js
-import { getLastConsultation } from 'react-native-altibbi';
+import { deleteConsultation } from 'react-native-altibbi';
+
+const response = await deleteConsultation(consultation_id)
 ```
 
+#### cancelConsultation
+
 ```js
-const response = await getLastConsultation()
+import { cancelConsultation } from 'react-native-altibbi';
+
+const response = await cancelConsultation(consultation_id)
 ```
 
-#### getConsultationList
+### TBISocket :
+
+#### After creating the consultation you can use TBISocket to listen to consultation status events
+
 
 ```js
-import { getConsultationList } from 'react-native-altibbi';
+import { TBISocket } from 'react-native-altibbi';
 ```
 
 ```js
-const response = await getConsultationList(user_id, page, per_page)
+const instance = TBISocket.getInstance();
 ```
 
-#### deleteConsultation
+#### connect && subscribe to listen to event
 
 ```js
-import { deleteConsultation } from 'react-native-altibbi';
+await instance.init({...socketParams,// socketParams retrived from consultation Object in SDK
+...{
+  onConnectionStateChange,
+  onError,
+  onEvent,
+  onSubscriptionSucceeded,
+  onSubscriptionError,
+  onDecryptionFailure,
+  onMemberAdded,
+  onMemberRemoved,
+  onSubscriptionCount,
+}});
+await instance.subscribe({ channelName: CHANNEL_NAME });
+await instance.connect();
 ```
 
+### Video Consultation
+
+#### import video components
+
 ```js
-const response = await deleteConsultation(consultation_id)
+import {
+  TBIPublisher,
+  TBISession,
+  TBISubscriber,
+  TBISubscriberView,
+} from 'react-native-altibbi';
 ```
 
-#### cancelConsultation
+```js
+<TBISession
+  options={{
+    androidZOrder: 'onTop',
+    androidOnTop: 'publisher',
+  }}
+  ref={(ref) => (sessionRef.current = ref)}
+  apiKey={API_KEY} //retrived from consultation Object in SDK
+  sessionId={CALL_ID}//retrived from consultation Object in SDK
+  token={TOKEN}//retrived from consultation Object in SDK
+  eventHandlers={{
+    streamDestroyed: (event) => {
+    },
+    error: (event) => {
+    },
+    otrnError: (event) => {
+    },
+  }}
+>
+  <TBISubscriber
+    eventHandlers={{
+      error: (event) => {
+      },
+      otrnError: (event) => {
+      },
+    }}
+  >
+    {renderSubscribers}
+  </TBISubscriber>
+  <TBIPublisher
+    properties={{
+      cameraPosition: 'front',
+      publishVideo: true, // set to false in voip consultation
+      publishAudio: true,
+      enableDtx: true,
+    }}
+    eventHandlers={{
+      streamDestroyed: (event) => {
+      },
+      error: (event) => {
+      },
+      otrnError: (event) => {
+      },
+    }}
+  />
+</TBISession>
+```
+
+### Chat Consultation
+
+#### import the components
 
 ```js
-import { cancelConsultation } from 'react-native-altibbi';
+import {
+  AltibbiChat,
+} from 'react-native-altibbi';
 ```
 
 ```js
-const response = await cancelConsultation(consultation_id)
+const ref = useRef(null);
+
+const init = () => {
+  AltibbiChat.init({
+    appId: APP_ID,
+    modules: [new GroupChannelModule()],
+  });
+};
+
+const connect = async () => {
+  await ref?.current?.connect(data.chat_user_id, data.chat_user_token);
+};
+
+const addHandler = () => {
+  let groupChannelHandler = new GroupChannelHandler({
+    onUserJoined,
+    onUserLeft,
+    onTypingStatusUpdated,
+    onMessageReceived,
+  });
+
+  let connectionHandler = new ConnectionHandler({
+    onConnected,
+    onReconnectStarted,
+    onReconnectSucceeded,
+    onReconnectFailed,
+    onDisconnected,
+  });
+  ref?.current?.groupChannel?.addGroupChannelHandler(
+    'CHA_HAN',
+    groupChannelHandler
+  );
+  ref?.current?.addConnectionHandler('CHA_CONN', connectionHandler);
+};
+
+const loadAllMessage = async (channelURL) => {
+  const channel = await getChannel(channelURL);
+  const previousMessageList = await channel.createPreviousMessageListQuery();
+  let allMessages = [];
+
+  while (previousMessageList.hasNext) {
+    let newMsgArr = await previousMessageList.load();
+    allMessages = [...allMessages, ...newMsgArr];
+  }
+  return allMessages;
+};
+
 ```
 
-## Support
+```js
+useEffect(() => {
+  const chatStart = async () => {
+    init();
+    addHandler();
+    connect().then(() => {
+      loadAllMessage(`channel_${data.group_id}`).then((res) => {
+        setMessageList(res);
+        setLoading(false);
+      });
+    });
+  };
+  chatStart();
+}, []);
+```
 
-If you need support you can contact: [mobile@altibbi.com](mobile@altibbi.com). Please
-ensure that you are referencing the latest version of our SDK to access all available features and improvements.
 
-## Contributing
+## Support
+
+For support, contact: [mobile@altibbi.com](mobile@altibbi.com). Please
+ensure that you are referencing the latest version of the SDK to access all available features and improvements.
 
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
 
 ## License
 
-MIT
+This project is licensed under the MIT License.
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-altibbi",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Altibbi Sdk",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -31,7 +31,6 @@
     "typecheck": "tsc --noEmit",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
     "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib"
-
   },
   "keywords": [
     "react-native",
@@ -155,7 +154,7 @@
   "dependencies": {
     "@sendbird/chat": "4.10.3",
     "axios": "1.6.2",
-    "deprecated-react-native-prop-types": "5.0.0",
+    "deprecated-react-native-prop-types": "2.3.0",
     "flow-bin": "0.223.3",
     "prop-types": "15.8.1",
     "underscore": "1.13.6",