@maren-sa/react-native-sanarkit 2.5.0 → 2.5.1

package/docs/itc_docs.md

@@ -0,0 +1,51 @@
+## ITCBooking 
+The ITCBooking module provides instant teleconsultation booking functionality with build in interface. It integrates with SanarKit services to enable Instant appointment booking and consultation features.
+
+### Installation
+The module is included in the SanarKit SDK package. No additional installation is required.
+
+#### Usage
+```typescript
+import { ITCBooking } from 'sanarkit';
+
+// In your component
+<ITCBooking
+  enable={boolean}
+  onEndFlow={() => void}
+/>
+```
+
+#### Parameters
+- `enable` (Boolean): Controls whether consultation module is active.
+- `onEndFlow` (Function): Callback triggered when ITCBooking module is closed on back button.
+
+#### Example
+```typescript
+import React, { useState } from 'react';
+import { ITCBooking } from 'sanarkit';
+
+const MyComponent = () => {
+  const [instantBooking, setInstantBooking] = useState(false);
+
+  return (
+    <ITCBooking
+      enable={instantBooking}
+      onEndFlow={() => setInstantBooking(false)}
+    />
+  );
+};
+```
+
+#### Integration with SanarKit
+The ITCBooking module requires an active SanarKit session to function properly. It uses the SanarKit session.
+
+#### Error Handling
+- If SanarKit session is not available, the component will trigger `onEndFlow` callback.
+- Console warnings are logged when SanarKit services are not connected.
+
+#### Notes
+- The component automatically handles navigation state changes.
+- Comes with build in interface for booking.
+- Chat consultation can be initiated from the booking interface post booking is done.
+
+For a complete implementation example, check out our [Example Repository](../exampleapp).

package/docs/readme.md

@@ -0,0 +1,89 @@
+# React Native SanarKit SDK — Installation Guide
+
+## 1. Install the SDK
+
+SanarKit is distributed as the private scoped package **`@maren-sa/react-native-sanarkit`**.
+
+### Option A — npm registry (recommended)
+
+This is the default channel. You need access to the `@maren-sa` scope (ask MarenTech for an npm auth token), then add it to your project's `.npmrc`:
+
+```ini
+@maren-sa:registry=https://registry.npmjs.org/
+//registry.npmjs.org/:_authToken=${NPM_TOKEN}
+```
+
+Install:
+
+```sh
+npm install @maren-sa/react-native-sanarkit
+# or
+yarn add @maren-sa/react-native-sanarkit
+```
+
+### Option B — GitHub URL (fallback)
+
+If you can't use the registry, install the same build straight from the repo (requires GitHub access to the repo). The package name and import path are identical to Option A.
+
+```sh
+npm install github:MarenTech/react-native-sanarkit
+# pin to a release tag (recommended):
+npm install github:MarenTech/react-native-sanarkit#v2.3.0
+```
+
+## 2. Install peer dependencies
+
+SanarKit relies on several native peer dependencies (Agora, permissions, SVG, WebView, etc.). Instead of installing them by hand, run the bundled setup command from your **app root** — after step 1, so the package is already installed (the `sanarkit-setup` bin is provided by SanarKit itself):
+
+```sh
+npx sanarkit-setup
+```
+
+This command (shipped inside the package) will:
+
+- Read SanarKit's declared `peerDependencies` (the authoritative list — always in sync with the installed version) and install any that are missing from your app, at the correct version ranges.
+- Remove the deprecated `sanar-rtc` package if it's still present (Agora 3.x → 4.x migration).
+- Run `cd ios && pod install` on macOS if anything changed.
+
+It auto-detects whether your app uses **npm** or **yarn** from your lockfile. Re-run it any time you upgrade SanarKit to pick up new or changed peer dependencies.
+
+> **Note:** Requires Node.js 16 or higher.
+
+## 3. Native permissions
+
+SanarKit's video/consultation features need camera and microphone access — see the [main README](../README.md#installation) for the iOS `Info.plist` keys and Android `AndroidManifest.xml` permissions.
+
+## Troubleshooting
+
+### iOS Issues
+1. Clean the build folder:
+   ```sh
+   cd ios && rm -rf build/
+   ```
+2. Remove Pods:
+   ```sh
+   cd ios && rm -rf Pods && rm -rf Podfile.lock
+   ```
+3. Reinstall pods:
+   ```sh
+   cd ios && pod install
+   ```
+4. If issues persist, clear the Metro bundler cache:
+   ```sh
+   npm start --reset-cache
+   # or
+   yarn start --reset-cache
+   ```
+
+### Android Issues
+1. Clean the gradle build:
+   ```sh
+   cd android && ./gradlew clean
+   ```
+2. Rebuild the project in Android Studio.
+
+## Support
+For any issues or questions, please contact MarenTech support or visit the [GitHub repository](https://github.com/MarenTech/react-native-sanarkit).
+
+## License
+This project is licensed under the MIT License — see the LICENSE file for details.

package/docs/sanarrtc_docs.md

@@ -0,0 +1,98 @@
+
+## SanarRTC Module Integration
+
+#### Step 1: Remove Agora SDK integration
+Assuming you have already integrated the SanarKit Version 1.0.7, you can proceed with the following steps to integrate the SanarRTC module.
+
+Remove the existing Agora SDK integration from your project which was installed from SanarKit previous version.
+
+```
+npm uninstall react-native-agora
+```
+
+Update Pods after removing the Agora SDK integration.
+
+```
+cd ios && pod install
+cd ..
+```
+
+Install the latest version of the SanarKit.
+
+```
+npm install https://github.com/MarenTech/react-native-sanarkit.git#1.1.0
+```
+
+#### Step 2: SanarKit SDK Dependencies update
+
+Assuming you have already setup sanar config like mentioned here [SanarKit SDK dependencies installation](readme.md#sanarkit-sdk-dependencies-installation), you can proceed with the following steps to update the SanarKit SDK dependencies.
+
+```sh
+npm run sanar:setup
+# or using yarn
+yarn sanar:setup
+```
+The above process will update and install the dependencies of the SanarKit SDK, along with the required dependencies for the SanarRTC module, which is a customized Agora dependency for teleconsultation.
+
+```json
+"sanar-rtc": "github:MarenTech/sanar-rtc",
+```
+
+#### Note: Permission integration check for iOS
+
+If you encounter any permission-related issues while using the SanarRTC component, ensure that you have properly configured the permissions in your iOS Podfile:
+
+1. Add the permissions setup script in your Podfile:
+```ruby
+require_relative '../node_modules/react-native-permissions/scripts/setup'
+```
+
+2. Configure the required permissions:
+```ruby
+setup_permissions([
+  'Camera',
+  'Microphone',
+])
+```
+
+3. Install pods after adding permissions:
+```sh
+cd ios && pod install
+cd ..
+```
+
+For a complete reference implementation, check the example Podfile at: [exampleapp/ios/Podfile](https://github.com/MarenTech/react-native-sanarkit/blob/1.1.0/exampleapp/ios/Podfile)
+
+## Troubleshooting
+
+### iOS Issues
+If you encounter any issues with iOS, try the following:
+1. Clean the build folder:
+   ```sh
+   cd ios && rm -rf build/
+   ```
+2. Remove Pods:
+   ```sh
+   cd ios && rm -rf Pods && rm -rf Podfile.lock
+   ```
+3. Reinstall pods:
+   ```sh
+   cd ios && pod install
+   ```
+4. If issues persist, try clearing the Metro bundler cache:
+   ```sh
+   npm start --reset-cache
+   # or
+   yarn start --reset-cache
+   ```
+
+### Android Issues
+If you encounter any issues with Android, try the following:
+1. Clean the gradle build:
+   ```sh
+   cd android && ./gradlew clean
+   ```
+2. Rebuild the project in Android Studio
+
+## Support
+For any issues or questions, please visit our [GitHub repository](https://github.com/MarenTech/react-native-sanarkit).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maren-sa/react-native-sanarkit",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "description": "SanarKit is a React Native library for integrating Sanar's services in your app.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -16,13 +16,14 @@
   },
   "files": [
     "lib",
+    "docs",
     "scripts/sanarkit-setup.js"
   ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/MarenTech/react-native-sanarkit.git"
   },
-  "homepage": "https://github.com/MarenTech/react-native-sanarkit#readme",
+  "homepage": "https://github.com/MarenTech/react-native-sanarkit/blob/main/docs/readme.md",
   "bugs": {
     "url": "https://github.com/MarenTech/react-native-sanarkit/issues"
   },